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