src/src/macros.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2014 */
   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
  16 /* When running in the test harness, the load average is fudged. */
  17
  18 #define OS_GETLOADAVG() \
  19   (running_in_test_harness? (test_harness_load_avg += 10) : os_getloadavg())
  20
  21
  22 /* The address_item structure has a word full of 1-bit flags. These macros
  23 manipulate them. */
  24
  25 #define setflag(addr,flag)    addr->flags |= (flag)
  26 #define clearflag(addr,flag)  addr->flags &= ~(flag)
  27
  28 #define testflag(addr,flag)       ((addr->flags & (flag)) != 0)
  29 #define testflagsall(addr,flag)   ((addr->flags & (flag)) == (flag))
  30
  31 #define copyflag(addrnew,addrold,flag) \
  32   addrnew->flags = (addrnew->flags & ~(flag)) | (addrold->flags & (flag))
  33
  34 #define orflag(addrnew,addrold,flag) \
  35   addrnew->flags |= addrold->flags & (flag)
  36
  37
  38 /* For almost all calls to convert things to printing characters, we want to
  39 allow tabs. A macro just makes life a bit easier. */
  40
  41 #define string_printing(s) string_printing2((s), TRUE)
  42
  43
  44 /* We need a special return code for "no recipients and failed to send an error
  45 message". ANSI C defines only EXIT_FAILURE and EXIT_SUCCESS. On the assumption
  46 that these are always 1 and 0 on Unix systems ... */
  47
  48 #define EXIT_NORECIPIENTS 2
  49
  50
  51 /* Character-handling macros. It seems that the set of standard functions in
  52 ctype.h aren't actually all that useful. One reason for this is that email is
  53 international, so the concept of using a locale to vary what they do is not
  54 helpful. Another problem is that in different operating systems, the libraries
  55 yield different results, even in the default locale. For example, Linux yields
  56 TRUE for iscntrl() for all characters > 127, whereas many other systems yield
  57 FALSE. For these reasons we define our own set of macros for a number of
  58 character testing functions. Ensure that all these tests treat their arguments
  59 as unsigned. */
  60
  61 #define mac_iscntrl(c) \
  62   ((uschar)(c) < 32 || (uschar)(c) == 127)
  63
  64 #define mac_iscntrl_or_special(c) \
  65   ((uschar)(c) < 32 || strchr(" ()<>@,;:\\\".[]\177", (uschar)(c)) != NULL)
  66
  67 #define mac_isgraph(c) \
  68   ((uschar)(c) > 32 && (uschar)(c) != 127)
  69
  70 #define mac_isprint(c) \
  71   (((uschar)(c) >= 32 && (uschar)(c) <= 126) || c == '\t' || \
  72   ((uschar)(c) > 127 && print_topbitchars))
  73
  74
  75 /* Convenience for testing strings */
  76
  77 #define streqic(Foo, Bar) (strcmpic(Foo, Bar) == 0)
  78
  79
  80 /* When built with TLS support, the act of flushing SMTP output becomes
  81 a no-op once an SSL session is in progress. */
  82
  83 #ifdef SUPPORT_TLS
  84 #define mac_smtp_fflush() if (tls_in.active < 0) fflush(smtp_out);
  85 #else
  86 #define mac_smtp_fflush() fflush(smtp_out);
  87 #endif
  88
  89
  90 /* Define which ends of pipes are for reading and writing, as some systems
  91 don't make the file descriptors two-way. */
  92
  93 #define pipe_read  0
  94 #define pipe_write 1
  95
  96 /* The RFC 1413 ident port */
  97
  98 #define IDENT_PORT 113
  99
 100 /* A macro to simplify testing bits in lookup types */
 101
 102 #define mac_islookup(a,b) ((lookup_list[a]->type & (b)) != 0)
 103
 104 /* Debugging control */
 105
 106 #define DEBUG(x)      if ((debug_selector & (x)) != 0)
 107 #define HDEBUG(x)     if (host_checking || (debug_selector & (x)) != 0)
 108
 109 /* The default From: text for DSNs */
 110
 111 #define DEFAULT_DSN_FROM "Mail Delivery System <Mailer-Daemon@$qualify_domain>"
 112
 113 /* The size of the vector for saving/restoring address expansion pointers while
 114 verifying. This has to be explicit because it is referenced in more than one
 115 source module. */
 116
 117 #define ADDRESS_EXPANSIONS_COUNT 18
 118
 119 /* The maximum permitted number of command-line (-D) macro definitions. We
 120 need a limit only to make it easier to generate argument vectors for re-exec
 121 of Exim. */
 122
 123 #define MAX_CLMACROS 10
 124
 125 /* The number of integer variables available in filter files. If this is
 126 changed, then the tables in expand.c for accessing them must be changed too. */
 127
 128 #define FILTER_VARIABLE_COUNT 10
 129
 130 /* The size of the vector holding delay warning times */
 131
 132 #define DELAY_WARNING_SIZE 12
 133
 134 /* The size of the buffer holding the processing information string. */
 135
 136 #define PROCESS_INFO_SIZE 256
 137
 138 /* The size of buffer to get for constructing log entries. Make it big
 139 enough to hold all the headers from a normal kind of message. */
 140
 141 #define LOG_BUFFER_SIZE 8192
 142
 143 /* The size of the circular buffer that remembers recent SMTP commands */
 144
 145 #define SMTP_HBUFF_SIZE 20
 146
 147 /* The initial size of a big buffer for use in various places. It gets put
 148 into big_buffer_size and in some circumstances increased. It should be at least
 149 as long as the maximum path length. */
 150
 151 #if defined PATH_MAX && PATH_MAX > 16384
 152 #define BIG_BUFFER_SIZE PATH_MAX
 153 #elif defined MAXPATHLEN && MAXPATHLEN > 16384
 154 #define BIG_BUFFER_SIZE MAXPATHLEN
 155 #else
 156 #define BIG_BUFFER_SIZE 16384
 157 #endif
 158
 159 /* header size of pipe content
 160    currently: char id, char subid, char[5] length */
 161 #define PIPE_HEADER_SIZE 7
 162
 163 /* This limits the length of data returned by local_scan(). Because it is
 164 written on the spool, it gets read into big_buffer. */
 165
 166 #define LOCAL_SCAN_MAX_RETURN (BIG_BUFFER_SIZE - 24)
 167
 168 /* A limit to the length of an address. RFC 2821 limits the local part to 64
 169 and the domain to 255, so this should be adequate, taking into account quotings
 170 etc. */
 171
 172 #define ADDRESS_MAXLENGTH 512
 173
 174 /* The length of the base names of spool files, which consist of an internal
 175 message id with a trailing "-H" or "-D" added. */
 176
 177 #define SPOOL_NAME_LENGTH (MESSAGE_ID_LENGTH+2)
 178
 179 /* The maximum number of message ids to store in a waiting database
 180 record. */
 181
 182 #define WAIT_NAME_MAX 50
 183
 184 /* Wait this long before determining that a Proxy Protocol configured
 185 host isn't speaking the protocol, and so is disallowed. Can be moved to
 186 runtime configuration if per site settings become needed. */
 187 #ifdef EXPERIMENTAL_PROXY
 188 #define PROXY_NEGOTIATION_TIMEOUT_SEC 3
 189 #define PROXY_NEGOTIATION_TIMEOUT_USEC 0
 190 #endif
 191
 192 /* Fixed option values for all PCRE functions */
 193
 194 #define PCRE_COPT 0   /* compile */
 195 #define PCRE_EOPT 0   /* exec */
 196
 197 /* Macros for trivial functions */
 198
 199 #define mac_ismsgid(s) \
 200   (pcre_exec(regex_ismsgid,NULL,CS s,Ustrlen(s),0,PCRE_EOPT,NULL,0) >= 0)
 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   DTYPE_NONE,
 217   DTYPE_ROUTER,
 218   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 EXPERIMENTAL_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 #define  OK            0    /* Successful match */
 273 #define  DEFER         1    /* Defer - some problem */
 274 #define  FAIL          2    /* Matching failed */
 275 #define  ERROR         3    /* Internal or config error */
 276 #define  FAIL_FORCED   4    /* "Forced" failure */
 277 /***********/
 278 #define DECLINE        5    /* Declined to handle the address, pass to next
 279                                  router unless no_more is set */
 280 #define PASS           6    /* Pass to next driver, or to pass_router,
 281                                  even if no_more is set */
 282 #define DISCARD        7    /* Address routed to :blackhole: or "seen finish" */
 283 #define SKIP           8    /* Skip this router (used in route_address only) */
 284 #define REROUTED       9    /* Address was changed and child created*/
 285 #define PANIC         10    /* Hard failed with internal error */
 286 #define BAD64         11    /* Bad base64 data (auth) */
 287 #define UNEXPECTED    12    /* Unexpected initial auth data */
 288 #define CANCELLED     13    /* Authentication cancelled */
 289 #define FAIL_SEND     14    /* send() failed in authenticator */
 290 #define FAIL_DROP     15    /* Fail and drop connection (used in ACL) */
 291
 292 /* Returns from the deliver_message() function */
 293
 294 #define DELIVER_ATTEMPTED_NORMAL   0  /* Tried a normal delivery */
 295 #define DELIVER_MUA_SUCCEEDED      1  /* Success when mua_wrapper is set */
 296 #define DELIVER_MUA_FAILED         2  /* Failure when mua_wrapper is set */
 297 #define DELIVER_NOT_ATTEMPTED      3  /* Not tried (no msg or is locked */
 298
 299 /* Returns from DNS lookup functions. */
 300
 301 enum { DNS_SUCCEED, DNS_NOMATCH, DNS_NODATA, DNS_AGAIN, DNS_FAIL };
 302
 303 /* Ending states when reading a message. The order is important. The test
 304 for having to swallow the rest of an SMTP message is whether the value is
 305 >= END_NOTENDED. */
 306
 307 #define END_NOTSTARTED 0    /* Message not started */
 308 #define END_DOT        1    /* Message ended with '.' */
 309 #define END_EOF        2    /* Message ended with EOF (error for SMTP) */
 310 #define END_NOTENDED   3    /* Message reading not yet ended */
 311 #define END_SIZE       4    /* Reading ended because message too big */
 312 #define END_WERROR     5    /* Write error while reading the message */
 313
 314 /* Options bits for debugging; D_v and D_local_scan are also in local_scan.h */
 315
 316 #define D_v                          0x00000001
 317 #define D_local_scan                 0x00000002
 318
 319 #define D_acl                        0x00000004
 320 #define D_auth                       0x00000008
 321 #define D_deliver                    0x00000010
 322 #define D_dns                        0x00000020
 323 #define D_dnsbl                      0x00000040
 324 #define D_exec                       0x00000080
 325 #define D_expand                     0x00000100
 326 #define D_filter                     0x00000200
 327 #define D_hints_lookup               0x00000400
 328 #define D_host_lookup                0x00000800
 329 #define D_ident                      0x00001000
 330 #define D_interface                  0x00002000
 331 #define D_lists                      0x00004000
 332 #define D_load                       0x00008000
 333 #define D_lookup                     0x00010000
 334 #define D_memory                     0x00020000
 335 #define D_pid                        0x00040000
 336 #define D_process_info               0x00080000
 337 #define D_queue_run                  0x00100000
 338 #define D_receive                    0x00200000
 339 #define D_resolver                   0x00400000
 340 #define D_retry                      0x00800000
 341 #define D_rewrite                    0x01000000
 342 #define D_route                      0x02000000
 343 #define D_timestamp                  0x04000000
 344 #define D_tls                        0x08000000
 345 #define D_transport                  0x10000000
 346 #define D_uid                        0x20000000
 347 #define D_verify                     0x40000000
 348
 349 /* The D_all value must always have all bits set, as it is recognized specially
 350 by the function that decodes debug and log selectors. This is to enable it to
 351 set all the bits in a multi-word selector. Debug doesn't use this yet, but we
 352 are getting close. In fact, we want to omit "memory" for -d+all, but can't
 353 handle this here. It is fudged externally. */
 354
 355 #define D_all                        0xffffffff
 356
 357 #define D_any                        (D_all & \
 358                                        ~(D_v           | \
 359                                          D_pid         | \
 360                                          D_timestamp)  )
 361
 362 #define D_default                    (0xffffffff & \
 363                                        ~(D_expand      | \
 364                                          D_filter      | \
 365                                          D_interface   | \
 366                                          D_load        | \
 367                                          D_local_scan  | \
 368                                          D_memory      | \
 369                                          D_pid         | \
 370                                          D_timestamp   | \
 371                                          D_resolver))
 372
 373 /* Options bits for logging. Those that will end up in log_write_selector have
 374 values < 0x80000000. They can be used in calls to log_write(). The others have
 375 values > 0x80000000 and are put into log_extra_selector (without the top bit).
 376 These are only ever tested independently. "All" is a magic value that is used
 377 only in the name table to set all options in both bit maps. */
 378
 379 /* The L_all value must always have all bits set, as it is recognized specially
 380 by the function that decodes debug and log selectors. This is to enable it to
 381 set all the bits in a multi-word selector. */
 382
 383 #define L_all                          0xffffffff
 384
 385 #define L_address_rewrite              0x00000001
 386 #define L_all_parents                  0x00000002
 387 #define L_connection_reject            0x00000004
 388 #define L_delay_delivery               0x00000008
 389 #define L_dnslist_defer                0x00000010
 390 #define L_etrn                         0x00000020
 391 #define L_host_lookup_failed           0x00000040
 392 #define L_lost_incoming_connection     0x00000080
 393 #define L_queue_run                    0x00000100
 394 #define L_retry_defer                  0x00000200
 395 #define L_size_reject                  0x00000400
 396 #define L_skip_delivery                0x00000800
 397 #define L_smtp_connection              0x00001000
 398 #define L_smtp_incomplete_transaction  0x00002000
 399 #define L_smtp_protocol_error          0x00004000
 400 #define L_smtp_syntax_error            0x00008000
 401
 402 #define LX_acl_warn_skipped            0x80000001
 403 #define LX_arguments                   0x80000002
 404 #define LX_deliver_time                0x80000004
 405 #define LX_delivery_size               0x80000008
 406 #define LX_ident_timeout               0x80000010
 407 #define LX_incoming_interface          0x80000020
 408 #define LX_incoming_port               0x80000040
 409 #define LX_outgoing_port               0x80000080
 410 #define LX_pid                         0x80000100
 411 #define LX_queue_time                  0x80000200
 412 #define LX_queue_time_overall          0x80000400
 413 #define LX_received_sender             0x80000800
 414 #define LX_received_recipients         0x80001000
 415 #define LX_rejected_header             0x80002000
 416 #define LX_return_path_on_delivery     0x80004000
 417 #define LX_sender_on_delivery          0x80008000
 418 #define LX_sender_verify_fail          0x80010000
 419 #define LX_smtp_confirmation           0x80020000
 420 #define LX_smtp_no_mail                0x80040000
 421 #define LX_subject                     0x80080000
 422 #define LX_tls_certificate_verified    0x80100000
 423 #define LX_tls_cipher                  0x80200000
 424 #define LX_tls_peerdn                  0x80400000
 425 #define LX_tls_sni                     0x80800000
 426 #define LX_unknown_in_list             0x81000000
 427 #define LX_8bitmime                    0x82000000
 428 #define LX_smtp_mailauth               0x84000000
 429 #define LX_proxy                       0x88000000
 430
 431 #define L_default     (L_connection_reject        | \
 432                        L_delay_delivery           | \
 433                        L_dnslist_defer            | \
 434                        L_etrn                     | \
 435                        L_host_lookup_failed       | \
 436                        L_lost_incoming_connection | \
 437                        L_queue_run                | \
 438                        L_retry_defer              | \
 439                        L_size_reject              | \
 440                        L_skip_delivery)
 441
 442 #define LX_default   ((LX_acl_warn_skipped        | \
 443                        LX_rejected_header         | \
 444                        LX_sender_verify_fail      | \
 445                        LX_smtp_confirmation       | \
 446                        LX_tls_certificate_verified| \
 447                        LX_tls_cipher) & 0x7fffffff)
 448
 449 /* Private error numbers for delivery failures, set negative so as not
 450 to conflict with system errno values. */
 451
 452 #define ERRNO_UNKNOWNERROR    (-1)
 453 #define ERRNO_USERSLASH       (-2)
 454 #define ERRNO_EXISTRACE       (-3)
 455 #define ERRNO_NOTREGULAR      (-4)
 456 #define ERRNO_NOTDIRECTORY    (-5)
 457 #define ERRNO_BADUGID         (-6)
 458 #define ERRNO_BADMODE         (-7)
 459 #define ERRNO_INODECHANGED    (-8)
 460 #define ERRNO_LOCKFAILED      (-9)
 461 #define ERRNO_BADADDRESS2    (-10)
 462 #define ERRNO_FORBIDPIPE     (-11)
 463 #define ERRNO_FORBIDFILE     (-12)
 464 #define ERRNO_FORBIDREPLY    (-13)
 465 #define ERRNO_MISSINGPIPE    (-14)
 466 #define ERRNO_MISSINGFILE    (-15)
 467 #define ERRNO_MISSINGREPLY   (-16)
 468 #define ERRNO_BADREDIRECT    (-17)
 469 #define ERRNO_SMTPCLOSED     (-18)
 470 #define ERRNO_SMTPFORMAT     (-19)
 471 #define ERRNO_SPOOLFORMAT    (-20)
 472 #define ERRNO_NOTABSOLUTE    (-21)
 473 #define ERRNO_EXIMQUOTA      (-22)   /* Exim-imposed quota */
 474 #define ERRNO_HELD           (-23)
 475 #define ERRNO_FILTER_FAIL    (-24)   /* Delivery filter process failure */
 476 #define ERRNO_CHHEADER_FAIL  (-25)   /* Delivery add/remove header failure */
 477 #define ERRNO_WRITEINCOMPLETE (-26)  /* Delivery write incomplete error */
 478 #define ERRNO_EXPANDFAIL     (-27)   /* Some expansion failed */
 479 #define ERRNO_GIDFAIL        (-28)   /* Failed to get gid */
 480 #define ERRNO_UIDFAIL        (-29)   /* Failed to get uid */
 481 #define ERRNO_BADTRANSPORT   (-30)   /* Unset or non-existent transport */
 482 #define ERRNO_MBXLENGTH      (-31)   /* MBX length mismatch */
 483 #define ERRNO_UNKNOWNHOST    (-32)   /* Lookup failed in smtp transport */
 484 #define ERRNO_FORMATUNKNOWN  (-33)   /* Can't match format in appendfile */
 485 #define ERRNO_BADCREATE      (-34)   /* Creation outside home in appendfile */
 486 #define ERRNO_LISTDEFER      (-35)   /* Can't check a list; lookup defer */
 487 #define ERRNO_DNSDEFER       (-36)   /* DNS lookup defer */
 488 #define ERRNO_TLSFAILURE     (-37)   /* Failed to start TLS session */
 489 #define ERRNO_TLSREQUIRED    (-38)   /* Mandatory TLS session not started */
 490 #define ERRNO_CHOWNFAIL      (-39)   /* Failed to chown a file */
 491 #define ERRNO_PIPEFAIL       (-40)   /* Failed to create a pipe */
 492 #define ERRNO_CALLOUTDEFER   (-41)   /* When verifying */
 493 #define ERRNO_AUTHFAIL       (-42)   /* When required by client */
 494 #define ERRNO_CONNECTTIMEOUT (-43)   /* Used internally in smtp transport */
 495 #define ERRNO_RCPT4XX        (-44)   /* RCPT gave 4xx error */
 496 #define ERRNO_MAIL4XX        (-45)   /* MAIL gave 4xx error */
 497 #define ERRNO_DATA4XX        (-46)   /* DATA gave 4xx error */
 498 #define ERRNO_PROXYFAIL      (-47)   /* Negotiation failed for proxy configured host */
 499 #define ERRNO_AUTHPROB       (-48)   /* Autheticator "other" failure */
 500
 501 /* These must be last, so all retry deferments can easily be identified */
 502
 503 #define ERRNO_RETRY_BASE     (-51)   /* Base to test against */
 504 #define ERRNO_RRETRY         (-51)   /* Not time for routing */
 505 #define ERRNO_LRETRY         (-52)   /* Not time for local delivery */
 506 #define ERRNO_HRETRY         (-53)   /* Not time for any remote host */
 507 #define ERRNO_LOCAL_ONLY     (-54)   /* Local-only delivery */
 508 #define ERRNO_QUEUE_DOMAIN   (-55)   /* Domain in queue_domains */
 509
 510 /* Special actions to take after failure or deferment. */
 511
 512 enum {
 513   SPECIAL_NONE,             /* No special action */
 514   SPECIAL_FREEZE,           /* Freeze message */
 515   SPECIAL_FAIL,             /* Fail the delivery */
 516   SPECIAL_WARN              /* Send a warning message */
 517 };
 518
 519 /* Flags that get ORed into the more_errno field of an address to give more
 520 information about errors for retry purposes. They are greater than 256, because
 521 the bottom byte contains 'A' or 'M' for remote addresses, to indicate whether
 522 the name was looked up only via an address record or whether MX records were
 523 used, respectively. */
 524
 525 #define RTEF_CTOUT     0x0100      /* Connection timed out */
 526
 527 /* Permission and other options for parse_extract_addresses(),
 528 filter_interpret(), and rda_interpret(), i.e. what special things are allowed
 529 in redirection operations. Not all apply to all cases. Some of the bits allow
 530 and some forbid, reflecting the "allow" and "forbid" options in the redirect
 531 router, which were chosen to represent the standard situation for users'
 532 .forward files. */
 533
 534 #define RDO_BLACKHOLE    0x00000001  /* Forbid :blackhole: */
 535 #define RDO_DEFER        0x00000002  /* Allow :defer: or "defer" */
 536 #define RDO_EACCES       0x00000004  /* Ignore EACCES */
 537 #define RDO_ENOTDIR      0x00000008  /* Ignore ENOTDIR */
 538 #define RDO_EXISTS       0x00000010  /* Forbid "exists" in expansion in filter */
 539 #define RDO_FAIL         0x00000020  /* Allow :fail: or "fail" */
 540 #define RDO_FILTER       0x00000040  /* Allow a filter script */
 541 #define RDO_FREEZE       0x00000080  /* Allow "freeze" */
 542 #define RDO_INCLUDE      0x00000100  /* Forbid :include: */
 543 #define RDO_LOG          0x00000200  /* Forbid "log" */
 544 #define RDO_LOOKUP       0x00000400  /* Forbid "lookup" in expansion in filter */
 545 #define RDO_PERL         0x00000800  /* Forbid "perl" in expansion in filter */
 546 #define RDO_READFILE     0x00001000  /* Forbid "readfile" in exp in filter */
 547 #define RDO_READSOCK     0x00002000  /* Forbid "readsocket" in exp in filter */
 548 #define RDO_RUN          0x00004000  /* Forbid "run" in expansion in filter */
 549 #define RDO_DLFUNC       0x00008000  /* Forbid "dlfunc" in expansion in filter */
 550 #define RDO_REALLOG      0x00010000  /* Really do log (not testing/verifying) */
 551 #define RDO_REWRITE      0x00020000  /* Rewrite generated addresses */
 552 #define RDO_EXIM_FILTER  0x00040000  /* Forbid Exim filters */
 553 #define RDO_SIEVE_FILTER 0x00080000  /* Forbid Sieve filters */
 554 #define RDO_PREPEND_HOME 0x00100000  /* Prepend $home to relative paths in Exim filter save commands */
 555
 556 /* This is the set that apply to expansions in filters */
 557
 558 #define RDO_FILTER_EXPANSIONS \
 559   (RDO_EXISTS|RDO_LOOKUP|RDO_PERL|RDO_READFILE|RDO_READSOCK|RDO_RUN|RDO_DLFUNC)
 560
 561 /* As well as the RDO bits themselves, we need the bit numbers in order to
 562 access (most of) the individual bits as separate options. This could be
 563 automated, but I haven't bothered. Keep this list in step with the above! */
 564
 565 enum { RDON_BLACKHOLE, RDON_DEFER, RDON_EACCES, RDON_ENOTDIR, RDON_EXISTS,
 566   RDON_FAIL, RDON_FILTER, RDON_FREEZE, RDON_INCLUDE, RDON_LOG, RDON_LOOKUP,
 567   RDON_PERL, RDON_READFILE, RDON_READSOCK, RDON_RUN, RDON_DLFUNC, RDON_REALLOG,
 568   RDON_REWRITE, RDON_EXIM_FILTER, RDON_SIEVE_FILTER, RDON_PREPEND_HOME };
 569
 570 /* Results of filter or forward file processing. Some are only from a filter;
 571 some are only from a forward file. */
 572
 573 enum {
 574   FF_DELIVERED,         /* Success, took significant action */
 575   FF_NOTDELIVERED,      /* Success, didn't take significant action */
 576   FF_BLACKHOLE,         /* Blackholing requested */
 577   FF_DEFER,             /* Defer requested */
 578   FF_FAIL,              /* Fail requested */
 579   FF_INCLUDEFAIL,       /* :include: failed */
 580   FF_NONEXIST,          /* Forward file does not exist */
 581   FF_FREEZE,            /* Freeze requested */
 582   FF_ERROR              /* We have a problem */
 583 };
 584
 585 /* Values for identifying particular headers; printing characters are used, so
 586 they can be read in the spool file for those headers that are permanently
 587 marked. The lower case values don't get onto the spool; they are used only as
 588 return values from header_checkname(). */
 589
 590 #define htype_other         ' '   /* Unspecified header */
 591 #define htype_from          'F'
 592 #define htype_to            'T'
 593 #define htype_cc            'C'
 594 #define htype_bcc           'B'
 595 #define htype_id            'I'   /* for message-id */
 596 #define htype_reply_to      'R'
 597 #define htype_received      'P'   /* P for Postmark */
 598 #define htype_sender        'S'
 599 #define htype_old           '*'   /* Replaced header */
 600
 601 #define htype_date          'd'
 602 #define htype_return_path   'p'
 603 #define htype_delivery_date 'x'
 604 #define htype_envelope_to   'e'
 605 #define htype_subject       's'
 606
 607 /* These values are used only when adding new headers from an ACL; they too
 608 never get onto the spool. The type of the added header is set by reference
 609 to the header name, by calling header_checkname(). */
 610
 611 #define htype_add_top       'a'
 612 #define htype_add_rec       'r'
 613 #define htype_add_bot       'z'
 614 #define htype_add_rfc       'f'
 615
 616 /* Types of item in options lists. These are the bottom 8 bits of the "type"
 617 field, which is an int. The opt_void value is used for entries in tables that
 618 point to special types of value that are accessed only indirectly (e.g. the
 619 rewrite data that is built out of a string option.) We need to have some values
 620 visible in local_scan, so the following are declared there:
 621
 622   opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed, opt_time,
 623   opt_bool
 624
 625 To make sure we don't conflict, the local_scan.h values start from zero, and
 626 those defined here start from 32. The boolean ones must all be together so they
 627 can be easily tested as a group. That is the only use of opt_bool_last. */
 628
 629 enum { opt_bit = 32, opt_bool_verify, opt_bool_set, opt_expand_bool,
 630   opt_bool_last,
 631   opt_rewrite, opt_timelist, opt_uid, opt_gid, opt_uidlist, opt_gidlist,
 632   opt_expand_uid, opt_expand_gid, opt_void };
 633
 634 /* There's a high-ish bit which is used to flag duplicate options, kept
 635 for compatibility, which shouldn't be output. Also used for hidden options
 636 that are automatically maintained from others. Another high bit is used to
 637 flag driver options that although private (so as to be settable only on some
 638 drivers), are stored in the instance block so as to be accessible from outside.
 639 A third high bit is set when an option is read, so as to be able to give an
 640 error if any option is set twice. Finally, there's a bit which is set when an
 641 option is set with the "hide" prefix, to prevent -bP from showing it to
 642 non-admin callers. The next byte up in the int is used to keep the bit number
 643 for booleans that are kept in one bit. */
 644
 645 #define opt_hidden  0x100      /* Private to Exim */
 646 #define opt_public  0x200      /* Stored in the main instance block */
 647 #define opt_set     0x400      /* Option is set */
 648 #define opt_secure  0x800      /* "hide" prefix used */
 649 #define opt_rep_con 0x1000     /* Can be appended to by a repeated line (condition) */
 650 #define opt_rep_str 0x2000     /* Can be appended to by a repeated line (string) */
 651 #define opt_mask    0x00ff
 652
 653 /* Verify types when directing and routing */
 654
 655 enum { v_none, v_sender, v_recipient, v_expn };
 656
 657 /* Option flags for verify_address() */
 658
 659 #define vopt_fake_sender          0x0001   /* for verify=sender=<address> */
 660 #define vopt_is_recipient         0x0002
 661 #define vopt_qualify              0x0004
 662 #define vopt_expn                 0x0008
 663 #define vopt_callout_fullpm       0x0010   /* full postmaster during callout */
 664 #define vopt_callout_random       0x0020   /* during callout */
 665 #define vopt_callout_no_cache     0x0040   /* disable callout cache */
 666 #define vopt_callout_recipsender  0x0080   /* use real sender to verify recip */
 667 #define vopt_callout_recippmaster 0x0100   /* use postmaster to verify recip */
 668 #define vopt_success_on_redirect  0x0200
 669
 670 /* Values for fields in callout cache records */
 671
 672 #define ccache_unknown         0       /* test hasn't been done */
 673 #define ccache_accept          1
 674 #define ccache_reject          2       /* All rejections except */
 675 #define ccache_reject_mfnull   3       /* MAIL FROM:<> was rejected */
 676
 677 /* Options for lookup functions */
 678
 679 #define lookup_querystyle      1    /* query-style lookup */
 680 #define lookup_absfile         2    /* requires absolute file name */
 681 #define lookup_absfilequery    4    /* query-style starts with file name */
 682
 683 /* Status values for host_item blocks. Require hstatus_unusable and
 684 hstatus_unusable_expired to be last. */
 685
 686 enum { hstatus_unknown, hstatus_usable, hstatus_unusable,
 687        hstatus_unusable_expired };
 688
 689 /* Reasons why a host is unusable (for clearer log messages) */
 690
 691 enum { hwhy_unknown, hwhy_retry, hwhy_failed, hwhy_deferred, hwhy_ignored };
 692
 693 /* Domain lookup types for routers */
 694
 695 enum { lk_default, lk_byname, lk_bydns };
 696
 697 /* Values for the self_code fields */
 698
 699 enum { self_freeze, self_defer, self_send, self_reroute, self_pass, self_fail };
 700
 701 /* Flags for rewrite rules */
 702
 703 #define rewrite_sender       0x0001
 704 #define rewrite_from         0x0002
 705 #define rewrite_to           0x0004
 706 #define rewrite_cc           0x0008
 707 #define rewrite_bcc          0x0010
 708 #define rewrite_replyto      0x0020
 709 #define rewrite_all_headers  0x003F  /* all header flags */
 710
 711 #define rewrite_envfrom      0x0040
 712 #define rewrite_envto        0x0080
 713 #define rewrite_all_envelope 0x00C0  /* all envelope flags */
 714
 715 #define rewrite_all      (rewrite_all_headers | rewrite_all_envelope)
 716
 717 #define rewrite_smtp         0x0100  /* rewrite at SMTP time */
 718 #define rewrite_smtp_sender  0x0200  /* SMTP sender rewrite (allows <>) */
 719 #define rewrite_qualify      0x0400  /* qualify if necessary */
 720 #define rewrite_repeat       0x0800  /* repeat rewrite rule */
 721
 722 #define rewrite_whole        0x1000  /* option bit for headers */
 723 #define rewrite_quit         0x2000  /* "no more" option */
 724
 725 /* Flags for log_write(); LOG_MAIN, LOG_PANIC, and LOG_REJECT are also in
 726 local_scan.h */
 727
 728 #define LOG_MAIN           1      /* Write to the main log */
 729 #define LOG_PANIC          2      /* Write to the panic log */
 730 #define LOG_PANIC_DIE      6      /* Write to the panic log and then die */
 731 #define LOG_REJECT        16      /* Write to the reject log, with headers */
 732 #define LOG_SENDER        32      /* Add raw sender to the message */
 733 #define LOG_RECIPIENTS    64      /* Add raw recipients to the message */
 734 #define LOG_CONFIG       128      /* Add "Exim configuration error" */
 735 #define LOG_CONFIG_FOR  (256+128) /* Add " for" instead of ":\n" */
 736 #define LOG_CONFIG_IN   (512+128) /* Add " in line x[ of file y]" */
 737
 738 /* and for debug_bits() logging action control: */
 739 #define DEBUG_FROM_CONFIG       0x0001
 740
 741 /* SMTP command identifiers for the smtp_connection_had field that records the
 742 most recent SMTP commands. Must be kept in step with the list of names in
 743 smtp_in.c that is used for creating the smtp_no_mail logging action. SCH_NONE
 744 is "empty". */
 745
 746 enum { SCH_NONE, SCH_AUTH, SCH_DATA, SCH_EHLO, SCH_ETRN, SCH_EXPN, SCH_HELO,
 747        SCH_HELP, SCH_MAIL, SCH_NOOP, SCH_QUIT, SCH_RCPT, SCH_RSET, SCH_STARTTLS,
 748        SCH_VRFY };
 749
 750 /* Returns from host_find_by{name,dns}() */
 751
 752 enum {
 753   HOST_FIND_FAILED,     /* failed to find the host */
 754   HOST_FIND_AGAIN,      /* could not resolve at this time */
 755   HOST_FOUND,           /* found host */
 756   HOST_FOUND_LOCAL,     /* found, but MX points to local host */
 757   HOST_IGNORED          /* found but ignored - used internally only */
 758 };
 759
 760 /* Flags for host_find_bydns() */
 761
 762 #define HOST_FIND_BY_SRV          0x0001
 763 #define HOST_FIND_BY_MX           0x0002
 764 #define HOST_FIND_BY_A            0x0004
 765 #define HOST_FIND_QUALIFY_SINGLE  0x0008
 766 #define HOST_FIND_SEARCH_PARENTS  0x0010
 767
 768 /* Actions applied to specific messages. */
 769
 770 enum { MSG_DELIVER, MSG_FREEZE, MSG_REMOVE, MSG_THAW, MSG_ADD_RECIPIENT,
 771        MSG_MARK_ALL_DELIVERED, MSG_MARK_DELIVERED, MSG_EDIT_SENDER,
 772        MSG_SHOW_COPY, MSG_LOAD,
 773        /* These ones must be last: a test for >= MSG_SHOW_BODY is used
 774        to test for actions that list individual spool files. */
 775        MSG_SHOW_BODY, MSG_SHOW_HEADER, MSG_SHOW_LOG };
 776
 777 /* Returns from the spool_read_header() function */
 778
 779 enum {
 780   spool_read_OK,        /* success */
 781   spool_read_notopen,   /* open failed */
 782   spool_read_enverror,  /* error in the envelope */
 783   spool_read_hdrerror   /* error in the headers */
 784 };
 785
 786 /* Options for transport_write_message */
 787
 788 #define topt_add_return_path    0x001
 789 #define topt_add_delivery_date  0x002
 790 #define topt_add_envelope_to    0x004
 791 #define topt_use_crlf           0x008  /* Terminate lines with CRLF */
 792 #define topt_end_dot            0x010  /* Send terminting dot line */
 793 #define topt_no_headers         0x020  /* Omit headers */
 794 #define topt_no_body            0x040  /* Omit body */
 795 #define topt_escape_headers     0x080  /* Apply escape check to headers */
 796
 797 /* Flags for recipient_block, used in DSN support */
 798
 799 #define rf_dsnlasthop           0x01  /* Do not propagate DSN any further */
 800 #define rf_notify_never         0x02  /* NOTIFY= settings */
 801 #define rf_notify_success       0x04
 802 #define rf_notify_failure       0x08
 803 #define rf_notify_delay         0x10
 804
 805 #define rf_dsnflags  (rf_notify_never | rf_notify_success | \
 806                       rf_notify_failure | rf_notify_delay)
 807
 808 /* DSN RET types */
 809
 810 #define dsn_ret_full            1
 811 #define dsn_ret_hdrs            2
 812
 813 #define dsn_support_unknown     0
 814 #define dsn_support_yes         1
 815 #define dsn_support_no          2
 816
 817
 818 /* Codes for the host_find_failed and host_all_ignored options. */
 819
 820 #define hff_freeze   0
 821 #define hff_defer    1
 822 #define hff_pass     2
 823 #define hff_decline  3
 824 #define hff_fail     4
 825 #define hff_ignore   5
 826
 827 /* Router information flags */
 828
 829 #define ri_yestransport    0x0001    /* Must have a transport */
 830 #define ri_notransport     0x0002    /* Must not have a transport */
 831
 832 /* Codes for match types in match_check_list; to any of them, MCL_NOEXPAND may
 833 be added */
 834
 835 #define MCL_NOEXPAND  16
 836
 837 enum { MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, MCL_LOCALPART };
 838
 839 /* Codes for the places from which ACLs can be called. These are cunningly
 840 ordered to make it easy to implement tests for certain ACLs when processing
 841 "control" modifiers, by means of a maximum "where" value. Do not modify this
 842 order without checking carefully!
 843
 844 **** IMPORTANT***
 845 ****   Furthermore, remember to keep these in step with the tables
 846 ****   of names and response codes in globals.c.
 847 **** IMPORTANT ****
 848 */
 849
 850 enum { ACL_WHERE_RCPT,       /* Some controls are for RCPT only */
 851        ACL_WHERE_MAIL,       /* )                                           */
 852        ACL_WHERE_PREDATA,    /* ) There are several tests for "in message", */
 853        ACL_WHERE_MIME,       /* ) implemented by <= WHERE_NOTSMTP           */
 854        ACL_WHERE_DKIM,       /* )                                           */
 855        ACL_WHERE_DATA,       /* )                                           */
 856 #ifndef DISABLE_PRDR
 857        ACL_WHERE_PRDR,       /* )                                           */
 858 #endif
 859        ACL_WHERE_NOTSMTP,    /* )                                           */
 860
 861        ACL_WHERE_AUTH,       /* These remaining ones are not currently    */
 862        ACL_WHERE_CONNECT,    /* required to be in a special order so they */
 863        ACL_WHERE_ETRN,       /* are just alphabetical.                    */
 864        ACL_WHERE_EXPN,
 865        ACL_WHERE_HELO,
 866        ACL_WHERE_MAILAUTH,
 867        ACL_WHERE_NOTSMTP_START,
 868        ACL_WHERE_NOTQUIT,
 869        ACL_WHERE_QUIT,
 870        ACL_WHERE_STARTTLS,
 871        ACL_WHERE_VRFY,
 872
 873        ACL_WHERE_DELIVERY,
 874        ACL_WHERE_UNKNOWN     /* Currently used by a ${acl:name} expansion */
 875      };
 876
 877 /* Situations for spool_write_header() */
 878
 879 enum { SW_RECEIVING, SW_DELIVERING, SW_MODIFYING };
 880
 881 /* MX fields for hosts not obtained from MX records are always negative.
 882 MX_NONE is the default case; lesser values are used when the hosts are
 883 randomized in batches. */
 884
 885 #define MX_NONE           (-1)
 886
 887 /* host_item.port defaults to PORT_NONE; the only current case where this
 888 is changed before running the transport is when an dnslookup router sets an
 889 explicit port number. */
 890
 891 #define PORT_NONE     (-1)
 892
 893 /* Flags for single-key search defaults */
 894
 895 #define SEARCH_STAR       0x01
 896 #define SEARCH_STARAT     0x02
 897
 898 /* Filter types */
 899
 900 enum { FILTER_UNSET, FILTER_FORWARD, FILTER_EXIM, FILTER_SIEVE };
 901
 902 /* End of macros.h */