290
|
1
|
|
2 /*
|
|
3 * Copyright (C) Igor Sysoev
|
|
4 */
|
|
5
|
|
6
|
|
7 #include <ngx_config.h>
|
|
8 #include <ngx_core.h>
|
|
9 #include <ngx_mail.h>
|
|
10
|
|
11
|
632
|
12 #define NGX_DEFAULT_CIPHERS "HIGH:!aNULL:!MD5"
|
|
13 #define NGX_DEFAULT_ECDH_CURVE "prime256v1"
|
290
|
14
|
|
15
|
|
16 static void *ngx_mail_ssl_create_conf(ngx_conf_t *cf);
|
|
17 static char *ngx_mail_ssl_merge_conf(ngx_conf_t *cf, void *parent, void *child);
|
404
|
18
|
|
19 static char *ngx_mail_ssl_enable(ngx_conf_t *cf, ngx_command_t *cmd,
|
|
20 void *conf);
|
|
21 static char *ngx_mail_ssl_starttls(ngx_conf_t *cf, ngx_command_t *cmd,
|
|
22 void *conf);
|
290
|
23 static char *ngx_mail_ssl_session_cache(ngx_conf_t *cf, ngx_command_t *cmd,
|
|
24 void *conf);
|
|
25
|
|
26
|
|
27 static ngx_conf_enum_t ngx_http_starttls_state[] = {
|
|
28 { ngx_string("off"), NGX_MAIL_STARTTLS_OFF },
|
|
29 { ngx_string("on"), NGX_MAIL_STARTTLS_ON },
|
|
30 { ngx_string("only"), NGX_MAIL_STARTTLS_ONLY },
|
|
31 { ngx_null_string, 0 }
|
|
32 };
|
|
33
|
|
34
|
|
35
|
|
36 static ngx_conf_bitmask_t ngx_mail_ssl_protocols[] = {
|
|
37 { ngx_string("SSLv2"), NGX_SSL_SSLv2 },
|
|
38 { ngx_string("SSLv3"), NGX_SSL_SSLv3 },
|
|
39 { ngx_string("TLSv1"), NGX_SSL_TLSv1 },
|
|
40 { ngx_null_string, 0 }
|
|
41 };
|
|
42
|
|
43
|
|
44 static ngx_command_t ngx_mail_ssl_commands[] = {
|
|
45
|
|
46 { ngx_string("ssl"),
|
|
47 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_FLAG,
|
404
|
48 ngx_mail_ssl_enable,
|
290
|
49 NGX_MAIL_SRV_CONF_OFFSET,
|
|
50 offsetof(ngx_mail_ssl_conf_t, enable),
|
|
51 NULL },
|
|
52
|
|
53 { ngx_string("starttls"),
|
|
54 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
|
404
|
55 ngx_mail_ssl_starttls,
|
290
|
56 NGX_MAIL_SRV_CONF_OFFSET,
|
|
57 offsetof(ngx_mail_ssl_conf_t, starttls),
|
|
58 ngx_http_starttls_state },
|
|
59
|
|
60 { ngx_string("ssl_certificate"),
|
|
61 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
|
|
62 ngx_conf_set_str_slot,
|
|
63 NGX_MAIL_SRV_CONF_OFFSET,
|
|
64 offsetof(ngx_mail_ssl_conf_t, certificate),
|
|
65 NULL },
|
|
66
|
|
67 { ngx_string("ssl_certificate_key"),
|
|
68 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
|
|
69 ngx_conf_set_str_slot,
|
|
70 NGX_MAIL_SRV_CONF_OFFSET,
|
|
71 offsetof(ngx_mail_ssl_conf_t, certificate_key),
|
|
72 NULL },
|
|
73
|
380
|
74 { ngx_string("ssl_dhparam"),
|
|
75 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
|
|
76 ngx_conf_set_str_slot,
|
|
77 NGX_MAIL_SRV_CONF_OFFSET,
|
|
78 offsetof(ngx_mail_ssl_conf_t, dhparam),
|
|
79 NULL },
|
|
80
|
632
|
81 { ngx_string("ssl_ecdh_curve"),
|
|
82 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
|
|
83 ngx_conf_set_str_slot,
|
|
84 NGX_MAIL_SRV_CONF_OFFSET,
|
|
85 offsetof(ngx_mail_ssl_conf_t, ecdh_curve),
|
|
86 NULL },
|
|
87
|
290
|
88 { ngx_string("ssl_protocols"),
|
|
89 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_1MORE,
|
|
90 ngx_conf_set_bitmask_slot,
|
|
91 NGX_MAIL_SRV_CONF_OFFSET,
|
|
92 offsetof(ngx_mail_ssl_conf_t, protocols),
|
|
93 &ngx_mail_ssl_protocols },
|
|
94
|
|
95 { ngx_string("ssl_ciphers"),
|
|
96 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
|
|
97 ngx_conf_set_str_slot,
|
|
98 NGX_MAIL_SRV_CONF_OFFSET,
|
|
99 offsetof(ngx_mail_ssl_conf_t, ciphers),
|
|
100 NULL },
|
|
101
|
|
102 { ngx_string("ssl_prefer_server_ciphers"),
|
|
103 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_FLAG,
|
|
104 ngx_conf_set_flag_slot,
|
|
105 NGX_MAIL_SRV_CONF_OFFSET,
|
|
106 offsetof(ngx_mail_ssl_conf_t, prefer_server_ciphers),
|
|
107 NULL },
|
|
108
|
|
109 { ngx_string("ssl_session_cache"),
|
|
110 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE12,
|
|
111 ngx_mail_ssl_session_cache,
|
|
112 NGX_MAIL_SRV_CONF_OFFSET,
|
|
113 0,
|
|
114 NULL },
|
|
115
|
|
116 { ngx_string("ssl_session_timeout"),
|
|
117 NGX_MAIL_MAIN_CONF|NGX_MAIL_SRV_CONF|NGX_CONF_TAKE1,
|
|
118 ngx_conf_set_sec_slot,
|
|
119 NGX_MAIL_SRV_CONF_OFFSET,
|
|
120 offsetof(ngx_mail_ssl_conf_t, session_timeout),
|
|
121 NULL },
|
|
122
|
|
123 ngx_null_command
|
|
124 };
|
|
125
|
|
126
|
|
127 static ngx_mail_module_t ngx_mail_ssl_module_ctx = {
|
336
|
128 NULL, /* protocol */
|
|
129
|
290
|
130 NULL, /* create main configuration */
|
|
131 NULL, /* init main configuration */
|
|
132
|
|
133 ngx_mail_ssl_create_conf, /* create server configuration */
|
|
134 ngx_mail_ssl_merge_conf /* merge server configuration */
|
|
135 };
|
|
136
|
|
137
|
|
138 ngx_module_t ngx_mail_ssl_module = {
|
|
139 NGX_MODULE_V1,
|
|
140 &ngx_mail_ssl_module_ctx, /* module context */
|
|
141 ngx_mail_ssl_commands, /* module directives */
|
|
142 NGX_MAIL_MODULE, /* module type */
|
|
143 NULL, /* init master */
|
|
144 NULL, /* init module */
|
|
145 NULL, /* init process */
|
|
146 NULL, /* init thread */
|
|
147 NULL, /* exit thread */
|
|
148 NULL, /* exit process */
|
|
149 NULL, /* exit master */
|
|
150 NGX_MODULE_V1_PADDING
|
|
151 };
|
|
152
|
|
153
|
|
154 static ngx_str_t ngx_mail_ssl_sess_id_ctx = ngx_string("MAIL");
|
|
155
|
|
156
|
|
157 static void *
|
|
158 ngx_mail_ssl_create_conf(ngx_conf_t *cf)
|
|
159 {
|
|
160 ngx_mail_ssl_conf_t *scf;
|
|
161
|
|
162 scf = ngx_pcalloc(cf->pool, sizeof(ngx_mail_ssl_conf_t));
|
|
163 if (scf == NULL) {
|
496
|
164 return NULL;
|
290
|
165 }
|
|
166
|
|
167 /*
|
|
168 * set by ngx_pcalloc():
|
|
169 *
|
|
170 * scf->protocols = 0;
|
380
|
171 * scf->certificate = { 0, NULL };
|
|
172 * scf->certificate_key = { 0, NULL };
|
|
173 * scf->dhparam = { 0, NULL };
|
632
|
174 * scf->ecdh_curve = { 0, NULL };
|
570
|
175 * scf->ciphers = { 0, NULL };
|
290
|
176 * scf->shm_zone = NULL;
|
|
177 */
|
|
178
|
|
179 scf->enable = NGX_CONF_UNSET;
|
482
|
180 scf->starttls = NGX_CONF_UNSET_UINT;
|
290
|
181 scf->prefer_server_ciphers = NGX_CONF_UNSET;
|
|
182 scf->builtin_session_cache = NGX_CONF_UNSET;
|
|
183 scf->session_timeout = NGX_CONF_UNSET;
|
|
184
|
|
185 return scf;
|
|
186 }
|
|
187
|
|
188
|
|
189 static char *
|
|
190 ngx_mail_ssl_merge_conf(ngx_conf_t *cf, void *parent, void *child)
|
|
191 {
|
|
192 ngx_mail_ssl_conf_t *prev = parent;
|
|
193 ngx_mail_ssl_conf_t *conf = child;
|
|
194
|
404
|
195 char *mode;
|
290
|
196 ngx_pool_cleanup_t *cln;
|
|
197
|
|
198 ngx_conf_merge_value(conf->enable, prev->enable, 0);
|
404
|
199 ngx_conf_merge_uint_value(conf->starttls, prev->starttls,
|
|
200 NGX_MAIL_STARTTLS_OFF);
|
290
|
201
|
|
202 ngx_conf_merge_value(conf->session_timeout,
|
|
203 prev->session_timeout, 300);
|
|
204
|
|
205 ngx_conf_merge_value(conf->prefer_server_ciphers,
|
|
206 prev->prefer_server_ciphers, 0);
|
|
207
|
|
208 ngx_conf_merge_bitmask_value(conf->protocols, prev->protocols,
|
534
|
209 (NGX_CONF_BITMASK_SET|NGX_SSL_SSLv3|NGX_SSL_TLSv1));
|
290
|
210
|
404
|
211 ngx_conf_merge_str_value(conf->certificate, prev->certificate, "");
|
|
212 ngx_conf_merge_str_value(conf->certificate_key, prev->certificate_key, "");
|
290
|
213
|
380
|
214 ngx_conf_merge_str_value(conf->dhparam, prev->dhparam, "");
|
|
215
|
632
|
216 ngx_conf_merge_str_value(conf->ecdh_curve, prev->ecdh_curve,
|
|
217 NGX_DEFAULT_ECDH_CURVE);
|
|
218
|
390
|
219 ngx_conf_merge_str_value(conf->ciphers, prev->ciphers, NGX_DEFAULT_CIPHERS);
|
290
|
220
|
|
221
|
|
222 conf->ssl.log = cf->log;
|
|
223
|
404
|
224 if (conf->enable) {
|
|
225 mode = "ssl";
|
|
226
|
|
227 } else if (conf->starttls != NGX_MAIL_STARTTLS_OFF) {
|
|
228 mode = "starttls";
|
|
229
|
|
230 } else {
|
|
231 mode = "";
|
|
232 }
|
|
233
|
|
234 if (*mode) {
|
|
235
|
|
236 if (conf->certificate.len == 0) {
|
|
237 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
|
|
238 "no \"ssl_certificate\" is defined for "
|
|
239 "the \"%s\" directive in %s:%ui",
|
|
240 mode, conf->file, conf->line);
|
|
241 return NGX_CONF_ERROR;
|
|
242 }
|
|
243
|
|
244 if (conf->certificate_key.len == 0) {
|
|
245 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
|
|
246 "no \"ssl_certificate_key\" is defined for "
|
|
247 "the \"%s\" directive in %s:%ui",
|
|
248 mode, conf->file, conf->line);
|
|
249 return NGX_CONF_ERROR;
|
|
250 }
|
|
251
|
|
252 } else {
|
|
253
|
|
254 if (conf->certificate.len == 0) {
|
|
255 return NGX_CONF_OK;
|
|
256 }
|
|
257
|
|
258 if (conf->certificate_key.len == 0) {
|
|
259 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
|
|
260 "no \"ssl_certificate_key\" is defined "
|
|
261 "for certificate \"%V\"",
|
|
262 &conf->certificate);
|
|
263 return NGX_CONF_ERROR;
|
|
264 }
|
|
265 }
|
|
266
|
290
|
267 if (ngx_ssl_create(&conf->ssl, conf->protocols, NULL) != NGX_OK) {
|
|
268 return NGX_CONF_ERROR;
|
|
269 }
|
|
270
|
|
271 cln = ngx_pool_cleanup_add(cf->pool, 0);
|
|
272 if (cln == NULL) {
|
|
273 return NGX_CONF_ERROR;
|
|
274 }
|
|
275
|
|
276 cln->handler = ngx_ssl_cleanup_ctx;
|
|
277 cln->data = &conf->ssl;
|
|
278
|
|
279 if (ngx_ssl_certificate(cf, &conf->ssl, &conf->certificate,
|
|
280 &conf->certificate_key)
|
|
281 != NGX_OK)
|
|
282 {
|
|
283 return NGX_CONF_ERROR;
|
|
284 }
|
|
285
|
|
286 if (conf->ciphers.len) {
|
|
287 if (SSL_CTX_set_cipher_list(conf->ssl.ctx,
|
|
288 (const char *) conf->ciphers.data)
|
|
289 == 0)
|
|
290 {
|
|
291 ngx_ssl_error(NGX_LOG_EMERG, cf->log, 0,
|
|
292 "SSL_CTX_set_cipher_list(\"%V\") failed",
|
|
293 &conf->ciphers);
|
|
294 }
|
|
295 }
|
|
296
|
|
297 if (conf->prefer_server_ciphers) {
|
|
298 SSL_CTX_set_options(conf->ssl.ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
|
|
299 }
|
|
300
|
632
|
301 SSL_CTX_set_tmp_rsa_callback(conf->ssl.ctx, ngx_ssl_rsa512_key_callback);
|
290
|
302
|
380
|
303 if (ngx_ssl_dhparam(cf, &conf->ssl, &conf->dhparam) != NGX_OK) {
|
|
304 return NGX_CONF_ERROR;
|
|
305 }
|
|
306
|
290
|
307 ngx_conf_merge_value(conf->builtin_session_cache,
|
378
|
308 prev->builtin_session_cache, NGX_SSL_NONE_SCACHE);
|
290
|
309
|
|
310 if (conf->shm_zone == NULL) {
|
|
311 conf->shm_zone = prev->shm_zone;
|
|
312 }
|
|
313
|
|
314 if (ngx_ssl_session_cache(&conf->ssl, &ngx_mail_ssl_sess_id_ctx,
|
|
315 conf->builtin_session_cache,
|
|
316 conf->shm_zone, conf->session_timeout)
|
|
317 != NGX_OK)
|
|
318 {
|
|
319 return NGX_CONF_ERROR;
|
|
320 }
|
|
321
|
|
322 return NGX_CONF_OK;
|
|
323 }
|
|
324
|
|
325
|
|
326 static char *
|
404
|
327 ngx_mail_ssl_enable(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
|
|
328 {
|
|
329 ngx_mail_ssl_conf_t *scf = conf;
|
|
330
|
|
331 char *rv;
|
|
332
|
|
333 rv = ngx_conf_set_flag_slot(cf, cmd, conf);
|
|
334
|
|
335 if (rv != NGX_CONF_OK) {
|
|
336 return rv;
|
|
337 }
|
|
338
|
|
339 if (scf->enable && (ngx_int_t) scf->starttls > NGX_MAIL_STARTTLS_OFF) {
|
|
340 ngx_conf_log_error(NGX_LOG_WARN, cf, 0,
|
|
341 "\"starttls\" directive conflicts with \"ssl on\"");
|
|
342 return NGX_CONF_ERROR;
|
|
343 }
|
|
344
|
|
345 scf->file = cf->conf_file->file.name.data;
|
|
346 scf->line = cf->conf_file->line;
|
|
347
|
|
348 return NGX_CONF_OK;
|
|
349 }
|
|
350
|
|
351
|
|
352 static char *
|
|
353 ngx_mail_ssl_starttls(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
|
|
354 {
|
|
355 ngx_mail_ssl_conf_t *scf = conf;
|
|
356
|
|
357 char *rv;
|
|
358
|
|
359 rv = ngx_conf_set_enum_slot(cf, cmd, conf);
|
|
360
|
|
361 if (rv != NGX_CONF_OK) {
|
|
362 return rv;
|
|
363 }
|
|
364
|
|
365 if (scf->enable == 1 && (ngx_int_t) scf->starttls > NGX_MAIL_STARTTLS_OFF) {
|
|
366 ngx_conf_log_error(NGX_LOG_WARN, cf, 0,
|
|
367 "\"ssl\" directive conflicts with \"starttls\"");
|
|
368 return NGX_CONF_ERROR;
|
|
369 }
|
|
370
|
|
371 scf->file = cf->conf_file->file.name.data;
|
|
372 scf->line = cf->conf_file->line;
|
|
373
|
|
374 return NGX_CONF_OK;
|
|
375 }
|
|
376
|
|
377
|
|
378 static char *
|
290
|
379 ngx_mail_ssl_session_cache(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
|
|
380 {
|
|
381 ngx_mail_ssl_conf_t *scf = conf;
|
|
382
|
|
383 size_t len;
|
|
384 ngx_str_t *value, name, size;
|
|
385 ngx_int_t n;
|
|
386 ngx_uint_t i, j;
|
|
387
|
|
388 value = cf->args->elts;
|
|
389
|
|
390 for (i = 1; i < cf->args->nelts; i++) {
|
|
391
|
358
|
392 if (ngx_strcmp(value[i].data, "off") == 0) {
|
|
393 scf->builtin_session_cache = NGX_SSL_NO_SCACHE;
|
|
394 continue;
|
|
395 }
|
|
396
|
378
|
397 if (ngx_strcmp(value[i].data, "none") == 0) {
|
|
398 scf->builtin_session_cache = NGX_SSL_NONE_SCACHE;
|
|
399 continue;
|
|
400 }
|
|
401
|
290
|
402 if (ngx_strcmp(value[i].data, "builtin") == 0) {
|
|
403 scf->builtin_session_cache = NGX_SSL_DFLT_BUILTIN_SCACHE;
|
|
404 continue;
|
|
405 }
|
|
406
|
|
407 if (value[i].len > sizeof("builtin:") - 1
|
|
408 && ngx_strncmp(value[i].data, "builtin:", sizeof("builtin:") - 1)
|
|
409 == 0)
|
|
410 {
|
|
411 n = ngx_atoi(value[i].data + sizeof("builtin:") - 1,
|
|
412 value[i].len - (sizeof("builtin:") - 1));
|
|
413
|
|
414 if (n == NGX_ERROR) {
|
|
415 goto invalid;
|
|
416 }
|
|
417
|
|
418 scf->builtin_session_cache = n;
|
|
419
|
|
420 continue;
|
|
421 }
|
|
422
|
|
423 if (value[i].len > sizeof("shared:") - 1
|
|
424 && ngx_strncmp(value[i].data, "shared:", sizeof("shared:") - 1)
|
|
425 == 0)
|
|
426 {
|
|
427 len = 0;
|
|
428
|
|
429 for (j = sizeof("shared:") - 1; j < value[i].len; j++) {
|
|
430 if (value[i].data[j] == ':') {
|
|
431 break;
|
|
432 }
|
|
433
|
|
434 len++;
|
|
435 }
|
|
436
|
|
437 if (len == 0) {
|
|
438 goto invalid;
|
|
439 }
|
|
440
|
|
441 name.len = len;
|
|
442 name.data = value[i].data + sizeof("shared:") - 1;
|
|
443
|
|
444 size.len = value[i].len - j - 1;
|
|
445 size.data = name.data + len + 1;
|
|
446
|
|
447 n = ngx_parse_size(&size);
|
|
448
|
|
449 if (n == NGX_ERROR) {
|
|
450 goto invalid;
|
|
451 }
|
|
452
|
|
453 if (n < (ngx_int_t) (8 * ngx_pagesize)) {
|
|
454 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
455 "session cache \"%V\" is too small",
|
|
456 &value[i]);
|
|
457
|
|
458 return NGX_CONF_ERROR;
|
|
459 }
|
|
460
|
|
461 scf->shm_zone = ngx_shared_memory_add(cf, &name, n,
|
|
462 &ngx_mail_ssl_module);
|
|
463 if (scf->shm_zone == NULL) {
|
|
464 return NGX_CONF_ERROR;
|
|
465 }
|
|
466
|
642
|
467 scf->shm_zone->init = ngx_ssl_session_cache_init;
|
|
468
|
290
|
469 continue;
|
|
470 }
|
|
471
|
|
472 goto invalid;
|
|
473 }
|
|
474
|
|
475 if (scf->shm_zone && scf->builtin_session_cache == NGX_CONF_UNSET) {
|
|
476 scf->builtin_session_cache = NGX_SSL_NO_BUILTIN_SCACHE;
|
|
477 }
|
|
478
|
|
479 return NGX_CONF_OK;
|
|
480
|
|
481 invalid:
|
|
482
|
|
483 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
|
|
484 "invalid session cache \"%V\"", &value[i]);
|
|
485
|
|
486 return NGX_CONF_ERROR;
|
|
487 }
|