Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

swh:1:snp:158a3f36b0bd3da461fb7458de44cfa2c94e4270
  • Code
  • Branches (0)
  • Releases (20)
    • Branches
    • Releases
      • 1.18.0-6ubuntu14.1
      • 1.18.0-6ubuntu14
      • 1.18.0-6ubuntu11.1
      • 1.18.0-6ubuntu11
      • 1.18.0-6ubuntu8.2
      • 1.18.0-6ubuntu8
      • 1.18.0-0ubuntu1.3
      • 1.17.10-0ubuntu1
      • 1.14.0-0ubuntu1.10
      • 1.10.3-0ubuntu0.16.04.5
      • 1.9.15-0ubuntu1
      • 1.4.6-1ubuntu3.9
      • 1.4.6-1ubuntu3
    • 2e49ddd
    • /
    • src
    • /
    • mail
    • /
    • ngx_mail.c
    Raw File Download

    To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
    Select below a type of object currently browsed in order to display its associated SWHID and permalink.

    • content
    • directory
    • snapshot
    • release
    content badge
    swh:1:cnt:3812e15179e35d52f30c2ba360ba62508a79cfce
    directory badge
    swh:1:dir:0c03764fd6b935d95453089931b66e4e130e50de
    snapshot badge
    swh:1:snp:158a3f36b0bd3da461fb7458de44cfa2c94e4270
    release badge
    swh:1:rel:7e9c2d14cba25cc2686b310679c48e0f8556d53e

    This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
    Select below a type of object currently browsed in order to generate citations for them.

    • content
    • directory
    • snapshot
    • release
    Generate software citation in BibTex format (requires biblatex-software package)
    Generating citation ...
    Generate software citation in BibTex format (requires biblatex-software package)
    Generating citation ...
    Generate software citation in BibTex format (requires biblatex-software package)
    Generating citation ...
    Generate software citation in BibTex format (requires biblatex-software package)
    Generating citation ...
    ngx_mail.c
    
    /*
     * Copyright (C) Igor Sysoev
     * Copyright (C) Nginx, Inc.
     */
    
    
    #include <ngx_config.h>
    #include <ngx_core.h>
    #include <ngx_event.h>
    #include <ngx_mail.h>
    
    
    static char *ngx_mail_block(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
    static ngx_int_t ngx_mail_add_ports(ngx_conf_t *cf, ngx_array_t *ports,
        ngx_mail_listen_t *listen);
    static char *ngx_mail_optimize_servers(ngx_conf_t *cf, ngx_array_t *ports);
    static ngx_int_t ngx_mail_add_addrs(ngx_conf_t *cf, ngx_mail_port_t *mport,
        ngx_mail_conf_addr_t *addr);
    #if (NGX_HAVE_INET6)
    static ngx_int_t ngx_mail_add_addrs6(ngx_conf_t *cf, ngx_mail_port_t *mport,
        ngx_mail_conf_addr_t *addr);
    #endif
    static ngx_int_t ngx_mail_cmp_conf_addrs(const void *one, const void *two);
    
    
    ngx_uint_t  ngx_mail_max_module;
    
    
    static ngx_command_t  ngx_mail_commands[] = {
    
        { ngx_string("mail"),
          NGX_MAIN_CONF|NGX_CONF_BLOCK|NGX_CONF_NOARGS,
          ngx_mail_block,
          0,
          0,
          NULL },
    
        { ngx_string("imap"),
          NGX_MAIN_CONF|NGX_CONF_BLOCK|NGX_CONF_NOARGS,
          ngx_mail_block,
          0,
          0,
          NULL },
    
          ngx_null_command
    };
    
    
    static ngx_core_module_t  ngx_mail_module_ctx = {
        ngx_string("mail"),
        NULL,
        NULL
    };
    
    
    ngx_module_t  ngx_mail_module = {
        NGX_MODULE_V1,
        &ngx_mail_module_ctx,                  /* module context */
        ngx_mail_commands,                     /* module directives */
        NGX_CORE_MODULE,                       /* module type */
        NULL,                                  /* init master */
        NULL,                                  /* init module */
        NULL,                                  /* init process */
        NULL,                                  /* init thread */
        NULL,                                  /* exit thread */
        NULL,                                  /* exit process */
        NULL,                                  /* exit master */
        NGX_MODULE_V1_PADDING
    };
    
    
    static char *
    ngx_mail_block(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
    {
        char                        *rv;
        ngx_uint_t                   i, m, mi, s;
        ngx_conf_t                   pcf;
        ngx_array_t                  ports;
        ngx_mail_listen_t           *listen;
        ngx_mail_module_t           *module;
        ngx_mail_conf_ctx_t         *ctx;
        ngx_mail_core_srv_conf_t   **cscfp;
        ngx_mail_core_main_conf_t   *cmcf;
    
        if (cmd->name.data[0] == 'i') {
            ngx_conf_log_error(NGX_LOG_WARN, cf, 0,
                               "the \"imap\" directive is deprecated, "
                               "use the \"mail\" directive instead");
        }
    
        /* the main mail context */
    
        ctx = ngx_pcalloc(cf->pool, sizeof(ngx_mail_conf_ctx_t));
        if (ctx == NULL) {
            return NGX_CONF_ERROR;
        }
    
        *(ngx_mail_conf_ctx_t **) conf = ctx;
    
        /* count the number of the http modules and set up their indices */
    
        ngx_mail_max_module = 0;
        for (m = 0; ngx_modules[m]; m++) {
            if (ngx_modules[m]->type != NGX_MAIL_MODULE) {
                continue;
            }
    
            ngx_modules[m]->ctx_index = ngx_mail_max_module++;
        }
    
    
        /* the mail main_conf context, it is the same in the all mail contexts */
    
        ctx->main_conf = ngx_pcalloc(cf->pool,
                                     sizeof(void *) * ngx_mail_max_module);
        if (ctx->main_conf == NULL) {
            return NGX_CONF_ERROR;
        }
    
    
        /*
         * the mail null srv_conf context, it is used to merge
         * the server{}s' srv_conf's
         */
    
        ctx->srv_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_mail_max_module);
        if (ctx->srv_conf == NULL) {
            return NGX_CONF_ERROR;
        }
    
    
        /*
         * create the main_conf's, the null srv_conf's, and the null loc_conf's
         * of the all mail modules
         */
    
        for (m = 0; ngx_modules[m]; m++) {
            if (ngx_modules[m]->type != NGX_MAIL_MODULE) {
                continue;
            }
    
            module = ngx_modules[m]->ctx;
            mi = ngx_modules[m]->ctx_index;
    
            if (module->create_main_conf) {
                ctx->main_conf[mi] = module->create_main_conf(cf);
                if (ctx->main_conf[mi] == NULL) {
                    return NGX_CONF_ERROR;
                }
            }
    
            if (module->create_srv_conf) {
                ctx->srv_conf[mi] = module->create_srv_conf(cf);
                if (ctx->srv_conf[mi] == NULL) {
                    return NGX_CONF_ERROR;
                }
            }
        }
    
    
        /* parse inside the mail{} block */
    
        pcf = *cf;
        cf->ctx = ctx;
    
        cf->module_type = NGX_MAIL_MODULE;
        cf->cmd_type = NGX_MAIL_MAIN_CONF;
        rv = ngx_conf_parse(cf, NULL);
    
        if (rv != NGX_CONF_OK) {
            *cf = pcf;
            return rv;
        }
    
    
        /* init mail{} main_conf's, merge the server{}s' srv_conf's */
    
        cmcf = ctx->main_conf[ngx_mail_core_module.ctx_index];
        cscfp = cmcf->servers.elts;
    
        for (m = 0; ngx_modules[m]; m++) {
            if (ngx_modules[m]->type != NGX_MAIL_MODULE) {
                continue;
            }
    
            module = ngx_modules[m]->ctx;
            mi = ngx_modules[m]->ctx_index;
    
            /* init mail{} main_conf's */
    
            cf->ctx = ctx;
    
            if (module->init_main_conf) {
                rv = module->init_main_conf(cf, ctx->main_conf[mi]);
                if (rv != NGX_CONF_OK) {
                    *cf = pcf;
                    return rv;
                }
            }
    
            for (s = 0; s < cmcf->servers.nelts; s++) {
    
                /* merge the server{}s' srv_conf's */
    
                cf->ctx = cscfp[s]->ctx;
    
                if (module->merge_srv_conf) {
                    rv = module->merge_srv_conf(cf,
                                                ctx->srv_conf[mi],
                                                cscfp[s]->ctx->srv_conf[mi]);
                    if (rv != NGX_CONF_OK) {
                        *cf = pcf;
                        return rv;
                    }
                }
            }
        }
    
        *cf = pcf;
    
    
        if (ngx_array_init(&ports, cf->temp_pool, 4, sizeof(ngx_mail_conf_port_t))
            != NGX_OK)
        {
            return NGX_CONF_ERROR;
        }
    
        listen = cmcf->listen.elts;
    
        for (i = 0; i < cmcf->listen.nelts; i++) {
            if (ngx_mail_add_ports(cf, &ports, &listen[i]) != NGX_OK) {
                return NGX_CONF_ERROR;
            }
        }
    
        return ngx_mail_optimize_servers(cf, &ports);
    }
    
    
    static ngx_int_t
    ngx_mail_add_ports(ngx_conf_t *cf, ngx_array_t *ports,
        ngx_mail_listen_t *listen)
    {
        in_port_t              p;
        ngx_uint_t             i;
        struct sockaddr       *sa;
        struct sockaddr_in    *sin;
        ngx_mail_conf_port_t  *port;
        ngx_mail_conf_addr_t  *addr;
    #if (NGX_HAVE_INET6)
        struct sockaddr_in6   *sin6;
    #endif
    
        sa = (struct sockaddr *) &listen->sockaddr;
    
        switch (sa->sa_family) {
    
    #if (NGX_HAVE_INET6)
        case AF_INET6:
            sin6 = (struct sockaddr_in6 *) sa;
            p = sin6->sin6_port;
            break;
    #endif
    
    #if (NGX_HAVE_UNIX_DOMAIN)
        case AF_UNIX:
            p = 0;
            break;
    #endif
    
        default: /* AF_INET */
            sin = (struct sockaddr_in *) sa;
            p = sin->sin_port;
            break;
        }
    
        port = ports->elts;
        for (i = 0; i < ports->nelts; i++) {
            if (p == port[i].port && sa->sa_family == port[i].family) {
    
                /* a port is already in the port list */
    
                port = &port[i];
                goto found;
            }
        }
    
        /* add a port to the port list */
    
        port = ngx_array_push(ports);
        if (port == NULL) {
            return NGX_ERROR;
        }
    
        port->family = sa->sa_family;
        port->port = p;
    
        if (ngx_array_init(&port->addrs, cf->temp_pool, 2,
                           sizeof(ngx_mail_conf_addr_t))
            != NGX_OK)
        {
            return NGX_ERROR;
        }
    
    found:
    
        addr = ngx_array_push(&port->addrs);
        if (addr == NULL) {
            return NGX_ERROR;
        }
    
        addr->sockaddr = (struct sockaddr *) &listen->sockaddr;
        addr->socklen = listen->socklen;
        addr->ctx = listen->ctx;
        addr->bind = listen->bind;
        addr->wildcard = listen->wildcard;
        addr->so_keepalive = listen->so_keepalive;
    #if (NGX_HAVE_KEEPALIVE_TUNABLE)
        addr->tcp_keepidle = listen->tcp_keepidle;
        addr->tcp_keepintvl = listen->tcp_keepintvl;
        addr->tcp_keepcnt = listen->tcp_keepcnt;
    #endif
    #if (NGX_MAIL_SSL)
        addr->ssl = listen->ssl;
    #endif
    #if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
        addr->ipv6only = listen->ipv6only;
    #endif
    
        return NGX_OK;
    }
    
    
    static char *
    ngx_mail_optimize_servers(ngx_conf_t *cf, ngx_array_t *ports)
    {
        ngx_uint_t             i, p, last, bind_wildcard;
        ngx_listening_t       *ls;
        ngx_mail_port_t       *mport;
        ngx_mail_conf_port_t  *port;
        ngx_mail_conf_addr_t  *addr;
    
        port = ports->elts;
        for (p = 0; p < ports->nelts; p++) {
    
            ngx_sort(port[p].addrs.elts, (size_t) port[p].addrs.nelts,
                     sizeof(ngx_mail_conf_addr_t), ngx_mail_cmp_conf_addrs);
    
            addr = port[p].addrs.elts;
            last = port[p].addrs.nelts;
    
            /*
             * if there is the binding to the "*:port" then we need to bind()
             * to the "*:port" only and ignore the other bindings
             */
    
            if (addr[last - 1].wildcard) {
                addr[last - 1].bind = 1;
                bind_wildcard = 1;
    
            } else {
                bind_wildcard = 0;
            }
    
            i = 0;
    
            while (i < last) {
    
                if (bind_wildcard && !addr[i].bind) {
                    i++;
                    continue;
                }
    
                ls = ngx_create_listening(cf, addr[i].sockaddr, addr[i].socklen);
                if (ls == NULL) {
                    return NGX_CONF_ERROR;
                }
    
                ls->addr_ntop = 1;
                ls->handler = ngx_mail_init_connection;
                ls->pool_size = 256;
    
                /* TODO: error_log directive */
                ls->logp = &cf->cycle->new_log;
                ls->log.data = &ls->addr_text;
                ls->log.handler = ngx_accept_log_error;
    
                ls->keepalive = addr[i].so_keepalive;
    #if (NGX_HAVE_KEEPALIVE_TUNABLE)
                ls->keepidle = addr[i].tcp_keepidle;
                ls->keepintvl = addr[i].tcp_keepintvl;
                ls->keepcnt = addr[i].tcp_keepcnt;
    #endif
    
    #if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
                ls->ipv6only = addr[i].ipv6only;
    #endif
    
                mport = ngx_palloc(cf->pool, sizeof(ngx_mail_port_t));
                if (mport == NULL) {
                    return NGX_CONF_ERROR;
                }
    
                ls->servers = mport;
    
                if (i == last - 1) {
                    mport->naddrs = last;
    
                } else {
                    mport->naddrs = 1;
                    i = 0;
                }
    
                switch (ls->sockaddr->sa_family) {
    #if (NGX_HAVE_INET6)
                case AF_INET6:
                    if (ngx_mail_add_addrs6(cf, mport, addr) != NGX_OK) {
                        return NGX_CONF_ERROR;
                    }
                    break;
    #endif
                default: /* AF_INET */
                    if (ngx_mail_add_addrs(cf, mport, addr) != NGX_OK) {
                        return NGX_CONF_ERROR;
                    }
                    break;
                }
    
                addr++;
                last--;
            }
        }
    
        return NGX_CONF_OK;
    }
    
    
    static ngx_int_t
    ngx_mail_add_addrs(ngx_conf_t *cf, ngx_mail_port_t *mport,
        ngx_mail_conf_addr_t *addr)
    {
        u_char              *p;
        size_t               len;
        ngx_uint_t           i;
        ngx_mail_in_addr_t  *addrs;
        struct sockaddr_in  *sin;
        u_char               buf[NGX_SOCKADDR_STRLEN];
    
        mport->addrs = ngx_pcalloc(cf->pool,
                                   mport->naddrs * sizeof(ngx_mail_in_addr_t));
        if (mport->addrs == NULL) {
            return NGX_ERROR;
        }
    
        addrs = mport->addrs;
    
        for (i = 0; i < mport->naddrs; i++) {
    
            sin = (struct sockaddr_in *) addr[i].sockaddr;
            addrs[i].addr = sin->sin_addr.s_addr;
    
            addrs[i].conf.ctx = addr[i].ctx;
    #if (NGX_MAIL_SSL)
            addrs[i].conf.ssl = addr[i].ssl;
    #endif
    
            len = ngx_sock_ntop(addr[i].sockaddr, buf, NGX_SOCKADDR_STRLEN, 1);
    
            p = ngx_pnalloc(cf->pool, len);
            if (p == NULL) {
                return NGX_ERROR;
            }
    
            ngx_memcpy(p, buf, len);
    
            addrs[i].conf.addr_text.len = len;
            addrs[i].conf.addr_text.data = p;
        }
    
        return NGX_OK;
    }
    
    
    #if (NGX_HAVE_INET6)
    
    static ngx_int_t
    ngx_mail_add_addrs6(ngx_conf_t *cf, ngx_mail_port_t *mport,
        ngx_mail_conf_addr_t *addr)
    {
        u_char               *p;
        size_t                len;
        ngx_uint_t            i;
        ngx_mail_in6_addr_t  *addrs6;
        struct sockaddr_in6  *sin6;
        u_char                buf[NGX_SOCKADDR_STRLEN];
    
        mport->addrs = ngx_pcalloc(cf->pool,
                                   mport->naddrs * sizeof(ngx_mail_in6_addr_t));
        if (mport->addrs == NULL) {
            return NGX_ERROR;
        }
    
        addrs6 = mport->addrs;
    
        for (i = 0; i < mport->naddrs; i++) {
    
            sin6 = (struct sockaddr_in6 *) addr[i].sockaddr;
            addrs6[i].addr6 = sin6->sin6_addr;
    
            addrs6[i].conf.ctx = addr[i].ctx;
    #if (NGX_MAIL_SSL)
            addrs6[i].conf.ssl = addr[i].ssl;
    #endif
    
            len = ngx_sock_ntop(addr[i].sockaddr, buf, NGX_SOCKADDR_STRLEN, 1);
    
            p = ngx_pnalloc(cf->pool, len);
            if (p == NULL) {
                return NGX_ERROR;
            }
    
            ngx_memcpy(p, buf, len);
    
            addrs6[i].conf.addr_text.len = len;
            addrs6[i].conf.addr_text.data = p;
        }
    
        return NGX_OK;
    }
    
    #endif
    
    
    static ngx_int_t
    ngx_mail_cmp_conf_addrs(const void *one, const void *two)
    {
        ngx_mail_conf_addr_t  *first, *second;
    
        first = (ngx_mail_conf_addr_t *) one;
        second = (ngx_mail_conf_addr_t *) two;
    
        if (first->wildcard) {
            /* a wildcard must be the last resort, shift it to the end */
            return 1;
        }
    
        if (second->wildcard) {
            /* a wildcard must be the last resort, shift it to the end */
            return -1;
        }
    
        if (first->bind && !second->bind) {
            /* shift explicit bind()ed addresses to the start */
            return -1;
        }
    
        if (!first->bind && second->bind) {
            /* shift explicit bind()ed addresses to the start */
            return 1;
        }
    
        /* do not sort by default */
    
        return 0;
    }
    

    back to top

    Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
    The source code of Software Heritage itself is available on our development forge.
    The source code files archived by Software Heritage are available under their own copyright and licenses.
    Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API