src/src/macros.h

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