One Level Up Top Level

src/mail/ngx_mail_imap_handler.c - nginx-1.31.3 nginx/ @ 42f8df65b

Global variables defined

Functions defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #include <ngx_config.h>
  9. #include <ngx_core.h>
  10. #include <ngx_event.h>
  11. #include <ngx_mail.h>
  12. #include <ngx_mail_imap_module.h>


  15. static ngx_int_t ngx_mail_imap_login(ngx_mail_session_t *s,
  16.     ngx_connection_t *c);
  17. static ngx_int_t ngx_mail_imap_authenticate(ngx_mail_session_t *s,
  18.     ngx_connection_t *c);
  19. static ngx_int_t ngx_mail_imap_capability(ngx_mail_session_t *s,
  20.     ngx_connection_t *c);
  21. static ngx_int_t ngx_mail_imap_starttls(ngx_mail_session_t *s,
  22.     ngx_connection_t *c);


  25. ‌static u_char  imap_greeting[] = "* OK IMAP4 ready" CRLF;
  26. ‌static u_char  imap_star[] = "* ";
  27. ‌static u_char  imap_ok[] = "OK completed" CRLF;
  28. ‌static u_char  imap_next[] = "+ OK" CRLF;
  29. ‌static u_char  imap_plain_next[] = "+ " CRLF;
  30. ‌static u_char  imap_username[] = "+ VXNlcm5hbWU6" CRLF;
  31. ‌static u_char  imap_password[] = "+ UGFzc3dvcmQ6" CRLF;
  32. ‌static u_char  imap_bye[] = "* BYE" CRLF;
  33. ‌static u_char  imap_invalid_command[] = "BAD invalid command" CRLF;


  36. void
  37. ‌ngx_mail_imap_init_session(ngx_mail_session_t *s, ngx_connection_t *c)
  38. {
  39.     ngx_mail_core_srv_conf_t  *cscf;

  41.     cscf = ngx_mail_get_module_srv_conf(s, ngx_mail_core_module);

  43.     ngx_str_set(&s->out, imap_greeting);

  45.     c->read->handler = ngx_mail_imap_init_protocol;

  47.     ngx_add_timer(c->read, cscf->timeout);

  49.     if (ngx_handle_read_event(c->read, 0) != NGX_OK) {
  50.         ngx_mail_close_connection(c);
  51.         return;
  52.     }

  54.     ngx_mail_send(c->write);
  55. }


  58. void
  59. ‌ngx_mail_imap_init_protocol(ngx_event_t *rev)
  60. {
  61.     ngx_connection_t          *c;
  62.     ngx_mail_session_t        *s;
  63.     ngx_mail_imap_srv_conf_t  *iscf;

  65.     c = rev->data;

  67.     c->log->action = "in auth state";

  69.     if (rev->timedout) {
  70.         ngx_log_error(NGX_LOG_INFO, c->log, NGX_ETIMEDOUT, "client timed out");
  71.         c->timedout = 1;
  72.         ngx_mail_close_connection(c);
  73.         return;
  74.     }

  76.     s = c->data;

  78.     if (s->buffer == NULL) {
  79.         if (ngx_array_init(&s->args, c->pool, 2, sizeof(ngx_str_t))
  80.             == NGX_ERROR)
  81.         {
  82.             ngx_mail_session_internal_server_error(s);
  83.             return;
  84.         }

  86.         iscf = ngx_mail_get_module_srv_conf(s, ngx_mail_imap_module);

  88.         s->buffer = ngx_create_temp_buf(c->pool, iscf->client_buffer_size);
  89.         if (s->buffer == NULL) {
  90.             ngx_mail_session_internal_server_error(s);
  91.             return;
  92.         }
  93.     }

  95.     s->mail_state = ngx_imap_start;
  96.     c->read->handler = ngx_mail_imap_auth_state;

  98.     ngx_mail_imap_auth_state(rev);
  99. }


  102. void
  103. ‌ngx_mail_imap_auth_state(ngx_event_t *rev)
  104. {
  105.     u_char              *p;
  106.     ngx_int_t            rc;
  107.     ngx_uint_t           tag;
  108.     ngx_connection_t    *c;
  109.     ngx_mail_session_t  *s;

  111.     c = rev->data;
  112.     s = c->data;

  114.     ngx_log_debug0(NGX_LOG_DEBUG_MAIL, c->log, 0, "imap auth state");

  116.     if (rev->timedout) {
  117.         ngx_log_error(NGX_LOG_INFO, c->log, NGX_ETIMEDOUT, "client timed out");
  118.         c->timedout = 1;
  119.         ngx_mail_close_connection(c);
  120.         return;
  121.     }

  123.     if (s->out.len) {
  124.         ngx_log_debug0(NGX_LOG_DEBUG_MAIL, c->log, 0, "imap send handler busy");
  125.         s->blocked = 1;

  127.         if (ngx_handle_read_event(c->read, 0) != NGX_OK) {
  128.             ngx_mail_close_connection(c);
  129.             return;
  130.         }

  132.         return;
  133.     }

  135.     s->blocked = 0;

  137.     rc = ngx_mail_read_command(s, c);

  139.     if (rc == NGX_AGAIN) {
  140.         if (ngx_handle_read_event(c->read, 0) != NGX_OK) {
  141.             ngx_mail_session_internal_server_error(s);
  142.             return;
  143.         }

  145.         return;
  146.     }

  148.     if (rc == NGX_ERROR) {
  149.         return;
  150.     }

  152.     tag = 1;
  153.     s->text.len = 0;
  154.     ngx_str_set(&s->out, imap_ok);

  156.     if (rc == NGX_OK) {

  158.         ngx_log_debug1(NGX_LOG_DEBUG_MAIL, c->log, 0, "imap auth command: %i",
  159.                        s->command);

  161.         switch (s->mail_state) {

  163.         case ngx_imap_start:

  165.             switch (s->command) {

  167.             case NGX_IMAP_LOGIN:
  168.                 rc = ngx_mail_imap_login(s, c);
  169.                 break;

  171.             case NGX_IMAP_AUTHENTICATE:
  172.                 rc = ngx_mail_imap_authenticate(s, c);
  173.                 tag = (rc != NGX_OK);
  174.                 break;

  176.             case NGX_IMAP_CAPABILITY:
  177.                 rc = ngx_mail_imap_capability(s, c);
  178.                 break;

  180.             case NGX_IMAP_LOGOUT:
  181.                 s->quit = 1;
  182.                 ngx_str_set(&s->text, imap_bye);
  183.                 break;

  185.             case NGX_IMAP_NOOP:
  186.                 break;

  188.             case NGX_IMAP_STARTTLS:
  189.                 rc = ngx_mail_imap_starttls(s, c);
  190.                 break;

  192.             default:
  193.                 rc = NGX_MAIL_PARSE_INVALID_COMMAND;
  194.                 break;
  195.             }

  197.             break;

  199.         case ngx_imap_auth_login_username:
  200.             rc = ngx_mail_auth_login_username(s, c, 0);

  202.             tag = 0;
  203.             ngx_str_set(&s->out, imap_password);
  204.             s->mail_state = ngx_imap_auth_login_password;

  206.             break;

  208.         case ngx_imap_auth_login_password:
  209.             rc = ngx_mail_auth_login_password(s, c);
  210.             break;

  212.         case ngx_imap_auth_plain:
  213.             rc = ngx_mail_auth_plain(s, c, 0);
  214.             break;

  216.         case ngx_imap_auth_cram_md5:
  217.             rc = ngx_mail_auth_cram_md5(s, c);
  218.             break;

  220.         case ngx_imap_auth_external:
  221.             rc = ngx_mail_auth_external(s, c, 0);
  222.             break;
  223.         }

  225.     } else if (rc == NGX_IMAP_NEXT) {
  226.         tag = 0;
  227.         ngx_str_set(&s->out, imap_next);
  228.     }

  230.     if (s->buffer->pos < s->buffer->last) {
  231.         s->blocked = 1;
  232.     }

  234.     switch (rc) {

  236.     case NGX_DONE:
  237.         ngx_mail_auth(s, c);
  238.         return;

  240.     case NGX_ERROR:
  241.         ngx_mail_session_internal_server_error(s);
  242.         return;

  244.     case NGX_MAIL_PARSE_INVALID_COMMAND:
  245.         s->state = 0;
  246.         ngx_str_set(&s->out, imap_invalid_command);
  247.         s->mail_state = ngx_imap_start;
  248.         break;
  249.     }

  251.     if (tag) {
  252.         if (s->tag.len == 0) {
  253.             ngx_str_set(&s->tag, imap_star);
  254.         }

  256.         if (s->tagged_line.len < s->tag.len + s->text.len + s->out.len) {
  257.             s->tagged_line.len = s->tag.len + s->text.len + s->out.len;
  258.             s->tagged_line.data = ngx_pnalloc(c->pool, s->tagged_line.len);
  259.             if (s->tagged_line.data == NULL) {
  260.                 ngx_mail_close_connection(c);
  261.                 return;
  262.             }
  263.         }

  265.         p = s->tagged_line.data;

  267.         if (s->text.len) {
  268.             p = ngx_cpymem(p, s->text.data, s->text.len);
  269.         }

  271.         p = ngx_cpymem(p, s->tag.data, s->tag.len);
  272.         ngx_memcpy(p, s->out.data, s->out.len);

  274.         s->out.len = s->text.len + s->tag.len + s->out.len;
  275.         s->out.data = s->tagged_line.data;
  276.     }

  278.     if (rc != NGX_IMAP_NEXT) {
  279.         s->args.nelts = 0;

  281.         if (s->state) {
  282.             /* preserve tag */
  283.             s->arg_start = s->buffer->pos;

  285.         } else {
  286.             if (s->buffer->pos == s->buffer->last) {
  287.                 s->buffer->pos = s->buffer->start;
  288.                 s->buffer->last = s->buffer->start;
  289.             }

  291.             s->tag.len = 0;
  292.         }
  293.     }

  295.     if (ngx_handle_read_event(c->read, 0) != NGX_OK) {
  296.         ngx_mail_session_internal_server_error(s);
  297.         return;
  298.     }

  300.     ngx_mail_send(c->write);
  301. }


  304. static ngx_int_t
  305. ‌ngx_mail_imap_login(ngx_mail_session_t *s, ngx_connection_t *c)
  306. {
  307.     ngx_str_t  *arg;

  309. #if (NGX_MAIL_SSL)
  310.     if (ngx_mail_starttls_only(s, c)) {
  311.         return NGX_MAIL_PARSE_INVALID_COMMAND;
  312.     }
  313. #endif

  315.     arg = s->args.elts;

  317.     if (s->args.nelts != 2 || arg[0].len == 0) {
  318.         return NGX_MAIL_PARSE_INVALID_COMMAND;
  319.     }

  321.     s->login.len = arg[0].len;
  322.     s->login.data = ngx_pnalloc(c->pool, s->login.len);
  323.     if (s->login.data == NULL) {
  324.         return NGX_ERROR;
  325.     }

  327.     ngx_memcpy(s->login.data, arg[0].data, s->login.len);

  329.     s->passwd.len = arg[1].len;
  330.     s->passwd.data = ngx_pnalloc(c->pool, s->passwd.len);
  331.     if (s->passwd.data == NULL) {
  332.         return NGX_ERROR;
  333.     }

  335.     ngx_memcpy(s->passwd.data, arg[1].data, s->passwd.len);

  337. #if (NGX_DEBUG_MAIL_PASSWD)
  338.     ngx_log_debug2(NGX_LOG_DEBUG_MAIL, c->log, 0,
  339.                    "imap login:\"%V\" passwd:\"%V\"",
  340.                    &s->login, &s->passwd);
  341. #else
  342.     ngx_log_debug1(NGX_LOG_DEBUG_MAIL, c->log, 0,
  343.                    "imap login:\"%V\"", &s->login);
  344. #endif

  346.     return NGX_DONE;
  347. }


  350. static ngx_int_t
  351. ‌ngx_mail_imap_authenticate(ngx_mail_session_t *s, ngx_connection_t *c)
  352. {
  353.     ngx_int_t                  rc;
  354.     ngx_mail_core_srv_conf_t  *cscf;
  355.     ngx_mail_imap_srv_conf_t  *iscf;

  357. #if (NGX_MAIL_SSL)
  358.     if (ngx_mail_starttls_only(s, c)) {
  359.         return NGX_MAIL_PARSE_INVALID_COMMAND;
  360.     }
  361. #endif

  363.     iscf = ngx_mail_get_module_srv_conf(s, ngx_mail_imap_module);

  365.     rc = ngx_mail_auth_parse(s, c);

  367.     switch (rc) {

  369.     case NGX_MAIL_AUTH_LOGIN:

  371.         ngx_str_set(&s->out, imap_username);
  372.         s->mail_state = ngx_imap_auth_login_username;

  374.         return NGX_OK;

  376.     case NGX_MAIL_AUTH_LOGIN_USERNAME:

  378.         ngx_str_set(&s->out, imap_password);
  379.         s->mail_state = ngx_imap_auth_login_password;

  381.         return ngx_mail_auth_login_username(s, c, 1);

  383.     case NGX_MAIL_AUTH_PLAIN:

  385.         ngx_str_set(&s->out, imap_plain_next);
  386.         s->mail_state = ngx_imap_auth_plain;

  388.         return NGX_OK;

  390.     case NGX_MAIL_AUTH_CRAM_MD5:

  392.         if (!(iscf->auth_methods & NGX_MAIL_AUTH_CRAM_MD5_ENABLED)) {
  393.             return NGX_MAIL_PARSE_INVALID_COMMAND;
  394.         }

  396.         if (s->salt.data == NULL) {
  397.             cscf = ngx_mail_get_module_srv_conf(s, ngx_mail_core_module);

  399.             if (ngx_mail_salt(s, c, cscf) != NGX_OK) {
  400.                 return NGX_ERROR;
  401.             }
  402.         }

  404.         if (ngx_mail_auth_cram_md5_salt(s, c, "+ ", 2) == NGX_OK) {
  405.             s->mail_state = ngx_imap_auth_cram_md5;
  406.             return NGX_OK;
  407.         }

  409.         return NGX_ERROR;

  411.     case NGX_MAIL_AUTH_EXTERNAL:

  413.         if (!(iscf->auth_methods & NGX_MAIL_AUTH_EXTERNAL_ENABLED)) {
  414.             return NGX_MAIL_PARSE_INVALID_COMMAND;
  415.         }

  417.         ngx_str_set(&s->out, imap_username);
  418.         s->mail_state = ngx_imap_auth_external;

  420.         return NGX_OK;
  421.     }

  423.     return rc;
  424. }


  427. static ngx_int_t
  428. ‌ngx_mail_imap_capability(ngx_mail_session_t *s, ngx_connection_t *c)
  429. {
  430.     ngx_mail_imap_srv_conf_t  *iscf;

  432.     iscf = ngx_mail_get_module_srv_conf(s, ngx_mail_imap_module);

  434. #if (NGX_MAIL_SSL)

  436.     if (c->ssl == NULL) {
  437.         ngx_mail_ssl_conf_t  *sslcf;

  439.         sslcf = ngx_mail_get_module_srv_conf(s, ngx_mail_ssl_module);

  441.         if (sslcf->starttls == NGX_MAIL_STARTTLS_ON) {
  442.             s->text = iscf->starttls_capability;
  443.             return NGX_OK;
  444.         }

  446.         if (sslcf->starttls == NGX_MAIL_STARTTLS_ONLY) {
  447.             s->text = iscf->starttls_only_capability;
  448.             return NGX_OK;
  449.         }
  450.     }
  451. #endif

  453.     s->text = iscf->capability;

  455.     return NGX_OK;
  456. }


  459. static ngx_int_t
  460. ‌ngx_mail_imap_starttls(ngx_mail_session_t *s, ngx_connection_t *c)
  461. {
  462. #if (NGX_MAIL_SSL)
  463.     ngx_mail_ssl_conf_t  *sslcf;

  465.     if (c->ssl == NULL) {
  466.         sslcf = ngx_mail_get_module_srv_conf(s, ngx_mail_ssl_module);
  467.         if (sslcf->starttls) {
  468.             s->buffer->pos = s->buffer->start;
  469.             s->buffer->last = s->buffer->start;
  470.             c->read->handler = ngx_mail_starttls_handler;
  471.             return NGX_OK;
  472.         }
  473.     }

  475. #endif

  477.     return NGX_MAIL_PARSE_INVALID_COMMAND;
  478. }

One Level Up Top Level