2 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4 * Copyright 2005 Nokia. All rights reserved.
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
13 #include "ssl_local.h"
14 #include "internal/e_os.h"
15 #include <openssl/objects.h>
16 #include <openssl/x509v3.h>
17 #include <openssl/rand.h>
18 #include <openssl/ocsp.h>
19 #include <openssl/dh.h>
20 #include <openssl/engine.h>
21 #include <openssl/async.h>
22 #include <openssl/ct.h>
23 #include <openssl/trace.h>
24 #include <openssl/core_names.h>
25 #include "internal/cryptlib.h"
26 #include "internal/nelem.h"
27 #include "internal/refcount.h"
28 #include "internal/ktls.h"
29 #include "quic/quic_local.h"
31 static int ssl_undefined_function_3(SSL_CONNECTION *sc, unsigned char *r,
32 unsigned char *s, size_t t, size_t *u)
34 return ssl_undefined_function(SSL_CONNECTION_GET_SSL(sc));
37 static int ssl_undefined_function_4(SSL_CONNECTION *sc, int r)
39 return ssl_undefined_function(SSL_CONNECTION_GET_SSL(sc));
42 static size_t ssl_undefined_function_5(SSL_CONNECTION *sc, const char *r,
43 size_t s, unsigned char *t)
45 return ssl_undefined_function(SSL_CONNECTION_GET_SSL(sc));
48 static int ssl_undefined_function_6(int r)
50 return ssl_undefined_function(NULL);
53 static int ssl_undefined_function_7(SSL_CONNECTION *sc, unsigned char *r,
54 size_t s, const char *t, size_t u,
55 const unsigned char *v, size_t w, int x)
57 return ssl_undefined_function(SSL_CONNECTION_GET_SSL(sc));
60 static int ssl_undefined_function_8(SSL_CONNECTION *sc)
62 return ssl_undefined_function(SSL_CONNECTION_GET_SSL(sc));
65 SSL3_ENC_METHOD ssl3_undef_enc_method = {
66 ssl_undefined_function_8,
67 ssl_undefined_function_3,
68 ssl_undefined_function_4,
69 ssl_undefined_function_5,
70 NULL, /* client_finished_label */
71 0, /* client_finished_label_len */
72 NULL, /* server_finished_label */
73 0, /* server_finished_label_len */
74 ssl_undefined_function_6,
75 ssl_undefined_function_7,
78 struct ssl_async_args {
82 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
84 int (*func_read) (SSL *, void *, size_t, size_t *);
85 int (*func_write) (SSL *, const void *, size_t, size_t *);
86 int (*func_other) (SSL *);
96 DANETLS_MATCHING_FULL, 0, NID_undef
99 DANETLS_MATCHING_2256, 1, NID_sha256
102 DANETLS_MATCHING_2512, 2, NID_sha512
106 static int dane_ctx_enable(struct dane_ctx_st *dctx)
108 const EVP_MD **mdevp;
110 uint8_t mdmax = DANETLS_MATCHING_LAST;
111 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
114 if (dctx->mdevp != NULL)
117 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
118 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
120 if (mdord == NULL || mdevp == NULL) {
126 /* Install default entries */
127 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
130 if (dane_mds[i].nid == NID_undef ||
131 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
133 mdevp[dane_mds[i].mtype] = md;
134 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
144 static void dane_ctx_final(struct dane_ctx_st *dctx)
146 OPENSSL_free(dctx->mdevp);
149 OPENSSL_free(dctx->mdord);
154 static void tlsa_free(danetls_record *t)
158 OPENSSL_free(t->data);
159 EVP_PKEY_free(t->spki);
163 static void dane_final(SSL_DANE *dane)
165 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
168 OSSL_STACK_OF_X509_free(dane->certs);
171 X509_free(dane->mcert);
179 * dane_copy - Copy dane configuration, sans verification state.
181 static int ssl_dane_dup(SSL_CONNECTION *to, SSL_CONNECTION *from)
186 if (!DANETLS_ENABLED(&from->dane))
189 num = sk_danetls_record_num(from->dane.trecs);
190 dane_final(&to->dane);
191 to->dane.flags = from->dane.flags;
192 to->dane.dctx = &SSL_CONNECTION_GET_CTX(to)->dane;
193 to->dane.trecs = sk_danetls_record_new_reserve(NULL, num);
195 if (to->dane.trecs == NULL) {
196 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
200 for (i = 0; i < num; ++i) {
201 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
203 if (SSL_dane_tlsa_add(SSL_CONNECTION_GET_SSL(to), t->usage,
204 t->selector, t->mtype, t->data, t->dlen) <= 0)
210 static int dane_mtype_set(struct dane_ctx_st *dctx,
211 const EVP_MD *md, uint8_t mtype, uint8_t ord)
215 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
216 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
220 if (mtype > dctx->mdmax) {
221 const EVP_MD **mdevp;
223 int n = ((int)mtype) + 1;
225 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
230 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
235 /* Zero-fill any gaps */
236 for (i = dctx->mdmax + 1; i < mtype; ++i) {
244 dctx->mdevp[mtype] = md;
245 /* Coerce ordinal of disabled matching types to 0 */
246 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
251 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
253 if (mtype > dane->dctx->mdmax)
255 return dane->dctx->mdevp[mtype];
258 static int dane_tlsa_add(SSL_DANE *dane,
261 uint8_t mtype, const unsigned char *data, size_t dlen)
264 const EVP_MD *md = NULL;
265 int ilen = (int)dlen;
269 if (dane->trecs == NULL) {
270 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_NOT_ENABLED);
274 if (ilen < 0 || dlen != (size_t)ilen) {
275 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
279 if (usage > DANETLS_USAGE_LAST) {
280 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
284 if (selector > DANETLS_SELECTOR_LAST) {
285 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_TLSA_BAD_SELECTOR);
289 if (mtype != DANETLS_MATCHING_FULL) {
290 md = tlsa_md_get(dane, mtype);
292 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
297 if (md != NULL && dlen != (size_t)EVP_MD_get_size(md)) {
298 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
302 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_TLSA_NULL_DATA);
306 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL)
310 t->selector = selector;
312 t->data = OPENSSL_malloc(dlen);
313 if (t->data == NULL) {
317 memcpy(t->data, data, dlen);
320 /* Validate and cache full certificate or public key */
321 if (mtype == DANETLS_MATCHING_FULL) {
322 const unsigned char *p = data;
324 EVP_PKEY *pkey = NULL;
327 case DANETLS_SELECTOR_CERT:
328 if (!d2i_X509(&cert, &p, ilen) || p < data ||
329 dlen != (size_t)(p - data)) {
331 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
334 if (X509_get0_pubkey(cert) == NULL) {
336 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
340 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
346 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
347 * records that contain full certificates of trust-anchors that are
348 * not present in the wire chain. For usage PKIX-TA(0), we augment
349 * the chain with untrusted Full(0) certificates from DNS, in case
350 * they are missing from the chain.
352 if ((dane->certs == NULL &&
353 (dane->certs = sk_X509_new_null()) == NULL) ||
354 !sk_X509_push(dane->certs, cert)) {
355 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
362 case DANETLS_SELECTOR_SPKI:
363 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
364 dlen != (size_t)(p - data)) {
366 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
371 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
372 * records that contain full bare keys of trust-anchors that are
373 * not present in the wire chain.
375 if (usage == DANETLS_USAGE_DANE_TA)
384 * Find the right insertion point for the new record.
386 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
387 * they can be processed first, as they require no chain building, and no
388 * expiration or hostname checks. Because DANE-EE(3) is numerically
389 * largest, this is accomplished via descending sort by "usage".
391 * We also sort in descending order by matching ordinal to simplify
392 * the implementation of digest agility in the verification code.
394 * The choice of order for the selector is not significant, so we
395 * use the same descending order for consistency.
397 num = sk_danetls_record_num(dane->trecs);
398 for (i = 0; i < num; ++i) {
399 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
401 if (rec->usage > usage)
403 if (rec->usage < usage)
405 if (rec->selector > selector)
407 if (rec->selector < selector)
409 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
414 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
416 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
419 dane->umask |= DANETLS_USAGE_BIT(usage);
425 * Return 0 if there is only one version configured and it was disabled
426 * at configure time. Return 1 otherwise.
428 static int ssl_check_allowed_versions(int min_version, int max_version)
430 int minisdtls = 0, maxisdtls = 0;
432 /* Figure out if we're doing DTLS versions or TLS versions */
433 if (min_version == DTLS1_BAD_VER
434 || min_version >> 8 == DTLS1_VERSION_MAJOR)
436 if (max_version == DTLS1_BAD_VER
437 || max_version >> 8 == DTLS1_VERSION_MAJOR)
439 /* A wildcard version of 0 could be DTLS or TLS. */
440 if ((minisdtls && !maxisdtls && max_version != 0)
441 || (maxisdtls && !minisdtls && min_version != 0)) {
442 /* Mixing DTLS and TLS versions will lead to sadness; deny it. */
446 if (minisdtls || maxisdtls) {
447 /* Do DTLS version checks. */
448 if (min_version == 0)
449 /* Ignore DTLS1_BAD_VER */
450 min_version = DTLS1_VERSION;
451 if (max_version == 0)
452 max_version = DTLS1_2_VERSION;
453 #ifdef OPENSSL_NO_DTLS1_2
454 if (max_version == DTLS1_2_VERSION)
455 max_version = DTLS1_VERSION;
457 #ifdef OPENSSL_NO_DTLS1
458 if (min_version == DTLS1_VERSION)
459 min_version = DTLS1_2_VERSION;
461 /* Done massaging versions; do the check. */
463 #ifdef OPENSSL_NO_DTLS1
464 || (DTLS_VERSION_GE(min_version, DTLS1_VERSION)
465 && DTLS_VERSION_GE(DTLS1_VERSION, max_version))
467 #ifdef OPENSSL_NO_DTLS1_2
468 || (DTLS_VERSION_GE(min_version, DTLS1_2_VERSION)
469 && DTLS_VERSION_GE(DTLS1_2_VERSION, max_version))
474 /* Regular TLS version checks. */
475 if (min_version == 0)
476 min_version = SSL3_VERSION;
477 if (max_version == 0)
478 max_version = TLS1_3_VERSION;
479 #ifdef OPENSSL_NO_TLS1_3
480 if (max_version == TLS1_3_VERSION)
481 max_version = TLS1_2_VERSION;
483 #ifdef OPENSSL_NO_TLS1_2
484 if (max_version == TLS1_2_VERSION)
485 max_version = TLS1_1_VERSION;
487 #ifdef OPENSSL_NO_TLS1_1
488 if (max_version == TLS1_1_VERSION)
489 max_version = TLS1_VERSION;
491 #ifdef OPENSSL_NO_TLS1
492 if (max_version == TLS1_VERSION)
493 max_version = SSL3_VERSION;
495 #ifdef OPENSSL_NO_SSL3
496 if (min_version == SSL3_VERSION)
497 min_version = TLS1_VERSION;
499 #ifdef OPENSSL_NO_TLS1
500 if (min_version == TLS1_VERSION)
501 min_version = TLS1_1_VERSION;
503 #ifdef OPENSSL_NO_TLS1_1
504 if (min_version == TLS1_1_VERSION)
505 min_version = TLS1_2_VERSION;
507 #ifdef OPENSSL_NO_TLS1_2
508 if (min_version == TLS1_2_VERSION)
509 min_version = TLS1_3_VERSION;
511 /* Done massaging versions; do the check. */
513 #ifdef OPENSSL_NO_SSL3
514 || (min_version <= SSL3_VERSION && SSL3_VERSION <= max_version)
516 #ifdef OPENSSL_NO_TLS1
517 || (min_version <= TLS1_VERSION && TLS1_VERSION <= max_version)
519 #ifdef OPENSSL_NO_TLS1_1
520 || (min_version <= TLS1_1_VERSION && TLS1_1_VERSION <= max_version)
522 #ifdef OPENSSL_NO_TLS1_2
523 || (min_version <= TLS1_2_VERSION && TLS1_2_VERSION <= max_version)
525 #ifdef OPENSSL_NO_TLS1_3
526 || (min_version <= TLS1_3_VERSION && TLS1_3_VERSION <= max_version)
534 #if defined(__TANDEM) && defined(OPENSSL_VPROC)
536 * Define a VPROC function for HP NonStop build ssl library.
537 * This is used by platform version identification tools.
538 * Do not inline this procedure or make it static.
540 # define OPENSSL_VPROC_STRING_(x) x##_SSL
541 # define OPENSSL_VPROC_STRING(x) OPENSSL_VPROC_STRING_(x)
542 # define OPENSSL_VPROC_FUNC OPENSSL_VPROC_STRING(OPENSSL_VPROC)
543 void OPENSSL_VPROC_FUNC(void) {}
546 static int clear_record_layer(SSL_CONNECTION *s)
550 /* We try and reset both record layers even if one fails */
552 ret = ssl_set_new_record_layer(s,
553 SSL_CONNECTION_IS_DTLS(s) ? DTLS_ANY_VERSION
555 OSSL_RECORD_DIRECTION_READ,
556 OSSL_RECORD_PROTECTION_LEVEL_NONE, NULL, 0,
557 NULL, 0, NULL, 0, NULL, 0, NULL, 0,
558 NID_undef, NULL, NULL, NULL);
560 ret &= ssl_set_new_record_layer(s,
561 SSL_CONNECTION_IS_DTLS(s) ? DTLS_ANY_VERSION
563 OSSL_RECORD_DIRECTION_WRITE,
564 OSSL_RECORD_PROTECTION_LEVEL_NONE, NULL, 0,
565 NULL, 0, NULL, 0, NULL, 0, NULL, 0,
566 NID_undef, NULL, NULL, NULL);
568 /* SSLfatal already called in the event of failure */
572 int SSL_clear(SSL *s)
574 if (s->method == NULL) {
575 ERR_raise(ERR_LIB_SSL, SSL_R_NO_METHOD_SPECIFIED);
579 return s->method->ssl_reset(s);
582 int ossl_ssl_connection_reset(SSL *s)
584 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
589 if (ssl_clear_bad_session(sc)) {
590 SSL_SESSION_free(sc->session);
593 SSL_SESSION_free(sc->psksession);
594 sc->psksession = NULL;
595 OPENSSL_free(sc->psksession_id);
596 sc->psksession_id = NULL;
597 sc->psksession_id_len = 0;
598 sc->hello_retry_request = 0;
599 sc->sent_tickets = 0;
605 if (sc->renegotiate) {
606 ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
610 ossl_statem_clear(sc);
612 /* TODO(QUIC): Version handling not yet clear */
613 sc->version = s->method->version;
614 sc->client_version = sc->version;
615 sc->rwstate = SSL_NOTHING;
617 BUF_MEM_free(sc->init_buf);
619 sc->first_packet = 0;
621 sc->key_update = SSL_KEY_UPDATE_NONE;
622 memset(sc->ext.compress_certificate_from_peer, 0,
623 sizeof(sc->ext.compress_certificate_from_peer));
624 sc->ext.compress_certificate_sent = 0;
626 EVP_MD_CTX_free(sc->pha_dgst);
629 /* Reset DANE verification result state */
632 X509_free(sc->dane.mcert);
633 sc->dane.mcert = NULL;
634 sc->dane.mtlsa = NULL;
636 /* Clear the verification result peername */
637 X509_VERIFY_PARAM_move_peername(sc->param, NULL);
639 /* Clear any shared connection state */
640 OPENSSL_free(sc->shared_sigalgs);
641 sc->shared_sigalgs = NULL;
642 sc->shared_sigalgslen = 0;
645 * Check to see if we were changed into a different method, if so, revert
648 if (s->method != s->defltmeth) {
649 s->method->ssl_deinit(s);
650 s->method = s->defltmeth;
651 if (!s->method->ssl_init(s))
654 if (!s->method->ssl_clear(s))
658 RECORD_LAYER_clear(&sc->rlayer);
659 BIO_free(sc->rlayer.rrlnext);
660 sc->rlayer.rrlnext = NULL;
662 if (!clear_record_layer(sc))
668 #ifndef OPENSSL_NO_DEPRECATED_3_0
669 /** Used to change an SSL_CTXs default SSL method type */
670 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
672 STACK_OF(SSL_CIPHER) *sk;
676 if (!SSL_CTX_set_ciphersuites(ctx, OSSL_default_ciphersuites())) {
677 ERR_raise(ERR_LIB_SSL, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
680 sk = ssl_create_cipher_list(ctx,
681 ctx->tls13_ciphersuites,
683 &(ctx->cipher_list_by_id),
684 OSSL_default_cipher_list(), ctx->cert);
685 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
686 ERR_raise(ERR_LIB_SSL, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
693 SSL *SSL_new(SSL_CTX *ctx)
696 ERR_raise(ERR_LIB_SSL, SSL_R_NULL_SSL_CTX);
699 if (ctx->method == NULL) {
700 ERR_raise(ERR_LIB_SSL, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
703 return ctx->method->ssl_new(ctx);
706 int ossl_ssl_init(SSL *ssl, SSL_CTX *ctx, const SSL_METHOD *method, int type)
711 ssl->lock = CRYPTO_THREAD_lock_new();
712 if (ssl->lock == NULL)
715 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, ssl, &ssl->ex_data)) {
716 CRYPTO_THREAD_lock_free(ssl->lock);
724 ssl->defltmeth = ssl->method = method;
729 SSL *ossl_ssl_connection_new_int(SSL_CTX *ctx, const SSL_METHOD *method)
734 s = OPENSSL_zalloc(sizeof(*s));
739 if (!ossl_ssl_init(ssl, ctx, method, SSL_TYPE_SSL_CONNECTION)) {
746 RECORD_LAYER_init(&s->rlayer, s);
748 s->options = ctx->options;
749 s->dane.flags = ctx->dane.flags;
750 if (method->version == ctx->method->version) {
751 s->min_proto_version = ctx->min_proto_version;
752 s->max_proto_version = ctx->max_proto_version;
755 s->max_cert_list = ctx->max_cert_list;
756 s->max_early_data = ctx->max_early_data;
757 s->recv_max_early_data = ctx->recv_max_early_data;
758 s->num_tickets = ctx->num_tickets;
759 s->pha_enabled = ctx->pha_enabled;
761 /* Shallow copy of the ciphersuites stack */
762 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
763 if (s->tls13_ciphersuites == NULL)
767 * Earlier library versions used to copy the pointer to the CERT, not
768 * its contents; only when setting new parameters for the per-SSL
769 * copy, ssl_cert_new would be called (and the direct reference to
770 * the per-SSL_CTX settings would be lost, but those still were
771 * indirectly accessed for various purposes, and for that reason they
772 * used to be known as s->ctx->default_cert). Now we don't look at the
773 * SSL_CTX's CERT after having duplicated it once.
775 s->cert = ssl_cert_dup(ctx->cert);
779 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
780 s->msg_callback = ctx->msg_callback;
781 s->msg_callback_arg = ctx->msg_callback_arg;
782 s->verify_mode = ctx->verify_mode;
783 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
784 s->rlayer.record_padding_cb = ctx->record_padding_cb;
785 s->rlayer.record_padding_arg = ctx->record_padding_arg;
786 s->rlayer.block_padding = ctx->block_padding;
787 s->sid_ctx_length = ctx->sid_ctx_length;
788 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
790 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
791 s->verify_callback = ctx->default_verify_callback;
792 s->generate_session_id = ctx->generate_session_id;
794 s->param = X509_VERIFY_PARAM_new();
795 if (s->param == NULL)
797 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
798 s->quiet_shutdown = ctx->quiet_shutdown;
800 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
801 s->max_send_fragment = ctx->max_send_fragment;
802 s->split_send_fragment = ctx->split_send_fragment;
803 s->max_pipelines = ctx->max_pipelines;
804 s->rlayer.default_read_buf_len = ctx->default_read_buf_len;
807 s->ext.debug_arg = NULL;
808 s->ext.ticket_expected = 0;
809 s->ext.status_type = ctx->ext.status_type;
810 s->ext.status_expected = 0;
811 s->ext.ocsp.ids = NULL;
812 s->ext.ocsp.exts = NULL;
813 s->ext.ocsp.resp = NULL;
814 s->ext.ocsp.resp_len = 0;
816 s->session_ctx = ctx;
817 if (ctx->ext.ecpointformats) {
818 s->ext.ecpointformats =
819 OPENSSL_memdup(ctx->ext.ecpointformats,
820 ctx->ext.ecpointformats_len);
821 if (!s->ext.ecpointformats) {
822 s->ext.ecpointformats_len = 0;
825 s->ext.ecpointformats_len =
826 ctx->ext.ecpointformats_len;
828 if (ctx->ext.supportedgroups) {
829 s->ext.supportedgroups =
830 OPENSSL_memdup(ctx->ext.supportedgroups,
831 ctx->ext.supportedgroups_len
832 * sizeof(*ctx->ext.supportedgroups));
833 if (!s->ext.supportedgroups) {
834 s->ext.supportedgroups_len = 0;
837 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
840 #ifndef OPENSSL_NO_NEXTPROTONEG
844 if (ctx->ext.alpn != NULL) {
845 s->ext.alpn = OPENSSL_malloc(ctx->ext.alpn_len);
846 if (s->ext.alpn == NULL) {
850 memcpy(s->ext.alpn, ctx->ext.alpn, ctx->ext.alpn_len);
851 s->ext.alpn_len = ctx->ext.alpn_len;
854 s->verified_chain = NULL;
855 s->verify_result = X509_V_OK;
857 s->default_passwd_callback = ctx->default_passwd_callback;
858 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
860 s->key_update = SSL_KEY_UPDATE_NONE;
862 s->allow_early_data_cb = ctx->allow_early_data_cb;
863 s->allow_early_data_cb_data = ctx->allow_early_data_cb_data;
865 if (!method->ssl_init(ssl))
868 s->server = (method->ssl_accept == ssl_undefined_function) ? 0 : 1;
870 if (!method->ssl_reset(ssl))
873 #ifndef OPENSSL_NO_PSK
874 s->psk_client_callback = ctx->psk_client_callback;
875 s->psk_server_callback = ctx->psk_server_callback;
877 s->psk_find_session_cb = ctx->psk_find_session_cb;
878 s->psk_use_session_cb = ctx->psk_use_session_cb;
880 s->async_cb = ctx->async_cb;
881 s->async_cb_arg = ctx->async_cb_arg;
885 #ifndef OPENSSL_NO_COMP_ALG
886 memcpy(s->cert_comp_prefs, ctx->cert_comp_prefs, sizeof(s->cert_comp_prefs));
888 if (ctx->client_cert_type != NULL) {
889 s->client_cert_type = OPENSSL_memdup(ctx->client_cert_type,
890 ctx->client_cert_type_len);
891 if (s->client_cert_type == NULL)
893 s->client_cert_type_len = ctx->client_cert_type_len;
895 if (ctx->server_cert_type != NULL) {
896 s->server_cert_type = OPENSSL_memdup(ctx->server_cert_type,
897 ctx->server_cert_type_len);
898 if (s->server_cert_type == NULL)
900 s->server_cert_type_len = ctx->server_cert_type_len;
903 #ifndef OPENSSL_NO_CT
904 if (!SSL_set_ct_validation_callback(ssl, ctx->ct_validation_callback,
905 ctx->ct_validation_callback_arg))
909 s->ssl_pkey_num = SSL_PKEY_NUM + ctx->sigalg_list_len;
912 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
915 ERR_raise(ERR_LIB_SSL, ERR_R_ASN1_LIB);
918 ERR_raise(ERR_LIB_SSL, ERR_R_SSL_LIB);
924 SSL *ossl_ssl_connection_new(SSL_CTX *ctx)
926 return ossl_ssl_connection_new_int(ctx, ctx->method);
929 int SSL_is_dtls(const SSL *s)
931 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
933 #ifndef OPENSSL_NO_QUIC
934 if (s->type == SSL_TYPE_QUIC_CONNECTION || s->type == SSL_TYPE_QUIC_XSO)
941 return SSL_CONNECTION_IS_DTLS(sc) ? 1 : 0;
944 int SSL_is_tls(const SSL *s)
946 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
948 #ifndef OPENSSL_NO_QUIC
949 if (s->type == SSL_TYPE_QUIC_CONNECTION || s->type == SSL_TYPE_QUIC_XSO)
956 return SSL_CONNECTION_IS_DTLS(sc) ? 0 : 1;
959 int SSL_is_quic(const SSL *s)
961 #ifndef OPENSSL_NO_QUIC
962 if (s->type == SSL_TYPE_QUIC_CONNECTION || s->type == SSL_TYPE_QUIC_XSO)
968 int SSL_up_ref(SSL *s)
972 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
975 REF_PRINT_COUNT("SSL", s);
976 REF_ASSERT_ISNT(i < 2);
977 return ((i > 1) ? 1 : 0);
980 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
981 unsigned int sid_ctx_len)
983 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
984 ERR_raise(ERR_LIB_SSL, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
987 ctx->sid_ctx_length = sid_ctx_len;
988 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
993 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
994 unsigned int sid_ctx_len)
996 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
1001 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
1002 ERR_raise(ERR_LIB_SSL, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
1005 sc->sid_ctx_length = sid_ctx_len;
1006 memcpy(sc->sid_ctx, sid_ctx, sid_ctx_len);
1011 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
1013 if (!CRYPTO_THREAD_write_lock(ctx->lock))
1015 ctx->generate_session_id = cb;
1016 CRYPTO_THREAD_unlock(ctx->lock);
1020 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
1022 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
1024 if (sc == NULL || !CRYPTO_THREAD_write_lock(ssl->lock))
1026 sc->generate_session_id = cb;
1027 CRYPTO_THREAD_unlock(ssl->lock);
1031 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
1032 unsigned int id_len)
1035 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
1036 * we can "construct" a session to give us the desired check - i.e. to
1037 * find if there's a session in the hash table that would conflict with
1038 * any new session built out of this id/id_len and the ssl_version in use
1042 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(ssl);
1044 if (sc == NULL || id_len > sizeof(r.session_id))
1047 r.ssl_version = sc->version;
1048 r.session_id_length = id_len;
1049 memcpy(r.session_id, id, id_len);
1051 if (!CRYPTO_THREAD_read_lock(sc->session_ctx->lock))
1053 p = lh_SSL_SESSION_retrieve(sc->session_ctx->sessions, &r);
1054 CRYPTO_THREAD_unlock(sc->session_ctx->lock);
1058 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
1060 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
1063 int SSL_set_purpose(SSL *s, int purpose)
1065 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1070 return X509_VERIFY_PARAM_set_purpose(sc->param, purpose);
1073 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
1075 return X509_VERIFY_PARAM_set_trust(s->param, trust);
1078 int SSL_set_trust(SSL *s, int trust)
1080 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1085 return X509_VERIFY_PARAM_set_trust(sc->param, trust);
1088 int SSL_set1_host(SSL *s, const char *hostname)
1090 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1095 /* If a hostname is provided and parses as an IP address,
1096 * treat it as such. */
1097 if (hostname != NULL
1098 && X509_VERIFY_PARAM_set1_ip_asc(sc->param, hostname) == 1)
1101 return X509_VERIFY_PARAM_set1_host(sc->param, hostname, 0);
1104 int SSL_add1_host(SSL *s, const char *hostname)
1106 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1111 /* If a hostname is provided and parses as an IP address,
1112 * treat it as such. */
1115 ASN1_OCTET_STRING *ip;
1118 ip = a2i_IPADDRESS(hostname);
1120 /* We didn't want it; only to check if it *is* an IP address */
1121 ASN1_OCTET_STRING_free(ip);
1123 old_ip = X509_VERIFY_PARAM_get1_ip_asc(sc->param);
1126 OPENSSL_free(old_ip);
1127 /* There can be only one IP address */
1131 return X509_VERIFY_PARAM_set1_ip_asc(sc->param, hostname);
1135 return X509_VERIFY_PARAM_add1_host(sc->param, hostname, 0);
1138 void SSL_set_hostflags(SSL *s, unsigned int flags)
1140 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1145 X509_VERIFY_PARAM_set_hostflags(sc->param, flags);
1148 const char *SSL_get0_peername(SSL *s)
1150 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1155 return X509_VERIFY_PARAM_get0_peername(sc->param);
1158 int SSL_CTX_dane_enable(SSL_CTX *ctx)
1160 return dane_ctx_enable(&ctx->dane);
1163 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
1165 unsigned long orig = ctx->dane.flags;
1167 ctx->dane.flags |= flags;
1171 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
1173 unsigned long orig = ctx->dane.flags;
1175 ctx->dane.flags &= ~flags;
1179 int SSL_dane_enable(SSL *s, const char *basedomain)
1182 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1188 if (s->ctx->dane.mdmax == 0) {
1189 ERR_raise(ERR_LIB_SSL, SSL_R_CONTEXT_NOT_DANE_ENABLED);
1192 if (dane->trecs != NULL) {
1193 ERR_raise(ERR_LIB_SSL, SSL_R_DANE_ALREADY_ENABLED);
1198 * Default SNI name. This rejects empty names, while set1_host below
1199 * accepts them and disables hostname checks. To avoid side-effects with
1200 * invalid input, set the SNI name first.
1202 if (sc->ext.hostname == NULL) {
1203 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1204 ERR_raise(ERR_LIB_SSL, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1209 /* Primary RFC6125 reference identifier */
1210 if (!X509_VERIFY_PARAM_set1_host(sc->param, basedomain, 0)) {
1211 ERR_raise(ERR_LIB_SSL, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1217 dane->dctx = &s->ctx->dane;
1218 dane->trecs = sk_danetls_record_new_null();
1220 if (dane->trecs == NULL) {
1221 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
1227 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1230 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
1235 orig = sc->dane.flags;
1237 sc->dane.flags |= flags;
1241 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1244 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
1249 orig = sc->dane.flags;
1251 sc->dane.flags &= ~flags;
1255 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1258 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1265 if (!DANETLS_ENABLED(dane) || sc->verify_result != X509_V_OK)
1269 *mcert = dane->mcert;
1271 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1276 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1277 uint8_t *mtype, const unsigned char **data, size_t *dlen)
1280 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1287 if (!DANETLS_ENABLED(dane) || sc->verify_result != X509_V_OK)
1291 *usage = dane->mtlsa->usage;
1293 *selector = dane->mtlsa->selector;
1295 *mtype = dane->mtlsa->mtype;
1297 *data = dane->mtlsa->data;
1299 *dlen = dane->mtlsa->dlen;
1304 SSL_DANE *SSL_get0_dane(SSL *s)
1306 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1314 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1315 uint8_t mtype, const unsigned char *data, size_t dlen)
1317 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1322 return dane_tlsa_add(&sc->dane, usage, selector, mtype, data, dlen);
1325 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1328 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1331 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1333 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1336 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1338 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
1343 return X509_VERIFY_PARAM_set1(sc->param, vpm);
1346 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1351 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1353 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
1361 void SSL_certs_clear(SSL *s)
1363 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1368 ssl_cert_clear_certs(sc->cert);
1371 void SSL_free(SSL *s)
1377 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1378 REF_PRINT_COUNT("SSL", s);
1381 REF_ASSERT_ISNT(i < 0);
1383 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1385 if (s->method != NULL)
1386 s->method->ssl_free(s);
1388 SSL_CTX_free(s->ctx);
1389 CRYPTO_THREAD_lock_free(s->lock);
1394 void ossl_ssl_connection_free(SSL *ssl)
1398 s = SSL_CONNECTION_FROM_SSL_ONLY(ssl);
1402 X509_VERIFY_PARAM_free(s->param);
1403 dane_final(&s->dane);
1405 /* Ignore return value */
1406 ssl_free_wbio_buffer(s);
1408 RECORD_LAYER_clear(&s->rlayer);
1410 BUF_MEM_free(s->init_buf);
1412 /* add extra stuff */
1413 sk_SSL_CIPHER_free(s->cipher_list);
1414 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1415 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1416 sk_SSL_CIPHER_free(s->peer_ciphers);
1418 /* Make the next call work :-) */
1419 if (s->session != NULL) {
1420 ssl_clear_bad_session(s);
1421 SSL_SESSION_free(s->session);
1423 SSL_SESSION_free(s->psksession);
1424 OPENSSL_free(s->psksession_id);
1426 ssl_cert_free(s->cert);
1427 OPENSSL_free(s->shared_sigalgs);
1428 /* Free up if allocated */
1430 OPENSSL_free(s->ext.hostname);
1431 SSL_CTX_free(s->session_ctx);
1432 OPENSSL_free(s->ext.ecpointformats);
1433 OPENSSL_free(s->ext.peer_ecpointformats);
1434 OPENSSL_free(s->ext.supportedgroups);
1435 OPENSSL_free(s->ext.peer_supportedgroups);
1436 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1437 #ifndef OPENSSL_NO_OCSP
1438 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1440 #ifndef OPENSSL_NO_CT
1441 SCT_LIST_free(s->scts);
1442 OPENSSL_free(s->ext.scts);
1444 OPENSSL_free(s->ext.ocsp.resp);
1445 OPENSSL_free(s->ext.alpn);
1446 OPENSSL_free(s->ext.tls13_cookie);
1447 if (s->clienthello != NULL)
1448 OPENSSL_free(s->clienthello->pre_proc_exts);
1449 OPENSSL_free(s->clienthello);
1450 OPENSSL_free(s->pha_context);
1451 EVP_MD_CTX_free(s->pha_dgst);
1453 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1454 sk_X509_NAME_pop_free(s->client_ca_names, X509_NAME_free);
1456 OPENSSL_free(s->client_cert_type);
1457 OPENSSL_free(s->server_cert_type);
1459 OSSL_STACK_OF_X509_free(s->verified_chain);
1461 if (ssl->method != NULL)
1462 ssl->method->ssl_deinit(ssl);
1464 ASYNC_WAIT_CTX_free(s->waitctx);
1466 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1467 OPENSSL_free(s->ext.npn);
1470 #ifndef OPENSSL_NO_SRTP
1471 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1475 * We do this late. We want to ensure that any other references we held to
1476 * these BIOs are freed first *before* we call BIO_free_all(), because
1477 * BIO_free_all() will only free each BIO in the chain if the number of
1478 * references to the first BIO have dropped to 0
1480 BIO_free_all(s->wbio);
1482 BIO_free_all(s->rbio);
1484 OPENSSL_free(s->s3.tmp.valid_flags);
1487 void SSL_set0_rbio(SSL *s, BIO *rbio)
1489 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1491 #ifndef OPENSSL_NO_QUIC
1493 ossl_quic_conn_set0_net_rbio(s, rbio);
1501 BIO_free_all(sc->rbio);
1503 sc->rlayer.rrlmethod->set1_bio(sc->rlayer.rrl, sc->rbio);
1506 void SSL_set0_wbio(SSL *s, BIO *wbio)
1508 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1510 #ifndef OPENSSL_NO_QUIC
1512 ossl_quic_conn_set0_net_wbio(s, wbio);
1521 * If the output buffering BIO is still in place, remove it
1523 if (sc->bbio != NULL)
1524 sc->wbio = BIO_pop(sc->wbio);
1526 BIO_free_all(sc->wbio);
1529 /* Re-attach |bbio| to the new |wbio|. */
1530 if (sc->bbio != NULL)
1531 sc->wbio = BIO_push(sc->bbio, sc->wbio);
1533 sc->rlayer.wrlmethod->set1_bio(sc->rlayer.wrl, sc->wbio);
1536 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1539 * For historical reasons, this function has many different cases in
1540 * ownership handling.
1543 /* If nothing has changed, do nothing */
1544 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1548 * If the two arguments are equal then one fewer reference is granted by the
1549 * caller than we want to take
1551 if (rbio != NULL && rbio == wbio)
1555 * If only the wbio is changed only adopt one reference.
1557 if (rbio == SSL_get_rbio(s)) {
1558 SSL_set0_wbio(s, wbio);
1562 * There is an asymmetry here for historical reasons. If only the rbio is
1563 * changed AND the rbio and wbio were originally different, then we only
1564 * adopt one reference.
1566 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1567 SSL_set0_rbio(s, rbio);
1571 /* Otherwise, adopt both references. */
1572 SSL_set0_rbio(s, rbio);
1573 SSL_set0_wbio(s, wbio);
1576 BIO *SSL_get_rbio(const SSL *s)
1578 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1580 #ifndef OPENSSL_NO_QUIC
1582 return ossl_quic_conn_get_net_rbio(s);
1591 BIO *SSL_get_wbio(const SSL *s)
1593 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1595 #ifndef OPENSSL_NO_QUIC
1597 return ossl_quic_conn_get_net_wbio(s);
1603 if (sc->bbio != NULL) {
1605 * If |bbio| is active, the true caller-configured BIO is its
1608 return BIO_next(sc->bbio);
1613 int SSL_get_fd(const SSL *s)
1615 return SSL_get_rfd(s);
1618 int SSL_get_rfd(const SSL *s)
1623 b = SSL_get_rbio(s);
1624 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1626 BIO_get_fd(r, &ret);
1630 int SSL_get_wfd(const SSL *s)
1635 b = SSL_get_wbio(s);
1636 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1638 BIO_get_fd(r, &ret);
1642 #ifndef OPENSSL_NO_SOCK
1643 int SSL_set_fd(SSL *s, int fd)
1648 bio = BIO_new(BIO_s_socket());
1651 ERR_raise(ERR_LIB_SSL, ERR_R_BUF_LIB);
1654 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1655 SSL_set_bio(s, bio, bio);
1656 #ifndef OPENSSL_NO_KTLS
1658 * The new socket is created successfully regardless of ktls_enable.
1659 * ktls_enable doesn't change any functionality of the socket, except
1660 * changing the setsockopt to enable the processing of ktls_start.
1661 * Thus, it is not a problem to call it for non-TLS sockets.
1664 #endif /* OPENSSL_NO_KTLS */
1670 int SSL_set_wfd(SSL *s, int fd)
1672 BIO *rbio = SSL_get_rbio(s);
1674 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1675 || (int)BIO_get_fd(rbio, NULL) != fd) {
1676 BIO *bio = BIO_new(BIO_s_socket());
1679 ERR_raise(ERR_LIB_SSL, ERR_R_BUF_LIB);
1682 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1683 SSL_set0_wbio(s, bio);
1684 #ifndef OPENSSL_NO_KTLS
1686 * The new socket is created successfully regardless of ktls_enable.
1687 * ktls_enable doesn't change any functionality of the socket, except
1688 * changing the setsockopt to enable the processing of ktls_start.
1689 * Thus, it is not a problem to call it for non-TLS sockets.
1692 #endif /* OPENSSL_NO_KTLS */
1695 SSL_set0_wbio(s, rbio);
1700 int SSL_set_rfd(SSL *s, int fd)
1702 BIO *wbio = SSL_get_wbio(s);
1704 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1705 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1706 BIO *bio = BIO_new(BIO_s_socket());
1709 ERR_raise(ERR_LIB_SSL, ERR_R_BUF_LIB);
1712 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1713 SSL_set0_rbio(s, bio);
1716 SSL_set0_rbio(s, wbio);
1723 /* return length of latest Finished message we sent, copy to 'buf' */
1724 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1727 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1732 ret = sc->s3.tmp.finish_md_len;
1735 memcpy(buf, sc->s3.tmp.finish_md, count);
1739 /* return length of latest Finished message we expected, copy to 'buf' */
1740 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1743 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1748 ret = sc->s3.tmp.peer_finish_md_len;
1751 memcpy(buf, sc->s3.tmp.peer_finish_md, count);
1755 int SSL_get_verify_mode(const SSL *s)
1757 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1762 return sc->verify_mode;
1765 int SSL_get_verify_depth(const SSL *s)
1767 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1772 return X509_VERIFY_PARAM_get_depth(sc->param);
1775 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1776 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1781 return sc->verify_callback;
1784 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1786 return ctx->verify_mode;
1789 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1791 return X509_VERIFY_PARAM_get_depth(ctx->param);
1794 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1795 return ctx->default_verify_callback;
1798 void SSL_set_verify(SSL *s, int mode,
1799 int (*callback) (int ok, X509_STORE_CTX *ctx))
1801 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1806 sc->verify_mode = mode;
1807 if (callback != NULL)
1808 sc->verify_callback = callback;
1811 void SSL_set_verify_depth(SSL *s, int depth)
1813 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1818 X509_VERIFY_PARAM_set_depth(sc->param, depth);
1821 void SSL_set_read_ahead(SSL *s, int yes)
1823 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1824 OSSL_PARAM options[2], *opts = options;
1829 RECORD_LAYER_set_read_ahead(&sc->rlayer, yes);
1831 *opts++ = OSSL_PARAM_construct_int(OSSL_LIBSSL_RECORD_LAYER_PARAM_READ_AHEAD,
1832 &sc->rlayer.read_ahead);
1833 *opts = OSSL_PARAM_construct_end();
1835 /* Ignore return value */
1836 sc->rlayer.rrlmethod->set_options(sc->rlayer.rrl, options);
1839 int SSL_get_read_ahead(const SSL *s)
1841 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1846 return RECORD_LAYER_get_read_ahead(&sc->rlayer);
1849 int SSL_pending(const SSL *s)
1851 size_t pending = s->method->ssl_pending(s);
1854 * SSL_pending cannot work properly if read-ahead is enabled
1855 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1856 * impossible to fix since SSL_pending cannot report errors that may be
1857 * observed while scanning the new data. (Note that SSL_pending() is
1858 * often used as a boolean value, so we'd better not return -1.)
1860 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1861 * we just return INT_MAX.
1863 return pending < INT_MAX ? (int)pending : INT_MAX;
1866 int SSL_has_pending(const SSL *s)
1869 * Similar to SSL_pending() but returns a 1 to indicate that we have
1870 * processed or unprocessed data available or 0 otherwise (as opposed to the
1871 * number of bytes available). Unlike SSL_pending() this will take into
1872 * account read_ahead data. A 1 return simply indicates that we have data.
1873 * That data may not result in any application data, or we may fail to parse
1874 * the records for some reason.
1876 const SSL_CONNECTION *sc;
1877 #ifndef OPENSSL_NO_QUIC
1878 const QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_CONST_SSL(s);
1881 return ossl_quic_has_pending(s);
1885 sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1887 /* Check buffered app data if any first */
1888 if (SSL_CONNECTION_IS_DTLS(sc)) {
1892 iter = pqueue_iterator(sc->rlayer.d->buffered_app_data.q);
1893 while ((item = pqueue_next(&iter)) != NULL) {
1895 if (rdata->length > 0)
1900 if (RECORD_LAYER_processed_read_pending(&sc->rlayer))
1903 return RECORD_LAYER_read_pending(&sc->rlayer);
1906 X509 *SSL_get1_peer_certificate(const SSL *s)
1908 X509 *r = SSL_get0_peer_certificate(s);
1916 X509 *SSL_get0_peer_certificate(const SSL *s)
1918 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1923 if (sc->session == NULL)
1926 return sc->session->peer;
1929 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1932 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
1937 if (sc->session == NULL)
1940 r = sc->session->peer_chain;
1943 * If we are a client, cert_chain includes the peer's own certificate; if
1944 * we are a server, it does not.
1951 * Now in theory, since the calling process own 't' it should be safe to
1952 * modify. We need to be able to read f without being hassled
1954 int SSL_copy_session_id(SSL *t, const SSL *f)
1957 /* TODO(QUIC): Do we want to support this for QUIC connections? */
1958 SSL_CONNECTION *tsc = SSL_CONNECTION_FROM_SSL_ONLY(t);
1959 const SSL_CONNECTION *fsc = SSL_CONNECTION_FROM_CONST_SSL_ONLY(f);
1961 if (tsc == NULL || fsc == NULL)
1964 /* Do we need to do SSL locking? */
1965 if (!SSL_set_session(t, SSL_get_session(f))) {
1970 * what if we are setup for one protocol version but want to talk another
1972 if (t->method != f->method) {
1973 t->method->ssl_deinit(t);
1974 t->method = f->method;
1975 if (t->method->ssl_init(t) == 0)
1979 CRYPTO_UP_REF(&fsc->cert->references, &i, fsc->cert->lock);
1980 ssl_cert_free(tsc->cert);
1981 tsc->cert = fsc->cert;
1982 if (!SSL_set_session_id_context(t, fsc->sid_ctx, (int)fsc->sid_ctx_length)) {
1989 /* Fix this so it checks all the valid key/cert options */
1990 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1992 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1993 ERR_raise(ERR_LIB_SSL, SSL_R_NO_CERTIFICATE_ASSIGNED);
1996 if (ctx->cert->key->privatekey == NULL) {
1997 ERR_raise(ERR_LIB_SSL, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
2000 return X509_check_private_key
2001 (ctx->cert->key->x509, ctx->cert->key->privatekey);
2004 /* Fix this function so that it takes an optional type parameter */
2005 int SSL_check_private_key(const SSL *ssl)
2007 const SSL_CONNECTION *sc;
2009 if ((sc = SSL_CONNECTION_FROM_CONST_SSL(ssl)) == NULL) {
2010 ERR_raise(ERR_LIB_SSL, ERR_R_PASSED_NULL_PARAMETER);
2013 if (sc->cert->key->x509 == NULL) {
2014 ERR_raise(ERR_LIB_SSL, SSL_R_NO_CERTIFICATE_ASSIGNED);
2017 if (sc->cert->key->privatekey == NULL) {
2018 ERR_raise(ERR_LIB_SSL, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
2021 return X509_check_private_key(sc->cert->key->x509,
2022 sc->cert->key->privatekey);
2025 int SSL_waiting_for_async(SSL *s)
2027 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2038 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
2040 ASYNC_WAIT_CTX *ctx;
2041 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2046 if ((ctx = sc->waitctx) == NULL)
2048 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
2051 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
2052 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
2054 ASYNC_WAIT_CTX *ctx;
2055 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2060 if ((ctx = sc->waitctx) == NULL)
2062 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
2066 int SSL_CTX_set_async_callback(SSL_CTX *ctx, SSL_async_callback_fn callback)
2068 ctx->async_cb = callback;
2072 int SSL_CTX_set_async_callback_arg(SSL_CTX *ctx, void *arg)
2074 ctx->async_cb_arg = arg;
2078 int SSL_set_async_callback(SSL *s, SSL_async_callback_fn callback)
2080 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2085 sc->async_cb = callback;
2089 int SSL_set_async_callback_arg(SSL *s, void *arg)
2091 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2096 sc->async_cb_arg = arg;
2100 int SSL_get_async_status(SSL *s, int *status)
2102 ASYNC_WAIT_CTX *ctx;
2103 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2108 if ((ctx = sc->waitctx) == NULL)
2110 *status = ASYNC_WAIT_CTX_get_status(ctx);
2114 int SSL_accept(SSL *s)
2116 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2118 #ifndef OPENSSL_NO_QUIC
2120 return s->method->ssl_accept(s);
2126 if (sc->handshake_func == NULL) {
2127 /* Not properly initialized yet */
2128 SSL_set_accept_state(s);
2131 return SSL_do_handshake(s);
2134 int SSL_connect(SSL *s)
2136 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2138 #ifndef OPENSSL_NO_QUIC
2140 return s->method->ssl_connect(s);
2146 if (sc->handshake_func == NULL) {
2147 /* Not properly initialized yet */
2148 SSL_set_connect_state(s);
2151 return SSL_do_handshake(s);
2154 long SSL_get_default_timeout(const SSL *s)
2156 return (long int)ossl_time2seconds(s->method->get_timeout());
2159 static int ssl_async_wait_ctx_cb(void *arg)
2161 SSL *s = (SSL *)arg;
2162 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2167 return sc->async_cb(s, sc->async_cb_arg);
2170 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
2171 int (*func) (void *))
2174 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2179 if (sc->waitctx == NULL) {
2180 sc->waitctx = ASYNC_WAIT_CTX_new();
2181 if (sc->waitctx == NULL)
2183 if (sc->async_cb != NULL
2184 && !ASYNC_WAIT_CTX_set_callback
2185 (sc->waitctx, ssl_async_wait_ctx_cb, s))
2189 sc->rwstate = SSL_NOTHING;
2190 switch (ASYNC_start_job(&sc->job, sc->waitctx, &ret, func, args,
2191 sizeof(struct ssl_async_args))) {
2193 sc->rwstate = SSL_NOTHING;
2194 ERR_raise(ERR_LIB_SSL, SSL_R_FAILED_TO_INIT_ASYNC);
2197 sc->rwstate = SSL_ASYNC_PAUSED;
2200 sc->rwstate = SSL_ASYNC_NO_JOBS;
2206 sc->rwstate = SSL_NOTHING;
2207 ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
2208 /* Shouldn't happen */
2213 static int ssl_io_intern(void *vargs)
2215 struct ssl_async_args *args;
2221 args = (struct ssl_async_args *)vargs;
2225 if ((sc = SSL_CONNECTION_FROM_SSL(s)) == NULL)
2228 switch (args->type) {
2230 return args->f.func_read(s, buf, num, &sc->asyncrw);
2232 return args->f.func_write(s, buf, num, &sc->asyncrw);
2234 return args->f.func_other(s);
2239 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
2241 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2243 #ifndef OPENSSL_NO_QUIC
2245 return s->method->ssl_read(s, buf, num, readbytes);
2251 if (sc->handshake_func == NULL) {
2252 ERR_raise(ERR_LIB_SSL, SSL_R_UNINITIALIZED);
2256 if (sc->shutdown & SSL_RECEIVED_SHUTDOWN) {
2257 sc->rwstate = SSL_NOTHING;
2261 if (sc->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
2262 || sc->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
2263 ERR_raise(ERR_LIB_SSL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2267 * If we are a client and haven't received the ServerHello etc then we
2270 ossl_statem_check_finish_init(sc, 0);
2272 if ((sc->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2273 struct ssl_async_args args;
2279 args.type = READFUNC;
2280 args.f.func_read = s->method->ssl_read;
2282 ret = ssl_start_async_job(s, &args, ssl_io_intern);
2283 *readbytes = sc->asyncrw;
2286 return s->method->ssl_read(s, buf, num, readbytes);
2290 int SSL_read(SSL *s, void *buf, int num)
2296 ERR_raise(ERR_LIB_SSL, SSL_R_BAD_LENGTH);
2300 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
2303 * The cast is safe here because ret should be <= INT_MAX because num is
2307 ret = (int)readbytes;
2312 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
2314 int ret = ssl_read_internal(s, buf, num, readbytes);
2321 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
2324 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
2326 /* TODO(QUIC): This will need special handling for QUIC */
2331 ERR_raise(ERR_LIB_SSL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2332 return SSL_READ_EARLY_DATA_ERROR;
2335 switch (sc->early_data_state) {
2336 case SSL_EARLY_DATA_NONE:
2337 if (!SSL_in_before(s)) {
2338 ERR_raise(ERR_LIB_SSL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2339 return SSL_READ_EARLY_DATA_ERROR;
2343 case SSL_EARLY_DATA_ACCEPT_RETRY:
2344 sc->early_data_state = SSL_EARLY_DATA_ACCEPTING;
2345 ret = SSL_accept(s);
2348 sc->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
2349 return SSL_READ_EARLY_DATA_ERROR;
2353 case SSL_EARLY_DATA_READ_RETRY:
2354 if (sc->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
2355 sc->early_data_state = SSL_EARLY_DATA_READING;
2356 ret = SSL_read_ex(s, buf, num, readbytes);
2358 * State machine will update early_data_state to
2359 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
2362 if (ret > 0 || (ret <= 0 && sc->early_data_state
2363 != SSL_EARLY_DATA_FINISHED_READING)) {
2364 sc->early_data_state = SSL_EARLY_DATA_READ_RETRY;
2365 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
2366 : SSL_READ_EARLY_DATA_ERROR;
2369 sc->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
2372 return SSL_READ_EARLY_DATA_FINISH;
2375 ERR_raise(ERR_LIB_SSL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2376 return SSL_READ_EARLY_DATA_ERROR;
2380 int SSL_get_early_data_status(const SSL *s)
2382 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL_ONLY(s);
2384 /* TODO(QUIC): This will need special handling for QUIC */
2388 return sc->ext.early_data;
2391 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
2393 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2395 #ifndef OPENSSL_NO_QUIC
2397 return s->method->ssl_peek(s, buf, num, readbytes);
2403 if (sc->handshake_func == NULL) {
2404 ERR_raise(ERR_LIB_SSL, SSL_R_UNINITIALIZED);
2408 if (sc->shutdown & SSL_RECEIVED_SHUTDOWN) {
2411 if ((sc->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2412 struct ssl_async_args args;
2418 args.type = READFUNC;
2419 args.f.func_read = s->method->ssl_peek;
2421 ret = ssl_start_async_job(s, &args, ssl_io_intern);
2422 *readbytes = sc->asyncrw;
2425 return s->method->ssl_peek(s, buf, num, readbytes);
2429 int SSL_peek(SSL *s, void *buf, int num)
2435 ERR_raise(ERR_LIB_SSL, SSL_R_BAD_LENGTH);
2439 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
2442 * The cast is safe here because ret should be <= INT_MAX because num is
2446 ret = (int)readbytes;
2452 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
2454 int ret = ssl_peek_internal(s, buf, num, readbytes);
2461 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
2463 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2465 #ifndef OPENSSL_NO_QUIC
2467 return s->method->ssl_write(s, buf, num, written);
2473 if (sc->handshake_func == NULL) {
2474 ERR_raise(ERR_LIB_SSL, SSL_R_UNINITIALIZED);
2478 if (sc->shutdown & SSL_SENT_SHUTDOWN) {
2479 sc->rwstate = SSL_NOTHING;
2480 ERR_raise(ERR_LIB_SSL, SSL_R_PROTOCOL_IS_SHUTDOWN);
2484 if (sc->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
2485 || sc->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
2486 || sc->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
2487 ERR_raise(ERR_LIB_SSL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2490 /* If we are a client and haven't sent the Finished we better do that */
2491 ossl_statem_check_finish_init(sc, 1);
2493 if ((sc->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2495 struct ssl_async_args args;
2498 args.buf = (void *)buf;
2500 args.type = WRITEFUNC;
2501 args.f.func_write = s->method->ssl_write;
2503 ret = ssl_start_async_job(s, &args, ssl_io_intern);
2504 *written = sc->asyncrw;
2507 return s->method->ssl_write(s, buf, num, written);
2511 ossl_ssize_t SSL_sendfile(SSL *s, int fd, off_t offset, size_t size, int flags)
2514 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
2519 if (sc->handshake_func == NULL) {
2520 ERR_raise(ERR_LIB_SSL, SSL_R_UNINITIALIZED);
2524 if (sc->shutdown & SSL_SENT_SHUTDOWN) {
2525 sc->rwstate = SSL_NOTHING;
2526 ERR_raise(ERR_LIB_SSL, SSL_R_PROTOCOL_IS_SHUTDOWN);
2530 if (!BIO_get_ktls_send(sc->wbio)) {
2531 ERR_raise(ERR_LIB_SSL, SSL_R_UNINITIALIZED);
2535 /* If we have an alert to send, lets send it */
2536 if (sc->s3.alert_dispatch > 0) {
2537 ret = (ossl_ssize_t)s->method->ssl_dispatch_alert(s);
2539 /* SSLfatal() already called if appropriate */
2542 /* if it went, fall through and send more stuff */
2545 sc->rwstate = SSL_WRITING;
2546 if (BIO_flush(sc->wbio) <= 0) {
2547 if (!BIO_should_retry(sc->wbio)) {
2548 sc->rwstate = SSL_NOTHING;
2551 set_sys_error(EAGAIN);
2557 #ifdef OPENSSL_NO_KTLS
2558 ERR_raise_data(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR,
2559 "can't call ktls_sendfile(), ktls disabled");
2562 ret = ktls_sendfile(SSL_get_wfd(s), fd, offset, size, flags);
2564 #if defined(EAGAIN) && defined(EINTR) && defined(EBUSY)
2565 if ((get_last_sys_error() == EAGAIN) ||
2566 (get_last_sys_error() == EINTR) ||
2567 (get_last_sys_error() == EBUSY))
2568 BIO_set_retry_write(sc->wbio);
2571 ERR_raise(ERR_LIB_SSL, SSL_R_UNINITIALIZED);
2574 sc->rwstate = SSL_NOTHING;
2579 int SSL_write(SSL *s, const void *buf, int num)
2585 ERR_raise(ERR_LIB_SSL, SSL_R_BAD_LENGTH);
2589 ret = ssl_write_internal(s, buf, (size_t)num, &written);
2592 * The cast is safe here because ret should be <= INT_MAX because num is
2601 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
2603 int ret = ssl_write_internal(s, buf, num, written);
2610 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
2612 int ret, early_data_state;
2614 uint32_t partialwrite;
2615 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
2617 /* TODO(QUIC): This will need special handling for QUIC */
2621 switch (sc->early_data_state) {
2622 case SSL_EARLY_DATA_NONE:
2624 || !SSL_in_before(s)
2625 || ((sc->session == NULL || sc->session->ext.max_early_data == 0)
2626 && (sc->psk_use_session_cb == NULL))) {
2627 ERR_raise(ERR_LIB_SSL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2632 case SSL_EARLY_DATA_CONNECT_RETRY:
2633 sc->early_data_state = SSL_EARLY_DATA_CONNECTING;
2634 ret = SSL_connect(s);
2637 sc->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2642 case SSL_EARLY_DATA_WRITE_RETRY:
2643 sc->early_data_state = SSL_EARLY_DATA_WRITING;
2645 * We disable partial write for early data because we don't keep track
2646 * of how many bytes we've written between the SSL_write_ex() call and
2647 * the flush if the flush needs to be retried)
2649 partialwrite = sc->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2650 sc->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2651 ret = SSL_write_ex(s, buf, num, &writtmp);
2652 sc->mode |= partialwrite;
2654 sc->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2657 sc->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2660 case SSL_EARLY_DATA_WRITE_FLUSH:
2661 /* The buffering BIO is still in place so we need to flush it */
2662 if (statem_flush(sc) != 1)
2665 sc->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2668 case SSL_EARLY_DATA_FINISHED_READING:
2669 case SSL_EARLY_DATA_READ_RETRY:
2670 early_data_state = sc->early_data_state;
2671 /* We are a server writing to an unauthenticated client */
2672 sc->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2673 ret = SSL_write_ex(s, buf, num, written);
2674 /* The buffering BIO is still in place */
2676 (void)BIO_flush(sc->wbio);
2677 sc->early_data_state = early_data_state;
2681 ERR_raise(ERR_LIB_SSL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2686 int SSL_shutdown(SSL *s)
2689 * Note that this function behaves differently from what one might
2690 * expect. Return values are 0 for no success (yet), 1 for success; but
2691 * calling it once is usually not enough, even if blocking I/O is used
2692 * (see ssl3_shutdown).
2694 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2695 #ifndef OPENSSL_NO_QUIC
2696 QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
2699 return ossl_quic_conn_shutdown(s, 0, NULL, 0);
2705 if (sc->handshake_func == NULL) {
2706 ERR_raise(ERR_LIB_SSL, SSL_R_UNINITIALIZED);
2710 if (!SSL_in_init(s)) {
2711 if ((sc->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2712 struct ssl_async_args args;
2714 memset(&args, 0, sizeof(args));
2716 args.type = OTHERFUNC;
2717 args.f.func_other = s->method->ssl_shutdown;
2719 return ssl_start_async_job(s, &args, ssl_io_intern);
2721 return s->method->ssl_shutdown(s);
2724 ERR_raise(ERR_LIB_SSL, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2729 int SSL_key_update(SSL *s, int updatetype)
2731 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2736 if (!SSL_CONNECTION_IS_TLS13(sc)) {
2737 ERR_raise(ERR_LIB_SSL, SSL_R_WRONG_SSL_VERSION);
2741 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2742 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2743 ERR_raise(ERR_LIB_SSL, SSL_R_INVALID_KEY_UPDATE_TYPE);
2747 if (!SSL_is_init_finished(s)) {
2748 ERR_raise(ERR_LIB_SSL, SSL_R_STILL_IN_INIT);
2752 if (RECORD_LAYER_write_pending(&sc->rlayer)) {
2753 ERR_raise(ERR_LIB_SSL, SSL_R_BAD_WRITE_RETRY);
2757 ossl_statem_set_in_init(sc, 1);
2758 sc->key_update = updatetype;
2762 int SSL_get_key_update_type(const SSL *s)
2764 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
2769 return sc->key_update;
2773 * Can we accept a renegotiation request? If yes, set the flag and
2774 * return 1 if yes. If not, raise error and return 0.
2776 static int can_renegotiate(const SSL_CONNECTION *sc)
2778 if (SSL_CONNECTION_IS_TLS13(sc)) {
2779 ERR_raise(ERR_LIB_SSL, SSL_R_WRONG_SSL_VERSION);
2783 if ((sc->options & SSL_OP_NO_RENEGOTIATION) != 0) {
2784 ERR_raise(ERR_LIB_SSL, SSL_R_NO_RENEGOTIATION);
2791 int SSL_renegotiate(SSL *s)
2793 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
2798 if (!can_renegotiate(sc))
2801 sc->renegotiate = 1;
2802 sc->new_session = 1;
2803 return s->method->ssl_renegotiate(s);
2806 int SSL_renegotiate_abbreviated(SSL *s)
2808 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
2813 if (!can_renegotiate(sc))
2816 sc->renegotiate = 1;
2817 sc->new_session = 0;
2818 return s->method->ssl_renegotiate(s);
2821 int SSL_renegotiate_pending(const SSL *s)
2823 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
2829 * becomes true when negotiation is requested; false again once a
2830 * handshake has finished
2832 return (sc->renegotiate != 0);
2835 int SSL_new_session_ticket(SSL *s)
2837 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2842 /* If we are in init because we're sending tickets, okay to send more. */
2843 if ((SSL_in_init(s) && sc->ext.extra_tickets_expected == 0)
2844 || SSL_IS_FIRST_HANDSHAKE(sc) || !sc->server
2845 || !SSL_CONNECTION_IS_TLS13(sc))
2847 sc->ext.extra_tickets_expected++;
2848 if (!RECORD_LAYER_write_pending(&sc->rlayer) && !SSL_in_init(s))
2849 ossl_statem_set_in_init(sc, 1);
2853 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2856 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2858 /* TODO(QUIC): Special handling for some ctrls will be needed */
2863 case SSL_CTRL_GET_READ_AHEAD:
2864 return RECORD_LAYER_get_read_ahead(&sc->rlayer);
2865 case SSL_CTRL_SET_READ_AHEAD:
2866 l = RECORD_LAYER_get_read_ahead(&sc->rlayer);
2867 RECORD_LAYER_set_read_ahead(&sc->rlayer, larg);
2870 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2871 sc->msg_callback_arg = parg;
2876 OSSL_PARAM options[2], *opts = options;
2880 *opts++ = OSSL_PARAM_construct_uint32(OSSL_LIBSSL_RECORD_LAYER_PARAM_MODE,
2882 *opts = OSSL_PARAM_construct_end();
2884 /* Ignore return value */
2885 sc->rlayer.rrlmethod->set_options(sc->rlayer.rrl, options);
2889 case SSL_CTRL_CLEAR_MODE:
2890 return (sc->mode &= ~larg);
2891 case SSL_CTRL_GET_MAX_CERT_LIST:
2892 return (long)sc->max_cert_list;
2893 case SSL_CTRL_SET_MAX_CERT_LIST:
2896 l = (long)sc->max_cert_list;
2897 sc->max_cert_list = (size_t)larg;
2899 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2900 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2902 #ifndef OPENSSL_NO_KTLS
2903 if (sc->wbio != NULL && BIO_get_ktls_send(sc->wbio))
2905 #endif /* OPENSSL_NO_KTLS */
2906 sc->max_send_fragment = larg;
2907 if (sc->max_send_fragment < sc->split_send_fragment)
2908 sc->split_send_fragment = sc->max_send_fragment;
2909 sc->rlayer.wrlmethod->set_max_frag_len(sc->rlayer.wrl, larg);
2911 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2912 if ((size_t)larg > sc->max_send_fragment || larg == 0)
2914 sc->split_send_fragment = larg;
2916 case SSL_CTRL_SET_MAX_PIPELINES:
2917 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2919 sc->max_pipelines = larg;
2920 if (sc->rlayer.rrlmethod->set_max_pipelines != NULL)
2921 sc->rlayer.rrlmethod->set_max_pipelines(sc->rlayer.rrl, (size_t)larg);
2923 case SSL_CTRL_GET_RI_SUPPORT:
2924 return sc->s3.send_connection_binding;
2925 case SSL_CTRL_SET_RETRY_VERIFY:
2926 sc->rwstate = SSL_RETRY_VERIFY;
2928 case SSL_CTRL_CERT_FLAGS:
2929 return (sc->cert->cert_flags |= larg);
2930 case SSL_CTRL_CLEAR_CERT_FLAGS:
2931 return (sc->cert->cert_flags &= ~larg);
2933 case SSL_CTRL_GET_RAW_CIPHERLIST:
2935 if (sc->s3.tmp.ciphers_raw == NULL)
2937 *(unsigned char **)parg = sc->s3.tmp.ciphers_raw;
2938 return (int)sc->s3.tmp.ciphers_rawlen;
2940 return TLS_CIPHER_LEN;
2942 case SSL_CTRL_GET_EXTMS_SUPPORT:
2943 if (!sc->session || SSL_in_init(s) || ossl_statem_get_in_handshake(sc))
2945 if (sc->session->flags & SSL_SESS_FLAG_EXTMS)
2949 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2950 return ssl_check_allowed_versions(larg, sc->max_proto_version)
2951 && ssl_set_version_bound(s->defltmeth->version, (int)larg,
2952 &sc->min_proto_version);
2953 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2954 return sc->min_proto_version;
2955 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2956 return ssl_check_allowed_versions(sc->min_proto_version, larg)
2957 && ssl_set_version_bound(s->defltmeth->version, (int)larg,
2958 &sc->max_proto_version);
2959 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2960 return sc->max_proto_version;
2962 return s->method->ssl_ctrl(s, cmd, larg, parg);
2966 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2968 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
2974 case SSL_CTRL_SET_MSG_CALLBACK:
2975 sc->msg_callback = (void (*)
2976 (int write_p, int version, int content_type,
2977 const void *buf, size_t len, SSL *ssl,
2982 return s->method->ssl_callback_ctrl(s, cmd, fp);
2986 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2988 return ctx->sessions;
2991 static int ssl_tsan_load(SSL_CTX *ctx, TSAN_QUALIFIER int *stat)
2995 if (ssl_tsan_lock(ctx)) {
2996 res = tsan_load(stat);
2997 ssl_tsan_unlock(ctx);
3002 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
3005 /* For some cases with ctx == NULL perform syntax checks */
3008 case SSL_CTRL_SET_GROUPS_LIST:
3009 return tls1_set_groups_list(ctx, NULL, NULL, parg);
3010 case SSL_CTRL_SET_SIGALGS_LIST:
3011 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
3012 return tls1_set_sigalgs_list(NULL, parg, 0);
3019 case SSL_CTRL_GET_READ_AHEAD:
3020 return ctx->read_ahead;
3021 case SSL_CTRL_SET_READ_AHEAD:
3022 l = ctx->read_ahead;
3023 ctx->read_ahead = larg;
3026 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
3027 ctx->msg_callback_arg = parg;
3030 case SSL_CTRL_GET_MAX_CERT_LIST:
3031 return (long)ctx->max_cert_list;
3032 case SSL_CTRL_SET_MAX_CERT_LIST:
3035 l = (long)ctx->max_cert_list;
3036 ctx->max_cert_list = (size_t)larg;
3039 case SSL_CTRL_SET_SESS_CACHE_SIZE:
3042 l = (long)ctx->session_cache_size;
3043 ctx->session_cache_size = (size_t)larg;
3045 case SSL_CTRL_GET_SESS_CACHE_SIZE:
3046 return (long)ctx->session_cache_size;
3047 case SSL_CTRL_SET_SESS_CACHE_MODE:
3048 l = ctx->session_cache_mode;
3049 ctx->session_cache_mode = larg;
3051 case SSL_CTRL_GET_SESS_CACHE_MODE:
3052 return ctx->session_cache_mode;
3054 case SSL_CTRL_SESS_NUMBER:
3055 return lh_SSL_SESSION_num_items(ctx->sessions);
3056 case SSL_CTRL_SESS_CONNECT:
3057 return ssl_tsan_load(ctx, &ctx->stats.sess_connect);
3058 case SSL_CTRL_SESS_CONNECT_GOOD:
3059 return ssl_tsan_load(ctx, &ctx->stats.sess_connect_good);
3060 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
3061 return ssl_tsan_load(ctx, &ctx->stats.sess_connect_renegotiate);
3062 case SSL_CTRL_SESS_ACCEPT:
3063 return ssl_tsan_load(ctx, &ctx->stats.sess_accept);
3064 case SSL_CTRL_SESS_ACCEPT_GOOD:
3065 return ssl_tsan_load(ctx, &ctx->stats.sess_accept_good);
3066 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
3067 return ssl_tsan_load(ctx, &ctx->stats.sess_accept_renegotiate);
3068 case SSL_CTRL_SESS_HIT:
3069 return ssl_tsan_load(ctx, &ctx->stats.sess_hit);
3070 case SSL_CTRL_SESS_CB_HIT:
3071 return ssl_tsan_load(ctx, &ctx->stats.sess_cb_hit);
3072 case SSL_CTRL_SESS_MISSES:
3073 return ssl_tsan_load(ctx, &ctx->stats.sess_miss);
3074 case SSL_CTRL_SESS_TIMEOUTS:
3075 return ssl_tsan_load(ctx, &ctx->stats.sess_timeout);
3076 case SSL_CTRL_SESS_CACHE_FULL:
3077 return ssl_tsan_load(ctx, &ctx->stats.sess_cache_full);
3079 return (ctx->mode |= larg);
3080 case SSL_CTRL_CLEAR_MODE:
3081 return (ctx->mode &= ~larg);
3082 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
3083 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
3085 ctx->max_send_fragment = larg;
3086 if (ctx->max_send_fragment < ctx->split_send_fragment)
3087 ctx->split_send_fragment = ctx->max_send_fragment;
3089 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
3090 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
3092 ctx->split_send_fragment = larg;
3094 case SSL_CTRL_SET_MAX_PIPELINES:
3095 if (larg < 1 || larg > SSL_MAX_PIPELINES)
3097 ctx->max_pipelines = larg;
3099 case SSL_CTRL_CERT_FLAGS:
3100 return (ctx->cert->cert_flags |= larg);
3101 case SSL_CTRL_CLEAR_CERT_FLAGS:
3102 return (ctx->cert->cert_flags &= ~larg);
3103 case SSL_CTRL_SET_MIN_PROTO_VERSION:
3104 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
3105 && ssl_set_version_bound(ctx->method->version, (int)larg,
3106 &ctx->min_proto_version);
3107 case SSL_CTRL_GET_MIN_PROTO_VERSION:
3108 return ctx->min_proto_version;
3109 case SSL_CTRL_SET_MAX_PROTO_VERSION:
3110 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
3111 && ssl_set_version_bound(ctx->method->version, (int)larg,
3112 &ctx->max_proto_version);
3113 case SSL_CTRL_GET_MAX_PROTO_VERSION:
3114 return ctx->max_proto_version;
3116 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
3120 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
3123 case SSL_CTRL_SET_MSG_CALLBACK:
3124 ctx->msg_callback = (void (*)
3125 (int write_p, int version, int content_type,
3126 const void *buf, size_t len, SSL *ssl,
3131 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
3135 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
3144 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
3145 const SSL_CIPHER *const *bp)
3147 if ((*ap)->id > (*bp)->id)
3149 if ((*ap)->id < (*bp)->id)
3155 * return a STACK of the ciphers available for the SSL and in order of
3158 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
3160 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
3163 if (sc->cipher_list != NULL) {
3164 return sc->cipher_list;
3165 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
3166 return s->ctx->cipher_list;
3172 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
3174 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
3176 if (sc == NULL || !sc->server)
3178 return sc->peer_ciphers;
3181 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
3183 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
3185 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
3190 ciphers = SSL_get_ciphers(s);
3193 if (!ssl_set_client_disabled(sc))
3195 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
3196 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
3197 if (!ssl_cipher_disabled(sc, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
3199 sk = sk_SSL_CIPHER_new_null();
3202 if (!sk_SSL_CIPHER_push(sk, c)) {
3203 sk_SSL_CIPHER_free(sk);
3211 /** return a STACK of the ciphers available for the SSL and in order of
3213 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL_CONNECTION *s)
3216 if (s->cipher_list_by_id != NULL)
3217 return s->cipher_list_by_id;
3218 else if (s->ssl.ctx != NULL
3219 && s->ssl.ctx->cipher_list_by_id != NULL)
3220 return s->ssl.ctx->cipher_list_by_id;
3225 /** The old interface to get the same thing as SSL_get_ciphers() */
3226 const char *SSL_get_cipher_list(const SSL *s, int n)
3228 const SSL_CIPHER *c;
3229 STACK_OF(SSL_CIPHER) *sk;
3233 sk = SSL_get_ciphers(s);
3234 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
3236 c = sk_SSL_CIPHER_value(sk, n);
3242 /** return a STACK of the ciphers available for the SSL_CTX and in order of
3244 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
3247 return ctx->cipher_list;
3252 * Distinguish between ciphers controlled by set_ciphersuite() and
3253 * set_cipher_list() when counting.
3255 static int cipher_list_tls12_num(STACK_OF(SSL_CIPHER) *sk)
3258 const SSL_CIPHER *c;
3262 for (i = 0; i < sk_SSL_CIPHER_num(sk); ++i) {
3263 c = sk_SSL_CIPHER_value(sk, i);
3264 if (c->min_tls >= TLS1_3_VERSION)
3271 /** specify the ciphers to be used by default by the SSL_CTX */
3272 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
3274 STACK_OF(SSL_CIPHER) *sk;
3276 sk = ssl_create_cipher_list(ctx, ctx->tls13_ciphersuites,
3277 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
3280 * ssl_create_cipher_list may return an empty stack if it was unable to
3281 * find a cipher matching the given rule string (for example if the rule
3282 * string specifies a cipher which has been disabled). This is not an
3283 * error as far as ssl_create_cipher_list is concerned, and hence
3284 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
3288 else if (cipher_list_tls12_num(sk) == 0) {
3289 ERR_raise(ERR_LIB_SSL, SSL_R_NO_CIPHER_MATCH);
3295 /** specify the ciphers to be used by the SSL */
3296 int SSL_set_cipher_list(SSL *s, const char *str)
3298 STACK_OF(SSL_CIPHER) *sk;
3299 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
3304 sk = ssl_create_cipher_list(s->ctx, sc->tls13_ciphersuites,
3305 &sc->cipher_list, &sc->cipher_list_by_id, str,
3307 /* see comment in SSL_CTX_set_cipher_list */
3310 else if (cipher_list_tls12_num(sk) == 0) {
3311 ERR_raise(ERR_LIB_SSL, SSL_R_NO_CIPHER_MATCH);
3317 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
3320 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
3321 const SSL_CIPHER *c;
3323 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
3329 || sc->peer_ciphers == NULL
3334 clntsk = sc->peer_ciphers;
3335 srvrsk = SSL_get_ciphers(s);
3336 if (clntsk == NULL || srvrsk == NULL)
3339 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
3342 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
3345 c = sk_SSL_CIPHER_value(clntsk, i);
3346 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
3349 n = strlen(c->name);
3366 * Return the requested servername (SNI) value. Note that the behaviour varies
3368 * - whether this is called by the client or the server,
3369 * - if we are before or during/after the handshake,
3370 * - if a resumption or normal handshake is being attempted/has occurred
3371 * - whether we have negotiated TLSv1.2 (or below) or TLSv1.3
3373 * Note that only the host_name type is defined (RFC 3546).
3375 const char *SSL_get_servername(const SSL *s, const int type)
3377 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
3384 * If we don't know if we are the client or the server yet then we assume
3387 server = sc->handshake_func == NULL ? 0 : sc->server;
3389 if (type != TLSEXT_NAMETYPE_host_name)
3395 * In TLSv1.3 on the server SNI is not associated with the session
3396 * but in TLSv1.2 or below it is.
3398 * Before the handshake:
3401 * During/after the handshake (TLSv1.2 or below resumption occurred):
3402 * - If a servername was accepted by the server in the original
3403 * handshake then it will return that servername, or NULL otherwise.
3405 * During/after the handshake (TLSv1.2 or below resumption did not occur):
3406 * - The function will return the servername requested by the client in
3407 * this handshake or NULL if none was requested.
3409 if (sc->hit && !SSL_CONNECTION_IS_TLS13(sc))
3410 return sc->session->ext.hostname;
3415 * Before the handshake:
3416 * - If a servername has been set via a call to
3417 * SSL_set_tlsext_host_name() then it will return that servername
3418 * - If one has not been set, but a TLSv1.2 resumption is being
3419 * attempted and the session from the original handshake had a
3420 * servername accepted by the server then it will return that
3422 * - Otherwise it returns NULL
3424 * During/after the handshake (TLSv1.2 or below resumption occurred):
3425 * - If the session from the original handshake had a servername accepted
3426 * by the server then it will return that servername.
3427 * - Otherwise it returns the servername set via
3428 * SSL_set_tlsext_host_name() (or NULL if it was not called).
3430 * During/after the handshake (TLSv1.2 or below resumption did not occur):
3431 * - It will return the servername set via SSL_set_tlsext_host_name()
3432 * (or NULL if it was not called).
3434 if (SSL_in_before(s)) {
3435 if (sc->ext.hostname == NULL
3436 && sc->session != NULL
3437 && sc->session->ssl_version != TLS1_3_VERSION)
3438 return sc->session->ext.hostname;
3440 if (!SSL_CONNECTION_IS_TLS13(sc) && sc->hit
3441 && sc->session->ext.hostname != NULL)
3442 return sc->session->ext.hostname;
3446 return sc->ext.hostname;
3449 int SSL_get_servername_type(const SSL *s)
3451 if (SSL_get_servername(s, TLSEXT_NAMETYPE_host_name) != NULL)
3452 return TLSEXT_NAMETYPE_host_name;
3457 * SSL_select_next_proto implements the standard protocol selection. It is
3458 * expected that this function is called from the callback set by
3459 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
3460 * vector of 8-bit, length prefixed byte strings. The length byte itself is
3461 * not included in the length. A byte string of length 0 is invalid. No byte
3462 * string may be truncated. The current, but experimental algorithm for
3463 * selecting the protocol is: 1) If the server doesn't support NPN then this
3464 * is indicated to the callback. In this case, the client application has to
3465 * abort the connection or have a default application level protocol. 2) If
3466 * the server supports NPN, but advertises an empty list then the client
3467 * selects the first protocol in its list, but indicates via the API that this
3468 * fallback case was enacted. 3) Otherwise, the client finds the first
3469 * protocol in the server's list that it supports and selects this protocol.
3470 * This is because it's assumed that the server has better information about
3471 * which protocol a client should use. 4) If the client doesn't support any
3472 * of the server's advertised protocols, then this is treated the same as
3473 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
3474 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
3476 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
3477 const unsigned char *server,
3478 unsigned int server_len,
3479 const unsigned char *client, unsigned int client_len)
3482 const unsigned char *result;
3483 int status = OPENSSL_NPN_UNSUPPORTED;
3486 * For each protocol in server preference order, see if we support it.
3488 for (i = 0; i < server_len;) {
3489 for (j = 0; j < client_len;) {
3490 if (server[i] == client[j] &&
3491 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
3492 /* We found a match */
3493 result = &server[i];
3494 status = OPENSSL_NPN_NEGOTIATED;
3504 /* There's no overlap between our protocols and the server's list. */
3506 status = OPENSSL_NPN_NO_OVERLAP;
3509 *out = (unsigned char *)result + 1;
3510 *outlen = result[0];
3514 #ifndef OPENSSL_NO_NEXTPROTONEG
3516 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
3517 * client's requested protocol for this connection and returns 0. If the
3518 * client didn't request any protocol, then *data is set to NULL. Note that
3519 * the client can request any protocol it chooses. The value returned from
3520 * this function need not be a member of the list of supported protocols
3521 * provided by the callback.
3523 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
3526 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
3529 /* We have no other way to indicate error */
3535 *data = sc->ext.npn;
3536 if (*data == NULL) {
3539 *len = (unsigned int)sc->ext.npn_len;
3544 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
3545 * a TLS server needs a list of supported protocols for Next Protocol
3546 * Negotiation. The returned list must be in wire format. The list is
3547 * returned by setting |out| to point to it and |outlen| to its length. This
3548 * memory will not be modified, but one should assume that the SSL* keeps a
3549 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
3550 * wishes to advertise. Otherwise, no such extension will be included in the
3553 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
3554 SSL_CTX_npn_advertised_cb_func cb,
3557 ctx->ext.npn_advertised_cb = cb;
3558 ctx->ext.npn_advertised_cb_arg = arg;
3562 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
3563 * client needs to select a protocol from the server's provided list. |out|
3564 * must be set to point to the selected protocol (which may be within |in|).
3565 * The length of the protocol name must be written into |outlen|. The
3566 * server's advertised protocols are provided in |in| and |inlen|. The
3567 * callback can assume that |in| is syntactically valid. The client must
3568 * select a protocol. It is fatal to the connection if this callback returns
3569 * a value other than SSL_TLSEXT_ERR_OK.
3571 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
3572 SSL_CTX_npn_select_cb_func cb,
3575 ctx->ext.npn_select_cb = cb;
3576 ctx->ext.npn_select_cb_arg = arg;
3580 static int alpn_value_ok(const unsigned char *protos, unsigned int protos_len)
3584 if (protos_len < 2 || protos == NULL)
3587 for (idx = 0; idx < protos_len; idx += protos[idx] + 1) {
3588 if (protos[idx] == 0)
3591 return idx == protos_len;
3594 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
3595 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
3596 * length-prefixed strings). Returns 0 on success.
3598 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
3599 unsigned int protos_len)
3601 unsigned char *alpn;
3603 if (protos_len == 0 || protos == NULL) {
3604 OPENSSL_free(ctx->ext.alpn);
3605 ctx->ext.alpn = NULL;
3606 ctx->ext.alpn_len = 0;
3609 /* Not valid per RFC */
3610 if (!alpn_value_ok(protos, protos_len))
3613 alpn = OPENSSL_memdup(protos, protos_len);
3616 OPENSSL_free(ctx->ext.alpn);
3617 ctx->ext.alpn = alpn;
3618 ctx->ext.alpn_len = protos_len;
3624 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
3625 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
3626 * length-prefixed strings). Returns 0 on success.
3628 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
3629 unsigned int protos_len)
3631 unsigned char *alpn;
3632 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
3637 if (protos_len == 0 || protos == NULL) {
3638 OPENSSL_free(sc->ext.alpn);
3639 sc->ext.alpn = NULL;
3640 sc->ext.alpn_len = 0;
3643 /* Not valid per RFC */
3644 if (!alpn_value_ok(protos, protos_len))
3647 alpn = OPENSSL_memdup(protos, protos_len);
3650 OPENSSL_free(sc->ext.alpn);
3651 sc->ext.alpn = alpn;
3652 sc->ext.alpn_len = protos_len;
3658 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
3659 * called during ClientHello processing in order to select an ALPN protocol
3660 * from the client's list of offered protocols.
3662 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
3663 SSL_CTX_alpn_select_cb_func cb,
3666 ctx->ext.alpn_select_cb = cb;
3667 ctx->ext.alpn_select_cb_arg = arg;
3671 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
3672 * On return it sets |*data| to point to |*len| bytes of protocol name
3673 * (not including the leading length-prefix byte). If the server didn't
3674 * respond with a negotiated protocol then |*len| will be zero.
3676 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
3679 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(ssl);
3682 /* We have no other way to indicate error */
3688 *data = sc->s3.alpn_selected;
3692 *len = (unsigned int)sc->s3.alpn_selected_len;
3695 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
3696 const char *label, size_t llen,
3697 const unsigned char *context, size_t contextlen,
3700 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
3705 if (sc->session == NULL
3706 || (sc->version < TLS1_VERSION && sc->version != DTLS1_BAD_VER))
3709 return s->method->ssl3_enc->export_keying_material(sc, out, olen, label,
3711 contextlen, use_context);
3714 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
3715 const char *label, size_t llen,
3716 const unsigned char *context,
3719 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
3724 if (sc->version != TLS1_3_VERSION)
3727 return tls13_export_keying_material_early(sc, out, olen, label, llen,
3728 context, contextlen);
3731 static unsigned long ssl_session_hash(const SSL_SESSION *a)
3733 const unsigned char *session_id = a->session_id;
3735 unsigned char tmp_storage[4];
3737 if (a->session_id_length < sizeof(tmp_storage)) {
3738 memset(tmp_storage, 0, sizeof(tmp_storage));
3739 memcpy(tmp_storage, a->session_id, a->session_id_length);
3740 session_id = tmp_storage;
3744 ((unsigned long)session_id[0]) |
3745 ((unsigned long)session_id[1] << 8L) |
3746 ((unsigned long)session_id[2] << 16L) |
3747 ((unsigned long)session_id[3] << 24L);
3752 * NB: If this function (or indeed the hash function which uses a sort of
3753 * coarser function than this one) is changed, ensure
3754 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
3755 * being able to construct an SSL_SESSION that will collide with any existing
3756 * session with a matching session ID.
3758 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
3760 if (a->ssl_version != b->ssl_version)
3762 if (a->session_id_length != b->session_id_length)
3764 return memcmp(a->session_id, b->session_id, a->session_id_length);
3768 * These wrapper functions should remain rather than redeclaring
3769 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
3770 * variable. The reason is that the functions aren't static, they're exposed
3774 SSL_CTX *SSL_CTX_new_ex(OSSL_LIB_CTX *libctx, const char *propq,
3775 const SSL_METHOD *meth)
3777 SSL_CTX *ret = NULL;
3778 #ifndef OPENSSL_NO_COMP_ALG
3783 ERR_raise(ERR_LIB_SSL, SSL_R_NULL_SSL_METHOD_PASSED);
3787 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
3790 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
3791 ERR_raise(ERR_LIB_SSL, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
3794 ret = OPENSSL_zalloc(sizeof(*ret));
3798 /* Init the reference counting before any call to SSL_CTX_free */
3799 ret->references = 1;
3800 ret->lock = CRYPTO_THREAD_lock_new();
3801 if (ret->lock == NULL) {
3802 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
3806 #ifdef TSAN_REQUIRES_LOCKING
3807 ret->tsan_lock = CRYPTO_THREAD_lock_new();
3808 if (ret->tsan_lock == NULL) {
3809 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
3814 ret->libctx = libctx;
3815 if (propq != NULL) {
3816 ret->propq = OPENSSL_strdup(propq);
3817 if (ret->propq == NULL)
3822 ret->min_proto_version = 0;
3823 ret->max_proto_version = 0;
3824 ret->mode = SSL_MODE_AUTO_RETRY;
3825 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
3826 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
3827 /* We take the system default. */
3828 ret->session_timeout = meth->get_timeout();
3829 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
3830 ret->verify_mode = SSL_VERIFY_NONE;
3832 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
3833 if (ret->sessions == NULL) {
3834 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
3837 ret->cert_store = X509_STORE_new();
3838 if (ret->cert_store == NULL) {
3839 ERR_raise(ERR_LIB_SSL, ERR_R_X509_LIB);
3842 #ifndef OPENSSL_NO_CT
3843 ret->ctlog_store = CTLOG_STORE_new_ex(libctx, propq);
3844 if (ret->ctlog_store == NULL) {
3845 ERR_raise(ERR_LIB_SSL, ERR_R_CT_LIB);
3850 /* initialize cipher/digest methods table */
3851 if (!ssl_load_ciphers(ret)) {
3852 ERR_raise(ERR_LIB_SSL, ERR_R_SSL_LIB);
3856 if (!ssl_load_groups(ret)) {
3857 ERR_raise(ERR_LIB_SSL, ERR_R_SSL_LIB);
3861 /* load provider sigalgs */
3862 if (!ssl_load_sigalgs(ret)) {
3863 ERR_raise(ERR_LIB_SSL, ERR_R_SSL_LIB);
3867 /* initialise sig algs */
3868 if (!ssl_setup_sigalgs(ret)) {
3869 ERR_raise(ERR_LIB_SSL, ERR_R_SSL_LIB);
3873 if (!SSL_CTX_set_ciphersuites(ret, OSSL_default_ciphersuites())) {
3874 ERR_raise(ERR_LIB_SSL, ERR_R_SSL_LIB);
3878 if ((ret->cert = ssl_cert_new(SSL_PKEY_NUM + ret->sigalg_list_len)) == NULL) {
3879 ERR_raise(ERR_LIB_SSL, ERR_R_SSL_LIB);
3883 if (!ssl_create_cipher_list(ret,
3884 ret->tls13_ciphersuites,
3885 &ret->cipher_list, &ret->cipher_list_by_id,
3886 OSSL_default_cipher_list(), ret->cert)
3887 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
3888 ERR_raise(ERR_LIB_SSL, SSL_R_LIBRARY_HAS_NO_CIPHERS);
3892 ret->param = X509_VERIFY_PARAM_new();
3893 if (ret->param == NULL) {
3894 ERR_raise(ERR_LIB_SSL, ERR_R_X509_LIB);
3899 * If these aren't available from the provider we'll get NULL returns.
3900 * That's fine but will cause errors later if SSLv3 is negotiated
3902 ret->md5 = ssl_evp_md_fetch(libctx, NID_md5, propq);
3903 ret->sha1 = ssl_evp_md_fetch(libctx, NID_sha1, propq);
3905 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL) {
3906 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
3910 if ((ret->client_ca_names = sk_X509_NAME_new_null()) == NULL) {
3911 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
3915 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data)) {
3916 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
3920 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
3923 /* No compression for DTLS */
3924 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
3925 ret->comp_methods = SSL_COMP_get_compression_methods();
3927 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3928 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3930 /* Setup RFC5077 ticket keys */
3931 if ((RAND_bytes_ex(libctx, ret->ext.tick_key_name,
3932 sizeof(ret->ext.tick_key_name), 0) <= 0)
3933 || (RAND_priv_bytes_ex(libctx, ret->ext.secure->tick_hmac_key,
3934 sizeof(ret->ext.secure->tick_hmac_key), 0) <= 0)
3935 || (RAND_priv_bytes_ex(libctx, ret->ext.secure->tick_aes_key,
3936 sizeof(ret->ext.secure->tick_aes_key), 0) <= 0))
3937 ret->options |= SSL_OP_NO_TICKET;
3939 if (RAND_priv_bytes_ex(libctx, ret->ext.cookie_hmac_key,
3940 sizeof(ret->ext.cookie_hmac_key), 0) <= 0) {
3941 ERR_raise(ERR_LIB_SSL, ERR_R_RAND_LIB);
3945 #ifndef OPENSSL_NO_SRP
3946 if (!ssl_ctx_srp_ctx_init_intern(ret)) {
3947 ERR_raise(ERR_LIB_SSL, ERR_R_SSL_LIB);
3951 #ifndef OPENSSL_NO_ENGINE
3952 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3953 # define eng_strx(x) #x
3954 # define eng_str(x) eng_strx(x)
3955 /* Use specific client engine automatically... ignore errors */
3958 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3961 ENGINE_load_builtin_engines();
3962 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3964 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3970 #ifndef OPENSSL_NO_COMP_ALG
3972 * Set the default order: brotli, zlib, zstd
3973 * Including only those enabled algorithms
3975 memset(ret->cert_comp_prefs, 0, sizeof(ret->cert_comp_prefs));
3977 if (ossl_comp_has_alg(TLSEXT_comp_cert_brotli))
3978 ret->cert_comp_prefs[i++] = TLSEXT_comp_cert_brotli;
3979 if (ossl_comp_has_alg(TLSEXT_comp_cert_zlib))
3980 ret->cert_comp_prefs[i++] = TLSEXT_comp_cert_zlib;
3981 if (ossl_comp_has_alg(TLSEXT_comp_cert_zstd))
3982 ret->cert_comp_prefs[i++] = TLSEXT_comp_cert_zstd;
3985 * Disable compression by default to prevent CRIME. Applications can
3986 * re-enable compression by configuring
3987 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3988 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3989 * middlebox compatibility by default. This may be disabled by default in
3990 * a later OpenSSL version.
3992 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3994 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3997 * We cannot usefully set a default max_early_data here (which gets
3998 * propagated in SSL_new(), for the following reason: setting the
3999 * SSL field causes tls_construct_stoc_early_data() to tell the
4000 * client that early data will be accepted when constructing a TLS 1.3
4001 * session ticket, and the client will accordingly send us early data
4002 * when using that ticket (if the client has early data to send).
4003 * However, in order for the early data to actually be consumed by
4004 * the application, the application must also have calls to
4005 * SSL_read_early_data(); otherwise we'll just skip past the early data
4006 * and ignore it. So, since the application must add calls to
4007 * SSL_read_early_data(), we also require them to add
4008 * calls to SSL_CTX_set_max_early_data() in order to use early data,
4009 * eliminating the bandwidth-wasting early data in the case described
4012 ret->max_early_data = 0;
4015 * Default recv_max_early_data is a fully loaded single record. Could be
4016 * split across multiple records in practice. We set this differently to
4017 * max_early_data so that, in the default case, we do not advertise any
4018 * support for early_data, but if a client were to send us some (e.g.
4019 * because of an old, stale ticket) then we will tolerate it and skip over
4022 ret->recv_max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
4024 /* By default we send two session tickets automatically in TLSv1.3 */
4025 ret->num_tickets = 2;
4027 ssl_ctx_system_config(ret);
4035 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
4037 return SSL_CTX_new_ex(NULL, NULL, meth);
4040 int SSL_CTX_up_ref(SSL_CTX *ctx)
4044 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
4047 REF_PRINT_COUNT("SSL_CTX", ctx);
4048 REF_ASSERT_ISNT(i < 2);
4049 return ((i > 1) ? 1 : 0);
4052 void SSL_CTX_free(SSL_CTX *a)
4060 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
4061 REF_PRINT_COUNT("SSL_CTX", a);
4064 REF_ASSERT_ISNT(i < 0);
4066 X509_VERIFY_PARAM_free(a->param);
4067 dane_ctx_final(&a->dane);
4070 * Free internal session cache. However: the remove_cb() may reference
4071 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
4072 * after the sessions were flushed.
4073 * As the ex_data handling routines might also touch the session cache,
4074 * the most secure solution seems to be: empty (flush) the cache, then
4075 * free ex_data, then finally free the cache.
4076 * (See ticket [openssl.org #212].)
4078 if (a->sessions != NULL)
4079 SSL_CTX_flush_sessions(a, 0);
4081 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
4082 lh_SSL_SESSION_free(a->sessions);
4083 X509_STORE_free(a->cert_store);
4084 #ifndef OPENSSL_NO_CT
4085 CTLOG_STORE_free(a->ctlog_store);
4087 sk_SSL_CIPHER_free(a->cipher_list);
4088 sk_SSL_CIPHER_free(a->cipher_list_by_id);
4089 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
4090 ssl_cert_free(a->cert);
4091 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
4092 sk_X509_NAME_pop_free(a->client_ca_names, X509_NAME_free);
4093 OSSL_STACK_OF_X509_free(a->extra_certs);
4094 a->comp_methods = NULL;
4095 #ifndef OPENSSL_NO_SRTP
4096 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
4098 #ifndef OPENSSL_NO_SRP
4099 ssl_ctx_srp_ctx_free_intern(a);
4101 #ifndef OPENSSL_NO_ENGINE
4102 tls_engine_finish(a->client_cert_engine);
4105 OPENSSL_free(a->ext.ecpointformats);
4106 OPENSSL_free(a->ext.supportedgroups);
4107 OPENSSL_free(a->ext.supported_groups_default);
4108 OPENSSL_free(a->ext.alpn);
4109 OPENSSL_secure_free(a->ext.secure);
4111 ssl_evp_md_free(a->md5);
4112 ssl_evp_md_free(a->sha1);
4114 for (j = 0; j < SSL_ENC_NUM_IDX; j++)
4115 ssl_evp_cipher_free(a->ssl_cipher_methods[j]);
4116 for (j = 0; j < SSL_MD_NUM_IDX; j++)
4117 ssl_evp_md_free(a->ssl_digest_methods[j]);
4118 for (j = 0; j < a->group_list_len; j++) {
4119 OPENSSL_free(a->group_list[j].tlsname);
4120 OPENSSL_free(a->group_list[j].realname);
4121 OPENSSL_free(a->group_list[j].algorithm);
4123 OPENSSL_free(a->group_list);
4124 for (j = 0; j < a->sigalg_list_len; j++) {
4125 OPENSSL_free(a->sigalg_list[j].name);
4126 OPENSSL_free(a->sigalg_list[j].sigalg_name);
4127 OPENSSL_free(a->sigalg_list[j].sigalg_oid);
4128 OPENSSL_free(a->sigalg_list[j].sig_name);
4129 OPENSSL_free(a->sigalg_list[j].sig_oid);
4130 OPENSSL_free(a->sigalg_list[j].hash_name);
4131 OPENSSL_free(a->sigalg_list[j].hash_oid);
4132 OPENSSL_free(a->sigalg_list[j].keytype);
4133 OPENSSL_free(a->sigalg_list[j].keytype_oid);
4135 OPENSSL_free(a->sigalg_list);
4136 OPENSSL_free(a->ssl_cert_info);
4138 OPENSSL_free(a->sigalg_lookup_cache);
4139 OPENSSL_free(a->tls12_sigalgs);
4141 OPENSSL_free(a->client_cert_type);
4142 OPENSSL_free(a->server_cert_type);
4144 CRYPTO_THREAD_lock_free(a->lock);
4145 #ifdef TSAN_REQUIRES_LOCKING
4146 CRYPTO_THREAD_lock_free(a->tsan_lock);
4149 OPENSSL_free(a->propq);
4154 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
4156 ctx->default_passwd_callback = cb;
4159 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
4161 ctx->default_passwd_callback_userdata = u;
4164 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
4166 return ctx->default_passwd_callback;
4169 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
4171 return ctx->default_passwd_callback_userdata;
4174 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
4176 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
4181 sc->default_passwd_callback = cb;
4184 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
4186 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
4191 sc->default_passwd_callback_userdata = u;
4194 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
4196 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
4201 return sc->default_passwd_callback;
4204 void *SSL_get_default_passwd_cb_userdata(SSL *s)
4206 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
4211 return sc->default_passwd_callback_userdata;
4214 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
4215 int (*cb) (X509_STORE_CTX *, void *),
4218 ctx->app_verify_callback = cb;
4219 ctx->app_verify_arg = arg;
4222 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
4223 int (*cb) (int, X509_STORE_CTX *))
4225 ctx->verify_mode = mode;
4226 ctx->default_verify_callback = cb;
4229 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
4231 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
4234 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
4236 ssl_cert_set_cert_cb(c->cert, cb, arg);
4239 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
4241 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
4246 ssl_cert_set_cert_cb(sc->cert, cb, arg);
4249 void ssl_set_masks(SSL_CONNECTION *s)
4252 uint32_t *pvalid = s->s3.tmp.valid_flags;
4253 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
4254 unsigned long mask_k, mask_a;
4255 int have_ecc_cert, ecdsa_ok;
4260 dh_tmp = (c->dh_tmp != NULL
4261 || c->dh_tmp_cb != NULL
4264 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
4265 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
4266 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
4267 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
4271 OSSL_TRACE4(TLS_CIPHER, "dh_tmp=%d rsa_enc=%d rsa_sign=%d dsa_sign=%d\n",
4272 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
4274 #ifndef OPENSSL_NO_GOST
4275 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
4276 mask_k |= SSL_kGOST | SSL_kGOST18;
4277 mask_a |= SSL_aGOST12;
4279 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
4280 mask_k |= SSL_kGOST | SSL_kGOST18;
4281 mask_a |= SSL_aGOST12;
4283 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
4284 mask_k |= SSL_kGOST;
4285 mask_a |= SSL_aGOST01;
4296 * If we only have an RSA-PSS certificate allow RSA authentication
4297 * if TLS 1.2 and peer supports it.
4300 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
4301 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
4302 && TLS1_get_version(&s->ssl) == TLS1_2_VERSION))
4309 mask_a |= SSL_aNULL;
4312 * You can do anything with an RPK key, since there's no cert to restrict it
4313 * But we need to check for private keys
4315 if (pvalid[SSL_PKEY_RSA] & CERT_PKEY_RPK) {
4319 if (pvalid[SSL_PKEY_ECC] & CERT_PKEY_RPK)
4320 mask_a |= SSL_aECDSA;
4321 if (TLS1_get_version(&s->ssl) == TLS1_2_VERSION) {
4322 if (pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_RPK)
4324 if (pvalid[SSL_PKEY_ED25519] & CERT_PKEY_RPK
4325 || pvalid[SSL_PKEY_ED448] & CERT_PKEY_RPK)
4326 mask_a |= SSL_aECDSA;
4330 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
4331 * depending on the key usage extension.
4333 if (have_ecc_cert) {
4335 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
4336 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
4337 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
4340 mask_a |= SSL_aECDSA;
4342 /* Allow Ed25519 for TLS 1.2 if peer supports it */
4343 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
4344 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
4345 && TLS1_get_version(&s->ssl) == TLS1_2_VERSION)
4346 mask_a |= SSL_aECDSA;
4348 /* Allow Ed448 for TLS 1.2 if peer supports it */
4349 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
4350 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
4351 && TLS1_get_version(&s->ssl) == TLS1_2_VERSION)
4352 mask_a |= SSL_aECDSA;
4354 mask_k |= SSL_kECDHE;
4356 #ifndef OPENSSL_NO_PSK
4359 if (mask_k & SSL_kRSA)
4360 mask_k |= SSL_kRSAPSK;
4361 if (mask_k & SSL_kDHE)
4362 mask_k |= SSL_kDHEPSK;
4363 if (mask_k & SSL_kECDHE)
4364 mask_k |= SSL_kECDHEPSK;
4367 s->s3.tmp.mask_k = mask_k;
4368 s->s3.tmp.mask_a = mask_a;
4371 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL_CONNECTION *s)
4373 if (s->s3.tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
4374 /* key usage, if present, must allow signing */
4375 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
4376 ERR_raise(ERR_LIB_SSL, SSL_R_ECC_CERT_NOT_FOR_SIGNING);
4380 return 1; /* all checks are ok */
4383 int ssl_get_server_cert_serverinfo(SSL_CONNECTION *s,
4384 const unsigned char **serverinfo,
4385 size_t *serverinfo_length)
4387 CERT_PKEY *cpk = s->s3.tmp.cert;
4388 *serverinfo_length = 0;
4390 if (cpk == NULL || cpk->serverinfo == NULL)
4393 *serverinfo = cpk->serverinfo;
4394 *serverinfo_length = cpk->serverinfo_length;
4398 void ssl_update_cache(SSL_CONNECTION *s, int mode)
4403 * If the session_id_length is 0, we are not supposed to cache it, and it
4404 * would be rather hard to do anyway :-)
4406 if (s->session->session_id_length == 0)
4410 * If sid_ctx_length is 0 there is no specific application context
4411 * associated with this session, so when we try to resume it and
4412 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
4413 * indication that this is actually a session for the proper application
4414 * context, and the *handshake* will fail, not just the resumption attempt.
4415 * Do not cache (on the server) these sessions that are not resumable
4416 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
4418 if (s->server && s->session->sid_ctx_length == 0
4419 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
4422 i = s->session_ctx->session_cache_mode;
4424 && (!s->hit || SSL_CONNECTION_IS_TLS13(s))) {
4426 * Add the session to the internal cache. In server side TLSv1.3 we
4427 * normally don't do this because by default it's a full stateless ticket
4428 * with only a dummy session id so there is no reason to cache it,
4430 * - we are doing early_data, in which case we cache so that we can
4432 * - the application has set a remove_session_cb so needs to know about
4433 * session timeout events
4434 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
4436 if ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0
4437 && (!SSL_CONNECTION_IS_TLS13(s)
4439 || (s->max_early_data > 0
4440 && (s->options & SSL_OP_NO_ANTI_REPLAY) == 0)
4441 || s->session_ctx->remove_session_cb != NULL
4442 || (s->options & SSL_OP_NO_TICKET) != 0))
4443 SSL_CTX_add_session(s->session_ctx, s->session);
4446 * Add the session to the external cache. We do this even in server side
4447 * TLSv1.3 without early data because some applications just want to
4448 * know about the creation of a session and aren't doing a full cache.
4450 if (s->session_ctx->new_session_cb != NULL) {
4451 SSL_SESSION_up_ref(s->session);
4452 if (!s->session_ctx->new_session_cb(SSL_CONNECTION_GET_SSL(s),
4454 SSL_SESSION_free(s->session);
4458 /* auto flush every 255 connections */
4459 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
4460 TSAN_QUALIFIER int *stat;
4462 if (mode & SSL_SESS_CACHE_CLIENT)
4463 stat = &s->session_ctx->stats.sess_connect_good;
4465 stat = &s->session_ctx->stats.sess_accept_good;
4466 if ((ssl_tsan_load(s->session_ctx, stat) & 0xff) == 0xff)
4467 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
4471 const SSL_METHOD *SSL_CTX_get_ssl_method(const SSL_CTX *ctx)
4476 const SSL_METHOD *SSL_get_ssl_method(const SSL *s)
4481 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
4484 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
4486 /* TODO(QUIC): Do we want this for QUIC? */
4488 || (s->type != SSL_TYPE_SSL_CONNECTION && s->method != meth))
4491 if (s->method != meth) {
4492 const SSL_METHOD *sm = s->method;
4493 int (*hf) (SSL *) = sc->handshake_func;
4495 if (sm->version == meth->version)
4500 ret = s->method->ssl_init(s);
4503 if (hf == sm->ssl_connect)
4504 sc->handshake_func = meth->ssl_connect;
4505 else if (hf == sm->ssl_accept)
4506 sc->handshake_func = meth->ssl_accept;
4511 int SSL_get_error(const SSL *s, int i)
4516 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
4519 return SSL_ERROR_NONE;
4521 #ifndef OPENSSL_NO_QUIC
4523 reason = ossl_quic_get_error(s, i);
4524 if (reason != SSL_ERROR_NONE)
4530 return SSL_ERROR_SSL;
4533 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
4534 * where we do encode the error
4536 if ((l = ERR_peek_error()) != 0) {
4537 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
4538 return SSL_ERROR_SYSCALL;
4540 return SSL_ERROR_SSL;
4543 #ifndef OPENSSL_NO_QUIC
4547 if (SSL_want_read(s)) {
4548 bio = SSL_get_rbio(s);
4549 if (BIO_should_read(bio))
4550 return SSL_ERROR_WANT_READ;
4551 else if (BIO_should_write(bio))
4553 * This one doesn't make too much sense ... We never try to
4554 * write to the rbio, and an application program where rbio and
4555 * wbio are separate couldn't even know what it should wait for.
4556 * However if we ever set s->rwstate incorrectly (so that we
4557 * have SSL_want_read(s) instead of SSL_want_write(s)) and rbio
4558 * and wbio *are* the same, this test works around that bug; so
4559 * it might be safer to keep it.
4561 return SSL_ERROR_WANT_WRITE;
4562 else if (BIO_should_io_special(bio)) {
4563 reason = BIO_get_retry_reason(bio);
4564 if (reason == BIO_RR_CONNECT)
4565 return SSL_ERROR_WANT_CONNECT;
4566 else if (reason == BIO_RR_ACCEPT)
4567 return SSL_ERROR_WANT_ACCEPT;
4569 return SSL_ERROR_SYSCALL; /* unknown */
4573 if (SSL_want_write(s)) {
4575 * Access wbio directly - in order to use the buffered bio if
4579 if (BIO_should_write(bio))
4580 return SSL_ERROR_WANT_WRITE;
4581 else if (BIO_should_read(bio))
4583 * See above (SSL_want_read(s) with BIO_should_write(bio))
4585 return SSL_ERROR_WANT_READ;
4586 else if (BIO_should_io_special(bio)) {
4587 reason = BIO_get_retry_reason(bio);
4588 if (reason == BIO_RR_CONNECT)
4589 return SSL_ERROR_WANT_CONNECT;
4590 else if (reason == BIO_RR_ACCEPT)
4591 return SSL_ERROR_WANT_ACCEPT;
4593 return SSL_ERROR_SYSCALL;
4598 if (SSL_want_x509_lookup(s))
4599 return SSL_ERROR_WANT_X509_LOOKUP;
4600 if (SSL_want_retry_verify(s))
4601 return SSL_ERROR_WANT_RETRY_VERIFY;
4602 if (SSL_want_async(s))
4603 return SSL_ERROR_WANT_ASYNC;
4604 if (SSL_want_async_job(s))
4605 return SSL_ERROR_WANT_ASYNC_JOB;
4606 if (SSL_want_client_hello_cb(s))
4607 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
4609 if ((sc->shutdown & SSL_RECEIVED_SHUTDOWN) &&
4610 (sc->s3.warn_alert == SSL_AD_CLOSE_NOTIFY))
4611 return SSL_ERROR_ZERO_RETURN;
4613 return SSL_ERROR_SYSCALL;
4616 static int ssl_do_handshake_intern(void *vargs)
4618 struct ssl_async_args *args = (struct ssl_async_args *)vargs;
4620 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
4625 return sc->handshake_func(s);
4628 int SSL_do_handshake(SSL *s)
4631 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
4633 #ifndef OPENSSL_NO_QUIC
4635 return ossl_quic_do_handshake(s);
4638 if (sc->handshake_func == NULL) {
4639 ERR_raise(ERR_LIB_SSL, SSL_R_CONNECTION_TYPE_NOT_SET);
4643 ossl_statem_check_finish_init(sc, -1);
4645 s->method->ssl_renegotiate_check(s, 0);
4647 if (SSL_in_init(s) || SSL_in_before(s)) {
4648 if ((sc->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
4649 struct ssl_async_args args;
4651 memset(&args, 0, sizeof(args));
4654 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
4656 ret = sc->handshake_func(s);
4662 void SSL_set_accept_state(SSL *s)
4664 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
4666 #ifndef OPENSSL_NO_QUIC
4668 ossl_quic_set_accept_state(s);
4675 ossl_statem_clear(sc);
4676 sc->handshake_func = s->method->ssl_accept;
4677 /* Ignore return value. Its a void public API function */
4678 clear_record_layer(sc);
4681 void SSL_set_connect_state(SSL *s)
4683 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
4685 #ifndef OPENSSL_NO_QUIC
4687 ossl_quic_set_connect_state(s);
4694 ossl_statem_clear(sc);
4695 sc->handshake_func = s->method->ssl_connect;
4696 /* Ignore return value. Its a void public API function */
4697 clear_record_layer(sc);
4700 int ssl_undefined_function(SSL *s)
4702 ERR_raise(ERR_LIB_SSL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
4706 int ssl_undefined_void_function(void)
4708 ERR_raise(ERR_LIB_SSL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
4712 int ssl_undefined_const_function(const SSL *s)
4717 const SSL_METHOD *ssl_bad_method(int ver)
4719 ERR_raise(ERR_LIB_SSL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
4723 const char *ssl_protocol_to_string(int version)
4727 case TLS1_3_VERSION:
4730 case TLS1_2_VERSION:
4733 case TLS1_1_VERSION:
4748 case DTLS1_2_VERSION:
4756 const char *SSL_get_version(const SSL *s)
4758 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
4760 #ifndef OPENSSL_NO_QUIC
4761 /* We only support QUICv1 - so if its QUIC its QUICv1 */
4762 if (s->type == SSL_TYPE_QUIC_CONNECTION || s->type == SSL_TYPE_QUIC_XSO)
4769 return ssl_protocol_to_string(sc->version);
4772 static int dup_ca_names(STACK_OF(X509_NAME) **dst, STACK_OF(X509_NAME) *src)
4774 STACK_OF(X509_NAME) *sk;
4783 if ((sk = sk_X509_NAME_new_null()) == NULL)
4785 for (i = 0; i < sk_X509_NAME_num(src); i++) {
4786 xn = X509_NAME_dup(sk_X509_NAME_value(src, i));
4788 sk_X509_NAME_pop_free(sk, X509_NAME_free);
4791 if (sk_X509_NAME_insert(sk, xn, i) == 0) {
4793 sk_X509_NAME_pop_free(sk, X509_NAME_free);
4802 SSL *SSL_dup(SSL *s)
4806 /* TODO(QUIC): Add a SSL_METHOD function for duplication */
4807 SSL_CONNECTION *retsc;
4808 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
4813 /* If we're not quiescent, just up_ref! */
4814 if (!SSL_in_init(s) || !SSL_in_before(s)) {
4815 CRYPTO_UP_REF(&s->references, &i, s->lock);
4820 * Otherwise, copy configuration state, and session if set.
4822 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
4824 if ((retsc = SSL_CONNECTION_FROM_SSL_ONLY(ret)) == NULL)
4827 if (sc->session != NULL) {
4829 * Arranges to share the same session via up_ref. This "copies"
4830 * session-id, SSL_METHOD, sid_ctx, and 'cert'
4832 if (!SSL_copy_session_id(ret, s))
4836 * No session has been established yet, so we have to expect that
4837 * s->cert or ret->cert will be changed later -- they should not both
4838 * point to the same object, and thus we can't use
4839 * SSL_copy_session_id.
4841 if (!SSL_set_ssl_method(ret, s->method))
4844 if (sc->cert != NULL) {
4845 ssl_cert_free(retsc->cert);
4846 retsc->cert = ssl_cert_dup(sc->cert);
4847 if (retsc->cert == NULL)
4851 if (!SSL_set_session_id_context(ret, sc->sid_ctx,
4852 (int)sc->sid_ctx_length))
4856 if (!ssl_dane_dup(retsc, sc))
4858 retsc->version = sc->version;
4859 retsc->options = sc->options;
4860 retsc->min_proto_version = sc->min_proto_version;
4861 retsc->max_proto_version = sc->max_proto_version;
4862 retsc->mode = sc->mode;
4863 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
4864 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
4865 retsc->msg_callback = sc->msg_callback;
4866 retsc->msg_callback_arg = sc->msg_callback_arg;
4867 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
4868 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
4869 retsc->generate_session_id = sc->generate_session_id;
4871 SSL_set_info_callback(ret, SSL_get_info_callback(s));
4873 /* copy app data, a little dangerous perhaps */
4874 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
4877 retsc->server = sc->server;
4878 if (sc->handshake_func) {
4880 SSL_set_accept_state(ret);
4882 SSL_set_connect_state(ret);
4884 retsc->shutdown = sc->shutdown;
4885 retsc->hit = sc->hit;
4887 retsc->default_passwd_callback = sc->default_passwd_callback;
4888 retsc->default_passwd_callback_userdata = sc->default_passwd_callback_userdata;
4890 X509_VERIFY_PARAM_inherit(retsc->param, sc->param);
4892 /* dup the cipher_list and cipher_list_by_id stacks */
4893 if (sc->cipher_list != NULL) {
4894 if ((retsc->cipher_list = sk_SSL_CIPHER_dup(sc->cipher_list)) == NULL)
4897 if (sc->cipher_list_by_id != NULL)
4898 if ((retsc->cipher_list_by_id = sk_SSL_CIPHER_dup(sc->cipher_list_by_id))
4902 /* Dup the client_CA list */
4903 if (!dup_ca_names(&retsc->ca_names, sc->ca_names)
4904 || !dup_ca_names(&retsc->client_ca_names, sc->client_ca_names))
4914 X509 *SSL_get_certificate(const SSL *s)
4916 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
4921 if (sc->cert != NULL)
4922 return sc->cert->key->x509;
4927 EVP_PKEY *SSL_get_privatekey(const SSL *s)
4929 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
4934 if (sc->cert != NULL)
4935 return sc->cert->key->privatekey;
4940 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
4942 if (ctx->cert != NULL)
4943 return ctx->cert->key->x509;
4948 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
4950 if (ctx->cert != NULL)
4951 return ctx->cert->key->privatekey;
4956 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
4958 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
4963 if ((sc->session != NULL) && (sc->session->cipher != NULL))
4964 return sc->session->cipher;
4968 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
4970 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
4975 return sc->s3.tmp.new_cipher;
4978 const COMP_METHOD *SSL_get_current_compression(const SSL *s)
4980 #ifndef OPENSSL_NO_COMP
4981 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL_ONLY(s);
4986 return sc->rlayer.wrlmethod->get_compression(sc->rlayer.wrl);
4992 const COMP_METHOD *SSL_get_current_expansion(const SSL *s)
4994 #ifndef OPENSSL_NO_COMP
4995 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL_ONLY(s);
5000 return sc->rlayer.rrlmethod->get_compression(sc->rlayer.rrl);
5006 int ssl_init_wbio_buffer(SSL_CONNECTION *s)
5010 if (s->bbio != NULL) {
5011 /* Already buffered. */
5015 bbio = BIO_new(BIO_f_buffer());
5016 if (bbio == NULL || BIO_set_read_buffer_size(bbio, 1) <= 0) {
5018 ERR_raise(ERR_LIB_SSL, ERR_R_BUF_LIB);
5022 s->wbio = BIO_push(bbio, s->wbio);
5024 s->rlayer.wrlmethod->set1_bio(s->rlayer.wrl, s->wbio);
5029 int ssl_free_wbio_buffer(SSL_CONNECTION *s)
5031 /* callers ensure s is never null */
5032 if (s->bbio == NULL)
5035 s->wbio = BIO_pop(s->wbio);
5036 s->rlayer.wrlmethod->set1_bio(s->rlayer.wrl, s->wbio);
5044 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
5046 ctx->quiet_shutdown = mode;
5049 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
5051 return ctx->quiet_shutdown;
5054 void SSL_set_quiet_shutdown(SSL *s, int mode)
5056 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
5058 /* TODO(QUIC): Do we want this for QUIC? */
5062 sc->quiet_shutdown = mode;
5065 int SSL_get_quiet_shutdown(const SSL *s)
5067 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL_ONLY(s);
5069 /* TODO(QUIC): Do we want this for QUIC? */
5073 return sc->quiet_shutdown;
5076 void SSL_set_shutdown(SSL *s, int mode)
5078 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
5080 /* TODO(QUIC): Do we want this for QUIC? */
5084 sc->shutdown = mode;
5087 int SSL_get_shutdown(const SSL *s)
5089 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL_ONLY(s);
5091 /* TODO(QUIC): Do we want this for QUIC? */
5095 return sc->shutdown;
5098 int SSL_version(const SSL *s)
5100 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5102 #ifndef OPENSSL_NO_QUIC
5103 /* We only support QUICv1 - so if its QUIC its QUICv1 */
5104 if (s->type == SSL_TYPE_QUIC_CONNECTION || s->type == SSL_TYPE_QUIC_XSO)
5105 return OSSL_QUIC1_VERSION;
5107 /* TODO(QUIC): Do we want to report QUIC version this way instead? */
5114 int SSL_client_version(const SSL *s)
5116 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5118 /* TODO(QUIC): Do we want to report QUIC version this way instead? */
5122 return sc->client_version;
5125 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
5130 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
5133 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(ssl);
5135 /* TODO(QUIC): Do we need this for QUIC support? */
5139 if (ssl->ctx == ctx)
5142 ctx = sc->session_ctx;
5143 new_cert = ssl_cert_dup(ctx->cert);
5144 if (new_cert == NULL) {
5148 if (!custom_exts_copy_flags(&new_cert->custext, &sc->cert->custext)) {
5149 ssl_cert_free(new_cert);
5153 ssl_cert_free(sc->cert);
5154 sc->cert = new_cert;
5157 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
5158 * so setter APIs must prevent invalid lengths from entering the system.
5160 if (!ossl_assert(sc->sid_ctx_length <= sizeof(sc->sid_ctx)))
5164 * If the session ID context matches that of the parent SSL_CTX,
5165 * inherit it from the new SSL_CTX as well. If however the context does
5166 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
5167 * leave it unchanged.
5169 if ((ssl->ctx != NULL) &&
5170 (sc->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
5171 (memcmp(sc->sid_ctx, ssl->ctx->sid_ctx, sc->sid_ctx_length) == 0)) {
5172 sc->sid_ctx_length = ctx->sid_ctx_length;
5173 memcpy(&sc->sid_ctx, &ctx->sid_ctx, sizeof(sc->sid_ctx));
5176 SSL_CTX_up_ref(ctx);
5177 SSL_CTX_free(ssl->ctx); /* decrement reference count */
5183 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
5185 return X509_STORE_set_default_paths_ex(ctx->cert_store, ctx->libctx,
5189 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
5191 X509_LOOKUP *lookup;
5193 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
5197 /* We ignore errors, in case the directory doesn't exist */
5200 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
5207 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
5209 X509_LOOKUP *lookup;
5211 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
5215 /* We ignore errors, in case the file doesn't exist */
5218 X509_LOOKUP_load_file_ex(lookup, NULL, X509_FILETYPE_DEFAULT, ctx->libctx,
5226 int SSL_CTX_set_default_verify_store(SSL_CTX *ctx)
5228 X509_LOOKUP *lookup;
5230 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_store());
5234 /* We ignore errors, in case the directory doesn't exist */
5237 X509_LOOKUP_add_store_ex(lookup, NULL, ctx->libctx, ctx->propq);
5244 int SSL_CTX_load_verify_file(SSL_CTX *ctx, const char *CAfile)
5246 return X509_STORE_load_file_ex(ctx->cert_store, CAfile, ctx->libctx,
5250 int SSL_CTX_load_verify_dir(SSL_CTX *ctx, const char *CApath)
5252 return X509_STORE_load_path(ctx->cert_store, CApath);
5255 int SSL_CTX_load_verify_store(SSL_CTX *ctx, const char *CAstore)
5257 return X509_STORE_load_store_ex(ctx->cert_store, CAstore, ctx->libctx,
5261 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
5264 if (CAfile == NULL && CApath == NULL)
5266 if (CAfile != NULL && !SSL_CTX_load_verify_file(ctx, CAfile))
5268 if (CApath != NULL && !SSL_CTX_load_verify_dir(ctx, CApath))
5273 void SSL_set_info_callback(SSL *ssl,
5274 void (*cb) (const SSL *ssl, int type, int val))
5276 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
5281 sc->info_callback = cb;
5285 * One compiler (Diab DCC) doesn't like argument names in returned function
5288 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
5291 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(ssl);
5296 return sc->info_callback;
5299 void SSL_set_verify_result(SSL *ssl, long arg)
5301 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
5306 sc->verify_result = arg;
5309 long SSL_get_verify_result(const SSL *ssl)
5311 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(ssl);
5316 return sc->verify_result;
5319 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
5321 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(ssl);
5327 return sizeof(sc->s3.client_random);
5328 if (outlen > sizeof(sc->s3.client_random))
5329 outlen = sizeof(sc->s3.client_random);
5330 memcpy(out, sc->s3.client_random, outlen);
5334 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
5336 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(ssl);
5342 return sizeof(sc->s3.server_random);
5343 if (outlen > sizeof(sc->s3.server_random))
5344 outlen = sizeof(sc->s3.server_random);
5345 memcpy(out, sc->s3.server_random, outlen);
5349 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
5350 unsigned char *out, size_t outlen)
5353 return session->master_key_length;
5354 if (outlen > session->master_key_length)
5355 outlen = session->master_key_length;
5356 memcpy(out, session->master_key, outlen);
5360 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
5363 if (len > sizeof(sess->master_key))
5366 memcpy(sess->master_key, in, len);
5367 sess->master_key_length = len;
5372 int SSL_set_ex_data(SSL *s, int idx, void *arg)
5374 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
5377 void *SSL_get_ex_data(const SSL *s, int idx)
5379 return CRYPTO_get_ex_data(&s->ex_data, idx);
5382 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
5384 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
5387 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
5389 return CRYPTO_get_ex_data(&s->ex_data, idx);
5392 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
5394 return ctx->cert_store;
5397 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
5399 X509_STORE_free(ctx->cert_store);
5400 ctx->cert_store = store;
5403 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
5406 X509_STORE_up_ref(store);
5407 SSL_CTX_set_cert_store(ctx, store);
5410 int SSL_want(const SSL *s)
5412 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5420 #ifndef OPENSSL_NO_PSK
5421 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
5423 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
5424 ERR_raise(ERR_LIB_SSL, SSL_R_DATA_LENGTH_TOO_LONG);
5427 OPENSSL_free(ctx->cert->psk_identity_hint);
5428 if (identity_hint != NULL) {
5429 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
5430 if (ctx->cert->psk_identity_hint == NULL)
5433 ctx->cert->psk_identity_hint = NULL;
5437 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
5439 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5444 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
5445 ERR_raise(ERR_LIB_SSL, SSL_R_DATA_LENGTH_TOO_LONG);
5448 OPENSSL_free(sc->cert->psk_identity_hint);
5449 if (identity_hint != NULL) {
5450 sc->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
5451 if (sc->cert->psk_identity_hint == NULL)
5454 sc->cert->psk_identity_hint = NULL;
5458 const char *SSL_get_psk_identity_hint(const SSL *s)
5460 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5462 if (sc == NULL || sc->session == NULL)
5465 return sc->session->psk_identity_hint;
5468 const char *SSL_get_psk_identity(const SSL *s)
5470 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5472 if (sc == NULL || sc->session == NULL)
5475 return sc->session->psk_identity;
5478 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
5480 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5485 sc->psk_client_callback = cb;
5488 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
5490 ctx->psk_client_callback = cb;
5493 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
5495 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5500 sc->psk_server_callback = cb;
5503 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
5505 ctx->psk_server_callback = cb;
5509 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
5511 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5516 sc->psk_find_session_cb = cb;
5519 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
5520 SSL_psk_find_session_cb_func cb)
5522 ctx->psk_find_session_cb = cb;
5525 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
5527 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5532 sc->psk_use_session_cb = cb;
5535 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
5536 SSL_psk_use_session_cb_func cb)
5538 ctx->psk_use_session_cb = cb;
5541 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
5542 void (*cb) (int write_p, int version,
5543 int content_type, const void *buf,
5544 size_t len, SSL *ssl, void *arg))
5546 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
5549 void SSL_set_msg_callback(SSL *ssl,
5550 void (*cb) (int write_p, int version,
5551 int content_type, const void *buf,
5552 size_t len, SSL *ssl, void *arg))
5554 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
5557 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
5558 int (*cb) (SSL *ssl,
5562 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
5563 (void (*)(void))cb);
5566 void SSL_set_not_resumable_session_callback(SSL *ssl,
5567 int (*cb) (SSL *ssl,
5568 int is_forward_secure))
5570 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
5571 (void (*)(void))cb);
5574 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
5575 size_t (*cb) (SSL *ssl, int type,
5576 size_t len, void *arg))
5578 ctx->record_padding_cb = cb;
5581 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
5583 ctx->record_padding_arg = arg;
5586 void *SSL_CTX_get_record_padding_callback_arg(const SSL_CTX *ctx)
5588 return ctx->record_padding_arg;
5591 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
5593 /* block size of 0 or 1 is basically no padding */
5594 if (block_size == 1)
5595 ctx->block_padding = 0;
5596 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
5597 ctx->block_padding = block_size;
5603 int SSL_set_record_padding_callback(SSL *ssl,
5604 size_t (*cb) (SSL *ssl, int type,
5605 size_t len, void *arg))
5608 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
5613 b = SSL_get_wbio(ssl);
5614 if (b == NULL || !BIO_get_ktls_send(b)) {
5615 sc->rlayer.record_padding_cb = cb;
5621 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
5623 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
5628 sc->rlayer.record_padding_arg = arg;
5631 void *SSL_get_record_padding_callback_arg(const SSL *ssl)
5633 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(ssl);
5638 return sc->rlayer.record_padding_arg;
5641 int SSL_set_block_padding(SSL *ssl, size_t block_size)
5643 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
5648 /* block size of 0 or 1 is basically no padding */
5649 if (block_size == 1)
5650 sc->rlayer.block_padding = 0;
5651 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
5652 sc->rlayer.block_padding = block_size;
5658 int SSL_set_num_tickets(SSL *s, size_t num_tickets)
5660 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5665 sc->num_tickets = num_tickets;
5670 size_t SSL_get_num_tickets(const SSL *s)
5672 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5677 return sc->num_tickets;
5680 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets)
5682 ctx->num_tickets = num_tickets;
5687 size_t SSL_CTX_get_num_tickets(const SSL_CTX *ctx)
5689 return ctx->num_tickets;
5692 /* Retrieve handshake hashes */
5693 int ssl_handshake_hash(SSL_CONNECTION *s,
5694 unsigned char *out, size_t outlen,
5697 EVP_MD_CTX *ctx = NULL;
5698 EVP_MD_CTX *hdgst = s->s3.handshake_dgst;
5699 int hashleni = EVP_MD_CTX_get_size(hdgst);
5702 if (hashleni < 0 || (size_t)hashleni > outlen) {
5703 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
5707 ctx = EVP_MD_CTX_new();
5709 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
5713 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
5714 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
5715 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
5719 *hashlen = hashleni;
5723 EVP_MD_CTX_free(ctx);
5727 int SSL_session_reused(const SSL *s)
5729 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5737 int SSL_is_server(const SSL *s)
5739 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5747 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
5748 void SSL_set_debug(SSL *s, int debug)
5750 /* Old function was do-nothing anyway... */
5756 void SSL_set_security_level(SSL *s, int level)
5758 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5763 sc->cert->sec_level = level;
5766 int SSL_get_security_level(const SSL *s)
5768 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5773 return sc->cert->sec_level;
5776 void SSL_set_security_callback(SSL *s,
5777 int (*cb) (const SSL *s, const SSL_CTX *ctx,
5778 int op, int bits, int nid,
5779 void *other, void *ex))
5781 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5786 sc->cert->sec_cb = cb;
5789 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
5790 const SSL_CTX *ctx, int op,
5791 int bits, int nid, void *other,
5793 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5798 return sc->cert->sec_cb;
5801 void SSL_set0_security_ex_data(SSL *s, void *ex)
5803 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5808 sc->cert->sec_ex = ex;
5811 void *SSL_get0_security_ex_data(const SSL *s)
5813 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5818 return sc->cert->sec_ex;
5821 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
5823 ctx->cert->sec_level = level;
5826 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
5828 return ctx->cert->sec_level;
5831 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
5832 int (*cb) (const SSL *s, const SSL_CTX *ctx,
5833 int op, int bits, int nid,
5834 void *other, void *ex))
5836 ctx->cert->sec_cb = cb;
5839 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
5845 return ctx->cert->sec_cb;
5848 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
5850 ctx->cert->sec_ex = ex;
5853 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
5855 return ctx->cert->sec_ex;
5858 uint64_t SSL_CTX_get_options(const SSL_CTX *ctx)
5860 return ctx->options;
5863 uint64_t SSL_get_options(const SSL *s)
5865 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5873 uint64_t SSL_CTX_set_options(SSL_CTX *ctx, uint64_t op)
5875 return ctx->options |= op;
5878 uint64_t SSL_set_options(SSL *s, uint64_t op)
5880 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5881 OSSL_PARAM options[2], *opts = options;
5888 *opts++ = OSSL_PARAM_construct_uint64(OSSL_LIBSSL_RECORD_LAYER_PARAM_OPTIONS,
5890 *opts = OSSL_PARAM_construct_end();
5892 /* Ignore return value */
5893 sc->rlayer.rrlmethod->set_options(sc->rlayer.rrl, options);
5898 uint64_t SSL_CTX_clear_options(SSL_CTX *ctx, uint64_t op)
5900 return ctx->options &= ~op;
5903 uint64_t SSL_clear_options(SSL *s, uint64_t op)
5905 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
5910 return sc->options &= ~op;
5913 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
5915 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
5920 return sc->verified_chain;
5923 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
5925 #ifndef OPENSSL_NO_CT
5928 * Moves SCTs from the |src| stack to the |dst| stack.
5929 * The source of each SCT will be set to |origin|.
5930 * If |dst| points to a NULL pointer, a new stack will be created and owned by
5932 * Returns the number of SCTs moved, or a negative integer if an error occurs.
5934 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
5935 sct_source_t origin)
5941 *dst = sk_SCT_new_null();
5943 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
5948 while ((sct = sk_SCT_pop(src)) != NULL) {
5949 if (SCT_set_source(sct, origin) != 1)
5952 if (sk_SCT_push(*dst, sct) <= 0)
5960 sk_SCT_push(src, sct); /* Put the SCT back */
5965 * Look for data collected during ServerHello and parse if found.
5966 * Returns the number of SCTs extracted.
5968 static int ct_extract_tls_extension_scts(SSL_CONNECTION *s)
5970 int scts_extracted = 0;
5972 if (s->ext.scts != NULL) {
5973 const unsigned char *p = s->ext.scts;
5974 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
5976 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
5978 SCT_LIST_free(scts);
5981 return scts_extracted;
5985 * Checks for an OCSP response and then attempts to extract any SCTs found if it
5986 * contains an SCT X509 extension. They will be stored in |s->scts|.
5988 * - The number of SCTs extracted, assuming an OCSP response exists.
5989 * - 0 if no OCSP response exists or it contains no SCTs.
5990 * - A negative integer if an error occurs.
5992 static int ct_extract_ocsp_response_scts(SSL_CONNECTION *s)
5994 # ifndef OPENSSL_NO_OCSP
5995 int scts_extracted = 0;
5996 const unsigned char *p;
5997 OCSP_BASICRESP *br = NULL;
5998 OCSP_RESPONSE *rsp = NULL;
5999 STACK_OF(SCT) *scts = NULL;
6002 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
6005 p = s->ext.ocsp.resp;
6006 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
6010 br = OCSP_response_get1_basic(rsp);
6014 for (i = 0; i < OCSP_resp_count(br); ++i) {
6015 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
6021 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
6023 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
6024 if (scts_extracted < 0)
6028 SCT_LIST_free(scts);
6029 OCSP_BASICRESP_free(br);
6030 OCSP_RESPONSE_free(rsp);
6031 return scts_extracted;
6033 /* Behave as if no OCSP response exists */
6039 * Attempts to extract SCTs from the peer certificate.
6040 * Return the number of SCTs extracted, or a negative integer if an error
6043 static int ct_extract_x509v3_extension_scts(SSL_CONNECTION *s)
6045 int scts_extracted = 0;
6046 X509 *cert = s->session != NULL ? s->session->peer : NULL;
6049 STACK_OF(SCT) *scts =
6050 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
6053 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
6055 SCT_LIST_free(scts);
6058 return scts_extracted;
6062 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
6063 * response (if it exists) and X509v3 extensions in the certificate.
6064 * Returns NULL if an error occurs.
6066 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
6068 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6073 if (!sc->scts_parsed) {
6074 if (ct_extract_tls_extension_scts(sc) < 0 ||
6075 ct_extract_ocsp_response_scts(sc) < 0 ||
6076 ct_extract_x509v3_extension_scts(sc) < 0)
6079 sc->scts_parsed = 1;
6086 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
6087 const STACK_OF(SCT) *scts, void *unused_arg)
6092 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
6093 const STACK_OF(SCT) *scts, void *unused_arg)
6095 int count = scts != NULL ? sk_SCT_num(scts) : 0;
6098 for (i = 0; i < count; ++i) {
6099 SCT *sct = sk_SCT_value(scts, i);
6100 int status = SCT_get_validation_status(sct);
6102 if (status == SCT_VALIDATION_STATUS_VALID)
6105 ERR_raise(ERR_LIB_SSL, SSL_R_NO_VALID_SCTS);
6109 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
6112 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6118 * Since code exists that uses the custom extension handler for CT, look
6119 * for this and throw an error if they have already registered to use CT.
6121 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
6122 TLSEXT_TYPE_signed_certificate_timestamp))
6124 ERR_raise(ERR_LIB_SSL, SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
6128 if (callback != NULL) {
6130 * If we are validating CT, then we MUST accept SCTs served via OCSP
6132 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
6136 sc->ct_validation_callback = callback;
6137 sc->ct_validation_callback_arg = arg;
6142 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
6143 ssl_ct_validation_cb callback, void *arg)
6146 * Since code exists that uses the custom extension handler for CT, look for
6147 * this and throw an error if they have already registered to use CT.
6149 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
6150 TLSEXT_TYPE_signed_certificate_timestamp))
6152 ERR_raise(ERR_LIB_SSL, SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
6156 ctx->ct_validation_callback = callback;
6157 ctx->ct_validation_callback_arg = arg;
6161 int SSL_ct_is_enabled(const SSL *s)
6163 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
6168 return sc->ct_validation_callback != NULL;
6171 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
6173 return ctx->ct_validation_callback != NULL;
6176 int ssl_validate_ct(SSL_CONNECTION *s)
6179 X509 *cert = s->session != NULL ? s->session->peer : NULL;
6181 SSL_DANE *dane = &s->dane;
6182 CT_POLICY_EVAL_CTX *ctx = NULL;
6183 const STACK_OF(SCT) *scts;
6186 * If no callback is set, the peer is anonymous, or its chain is invalid,
6187 * skip SCT validation - just return success. Applications that continue
6188 * handshakes without certificates, with unverified chains, or pinned leaf
6189 * certificates are outside the scope of the WebPKI and CT.
6191 * The above exclusions notwithstanding the vast majority of peers will
6192 * have rather ordinary certificate chains validated by typical
6193 * applications that perform certificate verification and therefore will
6194 * process SCTs when enabled.
6196 if (s->ct_validation_callback == NULL || cert == NULL ||
6197 s->verify_result != X509_V_OK ||
6198 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
6202 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
6203 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
6205 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
6206 switch (dane->mtlsa->usage) {
6207 case DANETLS_USAGE_DANE_TA:
6208 case DANETLS_USAGE_DANE_EE:
6213 ctx = CT_POLICY_EVAL_CTX_new_ex(SSL_CONNECTION_GET_CTX(s)->libctx,
6214 SSL_CONNECTION_GET_CTX(s)->propq);
6216 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_CT_LIB);
6220 issuer = sk_X509_value(s->verified_chain, 1);
6221 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
6222 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
6223 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx,
6224 SSL_CONNECTION_GET_CTX(s)->ctlog_store);
6225 CT_POLICY_EVAL_CTX_set_time(
6226 ctx, (uint64_t)SSL_SESSION_get_time(s->session) * 1000);
6228 scts = SSL_get0_peer_scts(SSL_CONNECTION_GET_SSL(s));
6231 * This function returns success (> 0) only when all the SCTs are valid, 0
6232 * when some are invalid, and < 0 on various internal errors (out of
6233 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
6234 * reason to abort the handshake, that decision is up to the callback.
6235 * Therefore, we error out only in the unexpected case that the return
6236 * value is negative.
6238 * XXX: One might well argue that the return value of this function is an
6239 * unfortunate design choice. Its job is only to determine the validation
6240 * status of each of the provided SCTs. So long as it correctly separates
6241 * the wheat from the chaff it should return success. Failure in this case
6242 * ought to correspond to an inability to carry out its duties.
6244 if (SCT_LIST_validate(scts, ctx) < 0) {
6245 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_R_SCT_VERIFICATION_FAILED);
6249 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
6251 ret = 0; /* This function returns 0 on failure */
6253 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_R_CALLBACK_FAILED);
6256 CT_POLICY_EVAL_CTX_free(ctx);
6258 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
6259 * failure return code here. Also the application may wish the complete
6260 * the handshake, and then disconnect cleanly at a higher layer, after
6261 * checking the verification status of the completed connection.
6263 * We therefore force a certificate verification failure which will be
6264 * visible via SSL_get_verify_result() and cached as part of any resumed
6267 * Note: the permissive callback is for information gathering only, always
6268 * returns success, and does not affect verification status. Only the
6269 * strict callback or a custom application-specified callback can trigger
6270 * connection failure or record a verification error.
6273 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
6277 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
6279 switch (validation_mode) {
6281 ERR_raise(ERR_LIB_SSL, SSL_R_INVALID_CT_VALIDATION_TYPE);
6283 case SSL_CT_VALIDATION_PERMISSIVE:
6284 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
6285 case SSL_CT_VALIDATION_STRICT:
6286 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
6290 int SSL_enable_ct(SSL *s, int validation_mode)
6292 switch (validation_mode) {
6294 ERR_raise(ERR_LIB_SSL, SSL_R_INVALID_CT_VALIDATION_TYPE);
6296 case SSL_CT_VALIDATION_PERMISSIVE:
6297 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
6298 case SSL_CT_VALIDATION_STRICT:
6299 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
6303 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
6305 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
6308 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
6310 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
6313 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
6315 CTLOG_STORE_free(ctx->ctlog_store);
6316 ctx->ctlog_store = logs;
6319 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
6321 return ctx->ctlog_store;
6324 #endif /* OPENSSL_NO_CT */
6326 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
6329 c->client_hello_cb = cb;
6330 c->client_hello_cb_arg = arg;
6333 int SSL_client_hello_isv2(SSL *s)
6335 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6340 if (sc->clienthello == NULL)
6342 return sc->clienthello->isv2;
6345 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
6347 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6352 if (sc->clienthello == NULL)
6354 return sc->clienthello->legacy_version;
6357 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
6359 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6364 if (sc->clienthello == NULL)
6367 *out = sc->clienthello->random;
6368 return SSL3_RANDOM_SIZE;
6371 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
6373 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6378 if (sc->clienthello == NULL)
6381 *out = sc->clienthello->session_id;
6382 return sc->clienthello->session_id_len;
6385 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
6387 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6392 if (sc->clienthello == NULL)
6395 *out = PACKET_data(&sc->clienthello->ciphersuites);
6396 return PACKET_remaining(&sc->clienthello->ciphersuites);
6399 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
6401 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6406 if (sc->clienthello == NULL)
6409 *out = sc->clienthello->compressions;
6410 return sc->clienthello->compressions_len;
6413 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
6418 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6423 if (sc->clienthello == NULL || out == NULL || outlen == NULL)
6425 for (i = 0; i < sc->clienthello->pre_proc_exts_len; i++) {
6426 ext = sc->clienthello->pre_proc_exts + i;
6435 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL)
6437 for (i = 0; i < sc->clienthello->pre_proc_exts_len; i++) {
6438 ext = sc->clienthello->pre_proc_exts + i;
6440 if (ext->received_order >= num)
6442 present[ext->received_order] = ext->type;
6449 OPENSSL_free(present);
6453 int SSL_client_hello_get_extension_order(SSL *s, uint16_t *exts, size_t *num_exts)
6457 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6462 if (sc->clienthello == NULL || num_exts == NULL)
6464 for (i = 0; i < sc->clienthello->pre_proc_exts_len; i++) {
6465 ext = sc->clienthello->pre_proc_exts + i;
6477 if (*num_exts < num)
6479 for (i = 0; i < sc->clienthello->pre_proc_exts_len; i++) {
6480 ext = sc->clienthello->pre_proc_exts + i;
6482 if (ext->received_order >= num)
6484 exts[ext->received_order] = ext->type;
6491 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
6496 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6501 if (sc->clienthello == NULL)
6503 for (i = 0; i < sc->clienthello->pre_proc_exts_len; ++i) {
6504 r = sc->clienthello->pre_proc_exts + i;
6505 if (r->present && r->type == type) {
6507 *out = PACKET_data(&r->data);
6509 *outlen = PACKET_remaining(&r->data);
6516 int SSL_free_buffers(SSL *ssl)
6519 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
6526 return rl->rrlmethod->free_buffers(rl->rrl)
6527 && rl->wrlmethod->free_buffers(rl->wrl);
6530 int SSL_alloc_buffers(SSL *ssl)
6533 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
6540 return rl->rrlmethod->alloc_buffers(rl->rrl)
6541 && rl->wrlmethod->alloc_buffers(rl->wrl);
6544 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
6546 ctx->keylog_callback = cb;
6549 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
6551 return ctx->keylog_callback;
6554 static int nss_keylog_int(const char *prefix,
6556 const uint8_t *parameter_1,
6557 size_t parameter_1_len,
6558 const uint8_t *parameter_2,
6559 size_t parameter_2_len)
6562 char *cursor = NULL;
6566 SSL_CTX *sctx = SSL_CONNECTION_GET_CTX(sc);
6568 if (sctx->keylog_callback == NULL)
6572 * Our output buffer will contain the following strings, rendered with
6573 * space characters in between, terminated by a NULL character: first the
6574 * prefix, then the first parameter, then the second parameter. The
6575 * meaning of each parameter depends on the specific key material being
6576 * logged. Note that the first and second parameters are encoded in
6577 * hexadecimal, so we need a buffer that is twice their lengths.
6579 prefix_len = strlen(prefix);
6580 out_len = prefix_len + (2 * parameter_1_len) + (2 * parameter_2_len) + 3;
6581 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL)
6584 strcpy(cursor, prefix);
6585 cursor += prefix_len;
6588 for (i = 0; i < parameter_1_len; i++) {
6589 sprintf(cursor, "%02x", parameter_1[i]);
6594 for (i = 0; i < parameter_2_len; i++) {
6595 sprintf(cursor, "%02x", parameter_2[i]);
6600 sctx->keylog_callback(SSL_CONNECTION_GET_SSL(sc), (const char *)out);
6601 OPENSSL_clear_free(out, out_len);
6606 int ssl_log_rsa_client_key_exchange(SSL_CONNECTION *sc,
6607 const uint8_t *encrypted_premaster,
6608 size_t encrypted_premaster_len,
6609 const uint8_t *premaster,
6610 size_t premaster_len)
6612 if (encrypted_premaster_len < 8) {
6613 SSLfatal(sc, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
6617 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
6618 return nss_keylog_int("RSA",
6620 encrypted_premaster,
6626 int ssl_log_secret(SSL_CONNECTION *sc,
6628 const uint8_t *secret,
6631 return nss_keylog_int(label,
6633 sc->s3.client_random,
6639 #define SSLV2_CIPHER_LEN 3
6641 int ssl_cache_cipherlist(SSL_CONNECTION *s, PACKET *cipher_suites, int sslv2format)
6645 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
6647 if (PACKET_remaining(cipher_suites) == 0) {
6648 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_R_NO_CIPHERS_SPECIFIED);
6652 if (PACKET_remaining(cipher_suites) % n != 0) {
6653 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
6657 OPENSSL_free(s->s3.tmp.ciphers_raw);
6658 s->s3.tmp.ciphers_raw = NULL;
6659 s->s3.tmp.ciphers_rawlen = 0;
6662 size_t numciphers = PACKET_remaining(cipher_suites) / n;
6663 PACKET sslv2ciphers = *cipher_suites;
6664 unsigned int leadbyte;
6668 * We store the raw ciphers list in SSLv3+ format so we need to do some
6669 * preprocessing to convert the list first. If there are any SSLv2 only
6670 * ciphersuites with a non-zero leading byte then we are going to
6671 * slightly over allocate because we won't store those. But that isn't a
6674 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
6675 s->s3.tmp.ciphers_raw = raw;
6677 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_CRYPTO_LIB);
6680 for (s->s3.tmp.ciphers_rawlen = 0;
6681 PACKET_remaining(&sslv2ciphers) > 0;
6682 raw += TLS_CIPHER_LEN) {
6683 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
6685 && !PACKET_copy_bytes(&sslv2ciphers, raw,
6688 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
6689 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_R_BAD_PACKET);
6690 OPENSSL_free(s->s3.tmp.ciphers_raw);
6691 s->s3.tmp.ciphers_raw = NULL;
6692 s->s3.tmp.ciphers_rawlen = 0;
6696 s->s3.tmp.ciphers_rawlen += TLS_CIPHER_LEN;
6698 } else if (!PACKET_memdup(cipher_suites, &s->s3.tmp.ciphers_raw,
6699 &s->s3.tmp.ciphers_rawlen)) {
6700 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
6706 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
6707 int isv2format, STACK_OF(SSL_CIPHER) **sk,
6708 STACK_OF(SSL_CIPHER) **scsvs)
6711 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6716 if (!PACKET_buf_init(&pkt, bytes, len))
6718 return ossl_bytes_to_cipher_list(sc, &pkt, sk, scsvs, isv2format, 0);
6721 int ossl_bytes_to_cipher_list(SSL_CONNECTION *s, PACKET *cipher_suites,
6722 STACK_OF(SSL_CIPHER) **skp,
6723 STACK_OF(SSL_CIPHER) **scsvs_out,
6724 int sslv2format, int fatal)
6726 const SSL_CIPHER *c;
6727 STACK_OF(SSL_CIPHER) *sk = NULL;
6728 STACK_OF(SSL_CIPHER) *scsvs = NULL;
6730 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
6731 unsigned char cipher[SSLV2_CIPHER_LEN];
6733 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
6735 if (PACKET_remaining(cipher_suites) == 0) {
6737 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_R_NO_CIPHERS_SPECIFIED);
6739 ERR_raise(ERR_LIB_SSL, SSL_R_NO_CIPHERS_SPECIFIED);
6743 if (PACKET_remaining(cipher_suites) % n != 0) {
6745 SSLfatal(s, SSL_AD_DECODE_ERROR,
6746 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
6748 ERR_raise(ERR_LIB_SSL, SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
6752 sk = sk_SSL_CIPHER_new_null();
6753 scsvs = sk_SSL_CIPHER_new_null();
6754 if (sk == NULL || scsvs == NULL) {
6756 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_CRYPTO_LIB);
6758 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
6762 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
6764 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
6765 * first byte set to zero, while true SSLv2 ciphers have a non-zero
6766 * first byte. We don't support any true SSLv2 ciphers, so skip them.
6768 if (sslv2format && cipher[0] != '\0')
6771 /* For SSLv2-compat, ignore leading 0-byte. */
6772 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
6774 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
6775 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
6777 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_CRYPTO_LIB);
6779 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
6784 if (PACKET_remaining(cipher_suites) > 0) {
6786 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_R_BAD_LENGTH);
6788 ERR_raise(ERR_LIB_SSL, SSL_R_BAD_LENGTH);
6795 sk_SSL_CIPHER_free(sk);
6796 if (scsvs_out != NULL)
6799 sk_SSL_CIPHER_free(scsvs);
6802 sk_SSL_CIPHER_free(sk);
6803 sk_SSL_CIPHER_free(scsvs);
6807 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
6809 ctx->max_early_data = max_early_data;
6814 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
6816 return ctx->max_early_data;
6819 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
6821 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6826 sc->max_early_data = max_early_data;
6831 uint32_t SSL_get_max_early_data(const SSL *s)
6833 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
6838 return sc->max_early_data;
6841 int SSL_CTX_set_recv_max_early_data(SSL_CTX *ctx, uint32_t recv_max_early_data)
6843 ctx->recv_max_early_data = recv_max_early_data;
6848 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX *ctx)
6850 return ctx->recv_max_early_data;
6853 int SSL_set_recv_max_early_data(SSL *s, uint32_t recv_max_early_data)
6855 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6860 sc->recv_max_early_data = recv_max_early_data;
6865 uint32_t SSL_get_recv_max_early_data(const SSL *s)
6867 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
6872 return sc->recv_max_early_data;
6875 __owur unsigned int ssl_get_max_send_fragment(const SSL_CONNECTION *sc)
6877 /* Return any active Max Fragment Len extension */
6878 if (sc->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(sc->session))
6879 return GET_MAX_FRAGMENT_LENGTH(sc->session);
6881 /* return current SSL connection setting */
6882 return sc->max_send_fragment;
6885 __owur unsigned int ssl_get_split_send_fragment(const SSL_CONNECTION *sc)
6887 /* Return a value regarding an active Max Fragment Len extension */
6888 if (sc->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(sc->session)
6889 && sc->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(sc->session))
6890 return GET_MAX_FRAGMENT_LENGTH(sc->session);
6892 /* else limit |split_send_fragment| to current |max_send_fragment| */
6893 if (sc->split_send_fragment > sc->max_send_fragment)
6894 return sc->max_send_fragment;
6896 /* return current SSL connection setting */
6897 return sc->split_send_fragment;
6900 int SSL_stateless(SSL *s)
6903 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
6905 /* TODO(QUIC): This will need further work. */
6909 /* Ensure there is no state left over from a previous invocation */
6915 sc->s3.flags |= TLS1_FLAGS_STATELESS;
6916 ret = SSL_accept(s);
6917 sc->s3.flags &= ~TLS1_FLAGS_STATELESS;
6919 if (ret > 0 && sc->ext.cookieok)
6922 if (sc->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(sc))
6928 void SSL_CTX_set_post_handshake_auth(SSL_CTX *ctx, int val)
6930 ctx->pha_enabled = val;
6933 void SSL_set_post_handshake_auth(SSL *ssl, int val)
6935 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
6940 sc->pha_enabled = val;
6943 int SSL_verify_client_post_handshake(SSL *ssl)
6945 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
6950 if (!SSL_CONNECTION_IS_TLS13(sc)) {
6951 ERR_raise(ERR_LIB_SSL, SSL_R_WRONG_SSL_VERSION);
6955 ERR_raise(ERR_LIB_SSL, SSL_R_NOT_SERVER);
6959 if (!SSL_is_init_finished(ssl)) {
6960 ERR_raise(ERR_LIB_SSL, SSL_R_STILL_IN_INIT);
6964 switch (sc->post_handshake_auth) {
6966 ERR_raise(ERR_LIB_SSL, SSL_R_EXTENSION_NOT_RECEIVED);
6969 case SSL_PHA_EXT_SENT:
6970 ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
6972 case SSL_PHA_EXT_RECEIVED:
6974 case SSL_PHA_REQUEST_PENDING:
6975 ERR_raise(ERR_LIB_SSL, SSL_R_REQUEST_PENDING);
6977 case SSL_PHA_REQUESTED:
6978 ERR_raise(ERR_LIB_SSL, SSL_R_REQUEST_SENT);
6982 sc->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
6984 /* checks verify_mode and algorithm_auth */
6985 if (!send_certificate_request(sc)) {
6986 sc->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
6987 ERR_raise(ERR_LIB_SSL, SSL_R_INVALID_CONFIG);
6991 ossl_statem_set_in_init(sc, 1);
6995 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
6996 SSL_CTX_generate_session_ticket_fn gen_cb,
6997 SSL_CTX_decrypt_session_ticket_fn dec_cb,
7000 ctx->generate_ticket_cb = gen_cb;
7001 ctx->decrypt_ticket_cb = dec_cb;
7002 ctx->ticket_cb_data = arg;
7006 void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
7007 SSL_allow_early_data_cb_fn cb,
7010 ctx->allow_early_data_cb = cb;
7011 ctx->allow_early_data_cb_data = arg;
7014 void SSL_set_allow_early_data_cb(SSL *s,
7015 SSL_allow_early_data_cb_fn cb,
7018 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
7023 sc->allow_early_data_cb = cb;
7024 sc->allow_early_data_cb_data = arg;
7027 const EVP_CIPHER *ssl_evp_cipher_fetch(OSSL_LIB_CTX *libctx,
7029 const char *properties)
7031 const EVP_CIPHER *ciph;
7033 ciph = tls_get_cipher_from_engine(nid);
7038 * If there is no engine cipher then we do an explicit fetch. This may fail
7039 * and that could be ok
7042 ciph = EVP_CIPHER_fetch(libctx, OBJ_nid2sn(nid), properties);
7048 int ssl_evp_cipher_up_ref(const EVP_CIPHER *cipher)
7050 /* Don't up-ref an implicit EVP_CIPHER */
7051 if (EVP_CIPHER_get0_provider(cipher) == NULL)
7055 * The cipher was explicitly fetched and therefore it is safe to cast
7058 return EVP_CIPHER_up_ref((EVP_CIPHER *)cipher);
7061 void ssl_evp_cipher_free(const EVP_CIPHER *cipher)
7066 if (EVP_CIPHER_get0_provider(cipher) != NULL) {
7068 * The cipher was explicitly fetched and therefore it is safe to cast
7071 EVP_CIPHER_free((EVP_CIPHER *)cipher);
7075 const EVP_MD *ssl_evp_md_fetch(OSSL_LIB_CTX *libctx,
7077 const char *properties)
7081 md = tls_get_digest_from_engine(nid);
7085 /* Otherwise we do an explicit fetch */
7087 md = EVP_MD_fetch(libctx, OBJ_nid2sn(nid), properties);
7092 int ssl_evp_md_up_ref(const EVP_MD *md)
7094 /* Don't up-ref an implicit EVP_MD */
7095 if (EVP_MD_get0_provider(md) == NULL)
7099 * The digest was explicitly fetched and therefore it is safe to cast
7102 return EVP_MD_up_ref((EVP_MD *)md);
7105 void ssl_evp_md_free(const EVP_MD *md)
7110 if (EVP_MD_get0_provider(md) != NULL) {
7112 * The digest was explicitly fetched and therefore it is safe to cast
7115 EVP_MD_free((EVP_MD *)md);
7119 int SSL_set0_tmp_dh_pkey(SSL *s, EVP_PKEY *dhpkey)
7121 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
7126 if (!ssl_security(sc, SSL_SECOP_TMP_DH,
7127 EVP_PKEY_get_security_bits(dhpkey), 0, dhpkey)) {
7128 ERR_raise(ERR_LIB_SSL, SSL_R_DH_KEY_TOO_SMALL);
7131 EVP_PKEY_free(sc->cert->dh_tmp);
7132 sc->cert->dh_tmp = dhpkey;
7136 int SSL_CTX_set0_tmp_dh_pkey(SSL_CTX *ctx, EVP_PKEY *dhpkey)
7138 if (!ssl_ctx_security(ctx, SSL_SECOP_TMP_DH,
7139 EVP_PKEY_get_security_bits(dhpkey), 0, dhpkey)) {
7140 ERR_raise(ERR_LIB_SSL, SSL_R_DH_KEY_TOO_SMALL);
7143 EVP_PKEY_free(ctx->cert->dh_tmp);
7144 ctx->cert->dh_tmp = dhpkey;
7148 /* QUIC-specific methods which are supported on QUIC connections only. */
7149 int SSL_tick(SSL *s)
7153 #ifndef OPENSSL_NO_QUIC
7155 return ossl_quic_tick(s);
7158 sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
7159 if (sc != NULL && SSL_CONNECTION_IS_DTLS(sc))
7161 * DTLSv1_handle_timeout returns 0 if the timer wasn't expired yet,
7162 * which we consider a success case. Theoretically DTLSv1_handle_timeout
7163 * can also return 0 if s is NULL or not a DTLS object, but we've
7164 * already ruled out those possibilities above, so this is not possible
7165 * here. Thus the only failure cases are where DTLSv1_handle_timeout
7168 return DTLSv1_handle_timeout(s) >= 0;
7173 int SSL_get_tick_timeout(SSL *s, struct timeval *tv)
7177 #ifndef OPENSSL_NO_QUIC
7179 return ossl_quic_get_tick_timeout(s, tv);
7182 sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
7183 if (sc != NULL && SSL_CONNECTION_IS_DTLS(sc)
7184 && DTLSv1_get_timeout(s, tv))
7192 int SSL_get_rpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
7194 #ifndef OPENSSL_NO_QUIC
7198 return ossl_quic_get_rpoll_descriptor(s, desc);
7204 int SSL_get_wpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc)
7206 #ifndef OPENSSL_NO_QUIC
7210 return ossl_quic_get_wpoll_descriptor(s, desc);
7216 int SSL_net_read_desired(SSL *s)
7218 #ifndef OPENSSL_NO_QUIC
7222 return ossl_quic_get_net_read_desired(s);
7228 int SSL_net_write_desired(SSL *s)
7230 #ifndef OPENSSL_NO_QUIC
7234 return ossl_quic_get_net_write_desired(s);
7240 int SSL_set_blocking_mode(SSL *s, int blocking)
7242 #ifndef OPENSSL_NO_QUIC
7246 return ossl_quic_conn_set_blocking_mode(s, blocking);
7252 int SSL_get_blocking_mode(SSL *s)
7254 #ifndef OPENSSL_NO_QUIC
7258 return ossl_quic_conn_get_blocking_mode(s);
7264 int SSL_set_initial_peer_addr(SSL *s, const BIO_ADDR *peer_addr)
7266 #ifndef OPENSSL_NO_QUIC
7270 return ossl_quic_conn_set_initial_peer_addr(s, peer_addr);
7276 int SSL_shutdown_ex(SSL *ssl, uint64_t flags,
7277 const SSL_SHUTDOWN_EX_ARGS *args,
7280 #ifndef OPENSSL_NO_QUIC
7282 return SSL_shutdown(ssl);
7284 return ossl_quic_conn_shutdown(ssl, flags, args, args_len);
7286 return SSL_shutdown(ssl);
7290 int SSL_stream_conclude(SSL *ssl, uint64_t flags)
7292 #ifndef OPENSSL_NO_QUIC
7296 return ossl_quic_conn_stream_conclude(ssl);
7302 SSL *SSL_new_stream(SSL *s, uint64_t flags)
7304 #ifndef OPENSSL_NO_QUIC
7308 return ossl_quic_conn_stream_new(s, flags);
7314 int SSL_add_expected_rpk(SSL *s, EVP_PKEY *rpk)
7316 unsigned char *data = NULL;
7317 SSL_DANE *dane = SSL_get0_dane(s);
7320 if (dane == NULL || dane->dctx == NULL)
7322 if ((ret = i2d_PUBKEY(rpk, &data)) <= 0)
7325 ret = SSL_dane_tlsa_add(s, DANETLS_USAGE_DANE_EE,
7326 DANETLS_SELECTOR_SPKI,
7327 DANETLS_MATCHING_FULL,
7328 data, (size_t)ret) > 0;
7333 EVP_PKEY *SSL_get0_peer_rpk(const SSL *s)
7335 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
7337 if (sc == NULL || sc->session == NULL)
7339 return sc->session->peer_rpk;
7342 int SSL_get_negotiated_client_cert_type(const SSL *s)
7344 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
7349 return sc->ext.client_cert_type;
7352 int SSL_get_negotiated_server_cert_type(const SSL *s)
7354 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
7359 return sc->ext.server_cert_type;
7362 static int validate_cert_type(const unsigned char *val, size_t len)
7368 if (val == NULL && len == 0)
7371 if (val == NULL || len == 0)
7374 for (i = 0; i < len; i++) {
7376 case TLSEXT_cert_type_rpk:
7381 case TLSEXT_cert_type_x509:
7386 case TLSEXT_cert_type_pgp:
7387 case TLSEXT_cert_type_1609dot2:
7395 static int set_cert_type(unsigned char **cert_type,
7396 size_t *cert_type_len,
7397 const unsigned char *val,
7400 unsigned char *tmp = NULL;
7402 if (!validate_cert_type(val, len))
7405 if (val != NULL && (tmp = OPENSSL_memdup(val, len)) == NULL)
7408 OPENSSL_free(*cert_type);
7410 *cert_type_len = len;
7414 int SSL_set1_client_cert_type(SSL *s, const unsigned char *val, size_t len)
7416 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
7418 return set_cert_type(&sc->client_cert_type, &sc->client_cert_type_len,
7422 int SSL_set1_server_cert_type(SSL *s, const unsigned char *val, size_t len)
7424 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
7426 return set_cert_type(&sc->server_cert_type, &sc->server_cert_type_len,
7430 int SSL_CTX_set1_client_cert_type(SSL_CTX *ctx, const unsigned char *val, size_t len)
7432 return set_cert_type(&ctx->client_cert_type, &ctx->client_cert_type_len,
7436 int SSL_CTX_set1_server_cert_type(SSL_CTX *ctx, const unsigned char *val, size_t len)
7438 return set_cert_type(&ctx->server_cert_type, &ctx->server_cert_type_len,
7442 int SSL_get0_client_cert_type(const SSL *s, unsigned char **t, size_t *len)
7444 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
7446 if (t == NULL || len == NULL)
7449 *t = sc->client_cert_type;
7450 *len = sc->client_cert_type_len;
7454 int SSL_get0_server_cert_type(const SSL *s, unsigned char **t, size_t *len)
7456 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_CONST_SSL(s);
7458 if (t == NULL || len == NULL)
7461 *t = sc->server_cert_type;
7462 *len = sc->server_cert_type_len;
7466 int SSL_CTX_get0_client_cert_type(const SSL_CTX *ctx, unsigned char **t, size_t *len)
7468 if (t == NULL || len == NULL)
7471 *t = ctx->client_cert_type;
7472 *len = ctx->client_cert_type_len;
7476 int SSL_CTX_get0_server_cert_type(const SSL_CTX *ctx, unsigned char **t, size_t *len)
7478 if (t == NULL || len == NULL)
7481 *t = ctx->server_cert_type;
7482 *len = ctx->server_cert_type_len;