src/mail/ngx_mail_pop3_module.c - nginx-1.7.10

Global variables defined

Functions defined

Source code


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


  5. #include <ngx_config.h>
  6. #include <ngx_core.h>
  7. #include <ngx_event.h>
  8. #include <ngx_mail.h>
  9. #include <ngx_mail_pop3_module.h>


  10. static void *ngx_mail_pop3_create_srv_conf(ngx_conf_t *cf);
  11. static char *ngx_mail_pop3_merge_srv_conf(ngx_conf_t *cf, void *parent,
  12.     void *child);


  13. static ngx_str_t  ngx_mail_pop3_default_capabilities[] = {
  14.     ngx_string("TOP"),
  15.     ngx_string("USER"),
  16.     ngx_string("UIDL"),
  17.     ngx_null_string
  18. };


  19. static ngx_conf_bitmask_t  ngx_mail_pop3_auth_methods[] = {
  20.     { ngx_string("plain"), NGX_MAIL_AUTH_PLAIN_ENABLED },
  21.     { ngx_string("apop"), NGX_MAIL_AUTH_APOP_ENABLED },
  22.     { ngx_string("cram-md5"), NGX_MAIL_AUTH_CRAM_MD5_ENABLED },
  23.     { ngx_null_string, 0 }
  24. };


  25. static ngx_str_t  ngx_mail_pop3_auth_plain_capability =
  26.     ngx_string("+OK methods supported:" CRLF
  27.                "LOGIN" CRLF
  28.                "PLAIN" CRLF
  29.                "." CRLF);


  30. static ngx_str_t  ngx_mail_pop3_auth_cram_md5_capability =
  31.     ngx_string("+OK methods supported:" CRLF
  32.                "LOGIN" CRLF
  33.                "PLAIN" CRLF
  34.                "CRAM-MD5" CRLF
  35.                "." CRLF);


  36. static ngx_mail_protocol_t  ngx_mail_pop3_protocol = {
  37.     ngx_string("pop3"),
  38.     { 110, 995, 0, 0 },
  39.     NGX_MAIL_POP3_PROTOCOL,

  40.     ngx_mail_pop3_init_session,
  41.     ngx_mail_pop3_init_protocol,
  42.     ngx_mail_pop3_parse_command,
  43.     ngx_mail_pop3_auth_state,

  44.     ngx_string("-ERR internal server error" CRLF)
  45. };


  46. static ngx_command_t  ngx_mail_pop3_commands[] = {

  47.     { ngx_string("pop3_capabilities"),
  48.       NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_1MORE,
  49.       ngx_mail_capabilities,
  50.       NGX_MAIL_SRV_CONF_OFFSET,
  51.       offsetof(ngx_mail_pop3_srv_conf_t, capabilities),
  52.       NULL },

  53.     { ngx_string("pop3_auth"),
  54.       NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_1MORE,
  55.       ngx_conf_set_bitmask_slot,
  56.       NGX_MAIL_SRV_CONF_OFFSET,
  57.       offsetof(ngx_mail_pop3_srv_conf_t, auth_methods),
  58.       &ngx_mail_pop3_auth_methods },

  59.       ngx_null_command
  60. };


  61. static ngx_mail_module_t  ngx_mail_pop3_module_ctx = {
  62.     &ngx_mail_pop3_protocol,               /* protocol */

  63.     NULL,                                  /* create main configuration */
  64.     NULL,                                  /* init main configuration */

  65.     ngx_mail_pop3_create_srv_conf,         /* create server configuration */
  66.     ngx_mail_pop3_merge_srv_conf           /* merge server configuration */
  67. };


  68. ngx_module_t  ngx_mail_pop3_module = {
  69.     NGX_MODULE_V1,
  70.     &ngx_mail_pop3_module_ctx,             /* module context */
  71.     ngx_mail_pop3_commands,                /* module directives */
  72.     NGX_MAIL_MODULE,                       /* module type */
  73.     NULL,                                  /* init master */
  74.     NULL,                                  /* init module */
  75.     NULL,                                  /* init process */
  76.     NULL,                                  /* init thread */
  77.     NULL,                                  /* exit thread */
  78.     NULL,                                  /* exit process */
  79.     NULL,                                  /* exit master */
  80.     NGX_MODULE_V1_PADDING
  81. };


  82. static void *
  83. ngx_mail_pop3_create_srv_conf(ngx_conf_t *cf)
  84. {
  85.     ngx_mail_pop3_srv_conf_t  *pscf;

  86.     pscf = ngx_pcalloc(cf->pool, sizeof(ngx_mail_pop3_srv_conf_t));
  87.     if (pscf == NULL) {
  88.         return NULL;
  89.     }

  90.     if (ngx_array_init(&pscf->capabilities, cf->pool, 4, sizeof(ngx_str_t))
  91.         != NGX_OK)
  92.     {
  93.         return NULL;
  94.     }

  95.     return pscf;
  96. }


  97. static char *
  98. ngx_mail_pop3_merge_srv_conf(ngx_conf_t *cf, void *parent, void *child)
  99. {
  100.     ngx_mail_pop3_srv_conf_t *prev = parent;
  101.     ngx_mail_pop3_srv_conf_t *conf = child;

  102.     u_char      *p;
  103.     size_t       size, stls_only_size;
  104.     ngx_str_t   *c, *d;
  105.     ngx_uint_t   i;

  106.     ngx_conf_merge_bitmask_value(conf->auth_methods,
  107.                                  prev->auth_methods,
  108.                                  (NGX_CONF_BITMASK_SET
  109.                                   |NGX_MAIL_AUTH_PLAIN_ENABLED));

  110.     if (conf->capabilities.nelts == 0) {
  111.         conf->capabilities = prev->capabilities;
  112.     }

  113.     if (conf->capabilities.nelts == 0) {

  114.         for (d = ngx_mail_pop3_default_capabilities; d->len; d++) {
  115.             c = ngx_array_push(&conf->capabilities);
  116.             if (c == NULL) {
  117.                 return NGX_CONF_ERROR;
  118.             }

  119.             *c = *d;
  120.         }
  121.     }

  122.     size = sizeof("+OK Capability list follows" CRLF) - 1
  123.            + sizeof("." CRLF) - 1;

  124.     stls_only_size = size + sizeof("STLS" CRLF) - 1;

  125.     c = conf->capabilities.elts;
  126.     for (i = 0; i < conf->capabilities.nelts; i++) {
  127.         size += c[i].len + sizeof(CRLF) - 1;

  128.         if (ngx_strcasecmp(c[i].data, (u_char *) "USER") == 0) {
  129.             continue;
  130.         }

  131.         stls_only_size += c[i].len + sizeof(CRLF) - 1;
  132.     }

  133.     if (conf->auth_methods & NGX_MAIL_AUTH_CRAM_MD5_ENABLED) {
  134.         size += sizeof("SASL LOGIN PLAIN CRAM-MD5" CRLF) - 1;

  135.     } else {
  136.         size += sizeof("SASL LOGIN PLAIN" CRLF) - 1;
  137.     }

  138.     p = ngx_pnalloc(cf->pool, size);
  139.     if (p == NULL) {
  140.         return NGX_CONF_ERROR;
  141.     }

  142.     conf->capability.len = size;
  143.     conf->capability.data = p;

  144.     p = ngx_cpymem(p, "+OK Capability list follows" CRLF,
  145.                    sizeof("+OK Capability list follows" CRLF) - 1);

  146.     for (i = 0; i < conf->capabilities.nelts; i++) {
  147.         p = ngx_cpymem(p, c[i].data, c[i].len);
  148.         *p++ = CR; *p++ = LF;
  149.     }

  150.     if (conf->auth_methods & NGX_MAIL_AUTH_CRAM_MD5_ENABLED) {
  151.         p = ngx_cpymem(p, "SASL LOGIN PLAIN CRAM-MD5" CRLF,
  152.                        sizeof("SASL LOGIN PLAIN CRAM-MD5" CRLF) - 1);

  153.     } else {
  154.         p = ngx_cpymem(p, "SASL LOGIN PLAIN" CRLF,
  155.                        sizeof("SASL LOGIN PLAIN" CRLF) - 1);
  156.     }

  157.     *p++ = '.'; *p++ = CR; *p = LF;


  158.     size += sizeof("STLS" CRLF) - 1;

  159.     p = ngx_pnalloc(cf->pool, size);
  160.     if (p == NULL) {
  161.         return NGX_CONF_ERROR;
  162.     }

  163.     conf->starttls_capability.len = size;
  164.     conf->starttls_capability.data = p;

  165.     p = ngx_cpymem(p, conf->capability.data,
  166.                    conf->capability.len - (sizeof("." CRLF) - 1));

  167.     p = ngx_cpymem(p, "STLS" CRLF, sizeof("STLS" CRLF) - 1);
  168.     *p++ = '.'; *p++ = CR; *p = LF;


  169.     if (conf->auth_methods & NGX_MAIL_AUTH_CRAM_MD5_ENABLED) {
  170.         conf->auth_capability = ngx_mail_pop3_auth_cram_md5_capability;

  171.     } else {
  172.         conf->auth_capability = ngx_mail_pop3_auth_plain_capability;
  173.     }


  174.     p = ngx_pnalloc(cf->pool, stls_only_size);
  175.     if (p == NULL) {
  176.         return NGX_CONF_ERROR;
  177.     }

  178.     conf->starttls_only_capability.len = stls_only_size;
  179.     conf->starttls_only_capability.data = p;

  180.     p = ngx_cpymem(p, "+OK Capability list follows" CRLF,
  181.                    sizeof("+OK Capability list follows" CRLF) - 1);

  182.     for (i = 0; i < conf->capabilities.nelts; i++) {
  183.         if (ngx_strcasecmp(c[i].data, (u_char *) "USER") == 0) {
  184.             continue;
  185.         }

  186.         p = ngx_cpymem(p, c[i].data, c[i].len);
  187.         *p++ = CR; *p++ = LF;
  188.     }

  189.     p = ngx_cpymem(p, "STLS" CRLF, sizeof("STLS" CRLF) - 1);
  190.     *p++ = '.'; *p++ = CR; *p = LF;

  191.     return NGX_CONF_OK;
  192. }