src/src/macros.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2012 */
   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 /* This limits the length of data returned by local_scan(). Because it is
 160 written on the spool, it gets read into big_buffer. */
 161
 162 #define LOCAL_SCAN_MAX_RETURN (BIG_BUFFER_SIZE - 24)
 163
 164 /* A limit to the length of an address. RFC 2821 limits the local part to 64
 165 and the domain to 255, so this should be adequate, taking into account quotings
 166 etc. */
 167
 168 #define ADDRESS_MAXLENGTH 512
 169
 170 /* The length of the base names of spool files, which consist of an internal
 171 message id with a trailing "-H" or "-D" added. */
 172
 173 #define SPOOL_NAME_LENGTH (MESSAGE_ID_LENGTH+2)
 174
 175 /* The maximum number of message ids to store in a waiting database
 176 record. */
 177
 178 #define WAIT_NAME_MAX 50
 179
 180 /* Fixed option values for all PCRE functions */
 181
 182 #define PCRE_COPT 0   /* compile */
 183 #define PCRE_EOPT 0   /* exec */
 184
 185 /* Macros for trivial functions */
 186
 187 #define mac_ismsgid(s) \
 188   (pcre_exec(regex_ismsgid,NULL,CS s,Ustrlen(s),0,PCRE_EOPT,NULL,0) >= 0)
 189
 190
 191 /* Options for dns_next_rr */
 192
 193 enum { RESET_NEXT, RESET_ANSWERS, RESET_AUTHORITY, RESET_ADDITIONAL };
 194
 195 /* Argument values for the time-of-day function */
 196
 197 enum { tod_log, tod_log_bare, tod_log_zone, tod_log_datestamp_daily,
 198        tod_log_datestamp_monthly, tod_zone, tod_full, tod_bsdin,
 199        tod_mbx, tod_epoch, tod_epoch_l, tod_zulu };
 200
 201 /* For identifying types of driver */
 202
 203 enum {
 204   DTYPE_NONE,
 205   DTYPE_ROUTER,
 206   DTYPE_TRANSPORT
 207 };
 208
 209 /* Error numbers for generating error messages when reading a message on the
 210 standard input. */
 211
 212 enum {
 213   ERRMESS_BADARGADDRESS,    /* Bad address via argument list */
 214   ERRMESS_BADADDRESS,       /* Bad address read via -t */
 215   ERRMESS_NOADDRESS,        /* Message has no addresses */
 216   ERRMESS_IGADDRESS,        /* All -t addresses ignored */
 217   ERRMESS_BADNOADDRESS,     /* Bad address via -t, leaving none */
 218   ERRMESS_IOERR,            /* I/O error while reading a message */
 219   ERRMESS_VLONGHEADER,      /* Excessively long message header */
 220   ERRMESS_VLONGHDRLINE,     /* Excessively long single line in header */
 221   ERRMESS_TOOBIG,           /* Message too big */
 222   ERRMESS_TOOMANYRECIP,     /* Too many recipients */
 223   ERRMESS_LOCAL_SCAN,       /* Rejected by local scan */
 224   ERRMESS_LOCAL_ACL         /* Rejected by non-SMTP ACL */
 225 };
 226
 227 /* Error handling styles - set by option, and apply only when receiving
 228 a local message not via SMTP. */
 229
 230 enum {
 231   ERRORS_SENDER,            /* Return to sender (default) */
 232   ERRORS_STDERR             /* Write on stderr */
 233 };
 234
 235 /* Exec control values when Exim execs itself via child_exec_exim. */
 236
 237 enum {
 238   CEE_RETURN_ARGV,          /* Don't exec, just build and return argv */
 239   CEE_EXEC_EXIT,            /* Just exit if exec fails */
 240   CEE_EXEC_PANIC            /* Panic-die if exec fails */
 241 };
 242
 243 /* Bit values for filter_test */
 244
 245 #define FTEST_NONE     0    /* Not filter testing */
 246 #define FTEST_USER     1    /* Testing user filter */
 247 #define FTEST_SYSTEM   2    /* Testing system filter */
 248
 249 /* Returns from the routing, transport and authentication functions (not all
 250 apply to all of them). Some other functions also use these convenient values,
 251 and some additional values are used only by non-driver functions.
 252
 253 OK, FAIL, DEFER, ERROR, and FAIL_FORCED are also declared in local_scan.h for
 254 use in the local_scan() function and in ${dlfunc loaded functions. Do not
 255 change them unilaterally. */
 256
 257 #define  OK            0    /* Successful match */
 258 #define  DEFER         1    /* Defer - some problem */
 259 #define  FAIL          2    /* Matching failed */
 260 #define  ERROR         3    /* Internal or config error */
 261 #define  FAIL_FORCED   4    /* "Forced" failure */
 262 /***********/
 263 #define DECLINE        5    /* Declined to handle the address, pass to next
 264                                  router unless no_more is set */
 265 #define PASS           6    /* Pass to next driver, or to pass_router,
 266                                  even if no_more is set */
 267 #define DISCARD        7    /* Address routed to :blackhole: or "seen finish" */
 268 #define SKIP           8    /* Skip this router (used in route_address only) */
 269 #define REROUTED       9    /* Address was changed and child created*/
 270 #define PANIC         10    /* Hard failed with internal error */
 271 #define BAD64         11    /* Bad base64 data (auth) */
 272 #define UNEXPECTED    12    /* Unexpected initial auth data */
 273 #define CANCELLED     13    /* Authentication cancelled */
 274 #define FAIL_SEND     14    /* send() failed in authenticator */
 275 #define FAIL_DROP     15    /* Fail and drop connection (used in ACL) */
 276
 277 /* Returns from the deliver_message() function */
 278
 279 #define DELIVER_ATTEMPTED_NORMAL   0  /* Tried a normal delivery */
 280 #define DELIVER_MUA_SUCCEEDED      1  /* Success when mua_wrapper is set */
 281 #define DELIVER_MUA_FAILED         2  /* Failure when mua_wrapper is set */
 282 #define DELIVER_NOT_ATTEMPTED      3  /* Not tried (no msg or is locked */
 283
 284 /* Returns from DNS lookup functions. */
 285
 286 enum { DNS_SUCCEED, DNS_NOMATCH, DNS_NODATA, DNS_AGAIN, DNS_FAIL };
 287
 288 /* Ending states when reading a message. The order is important. The test
 289 for having to swallow the rest of an SMTP message is whether the value is
 290 >= END_NOTENDED. */
 291
 292 #define END_NOTSTARTED 0    /* Message not started */
 293 #define END_DOT        1    /* Message ended with '.' */
 294 #define END_EOF        2    /* Message ended with EOF (error for SMTP) */
 295 #define END_NOTENDED   3    /* Message reading not yet ended */
 296 #define END_SIZE       4    /* Reading ended because message too big */
 297 #define END_WERROR     5    /* Write error while reading the message */
 298
 299 /* Options bits for debugging; D_v and D_local_scan are also in local_scan.h */
 300
 301 #define D_v                          0x00000001
 302 #define D_local_scan                 0x00000002
 303
 304 #define D_acl                        0x00000004
 305 #define D_auth                       0x00000008
 306 #define D_deliver                    0x00000010
 307 #define D_dns                        0x00000020
 308 #define D_dnsbl                      0x00000040
 309 #define D_exec                       0x00000080
 310 #define D_expand                     0x00000100
 311 #define D_filter                     0x00000200
 312 #define D_hints_lookup               0x00000400
 313 #define D_host_lookup                0x00000800
 314 #define D_ident                      0x00001000
 315 #define D_interface                  0x00002000
 316 #define D_lists                      0x00004000
 317 #define D_load                       0x00008000
 318 #define D_lookup                     0x00010000
 319 #define D_memory                     0x00020000
 320 #define D_pid                        0x00040000
 321 #define D_process_info               0x00080000
 322 #define D_queue_run                  0x00100000
 323 #define D_receive                    0x00200000
 324 #define D_resolver                   0x00400000
 325 #define D_retry                      0x00800000
 326 #define D_rewrite                    0x01000000
 327 #define D_route                      0x02000000
 328 #define D_timestamp                  0x04000000
 329 #define D_tls                        0x08000000
 330 #define D_transport                  0x10000000
 331 #define D_uid                        0x20000000
 332 #define D_verify                     0x40000000
 333
 334 /* The D_all value must always have all bits set, as it is recognized specially
 335 by the function that decodes debug and log selectors. This is to enable it to
 336 set all the bits in a multi-word selector. Debug doesn't use this yet, but we
 337 are getting close. In fact, we want to omit "memory" for -d+all, but can't
 338 handle this here. It is fudged externally. */
 339
 340 #define D_all                        0xffffffff
 341
 342 #define D_any                        (D_all & \
 343                                        ~(D_v           | \
 344                                          D_pid         | \
 345                                          D_timestamp)  )
 346
 347 #define D_default                    (0xffffffff & \
 348                                        ~(D_expand      | \
 349                                          D_filter      | \
 350                                          D_interface   | \
 351                                          D_load        | \
 352                                          D_local_scan  | \
 353                                          D_memory      | \
 354                                          D_pid         | \
 355                                          D_timestamp   | \
 356                                          D_resolver))
 357
 358 /* Options bits for logging. Those that will end up in log_write_selector have
 359 values < 0x80000000. They can be used in calls to log_write(). The others have
 360 values > 0x80000000 and are put into log_extra_selector (without the top bit).
 361 These are only ever tested independently. "All" is a magic value that is used
 362 only in the name table to set all options in both bit maps. */
 363
 364 /* The L_all value must always have all bits set, as it is recognized specially
 365 by the function that decodes debug and log selectors. This is to enable it to
 366 set all the bits in a multi-word selector. */
 367
 368 #define L_all                          0xffffffff
 369
 370 #define L_address_rewrite              0x00000001
 371 #define L_all_parents                  0x00000002
 372 #define L_connection_reject            0x00000004
 373 #define L_delay_delivery               0x00000008
 374 #define L_dnslist_defer                0x00000010
 375 #define L_etrn                         0x00000020
 376 #define L_host_lookup_failed           0x00000040
 377 #define L_lost_incoming_connection     0x00000080
 378 #define L_queue_run                    0x00000100
 379 #define L_retry_defer                  0x00000200
 380 #define L_size_reject                  0x00000400
 381 #define L_skip_delivery                0x00000800
 382 #define L_smtp_connection              0x00001000
 383 #define L_smtp_incomplete_transaction  0x00002000
 384 #define L_smtp_protocol_error          0x00004000
 385 #define L_smtp_syntax_error            0x00008000
 386
 387 #define LX_acl_warn_skipped            0x80000001
 388 #define LX_arguments                   0x80000002
 389 #define LX_deliver_time                0x80000004
 390 #define LX_delivery_size               0x80000008
 391 #define LX_ident_timeout               0x80000010
 392 #define LX_incoming_interface          0x80000020
 393 #define LX_incoming_port               0x80000040
 394 #define LX_outgoing_port               0x80000080
 395 #define LX_pid                         0x80000100
 396 #define LX_queue_time                  0x80000200
 397 #define LX_queue_time_overall          0x80000400
 398 #define LX_received_sender             0x80000800
 399 #define LX_received_recipients         0x80001000
 400 #define LX_rejected_header             0x80002000
 401 #define LX_return_path_on_delivery     0x80004000
 402 #define LX_sender_on_delivery          0x80008000
 403 #define LX_sender_verify_fail          0x80010000
 404 #define LX_smtp_confirmation           0x80020000
 405 #define LX_smtp_no_mail                0x80040000
 406 #define LX_subject                     0x80080000
 407 #define LX_tls_certificate_verified    0x80100000
 408 #define LX_tls_cipher                  0x80200000
 409 #define LX_tls_peerdn                  0x80400000
 410 #define LX_tls_sni                     0x80800000
 411 #define LX_unknown_in_list             0x81000000
 412 #define LX_8bitmime                    0x82000000
 413
 414 #define L_default     (L_connection_reject        | \
 415                        L_delay_delivery           | \
 416                        L_dnslist_defer            | \
 417                        L_etrn                     | \
 418                        L_host_lookup_failed       | \
 419                        L_lost_incoming_connection | \
 420                        L_queue_run                | \
 421                        L_retry_defer              | \
 422                        L_size_reject              | \
 423                        L_skip_delivery)
 424
 425 #define LX_default   ((LX_acl_warn_skipped        | \
 426                        LX_rejected_header         | \
 427                        LX_sender_verify_fail      | \
 428                        LX_smtp_confirmation       | \
 429                        LX_tls_cipher) & 0x7fffffff)
 430
 431 /* Private error numbers for delivery failures, set negative so as not
 432 to conflict with system errno values. */
 433
 434 #define ERRNO_UNKNOWNERROR    (-1)
 435 #define ERRNO_USERSLASH       (-2)
 436 #define ERRNO_EXISTRACE       (-3)
 437 #define ERRNO_NOTREGULAR      (-4)
 438 #define ERRNO_NOTDIRECTORY    (-5)
 439 #define ERRNO_BADUGID         (-6)
 440 #define ERRNO_BADMODE         (-7)
 441 #define ERRNO_INODECHANGED    (-8)
 442 #define ERRNO_LOCKFAILED      (-9)
 443 #define ERRNO_BADADDRESS2    (-10)
 444 #define ERRNO_FORBIDPIPE     (-11)
 445 #define ERRNO_FORBIDFILE     (-12)
 446 #define ERRNO_FORBIDREPLY    (-13)
 447 #define ERRNO_MISSINGPIPE    (-14)
 448 #define ERRNO_MISSINGFILE    (-15)
 449 #define ERRNO_MISSINGREPLY   (-16)
 450 #define ERRNO_BADREDIRECT    (-17)
 451 #define ERRNO_SMTPCLOSED     (-18)
 452 #define ERRNO_SMTPFORMAT     (-19)
 453 #define ERRNO_SPOOLFORMAT    (-20)
 454 #define ERRNO_NOTABSOLUTE    (-21)
 455 #define ERRNO_EXIMQUOTA      (-22)   /* Exim-imposed quota */
 456 #define ERRNO_HELD           (-23)
 457 #define ERRNO_FILTER_FAIL    (-24)   /* Delivery filter process failure */
 458 #define ERRNO_CHHEADER_FAIL  (-25)   /* Delivery add/remove header failure */
 459 #define ERRNO_WRITEINCOMPLETE (-26)  /* Delivery write incomplete error */
 460 #define ERRNO_EXPANDFAIL     (-27)   /* Some expansion failed */
 461 #define ERRNO_GIDFAIL        (-28)   /* Failed to get gid */
 462 #define ERRNO_UIDFAIL        (-29)   /* Failed to get uid */
 463 #define ERRNO_BADTRANSPORT   (-30)   /* Unset or non-existent transport */
 464 #define ERRNO_MBXLENGTH      (-31)   /* MBX length mismatch */
 465 #define ERRNO_UNKNOWNHOST    (-32)   /* Lookup failed in smtp transport */
 466 #define ERRNO_FORMATUNKNOWN  (-33)   /* Can't match format in appendfile */
 467 #define ERRNO_BADCREATE      (-34)   /* Creation outside home in appendfile */
 468 #define ERRNO_LISTDEFER      (-35)   /* Can't check a list; lookup defer */
 469 #define ERRNO_DNSDEFER       (-36)   /* DNS lookup defer */
 470 #define ERRNO_TLSFAILURE     (-37)   /* Failed to start TLS session */
 471 #define ERRNO_TLSREQUIRED    (-38)   /* Mandatory TLS session not started */
 472 #define ERRNO_CHOWNFAIL      (-39)   /* Failed to chown a file */
 473 #define ERRNO_PIPEFAIL       (-40)   /* Failed to create a pipe */
 474 #define ERRNO_CALLOUTDEFER   (-41)   /* When verifying */
 475 #define ERRNO_AUTHFAIL       (-42)   /* When required by client */
 476 #define ERRNO_CONNECTTIMEOUT (-43)   /* Used internally in smtp transport */
 477 #define ERRNO_RCPT4XX        (-44)   /* RCPT gave 4xx error */
 478 #define ERRNO_MAIL4XX        (-45)   /* MAIL gave 4xx error */
 479 #define ERRNO_DATA4XX        (-46)   /* DATA gave 4xx error */
 480
 481 /* These must be last, so all retry deferments can easily be identified */
 482
 483 #define ERRNO_RETRY_BASE     (-51)   /* Base to test against */
 484 #define ERRNO_RRETRY         (-51)   /* Not time for routing */
 485 #define ERRNO_LRETRY         (-52)   /* Not time for local delivery */
 486 #define ERRNO_HRETRY         (-53)   /* Not time for any remote host */
 487 #define ERRNO_LOCAL_ONLY     (-54)   /* Local-only delivery */
 488 #define ERRNO_QUEUE_DOMAIN   (-55)   /* Domain in queue_domains */
 489
 490 /* Special actions to take after failure or deferment. */
 491
 492 enum {
 493   SPECIAL_NONE,             /* No special action */
 494   SPECIAL_FREEZE,           /* Freeze message */
 495   SPECIAL_FAIL,             /* Fail the delivery */
 496   SPECIAL_WARN              /* Send a warning message */
 497 };
 498
 499 /* Flags that get ORed into the more_errno field of an address to give more
 500 information about errors for retry purposes. They are greater than 256, because
 501 the bottom byte contains 'A' or 'M' for remote addresses, to indicate whether
 502 the name was looked up only via an address record or whether MX records were
 503 used, respectively. */
 504
 505 #define RTEF_CTOUT     0x0100      /* Connection timed out */
 506
 507 /* Permission and other options for parse_extract_addresses(),
 508 filter_interpret(), and rda_interpret(), i.e. what special things are allowed
 509 in redirection operations. Not all apply to all cases. Some of the bits allow
 510 and some forbid, reflecting the "allow" and "forbid" options in the redirect
 511 router, which were chosen to represent the standard situation for users'
 512 .forward files. */
 513
 514 #define RDO_BLACKHOLE    0x00000001  /* Forbid :blackhole: */
 515 #define RDO_DEFER        0x00000002  /* Allow :defer: or "defer" */
 516 #define RDO_EACCES       0x00000004  /* Ignore EACCES */
 517 #define RDO_ENOTDIR      0x00000008  /* Ignore ENOTDIR */
 518 #define RDO_EXISTS       0x00000010  /* Forbid "exists" in expansion in filter */
 519 #define RDO_FAIL         0x00000020  /* Allow :fail: or "fail" */
 520 #define RDO_FILTER       0x00000040  /* Allow a filter script */
 521 #define RDO_FREEZE       0x00000080  /* Allow "freeze" */
 522 #define RDO_INCLUDE      0x00000100  /* Forbid :include: */
 523 #define RDO_LOG          0x00000200  /* Forbid "log" */
 524 #define RDO_LOOKUP       0x00000400  /* Forbid "lookup" in expansion in filter */
 525 #define RDO_PERL         0x00000800  /* Forbid "perl" in expansion in filter */
 526 #define RDO_READFILE     0x00001000  /* Forbid "readfile" in exp in filter */
 527 #define RDO_READSOCK     0x00002000  /* Forbid "readsocket" in exp in filter */
 528 #define RDO_RUN          0x00004000  /* Forbid "run" in expansion in filter */
 529 #define RDO_DLFUNC       0x00008000  /* Forbid "dlfunc" in expansion in filter */
 530 #define RDO_REALLOG      0x00010000  /* Really do log (not testing/verifying) */
 531 #define RDO_REWRITE      0x00020000  /* Rewrite generated addresses */
 532 #define RDO_EXIM_FILTER  0x00040000  /* Forbid Exim filters */
 533 #define RDO_SIEVE_FILTER 0x00080000  /* Forbid Sieve filters */
 534 #define RDO_PREPEND_HOME 0x00100000  /* Prepend $home to relative paths in Exim filter save commands */
 535
 536 /* This is the set that apply to expansions in filters */
 537
 538 #define RDO_FILTER_EXPANSIONS \
 539   (RDO_EXISTS|RDO_LOOKUP|RDO_PERL|RDO_READFILE|RDO_READSOCK|RDO_RUN|RDO_DLFUNC)
 540
 541 /* As well as the RDO bits themselves, we need the bit numbers in order to
 542 access (most of) the individual bits as separate options. This could be
 543 automated, but I haven't bothered. Keep this list in step with the above! */
 544
 545 enum { RDON_BLACKHOLE, RDON_DEFER, RDON_EACCES, RDON_ENOTDIR, RDON_EXISTS,
 546   RDON_FAIL, RDON_FILTER, RDON_FREEZE, RDON_INCLUDE, RDON_LOG, RDON_LOOKUP,
 547   RDON_PERL, RDON_READFILE, RDON_READSOCK, RDON_RUN, RDON_DLFUNC, RDON_REALLOG,
 548   RDON_REWRITE, RDON_EXIM_FILTER, RDON_SIEVE_FILTER, RDON_PREPEND_HOME };
 549
 550 /* Results of filter or forward file processing. Some are only from a filter;
 551 some are only from a forward file. */
 552
 553 enum {
 554   FF_DELIVERED,         /* Success, took significant action */
 555   FF_NOTDELIVERED,      /* Success, didn't take significant action */
 556   FF_BLACKHOLE,         /* Blackholing requested */
 557   FF_DEFER,             /* Defer requested */
 558   FF_FAIL,              /* Fail requested */
 559   FF_INCLUDEFAIL,       /* :include: failed */
 560   FF_NONEXIST,          /* Forward file does not exist */
 561   FF_FREEZE,            /* Freeze requested */
 562   FF_ERROR              /* We have a problem */
 563 };
 564
 565 /* Values for identifying particular headers; printing characters are used, so
 566 they can be read in the spool file for those headers that are permanently
 567 marked. The lower case values don't get onto the spool; they are used only as
 568 return values from header_checkname(). */
 569
 570 #define htype_other         ' '   /* Unspecified header */
 571 #define htype_from          'F'
 572 #define htype_to            'T'
 573 #define htype_cc            'C'
 574 #define htype_bcc           'B'
 575 #define htype_id            'I'   /* for message-id */
 576 #define htype_reply_to      'R'
 577 #define htype_received      'P'   /* P for Postmark */
 578 #define htype_sender        'S'
 579 #define htype_old           '*'   /* Replaced header */
 580
 581 #define htype_date          'd'
 582 #define htype_return_path   'p'
 583 #define htype_delivery_date 'x'
 584 #define htype_envelope_to   'e'
 585 #define htype_subject       's'
 586
 587 /* These values are used only when adding new headers from an ACL; they too
 588 never get onto the spool. The type of the added header is set by reference
 589 to the header name, by calling header_checkname(). */
 590
 591 #define htype_add_top       'a'
 592 #define htype_add_rec       'r'
 593 #define htype_add_bot       'z'
 594 #define htype_add_rfc       'f'
 595
 596 /* Types of item in options lists. These are the bottom 8 bits of the "type"
 597 field, which is an int. The opt_void value is used for entries in tables that
 598 point to special types of value that are accessed only indirectly (e.g. the
 599 rewrite data that is built out of a string option.) We need to have some values
 600 visible in local_scan, so the following are declared there:
 601
 602   opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed, opt_time,
 603   opt_bool
 604
 605 To make sure we don't conflict, the local_scan.h values start from zero, and
 606 those defined here start from 32. The boolean ones must all be together so they
 607 can be easily tested as a group. That is the only use of opt_bool_last. */
 608
 609 enum { opt_bit = 32, opt_bool_verify, opt_bool_set, opt_expand_bool,
 610   opt_bool_last,
 611   opt_rewrite, opt_timelist, opt_uid, opt_gid, opt_uidlist, opt_gidlist,
 612   opt_expand_uid, opt_expand_gid, opt_void };
 613
 614 /* There's a high-ish bit which is used to flag duplicate options, kept
 615 for compatibility, which shouldn't be output. Also used for hidden options
 616 that are automatically maintained from others. Another high bit is used to
 617 flag driver options that although private (so as to be settable only on some
 618 drivers), are stored in the instance block so as to be accessible from outside.
 619 A third high bit is set when an option is read, so as to be able to give an
 620 error if any option is set twice. Finally, there's a bit which is set when an
 621 option is set with the "hide" prefix, to prevent -bP from showing it to
 622 non-admin callers. The next byte up in the int is used to keep the bit number
 623 for booleans that are kept in one bit. */
 624
 625 #define opt_hidden  0x100      /* Private to Exim */
 626 #define opt_public  0x200      /* Stored in the main instance block */
 627 #define opt_set     0x400      /* Option is set */
 628 #define opt_secure  0x800      /* "hide" prefix used */
 629 #define opt_rep_con 0x1000     /* Can be appended to by a repeated line (condition) */
 630 #define opt_rep_str 0x2000     /* Can be appended to by a repeated line (string) */
 631 #define opt_mask    0x00ff
 632
 633 /* Verify types when directing and routing */
 634
 635 enum { v_none, v_sender, v_recipient, v_expn };
 636
 637 /* Option flags for verify_address() */
 638
 639 #define vopt_fake_sender          0x0001   /* for verify=sender=<address> */
 640 #define vopt_is_recipient         0x0002
 641 #define vopt_qualify              0x0004
 642 #define vopt_expn                 0x0008
 643 #define vopt_callout_fullpm       0x0010   /* full postmaster during callout */
 644 #define vopt_callout_random       0x0020   /* during callout */
 645 #define vopt_callout_no_cache     0x0040   /* disable callout cache */
 646 #define vopt_callout_recipsender  0x0080   /* use real sender to verify recip */
 647 #define vopt_callout_recippmaster 0x0100   /* use postmaster to verify recip */
 648 #define vopt_success_on_redirect  0x0200
 649
 650 /* Values for fields in callout cache records */
 651
 652 #define ccache_unknown         0       /* test hasn't been done */
 653 #define ccache_accept          1
 654 #define ccache_reject          2       /* All rejections except */
 655 #define ccache_reject_mfnull   3       /* MAIL FROM:<> was rejected */
 656
 657 /* Options for lookup functions */
 658
 659 #define lookup_querystyle      1    /* query-style lookup */
 660 #define lookup_absfile         2    /* requires absolute file name */
 661 #define lookup_absfilequery    4    /* query-style starts with file name */
 662
 663 /* Status values for host_item blocks. Require hstatus_unusable and
 664 hstatus_unusable_expired to be last. */
 665
 666 enum { hstatus_unknown, hstatus_usable, hstatus_unusable,
 667        hstatus_unusable_expired };
 668
 669 /* Reasons why a host is unusable (for clearer log messages) */
 670
 671 enum { hwhy_unknown, hwhy_retry, hwhy_failed, hwhy_deferred, hwhy_ignored };
 672
 673 /* Domain lookup types for routers */
 674
 675 enum { lk_default, lk_byname, lk_bydns };
 676
 677 /* Values for the self_code fields */
 678
 679 enum { self_freeze, self_defer, self_send, self_reroute, self_pass, self_fail };
 680
 681 /* Flags for rewrite rules */
 682
 683 #define rewrite_sender       0x0001
 684 #define rewrite_from         0x0002
 685 #define rewrite_to           0x0004
 686 #define rewrite_cc           0x0008
 687 #define rewrite_bcc          0x0010
 688 #define rewrite_replyto      0x0020
 689 #define rewrite_all_headers  0x003F  /* all header flags */
 690
 691 #define rewrite_envfrom      0x0040
 692 #define rewrite_envto        0x0080
 693 #define rewrite_all_envelope 0x00C0  /* all envelope flags */
 694
 695 #define rewrite_all      (rewrite_all_headers | rewrite_all_envelope)
 696
 697 #define rewrite_smtp         0x0100  /* rewrite at SMTP time */
 698 #define rewrite_smtp_sender  0x0200  /* SMTP sender rewrite (allows <>) */
 699 #define rewrite_qualify      0x0400  /* qualify if necessary */
 700 #define rewrite_repeat       0x0800  /* repeat rewrite rule */
 701
 702 #define rewrite_whole        0x1000  /* option bit for headers */
 703 #define rewrite_quit         0x2000  /* "no more" option */
 704
 705 /* Flags for log_write(); LOG_MAIN, LOG_PANIC, and LOG_REJECT are also in
 706 local_scan.h */
 707
 708 #define LOG_MAIN           1      /* Write to the main log */
 709 #define LOG_PANIC          2      /* Write to the panic log */
 710 #define LOG_PANIC_DIE      6      /* Write to the panic log and then die */
 711 #define LOG_REJECT        16      /* Write to the reject log, with headers */
 712 #define LOG_SENDER        32      /* Add raw sender to the message */
 713 #define LOG_RECIPIENTS    64      /* Add raw recipients to the message */
 714 #define LOG_CONFIG       128      /* Add "Exim configuration error" */
 715 #define LOG_CONFIG_FOR  (256+128) /* Add " for" instead of ":\n" */
 716 #define LOG_CONFIG_IN   (512+128) /* Add " in line x[ of file y]" */
 717
 718 /* and for debug_bits() logging action control: */
 719 #define DEBUG_FROM_CONFIG       0x0001
 720
 721 /* SMTP command identifiers for the smtp_connection_had field that records the
 722 most recent SMTP commands. Must be kept in step with the list of names in
 723 smtp_in.c that is used for creating the smtp_no_mail logging action. SCH_NONE
 724 is "empty". */
 725
 726 enum { SCH_NONE, SCH_AUTH, SCH_DATA, SCH_EHLO, SCH_ETRN, SCH_EXPN, SCH_HELO,
 727        SCH_HELP, SCH_MAIL, SCH_NOOP, SCH_QUIT, SCH_RCPT, SCH_RSET, SCH_STARTTLS,
 728        SCH_VRFY };
 729
 730 /* Returns from host_find_by{name,dns}() */
 731
 732 enum {
 733   HOST_FIND_FAILED,     /* failed to find the host */
 734   HOST_FIND_AGAIN,      /* could not resolve at this time */
 735   HOST_FOUND,           /* found host */
 736   HOST_FOUND_LOCAL,     /* found, but MX points to local host */
 737   HOST_IGNORED          /* found but ignored - used internally only */
 738 };
 739
 740 /* Flags for host_find_bydns() */
 741
 742 #define HOST_FIND_BY_SRV          0x0001
 743 #define HOST_FIND_BY_MX           0x0002
 744 #define HOST_FIND_BY_A            0x0004
 745 #define HOST_FIND_QUALIFY_SINGLE  0x0008
 746 #define HOST_FIND_SEARCH_PARENTS  0x0010
 747
 748 /* Actions applied to specific messages. */
 749
 750 enum { MSG_DELIVER, MSG_FREEZE, MSG_REMOVE, MSG_THAW, MSG_ADD_RECIPIENT,
 751        MSG_MARK_ALL_DELIVERED, MSG_MARK_DELIVERED, MSG_EDIT_SENDER,
 752        MSG_SHOW_COPY, MSG_LOAD,
 753        /* These ones must be last: a test for >= MSG_SHOW_BODY is used
 754        to test for actions that list individual spool files. */
 755        MSG_SHOW_BODY, MSG_SHOW_HEADER, MSG_SHOW_LOG };
 756
 757 /* Returns from the spool_read_header() function */
 758
 759 enum {
 760   spool_read_OK,        /* success */
 761   spool_read_notopen,   /* open failed */
 762   spool_read_enverror,  /* error in the envelope */
 763   spool_read_hdrerror   /* error in the headers */
 764 };
 765
 766 /* Options for transport_write_message */
 767
 768 #define topt_add_return_path    0x001
 769 #define topt_add_delivery_date  0x002
 770 #define topt_add_envelope_to    0x004
 771 #define topt_use_crlf           0x008  /* Terminate lines with CRLF */
 772 #define topt_end_dot            0x010  /* Send terminting dot line */
 773 #define topt_no_headers         0x020  /* Omit headers */
 774 #define topt_no_body            0x040  /* Omit body */
 775 #define topt_escape_headers     0x080  /* Apply escape check to headers */
 776
 777 /* Codes for the host_find_failed and host_all_ignored options. */
 778
 779 #define hff_freeze   0
 780 #define hff_defer    1
 781 #define hff_pass     2
 782 #define hff_decline  3
 783 #define hff_fail     4
 784 #define hff_ignore   5
 785
 786 /* Router information flags */
 787
 788 #define ri_yestransport    0x0001    /* Must have a transport */
 789 #define ri_notransport     0x0002    /* Must not have a transport */
 790
 791 /* Codes for match types in match_check_list; to any of them, MCL_NOEXPAND may
 792 be added */
 793
 794 #define MCL_NOEXPAND  16
 795
 796 enum { MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, MCL_LOCALPART };
 797
 798 /* Codes for the places from which ACLs can be called. These are cunningly
 799 ordered to make it easy to implement tests for certain ACLs when processing
 800 "control" modifiers, by means of a maximum "where" value. Do not modify this
 801 order without checking carefully!
 802
 803 **** IMPORTANT***
 804 ****   Furthermore, remember to keep these in step with the tables
 805 ****   of names and response codes in globals.c.
 806 **** IMPORTANT ****
 807 */
 808
 809 enum { ACL_WHERE_RCPT,       /* Some controls are for RCPT only */
 810        ACL_WHERE_MAIL,       /* )                                           */
 811        ACL_WHERE_PREDATA,    /* ) There are several tests for "in message", */
 812        ACL_WHERE_MIME,       /* ) implemented by <= WHERE_NOTSMTP           */
 813        ACL_WHERE_DKIM,       /* )                                           */
 814        ACL_WHERE_DATA,       /* )                                           */
 815        ACL_WHERE_NOTSMTP,    /* )                                           */
 816
 817        ACL_WHERE_AUTH,       /* These remaining ones are not currently    */
 818        ACL_WHERE_CONNECT,    /* required to be in a special order so they */
 819        ACL_WHERE_ETRN,       /* are just alphabetical.                    */
 820        ACL_WHERE_EXPN,
 821        ACL_WHERE_HELO,
 822        ACL_WHERE_MAILAUTH,
 823        ACL_WHERE_NOTSMTP_START,
 824        ACL_WHERE_NOTQUIT,
 825        ACL_WHERE_QUIT,
 826        ACL_WHERE_STARTTLS,
 827        ACL_WHERE_VRFY,
 828
 829        ACL_WHERE_DELIVERY,
 830        ACL_WHERE_UNKNOWN     /* Currently used by a ${acl:name} expansion */
 831      };
 832
 833 /* Situations for spool_write_header() */
 834
 835 enum { SW_RECEIVING, SW_DELIVERING, SW_MODIFYING };
 836
 837 /* MX fields for hosts not obtained from MX records are always negative.
 838 MX_NONE is the default case; lesser values are used when the hosts are
 839 randomized in batches. */
 840
 841 #define MX_NONE           (-1)
 842
 843 /* host_item.port defaults to PORT_NONE; the only current case where this
 844 is changed before running the transport is when an dnslookup router sets an
 845 explicit port number. */
 846
 847 #define PORT_NONE     (-1)
 848
 849 /* Flags for single-key search defaults */
 850
 851 #define SEARCH_STAR       0x01
 852 #define SEARCH_STARAT     0x02
 853
 854 /* Filter types */
 855
 856 enum { FILTER_UNSET, FILTER_FORWARD, FILTER_EXIM, FILTER_SIEVE };
 857
 858 /* End of macros.h */