src/src/structs.h

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