src/src/structs.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2015 */
   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 /* Structure for remembering macros for the configuration file */
  29
  30 typedef struct macro_item {
  31   struct  macro_item *next;
  32   BOOL    command_line;
  33   uschar *replacement;
  34   uschar  name[1];
  35 } macro_item;
  36
  37 /* Structure for bit tables for debugging and logging */
  38
  39 typedef struct bit_table {
  40   uschar *name;
  41   int bit;
  42 } bit_table;
  43
  44 /* Block for holding a uid and gid, possibly unset, and an initgroups flag. */
  45
  46 typedef struct ugid_block {
  47   uid_t   uid;
  48   gid_t   gid;
  49   BOOL    uid_set;
  50   BOOL    gid_set;
  51   BOOL    initgroups;
  52 } ugid_block;
  53
  54 typedef enum {  CHUNKING_NOT_OFFERED = -1,
  55                 CHUNKING_OFFERED,
  56                 CHUNKING_ACTIVE,
  57                 CHUNKING_LAST} chunking_state_t;
  58
  59 /* Structure for holding information about a host for use mainly by routers,
  60 but also used when checking lists of hosts and when transporting. Looking up
  61 host addresses is done using this structure. */
  62
  63 typedef enum {DS_UNK=-1, DS_NO, DS_YES} dnssec_status_t;
  64
  65 typedef struct host_item {
  66   struct host_item *next;
  67   const uschar *name;             /* Host name */
  68   const uschar *address;          /* IP address in text form */
  69   int     port;                   /* port value in host order (if SRV lookup) */
  70   int     mx;                     /* MX value if found via MX records */
  71   int     sort_key;               /* MX*1000 plus random "fraction" */
  72   int     status;                 /* Usable, unusable, or unknown */
  73   int     why;                    /* Why host is unusable */
  74   int     last_try;               /* Time of last try if known */
  75   dnssec_status_t dnssec;
  76 } host_item;
  77
  78 /* Chain of rewrite rules, read from the rewrite config, or parsed from the
  79 rewrite_headers field of a transport. */
  80
  81 typedef struct rewrite_rule {
  82   struct rewrite_rule *next;
  83   int     flags;
  84   uschar *key;
  85   uschar *replacement;
  86 } rewrite_rule;
  87
  88 /* This structure is used to pass back configuration data from the smtp
  89 transport to the outside world. It is used during callback processing. If ever
  90 another remote transport were implemented, it could use the same structure. */
  91
  92 typedef struct transport_feedback {
  93   uschar *interface;
  94   uschar *port;
  95   uschar *protocol;
  96   uschar *hosts;
  97   uschar *helo_data;
  98   BOOL   hosts_override;
  99   BOOL   hosts_randomize;
 100   BOOL   gethostbyname;
 101   BOOL   qualify_single;
 102   BOOL   search_parents;
 103 } transport_feedback;
 104
 105 /* Routers, transports, and authenticators have similar data blocks. Each
 106 driver that is compiled into the code is represented by a xxx_info block; the
 107 active drivers are represented by a chain of xxx_instance blocks. To make it
 108 possible to use the same code for reading the configuration files for all
 109 three, the layout of the start of the blocks is kept the same, and represented
 110 by the generic structures driver_info and driver_instance. */
 111
 112 typedef struct driver_instance {
 113   struct driver_instance *next;
 114   uschar *name;                   /* Instance name */
 115   struct driver_info *info;       /* Points to info for this driver */
 116   void   *options_block;          /* Pointer to private options */
 117   uschar *driver_name;            /* All start with this generic option */
 118 } driver_instance;
 119
 120 typedef struct driver_info {
 121   uschar *driver_name;            /* Name of driver */
 122   optionlist *options;            /* Table of private options names */
 123   int    *options_count;          /* -> Number of entries in table */
 124   void   *options_block;          /* Points to default private block */
 125   int     options_len;            /* Length of same in bytes */
 126   void  (*init)(                  /* Initialization entry point */
 127     struct driver_instance *);
 128 } driver_info;
 129
 130
 131 /* Structure for holding information about the configured transports. Some
 132 of the generally accessible options are set from the configuration file; others
 133 are set by transport initialization, since they can only be set for certain
 134 transports. They need to be generally accessible, however, as they are used by
 135 the main transport code. */
 136
 137 typedef struct transport_instance {
 138   struct transport_instance *next;
 139   uschar *name;                   /* Instance name */
 140   struct transport_info *info;    /* Info for this driver */
 141   void *options_block;            /* Pointer to private options */
 142   uschar *driver_name;            /* Must be first */
 143   int   (*setup)(                 /* Setup entry point */
 144     struct transport_instance *,
 145     struct address_item *,
 146     struct transport_feedback *,  /* For passing back config data */
 147     uid_t,                        /* The uid that will be used */
 148     gid_t,                        /* The gid that will be used */
 149     uschar **);                   /* For an error message */
 150                                   /**************************************/
 151   int     batch_max;              /* )                                  */
 152   uschar *batch_id;               /* )                                  */
 153   uschar *home_dir;               /* ) Used only for local transports   */
 154   uschar *current_dir;            /* )                                  */
 155                                   /**************************************/
 156   uschar *expand_multi_domain;    /* )                                  */
 157   BOOL    multi_domain;           /* )                                  */
 158   BOOL    overrides_hosts;        /* ) Used only for remote transports  */
 159   int     max_addresses;          /* )                                  */
 160   int     connection_max_messages;/* )                                  */
 161                                   /**************************************/
 162   BOOL    deliver_as_creator;     /* Used only by pipe at present */
 163   BOOL    disable_logging;        /* For very weird requirements */
 164   BOOL    initgroups;             /* Initialize groups when setting uid */
 165   BOOL    uid_set;                /* uid is set */
 166   BOOL    gid_set;                /* gid is set */
 167   uid_t   uid;
 168   gid_t   gid;
 169   uschar *expand_uid;             /* Variable uid */
 170   uschar *expand_gid;             /* Variable gid */
 171   uschar *warn_message;           /* Used only by appendfile at present */
 172   uschar *shadow;                 /* Name of shadow transport */
 173   uschar *shadow_condition;       /* Condition for running it */
 174   uschar *filter_command;         /* For on-the-fly-filtering */
 175   uschar *add_headers;            /* Add these headers */
 176   uschar *remove_headers;         /* Remove these headers */
 177   uschar *return_path;            /* Overriding (rewriting) return path */
 178   uschar *debug_string;           /* Debugging output */
 179   uschar *max_parallel;           /* Number of concurrent instances */
 180   uschar *message_size_limit;     /* Biggest message this transport handles */
 181   uschar *headers_rewrite;        /* Rules for rewriting headers */
 182   rewrite_rule *rewrite_rules;    /* Parsed rewriting rules */
 183   int     rewrite_existflags;     /* Bits showing which headers are rewritten */
 184   int     filter_timeout;         /* For transport filter timing */
 185   BOOL    body_only;              /* Deliver only the body */
 186   BOOL    delivery_date_add;      /* Add Delivery-Date header */
 187   BOOL    envelope_to_add;        /* Add Envelope-To header */
 188   BOOL    headers_only;           /* Deliver only the headers */
 189   BOOL    rcpt_include_affixes;   /* TRUE to retain affixes in RCPT commands */
 190   BOOL    return_path_add;        /* Add Return-Path header */
 191   BOOL    return_output;          /* TRUE if output should always be returned */
 192   BOOL    return_fail_output;     /* ditto, but only on failure */
 193   BOOL    log_output;             /* Similarly for logging */
 194   BOOL    log_fail_output;
 195   BOOL    log_defer_output;
 196   BOOL    retry_use_local_part;   /* Defaults true for local, false for remote */
 197 #ifndef DISABLE_EVENT
 198   uschar  *event_action;          /* String to expand on notable events */
 199 #endif
 200 } transport_instance;
 201
 202
 203 /* Structure for holding information about a type of transport. The first six
 204 fields must match driver_info above. */
 205
 206 typedef struct transport_info {
 207   uschar *driver_name;            /* Driver name */
 208   optionlist *options;            /* Table of private options names */
 209   int    *options_count;          /* -> Number of entries in table */
 210   void   *options_block;          /* Points to default private block */
 211   int     options_len;            /* Length of same in bytes */
 212   void (*init)(                   /* Initialization function */
 213     struct transport_instance *);
 214 /****/
 215   BOOL (*code)(                   /* Main entry point */
 216     transport_instance *,
 217     struct address_item *);
 218   void (*tidyup)(                 /* Tidyup function */
 219     struct transport_instance *);
 220   void  (*closedown)(             /* For closing down a passed channel */
 221     struct transport_instance *);
 222   BOOL    local;                  /* TRUE for local transports */
 223 } transport_info;
 224
 225
 226
 227 typedef struct {
 228   uschar *request;
 229   uschar *require;
 230 } dnssec_domains;
 231
 232 /* Structure for holding information about the configured routers. */
 233
 234 typedef struct router_instance {
 235   struct router_instance *next;
 236   uschar *name;
 237   struct router_info *info;
 238   void   *options_block;          /* Pointer to private options */
 239   uschar *driver_name;            /* Must be first */
 240
 241   uschar *address_data;           /* Arbitrary data */
 242 #ifdef EXPERIMENTAL_BRIGHTMAIL
 243   uschar *bmi_rule;               /* Brightmail AntiSpam rule checking */
 244 #endif
 245   uschar *cannot_route_message;   /* Used when routing fails */
 246   uschar *condition;              /* General condition */
 247   uschar *current_directory;      /* For use during delivery */
 248   uschar *debug_string;           /* Debugging output */
 249   uschar *domains;                /* Specific domains */
 250   uschar *errors_to;              /* Errors address */
 251   uschar *expand_gid;             /* Expanded gid string */
 252   uschar *expand_uid;             /* Expanded uid string */
 253   uschar *expand_more;            /* Expanded more string */
 254   uschar *expand_unseen;          /* Expanded unseen string */
 255   uschar *extra_headers;          /* Additional headers */
 256   uschar *fallback_hosts;         /* For remote transports (text list) */
 257   uschar *home_directory;         /* For use during delivery */
 258   uschar *ignore_target_hosts;    /* Target hosts to ignore */
 259   uschar *local_parts;            /* Specific local parts */
 260   uschar *pass_router_name;       /* Router for passed address */
 261   uschar *prefix;                 /* Address prefix */
 262   uschar *redirect_router_name;   /* Router for generated address */
 263   uschar *remove_headers;         /* Removed headers */
 264   uschar *require_files;          /* File checks before router is run */
 265   uschar *router_home_directory;  /* For use while routing */
 266   uschar *self;                   /* Text option for handling self reference */
 267   uschar *senders;                /* Specific senders */
 268   uschar *suffix;                 /* Address suffix */
 269   uschar *translate_ip_address;   /* IP address translation fudgery */
 270   uschar *transport_name;         /* Transport name */
 271
 272   BOOL    address_test;           /* Use this router when testing addresses */
 273 #ifdef EXPERIMENTAL_BRIGHTMAIL
 274   BOOL    bmi_deliver_alternate;  /* TRUE => BMI said that message should be delivered to alternate location */
 275   BOOL    bmi_deliver_default;    /* TRUE => BMI said that message should be delivered to default location */
 276   BOOL    bmi_dont_deliver;       /* TRUE => BMI said that message should not be delivered at all */
 277 #endif
 278   BOOL    expn;                   /* Use this router when processing EXPN */
 279   BOOL    caseful_local_part;     /* TRUE => don't lowercase */
 280   BOOL    check_local_user;       /* TRUE => check local user */
 281   BOOL    disable_logging;        /* For very weird requirements */
 282   BOOL    fail_verify_recipient;  /* Fail verify if recipient match this router */
 283   BOOL    fail_verify_sender;     /* Fail verify if sender match this router */
 284   BOOL    gid_set;                /* Flag to indicate gid is set */
 285   BOOL    initgroups;             /* TRUE if initgroups is required */
 286   BOOL    log_as_local;           /* TRUE logs as a local delivery */
 287   BOOL    more;                   /* If FALSE, do no more if this one fails */
 288   BOOL    pass_on_timeout;        /* Treat timeout DEFERs as fails */
 289   BOOL    prefix_optional;        /* Just what it says */
 290   BOOL    repeat_use;             /* If FALSE, skip if ancestor used it */
 291   BOOL    retry_use_local_part;   /* Just what it says */
 292   BOOL    same_domain_copy_routing; /* TRUE => copy routing for same domain */
 293   BOOL    self_rewrite;           /* TRUE to rewrite headers if making local */
 294   BOOL    suffix_optional;        /* As it says */
 295   BOOL    verify_only;            /* Skip this router if not verifying */
 296   BOOL    verify_recipient;       /* Use this router when verifying a recipient*/
 297   BOOL    verify_sender;          /* Use this router when verifying a sender */
 298   BOOL    uid_set;                /* Flag to indicate uid is set */
 299   BOOL    unseen;                 /* If TRUE carry on, even after success */
 300   BOOL    dsn_lasthop;            /* If TRUE, this router is a DSN endpoint */
 301
 302   int     self_code;              /* Encoded version of "self" */
 303   uid_t   uid;                    /* Fixed uid value */
 304   gid_t   gid;                    /* Fixed gid value */
 305
 306   host_item *fallback_hostlist;   /* For remote transport (block chain) */
 307   transport_instance *transport;  /* Transport block (when found) */
 308   struct router_instance *pass_router; /* Actual router for passed address */
 309   struct router_instance *redirect_router; /* Actual router for generated address */
 310
 311   dnssec_domains dnssec;
 312 } router_instance;
 313
 314
 315 /* Structure for holding information about a type of router. The first six
 316 fields must match driver_info above. */
 317
 318 typedef struct router_info {
 319   uschar *driver_name;
 320   optionlist *options;            /* Table of private options names */
 321   int    *options_count;          /* -> Number of entries in table */
 322   void   *options_block;          /* Points to default private block */
 323   int     options_len;            /* Length of same in bytes */
 324   void (*init)(                   /* Initialization function */
 325     struct router_instance *);
 326 /****/
 327   int (*code)(                    /* Main entry point */
 328     router_instance *,
 329     struct address_item *,
 330     struct passwd *,
 331     int,
 332     struct address_item **,
 333     struct address_item **,
 334     struct address_item **,
 335     struct address_item **);
 336   void (*tidyup)(                 /* Tidyup function */
 337     struct router_instance *);
 338   int     ri_flags;               /* Descriptive flags */
 339 } router_info;
 340
 341
 342 /* Structure for holding information about a lookup type. */
 343
 344 #include "lookupapi.h"
 345
 346
 347 /* Structure for holding information about the configured authentication
 348 mechanisms */
 349
 350 typedef struct auth_instance {
 351   struct auth_instance *next;
 352   uschar *name;                   /* Exim instance name */
 353   struct auth_info *info;         /* Pointer to driver info block */
 354   void   *options_block;          /* Pointer to private options */
 355   uschar *driver_name;            /* Must be first */
 356   uschar *advertise_condition;    /* Are we going to advertise this?*/
 357   uschar *client_condition;       /* Should the client try this? */
 358   uschar *public_name;            /* Advertised name */
 359   uschar *set_id;                 /* String to set when server as authenticated id */
 360   uschar *set_client_id;          /* String to set when client as client_authenticated id */
 361   uschar *mail_auth_condition;    /* Condition for AUTH on MAIL command */
 362   uschar *server_debug_string;    /* Debugging output */
 363   uschar *server_condition;       /* Authorization condition */
 364   BOOL    client;                 /* TRUE if client option(s) set */
 365   BOOL    server;                 /* TRUE if server options(s) set */
 366   BOOL    advertised;             /* Set TRUE when advertised */
 367 } auth_instance;
 368
 369
 370 /* Structure for holding information about an authentication mechanism. The
 371 first six fields must match driver_info above. */
 372
 373 typedef struct auth_info {
 374   uschar *driver_name;            /* e.g. "condition" */
 375   optionlist *options;            /* Table of private options names */
 376   int    *options_count;          /* -> Number of entries in table */
 377   void   *options_block;          /* Points to default private block */
 378   int     options_len;            /* Length of same in bytes */
 379   void (*init)(                   /* initialization function */
 380     struct auth_instance *);
 381 /****/
 382   int (*servercode)(              /* server function */
 383     auth_instance *,              /* the instance data */
 384     uschar *);                    /* rest of AUTH command */
 385   int (*clientcode)(              /* client function */
 386     struct auth_instance *,
 387     struct smtp_inblock *,        /* socket and input buffer */
 388     struct smtp_outblock *,       /* socket and output buffer */
 389     int,                          /* command timeout */
 390     uschar *,                     /* buffer for reading response */
 391     int);                         /* sizeof buffer */
 392   void (*version_report)(         /* diagnostic version reporting */
 393     FILE *);                      /* I/O stream to print to */
 394 } auth_info;
 395
 396
 397 /* Structure for holding a single IP address and port; used for the chain of
 398 addresses and ports for the local host. Make the char string large enough to
 399 hold an IPv6 address. */
 400
 401 typedef struct ip_address_item {
 402   struct ip_address_item *next;
 403   int    port;
 404   BOOL   v6_include_v4;            /* Used in the daemon */
 405   uschar address[46];
 406 } ip_address_item;
 407
 408 /* Structure for chaining together arbitrary strings. */
 409
 410 typedef struct string_item {
 411   struct string_item *next;
 412   uschar *text;
 413 } string_item;
 414
 415 /* Information about a soft delivery failure, for use when calculating
 416 retry information. It's separate from the address block, because there
 417 can be a chain of them for SMTP deliveries where multiple IP addresses
 418 can be tried. */
 419
 420 typedef struct retry_item {
 421   struct retry_item *next;        /* for chaining */
 422   uschar *key;                    /* string identifying host/address/message */
 423   int     basic_errno;            /* error code for this destination */
 424   int     more_errno;             /* additional error information */
 425   uschar *message;                /* local error message */
 426   int     flags;                  /* see below */
 427 } retry_item;
 428
 429 /* Retry data flags */
 430
 431 #define rf_delete   0x0001        /* retry info is to be deleted */
 432 #define rf_host     0x0002        /* retry info is for a remote host */
 433 #define rf_message  0x0004        /* retry info is for a host+message */
 434
 435 /* Information about a constructed message that is to be sent using the
 436 autoreply transport. This is pointed to from the address block. */
 437
 438 typedef struct reply_item {
 439   uschar *from;                   /* ) */
 440   uschar *reply_to;               /* ) */
 441   uschar *to;                     /* ) */
 442   uschar *cc;                     /* ) specific header fields */
 443   uschar *bcc;                    /* ) */
 444   uschar *subject;                /* ) */
 445   uschar *headers;                /* misc other headers, concatenated */
 446   uschar *text;                   /* text string body */
 447   uschar *file;                   /* file body */
 448   BOOL    file_expand;            /* expand the body */
 449   int     expand_forbid;          /* expansion lockout flags */
 450   uschar *logfile;                /* file to keep a log in */
 451   uschar *oncelog;                /* file to keep records in for once only */
 452   time_t  once_repeat;            /* time to repeat "once only" */
 453   BOOL    return_message;         /* send back the original message */
 454 } reply_item;
 455
 456
 457 /* The address_item structure contains many fields which are used at various
 458 times while delivering a message. Some are used only for remote deliveries;
 459 some only for local. A particular set of fields is copied whenever a child
 460 address is created. For convenience, we keep those fields in a separate
 461 sub-structure so they can be copied in one go. This also means I won't forget
 462 to edit the various copying places when new to-be-copied fields are added. */
 463
 464 typedef struct address_item_propagated {
 465   uschar *address_data;           /* arbitrary data to keep with the address */
 466   uschar *domain_data;            /* from "domains" lookup */
 467   uschar *localpart_data;         /* from "local_parts" lookup */
 468   uschar *errors_address;         /* where to send errors (NULL => sender) */
 469   header_line *extra_headers;     /* additional headers */
 470   uschar *remove_headers;         /* list of those to remove */
 471
 472   #ifdef EXPERIMENTAL_SRS
 473   uschar *srs_sender;             /* Change return path when delivering */
 474   #endif
 475   #ifdef SUPPORT_I18N
 476   BOOL    utf8_msg:1;             /* requires SMTPUTF8 processing */
 477   BOOL    utf8_downcvt:1;         /* mandatory downconvert on delivery */
 478   BOOL    utf8_downcvt_maybe:1;   /* optional downconvert on delivery */
 479   #endif
 480 } address_item_propagated;
 481
 482 /* Bits for the flags field below */
 483
 484 #define af_allow_file          0x00000001 /* allow file in generated address */
 485 #define af_allow_pipe          0x00000002 /* allow pipe in generated address */
 486 #define af_allow_reply         0x00000004 /* allow autoreply in generated address */
 487 #define af_dr_retry_exists     0x00000008 /* router retry record exists */
 488 #define af_expand_pipe         0x00000010 /* expand pipe arguments */
 489 #define af_file                0x00000020 /* file delivery; always with pfr */
 490 #define af_gid_set             0x00000040 /* gid field is set */
 491 #define af_home_expanded       0x00000080 /* home_dir is already expanded */
 492 #define af_ignore_error        0x00000100 /* ignore delivery error */
 493 #define af_initgroups          0x00000200 /* use initgroups() for local transporting */
 494 #define af_local_host_removed  0x00000400 /* local host was backup */
 495 #define af_lt_retry_exists     0x00000800 /* local transport retry exists */
 496 #define af_pfr                 0x00001000 /* pipe or file or reply delivery */
 497 #define af_retry_skipped       0x00002000 /* true if retry caused some skipping */
 498 #define af_retry_timedout      0x00004000 /* true if retry timed out */
 499 #define af_uid_set             0x00008000 /* uid field is set */
 500 #define af_hide_child          0x00010000 /* hide child in bounce/defer msgs */
 501 #define af_sverify_told        0x00020000 /* sender verify failure notified */
 502 #define af_verify_pmfail       0x00040000 /* verify failure was postmaster callout */
 503 #define af_verify_nsfail       0x00080000 /* verify failure was null sender callout */
 504 #define af_homonym             0x00100000 /* an ancestor has same address */
 505 #define af_verify_routed       0x00200000 /* for cached sender verify: routed OK */
 506 #define af_verify_callout      0x00400000 /* for cached sender verify: callout was specified */
 507 #define af_include_affixes     0x00800000 /* delivered with affixes in RCPT */
 508 #define af_cert_verified       0x01000000 /* delivered with verified TLS cert */
 509 #define af_pass_message        0x02000000 /* pass message in bounces */
 510 #define af_bad_reply           0x04000000 /* filter could not generate autoreply */
 511 #ifndef DISABLE_PRDR
 512 # define af_prdr_used          0x08000000 /* delivery used SMTP PRDR */
 513 #endif
 514 #define af_force_command       0x10000000 /* force_command in pipe transport */
 515 #ifdef EXPERIMENTAL_DANE
 516 # define af_dane_verified      0x20000000 /* TLS cert verify done with DANE */
 517 #endif
 518 #ifdef SUPPORT_I18N
 519 # define af_utf8_downcvt       0x40000000 /* downconvert was done for delivery */
 520 #endif
 521
 522 /* These flags must be propagated when a child is created */
 523
 524 #define af_propagate           (af_ignore_error)
 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   unsigned int flags;             /* a row of bits, defined above */
 595   unsigned int domain_cache[(MAX_NAMED_LIST * 2)/32];
 596   unsigned int localpart_cache[(MAX_NAMED_LIST * 2)/32];
 597   int     mode;                   /* mode for local transporting to a file */
 598   int     more_errno;             /* additional error information */
 599                                   /* (may need to hold a timestamp) */
 600
 601   short int basic_errno;          /* status after failure */
 602   short int child_count;          /* number of child addresses */
 603   short int return_file;          /* fileno of return data file */
 604   short int special_action;       /* ( used when when deferred or failed */
 605                                   /* (  also  */
 606                                   /* ( contains = or - when successful SMTP delivered */
 607                                   /* (  also  */
 608                                   /* ( contains verify rc in sender verify cache */
 609   short int transport_return;     /* result of delivery attempt */
 610   address_item_propagated prop;   /* fields that are propagated to children */
 611 } address_item;
 612
 613 /* The table of header names consists of items of this type */
 614
 615 typedef struct {
 616   uschar *name;
 617   int     len;
 618   BOOL    allow_resent;
 619   int     htype;
 620 } header_name;
 621
 622 /* Chain of information about errors (e.g. bad addresses) */
 623
 624 typedef struct error_block {
 625   struct error_block *next;
 626   const uschar *text1;
 627   uschar *text2;
 628 } error_block;
 629
 630 /* Chain of file names when processing the queue */
 631
 632 typedef struct queue_filename {
 633   struct queue_filename *next;
 634   uschar dir_uschar;
 635   uschar text[1];
 636 } queue_filename;
 637
 638 /* Chain of items of retry information, read from the retry config. */
 639
 640 typedef struct retry_rule {
 641   struct retry_rule *next;
 642   int    rule;
 643   int    timeout;
 644   int    p1;
 645   int    p2;
 646 } retry_rule;
 647
 648 typedef struct retry_config {
 649   struct retry_config *next;
 650   uschar *pattern;
 651   int     basic_errno;
 652   int     more_errno;
 653   uschar *senders;
 654   retry_rule *rules;
 655 } retry_config;
 656
 657 /* Structure for each node in a tree, of which there are various kinds */
 658
 659 typedef struct tree_node {
 660   struct tree_node *left;         /* pointer to left child */
 661   struct tree_node *right;        /* pointer to right child */
 662   union
 663     {
 664     void  *ptr;                   /* pointer to data */
 665     int val;                      /* or integer data */
 666     } data;
 667   uschar  balance;                /* balancing factor */
 668   uschar  name[1];                /* node name - variable length */
 669 } tree_node;
 670
 671 /* Structure for holding time-limited data such as DNS returns.
 672 We use this rather than extending tree_node to avoid wasting
 673 space for most tree use (variables...) at the cost of complexity
 674 for the lookups cache */
 675
 676 typedef struct expiring_data {
 677   time_t expiry;                  /* if nonzero, data invalid after this time */
 678   void   *ptr;                    /* pointer to data */
 679 } expiring_data;
 680
 681 /* Structure for holding the handle and the cached last lookup for searches.
 682 This block is pointed to by the tree entry for the file. The file can get
 683 closed if too many are opened at once. There is a LRU chain for deciding which
 684 to close. */
 685
 686 typedef struct search_cache {
 687   void   *handle;                 /* lookup handle, or NULL if closed */
 688   int search_type;                /* search type */
 689   tree_node *up;                  /* LRU up pointer */
 690   tree_node *down;                /* LRU down pointer */
 691   tree_node *item_cache;          /* tree of cached results */
 692 } search_cache;
 693
 694 /* Structure for holding a partially decoded DNS record; the name has been
 695 uncompressed, but the data pointer is into the raw data. */
 696
 697 typedef struct {
 698   uschar  name[DNS_MAXNAME];      /* domain name */
 699   int     type;                   /* record type */
 700   unsigned short ttl;             /* time-to-live, seconds */
 701   int     size;                   /* size of data */
 702   uschar *data;                   /* pointer to data */
 703 } dns_record;
 704
 705 /* Structure for holding the result of a DNS query. */
 706
 707 typedef struct {
 708   int     answerlen;              /* length of the answer */
 709   uschar  answer[MAXPACKET];      /* the answer itself */
 710 } dns_answer;
 711
 712 /* Structure for holding the intermediate data while scanning a DNS answer
 713 block. */
 714
 715 typedef struct {
 716   int     rrcount;                /* count of RRs in the answer */
 717   uschar *aptr;                   /* pointer in the answer while scanning */
 718   dns_record srr;                 /* data from current record in scan */
 719 } dns_scan;
 720
 721 /* Structure for holding a chain of IP addresses that are extracted from
 722 an A, AAAA, or A6 record. For the first two, there is only ever one address,
 723 but the chaining feature of A6 allows for several addresses to be realized from
 724 a single initial A6 record. The structure defines the address field of length
 725 1. In use, a suitable sized block is obtained to hold the complete textual
 726 address. */
 727
 728 typedef struct dns_address {
 729   struct dns_address *next;
 730   uschar  address[1];
 731 } dns_address;
 732
 733 /* Structure used for holding intermediate data during MD5 computations. */
 734
 735 typedef struct md5 {
 736   unsigned int length;
 737   unsigned int abcd[4];
 738   }
 739 md5;
 740
 741 /* Structure used for holding intermediate data during SHA-1 computations. */
 742
 743 typedef struct sha1 {
 744   unsigned int H[5];
 745   unsigned int length;
 746   }
 747 sha1;
 748
 749 /* Structure used to hold incoming packets of SMTP responses for a specific
 750 socket. The packets which may contain multiple lines (and in some cases,
 751 multiple responses). */
 752
 753 typedef struct smtp_inblock {
 754   int     sock;                   /* the socket */
 755   int     buffersize;             /* the size of the buffer */
 756   uschar *ptr;                    /* current position in the buffer */
 757   uschar *ptrend;                 /* end of data in the buffer */
 758   uschar *buffer;                 /* the buffer itself */
 759 } smtp_inblock;
 760
 761 /* Structure used to hold buffered outgoing packets of SMTP commands for a
 762 specific socket. The packets which may contain multiple lines when pipelining
 763 is in use. */
 764
 765 typedef struct smtp_outblock {
 766   int     sock;                   /* the socket */
 767   int     cmd_count;              /* count of buffered commands */
 768   int     buffersize;             /* the size of the buffer */
 769   BOOL    authenticating;         /* TRUE when authenticating */
 770   uschar *ptr;                    /* current position in the buffer */
 771   uschar *buffer;                 /* the buffer itself */
 772 } smtp_outblock;
 773
 774 /* Structure to hold information about the source of redirection information */
 775
 776 typedef struct redirect_block {
 777   uschar *string;                 /* file name or string */
 778   uid_t  *owners;                 /* allowed file owners */
 779   gid_t  *owngroups;              /* allowed file groups */
 780   struct passwd *pw;              /* possible owner if not NULL */
 781   int     modemask;               /* forbidden bits */
 782   BOOL    isfile;                 /* TRUE if string is a file name */
 783   BOOL    check_owner;            /* TRUE, FALSE, or TRUE_UNSET */
 784   BOOL    check_group;            /* TRUE, FALSE, or TRUE_UNSET */
 785 } redirect_block;
 786
 787 /* Structure for passing arguments to check_host() */
 788
 789 typedef struct check_host_block {
 790   const uschar *host_name;
 791   const uschar *host_address;
 792   const uschar *host_ipv4;
 793   BOOL   negative;
 794 } check_host_block;
 795
 796 /* Structure for remembering lookup data when caching the result of
 797 a lookup in a named list. */
 798
 799 typedef struct namedlist_cacheblock {
 800   struct namedlist_cacheblock *next;
 801   uschar *key;
 802   uschar *data;
 803 } namedlist_cacheblock;
 804
 805 /* Structure for holding data for an entry in a named list */
 806
 807 typedef struct namedlist_block {
 808   const uschar *string;              /* the list string */
 809   namedlist_cacheblock *cache_data;  /* cached domain_data or localpart_data */
 810   int number;                        /* the number of the list for caching */
 811 } namedlist_block;
 812
 813 /* Structures for Access Control Lists */
 814
 815 typedef struct acl_condition_block {
 816   struct acl_condition_block *next;
 817   uschar *arg;
 818   int type;
 819   union {
 820     BOOL negated;
 821     uschar *varname;
 822   } u;
 823 } acl_condition_block;
 824
 825 typedef struct acl_block {
 826   struct acl_block *next;
 827   acl_condition_block *condition;
 828   int verb;
 829 } acl_block;
 830
 831 /* smtp transport calc outbound_ip */
 832 typedef BOOL (*oicf) (uschar *message_id, void *data);
 833
 834 /* DKIM information for transport */
 835 struct ob_dkim {
 836   uschar *dkim_domain;
 837   uschar *dkim_private_key;
 838   uschar *dkim_selector;
 839   uschar *dkim_canon;
 840   uschar *dkim_sign_headers;
 841   uschar *dkim_strict;
 842 } dkim;
 843
 844 /* End of structs.h */