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