src/src/structs.h

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