src/src/macros.h

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