fd53de883889e7b25a88d5a261ba798365652aa7
[exim.git] / src / src / macros.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 /* These two macros make it possible to obtain the result of macro-expanding
10 a string as a text string. This is sometimes useful for debugging output. */
11
12 #define mac_string(s) # s
13 #define mac_expanded_string(s) mac_string(s)
14
15 /* Number of elements of an array */
16 #define nelem(arr) (sizeof(arr) / sizeof(*arr))
17
18 /* Maximum of two items */
19 #ifndef MAX
20 # define MAX(a,b) ((a) > (b) ? (a) : (b))
21 #endif
22
23
24 /* When running in the test harness, the load average is fudged. */
25
26 #define OS_GETLOADAVG() \
27 (f.running_in_test_harness? (test_harness_load_avg += 10) : os_getloadavg())
28
29
30 /* The address_item structure has a struct full of 1-bit flags. These macros
31 manipulate them. */
32
33 #define setflag(addr, flagname) addr->flags.flagname = TRUE
34 #define clearflag(addr, flagname) addr->flags.flagname = FALSE
35
36 #define testflag(addr, flagname) (addr->flags.flagname)
37
38 #define copyflag(addrnew, addrold, flagname) \
39 addrnew->flags.flagname = addrold->flags.flagname
40
41
42 /* For almost all calls to convert things to printing characters, we want to
43 allow tabs. A macro just makes life a bit easier. */
44
45 #define string_printing(s) string_printing2((s), TRUE)
46
47
48 /* We need a special return code for "no recipients and failed to send an error
49 message". ANSI C defines only EXIT_FAILURE and EXIT_SUCCESS. On the assumption
50 that these are always 1 and 0 on Unix systems ... */
51
52 #define EXIT_NORECIPIENTS 2
53
54
55 /* Character-handling macros. It seems that the set of standard functions in
56 ctype.h aren't actually all that useful. One reason for this is that email is
57 international, so the concept of using a locale to vary what they do is not
58 helpful. Another problem is that in different operating systems, the libraries
59 yield different results, even in the default locale. For example, Linux yields
60 TRUE for iscntrl() for all characters > 127, whereas many other systems yield
61 FALSE. For these reasons we define our own set of macros for a number of
62 character testing functions. Ensure that all these tests treat their arguments
63 as unsigned. */
64
65 #define mac_iscntrl(c) \
66 ((uschar)(c) < 32 || (uschar)(c) == 127)
67
68 #define mac_iscntrl_or_special(c) \
69 ((uschar)(c) < 32 || strchr(" ()<>@,;:\\\".[]\177", (uschar)(c)) != NULL)
70
71 #define mac_isgraph(c) \
72 ((uschar)(c) > 32 && (uschar)(c) != 127)
73
74 #define mac_isprint(c) \
75 (((uschar)(c) >= 32 && (uschar)(c) <= 126) || c == '\t' || \
76 ((uschar)(c) > 127 && print_topbitchars))
77
78
79 /* Convenience for testing strings */
80
81 #define streqic(Foo, Bar) (strcmpic(Foo, Bar) == 0)
82
83
84 /* When built with TLS support, the act of flushing SMTP output becomes
85 a no-op once an SSL session is in progress. */
86
87 #ifdef SUPPORT_TLS
88 #define mac_smtp_fflush() if (tls_in.active.sock < 0) fflush(smtp_out);
89 #else
90 #define mac_smtp_fflush() fflush(smtp_out);
91 #endif
92
93
94 /* Define which ends of pipes are for reading and writing, as some systems
95 don't make the file descriptors two-way. */
96
97 #define pipe_read 0
98 #define pipe_write 1
99
100 /* The RFC 1413 ident port */
101
102 #define IDENT_PORT 113
103
104 /* A macro to simplify testing bits in lookup types */
105
106 #define mac_islookup(a,b) ((lookup_list[a]->type & (b)) != 0)
107
108 /* Debugging control */
109
110 #define DEBUG(x) if (debug_selector & (x))
111 #define HDEBUG(x) if (host_checking || (debug_selector & (x)))
112
113 #define PTR_CHK(ptr) \
114 do { \
115 if ((void *)ptr > (void *)store_get(0)) \
116 debug_printf("BUG: ptr '%s' beyond arena at %s:%d\n", \
117 mac_expanded_string(ptr), __FUNCTION__, __LINE__); \
118 } while(0)
119
120 /* The default From: text for DSNs */
121
122 #define DEFAULT_DSN_FROM "Mail Delivery System <Mailer-Daemon@$qualify_domain>"
123
124 /* The size of the vector for saving/restoring address expansion pointers while
125 verifying. This has to be explicit because it is referenced in more than one
126 source module. */
127
128 #define ADDRESS_EXPANSIONS_COUNT 18
129
130 /* The maximum permitted number of command-line (-D) macro definitions. We
131 need a limit only to make it easier to generate argument vectors for re-exec
132 of Exim. */
133
134 #define MAX_CLMACROS 10
135
136 /* The number of integer variables available in filter files. If this is
137 changed, then the tables in expand.c for accessing them must be changed too. */
138
139 #define FILTER_VARIABLE_COUNT 10
140
141 /* The size of the vector holding delay warning times */
142
143 #define DELAY_WARNING_SIZE 12
144
145 /* The size of the buffer holding the processing information string. */
146
147 #define PROCESS_INFO_SIZE 256
148
149 /* The size of buffer to get for constructing log entries. Make it big
150 enough to hold all the headers from a normal kind of message. */
151
152 #define LOG_BUFFER_SIZE 8192
153
154 /* The size of the circular buffer that remembers recent SMTP commands */
155
156 #define SMTP_HBUFF_SIZE 20
157
158 /* The initial size of a big buffer for use in various places. It gets put
159 into big_buffer_size and in some circumstances increased. It should be at least
160 as long as the maximum path length. */
161
162 #if defined PATH_MAX && PATH_MAX > 16384
163 # define BIG_BUFFER_SIZE PATH_MAX
164 #elif defined MAXPATHLEN && MAXPATHLEN > 16384
165 # define BIG_BUFFER_SIZE MAXPATHLEN
166 #else
167 # define BIG_BUFFER_SIZE 16384
168 #endif
169
170 /* header size of pipe content
171 currently: char id, char subid, char[5] length */
172 #define PIPE_HEADER_SIZE 7
173
174 /* This limits the length of data returned by local_scan(). Because it is
175 written on the spool, it gets read into big_buffer. */
176
177 #define LOCAL_SCAN_MAX_RETURN (BIG_BUFFER_SIZE - 24)
178
179 /* A limit to the length of an address. RFC 2821 limits the local part to 64
180 and the domain to 255, so this should be adequate, taking into account quotings
181 etc. */
182
183 #define ADDRESS_MAXLENGTH 512
184
185 /* The length of the base names of spool files, which consist of an internal
186 message id with a trailing "-H" or "-D" added. */
187
188 #define SPOOL_NAME_LENGTH (MESSAGE_ID_LENGTH+2)
189
190 /* The maximum number of message ids to store in a waiting database
191 record. */
192
193 #define WAIT_NAME_MAX 50
194
195 /* Wait this long before determining that a Proxy Protocol configured
196 host isn't speaking the protocol, and so is disallowed. Can be moved to
197 runtime configuration if per site settings become needed. */
198 #ifdef SUPPORT_PROXY
199 #define PROXY_NEGOTIATION_TIMEOUT_SEC 3
200 #define PROXY_NEGOTIATION_TIMEOUT_USEC 0
201 #endif
202
203 /* Fixed option values for all PCRE functions */
204
205 #define PCRE_COPT 0 /* compile */
206 #define PCRE_EOPT 0 /* exec */
207
208 /* Macros for trivial functions */
209
210 #define mac_ismsgid(s) \
211 (pcre_exec(regex_ismsgid,NULL,CS s,Ustrlen(s),0,PCRE_EOPT,NULL,0) >= 0)
212
213
214 /* Options for dns_next_rr */
215
216 enum { RESET_NEXT, RESET_ANSWERS, RESET_AUTHORITY, RESET_ADDITIONAL };
217
218 /* Argument values for the time-of-day function */
219
220 enum { tod_log, tod_log_bare, tod_log_zone, tod_log_datestamp_daily,
221 tod_log_datestamp_monthly, tod_zone, tod_full, tod_bsdin,
222 tod_mbx, tod_epoch, tod_epoch_l, tod_zulu };
223
224 /* For identifying types of driver */
225
226 enum {
227 EXIM_DTYPE_NONE,
228 EXIM_DTYPE_ROUTER,
229 EXIM_DTYPE_TRANSPORT
230 };
231
232 /* Error numbers for generating error messages when reading a message on the
233 standard input. */
234
235 enum {
236 ERRMESS_BADARGADDRESS, /* Bad address via argument list */
237 ERRMESS_BADADDRESS, /* Bad address read via -t */
238 ERRMESS_NOADDRESS, /* Message has no addresses */
239 ERRMESS_IGADDRESS, /* All -t addresses ignored */
240 ERRMESS_BADNOADDRESS, /* Bad address via -t, leaving none */
241 ERRMESS_IOERR, /* I/O error while reading a message */
242 ERRMESS_VLONGHEADER, /* Excessively long message header */
243 ERRMESS_VLONGHDRLINE, /* Excessively long single line in header */
244 ERRMESS_TOOBIG, /* Message too big */
245 ERRMESS_TOOMANYRECIP, /* Too many recipients */
246 ERRMESS_LOCAL_SCAN, /* Rejected by local scan */
247 ERRMESS_LOCAL_ACL /* Rejected by non-SMTP ACL */
248 #ifdef EXPERIMENTAL_DMARC
249 ,ERRMESS_DMARC_FORENSIC /* DMARC Forensic Report */
250 #endif
251 };
252
253 /* Error handling styles - set by option, and apply only when receiving
254 a local message not via SMTP. */
255
256 enum {
257 ERRORS_SENDER, /* Return to sender (default) */
258 ERRORS_STDERR /* Write on stderr */
259 };
260
261 /* Exec control values when Exim execs itself via child_exec_exim. */
262
263 enum {
264 CEE_RETURN_ARGV, /* Don't exec, just build and return argv */
265 CEE_EXEC_EXIT, /* Just exit if exec fails */
266 CEE_EXEC_PANIC /* Panic-die if exec fails */
267 };
268
269 /* Bit values for filter_test */
270
271 #define FTEST_NONE 0 /* Not filter testing */
272 #define FTEST_USER 1 /* Testing user filter */
273 #define FTEST_SYSTEM 2 /* Testing system filter */
274
275 /* Returns from the routing, transport and authentication functions (not all
276 apply to all of them). Some other functions also use these convenient values,
277 and some additional values are used only by non-driver functions.
278
279 OK, FAIL, DEFER, ERROR, and FAIL_FORCED are also declared in local_scan.h for
280 use in the local_scan() function and in ${dlfunc loaded functions. Do not
281 change them unilaterally. */
282
283 #define OK 0 /* Successful match */
284 #define DEFER 1 /* Defer - some problem */
285 #define FAIL 2 /* Matching failed */
286 #define ERROR 3 /* Internal or config error */
287 #define FAIL_FORCED 4 /* "Forced" failure */
288 /***********/
289 #define DECLINE 5 /* Declined to handle the address, pass to next
290 router unless no_more is set */
291 #define PASS 6 /* Pass to next driver, or to pass_router,
292 even if no_more is set */
293 #define DISCARD 7 /* Address routed to :blackhole: or "seen finish" */
294 #define SKIP 8 /* Skip this router (used in route_address only) */
295 #define REROUTED 9 /* Address was changed and child created*/
296 #define PANIC 10 /* Hard failed with internal error */
297 #define BAD64 11 /* Bad base64 data (auth) */
298 #define UNEXPECTED 12 /* Unexpected initial auth data */
299 #define CANCELLED 13 /* Authentication cancelled */
300 #define FAIL_SEND 14 /* send() failed in authenticator */
301 #define FAIL_DROP 15 /* Fail and drop connection (used in ACL) */
302
303 /* Returns from the deliver_message() function */
304
305 #define DELIVER_ATTEMPTED_NORMAL 0 /* Tried a normal delivery */
306 #define DELIVER_MUA_SUCCEEDED 1 /* Success when mua_wrapper is set */
307 #define DELIVER_MUA_FAILED 2 /* Failure when mua_wrapper is set */
308 #define DELIVER_NOT_ATTEMPTED 3 /* Not tried (no msg or is locked */
309
310 /* Returns from DNS lookup functions. */
311
312 enum { DNS_SUCCEED, DNS_NOMATCH, DNS_NODATA, DNS_AGAIN, DNS_FAIL };
313
314 /* Ending states when reading a message. The order is important. The test
315 for having to swallow the rest of an SMTP message is whether the value is
316 >= END_NOTENDED. */
317
318 #define END_NOTSTARTED 0 /* Message not started */
319 #define END_DOT 1 /* Message ended with '.' */
320 #define END_EOF 2 /* Message ended with EOF (error for SMTP) */
321 #define END_NOTENDED 3 /* Message reading not yet ended */
322 #define END_SIZE 4 /* Reading ended because message too big */
323 #define END_WERROR 5 /* Write error while reading the message */
324 #define END_PROTOCOL 6 /* Protocol error in CHUNKING sequence */
325
326 /* result codes for bdat_getc() (which can also return EOF) */
327
328 #define EOD (-2)
329 #define ERR (-3)
330
331
332 /* Bit masks for debug and log selectors */
333
334 /* Assume words are 32 bits wide. Tiny waste of space on 64 bit
335 platforms, but this ensures bit vectors always work the same way. */
336 #define BITWORDSIZE 32
337
338 /* This macro is for single-word bit vectors: the debug selector,
339 and the first word of the log selector. */
340 #define BIT(n) (1 << (n))
341
342 /* And these are for multi-word vectors. */
343 #define BITWORD(n) ( (n) / BITWORDSIZE)
344 #define BITMASK(n) (1 << (n) % BITWORDSIZE)
345
346 #define BIT_CLEAR(s,z,n) ((s)[BITWORD(n)] &= ~BITMASK(n))
347 #define BIT_SET(s,z,n) ((s)[BITWORD(n)] |= BITMASK(n))
348 #define BIT_TEST(s,z,n) (((s)[BITWORD(n)] & BITMASK(n)) != 0)
349
350 /* Used in globals.c for initializing bit_table structures. T will be either
351 D or L corresponding to the debug and log selector bits declared below. */
352
353 #define BIT_TABLE(T,name) { US #name, T##i_##name }
354
355 /* IOTA allows us to keep an implicit sequential count, like a simple enum,
356 but we can have sequentially numbered identifiers which are not declared
357 sequentially. We use this for more compact declarations of bit indexes and
358 masks, alternating between sequential bit index and corresponding mask. */
359
360 #define IOTA(iota) (__LINE__ - iota)
361 #define IOTA_INIT(zero) (__LINE__ - zero + 1)
362
363 /* Options bits for debugging. DEBUG_BIT() declares both a bit index and the
364 corresponding mask. Di_all is a special value recognized by decode_bits().
365
366 Exim's code assumes in a number of places that the debug_selector is one
367 word, and this is exposed in the local_scan ABI. The D_v and D_local_scan bit
368 masks are part of the local_scan API so are #defined in local_scan.h */
369
370 #define DEBUG_BIT(name) Di_##name = IOTA(Di_iota), D_##name = BIT(Di_##name)
371
372 enum {
373 Di_all = -1,
374 Di_v = 0,
375 Di_local_scan = 1,
376
377 Di_iota = IOTA_INIT(2),
378 DEBUG_BIT(acl),
379 DEBUG_BIT(auth),
380 DEBUG_BIT(deliver),
381 DEBUG_BIT(dns),
382 DEBUG_BIT(dnsbl),
383 DEBUG_BIT(exec),
384 DEBUG_BIT(expand),
385 DEBUG_BIT(filter),
386 DEBUG_BIT(hints_lookup),
387 DEBUG_BIT(host_lookup),
388 DEBUG_BIT(ident),
389 DEBUG_BIT(interface),
390 DEBUG_BIT(lists),
391 DEBUG_BIT(load),
392 DEBUG_BIT(lookup),
393 DEBUG_BIT(memory),
394 DEBUG_BIT(pid),
395 DEBUG_BIT(process_info),
396 DEBUG_BIT(queue_run),
397 DEBUG_BIT(receive),
398 DEBUG_BIT(resolver),
399 DEBUG_BIT(retry),
400 DEBUG_BIT(rewrite),
401 DEBUG_BIT(route),
402 DEBUG_BIT(timestamp),
403 DEBUG_BIT(tls),
404 DEBUG_BIT(transport),
405 DEBUG_BIT(uid),
406 DEBUG_BIT(verify),
407 };
408
409 /* Multi-bit debug masks */
410
411 #define D_all 0xffffffff
412
413 #define D_any (D_all & \
414 ~(D_v | \
415 D_pid | \
416 D_timestamp) )
417
418 #define D_default (0xffffffff & \
419 ~(D_expand | \
420 D_filter | \
421 D_interface | \
422 D_load | \
423 D_local_scan | \
424 D_memory | \
425 D_pid | \
426 D_timestamp | \
427 D_resolver))
428
429 /* Options bits for logging. Those that have values < BITWORDSIZE can be used
430 in calls to log_write(). The others are put into later words in log_selector
431 and are only ever tested independently, so they do not need bit mask
432 declarations. The Li_all value is recognized specially by decode_bits(). */
433
434 #define LOG_BIT(name) Li_##name = IOTA(Li_iota), L_##name = BIT(Li_##name)
435
436 enum {
437 Li_all = -1,
438
439 Li_iota = IOTA_INIT(0),
440 LOG_BIT(address_rewrite),
441 LOG_BIT(all_parents),
442 LOG_BIT(connection_reject),
443 LOG_BIT(delay_delivery),
444 LOG_BIT(dnslist_defer),
445 LOG_BIT(etrn),
446 LOG_BIT(host_lookup_failed),
447 LOG_BIT(lost_incoming_connection),
448 LOG_BIT(queue_run),
449 LOG_BIT(retry_defer),
450 LOG_BIT(size_reject),
451 LOG_BIT(skip_delivery),
452 LOG_BIT(smtp_connection),
453 LOG_BIT(smtp_incomplete_transaction),
454 LOG_BIT(smtp_protocol_error),
455 LOG_BIT(smtp_syntax_error),
456
457 Li_8bitmime = BITWORDSIZE,
458 Li_acl_warn_skipped,
459 Li_arguments,
460 Li_deliver_time,
461 Li_delivery_size,
462 Li_dkim,
463 Li_dkim_verbose,
464 Li_dnssec,
465 Li_ident_timeout,
466 Li_incoming_interface,
467 Li_incoming_port,
468 Li_millisec,
469 Li_outgoing_interface,
470 Li_outgoing_port,
471 Li_pid,
472 Li_pipelining,
473 Li_proxy,
474 Li_queue_time,
475 Li_queue_time_overall,
476 Li_receive_time,
477 Li_received_sender,
478 Li_received_recipients,
479 Li_rejected_header,
480 Li_return_path_on_delivery,
481 Li_sender_on_delivery,
482 Li_sender_verify_fail,
483 Li_smtp_confirmation,
484 Li_smtp_mailauth,
485 Li_smtp_no_mail,
486 Li_subject,
487 Li_tls_certificate_verified,
488 Li_tls_cipher,
489 Li_tls_peerdn,
490 Li_tls_sni,
491 Li_unknown_in_list,
492
493 log_selector_size = BITWORD(Li_unknown_in_list) + 1
494 };
495
496 #define LOGGING(opt) BIT_TEST(log_selector, log_selector_size, Li_##opt)
497
498 /* Private error numbers for delivery failures, set negative so as not
499 to conflict with system errno values. Take care to maintain the string
500 table exim_errstrings[] in log.c */
501
502 #define ERRNO_UNKNOWNERROR (-1)
503 #define ERRNO_USERSLASH (-2)
504 #define ERRNO_EXISTRACE (-3)
505 #define ERRNO_NOTREGULAR (-4)
506 #define ERRNO_NOTDIRECTORY (-5)
507 #define ERRNO_BADUGID (-6)
508 #define ERRNO_BADMODE (-7)
509 #define ERRNO_INODECHANGED (-8)
510 #define ERRNO_LOCKFAILED (-9)
511 #define ERRNO_BADADDRESS2 (-10)
512 #define ERRNO_FORBIDPIPE (-11)
513 #define ERRNO_FORBIDFILE (-12)
514 #define ERRNO_FORBIDREPLY (-13)
515 #define ERRNO_MISSINGPIPE (-14)
516 #define ERRNO_MISSINGFILE (-15)
517 #define ERRNO_MISSINGREPLY (-16)
518 #define ERRNO_BADREDIRECT (-17)
519 #define ERRNO_SMTPCLOSED (-18)
520 #define ERRNO_SMTPFORMAT (-19)
521 #define ERRNO_SPOOLFORMAT (-20)
522 #define ERRNO_NOTABSOLUTE (-21)
523 #define ERRNO_EXIMQUOTA (-22) /* Exim-imposed quota */
524 #define ERRNO_HELD (-23)
525 #define ERRNO_FILTER_FAIL (-24) /* Delivery filter process failure */
526 #define ERRNO_CHHEADER_FAIL (-25) /* Delivery add/remove header failure */
527 #define ERRNO_WRITEINCOMPLETE (-26) /* Delivery write incomplete error */
528 #define ERRNO_EXPANDFAIL (-27) /* Some expansion failed */
529 #define ERRNO_GIDFAIL (-28) /* Failed to get gid */
530 #define ERRNO_UIDFAIL (-29) /* Failed to get uid */
531 #define ERRNO_BADTRANSPORT (-30) /* Unset or non-existent transport */
532 #define ERRNO_MBXLENGTH (-31) /* MBX length mismatch */
533 #define ERRNO_UNKNOWNHOST (-32) /* Lookup failed routing or in smtp tpt */
534 #define ERRNO_FORMATUNKNOWN (-33) /* Can't match format in appendfile */
535 #define ERRNO_BADCREATE (-34) /* Creation outside home in appendfile */
536 #define ERRNO_LISTDEFER (-35) /* Can't check a list; lookup defer */
537 #define ERRNO_DNSDEFER (-36) /* DNS lookup defer */
538 #define ERRNO_TLSFAILURE (-37) /* Failed to start TLS session */
539 #define ERRNO_TLSREQUIRED (-38) /* Mandatory TLS session not started */
540 #define ERRNO_CHOWNFAIL (-39) /* Failed to chown a file */
541 #define ERRNO_PIPEFAIL (-40) /* Failed to create a pipe */
542 #define ERRNO_CALLOUTDEFER (-41) /* When verifying */
543 #define ERRNO_AUTHFAIL (-42) /* When required by client */
544 #define ERRNO_CONNECTTIMEOUT (-43) /* Used internally in smtp transport */
545 #define ERRNO_RCPT4XX (-44) /* RCPT gave 4xx error */
546 #define ERRNO_MAIL4XX (-45) /* MAIL gave 4xx error */
547 #define ERRNO_DATA4XX (-46) /* DATA gave 4xx error */
548 #define ERRNO_PROXYFAIL (-47) /* Negotiation failed for proxy configured host */
549 #define ERRNO_AUTHPROB (-48) /* Authenticator "other" failure */
550
551 #ifdef SUPPORT_I18N
552 # define ERRNO_UTF8_FWD (-49) /* target not supporting SMTPUTF8 */
553 #endif
554 #if defined(SUPPORT_TLS) && defined(EXPERIMENTAL_REQUIRETLS)
555 # define ERRNO_REQUIRETLS (-50) /* REQUIRETLS session not started */
556 #endif
557
558 /* These must be last, so all retry deferments can easily be identified */
559
560 #define ERRNO_RETRY_BASE (-51) /* Base to test against */
561 #define ERRNO_RRETRY (-51) /* Not time for routing */
562 #define ERRNO_LRETRY (-52) /* Not time for local delivery */
563 #define ERRNO_HRETRY (-53) /* Not time for any remote host */
564 #define ERRNO_LOCAL_ONLY (-54) /* Local-only delivery */
565 #define ERRNO_QUEUE_DOMAIN (-55) /* Domain in queue_domains */
566 #define ERRNO_TRETRY (-56) /* Transport concurrency limit */
567
568
569
570 /* Special actions to take after failure or deferment. */
571
572 enum {
573 SPECIAL_NONE, /* No special action */
574 SPECIAL_FREEZE, /* Freeze message */
575 SPECIAL_FAIL, /* Fail the delivery */
576 SPECIAL_WARN /* Send a warning message */
577 };
578
579 /* Flags that get ORed into the more_errno field of an address to give more
580 information about errors for retry purposes. They are greater than 256, because
581 the bottom byte contains 'A' or 'M' for remote addresses, to indicate whether
582 the name was looked up only via an address record or whether MX records were
583 used, respectively. */
584
585 #define RTEF_CTOUT 0x0100 /* Connection timed out */
586
587 /* Permission and other options for parse_extract_addresses(),
588 filter_interpret(), and rda_interpret(), i.e. what special things are allowed
589 in redirection operations. Not all apply to all cases. Some of the bits allow
590 and some forbid, reflecting the "allow" and "forbid" options in the redirect
591 router, which were chosen to represent the standard situation for users'
592 .forward files. */
593
594 #define RDO_BLACKHOLE 0x00000001 /* Forbid :blackhole: */
595 #define RDO_DEFER 0x00000002 /* Allow :defer: or "defer" */
596 #define RDO_EACCES 0x00000004 /* Ignore EACCES */
597 #define RDO_ENOTDIR 0x00000008 /* Ignore ENOTDIR */
598 #define RDO_EXISTS 0x00000010 /* Forbid "exists" in expansion in filter */
599 #define RDO_FAIL 0x00000020 /* Allow :fail: or "fail" */
600 #define RDO_FILTER 0x00000040 /* Allow a filter script */
601 #define RDO_FREEZE 0x00000080 /* Allow "freeze" */
602 #define RDO_INCLUDE 0x00000100 /* Forbid :include: */
603 #define RDO_LOG 0x00000200 /* Forbid "log" */
604 #define RDO_LOOKUP 0x00000400 /* Forbid "lookup" in expansion in filter */
605 #define RDO_PERL 0x00000800 /* Forbid "perl" in expansion in filter */
606 #define RDO_READFILE 0x00001000 /* Forbid "readfile" in exp in filter */
607 #define RDO_READSOCK 0x00002000 /* Forbid "readsocket" in exp in filter */
608 #define RDO_RUN 0x00004000 /* Forbid "run" in expansion in filter */
609 #define RDO_DLFUNC 0x00008000 /* Forbid "dlfunc" in expansion in filter */
610 #define RDO_REALLOG 0x00010000 /* Really do log (not testing/verifying) */
611 #define RDO_REWRITE 0x00020000 /* Rewrite generated addresses */
612 #define RDO_EXIM_FILTER 0x00040000 /* Forbid Exim filters */
613 #define RDO_SIEVE_FILTER 0x00080000 /* Forbid Sieve filters */
614 #define RDO_PREPEND_HOME 0x00100000 /* Prepend $home to relative paths in Exim filter save commands */
615
616 /* This is the set that apply to expansions in filters */
617
618 #define RDO_FILTER_EXPANSIONS \
619 (RDO_EXISTS|RDO_LOOKUP|RDO_PERL|RDO_READFILE|RDO_READSOCK|RDO_RUN|RDO_DLFUNC)
620
621 /* As well as the RDO bits themselves, we need the bit numbers in order to
622 access (most of) the individual bits as separate options. This could be
623 automated, but I haven't bothered. Keep this list in step with the above! */
624
625 enum { RDON_BLACKHOLE, RDON_DEFER, RDON_EACCES, RDON_ENOTDIR, RDON_EXISTS,
626 RDON_FAIL, RDON_FILTER, RDON_FREEZE, RDON_INCLUDE, RDON_LOG, RDON_LOOKUP,
627 RDON_PERL, RDON_READFILE, RDON_READSOCK, RDON_RUN, RDON_DLFUNC, RDON_REALLOG,
628 RDON_REWRITE, RDON_EXIM_FILTER, RDON_SIEVE_FILTER, RDON_PREPEND_HOME };
629
630 /* Results of filter or forward file processing. Some are only from a filter;
631 some are only from a forward file. */
632
633 enum {
634 FF_DELIVERED, /* Success, took significant action */
635 FF_NOTDELIVERED, /* Success, didn't take significant action */
636 FF_BLACKHOLE, /* Blackholing requested */
637 FF_DEFER, /* Defer requested */
638 FF_FAIL, /* Fail requested */
639 FF_INCLUDEFAIL, /* :include: failed */
640 FF_NONEXIST, /* Forward file does not exist */
641 FF_FREEZE, /* Freeze requested */
642 FF_ERROR /* We have a problem */
643 };
644
645 /* Values for identifying particular headers; printing characters are used, so
646 they can be read in the spool file for those headers that are permanently
647 marked. The lower case values don't get onto the spool; they are used only as
648 return values from header_checkname(). */
649
650 #define htype_other ' ' /* Unspecified header */
651 #define htype_from 'F'
652 #define htype_to 'T'
653 #define htype_cc 'C'
654 #define htype_bcc 'B'
655 #define htype_id 'I' /* for message-id */
656 #define htype_reply_to 'R'
657 #define htype_received 'P' /* P for Postmark */
658 #define htype_sender 'S'
659 #define htype_old '*' /* Replaced header */
660
661 #define htype_date 'd'
662 #define htype_return_path 'p'
663 #define htype_delivery_date 'x'
664 #define htype_envelope_to 'e'
665 #define htype_subject 's'
666
667 /* These values are used only when adding new headers from an ACL; they too
668 never get onto the spool. The type of the added header is set by reference
669 to the header name, by calling header_checkname(). */
670
671 #define htype_add_top 'a'
672 #define htype_add_rec 'r'
673 #define htype_add_bot 'z'
674 #define htype_add_rfc 'f'
675
676 /* Types of item in options lists. These are the bottom 8 bits of the "type"
677 field, which is an int. The opt_void value is used for entries in tables that
678 point to special types of value that are accessed only indirectly (e.g. the
679 rewrite data that is built out of a string option.) We need to have some values
680 visible in local_scan, so the following are declared there:
681
682 opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed, opt_time,
683 opt_bool
684
685 To make sure we don't conflict, the local_scan.h values start from zero, and
686 those defined here start from 32. The boolean ones must all be together so they
687 can be easily tested as a group. That is the only use of opt_bool_last. */
688
689 enum { opt_bit = 32, opt_bool_verify, opt_bool_set, opt_expand_bool,
690 opt_bool_last,
691 opt_rewrite, opt_timelist, opt_uid, opt_gid, opt_uidlist, opt_gidlist,
692 opt_expand_uid, opt_expand_gid, opt_func, opt_void };
693
694 /* There's a high-ish bit which is used to flag duplicate options, kept
695 for compatibility, which shouldn't be output. Also used for hidden options
696 that are automatically maintained from others. Another high bit is used to
697 flag driver options that although private (so as to be settable only on some
698 drivers), are stored in the instance block so as to be accessible from outside.
699 A third high bit is set when an option is read, so as to be able to give an
700 error if any option is set twice. Finally, there's a bit which is set when an
701 option is set with the "hide" prefix, to prevent -bP from showing it to
702 non-admin callers. The next byte up in the int is used to keep the bit number
703 for booleans that are kept in one bit. */
704
705 #define opt_hidden 0x100 /* Private to Exim */
706 #define opt_public 0x200 /* Stored in the main instance block */
707 #define opt_set 0x400 /* Option is set */
708 #define opt_secure 0x800 /* "hide" prefix used */
709 #define opt_rep_con 0x1000 /* Can be appended to by a repeated line (condition) */
710 #define opt_rep_str 0x2000 /* Can be appended to by a repeated line (string) */
711 #define opt_mask 0x00ff
712
713 /* Verify types when directing and routing */
714
715 enum { v_none, v_sender, v_recipient, v_expn };
716
717 /* Option flags for verify_address() */
718
719 #define vopt_fake_sender 0x0001 /* for verify=sender=<address> */
720 #define vopt_is_recipient 0x0002
721 #define vopt_qualify 0x0004
722 #define vopt_expn 0x0008
723 #define vopt_callout_fullpm 0x0010 /* full postmaster during callout */
724 #define vopt_callout_random 0x0020 /* during callout */
725 #define vopt_callout_no_cache 0x0040 /* disable callout cache */
726 #define vopt_callout_recipsender 0x0080 /* use real sender to verify recip */
727 #define vopt_callout_recippmaster 0x0100 /* use postmaster to verify recip */
728 #define vopt_callout_hold 0x0200 /* lazy close connection */
729 #define vopt_success_on_redirect 0x0400
730
731 /* Values for fields in callout cache records */
732
733 #define ccache_unknown 0 /* test hasn't been done */
734 #define ccache_accept 1
735 #define ccache_reject 2 /* All rejections except */
736 #define ccache_reject_mfnull 3 /* MAIL FROM:<> was rejected */
737
738 /* Options for lookup functions */
739
740 #define lookup_querystyle 1 /* query-style lookup */
741 #define lookup_absfile 2 /* requires absolute file name */
742 #define lookup_absfilequery 4 /* query-style starts with file name */
743
744 /* Status values for host_item blocks. Require hstatus_unusable and
745 hstatus_unusable_expired to be last. */
746
747 enum { hstatus_unknown, hstatus_usable, hstatus_unusable,
748 hstatus_unusable_expired };
749
750 /* Reasons why a host is unusable (for clearer log messages) */
751
752 enum { hwhy_unknown, hwhy_retry, hwhy_insecure, hwhy_failed, hwhy_deferred,
753 hwhy_ignored };
754
755 /* Domain lookup types for routers */
756
757 #define LK_DEFAULT BIT(0)
758 #define LK_BYNAME BIT(1)
759 #define LK_BYDNS BIT(2) /* those 3 should be mutually exclusive */
760
761 #define LK_IPV4_ONLY BIT(3)
762 #define LK_IPV4_PREFER BIT(4)
763
764 /* Values for the self_code fields */
765
766 enum { self_freeze, self_defer, self_send, self_reroute, self_pass, self_fail };
767
768 /* Flags for rewrite rules */
769
770 #define rewrite_sender 0x0001
771 #define rewrite_from 0x0002
772 #define rewrite_to 0x0004
773 #define rewrite_cc 0x0008
774 #define rewrite_bcc 0x0010
775 #define rewrite_replyto 0x0020
776 #define rewrite_all_headers 0x003F /* all header flags */
777
778 #define rewrite_envfrom 0x0040
779 #define rewrite_envto 0x0080
780 #define rewrite_all_envelope 0x00C0 /* all envelope flags */
781
782 #define rewrite_all (rewrite_all_headers | rewrite_all_envelope)
783
784 #define rewrite_smtp 0x0100 /* rewrite at SMTP time */
785 #define rewrite_smtp_sender 0x0200 /* SMTP sender rewrite (allows <>) */
786 #define rewrite_qualify 0x0400 /* qualify if necessary */
787 #define rewrite_repeat 0x0800 /* repeat rewrite rule */
788
789 #define rewrite_whole 0x1000 /* option bit for headers */
790 #define rewrite_quit 0x2000 /* "no more" option */
791
792 /* Flags for log_write(); LOG_MAIN, LOG_PANIC, and LOG_REJECT are also in
793 local_scan.h */
794
795 #define LOG_MAIN 1 /* Write to the main log */
796 #define LOG_PANIC 2 /* Write to the panic log */
797 #define LOG_PANIC_DIE 6 /* Write to the panic log and then die */
798 #define LOG_REJECT 16 /* Write to the reject log, with headers */
799 #define LOG_SENDER 32 /* Add raw sender to the message */
800 #define LOG_RECIPIENTS 64 /* Add raw recipients to the message */
801 #define LOG_CONFIG 128 /* Add "Exim configuration error" */
802 #define LOG_CONFIG_FOR (256+128) /* Add " for" instead of ":\n" */
803 #define LOG_CONFIG_IN (512+128) /* Add " in line x[ of file y]" */
804
805 /* and for debug_bits() logging action control: */
806 #define DEBUG_FROM_CONFIG 0x0001
807
808 /* SMTP command identifiers for the smtp_connection_had field that records the
809 most recent SMTP commands. Must be kept in step with the list of names in
810 smtp_in.c that is used for creating the smtp_no_mail logging action. SCH_NONE
811 is "empty". */
812
813 enum { SCH_NONE, SCH_AUTH, SCH_DATA, SCH_BDAT,
814 SCH_EHLO, SCH_ETRN, SCH_EXPN, SCH_HELO,
815 SCH_HELP, SCH_MAIL, SCH_NOOP, SCH_QUIT, SCH_RCPT, SCH_RSET, SCH_STARTTLS,
816 SCH_VRFY };
817
818 /* Returns from host_find_by{name,dns}() */
819
820 enum {
821 HOST_FIND_FAILED, /* failed to find the host */
822 HOST_FIND_AGAIN, /* could not resolve at this time */
823 HOST_FIND_SECURITY, /* dnssec required but not acheived */
824 HOST_FOUND, /* found host */
825 HOST_FOUND_LOCAL, /* found, but MX points to local host */
826 HOST_IGNORED /* found but ignored - used internally only */
827 };
828
829 /* Flags for host_find_bydns() */
830
831 #define HOST_FIND_BY_SRV BIT(0)
832 #define HOST_FIND_BY_MX BIT(1)
833 #define HOST_FIND_BY_A BIT(2)
834 #define HOST_FIND_BY_AAAA BIT(3)
835 #define HOST_FIND_QUALIFY_SINGLE BIT(4)
836 #define HOST_FIND_SEARCH_PARENTS BIT(5)
837 #define HOST_FIND_IPV4_FIRST BIT(6)
838 #define HOST_FIND_IPV4_ONLY BIT(7)
839
840 /* Actions applied to specific messages. */
841
842 enum { MSG_DELIVER, MSG_FREEZE, MSG_REMOVE, MSG_THAW, MSG_ADD_RECIPIENT,
843 MSG_MARK_ALL_DELIVERED, MSG_MARK_DELIVERED, MSG_EDIT_SENDER,
844 MSG_SHOW_COPY, MSG_LOAD,
845 /* These ones must be last: a test for >= MSG_SHOW_BODY is used
846 to test for actions that list individual spool files. */
847 MSG_SHOW_BODY, MSG_SHOW_HEADER, MSG_SHOW_LOG };
848
849 /* Returns from the spool_read_header() function */
850
851 enum {
852 spool_read_OK, /* success */
853 spool_read_notopen, /* open failed */
854 spool_read_enverror, /* error in the envelope */
855 spool_read_hdrerror /* error in the headers */
856 };
857
858 /* Options for transport_write_message */
859
860 #define topt_add_return_path 0x001
861 #define topt_add_delivery_date 0x002
862 #define topt_add_envelope_to 0x004
863 #define topt_use_crlf 0x008 /* Terminate lines with CRLF */
864 #define topt_end_dot 0x010 /* Send terminating dot line */
865 #define topt_no_headers 0x020 /* Omit headers */
866 #define topt_no_body 0x040 /* Omit body */
867 #define topt_escape_headers 0x080 /* Apply escape check to headers */
868 #define topt_use_bdat 0x100 /* prepend chunks with RFC3030 BDAT header */
869 #define topt_output_string 0x200 /* create string rather than write to fd */
870 #define topt_continuation 0x400 /* do not reset buffer */
871 #define topt_not_socket 0x800 /* cannot do socket-only syscalls */
872
873 /* Options for smtp_write_command */
874
875 enum {
876 SCMD_FLUSH = 0, /* write to kernel */
877 SCMD_MORE, /* write to kernel, but likely more soon */
878 SCMD_BUFFER /* stash in application cmd output buffer */
879 };
880
881 /* Flags for recipient_block, used in DSN support */
882
883 #define rf_dsnlasthop 0x01 /* Do not propagate DSN any further */
884 #define rf_notify_never 0x02 /* NOTIFY= settings */
885 #define rf_notify_success 0x04
886 #define rf_notify_failure 0x08
887 #define rf_notify_delay 0x10
888
889 #define rf_dsnflags (rf_notify_never | rf_notify_success | \
890 rf_notify_failure | rf_notify_delay)
891
892 /* DSN RET types */
893
894 #define dsn_ret_full 1
895 #define dsn_ret_hdrs 2
896
897 #define dsn_support_unknown 0
898 #define dsn_support_yes 1
899 #define dsn_support_no 2
900
901
902 /* Codes for the host_find_failed and host_all_ignored options. */
903
904 #define hff_freeze 0
905 #define hff_defer 1
906 #define hff_pass 2
907 #define hff_decline 3
908 #define hff_fail 4
909 #define hff_ignore 5
910
911 /* Router information flags */
912
913 #define ri_yestransport 0x0001 /* Must have a transport */
914 #define ri_notransport 0x0002 /* Must not have a transport */
915
916 /* Codes for match types in match_check_list; to any of them, MCL_NOEXPAND may
917 be added */
918
919 #define MCL_NOEXPAND 16
920
921 enum { MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, MCL_LOCALPART };
922
923 /* Codes for the places from which ACLs can be called. These are cunningly
924 ordered to make it easy to implement tests for certain ACLs when processing
925 "control" modifiers, by means of a maximum "where" value. Do not modify this
926 order without checking carefully!
927
928 **** IMPORTANT***
929 **** Furthermore, remember to keep these in step with the tables
930 **** of names and response codes in globals.c.
931 **** IMPORTANT ****
932 */
933
934 enum { ACL_WHERE_RCPT, /* Some controls are for RCPT only */
935 ACL_WHERE_MAIL, /* ) */
936 ACL_WHERE_PREDATA, /* ) There are several tests for "in message", */
937 ACL_WHERE_MIME, /* ) implemented by <= WHERE_NOTSMTP */
938 ACL_WHERE_DKIM, /* ) */
939 ACL_WHERE_DATA, /* ) */
940 #ifndef DISABLE_PRDR
941 ACL_WHERE_PRDR, /* ) */
942 #endif
943 ACL_WHERE_NOTSMTP, /* ) */
944
945 ACL_WHERE_AUTH, /* These remaining ones are not currently */
946 ACL_WHERE_CONNECT, /* required to be in a special order so they */
947 ACL_WHERE_ETRN, /* are just alphabetical. */
948 ACL_WHERE_EXPN,
949 ACL_WHERE_HELO,
950 ACL_WHERE_MAILAUTH,
951 ACL_WHERE_NOTSMTP_START,
952 ACL_WHERE_NOTQUIT,
953 ACL_WHERE_QUIT,
954 ACL_WHERE_STARTTLS,
955 ACL_WHERE_VRFY,
956
957 ACL_WHERE_DELIVERY,
958 ACL_WHERE_UNKNOWN /* Currently used by a ${acl:name} expansion */
959 };
960
961 #define ACL_BIT_RCPT BIT(ACL_WHERE_RCPT)
962 #define ACL_BIT_MAIL BIT(ACL_WHERE_MAIL)
963 #define ACL_BIT_PREDATA BIT(ACL_WHERE_PREDATA)
964 #define ACL_BIT_MIME BIT(ACL_WHERE_MIME)
965 #define ACL_BIT_DKIM BIT(ACL_WHERE_DKIM)
966 #define ACL_BIT_DATA BIT(ACL_WHERE_DATA)
967 #ifndef DISABLE_PRDR
968 # define ACL_BIT_PRDR BIT(ACL_WHERE_PRDR)
969 #endif
970 #define ACL_BIT_NOTSMTP BIT(ACL_WHERE_NOTSMTP)
971 #define ACL_BIT_AUTH BIT(ACL_WHERE_AUTH)
972 #define ACL_BIT_CONNECT BIT(ACL_WHERE_CONNECT)
973 #define ACL_BIT_ETRN BIT(ACL_WHERE_ETRN)
974 #define ACL_BIT_EXPN BIT(ACL_WHERE_EXPN)
975 #define ACL_BIT_HELO BIT(ACL_WHERE_HELO)
976 #define ACL_BIT_MAILAUTH BIT(ACL_WHERE_MAILAUTH)
977 #define ACL_BIT_NOTSMTP_START BIT(ACL_WHERE_NOTSMTP_START)
978 #define ACL_BIT_NOTQUIT BIT(ACL_WHERE_NOTQUIT)
979 #define ACL_BIT_QUIT BIT(ACL_WHERE_QUIT)
980 #define ACL_BIT_STARTTLS BIT(ACL_WHERE_STARTTLS)
981 #define ACL_BIT_VRFY BIT(ACL_WHERE_VRFY)
982 #define ACL_BIT_DELIVERY BIT(ACL_WHERE_DELIVERY)
983 #define ACL_BIT_UNKNOWN BIT(ACL_WHERE_UNKNOWN)
984
985
986 /* Situations for spool_write_header() */
987
988 enum { SW_RECEIVING, SW_DELIVERING, SW_MODIFYING };
989
990 /* MX fields for hosts not obtained from MX records are always negative.
991 MX_NONE is the default case; lesser values are used when the hosts are
992 randomized in batches. */
993
994 #define MX_NONE (-1)
995
996 /* host_item.port defaults to PORT_NONE; the only current case where this
997 is changed before running the transport is when an dnslookup router sets an
998 explicit port number. */
999
1000 #define PORT_NONE (-1)
1001
1002 /* Flags for single-key search defaults */
1003
1004 #define SEARCH_STAR 0x01
1005 #define SEARCH_STARAT 0x02
1006
1007 /* Filter types */
1008
1009 enum { FILTER_UNSET, FILTER_FORWARD, FILTER_EXIM, FILTER_SIEVE };
1010
1011 /* Codes for ESMTP facilities offered by peer */
1012
1013 #define OPTION_TLS BIT(0)
1014 #define OPTION_IGNQ BIT(1)
1015 #define OPTION_PRDR BIT(2)
1016 #define OPTION_UTF8 BIT(3)
1017 #define OPTION_DSN BIT(4)
1018 #define OPTION_PIPE BIT(5)
1019 #define OPTION_SIZE BIT(6)
1020 #define OPTION_CHUNKING BIT(7)
1021 #define OPTION_REQUIRETLS BIT(8)
1022
1023 /* Codes for tls_requiretls requests (usually by sender) */
1024
1025 #define REQUIRETLS_MSG BIT(0) /* REQUIRETLS onward use */
1026
1027 /* Argument for *_getc */
1028
1029 #define GETC_BUFFER_UNLIMITED UINT_MAX
1030
1031 /* UTF-8 chars for line-drawing */
1032
1033 #define UTF8_DOWN_RIGHT "\xE2\x94\x8c"
1034 #define UTF8_HORIZ "\xE2\x94\x80"
1035 #define UTF8_VERT_RIGHT "\xE2\x94\x9C"
1036 #define UTF8_UP_RIGHT "\xE2\x94\x94"
1037 #define UTF8_VERT_2DASH "\xE2\x95\x8E"
1038
1039
1040 /* Options on tls_close */
1041 #define TLS_NO_SHUTDOWN 0
1042 #define TLS_SHUTDOWN_NOWAIT 1
1043 #define TLS_SHUTDOWN_WAIT 2
1044
1045
1046 /* End of macros.h */