1
2 /*
3 * Copyright (C) Igor Sysoev
4 * Copyright (C) Nginx, Inc.
5 */
6
7
8 #include <ngx_config.h>
9 #include <ngx_core.h>
10 #include <ngx_http.h>
11
12
13 typedef ngx_int_t (*ngx_ssl_variable_handler_pt)(ngx_connection_t *c,
14 ngx_pool_t *pool, ngx_str_t *s);
15
16
17 #define NGX_DEFAULT_CIPHERS "HIGH:!aNULL:!MD5"
18 #define NGX_DEFAULT_ECDH_CURVE "auto"
19
20 #define NGX_HTTP_NPN_ADVERTISE "\x08http/1.1"
21
22
23 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
24 static int ngx_http_ssl_alpn_select(ngx_ssl_conn_t *ssl_conn,
25 const unsigned char **out, unsigned char *outlen,
26 const unsigned char *in, unsigned int inlen, void *arg);
27 #endif
28
29 #ifdef TLSEXT_TYPE_next_proto_neg
30 static int ngx_http_ssl_npn_advertised(ngx_ssl_conn_t *ssl_conn,
31 const unsigned char **out, unsigned int *outlen, void *arg);
32 #endif
33
34 static ngx_int_t ngx_http_ssl_static_variable(ngx_http_request_t *r,
35 ngx_http_variable_value_t *v, uintptr_t data);
36 static ngx_int_t ngx_http_ssl_variable(ngx_http_request_t *r,
37 ngx_http_variable_value_t *v, uintptr_t data);
38
39 static ngx_int_t ngx_http_ssl_add_variables(ngx_conf_t *cf);
40 static void *ngx_http_ssl_create_srv_conf(ngx_conf_t *cf);
41 static char *ngx_http_ssl_merge_srv_conf(ngx_conf_t *cf,
42 void *parent, void *child);
43
44 static ngx_int_t ngx_http_ssl_compile_certificates(ngx_conf_t *cf,
45 ngx_http_ssl_srv_conf_t *conf);
46
47 static char *ngx_http_ssl_enable(ngx_conf_t *cf, ngx_command_t *cmd,
48 void *conf);
49 static char *ngx_http_ssl_password_file(ngx_conf_t *cf, ngx_command_t *cmd,
50 void *conf);
51 static char *ngx_http_ssl_session_cache(ngx_conf_t *cf, ngx_command_t *cmd,
52 void *conf);
53
54 static ngx_int_t ngx_http_ssl_init(ngx_conf_t *cf);
55
56
57 static ngx_conf_bitmask_t ngx_http_ssl_protocols[] = {
58 { ngx_string("SSLv2"), NGX_SSL_SSLv2 },
59 { ngx_string("SSLv3"), NGX_SSL_SSLv3 },
60 { ngx_string("TLSv1"), NGX_SSL_TLSv1 },
61 { ngx_string("TLSv1.1"), NGX_SSL_TLSv1_1 },
62 { ngx_string("TLSv1.2"), NGX_SSL_TLSv1_2 },
63 { ngx_string("TLSv1.3"), NGX_SSL_TLSv1_3 },
64 { ngx_null_string, 0 }
65 };
66
67
68 static ngx_conf_enum_t ngx_http_ssl_verify[] = {
69 { ngx_string("off"), 0 },
70 { ngx_string("on"), 1 },
71 { ngx_string("optional"), 2 },
72 { ngx_string("optional_no_ca"), 3 },
73 { ngx_null_string, 0 }
74 };
75
76
77 static ngx_conf_deprecated_t ngx_http_ssl_deprecated = {
78 ngx_conf_deprecated, "ssl", "listen ... ssl"
79 };
80
81
82 static ngx_command_t ngx_http_ssl_commands[] = {
83
84 { ngx_string("ssl"),
85 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
86 ngx_http_ssl_enable,
87 NGX_HTTP_SRV_CONF_OFFSET,
88 offsetof(ngx_http_ssl_srv_conf_t, enable),
89 &ngx_http_ssl_deprecated },
90
91 { ngx_string("ssl_certificate"),
92 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
93 ngx_conf_set_str_array_slot,
94 NGX_HTTP_SRV_CONF_OFFSET,
95 offsetof(ngx_http_ssl_srv_conf_t, certificates),
96 NULL },
97
98 { ngx_string("ssl_certificate_key"),
99 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
100 ngx_conf_set_str_array_slot,
101 NGX_HTTP_SRV_CONF_OFFSET,
102 offsetof(ngx_http_ssl_srv_conf_t, certificate_keys),
103 NULL },
104
105 { ngx_string("ssl_password_file"),
106 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
107 ngx_http_ssl_password_file,
108 NGX_HTTP_SRV_CONF_OFFSET,
109 0,
110 NULL },
111
112 { ngx_string("ssl_dhparam"),
113 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
114 ngx_conf_set_str_slot,
115 NGX_HTTP_SRV_CONF_OFFSET,
116 offsetof(ngx_http_ssl_srv_conf_t, dhparam),
117 NULL },
118
119 { ngx_string("ssl_ecdh_curve"),
120 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
121 ngx_conf_set_str_slot,
122 NGX_HTTP_SRV_CONF_OFFSET,
123 offsetof(ngx_http_ssl_srv_conf_t, ecdh_curve),
124 NULL },
125
126 { ngx_string("ssl_protocols"),
127 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_1MORE,
128 ngx_conf_set_bitmask_slot,
129 NGX_HTTP_SRV_CONF_OFFSET,
130 offsetof(ngx_http_ssl_srv_conf_t, protocols),
131 &ngx_http_ssl_protocols },
132
133 { ngx_string("ssl_ciphers"),
134 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
135 ngx_conf_set_str_slot,
136 NGX_HTTP_SRV_CONF_OFFSET,
137 offsetof(ngx_http_ssl_srv_conf_t, ciphers),
138 NULL },
139
140 { ngx_string("ssl_buffer_size"),
141 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
142 ngx_conf_set_size_slot,
143 NGX_HTTP_SRV_CONF_OFFSET,
144 offsetof(ngx_http_ssl_srv_conf_t, buffer_size),
145 NULL },
146
147 { ngx_string("ssl_verify_client"),
148 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
149 ngx_conf_set_enum_slot,
150 NGX_HTTP_SRV_CONF_OFFSET,
151 offsetof(ngx_http_ssl_srv_conf_t, verify),
152 &ngx_http_ssl_verify },
153
154 { ngx_string("ssl_verify_depth"),
155 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
156 ngx_conf_set_num_slot,
157 NGX_HTTP_SRV_CONF_OFFSET,
158 offsetof(ngx_http_ssl_srv_conf_t, verify_depth),
159 NULL },
160
161 { ngx_string("ssl_client_certificate"),
162 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
163 ngx_conf_set_str_slot,
164 NGX_HTTP_SRV_CONF_OFFSET,
165 offsetof(ngx_http_ssl_srv_conf_t, client_certificate),
166 NULL },
167
168 { ngx_string("ssl_trusted_certificate"),
169 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
170 ngx_conf_set_str_slot,
171 NGX_HTTP_SRV_CONF_OFFSET,
172 offsetof(ngx_http_ssl_srv_conf_t, trusted_certificate),
173 NULL },
174
175 { ngx_string("ssl_prefer_server_ciphers"),
176 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
177 ngx_conf_set_flag_slot,
178 NGX_HTTP_SRV_CONF_OFFSET,
179 offsetof(ngx_http_ssl_srv_conf_t, prefer_server_ciphers),
180 NULL },
181
182 { ngx_string("ssl_session_cache"),
183 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE12,
184 ngx_http_ssl_session_cache,
185 NGX_HTTP_SRV_CONF_OFFSET,
186 0,
187 NULL },
188
189 { ngx_string("ssl_session_tickets"),
190 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
191 ngx_conf_set_flag_slot,
192 NGX_HTTP_SRV_CONF_OFFSET,
193 offsetof(ngx_http_ssl_srv_conf_t, session_tickets),
194 NULL },
195
196 { ngx_string("ssl_session_ticket_key"),
197 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
198 ngx_conf_set_str_array_slot,
199 NGX_HTTP_SRV_CONF_OFFSET,
200 offsetof(ngx_http_ssl_srv_conf_t, session_ticket_keys),
201 NULL },
202
203 { ngx_string("ssl_session_timeout"),
204 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
205 ngx_conf_set_sec_slot,
206 NGX_HTTP_SRV_CONF_OFFSET,
207 offsetof(ngx_http_ssl_srv_conf_t, session_timeout),
208 NULL },
209
210 { ngx_string("ssl_crl"),
211 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
212 ngx_conf_set_str_slot,
213 NGX_HTTP_SRV_CONF_OFFSET,
214 offsetof(ngx_http_ssl_srv_conf_t, crl),
215 NULL },
216
217 { ngx_string("ssl_stapling"),
218 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
219 ngx_conf_set_flag_slot,
220 NGX_HTTP_SRV_CONF_OFFSET,
221 offsetof(ngx_http_ssl_srv_conf_t, stapling),
222 NULL },
223
224 { ngx_string("ssl_stapling_file"),
225 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
226 ngx_conf_set_str_slot,
227 NGX_HTTP_SRV_CONF_OFFSET,
228 offsetof(ngx_http_ssl_srv_conf_t, stapling_file),
229 NULL },
230
231 { ngx_string("ssl_stapling_responder"),
232 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
233 ngx_conf_set_str_slot,
234 NGX_HTTP_SRV_CONF_OFFSET,
235 offsetof(ngx_http_ssl_srv_conf_t, stapling_responder),
236 NULL },
237
238 { ngx_string("ssl_stapling_verify"),
239 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
240 ngx_conf_set_flag_slot,
241 NGX_HTTP_SRV_CONF_OFFSET,
242 offsetof(ngx_http_ssl_srv_conf_t, stapling_verify),
243 NULL },
244
245 { ngx_string("ssl_early_data"),
246 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
247 ngx_conf_set_flag_slot,
248 NGX_HTTP_SRV_CONF_OFFSET,
249 offsetof(ngx_http_ssl_srv_conf_t, early_data),
250 NULL },
251
252 ngx_null_command
253 };
254
255
256 static ngx_http_module_t ngx_http_ssl_module_ctx = {
257 ngx_http_ssl_add_variables, /* preconfiguration */
258 ngx_http_ssl_init, /* postconfiguration */
259
260 NULL, /* create main configuration */
261 NULL, /* init main configuration */
262
263 ngx_http_ssl_create_srv_conf, /* create server configuration */
264 ngx_http_ssl_merge_srv_conf, /* merge server configuration */
265
266 NULL, /* create location configuration */
267 NULL /* merge location configuration */
268 };
269
270
271 ngx_module_t ngx_http_ssl_module = {
272 NGX_MODULE_V1,
273 &ngx_http_ssl_module_ctx, /* module context */
274 ngx_http_ssl_commands, /* module directives */
275 NGX_HTTP_MODULE, /* module type */
276 NULL, /* init master */
277 NULL, /* init module */
278 NULL, /* init process */
279 NULL, /* init thread */
280 NULL, /* exit thread */
281 NULL, /* exit process */
282 NULL, /* exit master */
283 NGX_MODULE_V1_PADDING
284 };
285
286
287 static ngx_http_variable_t ngx_http_ssl_vars[] = {
288
289 { ngx_string("ssl_protocol"), NULL, ngx_http_ssl_static_variable,
290 (uintptr_t) ngx_ssl_get_protocol, NGX_HTTP_VAR_CHANGEABLE, 0 },
291
292 { ngx_string("ssl_cipher"), NULL, ngx_http_ssl_static_variable,
293 (uintptr_t) ngx_ssl_get_cipher_name, NGX_HTTP_VAR_CHANGEABLE, 0 },
294
295 { ngx_string("ssl_ciphers"), NULL, ngx_http_ssl_variable,
296 (uintptr_t) ngx_ssl_get_ciphers, NGX_HTTP_VAR_CHANGEABLE, 0 },
297
298 { ngx_string("ssl_curves"), NULL, ngx_http_ssl_variable,
299 (uintptr_t) ngx_ssl_get_curves, NGX_HTTP_VAR_CHANGEABLE, 0 },
300
301 { ngx_string("ssl_session_id"), NULL, ngx_http_ssl_variable,
302 (uintptr_t) ngx_ssl_get_session_id, NGX_HTTP_VAR_CHANGEABLE, 0 },
303
304 { ngx_string("ssl_session_reused"), NULL, ngx_http_ssl_variable,
305 (uintptr_t) ngx_ssl_get_session_reused, NGX_HTTP_VAR_CHANGEABLE, 0 },
306
307 { ngx_string("ssl_early_data"), NULL, ngx_http_ssl_variable,
308 (uintptr_t) ngx_ssl_get_early_data,
309 NGX_HTTP_VAR_CHANGEABLE|NGX_HTTP_VAR_NOCACHEABLE, 0 },
310
311 { ngx_string("ssl_server_name"), NULL, ngx_http_ssl_variable,
312 (uintptr_t) ngx_ssl_get_server_name, NGX_HTTP_VAR_CHANGEABLE, 0 },
313
314 { ngx_string("ssl_client_cert"), NULL, ngx_http_ssl_variable,
315 (uintptr_t) ngx_ssl_get_certificate, NGX_HTTP_VAR_CHANGEABLE, 0 },
316
317 { ngx_string("ssl_client_raw_cert"), NULL, ngx_http_ssl_variable,
318 (uintptr_t) ngx_ssl_get_raw_certificate,
319 NGX_HTTP_VAR_CHANGEABLE, 0 },
320
321 { ngx_string("ssl_client_escaped_cert"), NULL, ngx_http_ssl_variable,
322 (uintptr_t) ngx_ssl_get_escaped_certificate,
323 NGX_HTTP_VAR_CHANGEABLE, 0 },
324
325 { ngx_string("ssl_client_s_dn"), NULL, ngx_http_ssl_variable,
326 (uintptr_t) ngx_ssl_get_subject_dn, NGX_HTTP_VAR_CHANGEABLE, 0 },
327
328 { ngx_string("ssl_client_i_dn"), NULL, ngx_http_ssl_variable,
329 (uintptr_t) ngx_ssl_get_issuer_dn, NGX_HTTP_VAR_CHANGEABLE, 0 },
330
331 { ngx_string("ssl_client_s_dn_legacy"), NULL, ngx_http_ssl_variable,
332 (uintptr_t) ngx_ssl_get_subject_dn_legacy, NGX_HTTP_VAR_CHANGEABLE, 0 },
333
334 { ngx_string("ssl_client_i_dn_legacy"), NULL, ngx_http_ssl_variable,
335 (uintptr_t) ngx_ssl_get_issuer_dn_legacy, NGX_HTTP_VAR_CHANGEABLE, 0 },
336
337 { ngx_string("ssl_client_serial"), NULL, ngx_http_ssl_variable,
338 (uintptr_t) ngx_ssl_get_serial_number, NGX_HTTP_VAR_CHANGEABLE, 0 },
339
340 { ngx_string("ssl_client_fingerprint"), NULL, ngx_http_ssl_variable,
341 (uintptr_t) ngx_ssl_get_fingerprint, NGX_HTTP_VAR_CHANGEABLE, 0 },
342
343 { ngx_string("ssl_client_verify"), NULL, ngx_http_ssl_variable,
344 (uintptr_t) ngx_ssl_get_client_verify, NGX_HTTP_VAR_CHANGEABLE, 0 },
345
346 { ngx_string("ssl_client_v_start"), NULL, ngx_http_ssl_variable,
347 (uintptr_t) ngx_ssl_get_client_v_start, NGX_HTTP_VAR_CHANGEABLE, 0 },
348
349 { ngx_string("ssl_client_v_end"), NULL, ngx_http_ssl_variable,
350 (uintptr_t) ngx_ssl_get_client_v_end, NGX_HTTP_VAR_CHANGEABLE, 0 },
351
352 { ngx_string("ssl_client_v_remain"), NULL, ngx_http_ssl_variable,
353 (uintptr_t) ngx_ssl_get_client_v_remain, NGX_HTTP_VAR_CHANGEABLE, 0 },
354
355 ngx_http_null_variable
356 };
357
358
359 static ngx_str_t ngx_http_ssl_sess_id_ctx = ngx_string("HTTP");
360
361
362 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
363
364 static int
ngx_http_ssl_alpn_select(ngx_ssl_conn_t * ssl_conn,const unsigned char ** out,unsigned char * outlen,const unsigned char * in,unsigned int inlen,void * arg)365 ngx_http_ssl_alpn_select(ngx_ssl_conn_t *ssl_conn, const unsigned char **out,
366 unsigned char *outlen, const unsigned char *in, unsigned int inlen,
367 void *arg)
368 {
369 unsigned int srvlen;
370 unsigned char *srv;
371 #if (NGX_DEBUG)
372 unsigned int i;
373 #endif
374 #if (NGX_HTTP_V2)
375 ngx_http_connection_t *hc;
376 #endif
377 #if (NGX_HTTP_V2 || NGX_DEBUG)
378 ngx_connection_t *c;
379
380 c = ngx_ssl_get_connection(ssl_conn);
381 #endif
382
383 #if (NGX_DEBUG)
384 for (i = 0; i < inlen; i += in[i] + 1) {
385 ngx_log_debug2(NGX_LOG_DEBUG_HTTP, c->log, 0,
386 "SSL ALPN supported by client: %*s",
387 (size_t) in[i], &in[i + 1]);
388 }
389 #endif
390
391 #if (NGX_HTTP_V2)
392 hc = c->data;
393
394 if (hc->addr_conf->http2) {
395 srv =
396 (unsigned char *) NGX_HTTP_V2_ALPN_ADVERTISE NGX_HTTP_NPN_ADVERTISE;
397 srvlen = sizeof(NGX_HTTP_V2_ALPN_ADVERTISE NGX_HTTP_NPN_ADVERTISE) - 1;
398
399 } else
400 #endif
401 {
402 srv = (unsigned char *) NGX_HTTP_NPN_ADVERTISE;
403 srvlen = sizeof(NGX_HTTP_NPN_ADVERTISE) - 1;
404 }
405
406 if (SSL_select_next_proto((unsigned char **) out, outlen, srv, srvlen,
407 in, inlen)
408 != OPENSSL_NPN_NEGOTIATED)
409 {
410 return SSL_TLSEXT_ERR_NOACK;
411 }
412
413 ngx_log_debug2(NGX_LOG_DEBUG_HTTP, c->log, 0,
414 "SSL ALPN selected: %*s", (size_t) *outlen, *out);
415
416 return SSL_TLSEXT_ERR_OK;
417 }
418
419 #endif
420
421
422 #ifdef TLSEXT_TYPE_next_proto_neg
423
424 static int
ngx_http_ssl_npn_advertised(ngx_ssl_conn_t * ssl_conn,const unsigned char ** out,unsigned int * outlen,void * arg)425 ngx_http_ssl_npn_advertised(ngx_ssl_conn_t *ssl_conn,
426 const unsigned char **out, unsigned int *outlen, void *arg)
427 {
428 #if (NGX_HTTP_V2 || NGX_DEBUG)
429 ngx_connection_t *c;
430
431 c = ngx_ssl_get_connection(ssl_conn);
432 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, c->log, 0, "SSL NPN advertised");
433 #endif
434
435 #if (NGX_HTTP_V2)
436 {
437 ngx_http_connection_t *hc;
438
439 hc = c->data;
440
441 if (hc->addr_conf->http2) {
442 *out =
443 (unsigned char *) NGX_HTTP_V2_NPN_ADVERTISE NGX_HTTP_NPN_ADVERTISE;
444 *outlen = sizeof(NGX_HTTP_V2_NPN_ADVERTISE NGX_HTTP_NPN_ADVERTISE) - 1;
445
446 return SSL_TLSEXT_ERR_OK;
447 }
448 }
449 #endif
450
451 *out = (unsigned char *) NGX_HTTP_NPN_ADVERTISE;
452 *outlen = sizeof(NGX_HTTP_NPN_ADVERTISE) - 1;
453
454 return SSL_TLSEXT_ERR_OK;
455 }
456
457 #endif
458
459
460 static ngx_int_t
ngx_http_ssl_static_variable(ngx_http_request_t * r,ngx_http_variable_value_t * v,uintptr_t data)461 ngx_http_ssl_static_variable(ngx_http_request_t *r,
462 ngx_http_variable_value_t *v, uintptr_t data)
463 {
464 ngx_ssl_variable_handler_pt handler = (ngx_ssl_variable_handler_pt) data;
465
466 size_t len;
467 ngx_str_t s;
468
469 if (r->connection->ssl) {
470
471 (void) handler(r->connection, NULL, &s);
472
473 v->data = s.data;
474
475 for (len = 0; v->data[len]; len++) { /* void */ }
476
477 v->len = len;
478 v->valid = 1;
479 v->no_cacheable = 0;
480 v->not_found = 0;
481
482 return NGX_OK;
483 }
484
485 v->not_found = 1;
486
487 return NGX_OK;
488 }
489
490
491 static ngx_int_t
ngx_http_ssl_variable(ngx_http_request_t * r,ngx_http_variable_value_t * v,uintptr_t data)492 ngx_http_ssl_variable(ngx_http_request_t *r, ngx_http_variable_value_t *v,
493 uintptr_t data)
494 {
495 ngx_ssl_variable_handler_pt handler = (ngx_ssl_variable_handler_pt) data;
496
497 ngx_str_t s;
498
499 if (r->connection->ssl) {
500
501 if (handler(r->connection, r->pool, &s) != NGX_OK) {
502 return NGX_ERROR;
503 }
504
505 v->len = s.len;
506 v->data = s.data;
507
508 if (v->len) {
509 v->valid = 1;
510 v->no_cacheable = 0;
511 v->not_found = 0;
512
513 return NGX_OK;
514 }
515 }
516
517 v->not_found = 1;
518
519 return NGX_OK;
520 }
521
522
523 static ngx_int_t
ngx_http_ssl_add_variables(ngx_conf_t * cf)524 ngx_http_ssl_add_variables(ngx_conf_t *cf)
525 {
526 ngx_http_variable_t *var, *v;
527
528 for (v = ngx_http_ssl_vars; v->name.len; v++) {
529 var = ngx_http_add_variable(cf, &v->name, v->flags);
530 if (var == NULL) {
531 return NGX_ERROR;
532 }
533
534 var->get_handler = v->get_handler;
535 var->data = v->data;
536 }
537
538 return NGX_OK;
539 }
540
541
542 static void *
ngx_http_ssl_create_srv_conf(ngx_conf_t * cf)543 ngx_http_ssl_create_srv_conf(ngx_conf_t *cf)
544 {
545 ngx_http_ssl_srv_conf_t *sscf;
546
547 sscf = ngx_pcalloc(cf->pool, sizeof(ngx_http_ssl_srv_conf_t));
548 if (sscf == NULL) {
549 return NULL;
550 }
551
552 /*
553 * set by ngx_pcalloc():
554 *
555 * sscf->protocols = 0;
556 * sscf->certificate_values = NULL;
557 * sscf->dhparam = { 0, NULL };
558 * sscf->ecdh_curve = { 0, NULL };
559 * sscf->client_certificate = { 0, NULL };
560 * sscf->trusted_certificate = { 0, NULL };
561 * sscf->crl = { 0, NULL };
562 * sscf->ciphers = { 0, NULL };
563 * sscf->shm_zone = NULL;
564 * sscf->stapling_file = { 0, NULL };
565 * sscf->stapling_responder = { 0, NULL };
566 */
567
568 sscf->enable = NGX_CONF_UNSET;
569 sscf->prefer_server_ciphers = NGX_CONF_UNSET;
570 sscf->early_data = NGX_CONF_UNSET;
571 sscf->buffer_size = NGX_CONF_UNSET_SIZE;
572 sscf->verify = NGX_CONF_UNSET_UINT;
573 sscf->verify_depth = NGX_CONF_UNSET_UINT;
574 sscf->certificates = NGX_CONF_UNSET_PTR;
575 sscf->certificate_keys = NGX_CONF_UNSET_PTR;
576 sscf->passwords = NGX_CONF_UNSET_PTR;
577 sscf->builtin_session_cache = NGX_CONF_UNSET;
578 sscf->session_timeout = NGX_CONF_UNSET;
579 sscf->session_tickets = NGX_CONF_UNSET;
580 sscf->session_ticket_keys = NGX_CONF_UNSET_PTR;
581 sscf->stapling = NGX_CONF_UNSET;
582 sscf->stapling_verify = NGX_CONF_UNSET;
583
584 return sscf;
585 }
586
587
588 static char *
ngx_http_ssl_merge_srv_conf(ngx_conf_t * cf,void * parent,void * child)589 ngx_http_ssl_merge_srv_conf(ngx_conf_t *cf, void *parent, void *child)
590 {
591 ngx_http_ssl_srv_conf_t *prev = parent;
592 ngx_http_ssl_srv_conf_t *conf = child;
593
594 ngx_pool_cleanup_t *cln;
595
596 if (conf->enable == NGX_CONF_UNSET) {
597 if (prev->enable == NGX_CONF_UNSET) {
598 conf->enable = 0;
599
600 } else {
601 conf->enable = prev->enable;
602 conf->file = prev->file;
603 conf->line = prev->line;
604 }
605 }
606
607 ngx_conf_merge_value(conf->session_timeout,
608 prev->session_timeout, 300);
609
610 ngx_conf_merge_value(conf->prefer_server_ciphers,
611 prev->prefer_server_ciphers, 0);
612
613 ngx_conf_merge_value(conf->early_data, prev->early_data, 0);
614
615 ngx_conf_merge_bitmask_value(conf->protocols, prev->protocols,
616 (NGX_CONF_BITMASK_SET|NGX_SSL_TLSv1
617 |NGX_SSL_TLSv1_1|NGX_SSL_TLSv1_2));
618
619 ngx_conf_merge_size_value(conf->buffer_size, prev->buffer_size,
620 NGX_SSL_BUFSIZE);
621
622 ngx_conf_merge_uint_value(conf->verify, prev->verify, 0);
623 ngx_conf_merge_uint_value(conf->verify_depth, prev->verify_depth, 1);
624
625 ngx_conf_merge_ptr_value(conf->certificates, prev->certificates, NULL);
626 ngx_conf_merge_ptr_value(conf->certificate_keys, prev->certificate_keys,
627 NULL);
628
629 ngx_conf_merge_ptr_value(conf->passwords, prev->passwords, NULL);
630
631 ngx_conf_merge_str_value(conf->dhparam, prev->dhparam, "");
632
633 ngx_conf_merge_str_value(conf->client_certificate, prev->client_certificate,
634 "");
635 ngx_conf_merge_str_value(conf->trusted_certificate,
636 prev->trusted_certificate, "");
637 ngx_conf_merge_str_value(conf->crl, prev->crl, "");
638
639 ngx_conf_merge_str_value(conf->ecdh_curve, prev->ecdh_curve,
640 NGX_DEFAULT_ECDH_CURVE);
641
642 ngx_conf_merge_str_value(conf->ciphers, prev->ciphers, NGX_DEFAULT_CIPHERS);
643
644 ngx_conf_merge_value(conf->stapling, prev->stapling, 0);
645 ngx_conf_merge_value(conf->stapling_verify, prev->stapling_verify, 0);
646 ngx_conf_merge_str_value(conf->stapling_file, prev->stapling_file, "");
647 ngx_conf_merge_str_value(conf->stapling_responder,
648 prev->stapling_responder, "");
649
650 conf->ssl.log = cf->log;
651
652 if (conf->enable) {
653
654 if (conf->certificates == NULL) {
655 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
656 "no \"ssl_certificate\" is defined for "
657 "the \"ssl\" directive in %s:%ui",
658 conf->file, conf->line);
659 return NGX_CONF_ERROR;
660 }
661
662 if (conf->certificate_keys == NULL) {
663 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
664 "no \"ssl_certificate_key\" is defined for "
665 "the \"ssl\" directive in %s:%ui",
666 conf->file, conf->line);
667 return NGX_CONF_ERROR;
668 }
669
670 if (conf->certificate_keys->nelts < conf->certificates->nelts) {
671 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
672 "no \"ssl_certificate_key\" is defined "
673 "for certificate \"%V\" and "
674 "the \"ssl\" directive in %s:%ui",
675 ((ngx_str_t *) conf->certificates->elts)
676 + conf->certificates->nelts - 1,
677 conf->file, conf->line);
678 return NGX_CONF_ERROR;
679 }
680
681 } else {
682
683 if (conf->certificates == NULL) {
684 return NGX_CONF_OK;
685 }
686
687 if (conf->certificate_keys == NULL
688 || conf->certificate_keys->nelts < conf->certificates->nelts)
689 {
690 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
691 "no \"ssl_certificate_key\" is defined "
692 "for certificate \"%V\"",
693 ((ngx_str_t *) conf->certificates->elts)
694 + conf->certificates->nelts - 1);
695 return NGX_CONF_ERROR;
696 }
697 }
698
699 if (ngx_ssl_create(&conf->ssl, conf->protocols, conf) != NGX_OK) {
700 return NGX_CONF_ERROR;
701 }
702
703 cln = ngx_pool_cleanup_add(cf->pool, 0);
704 if (cln == NULL) {
705 ngx_ssl_cleanup_ctx(&conf->ssl);
706 return NGX_CONF_ERROR;
707 }
708
709 cln->handler = ngx_ssl_cleanup_ctx;
710 cln->data = &conf->ssl;
711
712 #ifdef SSL_CTRL_SET_TLSEXT_HOSTNAME
713
714 if (SSL_CTX_set_tlsext_servername_callback(conf->ssl.ctx,
715 ngx_http_ssl_servername)
716 == 0)
717 {
718 ngx_log_error(NGX_LOG_WARN, cf->log, 0,
719 "nginx was built with SNI support, however, now it is linked "
720 "dynamically to an OpenSSL library which has no tlsext support, "
721 "therefore SNI is not available");
722 }
723
724 #endif
725
726 #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
727 SSL_CTX_set_alpn_select_cb(conf->ssl.ctx, ngx_http_ssl_alpn_select, NULL);
728 #endif
729
730 #ifdef TLSEXT_TYPE_next_proto_neg
731 SSL_CTX_set_next_protos_advertised_cb(conf->ssl.ctx,
732 ngx_http_ssl_npn_advertised, NULL);
733 #endif
734
735 if (ngx_http_ssl_compile_certificates(cf, conf) != NGX_OK) {
736 return NGX_CONF_ERROR;
737 }
738
739 if (conf->certificate_values) {
740
741 #ifdef SSL_R_CERT_CB_ERROR
742
743 /* install callback to lookup certificates */
744
745 SSL_CTX_set_cert_cb(conf->ssl.ctx, ngx_http_ssl_certificate, conf);
746
747 #else
748 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
749 "variables in "
750 "\"ssl_certificate\" and \"ssl_certificate_key\" "
751 "directives are not supported on this platform");
752 return NGX_CONF_ERROR;
753 #endif
754
755 } else {
756
757 /* configure certificates */
758
759 if (ngx_ssl_certificates(cf, &conf->ssl, conf->certificates,
760 conf->certificate_keys, conf->passwords)
761 != NGX_OK)
762 {
763 return NGX_CONF_ERROR;
764 }
765 }
766
767 if (ngx_ssl_ciphers(cf, &conf->ssl, &conf->ciphers,
768 conf->prefer_server_ciphers)
769 != NGX_OK)
770 {
771 return NGX_CONF_ERROR;
772 }
773
774 conf->ssl.buffer_size = conf->buffer_size;
775
776 if (conf->verify) {
777
778 if (conf->client_certificate.len == 0 && conf->verify != 3) {
779 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
780 "no ssl_client_certificate for ssl_client_verify");
781 return NGX_CONF_ERROR;
782 }
783
784 if (ngx_ssl_client_certificate(cf, &conf->ssl,
785 &conf->client_certificate,
786 conf->verify_depth)
787 != NGX_OK)
788 {
789 return NGX_CONF_ERROR;
790 }
791 }
792
793 if (ngx_ssl_trusted_certificate(cf, &conf->ssl,
794 &conf->trusted_certificate,
795 conf->verify_depth)
796 != NGX_OK)
797 {
798 return NGX_CONF_ERROR;
799 }
800
801 if (ngx_ssl_crl(cf, &conf->ssl, &conf->crl) != NGX_OK) {
802 return NGX_CONF_ERROR;
803 }
804
805 if (ngx_ssl_dhparam(cf, &conf->ssl, &conf->dhparam) != NGX_OK) {
806 return NGX_CONF_ERROR;
807 }
808
809 if (ngx_ssl_ecdh_curve(cf, &conf->ssl, &conf->ecdh_curve) != NGX_OK) {
810 return NGX_CONF_ERROR;
811 }
812
813 ngx_conf_merge_value(conf->builtin_session_cache,
814 prev->builtin_session_cache, NGX_SSL_NONE_SCACHE);
815
816 if (conf->shm_zone == NULL) {
817 conf->shm_zone = prev->shm_zone;
818 }
819
820 if (ngx_ssl_session_cache(&conf->ssl, &ngx_http_ssl_sess_id_ctx,
821 conf->certificates, conf->builtin_session_cache,
822 conf->shm_zone, conf->session_timeout)
823 != NGX_OK)
824 {
825 return NGX_CONF_ERROR;
826 }
827
828 ngx_conf_merge_value(conf->session_tickets, prev->session_tickets, 1);
829
830 #ifdef SSL_OP_NO_TICKET
831 if (!conf->session_tickets) {
832 SSL_CTX_set_options(conf->ssl.ctx, SSL_OP_NO_TICKET);
833 }
834 #endif
835
836 ngx_conf_merge_ptr_value(conf->session_ticket_keys,
837 prev->session_ticket_keys, NULL);
838
839 if (ngx_ssl_session_ticket_keys(cf, &conf->ssl, conf->session_ticket_keys)
840 != NGX_OK)
841 {
842 return NGX_CONF_ERROR;
843 }
844
845 if (conf->stapling) {
846
847 if (ngx_ssl_stapling(cf, &conf->ssl, &conf->stapling_file,
848 &conf->stapling_responder, conf->stapling_verify)
849 != NGX_OK)
850 {
851 return NGX_CONF_ERROR;
852 }
853
854 }
855
856 if (ngx_ssl_early_data(cf, &conf->ssl, conf->early_data) != NGX_OK) {
857 return NGX_CONF_ERROR;
858 }
859
860 return NGX_CONF_OK;
861 }
862
863
864 static ngx_int_t
ngx_http_ssl_compile_certificates(ngx_conf_t * cf,ngx_http_ssl_srv_conf_t * conf)865 ngx_http_ssl_compile_certificates(ngx_conf_t *cf,
866 ngx_http_ssl_srv_conf_t *conf)
867 {
868 ngx_str_t *cert, *key;
869 ngx_uint_t i, nelts;
870 ngx_http_complex_value_t *cv;
871 ngx_http_compile_complex_value_t ccv;
872
873 cert = conf->certificates->elts;
874 key = conf->certificate_keys->elts;
875 nelts = conf->certificates->nelts;
876
877 for (i = 0; i < nelts; i++) {
878
879 if (ngx_http_script_variables_count(&cert[i])) {
880 goto found;
881 }
882
883 if (ngx_http_script_variables_count(&key[i])) {
884 goto found;
885 }
886 }
887
888 return NGX_OK;
889
890 found:
891
892 conf->certificate_values = ngx_array_create(cf->pool, nelts,
893 sizeof(ngx_http_complex_value_t));
894 if (conf->certificate_values == NULL) {
895 return NGX_ERROR;
896 }
897
898 conf->certificate_key_values = ngx_array_create(cf->pool, nelts,
899 sizeof(ngx_http_complex_value_t));
900 if (conf->certificate_key_values == NULL) {
901 return NGX_ERROR;
902 }
903
904 for (i = 0; i < nelts; i++) {
905
906 cv = ngx_array_push(conf->certificate_values);
907 if (cv == NULL) {
908 return NGX_ERROR;
909 }
910
911 ngx_memzero(&ccv, sizeof(ngx_http_compile_complex_value_t));
912
913 ccv.cf = cf;
914 ccv.value = &cert[i];
915 ccv.complex_value = cv;
916 ccv.zero = 1;
917
918 if (ngx_http_compile_complex_value(&ccv) != NGX_OK) {
919 return NGX_ERROR;
920 }
921
922 cv = ngx_array_push(conf->certificate_key_values);
923 if (cv == NULL) {
924 return NGX_ERROR;
925 }
926
927 ngx_memzero(&ccv, sizeof(ngx_http_compile_complex_value_t));
928
929 ccv.cf = cf;
930 ccv.value = &key[i];
931 ccv.complex_value = cv;
932 ccv.zero = 1;
933
934 if (ngx_http_compile_complex_value(&ccv) != NGX_OK) {
935 return NGX_ERROR;
936 }
937 }
938
939 conf->passwords = ngx_ssl_preserve_passwords(cf, conf->passwords);
940 if (conf->passwords == NULL) {
941 return NGX_ERROR;
942 }
943
944 return NGX_OK;
945 }
946
947
948 static char *
ngx_http_ssl_enable(ngx_conf_t * cf,ngx_command_t * cmd,void * conf)949 ngx_http_ssl_enable(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
950 {
951 ngx_http_ssl_srv_conf_t *sscf = conf;
952
953 char *rv;
954
955 rv = ngx_conf_set_flag_slot(cf, cmd, conf);
956
957 if (rv != NGX_CONF_OK) {
958 return rv;
959 }
960
961 sscf->file = cf->conf_file->file.name.data;
962 sscf->line = cf->conf_file->line;
963
964 return NGX_CONF_OK;
965 }
966
967
968 static char *
ngx_http_ssl_password_file(ngx_conf_t * cf,ngx_command_t * cmd,void * conf)969 ngx_http_ssl_password_file(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
970 {
971 ngx_http_ssl_srv_conf_t *sscf = conf;
972
973 ngx_str_t *value;
974
975 if (sscf->passwords != NGX_CONF_UNSET_PTR) {
976 return "is duplicate";
977 }
978
979 value = cf->args->elts;
980
981 sscf->passwords = ngx_ssl_read_password_file(cf, &value[1]);
982
983 if (sscf->passwords == NULL) {
984 return NGX_CONF_ERROR;
985 }
986
987 return NGX_CONF_OK;
988 }
989
990
991 static char *
ngx_http_ssl_session_cache(ngx_conf_t * cf,ngx_command_t * cmd,void * conf)992 ngx_http_ssl_session_cache(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
993 {
994 ngx_http_ssl_srv_conf_t *sscf = conf;
995
996 size_t len;
997 ngx_str_t *value, name, size;
998 ngx_int_t n;
999 ngx_uint_t i, j;
1000
1001 value = cf->args->elts;
1002
1003 for (i = 1; i < cf->args->nelts; i++) {
1004
1005 if (ngx_strcmp(value[i].data, "off") == 0) {
1006 sscf->builtin_session_cache = NGX_SSL_NO_SCACHE;
1007 continue;
1008 }
1009
1010 if (ngx_strcmp(value[i].data, "none") == 0) {
1011 sscf->builtin_session_cache = NGX_SSL_NONE_SCACHE;
1012 continue;
1013 }
1014
1015 if (ngx_strcmp(value[i].data, "builtin") == 0) {
1016 sscf->builtin_session_cache = NGX_SSL_DFLT_BUILTIN_SCACHE;
1017 continue;
1018 }
1019
1020 if (value[i].len > sizeof("builtin:") - 1
1021 && ngx_strncmp(value[i].data, "builtin:", sizeof("builtin:") - 1)
1022 == 0)
1023 {
1024 n = ngx_atoi(value[i].data + sizeof("builtin:") - 1,
1025 value[i].len - (sizeof("builtin:") - 1));
1026
1027 if (n == NGX_ERROR) {
1028 goto invalid;
1029 }
1030
1031 sscf->builtin_session_cache = n;
1032
1033 continue;
1034 }
1035
1036 if (value[i].len > sizeof("shared:") - 1
1037 && ngx_strncmp(value[i].data, "shared:", sizeof("shared:") - 1)
1038 == 0)
1039 {
1040 len = 0;
1041
1042 for (j = sizeof("shared:") - 1; j < value[i].len; j++) {
1043 if (value[i].data[j] == ':') {
1044 break;
1045 }
1046
1047 len++;
1048 }
1049
1050 if (len == 0) {
1051 goto invalid;
1052 }
1053
1054 name.len = len;
1055 name.data = value[i].data + sizeof("shared:") - 1;
1056
1057 size.len = value[i].len - j - 1;
1058 size.data = name.data + len + 1;
1059
1060 n = ngx_parse_size(&size);
1061
1062 if (n == NGX_ERROR) {
1063 goto invalid;
1064 }
1065
1066 if (n < (ngx_int_t) (8 * ngx_pagesize)) {
1067 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
1068 "session cache \"%V\" is too small",
1069 &value[i]);
1070
1071 return NGX_CONF_ERROR;
1072 }
1073
1074 sscf->shm_zone = ngx_shared_memory_add(cf, &name, n,
1075 &ngx_http_ssl_module);
1076 if (sscf->shm_zone == NULL) {
1077 return NGX_CONF_ERROR;
1078 }
1079
1080 sscf->shm_zone->init = ngx_ssl_session_cache_init;
1081
1082 continue;
1083 }
1084
1085 goto invalid;
1086 }
1087
1088 if (sscf->shm_zone && sscf->builtin_session_cache == NGX_CONF_UNSET) {
1089 sscf->builtin_session_cache = NGX_SSL_NO_BUILTIN_SCACHE;
1090 }
1091
1092 return NGX_CONF_OK;
1093
1094 invalid:
1095
1096 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
1097 "invalid session cache \"%V\"", &value[i]);
1098
1099 return NGX_CONF_ERROR;
1100 }
1101
1102
1103 static ngx_int_t
ngx_http_ssl_init(ngx_conf_t * cf)1104 ngx_http_ssl_init(ngx_conf_t *cf)
1105 {
1106 ngx_uint_t a, p, s;
1107 ngx_http_conf_addr_t *addr;
1108 ngx_http_conf_port_t *port;
1109 ngx_http_ssl_srv_conf_t *sscf;
1110 ngx_http_core_loc_conf_t *clcf;
1111 ngx_http_core_srv_conf_t **cscfp, *cscf;
1112 ngx_http_core_main_conf_t *cmcf;
1113
1114 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
1115 cscfp = cmcf->servers.elts;
1116
1117 for (s = 0; s < cmcf->servers.nelts; s++) {
1118
1119 sscf = cscfp[s]->ctx->srv_conf[ngx_http_ssl_module.ctx_index];
1120
1121 if (sscf->ssl.ctx == NULL || !sscf->stapling) {
1122 continue;
1123 }
1124
1125 clcf = cscfp[s]->ctx->loc_conf[ngx_http_core_module.ctx_index];
1126
1127 if (ngx_ssl_stapling_resolver(cf, &sscf->ssl, clcf->resolver,
1128 clcf->resolver_timeout)
1129 != NGX_OK)
1130 {
1131 return NGX_ERROR;
1132 }
1133 }
1134
1135 if (cmcf->ports == NULL) {
1136 return NGX_OK;
1137 }
1138
1139 port = cmcf->ports->elts;
1140 for (p = 0; p < cmcf->ports->nelts; p++) {
1141
1142 addr = port[p].addrs.elts;
1143 for (a = 0; a < port[p].addrs.nelts; a++) {
1144
1145 if (!addr[a].opt.ssl) {
1146 continue;
1147 }
1148
1149 cscf = addr[a].default_server;
1150 sscf = cscf->ctx->srv_conf[ngx_http_ssl_module.ctx_index];
1151
1152 if (sscf->certificates == NULL) {
1153 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
1154 "no \"ssl_certificate\" is defined for "
1155 "the \"listen ... ssl\" directive in %s:%ui",
1156 cscf->file_name, cscf->line);
1157 return NGX_ERROR;
1158 }
1159 }
1160 }
1161
1162 return NGX_OK;
1163 }
1164