src/src/macros.h

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