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