src/src/structs.h

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