X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/a55697acf8d60ff8fc67f8fc46f23b8f53a3b823..HEAD:/src/src/structs.h diff --git a/src/src/structs.h b/src/src/structs.h index 060eccf41..a32c55675 100644 --- a/src/src/structs.h +++ b/src/src/structs.h @@ -2,9 +2,13 @@ * Exim - an Internet mail transport agent * *************************************************/ +/* Copyright (c) The Exim Maintainers 2020 - 2024 */ /* Copyright (c) University of Cambridge 1995 - 2018 */ /* See the file NOTICE for conditions of use and distribution. */ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +#ifndef STRUCTS_H +#define STRUCTS_H /* Definitions of various structures. In addition, those that are visible for the compilation of local_scan() are defined in local_scan.h. These are @@ -79,14 +83,17 @@ typedef enum {DS_UNK=-1, DS_NO, DS_YES} dnssec_status_t; typedef struct host_item { struct host_item *next; - const uschar *name; /* Host name */ - const uschar *address; /* IP address in text form */ - int port; /* port value in host order (if SRV lookup) */ - int mx; /* MX value if found via MX records */ - int sort_key; /* MX*1000 plus random "fraction" */ - int status; /* Usable, unusable, or unknown */ - int why; /* Why host is unusable */ - int last_try; /* Time of last try if known */ + const uschar *name; /* Host name */ +#ifndef DISABLE_TLS + const uschar *certname; /* Name used for certificate checks */ +#endif + const uschar *address; /* IP address in text form */ + int port; /* port value in host order (if SRV lookup) */ + int mx; /* MX value if found via MX records */ + int sort_key; /* MX*1000 plus random "fraction" */ + int status; /* Usable, unusable, or unknown */ + int why; /* Why host is unusable */ + int last_try; /* Time of last try if known */ dnssec_status_t dnssec; } host_item; @@ -125,23 +132,39 @@ three, the layout of the start of the blocks is kept the same, and represented by the generic structures driver_info and driver_instance. */ typedef struct driver_instance { - struct driver_instance *next; + void *next; uschar *name; /* Instance name */ - struct driver_info *info; /* Points to info for this driver */ + void *info; /* Points to info for this driver */ void *options_block; /* Pointer to private options */ + uschar *driver_name; /* All start with this generic option */ + const uschar *srcfile; /* and config source info for errors */ + int srcline; } driver_instance; typedef struct driver_info { + struct driver_info * next; uschar *driver_name; /* Name of driver */ + optionlist *options; /* Table of private options names */ int *options_count; /* -> Number of entries in table */ void *options_block; /* Points to default private block */ int options_len; /* Length of same in bytes */ void (*init)( /* Initialization entry point */ - struct driver_instance *); + struct driver_instance *); + uint dyn_magic; /* Magic num if dynamic, else zero */ } driver_info; +/* Values for dyn_magic. Encode types and api version. */ +#define ROUTER_MAGIC 0x52544d31 /* RTM1 */ +#define TRANSPORT_MAGIC 0x54504d31 /* TPM1 */ +#define AUTH_MAGIC 0x65554d31 /* AUM1 */ + +typedef struct { + uint magic; + uschar * class; +} driver_magics; + /* Structure for holding information about the configured transports. Some of the generally accessible options are set from the configuration file; others @@ -150,11 +173,8 @@ transports. They need to be generally accessible, however, as they are used by the main transport code. */ typedef struct transport_instance { - struct transport_instance *next; - uschar *name; /* Instance name */ - struct transport_info *info; /* Info for this driver */ - void *options_block; /* Pointer to private options */ - uschar *driver_name; /* Must be first */ + driver_instance drinst; + int (*setup)( /* Setup entry point */ struct transport_instance *, struct address_item *, @@ -171,7 +191,7 @@ typedef struct transport_instance { uschar *expand_multi_domain; /* ) */ BOOL multi_domain; /* ) */ BOOL overrides_hosts; /* ) Used only for remote transports */ - int max_addresses; /* ) */ + uschar *max_addresses; /* ) */ int connection_max_messages;/* ) */ /**************************************/ BOOL deliver_as_creator; /* Used only by pipe at present */ @@ -215,18 +235,12 @@ typedef struct transport_instance { } transport_instance; -/* Structure for holding information about a type of transport. The first six -fields must match driver_info above. */ +/* Structure for holding information about a type of transport. The first +element must be a struct driver_info, to match auths and routers. */ typedef struct transport_info { - uschar *driver_name; /* Driver name */ - optionlist *options; /* Table of private options names */ - int *options_count; /* -> Number of entries in table */ - void *options_block; /* Points to default private block */ - int options_len; /* Length of same in bytes */ - void (*init)( /* Initialization function */ - struct transport_instance *); -/****/ + driver_info drinfo; + BOOL (*code)( /* Main entry point */ transport_instance *, struct address_item *); @@ -274,11 +288,7 @@ typedef struct { /* Structure for holding information about the configured routers. */ typedef struct router_instance { - struct router_instance *next; - uschar *name; - struct router_info *info; - void *options_block; /* Pointer to private options */ - uschar *driver_name; /* Must be first */ + driver_instance drinst; uschar *address_data; /* Arbitrary data */ #ifdef EXPERIMENTAL_BRIGHTMAIL @@ -355,18 +365,12 @@ typedef struct router_instance { } router_instance; -/* Structure for holding information about a type of router. The first six -fields must match driver_info above. */ +/* Structure for holding information about a type of router. The first element +must be a struct driver_info, to match auths and transports. */ typedef struct router_info { - uschar *driver_name; - optionlist *options; /* Table of private options names */ - int *options_count; /* -> Number of entries in table */ - void *options_block; /* Points to default private block */ - int options_len; /* Length of same in bytes */ - void (*init)( /* Initialization function */ - struct router_instance *); -/****/ + driver_info drinfo; + int (*code)( /* Main entry point */ router_instance *, struct address_item *, @@ -391,11 +395,8 @@ typedef struct router_info { mechanisms */ typedef struct auth_instance { - struct auth_instance *next; - uschar *name; /* Exim instance name */ - struct auth_info *info; /* Pointer to driver info block */ - void *options_block; /* Pointer to private options */ - uschar *driver_name; /* Must be first */ + driver_instance drinst; + uschar *advertise_condition; /* Are we going to advertise this?*/ uschar *client_condition; /* Should the client try this? */ uschar *public_name; /* Advertised name */ @@ -411,17 +412,11 @@ typedef struct auth_instance { /* Structure for holding information about an authentication mechanism. The -first six fields must match driver_info above. */ +first element must be a struct driver_info, to match routers and transports. */ typedef struct auth_info { - uschar *driver_name; /* e.g. "condition" */ - optionlist *options; /* Table of private options names */ - int *options_count; /* -> Number of entries in table */ - void *options_block; /* Points to default private block */ - int options_len; /* Length of same in bytes */ - void (*init)( /* initialization function */ - struct auth_instance *); -/****/ + driver_info drinfo; + int (*servercode)( /* server function */ auth_instance *, /* the instance data */ uschar *); /* rest of AUTH command */ @@ -431,8 +426,9 @@ typedef struct auth_info { int, /* command timeout */ uschar *, /* buffer for reading response */ int); /* sizeof buffer */ - void (*version_report)( /* diagnostic version reporting */ - FILE *); /* I/O stream to print to */ + gstring * (*version_report)( /* diagnostic version reporting */ + gstring *); /* string to append to */ + void (*macros_create)(void); /* feature-macro creation */ } auth_info; @@ -451,8 +447,8 @@ typedef struct ip_address_item { /* Structure for chaining together arbitrary strings. */ typedef struct string_item { - struct string_item *next; - uschar *text; + struct string_item * next; + uschar * text; } string_item; /* Information about a soft delivery failure, for use when calculating @@ -462,7 +458,7 @@ can be tried. */ typedef struct retry_item { struct retry_item *next; /* for chaining */ - uschar *key; /* string identifying host/address/message */ + const uschar *key; /* string identifying host/address/message */ int basic_errno; /* error code for this destination */ int more_errno; /* additional error information */ uschar *message; /* local error message */ @@ -508,14 +504,11 @@ typedef struct address_item_propagated { uschar *address_data; /* arbitrary data to keep with the address */ uschar *domain_data; /* from "domains" lookup */ uschar *localpart_data; /* from "local_parts" lookup */ - uschar *errors_address; /* where to send errors (NULL => sender) */ + const uschar *errors_address; /* where to send errors (NULL => sender) */ header_line *extra_headers; /* additional headers */ uschar *remove_headers; /* list of those to remove */ void *variables; /* router-vasriables */ -#ifdef EXPERIMENTAL_SRS - uschar *srs_sender; /* Change return path when delivering */ -#endif BOOL ignore_error:1; /* ignore delivery error */ #ifdef SUPPORT_I18N BOOL utf8_msg:1; /* requires SMTPUTF8 processing */ @@ -546,13 +539,15 @@ typedef struct address_item { reply_item *reply; /* data for autoreply */ retry_item *retries; /* chain of retry information */ - uschar *address; /* address being delivered or routed */ + const uschar *address; /* address being delivered or routed */ uschar *unique; /* used for disambiguating */ - uschar *cc_local_part; /* caseful local part */ - uschar *lc_local_part; /* lowercased local part */ - uschar *local_part; /* points to cc or lc version */ - uschar *prefix; /* stripped prefix of local part */ - uschar *suffix; /* stripped suffix of local part */ + const uschar *cc_local_part; /* caseful local part */ + const uschar *lc_local_part; /* lowercased local part */ + const uschar *local_part; /* points to cc or lc version */ + const uschar *prefix; /* stripped prefix of local part */ + const uschar *prefix_v; /* variable part of above */ + const uschar *suffix; /* stripped suffix of local part */ + const uschar *suffix_v; /* variable part of above */ const uschar *domain; /* working domain (lower cased) */ uschar *address_retry_key; /* retry key including full address */ @@ -563,12 +558,15 @@ typedef struct address_item { uschar *message; /* error message */ uschar *user_message; /* error message that can be sent over SMTP or quoted in bounce message */ - uschar *onetime_parent; /* saved original parent for onetime */ + const uschar *onetime_parent; /* saved original parent for onetime */ uschar **pipe_expandn; /* numeric expansions for pipe from filter */ uschar *return_filename; /* name of return file */ uschar *self_hostname; /* after self=pass */ uschar *shadow_message; /* info about shadow transporting */ + uid_t uid; /* uid for transporting */ + gid_t gid; /* gid for transporting */ + #ifndef DISABLE_TLS const uschar *tlsver; /* version used for transport */ uschar *cipher; /* Cipher used for transport */ @@ -591,9 +589,9 @@ typedef struct address_item { int dsn_flags; /* DSN flags */ int dsn_aware; /* DSN aware flag */ - uid_t uid; /* uid for transporting */ - gid_t gid; /* gid for transporting */ - +#ifndef DISABLE_DKIM + const uschar * dkim_used; /* DKIM info, or NULL */ +#endif /* flags */ struct { BOOL af_allow_file:1; /* allow file in generated address */ @@ -619,6 +617,8 @@ typedef struct address_item { BOOL af_verify_routed:1; /* for cached sender verify: routed OK */ BOOL af_verify_callout:1; /* for cached sender verify: callout was specified */ BOOL af_include_affixes:1; /* delivered with affixes in RCPT */ + BOOL af_new_conn:1; /* delivered on an fresh TCP conn */ + BOOL af_cont_conn:1; /* delivered (with new MAIL cmd) on an existing TCP conn */ BOOL af_cert_verified:1; /* delivered with verified TLS cert */ BOOL af_pass_message:1; /* pass message in bounces */ BOOL af_bad_reply:1; /* filter could not generate autoreply */ @@ -640,7 +640,7 @@ typedef struct address_item { #ifdef SUPPORT_I18N BOOL af_utf8_downcvt:1; /* downconvert was done for delivery */ #endif -#ifdef EXPERIMENTAL_TLS_RESUME +#ifndef DISABLE_TLS_RESUME BOOL af_tls_resume:1; /* TLS used a resumed session */ #endif } flags; @@ -724,14 +724,16 @@ typedef struct tree_node { /* Structure for holding time-limited data such as DNS returns. We use this rather than extending tree_node to avoid wasting space for most tree use (variables...) at the cost of complexity -for the lookups cache */ +for the lookups cache. +We also store any options used for the lookup. */ typedef struct expiring_data { - time_t expiry; /* if nonzero, data invalid after this time */ + time_t expiry; /* if nonzero, data invalid after this time */ + const uschar * opts; /* options, or NULL */ union { - void *ptr; /* pointer to data */ - int val; /* or integer data */ + void * ptr; /* pointer to data */ + int val; /* or integer data */ } data; } expiring_data; @@ -742,7 +744,7 @@ to close. */ typedef struct search_cache { void *handle; /* lookup handle, or NULL if closed */ - int search_type; /* search type */ + const lookup_info * li; /* info struct for search type */ tree_node *up; /* LRU up pointer */ tree_node *down; /* LRU down pointer */ tree_node *item_cache; /* tree of cached results */ @@ -811,6 +813,11 @@ typedef struct { int host_af; uschar * interface; + int sock; /* used for a bound but not connected socket */ + uschar * sending_ip_address; /* used for TLS resumption */ + const uschar * host_lbserver; /* ditto, for server-behind LB */ + BOOL have_lbserver:1; /* host_lbserver is valid */ + #ifdef SUPPORT_DANE BOOL dane:1; /* connection must do dane */ dns_answer tlsa_dnsa; /* strictly, this should use tainted mem */ @@ -864,13 +871,23 @@ typedef struct redirect_block { BOOL check_group; /* TRUE, FALSE, or TRUE_UNSET */ } redirect_block; +/* Sieve control data */ + +typedef struct sieve_block { + const uschar * inbox; + const uschar * enotify_mailto_owner; + const uschar * subaddress; + const uschar * useraddress; + const uschar * vacation_dir; +} sieve_block; + /* Structure for passing arguments to check_host() */ typedef struct check_host_block { const uschar *host_name; const uschar *host_address; const uschar *host_ipv4; - BOOL negative; + mcs_flags flags; } check_host_block; /* Structure for remembering lookup data when caching the result of @@ -885,9 +902,10 @@ typedef struct namedlist_cacheblock { /* Structure for holding data for an entry in a named list */ typedef struct namedlist_block { - const uschar *string; /* the list string */ - namedlist_cacheblock *cache_data; /* cached domain_data or localpart_data */ - int number; /* the number of the list for caching */ + const uschar *string; /* the list string */ + namedlist_cacheblock *cache_data; /* cached domain_data or localpart_data */ + short number; /* the number of the list for caching */ + BOOL hide; /* -bP does not display value */ } namedlist_block; /* Structures for Access Control Lists */ @@ -931,4 +949,96 @@ struct ob_dkim { #endif }; + +/* per-queue-runner info */ +typedef struct qrunner { + struct qrunner * next; /* list sorted by next tick */ + + uschar * name; /* NULL for the default queue */ + unsigned interval; /* tick rate, seconds. Zero for a one-time run */ + time_t next_tick; /* next run should, or should have, start(ed) */ + unsigned run_max; /* concurrent queue runner limit */ + unsigned run_count; /* current runners */ + + BOOL queue_run_force :1; + BOOL deliver_force_thaw :1; + BOOL queue_run_first_delivery :1; + BOOL queue_run_local :1; + BOOL queue_2stage :1; +} qrunner; + + +/* Types of variable table entry */ + +enum vtypes { + vtype_int, /* value is address of int */ + vtype_filter_int, /* ditto, but recognized only when filtering */ + vtype_ino, /* value is address of ino_t (not always an int) */ + vtype_uid, /* value is address of uid_t (not always an int) */ + vtype_gid, /* value is address of gid_t (not always an int) */ + vtype_bool, /* value is address of bool */ + vtype_stringptr, /* value is address of pointer to string */ + vtype_msgbody, /* as stringptr, but read when first required */ + vtype_msgbody_end, /* ditto, the end of the message */ + vtype_msgheaders, /* the message's headers, processed */ + vtype_msgheaders_raw, /* the message's headers, unprocessed */ + vtype_localpart, /* extract local part from string */ + vtype_domain, /* extract domain from string */ + vtype_string_func, /* value is string returned by given function */ + vtype_todbsdin, /* value not used; generate BSD inbox tod */ + vtype_tode, /* value not used; generate tod in epoch format */ + vtype_todel, /* value not used; generate tod in epoch/usec format */ + vtype_todf, /* value not used; generate full tod */ + vtype_todl, /* value not used; generate log tod */ + vtype_todlf, /* value not used; generate log file datestamp tod */ + vtype_todzone, /* value not used; generate time zone only */ + vtype_todzulu, /* value not used; generate zulu tod */ + vtype_reply, /* value not used; get reply from headers */ + vtype_pid, /* value not used; result is pid */ + vtype_host_lookup, /* value not used; get host name */ + vtype_load_avg, /* value not used; result is int from os_getloadavg */ + vtype_pspace, /* partition space; value is T/F for spool/log */ + vtype_pinodes, /* partition inodes; value is T/F for spool/log */ + vtype_cert, /* SSL certificate */ +#ifndef DISABLE_DKIM + vtype_dkim, /* Lookup of value in DKIM signature */ +#endif + vtype_module, /* variable lives in a module; value is module name */ +}; + +/* Type for main variable table */ + +typedef struct { + const char *name; + enum vtypes type; + void *value; +} var_entry; + + + +/* dynamic-load module info */ + +typedef struct misc_module_info { + struct misc_module_info * next; + + const uschar * name; + unsigned dyn_magic; + BOOL (*init)(void *); /* arg is the misc_module_info ptr */ + gstring * (*lib_vers_report)(gstring *); /* underlying library */ + int (*conn_init)(const uschar *, const uschar *); + void (*smtp_reset)(void); + int (*msg_init)(void); + gstring * (*authres)(gstring *); + + void * options; + unsigned options_count; + void * functions; + unsigned functions_count; + void * variables; + unsigned variables_count; +} misc_module_info; + +#define MISC_MODULE_MAGIC 0x4d4d4d31 /* MMM1 */ + +#endif /* whole file */ /* End of structs.h */