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