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