1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Definitions of various structures. In addition, those that are visible for
10 the compilation of local_scan() are defined in local_scan.h. These are
16 For those declared here, we have to pre-declare some because of mutually
17 recursive definitions in the auths, routers, and transports blocks. */
25 struct transport_info;
28 /* Structure for remembering macros for the configuration file */
30 typedef struct macro_item {
31 struct macro_item *next;
38 /* Structure for bit tables for debugging and logging */
40 typedef struct bit_table {
45 /* Block for holding a uid and gid, possibly unset, and an initgroups flag. */
47 typedef struct ugid_block {
55 typedef enum { CHUNKING_NOT_OFFERED = -1,
58 CHUNKING_LAST} chunking_state_t;
60 /* Structure for holding information about a host for use mainly by routers,
61 but also used when checking lists of hosts and when transporting. Looking up
62 host addresses is done using this structure. */
64 typedef enum {DS_UNK=-1, DS_NO, DS_YES} dnssec_status_t;
66 typedef struct host_item {
67 struct host_item *next;
68 const uschar *name; /* Host name */
69 const uschar *address; /* IP address in text form */
70 int port; /* port value in host order (if SRV lookup) */
71 int mx; /* MX value if found via MX records */
72 int sort_key; /* MX*1000 plus random "fraction" */
73 int status; /* Usable, unusable, or unknown */
74 int why; /* Why host is unusable */
75 int last_try; /* Time of last try if known */
76 dnssec_status_t dnssec;
79 /* Chain of rewrite rules, read from the rewrite config, or parsed from the
80 rewrite_headers field of a transport. */
82 typedef struct rewrite_rule {
83 struct rewrite_rule *next;
89 /* This structure is used to pass back configuration data from the smtp
90 transport to the outside world. It is used during callback processing. If ever
91 another remote transport were implemented, it could use the same structure. */
93 typedef struct transport_feedback {
100 BOOL hosts_randomize;
104 } transport_feedback;
106 /* Routers, transports, and authenticators have similar data blocks. Each
107 driver that is compiled into the code is represented by a xxx_info block; the
108 active drivers are represented by a chain of xxx_instance blocks. To make it
109 possible to use the same code for reading the configuration files for all
110 three, the layout of the start of the blocks is kept the same, and represented
111 by the generic structures driver_info and driver_instance. */
113 typedef struct driver_instance {
114 struct driver_instance *next;
115 uschar *name; /* Instance name */
116 struct driver_info *info; /* Points to info for this driver */
117 void *options_block; /* Pointer to private options */
118 uschar *driver_name; /* All start with this generic option */
121 typedef struct driver_info {
122 uschar *driver_name; /* Name of driver */
123 optionlist *options; /* Table of private options names */
124 int *options_count; /* -> Number of entries in table */
125 void *options_block; /* Points to default private block */
126 int options_len; /* Length of same in bytes */
127 void (*init)( /* Initialization entry point */
128 struct driver_instance *);
132 /* Structure for holding information about the configured transports. Some
133 of the generally accessible options are set from the configuration file; others
134 are set by transport initialization, since they can only be set for certain
135 transports. They need to be generally accessible, however, as they are used by
136 the main transport code. */
138 typedef struct transport_instance {
139 struct transport_instance *next;
140 uschar *name; /* Instance name */
141 struct transport_info *info; /* Info for this driver */
142 void *options_block; /* Pointer to private options */
143 uschar *driver_name; /* Must be first */
144 int (*setup)( /* Setup entry point */
145 struct transport_instance *,
146 struct address_item *,
147 struct transport_feedback *, /* For passing back config data */
148 uid_t, /* The uid that will be used */
149 gid_t, /* The gid that will be used */
150 uschar **); /* For an error message */
151 /**************************************/
152 int batch_max; /* ) */
153 uschar *batch_id; /* ) */
154 uschar *home_dir; /* ) Used only for local transports */
155 uschar *current_dir; /* ) */
156 /**************************************/
157 uschar *expand_multi_domain; /* ) */
158 BOOL multi_domain; /* ) */
159 BOOL overrides_hosts; /* ) Used only for remote transports */
160 int max_addresses; /* ) */
161 int connection_max_messages;/* ) */
162 /**************************************/
163 BOOL deliver_as_creator; /* Used only by pipe at present */
164 BOOL disable_logging; /* For very weird requirements */
165 BOOL initgroups; /* Initialize groups when setting uid */
166 BOOL uid_set; /* uid is set */
167 BOOL gid_set; /* gid is set */
170 uschar *expand_uid; /* Variable uid */
171 uschar *expand_gid; /* Variable gid */
172 uschar *warn_message; /* Used only by appendfile at present */
173 uschar *shadow; /* Name of shadow transport */
174 uschar *shadow_condition; /* Condition for running it */
175 uschar *filter_command; /* For on-the-fly-filtering */
176 uschar *add_headers; /* Add these headers */
177 uschar *remove_headers; /* Remove these headers */
178 uschar *return_path; /* Overriding (rewriting) return path */
179 uschar *debug_string; /* Debugging output */
180 uschar *max_parallel; /* Number of concurrent instances */
181 uschar *message_size_limit; /* Biggest message this transport handles */
182 uschar *headers_rewrite; /* Rules for rewriting headers */
183 rewrite_rule *rewrite_rules; /* Parsed rewriting rules */
184 int rewrite_existflags; /* Bits showing which headers are rewritten */
185 int filter_timeout; /* For transport filter timing */
186 BOOL body_only; /* Deliver only the body */
187 BOOL delivery_date_add; /* Add Delivery-Date header */
188 BOOL envelope_to_add; /* Add Envelope-To header */
189 BOOL headers_only; /* Deliver only the headers */
190 BOOL rcpt_include_affixes; /* TRUE to retain affixes in RCPT commands */
191 BOOL return_path_add; /* Add Return-Path header */
192 BOOL return_output; /* TRUE if output should always be returned */
193 BOOL return_fail_output; /* ditto, but only on failure */
194 BOOL log_output; /* Similarly for logging */
195 BOOL log_fail_output;
196 BOOL log_defer_output;
197 BOOL retry_use_local_part; /* Defaults true for local, false for remote */
198 #ifndef DISABLE_EVENT
199 uschar *event_action; /* String to expand on notable events */
201 } transport_instance;
204 /* Structure for holding information about a type of transport. The first six
205 fields must match driver_info above. */
207 typedef struct transport_info {
208 uschar *driver_name; /* Driver name */
209 optionlist *options; /* Table of private options names */
210 int *options_count; /* -> Number of entries in table */
211 void *options_block; /* Points to default private block */
212 int options_len; /* Length of same in bytes */
213 void (*init)( /* Initialization function */
214 struct transport_instance *);
216 BOOL (*code)( /* Main entry point */
217 transport_instance *,
218 struct address_item *);
219 void (*tidyup)( /* Tidyup function */
220 struct transport_instance *);
221 void (*closedown)( /* For closing down a passed channel */
222 struct transport_instance *);
223 BOOL local; /* TRUE for local transports */
227 /* smtp transport datachunk callback */
229 #define tc_reap_prev BIT(0) /* Flags: reap previous SMTP cmd responses */
230 #define tc_chunk_last BIT(1) /* annotate chunk SMTP cmd as LAST */
232 struct transport_context;
233 typedef int (*tpt_chunk_cmd_cb)(int fd, struct transport_context * tctx,
234 unsigned len, unsigned flags);
236 /* Structure for information about a delivery-in-progress */
238 typedef struct transport_context {
239 transport_instance * tblock; /* transport */
240 struct address_item * addr;
241 uschar * check_string; /* string replacement */
242 uschar * escape_string;
243 int options; /* output processing topt_* */
245 /* items below only used with option topt_use_bdat */
246 tpt_chunk_cmd_cb chunk_cb; /* per-datachunk callback */
257 /* Structure for holding information about the configured routers. */
259 typedef struct router_instance {
260 struct router_instance *next;
262 struct router_info *info;
263 void *options_block; /* Pointer to private options */
264 uschar *driver_name; /* Must be first */
266 uschar *address_data; /* Arbitrary data */
267 #ifdef EXPERIMENTAL_BRIGHTMAIL
268 uschar *bmi_rule; /* Brightmail AntiSpam rule checking */
270 uschar *cannot_route_message; /* Used when routing fails */
271 uschar *condition; /* General condition */
272 uschar *current_directory; /* For use during delivery */
273 uschar *debug_string; /* Debugging output */
274 uschar *domains; /* Specific domains */
275 uschar *errors_to; /* Errors address */
276 uschar *expand_gid; /* Expanded gid string */
277 uschar *expand_uid; /* Expanded uid string */
278 uschar *expand_more; /* Expanded more string */
279 uschar *expand_unseen; /* Expanded unseen string */
280 uschar *extra_headers; /* Additional headers */
281 uschar *fallback_hosts; /* For remote transports (text list) */
282 uschar *home_directory; /* For use during delivery */
283 uschar *ignore_target_hosts; /* Target hosts to ignore */
284 uschar *local_parts; /* Specific local parts */
285 uschar *pass_router_name; /* Router for passed address */
286 uschar *prefix; /* Address prefix */
287 uschar *redirect_router_name; /* Router for generated address */
288 uschar *remove_headers; /* Removed headers */
289 uschar *require_files; /* File checks before router is run */
290 uschar *router_home_directory; /* For use while routing */
291 uschar *self; /* Text option for handling self reference */
292 uschar *senders; /* Specific senders */
293 uschar *suffix; /* Address suffix */
294 uschar *translate_ip_address; /* IP address translation fudgery */
295 uschar *transport_name; /* Transport name */
297 BOOL address_test; /* Use this router when testing addresses */
298 #ifdef EXPERIMENTAL_BRIGHTMAIL
299 BOOL bmi_deliver_alternate; /* TRUE => BMI said that message should be delivered to alternate location */
300 BOOL bmi_deliver_default; /* TRUE => BMI said that message should be delivered to default location */
301 BOOL bmi_dont_deliver; /* TRUE => BMI said that message should not be delivered at all */
303 BOOL expn; /* Use this router when processing EXPN */
304 BOOL caseful_local_part; /* TRUE => don't lowercase */
305 BOOL check_local_user; /* TRUE => check local user */
306 BOOL disable_logging; /* For very weird requirements */
307 BOOL fail_verify_recipient; /* Fail verify if recipient match this router */
308 BOOL fail_verify_sender; /* Fail verify if sender match this router */
309 BOOL gid_set; /* Flag to indicate gid is set */
310 BOOL initgroups; /* TRUE if initgroups is required */
311 BOOL log_as_local; /* TRUE logs as a local delivery */
312 BOOL more; /* If FALSE, do no more if this one fails */
313 BOOL pass_on_timeout; /* Treat timeout DEFERs as fails */
314 BOOL prefix_optional; /* Just what it says */
315 BOOL repeat_use; /* If FALSE, skip if ancestor used it */
316 BOOL retry_use_local_part; /* Just what it says */
317 BOOL same_domain_copy_routing; /* TRUE => copy routing for same domain */
318 BOOL self_rewrite; /* TRUE to rewrite headers if making local */
319 BOOL suffix_optional; /* As it says */
320 BOOL verify_only; /* Skip this router if not verifying */
321 BOOL verify_recipient; /* Use this router when verifying a recipient*/
322 BOOL verify_sender; /* Use this router when verifying a sender */
323 BOOL uid_set; /* Flag to indicate uid is set */
324 BOOL unseen; /* If TRUE carry on, even after success */
325 BOOL dsn_lasthop; /* If TRUE, this router is a DSN endpoint */
327 int self_code; /* Encoded version of "self" */
328 uid_t uid; /* Fixed uid value */
329 gid_t gid; /* Fixed gid value */
331 host_item *fallback_hostlist; /* For remote transport (block chain) */
332 transport_instance *transport; /* Transport block (when found) */
333 struct router_instance *pass_router; /* Actual router for passed address */
334 struct router_instance *redirect_router; /* Actual router for generated address */
336 dnssec_domains dnssec;
340 /* Structure for holding information about a type of router. The first six
341 fields must match driver_info above. */
343 typedef struct router_info {
345 optionlist *options; /* Table of private options names */
346 int *options_count; /* -> Number of entries in table */
347 void *options_block; /* Points to default private block */
348 int options_len; /* Length of same in bytes */
349 void (*init)( /* Initialization function */
350 struct router_instance *);
352 int (*code)( /* Main entry point */
354 struct address_item *,
357 struct address_item **,
358 struct address_item **,
359 struct address_item **,
360 struct address_item **);
361 void (*tidyup)( /* Tidyup function */
362 struct router_instance *);
363 int ri_flags; /* Descriptive flags */
367 /* Structure for holding information about a lookup type. */
369 #include "lookupapi.h"
372 /* Structure for holding information about the configured authentication
375 typedef struct auth_instance {
376 struct auth_instance *next;
377 uschar *name; /* Exim instance name */
378 struct auth_info *info; /* Pointer to driver info block */
379 void *options_block; /* Pointer to private options */
380 uschar *driver_name; /* Must be first */
381 uschar *advertise_condition; /* Are we going to advertise this?*/
382 uschar *client_condition; /* Should the client try this? */
383 uschar *public_name; /* Advertised name */
384 uschar *set_id; /* String to set when server as authenticated id */
385 uschar *set_client_id; /* String to set when client as client_authenticated id */
386 uschar *mail_auth_condition; /* Condition for AUTH on MAIL command */
387 uschar *server_debug_string; /* Debugging output */
388 uschar *server_condition; /* Authorization condition */
389 BOOL client; /* TRUE if client option(s) set */
390 BOOL server; /* TRUE if server options(s) set */
391 BOOL advertised; /* Set TRUE when advertised */
395 /* Structure for holding information about an authentication mechanism. The
396 first six fields must match driver_info above. */
398 typedef struct auth_info {
399 uschar *driver_name; /* e.g. "condition" */
400 optionlist *options; /* Table of private options names */
401 int *options_count; /* -> Number of entries in table */
402 void *options_block; /* Points to default private block */
403 int options_len; /* Length of same in bytes */
404 void (*init)( /* initialization function */
405 struct auth_instance *);
407 int (*servercode)( /* server function */
408 auth_instance *, /* the instance data */
409 uschar *); /* rest of AUTH command */
410 int (*clientcode)( /* client function */
411 struct auth_instance *,
412 struct smtp_inblock *, /* socket and input buffer */
413 struct smtp_outblock *, /* socket and output buffer */
414 int, /* command timeout */
415 uschar *, /* buffer for reading response */
416 int); /* sizeof buffer */
417 void (*version_report)( /* diagnostic version reporting */
418 FILE *); /* I/O stream to print to */
422 /* Structure for holding a single IP address and port; used for the chain of
423 addresses and ports for the local host. Make the char string large enough to
424 hold an IPv6 address. */
426 typedef struct ip_address_item {
427 struct ip_address_item *next;
429 BOOL v6_include_v4; /* Used in the daemon */
433 /* Structure for chaining together arbitrary strings. */
435 typedef struct string_item {
436 struct string_item *next;
440 /* Information about a soft delivery failure, for use when calculating
441 retry information. It's separate from the address block, because there
442 can be a chain of them for SMTP deliveries where multiple IP addresses
445 typedef struct retry_item {
446 struct retry_item *next; /* for chaining */
447 uschar *key; /* string identifying host/address/message */
448 int basic_errno; /* error code for this destination */
449 int more_errno; /* additional error information */
450 uschar *message; /* local error message */
451 int flags; /* see below */
454 /* Retry data flags */
456 #define rf_delete 0x0001 /* retry info is to be deleted */
457 #define rf_host 0x0002 /* retry info is for a remote host */
458 #define rf_message 0x0004 /* retry info is for a host+message */
460 /* Information about a constructed message that is to be sent using the
461 autoreply transport. This is pointed to from the address block. */
463 typedef struct reply_item {
464 uschar *from; /* ) */
465 uschar *reply_to; /* ) */
467 uschar *cc; /* ) specific header fields */
469 uschar *subject; /* ) */
470 uschar *headers; /* misc other headers, concatenated */
471 uschar *text; /* text string body */
472 uschar *file; /* file body */
473 BOOL file_expand; /* expand the body */
474 int expand_forbid; /* expansion lockout flags */
475 uschar *logfile; /* file to keep a log in */
476 uschar *oncelog; /* file to keep records in for once only */
477 time_t once_repeat; /* time to repeat "once only" */
478 BOOL return_message; /* send back the original message */
482 /* The address_item structure contains many fields which are used at various
483 times while delivering a message. Some are used only for remote deliveries;
484 some only for local. A particular set of fields is copied whenever a child
485 address is created. For convenience, we keep those fields in a separate
486 sub-structure so they can be copied in one go. This also means I won't forget
487 to edit the various copying places when new to-be-copied fields are added. */
489 typedef struct address_item_propagated {
490 uschar *address_data; /* arbitrary data to keep with the address */
491 uschar *domain_data; /* from "domains" lookup */
492 uschar *localpart_data; /* from "local_parts" lookup */
493 uschar *errors_address; /* where to send errors (NULL => sender) */
494 header_line *extra_headers; /* additional headers */
495 uschar *remove_headers; /* list of those to remove */
497 #ifdef EXPERIMENTAL_SRS
498 uschar *srs_sender; /* Change return path when delivering */
501 BOOL utf8_msg:1; /* requires SMTPUTF8 processing */
502 BOOL utf8_downcvt:1; /* mandatory downconvert on delivery */
503 BOOL utf8_downcvt_maybe:1; /* optional downconvert on delivery */
505 } address_item_propagated;
507 /* Bits for the flags field below */
509 #define af_allow_file 0x00000001 /* allow file in generated address */
510 #define af_allow_pipe 0x00000002 /* allow pipe in generated address */
511 #define af_allow_reply 0x00000004 /* allow autoreply in generated address */
512 #define af_dr_retry_exists 0x00000008 /* router retry record exists */
513 #define af_expand_pipe 0x00000010 /* expand pipe arguments */
514 #define af_file 0x00000020 /* file delivery; always with pfr */
515 #define af_gid_set 0x00000040 /* gid field is set */
516 #define af_home_expanded 0x00000080 /* home_dir is already expanded */
517 #define af_ignore_error 0x00000100 /* ignore delivery error */
518 #define af_initgroups 0x00000200 /* use initgroups() for local transporting */
519 #define af_local_host_removed 0x00000400 /* local host was backup */
520 #define af_lt_retry_exists 0x00000800 /* local transport retry exists */
521 #define af_pfr 0x00001000 /* pipe or file or reply delivery */
522 #define af_retry_skipped 0x00002000 /* true if retry caused some skipping */
523 #define af_retry_timedout 0x00004000 /* true if retry timed out */
524 #define af_uid_set 0x00008000 /* uid field is set */
525 #define af_hide_child 0x00010000 /* hide child in bounce/defer msgs */
526 #define af_sverify_told 0x00020000 /* sender verify failure notified */
527 #define af_verify_pmfail 0x00040000 /* verify failure was postmaster callout */
528 #define af_verify_nsfail 0x00080000 /* verify failure was null sender callout */
529 #define af_homonym 0x00100000 /* an ancestor has same address */
530 #define af_verify_routed 0x00200000 /* for cached sender verify: routed OK */
531 #define af_verify_callout 0x00400000 /* for cached sender verify: callout was specified */
532 #define af_include_affixes 0x00800000 /* delivered with affixes in RCPT */
533 #define af_cert_verified 0x01000000 /* delivered with verified TLS cert */
534 #define af_pass_message 0x02000000 /* pass message in bounces */
535 #define af_bad_reply 0x04000000 /* filter could not generate autoreply */
537 # define af_prdr_used 0x08000000 /* delivery used SMTP PRDR */
539 #define af_chunking_used 0x10000000 /* delivery used SMTP CHUNKING */
540 #define af_force_command 0x20000000 /* force_command in pipe transport */
541 #ifdef EXPERIMENTAL_DANE
542 # define af_dane_verified 0x40000000 /* TLS cert verify done with DANE */
545 # define af_utf8_downcvt 0x80000000 /* downconvert was done for delivery */
548 /* These flags must be propagated when a child is created */
550 #define af_propagate (af_ignore_error)
552 /* The main address structure. Note that fields that are to be copied to
553 generated addresses should be put in the address_item_propagated structure (see
554 above) rather than directly into the address_item structure. */
556 typedef struct address_item {
557 struct address_item *next; /* for chaining addresses */
558 struct address_item *parent; /* parent address */
559 struct address_item *first; /* points to first after group delivery */
560 struct address_item *dupof; /* points to address this is a duplicate of */
562 router_instance *start_router; /* generated address starts here */
563 router_instance *router; /* the router that routed */
564 transport_instance *transport; /* the transport to use */
566 host_item *host_list; /* host data for the transport */
567 host_item *host_used; /* host that took delivery or failed hard */
568 host_item *fallback_hosts; /* to try if delivery defers */
570 reply_item *reply; /* data for autoreply */
571 retry_item *retries; /* chain of retry information */
573 uschar *address; /* address being delivered or routed */
574 uschar *unique; /* used for disambiguating */
575 uschar *cc_local_part; /* caseful local part */
576 uschar *lc_local_part; /* lowercased local part */
577 uschar *local_part; /* points to cc or lc version */
578 uschar *prefix; /* stripped prefix of local part */
579 uschar *suffix; /* stripped suffix of local part */
580 const uschar *domain; /* working domain (lower cased) */
582 uschar *address_retry_key; /* retry key including full address */
583 uschar *domain_retry_key; /* retry key for domain only */
585 uschar *current_dir; /* current directory for transporting */
586 uschar *home_dir; /* home directory for transporting */
587 uschar *message; /* error message */
588 uschar *user_message; /* error message that can be sent over SMTP
589 or quoted in bounce message */
590 uschar *onetime_parent; /* saved original parent for onetime */
591 uschar **pipe_expandn; /* numeric expansions for pipe from filter */
592 uschar *return_filename; /* name of return file */
593 uschar *self_hostname; /* after self=pass */
594 uschar *shadow_message; /* info about shadow transporting */
597 uschar *cipher; /* Cipher used for transport */
598 void *ourcert; /* Certificate offered to peer, binary */
599 void *peercert; /* Certificate from peer, binary */
600 uschar *peerdn; /* DN of server's certificate */
601 int ocsp; /* OCSP status of peer cert */
604 #ifdef EXPERIMENTAL_DSN_INFO
605 const uschar *smtp_greeting; /* peer self-identification */
606 const uschar *helo_response; /* peer message */
609 uschar *authenticator; /* auth driver name used by transport */
610 uschar *auth_id; /* auth "login" name used by transport */
611 uschar *auth_sndr; /* AUTH arg to SMTP MAIL, used by transport */
613 uschar *dsn_orcpt; /* DSN orcpt value */
614 int dsn_flags; /* DSN flags */
615 int dsn_aware; /* DSN aware flag */
617 uid_t uid; /* uid for transporting */
618 gid_t gid; /* gid for transporting */
620 unsigned int flags; /* a row of bits, defined above */
621 unsigned int domain_cache[(MAX_NAMED_LIST * 2)/32];
622 unsigned int localpart_cache[(MAX_NAMED_LIST * 2)/32];
623 int mode; /* mode for local transporting to a file */
624 int more_errno; /* additional error information */
625 /* (may need to hold a timestamp) */
627 short int basic_errno; /* status after failure */
628 short int child_count; /* number of child addresses */
629 short int return_file; /* fileno of return data file */
630 short int special_action; /* ( used when when deferred or failed */
632 /* ( contains = or - when successful SMTP delivered */
634 /* ( contains verify rc in sender verify cache */
635 short int transport_return; /* result of delivery attempt */
636 address_item_propagated prop; /* fields that are propagated to children */
639 /* The table of header names consists of items of this type */
648 /* Chain of information about errors (e.g. bad addresses) */
650 typedef struct error_block {
651 struct error_block *next;
656 /* Chain of file names when processing the queue */
658 typedef struct queue_filename {
659 struct queue_filename *next;
664 /* Chain of items of retry information, read from the retry config. */
666 typedef struct retry_rule {
667 struct retry_rule *next;
674 typedef struct retry_config {
675 struct retry_config *next;
683 /* Structure for each node in a tree, of which there are various kinds */
685 typedef struct tree_node {
686 struct tree_node *left; /* pointer to left child */
687 struct tree_node *right; /* pointer to right child */
690 void *ptr; /* pointer to data */
691 int val; /* or integer data */
693 uschar balance; /* balancing factor */
694 uschar name[1]; /* node name - variable length */
697 /* Structure for holding time-limited data such as DNS returns.
698 We use this rather than extending tree_node to avoid wasting
699 space for most tree use (variables...) at the cost of complexity
700 for the lookups cache */
702 typedef struct expiring_data {
703 time_t expiry; /* if nonzero, data invalid after this time */
704 void *ptr; /* pointer to data */
707 /* Structure for holding the handle and the cached last lookup for searches.
708 This block is pointed to by the tree entry for the file. The file can get
709 closed if too many are opened at once. There is a LRU chain for deciding which
712 typedef struct search_cache {
713 void *handle; /* lookup handle, or NULL if closed */
714 int search_type; /* search type */
715 tree_node *up; /* LRU up pointer */
716 tree_node *down; /* LRU down pointer */
717 tree_node *item_cache; /* tree of cached results */
720 /* Structure for holding a partially decoded DNS record; the name has been
721 uncompressed, but the data pointer is into the raw data. */
724 uschar name[DNS_MAXNAME]; /* domain name */
725 int type; /* record type */
726 unsigned short ttl; /* time-to-live, seconds */
727 int size; /* size of data */
728 const uschar *data; /* pointer to data */
731 /* Structure for holding the result of a DNS query. */
734 int answerlen; /* length of the answer */
735 uschar answer[MAXPACKET]; /* the answer itself */
738 /* Structure for holding the intermediate data while scanning a DNS answer
742 int rrcount; /* count of RRs in the answer */
743 const uschar *aptr; /* pointer in the answer while scanning */
744 dns_record srr; /* data from current record in scan */
747 /* Structure for holding a chain of IP addresses that are extracted from
748 an A, AAAA, or A6 record. For the first two, there is only ever one address,
749 but the chaining feature of A6 allows for several addresses to be realized from
750 a single initial A6 record. The structure defines the address field of length
751 1. In use, a suitable sized block is obtained to hold the complete textual
754 typedef struct dns_address {
755 struct dns_address *next;
759 /* Structure used for holding intermediate data during MD5 computations. */
763 unsigned int abcd[4];
767 /* Structure used for holding intermediate data during SHA-1 computations. */
769 typedef struct sha1 {
775 /* Structure used to hold incoming packets of SMTP responses for a specific
776 socket. The packets which may contain multiple lines (and in some cases,
777 multiple responses). */
779 typedef struct smtp_inblock {
780 int sock; /* the socket */
781 int buffersize; /* the size of the buffer */
782 uschar *ptr; /* current position in the buffer */
783 uschar *ptrend; /* end of data in the buffer */
784 uschar *buffer; /* the buffer itself */
787 /* Structure used to hold buffered outgoing packets of SMTP commands for a
788 specific socket. The packets which may contain multiple lines when pipelining
791 typedef struct smtp_outblock {
792 int sock; /* the socket */
793 int cmd_count; /* count of buffered commands */
794 int buffersize; /* the size of the buffer */
795 BOOL authenticating; /* TRUE when authenticating */
796 uschar *ptr; /* current position in the buffer */
797 uschar *buffer; /* the buffer itself */
800 /* Structure to hold information about the source of redirection information */
802 typedef struct redirect_block {
803 uschar *string; /* file name or string */
804 uid_t *owners; /* allowed file owners */
805 gid_t *owngroups; /* allowed file groups */
806 struct passwd *pw; /* possible owner if not NULL */
807 int modemask; /* forbidden bits */
808 BOOL isfile; /* TRUE if string is a file name */
809 BOOL check_owner; /* TRUE, FALSE, or TRUE_UNSET */
810 BOOL check_group; /* TRUE, FALSE, or TRUE_UNSET */
813 /* Structure for passing arguments to check_host() */
815 typedef struct check_host_block {
816 const uschar *host_name;
817 const uschar *host_address;
818 const uschar *host_ipv4;
822 /* Structure for remembering lookup data when caching the result of
823 a lookup in a named list. */
825 typedef struct namedlist_cacheblock {
826 struct namedlist_cacheblock *next;
829 } namedlist_cacheblock;
831 /* Structure for holding data for an entry in a named list */
833 typedef struct namedlist_block {
834 const uschar *string; /* the list string */
835 namedlist_cacheblock *cache_data; /* cached domain_data or localpart_data */
836 int number; /* the number of the list for caching */
839 /* Structures for Access Control Lists */
841 typedef struct acl_condition_block {
842 struct acl_condition_block *next;
849 } acl_condition_block;
851 typedef struct acl_block {
852 struct acl_block *next;
853 acl_condition_block *condition;
857 /* smtp transport calc outbound_ip */
858 typedef BOOL (*oicf) (uschar *message_id, void *data);
860 /* DKIM information for transport */
863 uschar *dkim_private_key;
864 uschar *dkim_selector;
866 uschar *dkim_sign_headers;
871 /* End of structs.h */