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