src/src/macros.h

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