2 * nghttp2 - HTTP/2 C Library
4 * Copyright (c) 2012 Tatsuhiro Tsujikawa
6 * Permission is hereby granted, free of charge, to any person obtaining
7 * a copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sublicense, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice shall be
15 * included in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
21 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 #include "shrpx_tls.h"
27 #ifdef HAVE_SYS_SOCKET_H
28 #include <sys/socket.h>
29 #endif // HAVE_SYS_SOCKET_H
32 #endif // HAVE_NETDB_H
33 #include <netinet/tcp.h>
35 #include <sys/types.h>
43 #include <openssl/crypto.h>
44 #include <openssl/x509.h>
45 #include <openssl/x509v3.h>
46 #include <openssl/rand.h>
47 #include <openssl/dh.h>
48 #ifndef OPENSSL_NO_OCSP
49 #include <openssl/ocsp.h>
50 #endif // OPENSSL_NO_OCSP
52 #include <nghttp2/nghttp2.h>
54 #include "shrpx_log.h"
55 #include "shrpx_client_handler.h"
56 #include "shrpx_config.h"
57 #include "shrpx_worker.h"
58 #include "shrpx_downstream_connection_pool.h"
59 #include "shrpx_http2_session.h"
60 #include "shrpx_memcached_request.h"
61 #include "shrpx_memcached_dispatcher.h"
62 #include "shrpx_connection_handler.h"
66 #include "ssl_compat.h"
69 using namespace nghttp2;
77 const unsigned char *ASN1_STRING_get0_data(ASN1_STRING *x) {
78 return ASN1_STRING_data(x);
81 #endif // !OPENSSL_1_1_API
84 int next_proto_cb(SSL *s, const unsigned char **data, unsigned int *len,
86 auto &prefs = get_config()->tls.alpn_prefs;
89 return SSL_TLSEXT_ERR_OK;
94 int verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
96 int err = X509_STORE_CTX_get_error(ctx);
97 int depth = X509_STORE_CTX_get_error_depth(ctx);
98 if (err == X509_V_ERR_CERT_HAS_EXPIRED && depth == 0 &&
99 get_config()->tls.client_verify.tolerate_expired) {
100 LOG(INFO) << "The client certificate has expired, but is accepted by "
104 LOG(ERROR) << "client certificate verify error:num=" << err << ":"
105 << X509_verify_cert_error_string(err) << ":depth=" << depth;
111 int set_alpn_prefs(std::vector<unsigned char> &out,
112 const std::vector<StringRef> &protos) {
115 for (const auto &proto : protos) {
116 if (proto.size() > 255) {
117 LOG(FATAL) << "Too long ALPN identifier: " << proto.size();
121 len += 1 + proto.size();
124 if (len > (1 << 16) - 1) {
125 LOG(FATAL) << "Too long ALPN identifier list: " << len;
130 auto ptr = out.data();
132 for (const auto &proto : protos) {
133 *ptr++ = proto.size();
134 ptr = std::copy(std::begin(proto), std::end(proto), ptr);
141 int ssl_pem_passwd_cb(char *buf, int size, int rwflag, void *user_data) {
142 auto config = static_cast<Config *>(user_data);
143 auto len = static_cast<int>(config->tls.private_key_passwd.size());
144 if (size < len + 1) {
145 LOG(ERROR) << "ssl_pem_passwd_cb: buf is too small " << size;
148 // Copy string including last '\0'.
149 memcpy(buf, config->tls.private_key_passwd.c_str(), len + 1);
155 // *al is set to SSL_AD_UNRECOGNIZED_NAME by openssl, so we don't have
156 // to set it explicitly.
157 int servername_callback(SSL *ssl, int *al, void *arg) {
158 auto conn = static_cast<Connection *>(SSL_get_app_data(ssl));
159 auto handler = static_cast<ClientHandler *>(conn->data);
160 auto worker = handler->get_worker();
162 auto rawhost = SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
163 if (rawhost == nullptr) {
164 return SSL_TLSEXT_ERR_NOACK;
167 auto len = strlen(rawhost);
168 // NI_MAXHOST includes terminal NULL.
169 if (len == 0 || len + 1 > NI_MAXHOST) {
170 return SSL_TLSEXT_ERR_NOACK;
173 std::array<uint8_t, NI_MAXHOST> buf;
175 auto end_buf = std::copy_n(rawhost, len, std::begin(buf));
177 util::inp_strlower(std::begin(buf), end_buf);
179 auto hostname = StringRef{std::begin(buf), end_buf};
181 auto cert_tree = worker->get_cert_lookup_tree();
183 auto idx = cert_tree->lookup(hostname);
185 return SSL_TLSEXT_ERR_NOACK;
188 handler->set_tls_sni(hostname);
190 auto conn_handler = worker->get_connection_handler();
192 const auto &ssl_ctx_list = conn_handler->get_indexed_ssl_ctx(idx);
193 assert(!ssl_ctx_list.empty());
195 #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
196 OPENSSL_VERSION_NUMBER >= 0x10002000L
197 auto num_shared_curves = SSL_get_shared_curve(ssl, -1);
199 for (auto i = 0; i < num_shared_curves; ++i) {
200 auto shared_curve = SSL_get_shared_curve(ssl, i);
202 for (auto ssl_ctx : ssl_ctx_list) {
203 auto cert = SSL_CTX_get0_certificate(ssl_ctx);
206 auto pubkey = X509_get0_pubkey(cert);
207 #else // !OPENSSL_1_1_API
208 auto pubkey = X509_get_pubkey(cert);
209 #endif // !OPENSSL_1_1_API
211 if (EVP_PKEY_base_id(pubkey) != EVP_PKEY_EC) {
216 auto eckey = EVP_PKEY_get0_EC_KEY(pubkey);
217 #else // !OPENSSL_1_1_API
218 auto eckey = EVP_PKEY_get1_EC_KEY(pubkey);
219 #endif // !OPENSSL_1_1_API
221 if (eckey == nullptr) {
225 auto ecgroup = EC_KEY_get0_group(eckey);
226 auto cert_curve = EC_GROUP_get_curve_name(ecgroup);
230 EVP_PKEY_free(pubkey);
231 #endif // !OPENSSL_1_1_API
233 if (shared_curve == cert_curve) {
234 SSL_set_SSL_CTX(ssl, ssl_ctx);
235 return SSL_TLSEXT_ERR_OK;
239 #endif // !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) &&
240 // OPENSSL_VERSION_NUMBER >= 0x10002000L
242 SSL_set_SSL_CTX(ssl, ssl_ctx_list[0]);
244 return SSL_TLSEXT_ERR_OK;
248 #ifndef OPENSSL_IS_BORINGSSL
250 std::shared_ptr<std::vector<uint8_t>>
251 get_ocsp_data(TLSContextData *tls_ctx_data) {
252 #ifdef HAVE_ATOMIC_STD_SHARED_PTR
253 return std::atomic_load_explicit(&tls_ctx_data->ocsp_data,
254 std::memory_order_acquire);
255 #else // !HAVE_ATOMIC_STD_SHARED_PTR
256 std::lock_guard<std::mutex> g(tls_ctx_data->mu);
257 return tls_ctx_data->ocsp_data;
258 #endif // !HAVE_ATOMIC_STD_SHARED_PTR
263 int ocsp_resp_cb(SSL *ssl, void *arg) {
264 auto ssl_ctx = SSL_get_SSL_CTX(ssl);
266 static_cast<TLSContextData *>(SSL_CTX_get_app_data(ssl_ctx));
268 auto data = get_ocsp_data(tls_ctx_data);
271 return SSL_TLSEXT_ERR_OK;
275 static_cast<uint8_t *>(CRYPTO_malloc(data->size(), __FILE__, __LINE__));
278 return SSL_TLSEXT_ERR_OK;
281 std::copy(std::begin(*data), std::end(*data), buf);
283 SSL_set_tlsext_status_ocsp_resp(ssl, buf, data->size());
285 return SSL_TLSEXT_ERR_OK;
288 #endif // OPENSSL_IS_BORINGSSL
290 constexpr auto MEMCACHED_SESSION_CACHE_KEY_PREFIX =
291 StringRef::from_lit("nghttpx:tls-session-cache:");
294 int tls_session_client_new_cb(SSL *ssl, SSL_SESSION *session) {
295 auto conn = static_cast<Connection *>(SSL_get_app_data(ssl));
296 if (conn->tls.client_session_cache == nullptr) {
300 try_cache_tls_session(conn->tls.client_session_cache, session,
308 int tls_session_new_cb(SSL *ssl, SSL_SESSION *session) {
309 auto conn = static_cast<Connection *>(SSL_get_app_data(ssl));
310 auto handler = static_cast<ClientHandler *>(conn->data);
311 auto worker = handler->get_worker();
312 auto dispatcher = worker->get_session_cache_memcached_dispatcher();
313 auto &balloc = handler->get_block_allocator();
315 #ifdef TLS1_3_VERSION
316 if (SSL_version(ssl) == TLS1_3_VERSION) {
319 #endif // TLS1_3_VERSION
321 const unsigned char *id;
324 id = SSL_SESSION_get_id(session, &idlen);
326 if (LOG_ENABLED(INFO)) {
327 LOG(INFO) << "Memcached: cache session, id=" << util::format_hex(id, idlen);
330 auto req = make_unique<MemcachedRequest>();
331 req->op = MEMCACHED_OP_ADD;
332 req->key = MEMCACHED_SESSION_CACHE_KEY_PREFIX.str();
334 util::format_hex(balloc, StringRef{id, static_cast<size_t>(idlen)});
336 auto sessionlen = i2d_SSL_SESSION(session, nullptr);
337 req->value.resize(sessionlen);
338 auto buf = &req->value[0];
339 i2d_SSL_SESSION(session, &buf);
341 req->cb = [](MemcachedRequest *req, MemcachedResult res) {
342 if (LOG_ENABLED(INFO)) {
343 LOG(INFO) << "Memcached: session cache done. key=" << req->key
344 << ", status_code=" << res.status_code << ", value="
345 << std::string(std::begin(res.value), std::end(res.value));
347 if (res.status_code != 0) {
348 LOG(WARN) << "Memcached: failed to cache session key=" << req->key
349 << ", status_code=" << res.status_code << ", value="
350 << std::string(std::begin(res.value), std::end(res.value));
353 assert(!req->canceled);
355 dispatcher->add_request(std::move(req));
362 SSL_SESSION *tls_session_get_cb(SSL *ssl,
364 const unsigned char *id,
365 #else // !OPENSSL_1_1_API
367 #endif // !OPENSSL_1_1_API
368 int idlen, int *copy) {
369 auto conn = static_cast<Connection *>(SSL_get_app_data(ssl));
370 auto handler = static_cast<ClientHandler *>(conn->data);
371 auto worker = handler->get_worker();
372 auto dispatcher = worker->get_session_cache_memcached_dispatcher();
373 auto &balloc = handler->get_block_allocator();
379 if (conn->tls.cached_session) {
380 if (LOG_ENABLED(INFO)) {
381 LOG(INFO) << "Memcached: found cached session, id="
382 << util::format_hex(id, idlen);
385 // This is required, without this, memory leak occurs.
388 auto session = conn->tls.cached_session;
389 conn->tls.cached_session = nullptr;
393 if (LOG_ENABLED(INFO)) {
394 LOG(INFO) << "Memcached: get cached session, id="
395 << util::format_hex(id, idlen);
398 auto req = make_unique<MemcachedRequest>();
399 req->op = MEMCACHED_OP_GET;
400 req->key = MEMCACHED_SESSION_CACHE_KEY_PREFIX.str();
402 util::format_hex(balloc, StringRef{id, static_cast<size_t>(idlen)});
403 req->cb = [conn](MemcachedRequest *, MemcachedResult res) {
404 if (LOG_ENABLED(INFO)) {
405 LOG(INFO) << "Memcached: returned status code " << res.status_code;
408 // We might stop reading, so start it again
409 conn->rlimit.startw();
410 ev_timer_again(conn->loop, &conn->rt);
412 conn->wlimit.startw();
413 ev_timer_again(conn->loop, &conn->wt);
415 conn->tls.cached_session_lookup_req = nullptr;
416 if (res.status_code != 0) {
417 conn->tls.handshake_state = TLS_CONN_CANCEL_SESSION_CACHE;
421 const uint8_t *p = res.value.data();
423 auto session = d2i_SSL_SESSION(nullptr, &p, res.value.size());
425 if (LOG_ENABLED(INFO)) {
426 LOG(INFO) << "cannot materialize session";
428 conn->tls.handshake_state = TLS_CONN_CANCEL_SESSION_CACHE;
432 conn->tls.cached_session = session;
433 conn->tls.handshake_state = TLS_CONN_GOT_SESSION_CACHE;
436 conn->tls.handshake_state = TLS_CONN_WAIT_FOR_SESSION_CACHE;
437 conn->tls.cached_session_lookup_req = req.get();
439 dispatcher->add_request(std::move(req));
446 int ticket_key_cb(SSL *ssl, unsigned char *key_name, unsigned char *iv,
447 EVP_CIPHER_CTX *ctx, HMAC_CTX *hctx, int enc) {
448 auto conn = static_cast<Connection *>(SSL_get_app_data(ssl));
449 auto handler = static_cast<ClientHandler *>(conn->data);
450 auto worker = handler->get_worker();
451 auto ticket_keys = worker->get_ticket_keys();
454 // No ticket keys available.
458 auto &keys = ticket_keys->keys;
459 assert(!keys.empty());
462 if (RAND_bytes(iv, EVP_MAX_IV_LENGTH) == 0) {
463 if (LOG_ENABLED(INFO)) {
464 CLOG(INFO, handler) << "session ticket key: RAND_bytes failed";
471 if (LOG_ENABLED(INFO)) {
472 CLOG(INFO, handler) << "encrypt session ticket key: "
473 << util::format_hex(key.data.name);
476 std::copy(std::begin(key.data.name), std::end(key.data.name), key_name);
478 EVP_EncryptInit_ex(ctx, get_config()->tls.ticket.cipher, nullptr,
479 key.data.enc_key.data(), iv);
480 HMAC_Init_ex(hctx, key.data.hmac_key.data(), key.hmac_keylen, key.hmac,
486 for (i = 0; i < keys.size(); ++i) {
488 if (std::equal(std::begin(key.data.name), std::end(key.data.name),
494 if (i == keys.size()) {
495 if (LOG_ENABLED(INFO)) {
496 CLOG(INFO, handler) << "session ticket key "
497 << util::format_hex(key_name, 16) << " not found";
502 if (LOG_ENABLED(INFO)) {
503 CLOG(INFO, handler) << "decrypt session ticket key: "
504 << util::format_hex(key_name, 16);
508 HMAC_Init_ex(hctx, key.data.hmac_key.data(), key.hmac_keylen, key.hmac,
510 EVP_DecryptInit_ex(ctx, key.cipher, nullptr, key.data.enc_key.data(), iv);
512 return i == 0 ? 1 : 2;
517 void info_callback(const SSL *ssl, int where, int ret) {
518 // To mitigate possible DOS attack using lots of renegotiations, we
519 // disable renegotiation. Since OpenSSL does not provide an easy way
520 // to disable it, we check that renegotiation is started in this
522 if (where & SSL_CB_HANDSHAKE_START) {
523 auto conn = static_cast<Connection *>(SSL_get_app_data(ssl));
524 if (conn && conn->tls.initial_handshake_done) {
525 auto handler = static_cast<ClientHandler *>(conn->data);
526 if (LOG_ENABLED(INFO)) {
527 CLOG(INFO, handler) << "TLS renegotiation started";
529 handler->start_immediate_shutdown();
535 #if OPENSSL_VERSION_NUMBER >= 0x10002000L
537 int alpn_select_proto_cb(SSL *ssl, const unsigned char **out,
538 unsigned char *outlen, const unsigned char *in,
539 unsigned int inlen, void *arg) {
540 // We assume that get_config()->npn_list contains ALPN protocol
541 // identifier sorted by preference order. So we just break when we
542 // found the first overlap.
543 for (const auto &target_proto_id : get_config()->tls.npn_list) {
544 for (auto p = in, end = in + inlen; p < end;) {
545 auto proto_id = p + 1;
548 if (proto_id + proto_len <= end &&
549 util::streq(target_proto_id, StringRef{proto_id, proto_len})) {
551 *out = reinterpret_cast<const unsigned char *>(proto_id);
554 return SSL_TLSEXT_ERR_OK;
561 return SSL_TLSEXT_ERR_NOACK;
564 #endif // OPENSSL_VERSION_NUMBER >= 0x10002000L
566 #if !LIBRESSL_IN_USE && OPENSSL_VERSION_NUMBER >= 0x10002000L
568 #ifndef TLSEXT_TYPE_signed_certificate_timestamp
569 #define TLSEXT_TYPE_signed_certificate_timestamp 18
570 #endif // !TLSEXT_TYPE_signed_certificate_timestamp
573 int sct_add_cb(SSL *ssl, unsigned int ext_type, unsigned int context,
574 const unsigned char **out, size_t *outlen, X509 *x,
575 size_t chainidx, int *al, void *add_arg) {
576 assert(ext_type == TLSEXT_TYPE_signed_certificate_timestamp);
578 auto conn = static_cast<Connection *>(SSL_get_app_data(ssl));
579 if (!conn->tls.sct_requested) {
583 if (LOG_ENABLED(INFO)) {
584 LOG(INFO) << "sct_add_cb is called, chainidx=" << chainidx << ", x=" << x
585 << ", context=" << std::hex << context;
588 // We only have SCTs for leaf certificate.
593 auto ssl_ctx = SSL_get_SSL_CTX(ssl);
595 static_cast<TLSContextData *>(SSL_CTX_get_app_data(ssl_ctx));
597 *out = tls_ctx_data->sct_data.data();
598 *outlen = tls_ctx_data->sct_data.size();
605 void sct_free_cb(SSL *ssl, unsigned int ext_type, unsigned int context,
606 const unsigned char *out, void *add_arg) {
607 assert(ext_type == TLSEXT_TYPE_signed_certificate_timestamp);
612 int sct_parse_cb(SSL *ssl, unsigned int ext_type, unsigned int context,
613 const unsigned char *in, size_t inlen, X509 *x,
614 size_t chainidx, int *al, void *parse_arg) {
615 assert(ext_type == TLSEXT_TYPE_signed_certificate_timestamp);
616 // client SHOULD send 0 length extension_data, but it is still
617 // SHOULD, and not MUST.
619 // For TLSv1.3 Certificate message, sct_add_cb is called even if
620 // client has not sent signed_certificate_timestamp extension in its
621 // ClientHello. Explicitly remember that client has included it
623 auto conn = static_cast<Connection *>(SSL_get_app_data(ssl));
624 conn->tls.sct_requested = true;
630 #if !OPENSSL_1_1_1_API
633 int legacy_sct_add_cb(SSL *ssl, unsigned int ext_type,
634 const unsigned char **out, size_t *outlen, int *al,
636 return sct_add_cb(ssl, ext_type, 0, out, outlen, nullptr, 0, al, add_arg);
641 void legacy_sct_free_cb(SSL *ssl, unsigned int ext_type,
642 const unsigned char *out, void *add_arg) {
643 sct_free_cb(ssl, ext_type, 0, out, add_arg);
648 int legacy_sct_parse_cb(SSL *ssl, unsigned int ext_type,
649 const unsigned char *in, size_t inlen, int *al,
651 return sct_parse_cb(ssl, ext_type, 0, in, inlen, nullptr, 0, al, parse_arg);
655 #endif // !OPENSSL_1_1_1_API
656 #endif // !LIBRESSL_IN_USE && OPENSSL_VERSION_NUMBER >= 0x10002000L
660 unsigned int psk_server_cb(SSL *ssl, const char *identity, unsigned char *psk,
661 unsigned int max_psk_len) {
662 auto config = get_config();
663 auto &tlsconf = config->tls;
665 auto it = tlsconf.psk_secrets.find(StringRef{identity});
666 if (it == std::end(tlsconf.psk_secrets)) {
670 auto &secret = (*it).second;
671 if (secret.size() > max_psk_len) {
672 LOG(ERROR) << "The size of PSK secret is " << secret.size()
673 << ", but the acceptable maximum size is" << max_psk_len;
677 std::copy(std::begin(secret), std::end(secret), psk);
679 return static_cast<unsigned int>(secret.size());
682 #endif // !LIBRESSL_IN_USE
686 unsigned int psk_client_cb(SSL *ssl, const char *hint, char *identity_out,
687 unsigned int max_identity_len, unsigned char *psk,
688 unsigned int max_psk_len) {
689 auto config = get_config();
690 auto &tlsconf = config->tls;
692 auto &identity = tlsconf.client.psk.identity;
693 auto &secret = tlsconf.client.psk.secret;
695 if (identity.empty()) {
699 if (identity.size() + 1 > max_identity_len) {
700 LOG(ERROR) << "The size of PSK identity is " << identity.size()
701 << ", but the acceptable maximum size is " << max_identity_len;
705 if (secret.size() > max_psk_len) {
706 LOG(ERROR) << "The size of PSK secret is " << secret.size()
707 << ", but the acceptable maximum size is " << max_psk_len;
711 *std::copy(std::begin(identity), std::end(identity), identity_out) = '\0';
712 std::copy(std::begin(secret), std::end(secret), psk);
714 return static_cast<unsigned int>(secret.size());
717 #endif // !LIBRESSL_IN_USE
724 constexpr TLSProtocol TLS_PROTOS[] = {
725 TLSProtocol{StringRef::from_lit("TLSv1.2"), SSL_OP_NO_TLSv1_2},
726 TLSProtocol{StringRef::from_lit("TLSv1.1"), SSL_OP_NO_TLSv1_1},
727 TLSProtocol{StringRef::from_lit("TLSv1.0"), SSL_OP_NO_TLSv1}};
729 long int create_tls_proto_mask(const std::vector<StringRef> &tls_proto_list) {
732 for (auto &supported : TLS_PROTOS) {
734 for (auto &name : tls_proto_list) {
735 if (util::strieq(supported.name, name)) {
741 res |= supported.mask;
747 SSL_CTX *create_ssl_context(const char *private_key_file, const char *cert_file,
748 const std::vector<uint8_t> &sct_data
749 #ifdef HAVE_NEVERBLEED
752 #endif // HAVE_NEVERBLEED
754 auto ssl_ctx = SSL_CTX_new(SSLv23_server_method());
756 LOG(FATAL) << ERR_error_string(ERR_get_error(), nullptr);
760 constexpr auto ssl_opts =
761 (SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS) | SSL_OP_NO_SSLv2 |
762 SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION |
763 SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION | SSL_OP_SINGLE_ECDH_USE |
764 SSL_OP_SINGLE_DH_USE | SSL_OP_CIPHER_SERVER_PREFERENCE;
766 auto config = mod_config();
767 auto &tlsconf = config->tls;
769 SSL_CTX_set_options(ssl_ctx, ssl_opts | tlsconf.tls_proto_mask);
771 if (nghttp2::tls::ssl_ctx_set_proto_versions(
772 ssl_ctx, tlsconf.min_proto_version, tlsconf.max_proto_version) != 0) {
773 LOG(FATAL) << "Could not set TLS protocol version";
777 const unsigned char sid_ctx[] = "shrpx";
778 SSL_CTX_set_session_id_context(ssl_ctx, sid_ctx, sizeof(sid_ctx) - 1);
779 SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_SERVER);
781 if (!tlsconf.session_cache.memcached.host.empty()) {
782 SSL_CTX_sess_set_new_cb(ssl_ctx, tls_session_new_cb);
783 SSL_CTX_sess_set_get_cb(ssl_ctx, tls_session_get_cb);
786 SSL_CTX_set_timeout(ssl_ctx, tlsconf.session_timeout.count());
788 if (SSL_CTX_set_cipher_list(ssl_ctx, tlsconf.ciphers.c_str()) == 0) {
789 LOG(FATAL) << "SSL_CTX_set_cipher_list " << tlsconf.ciphers
790 << " failed: " << ERR_error_string(ERR_get_error(), nullptr);
794 #ifndef OPENSSL_NO_EC
795 #if !LIBRESSL_IN_USE && OPENSSL_VERSION_NUMBER >= 0x10002000L
796 if (SSL_CTX_set1_curves_list(ssl_ctx, tlsconf.ecdh_curves.c_str()) != 1) {
797 LOG(FATAL) << "SSL_CTX_set1_curves_list " << tlsconf.ecdh_curves
801 #if !defined(OPENSSL_IS_BORINGSSL) && !OPENSSL_1_1_API
802 // It looks like we need this function call for OpenSSL 1.0.2. This
803 // function was deprecated in OpenSSL 1.1.0 and BoringSSL.
804 SSL_CTX_set_ecdh_auto(ssl_ctx, 1);
805 #endif // !defined(OPENSSL_IS_BORINGSSL) && !OPENSSL_1_1_API
806 #else // LIBRESSL_IN_USE || OPENSSL_VERSION_NUBMER < 0x10002000L
807 // Use P-256, which is sufficiently secure at the time of this
809 auto ecdh = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
810 if (ecdh == nullptr) {
811 LOG(FATAL) << "EC_KEY_new_by_curv_name failed: "
812 << ERR_error_string(ERR_get_error(), nullptr);
815 SSL_CTX_set_tmp_ecdh(ssl_ctx, ecdh);
817 #endif // LIBRESSL_IN_USE || OPENSSL_VERSION_NUBMER < 0x10002000L
818 #endif // OPENSSL_NO_EC
820 if (!tlsconf.dh_param_file.empty()) {
821 // Read DH parameters from file
822 auto bio = BIO_new_file(tlsconf.dh_param_file.c_str(), "r");
823 if (bio == nullptr) {
824 LOG(FATAL) << "BIO_new_file() failed: "
825 << ERR_error_string(ERR_get_error(), nullptr);
828 auto dh = PEM_read_bio_DHparams(bio, nullptr, nullptr, nullptr);
830 LOG(FATAL) << "PEM_read_bio_DHparams() failed: "
831 << ERR_error_string(ERR_get_error(), nullptr);
834 SSL_CTX_set_tmp_dh(ssl_ctx, dh);
839 SSL_CTX_set_mode(ssl_ctx, SSL_MODE_RELEASE_BUFFERS);
841 if (SSL_CTX_set_default_verify_paths(ssl_ctx) != 1) {
842 LOG(WARN) << "Could not load system trusted ca certificates: "
843 << ERR_error_string(ERR_get_error(), nullptr);
846 if (!tlsconf.cacert.empty()) {
847 if (SSL_CTX_load_verify_locations(ssl_ctx, tlsconf.cacert.c_str(),
849 LOG(FATAL) << "Could not load trusted ca certificates from "
850 << tlsconf.cacert << ": "
851 << ERR_error_string(ERR_get_error(), nullptr);
856 if (!tlsconf.private_key_passwd.empty()) {
857 SSL_CTX_set_default_passwd_cb(ssl_ctx, ssl_pem_passwd_cb);
858 SSL_CTX_set_default_passwd_cb_userdata(ssl_ctx, config);
861 #ifndef HAVE_NEVERBLEED
862 if (SSL_CTX_use_PrivateKey_file(ssl_ctx, private_key_file,
863 SSL_FILETYPE_PEM) != 1) {
864 LOG(FATAL) << "SSL_CTX_use_PrivateKey_file failed: "
865 << ERR_error_string(ERR_get_error(), nullptr);
867 #else // HAVE_NEVERBLEED
868 std::array<char, NEVERBLEED_ERRBUF_SIZE> errbuf;
869 if (neverbleed_load_private_key_file(nb, ssl_ctx, private_key_file,
870 errbuf.data()) != 1) {
871 LOG(FATAL) << "neverbleed_load_private_key_file failed: " << errbuf.data();
874 #endif // HAVE_NEVERBLEED
876 if (SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_file) != 1) {
877 LOG(FATAL) << "SSL_CTX_use_certificate_file failed: "
878 << ERR_error_string(ERR_get_error(), nullptr);
881 if (SSL_CTX_check_private_key(ssl_ctx) != 1) {
882 LOG(FATAL) << "SSL_CTX_check_private_key failed: "
883 << ERR_error_string(ERR_get_error(), nullptr);
886 if (tlsconf.client_verify.enabled) {
887 if (!tlsconf.client_verify.cacert.empty()) {
888 if (SSL_CTX_load_verify_locations(
889 ssl_ctx, tlsconf.client_verify.cacert.c_str(), nullptr) != 1) {
891 LOG(FATAL) << "Could not load trusted ca certificates from "
892 << tlsconf.client_verify.cacert << ": "
893 << ERR_error_string(ERR_get_error(), nullptr);
896 // It is heard that SSL_CTX_load_verify_locations() may leave
897 // error even though it returns success. See
898 // http://forum.nginx.org/read.php?29,242540
900 auto list = SSL_load_client_CA_file(tlsconf.client_verify.cacert.c_str());
902 LOG(FATAL) << "Could not load ca certificates from "
903 << tlsconf.client_verify.cacert << ": "
904 << ERR_error_string(ERR_get_error(), nullptr);
907 SSL_CTX_set_client_CA_list(ssl_ctx, list);
909 SSL_CTX_set_verify(ssl_ctx,
910 SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE |
911 SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
914 SSL_CTX_set_tlsext_servername_callback(ssl_ctx, servername_callback);
915 SSL_CTX_set_tlsext_ticket_key_cb(ssl_ctx, ticket_key_cb);
916 #ifndef OPENSSL_IS_BORINGSSL
917 SSL_CTX_set_tlsext_status_cb(ssl_ctx, ocsp_resp_cb);
918 #endif // OPENSSL_IS_BORINGSSL
919 SSL_CTX_set_info_callback(ssl_ctx, info_callback);
921 #ifdef OPENSSL_IS_BORINGSSL
922 SSL_CTX_set_early_data_enabled(ssl_ctx, 1);
923 #endif // OPENSSL_IS_BORINGSSL
926 SSL_CTX_set_next_protos_advertised_cb(ssl_ctx, next_proto_cb, nullptr);
927 #if OPENSSL_VERSION_NUMBER >= 0x10002000L
928 // ALPN selection callback
929 SSL_CTX_set_alpn_select_cb(ssl_ctx, alpn_select_proto_cb, nullptr);
930 #endif // OPENSSL_VERSION_NUMBER >= 0x10002000L
932 #if !LIBRESSL_IN_USE && OPENSSL_VERSION_NUMBER >= 0x10002000L
933 // SSL_extension_supported(TLSEXT_TYPE_signed_certificate_timestamp)
934 // returns 1, which means OpenSSL internally handles it. But
935 // OpenSSL handles signed_certificate_timestamp extension specially,
936 // and it lets custom handler to process the extension.
937 if (!sct_data.empty()) {
938 #if OPENSSL_1_1_1_API
939 // It is not entirely clear to me that SSL_EXT_CLIENT_HELLO is
940 // required here. sct_parse_cb is called without
941 // SSL_EXT_CLIENT_HELLO being set. But the passed context value
942 // is SSL_EXT_CLIENT_HELLO.
943 if (SSL_CTX_add_custom_ext(
944 ssl_ctx, TLSEXT_TYPE_signed_certificate_timestamp,
945 SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO |
946 SSL_EXT_TLS1_3_CERTIFICATE | SSL_EXT_IGNORE_ON_RESUMPTION,
947 sct_add_cb, sct_free_cb, nullptr, sct_parse_cb, nullptr) != 1) {
948 LOG(FATAL) << "SSL_CTX_add_custom_ext failed: "
949 << ERR_error_string(ERR_get_error(), nullptr);
952 #else // !OPENSSL_1_1_1_API
953 if (SSL_CTX_add_server_custom_ext(
954 ssl_ctx, TLSEXT_TYPE_signed_certificate_timestamp,
955 legacy_sct_add_cb, legacy_sct_free_cb, nullptr, legacy_sct_parse_cb,
957 LOG(FATAL) << "SSL_CTX_add_server_custom_ext failed: "
958 << ERR_error_string(ERR_get_error(), nullptr);
961 #endif // !OPENSSL_1_1_1_API
963 #endif // !LIBRESSL_IN_USE && OPENSSL_VERSION_NUMBER >= 0x10002000L
966 SSL_CTX_set_psk_server_callback(ssl_ctx, psk_server_cb);
967 #endif // !LIBRESSL_IN_USE
969 auto tls_ctx_data = new TLSContextData();
970 tls_ctx_data->cert_file = cert_file;
971 tls_ctx_data->sct_data = sct_data;
973 SSL_CTX_set_app_data(ssl_ctx, tls_ctx_data);
979 int select_h2_next_proto_cb(SSL *ssl, unsigned char **out,
980 unsigned char *outlen, const unsigned char *in,
981 unsigned int inlen, void *arg) {
982 if (!util::select_h2(const_cast<const unsigned char **>(out), outlen, in,
984 return SSL_TLSEXT_ERR_NOACK;
987 return SSL_TLSEXT_ERR_OK;
992 int select_h1_next_proto_cb(SSL *ssl, unsigned char **out,
993 unsigned char *outlen, const unsigned char *in,
994 unsigned int inlen, void *arg) {
995 auto end = in + inlen;
997 if (util::streq(NGHTTP2_H1_1_ALPN, StringRef{in, in + (in[0] + 1)})) {
998 *out = const_cast<unsigned char *>(in) + 1;
1000 return SSL_TLSEXT_ERR_OK;
1005 return SSL_TLSEXT_ERR_NOACK;
1010 int select_next_proto_cb(SSL *ssl, unsigned char **out, unsigned char *outlen,
1011 const unsigned char *in, unsigned int inlen,
1013 auto conn = static_cast<Connection *>(SSL_get_app_data(ssl));
1014 switch (conn->proto) {
1016 return select_h1_next_proto_cb(ssl, out, outlen, in, inlen, arg);
1018 return select_h2_next_proto_cb(ssl, out, outlen, in, inlen, arg);
1020 return SSL_TLSEXT_ERR_NOACK;
1025 SSL_CTX *create_ssl_client_context(
1026 #ifdef HAVE_NEVERBLEED
1028 #endif // HAVE_NEVERBLEED
1029 const StringRef &cacert, const StringRef &cert_file,
1030 const StringRef &private_key_file,
1031 int (*next_proto_select_cb)(SSL *s, unsigned char **out,
1032 unsigned char *outlen, const unsigned char *in,
1033 unsigned int inlen, void *arg)) {
1034 auto ssl_ctx = SSL_CTX_new(SSLv23_client_method());
1036 LOG(FATAL) << ERR_error_string(ERR_get_error(), nullptr);
1040 constexpr auto ssl_opts = (SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS) |
1041 SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 |
1042 SSL_OP_NO_COMPRESSION |
1043 SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION;
1045 auto &tlsconf = get_config()->tls;
1047 SSL_CTX_set_options(ssl_ctx, ssl_opts | tlsconf.tls_proto_mask);
1049 SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_CLIENT |
1050 SSL_SESS_CACHE_NO_INTERNAL_STORE);
1051 SSL_CTX_sess_set_new_cb(ssl_ctx, tls_session_client_new_cb);
1053 if (nghttp2::tls::ssl_ctx_set_proto_versions(
1054 ssl_ctx, tlsconf.min_proto_version, tlsconf.max_proto_version) != 0) {
1055 LOG(FATAL) << "Could not set TLS protocol version";
1059 if (SSL_CTX_set_cipher_list(ssl_ctx, tlsconf.client.ciphers.c_str()) == 0) {
1060 LOG(FATAL) << "SSL_CTX_set_cipher_list " << tlsconf.client.ciphers
1061 << " failed: " << ERR_error_string(ERR_get_error(), nullptr);
1065 SSL_CTX_set_mode(ssl_ctx, SSL_MODE_RELEASE_BUFFERS);
1067 if (SSL_CTX_set_default_verify_paths(ssl_ctx) != 1) {
1068 LOG(WARN) << "Could not load system trusted ca certificates: "
1069 << ERR_error_string(ERR_get_error(), nullptr);
1072 if (!cacert.empty()) {
1073 if (SSL_CTX_load_verify_locations(ssl_ctx, cacert.c_str(), nullptr) != 1) {
1075 LOG(FATAL) << "Could not load trusted ca certificates from " << cacert
1076 << ": " << ERR_error_string(ERR_get_error(), nullptr);
1081 if (!tlsconf.insecure) {
1082 SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
1085 if (!cert_file.empty()) {
1086 if (SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_file.c_str()) != 1) {
1088 LOG(FATAL) << "Could not load client certificate from " << cert_file
1089 << ": " << ERR_error_string(ERR_get_error(), nullptr);
1094 if (!private_key_file.empty()) {
1095 #ifndef HAVE_NEVERBLEED
1096 if (SSL_CTX_use_PrivateKey_file(ssl_ctx, private_key_file.c_str(),
1097 SSL_FILETYPE_PEM) != 1) {
1098 LOG(FATAL) << "Could not load client private key from "
1099 << private_key_file << ": "
1100 << ERR_error_string(ERR_get_error(), nullptr);
1103 #else // HAVE_NEVERBLEED
1104 std::array<char, NEVERBLEED_ERRBUF_SIZE> errbuf;
1105 if (neverbleed_load_private_key_file(nb, ssl_ctx, private_key_file.c_str(),
1106 errbuf.data()) != 1) {
1107 LOG(FATAL) << "neverbleed_load_private_key_file: could not load client "
1109 << private_key_file << ": " << errbuf.data();
1112 #endif // HAVE_NEVERBLEED
1115 #if !LIBRESSL_IN_USE
1116 SSL_CTX_set_psk_client_callback(ssl_ctx, psk_client_cb);
1117 #endif // !LIBRESSL_IN_USE
1119 // NPN selection callback. This is required to set SSL_CTX because
1120 // OpenSSL does not offer SSL_set_next_proto_select_cb.
1121 SSL_CTX_set_next_proto_select_cb(ssl_ctx, next_proto_select_cb, nullptr);
1126 SSL *create_ssl(SSL_CTX *ssl_ctx) {
1127 auto ssl = SSL_new(ssl_ctx);
1129 LOG(ERROR) << "SSL_new() failed: "
1130 << ERR_error_string(ERR_get_error(), nullptr);
1137 ClientHandler *accept_connection(Worker *worker, int fd, sockaddr *addr,
1138 int addrlen, const UpstreamAddr *faddr) {
1139 std::array<char, NI_MAXHOST> host;
1140 std::array<char, NI_MAXSERV> service;
1143 if (addr->sa_family == AF_UNIX) {
1144 std::copy_n("localhost", sizeof("localhost"), std::begin(host));
1147 rv = getnameinfo(addr, addrlen, host.data(), host.size(), service.data(),
1148 service.size(), NI_NUMERICHOST | NI_NUMERICSERV);
1150 LOG(ERROR) << "getnameinfo() failed: " << gai_strerror(rv);
1155 rv = util::make_socket_nodelay(fd);
1157 LOG(WARN) << "Setting option TCP_NODELAY failed: errno=" << errno;
1162 auto ssl_ctx = worker->get_sv_ssl_ctx();
1166 ssl = create_ssl(ssl_ctx);
1170 // Disable TLS session ticket if we don't have working ticket
1172 if (!worker->get_ticket_keys()) {
1173 SSL_set_options(ssl, SSL_OP_NO_TICKET);
1177 return new ClientHandler(worker, fd, ssl, StringRef{host.data()},
1178 StringRef{service.data()}, addr->sa_family, faddr);
1181 bool tls_hostname_match(const StringRef &pattern, const StringRef &hostname) {
1182 auto ptWildcard = std::find(std::begin(pattern), std::end(pattern), '*');
1183 if (ptWildcard == std::end(pattern)) {
1184 return util::strieq(pattern, hostname);
1187 auto ptLeftLabelEnd = std::find(std::begin(pattern), std::end(pattern), '.');
1188 auto wildcardEnabled = true;
1189 // Do case-insensitive match. At least 2 dots are required to enable
1190 // wildcard match. Also wildcard must be in the left-most label.
1191 // Don't attempt to match a presented identifier where the wildcard
1192 // character is embedded within an A-label.
1193 if (ptLeftLabelEnd == std::end(pattern) ||
1194 std::find(ptLeftLabelEnd + 1, std::end(pattern), '.') ==
1195 std::end(pattern) ||
1196 ptLeftLabelEnd < ptWildcard || util::istarts_with_l(pattern, "xn--")) {
1197 wildcardEnabled = false;
1200 if (!wildcardEnabled) {
1201 return util::strieq(pattern, hostname);
1204 auto hnLeftLabelEnd =
1205 std::find(std::begin(hostname), std::end(hostname), '.');
1206 if (hnLeftLabelEnd == std::end(hostname) ||
1207 !util::strieq(StringRef{ptLeftLabelEnd, std::end(pattern)},
1208 StringRef{hnLeftLabelEnd, std::end(hostname)})) {
1211 // Perform wildcard match. Here '*' must match at least one
1213 if (hnLeftLabelEnd - std::begin(hostname) <
1214 ptLeftLabelEnd - std::begin(pattern)) {
1217 return util::istarts_with(StringRef{std::begin(hostname), hnLeftLabelEnd},
1218 StringRef{std::begin(pattern), ptWildcard}) &&
1219 util::iends_with(StringRef{std::begin(hostname), hnLeftLabelEnd},
1220 StringRef{ptWildcard + 1, ptLeftLabelEnd});
1224 // if return value is not empty, StringRef.c_str() must be freed using
1226 StringRef get_common_name(X509 *cert) {
1227 auto subjectname = X509_get_subject_name(cert);
1229 LOG(WARN) << "Could not get X509 name object from the certificate.";
1234 lastpos = X509_NAME_get_index_by_NID(subjectname, NID_commonName, lastpos);
1235 if (lastpos == -1) {
1238 auto entry = X509_NAME_get_entry(subjectname, lastpos);
1241 auto plen = ASN1_STRING_to_UTF8(&p, X509_NAME_ENTRY_get_data(entry));
1245 if (std::find(p, p + plen, '\0') != p + plen) {
1246 // Embedded NULL is not permitted.
1250 LOG(WARN) << "X509 name is empty";
1255 return StringRef{p, static_cast<size_t>(plen)};
1262 int verify_numeric_hostname(X509 *cert, const StringRef &hostname,
1263 const Address *addr) {
1265 switch (addr->su.storage.ss_family) {
1267 saddr = &addr->su.in.sin_addr;
1270 saddr = &addr->su.in6.sin6_addr;
1276 auto altnames = static_cast<GENERAL_NAMES *>(
1277 X509_get_ext_d2i(cert, NID_subject_alt_name, nullptr, nullptr));
1279 auto altnames_deleter = defer(GENERAL_NAMES_free, altnames);
1280 size_t n = sk_GENERAL_NAME_num(altnames);
1281 auto ip_found = false;
1282 for (size_t i = 0; i < n; ++i) {
1283 auto altname = sk_GENERAL_NAME_value(altnames, i);
1284 if (altname->type != GEN_IPADD) {
1288 auto ip_addr = altname->d.iPAddress->data;
1292 size_t ip_addrlen = altname->d.iPAddress->length;
1295 if (addr->len == ip_addrlen && memcmp(saddr, ip_addr, ip_addrlen) == 0) {
1305 auto cn = get_common_name(cert);
1310 // cn is not NULL terminated
1311 auto rv = util::streq(hostname, cn);
1312 OPENSSL_free(const_cast<char *>(cn.c_str()));
1323 int verify_hostname(X509 *cert, const StringRef &hostname,
1324 const Address *addr) {
1325 if (util::numeric_host(hostname.c_str())) {
1326 return verify_numeric_hostname(cert, hostname, addr);
1329 auto altnames = static_cast<GENERAL_NAMES *>(
1330 X509_get_ext_d2i(cert, NID_subject_alt_name, nullptr, nullptr));
1332 auto dns_found = false;
1333 auto altnames_deleter = defer(GENERAL_NAMES_free, altnames);
1334 size_t n = sk_GENERAL_NAME_num(altnames);
1335 for (size_t i = 0; i < n; ++i) {
1336 auto altname = sk_GENERAL_NAME_value(altnames, i);
1337 if (altname->type != GEN_DNS) {
1341 auto name = ASN1_STRING_get0_data(altname->d.ia5);
1346 auto len = ASN1_STRING_length(altname->d.ia5);
1350 if (std::find(name, name + len, '\0') != name + len) {
1351 // Embedded NULL is not permitted.
1355 if (name[len - 1] == '.') {
1364 if (tls_hostname_match(StringRef{name, static_cast<size_t>(len)},
1370 // RFC 6125, section 6.4.4. says that client MUST not seek a match
1371 // for CN if a dns dNSName is found.
1377 auto cn = get_common_name(cert);
1382 if (cn[cn.size() - 1] == '.') {
1383 if (cn.size() == 1) {
1384 OPENSSL_free(const_cast<char *>(cn.c_str()));
1388 cn = StringRef{cn.c_str(), cn.size() - 1};
1391 auto rv = tls_hostname_match(cn, hostname);
1392 OPENSSL_free(const_cast<char *>(cn.c_str()));
1398 int check_cert(SSL *ssl, const Address *addr, const StringRef &host) {
1399 auto cert = SSL_get_peer_certificate(ssl);
1401 // By the protocol definition, TLS server always sends certificate
1402 // if it has. If certificate cannot be retrieved, authentication
1403 // without certificate is used, such as PSK.
1406 auto cert_deleter = defer(X509_free, cert);
1408 if (verify_hostname(cert, host, addr) != 0) {
1409 LOG(ERROR) << "Certificate verification failed: hostname does not match";
1415 int check_cert(SSL *ssl, const DownstreamAddr *addr, const Address *raddr) {
1417 addr->sni.empty() ? StringRef{addr->host} : StringRef{addr->sni};
1418 return check_cert(ssl, raddr, hostname);
1421 CertLookupTree::CertLookupTree() {}
1423 ssize_t CertLookupTree::add_cert(const StringRef &hostname, size_t idx) {
1424 std::array<uint8_t, NI_MAXHOST> buf;
1426 // NI_MAXHOST includes terminal NULL byte
1427 if (hostname.empty() || hostname.size() + 1 > buf.size()) {
1431 auto wildcard_it = std::find(std::begin(hostname), std::end(hostname), '*');
1432 if (wildcard_it != std::end(hostname) &&
1433 wildcard_it + 1 != std::end(hostname)) {
1434 auto wildcard_prefix = StringRef{std::begin(hostname), wildcard_it};
1435 auto wildcard_suffix = StringRef{wildcard_it + 1, std::end(hostname)};
1437 auto rev_suffix = StringRef{std::begin(buf),
1438 std::reverse_copy(std::begin(wildcard_suffix),
1439 std::end(wildcard_suffix),
1442 WildcardPattern *wpat;
1444 if (wildcard_patterns_.size() !=
1445 rev_wildcard_router_.add_route(rev_suffix, wildcard_patterns_.size())) {
1446 auto wcidx = rev_wildcard_router_.match(rev_suffix);
1448 assert(wcidx != -1);
1450 wpat = &wildcard_patterns_[wcidx];
1452 wildcard_patterns_.emplace_back();
1453 wpat = &wildcard_patterns_.back();
1456 auto rev_prefix = StringRef{std::begin(buf),
1457 std::reverse_copy(std::begin(wildcard_prefix),
1458 std::end(wildcard_prefix),
1461 for (auto &p : wpat->rev_prefix) {
1462 if (p.prefix == rev_prefix) {
1467 wpat->rev_prefix.emplace_back(rev_prefix, idx);
1472 return router_.add_route(hostname, idx);
1475 ssize_t CertLookupTree::lookup(const StringRef &hostname) {
1476 std::array<uint8_t, NI_MAXHOST> buf;
1478 // NI_MAXHOST includes terminal NULL byte
1479 if (hostname.empty() || hostname.size() + 1 > buf.size()) {
1483 // Always prefer exact match
1484 auto idx = router_.match(hostname);
1489 if (wildcard_patterns_.empty()) {
1493 ssize_t best_idx = -1;
1494 size_t best_prefixlen = 0;
1495 const RNode *last_node = nullptr;
1497 auto rev_host = StringRef{
1498 std::begin(buf), std::reverse_copy(std::begin(hostname),
1499 std::end(hostname), std::begin(buf))};
1505 rev_wildcard_router_.match_prefix(&nread, &last_node, rev_host);
1510 // '*' must match at least one byte
1511 if (nread == rev_host.size()) {
1515 rev_host = StringRef{std::begin(rev_host) + nread, std::end(rev_host)};
1517 auto rev_prefix = StringRef{std::begin(rev_host) + 1, std::end(rev_host)};
1519 auto &wpat = wildcard_patterns_[wcidx];
1520 for (auto &wprefix : wpat.rev_prefix) {
1521 if (!util::ends_with(rev_prefix, wprefix.prefix)) {
1526 wprefix.prefix.size() +
1527 (reinterpret_cast<const uint8_t *>(&rev_host[0]) - &buf[0]);
1529 // Breaking a tie with longer suffix
1530 if (prefixlen < best_prefixlen) {
1534 best_idx = wprefix.idx;
1535 best_prefixlen = prefixlen;
1540 void CertLookupTree::dump() const {
1541 std::cerr << "exact:" << std::endl;
1543 std::cerr << "wildcard suffix (reversed):" << std::endl;
1544 rev_wildcard_router_.dump();
1547 int cert_lookup_tree_add_ssl_ctx(
1548 CertLookupTree *lt, std::vector<std::vector<SSL_CTX *>> &indexed_ssl_ctx,
1550 std::array<uint8_t, NI_MAXHOST> buf;
1552 #if !defined(LIBRESSL_VERSION_NUMBER) && OPENSSL_VERSION_NUMBER >= 0x10002000L
1553 auto cert = SSL_CTX_get0_certificate(ssl_ctx);
1554 #else // defined(LIBRESSL_VERSION_NUMBER) || OPENSSL_VERSION_NUMBER <
1557 static_cast<TLSContextData *>(SSL_CTX_get_app_data(ssl_ctx));
1558 auto cert = load_certificate(tls_ctx_data->cert_file);
1559 auto cert_deleter = defer(X509_free, cert);
1560 #endif // defined(LIBRESSL_VERSION_NUMBER) || OPENSSL_VERSION_NUMBER <
1563 auto altnames = static_cast<GENERAL_NAMES *>(
1564 X509_get_ext_d2i(cert, NID_subject_alt_name, nullptr, nullptr));
1566 auto altnames_deleter = defer(GENERAL_NAMES_free, altnames);
1567 size_t n = sk_GENERAL_NAME_num(altnames);
1568 auto dns_found = false;
1569 for (size_t i = 0; i < n; ++i) {
1570 auto altname = sk_GENERAL_NAME_value(altnames, i);
1571 if (altname->type != GEN_DNS) {
1575 auto name = ASN1_STRING_get0_data(altname->d.ia5);
1580 auto len = ASN1_STRING_length(altname->d.ia5);
1584 if (std::find(name, name + len, '\0') != name + len) {
1585 // Embedded NULL is not permitted.
1589 if (name[len - 1] == '.') {
1598 if (static_cast<size_t>(len) + 1 > buf.size()) {
1602 auto end_buf = std::copy_n(name, len, std::begin(buf));
1603 util::inp_strlower(std::begin(buf), end_buf);
1605 auto idx = lt->add_cert(StringRef{std::begin(buf), end_buf},
1606 indexed_ssl_ctx.size());
1611 if (static_cast<size_t>(idx) < indexed_ssl_ctx.size()) {
1612 indexed_ssl_ctx[idx].push_back(ssl_ctx);
1614 assert(static_cast<size_t>(idx) == indexed_ssl_ctx.size());
1615 indexed_ssl_ctx.emplace_back(std::vector<SSL_CTX *>{ssl_ctx});
1619 // Don't bother CN if we have dNSName.
1625 auto cn = get_common_name(cert);
1630 if (cn[cn.size() - 1] == '.') {
1631 if (cn.size() == 1) {
1632 OPENSSL_free(const_cast<char *>(cn.c_str()));
1637 cn = StringRef{cn.c_str(), cn.size() - 1};
1640 auto end_buf = std::copy(std::begin(cn), std::end(cn), std::begin(buf));
1642 OPENSSL_free(const_cast<char *>(cn.c_str()));
1644 util::inp_strlower(std::begin(buf), end_buf);
1647 lt->add_cert(StringRef{std::begin(buf), end_buf}, indexed_ssl_ctx.size());
1652 if (static_cast<size_t>(idx) < indexed_ssl_ctx.size()) {
1653 indexed_ssl_ctx[idx].push_back(ssl_ctx);
1655 assert(static_cast<size_t>(idx) == indexed_ssl_ctx.size());
1656 indexed_ssl_ctx.emplace_back(std::vector<SSL_CTX *>{ssl_ctx});
1662 bool in_proto_list(const std::vector<StringRef> &protos,
1663 const StringRef &needle) {
1664 for (auto &proto : protos) {
1665 if (util::streq(proto, needle)) {
1672 bool upstream_tls_enabled(const ConnectionConfig &connconf) {
1673 const auto &faddrs = connconf.listener.addrs;
1674 return std::any_of(std::begin(faddrs), std::end(faddrs),
1675 [](const UpstreamAddr &faddr) { return faddr.tls; });
1678 X509 *load_certificate(const char *filename) {
1679 auto bio = BIO_new(BIO_s_file());
1681 fprintf(stderr, "BIO_new() failed\n");
1684 auto bio_deleter = defer(BIO_vfree, bio);
1685 if (!BIO_read_filename(bio, filename)) {
1686 fprintf(stderr, "Could not read certificate file '%s'\n", filename);
1689 auto cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr);
1691 fprintf(stderr, "Could not read X509 structure from file '%s'\n", filename);
1699 setup_server_ssl_context(std::vector<SSL_CTX *> &all_ssl_ctx,
1700 std::vector<std::vector<SSL_CTX *>> &indexed_ssl_ctx,
1701 CertLookupTree *cert_tree
1702 #ifdef HAVE_NEVERBLEED
1705 #endif // HAVE_NEVERBLEED
1707 auto config = get_config();
1709 if (!upstream_tls_enabled(config->conn)) {
1713 auto &tlsconf = config->tls;
1715 auto ssl_ctx = create_ssl_context(tlsconf.private_key_file.c_str(),
1716 tlsconf.cert_file.c_str(), tlsconf.sct_data
1717 #ifdef HAVE_NEVERBLEED
1720 #endif // HAVE_NEVERBLEED
1723 all_ssl_ctx.push_back(ssl_ctx);
1727 if (cert_lookup_tree_add_ssl_ctx(cert_tree, indexed_ssl_ctx, ssl_ctx) == -1) {
1728 LOG(FATAL) << "Failed to add default certificate.";
1732 for (auto &c : tlsconf.subcerts) {
1733 auto ssl_ctx = create_ssl_context(c.private_key_file.c_str(),
1734 c.cert_file.c_str(), c.sct_data
1735 #ifdef HAVE_NEVERBLEED
1738 #endif // HAVE_NEVERBLEED
1740 all_ssl_ctx.push_back(ssl_ctx);
1742 if (cert_lookup_tree_add_ssl_ctx(cert_tree, indexed_ssl_ctx, ssl_ctx) ==
1744 LOG(FATAL) << "Failed to add sub certificate.";
1752 SSL_CTX *setup_downstream_client_ssl_context(
1753 #ifdef HAVE_NEVERBLEED
1755 #endif // HAVE_NEVERBLEED
1757 auto &tlsconf = get_config()->tls;
1759 return create_ssl_client_context(
1760 #ifdef HAVE_NEVERBLEED
1762 #endif // HAVE_NEVERBLEED
1763 tlsconf.cacert, tlsconf.client.cert_file, tlsconf.client.private_key_file,
1764 select_next_proto_cb);
1767 void setup_downstream_http2_alpn(SSL *ssl) {
1768 #if OPENSSL_VERSION_NUMBER >= 0x10002000L
1769 // ALPN advertisement
1770 auto alpn = util::get_default_alpn();
1771 SSL_set_alpn_protos(ssl, alpn.data(), alpn.size());
1772 #endif // OPENSSL_VERSION_NUMBER >= 0x10002000L
1775 void setup_downstream_http1_alpn(SSL *ssl) {
1776 #if OPENSSL_VERSION_NUMBER >= 0x10002000L
1777 // ALPN advertisement
1778 SSL_set_alpn_protos(ssl, NGHTTP2_H1_1_ALPN.byte(), NGHTTP2_H1_1_ALPN.size());
1779 #endif // OPENSSL_VERSION_NUMBER >= 0x10002000L
1782 std::unique_ptr<CertLookupTree> create_cert_lookup_tree() {
1783 auto config = get_config();
1784 if (!upstream_tls_enabled(config->conn)) {
1787 return make_unique<CertLookupTree>();
1791 std::vector<uint8_t> serialize_ssl_session(SSL_SESSION *session) {
1792 auto len = i2d_SSL_SESSION(session, nullptr);
1793 auto buf = std::vector<uint8_t>(len);
1794 auto p = buf.data();
1795 i2d_SSL_SESSION(session, &p);
1801 void try_cache_tls_session(TLSSessionCache *cache, SSL_SESSION *session,
1803 if (cache->last_updated + 1_min > t) {
1804 if (LOG_ENABLED(INFO)) {
1805 LOG(INFO) << "Client session cache entry is still fresh.";
1810 if (LOG_ENABLED(INFO)) {
1811 LOG(INFO) << "Update client cache entry "
1812 << "timestamp = " << std::fixed << std::setprecision(6) << t;
1815 cache->session_data = serialize_ssl_session(session);
1816 cache->last_updated = t;
1819 SSL_SESSION *reuse_tls_session(const TLSSessionCache &cache) {
1820 if (cache.session_data.empty()) {
1824 auto p = cache.session_data.data();
1825 return d2i_SSL_SESSION(nullptr, &p, cache.session_data.size());
1828 int proto_version_from_string(const StringRef &v) {
1829 #ifdef TLS1_3_VERSION
1830 if (util::strieq_l("TLSv1.3", v)) {
1831 return TLS1_3_VERSION;
1833 #endif // TLS1_3_VERSION
1834 if (util::strieq_l("TLSv1.2", v)) {
1835 return TLS1_2_VERSION;
1837 if (util::strieq_l("TLSv1.1", v)) {
1838 return TLS1_1_VERSION;
1840 if (util::strieq_l("TLSv1.0", v)) {
1841 return TLS1_VERSION;
1846 int verify_ocsp_response(SSL_CTX *ssl_ctx, const uint8_t *ocsp_resp,
1847 size_t ocsp_resplen) {
1849 #if !defined(OPENSSL_NO_OCSP) && !defined(LIBRESSL_VERSION_NUMBER) && \
1850 OPENSSL_VERSION_NUMBER >= 0x10002000L
1853 STACK_OF(X509) * chain_certs;
1854 SSL_CTX_get0_chain_certs(ssl_ctx, &chain_certs);
1856 auto resp = d2i_OCSP_RESPONSE(nullptr, &ocsp_resp, ocsp_resplen);
1857 if (resp == nullptr) {
1858 LOG(ERROR) << "d2i_OCSP_RESPONSE failed";
1861 auto resp_deleter = defer(OCSP_RESPONSE_free, resp);
1865 auto bs = OCSP_response_get1_basic(resp);
1866 if (bs == nullptr) {
1867 LOG(ERROR) << "OCSP_response_get1_basic failed: "
1868 << ERR_error_string(ERR_get_error(), nullptr);
1871 auto bs_deleter = defer(OCSP_BASICRESP_free, bs);
1873 auto store = SSL_CTX_get_cert_store(ssl_ctx);
1877 rv = OCSP_basic_verify(bs, chain_certs, store, 0);
1880 LOG(ERROR) << "OCSP_basic_verify failed: "
1881 << ERR_error_string(ERR_get_error(), nullptr);
1885 auto sresp = OCSP_resp_get0(bs, 0);
1886 if (sresp == nullptr) {
1887 LOG(ERROR) << "OCSP response verification failed: no single response";
1892 auto certid = OCSP_SINGLERESP_get0_id(sresp);
1893 #else // !OPENSSL_1_1_API
1894 auto certid = sresp->certId;
1895 #endif // !OPENSSL_1_1_API
1896 assert(certid != nullptr);
1898 ASN1_INTEGER *serial;
1899 rv = OCSP_id_get0_info(nullptr, nullptr, nullptr, &serial,
1900 const_cast<OCSP_CERTID *>(certid));
1902 LOG(ERROR) << "OCSP_id_get0_info failed";
1906 if (serial == nullptr) {
1907 LOG(ERROR) << "OCSP response does not contain serial number";
1911 auto cert = SSL_CTX_get0_certificate(ssl_ctx);
1912 auto cert_serial = X509_get_serialNumber(cert);
1914 if (ASN1_INTEGER_cmp(cert_serial, serial)) {
1915 LOG(ERROR) << "OCSP verification serial numbers do not match";
1919 if (LOG_ENABLED(INFO)) {
1920 LOG(INFO) << "OCSP verification succeeded";
1922 #endif // !defined(OPENSSL_NO_OCSP) && !defined(LIBRESSL_VERSION_NUMBER)
1923 // && OPENSSL_VERSION_NUMBER >= 0x10002000L
1928 ssize_t get_x509_fingerprint(uint8_t *dst, size_t dstlen, const X509 *x,
1930 unsigned int len = dstlen;
1931 if (X509_digest(x, md, dst, &len) != 1) {
1938 StringRef get_x509_name(BlockAllocator &balloc, X509_NAME *nm) {
1939 auto b = BIO_new(BIO_s_mem());
1944 auto b_deleter = defer(BIO_free, b);
1946 // Not documented, but it seems that X509_NAME_print_ex returns the
1947 // number of bytes written into b.
1948 auto slen = X509_NAME_print_ex(b, nm, 0, XN_FLAG_RFC2253);
1953 auto iov = make_byte_ref(balloc, slen + 1);
1954 BIO_read(b, iov.base, slen);
1955 iov.base[slen] = '\0';
1956 return StringRef{iov.base, static_cast<size_t>(slen)};
1960 StringRef get_x509_subject_name(BlockAllocator &balloc, X509 *x) {
1961 return get_x509_name(balloc, X509_get_subject_name(x));
1964 StringRef get_x509_issuer_name(BlockAllocator &balloc, X509 *x) {
1965 return get_x509_name(balloc, X509_get_issuer_name(x));
1968 #ifdef WORDS_BIGENDIAN
1969 #define bswap64(N) (N)
1970 #else /* !WORDS_BIGENDIAN */
1971 #define bswap64(N) \
1972 ((uint64_t)(ntohl((uint32_t)(N))) << 32 | ntohl((uint32_t)((N) >> 32)))
1973 #endif /* !WORDS_BIGENDIAN */
1975 StringRef get_x509_serial(BlockAllocator &balloc, X509 *x) {
1977 auto sn = X509_get0_serialNumber(x);
1979 if (ASN1_INTEGER_get_uint64(&r, sn) != 1) {
1984 return util::format_hex(
1985 balloc, StringRef{reinterpret_cast<uint8_t *>(&r), sizeof(r)});
1986 #else // !OPENSSL_1_1_API
1987 auto sn = X509_get_serialNumber(x);
1989 auto bn_d = defer(BN_free, bn);
1990 if (!ASN1_INTEGER_to_BN(sn, bn)) {
1994 std::array<uint8_t, 8> b;
1995 auto n = BN_bn2bin(bn, b.data());
1996 assert(n == b.size());
1998 return util::format_hex(balloc, StringRef{std::begin(b), std::end(b)});
1999 #endif // !OPENSSL_1_1_API
2003 // Performs conversion from |at| to time_t. The result is stored in
2004 // |t|. This function returns 0 if it succeeds, or -1.
2005 int time_t_from_asn1_time(time_t &t, const ASN1_TIME *at) {
2008 #if OPENSSL_1_1_1_API
2010 rv = ASN1_TIME_to_tm(at, &tm);
2015 t = nghttp2_timegm(&tm);
2016 #else // !OPENSSL_1_1_1_API
2017 auto b = BIO_new(BIO_s_mem());
2022 auto bio_deleter = defer(BIO_free, b);
2024 rv = ASN1_TIME_print(b, at);
2030 auto slen = BIO_get_mem_data(b, &s);
2031 auto tt = util::parse_openssl_asn1_time_print(
2032 StringRef{s, static_cast<size_t>(slen)});
2038 #endif // !OPENSSL_1_1_1_API
2044 int get_x509_not_before(time_t &t, X509 *x) {
2046 auto at = X509_get0_notBefore(x);
2047 #else // !OPENSSL_1_1_API
2048 auto at = X509_get_notBefore(x);
2049 #endif // !OPENSSL_1_1_API
2054 return time_t_from_asn1_time(t, at);
2057 int get_x509_not_after(time_t &t, X509 *x) {
2059 auto at = X509_get0_notAfter(x);
2060 #else // !OPENSSL_1_1_API
2061 auto at = X509_get_notAfter(x);
2062 #endif // !OPENSSL_1_1_API
2067 return time_t_from_asn1_time(t, at);
2072 } // namespace shrpx