src/src/structs.h

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