src/src/transports/smtp.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2018 */
   6 /* See the file NOTICE for conditions of use and distribution. */
   7
   8 #define DELIVER_BUFFER_SIZE 4096
   9
  10 #define PENDING          256
  11 #define PENDING_DEFER   (PENDING + DEFER)
  12 #define PENDING_OK      (PENDING + OK)
  13
  14
  15 /* Private structure for the private options and other private data. */
  16
  17 typedef struct {
  18   uschar *hosts;
  19   uschar *fallback_hosts;
  20   host_item *hostlist;
  21   host_item *fallback_hostlist;
  22   uschar *authenticated_sender;
  23   uschar *helo_data;
  24   uschar *interface;
  25   uschar *port;
  26   uschar *protocol;
  27   uschar *dscp;
  28   uschar *serialize_hosts;
  29   uschar *hosts_try_auth;
  30   uschar *hosts_require_auth;
  31   uschar *hosts_try_chunking;
  32 #ifdef SUPPORT_DANE
  33   uschar *hosts_try_dane;
  34   uschar *hosts_require_dane;
  35   uschar *dane_require_tls_ciphers;
  36 #endif
  37   uschar *hosts_try_fastopen;
  38 #ifndef DISABLE_PRDR
  39   uschar *hosts_try_prdr;
  40 #endif
  41 #ifndef DISABLE_OCSP
  42   uschar *hosts_request_ocsp;
  43   uschar *hosts_require_ocsp;
  44 #endif
  45   uschar *hosts_require_tls;
  46   uschar *hosts_avoid_tls;
  47   uschar *hosts_verify_avoid_tls;
  48   uschar *hosts_avoid_pipelining;
  49   uschar *hosts_avoid_esmtp;
  50 #ifdef SUPPORT_TLS
  51   uschar *hosts_nopass_tls;
  52   uschar *hosts_noproxy_tls;
  53 #endif
  54   int     command_timeout;
  55   int     connect_timeout;
  56   int     data_timeout;
  57   int     final_timeout;
  58   int     size_addition;
  59   int     hosts_max_try;
  60   int     hosts_max_try_hardlimit;
  61   BOOL    address_retry_include_sender;
  62   BOOL    allow_localhost;
  63   BOOL    authenticated_sender_force;
  64   BOOL    gethostbyname;
  65   BOOL    dns_qualify_single;
  66   BOOL    dns_search_parents;
  67   dnssec_domains dnssec;
  68   BOOL    delay_after_cutoff;
  69   BOOL    hosts_override;
  70   BOOL    hosts_randomize;
  71   BOOL    keepalive;
  72   BOOL    lmtp_ignore_quota;
  73   uschar *expand_retry_include_ip_address;
  74   BOOL    retry_include_ip_address;
  75 #ifdef SUPPORT_SOCKS
  76   uschar *socks_proxy;
  77 #endif
  78 #ifdef SUPPORT_TLS
  79   uschar *tls_certificate;
  80   uschar *tls_crl;
  81   uschar *tls_privatekey;
  82   uschar *tls_require_ciphers;
  83   uschar *tls_sni;
  84   uschar *tls_verify_certificates;
  85   int     tls_dh_min_bits;
  86   BOOL    tls_tempfail_tryclear;
  87   uschar *tls_verify_hosts;
  88   uschar *tls_try_verify_hosts;
  89   uschar *tls_verify_cert_hostnames;
  90 #endif
  91 #ifdef SUPPORT_I18N
  92   uschar *utf8_downconvert;
  93 #endif
  94 #ifndef DISABLE_DKIM
  95   struct ob_dkim dkim;
  96 #endif
  97 #ifdef EXPERIMENTAL_ARC
  98   uschar *arc_sign;
  99 #endif
 100 } smtp_transport_options_block;
 101
 102 /* smtp connect context */
 103 typedef struct {
 104   uschar *              from_addr;
 105   address_item *        addrlist;
 106   host_item *           host;
 107   int                   host_af;
 108   int                   port;
 109   uschar *              interface;
 110
 111   BOOL verify:1;
 112   BOOL lmtp:1;
 113   BOOL smtps:1;
 114   BOOL ok:1;
 115   BOOL setting_up:1;
 116   BOOL esmtp:1;
 117   BOOL esmtp_sent:1;
 118 #ifndef DISABLE_PRDR
 119   BOOL prdr_active:1;
 120 #endif
 121 #ifdef SUPPORT_I18N
 122   BOOL utf8_needed:1;
 123 #endif
 124   BOOL dsn_all_lasthop:1;
 125 #if defined(SUPPORT_TLS) && defined(SUPPORT_DANE)
 126   BOOL dane:1;
 127   BOOL dane_required:1;
 128 #endif
 129   BOOL pending_MAIL:1;
 130   BOOL pending_BDAT:1;
 131   BOOL good_RCPT:1;
 132   BOOL completed_addr:1;
 133   BOOL send_rset:1;
 134   BOOL send_quit:1;
 135
 136   int           max_rcpt;
 137   int           cmd_count;
 138
 139   unsigned      peer_offered;
 140   unsigned      avoid_option;
 141   uschar *      igquotstr;
 142   uschar *      helo_data;
 143 #ifdef EXPERIMENTAL_DSN_INFO
 144   uschar *      smtp_greeting;
 145   uschar *      helo_response;
 146 #endif
 147
 148   address_item *        first_addr;
 149   address_item *        next_addr;
 150   address_item *        sync_addr;
 151
 152   client_conn_ctx       cctx;
 153   smtp_inblock          inblock;
 154   smtp_outblock         outblock;
 155   uschar        buffer[DELIVER_BUFFER_SIZE];
 156   uschar        inbuffer[4096];
 157   uschar        outbuffer[4096];
 158
 159   transport_instance *                  tblock;
 160   smtp_transport_options_block *        ob;
 161 } smtp_context;
 162
 163 extern int smtp_setup_conn(smtp_context *, BOOL);
 164 extern int smtp_write_mail_and_rcpt_cmds(smtp_context *, int *);
 165
 166
 167 /* Data for reading the private options. */
 168
 169 extern optionlist smtp_transport_options[];
 170 extern int smtp_transport_options_count;
 171
 172 /* Block containing default values. */
 173
 174 extern smtp_transport_options_block smtp_transport_option_defaults;
 175
 176 /* The main, init, and closedown entry points for the transport */
 177
 178 extern BOOL smtp_transport_entry(transport_instance *, address_item *);
 179 extern void smtp_transport_init(transport_instance *);
 180 extern void smtp_transport_closedown(transport_instance *);
 181
 182
 183
 184 extern int     smtp_auth(uschar *, unsigned, address_item *, host_item *,
 185                  smtp_transport_options_block *, BOOL,
 186                  smtp_inblock *, smtp_outblock *);
 187 extern BOOL    smtp_mail_auth_str(uschar *, unsigned,
 188                  address_item *, smtp_transport_options_block *);
 189
 190 #ifdef SUPPORT_SOCKS
 191 extern int     socks_sock_connect(host_item *, int, int, uschar *,
 192                  transport_instance *, int);
 193 #endif
 194
 195 /* End of transports/smtp.h */