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