|
290
|
1
|
|
|
2 /*
|
|
|
3 * Copyright (C) Igor Sysoev
|
|
|
4 */
|
|
|
5
|
|
|
6
|
|
|
7 #ifndef _NGX_MAIL_H_INCLUDED_
|
|
|
8 #define _NGX_MAIL_H_INCLUDED_
|
|
|
9
|
|
|
10
|
|
|
11 #include <ngx_config.h>
|
|
|
12 #include <ngx_core.h>
|
|
|
13 #include <ngx_event.h>
|
|
|
14 #include <ngx_event_connect.h>
|
|
|
15
|
|
|
16 #if (NGX_MAIL_SSL)
|
|
|
17 #include <ngx_mail_ssl_module.h>
|
|
|
18 #endif
|
|
|
19
|
|
|
20
|
|
|
21
|
|
|
22 typedef struct {
|
|
|
23 void **main_conf;
|
|
|
24 void **srv_conf;
|
|
|
25 } ngx_mail_conf_ctx_t;
|
|
|
26
|
|
|
27
|
|
|
28 typedef struct {
|
|
|
29 in_addr_t addr;
|
|
|
30 in_port_t port;
|
|
|
31 int family;
|
|
|
32
|
|
|
33 /* server ctx */
|
|
|
34 ngx_mail_conf_ctx_t *ctx;
|
|
|
35
|
|
|
36 unsigned bind:1;
|
|
|
37 } ngx_mail_listen_t;
|
|
|
38
|
|
|
39
|
|
|
40 typedef struct {
|
|
|
41 in_addr_t addr;
|
|
|
42 ngx_mail_conf_ctx_t *ctx;
|
|
|
43 ngx_str_t addr_text;
|
|
|
44 } ngx_mail_in_addr_t;
|
|
|
45
|
|
|
46
|
|
|
47 typedef struct {
|
|
|
48 ngx_mail_in_addr_t *addrs; /* array of ngx_mail_in_addr_t */
|
|
|
49 ngx_uint_t naddrs;
|
|
|
50 } ngx_mail_in_port_t;
|
|
|
51
|
|
|
52
|
|
|
53 typedef struct {
|
|
|
54 in_port_t port;
|
|
|
55 ngx_array_t addrs; /* array of ngx_mail_conf_in_addr_t */
|
|
|
56 } ngx_mail_conf_in_port_t;
|
|
|
57
|
|
|
58
|
|
|
59 typedef struct {
|
|
|
60 in_addr_t addr;
|
|
|
61 ngx_mail_conf_ctx_t *ctx;
|
|
|
62 unsigned bind:1;
|
|
|
63 } ngx_mail_conf_in_addr_t;
|
|
|
64
|
|
|
65
|
|
|
66 typedef struct {
|
|
|
67 ngx_array_t servers; /* ngx_mail_core_srv_conf_t */
|
|
|
68 ngx_array_t listen; /* ngx_mail_listen_t */
|
|
|
69 } ngx_mail_core_main_conf_t;
|
|
|
70
|
|
|
71
|
|
|
72 #define NGX_MAIL_POP3_PROTOCOL 0
|
|
|
73 #define NGX_MAIL_IMAP_PROTOCOL 1
|
|
|
74 #define NGX_MAIL_SMTP_PROTOCOL 2
|
|
|
75
|
|
336
|
76
|
|
|
77 typedef struct ngx_mail_protocol_s ngx_mail_protocol_t;
|
|
|
78
|
|
290
|
79
|
|
336
|
80 typedef struct {
|
|
|
81 ngx_mail_protocol_t *protocol;
|
|
290
|
82
|
|
336
|
83 ngx_msec_t timeout;
|
|
366
|
84 ngx_msec_t resolver_timeout;
|
|
290
|
85
|
|
|
86 ngx_flag_t so_keepalive;
|
|
|
87
|
|
336
|
88 ngx_str_t server_name;
|
|
290
|
89
|
|
336
|
90 u_char *file_name;
|
|
|
91 ngx_int_t line;
|
|
290
|
92
|
|
366
|
93 ngx_resolver_t *resolver;
|
|
|
94
|
|
290
|
95 /* server ctx */
|
|
|
96 ngx_mail_conf_ctx_t *ctx;
|
|
|
97 } ngx_mail_core_srv_conf_t;
|
|
|
98
|
|
|
99
|
|
|
100 typedef enum {
|
|
|
101 ngx_pop3_start = 0,
|
|
|
102 ngx_pop3_user,
|
|
|
103 ngx_pop3_passwd,
|
|
|
104 ngx_pop3_auth_login_username,
|
|
|
105 ngx_pop3_auth_login_password,
|
|
|
106 ngx_pop3_auth_plain,
|
|
|
107 ngx_pop3_auth_cram_md5
|
|
354
|
108 } ngx_pop3_state_e;
|
|
290
|
109
|
|
|
110
|
|
|
111 typedef enum {
|
|
|
112 ngx_imap_start = 0,
|
|
322
|
113 ngx_imap_auth_login_username,
|
|
|
114 ngx_imap_auth_login_password,
|
|
|
115 ngx_imap_auth_plain,
|
|
|
116 ngx_imap_auth_cram_md5,
|
|
290
|
117 ngx_imap_login,
|
|
|
118 ngx_imap_user,
|
|
|
119 ngx_imap_passwd
|
|
|
120 } ngx_imap_state_e;
|
|
|
121
|
|
|
122
|
|
|
123 typedef enum {
|
|
|
124 ngx_smtp_start = 0,
|
|
|
125 ngx_smtp_auth_login_username,
|
|
|
126 ngx_smtp_auth_login_password,
|
|
|
127 ngx_smtp_auth_plain,
|
|
|
128 ngx_smtp_auth_cram_md5,
|
|
|
129 ngx_smtp_helo,
|
|
|
130 ngx_smtp_noxclient,
|
|
|
131 ngx_smtp_xclient
|
|
|
132 } ngx_smtp_state_e;
|
|
|
133
|
|
|
134
|
|
|
135 typedef struct {
|
|
|
136 ngx_peer_connection_t upstream;
|
|
|
137 ngx_buf_t *buffer;
|
|
|
138 } ngx_mail_proxy_ctx_t;
|
|
|
139
|
|
|
140
|
|
|
141 typedef struct {
|
|
|
142 uint32_t signature; /* "MAIL" */
|
|
|
143
|
|
|
144 ngx_connection_t *connection;
|
|
|
145
|
|
|
146 ngx_str_t out;
|
|
|
147 ngx_buf_t *buffer;
|
|
|
148
|
|
|
149 void **ctx;
|
|
|
150 void **main_conf;
|
|
|
151 void **srv_conf;
|
|
|
152
|
|
366
|
153 ngx_resolver_ctx_t *resolver_ctx;
|
|
|
154
|
|
290
|
155 ngx_mail_proxy_ctx_t *proxy;
|
|
|
156
|
|
|
157 ngx_uint_t mail_state;
|
|
|
158
|
|
336
|
159 unsigned protocol:3;
|
|
290
|
160 unsigned blocked:1;
|
|
|
161 unsigned quit:1;
|
|
|
162 unsigned quoted:1;
|
|
|
163 unsigned backslash:1;
|
|
|
164 unsigned no_sync_literal:1;
|
|
|
165 unsigned starttls:1;
|
|
|
166 unsigned esmtp:1;
|
|
386
|
167 unsigned auth_method:3;
|
|
290
|
168 unsigned auth_wait:1;
|
|
|
169
|
|
|
170 ngx_str_t login;
|
|
|
171 ngx_str_t passwd;
|
|
|
172
|
|
|
173 ngx_str_t salt;
|
|
|
174 ngx_str_t tag;
|
|
|
175 ngx_str_t tagged_line;
|
|
336
|
176 ngx_str_t text;
|
|
290
|
177
|
|
|
178 ngx_str_t *addr_text;
|
|
366
|
179 ngx_str_t host;
|
|
290
|
180 ngx_str_t smtp_helo;
|
|
|
181
|
|
|
182 ngx_uint_t command;
|
|
|
183 ngx_array_t args;
|
|
|
184
|
|
|
185 ngx_uint_t login_attempt;
|
|
|
186
|
|
336
|
187 /* used to parse POP3/IMAP/SMTP command */
|
|
290
|
188
|
|
|
189 ngx_uint_t state;
|
|
|
190 u_char *cmd_start;
|
|
|
191 u_char *arg_start;
|
|
|
192 u_char *arg_end;
|
|
|
193 ngx_uint_t literal_len;
|
|
|
194 } ngx_mail_session_t;
|
|
|
195
|
|
|
196
|
|
|
197 typedef struct {
|
|
|
198 ngx_str_t *client;
|
|
|
199 ngx_mail_session_t *session;
|
|
|
200 } ngx_mail_log_ctx_t;
|
|
|
201
|
|
|
202
|
|
322
|
203 #define NGX_POP3_USER 1
|
|
|
204 #define NGX_POP3_PASS 2
|
|
|
205 #define NGX_POP3_CAPA 3
|
|
|
206 #define NGX_POP3_QUIT 4
|
|
|
207 #define NGX_POP3_NOOP 5
|
|
|
208 #define NGX_POP3_STLS 6
|
|
|
209 #define NGX_POP3_APOP 7
|
|
|
210 #define NGX_POP3_AUTH 8
|
|
|
211 #define NGX_POP3_STAT 9
|
|
|
212 #define NGX_POP3_LIST 10
|
|
|
213 #define NGX_POP3_RETR 11
|
|
|
214 #define NGX_POP3_DELE 12
|
|
|
215 #define NGX_POP3_RSET 13
|
|
|
216 #define NGX_POP3_TOP 14
|
|
|
217 #define NGX_POP3_UIDL 15
|
|
290
|
218
|
|
|
219
|
|
322
|
220 #define NGX_IMAP_LOGIN 1
|
|
|
221 #define NGX_IMAP_LOGOUT 2
|
|
|
222 #define NGX_IMAP_CAPABILITY 3
|
|
|
223 #define NGX_IMAP_NOOP 4
|
|
|
224 #define NGX_IMAP_STARTTLS 5
|
|
290
|
225
|
|
322
|
226 #define NGX_IMAP_NEXT 6
|
|
|
227
|
|
|
228 #define NGX_IMAP_AUTHENTICATE 7
|
|
290
|
229
|
|
|
230
|
|
322
|
231 #define NGX_SMTP_HELO 1
|
|
|
232 #define NGX_SMTP_EHLO 2
|
|
|
233 #define NGX_SMTP_AUTH 3
|
|
|
234 #define NGX_SMTP_QUIT 4
|
|
|
235 #define NGX_SMTP_NOOP 5
|
|
|
236 #define NGX_SMTP_MAIL 6
|
|
|
237 #define NGX_SMTP_RSET 7
|
|
|
238 #define NGX_SMTP_RCPT 8
|
|
|
239 #define NGX_SMTP_DATA 9
|
|
|
240 #define NGX_SMTP_VRFY 10
|
|
|
241 #define NGX_SMTP_EXPN 11
|
|
|
242 #define NGX_SMTP_HELP 12
|
|
|
243 #define NGX_SMTP_STARTTLS 13
|
|
290
|
244
|
|
|
245
|
|
386
|
246 #define NGX_MAIL_AUTH_PLAIN 0
|
|
|
247 #define NGX_MAIL_AUTH_LOGIN 1
|
|
|
248 #define NGX_MAIL_AUTH_LOGIN_USERNAME 2
|
|
|
249 #define NGX_MAIL_AUTH_APOP 3
|
|
|
250 #define NGX_MAIL_AUTH_CRAM_MD5 4
|
|
290
|
251
|
|
|
252
|
|
|
253 #define NGX_MAIL_AUTH_PLAIN_ENABLED 0x0002
|
|
|
254 #define NGX_MAIL_AUTH_LOGIN_ENABLED 0x0004
|
|
|
255 #define NGX_MAIL_AUTH_APOP_ENABLED 0x0008
|
|
|
256 #define NGX_MAIL_AUTH_CRAM_MD5_ENABLED 0x0010
|
|
|
257
|
|
|
258
|
|
|
259 #define NGX_MAIL_PARSE_INVALID_COMMAND 20
|
|
|
260
|
|
|
261
|
|
336
|
262 typedef void (*ngx_mail_init_session_pt)(ngx_mail_session_t *s,
|
|
|
263 ngx_connection_t *c);
|
|
|
264 typedef void (*ngx_mail_init_protocol_pt)(ngx_event_t *rev);
|
|
|
265 typedef void (*ngx_mail_auth_state_pt)(ngx_event_t *rev);
|
|
|
266 typedef ngx_int_t (*ngx_mail_parse_command_pt)(ngx_mail_session_t *s);
|
|
|
267
|
|
|
268
|
|
|
269 struct ngx_mail_protocol_s {
|
|
|
270 ngx_str_t name;
|
|
|
271 in_port_t port[4];
|
|
|
272 ngx_uint_t type;
|
|
|
273
|
|
|
274 ngx_mail_init_session_pt init_session;
|
|
|
275 ngx_mail_init_protocol_pt init_protocol;
|
|
|
276 ngx_mail_parse_command_pt parse_command;
|
|
|
277 ngx_mail_auth_state_pt auth_state;
|
|
290
|
278
|
|
336
|
279 ngx_str_t internal_server_error;
|
|
|
280 };
|
|
|
281
|
|
|
282
|
|
|
283 typedef struct {
|
|
|
284 ngx_mail_protocol_t *protocol;
|
|
|
285
|
|
|
286 void *(*create_main_conf)(ngx_conf_t *cf);
|
|
|
287 char *(*init_main_conf)(ngx_conf_t *cf, void *conf);
|
|
|
288
|
|
|
289 void *(*create_srv_conf)(ngx_conf_t *cf);
|
|
|
290 char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev,
|
|
|
291 void *conf);
|
|
|
292 } ngx_mail_module_t;
|
|
|
293
|
|
|
294
|
|
|
295 #define NGX_MAIL_MODULE 0x4C49414D /* "MAIL" */
|
|
|
296
|
|
|
297 #define NGX_MAIL_MAIN_CONF 0x02000000
|
|
|
298 #define NGX_MAIL_SRV_CONF 0x04000000
|
|
290
|
299
|
|
|
300
|
|
|
301 #define NGX_MAIL_MAIN_CONF_OFFSET offsetof(ngx_mail_conf_ctx_t, main_conf)
|
|
|
302 #define NGX_MAIL_SRV_CONF_OFFSET offsetof(ngx_mail_conf_ctx_t, srv_conf)
|
|
|
303
|
|
|
304
|
|
|
305 #define ngx_mail_get_module_ctx(s, module) (s)->ctx[module.ctx_index]
|
|
|
306 #define ngx_mail_set_ctx(s, c, module) s->ctx[module.ctx_index] = c;
|
|
|
307 #define ngx_mail_delete_ctx(s, module) s->ctx[module.ctx_index] = NULL;
|
|
|
308
|
|
|
309
|
|
|
310 #define ngx_mail_get_module_main_conf(s, module) \
|
|
|
311 (s)->main_conf[module.ctx_index]
|
|
|
312 #define ngx_mail_get_module_srv_conf(s, module) (s)->srv_conf[module.ctx_index]
|
|
|
313
|
|
|
314 #define ngx_mail_conf_get_module_main_conf(cf, module) \
|
|
|
315 ((ngx_mail_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index]
|
|
322
|
316 #define ngx_mail_conf_get_module_srv_conf(cf, module) \
|
|
|
317 ((ngx_mail_conf_ctx_t *) cf->ctx)->srv_conf[module.ctx_index]
|
|
290
|
318
|
|
|
319
|
|
336
|
320 #if (NGX_MAIL_SSL)
|
|
|
321 void ngx_mail_starttls_handler(ngx_event_t *rev);
|
|
|
322 ngx_int_t ngx_mail_starttls_only(ngx_mail_session_t *s, ngx_connection_t *c);
|
|
|
323 #endif
|
|
|
324
|
|
|
325
|
|
290
|
326 void ngx_mail_init_connection(ngx_connection_t *c);
|
|
336
|
327
|
|
|
328 ngx_int_t ngx_mail_salt(ngx_mail_session_t *s, ngx_connection_t *c,
|
|
|
329 ngx_mail_core_srv_conf_t *cscf);
|
|
|
330 ngx_int_t ngx_mail_auth_plain(ngx_mail_session_t *s, ngx_connection_t *c,
|
|
|
331 ngx_uint_t n);
|
|
|
332 ngx_int_t ngx_mail_auth_login_username(ngx_mail_session_t *s,
|
|
386
|
333 ngx_connection_t *c, ngx_uint_t n);
|
|
336
|
334 ngx_int_t ngx_mail_auth_login_password(ngx_mail_session_t *s,
|
|
|
335 ngx_connection_t *c);
|
|
|
336 ngx_int_t ngx_mail_auth_cram_md5_salt(ngx_mail_session_t *s,
|
|
|
337 ngx_connection_t *c, char *prefix, size_t len);
|
|
|
338 ngx_int_t ngx_mail_auth_cram_md5(ngx_mail_session_t *s, ngx_connection_t *c);
|
|
|
339 ngx_int_t ngx_mail_auth_parse(ngx_mail_session_t *s, ngx_connection_t *c);
|
|
|
340
|
|
290
|
341 void ngx_mail_send(ngx_event_t *wev);
|
|
336
|
342 ngx_int_t ngx_mail_read_command(ngx_mail_session_t *s, ngx_connection_t *c);
|
|
|
343 void ngx_mail_auth(ngx_mail_session_t *s, ngx_connection_t *c);
|
|
290
|
344 void ngx_mail_close_connection(ngx_connection_t *c);
|
|
|
345 void ngx_mail_session_internal_server_error(ngx_mail_session_t *s);
|
|
336
|
346 u_char *ngx_mail_log_error(ngx_log_t *log, u_char *buf, size_t len);
|
|
290
|
347
|
|
336
|
348
|
|
|
349 char *ngx_mail_capabilities(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
|
|
290
|
350
|
|
|
351
|
|
|
352 /* STUB */
|
|
|
353 void ngx_mail_proxy_init(ngx_mail_session_t *s, ngx_peer_addr_t *peer);
|
|
|
354 void ngx_mail_auth_http_init(ngx_mail_session_t *s);
|
|
|
355 /**/
|
|
|
356
|
|
|
357
|
|
|
358 extern ngx_uint_t ngx_mail_max_module;
|
|
|
359 extern ngx_module_t ngx_mail_core_module;
|
|
|
360
|
|
|
361
|
|
|
362 #endif /* _NGX_MAIL_H_INCLUDED_ */
|
