3 * Copyright (C) Igor Sysoev
7 #include <ngx_config.h>
11 #include <ngx_mail_smtp_module.h>
14 static void ngx_mail_smtp_resolve_addr_handler(ngx_resolver_ctx_t *ctx);
15 static void ngx_mail_smtp_resolve_name(ngx_event_t *rev);
16 static void ngx_mail_smtp_resolve_name_handler(ngx_resolver_ctx_t *ctx);
17 static void ngx_mail_smtp_greeting(ngx_mail_session_t *s, ngx_connection_t *c);
18 static void ngx_mail_smtp_invalid_pipelining(ngx_event_t *rev);
19 static ngx_int_t ngx_mail_smtp_create_buffer(ngx_mail_session_t *s,
22 static ngx_int_t ngx_mail_smtp_helo(ngx_mail_session_t *s, ngx_connection_t *c);
23 static ngx_int_t ngx_mail_smtp_auth(ngx_mail_session_t *s, ngx_connection_t *c);
24 static ngx_int_t ngx_mail_smtp_mail(ngx_mail_session_t *s, ngx_connection_t *c);
25 static ngx_int_t ngx_mail_smtp_starttls(ngx_mail_session_t *s,
27 static ngx_int_t ngx_mail_smtp_rset(ngx_mail_session_t *s, ngx_connection_t *c);
28 static ngx_int_t ngx_mail_smtp_rcpt(ngx_mail_session_t *s, ngx_connection_t *c);
30 static ngx_int_t ngx_mail_smtp_discard_command(ngx_mail_session_t *s,
31 ngx_connection_t *c, char *err);
32 static void ngx_mail_smtp_log_rejected_command(ngx_mail_session_t *s,
33 ngx_connection_t *c, char *err);
36 static u_char smtp_ok[] = "250 2.0.0 OK" CRLF;
37 static u_char smtp_bye[] = "221 2.0.0 Bye" CRLF;
38 static u_char smtp_starttls[] = "220 2.0.0 Start TLS" CRLF;
39 static u_char smtp_next[] = "334 " CRLF;
40 static u_char smtp_username[] = "334 VXNlcm5hbWU6" CRLF;
41 static u_char smtp_password[] = "334 UGFzc3dvcmQ6" CRLF;
42 static u_char smtp_invalid_command[] = "500 5.5.1 Invalid command" CRLF;
43 static u_char smtp_invalid_pipelining[] =
44 "503 5.5.0 Improper use of SMTP command pipelining" CRLF;
45 static u_char smtp_invalid_argument[] = "501 5.5.4 Invalid argument" CRLF;
46 static u_char smtp_auth_required[] = "530 5.7.1 Authentication required" CRLF;
47 static u_char smtp_bad_sequence[] = "503 5.5.1 Bad sequence of commands" CRLF;
50 static ngx_str_t smtp_unavailable = ngx_string("[UNAVAILABLE]");
51 static ngx_str_t smtp_tempunavail = ngx_string("[TEMPUNAVAIL]");
55 ngx_mail_smtp_init_session(ngx_mail_session_t *s, ngx_connection_t *c)
57 struct sockaddr_in *sin;
58 ngx_resolver_ctx_t *ctx;
59 ngx_mail_core_srv_conf_t *cscf;
61 cscf = ngx_mail_get_module_srv_conf(s, ngx_mail_core_module);
63 if (cscf->resolver == NULL) {
64 s->host = smtp_unavailable;
65 ngx_mail_smtp_greeting(s, c);
69 c->log->action = "in resolving client address";
71 ctx = ngx_resolve_start(cscf->resolver, NULL);
73 ngx_mail_close_connection(c);
79 sin = (struct sockaddr_in *) c->sockaddr;
81 ctx->addr = sin->sin_addr.s_addr;
82 ctx->handler = ngx_mail_smtp_resolve_addr_handler;
84 ctx->timeout = cscf->resolver_timeout;
86 if (ngx_resolve_addr(ctx) != NGX_OK) {
87 ngx_mail_close_connection(c);
93 ngx_mail_smtp_resolve_addr_handler(ngx_resolver_ctx_t *ctx)
96 ngx_mail_session_t *s;
102 ngx_log_error(NGX_LOG_ERR, c->log, 0,
103 "%V could not be resolved (%i: %s)",
104 &c->addr_text, ctx->state,
105 ngx_resolver_strerror(ctx->state));
107 if (ctx->state == NGX_RESOLVE_NXDOMAIN) {
108 s->host = smtp_unavailable;
111 s->host = smtp_tempunavail;
114 ngx_resolve_addr_done(ctx);
116 ngx_mail_smtp_greeting(s, s->connection);
121 c->log->action = "in resolving client hostname";
123 s->host.data = ngx_pstrdup(c->pool, &ctx->name);
124 if (s->host.data == NULL) {
125 ngx_resolve_addr_done(ctx);
126 ngx_mail_close_connection(c);
130 s->host.len = ctx->name.len;
132 ngx_resolve_addr_done(ctx);
134 ngx_log_debug1(NGX_LOG_DEBUG_MAIL, c->log, 0,
135 "address resolved: %V", &s->host);
137 c->read->handler = ngx_mail_smtp_resolve_name;
139 ngx_post_event(c->read, &ngx_posted_events);
144 ngx_mail_smtp_resolve_name(ngx_event_t *rev)
147 ngx_mail_session_t *s;
148 ngx_resolver_ctx_t *ctx;
149 ngx_mail_core_srv_conf_t *cscf;
154 cscf = ngx_mail_get_module_srv_conf(s, ngx_mail_core_module);
156 ctx = ngx_resolve_start(cscf->resolver, NULL);
158 ngx_mail_close_connection(c);
163 ctx->type = NGX_RESOLVE_A;
164 ctx->handler = ngx_mail_smtp_resolve_name_handler;
166 ctx->timeout = cscf->resolver_timeout;
168 if (ngx_resolve_name(ctx) != NGX_OK) {
169 ngx_mail_close_connection(c);
175 ngx_mail_smtp_resolve_name_handler(ngx_resolver_ctx_t *ctx)
180 struct sockaddr_in *sin;
181 ngx_mail_session_t *s;
187 ngx_log_error(NGX_LOG_ERR, c->log, 0,
188 "%V could not be resolved (%i: %s)",
189 &ctx->name, ctx->state,
190 ngx_resolver_strerror(ctx->state));
192 if (ctx->state == NGX_RESOLVE_NXDOMAIN) {
193 s->host = smtp_unavailable;
196 s->host = smtp_tempunavail;
203 sin = (struct sockaddr_in *) c->sockaddr;
205 for (i = 0; i < ctx->naddrs; i++) {
207 addr = ctx->addrs[i];
209 ngx_log_debug4(NGX_LOG_DEBUG_MAIL, c->log, 0,
210 "name was resolved to %ud.%ud.%ud.%ud",
211 (ntohl(addr) >> 24) & 0xff,
212 (ntohl(addr) >> 16) & 0xff,
213 (ntohl(addr) >> 8) & 0xff,
216 if (addr == sin->sin_addr.s_addr) {
221 s->host = smtp_unavailable;
226 ngx_resolve_name_done(ctx);
228 ngx_mail_smtp_greeting(s, c);
233 ngx_mail_smtp_greeting(ngx_mail_session_t *s, ngx_connection_t *c)
236 ngx_mail_core_srv_conf_t *cscf;
237 ngx_mail_smtp_srv_conf_t *sscf;
239 ngx_log_debug1(NGX_LOG_DEBUG_MAIL, c->log, 0,
240 "smtp greeting for \"%V\"", &s->host);
242 cscf = ngx_mail_get_module_srv_conf(s, ngx_mail_core_module);
243 sscf = ngx_mail_get_module_srv_conf(s, ngx_mail_smtp_module);
245 timeout = sscf->greeting_delay ? sscf->greeting_delay : cscf->timeout;
246 ngx_add_timer(c->read, timeout);
248 if (ngx_handle_read_event(c->read, 0) != NGX_OK) {
249 ngx_mail_close_connection(c);
252 if (sscf->greeting_delay) {
253 c->read->handler = ngx_mail_smtp_invalid_pipelining;
257 c->read->handler = ngx_mail_smtp_init_protocol;
259 s->out = sscf->greeting;
261 ngx_mail_send(c->write);
266 ngx_mail_smtp_invalid_pipelining(ngx_event_t *rev)
269 ngx_mail_session_t *s;
270 ngx_mail_core_srv_conf_t *cscf;
271 ngx_mail_smtp_srv_conf_t *sscf;
276 c->log->action = "in delay pipelining state";
280 ngx_log_debug0(NGX_LOG_DEBUG_MAIL, c->log, 0, "delay greeting");
284 cscf = ngx_mail_get_module_srv_conf(s, ngx_mail_core_module);
286 c->read->handler = ngx_mail_smtp_init_protocol;
288 ngx_add_timer(c->read, cscf->timeout);
290 if (ngx_handle_read_event(c->read, 0) != NGX_OK) {
291 ngx_mail_close_connection(c);
295 sscf = ngx_mail_get_module_srv_conf(s, ngx_mail_smtp_module);
297 s->out = sscf->greeting;
301 ngx_log_debug0(NGX_LOG_DEBUG_MAIL, c->log, 0, "invalid pipelining");
303 if (s->buffer == NULL) {
304 if (ngx_mail_smtp_create_buffer(s, c) != NGX_OK) {
309 if (ngx_mail_smtp_discard_command(s, c,
310 "client was rejected before greeting: \"%V\"")
316 s->out.len = sizeof(smtp_invalid_pipelining) - 1;
317 s->out.data = smtp_invalid_pipelining;
320 ngx_mail_send(c->write);
325 ngx_mail_smtp_init_protocol(ngx_event_t *rev)
328 ngx_mail_session_t *s;
332 c->log->action = "in auth state";
335 ngx_log_error(NGX_LOG_INFO, c->log, NGX_ETIMEDOUT, "client timed out");
337 ngx_mail_close_connection(c);
343 if (s->buffer == NULL) {
344 if (ngx_mail_smtp_create_buffer(s, c) != NGX_OK) {
349 s->mail_state = ngx_smtp_start;
350 c->read->handler = ngx_mail_smtp_auth_state;
352 ngx_mail_smtp_auth_state(rev);
357 ngx_mail_smtp_create_buffer(ngx_mail_session_t *s, ngx_connection_t *c)
359 ngx_mail_smtp_srv_conf_t *sscf;
361 if (ngx_array_init(&s->args, c->pool, 2, sizeof(ngx_str_t)) == NGX_ERROR) {
362 ngx_mail_session_internal_server_error(s);
366 sscf = ngx_mail_get_module_srv_conf(s, ngx_mail_smtp_module);
368 s->buffer = ngx_create_temp_buf(c->pool, sscf->client_buffer_size);
369 if (s->buffer == NULL) {
370 ngx_mail_session_internal_server_error(s);
379 ngx_mail_smtp_auth_state(ngx_event_t *rev)
383 ngx_mail_session_t *s;
388 ngx_log_debug0(NGX_LOG_DEBUG_MAIL, c->log, 0, "smtp auth state");
391 ngx_log_error(NGX_LOG_INFO, c->log, NGX_ETIMEDOUT, "client timed out");
393 ngx_mail_close_connection(c);
398 ngx_log_debug0(NGX_LOG_DEBUG_MAIL, c->log, 0, "smtp send handler busy");
405 rc = ngx_mail_read_command(s, c);
407 if (rc == NGX_AGAIN || rc == NGX_ERROR) {
411 s->out.len = sizeof(smtp_ok) - 1;
412 s->out.data = smtp_ok;
415 switch (s->mail_state) {
419 switch (s->command) {
423 rc = ngx_mail_smtp_helo(s, c);
427 rc = ngx_mail_smtp_auth(s, c);
432 s->out.len = sizeof(smtp_bye) - 1;
433 s->out.data = smtp_bye;
437 rc = ngx_mail_smtp_mail(s, c);
441 rc = ngx_mail_smtp_rcpt(s, c);
445 rc = ngx_mail_smtp_rset(s, c);
451 case NGX_SMTP_STARTTLS:
452 rc = ngx_mail_smtp_starttls(s, c);
453 s->out.len = sizeof(smtp_starttls) - 1;
454 s->out.data = smtp_starttls;
458 rc = NGX_MAIL_PARSE_INVALID_COMMAND;
464 case ngx_smtp_auth_login_username:
465 rc = ngx_mail_auth_login_username(s, c, 0);
467 s->out.len = sizeof(smtp_password) - 1;
468 s->out.data = smtp_password;
469 s->mail_state = ngx_smtp_auth_login_password;
472 case ngx_smtp_auth_login_password:
473 rc = ngx_mail_auth_login_password(s, c);
476 case ngx_smtp_auth_plain:
477 rc = ngx_mail_auth_plain(s, c, 0);
480 case ngx_smtp_auth_cram_md5:
481 rc = ngx_mail_auth_cram_md5(s, c);
493 ngx_mail_session_internal_server_error(s);
496 case NGX_MAIL_PARSE_INVALID_COMMAND:
497 s->mail_state = ngx_smtp_start;
500 s->out.len = sizeof(smtp_invalid_command) - 1;
501 s->out.data = smtp_invalid_command;
507 s->buffer->pos = s->buffer->start;
508 s->buffer->last = s->buffer->start;
511 s->arg_start = s->buffer->start;
514 ngx_mail_send(c->write);
520 ngx_mail_smtp_helo(ngx_mail_session_t *s, ngx_connection_t *c)
523 ngx_mail_smtp_srv_conf_t *sscf;
525 if (s->args.nelts != 1) {
526 s->out.len = sizeof(smtp_invalid_argument) - 1;
527 s->out.data = smtp_invalid_argument;
534 s->smtp_helo.len = arg[0].len;
536 s->smtp_helo.data = ngx_pnalloc(c->pool, arg[0].len);
537 if (s->smtp_helo.data == NULL) {
541 ngx_memcpy(s->smtp_helo.data, arg[0].data, arg[0].len);
543 s->smtp_from.len = 0;
544 s->smtp_from.data = NULL;
546 s->smtp_to.data = NULL;
548 sscf = ngx_mail_get_module_srv_conf(s, ngx_mail_smtp_module);
550 if (s->command == NGX_SMTP_HELO) {
551 s->out = sscf->server_name;
558 if (c->ssl == NULL) {
559 ngx_mail_ssl_conf_t *sslcf;
561 sslcf = ngx_mail_get_module_srv_conf(s, ngx_mail_ssl_module);
563 if (sslcf->starttls == NGX_MAIL_STARTTLS_ON) {
564 s->out = sscf->starttls_capability;
568 if (sslcf->starttls == NGX_MAIL_STARTTLS_ONLY) {
569 s->out = sscf->starttls_only_capability;
575 s->out = sscf->capability;
583 ngx_mail_smtp_auth(ngx_mail_session_t *s, ngx_connection_t *c)
586 ngx_mail_core_srv_conf_t *cscf;
587 ngx_mail_smtp_srv_conf_t *sscf;
590 if (ngx_mail_starttls_only(s, c)) {
591 return NGX_MAIL_PARSE_INVALID_COMMAND;
595 if (s->args.nelts == 0) {
596 s->out.len = sizeof(smtp_invalid_argument) - 1;
597 s->out.data = smtp_invalid_argument;
602 rc = ngx_mail_auth_parse(s, c);
606 case NGX_MAIL_AUTH_LOGIN:
608 s->out.len = sizeof(smtp_username) - 1;
609 s->out.data = smtp_username;
610 s->mail_state = ngx_smtp_auth_login_username;
614 case NGX_MAIL_AUTH_LOGIN_USERNAME:
616 s->out.len = sizeof(smtp_password) - 1;
617 s->out.data = smtp_password;
618 s->mail_state = ngx_smtp_auth_login_password;
620 return ngx_mail_auth_login_username(s, c, 1);
622 case NGX_MAIL_AUTH_PLAIN:
624 s->out.len = sizeof(smtp_next) - 1;
625 s->out.data = smtp_next;
626 s->mail_state = ngx_smtp_auth_plain;
630 case NGX_MAIL_AUTH_CRAM_MD5:
632 sscf = ngx_mail_get_module_srv_conf(s, ngx_mail_smtp_module);
634 if (!(sscf->auth_methods & NGX_MAIL_AUTH_CRAM_MD5_ENABLED)) {
635 return NGX_MAIL_PARSE_INVALID_COMMAND;
638 if (s->salt.data == NULL) {
639 cscf = ngx_mail_get_module_srv_conf(s, ngx_mail_core_module);
641 if (ngx_mail_salt(s, c, cscf) != NGX_OK) {
646 if (ngx_mail_auth_cram_md5_salt(s, c, "334 ", 4) == NGX_OK) {
647 s->mail_state = ngx_smtp_auth_cram_md5;
659 ngx_mail_smtp_mail(ngx_mail_session_t *s, ngx_connection_t *c)
664 ngx_mail_smtp_srv_conf_t *sscf;
666 sscf = ngx_mail_get_module_srv_conf(s, ngx_mail_smtp_module);
668 if (!(sscf->auth_methods & NGX_MAIL_AUTH_NONE_ENABLED)) {
669 ngx_mail_smtp_log_rejected_command(s, c, "client was rejected: \"%V\"");
671 s->out.len = sizeof(smtp_auth_required) - 1;
672 s->out.data = smtp_auth_required;
679 if (s->smtp_from.len) {
680 s->out.len = sizeof(smtp_bad_sequence) - 1;
681 s->out.data = smtp_bad_sequence;
685 l.len = s->buffer->last - s->buffer->start;
686 l.data = s->buffer->start;
688 for (i = 0; i < l.len; i++) {
691 if (ch != CR && ch != LF) {
699 if (l.data[i - 1] != ' ') {
708 s->smtp_from.len = l.len;
710 s->smtp_from.data = ngx_pnalloc(c->pool, l.len);
711 if (s->smtp_from.data == NULL) {
715 ngx_memcpy(s->smtp_from.data, l.data, l.len);
717 ngx_log_debug1(NGX_LOG_DEBUG_MAIL, c->log, 0,
718 "smtp mail from:\"%V\"", &s->smtp_from);
720 s->out.len = sizeof(smtp_ok) - 1;
721 s->out.data = smtp_ok;
728 ngx_mail_smtp_rcpt(ngx_mail_session_t *s, ngx_connection_t *c)
734 if (s->smtp_from.len == 0) {
735 s->out.len = sizeof(smtp_bad_sequence) - 1;
736 s->out.data = smtp_bad_sequence;
740 l.len = s->buffer->last - s->buffer->start;
741 l.data = s->buffer->start;
743 for (i = 0; i < l.len; i++) {
746 if (ch != CR && ch != LF) {
754 if (l.data[i - 1] != ' ') {
763 s->smtp_to.len = l.len;
765 s->smtp_to.data = ngx_pnalloc(c->pool, l.len);
766 if (s->smtp_to.data == NULL) {
770 ngx_memcpy(s->smtp_to.data, l.data, l.len);
772 ngx_log_debug1(NGX_LOG_DEBUG_MAIL, c->log, 0,
773 "smtp rcpt to:\"%V\"", &s->smtp_to);
775 s->auth_method = NGX_MAIL_AUTH_NONE;
782 ngx_mail_smtp_rset(ngx_mail_session_t *s, ngx_connection_t *c)
784 s->smtp_from.len = 0;
785 s->smtp_from.data = NULL;
787 s->smtp_to.data = NULL;
789 s->out.len = sizeof(smtp_ok) - 1;
790 s->out.data = smtp_ok;
797 ngx_mail_smtp_starttls(ngx_mail_session_t *s, ngx_connection_t *c)
800 ngx_mail_ssl_conf_t *sslcf;
802 if (c->ssl == NULL) {
803 sslcf = ngx_mail_get_module_srv_conf(s, ngx_mail_ssl_module);
804 if (sslcf->starttls) {
807 * RFC3207 requires us to discard any knowledge
808 * obtained from client before STARTTLS.
811 s->smtp_helo.len = 0;
812 s->smtp_helo.data = NULL;
813 s->smtp_from.len = 0;
814 s->smtp_from.data = NULL;
816 s->smtp_to.data = NULL;
818 c->read->handler = ngx_mail_starttls_handler;
825 return NGX_MAIL_PARSE_INVALID_COMMAND;
830 ngx_mail_smtp_discard_command(ngx_mail_session_t *s, ngx_connection_t *c,
835 n = c->recv(c, s->buffer->last, s->buffer->end - s->buffer->last);
837 if (n == NGX_ERROR || n == 0) {
838 ngx_mail_close_connection(c);
843 s->buffer->last += n;
846 if (n == NGX_AGAIN) {
847 if (ngx_handle_read_event(c->read, 0) != NGX_OK) {
848 ngx_mail_session_internal_server_error(s);
855 ngx_mail_smtp_log_rejected_command(s, c, err);
857 s->buffer->pos = s->buffer->start;
858 s->buffer->last = s->buffer->start;
865 ngx_mail_smtp_log_rejected_command(ngx_mail_session_t *s, ngx_connection_t *c,
872 if (c->log->log_level < NGX_LOG_INFO) {
876 cmd.len = s->buffer->last - s->buffer->start;
877 cmd.data = s->buffer->start;
879 for (i = 0; i < cmd.len; i++) {
882 if (ch != CR && ch != LF) {
891 ngx_log_error(NGX_LOG_INFO, c->log, 0, err, &cmd);