src/src/structs.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2015 */
   6 /* See the file NOTICE for conditions of use and distribution. */
   7
   8
   9 /* Definitions of various structures. In addition, those that are visible for
  10 the compilation of local_scan() are defined in local_scan.h. These are
  11
  12   header_line
  13   optionlist
  14   recipient_item
  15
  16 For those declared here, we have to pre-declare some because of mutually
  17 recursive definitions in the auths, routers, and transports blocks. */
  18
  19 struct address_item;
  20 struct auth_info;
  21 struct driver_info;
  22 struct director_info;
  23 struct smtp_inblock;
  24 struct smtp_outblock;
  25 struct transport_info;
  26 struct router_info;
  27
  28 /* Structure for remembering macros for the configuration file */
  29
  30 typedef struct macro_item {
  31   struct  macro_item *next;
  32   BOOL    command_line;
  33   uschar *replacement;
  34   uschar  name[1];
  35 } macro_item;
  36
  37 /* Structure for bit tables for debugging and logging */
  38
  39 typedef struct bit_table {
  40   uschar *name;
  41   int bit;
  42 } bit_table;
  43
  44 /* Block for holding a uid and gid, possibly unset, and an initgroups flag. */
  45
  46 typedef struct ugid_block {
  47   uid_t   uid;
  48   gid_t   gid;
  49   BOOL    uid_set;
  50   BOOL    gid_set;
  51   BOOL    initgroups;
  52 } ugid_block;
  53
  54 typedef enum {  CHUNKING_NOT_OFFERED = -1,
  55                 CHUNKING_OFFERED,
  56                 CHUNKING_ACTIVE,
  57                 CHUNKING_LAST} chunking_state_t;
  58
  59 /* Structure for holding information about a host for use mainly by routers,
  60 but also used when checking lists of hosts and when transporting. Looking up
  61 host addresses is done using this structure. */
  62
  63 typedef enum {DS_UNK=-1, DS_NO, DS_YES} dnssec_status_t;
  64
  65 typedef struct host_item {
  66   struct host_item *next;
  67   const uschar *name;             /* Host name */
  68   const uschar *address;          /* IP address in text form */
  69   int     port;                   /* port value in host order (if SRV lookup) */
  70   int     mx;                     /* MX value if found via MX records */
  71   int     sort_key;               /* MX*1000 plus random "fraction" */
  72   int     status;                 /* Usable, unusable, or unknown */
  73   int     why;                    /* Why host is unusable */
  74   int     last_try;               /* Time of last try if known */
  75   dnssec_status_t dnssec;
  76 } host_item;
  77
  78 /* Chain of rewrite rules, read from the rewrite config, or parsed from the
  79 rewrite_headers field of a transport. */
  80
  81 typedef struct rewrite_rule {
  82   struct rewrite_rule *next;
  83   int     flags;
  84   uschar *key;
  85   uschar *replacement;
  86 } rewrite_rule;
  87
  88 /* This structure is used to pass back configuration data from the smtp
  89 transport to the outside world. It is used during callback processing. If ever
  90 another remote transport were implemented, it could use the same structure. */
  91
  92 typedef struct transport_feedback {
  93   uschar *interface;
  94   uschar *port;
  95   uschar *protocol;
  96   uschar *hosts;
  97   uschar *helo_data;
  98   BOOL   hosts_override;
  99   BOOL   hosts_randomize;
 100   BOOL   gethostbyname;
 101   BOOL   qualify_single;
 102   BOOL   search_parents;
 103 } transport_feedback;
 104
 105 /* Routers, transports, and authenticators have similar data blocks. Each
 106 driver that is compiled into the code is represented by a xxx_info block; the
 107 active drivers are represented by a chain of xxx_instance blocks. To make it
 108 possible to use the same code for reading the configuration files for all
 109 three, the layout of the start of the blocks is kept the same, and represented
 110 by the generic structures driver_info and driver_instance. */
 111
 112 typedef struct driver_instance {
 113   struct driver_instance *next;
 114   uschar *name;                   /* Instance name */
 115   struct driver_info *info;       /* Points to info for this driver */
 116   void   *options_block;          /* Pointer to private options */
 117   uschar *driver_name;            /* All start with this generic option */
 118 } driver_instance;
 119
 120 typedef struct driver_info {
 121   uschar *driver_name;            /* Name of driver */
 122   optionlist *options;            /* Table of private options names */
 123   int    *options_count;          /* -> Number of entries in table */
 124   void   *options_block;          /* Points to default private block */
 125   int     options_len;            /* Length of same in bytes */
 126   void  (*init)(                  /* Initialization entry point */
 127     struct driver_instance *);
 128 } driver_info;
 129
 130
 131 /* Structure for holding information about the configured transports. Some
 132 of the generally accessible options are set from the configuration file; others
 133 are set by transport initialization, since they can only be set for certain
 134 transports. They need to be generally accessible, however, as they are used by
 135 the main transport code. */
 136
 137 typedef struct transport_instance {
 138   struct transport_instance *next;
 139   uschar *name;                   /* Instance name */
 140   struct transport_info *info;    /* Info for this driver */
 141   void *options_block;            /* Pointer to private options */
 142   uschar *driver_name;            /* Must be first */
 143   int   (*setup)(                 /* Setup entry point */
 144     struct transport_instance *,
 145     struct address_item *,
 146     struct transport_feedback *,  /* For passing back config data */
 147     uid_t,                        /* The uid that will be used */
 148     gid_t,                        /* The gid that will be used */
 149     uschar **);                   /* For an error message */
 150                                   /**************************************/
 151   int     batch_max;              /* )                                  */
 152   uschar *batch_id;               /* )                                  */
 153   uschar *home_dir;               /* ) Used only for local transports   */
 154   uschar *current_dir;            /* )                                  */
 155                                   /**************************************/
 156   uschar *expand_multi_domain;    /* )                                  */
 157   BOOL    multi_domain;           /* )                                  */
 158   BOOL    overrides_hosts;        /* ) Used only for remote transports  */
 159   int     max_addresses;          /* )                                  */
 160   int     connection_max_messages;/* )                                  */
 161                                   /**************************************/
 162   BOOL    deliver_as_creator;     /* Used only by pipe at present */
 163   BOOL    disable_logging;        /* For very weird requirements */
 164   BOOL    initgroups;             /* Initialize groups when setting uid */
 165   BOOL    uid_set;                /* uid is set */
 166   BOOL    gid_set;                /* gid is set */
 167   uid_t   uid;
 168   gid_t   gid;
 169   uschar *expand_uid;             /* Variable uid */
 170   uschar *expand_gid;             /* Variable gid */
 171   uschar *warn_message;           /* Used only by appendfile at present */
 172   uschar *shadow;                 /* Name of shadow transport */
 173   uschar *shadow_condition;       /* Condition for running it */
 174   uschar *filter_command;         /* For on-the-fly-filtering */
 175   uschar *add_headers;            /* Add these headers */
 176   uschar *remove_headers;         /* Remove these headers */
 177   uschar *return_path;            /* Overriding (rewriting) return path */
 178   uschar *debug_string;           /* Debugging output */
 179   uschar *max_parallel;           /* Number of concurrent instances */
 180   uschar *message_size_limit;     /* Biggest message this transport handles */
 181   uschar *headers_rewrite;        /* Rules for rewriting headers */
 182   rewrite_rule *rewrite_rules;    /* Parsed rewriting rules */
 183   int     rewrite_existflags;     /* Bits showing which headers are rewritten */
 184   int     filter_timeout;         /* For transport filter timing */
 185   BOOL    body_only;              /* Deliver only the body */
 186   BOOL    delivery_date_add;      /* Add Delivery-Date header */
 187   BOOL    envelope_to_add;        /* Add Envelope-To header */
 188   BOOL    headers_only;           /* Deliver only the headers */
 189   BOOL    rcpt_include_affixes;   /* TRUE to retain affixes in RCPT commands */
 190   BOOL    return_path_add;        /* Add Return-Path header */
 191   BOOL    return_output;          /* TRUE if output should always be returned */
 192   BOOL    return_fail_output;     /* ditto, but only on failure */
 193   BOOL    log_output;             /* Similarly for logging */
 194   BOOL    log_fail_output;
 195   BOOL    log_defer_output;
 196   BOOL    retry_use_local_part;   /* Defaults true for local, false for remote */
 197 #ifndef DISABLE_EVENT
 198   uschar  *event_action;          /* String to expand on notable events */
 199 #endif
 200 } transport_instance;
 201
 202
 203 /* Structure for holding information about a type of transport. The first six
 204 fields must match driver_info above. */
 205
 206 typedef struct transport_info {
 207   uschar *driver_name;            /* Driver name */
 208   optionlist *options;            /* Table of private options names */
 209   int    *options_count;          /* -> Number of entries in table */
 210   void   *options_block;          /* Points to default private block */
 211   int     options_len;            /* Length of same in bytes */
 212   void (*init)(                   /* Initialization function */
 213     struct transport_instance *);
 214 /****/
 215   BOOL (*code)(                   /* Main entry point */
 216     transport_instance *,
 217     struct address_item *);
 218   void (*tidyup)(                 /* Tidyup function */
 219     struct transport_instance *);
 220   void  (*closedown)(             /* For closing down a passed channel */
 221     struct transport_instance *);
 222   BOOL    local;                  /* TRUE for local transports */
 223 } transport_info;
 224
 225
 226 /* smtp transport datachunk callback */
 227
 228 #define tc_reap_prev    BIT(0)  /* Flags: reap previous SMTP cmd responses */
 229 #define tc_chunk_last   BIT(1)  /* annotate chunk SMTP cmd as LAST */
 230
 231 struct transport_context;
 232 typedef int (*tpt_chunk_cmd_cb)(int fd, struct transport_context * tctx,
 233                                 unsigned len, unsigned flags);
 234
 235 /* Structure for information about a delivery-in-progress */
 236
 237 typedef struct transport_context {
 238   transport_instance    * tblock;               /* transport */
 239   struct address_item   * addr;
 240   uschar                * check_string;         /* string replacement */
 241   uschar                * escape_string;
 242   int                     options;              /* output processing topt_* */
 243
 244   /* items below only used with option topt_use_bdat */
 245   tpt_chunk_cmd_cb        chunk_cb;             /* per-datachunk callback */
 246   struct smtp_inblock   * inblock;
 247   struct smtp_outblock  * outblock;
 248   host_item             * host;
 249   struct address_item   * first_addr;
 250   struct address_item   **sync_addr;
 251   BOOL                    pending_MAIL;
 252   BOOL                    pending_BDAT;
 253   BOOL                    good_RCPT;
 254   BOOL                  * completed_address;
 255   int                     cmd_count;
 256   uschar                * buffer;
 257 } transport_ctx;
 258
 259
 260
 261 typedef struct {
 262   uschar *request;
 263   uschar *require;
 264 } dnssec_domains;
 265
 266 /* Structure for holding information about the configured routers. */
 267
 268 typedef struct router_instance {
 269   struct router_instance *next;
 270   uschar *name;
 271   struct router_info *info;
 272   void   *options_block;          /* Pointer to private options */
 273   uschar *driver_name;            /* Must be first */
 274
 275   uschar *address_data;           /* Arbitrary data */
 276 #ifdef EXPERIMENTAL_BRIGHTMAIL
 277   uschar *bmi_rule;               /* Brightmail AntiSpam rule checking */
 278 #endif
 279   uschar *cannot_route_message;   /* Used when routing fails */
 280   uschar *condition;              /* General condition */
 281   uschar *current_directory;      /* For use during delivery */
 282   uschar *debug_string;           /* Debugging output */
 283   uschar *domains;                /* Specific domains */
 284   uschar *errors_to;              /* Errors address */
 285   uschar *expand_gid;             /* Expanded gid string */
 286   uschar *expand_uid;             /* Expanded uid string */
 287   uschar *expand_more;            /* Expanded more string */
 288   uschar *expand_unseen;          /* Expanded unseen string */
 289   uschar *extra_headers;          /* Additional headers */
 290   uschar *fallback_hosts;         /* For remote transports (text list) */
 291   uschar *home_directory;         /* For use during delivery */
 292   uschar *ignore_target_hosts;    /* Target hosts to ignore */
 293   uschar *local_parts;            /* Specific local parts */
 294   uschar *pass_router_name;       /* Router for passed address */
 295   uschar *prefix;                 /* Address prefix */
 296   uschar *redirect_router_name;   /* Router for generated address */
 297   uschar *remove_headers;         /* Removed headers */
 298   uschar *require_files;          /* File checks before router is run */
 299   uschar *router_home_directory;  /* For use while routing */
 300   uschar *self;                   /* Text option for handling self reference */
 301   uschar *senders;                /* Specific senders */
 302   uschar *suffix;                 /* Address suffix */
 303   uschar *translate_ip_address;   /* IP address translation fudgery */
 304   uschar *transport_name;         /* Transport name */
 305
 306   BOOL    address_test;           /* Use this router when testing addresses */
 307 #ifdef EXPERIMENTAL_BRIGHTMAIL
 308   BOOL    bmi_deliver_alternate;  /* TRUE => BMI said that message should be delivered to alternate location */
 309   BOOL    bmi_deliver_default;    /* TRUE => BMI said that message should be delivered to default location */
 310   BOOL    bmi_dont_deliver;       /* TRUE => BMI said that message should not be delivered at all */
 311 #endif
 312   BOOL    expn;                   /* Use this router when processing EXPN */
 313   BOOL    caseful_local_part;     /* TRUE => don't lowercase */
 314   BOOL    check_local_user;       /* TRUE => check local user */
 315   BOOL    disable_logging;        /* For very weird requirements */
 316   BOOL    fail_verify_recipient;  /* Fail verify if recipient match this router */
 317   BOOL    fail_verify_sender;     /* Fail verify if sender match this router */
 318   BOOL    gid_set;                /* Flag to indicate gid is set */
 319   BOOL    initgroups;             /* TRUE if initgroups is required */
 320   BOOL    log_as_local;           /* TRUE logs as a local delivery */
 321   BOOL    more;                   /* If FALSE, do no more if this one fails */
 322   BOOL    pass_on_timeout;        /* Treat timeout DEFERs as fails */
 323   BOOL    prefix_optional;        /* Just what it says */
 324   BOOL    repeat_use;             /* If FALSE, skip if ancestor used it */
 325   BOOL    retry_use_local_part;   /* Just what it says */
 326   BOOL    same_domain_copy_routing; /* TRUE => copy routing for same domain */
 327   BOOL    self_rewrite;           /* TRUE to rewrite headers if making local */
 328   BOOL    suffix_optional;        /* As it says */
 329   BOOL    verify_only;            /* Skip this router if not verifying */
 330   BOOL    verify_recipient;       /* Use this router when verifying a recipient*/
 331   BOOL    verify_sender;          /* Use this router when verifying a sender */
 332   BOOL    uid_set;                /* Flag to indicate uid is set */
 333   BOOL    unseen;                 /* If TRUE carry on, even after success */
 334   BOOL    dsn_lasthop;            /* If TRUE, this router is a DSN endpoint */
 335
 336   int     self_code;              /* Encoded version of "self" */
 337   uid_t   uid;                    /* Fixed uid value */
 338   gid_t   gid;                    /* Fixed gid value */
 339
 340   host_item *fallback_hostlist;   /* For remote transport (block chain) */
 341   transport_instance *transport;  /* Transport block (when found) */
 342   struct router_instance *pass_router; /* Actual router for passed address */
 343   struct router_instance *redirect_router; /* Actual router for generated address */
 344
 345   dnssec_domains dnssec;
 346 } router_instance;
 347
 348
 349 /* Structure for holding information about a type of router. The first six
 350 fields must match driver_info above. */
 351
 352 typedef struct router_info {
 353   uschar *driver_name;
 354   optionlist *options;            /* Table of private options names */
 355   int    *options_count;          /* -> Number of entries in table */
 356   void   *options_block;          /* Points to default private block */
 357   int     options_len;            /* Length of same in bytes */
 358   void (*init)(                   /* Initialization function */
 359     struct router_instance *);
 360 /****/
 361   int (*code)(                    /* Main entry point */
 362     router_instance *,
 363     struct address_item *,
 364     struct passwd *,
 365     int,
 366     struct address_item **,
 367     struct address_item **,
 368     struct address_item **,
 369     struct address_item **);
 370   void (*tidyup)(                 /* Tidyup function */
 371     struct router_instance *);
 372   int     ri_flags;               /* Descriptive flags */
 373 } router_info;
 374
 375
 376 /* Structure for holding information about a lookup type. */
 377
 378 #include "lookupapi.h"
 379
 380
 381 /* Structure for holding information about the configured authentication
 382 mechanisms */
 383
 384 typedef struct auth_instance {
 385   struct auth_instance *next;
 386   uschar *name;                   /* Exim instance name */
 387   struct auth_info *info;         /* Pointer to driver info block */
 388   void   *options_block;          /* Pointer to private options */
 389   uschar *driver_name;            /* Must be first */
 390   uschar *advertise_condition;    /* Are we going to advertise this?*/
 391   uschar *client_condition;       /* Should the client try this? */
 392   uschar *public_name;            /* Advertised name */
 393   uschar *set_id;                 /* String to set when server as authenticated id */
 394   uschar *set_client_id;          /* String to set when client as client_authenticated id */
 395   uschar *mail_auth_condition;    /* Condition for AUTH on MAIL command */
 396   uschar *server_debug_string;    /* Debugging output */
 397   uschar *server_condition;       /* Authorization condition */
 398   BOOL    client;                 /* TRUE if client option(s) set */
 399   BOOL    server;                 /* TRUE if server options(s) set */
 400   BOOL    advertised;             /* Set TRUE when advertised */
 401 } auth_instance;
 402
 403
 404 /* Structure for holding information about an authentication mechanism. The
 405 first six fields must match driver_info above. */
 406
 407 typedef struct auth_info {
 408   uschar *driver_name;            /* e.g. "condition" */
 409   optionlist *options;            /* Table of private options names */
 410   int    *options_count;          /* -> Number of entries in table */
 411   void   *options_block;          /* Points to default private block */
 412   int     options_len;            /* Length of same in bytes */
 413   void (*init)(                   /* initialization function */
 414     struct auth_instance *);
 415 /****/
 416   int (*servercode)(              /* server function */
 417     auth_instance *,              /* the instance data */
 418     uschar *);                    /* rest of AUTH command */
 419   int (*clientcode)(              /* client function */
 420     struct auth_instance *,
 421     struct smtp_inblock *,        /* socket and input buffer */
 422     struct smtp_outblock *,       /* socket and output buffer */
 423     int,                          /* command timeout */
 424     uschar *,                     /* buffer for reading response */
 425     int);                         /* sizeof buffer */
 426   void (*version_report)(         /* diagnostic version reporting */
 427     FILE *);                      /* I/O stream to print to */
 428 } auth_info;
 429
 430
 431 /* Structure for holding a single IP address and port; used for the chain of
 432 addresses and ports for the local host. Make the char string large enough to
 433 hold an IPv6 address. */
 434
 435 typedef struct ip_address_item {
 436   struct ip_address_item *next;
 437   int    port;
 438   BOOL   v6_include_v4;            /* Used in the daemon */
 439   uschar address[46];
 440 } ip_address_item;
 441
 442 /* Structure for chaining together arbitrary strings. */
 443
 444 typedef struct string_item {
 445   struct string_item *next;
 446   uschar *text;
 447 } string_item;
 448
 449 /* Information about a soft delivery failure, for use when calculating
 450 retry information. It's separate from the address block, because there
 451 can be a chain of them for SMTP deliveries where multiple IP addresses
 452 can be tried. */
 453
 454 typedef struct retry_item {
 455   struct retry_item *next;        /* for chaining */
 456   uschar *key;                    /* string identifying host/address/message */
 457   int     basic_errno;            /* error code for this destination */
 458   int     more_errno;             /* additional error information */
 459   uschar *message;                /* local error message */
 460   int     flags;                  /* see below */
 461 } retry_item;
 462
 463 /* Retry data flags */
 464
 465 #define rf_delete   0x0001        /* retry info is to be deleted */
 466 #define rf_host     0x0002        /* retry info is for a remote host */
 467 #define rf_message  0x0004        /* retry info is for a host+message */
 468
 469 /* Information about a constructed message that is to be sent using the
 470 autoreply transport. This is pointed to from the address block. */
 471
 472 typedef struct reply_item {
 473   uschar *from;                   /* ) */
 474   uschar *reply_to;               /* ) */
 475   uschar *to;                     /* ) */
 476   uschar *cc;                     /* ) specific header fields */
 477   uschar *bcc;                    /* ) */
 478   uschar *subject;                /* ) */
 479   uschar *headers;                /* misc other headers, concatenated */
 480   uschar *text;                   /* text string body */
 481   uschar *file;                   /* file body */
 482   BOOL    file_expand;            /* expand the body */
 483   int     expand_forbid;          /* expansion lockout flags */
 484   uschar *logfile;                /* file to keep a log in */
 485   uschar *oncelog;                /* file to keep records in for once only */
 486   time_t  once_repeat;            /* time to repeat "once only" */
 487   BOOL    return_message;         /* send back the original message */
 488 } reply_item;
 489
 490
 491 /* The address_item structure contains many fields which are used at various
 492 times while delivering a message. Some are used only for remote deliveries;
 493 some only for local. A particular set of fields is copied whenever a child
 494 address is created. For convenience, we keep those fields in a separate
 495 sub-structure so they can be copied in one go. This also means I won't forget
 496 to edit the various copying places when new to-be-copied fields are added. */
 497
 498 typedef struct address_item_propagated {
 499   uschar *address_data;           /* arbitrary data to keep with the address */
 500   uschar *domain_data;            /* from "domains" lookup */
 501   uschar *localpart_data;         /* from "local_parts" lookup */
 502   uschar *errors_address;         /* where to send errors (NULL => sender) */
 503   header_line *extra_headers;     /* additional headers */
 504   uschar *remove_headers;         /* list of those to remove */
 505
 506   #ifdef EXPERIMENTAL_SRS
 507   uschar *srs_sender;             /* Change return path when delivering */
 508   #endif
 509   #ifdef SUPPORT_I18N
 510   BOOL    utf8_msg:1;             /* requires SMTPUTF8 processing */
 511   BOOL    utf8_downcvt:1;         /* mandatory downconvert on delivery */
 512   BOOL    utf8_downcvt_maybe:1;   /* optional downconvert on delivery */
 513   #endif
 514 } address_item_propagated;
 515
 516 /* Bits for the flags field below */
 517
 518 #define af_allow_file          0x00000001 /* allow file in generated address */
 519 #define af_allow_pipe          0x00000002 /* allow pipe in generated address */
 520 #define af_allow_reply         0x00000004 /* allow autoreply in generated address */
 521 #define af_dr_retry_exists     0x00000008 /* router retry record exists */
 522 #define af_expand_pipe         0x00000010 /* expand pipe arguments */
 523 #define af_file                0x00000020 /* file delivery; always with pfr */
 524 #define af_gid_set             0x00000040 /* gid field is set */
 525 #define af_home_expanded       0x00000080 /* home_dir is already expanded */
 526 #define af_ignore_error        0x00000100 /* ignore delivery error */
 527 #define af_initgroups          0x00000200 /* use initgroups() for local transporting */
 528 #define af_local_host_removed  0x00000400 /* local host was backup */
 529 #define af_lt_retry_exists     0x00000800 /* local transport retry exists */
 530 #define af_pfr                 0x00001000 /* pipe or file or reply delivery */
 531 #define af_retry_skipped       0x00002000 /* true if retry caused some skipping */
 532 #define af_retry_timedout      0x00004000 /* true if retry timed out */
 533 #define af_uid_set             0x00008000 /* uid field is set */
 534 #define af_hide_child          0x00010000 /* hide child in bounce/defer msgs */
 535 #define af_sverify_told        0x00020000 /* sender verify failure notified */
 536 #define af_verify_pmfail       0x00040000 /* verify failure was postmaster callout */
 537 #define af_verify_nsfail       0x00080000 /* verify failure was null sender callout */
 538 #define af_homonym             0x00100000 /* an ancestor has same address */
 539 #define af_verify_routed       0x00200000 /* for cached sender verify: routed OK */
 540 #define af_verify_callout      0x00400000 /* for cached sender verify: callout was specified */
 541 #define af_include_affixes     0x00800000 /* delivered with affixes in RCPT */
 542 #define af_cert_verified       0x01000000 /* delivered with verified TLS cert */
 543 #define af_pass_message        0x02000000 /* pass message in bounces */
 544 #define af_bad_reply           0x04000000 /* filter could not generate autoreply */
 545 #ifndef DISABLE_PRDR
 546 # define af_prdr_used          0x08000000 /* delivery used SMTP PRDR */
 547 #endif
 548 #define af_chunking_used       0x10000000 /* delivery used SMTP CHUNKING */
 549 #define af_force_command       0x20000000 /* force_command in pipe transport */
 550 #ifdef EXPERIMENTAL_DANE
 551 # define af_dane_verified      0x40000000 /* TLS cert verify done with DANE */
 552 #endif
 553 #ifdef SUPPORT_I18N
 554 # define af_utf8_downcvt       0x80000000 /* downconvert was done for delivery */
 555 #endif
 556
 557 /* These flags must be propagated when a child is created */
 558
 559 #define af_propagate           (af_ignore_error)
 560
 561 /* The main address structure. Note that fields that are to be copied to
 562 generated addresses should be put in the address_item_propagated structure (see
 563 above) rather than directly into the address_item structure. */
 564
 565 typedef struct address_item {
 566   struct address_item *next;      /* for chaining addresses */
 567   struct address_item *parent;    /* parent address */
 568   struct address_item *first;     /* points to first after group delivery */
 569   struct address_item *dupof;     /* points to address this is a duplicate of */
 570
 571   router_instance *start_router;  /* generated address starts here */
 572   router_instance *router;        /* the router that routed */
 573   transport_instance *transport;  /* the transport to use */
 574
 575   host_item *host_list;           /* host data for the transport */
 576   host_item *host_used;           /* host that took delivery or failed hard */
 577   host_item *fallback_hosts;      /* to try if delivery defers */
 578
 579   reply_item *reply;              /* data for autoreply */
 580   retry_item *retries;            /* chain of retry information */
 581
 582   uschar *address;                /* address being delivered or routed */
 583   uschar *unique;                 /* used for disambiguating */
 584   uschar *cc_local_part;          /* caseful local part */
 585   uschar *lc_local_part;          /* lowercased local part */
 586   uschar *local_part;             /* points to cc or lc version */
 587   uschar *prefix;                 /* stripped prefix of local part */
 588   uschar *suffix;                 /* stripped suffix of local part */
 589   const uschar *domain;           /* working domain (lower cased) */
 590
 591   uschar *address_retry_key;      /* retry key including full address */
 592   uschar *domain_retry_key;       /* retry key for domain only */
 593
 594   uschar *current_dir;            /* current directory for transporting */
 595   uschar *home_dir;               /* home directory for transporting */
 596   uschar *message;                /* error message */
 597   uschar *user_message;           /* error message that can be sent over SMTP
 598                                      or quoted in bounce message */
 599   uschar *onetime_parent;         /* saved original parent for onetime */
 600   uschar **pipe_expandn;          /* numeric expansions for pipe from filter */
 601   uschar *return_filename;        /* name of return file */
 602   uschar *self_hostname;          /* after self=pass */
 603   uschar *shadow_message;         /* info about shadow transporting */
 604
 605 #ifdef SUPPORT_TLS
 606   uschar *cipher;                 /* Cipher used for transport */
 607   void   *ourcert;                /* Certificate offered to peer, binary */
 608   void   *peercert;               /* Certificate from peer, binary */
 609   uschar *peerdn;                 /* DN of server's certificate */
 610   int    ocsp;                    /* OCSP status of peer cert */
 611 #endif
 612
 613 #ifdef EXPERIMENTAL_DSN_INFO
 614   const uschar *smtp_greeting;    /* peer self-identification */
 615   const uschar *helo_response;    /* peer message */
 616 #endif
 617
 618   uschar *authenticator;          /* auth driver name used by transport */
 619   uschar *auth_id;                /* auth "login" name used by transport */
 620   uschar *auth_sndr;              /* AUTH arg to SMTP MAIL, used by transport */
 621
 622   uschar *dsn_orcpt;              /* DSN orcpt value */
 623   int     dsn_flags;              /* DSN flags */
 624   int     dsn_aware;              /* DSN aware flag */
 625
 626   uid_t   uid;                    /* uid for transporting */
 627   gid_t   gid;                    /* gid for transporting */
 628
 629   unsigned int flags;             /* a row of bits, defined above */
 630   unsigned int domain_cache[(MAX_NAMED_LIST * 2)/32];
 631   unsigned int localpart_cache[(MAX_NAMED_LIST * 2)/32];
 632   int     mode;                   /* mode for local transporting to a file */
 633   int     more_errno;             /* additional error information */
 634                                   /* (may need to hold a timestamp) */
 635
 636   short int basic_errno;          /* status after failure */
 637   short int child_count;          /* number of child addresses */
 638   short int return_file;          /* fileno of return data file */
 639   short int special_action;       /* ( used when when deferred or failed */
 640                                   /* (  also  */
 641                                   /* ( contains = or - when successful SMTP delivered */
 642                                   /* (  also  */
 643                                   /* ( contains verify rc in sender verify cache */
 644   short int transport_return;     /* result of delivery attempt */
 645   address_item_propagated prop;   /* fields that are propagated to children */
 646 } address_item;
 647
 648 /* The table of header names consists of items of this type */
 649
 650 typedef struct {
 651   uschar *name;
 652   int     len;
 653   BOOL    allow_resent;
 654   int     htype;
 655 } header_name;
 656
 657 /* Chain of information about errors (e.g. bad addresses) */
 658
 659 typedef struct error_block {
 660   struct error_block *next;
 661   const uschar *text1;
 662   uschar *text2;
 663 } error_block;
 664
 665 /* Chain of file names when processing the queue */
 666
 667 typedef struct queue_filename {
 668   struct queue_filename *next;
 669   uschar dir_uschar;
 670   uschar text[1];
 671 } queue_filename;
 672
 673 /* Chain of items of retry information, read from the retry config. */
 674
 675 typedef struct retry_rule {
 676   struct retry_rule *next;
 677   int    rule;
 678   int    timeout;
 679   int    p1;
 680   int    p2;
 681 } retry_rule;
 682
 683 typedef struct retry_config {
 684   struct retry_config *next;
 685   uschar *pattern;
 686   int     basic_errno;
 687   int     more_errno;
 688   uschar *senders;
 689   retry_rule *rules;
 690 } retry_config;
 691
 692 /* Structure for each node in a tree, of which there are various kinds */
 693
 694 typedef struct tree_node {
 695   struct tree_node *left;         /* pointer to left child */
 696   struct tree_node *right;        /* pointer to right child */
 697   union
 698     {
 699     void  *ptr;                   /* pointer to data */
 700     int val;                      /* or integer data */
 701     } data;
 702   uschar  balance;                /* balancing factor */
 703   uschar  name[1];                /* node name - variable length */
 704 } tree_node;
 705
 706 /* Structure for holding time-limited data such as DNS returns.
 707 We use this rather than extending tree_node to avoid wasting
 708 space for most tree use (variables...) at the cost of complexity
 709 for the lookups cache */
 710
 711 typedef struct expiring_data {
 712   time_t expiry;                  /* if nonzero, data invalid after this time */
 713   void   *ptr;                    /* pointer to data */
 714 } expiring_data;
 715
 716 /* Structure for holding the handle and the cached last lookup for searches.
 717 This block is pointed to by the tree entry for the file. The file can get
 718 closed if too many are opened at once. There is a LRU chain for deciding which
 719 to close. */
 720
 721 typedef struct search_cache {
 722   void   *handle;                 /* lookup handle, or NULL if closed */
 723   int search_type;                /* search type */
 724   tree_node *up;                  /* LRU up pointer */
 725   tree_node *down;                /* LRU down pointer */
 726   tree_node *item_cache;          /* tree of cached results */
 727 } search_cache;
 728
 729 /* Structure for holding a partially decoded DNS record; the name has been
 730 uncompressed, but the data pointer is into the raw data. */
 731
 732 typedef struct {
 733   uschar  name[DNS_MAXNAME];      /* domain name */
 734   int     type;                   /* record type */
 735   unsigned short ttl;             /* time-to-live, seconds */
 736   int     size;                   /* size of data */
 737   uschar *data;                   /* pointer to data */
 738 } dns_record;
 739
 740 /* Structure for holding the result of a DNS query. */
 741
 742 typedef struct {
 743   int     answerlen;              /* length of the answer */
 744   uschar  answer[MAXPACKET];      /* the answer itself */
 745 } dns_answer;
 746
 747 /* Structure for holding the intermediate data while scanning a DNS answer
 748 block. */
 749
 750 typedef struct {
 751   int     rrcount;                /* count of RRs in the answer */
 752   uschar *aptr;                   /* pointer in the answer while scanning */
 753   dns_record srr;                 /* data from current record in scan */
 754 } dns_scan;
 755
 756 /* Structure for holding a chain of IP addresses that are extracted from
 757 an A, AAAA, or A6 record. For the first two, there is only ever one address,
 758 but the chaining feature of A6 allows for several addresses to be realized from
 759 a single initial A6 record. The structure defines the address field of length
 760 1. In use, a suitable sized block is obtained to hold the complete textual
 761 address. */
 762
 763 typedef struct dns_address {
 764   struct dns_address *next;
 765   uschar  address[1];
 766 } dns_address;
 767
 768 /* Structure used for holding intermediate data during MD5 computations. */
 769
 770 typedef struct md5 {
 771   unsigned int length;
 772   unsigned int abcd[4];
 773   }
 774 md5;
 775
 776 /* Structure used for holding intermediate data during SHA-1 computations. */
 777
 778 typedef struct sha1 {
 779   unsigned int H[5];
 780   unsigned int length;
 781   }
 782 sha1;
 783
 784 /* Structure used to hold incoming packets of SMTP responses for a specific
 785 socket. The packets which may contain multiple lines (and in some cases,
 786 multiple responses). */
 787
 788 typedef struct smtp_inblock {
 789   int     sock;                   /* the socket */
 790   int     buffersize;             /* the size of the buffer */
 791   uschar *ptr;                    /* current position in the buffer */
 792   uschar *ptrend;                 /* end of data in the buffer */
 793   uschar *buffer;                 /* the buffer itself */
 794 } smtp_inblock;
 795
 796 /* Structure used to hold buffered outgoing packets of SMTP commands for a
 797 specific socket. The packets which may contain multiple lines when pipelining
 798 is in use. */
 799
 800 typedef struct smtp_outblock {
 801   int     sock;                   /* the socket */
 802   int     cmd_count;              /* count of buffered commands */
 803   int     buffersize;             /* the size of the buffer */
 804   BOOL    authenticating;         /* TRUE when authenticating */
 805   uschar *ptr;                    /* current position in the buffer */
 806   uschar *buffer;                 /* the buffer itself */
 807 } smtp_outblock;
 808
 809 /* Structure to hold information about the source of redirection information */
 810
 811 typedef struct redirect_block {
 812   uschar *string;                 /* file name or string */
 813   uid_t  *owners;                 /* allowed file owners */
 814   gid_t  *owngroups;              /* allowed file groups */
 815   struct passwd *pw;              /* possible owner if not NULL */
 816   int     modemask;               /* forbidden bits */
 817   BOOL    isfile;                 /* TRUE if string is a file name */
 818   BOOL    check_owner;            /* TRUE, FALSE, or TRUE_UNSET */
 819   BOOL    check_group;            /* TRUE, FALSE, or TRUE_UNSET */
 820 } redirect_block;
 821
 822 /* Structure for passing arguments to check_host() */
 823
 824 typedef struct check_host_block {
 825   const uschar *host_name;
 826   const uschar *host_address;
 827   const uschar *host_ipv4;
 828   BOOL   negative;
 829 } check_host_block;
 830
 831 /* Structure for remembering lookup data when caching the result of
 832 a lookup in a named list. */
 833
 834 typedef struct namedlist_cacheblock {
 835   struct namedlist_cacheblock *next;
 836   uschar *key;
 837   uschar *data;
 838 } namedlist_cacheblock;
 839
 840 /* Structure for holding data for an entry in a named list */
 841
 842 typedef struct namedlist_block {
 843   const uschar *string;              /* the list string */
 844   namedlist_cacheblock *cache_data;  /* cached domain_data or localpart_data */
 845   int number;                        /* the number of the list for caching */
 846 } namedlist_block;
 847
 848 /* Structures for Access Control Lists */
 849
 850 typedef struct acl_condition_block {
 851   struct acl_condition_block *next;
 852   uschar *arg;
 853   int type;
 854   union {
 855     BOOL negated;
 856     uschar *varname;
 857   } u;
 858 } acl_condition_block;
 859
 860 typedef struct acl_block {
 861   struct acl_block *next;
 862   acl_condition_block *condition;
 863   int verb;
 864 } acl_block;
 865
 866 /* smtp transport calc outbound_ip */
 867 typedef BOOL (*oicf) (uschar *message_id, void *data);
 868
 869 /* DKIM information for transport */
 870 struct ob_dkim {
 871   uschar *dkim_domain;
 872   uschar *dkim_private_key;
 873   uschar *dkim_selector;
 874   uschar *dkim_canon;
 875   uschar *dkim_sign_headers;
 876   uschar *dkim_strict;
 877   BOOL    dot_stuffed;
 878 };
 879
 880 /* End of structs.h */