[PATCH 3 of 6] SSL: caching certificates
Mini Hawthorne
mini at nginx.com
Tue Jul 23 19:30:26 UTC 2024
# HG changeset patch
# User Mini Hawthorne <mini at f5.com>
# Date 1721762857 0
# Tue Jul 23 19:27:37 2024 +0000
# Node ID 42e86c051200bf00d9ae6e38d6c87a916391b642
# Parent 8eee61e223bb7cb7475e50b866fd6b9a83fa5fa0
SSL: caching certificates.
Added ngx_ssl_cache_cert, which loads certificate chains once via BIO's
created by ngx_ssl_cache_create_bio() which will be used by the following
patches as well.
The certificate cache provides each chain as a unique stack of shared
references. This shallow copy is required because OpenSSL's stacks aren't
reference counted; instead they contain a unique array of referenced entries.
Also note that callers must pop the first certificate off of the stack due to
awkwardness in OpenSSL certificate API.
diff --git a/src/event/ngx_event_openssl.c b/src/event/ngx_event_openssl.c
--- a/src/event/ngx_event_openssl.c
+++ b/src/event/ngx_event_openssl.c
@@ -18,8 +18,6 @@ typedef struct {
} ngx_openssl_conf_t;
-static X509 *ngx_ssl_load_certificate(ngx_pool_t *pool, char **err,
- ngx_str_t *cert, STACK_OF(X509) **chain);
static EVP_PKEY *ngx_ssl_load_certificate_key(ngx_pool_t *pool, char **err,
ngx_str_t *key, ngx_array_t *passwords);
static int ngx_ssl_password_callback(char *buf, int size, int rwflag,
@@ -443,8 +441,9 @@ ngx_ssl_certificate(ngx_conf_t *cf, ngx_
STACK_OF(X509) *chain;
ngx_ssl_name_t *name;
- x509 = ngx_ssl_load_certificate(cf->pool, &err, cert, &chain);
- if (x509 == NULL) {
+ chain = ngx_ssl_cache_fetch(cf->cycle, cf->pool, &ngx_ssl_cache_cert,
+ &err, cert, NULL);
+ if (chain == NULL) {
if (err != NULL) {
ngx_ssl_error(NGX_LOG_EMERG, ssl->log, 0,
"cannot load certificate \"%s\": %s",
@@ -454,6 +453,8 @@ ngx_ssl_certificate(ngx_conf_t *cf, ngx_
return NGX_ERROR;
}
+ x509 = sk_X509_shift(chain);
+
if (SSL_CTX_use_certificate(ssl->ctx, x509) == 0) {
ngx_ssl_error(NGX_LOG_EMERG, ssl->log, 0,
"SSL_CTX_use_certificate(\"%s\") failed", cert->data);
@@ -568,8 +569,9 @@ ngx_ssl_connection_certificate(ngx_conne
EVP_PKEY *pkey;
STACK_OF(X509) *chain;
- x509 = ngx_ssl_load_certificate(pool, &err, cert, &chain);
- if (x509 == NULL) {
+ chain = ngx_ssl_cache_fetch((ngx_cycle_t *) ngx_cycle, c->pool,
+ &ngx_ssl_cache_cert, &err, cert, NULL);
+ if (chain == NULL) {
if (err != NULL) {
ngx_ssl_error(NGX_LOG_ERR, c->log, 0,
"cannot load certificate \"%s\": %s",
@@ -579,6 +581,8 @@ ngx_ssl_connection_certificate(ngx_conne
return NGX_ERROR;
}
+ x509 = sk_X509_shift(chain);
+
if (SSL_use_certificate(c->ssl->connection, x509) == 0) {
ngx_ssl_error(NGX_LOG_ERR, c->log, 0,
"SSL_use_certificate(\"%s\") failed", cert->data);
@@ -630,96 +634,6 @@ ngx_ssl_connection_certificate(ngx_conne
}
-static X509 *
-ngx_ssl_load_certificate(ngx_pool_t *pool, char **err, ngx_str_t *cert,
- STACK_OF(X509) **chain)
-{
- BIO *bio;
- X509 *x509, *temp;
- u_long n;
-
- if (ngx_strncmp(cert->data, "data:", sizeof("data:") - 1) == 0) {
-
- bio = BIO_new_mem_buf(cert->data + sizeof("data:") - 1,
- cert->len - (sizeof("data:") - 1));
- if (bio == NULL) {
- *err = "BIO_new_mem_buf() failed";
- return NULL;
- }
-
- } else {
-
- if (ngx_get_full_name(pool, (ngx_str_t *) &ngx_cycle->conf_prefix, cert)
- != NGX_OK)
- {
- *err = NULL;
- return NULL;
- }
-
- bio = BIO_new_file((char *) cert->data, "r");
- if (bio == NULL) {
- *err = "BIO_new_file() failed";
- return NULL;
- }
- }
-
- /* certificate itself */
-
- x509 = PEM_read_bio_X509_AUX(bio, NULL, NULL, NULL);
- if (x509 == NULL) {
- *err = "PEM_read_bio_X509_AUX() failed";
- BIO_free(bio);
- return NULL;
- }
-
- /* rest of the chain */
-
- *chain = sk_X509_new_null();
- if (*chain == NULL) {
- *err = "sk_X509_new_null() failed";
- BIO_free(bio);
- X509_free(x509);
- return NULL;
- }
-
- for ( ;; ) {
-
- temp = PEM_read_bio_X509(bio, NULL, NULL, NULL);
- if (temp == NULL) {
- n = ERR_peek_last_error();
-
- if (ERR_GET_LIB(n) == ERR_LIB_PEM
- && ERR_GET_REASON(n) == PEM_R_NO_START_LINE)
- {
- /* end of file */
- ERR_clear_error();
- break;
- }
-
- /* some real error */
-
- *err = "PEM_read_bio_X509() failed";
- BIO_free(bio);
- X509_free(x509);
- sk_X509_pop_free(*chain, X509_free);
- return NULL;
- }
-
- if (sk_X509_push(*chain, temp) == 0) {
- *err = "sk_X509_push() failed";
- BIO_free(bio);
- X509_free(x509);
- sk_X509_pop_free(*chain, X509_free);
- return NULL;
- }
- }
-
- BIO_free(bio);
-
- return x509;
-}
-
-
static EVP_PKEY *
ngx_ssl_load_certificate_key(ngx_pool_t *pool, char **err,
ngx_str_t *key, ngx_array_t *passwords)
diff --git a/src/event/ngx_event_openssl.h b/src/event/ngx_event_openssl.h
--- a/src/event/ngx_event_openssl.h
+++ b/src/event/ngx_event_openssl.h
@@ -351,4 +351,7 @@ extern int ngx_ssl_ocsp_index;
extern int ngx_ssl_index;
+extern ngx_ssl_cache_type_t ngx_ssl_cache_cert;
+
+
#endif /* _NGX_EVENT_OPENSSL_H_INCLUDED_ */
diff --git a/src/event/ngx_event_openssl_cache.c b/src/event/ngx_event_openssl_cache.c
--- a/src/event/ngx_event_openssl_cache.c
+++ b/src/event/ngx_event_openssl_cache.c
@@ -46,6 +46,12 @@ static void ngx_ssl_cache_node_insert(ng
static ngx_ssl_cache_node_t *ngx_ssl_cache_lookup(ngx_ssl_cache_t *cache,
ngx_ssl_cache_type_t *type, ngx_str_t *id, uint32_t hash);
+static void *ngx_ssl_cache_cert_create(ngx_str_t *id, char **err, void *data);
+static void ngx_ssl_cache_cert_free(void *data);
+static void *ngx_ssl_cache_cert_ref(char **err, void *data);
+
+static BIO *ngx_ssl_cache_create_bio(ngx_str_t *id, char **err);
+
static ngx_core_module_t ngx_openssl_cache_module_ctx = {
ngx_string("openssl_cache"),
@@ -54,6 +60,15 @@ static ngx_core_module_t ngx_openssl_ca
};
+ngx_ssl_cache_type_t ngx_ssl_cache_cert = {
+ "certificate chain",
+
+ ngx_ssl_cache_cert_create,
+ ngx_ssl_cache_cert_free,
+ ngx_ssl_cache_cert_ref,
+};
+
+
ngx_module_t ngx_openssl_cache_module = {
NGX_MODULE_V1,
&ngx_openssl_cache_module_ctx, /* module context */
@@ -275,3 +290,165 @@ ngx_ssl_cache_lookup(ngx_ssl_cache_t *ca
return NULL;
}
+
+
+static void *
+ngx_ssl_cache_cert_create(ngx_str_t *id, char **err, void *data)
+{
+ BIO *bio;
+ X509 *x;
+ u_long n;
+ STACK_OF(X509) *sk;
+
+ /* start with an empty certificate chain */
+ sk = sk_X509_new_null();
+ if (sk == NULL) {
+ *err = "sk_X509_new_null() failed";
+ return NULL;
+ }
+
+ /* figure out where to load from */
+ bio = ngx_ssl_cache_create_bio(id, err);
+ if (bio == NULL) {
+ sk_X509_pop_free(sk, X509_free);
+ return NULL;
+ }
+
+ /* certificate itself */
+ x = PEM_read_bio_X509_AUX(bio, NULL, NULL, NULL);
+ if (x == NULL) {
+ *err = "PEM_read_bio_X509_AUX() failed";
+ BIO_free(bio);
+ sk_X509_pop_free(sk, X509_free);
+ return NULL;
+ }
+
+ if (sk_X509_push(sk, x) <= 0) {
+ *err = "sk_X509_push() failed";
+ BIO_free(bio);
+ X509_free(x);
+ sk_X509_pop_free(sk, X509_free);
+ return NULL;
+ }
+
+ /* rest of the chain */
+ for ( ;; ) {
+
+ x = PEM_read_bio_X509(bio, NULL, NULL, NULL);
+ if (x == NULL) {
+ n = ERR_peek_last_error();
+
+ if (ERR_GET_LIB(n) == ERR_LIB_PEM
+ && ERR_GET_REASON(n) == PEM_R_NO_START_LINE)
+ {
+ /* end of file */
+ ERR_clear_error();
+ break;
+ }
+
+ /* some real error */
+ *err = "PEM_read_bio_X509() failed";
+ BIO_free(bio);
+ sk_X509_pop_free(sk, X509_free);
+ return NULL;
+ }
+
+ if (sk_X509_push(sk, x) <= 0) {
+ /* memory allocation failed */
+ *err = "sk_X509_push() failed";
+ BIO_free(bio);
+ sk_X509_pop_free(sk, X509_free);
+ return NULL;
+ }
+ }
+
+ BIO_free(bio);
+ return sk;
+}
+
+
+static void
+ngx_ssl_cache_cert_free(void *data)
+{
+ sk_X509_pop_free(data, X509_free);
+}
+
+
+static void *
+ngx_ssl_cache_cert_ref(char **err, void *data)
+{
+ int n, i;
+ X509 *x;
+ STACK_OF(X509) *sk;
+
+ /* stacks aren't reference-counted, so shallow copy into a new stack */
+ sk = sk_X509_dup(data);
+ if (sk == NULL) {
+ *err = "sk_X509_dup() failed";
+ return NULL;
+ }
+
+ /* bump the certificates' reference counts */
+ n = sk_X509_num(sk);
+
+ for (i = 0; i < n; i++) {
+ x = sk_X509_value(sk, i);
+
+#if (OPENSSL_VERSION_NUMBER >= 0x10100000L)
+ X509_up_ref(x);
+#else
+ CRYPTO_add(&x->references, 1, CRYPTO_LOCK_X509);
+#endif
+ }
+
+ return sk;
+}
+
+
+static BIO *
+ngx_ssl_cache_create_bio(ngx_str_t *id, char **err)
+{
+ BIO *bio;
+ ngx_str_t path;
+ ngx_pool_t *temp_pool;
+
+ if (ngx_strncmp(id->data, "data:", sizeof("data:") - 1) == 0) {
+ bio = BIO_new_mem_buf(id->data + sizeof("data:") - 1,
+ id->len - (sizeof("data:") - 1));
+
+ if (bio == NULL) {
+ *err = "BIO_new_mem_buf() failed";
+ }
+
+ return bio;
+ }
+
+ /* generate a translated path */
+ temp_pool = ngx_create_pool(NGX_MAX_PATH, ngx_cycle->log);
+ if (temp_pool == NULL) {
+ *err = NULL;
+ return NULL;
+ }
+
+ ngx_memcpy(&path, id, sizeof(ngx_str_t));
+
+ if (ngx_get_full_name(temp_pool,
+ (ngx_str_t *) &ngx_cycle->conf_prefix,
+ &path)
+ != NGX_OK)
+ {
+ *err = NULL;
+ ngx_destroy_pool(temp_pool);
+ return NULL;
+ }
+
+ bio = BIO_new_file((char *) path.data, "r");
+
+ if (bio == NULL) {
+ *err = "BIO_new_file() failed";
+ }
+
+ ngx_destroy_pool(temp_pool);
+
+ return bio;
+}
More information about the nginx-devel
mailing list