src/src/macros.h

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