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
 309 /* Returns from the deliver_message() function */
 310
 311 #define DELIVER_ATTEMPTED_NORMAL   0  /* Tried a normal delivery */
 312 #define DELIVER_MUA_SUCCEEDED      1  /* Success when mua_wrapper is set */
 313 #define DELIVER_MUA_FAILED         2  /* Failure when mua_wrapper is set */
 314 #define DELIVER_NOT_ATTEMPTED      3  /* Not tried (no msg or is locked */
 315
 316 /* Returns from DNS lookup functions. */
 317
 318 enum { DNS_SUCCEED, DNS_NOMATCH, DNS_NODATA, DNS_AGAIN, DNS_FAIL };
 319
 320 /* Ending states when reading a message. The order is important. The test
 321 for having to swallow the rest of an SMTP message is whether the value is
 322 >= END_NOTENDED. */
 323
 324 #define END_NOTSTARTED 0    /* Message not started */
 325 #define END_DOT        1    /* Message ended with '.' */
 326 #define END_EOF        2    /* Message ended with EOF (error for SMTP) */
 327 #define END_NOTENDED   3    /* Message reading not yet ended */
 328 #define END_SIZE       4    /* Reading ended because message too big */
 329 #define END_WERROR     5    /* Write error while reading the message */
 330 #define END_PROTOCOL   6    /* Protocol error in CHUNKING sequence */
 331
 332 /* result codes for bdat_getc() (which can also return EOF) */
 333
 334 #define EOD (-2)
 335 #define ERR (-3)
 336
 337
 338 /* Bit masks for debug and log selectors */
 339
 340 /* Assume words are 32 bits wide. Tiny waste of space on 64 bit
 341 platforms, but this ensures bit vectors always work the same way. */
 342 #define BITWORDSIZE 32
 343
 344 /* This macro is for single-word bit vectors: the debug selector,
 345 and the first word of the log selector. */
 346 #define BIT(n) (1UL << (n))
 347
 348 /* And these are for multi-word vectors. */
 349 #define BITWORD(n) (      (n) / BITWORDSIZE)
 350 #define BITMASK(n) (1U << (n) % BITWORDSIZE)
 351
 352 #define BIT_CLEAR(s,z,n) ((s)[BITWORD(n)] &= ~BITMASK(n))
 353 #define BIT_SET(s,z,n)   ((s)[BITWORD(n)] |=  BITMASK(n))
 354 #define BIT_TEST(s,z,n) (((s)[BITWORD(n)] &   BITMASK(n)) != 0)
 355
 356 /* Used in globals.c for initializing bit_table structures. T will be either
 357 D or L corresponding to the debug and log selector bits declared below. */
 358
 359 #define BIT_TABLE(T,name) { US #name, T##i_##name }
 360
 361 /* IOTA allows us to keep an implicit sequential count, like a simple enum,
 362 but we can have sequentially numbered identifiers which are not declared
 363 sequentially. We use this for more compact declarations of bit indexes and
 364 masks, alternating between sequential bit index and corresponding mask. */
 365
 366 #define IOTA(iota)      (__LINE__ - iota)
 367 #define IOTA_INIT(zero) (__LINE__ - zero + 1)
 368
 369 /* Options bits for debugging. DEBUG_BIT() declares both a bit index and the
 370 corresponding mask. Di_all is a special value recognized by decode_bits().
 371 These must match the debug_options table in globals.c .
 372
 373 Exim's code assumes in a number of places that the debug_selector is one
 374 word, and this is exposed in the local_scan ABI. The D_v and D_local_scan bit
 375 masks are part of the local_scan API so are #defined in local_scan.h */
 376
 377 #define DEBUG_BIT(name) Di_##name = IOTA(Di_iota), D_##name = (int)BIT(Di_##name)
 378
 379 enum {
 380   Di_all        = -1,
 381   Di_v          = 0,
 382   Di_local_scan = 1,
 383
 384   Di_iota = IOTA_INIT(2),
 385   DEBUG_BIT(acl),               /* 2 */
 386   DEBUG_BIT(auth),
 387   DEBUG_BIT(deliver),
 388   DEBUG_BIT(dns),
 389   DEBUG_BIT(dnsbl),
 390   DEBUG_BIT(exec),              /* 7 */
 391   DEBUG_BIT(expand),
 392   DEBUG_BIT(filter),
 393   DEBUG_BIT(hints_lookup),
 394   DEBUG_BIT(host_lookup),
 395   DEBUG_BIT(ident),
 396   DEBUG_BIT(interface),
 397   DEBUG_BIT(lists),
 398   DEBUG_BIT(load),              /* 15 */
 399   DEBUG_BIT(lookup),
 400   DEBUG_BIT(memory),
 401   DEBUG_BIT(noutf8),
 402   DEBUG_BIT(pid),
 403   DEBUG_BIT(process_info),
 404   DEBUG_BIT(queue_run),
 405   DEBUG_BIT(receive),
 406   DEBUG_BIT(resolver),          /* 23 */
 407   DEBUG_BIT(retry),
 408   DEBUG_BIT(rewrite),
 409   DEBUG_BIT(route),
 410   DEBUG_BIT(timestamp),
 411   DEBUG_BIT(tls),
 412   DEBUG_BIT(transport),
 413   DEBUG_BIT(uid),
 414   DEBUG_BIT(verify),            /* 31 */
 415 };
 416
 417 /* Multi-bit debug masks */
 418
 419 #define D_all                        0xffffffff
 420
 421 #define D_any                        (D_all & \
 422                                        ~(D_v           | \
 423                                          D_noutf8      | \
 424                                          D_pid         | \
 425                                          D_timestamp)  )
 426
 427 #define D_default                    (0xffffffff & \
 428                                        ~(D_expand      | \
 429                                          D_filter      | \
 430                                          D_interface   | \
 431                                          D_load        | \
 432                                          D_local_scan  | \
 433                                          D_memory      | \
 434                                          D_noutf8      | \
 435                                          D_pid         | \
 436                                          D_timestamp   | \
 437                                          D_resolver))
 438
 439 /* Options bits for logging. Those that have values < BITWORDSIZE can be used
 440 in calls to log_write(). The others are put into later words in log_selector
 441 and are only ever tested independently, so they do not need bit mask
 442 declarations. The Li_all value is recognized specially by decode_bits().
 443 Add also to log_options[] when creating new ones. */
 444
 445 #define LOG_BIT(name) Li_##name = IOTA(Li_iota), L_##name = BIT(Li_##name)
 446
 447 enum logbit {
 448   Li_all = -1,
 449
 450   Li_iota = IOTA_INIT(0),
 451   LOG_BIT(address_rewrite),
 452   LOG_BIT(all_parents),
 453   LOG_BIT(connection_reject),
 454   LOG_BIT(delay_delivery),
 455   LOG_BIT(dnslist_defer),
 456   LOG_BIT(etrn),
 457   LOG_BIT(host_lookup_failed),
 458   LOG_BIT(lost_incoming_connection),
 459   LOG_BIT(queue_run),
 460   LOG_BIT(retry_defer),
 461   LOG_BIT(size_reject),
 462   LOG_BIT(skip_delivery),
 463   LOG_BIT(smtp_connection),
 464   LOG_BIT(smtp_incomplete_transaction),
 465   LOG_BIT(smtp_protocol_error),
 466   LOG_BIT(smtp_syntax_error),
 467
 468   Li_8bitmime = BITWORDSIZE,
 469   Li_acl_warn_skipped,
 470   Li_arguments,
 471   Li_deliver_time,
 472   Li_delivery_size,
 473   Li_dkim,
 474   Li_dkim_verbose,
 475   Li_dnssec,
 476   Li_ident_timeout,
 477   Li_incoming_interface,
 478   Li_incoming_port,
 479   Li_millisec,
 480   Li_msg_id,
 481   Li_msg_id_created,
 482   Li_outgoing_interface,
 483   Li_outgoing_port,
 484   Li_pid,
 485   Li_pipelining,
 486   Li_protocol_detail,
 487   Li_proxy,
 488   Li_queue_time,
 489   Li_queue_time_overall,
 490   Li_receive_time,
 491   Li_received_sender,
 492   Li_received_recipients,
 493   Li_rejected_header,
 494   Li_return_path_on_delivery,
 495   Li_sender_on_delivery,
 496   Li_sender_verify_fail,
 497   Li_smtp_confirmation,
 498   Li_smtp_mailauth,
 499   Li_smtp_no_mail,
 500   Li_subject,
 501   Li_tls_certificate_verified,
 502   Li_tls_cipher,
 503   Li_tls_peerdn,
 504   Li_tls_resumption,
 505   Li_tls_sni,
 506   Li_unknown_in_list,
 507
 508   log_selector_size = BITWORD(Li_unknown_in_list) + 1
 509 };
 510
 511 #define LOGGING(opt) BIT_TEST(log_selector, log_selector_size, Li_##opt)
 512
 513 /* Private error numbers for delivery failures, set negative so as not
 514 to conflict with system errno values.  Take care to maintain the string
 515 table exim_errstrings[] in log.c */
 516
 517 #define ERRNO_UNKNOWNERROR    (-1)
 518 #define ERRNO_USERSLASH       (-2)
 519 #define ERRNO_EXISTRACE       (-3)
 520 #define ERRNO_NOTREGULAR      (-4)
 521 #define ERRNO_NOTDIRECTORY    (-5)
 522 #define ERRNO_BADUGID         (-6)
 523 #define ERRNO_BADMODE         (-7)
 524 #define ERRNO_INODECHANGED    (-8)
 525 #define ERRNO_LOCKFAILED      (-9)
 526 #define ERRNO_BADADDRESS2    (-10)
 527 #define ERRNO_FORBIDPIPE     (-11)
 528 #define ERRNO_FORBIDFILE     (-12)
 529 #define ERRNO_FORBIDREPLY    (-13)
 530 #define ERRNO_MISSINGPIPE    (-14)
 531 #define ERRNO_MISSINGFILE    (-15)
 532 #define ERRNO_MISSINGREPLY   (-16)
 533 #define ERRNO_BADREDIRECT    (-17)
 534 #define ERRNO_SMTPCLOSED     (-18)
 535 #define ERRNO_SMTPFORMAT     (-19)
 536 #define ERRNO_SPOOLFORMAT    (-20)
 537 #define ERRNO_NOTABSOLUTE    (-21)
 538 #define ERRNO_EXIMQUOTA      (-22)   /* Exim-imposed quota */
 539 #define ERRNO_HELD           (-23)
 540 #define ERRNO_FILTER_FAIL    (-24)   /* Delivery filter process failure */
 541 #define ERRNO_CHHEADER_FAIL  (-25)   /* Delivery add/remove header failure */
 542 #define ERRNO_WRITEINCOMPLETE (-26)  /* Delivery write incomplete error */
 543 #define ERRNO_EXPANDFAIL     (-27)   /* Some expansion failed */
 544 #define ERRNO_GIDFAIL        (-28)   /* Failed to get gid */
 545 #define ERRNO_UIDFAIL        (-29)   /* Failed to get uid */
 546 #define ERRNO_BADTRANSPORT   (-30)   /* Unset or non-existent transport */
 547 #define ERRNO_MBXLENGTH      (-31)   /* MBX length mismatch */
 548 #define ERRNO_UNKNOWNHOST    (-32)   /* Lookup failed routing or in smtp tpt */
 549 #define ERRNO_FORMATUNKNOWN  (-33)   /* Can't match format in appendfile */
 550 #define ERRNO_BADCREATE      (-34)   /* Creation outside home in appendfile */
 551 #define ERRNO_LISTDEFER      (-35)   /* Can't check a list; lookup defer */
 552 #define ERRNO_DNSDEFER       (-36)   /* DNS lookup defer */
 553 #define ERRNO_TLSFAILURE     (-37)   /* Failed to start TLS session */
 554 #define ERRNO_TLSREQUIRED    (-38)   /* Mandatory TLS session not started */
 555 #define ERRNO_CHOWNFAIL      (-39)   /* Failed to chown a file */
 556 #define ERRNO_PIPEFAIL       (-40)   /* Failed to create a pipe */
 557 #define ERRNO_CALLOUTDEFER   (-41)   /* When verifying */
 558 #define ERRNO_AUTHFAIL       (-42)   /* When required by client */
 559 #define ERRNO_CONNECTTIMEOUT (-43)   /* Used internally in smtp transport */
 560 #define ERRNO_RCPT4XX        (-44)   /* RCPT gave 4xx error */
 561 #define ERRNO_MAIL4XX        (-45)   /* MAIL gave 4xx error */
 562 #define ERRNO_DATA4XX        (-46)   /* DATA gave 4xx error */
 563 #define ERRNO_PROXYFAIL      (-47)   /* Negotiation failed for proxy configured host */
 564 #define ERRNO_AUTHPROB       (-48)   /* Authenticator "other" failure */
 565 #define ERRNO_UTF8_FWD       (-49)   /* target not supporting SMTPUTF8 */
 566 #define ERRNO_HOST_IS_LOCAL  (-50)   /* Transport refuses to talk to localhost */
 567
 568 /* These must be last, so all retry deferments can easily be identified */
 569
 570 #define ERRNO_RETRY_BASE     (-51)   /* Base to test against */
 571 #define ERRNO_RRETRY         (-51)   /* Not time for routing */
 572
 573 #define ERRNO_WARN_BASE      (-52)   /* Base to test against */
 574 #define ERRNO_LRETRY         (-52)   /* Not time for local delivery */
 575 #define ERRNO_HRETRY         (-53)   /* Not time for any remote host */
 576 #define ERRNO_LOCAL_ONLY     (-54)   /* Local-only delivery */
 577 #define ERRNO_QUEUE_DOMAIN   (-55)   /* Domain in queue_domains */
 578 #define ERRNO_TRETRY         (-56)   /* Transport concurrency limit */
 579 #define ERRNO_EVENT          (-57)   /* Event processing request alternate response */
 580
 581
 582
 583 /* Special actions to take after failure or deferment. */
 584
 585 enum {
 586   SPECIAL_NONE,             /* No special action */
 587   SPECIAL_FREEZE,           /* Freeze message */
 588   SPECIAL_FAIL,             /* Fail the delivery */
 589   SPECIAL_WARN              /* Send a warning message */
 590 };
 591
 592 /* Flags that get ORed into the more_errno field of an address to give more
 593 information about errors for retry purposes. They are greater than 256, because
 594 the bottom byte contains 'A' or 'M' for remote addresses, to indicate whether
 595 the name was looked up only via an address record or whether MX records were
 596 used, respectively. */
 597
 598 #define RTEF_CTOUT     0x0100      /* Connection timed out */
 599
 600 /* Permission and other options for parse_extract_addresses(),
 601 filter_interpret(), and rda_interpret(), i.e. what special things are allowed
 602 in redirection operations. Not all apply to all cases. Some of the bits allow
 603 and some forbid, reflecting the "allow" and "forbid" options in the redirect
 604 router, which were chosen to represent the standard situation for users'
 605 .forward files. */
 606
 607 #define RDO_BLACKHOLE    0x00000001  /* Forbid :blackhole: */
 608 #define RDO_DEFER        0x00000002  /* Allow :defer: or "defer" */
 609 #define RDO_EACCES       0x00000004  /* Ignore EACCES */
 610 #define RDO_ENOTDIR      0x00000008  /* Ignore ENOTDIR */
 611 #define RDO_EXISTS       0x00000010  /* Forbid "exists" in expansion in filter */
 612 #define RDO_FAIL         0x00000020  /* Allow :fail: or "fail" */
 613 #define RDO_FILTER       0x00000040  /* Allow a filter script */
 614 #define RDO_FREEZE       0x00000080  /* Allow "freeze" */
 615 #define RDO_INCLUDE      0x00000100  /* Forbid :include: */
 616 #define RDO_LOG          0x00000200  /* Forbid "log" */
 617 #define RDO_LOOKUP       0x00000400  /* Forbid "lookup" in expansion in filter */
 618 #define RDO_PERL         0x00000800  /* Forbid "perl" in expansion in filter */
 619 #define RDO_READFILE     0x00001000  /* Forbid "readfile" in exp in filter */
 620 #define RDO_READSOCK     0x00002000  /* Forbid "readsocket" in exp in filter */
 621 #define RDO_RUN          0x00004000  /* Forbid "run" in expansion in filter */
 622 #define RDO_DLFUNC       0x00008000  /* Forbid "dlfunc" in expansion in filter */
 623 #define RDO_REALLOG      0x00010000  /* Really do log (not testing/verifying) */
 624 #define RDO_REWRITE      0x00020000  /* Rewrite generated addresses */
 625 #define RDO_EXIM_FILTER  0x00040000  /* Forbid Exim filters */
 626 #define RDO_SIEVE_FILTER 0x00080000  /* Forbid Sieve filters */
 627 #define RDO_PREPEND_HOME 0x00100000  /* Prepend $home to relative paths in Exim filter save commands */
 628
 629 /* This is the set that apply to expansions in filters */
 630
 631 #define RDO_FILTER_EXPANSIONS \
 632   (RDO_EXISTS|RDO_LOOKUP|RDO_PERL|RDO_READFILE|RDO_READSOCK|RDO_RUN|RDO_DLFUNC)
 633
 634 /* As well as the RDO bits themselves, we need the bit numbers in order to
 635 access (most of) the individual bits as separate options. This could be
 636 automated, but I haven't bothered. Keep this list in step with the above! */
 637
 638 enum { RDON_BLACKHOLE, RDON_DEFER, RDON_EACCES, RDON_ENOTDIR, RDON_EXISTS,
 639   RDON_FAIL, RDON_FILTER, RDON_FREEZE, RDON_INCLUDE, RDON_LOG, RDON_LOOKUP,
 640   RDON_PERL, RDON_READFILE, RDON_READSOCK, RDON_RUN, RDON_DLFUNC, RDON_REALLOG,
 641   RDON_REWRITE, RDON_EXIM_FILTER, RDON_SIEVE_FILTER, RDON_PREPEND_HOME };
 642
 643 /* Results of filter or forward file processing. Some are only from a filter;
 644 some are only from a forward file. */
 645
 646 enum {
 647   FF_DELIVERED,         /* Success, took significant action */
 648   FF_NOTDELIVERED,      /* Success, didn't take significant action */
 649   FF_BLACKHOLE,         /* Blackholing requested */
 650   FF_DEFER,             /* Defer requested */
 651   FF_FAIL,              /* Fail requested */
 652   FF_INCLUDEFAIL,       /* :include: failed */
 653   FF_NONEXIST,          /* Forward file does not exist */
 654   FF_FREEZE,            /* Freeze requested */
 655   FF_ERROR              /* We have a problem */
 656 };
 657
 658 /* Values for identifying particular headers; printing characters are used, so
 659 they can be read in the spool file for those headers that are permanently
 660 marked. The lower case values don't get onto the spool; they are used only as
 661 return values from header_checkname(). */
 662
 663 #define htype_other         ' '   /* Unspecified header */
 664 #define htype_from          'F'
 665 #define htype_to            'T'
 666 #define htype_cc            'C'
 667 #define htype_bcc           'B'
 668 #define htype_id            'I'   /* for message-id */
 669 #define htype_reply_to      'R'
 670 #define htype_received      'P'   /* P for Postmark */
 671 #define htype_sender        'S'
 672 #define htype_old           '*'   /* Replaced header */
 673
 674 #define htype_date          'd'
 675 #define htype_return_path   'p'
 676 #define htype_delivery_date 'x'
 677 #define htype_envelope_to   'e'
 678 #define htype_subject       's'
 679
 680 /* These values are used only when adding new headers from an ACL; they too
 681 never get onto the spool. The type of the added header is set by reference
 682 to the header name, by calling header_checkname(). */
 683
 684 #define htype_add_top       'a'
 685 #define htype_add_rec       'r'
 686 #define htype_add_bot       'z'
 687 #define htype_add_rfc       'f'
 688
 689 /* Types of item in options lists. These are the bottom 8 bits of the "type"
 690 field, which is an int. The opt_void value is used for entries in tables that
 691 point to special types of value that are accessed only indirectly (e.g. the
 692 rewrite data that is built out of a string option.) We need to have some values
 693 visible in local_scan, so the following are declared there:
 694
 695   opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed, opt_time,
 696   opt_bool
 697
 698 To make sure we don't conflict, the local_scan.h values start from zero, and
 699 those defined here start from 32. The boolean ones must all be together so they
 700 can be easily tested as a group. That is the only use of opt_bool_last. */
 701
 702 enum { opt_bit = 32, opt_bool_verify, opt_bool_set, opt_expand_bool,
 703   opt_bool_last,
 704   opt_rewrite, opt_timelist, opt_uid, opt_gid, opt_uidlist, opt_gidlist,
 705   opt_expand_uid, opt_expand_gid, opt_func, opt_void };
 706
 707 /* There's a high-ish bit which is used to flag duplicate options, kept
 708 for compatibility, which shouldn't be output. Also used for hidden options
 709 that are automatically maintained from others. Another high bit is used to
 710 flag driver options that although private (so as to be settable only on some
 711 drivers), are stored in the instance block so as to be accessible from outside.
 712 A third high bit is set when an option is read, so as to be able to give an
 713 error if any option is set twice. Finally, there's a bit which is set when an
 714 option is set with the "hide" prefix, to prevent -bP from showing it to
 715 non-admin callers. The next byte up in the int is used to keep the bit number
 716 for booleans that are kept in one bit. */
 717
 718 #define opt_hidden  0x100      /* Private to Exim */
 719 #define opt_public  0x200      /* Stored in the main instance block */
 720 #define opt_set     0x400      /* Option is set */
 721 #define opt_secure  0x800      /* "hide" prefix used */
 722 #define opt_rep_con 0x1000     /* Can be appended to by a repeated line (condition) */
 723 #define opt_rep_str 0x2000     /* Can be appended to by a repeated line (string) */
 724 #define opt_mask    0x00ff
 725
 726 /* Verify types when directing and routing */
 727
 728 enum { v_none, v_sender, v_recipient, v_expn };
 729
 730 /* Option flags for verify_address() */
 731
 732 #define vopt_fake_sender          0x0001   /* for verify=sender=<address> */
 733 #define vopt_is_recipient         0x0002
 734 #define vopt_qualify              0x0004
 735 #define vopt_expn                 0x0008
 736 #define vopt_callout_fullpm       0x0010   /* full postmaster during callout */
 737 #define vopt_callout_random       0x0020   /* during callout */
 738 #define vopt_callout_no_cache     0x0040   /* disable callout cache */
 739 #define vopt_callout_recipsender  0x0080   /* use real sender to verify recip */
 740 #define vopt_callout_recippmaster 0x0100   /* use postmaster to verify recip */
 741 #define vopt_callout_hold         0x0200   /* lazy close connection */
 742 #define vopt_success_on_redirect  0x0400
 743 #define vopt_quota                0x0800   /* quota check, to local/appendfile */
 744
 745 /* Values for fields in callout cache records */
 746
 747 #define ccache_unknown         0       /* test hasn't been done */
 748 #define ccache_accept          1
 749 #define ccache_reject          2       /* All rejections except */
 750 #define ccache_reject_mfnull   3       /* MAIL FROM:<> was rejected */
 751
 752 /* Options for lookup functions */
 753
 754 #define lookup_querystyle      1    /* query-style lookup */
 755 #define lookup_absfile         2    /* requires absolute file name */
 756 #define lookup_absfilequery    4    /* query-style starts with file name */
 757
 758 /* Status values for host_item blocks. Require hstatus_unusable and
 759 hstatus_unusable_expired to be last. */
 760
 761 enum { hstatus_unknown, hstatus_usable, hstatus_unusable,
 762        hstatus_unusable_expired };
 763
 764 /* Reasons why a host is unusable (for clearer log messages) */
 765
 766 enum { hwhy_unknown, hwhy_retry, hwhy_insecure, hwhy_failed, hwhy_deferred,
 767        hwhy_ignored };
 768
 769 /* Domain lookup types for routers */
 770
 771 #define LK_DEFAULT      BIT(0)
 772 #define LK_BYNAME       BIT(1)
 773 #define LK_BYDNS        BIT(2)  /* those 3 should be mutually exclusive */
 774
 775 #define LK_IPV4_ONLY    BIT(3)
 776 #define LK_IPV4_PREFER  BIT(4)
 777
 778 /* Values for the self_code fields */
 779
 780 enum { self_freeze, self_defer, self_send, self_reroute, self_pass, self_fail };
 781
 782 /* Flags for rewrite rules */
 783
 784 #define rewrite_sender       0x0001
 785 #define rewrite_from         0x0002
 786 #define rewrite_to           0x0004
 787 #define rewrite_cc           0x0008
 788 #define rewrite_bcc          0x0010
 789 #define rewrite_replyto      0x0020
 790 #define rewrite_all_headers  0x003F  /* all header flags */
 791
 792 #define rewrite_envfrom      0x0040
 793 #define rewrite_envto        0x0080
 794 #define rewrite_all_envelope 0x00C0  /* all envelope flags */
 795
 796 #define rewrite_all      (rewrite_all_headers | rewrite_all_envelope)
 797
 798 #define rewrite_smtp         0x0100  /* rewrite at SMTP time */
 799 #define rewrite_smtp_sender  0x0200  /* SMTP sender rewrite (allows <>) */
 800 #define rewrite_qualify      0x0400  /* qualify if necessary */
 801 #define rewrite_repeat       0x0800  /* repeat rewrite rule */
 802
 803 #define rewrite_whole        0x1000  /* option bit for headers */
 804 #define rewrite_quit         0x2000  /* "no more" option */
 805
 806 /* Flags for log_write(); LOG_MAIN, LOG_PANIC, and LOG_REJECT are also in
 807 local_scan.h */
 808
 809 #define LOG_MAIN           1      /* Write to the main log */
 810 #define LOG_PANIC          2      /* Write to the panic log */
 811 #define LOG_PANIC_DIE      6      /* Write to the panic log and then die */
 812 #define LOG_REJECT        16      /* Write to the reject log, with headers */
 813 #define LOG_SENDER        32      /* Add raw sender to the message */
 814 #define LOG_RECIPIENTS    64      /* Add raw recipients to the message */
 815 #define LOG_CONFIG       128      /* Add "Exim configuration error" */
 816 #define LOG_CONFIG_FOR  (256+128) /* Add " for" instead of ":\n" */
 817 #define LOG_CONFIG_IN   (512+128) /* Add " in line x[ of file y]" */
 818
 819 /* and for debug_bits() logging action control: */
 820 #define DEBUG_FROM_CONFIG       0x0001
 821
 822 /* SMTP command identifiers for the smtp_connection_had field that records the
 823 most recent SMTP commands. Must be kept in step with the list of names in
 824 smtp_in.c that is used for creating the smtp_no_mail logging action. SCH_NONE
 825 is "empty". */
 826
 827 enum { SCH_NONE, SCH_AUTH, SCH_DATA, SCH_BDAT,
 828        SCH_EHLO, SCH_ETRN, SCH_EXPN, SCH_HELO,
 829        SCH_HELP, SCH_MAIL, SCH_NOOP, SCH_QUIT, SCH_RCPT, SCH_RSET, SCH_STARTTLS,
 830        SCH_VRFY };
 831
 832 /* Returns from host_find_by{name,dns}() */
 833
 834 enum {
 835   HOST_FIND_FAILED,     /* failed to find the host */
 836   HOST_FIND_AGAIN,      /* could not resolve at this time */
 837   HOST_FIND_SECURITY,   /* dnssec required but not acheived */
 838   HOST_FOUND,           /* found host */
 839   HOST_FOUND_LOCAL,     /* found, but MX points to local host */
 840   HOST_IGNORED          /* found but ignored - used internally only */
 841 };
 842
 843 /* Flags for host_find_bydns() */
 844
 845 #define HOST_FIND_BY_SRV          BIT(0)
 846 #define HOST_FIND_BY_MX           BIT(1)
 847 #define HOST_FIND_BY_A            BIT(2)
 848 #define HOST_FIND_BY_AAAA         BIT(3)
 849 #define HOST_FIND_QUALIFY_SINGLE  BIT(4)
 850 #define HOST_FIND_SEARCH_PARENTS  BIT(5)
 851 #define HOST_FIND_IPV4_FIRST      BIT(6)
 852 #define HOST_FIND_IPV4_ONLY       BIT(7)
 853
 854 /* Actions applied to specific messages. */
 855
 856 enum { MSG_DELIVER, MSG_FREEZE, MSG_REMOVE, MSG_THAW, MSG_ADD_RECIPIENT,
 857        MSG_MARK_ALL_DELIVERED, MSG_MARK_DELIVERED, MSG_EDIT_SENDER,
 858        MSG_SHOW_COPY, MSG_LOAD, MSG_SETQUEUE,
 859        /* These ones must be last: a test for >= MSG_SHOW_BODY is used
 860        to test for actions that list individual spool files. */
 861        MSG_SHOW_BODY, MSG_SHOW_HEADER, MSG_SHOW_LOG };
 862
 863 /* Returns from the spool_read_header() function */
 864
 865 enum {
 866   spool_read_OK,        /* success */
 867   spool_read_notopen,   /* open failed */
 868   spool_read_enverror,  /* error in the envelope */
 869   spool_read_hdrerror   /* error in the headers */
 870 };
 871
 872 /* Options for transport_write_message */
 873
 874 #define topt_add_return_path    0x001
 875 #define topt_add_delivery_date  0x002
 876 #define topt_add_envelope_to    0x004
 877 #define topt_use_crlf           0x008  /* Terminate lines with CRLF */
 878 #define topt_end_dot            0x010  /* Send terminating dot line */
 879 #define topt_no_headers         0x020  /* Omit headers */
 880 #define topt_no_body            0x040  /* Omit body */
 881 #define topt_escape_headers     0x080  /* Apply escape check to headers */
 882 #define topt_use_bdat           0x100  /* prepend chunks with RFC3030 BDAT header */
 883 #define topt_output_string      0x200  /* create string rather than write to fd */
 884 #define topt_continuation       0x400  /* do not reset buffer */
 885 #define topt_not_socket         0x800  /* cannot do socket-only syscalls */
 886
 887 /* Options for smtp_write_command */
 888
 889 enum {
 890   SCMD_FLUSH = 0,       /* write to kernel */
 891   SCMD_MORE,            /* write to kernel, but likely more soon */
 892   SCMD_BUFFER           /* stash in application cmd output buffer */
 893 };
 894
 895 /* Flags for recipient_block, used in DSN support */
 896
 897 #define rf_dsnlasthop           0x01  /* Do not propagate DSN any further */
 898 #define rf_notify_never         0x02  /* NOTIFY= settings */
 899 #define rf_notify_success       0x04
 900 #define rf_notify_failure       0x08
 901 #define rf_notify_delay         0x10
 902
 903 #define rf_dsnflags  (rf_notify_never | rf_notify_success | \
 904                       rf_notify_failure | rf_notify_delay)
 905
 906 /* DSN RET types */
 907
 908 #define dsn_ret_full            1
 909 #define dsn_ret_hdrs            2
 910
 911 #define dsn_support_unknown     0
 912 #define dsn_support_yes         1
 913 #define dsn_support_no          2
 914
 915
 916 /* Codes for the host_find_failed and host_all_ignored options. */
 917
 918 #define hff_freeze   0
 919 #define hff_defer    1
 920 #define hff_pass     2
 921 #define hff_decline  3
 922 #define hff_fail     4
 923 #define hff_ignore   5
 924
 925 /* Router information flags */
 926
 927 #define ri_yestransport    0x0001    /* Must have a transport */
 928 #define ri_notransport     0x0002    /* Must not have a transport */
 929
 930 /* Codes for match types in match_check_list; to any of them, MCL_NOEXPAND may
 931 be added */
 932
 933 #define MCL_NOEXPAND  16
 934
 935 enum { MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, MCL_LOCALPART };
 936
 937 /* Codes for the places from which ACLs can be called. These are cunningly
 938 ordered to make it easy to implement tests for certain ACLs when processing
 939 "control" modifiers, by means of a maximum "where" value. Do not modify this
 940 order without checking carefully!
 941
 942 **** IMPORTANT***
 943 ****   Furthermore, remember to keep these in step with the tables
 944 ****   of names and response codes in globals.c.
 945 **** IMPORTANT ****
 946 */
 947
 948 enum { ACL_WHERE_RCPT,       /* Some controls are for RCPT only */
 949        ACL_WHERE_MAIL,       /* )                                           */
 950        ACL_WHERE_PREDATA,    /* ) There are several tests for "in message", */
 951        ACL_WHERE_MIME,       /* ) implemented by <= WHERE_NOTSMTP           */
 952        ACL_WHERE_DKIM,       /* )                                           */
 953        ACL_WHERE_DATA,       /* )                                           */
 954 #ifndef DISABLE_PRDR
 955        ACL_WHERE_PRDR,       /* )                                           */
 956 #endif
 957        ACL_WHERE_NOTSMTP,    /* )                                           */
 958
 959        ACL_WHERE_AUTH,       /* These remaining ones are not currently    */
 960        ACL_WHERE_CONNECT,    /* required to be in a special order so they */
 961        ACL_WHERE_ETRN,       /* are just alphabetical.                    */
 962        ACL_WHERE_EXPN,
 963        ACL_WHERE_HELO,
 964        ACL_WHERE_MAILAUTH,
 965        ACL_WHERE_NOTSMTP_START,
 966        ACL_WHERE_NOTQUIT,
 967        ACL_WHERE_QUIT,
 968        ACL_WHERE_STARTTLS,
 969        ACL_WHERE_VRFY,
 970
 971        ACL_WHERE_DELIVERY,
 972        ACL_WHERE_UNKNOWN     /* Currently used by a ${acl:name} expansion */
 973      };
 974
 975 #define ACL_BIT_RCPT            BIT(ACL_WHERE_RCPT)
 976 #define ACL_BIT_MAIL            BIT(ACL_WHERE_MAIL)
 977 #define ACL_BIT_PREDATA         BIT(ACL_WHERE_PREDATA)
 978 #define ACL_BIT_MIME            BIT(ACL_WHERE_MIME)
 979 #define ACL_BIT_DKIM            BIT(ACL_WHERE_DKIM)
 980 #define ACL_BIT_DATA            BIT(ACL_WHERE_DATA)
 981 #ifdef DISABLE_PRDR
 982 # define ACL_BIT_PRDR           0
 983 #else
 984 # define ACL_BIT_PRDR           BIT(ACL_WHERE_PRDR)
 985 #endif
 986 #define ACL_BIT_NOTSMTP         BIT(ACL_WHERE_NOTSMTP)
 987 #define ACL_BIT_AUTH            BIT(ACL_WHERE_AUTH)
 988 #define ACL_BIT_CONNECT         BIT(ACL_WHERE_CONNECT)
 989 #define ACL_BIT_ETRN            BIT(ACL_WHERE_ETRN)
 990 #define ACL_BIT_EXPN            BIT(ACL_WHERE_EXPN)
 991 #define ACL_BIT_HELO            BIT(ACL_WHERE_HELO)
 992 #define ACL_BIT_MAILAUTH        BIT(ACL_WHERE_MAILAUTH)
 993 #define ACL_BIT_NOTSMTP_START   BIT(ACL_WHERE_NOTSMTP_START)
 994 #define ACL_BIT_NOTQUIT         BIT(ACL_WHERE_NOTQUIT)
 995 #define ACL_BIT_QUIT            BIT(ACL_WHERE_QUIT)
 996 #define ACL_BIT_STARTTLS        BIT(ACL_WHERE_STARTTLS)
 997 #define ACL_BIT_VRFY            BIT(ACL_WHERE_VRFY)
 998 #define ACL_BIT_DELIVERY        BIT(ACL_WHERE_DELIVERY)
 999 #define ACL_BIT_UNKNOWN         BIT(ACL_WHERE_UNKNOWN)
