One Level Up Top Level

src/mail/ngx_mail_core_module.c - nginx-1.7.10

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>


  14. static void *ngx_mail_core_create_main_conf(ngx_conf_t *cf);
  15. static void *ngx_mail_core_create_srv_conf(ngx_conf_t *cf);
  16. static char *ngx_mail_core_merge_srv_conf(ngx_conf_t *cf, void *parent,
  17.     void *child);
  18. static char *ngx_mail_core_server(ngx_conf_t *cf, ngx_command_t *cmd,
  19.     void *conf);
  20. static char *ngx_mail_core_listen(ngx_conf_t *cf, ngx_command_t *cmd,
  21.     void *conf);
  22. static char *ngx_mail_core_protocol(ngx_conf_t *cf, ngx_command_t *cmd,
  23.     void *conf);
  24. static char *ngx_mail_core_resolver(ngx_conf_t *cf, ngx_command_t *cmd,
  25.     void *conf);


  28. ‌static ngx_conf_deprecated_t  ngx_conf_deprecated_so_keepalive = {
  29.     ngx_conf_deprecated, "so_keepalive",
  30.     "so_keepalive\" parameter of the \"listen"
  31. };


  34. ‌static ngx_command_t  ngx_mail_core_commands[] = {

  36.     { ngx_string("server"),
  37.       NGX_MAIL_MAIN_CONF|NGX_CONF_BLOCK|NGX_CONF_NOARGS,
  38.       ngx_mail_core_server,
  39.       0,
  40.       0,
  41.       NULL },

  43.     { ngx_string("listen"),
  44.       NGX_MAIL_SRV_CONF|NGX_CONF_1MORE,
  45.       ngx_mail_core_listen,
  46.       NGX_MAIL_SRV_CONF_OFFSET,
  47.       0,
  48.       NULL },

  50.     { ngx_string("protocol"),
  51.       NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
  52.       ngx_mail_core_protocol,
  53.       NGX_MAIL_SRV_CONF_OFFSET,
  54.       0,
  55.       NULL },

  57.     { ngx_string("so_keepalive"),
  58.       NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_FLAG,
  59.       ngx_conf_set_flag_slot,
  60.       NGX_MAIL_SRV_CONF_OFFSET,
  61.       offsetof(ngx_mail_core_srv_conf_t, so_keepalive),
  62.       &ngx_conf_deprecated_so_keepalive },

  64.     { ngx_string("timeout"),
  65.       NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
  66.       ngx_conf_set_msec_slot,
  67.       NGX_MAIL_SRV_CONF_OFFSET,
  68.       offsetof(ngx_mail_core_srv_conf_t, timeout),
  69.       NULL },

  71.     { ngx_string("server_name"),
  72.       NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
  73.       ngx_conf_set_str_slot,
  74.       NGX_MAIL_SRV_CONF_OFFSET,
  75.       offsetof(ngx_mail_core_srv_conf_t, server_name),
  76.       NULL },

  78.     { ngx_string("resolver"),
  79.       NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_1MORE,
  80.       ngx_mail_core_resolver,
  81.       NGX_MAIL_SRV_CONF_OFFSET,
  82.       0,
  83.       NULL },

  85.     { ngx_string("resolver_timeout"),
  86.       NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
  87.       ngx_conf_set_msec_slot,
  88.       NGX_MAIL_SRV_CONF_OFFSET,
  89.       offsetof(ngx_mail_core_srv_conf_t, resolver_timeout),
  90.       NULL },

  92.       ngx_null_command
  93. };


  96. ‌static ngx_mail_module_t  ngx_mail_core_module_ctx = {
  97.     NULL,                                  /* protocol */

  99.     ngx_mail_core_create_main_conf,        /* create main configuration */
  100.     NULL,                                  /* init main configuration */

  102.     ngx_mail_core_create_srv_conf,         /* create server configuration */
  103.     ngx_mail_core_merge_srv_conf           /* merge server configuration */
  104. };


  107. ‌ngx_module_t  ngx_mail_core_module = {
  108.     NGX_MODULE_V1,
  109.     &ngx_mail_core_module_ctx,             /* module context */
  110.     ngx_mail_core_commands,                /* module directives */
  111.     NGX_MAIL_MODULE,                       /* module type */
  112.     NULL,                                  /* init master */
  113.     NULL,                                  /* init module */
  114.     NULL,                                  /* init process */
  115.     NULL,                                  /* init thread */
  116.     NULL,                                  /* exit thread */
  117.     NULL,                                  /* exit process */
  118.     NULL,                                  /* exit master */
  119.     NGX_MODULE_V1_PADDING
  120. };


  123. static void *
  124. ‌ngx_mail_core_create_main_conf(ngx_conf_t *cf)
  125. {
  126.     ngx_mail_core_main_conf_t  *cmcf;

  128.     cmcf = ngx_pcalloc(cf->pool, sizeof(ngx_mail_core_main_conf_t));
  129.     if (cmcf == NULL) {
  130.         return NULL;
  131.     }

  133.     if (ngx_array_init(&cmcf->servers, cf->pool, 4,
  134.                        sizeof(ngx_mail_core_srv_conf_t *))
  135.         != NGX_OK)
  136.     {
  137.         return NULL;
  138.     }

  140.     if (ngx_array_init(&cmcf->listen, cf->pool, 4, sizeof(ngx_mail_listen_t))
  141.         != NGX_OK)
  142.     {
  143.         return NULL;
  144.     }

  146.     return cmcf;
  147. }


  150. static void *
  151. ‌ngx_mail_core_create_srv_conf(ngx_conf_t *cf)
  152. {
  153.     ngx_mail_core_srv_conf_t  *cscf;

  155.     cscf = ngx_pcalloc(cf->pool, sizeof(ngx_mail_core_srv_conf_t));
  156.     if (cscf == NULL) {
  157.         return NULL;
  158.     }

  160.     /*
  161.      * set by ngx_pcalloc():
  162.      *
  163.      *     cscf->protocol = NULL;
  164.      */

  166.     cscf->timeout = NGX_CONF_UNSET_MSEC;
  167.     cscf->resolver_timeout = NGX_CONF_UNSET_MSEC;
  168.     cscf->so_keepalive = NGX_CONF_UNSET;

  170.     cscf->resolver = NGX_CONF_UNSET_PTR;

  172.     cscf->file_name = cf->conf_file->file.name.data;
  173.     cscf->line = cf->conf_file->line;

  175.     return cscf;
  176. }


  179. static char *
  180. ‌ngx_mail_core_merge_srv_conf(ngx_conf_t *cf, void *parent, void *child)
  181. {
  182.     ngx_mail_core_srv_conf_t *prev = parent;
  183.     ngx_mail_core_srv_conf_t *conf = child;

  185.     ngx_conf_merge_msec_value(conf->timeout, prev->timeout, 60000);
  186.     ngx_conf_merge_msec_value(conf->resolver_timeout, prev->resolver_timeout,
  187.                               30000);

  189.     ngx_conf_merge_value(conf->so_keepalive, prev->so_keepalive, 0);


  192.     ngx_conf_merge_str_value(conf->server_name, prev->server_name, "");

  194.     if (conf->server_name.len == 0) {
  195.         conf->server_name = cf->cycle->hostname;
  196.     }

  198.     if (conf->protocol == NULL) {
  199.         ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
  200.                       "unknown mail protocol for server in %s:%ui",
  201.                       conf->file_name, conf->line);
  202.         return NGX_CONF_ERROR;
  203.     }

  205.     ngx_conf_merge_ptr_value(conf->resolver, prev->resolver, NULL);

  207.     return NGX_CONF_OK;
  208. }


  211. static char *
  212. ‌ngx_mail_core_server(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  213. {
  214.     char                       *rv;
  215.     void                       *mconf;
  216.     ngx_uint_t                  m;
  217.     ngx_conf_t                  pcf;
  218.     ngx_mail_module_t          *module;
  219.     ngx_mail_conf_ctx_t        *ctx, *mail_ctx;
  220.     ngx_mail_core_srv_conf_t   *cscf, **cscfp;
  221.     ngx_mail_core_main_conf_t  *cmcf;

  223.     ctx = ngx_pcalloc(cf->pool, sizeof(ngx_mail_conf_ctx_t));
  224.     if (ctx == NULL) {
  225.         return NGX_CONF_ERROR;
  226.     }

  228.     mail_ctx = cf->ctx;
  229.     ctx->main_conf = mail_ctx->main_conf;

  231.     /* the server{}'s srv_conf */

  233.     ctx->srv_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_mail_max_module);
  234.     if (ctx->srv_conf == NULL) {
  235.         return NGX_CONF_ERROR;
  236.     }

  238.     for (m = 0; ngx_modules[m]; m++) {
  239.         if (ngx_modules[m]->type != NGX_MAIL_MODULE) {
  240.             continue;
  241.         }

  243.         module = ngx_modules[m]->ctx;

  245.         if (module->create_srv_conf) {
  246.             mconf = module->create_srv_conf(cf);
  247.             if (mconf == NULL) {
  248.                 return NGX_CONF_ERROR;
  249.             }

  251.             ctx->srv_conf[ngx_modules[m]->ctx_index] = mconf;
  252.         }
  253.     }

  255.     /* the server configuration context */

  257.     cscf = ctx->srv_conf[ngx_mail_core_module.ctx_index];
  258.     cscf->ctx = ctx;

  260.     cmcf = ctx->main_conf[ngx_mail_core_module.ctx_index];

  262.     cscfp = ngx_array_push(&cmcf->servers);
  263.     if (cscfp == NULL) {
  264.         return NGX_CONF_ERROR;
  265.     }

  267.     *cscfp = cscf;


  270.     /* parse inside server{} */

  272.     pcf = *cf;
  273.     cf->ctx = ctx;
  274.     cf->cmd_type = NGX_MAIL_SRV_CONF;

  276.     rv = ngx_conf_parse(cf, NULL);

  278.     *cf = pcf;

  280.     return rv;
  281. }


  284. static char *
  285. ‌ngx_mail_core_listen(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  286. {
  287.     ngx_mail_core_srv_conf_t  *cscf = conf;

  289.     size_t                      len, off;
  290.     in_port_t                   port;
  291.     ngx_str_t                  *value;
  292.     ngx_url_t                   u;
  293.     ngx_uint_t                  i, m;
  294.     struct sockaddr            *sa;
  295.     ngx_mail_listen_t          *ls;
  296.     ngx_mail_module_t          *module;
  297.     struct sockaddr_in         *sin;
  298.     ngx_mail_core_main_conf_t  *cmcf;
  299. #if (NGX_HAVE_INET6)
  300.     struct sockaddr_in6        *sin6;
  301. #endif

  303.     value = cf->args->elts;

  305.     ngx_memzero(&u, sizeof(ngx_url_t));

  307.     u.url = value[1];
  308.     u.listen = 1;

  310.     if (ngx_parse_url(cf->pool, &u) != NGX_OK) {
  311.         if (u.err) {
  312.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  313.                                "%s in \"%V\" of the \"listen\" directive",
  314.                                u.err, &u.url);
  315.         }

  317.         return NGX_CONF_ERROR;
  318.     }

  320.     cmcf = ngx_mail_conf_get_module_main_conf(cf, ngx_mail_core_module);

  322.     ls = cmcf->listen.elts;

  324.     for (i = 0; i < cmcf->listen.nelts; i++) {

  326.         sa = (struct sockaddr *) ls[i].sockaddr;

  328.         if (sa->sa_family != u.family) {
  329.             continue;
  330.         }

  332.         switch (sa->sa_family) {

  334. #if (NGX_HAVE_INET6)
  335.         case AF_INET6:
  336.             off = offsetof(struct sockaddr_in6, sin6_addr);
  337.             len = 16;
  338.             sin6 = (struct sockaddr_in6 *) sa;
  339.             port = sin6->sin6_port;
  340.             break;
  341. #endif

  343. #if (NGX_HAVE_UNIX_DOMAIN)
  344.         case AF_UNIX:
  345.             off = offsetof(struct sockaddr_un, sun_path);
  346.             len = sizeof(((struct sockaddr_un *) sa)->sun_path);
  347.             port = 0;
  348.             break;
  349. #endif

  351.         default: /* AF_INET */
  352.             off = offsetof(struct sockaddr_in, sin_addr);
  353.             len = 4;
  354.             sin = (struct sockaddr_in *) sa;
  355.             port = sin->sin_port;
  356.             break;
  357.         }

  359.         if (ngx_memcmp(ls[i].sockaddr + off, u.sockaddr + off, len) != 0) {
  360.             continue;
  361.         }

  363.         if (port != u.port) {
  364.             continue;
  365.         }

  367.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  368.                            "duplicate \"%V\" address and port pair", &u.url);
  369.         return NGX_CONF_ERROR;
  370.     }

  372.     ls = ngx_array_push(&cmcf->listen);
  373.     if (ls == NULL) {
  374.         return NGX_CONF_ERROR;
  375.     }

  377.     ngx_memzero(ls, sizeof(ngx_mail_listen_t));

  379.     ngx_memcpy(ls->sockaddr, u.sockaddr, u.socklen);

  381.     ls->socklen = u.socklen;
  382.     ls->wildcard = u.wildcard;
  383.     ls->ctx = cf->ctx;

  385. #if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
  386.     ls->ipv6only = 1;
  387. #endif

  389.     if (cscf->protocol == NULL) {
  390.         for (m = 0; ngx_modules[m]; m++) {
  391.             if (ngx_modules[m]->type != NGX_MAIL_MODULE) {
  392.                 continue;
  393.             }

  395.             module = ngx_modules[m]->ctx;

  397.             if (module->protocol == NULL) {
  398.                 continue;
  399.             }

  401.             for (i = 0; module->protocol->port[i]; i++) {
  402.                 if (module->protocol->port[i] == u.port) {
  403.                     cscf->protocol = module->protocol;
  404.                     break;
  405.                 }
  406.             }
  407.         }
  408.     }

  410.     for (i = 2; i < cf->args->nelts; i++) {

  412.         if (ngx_strcmp(value[i].data, "bind") == 0) {
  413.             ls->bind = 1;
  414.             continue;
  415.         }

  417.         if (ngx_strncmp(value[i].data, "ipv6only=o", 10) == 0) {
  418. #if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
  419.             struct sockaddr  *sa;
  420.             u_char            buf[NGX_SOCKADDR_STRLEN];

  422.             sa = (struct sockaddr *) ls->sockaddr;

  424.             if (sa->sa_family == AF_INET6) {

  426.                 if (ngx_strcmp(&value[i].data[10], "n") == 0) {
  427.                     ls->ipv6only = 1;

  429.                 } else if (ngx_strcmp(&value[i].data[10], "ff") == 0) {
  430.                     ls->ipv6only = 0;

  432.                 } else {
  433.                     ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  434.                                        "invalid ipv6only flags \"%s\"",
  435.                                        &value[i].data[9]);
  436.                     return NGX_CONF_ERROR;
  437.                 }

  439.                 ls->bind = 1;

  441.             } else {
  442.                 len = ngx_sock_ntop(sa, ls->socklen, buf,
  443.                                     NGX_SOCKADDR_STRLEN, 1);

  445.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  446.                                    "ipv6only is not supported "
  447.                                    "on addr \"%*s\", ignored", len, buf);
  448.             }

  450.             continue;
  451. #else
  452.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  453.                                "bind ipv6only is not supported "
  454.                                "on this platform");
  455.             return NGX_CONF_ERROR;
  456. #endif
  457.         }

  459.         if (ngx_strcmp(value[i].data, "ssl") == 0) {
  460. #if (NGX_MAIL_SSL)
  461.             ls->ssl = 1;
  462.             continue;
  463. #else
  464.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  465.                                "the \"ssl\" parameter requires "
  466.                                "ngx_mail_ssl_module");
  467.             return NGX_CONF_ERROR;
  468. #endif
  469.         }

  471.         if (ngx_strncmp(value[i].data, "so_keepalive=", 13) == 0) {

  473.             if (ngx_strcmp(&value[i].data[13], "on") == 0) {
  474.                 ls->so_keepalive = 1;

  476.             } else if (ngx_strcmp(&value[i].data[13], "off") == 0) {
  477.                 ls->so_keepalive = 2;

  479.             } else {

  481. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  482.                 u_char     *p, *end;
  483.                 ngx_str_t   s;

  485.                 end = value[i].data + value[i].len;
  486.                 s.data = value[i].data + 13;

  488.                 p = ngx_strlchr(s.data, end, ':');
  489.                 if (p == NULL) {
  490.                     p = end;
  491.                 }

  493.                 if (p > s.data) {
  494.                     s.len = p - s.data;

  496.                     ls->tcp_keepidle = ngx_parse_time(&s, 1);
  497.                     if (ls->tcp_keepidle == (time_t) NGX_ERROR) {
  498.                         goto invalid_so_keepalive;
  499.                     }
  500.                 }

  502.                 s.data = (p < end) ? (p + 1) : end;

  504.                 p = ngx_strlchr(s.data, end, ':');
  505.                 if (p == NULL) {
  506.                     p = end;
  507.                 }

  509.                 if (p > s.data) {
  510.                     s.len = p - s.data;

  512.                     ls->tcp_keepintvl = ngx_parse_time(&s, 1);
  513.                     if (ls->tcp_keepintvl == (time_t) NGX_ERROR) {
  514.                         goto invalid_so_keepalive;
  515.                     }
  516.                 }

  518.                 s.data = (p < end) ? (p + 1) : end;

  520.                 if (s.data < end) {
  521.                     s.len = end - s.data;

  523.                     ls->tcp_keepcnt = ngx_atoi(s.data, s.len);
  524.                     if (ls->tcp_keepcnt == NGX_ERROR) {
  525.                         goto invalid_so_keepalive;
  526.                     }
  527.                 }

  529.                 if (ls->tcp_keepidle == 0 && ls->tcp_keepintvl == 0
  530.                     && ls->tcp_keepcnt == 0)
  531.                 {
  532.                     goto invalid_so_keepalive;
  533.                 }

  535.                 ls->so_keepalive = 1;

  537. #else

  539.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  540.                                    "the \"so_keepalive\" parameter accepts "
  541.                                    "only \"on\" or \"off\" on this platform");
  542.                 return NGX_CONF_ERROR;

  544. #endif
  545.             }

  547.             ls->bind = 1;

  549.             continue;

  551. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  552.         invalid_so_keepalive:

  554.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  555.                                "invalid so_keepalive value: \"%s\"",
  556.                                &value[i].data[13]);
  557.             return NGX_CONF_ERROR;
  558. #endif
  559.         }

  561.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  562.                            "the invalid \"%V\" parameter", &value[i]);
  563.         return NGX_CONF_ERROR;
  564.     }

  566.     return NGX_CONF_OK;
  567. }


  570. static char *
  571. ‌ngx_mail_core_protocol(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  572. {
  573.     ngx_mail_core_srv_conf_t  *cscf = conf;

  575.     ngx_str_t          *value;
  576.     ngx_uint_t          m;
  577.     ngx_mail_module_t  *module;

  579.     value = cf->args->elts;

  581.     for (m = 0; ngx_modules[m]; m++) {
  582.         if (ngx_modules[m]->type != NGX_MAIL_MODULE) {
  583.             continue;
  584.         }

  586.         module = ngx_modules[m]->ctx;

  588.         if (module->protocol
  589.             && ngx_strcmp(module->protocol->name.data, value[1].data) == 0)
  590.         {
  591.             cscf->protocol = module->protocol;

  593.             return NGX_CONF_OK;
  594.         }
  595.     }

  597.     ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  598.                        "unknown protocol \"%V\"", &value[1]);
  599.     return NGX_CONF_ERROR;
  600. }


  603. static char *
  604. ‌ngx_mail_core_resolver(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  605. {
  606.     ngx_mail_core_srv_conf_t  *cscf = conf;

  608.     ngx_str_t  *value;

  610.     value = cf->args->elts;

  612.     if (cscf->resolver != NGX_CONF_UNSET_PTR) {
  613.         return "is duplicate";
  614.     }

  616.     if (ngx_strcmp(value[1].data, "off") == 0) {
  617.         cscf->resolver = NULL;
  618.         return NGX_CONF_OK;
  619.     }

  621.     cscf->resolver = ngx_resolver_create(cf, &value[1], cf->args->nelts - 1);
  622.     if (cscf->resolver == NULL) {
  623.         return NGX_CONF_ERROR;
  624.     }

  626.     return NGX_CONF_OK;
  627. }


  630. char *
  631. ‌ngx_mail_capabilities(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  632. {
  633.     char  *p = conf;

  635.     ngx_str_t    *c, *value;
  636.     ngx_uint_t    i;
  637.     ngx_array_t  *a;

  639.     a = (ngx_array_t *) (p + cmd->offset);

  641.     value = cf->args->elts;

  643.     for (i = 1; i < cf->args->nelts; i++) {
  644.         c = ngx_array_push(a);
  645.         if (c == NULL) {
  646.             return NGX_CONF_ERROR;
  647.         }

  649.         *c = value[i];
  650.     }

  652.     return NGX_CONF_OK;
  653. }

One Level Up Top Level