src/src/macros.h

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