1000
1001 #define ACL_BITS_HAVEDATA       (ACL_BIT_MIME | ACL_BIT_DKIM | ACL_BIT_DATA \
1002                                 | ACL_BIT_PRDR \
1003                                 | ACL_BIT_NOTSMTP | ACL_BIT_QUIT | ACL_BIT_NOTQUIT)
1004
1005
1006 /* Situations for spool_write_header() */
1007
1008 enum { SW_RECEIVING, SW_DELIVERING, SW_MODIFYING };
1009
1010 /* MX fields for hosts not obtained from MX records are always negative.
1011 MX_NONE is the default case; lesser values are used when the hosts are
1012 randomized in batches. */
1013
1014 #define MX_NONE           (-1)
1015
1016 /* host_item.port defaults to PORT_NONE; the only current case where this
1017 is changed before running the transport is when an dnslookup router sets an
1018 explicit port number. */
1019
1020 #define PORT_NONE     (-1)
1021
1022 /* Flags for single-key search defaults */
1023
1024 #define SEARCH_STAR       0x01
1025 #define SEARCH_STARAT     0x02
1026
1027 /* Filter types */
1028
1029 enum { FILTER_UNSET, FILTER_FORWARD, FILTER_EXIM, FILTER_SIEVE };
1030
1031 /* Codes for ESMTP facilities offered by peer */
1032
1033 #define OPTION_TLS              BIT(0)
1034 #define OPTION_IGNQ             BIT(1)
1035 #define OPTION_PRDR             BIT(2)
1036 #define OPTION_UTF8             BIT(3)
1037 #define OPTION_DSN              BIT(4)
1038 #define OPTION_PIPE             BIT(5)
1039 #define OPTION_SIZE             BIT(6)
1040 #define OPTION_CHUNKING         BIT(7)
1041 #define OPTION_EARLY_PIPE       BIT(8)
1042
1043 /* Argument for *_getc */
1044
1045 #define GETC_BUFFER_UNLIMITED   UINT_MAX
1046
1047 /* UTF-8 chars for line-drawing */
1048
1049 #define UTF8_DOWN_RIGHT         "\xE2\x95\xAD"
1050 #define UTF8_VERT               "\xE2\x94\x82"
1051 #define UTF8_HORIZ              "\xE2\x94\x80"
1052 #define UTF8_VERT_RIGHT         "\xE2\x94\x9C"
1053 #define UTF8_UP_RIGHT           "\xE2\x95\xB0"
1054 #define UTF8_VERT_2DASH         "\xE2\x95\x8E"
1055
1056
1057 /* Options on tls_close */
1058 #define TLS_NO_SHUTDOWN         0
1059 #define TLS_SHUTDOWN_NOWAIT     1
1060 #define TLS_SHUTDOWN_WAIT       2
1061
1062
1063 #ifdef COMPILE_UTILITY
1064 # define ALARM(seconds) alarm(seconds);
1065 # define ALARM_CLR(seconds) alarm(seconds);
1066 #else
1067 /* For debugging of odd alarm-signal problems, stash caller info while the
1068 alarm is active.  Clear it down on cancelling the alarm so we can tell there
1069 should not be one active. */
1070
1071 # define ALARM(seconds) \
1072     debug_selector & D_any \
1073     ? (sigalarm_setter = CUS __FUNCTION__, alarm(seconds)) : alarm(seconds);
1074 # define ALARM_CLR(seconds) \
1075     debug_selector & D_any \
1076     ? (sigalarm_setter = NULL, alarm(seconds)) : alarm(seconds);
1077 #endif
1078
1079 #define AUTHS_REGEX US"\\n250[\\s\\-]AUTH\\s+([\\-\\w \\t]+)(?:\\n|$)"
1080
1081 #define EARLY_PIPE_FEATURE_NAME "X_PIPE_CONNECT"
1082 #define EARLY_PIPE_FEATURE_LEN  14
1083
1084
1085 /* Flags for auth_client_item() */
1086
1087 #define AUTH_ITEM_FIRST BIT(0)
1088 #define AUTH_ITEM_LAST  BIT(1)
1089 #define AUTH_ITEM_IGN64 BIT(2)
1090
1091
1092 /* Flags for tls_{in,out}_resumption */
1093 #define RESUME_SUPPORTED        BIT(0)
1094 #define RESUME_CLIENT_REQUESTED BIT(1)
1095 #define RESUME_CLIENT_SUGGESTED BIT(2)
1096 #define RESUME_SERVER_TICKET    BIT(3)
1097 #define RESUME_USED             BIT(4)
1098
1099 #define RESUME_DECODE_STRING \
1100           US"not requested or offered : 0x02 :client requested, no server ticket" \
1101     ": 0x04 : 0x05 : 0x06 :client offered session, no server action" \
1102     ": 0x08 :no client request: 0x0A :client requested new ticket, server provided" \
1103     ": 0x0C :client offered session, not used: 0x0E :client offered session, server only provided new ticket" \
1104     ": 0x10 :session resumed unasked: 0x12 :session resumed unasked" \
1105     ": 0x14 : 0x15 : 0x16 :session resumed" \
1106     ": 0x18 :session resumed unasked: 0x1A :session resumed unasked" \
1107     ": 0x1C :session resumed: 0x1E :session resumed, also new ticket"
1108
1109 /* Flags for string_vformat */
1110 #define SVFMT_EXTEND            BIT(0)
1111 #define SVFMT_REBUFFER          BIT(1)
1112 #define SVFMT_TAINT_NOCHK       BIT(2)
1113
1114
1115 #define NOTIFIER_SOCKET_NAME    "exim_daemon_notify"
1116 #define NOTIFY_MSG_QRUN         1       /* Notify message types */
1117 #define NOTIFY_QUEUE_SIZE_REQ   2
1118
1119 /* End of macros.h */