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 } auth_info;
 437
 438
 439 /* Structure for holding a single IP address and port; used for the chain of
 440 addresses and ports for the local host. Make the char string large enough to
 441 hold an IPv6 address. */
 442
 443 typedef struct ip_address_item {
 444   struct ip_address_item *next;
 445   int    port;
 446   BOOL   v6_include_v4;            /* Used in the daemon */
 447   uschar address[46];
 448   uschar * log;                    /* portion of "listening on" log line */
 449 } ip_address_item;
 450
 451 /* Structure for chaining together arbitrary strings. */
 452
 453 typedef struct string_item {
 454   struct string_item *next;
 455   uschar *text;
 456 } string_item;
 457
 458 /* Information about a soft delivery failure, for use when calculating
 459 retry information. It's separate from the address block, because there
 460 can be a chain of them for SMTP deliveries where multiple IP addresses
 461 can be tried. */
 462
 463 typedef struct retry_item {
 464   struct retry_item *next;        /* for chaining */
 465   uschar *key;                    /* string identifying host/address/message */
 466   int     basic_errno;            /* error code for this destination */
 467   int     more_errno;             /* additional error information */
 468   uschar *message;                /* local error message */
 469   int     flags;                  /* see below */
 470 } retry_item;
 471
 472 /* Retry data flags */
 473
 474 #define rf_delete   0x0001        /* retry info is to be deleted */
 475 #define rf_host     0x0002        /* retry info is for a remote host */
 476 #define rf_message  0x0004        /* retry info is for a host+message */
 477
 478 /* Information about a constructed message that is to be sent using the
 479 autoreply transport. This is pointed to from the address block. */
 480
 481 typedef struct reply_item {
 482   uschar *from;                   /* ) */
 483   uschar *reply_to;               /* ) */
 484   uschar *to;                     /* ) */
 485   uschar *cc;                     /* ) specific header fields */
 486   uschar *bcc;                    /* ) */
 487   uschar *subject;                /* ) */
 488   uschar *headers;                /* misc other headers, concatenated */
 489   uschar *text;                   /* text string body */
 490   uschar *file;                   /* file body */
 491   BOOL    file_expand;            /* expand the body */
 492   int     expand_forbid;          /* expansion lockout flags */
 493   uschar *logfile;                /* file to keep a log in */
 494   uschar *oncelog;                /* file to keep records in for once only */
 495   time_t  once_repeat;            /* time to repeat "once only" */
 496   BOOL    return_message;         /* send back the original message */
 497 } reply_item;
 498
 499
 500 /* The address_item structure contains many fields which are used at various
 501 times while delivering a message. Some are used only for remote deliveries;
 502 some only for local. A particular set of fields is copied whenever a child
 503 address is created. For convenience, we keep those fields in a separate
 504 sub-structure so they can be copied in one go. This also means I won't forget
 505 to edit the various copying places when new to-be-copied fields are added. */
 506
 507 typedef struct address_item_propagated {
 508   uschar *address_data;           /* arbitrary data to keep with the address */
 509   uschar *domain_data;            /* from "domains" lookup */
 510   uschar *localpart_data;         /* from "local_parts" lookup */
 511   uschar *errors_address;         /* where to send errors (NULL => sender) */
 512   header_line *extra_headers;     /* additional headers */
 513   uschar *remove_headers;         /* list of those to remove */
 514   gstring *set;                   /* list of variables, with values */
 515
 516   #ifdef EXPERIMENTAL_SRS
 517   uschar *srs_sender;             /* Change return path when delivering */
 518   #endif
 519   BOOL    ignore_error:1;         /* ignore delivery error */
 520   #ifdef SUPPORT_I18N
 521   BOOL    utf8_msg:1;             /* requires SMTPUTF8 processing */
 522   BOOL    utf8_downcvt:1;         /* mandatory downconvert on delivery */
 523   BOOL    utf8_downcvt_maybe:1;   /* optional downconvert on delivery */
 524   #endif
 525 } address_item_propagated;
 526
 527
 528 /* The main address structure. Note that fields that are to be copied to
 529 generated addresses should be put in the address_item_propagated structure (see
 530 above) rather than directly into the address_item structure. */
 531
 532 typedef struct address_item {
 533   struct address_item *next;      /* for chaining addresses */
 534   struct address_item *parent;    /* parent address */
 535   struct address_item *first;     /* points to first after group delivery */
 536   struct address_item *dupof;     /* points to address this is a duplicate of */
 537
 538   router_instance *start_router;  /* generated address starts here */
 539   router_instance *router;        /* the router that routed */
 540   transport_instance *transport;  /* the transport to use */
 541
 542   host_item *host_list;           /* host data for the transport */
 543   host_item *host_used;           /* host that took delivery or failed hard */
 544   host_item *fallback_hosts;      /* to try if delivery defers */
 545
 546   reply_item *reply;              /* data for autoreply */
 547   retry_item *retries;            /* chain of retry information */
 548
 549   uschar *address;                /* address being delivered or routed */
 550   uschar *unique;                 /* used for disambiguating */
 551   uschar *cc_local_part;          /* caseful local part */
 552   uschar *lc_local_part;          /* lowercased local part */
 553   uschar *local_part;             /* points to cc or lc version */
 554   uschar *prefix;                 /* stripped prefix of local part */
 555   uschar *suffix;                 /* stripped suffix of local part */
 556   const uschar *domain;           /* working domain (lower cased) */
 557
 558   uschar *address_retry_key;      /* retry key including full address */
 559   uschar *domain_retry_key;       /* retry key for domain only */
 560
 561   uschar *current_dir;            /* current directory for transporting */
 562   uschar *home_dir;               /* home directory for transporting */
 563   uschar *message;                /* error message */
 564   uschar *user_message;           /* error message that can be sent over SMTP
 565                                      or quoted in bounce message */
 566   uschar *onetime_parent;         /* saved original parent for onetime */
 567   uschar **pipe_expandn;          /* numeric expansions for pipe from filter */
 568   uschar *return_filename;        /* name of return file */
 569   uschar *self_hostname;          /* after self=pass */
 570   uschar *shadow_message;         /* info about shadow transporting */
 571
 572 #ifndef DISABLE_TLS
 573   uschar *cipher;                 /* Cipher used for transport */
 574   void   *ourcert;                /* Certificate offered to peer, binary */
 575   void   *peercert;               /* Certificate from peer, binary */
 576   uschar *peerdn;                 /* DN of server's certificate */
 577   int    ocsp;                    /* OCSP status of peer cert */
 578 #endif
 579
 580 #ifdef EXPERIMENTAL_DSN_INFO
 581   const uschar *smtp_greeting;    /* peer self-identification */
 582   const uschar *helo_response;    /* peer message */
 583 #endif
 584
 585   uschar *authenticator;          /* auth driver name used by transport */
 586   uschar *auth_id;                /* auth "login" name used by transport */
 587   uschar *auth_sndr;              /* AUTH arg to SMTP MAIL, used by transport */
 588
 589   uschar *dsn_orcpt;              /* DSN orcpt value */
 590   int     dsn_flags;              /* DSN flags */
 591   int     dsn_aware;              /* DSN aware flag */
 592
 593   uid_t   uid;                    /* uid for transporting */
 594   gid_t   gid;                    /* gid for transporting */
 595
 596                                   /* flags */
 597   struct {
 598     BOOL af_allow_file:1;               /* allow file in generated address */
 599     BOOL af_allow_pipe:1;               /* allow pipe in generated address */
 600     BOOL af_allow_reply:1;              /* allow autoreply in generated address */
 601     BOOL af_dr_retry_exists:1;          /* router retry record exists */
 602     BOOL af_expand_pipe:1;              /* expand pipe arguments */
 603     BOOL af_file:1;                     /* file delivery; always with pfr */
 604     BOOL af_gid_set:1;                  /* gid field is set */
 605     BOOL af_home_expanded:1;            /* home_dir is already expanded */
 606     BOOL af_initgroups:1;               /* use initgroups() for local transporting */
 607     BOOL af_local_host_removed:1;       /* local host was backup */
 608     BOOL af_lt_retry_exists:1;          /* local transport retry exists */
 609     BOOL af_pfr:1;                      /* pipe or file or reply delivery */
 610     BOOL af_retry_skipped:1;            /* true if retry caused some skipping */
 611     BOOL af_retry_timedout:1;           /* true if retry timed out */
 612     BOOL af_uid_set:1;                  /* uid field is set */
 613     BOOL af_hide_child:1;               /* hide child in bounce/defer msgs */
 614     BOOL af_sverify_told:1;             /* sender verify failure notified */
 615     BOOL af_verify_pmfail:1;            /* verify failure was postmaster callout */
 616     BOOL af_verify_nsfail:1;            /* verify failure was null sender callout */
 617     BOOL af_homonym:1;                  /* an ancestor has same address */
 618     BOOL af_verify_routed:1;            /* for cached sender verify: routed OK */
 619     BOOL af_verify_callout:1;           /* for cached sender verify: callout was specified */
 620     BOOL af_include_affixes:1;          /* delivered with affixes in RCPT */
 621     BOOL af_cert_verified:1;            /* delivered with verified TLS cert */
 622     BOOL af_pass_message:1;             /* pass message in bounces */
 623     BOOL af_bad_reply:1;                /* filter could not generate autoreply */
 624     BOOL af_tcp_fastopen_conn:1;        /* delivery connection used TCP Fast Open */
 625     BOOL af_tcp_fastopen:1;             /* delivery usefully used TCP Fast Open */
 626     BOOL af_tcp_fastopen_data:1;        /* delivery sent SMTP commands on TCP Fast Open */
 627     BOOL af_pipelining:1;               /* delivery used (traditional) pipelining */
 628 #ifdef SUPPORT_PIPE_CONNECT
 629     BOOL af_early_pipe:1;               /* delivery used connect-time pipelining */
 630 #endif
 631 #ifndef DISABLE_PRDR
 632     BOOL af_prdr_used:1;                /* delivery used SMTP PRDR */
 633 #endif
 634     BOOL af_chunking_used:1;            /* delivery used SMTP CHUNKING */
 635     BOOL af_force_command:1;            /* force_command in pipe transport */
 636 #ifdef SUPPORT_DANE
 637     BOOL af_dane_verified:1;            /* TLS cert verify done with DANE */
 638 #endif
 639 #ifdef SUPPORT_I18N
 640     BOOL af_utf8_downcvt:1;             /* downconvert was done for delivery */
 641 #endif
 642 #ifdef EXPERIMENTAL_TLS_RESUME
 643     BOOL af_tls_resume:1;               /* TLS used a resumed session */
 644 #endif
 645   } flags;
 646
 647   unsigned int domain_cache[(MAX_NAMED_LIST * 2)/32];
 648   unsigned int localpart_cache[(MAX_NAMED_LIST * 2)/32];
 649   int     mode;                   /* mode for local transporting to a file */
 650   int     more_errno;             /* additional error information */
 651                                   /* (may need to hold a timestamp) */
 652   unsigned int delivery_usec;     /* subsecond part of delivery time */
 653
 654   short int basic_errno;          /* status after failure */
 655   unsigned short child_count;     /* number of child addresses */
 656   short int return_file;          /* fileno of return data file */
 657   short int special_action;       /* ( used when when deferred or failed */
 658                                   /* (  also  */
 659                                   /* ( contains = or - when successful SMTP delivered */
 660                                   /* (  also  */
 661                                   /* ( contains verify rc in sender verify cache */
 662   short int transport_return;     /* result of delivery attempt */
 663   address_item_propagated prop;   /* fields that are propagated to children */
 664 } address_item;
 665
 666 /* The table of header names consists of items of this type */
 667
 668 typedef struct {
 669   uschar *name;
 670   int     len;
 671   BOOL    allow_resent;
 672   int     htype;
 673 } header_name;
 674
 675 /* Chain of information about errors (e.g. bad addresses) */
 676
 677 typedef struct error_block {
 678   struct error_block *next;
 679   const uschar *text1;
 680   uschar *text2;
 681 } error_block;
 682
 683 /* Chain of file names when processing the queue */
 684
 685 typedef struct queue_filename {
 686   struct queue_filename *next;
 687   uschar dir_uschar;
 688   uschar text[1];
 689 } queue_filename;
 690
 691 /* Chain of items of retry information, read from the retry config. */
 692
 693 typedef struct retry_rule {
 694   struct retry_rule *next;
 695   int    rule;
 696   int    timeout;
 697   int    p1;
 698   int    p2;
 699 } retry_rule;
 700
 701 typedef struct retry_config {
 702   struct retry_config *next;
 703   uschar *pattern;
 704   int     basic_errno;
 705   int     more_errno;
 706   uschar *senders;
 707   retry_rule *rules;
 708 } retry_config;
 709
 710 /* Structure for each node in a tree, of which there are various kinds */
 711
 712 typedef struct tree_node {
 713   struct tree_node *left;         /* pointer to left child */
 714   struct tree_node *right;        /* pointer to right child */
 715   union
 716     {
 717     void  *ptr;                   /* pointer to data */
 718     int val;                      /* or integer data */
 719     } data;
 720   uschar  balance;                /* balancing factor */
 721   uschar  name[1];                /* node name - variable length */
 722 } tree_node;
 723
 724 /* Structure for holding time-limited data such as DNS returns.
 725 We use this rather than extending tree_node to avoid wasting
 726 space for most tree use (variables...) at the cost of complexity
 727 for the lookups cache */
 728
 729 typedef struct expiring_data {
 730   time_t expiry;                  /* if nonzero, data invalid after this time */
 731   void   *ptr;                    /* pointer to data */
 732 } expiring_data;
 733
 734 /* Structure for holding the handle and the cached last lookup for searches.
 735 This block is pointed to by the tree entry for the file. The file can get
 736 closed if too many are opened at once. There is a LRU chain for deciding which
 737 to close. */
 738
 739 typedef struct search_cache {
 740   void   *handle;                 /* lookup handle, or NULL if closed */
 741   int search_type;                /* search type */
 742   tree_node *up;                  /* LRU up pointer */
 743   tree_node *down;                /* LRU down pointer */
 744   tree_node *item_cache;          /* tree of cached results */
 745 } search_cache;
 746
 747 /* Structure for holding a partially decoded DNS record; the name has been
 748 uncompressed, but the data pointer is into the raw data. */
 749
 750 typedef struct {
 751   uschar        name[DNS_MAXNAME];      /* domain name */
 752   int           type;                   /* record type */
 753   unsigned short ttl;                   /* time-to-live, seconds */
 754   int           size;                   /* size of data */
 755   const uschar *data;                   /* pointer to data */
 756 } dns_record;
 757
 758 /* Structure for holding the result of a DNS query.  A touch over
 759 64k big, so take care to release as soon as possible. */
 760
 761 typedef struct {
 762   int     answerlen;              /* length of the answer */
 763   uschar  answer[NS_MAXMSG];      /* the answer itself */
 764 } dns_answer;
 765
 766 /* Structure for holding the intermediate data while scanning a DNS answer
 767 block. */
 768
 769 typedef struct {
 770   int            rrcount;         /* count of RRs in the answer */
 771   const uschar *aptr;             /* pointer in the answer while scanning */
 772   dns_record     srr;             /* data from current record in scan */
 773 } dns_scan;
 774
 775 /* Structure for holding a chain of IP addresses that are extracted from
 776 an A, AAAA, or A6 record. For the first two, there is only ever one address,
 777 but the chaining feature of A6 allows for several addresses to be realized from
 778 a single initial A6 record. The structure defines the address field of length
 779 1. In use, a suitable sized block is obtained to hold the complete textual
 780 address. */
 781
 782 typedef struct dns_address {
 783   struct dns_address *next;
 784   uschar  address[1];
 785 } dns_address;
 786
 787 /* Structure used for holding intermediate data during MD5 computations. */
 788
 789 typedef struct md5 {
 790   unsigned int length;
 791   unsigned int abcd[4];
 792   }
 793 md5;
 794
 795 /* Structure used for holding intermediate data during SHA-1 computations. */
 796
 797 typedef struct sha1 {
 798   unsigned int H[5];
 799   unsigned int length;
 800 } sha1;
 801
 802 /* Information for making an smtp connection */
 803 typedef struct {
 804   transport_instance *  tblock;
 805   void *                ob;     /* smtp_transport_options_block * */
 806   host_item *           host;
 807   int                   host_af;
 808   uschar *              interface;
 809
 810 #ifdef SUPPORT_DANE
 811   BOOL dane:1;                  /* connection must do dane */
 812   dns_answer            tlsa_dnsa;
 813 #endif
 814 } smtp_connect_args;
 815
 816 /* A client-initiated connection. If TLS, the second element is non-NULL */
 817 typedef struct {
 818   int   sock;
 819   void * tls_ctx;
 820 } client_conn_ctx;
 821
 822
 823 /* Structure used to hold incoming packets of SMTP responses for a specific
 824 socket. The packets which may contain multiple lines (and in some cases,
 825 multiple responses). */
 826
 827 typedef struct smtp_inblock {
 828   client_conn_ctx * cctx;         /* the connection */
 829   int     buffersize;             /* the size of the buffer */
 830   uschar *ptr;                    /* current position in the buffer */
 831   uschar *ptrend;                 /* end of data in the buffer */
 832   uschar *buffer;                 /* the buffer itself */
 833 } smtp_inblock;
 834
 835 /* Structure used to hold buffered outgoing packets of SMTP commands for a
 836 specific socket. The packets which may contain multiple lines when pipelining
 837 is in use. */
 838
 839 typedef struct smtp_outblock {
 840   client_conn_ctx * cctx;         /* the connection */
 841   int     cmd_count;              /* count of buffered commands */
 842   int     buffersize;             /* the size of the buffer */
 843   BOOL    authenticating;         /* TRUE when authenticating */
 844   uschar *ptr;                    /* current position in the buffer */
 845   uschar *buffer;                 /* the buffer itself */
 846
 847   smtp_connect_args * conn_args;  /* to make connection, if not yet made */
 848 } smtp_outblock;
 849
 850 /* Structure to hold information about the source of redirection information */
 851
 852 typedef struct redirect_block {
 853   uschar *string;                 /* file name or string */
 854   uid_t  *owners;                 /* allowed file owners */
 855   gid_t  *owngroups;              /* allowed file groups */
 856   struct passwd *pw;              /* possible owner if not NULL */
 857   int     modemask;               /* forbidden bits */
 858   BOOL    isfile;                 /* TRUE if string is a file name */
 859   BOOL    check_owner;            /* TRUE, FALSE, or TRUE_UNSET */
 860   BOOL    check_group;            /* TRUE, FALSE, or TRUE_UNSET */
 861 } redirect_block;
 862
 863 /* Structure for passing arguments to check_host() */
 864
 865 typedef struct check_host_block {
 866   const uschar *host_name;
 867   const uschar *host_address;
 868   const uschar *host_ipv4;
 869   BOOL   negative;
 870 } check_host_block;
 871
 872 /* Structure for remembering lookup data when caching the result of
 873 a lookup in a named list. */
 874
 875 typedef struct namedlist_cacheblock {
 876   struct namedlist_cacheblock *next;
 877   uschar *key;
 878   uschar *data;
 879 } namedlist_cacheblock;
 880
 881 /* Structure for holding data for an entry in a named list */
 882
 883 typedef struct namedlist_block {
 884   const uschar *string;              /* the list string */
 885   namedlist_cacheblock *cache_data;  /* cached domain_data or localpart_data */
 886   int number;                        /* the number of the list for caching */
 887 } namedlist_block;
 888
 889 /* Structures for Access Control Lists */
 890
 891 typedef struct acl_condition_block {
 892   struct acl_condition_block *  next;
 893   uschar *                      arg;
 894   int                           type;
 895   union {
 896     BOOL        negated;
 897     uschar *    varname;
 898   } u;
 899 } acl_condition_block;
 900
 901 typedef struct acl_block {
 902   struct acl_block *    next;
 903   acl_condition_block * condition;
 904   int                   verb;
 905   int                   srcline;
 906   const uschar *        srcfile;
 907 } acl_block;
 908
 909 /* smtp transport calc outbound_ip */
 910 typedef BOOL (*oicf) (uschar *message_id, void *data);
 911
 912 /* DKIM information for transport */
 913 struct ob_dkim {
 914   uschar *dkim_domain;
 915   uschar *dkim_identity;
 916   uschar *dkim_private_key;
 917   uschar *dkim_selector;
 918   uschar *dkim_canon;
 919   uschar *dkim_sign_headers;
 920   uschar *dkim_strict;
 921   uschar *dkim_hash;
 922   uschar *dkim_timestamps;
 923   BOOL    dot_stuffed;
 924   BOOL    force_bodyhash;
 925 #ifdef EXPERIMENTAL_ARC
 926   uschar *arc_signspec;
 927 #endif
 928 };
 929
 930 /* End of structs.h */