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;
37 /* Structure for bit tables for debugging and logging */
39 typedef struct bit_table {
44 /* Block for holding a uid and gid, possibly unset, and an initgroups flag. */
46 typedef struct ugid_block {
54 typedef enum { CHUNKING_NOT_OFFERED = -1,
57 CHUNKING_LAST} chunking_state_t;
59 /* Structure for holding information about a host for use mainly by routers,
60 but also used when checking lists of hosts and when transporting. Looking up
61 host addresses is done using this structure. */
63 typedef enum {DS_UNK=-1, DS_NO, DS_YES} dnssec_status_t;
65 typedef struct host_item {
66 struct host_item *next;
67 const uschar *name; /* Host name */
68 const uschar *address; /* IP address in text form */
69 int port; /* port value in host order (if SRV lookup) */
70 int mx; /* MX value if found via MX records */
71 int sort_key; /* MX*1000 plus random "fraction" */
72 int status; /* Usable, unusable, or unknown */
73 int why; /* Why host is unusable */
74 int last_try; /* Time of last try if known */
75 dnssec_status_t dnssec;
78 /* Chain of rewrite rules, read from the rewrite config, or parsed from the
79 rewrite_headers field of a transport. */
81 typedef struct rewrite_rule {
82 struct rewrite_rule *next;
88 /* This structure is used to pass back configuration data from the smtp
89 transport to the outside world. It is used during callback processing. If ever
90 another remote transport were implemented, it could use the same structure. */
92 typedef struct transport_feedback {
103 } transport_feedback;
105 /* Routers, transports, and authenticators have similar data blocks. Each
106 driver that is compiled into the code is represented by a xxx_info block; the
107 active drivers are represented by a chain of xxx_instance blocks. To make it
108 possible to use the same code for reading the configuration files for all
109 three, the layout of the start of the blocks is kept the same, and represented
110 by the generic structures driver_info and driver_instance. */
112 typedef struct driver_instance {
113 struct driver_instance *next;
114 uschar *name; /* Instance name */
115 struct driver_info *info; /* Points to info for this driver */
116 void *options_block; /* Pointer to private options */
117 uschar *driver_name; /* All start with this generic option */
120 typedef struct driver_info {
121 uschar *driver_name; /* Name of driver */
122 optionlist *options; /* Table of private options names */
123 int *options_count; /* -> Number of entries in table */
124 void *options_block; /* Points to default private block */
125 int options_len; /* Length of same in bytes */
126 void (*init)( /* Initialization entry point */
127 struct driver_instance *);
131 /* Structure for holding information about the configured transports. Some
132 of the generally accessible options are set from the configuration file; others
133 are set by transport initialization, since they can only be set for certain
134 transports. They need to be generally accessible, however, as they are used by
135 the main transport code. */
137 typedef struct transport_instance {
138 struct transport_instance *next;
139 uschar *name; /* Instance name */
140 struct transport_info *info; /* Info for this driver */
141 void *options_block; /* Pointer to private options */
142 uschar *driver_name; /* Must be first */
143 int (*setup)( /* Setup entry point */
144 struct transport_instance *,
145 struct address_item *,
146 struct transport_feedback *, /* For passing back config data */
147 uid_t, /* The uid that will be used */
148 gid_t, /* The gid that will be used */
149 uschar **); /* For an error message */
150 /**************************************/
151 int batch_max; /* ) */
152 uschar *batch_id; /* ) */
153 uschar *home_dir; /* ) Used only for local transports */
154 uschar *current_dir; /* ) */
155 /**************************************/
156 uschar *expand_multi_domain; /* ) */
157 BOOL multi_domain; /* ) */
158 BOOL overrides_hosts; /* ) Used only for remote transports */
159 int max_addresses; /* ) */
160 int connection_max_messages;/* ) */
161 /**************************************/
162 BOOL deliver_as_creator; /* Used only by pipe at present */
163 BOOL disable_logging; /* For very weird requirements */
164 BOOL initgroups; /* Initialize groups when setting uid */
165 BOOL uid_set; /* uid is set */
166 BOOL gid_set; /* gid is set */
169 uschar *expand_uid; /* Variable uid */
170 uschar *expand_gid; /* Variable gid */
171 uschar *warn_message; /* Used only by appendfile at present */
172 uschar *shadow; /* Name of shadow transport */
173 uschar *shadow_condition; /* Condition for running it */
174 uschar *filter_command; /* For on-the-fly-filtering */
175 uschar *add_headers; /* Add these headers */
176 uschar *remove_headers; /* Remove these headers */
177 uschar *return_path; /* Overriding (rewriting) return path */
178 uschar *debug_string; /* Debugging output */
179 uschar *max_parallel; /* Number of concurrent instances */
180 uschar *message_size_limit; /* Biggest message this transport handles */
181 uschar *headers_rewrite; /* Rules for rewriting headers */
182 rewrite_rule *rewrite_rules; /* Parsed rewriting rules */
183 int rewrite_existflags; /* Bits showing which headers are rewritten */
184 int filter_timeout; /* For transport filter timing */
185 BOOL body_only; /* Deliver only the body */
186 BOOL delivery_date_add; /* Add Delivery-Date header */
187 BOOL envelope_to_add; /* Add Envelope-To header */
188 BOOL headers_only; /* Deliver only the headers */
189 BOOL rcpt_include_affixes; /* TRUE to retain affixes in RCPT commands */
190 BOOL return_path_add; /* Add Return-Path header */
191 BOOL return_output; /* TRUE if output should always be returned */
192 BOOL return_fail_output; /* ditto, but only on failure */
193 BOOL log_output; /* Similarly for logging */
194 BOOL log_fail_output;
195 BOOL log_defer_output;
196 BOOL retry_use_local_part; /* Defaults true for local, false for remote */
197 #ifndef DISABLE_EVENT
198 uschar *event_action; /* String to expand on notable events */
200 } transport_instance;
203 /* Structure for holding information about a type of transport. The first six
204 fields must match driver_info above. */
206 typedef struct transport_info {
207 uschar *driver_name; /* Driver name */
208 optionlist *options; /* Table of private options names */
209 int *options_count; /* -> Number of entries in table */
210 void *options_block; /* Points to default private block */
211 int options_len; /* Length of same in bytes */
212 void (*init)( /* Initialization function */
213 struct transport_instance *);
215 BOOL (*code)( /* Main entry point */
216 transport_instance *,
217 struct address_item *);
218 void (*tidyup)( /* Tidyup function */
219 struct transport_instance *);
220 void (*closedown)( /* For closing down a passed channel */
221 struct transport_instance *);
222 BOOL local; /* TRUE for local transports */
226 /* smtp transport datachunk callback */
228 struct transport_context;
229 typedef int (*tpt_chunk_cmd_cb)(int fd, struct transport_context * tctx,
230 unsigned len, BOOL last);
232 /* Structure for information about a delivery-in-progress */
234 typedef struct transport_context {
235 transport_instance * tblock; /* transport */
236 struct address_item * addr;
237 uschar * check_string; /* string replacement */
238 uschar * escape_string;
239 int options; /* output processing topt_* */
241 /* items below only used with option topt_use_bdat */
242 tpt_chunk_cmd_cb chunk_cb; /* per-datachunk callback */
243 struct smtp_inblock * inblock;
244 struct smtp_outblock * outblock;
246 struct address_item * first_addr;
247 struct address_item **sync_addr;
249 BOOL * completed_address;
260 /* Structure for holding information about the configured routers. */
262 typedef struct router_instance {
263 struct router_instance *next;
265 struct router_info *info;
266 void *options_block; /* Pointer to private options */
267 uschar *driver_name; /* Must be first */
269 uschar *address_data; /* Arbitrary data */
270 #ifdef EXPERIMENTAL_BRIGHTMAIL
271 uschar *bmi_rule; /* Brightmail AntiSpam rule checking */
273 uschar *cannot_route_message; /* Used when routing fails */
274 uschar *condition; /* General condition */
275 uschar *current_directory; /* For use during delivery */
276 uschar *debug_string; /* Debugging output */
277 uschar *domains; /* Specific domains */
278 uschar *errors_to; /* Errors address */
279 uschar *expand_gid; /* Expanded gid string */
280 uschar *expand_uid; /* Expanded uid string */
281 uschar *expand_more; /* Expanded more string */
282 uschar *expand_unseen; /* Expanded unseen string */
283 uschar *extra_headers; /* Additional headers */
284 uschar *fallback_hosts; /* For remote transports (text list) */
285 uschar *home_directory; /* For use during delivery */
286 uschar *ignore_target_hosts; /* Target hosts to ignore */
287 uschar *local_parts; /* Specific local parts */
288 uschar *pass_router_name; /* Router for passed address */
289 uschar *prefix; /* Address prefix */
290 uschar *redirect_router_name; /* Router for generated address */
291 uschar *remove_headers; /* Removed headers */
292 uschar *require_files; /* File checks before router is run */
293 uschar *router_home_directory; /* For use while routing */
294 uschar *self; /* Text option for handling self reference */
295 uschar *senders; /* Specific senders */
296 uschar *suffix; /* Address suffix */
297 uschar *translate_ip_address; /* IP address translation fudgery */
298 uschar *transport_name; /* Transport name */
300 BOOL address_test; /* Use this router when testing addresses */
301 #ifdef EXPERIMENTAL_BRIGHTMAIL
302 BOOL bmi_deliver_alternate; /* TRUE => BMI said that message should be delivered to alternate location */
303 BOOL bmi_deliver_default; /* TRUE => BMI said that message should be delivered to default location */
304 BOOL bmi_dont_deliver; /* TRUE => BMI said that message should not be delivered at all */
306 BOOL expn; /* Use this router when processing EXPN */
307 BOOL caseful_local_part; /* TRUE => don't lowercase */
308 BOOL check_local_user; /* TRUE => check local user */
309 BOOL disable_logging; /* For very weird requirements */
310 BOOL fail_verify_recipient; /* Fail verify if recipient match this router */
311 BOOL fail_verify_sender; /* Fail verify if sender match this router */
312 BOOL gid_set; /* Flag to indicate gid is set */
313 BOOL initgroups; /* TRUE if initgroups is required */
314 BOOL log_as_local; /* TRUE logs as a local delivery */
315 BOOL more; /* If FALSE, do no more if this one fails */
316 BOOL pass_on_timeout; /* Treat timeout DEFERs as fails */
317 BOOL prefix_optional; /* Just what it says */
318 BOOL repeat_use; /* If FALSE, skip if ancestor used it */
319 BOOL retry_use_local_part; /* Just what it says */
320 BOOL same_domain_copy_routing; /* TRUE => copy routing for same domain */
321 BOOL self_rewrite; /* TRUE to rewrite headers if making local */
322 BOOL suffix_optional; /* As it says */
323 BOOL verify_only; /* Skip this router if not verifying */
324 BOOL verify_recipient; /* Use this router when verifying a recipient*/
325 BOOL verify_sender; /* Use this router when verifying a sender */
326 BOOL uid_set; /* Flag to indicate uid is set */
327 BOOL unseen; /* If TRUE carry on, even after success */
328 BOOL dsn_lasthop; /* If TRUE, this router is a DSN endpoint */
330 int self_code; /* Encoded version of "self" */
331 uid_t uid; /* Fixed uid value */
332 gid_t gid; /* Fixed gid value */
334 host_item *fallback_hostlist; /* For remote transport (block chain) */
335 transport_instance *transport; /* Transport block (when found) */
336 struct router_instance *pass_router; /* Actual router for passed address */
337 struct router_instance *redirect_router; /* Actual router for generated address */
339 dnssec_domains dnssec;
343 /* Structure for holding information about a type of router. The first six
344 fields must match driver_info above. */
346 typedef struct router_info {
348 optionlist *options; /* Table of private options names */
349 int *options_count; /* -> Number of entries in table */
350 void *options_block; /* Points to default private block */
351 int options_len; /* Length of same in bytes */
352 void (*init)( /* Initialization function */
353 struct router_instance *);
355 int (*code)( /* Main entry point */
357 struct address_item *,
360 struct address_item **,
361 struct address_item **,
362 struct address_item **,
363 struct address_item **);
364 void (*tidyup)( /* Tidyup function */
365 struct router_instance *);
366 int ri_flags; /* Descriptive flags */
370 /* Structure for holding information about a lookup type. */
372 #include "lookupapi.h"
375 /* Structure for holding information about the configured authentication
378 typedef struct auth_instance {
379 struct auth_instance *next;
380 uschar *name; /* Exim instance name */
381 struct auth_info *info; /* Pointer to driver info block */
382 void *options_block; /* Pointer to private options */
383 uschar *driver_name; /* Must be first */
384 uschar *advertise_condition; /* Are we going to advertise this?*/
385 uschar *client_condition; /* Should the client try this? */
386 uschar *public_name; /* Advertised name */
387 uschar *set_id; /* String to set when server as authenticated id */
388 uschar *set_client_id; /* String to set when client as client_authenticated id */
389 uschar *mail_auth_condition; /* Condition for AUTH on MAIL command */
390 uschar *server_debug_string; /* Debugging output */
391 uschar *server_condition; /* Authorization condition */
392 BOOL client; /* TRUE if client option(s) set */
393 BOOL server; /* TRUE if server options(s) set */
394 BOOL advertised; /* Set TRUE when advertised */
398 /* Structure for holding information about an authentication mechanism. The
399 first six fields must match driver_info above. */
401 typedef struct auth_info {
402 uschar *driver_name; /* e.g. "condition" */
403 optionlist *options; /* Table of private options names */
404 int *options_count; /* -> Number of entries in table */
405 void *options_block; /* Points to default private block */
406 int options_len; /* Length of same in bytes */
407 void (*init)( /* initialization function */
408 struct auth_instance *);
410 int (*servercode)( /* server function */
411 auth_instance *, /* the instance data */
412 uschar *); /* rest of AUTH command */
413 int (*clientcode)( /* client function */
414 struct auth_instance *,
415 struct smtp_inblock *, /* socket and input buffer */
416 struct smtp_outblock *, /* socket and output buffer */
417 int, /* command timeout */
418 uschar *, /* buffer for reading response */
419 int); /* sizeof buffer */
420 void (*version_report)( /* diagnostic version reporting */
421 FILE *); /* I/O stream to print to */
425 /* Structure for holding a single IP address and port; used for the chain of
426 addresses and ports for the local host. Make the char string large enough to
427 hold an IPv6 address. */
429 typedef struct ip_address_item {
430 struct ip_address_item *next;
432 BOOL v6_include_v4; /* Used in the daemon */
436 /* Structure for chaining together arbitrary strings. */
438 typedef struct string_item {
439 struct string_item *next;
443 /* Information about a soft delivery failure, for use when calculating
444 retry information. It's separate from the address block, because there
445 can be a chain of them for SMTP deliveries where multiple IP addresses
448 typedef struct retry_item {
449 struct retry_item *next; /* for chaining */
450 uschar *key; /* string identifying host/address/message */
451 int basic_errno; /* error code for this destination */
452 int more_errno; /* additional error information */
453 uschar *message; /* local error message */
454 int flags; /* see below */
457 /* Retry data flags */
459 #define rf_delete 0x0001 /* retry info is to be deleted */
460 #define rf_host 0x0002 /* retry info is for a remote host */
461 #define rf_message 0x0004 /* retry info is for a host+message */
463 /* Information about a constructed message that is to be sent using the
464 autoreply transport. This is pointed to from the address block. */
466 typedef struct reply_item {
467 uschar *from; /* ) */
468 uschar *reply_to; /* ) */
470 uschar *cc; /* ) specific header fields */
472 uschar *subject; /* ) */
473 uschar *headers; /* misc other headers, concatenated */
474 uschar *text; /* text string body */
475 uschar *file; /* file body */
476 BOOL file_expand; /* expand the body */
477 int expand_forbid; /* expansion lockout flags */
478 uschar *logfile; /* file to keep a log in */
479 uschar *oncelog; /* file to keep records in for once only */
480 time_t once_repeat; /* time to repeat "once only" */
481 BOOL return_message; /* send back the original message */
485 /* The address_item structure contains many fields which are used at various
486 times while delivering a message. Some are used only for remote deliveries;
487 some only for local. A particular set of fields is copied whenever a child
488 address is created. For convenience, we keep those fields in a separate
489 sub-structure so they can be copied in one go. This also means I won't forget
490 to edit the various copying places when new to-be-copied fields are added. */
492 typedef struct address_item_propagated {
493 uschar *address_data; /* arbitrary data to keep with the address */
494 uschar *domain_data; /* from "domains" lookup */
495 uschar *localpart_data; /* from "local_parts" lookup */
496 uschar *errors_address; /* where to send errors (NULL => sender) */
497 header_line *extra_headers; /* additional headers */
498 uschar *remove_headers; /* list of those to remove */
500 #ifdef EXPERIMENTAL_SRS
501 uschar *srs_sender; /* Change return path when delivering */
504 BOOL utf8_msg:1; /* requires SMTPUTF8 processing */
505 BOOL utf8_downcvt:1; /* mandatory downconvert on delivery */
506 BOOL utf8_downcvt_maybe:1; /* optional downconvert on delivery */
508 } address_item_propagated;
510 /* Bits for the flags field below */
512 #define af_allow_file 0x00000001 /* allow file in generated address */
513 #define af_allow_pipe 0x00000002 /* allow pipe in generated address */
514 #define af_allow_reply 0x00000004 /* allow autoreply in generated address */
515 #define af_dr_retry_exists 0x00000008 /* router retry record exists */
516 #define af_expand_pipe 0x00000010 /* expand pipe arguments */
517 #define af_file 0x00000020 /* file delivery; always with pfr */
518 #define af_gid_set 0x00000040 /* gid field is set */
519 #define af_home_expanded 0x00000080 /* home_dir is already expanded */
520 #define af_ignore_error 0x00000100 /* ignore delivery error */
521 #define af_initgroups 0x00000200 /* use initgroups() for local transporting */
522 #define af_local_host_removed 0x00000400 /* local host was backup */
523 #define af_lt_retry_exists 0x00000800 /* local transport retry exists */
524 #define af_pfr 0x00001000 /* pipe or file or reply delivery */
525 #define af_retry_skipped 0x00002000 /* true if retry caused some skipping */
526 #define af_retry_timedout 0x00004000 /* true if retry timed out */
527 #define af_uid_set 0x00008000 /* uid field is set */
528 #define af_hide_child 0x00010000 /* hide child in bounce/defer msgs */
529 #define af_sverify_told 0x00020000 /* sender verify failure notified */
530 #define af_verify_pmfail 0x00040000 /* verify failure was postmaster callout */
531 #define af_verify_nsfail 0x00080000 /* verify failure was null sender callout */
532 #define af_homonym 0x00100000 /* an ancestor has same address */
533 #define af_verify_routed 0x00200000 /* for cached sender verify: routed OK */
534 #define af_verify_callout 0x00400000 /* for cached sender verify: callout was specified */
535 #define af_include_affixes 0x00800000 /* delivered with affixes in RCPT */
536 #define af_cert_verified 0x01000000 /* delivered with verified TLS cert */
537 #define af_pass_message 0x02000000 /* pass message in bounces */
538 #define af_bad_reply 0x04000000 /* filter could not generate autoreply */
540 # define af_prdr_used 0x08000000 /* delivery used SMTP PRDR */
542 #define af_force_command 0x10000000 /* force_command in pipe transport */
543 #ifdef EXPERIMENTAL_DANE
544 # define af_dane_verified 0x20000000 /* TLS cert verify done with DANE */
547 # define af_utf8_downcvt 0x40000000 /* downconvert was done for delivery */
550 /* These flags must be propagated when a child is created */
552 #define af_propagate (af_ignore_error)
554 /* The main address structure. Note that fields that are to be copied to
555 generated addresses should be put in the address_item_propagated structure (see
556 above) rather than directly into the address_item structure. */
558 typedef struct address_item {
559 struct address_item *next; /* for chaining addresses */
560 struct address_item *parent; /* parent address */
561 struct address_item *first; /* points to first after group delivery */
562 struct address_item *dupof; /* points to address this is a duplicate of */
564 router_instance *start_router; /* generated address starts here */
565 router_instance *router; /* the router that routed */
566 transport_instance *transport; /* the transport to use */
568 host_item *host_list; /* host data for the transport */
569 host_item *host_used; /* host that took delivery or failed hard */
570 host_item *fallback_hosts; /* to try if delivery defers */
572 reply_item *reply; /* data for autoreply */
573 retry_item *retries; /* chain of retry information */
575 uschar *address; /* address being delivered or routed */
576 uschar *unique; /* used for disambiguating */
577 uschar *cc_local_part; /* caseful local part */
578 uschar *lc_local_part; /* lowercased local part */
579 uschar *local_part; /* points to cc or lc version */
580 uschar *prefix; /* stripped prefix of local part */
581 uschar *suffix; /* stripped suffix of local part */
582 const uschar *domain; /* working domain (lower cased) */
584 uschar *address_retry_key; /* retry key including full address */
585 uschar *domain_retry_key; /* retry key for domain only */
587 uschar *current_dir; /* current directory for transporting */
588 uschar *home_dir; /* home directory for transporting */
589 uschar *message; /* error message */
590 uschar *user_message; /* error message that can be sent over SMTP
591 or quoted in bounce message */
592 uschar *onetime_parent; /* saved original parent for onetime */
593 uschar **pipe_expandn; /* numeric expansions for pipe from filter */
594 uschar *return_filename; /* name of return file */
595 uschar *self_hostname; /* after self=pass */
596 uschar *shadow_message; /* info about shadow transporting */
599 uschar *cipher; /* Cipher used for transport */
600 void *ourcert; /* Certificate offered to peer, binary */
601 void *peercert; /* Certificate from peer, binary */
602 uschar *peerdn; /* DN of server's certificate */
603 int ocsp; /* OCSP status of peer cert */
606 #ifdef EXPERIMENTAL_DSN_INFO
607 const uschar *smtp_greeting; /* peer self-identification */
608 const uschar *helo_response; /* peer message */
611 uschar *authenticator; /* auth driver name used by transport */
612 uschar *auth_id; /* auth "login" name used by transport */
613 uschar *auth_sndr; /* AUTH arg to SMTP MAIL, used by transport */
615 uschar *dsn_orcpt; /* DSN orcpt value */
616 int dsn_flags; /* DSN flags */
617 int dsn_aware; /* DSN aware flag */
619 uid_t uid; /* uid for transporting */
620 gid_t gid; /* gid for transporting */
622 unsigned int flags; /* a row of bits, defined above */
623 unsigned int domain_cache[(MAX_NAMED_LIST * 2)/32];
624 unsigned int localpart_cache[(MAX_NAMED_LIST * 2)/32];
625 int mode; /* mode for local transporting to a file */
626 int more_errno; /* additional error information */
627 /* (may need to hold a timestamp) */
629 short int basic_errno; /* status after failure */
630 short int child_count; /* number of child addresses */
631 short int return_file; /* fileno of return data file */
632 short int special_action; /* ( used when when deferred or failed */
634 /* ( contains = or - when successful SMTP delivered */
636 /* ( contains verify rc in sender verify cache */
637 short int transport_return; /* result of delivery attempt */
638 address_item_propagated prop; /* fields that are propagated to children */
641 /* The table of header names consists of items of this type */
650 /* Chain of information about errors (e.g. bad addresses) */
652 typedef struct error_block {
653 struct error_block *next;
658 /* Chain of file names when processing the queue */
660 typedef struct queue_filename {
661 struct queue_filename *next;
666 /* Chain of items of retry information, read from the retry config. */
668 typedef struct retry_rule {
669 struct retry_rule *next;
676 typedef struct retry_config {
677 struct retry_config *next;
685 /* Structure for each node in a tree, of which there are various kinds */
687 typedef struct tree_node {
688 struct tree_node *left; /* pointer to left child */
689 struct tree_node *right; /* pointer to right child */
692 void *ptr; /* pointer to data */
693 int val; /* or integer data */
695 uschar balance; /* balancing factor */
696 uschar name[1]; /* node name - variable length */
699 /* Structure for holding time-limited data such as DNS returns.
700 We use this rather than extending tree_node to avoid wasting
701 space for most tree use (variables...) at the cost of complexity
702 for the lookups cache */
704 typedef struct expiring_data {
705 time_t expiry; /* if nonzero, data invalid after this time */
706 void *ptr; /* pointer to data */
709 /* Structure for holding the handle and the cached last lookup for searches.
710 This block is pointed to by the tree entry for the file. The file can get
711 closed if too many are opened at once. There is a LRU chain for deciding which
714 typedef struct search_cache {
715 void *handle; /* lookup handle, or NULL if closed */
716 int search_type; /* search type */
717 tree_node *up; /* LRU up pointer */
718 tree_node *down; /* LRU down pointer */
719 tree_node *item_cache; /* tree of cached results */
722 /* Structure for holding a partially decoded DNS record; the name has been
723 uncompressed, but the data pointer is into the raw data. */
726 uschar name[DNS_MAXNAME]; /* domain name */
727 int type; /* record type */
728 unsigned short ttl; /* time-to-live, seconds */
729 int size; /* size of data */
730 uschar *data; /* pointer to data */
733 /* Structure for holding the result of a DNS query. */
736 int answerlen; /* length of the answer */
737 uschar answer[MAXPACKET]; /* the answer itself */
740 /* Structure for holding the intermediate data while scanning a DNS answer
744 int rrcount; /* count of RRs in the answer */
745 uschar *aptr; /* pointer in the answer while scanning */
746 dns_record srr; /* data from current record in scan */
749 /* Structure for holding a chain of IP addresses that are extracted from
750 an A, AAAA, or A6 record. For the first two, there is only ever one address,
751 but the chaining feature of A6 allows for several addresses to be realized from
752 a single initial A6 record. The structure defines the address field of length
753 1. In use, a suitable sized block is obtained to hold the complete textual
756 typedef struct dns_address {
757 struct dns_address *next;
761 /* Structure used for holding intermediate data during MD5 computations. */
765 unsigned int abcd[4];
769 /* Structure used for holding intermediate data during SHA-1 computations. */
771 typedef struct sha1 {
777 /* Structure used to hold incoming packets of SMTP responses for a specific
778 socket. The packets which may contain multiple lines (and in some cases,
779 multiple responses). */
781 typedef struct smtp_inblock {
782 int sock; /* the socket */
783 int buffersize; /* the size of the buffer */
784 uschar *ptr; /* current position in the buffer */
785 uschar *ptrend; /* end of data in the buffer */
786 uschar *buffer; /* the buffer itself */
789 /* Structure used to hold buffered outgoing packets of SMTP commands for a
790 specific socket. The packets which may contain multiple lines when pipelining
793 typedef struct smtp_outblock {
794 int sock; /* the socket */
795 int cmd_count; /* count of buffered commands */
796 int buffersize; /* the size of the buffer */
797 BOOL authenticating; /* TRUE when authenticating */
798 uschar *ptr; /* current position in the buffer */
799 uschar *buffer; /* the buffer itself */
802 /* Structure to hold information about the source of redirection information */
804 typedef struct redirect_block {
805 uschar *string; /* file name or string */
806 uid_t *owners; /* allowed file owners */
807 gid_t *owngroups; /* allowed file groups */
808 struct passwd *pw; /* possible owner if not NULL */
809 int modemask; /* forbidden bits */
810 BOOL isfile; /* TRUE if string is a file name */
811 BOOL check_owner; /* TRUE, FALSE, or TRUE_UNSET */
812 BOOL check_group; /* TRUE, FALSE, or TRUE_UNSET */
815 /* Structure for passing arguments to check_host() */
817 typedef struct check_host_block {
818 const uschar *host_name;
819 const uschar *host_address;
820 const uschar *host_ipv4;
824 /* Structure for remembering lookup data when caching the result of
825 a lookup in a named list. */
827 typedef struct namedlist_cacheblock {
828 struct namedlist_cacheblock *next;
831 } namedlist_cacheblock;
833 /* Structure for holding data for an entry in a named list */
835 typedef struct namedlist_block {
836 const uschar *string; /* the list string */
837 namedlist_cacheblock *cache_data; /* cached domain_data or localpart_data */
838 int number; /* the number of the list for caching */
841 /* Structures for Access Control Lists */
843 typedef struct acl_condition_block {
844 struct acl_condition_block *next;
851 } acl_condition_block;
853 typedef struct acl_block {
854 struct acl_block *next;
855 acl_condition_block *condition;
859 /* smtp transport calc outbound_ip */
860 typedef BOOL (*oicf) (uschar *message_id, void *data);
862 /* DKIM information for transport */
865 uschar *dkim_private_key;
866 uschar *dkim_selector;
868 uschar *dkim_sign_headers;
872 /* End of structs.h */