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