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