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