33c5aaf036a1f2454301f26266bbcba921946c07
[exim.git] / 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 EXPERIMENTAL_DANE
33 uschar *hosts_try_dane;
34 uschar *hosts_require_dane;
35 #endif
36 uschar *hosts_try_fastopen;
37 #ifndef DISABLE_PRDR
38 uschar *hosts_try_prdr;
39 #endif
40 #ifndef DISABLE_OCSP
41 uschar *hosts_request_ocsp;
42 uschar *hosts_require_ocsp;
43 #endif
44 uschar *hosts_require_tls;
45 uschar *hosts_avoid_tls;
46 uschar *hosts_verify_avoid_tls;
47 uschar *hosts_avoid_pipelining;
48 uschar *hosts_avoid_esmtp;
49 #ifdef SUPPORT_TLS
50 uschar *hosts_nopass_tls;
51 uschar *hosts_noproxy_tls;
52 #endif
53 int command_timeout;
54 int connect_timeout;
55 int data_timeout;
56 int final_timeout;
57 int size_addition;
58 int hosts_max_try;
59 int hosts_max_try_hardlimit;
60 BOOL address_retry_include_sender;
61 BOOL allow_localhost;
62 BOOL authenticated_sender_force;
63 BOOL gethostbyname;
64 BOOL dns_qualify_single;
65 BOOL dns_search_parents;
66 dnssec_domains dnssec;
67 BOOL delay_after_cutoff;
68 BOOL hosts_override;
69 BOOL hosts_randomize;
70 BOOL keepalive;
71 BOOL lmtp_ignore_quota;
72 uschar *expand_retry_include_ip_address;
73 BOOL retry_include_ip_address;
74 #ifdef SUPPORT_SOCKS
75 uschar *socks_proxy;
76 #endif
77 #ifdef SUPPORT_TLS
78 uschar *tls_certificate;
79 uschar *tls_crl;
80 uschar *tls_privatekey;
81 uschar *tls_require_ciphers;
82 uschar *tls_sni;
83 uschar *tls_verify_certificates;
84 int tls_dh_min_bits;
85 BOOL tls_tempfail_tryclear;
86 uschar *tls_verify_hosts;
87 uschar *tls_try_verify_hosts;
88 uschar *tls_verify_cert_hostnames;
89 #endif
90 #ifndef DISABLE_DKIM
91 struct ob_dkim dkim;
92 #endif
93 } smtp_transport_options_block;
94
95 /* smtp connect context */
96 typedef struct {
97 uschar * from_addr;
98 address_item * addrlist;
99 host_item * host;
100 int host_af;
101 int port;
102 uschar * interface;
103
104 BOOL verify:1;
105 BOOL lmtp:1;
106 BOOL smtps:1;
107 BOOL ok:1;
108 BOOL setting_up:1;
109 BOOL esmtp:1;
110 BOOL esmtp_sent:1;
111 #ifndef DISABLE_PRDR
112 BOOL prdr_active:1;
113 #endif
114 #ifdef SUPPORT_I18N
115 BOOL utf8_needed:1;
116 #endif
117 BOOL dsn_all_lasthop:1;
118 #if defined(SUPPORT_TLS) && defined(EXPERIMENTAL_DANE)
119 BOOL dane:1;
120 BOOL dane_required:1;
121 #endif
122 BOOL pending_MAIL:1;
123 BOOL pending_BDAT:1;
124 BOOL good_RCPT:1;
125 BOOL completed_addr:1;
126 BOOL send_rset:1;
127 BOOL send_quit:1;
128
129 int max_rcpt;
130 int cmd_count;
131
132 uschar peer_offered;
133 uschar avoid_option;
134 uschar * igquotstr;
135 uschar * helo_data;
136 #ifdef EXPERIMENTAL_DSN_INFO
137 uschar * smtp_greeting;
138 uschar * helo_response;
139 #endif
140
141 address_item * first_addr;
142 address_item * next_addr;
143 address_item * sync_addr;
144
145 smtp_inblock inblock;
146 smtp_outblock outblock;
147 uschar buffer[DELIVER_BUFFER_SIZE];
148 uschar inbuffer[4096];
149 uschar outbuffer[4096];
150
151 transport_instance * tblock;
152 smtp_transport_options_block * ob;
153 } smtp_context;
154
155 extern int smtp_setup_conn(smtp_context *, BOOL);
156 extern int smtp_write_mail_and_rcpt_cmds(smtp_context *, int *);
157
158
159 /* Data for reading the private options. */
160
161 extern optionlist smtp_transport_options[];
162 extern int smtp_transport_options_count;
163
164 /* Block containing default values. */
165
166 extern smtp_transport_options_block smtp_transport_option_defaults;
167
168 /* The main, init, and closedown entry points for the transport */
169
170 extern BOOL smtp_transport_entry(transport_instance *, address_item *);
171 extern void smtp_transport_init(transport_instance *);
172 extern void smtp_transport_closedown(transport_instance *);
173
174
175
176 extern int smtp_auth(uschar *, unsigned, address_item *, host_item *,
177 smtp_transport_options_block *, BOOL,
178 smtp_inblock *, smtp_outblock *);
179 extern BOOL smtp_mail_auth_str(uschar *, unsigned,
180 address_item *, smtp_transport_options_block *);
181
182 #ifdef SUPPORT_SOCKS
183 extern int socks_sock_connect(host_item *, int, int, uschar *,
184 transport_instance *, int);
185 #endif
186
187 /* End of transports/smtp.h */