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   uschar *name;                   /* Host name */
  63   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 /* Structure for holding information about the configured routers. */
 222
 223 typedef struct router_instance {
 224   struct router_instance *next;
 225   uschar *name;
 226   struct router_info *info;
 227   void   *options_block;          /* Pointer to private options */
 228   uschar *driver_name;            /* Must be first */
 229
 230   uschar *address_data;           /* Arbitrary data */
 231 #ifdef EXPERIMENTAL_BRIGHTMAIL
 232   uschar *bmi_rule;               /* Brightmail AntiSpam rule checking */
 233 #endif
 234   uschar *cannot_route_message;   /* Used when routing fails */
 235   uschar *condition;              /* General condition */
 236   uschar *current_directory;      /* For use during delivery */
 237   uschar *debug_string;           /* Debugging output */
 238   uschar *domains;                /* Specific domains */
 239   uschar *errors_to;              /* Errors address */
 240   uschar *expand_gid;             /* Expanded gid string */
 241   uschar *expand_uid;             /* Expanded uid string */
 242   uschar *expand_more;            /* Expanded more string */
 243   uschar *expand_unseen;          /* Expanded unseen string */
 244   uschar *extra_headers;          /* Additional headers */
 245   uschar *fallback_hosts;         /* For remote transports (text list) */
 246   uschar *home_directory;         /* For use during delivery */
 247   uschar *ignore_target_hosts;    /* Target hosts to ignore */
 248   uschar *local_parts;            /* Specific local parts */
 249   uschar *pass_router_name;       /* Router for passed address */
 250   uschar *prefix;                 /* Address prefix */
 251   uschar *redirect_router_name;   /* Router for generated address */
 252   uschar *remove_headers;         /* Removed headers */
 253   uschar *require_files;          /* File checks before router is run */
 254   uschar *router_home_directory;  /* For use while routing */
 255   uschar *self;                   /* Text option for handling self reference */
 256   uschar *senders;                /* Specific senders */
 257   uschar *suffix;                 /* Address suffix */
 258   uschar *translate_ip_address;   /* IP address translation fudgery */
 259   uschar *transport_name;         /* Transport name */
 260
 261   BOOL    address_test;           /* Use this router when testing addresses */
 262 #ifdef EXPERIMENTAL_BRIGHTMAIL
 263   BOOL    bmi_deliver_alternate;  /* TRUE => BMI said that message should be delivered to alternate location */
 264   BOOL    bmi_deliver_default;    /* TRUE => BMI said that message should be delivered to default location */
 265   BOOL    bmi_dont_deliver;       /* TRUE => BMI said that message should not be delivered at all */
 266 #endif
 267   BOOL    expn;                   /* Use this router when processing EXPN */
 268   BOOL    caseful_local_part;     /* TRUE => don't lowercase */
 269   BOOL    check_local_user;       /* TRUE => check local user */
 270   BOOL    disable_logging;        /* For very weird requirements */
 271   BOOL    fail_verify_recipient;  /* Fail verify if recipient match this router */
 272   BOOL    fail_verify_sender;     /* Fail verify if sender match this router */
 273   BOOL    gid_set;                /* Flag to indicate gid is set */
 274   BOOL    initgroups;             /* TRUE if initgroups is required */
 275   BOOL    log_as_local;           /* TRUE logs as a local delivery */
 276   BOOL    more;                   /* If FALSE, do no more if this one fails */
 277   BOOL    pass_on_timeout;        /* Treat timeout DEFERs as fails */
 278   BOOL    prefix_optional;        /* Just what it says */
 279   BOOL    repeat_use;             /* If FALSE, skip if ancestor used it */
 280   BOOL    retry_use_local_part;   /* Just what it says */
 281   BOOL    same_domain_copy_routing; /* TRUE => copy routing for same domain */
 282   BOOL    self_rewrite;           /* TRUE to rewrite headers if making local */
 283   BOOL    suffix_optional;        /* As it says */
 284   BOOL    verify_only;            /* Skip this router if not verifying */
 285   BOOL    verify_recipient;       /* Use this router when verifying a recipient*/
 286   BOOL    verify_sender;          /* Use this router when verifying a sender */
 287   BOOL    uid_set;                /* Flag to indicate uid is set */
 288   BOOL    unseen;                 /* If TRUE carry on, even after success */
 289 #ifdef EXPERIMENTAL_DSN
 290   BOOL    dsn_lasthop;            /* If TRUE, this router is a DSN endpoint */
 291 #endif
 292
 293   int     self_code;              /* Encoded version of "self" */
 294   uid_t   uid;                    /* Fixed uid value */
 295   gid_t   gid;                    /* Fixed gid value */
 296
 297   host_item *fallback_hostlist;   /* For remote transport (block chain) */
 298   transport_instance *transport;  /* Transport block (when found) */
 299   struct router_instance *pass_router; /* Actual router for passed address */
 300   struct router_instance *redirect_router; /* Actual router for generated address */
 301 } router_instance;
 302
 303
 304 /* Structure for holding information about a type of router. The first six
 305 fields must match driver_info above. */
 306
 307 typedef struct router_info {
 308   uschar *driver_name;
 309   optionlist *options;            /* Table of private options names */
 310   int    *options_count;          /* -> Number of entries in table */
 311   void   *options_block;          /* Points to default private block */
 312   int     options_len;            /* Length of same in bytes */
 313   void (*init)(                   /* Initialization function */
 314     struct router_instance *);
 315 /****/
 316   int (*code)(                    /* Main entry point */
 317     router_instance *,
 318     struct address_item *,
 319     struct passwd *,
 320     int,
 321     struct address_item **,
 322     struct address_item **,
 323     struct address_item **,
 324     struct address_item **);
 325   void (*tidyup)(                 /* Tidyup function */
 326     struct router_instance *);
 327   int     ri_flags;               /* Descriptive flags */
 328 } router_info;
 329
 330
 331 /* Structure for holding information about a lookup type. */
 332
 333 #include "lookupapi.h"
 334
 335
 336 /* Structure for holding information about the configured authentication
 337 mechanisms */
 338
 339 typedef struct auth_instance {
 340   struct auth_instance *next;
 341   uschar *name;                   /* Exim instance name */
 342   struct auth_info *info;         /* Pointer to driver info block */
 343   void   *options_block;          /* Pointer to private options */
 344   uschar *driver_name;            /* Must be first */
 345   uschar *advertise_condition;    /* Are we going to advertise this?*/
 346   uschar *client_condition;       /* Should the client try this? */
 347   uschar *public_name;            /* Advertised name */
 348   uschar *set_id;                 /* String to set when server as authenticated id */
 349   uschar *set_client_id;          /* String to set when client as client_authenticated id */
 350   uschar *mail_auth_condition;    /* Condition for AUTH on MAIL command */
 351   uschar *server_debug_string;    /* Debugging output */
 352   uschar *server_condition;       /* Authorization condition */
 353   BOOL    client;                 /* TRUE if client option(s) set */
 354   BOOL    server;                 /* TRUE if server options(s) set */
 355   BOOL    advertised;             /* Set TRUE when advertised */
 356 } auth_instance;
 357
 358
 359 /* Structure for holding information about an authentication mechanism. The
 360 first six fields must match driver_info above. */
 361
 362 typedef struct auth_info {
 363   uschar *driver_name;            /* e.g. "condition" */
 364   optionlist *options;            /* Table of private options names */
 365   int    *options_count;          /* -> Number of entries in table */
 366   void   *options_block;          /* Points to default private block */
 367   int     options_len;            /* Length of same in bytes */
 368   void (*init)(                   /* initialization function */
 369     struct auth_instance *);
 370 /****/
 371   int (*servercode)(              /* server function */
 372     auth_instance *,              /* the instance data */
 373     uschar *);                    /* rest of AUTH command */
 374   int (*clientcode)(              /* client function */
 375     struct auth_instance *,
 376     struct smtp_inblock *,        /* socket and input buffer */
 377     struct smtp_outblock *,       /* socket and output buffer */
 378     int,                          /* command timeout */
 379     uschar *,                     /* buffer for reading response */
 380     int);                         /* sizeof buffer */
 381   void (*version_report)(         /* diagnostic version reporting */
 382     FILE *);                      /* I/O stream to print to */
 383 } auth_info;
 384
 385
 386 /* Structure for holding a single IP address and port; used for the chain of
 387 addresses and ports for the local host. Make the char string large enough to
 388 hold an IPv6 address. */
 389
 390 typedef struct ip_address_item {
 391   struct ip_address_item *next;
 392   int    port;
 393   BOOL   v6_include_v4;            /* Used in the daemon */
 394   uschar address[46];
 395 } ip_address_item;
 396
 397 /* Structure for chaining together arbitrary strings. */
 398
 399 typedef struct string_item {
 400   struct string_item *next;
 401   uschar *text;
 402 } string_item;
 403
 404 /* Information about a soft delivery failure, for use when calculating
 405 retry information. It's separate from the address block, because there
 406 can be a chain of them for SMTP deliveries where multiple IP addresses
 407 can be tried. */
 408
 409 typedef struct retry_item {
 410   struct retry_item *next;        /* for chaining */
 411   uschar *key;                    /* string identifying host/address/message */
 412   int     basic_errno;            /* error code for this destination */
 413   int     more_errno;             /* additional error information */
 414   uschar *message;                /* local error message */
 415   int     flags;                  /* see below */
 416 } retry_item;
 417
 418 /* Retry data flags */
 419
 420 #define rf_delete   0x0001        /* retry info is to be deleted */
 421 #define rf_host     0x0002        /* retry info is for a remote host */
 422 #define rf_message  0x0004        /* retry info is for a host+message */
 423
 424 /* Information about a constructed message that is to be sent using the
 425 autoreply transport. This is pointed to from the address block. */
 426
 427 typedef struct reply_item {
 428   uschar *from;                   /* ) */
 429   uschar *reply_to;               /* ) */
 430   uschar *to;                     /* ) */
 431   uschar *cc;                     /* ) specific header fields */
 432   uschar *bcc;                    /* ) */
 433   uschar *subject;                /* ) */
 434   uschar *headers;                /* misc other headers, concatenated */
 435   uschar *text;                   /* text string body */
 436   uschar *file;                   /* file body */
 437   BOOL    file_expand;            /* expand the body */
 438   int     expand_forbid;          /* expansion lockout flags */
 439   uschar *logfile;                /* file to keep a log in */
 440   uschar *oncelog;                /* file to keep records in for once only */
 441   time_t  once_repeat;            /* time to repeat "once only" */
 442   BOOL    return_message;         /* send back the original message */
 443 } reply_item;
 444
 445
 446 /* The address_item structure contains many fields which are used at various
 447 times while delivering a message. Some are used only for remote deliveries;
 448 some only for local. A particular set of fields is copied whenever a child
 449 address is created. For convenience, we keep those fields in a separate
 450 sub-structure so they can be copied in one go. This also means I won't forget
 451 to edit the various copying places when new to-be-copied fields are added. */
 452
 453 typedef struct address_item_propagated {
 454   uschar *address_data;           /* arbitrary data to keep with the address */
 455   uschar *domain_data;            /* from "domains" lookup */
 456   uschar *localpart_data;         /* from "local_parts" lookup */
 457   uschar *errors_address;         /* where to send errors (NULL => sender) */
 458   header_line *extra_headers;     /* additional headers */
 459   uschar *remove_headers;         /* list of those to remove */
 460
 461   #ifdef EXPERIMENTAL_SRS
 462   uschar *srs_sender;             /* Change return path when delivering */
 463   #endif
 464 } address_item_propagated;
 465
 466 /* Bits for the flags field below */
 467
 468 #define af_allow_file          0x00000001 /* allow file in generated address */
 469 #define af_allow_pipe          0x00000002 /* allow pipe in generated address */
 470 #define af_allow_reply         0x00000004 /* allow autoreply in generated address */
 471 #define af_dr_retry_exists     0x00000008 /* router retry record exists */
 472 #define af_expand_pipe         0x00000010 /* expand pipe arguments */
 473 #define af_file                0x00000020 /* file delivery; always with pfr */
 474 #define af_gid_set             0x00000040 /* gid field is set */
 475 #define af_home_expanded       0x00000080 /* home_dir is already expanded */
 476 #define af_ignore_error        0x00000100 /* ignore delivery error */
 477 #define af_initgroups          0x00000200 /* use initgroups() for local transporting */
 478 #define af_local_host_removed  0x00000400 /* local host was backup */
 479 #define af_lt_retry_exists     0x00000800 /* local transport retry exists */
 480 #define af_pfr                 0x00001000 /* pipe or file or reply delivery */
 481 #define af_retry_skipped       0x00002000 /* true if retry caused some skipping */
 482 #define af_retry_timedout      0x00004000 /* true if retry timed out */
 483 #define af_uid_set             0x00008000 /* uid field is set */
 484 #define af_hide_child          0x00010000 /* hide child in bounce/defer msgs */
 485 #define af_sverify_told        0x00020000 /* sender verify failure notified */
 486 #define af_verify_pmfail       0x00040000 /* verify failure was postmaster callout */
 487 #define af_verify_nsfail       0x00080000 /* verify failure was null sender callout */
 488 #define af_homonym             0x00100000 /* an ancestor has same address */
 489 #define af_verify_routed       0x00200000 /* for cached sender verify: routed OK */
 490 #define af_verify_callout      0x00400000 /* for cached sender verify: callout was specified */
 491 #define af_include_affixes     0x00800000 /* delivered with affixes in RCPT */
 492 #define af_cert_verified       0x01000000 /* delivered with verified TLS cert */
 493 #define af_pass_message        0x02000000 /* pass message in bounces */
 494 #define af_bad_reply           0x04000000 /* filter could not generate autoreply */
 495 #ifndef DISABLE_PRDR
 496 # define af_prdr_used          0x08000000 /* delivery used SMTP PRDR */
 497 #endif
 498 #define af_force_command       0x10000000 /* force_command in pipe transport */
 499 #ifdef EXPERIMENTAL_DANE
 500 # define af_dane_verified      0x20000000 /* TLS cert verify done with DANE */
 501 #endif
 502
 503 /* These flags must be propagated when a child is created */
 504
 505 #define af_propagate           (af_ignore_error)
 506
 507 /* The main address structure. Note that fields that are to be copied to
 508 generated addresses should be put in the address_item_propagated structure (see
 509 above) rather than directly into the address_item structure. */
 510
 511 typedef struct address_item {
 512   struct address_item *next;      /* for chaining addresses */
 513   struct address_item *parent;    /* parent address */
 514   struct address_item *first;     /* points to first after group delivery */
 515   struct address_item *dupof;     /* points to address this is a duplicate of */
 516
 517   router_instance *start_router;  /* generated address starts here */
 518   router_instance *router;        /* the router that routed */
 519   transport_instance *transport;  /* the transport to use */
 520
 521   host_item *host_list;           /* host data for the transport */
 522   host_item *host_used;           /* host that took delivery or failed hard */
 523   host_item *fallback_hosts;      /* to try if delivery defers */
 524
 525   reply_item *reply;              /* data for autoreply */
 526   retry_item *retries;            /* chain of retry information */
 527
 528   uschar *address;                /* address being delivered or routed */
 529   uschar *unique;                 /* used for disambiguating */
 530   uschar *cc_local_part;          /* caseful local part */
 531   uschar *lc_local_part;          /* lowercased local part */
 532   uschar *local_part;             /* points to cc or lc version */
 533   uschar *prefix;                 /* stripped prefix of local part */
 534   uschar *suffix;                 /* stripped suffix of local part */
 535   uschar *domain;                 /* working domain (lower cased) */
 536
 537   uschar *address_retry_key;      /* retry key including full address */
 538   uschar *domain_retry_key;       /* retry key for domain only */
 539
 540   uschar *current_dir;            /* current directory for transporting */
 541   uschar *home_dir;               /* home directory for transporting */
 542   uschar *message;                /* error message */
 543   uschar *user_message;           /* error message that can be sent over SMTP
 544                                      or quoted in bounce message */
 545   uschar *onetime_parent;         /* saved original parent for onetime */
 546   uschar **pipe_expandn;          /* numeric expansions for pipe from filter */
 547   uschar *return_filename;        /* name of return file */
 548   uschar *self_hostname;          /* after self=pass */
 549   uschar *shadow_message;         /* info about shadow transporting */
 550
 551   #ifdef SUPPORT_TLS
 552   uschar *cipher;                 /* Cipher used for transport */
 553   void   *ourcert;                /* Certificate offered to peer, binary */
 554   void   *peercert;               /* Certificate from peer, binary */
 555   uschar *peerdn;                 /* DN of server's certificate */
 556   int    ocsp;                    /* OCSP status of peer cert */
 557   #endif
 558
 559   uschar *authenticator;          /* auth driver name used by transport */
 560   uschar *auth_id;                /* auth "login" name used by transport */
 561   uschar *auth_sndr;              /* AUTH arg to SMTP MAIL, used by transport */
 562
 563   #ifdef EXPERIMENTAL_DSN
 564   uschar *dsn_orcpt;              /* DSN orcpt value */
 565   int     dsn_flags;              /* DSN flags */
 566   int     dsn_aware;              /* DSN aware flag */
 567   #endif
 568
 569   uid_t   uid;                    /* uid for transporting */
 570   gid_t   gid;                    /* gid for transporting */
 571
 572   unsigned int flags;             /* a row of bits, defined above */
 573   unsigned int domain_cache[(MAX_NAMED_LIST * 2)/32];
 574   unsigned int localpart_cache[(MAX_NAMED_LIST * 2)/32];
 575   int     mode;                   /* mode for local transporting to a file */
 576   int     more_errno;             /* additional error information */
 577                                   /* (may need to hold a timestamp) */
 578
 579   short int basic_errno;          /* status after failure */
 580   short int child_count;          /* number of child addresses */
 581   short int return_file;          /* fileno of return data file */
 582   short int special_action;       /* ( used when when deferred or failed */
 583                                   /* (  also  */
 584                                   /* ( contains = or - when successful SMTP delivered */
 585                                   /* (  also  */
 586                                   /* ( contains verify rc in sender verify cache */
 587   short int transport_return;     /* result of delivery attempt */
 588   address_item_propagated p;      /* fields that are propagated to children */
 589 } address_item;
 590
 591 /* The table of header names consists of items of this type */
 592
 593 typedef struct {
 594   uschar *name;
 595   int     len;
 596   BOOL    allow_resent;
 597   int     htype;
 598 } header_name;
 599
 600 /* Chain of information about errors (e.g. bad addresses) */
 601
 602 typedef struct error_block {
 603   struct error_block *next;
 604   uschar *text1;
 605   uschar *text2;
 606 } error_block;
 607
 608 /* Chain of file names when processing the queue */
 609
 610 typedef struct queue_filename {
 611   struct queue_filename *next;
 612   uschar dir_uschar;
 613   uschar text[1];
 614 } queue_filename;
 615
 616 /* Chain of items of retry information, read from the retry config. */
 617
 618 typedef struct retry_rule {
 619   struct retry_rule *next;
 620   int    rule;
 621   int    timeout;
 622   int    p1;
 623   int    p2;
 624 } retry_rule;
 625
 626 typedef struct retry_config {
 627   struct retry_config *next;
 628   uschar *pattern;
 629   int     basic_errno;
 630   int     more_errno;
 631   uschar *senders;
 632   retry_rule *rules;
 633 } retry_config;
 634
 635 /* Structure for each node in a tree, of which there are various kinds */
 636
 637 typedef struct tree_node {
 638   struct tree_node *left;         /* pointer to left child */
 639   struct tree_node *right;        /* pointer to right child */
 640   union
 641     {
 642     void  *ptr;                   /* pointer to data */
 643     int val;                      /* or integer data */
 644     } data;
 645   uschar  balance;                /* balancing factor */
 646   uschar  name[1];                /* node name - variable length */
 647 } tree_node;
 648
 649 /* Structure for holding the handle and the cached last lookup for searches.
 650 This block is pointed to by the tree entry for the file. The file can get
 651 closed if too many are opened at once. There is a LRU chain for deciding which
 652 to close. */
 653
 654 typedef struct search_cache {
 655   void   *handle;                 /* lookup handle, or NULL if closed */
 656   int search_type;                /* search type */
 657   tree_node *up;                  /* LRU up pointer */
 658   tree_node *down;                /* LRU down pointer */
 659   tree_node *item_cache;          /* tree of cached results */
 660 } search_cache;
 661
 662 /* Structure for holding a partially decoded DNS record; the name has been
 663 uncompressed, but the data pointer is into the raw data. */
 664
 665 typedef struct {
 666   uschar  name[DNS_MAXNAME];      /* domain name */
 667   int     type;                   /* record type */
 668   int     size;                   /* size of data */
 669   uschar *data;                   /* pointer to data */
 670 } dns_record;
 671
 672 /* Structure for holding the result of a DNS query. */
 673
 674 typedef struct {
 675   int     answerlen;              /* length of the answer */
 676   uschar  answer[MAXPACKET];      /* the answer itself */
 677 } dns_answer;
 678
 679 /* Structure for holding the intermediate data while scanning a DNS answer
 680 block. */
 681
 682 typedef struct {
 683   int     rrcount;                /* count of RRs in the answer */
 684   uschar *aptr;                   /* pointer in the answer while scanning */
 685   dns_record srr;                 /* data from current record in scan */
 686 } dns_scan;
 687
 688 /* Structure for holding a chain of IP addresses that are extracted from
 689 an A, AAAA, or A6 record. For the first two, there is only ever one address,
 690 but the chaining feature of A6 allows for several addresses to be realized from
 691 a single initial A6 record. The structure defines the address field of length
 692 1. In use, a suitable sized block is obtained to hold the complete textual
 693 address. */
 694
 695 typedef struct dns_address {
 696   struct dns_address *next;
 697   uschar  address[1];
 698 } dns_address;
 699
 700 /* Structure used for holding intermediate data during MD5 computations. */
 701
 702 typedef struct md5 {
 703   unsigned int length;
 704   unsigned int abcd[4];
 705   }
 706 md5;
 707
 708 /* Structure used for holding intermediate data during SHA-1 computations. */
 709
 710 typedef struct sha1 {
 711   unsigned int H[5];
 712   unsigned int length;
 713   }
 714 sha1;
 715
 716 /* Structure used to hold incoming packets of SMTP responses for a specific
 717 socket. The packets which may contain multiple lines (and in some cases,
 718 multiple responses). */
 719
 720 typedef struct smtp_inblock {
 721   int     sock;                   /* the socket */
 722   int     buffersize;             /* the size of the buffer */
 723   uschar *ptr;                    /* current position in the buffer */
 724   uschar *ptrend;                 /* end of data in the buffer */
 725   uschar *buffer;                 /* the buffer itself */
 726 } smtp_inblock;
 727
 728 /* Structure used to hold buffered outgoing packets of SMTP commands for a
 729 specific socket. The packets which may contain multiple lines when pipelining
 730 is in use. */
 731
 732 typedef struct smtp_outblock {
 733   int     sock;                   /* the socket */
 734   int     cmd_count;              /* count of buffered commands */
 735   int     buffersize;             /* the size of the buffer */
 736   BOOL    authenticating;         /* TRUE when authenticating */
 737   uschar *ptr;                    /* current position in the buffer */
 738   uschar *buffer;                 /* the buffer itself */
 739 } smtp_outblock;
 740
 741 /* Structure to hold information about the source of redirection information */
 742
 743 typedef struct redirect_block {
 744   uschar *string;                 /* file name or string */
 745   uid_t  *owners;                 /* allowed file owners */
 746   gid_t  *owngroups;              /* allowed file groups */
 747   struct passwd *pw;              /* possible owner if not NULL */
 748   int     modemask;               /* forbidden bits */
 749   BOOL    isfile;                 /* TRUE if string is a file name */
 750   BOOL    check_owner;            /* TRUE, FALSE, or TRUE_UNSET */
 751   BOOL    check_group;            /* TRUE, FALSE, or TRUE_UNSET */
 752 } redirect_block;
 753
 754 /* Structure for passing arguments to check_host() */
 755
 756 typedef struct check_host_block {
 757   uschar *host_name;
 758   uschar *host_address;
 759   uschar *host_ipv4;
 760   BOOL   negative;
 761 } check_host_block;
 762
 763 /* Structure for remembering lookup data when caching the result of
 764 a lookup in a named list. */
 765
 766 typedef struct namedlist_cacheblock {
 767   struct namedlist_cacheblock *next;
 768   uschar *key;
 769   uschar *data;
 770 } namedlist_cacheblock;
 771
 772 /* Structure for holding data for an entry in a named list */
 773
 774 typedef struct namedlist_block {
 775   uschar *string;                    /* the list string */
 776   namedlist_cacheblock *cache_data;  /* cached domain_data or localpart_data */
 777   int number;                        /* the number of the list for caching */
 778 } namedlist_block;
 779
 780 /* Structures for Access Control Lists */
 781
 782 typedef struct acl_condition_block {
 783   struct acl_condition_block *next;
 784   uschar *arg;
 785   int type;
 786   union {
 787     BOOL negated;
 788     uschar *varname;
 789   } u;
 790 } acl_condition_block;
 791
 792 typedef struct acl_block {
 793   struct acl_block *next;
 794   acl_condition_block *condition;
 795   int verb;
 796 } acl_block;
 797
 798 /* End of structs.h */