Mercurial > hg > nginx-mail
annotate src/mail/ngx_mail.h @ 409:52b28d322d76
Merge with nginx 0.6.12.
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Mon, 11 Aug 2008 21:22:47 +0400 |
parents | 481e8f936572 1c519aff5c0c |
children | cd9cb7a3ff9e |
rev | line source |
---|---|
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; |
290 | 84 |
85 ngx_flag_t so_keepalive; | |
86 | |
336 | 87 ngx_str_t server_name; |
290 | 88 |
336 | 89 u_char *file_name; |
90 ngx_int_t line; | |
290 | 91 |
92 /* server ctx */ | |
93 ngx_mail_conf_ctx_t *ctx; | |
94 } ngx_mail_core_srv_conf_t; | |
95 | |
96 | |
97 typedef enum { | |
98 ngx_pop3_start = 0, | |
99 ngx_pop3_user, | |
100 ngx_pop3_passwd, | |
101 ngx_pop3_auth_login_username, | |
102 ngx_pop3_auth_login_password, | |
103 ngx_pop3_auth_plain, | |
104 ngx_pop3_auth_cram_md5 | |
105 } ngx_po3_state_e; | |
106 | |
107 | |
108 typedef enum { | |
109 ngx_imap_start = 0, | |
322 | 110 ngx_imap_auth_login_username, |
111 ngx_imap_auth_login_password, | |
112 ngx_imap_auth_plain, | |
113 ngx_imap_auth_cram_md5, | |
290 | 114 ngx_imap_login, |
115 ngx_imap_user, | |
116 ngx_imap_passwd | |
117 } ngx_imap_state_e; | |
118 | |
119 | |
120 typedef enum { | |
121 ngx_smtp_start = 0, | |
122 ngx_smtp_auth_login_username, | |
123 ngx_smtp_auth_login_password, | |
124 ngx_smtp_auth_plain, | |
125 ngx_smtp_auth_cram_md5, | |
126 ngx_smtp_helo, | |
404
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
127 ngx_smtp_helo_xclient, |
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
128 ngx_smtp_helo_from, |
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
129 ngx_smtp_xclient, |
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
130 ngx_smtp_xclient_from, |
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
131 ngx_smtp_from, |
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
132 ngx_smtp_to |
290 | 133 } ngx_smtp_state_e; |
134 | |
135 | |
136 typedef struct { | |
137 ngx_peer_connection_t upstream; | |
138 ngx_buf_t *buffer; | |
139 } ngx_mail_proxy_ctx_t; | |
140 | |
141 | |
142 typedef struct { | |
143 uint32_t signature; /* "MAIL" */ | |
144 | |
145 ngx_connection_t *connection; | |
146 | |
147 ngx_str_t out; | |
148 ngx_buf_t *buffer; | |
149 | |
150 void **ctx; | |
151 void **main_conf; | |
152 void **srv_conf; | |
153 | |
154 ngx_mail_proxy_ctx_t *proxy; | |
155 | |
156 ngx_uint_t mail_state; | |
157 | |
336 | 158 unsigned protocol:3; |
290 | 159 unsigned blocked:1; |
160 unsigned quit:1; | |
161 unsigned quoted:1; | |
162 unsigned backslash:1; | |
163 unsigned no_sync_literal:1; | |
164 unsigned starttls:1; | |
165 unsigned esmtp:1; | |
404
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
166 unsigned auth_method:3; |
290 | 167 unsigned auth_wait:1; |
168 | |
169 ngx_str_t login; | |
170 ngx_str_t passwd; | |
171 | |
172 ngx_str_t salt; | |
173 ngx_str_t tag; | |
174 ngx_str_t tagged_line; | |
336 | 175 ngx_str_t text; |
290 | 176 |
177 ngx_str_t *addr_text; | |
178 ngx_str_t smtp_helo; | |
404
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
179 ngx_str_t smtp_from; |
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
180 ngx_str_t smtp_to; |
290 | 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 | |
246 #define NGX_MAIL_AUTH_PLAIN 0 | |
247 #define NGX_MAIL_AUTH_LOGIN 1 | |
248 #define NGX_MAIL_AUTH_APOP 2 | |
249 #define NGX_MAIL_AUTH_CRAM_MD5 3 | |
404
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
250 #define NGX_MAIL_AUTH_NONE 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 | |
404
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
257 #define NGX_MAIL_AUTH_NONE_ENABLED 0x0020 |
290 | 258 |
259 | |
260 #define NGX_MAIL_PARSE_INVALID_COMMAND 20 | |
261 | |
262 | |
336 | 263 typedef void (*ngx_mail_init_session_pt)(ngx_mail_session_t *s, |
264 ngx_connection_t *c); | |
265 typedef void (*ngx_mail_init_protocol_pt)(ngx_event_t *rev); | |
266 typedef void (*ngx_mail_auth_state_pt)(ngx_event_t *rev); | |
267 typedef ngx_int_t (*ngx_mail_parse_command_pt)(ngx_mail_session_t *s); | |
268 | |
269 | |
270 struct ngx_mail_protocol_s { | |
271 ngx_str_t name; | |
272 in_port_t port[4]; | |
273 ngx_uint_t type; | |
274 | |
275 ngx_mail_init_session_pt init_session; | |
276 ngx_mail_init_protocol_pt init_protocol; | |
277 ngx_mail_parse_command_pt parse_command; | |
278 ngx_mail_auth_state_pt auth_state; | |
290 | 279 |
336 | 280 ngx_str_t internal_server_error; |
281 }; | |
282 | |
283 | |
284 typedef struct { | |
285 ngx_mail_protocol_t *protocol; | |
286 | |
287 void *(*create_main_conf)(ngx_conf_t *cf); | |
288 char *(*init_main_conf)(ngx_conf_t *cf, void *conf); | |
289 | |
290 void *(*create_srv_conf)(ngx_conf_t *cf); | |
291 char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, | |
292 void *conf); | |
293 } ngx_mail_module_t; | |
294 | |
295 | |
296 #define NGX_MAIL_MODULE 0x4C49414D /* "MAIL" */ | |
297 | |
298 #define NGX_MAIL_MAIN_CONF 0x02000000 | |
299 #define NGX_MAIL_SRV_CONF 0x04000000 | |
290 | 300 |
301 | |
302 #define NGX_MAIL_MAIN_CONF_OFFSET offsetof(ngx_mail_conf_ctx_t, main_conf) | |
303 #define NGX_MAIL_SRV_CONF_OFFSET offsetof(ngx_mail_conf_ctx_t, srv_conf) | |
304 | |
305 | |
306 #define ngx_mail_get_module_ctx(s, module) (s)->ctx[module.ctx_index] | |
307 #define ngx_mail_set_ctx(s, c, module) s->ctx[module.ctx_index] = c; | |
308 #define ngx_mail_delete_ctx(s, module) s->ctx[module.ctx_index] = NULL; | |
309 | |
310 | |
311 #define ngx_mail_get_module_main_conf(s, module) \ | |
312 (s)->main_conf[module.ctx_index] | |
313 #define ngx_mail_get_module_srv_conf(s, module) (s)->srv_conf[module.ctx_index] | |
314 | |
315 #define ngx_mail_conf_get_module_main_conf(cf, module) \ | |
316 ((ngx_mail_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index] | |
322 | 317 #define ngx_mail_conf_get_module_srv_conf(cf, module) \ |
318 ((ngx_mail_conf_ctx_t *) cf->ctx)->srv_conf[module.ctx_index] | |
290 | 319 |
320 | |
336 | 321 #if (NGX_MAIL_SSL) |
322 void ngx_mail_starttls_handler(ngx_event_t *rev); | |
323 ngx_int_t ngx_mail_starttls_only(ngx_mail_session_t *s, ngx_connection_t *c); | |
324 #endif | |
325 | |
326 | |
290 | 327 void ngx_mail_init_connection(ngx_connection_t *c); |
336 | 328 |
329 ngx_int_t ngx_mail_salt(ngx_mail_session_t *s, ngx_connection_t *c, | |
330 ngx_mail_core_srv_conf_t *cscf); | |
331 ngx_int_t ngx_mail_auth_plain(ngx_mail_session_t *s, ngx_connection_t *c, | |
332 ngx_uint_t n); | |
333 ngx_int_t ngx_mail_auth_login_username(ngx_mail_session_t *s, | |
334 ngx_connection_t *c); | |
335 ngx_int_t ngx_mail_auth_login_password(ngx_mail_session_t *s, | |
336 ngx_connection_t *c); | |
337 ngx_int_t ngx_mail_auth_cram_md5_salt(ngx_mail_session_t *s, | |
338 ngx_connection_t *c, char *prefix, size_t len); | |
339 ngx_int_t ngx_mail_auth_cram_md5(ngx_mail_session_t *s, ngx_connection_t *c); | |
340 ngx_int_t ngx_mail_auth_parse(ngx_mail_session_t *s, ngx_connection_t *c); | |
341 | |
290 | 342 void ngx_mail_send(ngx_event_t *wev); |
336 | 343 ngx_int_t ngx_mail_read_command(ngx_mail_session_t *s, ngx_connection_t *c); |
344 void ngx_mail_auth(ngx_mail_session_t *s, ngx_connection_t *c); | |
290 | 345 void ngx_mail_close_connection(ngx_connection_t *c); |
346 void ngx_mail_session_internal_server_error(ngx_mail_session_t *s); | |
336 | 347 u_char *ngx_mail_log_error(ngx_log_t *log, u_char *buf, size_t len); |
290 | 348 |
336 | 349 |
350 char *ngx_mail_capabilities(ngx_conf_t *cf, ngx_command_t *cmd, void *conf); | |
290 | 351 |
404
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
352 #if (NGX_MAIL_SSL) |
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
353 void ngx_mail_starttls_handler(ngx_event_t *rev); |
481e8f936572
Mail: rename "unauth" to "none".
Maxim Dounin <mdounin@mdounin.ru>
parents:
403
diff
changeset
|
354 #endif |
290 | 355 |
356 /* STUB */ | |
357 void ngx_mail_proxy_init(ngx_mail_session_t *s, ngx_peer_addr_t *peer); | |
358 void ngx_mail_auth_http_init(ngx_mail_session_t *s); | |
359 /**/ | |
360 | |
361 | |
362 extern ngx_uint_t ngx_mail_max_module; | |
363 extern ngx_module_t ngx_mail_core_module; | |
364 | |
365 | |
366 #endif /* _NGX_MAIL_H_INCLUDED_ */ |