src/src/macros.h

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