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