3 * Copyright (C) Igor Sysoev
7 #include <ngx_config.h>
12 typedef ngx_int_t (*ngx_ssl_variable_handler_pt)(ngx_connection_t *c,
13 ngx_pool_t *pool, ngx_str_t *s);
16 #define NGX_DEFAULT_CIPHERS "ALL:!ADH:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP"
19 static ngx_int_t ngx_http_ssl_static_variable(ngx_http_request_t *r,
20 ngx_http_variable_value_t *v, uintptr_t data);
21 static ngx_int_t ngx_http_ssl_variable(ngx_http_request_t *r,
22 ngx_http_variable_value_t *v, uintptr_t data);
24 static ngx_int_t ngx_http_ssl_add_variables(ngx_conf_t *cf);
25 static void *ngx_http_ssl_create_srv_conf(ngx_conf_t *cf);
26 static char *ngx_http_ssl_merge_srv_conf(ngx_conf_t *cf,
27 void *parent, void *child);
29 static char *ngx_http_ssl_enable(ngx_conf_t *cf, ngx_command_t *cmd,
31 static char *ngx_http_ssl_session_cache(ngx_conf_t *cf, ngx_command_t *cmd,
34 #if !defined (SSL_OP_CIPHER_SERVER_PREFERENCE)
36 static char *ngx_http_ssl_nosupported(ngx_conf_t *cf, ngx_command_t *cmd,
39 static char ngx_http_ssl_openssl097[] = "OpenSSL 0.9.7 and higher";
44 static ngx_conf_bitmask_t ngx_http_ssl_protocols[] = {
45 { ngx_string("SSLv2"), NGX_SSL_SSLv2 },
46 { ngx_string("SSLv3"), NGX_SSL_SSLv3 },
47 { ngx_string("TLSv1"), NGX_SSL_TLSv1 },
48 { ngx_null_string, 0 }
52 static ngx_conf_enum_t ngx_http_ssl_verify[] = {
53 { ngx_string("off"), 0 },
54 { ngx_string("on"), 1 },
55 { ngx_string("ask"), 2 },
56 { ngx_null_string, 0 }
60 static ngx_command_t ngx_http_ssl_commands[] = {
63 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
65 NGX_HTTP_SRV_CONF_OFFSET,
66 offsetof(ngx_http_ssl_srv_conf_t, enable),
69 { ngx_string("ssl_certificate"),
70 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
71 ngx_conf_set_str_slot,
72 NGX_HTTP_SRV_CONF_OFFSET,
73 offsetof(ngx_http_ssl_srv_conf_t, certificate),
76 { ngx_string("ssl_certificate_key"),
77 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
78 ngx_conf_set_str_slot,
79 NGX_HTTP_SRV_CONF_OFFSET,
80 offsetof(ngx_http_ssl_srv_conf_t, certificate_key),
83 { ngx_string("ssl_dhparam"),
84 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
85 ngx_conf_set_str_slot,
86 NGX_HTTP_SRV_CONF_OFFSET,
87 offsetof(ngx_http_ssl_srv_conf_t, dhparam),
90 { ngx_string("ssl_protocols"),
91 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_1MORE,
92 ngx_conf_set_bitmask_slot,
93 NGX_HTTP_SRV_CONF_OFFSET,
94 offsetof(ngx_http_ssl_srv_conf_t, protocols),
95 &ngx_http_ssl_protocols },
97 { ngx_string("ssl_ciphers"),
98 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
99 ngx_conf_set_str_slot,
100 NGX_HTTP_SRV_CONF_OFFSET,
101 offsetof(ngx_http_ssl_srv_conf_t, ciphers),
104 { ngx_string("ssl_verify_client"),
105 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
106 ngx_conf_set_enum_slot,
107 NGX_HTTP_SRV_CONF_OFFSET,
108 offsetof(ngx_http_ssl_srv_conf_t, verify),
109 &ngx_http_ssl_verify },
111 { ngx_string("ssl_verify_depth"),
112 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_1MORE,
113 ngx_conf_set_num_slot,
114 NGX_HTTP_SRV_CONF_OFFSET,
115 offsetof(ngx_http_ssl_srv_conf_t, verify_depth),
118 { ngx_string("ssl_client_certificate"),
119 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
120 ngx_conf_set_str_slot,
121 NGX_HTTP_SRV_CONF_OFFSET,
122 offsetof(ngx_http_ssl_srv_conf_t, client_certificate),
125 { ngx_string("ssl_prefer_server_ciphers"),
126 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_FLAG,
127 #ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
128 ngx_conf_set_flag_slot,
129 NGX_HTTP_SRV_CONF_OFFSET,
130 offsetof(ngx_http_ssl_srv_conf_t, prefer_server_ciphers),
133 ngx_http_ssl_nosupported, 0, 0, ngx_http_ssl_openssl097 },
136 { ngx_string("ssl_session_cache"),
137 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE12,
138 ngx_http_ssl_session_cache,
139 NGX_HTTP_SRV_CONF_OFFSET,
143 { ngx_string("ssl_session_timeout"),
144 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_CONF_TAKE1,
145 ngx_conf_set_sec_slot,
146 NGX_HTTP_SRV_CONF_OFFSET,
147 offsetof(ngx_http_ssl_srv_conf_t, session_timeout),
154 static ngx_http_module_t ngx_http_ssl_module_ctx = {
155 ngx_http_ssl_add_variables, /* preconfiguration */
156 NULL, /* postconfiguration */
158 NULL, /* create main configuration */
159 NULL, /* init main configuration */
161 ngx_http_ssl_create_srv_conf, /* create server configuration */
162 ngx_http_ssl_merge_srv_conf, /* merge server configuration */
164 NULL, /* create location configuration */
165 NULL /* merge location configuration */
169 ngx_module_t ngx_http_ssl_module = {
171 &ngx_http_ssl_module_ctx, /* module context */
172 ngx_http_ssl_commands, /* module directives */
173 NGX_HTTP_MODULE, /* module type */
174 NULL, /* init master */
175 NULL, /* init module */
176 NULL, /* init process */
177 NULL, /* init thread */
178 NULL, /* exit thread */
179 NULL, /* exit process */
180 NULL, /* exit master */
181 NGX_MODULE_V1_PADDING
185 static ngx_http_variable_t ngx_http_ssl_vars[] = {
187 { ngx_string("ssl_protocol"), NULL, ngx_http_ssl_static_variable,
188 (uintptr_t) ngx_ssl_get_protocol, NGX_HTTP_VAR_CHANGEABLE, 0 },
190 { ngx_string("ssl_cipher"), NULL, ngx_http_ssl_static_variable,
191 (uintptr_t) ngx_ssl_get_cipher_name, NGX_HTTP_VAR_CHANGEABLE, 0 },
193 { ngx_string("ssl_client_cert"), NULL, ngx_http_ssl_variable,
194 (uintptr_t) ngx_ssl_get_certificate, NGX_HTTP_VAR_CHANGEABLE, 0 },
196 { ngx_string("ssl_client_raw_cert"), NULL, ngx_http_ssl_variable,
197 (uintptr_t) ngx_ssl_get_raw_certificate,
198 NGX_HTTP_VAR_CHANGEABLE, 0 },
200 { ngx_string("ssl_client_s_dn"), NULL, ngx_http_ssl_variable,
201 (uintptr_t) ngx_ssl_get_subject_dn, NGX_HTTP_VAR_CHANGEABLE, 0 },
203 { ngx_string("ssl_client_i_dn"), NULL, ngx_http_ssl_variable,
204 (uintptr_t) ngx_ssl_get_issuer_dn, NGX_HTTP_VAR_CHANGEABLE, 0 },
206 { ngx_string("ssl_client_serial"), NULL, ngx_http_ssl_variable,
207 (uintptr_t) ngx_ssl_get_serial_number, NGX_HTTP_VAR_CHANGEABLE, 0 },
209 { ngx_null_string, NULL, NULL, 0, 0, 0 }
213 static ngx_str_t ngx_http_ssl_sess_id_ctx = ngx_string("HTTP");
217 ngx_http_ssl_static_variable(ngx_http_request_t *r,
218 ngx_http_variable_value_t *v, uintptr_t data)
220 ngx_ssl_variable_handler_pt handler = (ngx_ssl_variable_handler_pt) data;
225 if (r->connection->ssl) {
227 (void) handler(r->connection, NULL, &s);
231 for (len = 0; v->data[len]; len++) { /* void */ }
248 ngx_http_ssl_variable(ngx_http_request_t *r, ngx_http_variable_value_t *v,
251 ngx_ssl_variable_handler_pt handler = (ngx_ssl_variable_handler_pt) data;
255 if (r->connection->ssl) {
257 if (handler(r->connection, r->pool, &s) != NGX_OK) {
280 ngx_http_ssl_add_variables(ngx_conf_t *cf)
282 ngx_http_variable_t *var, *v;
284 for (v = ngx_http_ssl_vars; v->name.len; v++) {
285 var = ngx_http_add_variable(cf, &v->name, v->flags);
290 var->get_handler = v->get_handler;
299 ngx_http_ssl_create_srv_conf(ngx_conf_t *cf)
301 ngx_http_ssl_srv_conf_t *sscf;
303 sscf = ngx_pcalloc(cf->pool, sizeof(ngx_http_ssl_srv_conf_t));
305 return NGX_CONF_ERROR;
309 * set by ngx_pcalloc():
311 * sscf->protocols = 0;
312 * sscf->certificate = { 0, NULL };
313 * sscf->certificate_key = { 0, NULL };
314 * sscf->dhparam = { 0, NULL };
315 * sscf->client_certificate = { 0, NULL };
316 * sscf->ciphers.len = 0;
317 * sscf->ciphers.data = NULL;
318 * sscf->shm_zone = NULL;
321 sscf->enable = NGX_CONF_UNSET;
322 sscf->prefer_server_ciphers = NGX_CONF_UNSET;
323 sscf->verify = NGX_CONF_UNSET;
324 sscf->verify_depth = NGX_CONF_UNSET;
325 sscf->builtin_session_cache = NGX_CONF_UNSET;
326 sscf->session_timeout = NGX_CONF_UNSET;
333 ngx_http_ssl_merge_srv_conf(ngx_conf_t *cf, void *parent, void *child)
335 ngx_http_ssl_srv_conf_t *prev = parent;
336 ngx_http_ssl_srv_conf_t *conf = child;
338 ngx_pool_cleanup_t *cln;
340 ngx_conf_merge_value(conf->enable, prev->enable, 0);
342 ngx_conf_merge_value(conf->session_timeout,
343 prev->session_timeout, 300);
345 ngx_conf_merge_value(conf->prefer_server_ciphers,
346 prev->prefer_server_ciphers, 0);
348 ngx_conf_merge_bitmask_value(conf->protocols, prev->protocols,
349 (NGX_CONF_BITMASK_SET
350 |NGX_SSL_SSLv2|NGX_SSL_SSLv3|NGX_SSL_TLSv1));
352 ngx_conf_merge_uint_value(conf->verify, prev->verify, 0);
353 ngx_conf_merge_uint_value(conf->verify_depth, prev->verify_depth, 1);
355 ngx_conf_merge_str_value(conf->certificate, prev->certificate, "");
356 ngx_conf_merge_str_value(conf->certificate_key, prev->certificate_key, "");
358 ngx_conf_merge_str_value(conf->dhparam, prev->dhparam, "");
360 ngx_conf_merge_str_value(conf->client_certificate, prev->client_certificate,
363 ngx_conf_merge_str_value(conf->ciphers, prev->ciphers, NGX_DEFAULT_CIPHERS);
366 conf->ssl.log = cf->log;
370 if (conf->certificate.len == 0) {
371 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
372 "no \"ssl_certificate\" is defined for "
373 "the \"ssl\" directive in %s:%ui",
374 conf->file, conf->line);
375 return NGX_CONF_ERROR;
378 if (conf->certificate_key.len == 0) {
379 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
380 "no \"ssl_certificate_key\" is defined for "
381 "the \"ssl\" directive in %s:%ui",
382 conf->file, conf->line);
383 return NGX_CONF_ERROR;
388 if (conf->certificate.len == 0) {
392 if (conf->certificate_key.len == 0) {
393 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
394 "no \"ssl_certificate_key\" is defined "
395 "for certificate \"%V\"", &conf->certificate);
396 return NGX_CONF_ERROR;
400 if (ngx_ssl_create(&conf->ssl, conf->protocols, conf) != NGX_OK) {
401 return NGX_CONF_ERROR;
404 #ifdef SSL_CTRL_SET_TLSEXT_HOSTNAME
406 if (SSL_CTX_set_tlsext_servername_callback(conf->ssl.ctx,
407 ngx_http_ssl_servername)
410 ngx_ssl_error(NGX_LOG_EMERG, cf->log, 0,
411 "SSL_CTX_set_tlsext_servername_callback() failed");
412 return NGX_CONF_ERROR;
417 cln = ngx_pool_cleanup_add(cf->pool, 0);
419 return NGX_CONF_ERROR;
422 cln->handler = ngx_ssl_cleanup_ctx;
423 cln->data = &conf->ssl;
425 if (ngx_ssl_certificate(cf, &conf->ssl, &conf->certificate,
426 &conf->certificate_key)
429 return NGX_CONF_ERROR;
432 if (SSL_CTX_set_cipher_list(conf->ssl.ctx,
433 (const char *) conf->ciphers.data)
436 ngx_ssl_error(NGX_LOG_EMERG, cf->log, 0,
437 "SSL_CTX_set_cipher_list(\"%V\") failed",
443 if (conf->client_certificate.len == 0) {
444 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
445 "no ssl_client_certificate for ssl_client_verify");
446 return NGX_CONF_ERROR;
449 if (ngx_ssl_client_certificate(cf, &conf->ssl,
450 &conf->client_certificate,
454 return NGX_CONF_ERROR;
458 #ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
460 if (conf->prefer_server_ciphers) {
461 SSL_CTX_set_options(conf->ssl.ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
466 /* a temporary 512-bit RSA key is required for export versions of MSIE */
467 if (ngx_ssl_generate_rsa512_key(&conf->ssl) != NGX_OK) {
468 return NGX_CONF_ERROR;
471 if (ngx_ssl_dhparam(cf, &conf->ssl, &conf->dhparam) != NGX_OK) {
472 return NGX_CONF_ERROR;
475 ngx_conf_merge_value(conf->builtin_session_cache,
476 prev->builtin_session_cache, NGX_SSL_NONE_SCACHE);
478 if (conf->shm_zone == NULL) {
479 conf->shm_zone = prev->shm_zone;
482 if (ngx_ssl_session_cache(&conf->ssl, &ngx_http_ssl_sess_id_ctx,
483 conf->builtin_session_cache,
484 conf->shm_zone, conf->session_timeout)
487 return NGX_CONF_ERROR;
495 ngx_http_ssl_enable(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
497 ngx_http_ssl_srv_conf_t *sscf = conf;
501 rv = ngx_conf_set_flag_slot(cf, cmd, conf);
503 if (rv != NGX_CONF_OK) {
507 sscf->file = cf->conf_file->file.name.data;
508 sscf->line = cf->conf_file->line;
515 ngx_http_ssl_session_cache(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
517 ngx_http_ssl_srv_conf_t *sscf = conf;
520 ngx_str_t *value, name, size;
524 value = cf->args->elts;
526 for (i = 1; i < cf->args->nelts; i++) {
528 if (ngx_strcmp(value[i].data, "off") == 0) {
529 sscf->builtin_session_cache = NGX_SSL_NO_SCACHE;
533 if (ngx_strcmp(value[i].data, "none") == 0) {
534 sscf->builtin_session_cache = NGX_SSL_NONE_SCACHE;
538 if (ngx_strcmp(value[i].data, "builtin") == 0) {
539 sscf->builtin_session_cache = NGX_SSL_DFLT_BUILTIN_SCACHE;
543 if (value[i].len > sizeof("builtin:") - 1
544 && ngx_strncmp(value[i].data, "builtin:", sizeof("builtin:") - 1)
547 n = ngx_atoi(value[i].data + sizeof("builtin:") - 1,
548 value[i].len - (sizeof("builtin:") - 1));
550 if (n == NGX_ERROR) {
554 sscf->builtin_session_cache = n;
559 if (value[i].len > sizeof("shared:") - 1
560 && ngx_strncmp(value[i].data, "shared:", sizeof("shared:") - 1)
565 for (j = sizeof("shared:") - 1; j < value[i].len; j++) {
566 if (value[i].data[j] == ':') {
578 name.data = value[i].data + sizeof("shared:") - 1;
580 size.len = value[i].len - j - 1;
581 size.data = name.data + len + 1;
583 n = ngx_parse_size(&size);
585 if (n == NGX_ERROR) {
589 if (n < (ngx_int_t) (8 * ngx_pagesize)) {
590 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
591 "session cache \"%V\" is too small",
594 return NGX_CONF_ERROR;
597 sscf->shm_zone = ngx_shared_memory_add(cf, &name, n,
598 &ngx_http_ssl_module);
599 if (sscf->shm_zone == NULL) {
600 return NGX_CONF_ERROR;
609 if (sscf->shm_zone && sscf->builtin_session_cache == NGX_CONF_UNSET) {
610 sscf->builtin_session_cache = NGX_SSL_NO_BUILTIN_SCACHE;
617 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
618 "invalid session cache \"%V\"", &value[i]);
620 return NGX_CONF_ERROR;
624 #if !defined (SSL_OP_CIPHER_SERVER_PREFERENCE)
627 ngx_http_ssl_nosupported(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
629 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
630 "\"%V\" directive is available only in %s,",
631 &cmd->name, cmd->post);
633 return NGX_CONF_ERROR;