1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
11 /* Definitions of various structures. In addition, those that are visible for
12 the compilation of local_scan() are defined in local_scan.h. These are
18 For those declared here, we have to pre-declare some because of mutually
19 recursive definitions in the auths, routers, and transports blocks. */
27 struct transport_info;
31 typedef struct gstring {
32 int size; /* Current capacity of string memory */
33 int ptr; /* Offset at which to append further chars */
34 uschar * s; /* The string memory */
37 /* Structure for remembering macros for the configuration file */
39 typedef struct macro_item {
40 struct macro_item * next;
45 const uschar * replacement;
48 /* Structure for bit tables for debugging and logging */
50 typedef struct bit_table {
55 /* Block for holding a uid and gid, possibly unset, and an initgroups flag. */
57 typedef struct ugid_block {
65 typedef enum { CHUNKING_NOT_OFFERED = -1,
68 CHUNKING_LAST} chunking_state_t;
70 typedef enum { TFO_NOT_USED = 0,
74 TFO_USED_DATA } tfo_state_t;
76 /* Structure for holding information about a host for use mainly by routers,
77 but also used when checking lists of hosts and when transporting. Looking up
78 host addresses is done using this structure. */
80 typedef enum {DS_UNK=-1, DS_NO, DS_YES} dnssec_status_t;
82 typedef struct host_item {
83 struct host_item *next;
84 const uschar *name; /* Host name */
86 const uschar *certname; /* Name used for certificate checks */
88 const uschar *address; /* IP address in text form */
89 int port; /* port value in host order (if SRV lookup) */
90 int mx; /* MX value if found via MX records */
91 int sort_key; /* MX*1000 plus random "fraction" */
92 int status; /* Usable, unusable, or unknown */
93 int why; /* Why host is unusable */
94 int last_try; /* Time of last try if known */
95 dnssec_status_t dnssec;
98 /* Chain of rewrite rules, read from the rewrite config, or parsed from the
99 rewrite_headers field of a transport. */
101 typedef struct rewrite_rule {
102 struct rewrite_rule *next;
108 /* This structure is used to pass back configuration data from the smtp
109 transport to the outside world. It is used during callback processing. If ever
110 another remote transport were implemented, it could use the same structure. */
112 typedef struct transport_feedback {
119 BOOL hosts_randomize;
123 } transport_feedback;
125 /* Routers, transports, and authenticators have similar data blocks. Each
126 driver that is compiled into the code is represented by a xxx_info block; the
127 active drivers are represented by a chain of xxx_instance blocks. To make it
128 possible to use the same code for reading the configuration files for all
129 three, the layout of the start of the blocks is kept the same, and represented
130 by the generic structures driver_info and driver_instance. */
132 typedef struct driver_instance {
134 uschar *name; /* Instance name */
135 void *info; /* Points to info for this driver */
136 void *options_block; /* Pointer to private options */
138 uschar *driver_name; /* All start with this generic option */
139 const uschar *srcfile; /* and config source info for errors */
143 typedef struct driver_info {
144 struct driver_info * next;
145 uschar *driver_name; /* Name of driver */
147 optionlist *options; /* Table of private options names */
148 int *options_count; /* -> Number of entries in table */
149 void *options_block; /* Points to default private block */
150 int options_len; /* Length of same in bytes */
151 void (*init)( /* Initialization entry point */
152 struct driver_instance *);
153 uint dyn_magic; /* Magic num if dynamic, else zero */
156 /* Values for dyn_magic. Encode types and api version. */
157 #define ROUTER_MAGIC 0x52544d31 /* RTM1 */
158 #define TRANSPORT_MAGIC 0x54504d31 /* TPM1 */
159 #define AUTH_MAGIC 0x65554d31 /* AUM1 */
167 /* Structure for holding information about the configured transports. Some
168 of the generally accessible options are set from the configuration file; others
169 are set by transport initialization, since they can only be set for certain
170 transports. They need to be generally accessible, however, as they are used by
171 the main transport code. */
173 typedef struct transport_instance {
174 driver_instance drinst;
176 int (*setup)( /* Setup entry point */
177 struct transport_instance *,
178 struct address_item *,
179 struct transport_feedback *, /* For passing back config data */
180 uid_t, /* The uid that will be used */
181 gid_t, /* The gid that will be used */
182 uschar **); /* For an error message */
183 /**************************************/
184 int batch_max; /* ) */
185 uschar *batch_id; /* ) */
186 uschar *home_dir; /* ) Used only for local transports */
187 uschar *current_dir; /* ) */
188 /**************************************/
189 uschar *expand_multi_domain; /* ) */
190 BOOL multi_domain; /* ) */
191 BOOL overrides_hosts; /* ) Used only for remote transports */
192 uschar *max_addresses; /* ) */
193 int connection_max_messages;/* ) */
194 /**************************************/
195 BOOL deliver_as_creator; /* Used only by pipe at present */
196 BOOL disable_logging; /* For very weird requirements */
197 BOOL initgroups; /* Initialize groups when setting uid */
198 BOOL uid_set; /* uid is set */
199 BOOL gid_set; /* gid is set */
202 uschar *expand_uid; /* Variable uid */
203 uschar *expand_gid; /* Variable gid */
204 uschar *warn_message; /* Used only by appendfile at present */
205 uschar *shadow; /* Name of shadow transport */
206 uschar *shadow_condition; /* Condition for running it */
207 uschar *filter_command; /* For on-the-fly-filtering */
208 uschar *add_headers; /* Add these headers */
209 uschar *remove_headers; /* Remove these headers */
210 uschar *return_path; /* Overriding (rewriting) return path */
211 uschar *debug_string; /* Debugging output */
212 uschar *max_parallel; /* Number of concurrent instances */
213 uschar *message_size_limit; /* Biggest message this transport handles */
214 uschar *headers_rewrite; /* Rules for rewriting headers */
215 rewrite_rule *rewrite_rules; /* Parsed rewriting rules */
216 int rewrite_existflags; /* Bits showing which headers are rewritten */
217 int filter_timeout; /* For transport filter timing */
218 BOOL body_only; /* Deliver only the body */
219 BOOL delivery_date_add; /* Add Delivery-Date header */
220 BOOL envelope_to_add; /* Add Envelope-To header */
221 BOOL headers_only; /* Deliver only the headers */
222 BOOL rcpt_include_affixes; /* TRUE to retain affixes in RCPT commands */
223 BOOL return_path_add; /* Add Return-Path header */
224 BOOL return_output; /* TRUE if output should always be returned */
225 BOOL return_fail_output; /* ditto, but only on failure */
226 BOOL log_output; /* Similarly for logging */
227 BOOL log_fail_output;
228 BOOL log_defer_output;
229 BOOL retry_use_local_part; /* Defaults true for local, false for remote */
230 #ifndef DISABLE_EVENT
231 uschar *event_action; /* String to expand on notable events */
233 } transport_instance;
236 /* Structure for holding information about a type of transport. The first
237 element must be a struct driver_info, to match auths and routers. */
239 typedef struct transport_info {
242 BOOL (*code)( /* Main entry point */
243 transport_instance *,
244 struct address_item *);
245 void (*tidyup)( /* Tidyup function */
246 struct transport_instance *);
247 void (*closedown)( /* For closing down a passed channel */
248 struct transport_instance *);
249 BOOL local; /* TRUE for local transports */
253 /* smtp transport datachunk callback */
255 #define tc_reap_prev BIT(0) /* Flags: reap previous SMTP cmd responses */
256 #define tc_chunk_last BIT(1) /* annotate chunk SMTP cmd as LAST */
258 struct transport_context;
259 typedef int (*tpt_chunk_cmd_cb)(struct transport_context *, unsigned, unsigned);
261 /* Structure for information about a delivery-in-progress */
263 typedef struct transport_context {
264 union { /* discriminated by option topt_output_string */
265 int fd; /* file descriptor to write message to */
266 gstring * msg; /* allocated string with written message */
268 transport_instance * tblock; /* transport */
269 struct address_item * addr;
270 uschar * check_string; /* string replacement */
271 uschar * escape_string;
272 int options; /* output processing topt_* */
274 /* items below only used with option topt_use_bdat */
275 tpt_chunk_cmd_cb chunk_cb; /* per-datachunk callback */
286 /* Structure for holding information about the configured routers. */
288 typedef struct router_instance {
289 driver_instance drinst;
291 uschar *address_data; /* Arbitrary data */
292 #ifdef EXPERIMENTAL_BRIGHTMAIL
293 uschar *bmi_rule; /* Brightmail AntiSpam rule checking */
295 uschar *cannot_route_message; /* Used when routing fails */
296 uschar *condition; /* General condition */
297 uschar *current_directory; /* For use during delivery */
298 uschar *debug_string; /* Debugging output */
299 uschar *domains; /* Specific domains */
300 uschar *errors_to; /* Errors address */
301 uschar *expand_gid; /* Expanded gid string */
302 uschar *expand_uid; /* Expanded uid string */
303 uschar *expand_more; /* Expanded more string */
304 uschar *expand_unseen; /* Expanded unseen string */
305 uschar *extra_headers; /* Additional headers */
306 uschar *fallback_hosts; /* For remote transports (text list) */
307 uschar *home_directory; /* For use during delivery */
308 uschar *ignore_target_hosts; /* Target hosts to ignore */
309 uschar *local_parts; /* Specific local parts */
310 uschar *pass_router_name; /* Router for passed address */
311 uschar *prefix; /* Address prefix */
312 uschar *redirect_router_name; /* Router for generated address */
313 uschar *remove_headers; /* Removed headers */
314 uschar *require_files; /* File checks before router is run */
315 uschar *router_home_directory; /* For use while routing */
316 uschar *self; /* Text option for handling self reference */
317 uschar *senders; /* Specific senders */
318 uschar *suffix; /* Address suffix */
319 uschar *translate_ip_address; /* IP address translation fudgery */
320 uschar *transport_name; /* Transport name */
322 BOOL address_test; /* Use this router when testing addresses */
323 #ifdef EXPERIMENTAL_BRIGHTMAIL
324 BOOL bmi_deliver_alternate; /* TRUE => BMI said that message should be delivered to alternate location */
325 BOOL bmi_deliver_default; /* TRUE => BMI said that message should be delivered to default location */
326 BOOL bmi_dont_deliver; /* TRUE => BMI said that message should not be delivered at all */
328 BOOL expn; /* Use this router when processing EXPN */
329 BOOL caseful_local_part; /* TRUE => don't lowercase */
330 BOOL check_local_user; /* TRUE => check local user */
331 BOOL disable_logging; /* For very weird requirements */
332 BOOL fail_verify_recipient; /* Fail verify if recipient match this router */
333 BOOL fail_verify_sender; /* Fail verify if sender match this router */
334 BOOL gid_set; /* Flag to indicate gid is set */
335 BOOL initgroups; /* TRUE if initgroups is required */
336 BOOL log_as_local; /* TRUE logs as a local delivery */
337 BOOL more; /* If FALSE, do no more if this one fails */
338 BOOL pass_on_timeout; /* Treat timeout DEFERs as fails */
339 BOOL prefix_optional; /* Just what it says */
340 BOOL repeat_use; /* If FALSE, skip if ancestor used it */
341 BOOL retry_use_local_part; /* Just what it says */
342 BOOL same_domain_copy_routing; /* TRUE => copy routing for same domain */
343 BOOL self_rewrite; /* TRUE to rewrite headers if making local */
344 uschar *set; /* Variable = value to set; list */
345 BOOL suffix_optional; /* As it says */
346 BOOL verify_only; /* Skip this router if not verifying */
347 BOOL verify_recipient; /* Use this router when verifying a recipient*/
348 BOOL verify_sender; /* Use this router when verifying a sender */
349 BOOL uid_set; /* Flag to indicate uid is set */
350 BOOL unseen; /* If TRUE carry on, even after success */
351 BOOL dsn_lasthop; /* If TRUE, this router is a DSN endpoint */
353 int self_code; /* Encoded version of "self" */
354 uid_t uid; /* Fixed uid value */
355 gid_t gid; /* Fixed gid value */
357 host_item *fallback_hostlist; /* For remote transport (block chain) */
358 transport_instance *transport; /* Transport block (when found) */
359 struct router_instance *pass_router; /* Actual router for passed address */
360 struct router_instance *redirect_router; /* Actual router for generated address */
362 dnssec_domains dnssec;
366 /* Structure for holding information about a type of router. The first element
367 must be a struct driver_info, to match auths and transports. */
369 typedef struct router_info {
372 int (*code)( /* Main entry point */
374 struct address_item *,
377 struct address_item **,
378 struct address_item **,
379 struct address_item **,
380 struct address_item **);
381 void (*tidyup)( /* Tidyup function */
382 struct router_instance *);
383 int ri_flags; /* Descriptive flags */
387 /* Structure for holding information about a lookup type. */
389 #include "lookupapi.h"
392 /* Structure for holding information about the configured authentication
395 typedef struct auth_instance {
396 driver_instance drinst;
398 uschar *advertise_condition; /* Are we going to advertise this?*/
399 uschar *client_condition; /* Should the client try this? */
400 uschar *public_name; /* Advertised name */
401 uschar *set_id; /* String to set when server as authenticated id */
402 uschar *set_client_id; /* String to set when client as client_authenticated id */
403 uschar *mail_auth_condition; /* Condition for AUTH on MAIL command */
404 uschar *server_debug_string; /* Debugging output */
405 uschar *server_condition; /* Authorization condition */
406 BOOL client; /* TRUE if client option(s) set */
407 BOOL server; /* TRUE if server options(s) set */
408 BOOL advertised; /* Set TRUE when advertised */
412 /* Structure for holding information about an authentication mechanism. The
413 first element must be a struct driver_info, to match routers and transports. */
415 typedef struct auth_info {
418 int (*servercode)( /* server function */
419 auth_instance *, /* the instance data */
420 uschar *); /* rest of AUTH command */
421 int (*clientcode)( /* client function */
422 struct auth_instance *,
423 void *, /* smtp conn, with socket, output and input buffers */
424 int, /* command timeout */
425 uschar *, /* buffer for reading response */
426 int); /* sizeof buffer */
427 gstring * (*version_report)( /* diagnostic version reporting */
428 gstring *); /* string to append to */
429 void (*macros_create)(void); /* feature-macro creation */
433 /* Structure for holding a single IP address and port; used for the chain of
434 addresses and ports for the local host. Make the char string large enough to
435 hold an IPv6 address. */
437 typedef struct ip_address_item {
438 struct ip_address_item *next;
440 BOOL v6_include_v4; /* Used in the daemon */
442 uschar * log; /* portion of "listening on" log line */
445 /* Structure for chaining together arbitrary strings. */
447 typedef struct string_item {
448 struct string_item * next;
452 /* Information about a soft delivery failure, for use when calculating
453 retry information. It's separate from the address block, because there
454 can be a chain of them for SMTP deliveries where multiple IP addresses
457 typedef struct retry_item {
458 struct retry_item *next; /* for chaining */
459 const uschar *key; /* string identifying host/address/message */
460 int basic_errno; /* error code for this destination */
461 int more_errno; /* additional error information */
462 uschar *message; /* local error message */
463 int flags; /* see below */
466 /* Retry data flags */
468 #define rf_delete 0x0001 /* retry info is to be deleted */
469 #define rf_host 0x0002 /* retry info is for a remote host */
470 #define rf_message 0x0004 /* retry info is for a host+message */
472 /* Information about a constructed message that is to be sent using the
473 autoreply transport. This is pointed to from the address block. */
475 typedef struct reply_item {
476 uschar *from; /* ) */
477 uschar *reply_to; /* ) */
479 uschar *cc; /* ) specific header fields */
481 uschar *subject; /* ) */
482 uschar *headers; /* misc other headers, concatenated */
483 uschar *text; /* text string body */
484 uschar *file; /* file body */
485 BOOL file_expand; /* expand the body */
486 int expand_forbid; /* expansion lockout flags */
487 uschar *logfile; /* file to keep a log in */
488 uschar *oncelog; /* file to keep records in for once only */
489 time_t once_repeat; /* time to repeat "once only" */
490 BOOL return_message; /* send back the original message */
494 /* The address_item structure contains many fields which are used at various
495 times while delivering a message. Some are used only for remote deliveries;
496 some only for local. A particular set of fields is copied whenever a child
497 address is created. For convenience, we keep those fields in a separate
498 sub-structure so they can be copied in one go. This also means I won't forget
499 to edit the various copying places when new to-be-copied fields are added. */
501 typedef struct address_item_propagated {
502 uschar *address_data; /* arbitrary data to keep with the address */
503 uschar *domain_data; /* from "domains" lookup */
504 uschar *localpart_data; /* from "local_parts" lookup */
505 const uschar *errors_address; /* where to send errors (NULL => sender) */
506 header_line *extra_headers; /* additional headers */
507 uschar *remove_headers; /* list of those to remove */
508 void *variables; /* router-vasriables */
510 BOOL ignore_error:1; /* ignore delivery error */
512 BOOL utf8_msg:1; /* requires SMTPUTF8 processing */
513 BOOL utf8_downcvt:1; /* mandatory downconvert on delivery */
514 BOOL utf8_downcvt_maybe:1; /* optional downconvert on delivery */
516 } address_item_propagated;
519 /* The main address structure. Note that fields that are to be copied to
520 generated addresses should be put in the address_item_propagated structure (see
521 above) rather than directly into the address_item structure. */
523 typedef struct address_item {
524 struct address_item *next; /* for chaining addresses */
525 struct address_item *parent; /* parent address */
526 struct address_item *first; /* points to first after group delivery */
527 struct address_item *dupof; /* points to address this is a duplicate of */
529 router_instance *start_router; /* generated address starts here */
530 router_instance *router; /* the router that routed */
531 transport_instance *transport; /* the transport to use */
533 host_item *host_list; /* host data for the transport */
534 host_item *host_used; /* host that took delivery or failed hard */
535 host_item *fallback_hosts; /* to try if delivery defers */
537 reply_item *reply; /* data for autoreply */
538 retry_item *retries; /* chain of retry information */
540 const uschar *address; /* address being delivered or routed */
541 uschar *unique; /* used for disambiguating */
542 const uschar *cc_local_part; /* caseful local part */
543 const uschar *lc_local_part; /* lowercased local part */
544 const uschar *local_part; /* points to cc or lc version */
545 const uschar *prefix; /* stripped prefix of local part */
546 const uschar *prefix_v; /* variable part of above */
547 const uschar *suffix; /* stripped suffix of local part */
548 const uschar *suffix_v; /* variable part of above */
549 const uschar *domain; /* working domain (lower cased) */
551 uschar *address_retry_key; /* retry key including full address */
552 uschar *domain_retry_key; /* retry key for domain only */
554 uschar *current_dir; /* current directory for transporting */
555 uschar *home_dir; /* home directory for transporting */
556 uschar *message; /* error message */
557 uschar *user_message; /* error message that can be sent over SMTP
558 or quoted in bounce message */
559 const uschar *onetime_parent; /* saved original parent for onetime */
560 uschar **pipe_expandn; /* numeric expansions for pipe from filter */
561 uschar *return_filename; /* name of return file */
562 uschar *self_hostname; /* after self=pass */
563 uschar *shadow_message; /* info about shadow transporting */
565 uid_t uid; /* uid for transporting */
566 gid_t gid; /* gid for transporting */
569 const uschar *tlsver; /* version used for transport */
570 uschar *cipher; /* Cipher used for transport */
571 void *ourcert; /* Certificate offered to peer, binary */
572 void *peercert; /* Certificate from peer, binary */
573 uschar *peerdn; /* DN of server's certificate */
574 int ocsp; /* OCSP status of peer cert */
577 #ifdef EXPERIMENTAL_DSN_INFO
578 const uschar *smtp_greeting; /* peer self-identification */
579 const uschar *helo_response; /* peer message */
582 uschar *authenticator; /* auth driver name used by transport */
583 uschar *auth_id; /* auth "login" name used by transport */
584 uschar *auth_sndr; /* AUTH arg to SMTP MAIL, used by transport */
586 uschar *dsn_orcpt; /* DSN orcpt value */
587 int dsn_flags; /* DSN flags */
588 int dsn_aware; /* DSN aware flag */
591 const uschar * dkim_used; /* DKIM info, or NULL */
595 BOOL af_allow_file:1; /* allow file in generated address */
596 BOOL af_allow_pipe:1; /* allow pipe in generated address */
597 BOOL af_allow_reply:1; /* allow autoreply in generated address */
598 BOOL af_dr_retry_exists:1; /* router retry record exists */
599 BOOL af_expand_pipe:1; /* expand pipe arguments */
600 BOOL af_file:1; /* file delivery; always with pfr */
601 BOOL af_gid_set:1; /* gid field is set */
602 BOOL af_home_expanded:1; /* home_dir is already expanded */
603 BOOL af_initgroups:1; /* use initgroups() for local transporting */
604 BOOL af_local_host_removed:1; /* local host was backup */
605 BOOL af_lt_retry_exists:1; /* local transport retry exists */
606 BOOL af_pfr:1; /* pipe or file or reply delivery */
607 BOOL af_retry_skipped:1; /* true if retry caused some skipping */
608 BOOL af_retry_timedout:1; /* true if retry timed out */
609 BOOL af_uid_set:1; /* uid field is set */
610 BOOL af_hide_child:1; /* hide child in bounce/defer msgs */
611 BOOL af_sverify_told:1; /* sender verify failure notified */
612 BOOL af_verify_pmfail:1; /* verify failure was postmaster callout */
613 BOOL af_verify_nsfail:1; /* verify failure was null sender callout */
614 BOOL af_homonym:1; /* an ancestor has same address */
615 BOOL af_verify_routed:1; /* for cached sender verify: routed OK */
616 BOOL af_verify_callout:1; /* for cached sender verify: callout was specified */
617 BOOL af_include_affixes:1; /* delivered with affixes in RCPT */
618 BOOL af_new_conn:1; /* delivered on an fresh TCP conn */
619 BOOL af_cont_conn:1; /* delivered (with new MAIL cmd) on an existing TCP conn */
620 BOOL af_cert_verified:1; /* delivered with verified TLS cert */
621 BOOL af_pass_message:1; /* pass message in bounces */
622 BOOL af_bad_reply:1; /* filter could not generate autoreply */
623 BOOL af_tcp_fastopen_conn:1; /* delivery connection used TCP Fast Open */
624 BOOL af_tcp_fastopen:1; /* delivery usefully used TCP Fast Open */
625 BOOL af_tcp_fastopen_data:1; /* delivery sent SMTP commands on TCP Fast Open */
626 BOOL af_pipelining:1; /* delivery used (traditional) pipelining */
627 #ifndef DISABLE_PIPE_CONNECT
628 BOOL af_early_pipe:1; /* delivery used connect-time pipelining */
631 BOOL af_prdr_used:1; /* delivery used SMTP PRDR */
633 BOOL af_chunking_used:1; /* delivery used SMTP CHUNKING */
634 BOOL af_force_command:1; /* force_command in pipe transport */
636 BOOL af_dane_verified:1; /* TLS cert verify done with DANE */
639 BOOL af_utf8_downcvt:1; /* downconvert was done for delivery */
641 #ifndef DISABLE_TLS_RESUME
642 BOOL af_tls_resume:1; /* TLS used a resumed session */
646 unsigned int domain_cache[(MAX_NAMED_LIST * 2)/32];
647 unsigned int localpart_cache[(MAX_NAMED_LIST * 2)/32];
648 int mode; /* mode for local transporting to a file */
649 int basic_errno; /* status after failure */
650 int more_errno; /* additional error information */
651 struct timeval delivery_time; /* time taken to do delivery/attempt */
653 unsigned short child_count; /* number of child addresses */
654 short int return_file; /* fileno of return data file */
655 short int special_action; /* ( used when when deferred or failed */
657 /* ( contains = or - when successful SMTP delivered */
659 /* ( contains verify rc in sender verify cache */
660 short int transport_return; /* result of delivery attempt */
661 address_item_propagated prop; /* fields that are propagated to children */
664 /* The table of header names consists of items of this type */
673 /* Chain of information about errors (e.g. bad addresses) */
675 typedef struct error_block {
676 struct error_block *next;
681 /* Chain of file names when processing the queue */
683 typedef struct queue_filename {
684 struct queue_filename *next;
689 /* Chain of items of retry information, read from the retry config. */
691 typedef struct retry_rule {
692 struct retry_rule *next;
699 typedef struct retry_config {
700 struct retry_config *next;
708 /* Structure for each node in a tree, of which there are various kinds */
710 typedef struct tree_node {
711 struct tree_node *left; /* pointer to left child */
712 struct tree_node *right; /* pointer to right child */
715 void *ptr; /* pointer to data */
716 int val; /* or integer data */
718 uschar balance; /* balancing factor */
719 uschar name[1]; /* node name - variable length */
722 /* Structure for holding time-limited data such as DNS returns.
723 We use this rather than extending tree_node to avoid wasting
724 space for most tree use (variables...) at the cost of complexity
725 for the lookups cache.
726 We also store any options used for the lookup. */
728 typedef struct expiring_data {
729 time_t expiry; /* if nonzero, data invalid after this time */
730 const uschar * opts; /* options, or NULL */
733 void * ptr; /* pointer to data */
734 int val; /* or integer data */
738 /* Structure for holding the handle and the cached last lookup for searches.
739 This block is pointed to by the tree entry for the file. The file can get
740 closed if too many are opened at once. There is a LRU chain for deciding which
743 typedef struct search_cache {
744 void *handle; /* lookup handle, or NULL if closed */
745 const lookup_info * li; /* info struct for search type */
746 tree_node *up; /* LRU up pointer */
747 tree_node *down; /* LRU down pointer */
748 tree_node *item_cache; /* tree of cached results */
751 /* Structure for holding a partially decoded DNS record; the name has been
752 uncompressed, but the data pointer is into the raw data. */
755 uschar name[DNS_MAXNAME]; /* domain name */
756 int type; /* record type */
757 unsigned short ttl; /* time-to-live, seconds */
758 int size; /* size of data */
759 const uschar *data; /* pointer to data */
762 /* Structure for holding the result of a DNS query. A touch over
763 64k big, so take care to release as soon as possible. */
766 int answerlen; /* length of the answer */
767 uschar answer[NS_MAXMSG]; /* the answer itself */
770 /* Structure for holding the intermediate data while scanning a DNS answer
774 int rrcount; /* count of RRs in the answer */
775 const uschar *aptr; /* pointer in the answer while scanning */
776 dns_record srr; /* data from current record in scan */
779 /* Structure for holding a chain of IP addresses that are extracted from
780 an A, AAAA, or A6 record. For the first two, there is only ever one address,
781 but the chaining feature of A6 allows for several addresses to be realized from
782 a single initial A6 record. The structure defines the address field of length
783 1. In use, a suitable sized block is obtained to hold the complete textual
786 typedef struct dns_address {
787 struct dns_address *next;
791 /* Structure used for holding intermediate data during MD5 computations. */
795 unsigned int abcd[4];
799 /* Structure used for holding intermediate data during SHA-1 computations. */
801 typedef struct sha1 {
806 /* Information for making an smtp connection */
808 transport_instance * tblock;
809 void * ob; /* smtp_transport_options_block * */
814 int sock; /* used for a bound but not connected socket */
815 uschar * sending_ip_address; /* used for TLS resumption */
816 const uschar * host_lbserver; /* ditto, for server-behind LB */
817 BOOL have_lbserver:1; /* host_lbserver is valid */
820 BOOL dane:1; /* connection must do dane */
821 dns_answer tlsa_dnsa; /* strictly, this should use tainted mem */
825 /* A client-initiated connection. If TLS, the second element is non-NULL */
832 /* Structure used to hold incoming packets of SMTP responses for a specific
833 socket. The packets which may contain multiple lines (and in some cases,
834 multiple responses). */
836 typedef struct smtp_inblock {
837 client_conn_ctx * cctx; /* the connection */
838 int buffersize; /* the size of the buffer */
839 uschar *ptr; /* current position in the buffer */
840 uschar *ptrend; /* end of data in the buffer */
841 uschar *buffer; /* the buffer itself */
844 /* Structure used to hold buffered outgoing packets of SMTP commands for a
845 specific socket. The packets which may contain multiple lines when pipelining
848 typedef struct smtp_outblock {
849 client_conn_ctx * cctx; /* the connection */
850 int cmd_count; /* count of buffered commands */
851 int buffersize; /* the size of the buffer */
852 BOOL authenticating; /* TRUE when authenticating */
853 uschar *ptr; /* current position in the buffer */
854 uschar *buffer; /* the buffer itself */
856 smtp_connect_args * conn_args; /* to make connection, if not yet made */
859 /* Structure to hold information about the source of redirection information */
861 typedef struct redirect_block {
862 uschar *string; /* file name or string */
863 uid_t *owners; /* allowed file owners */
864 gid_t *owngroups; /* allowed file groups */
865 struct passwd *pw; /* possible owner if not NULL */
866 int modemask; /* forbidden bits */
867 BOOL isfile; /* TRUE if string is a file name */
868 BOOL check_owner; /* TRUE, FALSE, or TRUE_UNSET */
869 BOOL check_group; /* TRUE, FALSE, or TRUE_UNSET */
872 /* Sieve control data */
874 typedef struct sieve_block {
875 const uschar * inbox;
876 const uschar * enotify_mailto_owner;
877 const uschar * subaddress;
878 const uschar * useraddress;
879 const uschar * vacation_dir;
882 /* Structure for passing arguments to check_host() */
884 typedef struct check_host_block {
885 const uschar *host_name;
886 const uschar *host_address;
887 const uschar *host_ipv4;
891 /* Structure for remembering lookup data when caching the result of
892 a lookup in a named list. */
894 typedef struct namedlist_cacheblock {
895 struct namedlist_cacheblock *next;
898 } namedlist_cacheblock;
900 /* Structure for holding data for an entry in a named list */
902 typedef struct namedlist_block {
903 const uschar *string; /* the list string */
904 namedlist_cacheblock *cache_data; /* cached domain_data or localpart_data */
905 short number; /* the number of the list for caching */
906 BOOL hide; /* -bP does not display value */
909 /* Structures for Access Control Lists */
911 typedef struct acl_condition_block {
912 struct acl_condition_block * next;
919 } acl_condition_block;
921 typedef struct acl_block {
922 struct acl_block * next;
923 acl_condition_block * condition;
926 const uschar * srcfile;
929 /* smtp transport calc outbound_ip */
930 typedef BOOL (*oicf) (uschar *message_id, void *data);
932 /* DKIM information for transport */
935 uschar *dkim_identity;
936 uschar *dkim_private_key;
937 uschar *dkim_selector;
939 uschar *dkim_sign_headers;
942 uschar *dkim_timestamps;
945 #ifdef EXPERIMENTAL_ARC
946 uschar *arc_signspec;
951 /* per-queue-runner info */
952 typedef struct qrunner {
953 struct qrunner * next; /* list sorted by next tick */
955 uschar * name; /* NULL for the default queue */
956 unsigned interval; /* tick rate, seconds. Zero for a one-time run */
957 time_t next_tick; /* next run should, or should have, start(ed) */
958 unsigned run_max; /* concurrent queue runner limit */
959 unsigned run_count; /* current runners */
961 BOOL queue_run_force :1;
962 BOOL deliver_force_thaw :1;
963 BOOL queue_run_first_delivery :1;
964 BOOL queue_run_local :1;
965 BOOL queue_2stage :1;
969 /* Types of variable table entry */
972 vtype_int, /* value is address of int */
973 vtype_filter_int, /* ditto, but recognized only when filtering */
974 vtype_ino, /* value is address of ino_t (not always an int) */
975 vtype_uid, /* value is address of uid_t (not always an int) */
976 vtype_gid, /* value is address of gid_t (not always an int) */
977 vtype_bool, /* value is address of bool */
978 vtype_stringptr, /* value is address of pointer to string */
979 vtype_msgbody, /* as stringptr, but read when first required */
980 vtype_msgbody_end, /* ditto, the end of the message */
981 vtype_msgheaders, /* the message's headers, processed */
982 vtype_msgheaders_raw, /* the message's headers, unprocessed */
983 vtype_localpart, /* extract local part from string */
984 vtype_domain, /* extract domain from string */
985 vtype_string_func, /* value is string returned by given function */
986 vtype_todbsdin, /* value not used; generate BSD inbox tod */
987 vtype_tode, /* value not used; generate tod in epoch format */
988 vtype_todel, /* value not used; generate tod in epoch/usec format */
989 vtype_todf, /* value not used; generate full tod */
990 vtype_todl, /* value not used; generate log tod */
991 vtype_todlf, /* value not used; generate log file datestamp tod */
992 vtype_todzone, /* value not used; generate time zone only */
993 vtype_todzulu, /* value not used; generate zulu tod */
994 vtype_reply, /* value not used; get reply from headers */
995 vtype_pid, /* value not used; result is pid */
996 vtype_host_lookup, /* value not used; get host name */
997 vtype_load_avg, /* value not used; result is int from os_getloadavg */
998 vtype_pspace, /* partition space; value is T/F for spool/log */
999 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
1000 vtype_cert, /* SSL certificate */
1001 #ifndef DISABLE_DKIM
1002 vtype_dkim, /* Lookup of value in DKIM signature */
1004 vtype_module, /* variable lives in a module; value is module name */
1007 /* Type for main variable table */
1017 /* dynamic-load module info */
1019 typedef struct misc_module_info {
1020 struct misc_module_info * next;
1022 const uschar * name;
1024 BOOL (*init)(void *); /* arg is the misc_module_info ptr */
1025 gstring * (*lib_vers_report)(gstring *); /* underlying library */
1026 int (*conn_init)(const uschar *, const uschar *);
1027 void (*smtp_reset)(void);
1028 int (*msg_init)(void);
1031 unsigned options_count;
1033 unsigned functions_count;
1035 unsigned variables_count;
1038 #define MISC_MODULE_MAGIC 0x4d4d4d31 /* MMM1 */
1040 /* End of structs.h */