Commit | Line | Data |
---|---|---|
1130bfb0 | 1 | /* $Cambridge: exim/src/src/macros.h,v 1.19 2005/09/12 13:39:31 ph10 Exp $ */ |
059ec3d9 PH |
2 | |
3 | /************************************************* | |
4 | * Exim - an Internet mail transport agent * | |
5 | *************************************************/ | |
6 | ||
c988f1f4 | 7 | /* Copyright (c) University of Cambridge 1995 - 2005 */ |
059ec3d9 PH |
8 | /* See the file NOTICE for conditions of use and distribution. */ |
9 | ||
10 | ||
11 | /* These two macros make it possible to obtain the result of macro-expanding | |
12 | a string as a text string. This is sometimes useful for debugging output. */ | |
13 | ||
14 | #define mac_string(s) # s | |
15 | #define mac_expanded_string(s) mac_string(s) | |
16 | ||
17 | ||
18 | /* The address_item structure has a word full of 1-bit flags. These macros | |
19 | manipulate them. */ | |
20 | ||
21 | #define setflag(addr,flag) addr->flags |= (flag) | |
22 | #define clearflag(addr,flag) addr->flags &= ~(flag) | |
23 | ||
24 | #define testflag(addr,flag) ((addr->flags & (flag)) != 0) | |
25 | #define testflagsall(addr,flag) ((addr->flags & (flag)) == (flag)) | |
26 | ||
27 | #define copyflag(addrnew,addrold,flag) \ | |
28 | addrnew->flags = (addrnew->flags & ~(flag)) | (addrold->flags & (flag)) | |
29 | ||
30 | #define orflag(addrnew,addrold,flag) \ | |
31 | addrnew->flags |= addrold->flags & (flag) | |
32 | ||
33 | ||
34 | /* For almost all calls to convert things to printing characters, we want to | |
35 | allow tabs. A macro just makes life a bit easier. */ | |
36 | ||
37 | #define string_printing(s) string_printing2((s), TRUE) | |
38 | ||
39 | ||
40 | /* We need a special return code for "no recipients and failed to send an error | |
41 | message". ANSI C defines only EXIT_FAILURE and EXIT_SUCCESS. On the assumption | |
42 | that these are always 1 and 0 on Unix systems ... */ | |
43 | ||
44 | #define EXIT_NORECIPIENTS 2 | |
45 | ||
46 | ||
47 | /* Character-handling macros. It seems that the set of standard functions in | |
48 | ctype.h aren't actually all that useful. One reason for this is that email is | |
49 | international, so the concept of using a locale to vary what they do is not | |
50 | helpful. Another problem is that in different operating systems, the libraries | |
51 | yield different results, even in the default locale. For example, Linux yields | |
52 | TRUE for iscntrl() for all characters > 127, whereas many other systems yield | |
53 | FALSE. For these reasons we define our own set of macros for a number of | |
54 | character testing functions. Ensure that all these tests treat their arguments | |
55 | as unsigned. */ | |
56 | ||
57 | #define mac_iscntrl(c) \ | |
58 | ((uschar)(c) < 32 || (uschar)(c) == 127) | |
59 | ||
60 | #define mac_iscntrl_or_special(c) \ | |
61 | ((uschar)(c) < 32 || strchr(" ()<>@,;:\\\".[]\177", (uschar)(c)) != NULL) | |
62 | ||
63 | #define mac_isgraph(c) \ | |
64 | ((uschar)(c) > 32 && (uschar)(c) != 127) | |
65 | ||
66 | #define mac_isprint(c) \ | |
67 | (((uschar)(c) >= 32 && (uschar)(c) <= 126) || c == '\t' || \ | |
68 | ((uschar)(c) > 127 && print_topbitchars)) | |
69 | ||
70 | ||
71 | /* When built with TLS support, the act of flushing SMTP output becomes | |
72 | a no-op once an SSL session is in progress. */ | |
73 | ||
74 | #ifdef SUPPORT_TLS | |
f7b63901 | 75 | #define mac_smtp_fflush() if (tls_active < 0) fflush(smtp_out); |
059ec3d9 PH |
76 | #else |
77 | #define mac_smtp_fflush() fflush(smtp_out); | |
78 | #endif | |
79 | ||
80 | ||
81 | /* Define which ends of pipes are for reading and writing, as some systems | |
82 | don't make the file descriptors two-way. */ | |
83 | ||
84 | #define pipe_read 0 | |
85 | #define pipe_write 1 | |
86 | ||
87 | /* The RFC 1413 ident port */ | |
88 | ||
89 | #define IDENT_PORT 113 | |
90 | ||
91 | /* A macro to simplify testing bits in lookup types */ | |
92 | ||
93 | #define mac_islookup(a,b) ((lookup_list[a].type & (b)) != 0) | |
94 | ||
95 | /* Debugging control */ | |
96 | ||
97 | #define DEBUG(x) if ((debug_selector & (x)) != 0) | |
98 | #define HDEBUG(x) if (host_checking || (debug_selector & (x)) != 0) | |
99 | ||
100 | /* The size of the vector for saving/restoring address expansion pointers while | |
101 | verifying. This has to be explicit because it is referenced in more than one | |
102 | source module. */ | |
103 | ||
104 | #define ADDRESS_EXPANSIONS_COUNT 18 | |
105 | ||
106 | /* The maximum permitted number of command-line (-D) macro definitions. We | |
107 | need a limit only to make it easier to generate argument vectors for re-exec | |
108 | of Exim. */ | |
109 | ||
110 | #define MAX_CLMACROS 10 | |
111 | ||
112 | /* The number of integer variables available in filter files. If this is | |
113 | changed, then the tables in expand.c for accessing them must be changed too. */ | |
114 | ||
115 | #define FILTER_VARIABLE_COUNT 10 | |
116 | ||
117 | /* The size of the vector holding delay warning times */ | |
118 | ||
119 | #define DELAY_WARNING_SIZE 12 | |
120 | ||
121 | /* The size of the buffer holding the processing information string. */ | |
122 | ||
123 | #define PROCESS_INFO_SIZE 256 | |
124 | ||
125 | /* The size of buffer to get for constructing log entries. Make it big | |
126 | enough to hold all the headers from a normal kind of message. */ | |
127 | ||
128 | #define LOG_BUFFER_SIZE 8192 | |
129 | ||
130 | /* The initial size of a big buffer for use in various places. It gets put | |
131 | into big_buffer_size and in some circumstances increased. It should be at least | |
132 | as long as the maximum path length. */ | |
133 | ||
8523533c | 134 | #if defined PATH_MAX && PATH_MAX > 16384 |
059ec3d9 | 135 | #define BIG_BUFFER_SIZE PATH_MAX |
8523533c | 136 | #elif defined MAXPATHLEN && MAXPATHLEN > 16384 |
059ec3d9 PH |
137 | #define BIG_BUFFER_SIZE MAXPATHLEN |
138 | #else | |
8523533c | 139 | #define BIG_BUFFER_SIZE 16384 |
059ec3d9 PH |
140 | #endif |
141 | ||
142 | /* This limits the length of data returned by local_scan(). Because it is | |
143 | written on the spool, it gets read into big_buffer. */ | |
144 | ||
145 | #define LOCAL_SCAN_MAX_RETURN (BIG_BUFFER_SIZE - 24) | |
146 | ||
147 | /* A limit to the length of an address. RFC 2821 limits the local part to 64 | |
148 | and the domain to 255, so this should be adequate, taking into account quotings | |
149 | etc. */ | |
150 | ||
151 | #define ADDRESS_MAXLENGTH 512 | |
152 | ||
153 | /* The length of the base names of spool files, which consist of an internal | |
154 | message id with a trailing "-H" or "-D" added. */ | |
155 | ||
156 | #define SPOOL_NAME_LENGTH (MESSAGE_ID_LENGTH+2) | |
157 | ||
158 | /* The maximum number of message ids to store in a waiting database | |
159 | record. */ | |
160 | ||
161 | #define WAIT_NAME_MAX 50 | |
162 | ||
163 | /* The numbers of connection and message variables for ACLs */ | |
164 | ||
165 | #define ACL_C_MAX 10 | |
166 | #define ACL_M_MAX 10 | |
167 | ||
168 | /* Fixed option values for all PCRE functions */ | |
169 | ||
170 | #define PCRE_COPT 0 /* compile */ | |
171 | #define PCRE_EOPT 0 /* exec */ | |
172 | ||
173 | /* Macros for trivial functions */ | |
174 | ||
175 | #define mac_ismsgid(s) \ | |
176 | (pcre_exec(regex_ismsgid,NULL,CS s,Ustrlen(s),0,PCRE_EOPT,NULL,0) >= 0) | |
177 | ||
178 | ||
179 | /* Options for dns_next_rr */ | |
180 | ||
e5a9dba6 | 181 | enum { RESET_NEXT, RESET_ANSWERS, RESET_AUTHORITY, RESET_ADDITIONAL }; |
059ec3d9 PH |
182 | |
183 | /* Argument values for the time-of-day function */ | |
184 | ||
185 | enum { tod_log, tod_log_bare, tod_log_zone, tod_log_datestamp, | |
186 | tod_zone, tod_full, tod_bsdin, tod_mbx, tod_epoch, tod_zulu }; | |
187 | ||
188 | /* For identifying types of driver */ | |
189 | ||
190 | enum { | |
191 | DTYPE_NONE, | |
192 | DTYPE_ROUTER, | |
193 | DTYPE_TRANSPORT | |
194 | }; | |
195 | ||
196 | /* Error numbers for generating error messages when reading a message on the | |
197 | standard input. */ | |
198 | ||
199 | enum { | |
200 | ERRMESS_BADARGADDRESS, /* Bad address via argument list */ | |
201 | ERRMESS_BADADDRESS, /* Bad address read via -t */ | |
202 | ERRMESS_NOADDRESS, /* Message has no addresses */ | |
203 | ERRMESS_IGADDRESS, /* All -t addresses ignored */ | |
204 | ERRMESS_BADNOADDRESS, /* Bad address via -t, leaving none */ | |
205 | ERRMESS_IOERR, /* I/O error while reading a message */ | |
206 | ERRMESS_VLONGHEADER, /* Excessively long message header */ | |
207 | ERRMESS_VLONGHDRLINE, /* Excessively long single line in header */ | |
208 | ERRMESS_TOOBIG, /* Message too big */ | |
209 | ERRMESS_TOOMANYRECIP, /* Too many recipients */ | |
210 | ERRMESS_LOCAL_SCAN, /* Rejected by local scan */ | |
211 | ERRMESS_LOCAL_ACL /* Rejected by non-SMTP ACL */ | |
212 | }; | |
213 | ||
214 | /* Error handling styles - set by option, and apply only when receiving | |
215 | a local message not via SMTP. */ | |
216 | ||
217 | enum { | |
218 | ERRORS_SENDER, /* Return to sender (default) */ | |
219 | ERRORS_STDERR /* Write on stderr */ | |
220 | }; | |
221 | ||
222 | /* Exec control values when Exim execs itself via child_exec_exim. */ | |
223 | ||
224 | enum { | |
225 | CEE_RETURN_ARGV, /* Don't exec, just build and return argv */ | |
226 | CEE_EXEC_EXIT, /* Just exit if exec fails */ | |
227 | CEE_EXEC_PANIC /* Panic-die if exec fails */ | |
228 | }; | |
229 | ||
f05da2e8 PH |
230 | /* Bit values for filter_test */ |
231 | ||
232 | #define FTEST_NONE 0 /* Not filter testing */ | |
233 | #define FTEST_USER 1 /* Testing user filter */ | |
8e669ac1 | 234 | #define FTEST_SYSTEM 2 /* Testing system filter */ |
f05da2e8 | 235 | |
059ec3d9 PH |
236 | /* Returns from the routing, transport and authentication functions (not all |
237 | apply to all of them). Some other functions also use these convenient values, | |
238 | and some additional values are used only by non-driver functions. | |
239 | ||
1a46a8c5 PH |
240 | OK, FAIL, DEFER, ERROR, and FAIL_FORCED are also declared in local_scan.h for |
241 | use in the local_scan() function and in ${dlfunc loaded functions. Do not | |
242 | change them unilaterally. */ | |
059ec3d9 | 243 | |
f05da2e8 PH |
244 | #define OK 0 /* Successful match */ |
245 | #define DEFER 1 /* Defer - some problem */ | |
246 | #define FAIL 2 /* Matching failed */ | |
247 | #define ERROR 3 /* Internal or config error */ | |
1a46a8c5 | 248 | #define FAIL_FORCED 4 /* "Forced" failure */ |
059ec3d9 | 249 | /***********/ |
1a46a8c5 | 250 | #define DECLINE 5 /* Declined to handle the address, pass to next |
059ec3d9 | 251 | router unless no_more is set */ |
1a46a8c5 | 252 | #define PASS 6 /* Pass to next driver, or to pass_router, |
059ec3d9 | 253 | even if no_more is set */ |
1a46a8c5 PH |
254 | #define DISCARD 7 /* Address routed to :blackhole: or "seen finish" */ |
255 | #define SKIP 8 /* Skip this router (used in route_address only) */ | |
256 | #define REROUTED 9 /* Address was changed and child created*/ | |
257 | #define PANIC 10 /* Hard failed with internal error */ | |
258 | #define BAD64 11 /* Bad base64 data (auth) */ | |
259 | #define UNEXPECTED 12 /* Unexpected initial auth data */ | |
260 | #define CANCELLED 13 /* Authentication cancelled */ | |
261 | #define FAIL_SEND 14 /* send() failed in authenticator */ | |
262 | #define FAIL_DROP 15 /* Fail and drop connection (used in ACL) */ | |
059ec3d9 PH |
263 | |
264 | /* Returns from the deliver_message() function */ | |
265 | ||
266 | #define DELIVER_ATTEMPTED_NORMAL 0 /* Tried a normal delivery */ | |
267 | #define DELIVER_MUA_SUCCEEDED 1 /* Success when mua_wrapper is set */ | |
268 | #define DELIVER_MUA_FAILED 2 /* Failure when mua_wrapper is set */ | |
269 | #define DELIVER_NOT_ATTEMPTED 3 /* Not tried (no msg or is locked */ | |
270 | ||
271 | /* Returns from DNS lookup functions. */ | |
272 | ||
273 | enum { DNS_SUCCEED, DNS_NOMATCH, DNS_NODATA, DNS_AGAIN, DNS_FAIL }; | |
274 | ||
275 | /* Ending states when reading a message. The order is important. The test | |
276 | for having to swallow the rest of an SMTP message is whether the value is | |
277 | >= END_NOTENDED. */ | |
278 | ||
279 | #define END_NOTSTARTED 0 /* Message not started */ | |
280 | #define END_DOT 1 /* Message ended with '.' */ | |
281 | #define END_EOF 2 /* Message ended with EOF (error for SMTP) */ | |
282 | #define END_NOTENDED 3 /* Message reading not yet ended */ | |
283 | #define END_SIZE 4 /* Reading ended because message too big */ | |
284 | #define END_WERROR 5 /* Write error while reading the message */ | |
285 | ||
286 | /* Options bits for debugging; D_v and D_local_scan are also in local_scan.h */ | |
287 | ||
288 | #define D_v 0x00000001 | |
289 | #define D_local_scan 0x00000002 | |
290 | ||
291 | #define D_acl 0x00000004 | |
292 | #define D_auth 0x00000008 | |
293 | #define D_deliver 0x00000010 | |
294 | #define D_dns 0x00000020 | |
295 | #define D_dnsbl 0x00000040 | |
296 | #define D_exec 0x00000080 | |
297 | #define D_expand 0x00000100 | |
298 | #define D_filter 0x00000200 | |
299 | #define D_hints_lookup 0x00000400 | |
300 | #define D_host_lookup 0x00000800 | |
301 | #define D_ident 0x00001000 | |
302 | #define D_interface 0x00002000 | |
303 | #define D_lists 0x00004000 | |
304 | #define D_load 0x00008000 | |
305 | #define D_lookup 0x00010000 | |
306 | #define D_memory 0x00020000 | |
307 | #define D_pid 0x00040000 | |
308 | #define D_process_info 0x00080000 | |
309 | #define D_queue_run 0x00100000 | |
310 | #define D_receive 0x00200000 | |
311 | #define D_resolver 0x00400000 | |
312 | #define D_retry 0x00800000 | |
313 | #define D_rewrite 0x01000000 | |
314 | #define D_route 0x02000000 | |
315 | #define D_timestamp 0x04000000 | |
316 | #define D_tls 0x08000000 | |
317 | #define D_transport 0x10000000 | |
318 | #define D_uid 0x20000000 | |
319 | #define D_verify 0x40000000 | |
320 | ||
1fe64dcc PH |
321 | /* The D_all value must always have all bits set, as it is recognized specially |
322 | by the function that decodes debug and log selectors. This is to enable it to | |
323 | set all the bits in a multi-word selector. Debug doesn't use this yet, but we | |
324 | are getting close. In fact, we want to omit "memory" for -d+all, but can't | |
325 | handle this here. It is fudged externally. */ | |
326 | ||
327 | #define D_all 0xffffffff | |
059ec3d9 PH |
328 | |
329 | #define D_any (D_all & \ | |
330 | ~(D_v | \ | |
331 | D_pid | \ | |
332 | D_timestamp) ) | |
333 | ||
59cf8544 | 334 | #define D_default (0xffffffff & \ |
059ec3d9 PH |
335 | ~(D_expand | \ |
336 | D_filter | \ | |
337 | D_interface | \ | |
338 | D_load | \ | |
339 | D_local_scan | \ | |
340 | D_memory | \ | |
341 | D_pid | \ | |
342 | D_timestamp | \ | |
343 | D_resolver)) | |
344 | ||
345 | /* Options bits for logging. Those that will end up in log_write_selector have | |
346 | values < 0x80000000. They can be used in calls to log_write(). The others have | |
347 | values > 0x80000000 and are put into log_extra_selector (without the top bit). | |
348 | These are only ever tested independently. "All" is a magic value that is used | |
349 | only in the name table to set all options in both bit maps. */ | |
350 | ||
1fe64dcc PH |
351 | /* The L_all value must always have all bits set, as it is recognized specially |
352 | by the function that decodes debug and log selectors. This is to enable it to | |
353 | set all the bits in a multi-word selector. */ | |
354 | ||
059ec3d9 PH |
355 | #define L_all 0xffffffff |
356 | ||
357 | #define L_address_rewrite 0x00000001 | |
358 | #define L_all_parents 0x00000002 | |
359 | #define L_connection_reject 0x00000004 | |
360 | #define L_delay_delivery 0x00000008 | |
361 | #define L_dnslist_defer 0x00000010 | |
362 | #define L_etrn 0x00000020 | |
363 | #define L_host_lookup_failed 0x00000040 | |
364 | #define L_lost_incoming_connection 0x00000080 | |
365 | #define L_queue_run 0x00000100 | |
366 | #define L_retry_defer 0x00000200 | |
367 | #define L_size_reject 0x00000400 | |
368 | #define L_skip_delivery 0x00000800 | |
369 | #define L_smtp_connection 0x00001000 | |
370 | #define L_smtp_incomplete_transaction 0x00002000 | |
371 | #define L_smtp_protocol_error 0x00004000 | |
372 | #define L_smtp_syntax_error 0x00008000 | |
373 | ||
374 | #define LX_arguments 0x80000001 | |
375 | #define LX_deliver_time 0x80000002 | |
376 | #define LX_delivery_size 0x80000004 | |
377 | #define LX_ident_timeout 0x80000008 | |
378 | #define LX_incoming_interface 0x80000010 | |
379 | #define LX_incoming_port 0x80000020 | |
380 | #define LX_outgoing_port 0x80000040 | |
381 | #define LX_queue_time 0x80000080 | |
2ac0e484 PH |
382 | #define LX_queue_time_overall 0x80000100 |
383 | #define LX_received_sender 0x80000200 | |
384 | #define LX_received_recipients 0x80000400 | |
385 | #define LX_rejected_header 0x80000800 | |
386 | #define LX_return_path_on_delivery 0x80001000 | |
387 | #define LX_sender_on_delivery 0x80002000 | |
388 | #define LX_smtp_confirmation 0x80004000 | |
389 | #define LX_subject 0x80008000 | |
390 | #define LX_tls_certificate_verified 0x80010000 | |
391 | #define LX_tls_cipher 0x80020000 | |
392 | #define LX_tls_peerdn 0x80040000 | |
1130bfb0 | 393 | #define LX_unknown_in_list 0x80080000 |
059ec3d9 PH |
394 | |
395 | #define L_default (L_connection_reject | \ | |
396 | L_delay_delivery | \ | |
397 | L_dnslist_defer | \ | |
398 | L_etrn | \ | |
399 | L_host_lookup_failed | \ | |
400 | L_lost_incoming_connection | \ | |
401 | L_queue_run | \ | |
402 | L_retry_defer | \ | |
403 | L_size_reject | \ | |
404 | L_skip_delivery) | |
405 | ||
406 | #define LX_default ((LX_rejected_header | \ | |
407 | LX_tls_cipher) & 0x7fffffff) | |
408 | ||
409 | /* Private error numbers for delivery failures, set negative so as not | |
410 | to conflict with system errno values. */ | |
411 | ||
412 | #define ERRNO_UNKNOWNERROR (-1) | |
413 | #define ERRNO_USERSLASH (-2) | |
414 | #define ERRNO_EXISTRACE (-3) | |
415 | #define ERRNO_NOTREGULAR (-4) | |
416 | #define ERRNO_NOTDIRECTORY (-5) | |
417 | #define ERRNO_BADUGID (-6) | |
418 | #define ERRNO_BADMODE (-7) | |
419 | #define ERRNO_INODECHANGED (-8) | |
420 | #define ERRNO_LOCKFAILED (-9) | |
421 | #define ERRNO_BADADDRESS2 (-10) | |
422 | #define ERRNO_FORBIDPIPE (-11) | |
423 | #define ERRNO_FORBIDFILE (-12) | |
424 | #define ERRNO_FORBIDREPLY (-13) | |
425 | #define ERRNO_MISSINGPIPE (-14) | |
426 | #define ERRNO_MISSINGFILE (-15) | |
427 | #define ERRNO_MISSINGREPLY (-16) | |
428 | #define ERRNO_BADREDIRECT (-17) | |
429 | #define ERRNO_SMTPCLOSED (-18) | |
430 | #define ERRNO_SMTPFORMAT (-19) | |
431 | #define ERRNO_SPOOLFORMAT (-20) | |
432 | #define ERRNO_NOTABSOLUTE (-21) | |
433 | #define ERRNO_EXIMQUOTA (-22) /* Exim-imposed quota */ | |
434 | #define ERRNO_HELD (-23) | |
435 | #define ERRNO_FILTER_FAIL (-24) /* Delivery filter process failure */ | |
436 | #define ERRNO_CHHEADER_FAIL (-25) /* Delivery add/remove header failure */ | |
437 | #define ERRNO_WRITEINCOMPLETE (-26) /* Delivery write incomplete error */ | |
438 | #define ERRNO_EXPANDFAIL (-27) /* Some expansion failed */ | |
439 | #define ERRNO_GIDFAIL (-28) /* Failed to get gid */ | |
440 | #define ERRNO_UIDFAIL (-29) /* Failed to get uid */ | |
441 | #define ERRNO_BADTRANSPORT (-30) /* Unset or non-existent transport */ | |
442 | #define ERRNO_MBXLENGTH (-31) /* MBX length mismatch */ | |
443 | #define ERRNO_UNKNOWNHOST (-32) /* Lookup failed in smtp transport */ | |
444 | #define ERRNO_FORMATUNKNOWN (-33) /* Can't match format in appendfile */ | |
445 | #define ERRNO_BADCREATE (-34) /* Creation outside home in appendfile */ | |
446 | #define ERRNO_LISTDEFER (-35) /* Can't check a list; lookup defer */ | |
447 | #define ERRNO_DNSDEFER (-36) /* DNS lookup defer */ | |
448 | #define ERRNO_TLSFAILURE (-37) /* Failed to start TLS session */ | |
449 | #define ERRNO_TLSREQUIRED (-38) /* Mandatory TLS session not started */ | |
450 | #define ERRNO_CHOWNFAIL (-39) /* Failed to chown a file */ | |
451 | #define ERRNO_PIPEFAIL (-40) /* Failed to create a pipe */ | |
452 | #define ERRNO_CALLOUTDEFER (-41) /* When verifying */ | |
453 | #define ERRNO_AUTHFAIL (-42) /* When required by client */ | |
454 | #define ERRNO_CONNECTTIMEOUT (-43) /* Used internally in smtp transport */ | |
455 | #define ERRNO_RCPT4XX (-44) /* RCPT gave 4xx error */ | |
456 | ||
457 | /* These must be last, so all retry deferments can easily be identified */ | |
458 | ||
459 | #define ERRNO_RETRY_BASE (-51) /* Base to test against */ | |
460 | #define ERRNO_RRETRY (-51) /* Not time for routing */ | |
461 | #define ERRNO_LRETRY (-52) /* Not time for local delivery */ | |
462 | #define ERRNO_HRETRY (-53) /* Not time for any remote host */ | |
463 | #define ERRNO_LOCAL_ONLY (-54) /* Local-only delivery */ | |
464 | #define ERRNO_QUEUE_DOMAIN (-55) /* Domain in queue_domains */ | |
465 | ||
466 | /* Special actions to take after failure or deferment. */ | |
467 | ||
468 | enum { | |
469 | SPECIAL_NONE, /* No special action */ | |
470 | SPECIAL_FREEZE, /* Freeze message */ | |
471 | SPECIAL_FAIL, /* Fail the delivery */ | |
472 | SPECIAL_WARN /* Send a warning message */ | |
473 | }; | |
474 | ||
475 | /* Flags that get ORed into the more_errno field of an address to give more | |
476 | information about errors for retry purposes. They are greater than 256, because | |
477 | the bottom byte contains 'A' or 'M' for remote addresses, to indicate whether | |
478 | the name was looked up only via an address record or whether MX records were | |
479 | used, respectively. */ | |
480 | ||
481 | #define RTEF_CTOUT 0x0100 /* Connection timed out */ | |
482 | ||
483 | /* Permission and other options for parse_extract_addresses(), | |
484 | filter_interpret(), and rda_interpret(), i.e. what special things are allowed | |
485 | in redirection operations. Not all apply to all cases. Some of the bits allow | |
486 | and some forbid, reflecting the "allow" and "forbid" options in the redirect | |
487 | router, which were chosen to represent the standard situation for users' | |
488 | .forward files. */ | |
489 | ||
23c7ff99 PH |
490 | #define RDO_BLACKHOLE 0x00000001 /* Forbid :blackhole: */ |
491 | #define RDO_DEFER 0x00000002 /* Allow :defer: or "defer" */ | |
492 | #define RDO_EACCES 0x00000004 /* Ignore EACCES */ | |
493 | #define RDO_ENOTDIR 0x00000008 /* Ignore ENOTDIR */ | |
494 | #define RDO_EXISTS 0x00000010 /* Forbid "exists" in expansion in filter */ | |
495 | #define RDO_FAIL 0x00000020 /* Allow :fail: or "fail" */ | |
496 | #define RDO_FILTER 0x00000040 /* Allow a filter script */ | |
497 | #define RDO_FREEZE 0x00000080 /* Allow "freeze" */ | |
498 | #define RDO_INCLUDE 0x00000100 /* Forbid :include: */ | |
499 | #define RDO_LOG 0x00000200 /* Forbid "log" */ | |
500 | #define RDO_LOOKUP 0x00000400 /* Forbid "lookup" in expansion in filter */ | |
501 | #define RDO_PERL 0x00000800 /* Forbid "perl" in expansion in filter */ | |
502 | #define RDO_READFILE 0x00001000 /* Forbid "readfile" in exp in filter */ | |
503 | #define RDO_READSOCK 0x00002000 /* Forbid "readsocket" in exp in filter */ | |
504 | #define RDO_RUN 0x00004000 /* Forbid "run" in expansion in filter */ | |
1a46a8c5 PH |
505 | #define RDO_DLFUNC 0x00008000 /* Forbid "dlfunc" in expansion in filter */ |
506 | #define RDO_REALLOG 0x00010000 /* Really do log (not testing/verifying) */ | |
507 | #define RDO_REWRITE 0x00020000 /* Rewrite generated addresses */ | |
508 | #define RDO_EXIM_FILTER 0x00040000 /* Forbid Exim filters */ | |
509 | #define RDO_SIEVE_FILTER 0x00080000 /* Forbid Sieve filters */ | |
059ec3d9 PH |
510 | |
511 | /* This is the set that apply to expansions in filters */ | |
512 | ||
513 | #define RDO_FILTER_EXPANSIONS \ | |
1a46a8c5 | 514 | (RDO_EXISTS|RDO_LOOKUP|RDO_PERL|RDO_READFILE|RDO_READSOCK|RDO_RUN|RDO_DLFUNC) |
059ec3d9 PH |
515 | |
516 | /* As well as the RDO bits themselves, we need the bit numbers in order to | |
517 | access (most of) the individual bits as separate options. This could be | |
518 | automated, but I haven't bothered. Keep this list in step with the above! */ | |
519 | ||
520 | enum { RDON_BLACKHOLE, RDON_DEFER, RDON_EACCES, RDON_ENOTDIR, RDON_EXISTS, | |
521 | RDON_FAIL, RDON_FILTER, RDON_FREEZE, RDON_INCLUDE, RDON_LOG, RDON_LOOKUP, | |
1a46a8c5 | 522 | RDON_PERL, RDON_READFILE, RDON_READSOCK, RDON_RUN, RDON_DLFUNC, RDON_REALLOG, |
23c7ff99 | 523 | RDON_REWRITE, RDON_EXIM_FILTER, RDON_SIEVE_FILTER }; |
059ec3d9 PH |
524 | |
525 | /* Results of filter or forward file processing. Some are only from a filter; | |
526 | some are only from a forward file. */ | |
527 | ||
528 | enum { | |
529 | FF_DELIVERED, /* Success, took significant action */ | |
530 | FF_NOTDELIVERED, /* Success, didn't take significant action */ | |
531 | FF_BLACKHOLE, /* Blackholing requested */ | |
532 | FF_DEFER, /* Defer requested */ | |
533 | FF_FAIL, /* Fail requested */ | |
534 | FF_INCLUDEFAIL, /* :include: failed */ | |
535 | FF_NONEXIST, /* Forward file does not exist */ | |
536 | FF_FREEZE, /* Freeze requested */ | |
537 | FF_ERROR /* We have a problem */ | |
538 | }; | |
539 | ||
540 | /* Values for identifying particular headers; printing characters are used, so | |
541 | they can be read in the spool file for those headers that are permanently | |
542 | marked. The lower case values don't get onto the spool; they are used only as | |
543 | return values from header_checkname(). */ | |
544 | ||
545 | #define htype_other ' ' /* Unspecified header */ | |
546 | #define htype_from 'F' | |
547 | #define htype_to 'T' | |
548 | #define htype_cc 'C' | |
549 | #define htype_bcc 'B' | |
550 | #define htype_id 'I' /* for message-id */ | |
551 | #define htype_reply_to 'R' | |
552 | #define htype_received 'P' /* P for Postmark */ | |
553 | #define htype_sender 'S' | |
554 | #define htype_old '*' /* Replaced header */ | |
555 | ||
556 | #define htype_date 'd' | |
557 | #define htype_return_path 'p' | |
558 | #define htype_delivery_date 'x' | |
559 | #define htype_envelope_to 'e' | |
560 | #define htype_subject 's' | |
561 | ||
562 | /* These values are used only when adding new headers from an ACL; they too | |
563 | never get onto the spool. The type of the added header is set by reference | |
564 | to the header name, by calling header_checkname(). */ | |
565 | ||
566 | #define htype_add_top 'a' | |
567 | #define htype_add_rec 'r' | |
568 | #define htype_add_bot 'z' | |
8523533c | 569 | #define htype_add_rfc 'f' |
059ec3d9 PH |
570 | |
571 | /* Types of item in options lists. These are the bottom 8 bits of the "type" | |
572 | field, which is an int. The opt_void value is used for entries in tables that | |
573 | point to special types of value that are accessed only indirectly (e.g. the | |
574 | rewrite data that is built out of a string option.) We need to have some values | |
575 | visible in local_scan, so the following are declared there: | |
576 | ||
577 | opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed, opt_time, | |
578 | opt_bool | |
579 | ||
580 | To make sure we don't conflict, the local_scan.h values start from zero, and | |
581 | those defined here start from 32. The boolean ones must all be together so they | |
582 | can be easily tested as a group. That is the only use of opt_bool_last. */ | |
583 | ||
584 | enum { opt_bit = 32, opt_bool_verify, opt_bool_set, opt_expand_bool, | |
585 | opt_bool_last, | |
586 | opt_rewrite, opt_timelist, opt_uid, opt_gid, opt_uidlist, opt_gidlist, | |
587 | opt_expand_uid, opt_expand_gid, opt_void }; | |
588 | ||
589 | /* There's a high-ish bit which is used to flag duplicate options, kept | |
590 | for compatibility, which shouldn't be output. Also used for hidden options | |
591 | that are automatically maintained from others. Another high bit is used to | |
592 | flag driver options that although private (so as to be settable only on some | |
593 | drivers), are stored in the instance block so as to be accessible from outside. | |
594 | A third high bit is set when an option is read, so as to be able to give an | |
595 | error if any option is set twice. Finally, there's a bit which is set when an | |
596 | option is set with the "hide" prefix, to prevent -bP from showing it to | |
597 | non-admin callers. The next byte up in the int is used to keep the bit number | |
598 | for booleans that are kept in one bit. */ | |
599 | ||
600 | #define opt_hidden 0x100 /* Private to Exim */ | |
601 | #define opt_public 0x200 /* Stored in the main instance block */ | |
602 | #define opt_set 0x400 /* Option is set */ | |
603 | #define opt_secure 0x800 /* "hide" prefix used */ | |
604 | #define opt_mask 0x0ff | |
605 | ||
606 | /* Verify types when directing and routing */ | |
607 | ||
608 | enum { v_none, v_sender, v_recipient, v_expn }; | |
609 | ||
610 | /* Option flags for verify_address() */ | |
611 | ||
612 | #define vopt_fake_sender 0x0001 /* for verify=sender=<address> */ | |
613 | #define vopt_is_recipient 0x0002 | |
614 | #define vopt_qualify 0x0004 | |
615 | #define vopt_expn 0x0008 | |
2a4be8f9 | 616 | #define vopt_callout_fullpm 0x0010 /* full postmaster during callout */ |
059ec3d9 PH |
617 | #define vopt_callout_random 0x0020 /* during callout */ |
618 | #define vopt_callout_no_cache 0x0040 /* disable callout cache */ | |
619 | #define vopt_callout_recipsender 0x0080 /* use real sender to verify recip */ | |
620 | #define vopt_callout_recippmaster 0x0100 /* use postmaster to verify recip */ | |
eafd343b | 621 | #define vopt_success_on_redirect 0x0200 |
059ec3d9 PH |
622 | |
623 | /* Values for fields in callout cache records */ | |
624 | ||
625 | #define ccache_unknown 0 /* test hasn't been done */ | |
626 | #define ccache_accept 1 | |
627 | #define ccache_reject 2 | |
628 | ||
629 | /* Options for lookup functions */ | |
630 | ||
631 | #define lookup_querystyle 1 /* query-style lookup */ | |
632 | #define lookup_absfile 2 /* requires absolute file name */ | |
13b685f9 | 633 | #define lookup_absfilequery 4 /* query-style starts with file name */ |
059ec3d9 PH |
634 | |
635 | /* Status values for host_item blocks. Require hstatus_unusable and | |
636 | hstatus_unusable_expired to be last. */ | |
637 | ||
638 | enum { hstatus_unknown, hstatus_usable, hstatus_unusable, | |
639 | hstatus_unusable_expired }; | |
640 | ||
641 | /* Reasons why a host is unusable (for clearer log messages) */ | |
642 | ||
643 | enum { hwhy_unknown, hwhy_retry, hwhy_failed, hwhy_deferred, hwhy_ignored }; | |
644 | ||
645 | /* Domain lookup types for routers */ | |
646 | ||
647 | enum { lk_default, lk_byname, lk_bydns }; | |
648 | ||
649 | /* Values for the self_code fields */ | |
650 | ||
651 | enum { self_freeze, self_defer, self_send, self_reroute, self_pass, self_fail }; | |
652 | ||
653 | /* Flags for rewrite rules */ | |
654 | ||
655 | #define rewrite_sender 0x0001 | |
656 | #define rewrite_from 0x0002 | |
657 | #define rewrite_to 0x0004 | |
658 | #define rewrite_cc 0x0008 | |
659 | #define rewrite_bcc 0x0010 | |
660 | #define rewrite_replyto 0x0020 | |
661 | #define rewrite_all_headers 0x003F /* all header flags */ | |
662 | ||
663 | #define rewrite_envfrom 0x0040 | |
664 | #define rewrite_envto 0x0080 | |
665 | #define rewrite_all_envelope 0x00C0 /* all envelope flags */ | |
666 | ||
667 | #define rewrite_all (rewrite_all_headers | rewrite_all_envelope) | |
668 | ||
669 | #define rewrite_smtp 0x0100 /* rewrite at SMTP time */ | |
670 | #define rewrite_smtp_sender 0x0200 /* SMTP sender rewrite (allows <>) */ | |
671 | #define rewrite_qualify 0x0400 /* qualify if necessary */ | |
672 | #define rewrite_repeat 0x0800 /* repeat rewrite rule */ | |
673 | ||
674 | #define rewrite_whole 0x1000 /* option bit for headers */ | |
675 | #define rewrite_quit 0x2000 /* "no more" option */ | |
676 | ||
677 | /* Flags for log_write(); LOG_MAIN, LOG_PANIC, and LOG_REJECT are also in | |
678 | local_scan.h */ | |
679 | ||
680 | #define LOG_MAIN 1 /* Write to the main log */ | |
681 | #define LOG_PANIC 2 /* Write to the panic log */ | |
682 | #define LOG_PANIC_DIE 6 /* Write to the panic log and then die */ | |
683 | #define LOG_PROCESS 8 /* Write to the process log */ | |
684 | #define LOG_REJECT 16 /* Write to the reject log, with headers */ | |
685 | #define LOG_SENDER 32 /* Add raw sender to the message */ | |
686 | #define LOG_RECIPIENTS 64 /* Add raw recipients to the message */ | |
687 | #define LOG_CONFIG 128 /* Add "Exim configuration error" */ | |
688 | #define LOG_CONFIG_FOR (256+128) /* Add " for" instead of ":\n" */ | |
689 | #define LOG_CONFIG_IN (512+128) /* Add " in line x[ of file y]" */ | |
690 | ||
691 | /* Returns from host_find_by{name,dns}() */ | |
692 | ||
693 | enum { | |
694 | HOST_FIND_FAILED, /* failed to find the host */ | |
695 | HOST_FIND_AGAIN, /* could not resolve at this time */ | |
696 | HOST_FOUND, /* found host */ | |
697 | HOST_FOUND_LOCAL, /* found, but MX points to local host */ | |
698 | HOST_IGNORED /* found but ignored - used internally only */ | |
699 | }; | |
700 | ||
701 | /* Flags for host_find_bydns() */ | |
702 | ||
703 | #define HOST_FIND_BY_SRV 0x0001 | |
704 | #define HOST_FIND_BY_MX 0x0002 | |
705 | #define HOST_FIND_BY_A 0x0004 | |
706 | #define HOST_FIND_QUALIFY_SINGLE 0x0008 | |
707 | #define HOST_FIND_SEARCH_PARENTS 0x0010 | |
708 | ||
709 | /* Actions applied to specific messages. */ | |
710 | ||
711 | enum { MSG_DELIVER, MSG_FREEZE, MSG_REMOVE, MSG_THAW, MSG_ADD_RECIPIENT, | |
712 | MSG_MARK_ALL_DELIVERED, MSG_MARK_DELIVERED, MSG_EDIT_SENDER, | |
713 | MSG_SHOW_BODY, MSG_SHOW_HEADER, MSG_SHOW_LOG }; | |
714 | ||
715 | /* Returns from the spool_read_header() function */ | |
716 | ||
717 | enum { | |
718 | spool_read_OK, /* success */ | |
719 | spool_read_notopen, /* open failed */ | |
720 | spool_read_enverror, /* error in the envelope */ | |
721 | spool_read_hdrerror /* error in the headers */ | |
722 | }; | |
723 | ||
724 | /* Options for transport_write_message */ | |
725 | ||
726 | #define topt_add_return_path 0x001 | |
727 | #define topt_add_delivery_date 0x002 | |
728 | #define topt_add_envelope_to 0x004 | |
729 | #define topt_use_crlf 0x008 /* Terminate lines with CRLF */ | |
730 | #define topt_end_dot 0x010 /* Send terminting dot line */ | |
731 | #define topt_no_headers 0x020 /* Omit headers */ | |
732 | #define topt_no_body 0x040 /* Omit body */ | |
733 | #define topt_escape_headers 0x080 /* Apply escape check to headers */ | |
734 | ||
735 | /* Codes for the host_find_failed option. */ | |
736 | ||
737 | #define hff_freeze 0 | |
738 | #define hff_defer 1 | |
739 | #define hff_pass 2 | |
740 | #define hff_decline 3 | |
741 | #define hff_fail 4 | |
742 | ||
743 | /* Router information flags */ | |
744 | ||
745 | #define ri_yestransport 0x0001 /* Must have a transport */ | |
746 | #define ri_notransport 0x0002 /* Must not have a transport */ | |
747 | ||
748 | /* Codes for match types in match_check_list; to any of them, MCL_NOEXPAND may | |
749 | be added */ | |
750 | ||
751 | #define MCL_NOEXPAND 16 | |
752 | ||
753 | enum { MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, MCL_LOCALPART }; | |
754 | ||
755 | /* Codes for the places from which ACLs can be called. These are cunningly | |
756 | ordered to make it easy to implement tests for certain ACLs when processing | |
757 | "control" modifiers, by means of a maximum "where" value. Do not modify this | |
9c4e8f60 PH |
758 | order without checking carefully! |
759 | ||
760 | **** IMPORTANT*** | |
761 | **** Furthermore, remember to keep these in step with the tables | |
762 | **** of names and response codes in globals.c. | |
763 | **** IMPORTANT **** | |
764 | */ | |
059ec3d9 PH |
765 | |
766 | enum { ACL_WHERE_RCPT, /* Some controls are for RCPT only */ | |
767 | ACL_WHERE_MAIL, /* ) */ | |
768 | ACL_WHERE_PREDATA, /* ) There are several tests for "in message", */ | |
9c4e8f60 | 769 | ACL_WHERE_MIME, /* ) implemented by <= WHERE_NOTSMTP */ |
3e11c26b PH |
770 | ACL_WHERE_DATA, /* ) */ |
771 | ACL_WHERE_NOTSMTP, /* ) */ | |
059ec3d9 PH |
772 | |
773 | ACL_WHERE_AUTH, /* These remaining ones are not currently */ | |
774 | ACL_WHERE_CONNECT, /* required to be in a special order so they */ | |
775 | ACL_WHERE_ETRN, /* are just alphabetical. */ | |
776 | ACL_WHERE_EXPN, | |
777 | ACL_WHERE_HELO, | |
778 | ACL_WHERE_MAILAUTH, | |
779 | ACL_WHERE_QUIT, | |
780 | ACL_WHERE_STARTTLS, | |
781 | ACL_WHERE_VRFY | |
782 | }; | |
783 | ||
784 | /* Situations for spool_write_header() */ | |
785 | ||
786 | enum { SW_RECEIVING, SW_DELIVERING, SW_MODIFYING }; | |
787 | ||
788 | /* MX fields for hosts not obtained from MX records are always negative. | |
789 | MX_NONE is the default case; lesser values are used when the hosts are | |
790 | randomized in batches. */ | |
791 | ||
792 | #define MX_NONE (-1) | |
793 | ||
794 | /* host_item.port defaults to PORT_NONE; the only current case where this | |
795 | is changed before running the transport is when an dnslookup router sets an | |
796 | explicit port number. */ | |
797 | ||
798 | #define PORT_NONE (-1) | |
799 | ||
800 | /* Flags for single-key search defaults */ | |
801 | ||
802 | #define SEARCH_STAR 0x01 | |
803 | #define SEARCH_STARAT 0x02 | |
804 | ||
805 | /* Filter types */ | |
806 | ||
807 | enum { FILTER_UNSET, FILTER_FORWARD, FILTER_EXIM, FILTER_SIEVE }; | |
808 | ||
809 | /* End of macros.h */ |