src/src/structs.h

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