src/src/macros.h

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