src/src/macros.h

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