Mercurial > hg > nginx
annotate src/mail/ngx_mail.h @ 1501:4d3113e06df1 stable-0.5
r1323 merge:
SMTP STARTTLS
patch by Maxim Dounin
author | Igor Sysoev <igor@sysoev.ru> |
---|---|
date | Sat, 22 Sep 2007 18:35:18 +0000 |
parents | 68f30ab68bb7 |
children | c4b2c893989d |
rev | line source |
---|---|
441
da8c5707af39
nginx-0.1.0-2004-09-28-12:34:51 import; set copyright and remove unused files
Igor Sysoev <igor@sysoev.ru>
parents:
424
diff
changeset
|
1 |
da8c5707af39
nginx-0.1.0-2004-09-28-12:34:51 import; set copyright and remove unused files
Igor Sysoev <igor@sysoev.ru>
parents:
424
diff
changeset
|
2 /* |
444
42d11f017717
nginx-0.1.0-2004-09-29-20:00:49 import; remove years from copyright
Igor Sysoev <igor@sysoev.ru>
parents:
441
diff
changeset
|
3 * Copyright (C) Igor Sysoev |
441
da8c5707af39
nginx-0.1.0-2004-09-28-12:34:51 import; set copyright and remove unused files
Igor Sysoev <igor@sysoev.ru>
parents:
424
diff
changeset
|
4 */ |
da8c5707af39
nginx-0.1.0-2004-09-28-12:34:51 import; set copyright and remove unused files
Igor Sysoev <igor@sysoev.ru>
parents:
424
diff
changeset
|
5 |
da8c5707af39
nginx-0.1.0-2004-09-28-12:34:51 import; set copyright and remove unused files
Igor Sysoev <igor@sysoev.ru>
parents:
424
diff
changeset
|
6 |
1136 | 7 #ifndef _NGX_MAIL_H_INCLUDED_ |
8 #define _NGX_MAIL_H_INCLUDED_ | |
417
0526206251f6
nginx-0.0.10-2004-09-07-19:29:22 import
Igor Sysoev <igor@sysoev.ru>
parents:
diff
changeset
|
9 |
0526206251f6
nginx-0.0.10-2004-09-07-19:29:22 import
Igor Sysoev <igor@sysoev.ru>
parents:
diff
changeset
|
10 |
0526206251f6
nginx-0.0.10-2004-09-07-19:29:22 import
Igor Sysoev <igor@sysoev.ru>
parents:
diff
changeset
|
11 #include <ngx_config.h> |
0526206251f6
nginx-0.0.10-2004-09-07-19:29:22 import
Igor Sysoev <igor@sysoev.ru>
parents:
diff
changeset
|
12 #include <ngx_core.h> |
419
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
13 #include <ngx_event.h> |
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
14 #include <ngx_event_connect.h> |
417
0526206251f6
nginx-0.0.10-2004-09-07-19:29:22 import
Igor Sysoev <igor@sysoev.ru>
parents:
diff
changeset
|
15 |
1136 | 16 #if (NGX_MAIL_SSL) |
17 #include <ngx_mail_ssl_module.h> | |
539 | 18 #endif |
19 | |
20 | |
417
0526206251f6
nginx-0.0.10-2004-09-07-19:29:22 import
Igor Sysoev <igor@sysoev.ru>
parents:
diff
changeset
|
21 |
0526206251f6
nginx-0.0.10-2004-09-07-19:29:22 import
Igor Sysoev <igor@sysoev.ru>
parents:
diff
changeset
|
22 typedef struct { |
583 | 23 void **main_conf; |
24 void **srv_conf; | |
1136 | 25 } ngx_mail_conf_ctx_t; |
521 | 26 |
27 | |
28 typedef struct { | |
641 | 29 in_addr_t addr; |
30 in_port_t port; | |
31 int family; | |
32 | |
33 /* server ctx */ | |
1136 | 34 ngx_mail_conf_ctx_t *ctx; |
641 | 35 |
36 unsigned bind:1; | |
1136 | 37 } ngx_mail_listen_t; |
641 | 38 |
39 | |
40 typedef struct { | |
41 in_addr_t addr; | |
1136 | 42 ngx_mail_conf_ctx_t *ctx; |
641 | 43 ngx_str_t addr_text; |
1136 | 44 } ngx_mail_in_addr_t; |
641 | 45 |
46 | |
47 typedef struct { | |
1136 | 48 ngx_mail_in_addr_t *addrs; /* array of ngx_mail_in_addr_t */ |
641 | 49 ngx_uint_t naddrs; |
1136 | 50 } ngx_mail_in_port_t; |
641 | 51 |
52 | |
53 typedef struct { | |
54 in_port_t port; | |
1136 | 55 ngx_array_t addrs; /* array of ngx_mail_conf_in_addr_t */ |
56 } ngx_mail_conf_in_port_t; | |
641 | 57 |
58 | |
59 typedef struct { | |
60 in_addr_t addr; | |
1136 | 61 ngx_mail_conf_ctx_t *ctx; |
641 | 62 unsigned bind:1; |
1136 | 63 } ngx_mail_conf_in_addr_t; |
641 | 64 |
65 | |
66 typedef struct { | |
1136 | 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; | |
521 | 70 |
71 | |
1136 | 72 #define NGX_MAIL_POP3_PROTOCOL 0 |
73 #define NGX_MAIL_IMAP_PROTOCOL 1 | |
74 #define NGX_MAIL_SMTP_PROTOCOL 2 | |
521 | 75 |
76 typedef struct { | |
583 | 77 ngx_msec_t timeout; |
418
cf072d26d6d6
nginx-0.0.10-2004-09-08-09:18:51 import
Igor Sysoev <igor@sysoev.ru>
parents:
417
diff
changeset
|
78 |
583 | 79 size_t imap_client_buffer_size; |
521 | 80 |
583 | 81 ngx_uint_t protocol; |
521 | 82 |
587 | 83 ngx_flag_t so_keepalive; |
84 | |
583 | 85 ngx_str_t pop3_capability; |
86 ngx_str_t pop3_starttls_capability; | |
1136 | 87 ngx_str_t pop3_starttls_only_capability; |
809 | 88 ngx_str_t pop3_auth_capability; |
89 | |
583 | 90 ngx_str_t imap_capability; |
91 ngx_str_t imap_starttls_capability; | |
92 ngx_str_t imap_starttls_only_capability; | |
527 | 93 |
1136 | 94 ngx_str_t smtp_capability; |
1501 | 95 ngx_str_t smtp_starttls_capability; |
96 ngx_str_t smtp_starttls_only_capability; | |
800 | 97 |
1136 | 98 ngx_str_t server_name; |
99 ngx_str_t smtp_server_name; | |
100 ngx_str_t smtp_greeting; | |
101 | |
102 ngx_uint_t pop3_auth_methods; | |
103 ngx_uint_t smtp_auth_methods; | |
800 | 104 |
583 | 105 ngx_array_t pop3_capabilities; |
106 ngx_array_t imap_capabilities; | |
1136 | 107 ngx_array_t smtp_capabilities; |
527 | 108 |
521 | 109 /* server ctx */ |
1136 | 110 ngx_mail_conf_ctx_t *ctx; |
111 } ngx_mail_core_srv_conf_t; | |
521 | 112 |
113 | |
114 typedef struct { | |
583 | 115 void *(*create_main_conf)(ngx_conf_t *cf); |
116 char *(*init_main_conf)(ngx_conf_t *cf, void *conf); | |
521 | 117 |
583 | 118 void *(*create_srv_conf)(ngx_conf_t *cf); |
119 char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, | |
120 void *conf); | |
1136 | 121 } ngx_mail_module_t; |
527 | 122 |
123 | |
124 typedef enum { | |
421
01456a419cf9
nginx-0.0.10-2004-09-10-18:32:02 import
Igor Sysoev <igor@sysoev.ru>
parents:
419
diff
changeset
|
125 ngx_pop3_start = 0, |
527 | 126 ngx_pop3_user, |
809 | 127 ngx_pop3_passwd, |
128 ngx_pop3_auth_login_username, | |
129 ngx_pop3_auth_login_password, | |
130 ngx_pop3_auth_plain, | |
131 ngx_pop3_auth_cram_md5 | |
527 | 132 } ngx_po3_state_e; |
421
01456a419cf9
nginx-0.0.10-2004-09-10-18:32:02 import
Igor Sysoev <igor@sysoev.ru>
parents:
419
diff
changeset
|
133 |
01456a419cf9
nginx-0.0.10-2004-09-10-18:32:02 import
Igor Sysoev <igor@sysoev.ru>
parents:
419
diff
changeset
|
134 |
1136 | 135 typedef enum { |
136 ngx_imap_start = 0, | |
137 ngx_imap_login, | |
138 ngx_imap_user, | |
139 ngx_imap_passwd | |
140 } ngx_imap_state_e; | |
141 | |
142 | |
143 typedef enum { | |
144 ngx_smtp_start = 0, | |
145 ngx_smtp_auth_login_username, | |
146 ngx_smtp_auth_login_password, | |
147 ngx_smtp_auth_plain, | |
148 ngx_smtp_auth_cram_md5, | |
149 ngx_smtp_helo, | |
150 ngx_smtp_noxclient, | |
151 ngx_smtp_xclient | |
152 } ngx_smtp_state_e; | |
153 | |
154 | |
418
cf072d26d6d6
nginx-0.0.10-2004-09-08-09:18:51 import
Igor Sysoev <igor@sysoev.ru>
parents:
417
diff
changeset
|
155 typedef struct { |
521 | 156 ngx_peer_connection_t upstream; |
157 ngx_buf_t *buffer; | |
1136 | 158 } ngx_mail_proxy_ctx_t; |
521 | 159 |
160 | |
161 typedef struct { | |
1136 | 162 uint32_t signature; /* "MAIL" */ |
419
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
163 |
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
164 ngx_connection_t *connection; |
521 | 165 |
539 | 166 ngx_str_t out; |
419
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
167 ngx_buf_t *buffer; |
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
168 |
521 | 169 void **ctx; |
170 void **main_conf; | |
171 void **srv_conf; | |
172 | |
1136 | 173 ngx_mail_proxy_ctx_t *proxy; |
521 | 174 |
1136 | 175 ngx_uint_t mail_state; |
421
01456a419cf9
nginx-0.0.10-2004-09-10-18:32:02 import
Igor Sysoev <igor@sysoev.ru>
parents:
419
diff
changeset
|
176 |
539 | 177 unsigned blocked:1; |
178 unsigned quit:1; | |
1136 | 179 unsigned protocol:2; |
527 | 180 unsigned quoted:1; |
543 | 181 unsigned backslash:1; |
182 unsigned no_sync_literal:1; | |
641 | 183 unsigned starttls:1; |
1136 | 184 unsigned esmtp:1; |
809 | 185 unsigned auth_method:2; |
883 | 186 unsigned auth_wait:1; |
418
cf072d26d6d6
nginx-0.0.10-2004-09-08-09:18:51 import
Igor Sysoev <igor@sysoev.ru>
parents:
417
diff
changeset
|
187 |
422
edaefb2a20fc
nginx-0.0.10-2004-09-12-00:22:11 import
Igor Sysoev <igor@sysoev.ru>
parents:
421
diff
changeset
|
188 ngx_str_t login; |
edaefb2a20fc
nginx-0.0.10-2004-09-12-00:22:11 import
Igor Sysoev <igor@sysoev.ru>
parents:
421
diff
changeset
|
189 ngx_str_t passwd; |
edaefb2a20fc
nginx-0.0.10-2004-09-12-00:22:11 import
Igor Sysoev <igor@sysoev.ru>
parents:
421
diff
changeset
|
190 |
800 | 191 ngx_str_t salt; |
527 | 192 ngx_str_t tag; |
539 | 193 ngx_str_t tagged_line; |
527 | 194 |
641 | 195 ngx_str_t *addr_text; |
1136 | 196 ngx_str_t smtp_helo; |
641 | 197 |
419
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
198 ngx_uint_t command; |
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
199 ngx_array_t args; |
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
200 |
527 | 201 ngx_uint_t login_attempt; |
202 | |
1136 | 203 /* used to parse IMAP/POP3/SMTP command */ |
419
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
204 |
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
205 ngx_uint_t state; |
527 | 206 u_char *cmd_start; |
419
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
207 u_char *arg_start; |
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
208 u_char *arg_end; |
527 | 209 ngx_uint_t literal_len; |
1136 | 210 } ngx_mail_session_t; |
418
cf072d26d6d6
nginx-0.0.10-2004-09-08-09:18:51 import
Igor Sysoev <igor@sysoev.ru>
parents:
417
diff
changeset
|
211 |
cf072d26d6d6
nginx-0.0.10-2004-09-08-09:18:51 import
Igor Sysoev <igor@sysoev.ru>
parents:
417
diff
changeset
|
212 |
541 | 213 typedef struct { |
583 | 214 ngx_str_t *client; |
1136 | 215 ngx_mail_session_t *session; |
216 } ngx_mail_log_ctx_t; | |
541 | 217 |
218 | |
800 | 219 #define NGX_POP3_USER 1 |
220 #define NGX_POP3_PASS 2 | |
221 #define NGX_POP3_CAPA 3 | |
222 #define NGX_POP3_QUIT 4 | |
223 #define NGX_POP3_NOOP 5 | |
224 #define NGX_POP3_STLS 6 | |
225 #define NGX_POP3_APOP 7 | |
809 | 226 #define NGX_POP3_AUTH 8 |
227 #define NGX_POP3_STAT 9 | |
228 #define NGX_POP3_LIST 10 | |
229 #define NGX_POP3_RETR 11 | |
230 #define NGX_POP3_DELE 12 | |
231 #define NGX_POP3_RSET 13 | |
232 #define NGX_POP3_TOP 14 | |
233 #define NGX_POP3_UIDL 15 | |
419
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
234 |
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
235 |
800 | 236 #define NGX_IMAP_LOGIN 1 |
237 #define NGX_IMAP_LOGOUT 2 | |
238 #define NGX_IMAP_CAPABILITY 3 | |
239 #define NGX_IMAP_NOOP 4 | |
240 #define NGX_IMAP_STARTTLS 5 | |
241 | |
242 #define NGX_IMAP_NEXT 6 | |
527 | 243 |
800 | 244 |
1136 | 245 #define NGX_SMTP_HELO 1 |
246 #define NGX_SMTP_EHLO 2 | |
247 #define NGX_SMTP_AUTH 3 | |
248 #define NGX_SMTP_QUIT 4 | |
249 #define NGX_SMTP_NOOP 5 | |
250 #define NGX_SMTP_MAIL 6 | |
251 #define NGX_SMTP_RSET 7 | |
1501 | 252 #define NGX_SMTP_RCPT 8 |
253 #define NGX_SMTP_DATA 9 | |
254 #define NGX_SMTP_VRFY 10 | |
255 #define NGX_SMTP_EXPN 11 | |
256 #define NGX_SMTP_HELP 12 | |
257 #define NGX_SMTP_STARTTLS 13 | |
527 | 258 |
259 | |
1136 | 260 #define NGX_MAIL_AUTH_PLAIN 0 |
261 #define NGX_MAIL_AUTH_LOGIN 1 | |
262 #define NGX_MAIL_AUTH_APOP 2 | |
263 #define NGX_MAIL_AUTH_CRAM_MD5 3 | |
419
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
264 |
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
265 |
1136 | 266 #define NGX_MAIL_AUTH_PLAIN_ENABLED 0x0002 |
267 #define NGX_MAIL_AUTH_LOGIN_ENABLED 0x0004 | |
268 #define NGX_MAIL_AUTH_APOP_ENABLED 0x0008 | |
269 #define NGX_MAIL_AUTH_CRAM_MD5_ENABLED 0x0010 | |
521 | 270 |
271 | |
1136 | 272 #define NGX_MAIL_PARSE_INVALID_COMMAND 20 |
521 | 273 |
274 | |
1136 | 275 #define NGX_MAIL_MODULE 0x4C49414D /* "MAIL" */ |
276 | |
277 #define NGX_MAIL_MAIN_CONF 0x02000000 | |
278 #define NGX_MAIL_SRV_CONF 0x04000000 | |
279 | |
280 | |
281 #define NGX_MAIL_MAIN_CONF_OFFSET offsetof(ngx_mail_conf_ctx_t, main_conf) | |
282 #define NGX_MAIL_SRV_CONF_OFFSET offsetof(ngx_mail_conf_ctx_t, srv_conf) | |
283 | |
284 | |
285 #define ngx_mail_get_module_ctx(s, module) (s)->ctx[module.ctx_index] | |
286 #define ngx_mail_set_ctx(s, c, module) s->ctx[module.ctx_index] = c; | |
287 #define ngx_mail_delete_ctx(s, module) s->ctx[module.ctx_index] = NULL; | |
521 | 288 |
289 | |
1136 | 290 #define ngx_mail_get_module_main_conf(s, module) \ |
521 | 291 (s)->main_conf[module.ctx_index] |
1136 | 292 #define ngx_mail_get_module_srv_conf(s, module) (s)->srv_conf[module.ctx_index] |
423
fda5987b188d
nginx-0.0.10-2004-09-13-20:18:09 import
Igor Sysoev <igor@sysoev.ru>
parents:
422
diff
changeset
|
293 |
1136 | 294 #define ngx_mail_conf_get_module_main_conf(cf, module) \ |
295 ((ngx_mail_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index] | |
1501 | 296 #define ngx_mail_conf_get_module_srv_conf(cf, module) \ |
297 ((ngx_mail_conf_ctx_t *) cf->ctx)->srv_conf[module.ctx_index] | |
641 | 298 |
423
fda5987b188d
nginx-0.0.10-2004-09-13-20:18:09 import
Igor Sysoev <igor@sysoev.ru>
parents:
422
diff
changeset
|
299 |
1136 | 300 void ngx_mail_init_connection(ngx_connection_t *c); |
301 void ngx_mail_send(ngx_event_t *wev); | |
527 | 302 void ngx_pop3_auth_state(ngx_event_t *rev); |
1136 | 303 void ngx_imap_auth_state(ngx_event_t *rev); |
304 void ngx_smtp_auth_state(ngx_event_t *rev); | |
305 void ngx_mail_close_connection(ngx_connection_t *c); | |
306 void ngx_mail_session_internal_server_error(ngx_mail_session_t *s); | |
417
0526206251f6
nginx-0.0.10-2004-09-07-19:29:22 import
Igor Sysoev <igor@sysoev.ru>
parents:
diff
changeset
|
307 |
1136 | 308 ngx_int_t ngx_pop3_parse_command(ngx_mail_session_t *s); |
309 ngx_int_t ngx_imap_parse_command(ngx_mail_session_t *s); | |
310 ngx_int_t ngx_smtp_parse_command(ngx_mail_session_t *s); | |
419
47709bff4468
nginx-0.0.10-2004-09-09-19:40:48 import
Igor Sysoev <igor@sysoev.ru>
parents:
418
diff
changeset
|
311 |
417
0526206251f6
nginx-0.0.10-2004-09-07-19:29:22 import
Igor Sysoev <igor@sysoev.ru>
parents:
diff
changeset
|
312 |
521 | 313 /* STUB */ |
1136 | 314 void ngx_mail_proxy_init(ngx_mail_session_t *s, ngx_peer_addr_t *peer); |
315 void ngx_mail_auth_http_init(ngx_mail_session_t *s); | |
521 | 316 /**/ |
317 | |
318 | |
1136 | 319 extern ngx_uint_t ngx_mail_max_module; |
320 extern ngx_module_t ngx_mail_core_module; | |
521 | 321 |
322 | |
1136 | 323 #endif /* _NGX_MAIL_H_INCLUDED_ */ |