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