src/src/structs.h

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