src/src/structs.h

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