Commit | Line | Data |
---|---|---|
059ec3d9 PH |
1 | /************************************************* |
2 | * Exim - an Internet mail transport agent * | |
3 | *************************************************/ | |
4 | ||
f9ba5e22 | 5 | /* Copyright (c) University of Cambridge 1995 - 2018 */ |
059ec3d9 PH |
6 | /* See the file NOTICE for conditions of use and distribution. */ |
7 | ||
8 | ||
9 | /* 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 | ||
f846c8f5 JH |
15 | /* Number of elements of an array */ |
16 | #define nelem(arr) (sizeof(arr) / sizeof(*arr)) | |
17 | ||
9960d1e5 JH |
18 | /* Maximum of two items */ |
19 | #ifndef MAX | |
20 | # define MAX(a,b) ((a) > (b) ? (a) : (b)) | |
21 | #endif | |
22 | ||
059ec3d9 | 23 | |
8669f003 PH |
24 | /* When running in the test harness, the load average is fudged. */ |
25 | ||
26 | #define OS_GETLOADAVG() \ | |
8768d548 | 27 | (f.running_in_test_harness? (test_harness_load_avg += 10) : os_getloadavg()) |
8669f003 PH |
28 | |
29 | ||
7eb0e5d2 | 30 | /* The address_item structure has a struct full of 1-bit flags. These macros |
059ec3d9 PH |
31 | manipulate them. */ |
32 | ||
7eb0e5d2 JH |
33 | #define setflag(addr, flagname) addr->flags.flagname = TRUE |
34 | #define clearflag(addr, flagname) addr->flags.flagname = FALSE | |
059ec3d9 | 35 | |
7eb0e5d2 | 36 | #define testflag(addr, flagname) (addr->flags.flagname) |
059ec3d9 | 37 | |
7eb0e5d2 JH |
38 | #define copyflag(addrnew, addrold, flagname) \ |
39 | addrnew->flags.flagname = addrold->flags.flagname | |
059ec3d9 PH |
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 | ||
ce52b325 PP |
79 | /* Convenience for testing strings */ |
80 | ||
81 | #define streqic(Foo, Bar) (strcmpic(Foo, Bar) == 0) | |
82 | ||
83 | ||
059ec3d9 PH |
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 | |
74f1a423 | 88 | #define mac_smtp_fflush() if (tls_in.active.sock < 0) fflush(smtp_out); |
059ec3d9 PH |
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 | ||
e6d225ae | 106 | #define mac_islookup(a,b) ((lookup_list[a]->type & (b)) != 0) |
059ec3d9 PH |
107 | |
108 | /* Debugging control */ | |
109 | ||
bb07bcd3 JH |
110 | #define DEBUG(x) if (debug_selector & (x)) |
111 | #define HDEBUG(x) if (host_checking || (debug_selector & (x))) | |
059ec3d9 | 112 | |
55414b25 JH |
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 | ||
0e22dfd1 PH |
120 | /* The default From: text for DSNs */ |
121 | ||
122 | #define DEFAULT_DSN_FROM "Mail Delivery System <Mailer-Daemon@$qualify_domain>" | |
123 | ||
059ec3d9 PH |
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 | ||
b4ed4da0 PH |
154 | /* The size of the circular buffer that remembers recent SMTP commands */ |
155 | ||
156 | #define SMTP_HBUFF_SIZE 20 | |
157 | ||
059ec3d9 PH |
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 | ||
8523533c | 162 | #if defined PATH_MAX && PATH_MAX > 16384 |
f846c8f5 | 163 | # define BIG_BUFFER_SIZE PATH_MAX |
8523533c | 164 | #elif defined MAXPATHLEN && MAXPATHLEN > 16384 |
f846c8f5 | 165 | # define BIG_BUFFER_SIZE MAXPATHLEN |
059ec3d9 | 166 | #else |
f846c8f5 | 167 | # define BIG_BUFFER_SIZE 16384 |
059ec3d9 PH |
168 | #endif |
169 | ||
94431adb | 170 | /* header size of pipe content |
bd21a787 WB |
171 | currently: char id, char subid, char[5] length */ |
172 | #define PIPE_HEADER_SIZE 7 | |
173 | ||
059ec3d9 PH |
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 | ||
a3c86431 TL |
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. */ | |
cee5f132 | 198 | #ifdef SUPPORT_PROXY |
a3c86431 TL |
199 | #define PROXY_NEGOTIATION_TIMEOUT_SEC 3 |
200 | #define PROXY_NEGOTIATION_TIMEOUT_USEC 0 | |
201 | #endif | |
202 | ||
059ec3d9 PH |
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 | ||
e5a9dba6 | 216 | enum { RESET_NEXT, RESET_ANSWERS, RESET_AUTHORITY, RESET_ADDITIONAL }; |
059ec3d9 PH |
217 | |
218 | /* Argument values for the time-of-day function */ | |
219 | ||
f1e5fef5 PP |
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, | |
f5787926 | 222 | tod_mbx, tod_epoch, tod_epoch_l, tod_zulu }; |
059ec3d9 PH |
223 | |
224 | /* For identifying types of driver */ | |
225 | ||
226 | enum { | |
ba936fb8 JH |
227 | EXIM_DTYPE_NONE, |
228 | EXIM_DTYPE_ROUTER, | |
229 | EXIM_DTYPE_TRANSPORT | |
059ec3d9 PH |
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 */ | |
4840604e TL |
248 | #ifdef EXPERIMENTAL_DMARC |
249 | ,ERRMESS_DMARC_FORENSIC /* DMARC Forensic Report */ | |
250 | #endif | |
059ec3d9 PH |
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 | ||
f05da2e8 PH |
269 | /* Bit values for filter_test */ |
270 | ||
271 | #define FTEST_NONE 0 /* Not filter testing */ | |
272 | #define FTEST_USER 1 /* Testing user filter */ | |
8e669ac1 | 273 | #define FTEST_SYSTEM 2 /* Testing system filter */ |
f05da2e8 | 274 | |
059ec3d9 PH |
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 | ||
1a46a8c5 PH |
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 | |
9c5e5449 JH |
281 | change them unilaterally. |
282 | ||
283 | Use rc_names[] for debug strings. */ | |
059ec3d9 | 284 | |
f05da2e8 PH |
285 | #define OK 0 /* Successful match */ |
286 | #define DEFER 1 /* Defer - some problem */ | |
287 | #define FAIL 2 /* Matching failed */ | |
288 | #define ERROR 3 /* Internal or config error */ | |
1a46a8c5 | 289 | #define FAIL_FORCED 4 /* "Forced" failure */ |
059ec3d9 | 290 | /***********/ |
1a46a8c5 | 291 | #define DECLINE 5 /* Declined to handle the address, pass to next |
059ec3d9 | 292 | router unless no_more is set */ |
1a46a8c5 | 293 | #define PASS 6 /* Pass to next driver, or to pass_router, |
059ec3d9 | 294 | even if no_more is set */ |
1a46a8c5 PH |
295 | #define DISCARD 7 /* Address routed to :blackhole: or "seen finish" */ |
296 | #define SKIP 8 /* Skip this router (used in route_address only) */ | |
297 | #define REROUTED 9 /* Address was changed and child created*/ | |
298 | #define PANIC 10 /* Hard failed with internal error */ | |
299 | #define BAD64 11 /* Bad base64 data (auth) */ | |
300 | #define UNEXPECTED 12 /* Unexpected initial auth data */ | |
301 | #define CANCELLED 13 /* Authentication cancelled */ | |
302 | #define FAIL_SEND 14 /* send() failed in authenticator */ | |
303 | #define FAIL_DROP 15 /* Fail and drop connection (used in ACL) */ | |
059ec3d9 PH |
304 | |
305 | /* Returns from the deliver_message() function */ | |
306 | ||
307 | #define DELIVER_ATTEMPTED_NORMAL 0 /* Tried a normal delivery */ | |
308 | #define DELIVER_MUA_SUCCEEDED 1 /* Success when mua_wrapper is set */ | |
309 | #define DELIVER_MUA_FAILED 2 /* Failure when mua_wrapper is set */ | |
310 | #define DELIVER_NOT_ATTEMPTED 3 /* Not tried (no msg or is locked */ | |
311 | ||
312 | /* Returns from DNS lookup functions. */ | |
313 | ||
314 | enum { DNS_SUCCEED, DNS_NOMATCH, DNS_NODATA, DNS_AGAIN, DNS_FAIL }; | |
315 | ||
316 | /* Ending states when reading a message. The order is important. The test | |
317 | for having to swallow the rest of an SMTP message is whether the value is | |
318 | >= END_NOTENDED. */ | |
319 | ||
320 | #define END_NOTSTARTED 0 /* Message not started */ | |
321 | #define END_DOT 1 /* Message ended with '.' */ | |
322 | #define END_EOF 2 /* Message ended with EOF (error for SMTP) */ | |
323 | #define END_NOTENDED 3 /* Message reading not yet ended */ | |
324 | #define END_SIZE 4 /* Reading ended because message too big */ | |
325 | #define END_WERROR 5 /* Write error while reading the message */ | |
7e3ce68e JH |
326 | #define END_PROTOCOL 6 /* Protocol error in CHUNKING sequence */ |
327 | ||
328 | /* result codes for bdat_getc() (which can also return EOF) */ | |
329 | ||
330 | #define EOD (-2) | |
331 | #define ERR (-3) | |
332 | ||
059ec3d9 | 333 | |
6c6d6e48 TF |
334 | /* Bit masks for debug and log selectors */ |
335 | ||
336 | /* Assume words are 32 bits wide. Tiny waste of space on 64 bit | |
337 | platforms, but this ensures bit vectors always work the same way. */ | |
338 | #define BITWORDSIZE 32 | |
339 | ||
340 | /* This macro is for single-word bit vectors: the debug selector, | |
341 | and the first word of the log selector. */ | |
342 | #define BIT(n) (1 << (n)) | |
343 | ||
344 | /* And these are for multi-word vectors. */ | |
345 | #define BITWORD(n) ( (n) / BITWORDSIZE) | |
346 | #define BITMASK(n) (1 << (n) % BITWORDSIZE) | |
347 | ||
348 | #define BIT_CLEAR(s,z,n) ((s)[BITWORD(n)] &= ~BITMASK(n)) | |
349 | #define BIT_SET(s,z,n) ((s)[BITWORD(n)] |= BITMASK(n)) | |
350 | #define BIT_TEST(s,z,n) (((s)[BITWORD(n)] & BITMASK(n)) != 0) | |
351 | ||
352 | /* Used in globals.c for initializing bit_table structures. T will be either | |
4c04137d | 353 | D or L corresponding to the debug and log selector bits declared below. */ |
6c6d6e48 TF |
354 | |
355 | #define BIT_TABLE(T,name) { US #name, T##i_##name } | |
356 | ||
357 | /* IOTA allows us to keep an implicit sequential count, like a simple enum, | |
358 | but we can have sequentially numbered identifiers which are not declared | |
359 | sequentially. We use this for more compact declarations of bit indexes and | |
360 | masks, alternating between sequential bit index and corresponding mask. */ | |
361 | ||
362 | #define IOTA(iota) (__LINE__ - iota) | |
363 | #define IOTA_INIT(zero) (__LINE__ - zero + 1) | |
364 | ||
365 | /* Options bits for debugging. DEBUG_BIT() declares both a bit index and the | |
366 | corresponding mask. Di_all is a special value recognized by decode_bits(). | |
ae8f9024 | 367 | These must match the debug_options table in globals.c . |
6c6d6e48 TF |
368 | |
369 | Exim's code assumes in a number of places that the debug_selector is one | |
370 | word, and this is exposed in the local_scan ABI. The D_v and D_local_scan bit | |
371 | masks are part of the local_scan API so are #defined in local_scan.h */ | |
372 | ||
373 | #define DEBUG_BIT(name) Di_##name = IOTA(Di_iota), D_##name = BIT(Di_##name) | |
374 | ||
375 | enum { | |
376 | Di_all = -1, | |
377 | Di_v = 0, | |
378 | Di_local_scan = 1, | |
379 | ||
380 | Di_iota = IOTA_INIT(2), | |
381 | DEBUG_BIT(acl), | |
382 | DEBUG_BIT(auth), | |
383 | DEBUG_BIT(deliver), | |
384 | DEBUG_BIT(dns), | |
385 | DEBUG_BIT(dnsbl), | |
386 | DEBUG_BIT(exec), | |
387 | DEBUG_BIT(expand), | |
388 | DEBUG_BIT(filter), | |
389 | DEBUG_BIT(hints_lookup), | |
390 | DEBUG_BIT(host_lookup), | |
391 | DEBUG_BIT(ident), | |
392 | DEBUG_BIT(interface), | |
393 | DEBUG_BIT(lists), | |
394 | DEBUG_BIT(load), | |
395 | DEBUG_BIT(lookup), | |
396 | DEBUG_BIT(memory), | |
ae8f9024 | 397 | DEBUG_BIT(noutf8), |
6c6d6e48 TF |
398 | DEBUG_BIT(pid), |
399 | DEBUG_BIT(process_info), | |
400 | DEBUG_BIT(queue_run), | |
401 | DEBUG_BIT(receive), | |
402 | DEBUG_BIT(resolver), | |
403 | DEBUG_BIT(retry), | |
404 | DEBUG_BIT(rewrite), | |
405 | DEBUG_BIT(route), | |
406 | DEBUG_BIT(timestamp), | |
407 | DEBUG_BIT(tls), | |
408 | DEBUG_BIT(transport), | |
409 | DEBUG_BIT(uid), | |
410 | DEBUG_BIT(verify), | |
411 | }; | |
412 | ||
413 | /* Multi-bit debug masks */ | |
1fe64dcc PH |
414 | |
415 | #define D_all 0xffffffff | |
059ec3d9 PH |
416 | |
417 | #define D_any (D_all & \ | |
418 | ~(D_v | \ | |
ae8f9024 | 419 | D_noutf8 | \ |
059ec3d9 PH |
420 | D_pid | \ |
421 | D_timestamp) ) | |
422 | ||
59cf8544 | 423 | #define D_default (0xffffffff & \ |
059ec3d9 PH |
424 | ~(D_expand | \ |
425 | D_filter | \ | |
426 | D_interface | \ | |
427 | D_load | \ | |
428 | D_local_scan | \ | |
429 | D_memory | \ | |
ae8f9024 | 430 | D_noutf8 | \ |
059ec3d9 PH |
431 | D_pid | \ |
432 | D_timestamp | \ | |
433 | D_resolver)) | |
434 | ||
6c6d6e48 TF |
435 | /* Options bits for logging. Those that have values < BITWORDSIZE can be used |
436 | in calls to log_write(). The others are put into later words in log_selector | |
437 | and are only ever tested independently, so they do not need bit mask | |
438 | declarations. The Li_all value is recognized specially by decode_bits(). */ | |
439 | ||
440 | #define LOG_BIT(name) Li_##name = IOTA(Li_iota), L_##name = BIT(Li_##name) | |
441 | ||
442 | enum { | |
443 | Li_all = -1, | |
444 | ||
445 | Li_iota = IOTA_INIT(0), | |
446 | LOG_BIT(address_rewrite), | |
447 | LOG_BIT(all_parents), | |
448 | LOG_BIT(connection_reject), | |
449 | LOG_BIT(delay_delivery), | |
450 | LOG_BIT(dnslist_defer), | |
451 | LOG_BIT(etrn), | |
452 | LOG_BIT(host_lookup_failed), | |
453 | LOG_BIT(lost_incoming_connection), | |
454 | LOG_BIT(queue_run), | |
455 | LOG_BIT(retry_defer), | |
456 | LOG_BIT(size_reject), | |
457 | LOG_BIT(skip_delivery), | |
458 | LOG_BIT(smtp_connection), | |
459 | LOG_BIT(smtp_incomplete_transaction), | |
460 | LOG_BIT(smtp_protocol_error), | |
461 | LOG_BIT(smtp_syntax_error), | |
462 | ||
fc16abb4 JH |
463 | Li_8bitmime = BITWORDSIZE, |
464 | Li_acl_warn_skipped, | |
6c6d6e48 TF |
465 | Li_arguments, |
466 | Li_deliver_time, | |
467 | Li_delivery_size, | |
2c47372f JH |
468 | Li_dkim, |
469 | Li_dkim_verbose, | |
fc16abb4 | 470 | Li_dnssec, |
6c6d6e48 TF |
471 | Li_ident_timeout, |
472 | Li_incoming_interface, | |
473 | Li_incoming_port, | |
571b2715 | 474 | Li_millisec, |
fc16abb4 | 475 | Li_outgoing_interface, |
6c6d6e48 TF |
476 | Li_outgoing_port, |
477 | Li_pid, | |
7c576fca | 478 | Li_pipelining, |
fc16abb4 | 479 | Li_proxy, |
6c6d6e48 TF |
480 | Li_queue_time, |
481 | Li_queue_time_overall, | |
306c6c77 | 482 | Li_receive_time, |
6c6d6e48 TF |
483 | Li_received_sender, |
484 | Li_received_recipients, | |
485 | Li_rejected_header, | |
486 | Li_return_path_on_delivery, | |
487 | Li_sender_on_delivery, | |
488 | Li_sender_verify_fail, | |
489 | Li_smtp_confirmation, | |
fc16abb4 | 490 | Li_smtp_mailauth, |
6c6d6e48 TF |
491 | Li_smtp_no_mail, |
492 | Li_subject, | |
493 | Li_tls_certificate_verified, | |
494 | Li_tls_cipher, | |
495 | Li_tls_peerdn, | |
496 | Li_tls_sni, | |
497 | Li_unknown_in_list, | |
6c6d6e48 | 498 | |
fc16abb4 | 499 | log_selector_size = BITWORD(Li_unknown_in_list) + 1 |
6c6d6e48 TF |
500 | }; |
501 | ||
502 | #define LOGGING(opt) BIT_TEST(log_selector, log_selector_size, Li_##opt) | |
059ec3d9 PH |
503 | |
504 | /* Private error numbers for delivery failures, set negative so as not | |
37f3dc43 JH |
505 | to conflict with system errno values. Take care to maintain the string |
506 | table exim_errstrings[] in log.c */ | |
059ec3d9 PH |
507 | |
508 | #define ERRNO_UNKNOWNERROR (-1) | |
509 | #define ERRNO_USERSLASH (-2) | |
510 | #define ERRNO_EXISTRACE (-3) | |
511 | #define ERRNO_NOTREGULAR (-4) | |
512 | #define ERRNO_NOTDIRECTORY (-5) | |
513 | #define ERRNO_BADUGID (-6) | |
514 | #define ERRNO_BADMODE (-7) | |
515 | #define ERRNO_INODECHANGED (-8) | |
516 | #define ERRNO_LOCKFAILED (-9) | |
517 | #define ERRNO_BADADDRESS2 (-10) | |
518 | #define ERRNO_FORBIDPIPE (-11) | |
519 | #define ERRNO_FORBIDFILE (-12) | |
520 | #define ERRNO_FORBIDREPLY (-13) | |
521 | #define ERRNO_MISSINGPIPE (-14) | |
522 | #define ERRNO_MISSINGFILE (-15) | |
523 | #define ERRNO_MISSINGREPLY (-16) | |
524 | #define ERRNO_BADREDIRECT (-17) | |
525 | #define ERRNO_SMTPCLOSED (-18) | |
526 | #define ERRNO_SMTPFORMAT (-19) | |
527 | #define ERRNO_SPOOLFORMAT (-20) | |
528 | #define ERRNO_NOTABSOLUTE (-21) | |
529 | #define ERRNO_EXIMQUOTA (-22) /* Exim-imposed quota */ | |
530 | #define ERRNO_HELD (-23) | |
531 | #define ERRNO_FILTER_FAIL (-24) /* Delivery filter process failure */ | |
532 | #define ERRNO_CHHEADER_FAIL (-25) /* Delivery add/remove header failure */ | |
533 | #define ERRNO_WRITEINCOMPLETE (-26) /* Delivery write incomplete error */ | |
534 | #define ERRNO_EXPANDFAIL (-27) /* Some expansion failed */ | |
535 | #define ERRNO_GIDFAIL (-28) /* Failed to get gid */ | |
536 | #define ERRNO_UIDFAIL (-29) /* Failed to get uid */ | |
537 | #define ERRNO_BADTRANSPORT (-30) /* Unset or non-existent transport */ | |
538 | #define ERRNO_MBXLENGTH (-31) /* MBX length mismatch */ | |
bd4ece7d | 539 | #define ERRNO_UNKNOWNHOST (-32) /* Lookup failed routing or in smtp tpt */ |
059ec3d9 PH |
540 | #define ERRNO_FORMATUNKNOWN (-33) /* Can't match format in appendfile */ |
541 | #define ERRNO_BADCREATE (-34) /* Creation outside home in appendfile */ | |
542 | #define ERRNO_LISTDEFER (-35) /* Can't check a list; lookup defer */ | |
543 | #define ERRNO_DNSDEFER (-36) /* DNS lookup defer */ | |
544 | #define ERRNO_TLSFAILURE (-37) /* Failed to start TLS session */ | |
545 | #define ERRNO_TLSREQUIRED (-38) /* Mandatory TLS session not started */ | |
546 | #define ERRNO_CHOWNFAIL (-39) /* Failed to chown a file */ | |
547 | #define ERRNO_PIPEFAIL (-40) /* Failed to create a pipe */ | |
548 | #define ERRNO_CALLOUTDEFER (-41) /* When verifying */ | |
549 | #define ERRNO_AUTHFAIL (-42) /* When required by client */ | |
550 | #define ERRNO_CONNECTTIMEOUT (-43) /* Used internally in smtp transport */ | |
551 | #define ERRNO_RCPT4XX (-44) /* RCPT gave 4xx error */ | |
e97957bc PH |
552 | #define ERRNO_MAIL4XX (-45) /* MAIL gave 4xx error */ |
553 | #define ERRNO_DATA4XX (-46) /* DATA gave 4xx error */ | |
a3c86431 | 554 | #define ERRNO_PROXYFAIL (-47) /* Negotiation failed for proxy configured host */ |
7ade712c JH |
555 | #define ERRNO_AUTHPROB (-48) /* Authenticator "other" failure */ |
556 | ||
8c5d388a | 557 | #ifdef SUPPORT_I18N |
7ade712c JH |
558 | # define ERRNO_UTF8_FWD (-49) /* target not supporting SMTPUTF8 */ |
559 | #endif | |
8ac90765 JH |
560 | #if defined(SUPPORT_TLS) && defined(EXPERIMENTAL_REQUIRETLS) |
561 | # define ERRNO_REQUIRETLS (-50) /* REQUIRETLS session not started */ | |
562 | #endif | |
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 */ |
1fa1333c | 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 | ||
581 | enum { | |
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 | |
589 | information about errors for retry purposes. They are greater than 256, because | |
590 | the bottom byte contains 'A' or 'M' for remote addresses, to indicate whether | |
591 | the name was looked up only via an address record or whether MX records were | |
592 | used, respectively. */ | |
593 | ||
594 | #define RTEF_CTOUT 0x0100 /* Connection timed out */ | |
595 | ||
596 | /* Permission and other options for parse_extract_addresses(), | |
597 | filter_interpret(), and rda_interpret(), i.e. what special things are allowed | |
598 | in redirection operations. Not all apply to all cases. Some of the bits allow | |
599 | and some forbid, reflecting the "allow" and "forbid" options in the redirect | |
600 | router, 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 | |
631 | access (most of) the individual bits as separate options. This could be | |
632 | automated, but I haven't bothered. Keep this list in step with the above! */ | |
633 | ||
634 | enum { 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; | |
640 | some are only from a forward file. */ | |
641 | ||
642 | enum { | |
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 | |
655 | they can be read in the spool file for those headers that are permanently | |
656 | marked. The lower case values don't get onto the spool; they are used only as | |
657 | return 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 | |
677 | never get onto the spool. The type of the added header is set by reference | |
678 | to 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" | |
686 | field, which is an int. The opt_void value is used for entries in tables that | |
687 | point to special types of value that are accessed only indirectly (e.g. the | |
688 | rewrite data that is built out of a string option.) We need to have some values | |
689 | visible 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 | ||
694 | To make sure we don't conflict, the local_scan.h values start from zero, and | |
695 | those defined here start from 32. The boolean ones must all be together so they | |
696 | can be easily tested as a group. That is the only use of opt_bool_last. */ | |
697 | ||
698 | enum { 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 | |
704 | for compatibility, which shouldn't be output. Also used for hidden options | |
705 | that are automatically maintained from others. Another high bit is used to | |
706 | flag driver options that although private (so as to be settable only on some | |
707 | drivers), are stored in the instance block so as to be accessible from outside. | |
708 | A third high bit is set when an option is read, so as to be able to give an | |
709 | error if any option is set twice. Finally, there's a bit which is set when an | |
710 | option is set with the "hide" prefix, to prevent -bP from showing it to | |
711 | non-admin callers. The next byte up in the int is used to keep the bit number | |
712 | for 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 | ||
724 | enum { 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 | |
754 | hstatus_unusable_expired to be last. */ | |
755 | ||
756 | enum { 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 |
761 | enum { 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 | ||
775 | enum { 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 | |
802 | local_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 |
818 | most recent SMTP commands. Must be kept in step with the list of names in | |
819 | smtp_in.c that is used for creating the smtp_no_mail logging action. SCH_NONE | |
820 | is "empty". */ | |
821 | ||
18481de3 JH |
822 | enum { 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 | ||
829 | enum { | |
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 | ||
851 | enum { MSG_DELIVER, MSG_FREEZE, MSG_REMOVE, MSG_THAW, MSG_ADD_RECIPIENT, | |
852 | MSG_MARK_ALL_DELIVERED, MSG_MARK_DELIVERED, MSG_EDIT_SENDER, | |
a96603a0 PH |
853 | MSG_SHOW_COPY, MSG_LOAD, |
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 | ||
860 | enum { | |
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 | ||
884 | enum { | |
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 | |
926 | be added */ | |
927 | ||
928 | #define MCL_NOEXPAND 16 | |
929 | ||
930 | enum { 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 | |
933 | ordered 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 |
935 | order 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 | |
943 | enum { 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 | ||
997 | enum { SW_RECEIVING, SW_DELIVERING, SW_MODIFYING }; | |
998 | ||
999 | /* MX fields for hosts not obtained from MX records are always negative. | |
1000 | MX_NONE is the default case; lesser values are used when the hosts are | |
1001 | randomized in batches. */ | |
1002 | ||
1003 | #define MX_NONE (-1) | |
1004 | ||
1005 | /* host_item.port defaults to PORT_NONE; the only current case where this | |
1006 | is changed before running the transport is when an dnslookup router sets an | |
1007 | explicit 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 | ||
1018 | enum { 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) | |
1030 | #define OPTION_REQUIRETLS BIT(8) | |
1031 | #define OPTION_EARLY_PIPE BIT(9) | |
8ac90765 JH |
1032 | |
1033 | /* Codes for tls_requiretls requests (usually by sender) */ | |
1034 | ||
1035 | #define REQUIRETLS_MSG BIT(0) /* REQUIRETLS onward use */ | |
9094b84b | 1036 | |
bd8fbe36 JH |
1037 | /* Argument for *_getc */ |
1038 | ||
1039 | #define GETC_BUFFER_UNLIMITED UINT_MAX | |
1040 | ||
1b37ac39 JH |
1041 | /* UTF-8 chars for line-drawing */ |
1042 | ||
1043 | #define UTF8_DOWN_RIGHT "\xE2\x94\x8c" | |
1044 | #define UTF8_HORIZ "\xE2\x94\x80" | |
1045 | #define UTF8_VERT_RIGHT "\xE2\x94\x9C" | |
1046 | #define UTF8_UP_RIGHT "\xE2\x94\x94" | |
f9913671 | 1047 | #define UTF8_VERT_2DASH "\xE2\x95\x8E" |
1b37ac39 JH |
1048 | |
1049 | ||
dec766a1 WB |
1050 | /* Options on tls_close */ |
1051 | #define TLS_NO_SHUTDOWN 0 | |
1052 | #define TLS_SHUTDOWN_NOWAIT 1 | |
1053 | #define TLS_SHUTDOWN_WAIT 2 | |
1054 | ||
9094b84b | 1055 | |
c2a1bba0 JH |
1056 | #ifdef COMPILE_UTILITY |
1057 | # define ALARM(seconds) alarm(seconds); | |
1058 | # define ALARM_CLR(seconds) alarm(seconds); | |
1059 | #else | |
1060 | /* For debugging of odd alarm-signal problems, stash caller info while the | |
1061 | alarm is active. Clear it down on cancelling the alarm so we can tell there | |
1062 | should not be one active. */ | |
1063 | ||
1064 | # define ALARM(seconds) \ | |
1065 | debug_selector & D_any \ | |
48224640 | 1066 | ? (sigalarm_setter = CUS __FUNCTION__, alarm(seconds)) : alarm(seconds); |
c2a1bba0 JH |
1067 | # define ALARM_CLR(seconds) \ |
1068 | debug_selector & D_any \ | |
1069 | ? (sigalarm_setter = NULL, alarm(seconds)) : alarm(seconds); | |
1070 | #endif | |
1071 | ||
ee8b8090 JH |
1072 | #define AUTHS_REGEX US"\\n250[\\s\\-]AUTH\\s+([\\-\\w \\t]+)(?:\\n|$)" |
1073 | ||
1074 | #define EARLY_PIPE_FEATURE_NAME "X_PIPE_CONNECT" | |
1075 | #define EARLY_PIPE_FEATURE_LEN 14 | |
1076 | ||
1077 | ||
a310a8d0 JH |
1078 | /* Flags for auth_client_item() */ |
1079 | ||
1080 | #define AUTH_ITEM_FIRST BIT(0) | |
1081 | #define AUTH_ITEM_LAST BIT(1) | |
1082 | #define AUTH_ITEM_IGN64 BIT(2) | |
1083 | ||
1084 | ||
1085 | ||
059ec3d9 | 1086 | /* End of macros.h */ |