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