src/src/structs.h

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