1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
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. */
12 #define mac_string(s) # s
13 #define mac_expanded_string(s) mac_string(s)
15 /* Number of elements of an array */
16 #define nelem(arr) (sizeof(arr) / sizeof(*arr))
18 /* Maximum of two items */
20 # define MAX(a,b) ((a) > (b) ? (a) : (b))
24 /* When running in the test harness, the load average is fudged. */
26 #define OS_GETLOADAVG() \
27 (f.running_in_test_harness? (test_harness_load_avg += 10) : os_getloadavg())
30 /* The address_item structure has a struct full of 1-bit flags. These macros
33 #define setflag(addr, flagname) addr->flags.flagname = TRUE
34 #define clearflag(addr, flagname) addr->flags.flagname = FALSE
36 #define testflag(addr, flagname) (addr->flags.flagname)
38 #define copyflag(addrnew, addrold, flagname) \
39 addrnew->flags.flagname = addrold->flags.flagname
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. */
45 #define string_printing(s) string_printing2((s), TRUE)
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 ... */
52 #define EXIT_NORECIPIENTS 2
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
65 #define mac_iscntrl(c) \
66 ((uschar)(c) < 32 || (uschar)(c) == 127)
68 #define mac_iscntrl_or_special(c) \
69 ((uschar)(c) < 32 || strchr(" ()<>@,;:\\\".[]\177", (uschar)(c)) != NULL)
71 #define mac_isgraph(c) \
72 ((uschar)(c) > 32 && (uschar)(c) != 127)
74 #define mac_isprint(c) \
75 (((uschar)(c) >= 32 && (uschar)(c) <= 126) || c == '\t' || \
76 ((uschar)(c) > 127 && print_topbitchars))
79 /* Convenience for testing strings */
81 #define streqic(Foo, Bar) (strcmpic(Foo, Bar) == 0)
84 /* When built with TLS support, the act of flushing SMTP output becomes
85 a no-op once an SSL session is in progress. */
88 #define mac_smtp_fflush() if (tls_in.active.sock < 0) fflush(smtp_out);
90 #define mac_smtp_fflush() fflush(smtp_out);
94 /* Define which ends of pipes are for reading and writing, as some systems
95 don't make the file descriptors two-way. */
100 /* The RFC 1413 ident port */
102 #define IDENT_PORT 113
104 /* A macro to simplify testing bits in lookup types */
106 #define mac_islookup(a,b) ((lookup_list[a]->type & (b)) != 0)
108 /* Debugging control */
110 #define DEBUG(x) if (debug_selector & (x))
111 #define HDEBUG(x) if (host_checking || (debug_selector & (x)))
113 /* The default From: text for DSNs */
115 #define DEFAULT_DSN_FROM "Mail Delivery System <Mailer-Daemon@$qualify_domain>"
117 /* The size of the vector for saving/restoring address expansion pointers while
118 verifying. This has to be explicit because it is referenced in more than one
121 #define ADDRESS_EXPANSIONS_COUNT 18
123 /* The maximum permitted number of command-line (-D) macro definitions. We
124 need a limit only to make it easier to generate argument vectors for re-exec
127 #define MAX_CLMACROS 10
129 /* The number of integer variables available in filter files. If this is
130 changed, then the tables in expand.c for accessing them must be changed too. */
132 #define FILTER_VARIABLE_COUNT 10
134 /* The size of the vector holding delay warning times */
136 #define DELAY_WARNING_SIZE 12
138 /* The size of the buffer holding the processing information string. */
140 #define PROCESS_INFO_SIZE 256
142 /* The size of buffer to get for constructing log entries. Make it big
143 enough to hold all the headers from a normal kind of message. */
145 #define LOG_BUFFER_SIZE 8192
147 /* The size of the circular buffer that remembers recent SMTP commands */
149 #define SMTP_HBUFF_SIZE 20
151 /* The initial size of a big buffer for use in various places. It gets put
152 into big_buffer_size and in some circumstances increased. It should be at least
153 as long as the maximum path length. */
155 #if defined PATH_MAX && PATH_MAX > 16384
156 # define BIG_BUFFER_SIZE PATH_MAX
157 #elif defined MAXPATHLEN && MAXPATHLEN > 16384
158 # define BIG_BUFFER_SIZE MAXPATHLEN
160 # define BIG_BUFFER_SIZE 16384
163 /* header size of pipe content
164 currently: char id, char subid, char[5] length */
165 #define PIPE_HEADER_SIZE 7
167 /* This limits the length of data returned by local_scan(). Because it is
168 written on the spool, it gets read into big_buffer. */
170 #define LOCAL_SCAN_MAX_RETURN (BIG_BUFFER_SIZE - 24)
172 /* A limit to the length of an address. RFC 2821 limits the local part to 64
173 and the domain to 255, so this should be adequate, taking into account quotings
176 #define ADDRESS_MAXLENGTH 512
178 /* The length of the base names of spool files, which consist of an internal
179 message id with a trailing "-H" or "-D" added. */
181 #define SPOOL_NAME_LENGTH (MESSAGE_ID_LENGTH+2)
183 /* The maximum number of message ids to store in a waiting database
186 #define WAIT_NAME_MAX 50
188 /* Wait this long before determining that a Proxy Protocol configured
189 host isn't speaking the protocol, and so is disallowed. Can be moved to
190 runtime configuration if per site settings become needed. */
192 #define PROXY_NEGOTIATION_TIMEOUT_SEC 3
193 #define PROXY_NEGOTIATION_TIMEOUT_USEC 0
196 /* Fixed option values for all PCRE functions */
198 #define PCRE_COPT 0 /* compile */
199 #define PCRE_EOPT 0 /* exec */
201 /* Macros for trivial functions */
203 #define mac_ismsgid(s) \
204 (pcre_exec(regex_ismsgid,NULL,CS s,Ustrlen(s),0,PCRE_EOPT,NULL,0) >= 0)
207 /* Options for dns_next_rr */
209 enum { RESET_NEXT, RESET_ANSWERS, RESET_AUTHORITY, RESET_ADDITIONAL };
211 /* Argument values for the time-of-day function */
213 enum { tod_log, tod_log_bare, tod_log_zone, tod_log_datestamp_daily,
214 tod_log_datestamp_monthly, tod_zone, tod_full, tod_bsdin,
215 tod_mbx, tod_epoch, tod_epoch_l, tod_zulu };
217 /* For identifying types of driver */
225 /* Error numbers for generating error messages when reading a message on the
229 ERRMESS_BADARGADDRESS, /* Bad address via argument list */
230 ERRMESS_BADADDRESS, /* Bad address read via -t */
231 ERRMESS_NOADDRESS, /* Message has no addresses */
232 ERRMESS_IGADDRESS, /* All -t addresses ignored */
233 ERRMESS_BADNOADDRESS, /* Bad address via -t, leaving none */
234 ERRMESS_IOERR, /* I/O error while reading a message */
235 ERRMESS_VLONGHEADER, /* Excessively long message header */
236 ERRMESS_VLONGHDRLINE, /* Excessively long single line in header */
237 ERRMESS_TOOBIG, /* Message too big */
238 ERRMESS_TOOMANYRECIP, /* Too many recipients */
239 ERRMESS_LOCAL_SCAN, /* Rejected by local scan */
240 ERRMESS_LOCAL_ACL /* Rejected by non-SMTP ACL */
241 #ifdef EXPERIMENTAL_DMARC
242 ,ERRMESS_DMARC_FORENSIC /* DMARC Forensic Report */
246 /* Error handling styles - set by option, and apply only when receiving
247 a local message not via SMTP. */
250 ERRORS_SENDER, /* Return to sender (default) */
251 ERRORS_STDERR /* Write on stderr */
254 /* Exec control values when Exim execs itself via child_exec_exim. */
257 CEE_RETURN_ARGV, /* Don't exec, just build and return argv */
258 CEE_EXEC_EXIT, /* Just exit if exec fails */
259 CEE_EXEC_PANIC /* Panic-die if exec fails */
262 /* Bit values for filter_test */
264 #define FTEST_NONE 0 /* Not filter testing */
265 #define FTEST_USER 1 /* Testing user filter */
266 #define FTEST_SYSTEM 2 /* Testing system filter */
268 /* Returns from the routing, transport and authentication functions (not all
269 apply to all of them). Some other functions also use these convenient values,
270 and some additional values are used only by non-driver functions.
272 OK, FAIL, DEFER, ERROR, and FAIL_FORCED are also declared in local_scan.h for
273 use in the local_scan() function and in ${dlfunc loaded functions. Do not
274 change them unilaterally.
276 Use rc_names[] for debug strings. */
278 #define OK 0 /* Successful match */
279 #define DEFER 1 /* Defer - some problem */
280 #define FAIL 2 /* Matching failed */
281 #define ERROR 3 /* Internal or config error */
282 #define FAIL_FORCED 4 /* "Forced" failure */
284 #define DECLINE 5 /* Declined to handle the address, pass to next
285 router unless no_more is set */
286 #define PASS 6 /* Pass to next driver, or to pass_router,
287 even if no_more is set */
288 #define DISCARD 7 /* Address routed to :blackhole: or "seen finish" */
289 #define SKIP 8 /* Skip this router (used in route_address only) */
290 #define REROUTED 9 /* Address was changed and child created*/
291 #define PANIC 10 /* Hard failed with internal error */
292 #define BAD64 11 /* Bad base64 data (auth) */
293 #define UNEXPECTED 12 /* Unexpected initial auth data */
294 #define CANCELLED 13 /* Authentication cancelled */
295 #define FAIL_SEND 14 /* send() failed in authenticator */
296 #define FAIL_DROP 15 /* Fail and drop connection (used in ACL) */
298 /* Returns from the deliver_message() function */
300 #define DELIVER_ATTEMPTED_NORMAL 0 /* Tried a normal delivery */
301 #define DELIVER_MUA_SUCCEEDED 1 /* Success when mua_wrapper is set */
302 #define DELIVER_MUA_FAILED 2 /* Failure when mua_wrapper is set */
303 #define DELIVER_NOT_ATTEMPTED 3 /* Not tried (no msg or is locked */
305 /* Returns from DNS lookup functions. */
307 enum { DNS_SUCCEED, DNS_NOMATCH, DNS_NODATA, DNS_AGAIN, DNS_FAIL };
309 /* Ending states when reading a message. The order is important. The test
310 for having to swallow the rest of an SMTP message is whether the value is
313 #define END_NOTSTARTED 0 /* Message not started */
314 #define END_DOT 1 /* Message ended with '.' */
315 #define END_EOF 2 /* Message ended with EOF (error for SMTP) */
316 #define END_NOTENDED 3 /* Message reading not yet ended */
317 #define END_SIZE 4 /* Reading ended because message too big */
318 #define END_WERROR 5 /* Write error while reading the message */
319 #define END_PROTOCOL 6 /* Protocol error in CHUNKING sequence */
321 /* result codes for bdat_getc() (which can also return EOF) */
327 /* Bit masks for debug and log selectors */
329 /* Assume words are 32 bits wide. Tiny waste of space on 64 bit
330 platforms, but this ensures bit vectors always work the same way. */
331 #define BITWORDSIZE 32
333 /* This macro is for single-word bit vectors: the debug selector,
334 and the first word of the log selector. */
335 #define BIT(n) (1UL << (n))
337 /* And these are for multi-word vectors. */
338 #define BITWORD(n) ( (n) / BITWORDSIZE)
339 #define BITMASK(n) (1U << (n) % BITWORDSIZE)
341 #define BIT_CLEAR(s,z,n) ((s)[BITWORD(n)] &= ~BITMASK(n))
342 #define BIT_SET(s,z,n) ((s)[BITWORD(n)] |= BITMASK(n))
343 #define BIT_TEST(s,z,n) (((s)[BITWORD(n)] & BITMASK(n)) != 0)
345 /* Used in globals.c for initializing bit_table structures. T will be either
346 D or L corresponding to the debug and log selector bits declared below. */
348 #define BIT_TABLE(T,name) { US #name, T##i_##name }
350 /* IOTA allows us to keep an implicit sequential count, like a simple enum,
351 but we can have sequentially numbered identifiers which are not declared
352 sequentially. We use this for more compact declarations of bit indexes and
353 masks, alternating between sequential bit index and corresponding mask. */
355 #define IOTA(iota) (__LINE__ - iota)
356 #define IOTA_INIT(zero) (__LINE__ - zero + 1)
358 /* Options bits for debugging. DEBUG_BIT() declares both a bit index and the
359 corresponding mask. Di_all is a special value recognized by decode_bits().
360 These must match the debug_options table in globals.c .
362 Exim's code assumes in a number of places that the debug_selector is one
363 word, and this is exposed in the local_scan ABI. The D_v and D_local_scan bit
364 masks are part of the local_scan API so are #defined in local_scan.h */
366 #define DEBUG_BIT(name) Di_##name = IOTA(Di_iota), D_##name = (int)BIT(Di_##name)
373 Di_iota = IOTA_INIT(2),
374 DEBUG_BIT(acl), /* 2 */
379 DEBUG_BIT(exec), /* 7 */
382 DEBUG_BIT(hints_lookup),
383 DEBUG_BIT(host_lookup),
385 DEBUG_BIT(interface),
387 DEBUG_BIT(load), /* 15 */
392 DEBUG_BIT(process_info),
393 DEBUG_BIT(queue_run),
395 DEBUG_BIT(resolver), /* 23 */
399 DEBUG_BIT(timestamp),
401 DEBUG_BIT(transport),
403 DEBUG_BIT(verify), /* 31 */
406 /* Multi-bit debug masks */
408 #define D_all 0xffffffff
410 #define D_any (D_all & \
416 #define D_default (0xffffffff & \
428 /* Options bits for logging. Those that have values < BITWORDSIZE can be used
429 in calls to log_write(). The others are put into later words in log_selector
430 and are only ever tested independently, so they do not need bit mask
431 declarations. The Li_all value is recognized specially by decode_bits().
432 Add also to log_options[] when creating new ones. */
434 #define LOG_BIT(name) Li_##name = IOTA(Li_iota), L_##name = BIT(Li_##name)
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),
446 LOG_BIT(host_lookup_failed),
447 LOG_BIT(lost_incoming_connection),
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),
457 Li_8bitmime = BITWORDSIZE,
466 Li_incoming_interface,
471 Li_outgoing_interface,
477 Li_queue_time_overall,
480 Li_received_recipients,
482 Li_return_path_on_delivery,
483 Li_sender_on_delivery,
484 Li_sender_verify_fail,
485 Li_smtp_confirmation,
489 Li_tls_certificate_verified,
496 log_selector_size = BITWORD(Li_unknown_in_list) + 1
499 #define LOGGING(opt) BIT_TEST(log_selector, log_selector_size, Li_##opt)
501 /* Private error numbers for delivery failures, set negative so as not
502 to conflict with system errno values. Take care to maintain the string
503 table exim_errstrings[] in log.c */
505 #define ERRNO_UNKNOWNERROR (-1)
506 #define ERRNO_USERSLASH (-2)
507 #define ERRNO_EXISTRACE (-3)
508 #define ERRNO_NOTREGULAR (-4)
509 #define ERRNO_NOTDIRECTORY (-5)
510 #define ERRNO_BADUGID (-6)
511 #define ERRNO_BADMODE (-7)
512 #define ERRNO_INODECHANGED (-8)
513 #define ERRNO_LOCKFAILED (-9)
514 #define ERRNO_BADADDRESS2 (-10)
515 #define ERRNO_FORBIDPIPE (-11)
516 #define ERRNO_FORBIDFILE (-12)
517 #define ERRNO_FORBIDREPLY (-13)
518 #define ERRNO_MISSINGPIPE (-14)
519 #define ERRNO_MISSINGFILE (-15)
520 #define ERRNO_MISSINGREPLY (-16)
521 #define ERRNO_BADREDIRECT (-17)
522 #define ERRNO_SMTPCLOSED (-18)
523 #define ERRNO_SMTPFORMAT (-19)
524 #define ERRNO_SPOOLFORMAT (-20)
525 #define ERRNO_NOTABSOLUTE (-21)
526 #define ERRNO_EXIMQUOTA (-22) /* Exim-imposed quota */
527 #define ERRNO_HELD (-23)
528 #define ERRNO_FILTER_FAIL (-24) /* Delivery filter process failure */
529 #define ERRNO_CHHEADER_FAIL (-25) /* Delivery add/remove header failure */
530 #define ERRNO_WRITEINCOMPLETE (-26) /* Delivery write incomplete error */
531 #define ERRNO_EXPANDFAIL (-27) /* Some expansion failed */
532 #define ERRNO_GIDFAIL (-28) /* Failed to get gid */
533 #define ERRNO_UIDFAIL (-29) /* Failed to get uid */
534 #define ERRNO_BADTRANSPORT (-30) /* Unset or non-existent transport */
535 #define ERRNO_MBXLENGTH (-31) /* MBX length mismatch */
536 #define ERRNO_UNKNOWNHOST (-32) /* Lookup failed routing or in smtp tpt */
537 #define ERRNO_FORMATUNKNOWN (-33) /* Can't match format in appendfile */
538 #define ERRNO_BADCREATE (-34) /* Creation outside home in appendfile */
539 #define ERRNO_LISTDEFER (-35) /* Can't check a list; lookup defer */
540 #define ERRNO_DNSDEFER (-36) /* DNS lookup defer */
541 #define ERRNO_TLSFAILURE (-37) /* Failed to start TLS session */
542 #define ERRNO_TLSREQUIRED (-38) /* Mandatory TLS session not started */
543 #define ERRNO_CHOWNFAIL (-39) /* Failed to chown a file */
544 #define ERRNO_PIPEFAIL (-40) /* Failed to create a pipe */
545 #define ERRNO_CALLOUTDEFER (-41) /* When verifying */
546 #define ERRNO_AUTHFAIL (-42) /* When required by client */
547 #define ERRNO_CONNECTTIMEOUT (-43) /* Used internally in smtp transport */
548 #define ERRNO_RCPT4XX (-44) /* RCPT gave 4xx error */
549 #define ERRNO_MAIL4XX (-45) /* MAIL gave 4xx error */
550 #define ERRNO_DATA4XX (-46) /* DATA gave 4xx error */
551 #define ERRNO_PROXYFAIL (-47) /* Negotiation failed for proxy configured host */
552 #define ERRNO_AUTHPROB (-48) /* Authenticator "other" failure */
555 # define ERRNO_UTF8_FWD (-49) /* target not supporting SMTPUTF8 */
557 /* -50 free for re-use */
559 /* These must be last, so all retry deferments can easily be identified */
561 #define ERRNO_RETRY_BASE (-51) /* Base to test against */
562 #define ERRNO_RRETRY (-51) /* Not time for routing */
564 #define ERRNO_WARN_BASE (-52) /* Base to test against */
565 #define ERRNO_LRETRY (-52) /* Not time for local delivery */
566 #define ERRNO_HRETRY (-53) /* Not time for any remote host */
567 #define ERRNO_LOCAL_ONLY (-54) /* Local-only delivery */
568 #define ERRNO_QUEUE_DOMAIN (-55) /* Domain in queue_domains */
569 #define ERRNO_TRETRY (-56) /* Transport concurrency limit */
570 #define ERRNO_EVENT (-57) /* Event processing request alternate response */
574 /* Special actions to take after failure or deferment. */
577 SPECIAL_NONE, /* No special action */
578 SPECIAL_FREEZE, /* Freeze message */
579 SPECIAL_FAIL, /* Fail the delivery */
580 SPECIAL_WARN /* Send a warning message */
583 /* Flags that get ORed into the more_errno field of an address to give more
584 information about errors for retry purposes. They are greater than 256, because
585 the bottom byte contains 'A' or 'M' for remote addresses, to indicate whether
586 the name was looked up only via an address record or whether MX records were
587 used, respectively. */
589 #define RTEF_CTOUT 0x0100 /* Connection timed out */
591 /* Permission and other options for parse_extract_addresses(),
592 filter_interpret(), and rda_interpret(), i.e. what special things are allowed
593 in redirection operations. Not all apply to all cases. Some of the bits allow
594 and some forbid, reflecting the "allow" and "forbid" options in the redirect
595 router, which were chosen to represent the standard situation for users'
598 #define RDO_BLACKHOLE 0x00000001 /* Forbid :blackhole: */
599 #define RDO_DEFER 0x00000002 /* Allow :defer: or "defer" */
600 #define RDO_EACCES 0x00000004 /* Ignore EACCES */
601 #define RDO_ENOTDIR 0x00000008 /* Ignore ENOTDIR */
602 #define RDO_EXISTS 0x00000010 /* Forbid "exists" in expansion in filter */
603 #define RDO_FAIL 0x00000020 /* Allow :fail: or "fail" */
604 #define RDO_FILTER 0x00000040 /* Allow a filter script */
605 #define RDO_FREEZE 0x00000080 /* Allow "freeze" */
606 #define RDO_INCLUDE 0x00000100 /* Forbid :include: */
607 #define RDO_LOG 0x00000200 /* Forbid "log" */
608 #define RDO_LOOKUP 0x00000400 /* Forbid "lookup" in expansion in filter */
609 #define RDO_PERL 0x00000800 /* Forbid "perl" in expansion in filter */
610 #define RDO_READFILE 0x00001000 /* Forbid "readfile" in exp in filter */
611 #define RDO_READSOCK 0x00002000 /* Forbid "readsocket" in exp in filter */
612 #define RDO_RUN 0x00004000 /* Forbid "run" in expansion in filter */
613 #define RDO_DLFUNC 0x00008000 /* Forbid "dlfunc" in expansion in filter */
614 #define RDO_REALLOG 0x00010000 /* Really do log (not testing/verifying) */
615 #define RDO_REWRITE 0x00020000 /* Rewrite generated addresses */
616 #define RDO_EXIM_FILTER 0x00040000 /* Forbid Exim filters */
617 #define RDO_SIEVE_FILTER 0x00080000 /* Forbid Sieve filters */
618 #define RDO_PREPEND_HOME 0x00100000 /* Prepend $home to relative paths in Exim filter save commands */
620 /* This is the set that apply to expansions in filters */
622 #define RDO_FILTER_EXPANSIONS \
623 (RDO_EXISTS|RDO_LOOKUP|RDO_PERL|RDO_READFILE|RDO_READSOCK|RDO_RUN|RDO_DLFUNC)
625 /* As well as the RDO bits themselves, we need the bit numbers in order to
626 access (most of) the individual bits as separate options. This could be
627 automated, but I haven't bothered. Keep this list in step with the above! */
629 enum { RDON_BLACKHOLE, RDON_DEFER, RDON_EACCES, RDON_ENOTDIR, RDON_EXISTS,
630 RDON_FAIL, RDON_FILTER, RDON_FREEZE, RDON_INCLUDE, RDON_LOG, RDON_LOOKUP,
631 RDON_PERL, RDON_READFILE, RDON_READSOCK, RDON_RUN, RDON_DLFUNC, RDON_REALLOG,
632 RDON_REWRITE, RDON_EXIM_FILTER, RDON_SIEVE_FILTER, RDON_PREPEND_HOME };
634 /* Results of filter or forward file processing. Some are only from a filter;
635 some are only from a forward file. */
638 FF_DELIVERED, /* Success, took significant action */
639 FF_NOTDELIVERED, /* Success, didn't take significant action */
640 FF_BLACKHOLE, /* Blackholing requested */
641 FF_DEFER, /* Defer requested */
642 FF_FAIL, /* Fail requested */
643 FF_INCLUDEFAIL, /* :include: failed */
644 FF_NONEXIST, /* Forward file does not exist */
645 FF_FREEZE, /* Freeze requested */
646 FF_ERROR /* We have a problem */
649 /* Values for identifying particular headers; printing characters are used, so
650 they can be read in the spool file for those headers that are permanently
651 marked. The lower case values don't get onto the spool; they are used only as
652 return values from header_checkname(). */
654 #define htype_other ' ' /* Unspecified header */
655 #define htype_from 'F'
658 #define htype_bcc 'B'
659 #define htype_id 'I' /* for message-id */
660 #define htype_reply_to 'R'
661 #define htype_received 'P' /* P for Postmark */
662 #define htype_sender 'S'
663 #define htype_old '*' /* Replaced header */
665 #define htype_date 'd'
666 #define htype_return_path 'p'
667 #define htype_delivery_date 'x'
668 #define htype_envelope_to 'e'
669 #define htype_subject 's'
671 /* These values are used only when adding new headers from an ACL; they too
672 never get onto the spool. The type of the added header is set by reference
673 to the header name, by calling header_checkname(). */
675 #define htype_add_top 'a'
676 #define htype_add_rec 'r'
677 #define htype_add_bot 'z'
678 #define htype_add_rfc 'f'
680 /* Types of item in options lists. These are the bottom 8 bits of the "type"
681 field, which is an int. The opt_void value is used for entries in tables that
682 point to special types of value that are accessed only indirectly (e.g. the
683 rewrite data that is built out of a string option.) We need to have some values
684 visible in local_scan, so the following are declared there:
686 opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed, opt_time,
689 To make sure we don't conflict, the local_scan.h values start from zero, and
690 those defined here start from 32. The boolean ones must all be together so they
691 can be easily tested as a group. That is the only use of opt_bool_last. */
693 enum { opt_bit = 32, opt_bool_verify, opt_bool_set, opt_expand_bool,
695 opt_rewrite, opt_timelist, opt_uid, opt_gid, opt_uidlist, opt_gidlist,
696 opt_expand_uid, opt_expand_gid, opt_func, opt_void };
698 /* There's a high-ish bit which is used to flag duplicate options, kept
699 for compatibility, which shouldn't be output. Also used for hidden options
700 that are automatically maintained from others. Another high bit is used to
701 flag driver options that although private (so as to be settable only on some
702 drivers), are stored in the instance block so as to be accessible from outside.
703 A third high bit is set when an option is read, so as to be able to give an
704 error if any option is set twice. Finally, there's a bit which is set when an
705 option is set with the "hide" prefix, to prevent -bP from showing it to
706 non-admin callers. The next byte up in the int is used to keep the bit number
707 for booleans that are kept in one bit. */
709 #define opt_hidden 0x100 /* Private to Exim */
710 #define opt_public 0x200 /* Stored in the main instance block */
711 #define opt_set 0x400 /* Option is set */
712 #define opt_secure 0x800 /* "hide" prefix used */
713 #define opt_rep_con 0x1000 /* Can be appended to by a repeated line (condition) */
714 #define opt_rep_str 0x2000 /* Can be appended to by a repeated line (string) */
715 #define opt_mask 0x00ff
717 /* Verify types when directing and routing */
719 enum { v_none, v_sender, v_recipient, v_expn };
721 /* Option flags for verify_address() */
723 #define vopt_fake_sender 0x0001 /* for verify=sender=<address> */
724 #define vopt_is_recipient 0x0002
725 #define vopt_qualify 0x0004
726 #define vopt_expn 0x0008
727 #define vopt_callout_fullpm 0x0010 /* full postmaster during callout */
728 #define vopt_callout_random 0x0020 /* during callout */
729 #define vopt_callout_no_cache 0x0040 /* disable callout cache */
730 #define vopt_callout_recipsender 0x0080 /* use real sender to verify recip */
731 #define vopt_callout_recippmaster 0x0100 /* use postmaster to verify recip */
732 #define vopt_callout_hold 0x0200 /* lazy close connection */
733 #define vopt_success_on_redirect 0x0400
735 /* Values for fields in callout cache records */
737 #define ccache_unknown 0 /* test hasn't been done */
738 #define ccache_accept 1
739 #define ccache_reject 2 /* All rejections except */
740 #define ccache_reject_mfnull 3 /* MAIL FROM:<> was rejected */
742 /* Options for lookup functions */
744 #define lookup_querystyle 1 /* query-style lookup */
745 #define lookup_absfile 2 /* requires absolute file name */
746 #define lookup_absfilequery 4 /* query-style starts with file name */
748 /* Status values for host_item blocks. Require hstatus_unusable and
749 hstatus_unusable_expired to be last. */
751 enum { hstatus_unknown, hstatus_usable, hstatus_unusable,
752 hstatus_unusable_expired };
754 /* Reasons why a host is unusable (for clearer log messages) */
756 enum { hwhy_unknown, hwhy_retry, hwhy_insecure, hwhy_failed, hwhy_deferred,
759 /* Domain lookup types for routers */
761 #define LK_DEFAULT BIT(0)
762 #define LK_BYNAME BIT(1)
763 #define LK_BYDNS BIT(2) /* those 3 should be mutually exclusive */
765 #define LK_IPV4_ONLY BIT(3)
766 #define LK_IPV4_PREFER BIT(4)
768 /* Values for the self_code fields */
770 enum { self_freeze, self_defer, self_send, self_reroute, self_pass, self_fail };
772 /* Flags for rewrite rules */
774 #define rewrite_sender 0x0001
775 #define rewrite_from 0x0002
776 #define rewrite_to 0x0004
777 #define rewrite_cc 0x0008
778 #define rewrite_bcc 0x0010
779 #define rewrite_replyto 0x0020
780 #define rewrite_all_headers 0x003F /* all header flags */
782 #define rewrite_envfrom 0x0040
783 #define rewrite_envto 0x0080
784 #define rewrite_all_envelope 0x00C0 /* all envelope flags */
786 #define rewrite_all (rewrite_all_headers | rewrite_all_envelope)
788 #define rewrite_smtp 0x0100 /* rewrite at SMTP time */
789 #define rewrite_smtp_sender 0x0200 /* SMTP sender rewrite (allows <>) */
790 #define rewrite_qualify 0x0400 /* qualify if necessary */
791 #define rewrite_repeat 0x0800 /* repeat rewrite rule */
793 #define rewrite_whole 0x1000 /* option bit for headers */
794 #define rewrite_quit 0x2000 /* "no more" option */
796 /* Flags for log_write(); LOG_MAIN, LOG_PANIC, and LOG_REJECT are also in
799 #define LOG_MAIN 1 /* Write to the main log */
800 #define LOG_PANIC 2 /* Write to the panic log */
801 #define LOG_PANIC_DIE 6 /* Write to the panic log and then die */
802 #define LOG_REJECT 16 /* Write to the reject log, with headers */
803 #define LOG_SENDER 32 /* Add raw sender to the message */
804 #define LOG_RECIPIENTS 64 /* Add raw recipients to the message */
805 #define LOG_CONFIG 128 /* Add "Exim configuration error" */
806 #define LOG_CONFIG_FOR (256+128) /* Add " for" instead of ":\n" */
807 #define LOG_CONFIG_IN (512+128) /* Add " in line x[ of file y]" */
809 /* and for debug_bits() logging action control: */
810 #define DEBUG_FROM_CONFIG 0x0001
812 /* SMTP command identifiers for the smtp_connection_had field that records the
813 most recent SMTP commands. Must be kept in step with the list of names in
814 smtp_in.c that is used for creating the smtp_no_mail logging action. SCH_NONE
817 enum { SCH_NONE, SCH_AUTH, SCH_DATA, SCH_BDAT,
818 SCH_EHLO, SCH_ETRN, SCH_EXPN, SCH_HELO,
819 SCH_HELP, SCH_MAIL, SCH_NOOP, SCH_QUIT, SCH_RCPT, SCH_RSET, SCH_STARTTLS,
822 /* Returns from host_find_by{name,dns}() */
825 HOST_FIND_FAILED, /* failed to find the host */
826 HOST_FIND_AGAIN, /* could not resolve at this time */
827 HOST_FIND_SECURITY, /* dnssec required but not acheived */
828 HOST_FOUND, /* found host */
829 HOST_FOUND_LOCAL, /* found, but MX points to local host */
830 HOST_IGNORED /* found but ignored - used internally only */
833 /* Flags for host_find_bydns() */
835 #define HOST_FIND_BY_SRV BIT(0)
836 #define HOST_FIND_BY_MX BIT(1)
837 #define HOST_FIND_BY_A BIT(2)
838 #define HOST_FIND_BY_AAAA BIT(3)
839 #define HOST_FIND_QUALIFY_SINGLE BIT(4)
840 #define HOST_FIND_SEARCH_PARENTS BIT(5)
841 #define HOST_FIND_IPV4_FIRST BIT(6)
842 #define HOST_FIND_IPV4_ONLY BIT(7)
844 /* Actions applied to specific messages. */
846 enum { MSG_DELIVER, MSG_FREEZE, MSG_REMOVE, MSG_THAW, MSG_ADD_RECIPIENT,
847 MSG_MARK_ALL_DELIVERED, MSG_MARK_DELIVERED, MSG_EDIT_SENDER,
848 MSG_SHOW_COPY, MSG_LOAD,
849 /* These ones must be last: a test for >= MSG_SHOW_BODY is used
850 to test for actions that list individual spool files. */
851 MSG_SHOW_BODY, MSG_SHOW_HEADER, MSG_SHOW_LOG };
853 /* Returns from the spool_read_header() function */
856 spool_read_OK, /* success */
857 spool_read_notopen, /* open failed */
858 spool_read_enverror, /* error in the envelope */
859 spool_read_hdrerror /* error in the headers */
862 /* Options for transport_write_message */
864 #define topt_add_return_path 0x001
865 #define topt_add_delivery_date 0x002
866 #define topt_add_envelope_to 0x004
867 #define topt_use_crlf 0x008 /* Terminate lines with CRLF */
868 #define topt_end_dot 0x010 /* Send terminating dot line */
869 #define topt_no_headers 0x020 /* Omit headers */
870 #define topt_no_body 0x040 /* Omit body */
871 #define topt_escape_headers 0x080 /* Apply escape check to headers */
872 #define topt_use_bdat 0x100 /* prepend chunks with RFC3030 BDAT header */
873 #define topt_output_string 0x200 /* create string rather than write to fd */
874 #define topt_continuation 0x400 /* do not reset buffer */
875 #define topt_not_socket 0x800 /* cannot do socket-only syscalls */
877 /* Options for smtp_write_command */
880 SCMD_FLUSH = 0, /* write to kernel */
881 SCMD_MORE, /* write to kernel, but likely more soon */
882 SCMD_BUFFER /* stash in application cmd output buffer */
885 /* Flags for recipient_block, used in DSN support */
887 #define rf_dsnlasthop 0x01 /* Do not propagate DSN any further */
888 #define rf_notify_never 0x02 /* NOTIFY= settings */
889 #define rf_notify_success 0x04
890 #define rf_notify_failure 0x08
891 #define rf_notify_delay 0x10
893 #define rf_dsnflags (rf_notify_never | rf_notify_success | \
894 rf_notify_failure | rf_notify_delay)
898 #define dsn_ret_full 1
899 #define dsn_ret_hdrs 2
901 #define dsn_support_unknown 0
902 #define dsn_support_yes 1
903 #define dsn_support_no 2
906 /* Codes for the host_find_failed and host_all_ignored options. */
911 #define hff_decline 3
915 /* Router information flags */
917 #define ri_yestransport 0x0001 /* Must have a transport */
918 #define ri_notransport 0x0002 /* Must not have a transport */
920 /* Codes for match types in match_check_list; to any of them, MCL_NOEXPAND may
923 #define MCL_NOEXPAND 16
925 enum { MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, MCL_LOCALPART };
927 /* Codes for the places from which ACLs can be called. These are cunningly
928 ordered to make it easy to implement tests for certain ACLs when processing
929 "control" modifiers, by means of a maximum "where" value. Do not modify this
930 order without checking carefully!
933 **** Furthermore, remember to keep these in step with the tables
934 **** of names and response codes in globals.c.
938 enum { ACL_WHERE_RCPT, /* Some controls are for RCPT only */
939 ACL_WHERE_MAIL, /* ) */
940 ACL_WHERE_PREDATA, /* ) There are several tests for "in message", */
941 ACL_WHERE_MIME, /* ) implemented by <= WHERE_NOTSMTP */
942 ACL_WHERE_DKIM, /* ) */
943 ACL_WHERE_DATA, /* ) */
945 ACL_WHERE_PRDR, /* ) */
947 ACL_WHERE_NOTSMTP, /* ) */
949 ACL_WHERE_AUTH, /* These remaining ones are not currently */
950 ACL_WHERE_CONNECT, /* required to be in a special order so they */
951 ACL_WHERE_ETRN, /* are just alphabetical. */
955 ACL_WHERE_NOTSMTP_START,
962 ACL_WHERE_UNKNOWN /* Currently used by a ${acl:name} expansion */
965 #define ACL_BIT_RCPT BIT(ACL_WHERE_RCPT)
966 #define ACL_BIT_MAIL BIT(ACL_WHERE_MAIL)
967 #define ACL_BIT_PREDATA BIT(ACL_WHERE_PREDATA)
968 #define ACL_BIT_MIME BIT(ACL_WHERE_MIME)
969 #define ACL_BIT_DKIM BIT(ACL_WHERE_DKIM)
970 #define ACL_BIT_DATA BIT(ACL_WHERE_DATA)
972 # define ACL_BIT_PRDR BIT(ACL_WHERE_PRDR)
974 #define ACL_BIT_NOTSMTP BIT(ACL_WHERE_NOTSMTP)
975 #define ACL_BIT_AUTH BIT(ACL_WHERE_AUTH)
976 #define ACL_BIT_CONNECT BIT(ACL_WHERE_CONNECT)
977 #define ACL_BIT_ETRN BIT(ACL_WHERE_ETRN)
978 #define ACL_BIT_EXPN BIT(ACL_WHERE_EXPN)
979 #define ACL_BIT_HELO BIT(ACL_WHERE_HELO)
980 #define ACL_BIT_MAILAUTH BIT(ACL_WHERE_MAILAUTH)
981 #define ACL_BIT_NOTSMTP_START BIT(ACL_WHERE_NOTSMTP_START)
982 #define ACL_BIT_NOTQUIT BIT(ACL_WHERE_NOTQUIT)
983 #define ACL_BIT_QUIT BIT(ACL_WHERE_QUIT)
984 #define ACL_BIT_STARTTLS BIT(ACL_WHERE_STARTTLS)
985 #define ACL_BIT_VRFY BIT(ACL_WHERE_VRFY)
986 #define ACL_BIT_DELIVERY BIT(ACL_WHERE_DELIVERY)
987 #define ACL_BIT_UNKNOWN BIT(ACL_WHERE_UNKNOWN)
990 /* Situations for spool_write_header() */
992 enum { SW_RECEIVING, SW_DELIVERING, SW_MODIFYING };
994 /* MX fields for hosts not obtained from MX records are always negative.
995 MX_NONE is the default case; lesser values are used when the hosts are
996 randomized in batches. */
1000 /* host_item.port defaults to PORT_NONE; the only current case where this
1001 is changed before running the transport is when an dnslookup router sets an
1002 explicit port number. */
1004 #define PORT_NONE (-1)
1006 /* Flags for single-key search defaults */
1008 #define SEARCH_STAR 0x01
1009 #define SEARCH_STARAT 0x02
1013 enum { FILTER_UNSET, FILTER_FORWARD, FILTER_EXIM, FILTER_SIEVE };
1015 /* Codes for ESMTP facilities offered by peer */
1017 #define OPTION_TLS BIT(0)
1018 #define OPTION_IGNQ BIT(1)
1019 #define OPTION_PRDR BIT(2)
1020 #define OPTION_UTF8 BIT(3)
1021 #define OPTION_DSN BIT(4)
1022 #define OPTION_PIPE BIT(5)
1023 #define OPTION_SIZE BIT(6)
1024 #define OPTION_CHUNKING BIT(7)
1025 #define OPTION_EARLY_PIPE BIT(8)
1027 /* Argument for *_getc */
1029 #define GETC_BUFFER_UNLIMITED UINT_MAX
1031 /* UTF-8 chars for line-drawing */
1033 #define UTF8_DOWN_RIGHT "\xE2\x95\xAD"
1034 #define UTF8_VERT "\xE2\x94\x82"
1035 #define UTF8_HORIZ "\xE2\x94\x80"
1036 #define UTF8_VERT_RIGHT "\xE2\x94\x9C"
1037 #define UTF8_UP_RIGHT "\xE2\x95\xB0"
1038 #define UTF8_VERT_2DASH "\xE2\x95\x8E"
1041 /* Options on tls_close */
1042 #define TLS_NO_SHUTDOWN 0
1043 #define TLS_SHUTDOWN_NOWAIT 1
1044 #define TLS_SHUTDOWN_WAIT 2
1047 #ifdef COMPILE_UTILITY
1048 # define ALARM(seconds) alarm(seconds);
1049 # define ALARM_CLR(seconds) alarm(seconds);
1051 /* For debugging of odd alarm-signal problems, stash caller info while the
1052 alarm is active. Clear it down on cancelling the alarm so we can tell there
1053 should not be one active. */
1055 # define ALARM(seconds) \
1056 debug_selector & D_any \
1057 ? (sigalarm_setter = CUS __FUNCTION__, alarm(seconds)) : alarm(seconds);
1058 # define ALARM_CLR(seconds) \
1059 debug_selector & D_any \
1060 ? (sigalarm_setter = NULL, alarm(seconds)) : alarm(seconds);
1063 #define AUTHS_REGEX US"\\n250[\\s\\-]AUTH\\s+([\\-\\w \\t]+)(?:\\n|$)"
1065 #define EARLY_PIPE_FEATURE_NAME "X_PIPE_CONNECT"
1066 #define EARLY_PIPE_FEATURE_LEN 14
1069 /* Flags for auth_client_item() */
1071 #define AUTH_ITEM_FIRST BIT(0)
1072 #define AUTH_ITEM_LAST BIT(1)
1073 #define AUTH_ITEM_IGN64 BIT(2)
1076 /* Flags for tls_{in,out}_resumption */
1077 #define RESUME_SUPPORTED BIT(0)
1078 #define RESUME_CLIENT_REQUESTED BIT(1)
1079 #define RESUME_CLIENT_SUGGESTED BIT(2)
1080 #define RESUME_SERVER_TICKET BIT(3)
1081 #define RESUME_USED BIT(4)
1083 #define RESUME_DECODE_STRING \
1084 US"not requested or offered : 0x02 :client requested, no server ticket" \
1085 ": 0x04 : 0x05 : 0x06 :client offered session, no server action" \
1086 ": 0x08 :no client request: 0x0A :client requested new ticket, server provided" \
1087 ": 0x0C :client offered session, not used: 0x0E :client offered session, server only provided new ticket" \
1088 ": 0x10 :session resumed unasked: 0x12 :session resumed unasked" \
1089 ": 0x14 : 0x15 : 0x16 :session resumed" \
1090 ": 0x18 :session resumed unasked: 0x1A :session resumed unasked" \
1091 ": 0x1C :session resumed: 0x1E :session resumed, also new ticket"
1093 /* Flags for string_vformat */
1094 #define SVFMT_EXTEND BIT(0)
1095 #define SVFMT_REBUFFER BIT(1)
1096 #define SVFMT_TAINT_NOCHK BIT(2)
1099 /* End of macros.h */