1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 - 2021 */
7 /* See the file NOTICE for conditions of use and distribution. */
10 /* Definitions of various structures. In addition, those that are visible for
11 the compilation of local_scan() are defined in local_scan.h. These are
17 For those declared here, we have to pre-declare some because of mutually
18 recursive definitions in the auths, routers, and transports blocks. */
26 struct transport_info;
30 typedef struct gstring {
31 int size; /* Current capacity of string memory */
32 int ptr; /* Offset at which to append further chars */
33 uschar * s; /* The string memory */
36 /* Structure for remembering macros for the configuration file */
38 typedef struct macro_item {
39 struct macro_item * next;
44 const uschar * replacement;
47 /* Structure for bit tables for debugging and logging */
49 typedef struct bit_table {
54 /* Block for holding a uid and gid, possibly unset, and an initgroups flag. */
56 typedef struct ugid_block {
64 typedef enum { CHUNKING_NOT_OFFERED = -1,
67 CHUNKING_LAST} chunking_state_t;
69 typedef enum { TFO_NOT_USED = 0,
73 TFO_USED_DATA } tfo_state_t;
75 /* Structure for holding information about a host for use mainly by routers,
76 but also used when checking lists of hosts and when transporting. Looking up
77 host addresses is done using this structure. */
79 typedef enum {DS_UNK=-1, DS_NO, DS_YES} dnssec_status_t;
81 typedef struct host_item {
82 struct host_item *next;
83 const uschar *name; /* Host name */
85 const uschar *certname; /* Name used for certificate checks */
87 const uschar *address; /* IP address in text form */
88 int port; /* port value in host order (if SRV lookup) */
89 int mx; /* MX value if found via MX records */
90 int sort_key; /* MX*1000 plus random "fraction" */
91 int status; /* Usable, unusable, or unknown */
92 int why; /* Why host is unusable */
93 int last_try; /* Time of last try if known */
94 dnssec_status_t dnssec;
97 /* Chain of rewrite rules, read from the rewrite config, or parsed from the
98 rewrite_headers field of a transport. */
100 typedef struct rewrite_rule {
101 struct rewrite_rule *next;
107 /* This structure is used to pass back configuration data from the smtp
108 transport to the outside world. It is used during callback processing. If ever
109 another remote transport were implemented, it could use the same structure. */
111 typedef struct transport_feedback {
118 BOOL hosts_randomize;
122 } transport_feedback;
124 /* Routers, transports, and authenticators have similar data blocks. Each
125 driver that is compiled into the code is represented by a xxx_info block; the
126 active drivers are represented by a chain of xxx_instance blocks. To make it
127 possible to use the same code for reading the configuration files for all
128 three, the layout of the start of the blocks is kept the same, and represented
129 by the generic structures driver_info and driver_instance. */
131 typedef struct driver_instance {
132 struct driver_instance *next;
133 uschar *name; /* Instance name */
134 struct driver_info *info; /* Points to info for this driver */
135 void *options_block; /* Pointer to private options */
137 uschar *driver_name; /* All start with this generic option */
138 const uschar *srcfile; /* and config source info for errors */
142 typedef struct driver_info {
143 uschar *driver_name; /* Name of driver */
145 optionlist *options; /* Table of private options names */
146 int *options_count; /* -> Number of entries in table */
147 void *options_block; /* Points to default private block */
148 int options_len; /* Length of same in bytes */
149 void (*init)( /* Initialization entry point */
150 struct driver_instance *);
154 /* Structure for holding information about the configured transports. Some
155 of the generally accessible options are set from the configuration file; others
156 are set by transport initialization, since they can only be set for certain
157 transports. They need to be generally accessible, however, as they are used by
158 the main transport code. */
160 typedef struct transport_instance {
161 struct transport_instance *next;
162 uschar *name; /* Instance name */
163 struct transport_info *info; /* Info for this driver */
164 void *options_block; /* Pointer to private options */
165 uschar *driver_name; /* Must be first */
166 const uschar *srcfile;
169 int (*setup)( /* Setup entry point */
170 struct transport_instance *,
171 struct address_item *,
172 struct transport_feedback *, /* For passing back config data */
173 uid_t, /* The uid that will be used */
174 gid_t, /* The gid that will be used */
175 uschar **); /* For an error message */
176 /**************************************/
177 int batch_max; /* ) */
178 uschar *batch_id; /* ) */
179 uschar *home_dir; /* ) Used only for local transports */
180 uschar *current_dir; /* ) */
181 /**************************************/
182 uschar *expand_multi_domain; /* ) */
183 BOOL multi_domain; /* ) */
184 BOOL overrides_hosts; /* ) Used only for remote transports */
185 int max_addresses; /* ) */
186 int connection_max_messages;/* ) */
187 /**************************************/
188 BOOL deliver_as_creator; /* Used only by pipe at present */
189 BOOL disable_logging; /* For very weird requirements */
190 BOOL initgroups; /* Initialize groups when setting uid */
191 BOOL uid_set; /* uid is set */
192 BOOL gid_set; /* gid is set */
195 uschar *expand_uid; /* Variable uid */
196 uschar *expand_gid; /* Variable gid */
197 uschar *warn_message; /* Used only by appendfile at present */
198 uschar *shadow; /* Name of shadow transport */
199 uschar *shadow_condition; /* Condition for running it */
200 uschar *filter_command; /* For on-the-fly-filtering */
201 uschar *add_headers; /* Add these headers */
202 uschar *remove_headers; /* Remove these headers */
203 uschar *return_path; /* Overriding (rewriting) return path */
204 uschar *debug_string; /* Debugging output */
205 uschar *max_parallel; /* Number of concurrent instances */
206 uschar *message_size_limit; /* Biggest message this transport handles */
207 uschar *headers_rewrite; /* Rules for rewriting headers */
208 rewrite_rule *rewrite_rules; /* Parsed rewriting rules */
209 int rewrite_existflags; /* Bits showing which headers are rewritten */
210 int filter_timeout; /* For transport filter timing */
211 BOOL body_only; /* Deliver only the body */
212 BOOL delivery_date_add; /* Add Delivery-Date header */
213 BOOL envelope_to_add; /* Add Envelope-To header */
214 BOOL headers_only; /* Deliver only the headers */
215 BOOL rcpt_include_affixes; /* TRUE to retain affixes in RCPT commands */
216 BOOL return_path_add; /* Add Return-Path header */
217 BOOL return_output; /* TRUE if output should always be returned */
218 BOOL return_fail_output; /* ditto, but only on failure */
219 BOOL log_output; /* Similarly for logging */
220 BOOL log_fail_output;
221 BOOL log_defer_output;
222 BOOL retry_use_local_part; /* Defaults true for local, false for remote */
223 #ifndef DISABLE_EVENT
224 uschar *event_action; /* String to expand on notable events */
226 } transport_instance;
229 /* Structure for holding information about a type of transport. The first six
230 fields must match driver_info above. */
232 typedef struct transport_info {
233 uschar *driver_name; /* Driver name */
234 optionlist *options; /* Table of private options names */
235 int *options_count; /* -> Number of entries in table */
236 void *options_block; /* Points to default private block */
237 int options_len; /* Length of same in bytes */
238 void (*init)( /* Initialization function */
239 struct transport_instance *);
241 BOOL (*code)( /* Main entry point */
242 transport_instance *,
243 struct address_item *);
244 void (*tidyup)( /* Tidyup function */
245 struct transport_instance *);
246 void (*closedown)( /* For closing down a passed channel */
247 struct transport_instance *);
248 BOOL local; /* TRUE for local transports */
252 /* smtp transport datachunk callback */
254 #define tc_reap_prev BIT(0) /* Flags: reap previous SMTP cmd responses */
255 #define tc_chunk_last BIT(1) /* annotate chunk SMTP cmd as LAST */
257 struct transport_context;
258 typedef int (*tpt_chunk_cmd_cb)(struct transport_context *, unsigned, unsigned);
260 /* Structure for information about a delivery-in-progress */
262 typedef struct transport_context {
263 union { /* discriminated by option topt_output_string */
264 int fd; /* file descriptor to write message to */
265 gstring * msg; /* allocated string with written message */
267 transport_instance * tblock; /* transport */
268 struct address_item * addr;
269 uschar * check_string; /* string replacement */
270 uschar * escape_string;
271 int options; /* output processing topt_* */
273 /* items below only used with option topt_use_bdat */
274 tpt_chunk_cmd_cb chunk_cb; /* per-datachunk callback */
285 /* Structure for holding information about the configured routers. */
287 typedef struct router_instance {
288 struct router_instance *next;
290 struct router_info *info;
291 void *options_block; /* Pointer to private options */
292 uschar *driver_name; /* Must be first */
293 const uschar *srcfile;
296 uschar *address_data; /* Arbitrary data */
297 #ifdef EXPERIMENTAL_BRIGHTMAIL
298 uschar *bmi_rule; /* Brightmail AntiSpam rule checking */
300 uschar *cannot_route_message; /* Used when routing fails */
301 uschar *condition; /* General condition */
302 uschar *current_directory; /* For use during delivery */
303 uschar *debug_string; /* Debugging output */
304 uschar *domains; /* Specific domains */
305 uschar *errors_to; /* Errors address */
306 uschar *expand_gid; /* Expanded gid string */
307 uschar *expand_uid; /* Expanded uid string */
308 uschar *expand_more; /* Expanded more string */
309 uschar *expand_unseen; /* Expanded unseen string */
310 uschar *extra_headers; /* Additional headers */
311 uschar *fallback_hosts; /* For remote transports (text list) */
312 uschar *home_directory; /* For use during delivery */
313 uschar *ignore_target_hosts; /* Target hosts to ignore */
314 uschar *local_parts; /* Specific local parts */
315 uschar *pass_router_name; /* Router for passed address */
316 uschar *prefix; /* Address prefix */
317 uschar *redirect_router_name; /* Router for generated address */
318 uschar *remove_headers; /* Removed headers */
319 uschar *require_files; /* File checks before router is run */
320 uschar *router_home_directory; /* For use while routing */
321 uschar *self; /* Text option for handling self reference */
322 uschar *senders; /* Specific senders */
323 uschar *suffix; /* Address suffix */
324 uschar *translate_ip_address; /* IP address translation fudgery */
325 uschar *transport_name; /* Transport name */
327 BOOL address_test; /* Use this router when testing addresses */
328 #ifdef EXPERIMENTAL_BRIGHTMAIL
329 BOOL bmi_deliver_alternate; /* TRUE => BMI said that message should be delivered to alternate location */
330 BOOL bmi_deliver_default; /* TRUE => BMI said that message should be delivered to default location */
331 BOOL bmi_dont_deliver; /* TRUE => BMI said that message should not be delivered at all */
333 BOOL expn; /* Use this router when processing EXPN */
334 BOOL caseful_local_part; /* TRUE => don't lowercase */
335 BOOL check_local_user; /* TRUE => check local user */
336 BOOL disable_logging; /* For very weird requirements */
337 BOOL fail_verify_recipient; /* Fail verify if recipient match this router */
338 BOOL fail_verify_sender; /* Fail verify if sender match this router */
339 BOOL gid_set; /* Flag to indicate gid is set */
340 BOOL initgroups; /* TRUE if initgroups is required */
341 BOOL log_as_local; /* TRUE logs as a local delivery */
342 BOOL more; /* If FALSE, do no more if this one fails */
343 BOOL pass_on_timeout; /* Treat timeout DEFERs as fails */
344 BOOL prefix_optional; /* Just what it says */
345 BOOL repeat_use; /* If FALSE, skip if ancestor used it */
346 BOOL retry_use_local_part; /* Just what it says */
347 BOOL same_domain_copy_routing; /* TRUE => copy routing for same domain */
348 BOOL self_rewrite; /* TRUE to rewrite headers if making local */
349 uschar *set; /* Variable = value to set; list */
350 BOOL suffix_optional; /* As it says */
351 BOOL verify_only; /* Skip this router if not verifying */
352 BOOL verify_recipient; /* Use this router when verifying a recipient*/
353 BOOL verify_sender; /* Use this router when verifying a sender */
354 BOOL uid_set; /* Flag to indicate uid is set */
355 BOOL unseen; /* If TRUE carry on, even after success */
356 BOOL dsn_lasthop; /* If TRUE, this router is a DSN endpoint */
358 int self_code; /* Encoded version of "self" */
359 uid_t uid; /* Fixed uid value */
360 gid_t gid; /* Fixed gid value */
362 host_item *fallback_hostlist; /* For remote transport (block chain) */
363 transport_instance *transport; /* Transport block (when found) */
364 struct router_instance *pass_router; /* Actual router for passed address */
365 struct router_instance *redirect_router; /* Actual router for generated address */
367 dnssec_domains dnssec;
371 /* Structure for holding information about a type of router. The first six
372 fields must match driver_info above. */
374 typedef struct router_info {
376 optionlist *options; /* Table of private options names */
377 int *options_count; /* -> Number of entries in table */
378 void *options_block; /* Points to default private block */
379 int options_len; /* Length of same in bytes */
380 void (*init)( /* Initialization function */
381 struct router_instance *);
383 int (*code)( /* Main entry point */
385 struct address_item *,
388 struct address_item **,
389 struct address_item **,
390 struct address_item **,
391 struct address_item **);
392 void (*tidyup)( /* Tidyup function */
393 struct router_instance *);
394 int ri_flags; /* Descriptive flags */
398 /* Structure for holding information about a lookup type. */
400 #include "lookupapi.h"
403 /* Structure for holding information about the configured authentication
406 typedef struct auth_instance {
407 struct auth_instance *next;
408 uschar *name; /* Exim instance name */
409 struct auth_info *info; /* Pointer to driver info block */
410 void *options_block; /* Pointer to private options */
411 uschar *driver_name; /* Must be first */
412 const uschar *srcfile;
415 uschar *advertise_condition; /* Are we going to advertise this?*/
416 uschar *client_condition; /* Should the client try this? */
417 uschar *public_name; /* Advertised name */
418 uschar *set_id; /* String to set when server as authenticated id */
419 uschar *set_client_id; /* String to set when client as client_authenticated id */
420 uschar *mail_auth_condition; /* Condition for AUTH on MAIL command */
421 uschar *server_debug_string; /* Debugging output */
422 uschar *server_condition; /* Authorization condition */
423 BOOL client; /* TRUE if client option(s) set */
424 BOOL server; /* TRUE if server options(s) set */
425 BOOL advertised; /* Set TRUE when advertised */
429 /* Structure for holding information about an authentication mechanism. The
430 first six fields must match driver_info above. */
432 typedef struct auth_info {
433 uschar *driver_name; /* e.g. "condition" */
434 optionlist *options; /* Table of private options names */
435 int *options_count; /* -> Number of entries in table */
436 void *options_block; /* Points to default private block */
437 int options_len; /* Length of same in bytes */
438 void (*init)( /* initialization function */
439 struct auth_instance *);
441 int (*servercode)( /* server function */
442 auth_instance *, /* the instance data */
443 uschar *); /* rest of AUTH command */
444 int (*clientcode)( /* client function */
445 struct auth_instance *,
446 void *, /* smtp conn, with socket, output and input buffers */
447 int, /* command timeout */
448 uschar *, /* buffer for reading response */
449 int); /* sizeof buffer */
450 gstring * (*version_report)( /* diagnostic version reporting */
451 gstring *); /* string to append to */
452 void (*macros_create)(void); /* feature-macro creation */
456 /* Structure for holding a single IP address and port; used for the chain of
457 addresses and ports for the local host. Make the char string large enough to
458 hold an IPv6 address. */
460 typedef struct ip_address_item {
461 struct ip_address_item *next;
463 BOOL v6_include_v4; /* Used in the daemon */
465 uschar * log; /* portion of "listening on" log line */
468 /* Structure for chaining together arbitrary strings. */
470 typedef struct string_item {
471 struct string_item *next;
475 /* Information about a soft delivery failure, for use when calculating
476 retry information. It's separate from the address block, because there
477 can be a chain of them for SMTP deliveries where multiple IP addresses
480 typedef struct retry_item {
481 struct retry_item *next; /* for chaining */
482 uschar *key; /* string identifying host/address/message */
483 int basic_errno; /* error code for this destination */
484 int more_errno; /* additional error information */
485 uschar *message; /* local error message */
486 int flags; /* see below */
489 /* Retry data flags */
491 #define rf_delete 0x0001 /* retry info is to be deleted */
492 #define rf_host 0x0002 /* retry info is for a remote host */
493 #define rf_message 0x0004 /* retry info is for a host+message */
495 /* Information about a constructed message that is to be sent using the
496 autoreply transport. This is pointed to from the address block. */
498 typedef struct reply_item {
499 uschar *from; /* ) */
500 uschar *reply_to; /* ) */
502 uschar *cc; /* ) specific header fields */
504 uschar *subject; /* ) */
505 uschar *headers; /* misc other headers, concatenated */
506 uschar *text; /* text string body */
507 uschar *file; /* file body */
508 BOOL file_expand; /* expand the body */
509 int expand_forbid; /* expansion lockout flags */
510 uschar *logfile; /* file to keep a log in */
511 uschar *oncelog; /* file to keep records in for once only */
512 time_t once_repeat; /* time to repeat "once only" */
513 BOOL return_message; /* send back the original message */
517 /* The address_item structure contains many fields which are used at various
518 times while delivering a message. Some are used only for remote deliveries;
519 some only for local. A particular set of fields is copied whenever a child
520 address is created. For convenience, we keep those fields in a separate
521 sub-structure so they can be copied in one go. This also means I won't forget
522 to edit the various copying places when new to-be-copied fields are added. */
524 typedef struct address_item_propagated {
525 uschar *address_data; /* arbitrary data to keep with the address */
526 uschar *domain_data; /* from "domains" lookup */
527 uschar *localpart_data; /* from "local_parts" lookup */
528 uschar *errors_address; /* where to send errors (NULL => sender) */
529 header_line *extra_headers; /* additional headers */
530 uschar *remove_headers; /* list of those to remove */
531 void *variables; /* router-vasriables */
533 BOOL ignore_error:1; /* ignore delivery error */
535 BOOL utf8_msg:1; /* requires SMTPUTF8 processing */
536 BOOL utf8_downcvt:1; /* mandatory downconvert on delivery */
537 BOOL utf8_downcvt_maybe:1; /* optional downconvert on delivery */
539 } address_item_propagated;
542 /* The main address structure. Note that fields that are to be copied to
543 generated addresses should be put in the address_item_propagated structure (see
544 above) rather than directly into the address_item structure. */
546 typedef struct address_item {
547 struct address_item *next; /* for chaining addresses */
548 struct address_item *parent; /* parent address */
549 struct address_item *first; /* points to first after group delivery */
550 struct address_item *dupof; /* points to address this is a duplicate of */
552 router_instance *start_router; /* generated address starts here */
553 router_instance *router; /* the router that routed */
554 transport_instance *transport; /* the transport to use */
556 host_item *host_list; /* host data for the transport */
557 host_item *host_used; /* host that took delivery or failed hard */
558 host_item *fallback_hosts; /* to try if delivery defers */
560 reply_item *reply; /* data for autoreply */
561 retry_item *retries; /* chain of retry information */
563 uschar *address; /* address being delivered or routed */
564 uschar *unique; /* used for disambiguating */
565 uschar *cc_local_part; /* caseful local part */
566 uschar *lc_local_part; /* lowercased local part */
567 uschar *local_part; /* points to cc or lc version */
568 uschar *prefix; /* stripped prefix of local part */
569 uschar *prefix_v; /* variable part of above */
570 uschar *suffix; /* stripped suffix of local part */
571 uschar *suffix_v; /* variable part of above */
572 const uschar *domain; /* working domain (lower cased) */
574 uschar *address_retry_key; /* retry key including full address */
575 uschar *domain_retry_key; /* retry key for domain only */
577 uschar *current_dir; /* current directory for transporting */
578 uschar *home_dir; /* home directory for transporting */
579 uschar *message; /* error message */
580 uschar *user_message; /* error message that can be sent over SMTP
581 or quoted in bounce message */
582 uschar *onetime_parent; /* saved original parent for onetime */
583 uschar **pipe_expandn; /* numeric expansions for pipe from filter */
584 uschar *return_filename; /* name of return file */
585 uschar *self_hostname; /* after self=pass */
586 uschar *shadow_message; /* info about shadow transporting */
589 const uschar *tlsver; /* version used for transport */
590 uschar *cipher; /* Cipher used for transport */
591 void *ourcert; /* Certificate offered to peer, binary */
592 void *peercert; /* Certificate from peer, binary */
593 uschar *peerdn; /* DN of server's certificate */
594 int ocsp; /* OCSP status of peer cert */
597 #ifdef EXPERIMENTAL_DSN_INFO
598 const uschar *smtp_greeting; /* peer self-identification */
599 const uschar *helo_response; /* peer message */
602 uschar *authenticator; /* auth driver name used by transport */
603 uschar *auth_id; /* auth "login" name used by transport */
604 uschar *auth_sndr; /* AUTH arg to SMTP MAIL, used by transport */
606 uschar *dsn_orcpt; /* DSN orcpt value */
607 int dsn_flags; /* DSN flags */
608 int dsn_aware; /* DSN aware flag */
610 uid_t uid; /* uid for transporting */
611 gid_t gid; /* gid for transporting */
615 BOOL af_allow_file:1; /* allow file in generated address */
616 BOOL af_allow_pipe:1; /* allow pipe in generated address */
617 BOOL af_allow_reply:1; /* allow autoreply in generated address */
618 BOOL af_dr_retry_exists:1; /* router retry record exists */
619 BOOL af_expand_pipe:1; /* expand pipe arguments */
620 BOOL af_file:1; /* file delivery; always with pfr */
621 BOOL af_gid_set:1; /* gid field is set */
622 BOOL af_home_expanded:1; /* home_dir is already expanded */
623 BOOL af_initgroups:1; /* use initgroups() for local transporting */
624 BOOL af_local_host_removed:1; /* local host was backup */
625 BOOL af_lt_retry_exists:1; /* local transport retry exists */
626 BOOL af_pfr:1; /* pipe or file or reply delivery */
627 BOOL af_retry_skipped:1; /* true if retry caused some skipping */
628 BOOL af_retry_timedout:1; /* true if retry timed out */
629 BOOL af_uid_set:1; /* uid field is set */
630 BOOL af_hide_child:1; /* hide child in bounce/defer msgs */
631 BOOL af_sverify_told:1; /* sender verify failure notified */
632 BOOL af_verify_pmfail:1; /* verify failure was postmaster callout */
633 BOOL af_verify_nsfail:1; /* verify failure was null sender callout */
634 BOOL af_homonym:1; /* an ancestor has same address */
635 BOOL af_verify_routed:1; /* for cached sender verify: routed OK */
636 BOOL af_verify_callout:1; /* for cached sender verify: callout was specified */
637 BOOL af_include_affixes:1; /* delivered with affixes in RCPT */
638 BOOL af_new_conn:1; /* delivered on an fresh TCP conn */
639 BOOL af_cont_conn:1; /* delivered (with new MAIL cmd) on an existing TCP conn */
640 BOOL af_cert_verified:1; /* delivered with verified TLS cert */
641 BOOL af_pass_message:1; /* pass message in bounces */
642 BOOL af_bad_reply:1; /* filter could not generate autoreply */
643 BOOL af_tcp_fastopen_conn:1; /* delivery connection used TCP Fast Open */
644 BOOL af_tcp_fastopen:1; /* delivery usefully used TCP Fast Open */
645 BOOL af_tcp_fastopen_data:1; /* delivery sent SMTP commands on TCP Fast Open */
646 BOOL af_pipelining:1; /* delivery used (traditional) pipelining */
647 #ifndef DISABLE_PIPE_CONNECT
648 BOOL af_early_pipe:1; /* delivery used connect-time pipelining */
651 BOOL af_prdr_used:1; /* delivery used SMTP PRDR */
653 BOOL af_chunking_used:1; /* delivery used SMTP CHUNKING */
654 BOOL af_force_command:1; /* force_command in pipe transport */
656 BOOL af_dane_verified:1; /* TLS cert verify done with DANE */
659 BOOL af_utf8_downcvt:1; /* downconvert was done for delivery */
661 #ifndef DISABLE_TLS_RESUME
662 BOOL af_tls_resume:1; /* TLS used a resumed session */
666 unsigned int domain_cache[(MAX_NAMED_LIST * 2)/32];
667 unsigned int localpart_cache[(MAX_NAMED_LIST * 2)/32];
668 int mode; /* mode for local transporting to a file */
669 int basic_errno; /* status after failure */
670 int more_errno; /* additional error information */
671 struct timeval delivery_time; /* time taken to do delivery/attempt */
673 unsigned short child_count; /* number of child addresses */
674 short int return_file; /* fileno of return data file */
675 short int special_action; /* ( used when when deferred or failed */
677 /* ( contains = or - when successful SMTP delivered */
679 /* ( contains verify rc in sender verify cache */
680 short int transport_return; /* result of delivery attempt */
681 address_item_propagated prop; /* fields that are propagated to children */
684 /* The table of header names consists of items of this type */
693 /* Chain of information about errors (e.g. bad addresses) */
695 typedef struct error_block {
696 struct error_block *next;
701 /* Chain of file names when processing the queue */
703 typedef struct queue_filename {
704 struct queue_filename *next;
709 /* Chain of items of retry information, read from the retry config. */
711 typedef struct retry_rule {
712 struct retry_rule *next;
719 typedef struct retry_config {
720 struct retry_config *next;
728 /* Structure for each node in a tree, of which there are various kinds */
730 typedef struct tree_node {
731 struct tree_node *left; /* pointer to left child */
732 struct tree_node *right; /* pointer to right child */
735 void *ptr; /* pointer to data */
736 int val; /* or integer data */
738 uschar balance; /* balancing factor */
739 uschar name[1]; /* node name - variable length */
742 /* Structure for holding time-limited data such as DNS returns.
743 We use this rather than extending tree_node to avoid wasting
744 space for most tree use (variables...) at the cost of complexity
745 for the lookups cache.
746 We also store any options used for the lookup. */
748 typedef struct expiring_data {
749 time_t expiry; /* if nonzero, data invalid after this time */
750 const uschar * opts; /* options, or NULL */
753 void * ptr; /* pointer to data */
754 int val; /* or integer data */
758 /* Structure for holding the handle and the cached last lookup for searches.
759 This block is pointed to by the tree entry for the file. The file can get
760 closed if too many are opened at once. There is a LRU chain for deciding which
763 typedef struct search_cache {
764 void *handle; /* lookup handle, or NULL if closed */
765 int search_type; /* search type */
766 tree_node *up; /* LRU up pointer */
767 tree_node *down; /* LRU down pointer */
768 tree_node *item_cache; /* tree of cached results */
771 /* Structure for holding a partially decoded DNS record; the name has been
772 uncompressed, but the data pointer is into the raw data. */
775 uschar name[DNS_MAXNAME]; /* domain name */
776 int type; /* record type */
777 unsigned short ttl; /* time-to-live, seconds */
778 int size; /* size of data */
779 const uschar *data; /* pointer to data */
782 /* Structure for holding the result of a DNS query. A touch over
783 64k big, so take care to release as soon as possible. */
786 int answerlen; /* length of the answer */
787 uschar answer[NS_MAXMSG]; /* the answer itself */
790 /* Structure for holding the intermediate data while scanning a DNS answer
794 int rrcount; /* count of RRs in the answer */
795 const uschar *aptr; /* pointer in the answer while scanning */
796 dns_record srr; /* data from current record in scan */
799 /* Structure for holding a chain of IP addresses that are extracted from
800 an A, AAAA, or A6 record. For the first two, there is only ever one address,
801 but the chaining feature of A6 allows for several addresses to be realized from
802 a single initial A6 record. The structure defines the address field of length
803 1. In use, a suitable sized block is obtained to hold the complete textual
806 typedef struct dns_address {
807 struct dns_address *next;
811 /* Structure used for holding intermediate data during MD5 computations. */
815 unsigned int abcd[4];
819 /* Structure used for holding intermediate data during SHA-1 computations. */
821 typedef struct sha1 {
826 /* Information for making an smtp connection */
828 transport_instance * tblock;
829 void * ob; /* smtp_transport_options_block * */
833 uschar * sending_ip_address; /* used for TLS resumption */
834 int sock; /* used for a bound but not connected socket */
837 BOOL dane:1; /* connection must do dane */
838 dns_answer tlsa_dnsa; /* strictly, this should use tainted mem */
842 /* A client-initiated connection. If TLS, the second element is non-NULL */
849 /* Structure used to hold incoming packets of SMTP responses for a specific
850 socket. The packets which may contain multiple lines (and in some cases,
851 multiple responses). */
853 typedef struct smtp_inblock {
854 client_conn_ctx * cctx; /* the connection */
855 int buffersize; /* the size of the buffer */
856 uschar *ptr; /* current position in the buffer */
857 uschar *ptrend; /* end of data in the buffer */
858 uschar *buffer; /* the buffer itself */
861 /* Structure used to hold buffered outgoing packets of SMTP commands for a
862 specific socket. The packets which may contain multiple lines when pipelining
865 typedef struct smtp_outblock {
866 client_conn_ctx * cctx; /* the connection */
867 int cmd_count; /* count of buffered commands */
868 int buffersize; /* the size of the buffer */
869 BOOL authenticating; /* TRUE when authenticating */
870 uschar *ptr; /* current position in the buffer */
871 uschar *buffer; /* the buffer itself */
873 smtp_connect_args * conn_args; /* to make connection, if not yet made */
876 /* Structure to hold information about the source of redirection information */
878 typedef struct redirect_block {
879 uschar *string; /* file name or string */
880 uid_t *owners; /* allowed file owners */
881 gid_t *owngroups; /* allowed file groups */
882 struct passwd *pw; /* possible owner if not NULL */
883 int modemask; /* forbidden bits */
884 BOOL isfile; /* TRUE if string is a file name */
885 BOOL check_owner; /* TRUE, FALSE, or TRUE_UNSET */
886 BOOL check_group; /* TRUE, FALSE, or TRUE_UNSET */
889 /* Structure for passing arguments to check_host() */
891 typedef struct check_host_block {
892 const uschar *host_name;
893 const uschar *host_address;
894 const uschar *host_ipv4;
898 /* Structure for remembering lookup data when caching the result of
899 a lookup in a named list. */
901 typedef struct namedlist_cacheblock {
902 struct namedlist_cacheblock *next;
905 } namedlist_cacheblock;
907 /* Structure for holding data for an entry in a named list */
909 typedef struct namedlist_block {
910 const uschar *string; /* the list string */
911 namedlist_cacheblock *cache_data; /* cached domain_data or localpart_data */
912 short number; /* the number of the list for caching */
913 BOOL hide; /* -bP does not display value */
916 /* Structures for Access Control Lists */
918 typedef struct acl_condition_block {
919 struct acl_condition_block * next;
926 } acl_condition_block;
928 typedef struct acl_block {
929 struct acl_block * next;
930 acl_condition_block * condition;
933 const uschar * srcfile;
936 /* smtp transport calc outbound_ip */
937 typedef BOOL (*oicf) (uschar *message_id, void *data);
939 /* DKIM information for transport */
942 uschar *dkim_identity;
943 uschar *dkim_private_key;
944 uschar *dkim_selector;
946 uschar *dkim_sign_headers;
949 uschar *dkim_timestamps;
952 #ifdef EXPERIMENTAL_ARC
953 uschar *arc_signspec;
957 /* End of structs.h */