src/src/structs.h

   1 /* $Cambridge: exim/src/src/structs.h,v 1.13 2006/10/16 15:44:36 ph10 Exp $ */
   2
   3 /*************************************************
   4 *     Exim - an Internet mail transport agent    *
   5 *************************************************/
   6
   7 /* Copyright (c) University of Cambridge 1995 - 2006 */
   8 /* See the file NOTICE for conditions of use and distribution. */
   9
  10
  11 /* Definitions of various structures. In addition, those that are visible for
  12 the compilation of local_scan() are defined in local_scan.h. These are
  13
  14   header_line
  15   optionlist
  16   recipient_item
  17
  18 For those declared here, we have to pre-declare some because of mutually
  19 recursive definitions in the auths, routers, and transports blocks. */
  20
  21 struct address_item;
  22 struct auth_info;
  23 struct driver_info;
  24 struct director_info;
  25 struct smtp_inblock;
  26 struct smtp_outblock;
  27 struct transport_info;
  28 struct router_info;
  29
  30 /* Structure for remembering macros for the configuration file */
  31
  32 typedef struct macro_item {
  33   struct  macro_item *next;
  34   BOOL    command_line;
  35   uschar *replacement;
  36   uschar  name[1];
  37 } macro_item;
  38
  39 /* Structure for bit tables for debugging and logging */
  40
  41 typedef struct bit_table {
  42   uschar *name;
  43   unsigned int bit;
  44 } bit_table;
  45
  46 /* Block for holding a uid and gid, possibly unset, and an initgroups flag. */
  47
  48 typedef struct ugid_block {
  49   uid_t   uid;
  50   gid_t   gid;
  51   BOOL    uid_set;
  52   BOOL    gid_set;
  53   BOOL    initgroups;
  54 } ugid_block;
  55
  56 /* Structure for holding information about a host for use mainly by routers,
  57 but also used when checking lists of hosts and when transporting. Looking up
  58 host addresses is done using this structure. */
  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   BOOL    update_waiting;         /* Turned off if wait db not to be updated */
  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   BOOL    multi_domain;           /* )                                  */
 152   BOOL    overrides_hosts;        /* ) Used only for remote transports  */
 153   int     max_addresses;          /* )                                  */
 154   int     connection_max_messages;/* )                                  */
 155                                   /**************************************/
 156   BOOL    deliver_as_creator;     /* Used only by pipe at present */
 157   BOOL    disable_logging;        /* For very weird requirements */
 158   BOOL    initgroups;             /* Initialize groups when setting uid */
 159   BOOL    uid_set;                /* uid is set */
 160   BOOL    gid_set;                /* gid is set */
 161   uid_t   uid;
 162   gid_t   gid;
 163   uschar *expand_uid;             /* Variable uid */
 164   uschar *expand_gid;             /* Variable gid */
 165   uschar *warn_message;           /* Used only by appendfile at present */
 166   uschar *shadow;                 /* Name of shadow transport */
 167   uschar *shadow_condition;       /* Condition for running it */
 168   uschar *filter_command;         /* For on-the-fly-filtering */
 169   uschar *add_headers;            /* Add these headers */
 170   uschar *remove_headers;         /* Remove these headers */
 171   uschar *return_path;            /* Overriding (rewriting) return path */
 172   uschar *debug_string;           /* Debugging output */
 173   uschar *message_size_limit;     /* Biggest message this transport handles */
 174   uschar *headers_rewrite;        /* Rules for rewriting headers */
 175   rewrite_rule *rewrite_rules;    /* Parsed rewriting rules */
 176   int     rewrite_existflags;     /* Bits showing which headers are rewritten */
 177   int     filter_timeout;         /* For transport filter timing */
 178   BOOL    body_only;              /* Deliver only the body */
 179   BOOL    delivery_date_add;      /* Add Delivery-Date header */
 180   BOOL    envelope_to_add;        /* Add Envelope-To header */
 181   BOOL    headers_only;           /* Deliver only the headers */
 182   BOOL    rcpt_include_affixes;   /* TRUE to retain affixes in RCPT commands */
 183   BOOL    return_path_add;        /* Add Return-Path header */
 184   BOOL    return_output;          /* TRUE if output should always be returned */
 185   BOOL    return_fail_output;     /* ditto, but only on failure */
 186   BOOL    log_output;             /* Similarly for logging */
 187   BOOL    log_fail_output;
 188   BOOL    log_defer_output;
 189   BOOL    retry_use_local_part;   /* Defaults true for local, false for remote */
 190 } transport_instance;
 191
 192
 193 /* Structure for holding information about a type of transport. The first six
 194 fields must match driver_info above. */
 195
 196 typedef struct transport_info {
 197   uschar *driver_name;            /* Driver name */
 198   optionlist *options;            /* Table of private options names */
 199   int    *options_count;          /* -> Number of entries in table */
 200   void   *options_block;          /* Points to default private block */
 201   int     options_len;            /* Length of same in bytes */
 202   void (*init)(                   /* Initialization function */
 203     struct transport_instance *);
 204 /****/
 205   BOOL (*code)(                   /* Main entry point */
 206     transport_instance *,
 207     struct address_item *);
 208   void (*tidyup)(                 /* Tidyup function */
 209     struct transport_instance *);
 210   void  (*closedown)(             /* For closing down a passed channel */
 211     struct transport_instance *);
 212   BOOL    local;                  /* TRUE for local transports */
 213 } transport_info;
 214
 215
 216
 217 /* Structure for holding information about the configured routers. */
 218
 219 typedef struct router_instance {
 220   struct router_instance *next;
 221   uschar *name;
 222   struct router_info *info;
 223   void   *options_block;          /* Pointer to private options */
 224   uschar *driver_name;            /* Must be first */
 225
 226   uschar *address_data;           /* Arbitrary data */
 227 #ifdef EXPERIMENTAL_BRIGHTMAIL
 228   uschar *bmi_rule;               /* Brightmail AntiSpam rule checking */
 229 #endif
 230   uschar *cannot_route_message;   /* Used when routing fails */
 231   uschar *condition;              /* General condition */
 232   uschar *current_directory;      /* For use during delivery */
 233   uschar *debug_string;           /* Debugging output */
 234   uschar *domains;                /* Specific domains */
 235   uschar *errors_to;              /* Errors address */
 236   uschar *expand_gid;             /* Expanded gid string */
 237   uschar *expand_uid;             /* Expanded uid string */
 238   uschar *expand_more;            /* Expanded more string */
 239   uschar *expand_unseen;          /* Expanded unseen string */
 240   uschar *extra_headers;          /* Additional headers */
 241   uschar *fallback_hosts;         /* For remote transports (text list) */
 242   uschar *home_directory;         /* For use during delivery */
 243   uschar *ignore_target_hosts;    /* Target hosts to ignore */
 244   uschar *local_parts;            /* Specific local parts */
 245   uschar *pass_router_name;       /* Router for passed address */
 246   uschar *prefix;                 /* Address prefix */
 247   uschar *redirect_router_name;   /* Router for generated address */
 248   uschar *remove_headers;         /* Removed headers */
 249   uschar *require_files;          /* File checks before router is run */
 250   uschar *router_home_directory;  /* For use while routing */
 251   uschar *self;                   /* Text option for handling self reference */
 252   uschar *senders;                /* Specific senders */
 253   uschar *suffix;                 /* Address suffix */
 254   uschar *translate_ip_address;   /* IP address translation fudgery */
 255   uschar *transport_name;         /* Transport name */
 256
 257   BOOL    address_test;           /* Use this router when testing addresses */
 258 #ifdef EXPERIMENTAL_BRIGHTMAIL
 259   BOOL    bmi_deliver_alternate;  /* TRUE => BMI said that message should be delivered to alternate location */
 260   BOOL    bmi_deliver_default;    /* TRUE => BMI said that message should be delivered to default location */
 261   BOOL    bmi_dont_deliver;       /* TRUE => BMI said that message should not be delivered at all */
 262 #endif
 263   BOOL    expn;                   /* Use this router when processing EXPN */
 264   BOOL    caseful_local_part;     /* TRUE => don't lowercase */
 265   BOOL    check_local_user;       /* TRUE => check local user */
 266   BOOL    disable_logging;        /* For very weird requirements */
 267   BOOL    fail_verify_recipient;  /* Fail verify if recipient match this router */
 268   BOOL    fail_verify_sender;     /* Fail verify if sender match this router */
 269   BOOL    gid_set;                /* Flag to indicate gid is set */
 270   BOOL    initgroups;             /* TRUE if initgroups is required */
 271   BOOL    log_as_local;           /* TRUE logs as a local delivery */
 272   BOOL    more;                   /* If FALSE, do no more if this one fails */
 273   BOOL    pass_on_timeout;        /* Treat timeout DEFERs as fails */
 274   BOOL    prefix_optional;        /* Just what it says */
 275   BOOL    repeat_use;             /* If FALSE, skip if ancestor used it */
 276   BOOL    retry_use_local_part;   /* Just what it says */
 277   BOOL    same_domain_copy_routing; /* TRUE => copy routing for same domain */
 278   BOOL    self_rewrite;           /* TRUE to rewrite headers if making local */
 279   BOOL    suffix_optional;        /* As it says */
 280   BOOL    verify_only;            /* Skip this router if not verifying */
 281   BOOL    verify_recipient;       /* Use this router when verifying a recipient*/
 282   BOOL    verify_sender;          /* Use this router when verifying a sender */
 283   BOOL    uid_set;                /* Flag to indicate uid is set */
 284   BOOL    unseen;                 /* If TRUE carry on, even after success */
 285
 286   int     self_code;              /* Encoded version of "self" */
 287   uid_t   uid;                    /* Fixed uid value */
 288   gid_t   gid;                    /* Fixed gid value */
 289
 290   host_item *fallback_hostlist;   /* For remote transport (block chain) */
 291   transport_instance *transport;  /* Transport block (when found) */
 292   struct router_instance *pass_router; /* Actual router for passed address */
 293   struct router_instance *redirect_router; /* Actual router for generated address */
 294 } router_instance;
 295
 296
 297 /* Structure for holding information about a type of router. The first six
 298 fields must match driver_info above. */
 299
 300 typedef struct router_info {
 301   uschar *driver_name;
 302   optionlist *options;            /* Table of private options names */
 303   int    *options_count;          /* -> Number of entries in table */
 304   void   *options_block;          /* Points to default private block */
 305   int     options_len;            /* Length of same in bytes */
 306   void (*init)(                   /* Initialization function */
 307     struct router_instance *);
 308 /****/
 309   int (*code)(                    /* Main entry point */
 310     router_instance *,
 311     struct address_item *,
 312     struct passwd *,
 313     int,
 314     struct address_item **,
 315     struct address_item **,
 316     struct address_item **,
 317     struct address_item **);
 318   void (*tidyup)(                 /* Tidyup function */
 319     struct router_instance *);
 320   int     ri_flags;               /* Descriptive flags */
 321 } router_info;
 322
 323
 324 /* Structure for holding information about a lookup type. */
 325
 326 typedef struct lookup_info {
 327   uschar *name;                   /* e.g. "lsearch" */
 328   int type;                       /* query/singlekey/abs-file */
 329   void *(*open)(                  /* open function */
 330     uschar *,                     /* file name for those that have one */
 331     uschar **);                   /* for error message */
 332   BOOL (*check)(                  /* file checking function */
 333     void *,                       /* handle */
 334     uschar *,                     /* file name */
 335     int,                          /* modemask for file checking */
 336     uid_t *,                      /* owners for file checking */
 337     gid_t *,                      /* owngroups for file checking */
 338     uschar **);                   /* for error messages */
 339   int (*find)(                    /* find function */
 340     void *,                       /* handle */
 341     uschar *,                     /* file name or NULL */
 342     uschar *,                     /* key or query */
 343     int,                          /* length of key or query */
 344     uschar **,                    /* for returning answer */
 345     uschar **,                    /* for error message */
 346     BOOL *);                      /* to request cache cleanup */
 347   void (*close)(                  /* close function */
 348     void *);                      /* handle */
 349   void (*tidy)(void);             /* tidy function */
 350   uschar *(*quote)(               /* quoting function */
 351     uschar *,                     /* string to quote */
 352     uschar *);                    /* additional data from quote name */
 353 } lookup_info;
 354
 355
 356 /* Structure for holding information about the configured authentication
 357 mechanisms */
 358
 359 typedef struct auth_instance {
 360   struct auth_instance *next;
 361   uschar *name;                   /* Exim instance name */
 362   struct auth_info *info;         /* Pointer to driver info block */
 363   void   *options_block;          /* Pointer to private options */
 364   uschar *driver_name;            /* Must be first */
 365   uschar *advertise_condition;    /* Are we going to advertise this?*/
 366   uschar *public_name;            /* Advertised name */
 367   uschar *set_id;                 /* String to set as authenticated id */
 368   uschar *mail_auth_condition;    /* Condition for AUTH on MAIL command */
 369   uschar *server_debug_string;    /* Debugging output */
 370   uschar *server_condition;       /* Authorization condition */
 371   BOOL    client;                 /* TRUE if client option(s) set */
 372   BOOL    server;                 /* TRUE if server options(s) set */
 373   BOOL    advertised;             /* Set TRUE when advertised */
 374 } auth_instance;
 375
 376
 377 /* Structure for holding information about an authentication mechanism. The
 378 first six fields must match driver_info above. */
 379
 380 typedef struct auth_info {
 381   uschar *driver_name;            /* e.g. "condition" */
 382   optionlist *options;            /* Table of private options names */
 383   int    *options_count;          /* -> Number of entries in table */
 384   void   *options_block;          /* Points to default private block */
 385   int     options_len;            /* Length of same in bytes */
 386   void (*init)(                   /* initialization function */
 387     struct auth_instance *);
 388 /****/
 389   int (*servercode)(              /* server function */
 390     auth_instance *,              /* the instance data */
 391     uschar *);                    /* rest of AUTH command */
 392   int (*clientcode)(              /* client function */
 393     struct auth_instance *,
 394     struct smtp_inblock *,        /* socket and input buffer */
 395     struct smtp_outblock *,       /* socket and output buffer */
 396     int,                          /* command timeout */
 397     uschar *,                     /* buffer for reading response */
 398     int);                         /* sizeof buffer */
 399 } auth_info;
 400
 401
 402 /* Structure for holding a single IP address and port; used for the chain of
 403 addresses and ports for the local host. Make the char string large enough to
 404 hold an IPv6 address. */
 405
 406 typedef struct ip_address_item {
 407   struct ip_address_item *next;
 408   int    port;
 409   BOOL   v6_include_v4;            /* Used in the daemon */
 410   uschar address[46];
 411 } ip_address_item;
 412
 413 /* Structure for chaining together arbitrary strings. */
 414
 415 typedef struct string_item {
 416   struct string_item *next;
 417   uschar *text;
 418 } string_item;
 419
 420 /* Information about a soft delivery failure, for use when calculating
 421 retry information. It's separate from the address block, because there
 422 can be a chain of them for SMTP deliveries where multiple IP addresses
 423 can be tried. */
 424
 425 typedef struct retry_item {
 426   struct retry_item *next;        /* for chaining */
 427   uschar *key;                    /* string identifying host/address/message */
 428   int     basic_errno;            /* error code for this destination */
 429   int     more_errno;             /* additional error information */
 430   uschar *message;                /* local error message */
 431   int     flags;                  /* see below */
 432 } retry_item;
 433
 434 /* Retry data flags */
 435
 436 #define rf_delete   0x0001        /* retry info is to be deleted */
 437 #define rf_host     0x0002        /* retry info is for a remote host */
 438 #define rf_message  0x0004        /* retry info is for a host+message */
 439
 440 /* Information about a constructed message that is to be sent using the
 441 autoreply transport. This is pointed to from the address block. */
 442
 443 typedef struct reply_item {
 444   uschar *from;                   /* ) */
 445   uschar *reply_to;               /* ) */
 446   uschar *to;                     /* ) */
 447   uschar *cc;                     /* ) specific header fields */
 448   uschar *bcc;                    /* ) */
 449   uschar *subject;                /* ) */
 450   uschar *headers;                /* misc other headers, concatenated */
 451   uschar *text;                   /* text string body */
 452   uschar *file;                   /* file body */
 453   BOOL    file_expand;            /* expand the body */
 454   int     expand_forbid;          /* expansion lockout flags */
 455   uschar *logfile;                /* file to keep a log in */
 456   uschar *oncelog;                /* file to keep records in for once only */
 457   time_t  once_repeat;            /* time to repeat "once only" */
 458   BOOL    return_message;         /* send back the original message */
 459 } reply_item;
 460
 461
 462 /* The address_item structure contains many fields which are used at various
 463 times while delivering a message. Some are used only for remote deliveries;
 464 some only for local. A particular set of fields is copied whenever a child
 465 address is created. For convenience, we keep those fields in a separate
 466 sub-structure so they can be copied in one go. This also means I won't forget
 467 to edit the various copying places when new to-be-copied fields are added. */
 468
 469 typedef struct address_item_propagated {
 470   uschar *address_data;           /* arbitrary data to keep with the address */
 471   uschar *domain_data;            /* from "domains" lookup */
 472   uschar *localpart_data;         /* from "local_parts" lookup */
 473   uschar *errors_address;         /* where to send errors (NULL => sender) */
 474   header_line *extra_headers;     /* additional headers */
 475   uschar *remove_headers;         /* list of those to remove */
 476
 477   #ifdef EXPERIMENTAL_SRS
 478   uschar *srs_sender;             /* Change return path when delivering */
 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
 512 /* These flags must be propagated when a child is created */
 513
 514 #define af_propagate           (af_ignore_error)
 515
 516 /* The main address structure. Note that fields that are to be copied to
 517 generated addresses should be put in the address_item_propagated structure (see
 518 above) rather than directly into the address_item structure. */
 519
 520 typedef struct address_item {
 521   struct address_item *next;      /* for chaining addresses */
 522   struct address_item *parent;    /* parent address */
 523   struct address_item *first;     /* points to first after group delivery */
 524   struct address_item *dupof;     /* points to address this is a duplicate of */
 525
 526   router_instance *start_router;  /* generated address starts here */
 527   router_instance *router;        /* the router that routed */
 528   transport_instance *transport;  /* the transport to use */
 529
 530   host_item *host_list;           /* host data for the transport */
 531   host_item *host_used;           /* host that took delivery or failed hard */
 532   host_item *fallback_hosts;      /* to try if delivery defers */
 533
 534   reply_item *reply;              /* data for autoreply */
 535   retry_item *retries;            /* chain of retry information */
 536
 537   uschar *address;                /* address being delivered or routed */
 538   uschar *unique;                 /* used for disambiguating */
 539   uschar *cc_local_part;          /* caseful local part */
 540   uschar *lc_local_part;          /* lowercased local part */
 541   uschar *local_part;             /* points to cc or lc version */
 542   uschar *prefix;                 /* stripped prefix of local part */
 543   uschar *suffix;                 /* stripped suffix of local part */
 544   uschar *domain;                 /* working domain (lower cased) */
 545
 546   uschar *address_retry_key;      /* retry key including full address */
 547   uschar *domain_retry_key;       /* retry key for domain only */
 548
 549   uschar *current_dir;            /* current directory for transporting */
 550   uschar *home_dir;               /* home directory for transporting */
 551   uschar *message;                /* error message */
 552   uschar *user_message;           /* error message that can be sent over SMTP
 553                                      or quoted in bounce message */
 554   uschar *onetime_parent;         /* saved original parent for onetime */
 555   uschar **pipe_expandn;          /* numeric expansions for pipe from filter */
 556   uschar *return_filename;        /* name of return file */
 557   uschar *self_hostname;          /* after self=pass */
 558   uschar *shadow_message;         /* info about shadow transporting */
 559
 560   #ifdef SUPPORT_TLS
 561   uschar *cipher;                 /* Cipher used for transport */
 562   uschar *peerdn;                 /* DN of server's certificate */
 563   #endif
 564
 565   uid_t   uid;                    /* uid for transporting */
 566   gid_t   gid;                    /* gid for transporting */
 567
 568   unsigned int flags;             /* a row of bits, defined above */
 569   unsigned int domain_cache[(MAX_NAMED_LIST * 2)/32];
 570   unsigned int localpart_cache[(MAX_NAMED_LIST * 2)/32];
 571   int     mode;                   /* mode for local transporting to a file */
 572   int     more_errno;             /* additional error information */
 573                                   /* (may need to hold a timestamp) */
 574
 575   short int basic_errno;          /* status after failure */
 576   short int child_count;          /* number of child addresses */
 577   short int return_file;          /* fileno of return data file */
 578   short int special_action;       /* ( used when when deferred or failed */
 579                                   /* (  also  */
 580                                   /* ( contains = or - when successful SMTP delivered */
 581                                   /* (  also  */
 582                                   /* ( contains verify rc in sender verify cache */
 583   short int transport_return;     /* result of delivery attempt */
 584   address_item_propagated p;      /* fields that are propagated to children */
 585 } address_item;
 586
 587 /* The table of header names consists of items of this type */
 588
 589 typedef struct {
 590   uschar *name;
 591   int     len;
 592   BOOL    allow_resent;
 593   int     htype;
 594 } header_name;
 595
 596 /* Chain of information about errors (e.g. bad addresses) */
 597
 598 typedef struct error_block {
 599   struct error_block *next;
 600   uschar *text1;
 601   uschar *text2;
 602 } error_block;
 603
 604 /* Chain of file names when processing the queue */
 605
 606 typedef struct queue_filename {
 607   struct queue_filename *next;
 608   uschar dir_uschar;
 609   uschar text[1];
 610 } queue_filename;
 611
 612 /* Chain of items of retry information, read from the retry config. */
 613
 614 typedef struct retry_rule {
 615   struct retry_rule *next;
 616   int    rule;
 617   int    timeout;
 618   int    p1;
 619   int    p2;
 620 } retry_rule;
 621
 622 typedef struct retry_config {
 623   struct retry_config *next;
 624   uschar *pattern;
 625   int     basic_errno;
 626   int     more_errno;
 627   uschar *senders;
 628   retry_rule *rules;
 629 } retry_config;
 630
 631 /* Structure for each node in a tree, of which there are various kinds */
 632
 633 typedef struct tree_node {
 634   struct tree_node *left;         /* pointer to left child */
 635   struct tree_node *right;        /* pointer to right child */
 636   union
 637     {
 638     void  *ptr;                   /* pointer to data */
 639     int val;                      /* or integer data */
 640     } data;
 641   uschar  balance;                /* balancing factor */
 642   uschar  name[1];                /* node name - variable length */
 643 } tree_node;
 644
 645 /* Structure for holding the handle and the cached last lookup for searches.
 646 This block is pointed to by the tree entry for the file. The file can get
 647 closed if too many are opened at once. There is a LRU chain for deciding which
 648 to close. */
 649
 650 typedef struct search_cache {
 651   void   *handle;                 /* lookup handle, or NULL if closed */
 652   int search_type;                /* search type */
 653   tree_node *up;                  /* LRU up pointer */
 654   tree_node *down;                /* LRU down pointer */
 655   tree_node *item_cache;          /* tree of cached results */
 656 } search_cache;
 657
 658 /* Structure for holding a partially decoded DNS record; the name has been
 659 uncompressed, but the data pointer is into the raw data. */
 660
 661 typedef struct {
 662   uschar  name[DNS_MAXNAME];      /* domain name */
 663   int     type;                   /* record type */
 664   int     size;                   /* size of data */
 665   uschar *data;                   /* pointer to data */
 666 } dns_record;
 667
 668 /* Structure for holding the result of a DNS query. */
 669
 670 typedef struct {
 671   int     answerlen;              /* length of the answer */
 672   uschar  answer[MAXPACKET];      /* the answer itself */
 673 } dns_answer;
 674
 675 /* Structure for holding the intermediate data while scanning a DNS answer
 676 block. */
 677
 678 typedef struct {
 679   int     rrcount;                /* count of RRs in the answer */
 680   uschar *aptr;                   /* pointer in the answer while scanning */
 681   dns_record srr;                 /* data from current record in scan */
 682 } dns_scan;
 683
 684 /* Structure for holding a chain of IP addresses that are extracted from
 685 an A, AAAA, or A6 record. For the first two, there is only ever one address,
 686 but the chaining feature of A6 allows for several addresses to be realized from
 687 a single initial A6 record. The structure defines the address field of length
 688 1. In use, a suitable sized block is obtained to hold the complete textual
 689 address. */
 690
 691 typedef struct dns_address {
 692   struct dns_address *next;
 693   uschar  address[1];
 694 } dns_address;
 695
 696 /* Structure used for holding intermediate data during MD5 computations. */
 697
 698 typedef struct md5 {
 699   unsigned int length;
 700   unsigned int abcd[4];
 701   }
 702 md5;
 703
 704 /* Structure used for holding intermediate data during SHA-1 computations. */
 705
 706 typedef struct sha1 {
 707   unsigned int H[5];
 708   unsigned int length;
 709   }
 710 sha1;
 711
 712 /* Structure used to hold incoming packets of SMTP responses for a specific
 713 socket. The packets which may contain multiple lines (and in some cases,
 714 multiple responses). */
 715
 716 typedef struct smtp_inblock {
 717   int     sock;                   /* the socket */
 718   int     buffersize;             /* the size of the buffer */
 719   uschar *ptr;                    /* current position in the buffer */
 720   uschar *ptrend;                 /* end of data in the buffer */
 721   uschar *buffer;                 /* the buffer itself */
 722 } smtp_inblock;
 723
 724 /* Structure used to hold buffered outgoing packets of SMTP commands for a
 725 specific socket. The packets which may contain multiple lines when pipelining
 726 is in use. */
 727
 728 typedef struct smtp_outblock {
 729   int     sock;                   /* the socket */
 730   int     cmd_count;              /* count of buffered commands */
 731   int     buffersize;             /* the size of the buffer */
 732   BOOL    authenticating;         /* TRUE when authenticating */
 733   uschar *ptr;                    /* current position in the buffer */
 734   uschar *buffer;                 /* the buffer itself */
 735 } smtp_outblock;
 736
 737 /* Structure to hold information about the source of redirection information */
 738
 739 typedef struct redirect_block {
 740   uschar *string;                 /* file name or string */
 741   uid_t  *owners;                 /* allowed file owners */
 742   gid_t  *owngroups;              /* allowed file groups */
 743   struct passwd *pw;              /* possible owner if not NULL */
 744   int     modemask;               /* forbidden bits */
 745   BOOL    isfile;                 /* TRUE if string is a file name */
 746   BOOL    check_owner;            /* TRUE, FALSE, or TRUE_UNSET */
 747   BOOL    check_group;            /* TRUE, FALSE, or TRUE_UNSET */
 748 } redirect_block;
 749
 750 /* Structure for passing arguments to check_host() */
 751
 752 typedef struct check_host_block {
 753   uschar *host_name;
 754   uschar *host_address;
 755   uschar *host_ipv4;
 756   BOOL   negative;
 757 } check_host_block;
 758
 759 /* Structure for remembering lookup data when caching the result of
 760 a lookup in a named list. */
 761
 762 typedef struct namedlist_cacheblock {
 763   struct namedlist_cacheblock *next;
 764   uschar *key;
 765   uschar *data;
 766 } namedlist_cacheblock;
 767
 768 /* Structure for holding data for an entry in a named list */
 769
 770 typedef struct namedlist_block {
 771   uschar *string;                    /* the list string */
 772   namedlist_cacheblock *cache_data;  /* cached domain_data or localpart_data */
 773   int number;                        /* the number of the list for caching */
 774 } namedlist_block;
 775
 776 /* Structures for Access Control Lists */
 777
 778 typedef struct acl_condition_block {
 779   struct acl_condition_block *next;
 780   uschar *arg;
 781   int type;
 782   union {
 783     BOOL negated;
 784     uschar *varname;
 785   } u;
 786 } acl_condition_block;
 787
 788 typedef struct acl_block {
 789   struct acl_block *next;
 790   acl_condition_block *condition;
 791   int verb;
 792 } acl_block;
 793
 794 /* End of structs.h */