nginx/src/mail/ngx_mail.c

   1
   2 /*
   3  * Copyright (C) Igor Sysoev
   4  */
   5
   6
   7 #include <ngx_config.h>
   8 #include <ngx_core.h>
   9 #include <ngx_event.h>
  10 #include <ngx_mail.h>
  11
  12
  13 static char *ngx_mail_block(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  14 static ngx_int_t ngx_mail_cmp_conf_in_addrs(const void *one, const void *two);
  15
  16
  17 ngx_uint_t  ngx_mail_max_module;
  18
  19
  20 static ngx_command_t  ngx_mail_commands[] = {
  21
  22     { ngx_string("mail"),
  23       NGX_MAIN_CONF|NGX_CONF_BLOCK|NGX_CONF_NOARGS,
  24       ngx_mail_block,
  25       0,
  26       0,
  27       NULL },
  28
  29     { ngx_string("imap"),
  30       NGX_MAIN_CONF|NGX_CONF_BLOCK|NGX_CONF_NOARGS,
  31       ngx_mail_block,
  32       0,
  33       0,
  34       NULL },
  35
  36       ngx_null_command
  37 };
  38
  39
  40 static ngx_core_module_t  ngx_mail_module_ctx = {
  41     ngx_string("mail"),
  42     NULL,
  43     NULL
  44 };
  45
  46
  47 ngx_module_t  ngx_mail_module = {
  48     NGX_MODULE_V1,
  49     &ngx_mail_module_ctx,                  /* module context */
  50     ngx_mail_commands,                     /* module directives */
  51     NGX_CORE_MODULE,                       /* module type */
  52     NULL,                                  /* init master */
  53     NULL,                                  /* init module */
  54     NULL,                                  /* init process */
  55     NULL,                                  /* init thread */
  56     NULL,                                  /* exit thread */
  57     NULL,                                  /* exit process */
  58     NULL,                                  /* exit master */
  59     NGX_MODULE_V1_PADDING
  60 };
  61
  62
  63 static char *
  64 ngx_mail_block(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  65 {
  66     char                        *rv;
  67     u_char                      *text;
  68     size_t                       len;
  69     ngx_uint_t                   i, a, l, m, mi, s, p, last, bind_all, done;
  70     ngx_conf_t                   pcf;
  71     ngx_array_t                  in_ports;
  72     ngx_listening_t             *ls;
  73     ngx_mail_listen_t           *imls;
  74     ngx_mail_module_t           *module;
  75     ngx_mail_in_port_t          *imip;
  76     ngx_mail_conf_ctx_t         *ctx;
  77     ngx_mail_conf_in_port_t     *in_port;
  78     ngx_mail_conf_in_addr_t     *in_addr;
  79     ngx_mail_core_srv_conf_t   **cscfp;
  80     ngx_mail_core_main_conf_t   *cmcf;
  81
  82     if (cmd->name.data[0] == 'i') {
  83         ngx_conf_log_error(NGX_LOG_WARN, cf, 0,
  84                            "the \"imap\" directive is deprecated, "
  85                            "use the \"mail\" directive instead");
  86     }
  87
  88     /* the main mail context */
  89
  90     ctx = ngx_pcalloc(cf->pool, sizeof(ngx_mail_conf_ctx_t));
  91     if (ctx == NULL) {
  92         return NGX_CONF_ERROR;
  93     }
  94
  95     *(ngx_mail_conf_ctx_t **) conf = ctx;
  96
  97     /* count the number of the http modules and set up their indices */
  98
  99     ngx_mail_max_module = 0;
 100     for (m = 0; ngx_modules[m]; m++) {
 101         if (ngx_modules[m]->type != NGX_MAIL_MODULE) {
 102             continue;
 103         }
 104
 105         ngx_modules[m]->ctx_index = ngx_mail_max_module++;
 106     }
 107
 108
 109     /* the mail main_conf context, it is the same in the all mail contexts */
 110
 111     ctx->main_conf = ngx_pcalloc(cf->pool,
 112                                  sizeof(void *) * ngx_mail_max_module);
 113     if (ctx->main_conf == NULL) {
 114         return NGX_CONF_ERROR;
 115     }
 116
 117
 118     /*
 119      * the mail null srv_conf context, it is used to merge
 120      * the server{}s' srv_conf's
 121      */
 122
 123     ctx->srv_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_mail_max_module);
 124     if (ctx->srv_conf == NULL) {
 125         return NGX_CONF_ERROR;
 126     }
 127
 128
 129     /*
 130      * create the main_conf's, the null srv_conf's, and the null loc_conf's
 131      * of the all mail modules
 132      */
 133
 134     for (m = 0; ngx_modules[m]; m++) {
 135         if (ngx_modules[m]->type != NGX_MAIL_MODULE) {
 136             continue;
 137         }
 138
 139         module = ngx_modules[m]->ctx;
 140         mi = ngx_modules[m]->ctx_index;
 141
 142         if (module->create_main_conf) {
 143             ctx->main_conf[mi] = module->create_main_conf(cf);
 144             if (ctx->main_conf[mi] == NULL) {
 145                 return NGX_CONF_ERROR;
 146             }
 147         }
 148
 149         if (module->create_srv_conf) {
 150             ctx->srv_conf[mi] = module->create_srv_conf(cf);
 151             if (ctx->srv_conf[mi] == NULL) {
 152                 return NGX_CONF_ERROR;
 153             }
 154         }
 155     }
 156
 157
 158     /* parse inside the mail{} block */
 159
 160     pcf = *cf;
 161     cf->ctx = ctx;
 162
 163     cf->module_type = NGX_MAIL_MODULE;
 164     cf->cmd_type = NGX_MAIL_MAIN_CONF;
 165     rv = ngx_conf_parse(cf, NULL);
 166
 167     if (rv != NGX_CONF_OK) {
 168         *cf = pcf;
 169         return rv;
 170     }
 171
 172
 173     /* init mail{} main_conf's, merge the server{}s' srv_conf's */
 174
 175     cmcf = ctx->main_conf[ngx_mail_core_module.ctx_index];
 176     cscfp = cmcf->servers.elts;
 177
 178     for (m = 0; ngx_modules[m]; m++) {
 179         if (ngx_modules[m]->type != NGX_MAIL_MODULE) {
 180             continue;
 181         }
 182
 183         module = ngx_modules[m]->ctx;
 184         mi = ngx_modules[m]->ctx_index;
 185
 186         /* init mail{} main_conf's */
 187
 188         cf->ctx = ctx;
 189
 190         if (module->init_main_conf) {
 191             rv = module->init_main_conf(cf, ctx->main_conf[mi]);
 192             if (rv != NGX_CONF_OK) {
 193                 *cf = pcf;
 194                 return rv;
 195             }
 196         }
 197
 198         for (s = 0; s < cmcf->servers.nelts; s++) {
 199
 200             /* merge the server{}s' srv_conf's */
 201
 202             cf->ctx = cscfp[s]->ctx;
 203
 204             if (module->merge_srv_conf) {
 205                 rv = module->merge_srv_conf(cf,
 206                                             ctx->srv_conf[mi],
 207                                             cscfp[s]->ctx->srv_conf[mi]);
 208                 if (rv != NGX_CONF_OK) {
 209                     *cf = pcf;
 210                     return rv;
 211                 }
 212             }
 213         }
 214     }
 215
 216     *cf = pcf;
 217
 218
 219     if (ngx_array_init(&in_ports, cf->temp_pool, 4,
 220                        sizeof(ngx_mail_conf_in_port_t))
 221         != NGX_OK)
 222     {
 223         return NGX_CONF_ERROR;
 224     }
 225
 226     imls = cmcf->listen.elts;
 227
 228     for (l = 0; l < cmcf->listen.nelts; l++) {
 229
 230         /* AF_INET only */
 231
 232         in_port = in_ports.elts;
 233         for (p = 0; p < in_ports.nelts; p++) {
 234             if (in_port[p].port == imls[l].port) {
 235                 in_port = &in_port[p];
 236                 goto found;
 237             }
 238         }
 239
 240         in_port = ngx_array_push(&in_ports);
 241         if (in_port == NULL) {
 242             return NGX_CONF_ERROR;
 243         }
 244
 245         in_port->port = imls[l].port;
 246
 247         if (ngx_array_init(&in_port->addrs, cf->temp_pool, 2,
 248                            sizeof(ngx_mail_conf_in_addr_t))
 249             != NGX_OK)
 250         {
 251             return NGX_CONF_ERROR;
 252         }
 253
 254     found:
 255
 256         in_addr = ngx_array_push(&in_port->addrs);
 257         if (in_addr == NULL) {
 258             return NGX_CONF_ERROR;
 259         }
 260
 261         in_addr->addr = imls[l].addr;
 262         in_addr->ctx = imls[l].ctx;
 263         in_addr->bind = imls[l].bind;
 264 #if (NGX_MAIL_SSL)
 265         in_addr->ssl = imls[l].ssl;
 266 #endif
 267     }
 268
 269     /* optimize the lists of ports and addresses */
 270
 271     /* AF_INET only */
 272
 273     in_port = in_ports.elts;
 274     for (p = 0; p < in_ports.nelts; p++) {
 275
 276         ngx_sort(in_port[p].addrs.elts, (size_t) in_port[p].addrs.nelts,
 277                  sizeof(ngx_mail_conf_in_addr_t), ngx_mail_cmp_conf_in_addrs);
 278
 279         in_addr = in_port[p].addrs.elts;
 280         last = in_port[p].addrs.nelts;
 281
 282         /*
 283          * if there is the binding to the "*:port" then we need to bind()
 284          * to the "*:port" only and ignore the other bindings
 285          */
 286
 287         if (in_addr[last - 1].addr == INADDR_ANY) {
 288             in_addr[last - 1].bind = 1;
 289             bind_all = 0;
 290
 291         } else {
 292             bind_all = 1;
 293         }
 294
 295         for (a = 0; a < last; /* void */ ) {
 296
 297             if (!bind_all && !in_addr[a].bind) {
 298                 a++;
 299                 continue;
 300             }
 301
 302             ls = ngx_listening_inet_stream_socket(cf, in_addr[a].addr,
 303                                                   in_port[p].port);
 304             if (ls == NULL) {
 305                 return NGX_CONF_ERROR;
 306             }
 307
 308             ls->backlog = NGX_LISTEN_BACKLOG;
 309             ls->rcvbuf = -1;
 310             ls->sndbuf = -1;
 311
 312             ls->addr_ntop = 1;
 313             ls->handler = ngx_mail_init_connection;
 314             ls->pool_size = 256;
 315
 316             /* STUB */
 317             ls->log = *cf->cycle->new_log;
 318             ls->log.data = &ls->addr_text;
 319             ls->log.handler = ngx_accept_log_error;
 320             /**/
 321
 322             imip = ngx_palloc(cf->pool, sizeof(ngx_mail_in_port_t));
 323             if (imip == NULL) {
 324                 return NGX_CONF_ERROR;
 325             }
 326
 327             ls->servers = imip;
 328
 329             in_addr = in_port[p].addrs.elts;
 330
 331             if (in_addr[a].bind && in_addr[a].addr != INADDR_ANY) {
 332                 imip->naddrs = 1;
 333                 done = 0;
 334
 335             } else if (in_port[p].addrs.nelts > 1
 336                        && in_addr[last - 1].addr == INADDR_ANY)
 337             {
 338                 imip->naddrs = last;
 339                 done = 1;
 340
 341             } else {
 342                 imip->naddrs = 1;
 343                 done = 0;
 344             }
 345
 346 #if 0
 347             ngx_log_error(NGX_LOG_ALERT, cf->log, 0,
 348                           "%ui: %V %d %ui %ui",
 349                           a, &ls->addr_text, in_addr[a].bind,
 350                           imip->naddrs, last);
 351 #endif
 352
 353             imip->addrs = ngx_pcalloc(cf->pool,
 354                                     imip->naddrs * sizeof(ngx_mail_in_addr_t));
 355             if (imip->addrs == NULL) {
 356                 return NGX_CONF_ERROR;
 357             }
 358
 359             for (i = 0; i < imip->naddrs; i++) {
 360                 imip->addrs[i].addr = in_addr[i].addr;
 361                 imip->addrs[i].ctx = in_addr[i].ctx;
 362
 363                 text = ngx_pnalloc(cf->pool,
 364                                    NGX_INET_ADDRSTRLEN + sizeof(":65535") - 1);
 365                 if (text == NULL) {
 366                     return NGX_CONF_ERROR;
 367                 }
 368
 369                 len = ngx_inet_ntop(AF_INET, &in_addr[i].addr, text,
 370                                     NGX_INET_ADDRSTRLEN);
 371
 372                 len = ngx_sprintf(text + len, ":%d", in_port[p].port) - text;
 373
 374                 imip->addrs[i].addr_text.len = len;
 375                 imip->addrs[i].addr_text.data = text;
 376
 377 #if (NGX_MAIL_SSL)
 378                 imip->addrs[i].ssl = in_addr[i].ssl;
 379 #endif
 380             }
 381
 382             if (done) {
 383                 break;
 384             }
 385
 386             in_addr++;
 387             in_port[p].addrs.elts = in_addr;
 388             last--;
 389
 390             a = 0;
 391         }
 392     }
 393
 394     return NGX_CONF_OK;
 395 }
 396
 397
 398 static ngx_int_t
 399 ngx_mail_cmp_conf_in_addrs(const void *one, const void *two)
 400 {
 401     ngx_mail_conf_in_addr_t  *first, *second;
 402
 403     first = (ngx_mail_conf_in_addr_t *) one;
 404     second = (ngx_mail_conf_in_addr_t *) two;
 405
 406     if (first->addr == INADDR_ANY) {
 407         /* the INADDR_ANY must be the last resort, shift it to the end */
 408         return 1;
 409     }
 410
 411     if (first->bind && !second->bind) {
 412         /* shift explicit bind()ed addresses to the start */
 413         return -1;
 414     }
 415
 416     if (!first->bind && second->bind) {
 417         /* shift explicit bind()ed addresses to the start */
 418         return 1;
 419     }
 420
 421     /* do not sort by default */
 422
 423     return 0;
 424 }