src/src/structs.h

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