src/src/structs.h

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