2 * Copyright 1995-2020 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 OpenSSL license (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 <openssl/objects.h>
15 #include <openssl/x509v3.h>
16 #include <openssl/rand.h>
17 #include <openssl/rand_drbg.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 "internal/cryptlib.h"
24 #include "internal/refcount.h"
26 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
28 static int ssl_undefined_function_1(SSL *ssl, SSL3_RECORD *r, size_t s, int t)
33 return ssl_undefined_function(ssl);
36 static int ssl_undefined_function_2(SSL *ssl, SSL3_RECORD *r, unsigned char *s,
42 return ssl_undefined_function(ssl);
45 static int ssl_undefined_function_3(SSL *ssl, unsigned char *r,
46 unsigned char *s, size_t t, size_t *u)
52 return ssl_undefined_function(ssl);
55 static int ssl_undefined_function_4(SSL *ssl, int r)
58 return ssl_undefined_function(ssl);
61 static size_t ssl_undefined_function_5(SSL *ssl, const char *r, size_t s,
67 return ssl_undefined_function(ssl);
70 static int ssl_undefined_function_6(int r)
73 return ssl_undefined_function(NULL);
76 static int ssl_undefined_function_7(SSL *ssl, unsigned char *r, size_t s,
77 const char *t, size_t u,
78 const unsigned char *v, size_t w, int x)
87 return ssl_undefined_function(ssl);
90 SSL3_ENC_METHOD ssl3_undef_enc_method = {
91 ssl_undefined_function_1,
92 ssl_undefined_function_2,
93 ssl_undefined_function,
94 ssl_undefined_function_3,
95 ssl_undefined_function_4,
96 ssl_undefined_function_5,
97 NULL, /* client_finished_label */
98 0, /* client_finished_label_len */
99 NULL, /* server_finished_label */
100 0, /* server_finished_label_len */
101 ssl_undefined_function_6,
102 ssl_undefined_function_7,
105 struct ssl_async_args {
109 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
111 int (*func_read) (SSL *, void *, size_t, size_t *);
112 int (*func_write) (SSL *, const void *, size_t, size_t *);
113 int (*func_other) (SSL *);
117 static const struct {
123 DANETLS_MATCHING_FULL, 0, NID_undef
126 DANETLS_MATCHING_2256, 1, NID_sha256
129 DANETLS_MATCHING_2512, 2, NID_sha512
133 static int dane_ctx_enable(struct dane_ctx_st *dctx)
135 const EVP_MD **mdevp;
137 uint8_t mdmax = DANETLS_MATCHING_LAST;
138 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
141 if (dctx->mdevp != NULL)
144 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
145 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
147 if (mdord == NULL || mdevp == NULL) {
150 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
154 /* Install default entries */
155 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
158 if (dane_mds[i].nid == NID_undef ||
159 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
161 mdevp[dane_mds[i].mtype] = md;
162 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
172 static void dane_ctx_final(struct dane_ctx_st *dctx)
174 OPENSSL_free(dctx->mdevp);
177 OPENSSL_free(dctx->mdord);
182 static void tlsa_free(danetls_record *t)
186 OPENSSL_free(t->data);
187 EVP_PKEY_free(t->spki);
191 static void dane_final(SSL_DANE *dane)
193 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
196 sk_X509_pop_free(dane->certs, X509_free);
199 X509_free(dane->mcert);
207 * dane_copy - Copy dane configuration, sans verification state.
209 static int ssl_dane_dup(SSL *to, SSL *from)
214 if (!DANETLS_ENABLED(&from->dane))
217 num = sk_danetls_record_num(from->dane.trecs);
218 dane_final(&to->dane);
219 to->dane.flags = from->dane.flags;
220 to->dane.dctx = &to->ctx->dane;
221 to->dane.trecs = sk_danetls_record_new_reserve(NULL, num);
223 if (to->dane.trecs == NULL) {
224 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
228 for (i = 0; i < num; ++i) {
229 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
231 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
232 t->data, t->dlen) <= 0)
238 static int dane_mtype_set(struct dane_ctx_st *dctx,
239 const EVP_MD *md, uint8_t mtype, uint8_t ord)
243 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
244 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
248 if (mtype > dctx->mdmax) {
249 const EVP_MD **mdevp;
251 int n = ((int)mtype) + 1;
253 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
255 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
260 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
262 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
267 /* Zero-fill any gaps */
268 for (i = dctx->mdmax + 1; i < mtype; ++i) {
276 dctx->mdevp[mtype] = md;
277 /* Coerce ordinal of disabled matching types to 0 */
278 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
283 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
285 if (mtype > dane->dctx->mdmax)
287 return dane->dctx->mdevp[mtype];
290 static int dane_tlsa_add(SSL_DANE *dane,
293 uint8_t mtype, unsigned const char *data, size_t dlen)
296 const EVP_MD *md = NULL;
297 int ilen = (int)dlen;
301 if (dane->trecs == NULL) {
302 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
306 if (ilen < 0 || dlen != (size_t)ilen) {
307 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
311 if (usage > DANETLS_USAGE_LAST) {
312 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
316 if (selector > DANETLS_SELECTOR_LAST) {
317 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
321 if (mtype != DANETLS_MATCHING_FULL) {
322 md = tlsa_md_get(dane, mtype);
324 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
329 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
330 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
334 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
338 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
339 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
344 t->selector = selector;
346 t->data = OPENSSL_malloc(dlen);
347 if (t->data == NULL) {
349 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
352 memcpy(t->data, data, dlen);
355 /* Validate and cache full certificate or public key */
356 if (mtype == DANETLS_MATCHING_FULL) {
357 const unsigned char *p = data;
359 EVP_PKEY *pkey = NULL;
362 case DANETLS_SELECTOR_CERT:
363 if (!d2i_X509(&cert, &p, ilen) || p < data ||
364 dlen != (size_t)(p - data)) {
366 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
369 if (X509_get0_pubkey(cert) == NULL) {
371 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
375 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
381 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
382 * records that contain full certificates of trust-anchors that are
383 * not present in the wire chain. For usage PKIX-TA(0), we augment
384 * the chain with untrusted Full(0) certificates from DNS, in case
385 * they are missing from the chain.
387 if ((dane->certs == NULL &&
388 (dane->certs = sk_X509_new_null()) == NULL) ||
389 !sk_X509_push(dane->certs, cert)) {
390 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
397 case DANETLS_SELECTOR_SPKI:
398 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
399 dlen != (size_t)(p - data)) {
401 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
406 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
407 * records that contain full bare keys of trust-anchors that are
408 * not present in the wire chain.
410 if (usage == DANETLS_USAGE_DANE_TA)
419 * Find the right insertion point for the new record.
421 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
422 * they can be processed first, as they require no chain building, and no
423 * expiration or hostname checks. Because DANE-EE(3) is numerically
424 * largest, this is accomplished via descending sort by "usage".
426 * We also sort in descending order by matching ordinal to simplify
427 * the implementation of digest agility in the verification code.
429 * The choice of order for the selector is not significant, so we
430 * use the same descending order for consistency.
432 num = sk_danetls_record_num(dane->trecs);
433 for (i = 0; i < num; ++i) {
434 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
436 if (rec->usage > usage)
438 if (rec->usage < usage)
440 if (rec->selector > selector)
442 if (rec->selector < selector)
444 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
449 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
451 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
454 dane->umask |= DANETLS_USAGE_BIT(usage);
460 * Return 0 if there is only one version configured and it was disabled
461 * at configure time. Return 1 otherwise.
463 static int ssl_check_allowed_versions(int min_version, int max_version)
465 int minisdtls = 0, maxisdtls = 0;
467 /* Figure out if we're doing DTLS versions or TLS versions */
468 if (min_version == DTLS1_BAD_VER
469 || min_version >> 8 == DTLS1_VERSION_MAJOR)
471 if (max_version == DTLS1_BAD_VER
472 || max_version >> 8 == DTLS1_VERSION_MAJOR)
474 /* A wildcard version of 0 could be DTLS or TLS. */
475 if ((minisdtls && !maxisdtls && max_version != 0)
476 || (maxisdtls && !minisdtls && min_version != 0)) {
477 /* Mixing DTLS and TLS versions will lead to sadness; deny it. */
481 if (minisdtls || maxisdtls) {
482 /* Do DTLS version checks. */
483 if (min_version == 0)
484 /* Ignore DTLS1_BAD_VER */
485 min_version = DTLS1_VERSION;
486 if (max_version == 0)
487 max_version = DTLS1_2_VERSION;
488 #ifdef OPENSSL_NO_DTLS1_2
489 if (max_version == DTLS1_2_VERSION)
490 max_version = DTLS1_VERSION;
492 #ifdef OPENSSL_NO_DTLS1
493 if (min_version == DTLS1_VERSION)
494 min_version = DTLS1_2_VERSION;
496 /* Done massaging versions; do the check. */
498 #ifdef OPENSSL_NO_DTLS1
499 || (DTLS_VERSION_GE(min_version, DTLS1_VERSION)
500 && DTLS_VERSION_GE(DTLS1_VERSION, max_version))
502 #ifdef OPENSSL_NO_DTLS1_2
503 || (DTLS_VERSION_GE(min_version, DTLS1_2_VERSION)
504 && DTLS_VERSION_GE(DTLS1_2_VERSION, max_version))
509 /* Regular TLS version checks. */
510 if (min_version == 0)
511 min_version = SSL3_VERSION;
512 if (max_version == 0)
513 max_version = TLS1_3_VERSION;
514 #ifdef OPENSSL_NO_TLS1_3
515 if (max_version == TLS1_3_VERSION)
516 max_version = TLS1_2_VERSION;
518 #ifdef OPENSSL_NO_TLS1_2
519 if (max_version == TLS1_2_VERSION)
520 max_version = TLS1_1_VERSION;
522 #ifdef OPENSSL_NO_TLS1_1
523 if (max_version == TLS1_1_VERSION)
524 max_version = TLS1_VERSION;
526 #ifdef OPENSSL_NO_TLS1
527 if (max_version == TLS1_VERSION)
528 max_version = SSL3_VERSION;
530 #ifdef OPENSSL_NO_SSL3
531 if (min_version == SSL3_VERSION)
532 min_version = TLS1_VERSION;
534 #ifdef OPENSSL_NO_TLS1
535 if (min_version == TLS1_VERSION)
536 min_version = TLS1_1_VERSION;
538 #ifdef OPENSSL_NO_TLS1_1
539 if (min_version == TLS1_1_VERSION)
540 min_version = TLS1_2_VERSION;
542 #ifdef OPENSSL_NO_TLS1_2
543 if (min_version == TLS1_2_VERSION)
544 min_version = TLS1_3_VERSION;
546 /* Done massaging versions; do the check. */
548 #ifdef OPENSSL_NO_SSL3
549 || (min_version <= SSL3_VERSION && SSL3_VERSION <= max_version)
551 #ifdef OPENSSL_NO_TLS1
552 || (min_version <= TLS1_VERSION && TLS1_VERSION <= max_version)
554 #ifdef OPENSSL_NO_TLS1_1
555 || (min_version <= TLS1_1_VERSION && TLS1_1_VERSION <= max_version)
557 #ifdef OPENSSL_NO_TLS1_2
558 || (min_version <= TLS1_2_VERSION && TLS1_2_VERSION <= max_version)
560 #ifdef OPENSSL_NO_TLS1_3
561 || (min_version <= TLS1_3_VERSION && TLS1_3_VERSION <= max_version)
569 static void clear_ciphers(SSL *s)
571 /* clear the current cipher */
572 ssl_clear_cipher_ctx(s);
573 ssl_clear_hash_ctx(&s->read_hash);
574 ssl_clear_hash_ctx(&s->write_hash);
577 int SSL_clear(SSL *s)
579 if (s->method == NULL) {
580 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
584 if (ssl_clear_bad_session(s)) {
585 SSL_SESSION_free(s->session);
588 SSL_SESSION_free(s->psksession);
589 s->psksession = NULL;
590 OPENSSL_free(s->psksession_id);
591 s->psksession_id = NULL;
592 s->psksession_id_len = 0;
593 s->hello_retry_request = 0;
600 if (s->renegotiate) {
601 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
605 ossl_statem_clear(s);
607 s->version = s->method->version;
608 s->client_version = s->version;
609 s->rwstate = SSL_NOTHING;
611 BUF_MEM_free(s->init_buf);
616 s->key_update = SSL_KEY_UPDATE_NONE;
618 EVP_MD_CTX_free(s->pha_dgst);
621 /* Reset DANE verification result state */
624 X509_free(s->dane.mcert);
625 s->dane.mcert = NULL;
626 s->dane.mtlsa = NULL;
628 /* Clear the verification result peername */
629 X509_VERIFY_PARAM_move_peername(s->param, NULL);
631 /* Clear any shared connection state */
632 OPENSSL_free(s->shared_sigalgs);
633 s->shared_sigalgs = NULL;
634 s->shared_sigalgslen = 0;
637 * Check to see if we were changed into a different method, if so, revert
640 if (s->method != s->ctx->method) {
641 s->method->ssl_free(s);
642 s->method = s->ctx->method;
643 if (!s->method->ssl_new(s))
646 if (!s->method->ssl_clear(s))
650 RECORD_LAYER_clear(&s->rlayer);
655 /** Used to change an SSL_CTXs default SSL method type */
656 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
658 STACK_OF(SSL_CIPHER) *sk;
662 if (!SSL_CTX_set_ciphersuites(ctx, TLS_DEFAULT_CIPHERSUITES)) {
663 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
666 sk = ssl_create_cipher_list(ctx->method,
667 ctx->tls13_ciphersuites,
669 &(ctx->cipher_list_by_id),
670 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
671 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
672 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
678 SSL *SSL_new(SSL_CTX *ctx)
683 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
686 if (ctx->method == NULL) {
687 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
691 s = OPENSSL_zalloc(sizeof(*s));
696 s->lock = CRYPTO_THREAD_lock_new();
697 if (s->lock == NULL) {
703 RECORD_LAYER_init(&s->rlayer, s);
705 s->options = ctx->options;
706 s->dane.flags = ctx->dane.flags;
707 s->min_proto_version = ctx->min_proto_version;
708 s->max_proto_version = ctx->max_proto_version;
710 s->max_cert_list = ctx->max_cert_list;
711 s->max_early_data = ctx->max_early_data;
712 s->recv_max_early_data = ctx->recv_max_early_data;
713 s->num_tickets = ctx->num_tickets;
714 s->pha_enabled = ctx->pha_enabled;
716 /* Shallow copy of the ciphersuites stack */
717 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
718 if (s->tls13_ciphersuites == NULL)
722 * Earlier library versions used to copy the pointer to the CERT, not
723 * its contents; only when setting new parameters for the per-SSL
724 * copy, ssl_cert_new would be called (and the direct reference to
725 * the per-SSL_CTX settings would be lost, but those still were
726 * indirectly accessed for various purposes, and for that reason they
727 * used to be known as s->ctx->default_cert). Now we don't look at the
728 * SSL_CTX's CERT after having duplicated it once.
730 s->cert = ssl_cert_dup(ctx->cert);
734 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
735 s->msg_callback = ctx->msg_callback;
736 s->msg_callback_arg = ctx->msg_callback_arg;
737 s->verify_mode = ctx->verify_mode;
738 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
739 s->record_padding_cb = ctx->record_padding_cb;
740 s->record_padding_arg = ctx->record_padding_arg;
741 s->block_padding = ctx->block_padding;
742 s->sid_ctx_length = ctx->sid_ctx_length;
743 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
745 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
746 s->verify_callback = ctx->default_verify_callback;
747 s->generate_session_id = ctx->generate_session_id;
749 s->param = X509_VERIFY_PARAM_new();
750 if (s->param == NULL)
752 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
753 s->quiet_shutdown = ctx->quiet_shutdown;
755 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
756 s->max_send_fragment = ctx->max_send_fragment;
757 s->split_send_fragment = ctx->split_send_fragment;
758 s->max_pipelines = ctx->max_pipelines;
759 if (s->max_pipelines > 1)
760 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
761 if (ctx->default_read_buf_len > 0)
762 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
767 s->ext.debug_arg = NULL;
768 s->ext.ticket_expected = 0;
769 s->ext.status_type = ctx->ext.status_type;
770 s->ext.status_expected = 0;
771 s->ext.ocsp.ids = NULL;
772 s->ext.ocsp.exts = NULL;
773 s->ext.ocsp.resp = NULL;
774 s->ext.ocsp.resp_len = 0;
776 s->session_ctx = ctx;
777 #ifndef OPENSSL_NO_EC
778 if (ctx->ext.ecpointformats) {
779 s->ext.ecpointformats =
780 OPENSSL_memdup(ctx->ext.ecpointformats,
781 ctx->ext.ecpointformats_len);
782 if (!s->ext.ecpointformats)
784 s->ext.ecpointformats_len =
785 ctx->ext.ecpointformats_len;
787 if (ctx->ext.supportedgroups) {
788 s->ext.supportedgroups =
789 OPENSSL_memdup(ctx->ext.supportedgroups,
790 ctx->ext.supportedgroups_len
791 * sizeof(*ctx->ext.supportedgroups));
792 if (!s->ext.supportedgroups)
794 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
797 #ifndef OPENSSL_NO_NEXTPROTONEG
801 if (s->ctx->ext.alpn) {
802 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
803 if (s->ext.alpn == NULL)
805 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
806 s->ext.alpn_len = s->ctx->ext.alpn_len;
809 s->verified_chain = NULL;
810 s->verify_result = X509_V_OK;
812 s->default_passwd_callback = ctx->default_passwd_callback;
813 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
815 s->method = ctx->method;
817 s->key_update = SSL_KEY_UPDATE_NONE;
819 s->allow_early_data_cb = ctx->allow_early_data_cb;
820 s->allow_early_data_cb_data = ctx->allow_early_data_cb_data;
822 if (!s->method->ssl_new(s))
825 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
830 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
833 #ifndef OPENSSL_NO_PSK
834 s->psk_client_callback = ctx->psk_client_callback;
835 s->psk_server_callback = ctx->psk_server_callback;
837 s->psk_find_session_cb = ctx->psk_find_session_cb;
838 s->psk_use_session_cb = ctx->psk_use_session_cb;
842 #ifndef OPENSSL_NO_CT
843 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
844 ctx->ct_validation_callback_arg))
851 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
855 int SSL_is_dtls(const SSL *s)
857 return SSL_IS_DTLS(s) ? 1 : 0;
860 int SSL_up_ref(SSL *s)
864 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
867 REF_PRINT_COUNT("SSL", s);
868 REF_ASSERT_ISNT(i < 2);
869 return ((i > 1) ? 1 : 0);
872 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
873 unsigned int sid_ctx_len)
875 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
876 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
877 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
880 ctx->sid_ctx_length = sid_ctx_len;
881 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
886 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
887 unsigned int sid_ctx_len)
889 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
890 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
891 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
894 ssl->sid_ctx_length = sid_ctx_len;
895 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
900 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
902 CRYPTO_THREAD_write_lock(ctx->lock);
903 ctx->generate_session_id = cb;
904 CRYPTO_THREAD_unlock(ctx->lock);
908 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
910 CRYPTO_THREAD_write_lock(ssl->lock);
911 ssl->generate_session_id = cb;
912 CRYPTO_THREAD_unlock(ssl->lock);
916 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
920 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
921 * we can "construct" a session to give us the desired check - i.e. to
922 * find if there's a session in the hash table that would conflict with
923 * any new session built out of this id/id_len and the ssl_version in use
928 if (id_len > sizeof(r.session_id))
931 r.ssl_version = ssl->version;
932 r.session_id_length = id_len;
933 memcpy(r.session_id, id, id_len);
935 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
936 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
937 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
941 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
943 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
946 int SSL_set_purpose(SSL *s, int purpose)
948 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
951 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
953 return X509_VERIFY_PARAM_set_trust(s->param, trust);
956 int SSL_set_trust(SSL *s, int trust)
958 return X509_VERIFY_PARAM_set_trust(s->param, trust);
961 int SSL_set1_host(SSL *s, const char *hostname)
963 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
966 int SSL_add1_host(SSL *s, const char *hostname)
968 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
971 void SSL_set_hostflags(SSL *s, unsigned int flags)
973 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
976 const char *SSL_get0_peername(SSL *s)
978 return X509_VERIFY_PARAM_get0_peername(s->param);
981 int SSL_CTX_dane_enable(SSL_CTX *ctx)
983 return dane_ctx_enable(&ctx->dane);
986 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
988 unsigned long orig = ctx->dane.flags;
990 ctx->dane.flags |= flags;
994 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
996 unsigned long orig = ctx->dane.flags;
998 ctx->dane.flags &= ~flags;
1002 int SSL_dane_enable(SSL *s, const char *basedomain)
1004 SSL_DANE *dane = &s->dane;
1006 if (s->ctx->dane.mdmax == 0) {
1007 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
1010 if (dane->trecs != NULL) {
1011 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1016 * Default SNI name. This rejects empty names, while set1_host below
1017 * accepts them and disables host name checks. To avoid side-effects with
1018 * invalid input, set the SNI name first.
1020 if (s->ext.hostname == NULL) {
1021 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1022 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1027 /* Primary RFC6125 reference identifier */
1028 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1029 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1035 dane->dctx = &s->ctx->dane;
1036 dane->trecs = sk_danetls_record_new_null();
1038 if (dane->trecs == NULL) {
1039 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1045 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1047 unsigned long orig = ssl->dane.flags;
1049 ssl->dane.flags |= flags;
1053 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1055 unsigned long orig = ssl->dane.flags;
1057 ssl->dane.flags &= ~flags;
1061 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1063 SSL_DANE *dane = &s->dane;
1065 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1069 *mcert = dane->mcert;
1071 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1076 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1077 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1079 SSL_DANE *dane = &s->dane;
1081 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1085 *usage = dane->mtlsa->usage;
1087 *selector = dane->mtlsa->selector;
1089 *mtype = dane->mtlsa->mtype;
1091 *data = dane->mtlsa->data;
1093 *dlen = dane->mtlsa->dlen;
1098 SSL_DANE *SSL_get0_dane(SSL *s)
1103 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1104 uint8_t mtype, unsigned const char *data, size_t dlen)
1106 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1109 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1112 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1115 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1117 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1120 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1122 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1125 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1130 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1135 void SSL_certs_clear(SSL *s)
1137 ssl_cert_clear_certs(s->cert);
1140 void SSL_free(SSL *s)
1146 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1147 REF_PRINT_COUNT("SSL", s);
1150 REF_ASSERT_ISNT(i < 0);
1152 X509_VERIFY_PARAM_free(s->param);
1153 dane_final(&s->dane);
1154 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1156 /* Ignore return value */
1157 ssl_free_wbio_buffer(s);
1159 BIO_free_all(s->wbio);
1160 BIO_free_all(s->rbio);
1162 BUF_MEM_free(s->init_buf);
1164 /* add extra stuff */
1165 sk_SSL_CIPHER_free(s->cipher_list);
1166 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1167 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1168 sk_SSL_CIPHER_free(s->peer_ciphers);
1170 /* Make the next call work :-) */
1171 if (s->session != NULL) {
1172 ssl_clear_bad_session(s);
1173 SSL_SESSION_free(s->session);
1175 SSL_SESSION_free(s->psksession);
1176 OPENSSL_free(s->psksession_id);
1180 ssl_cert_free(s->cert);
1181 OPENSSL_free(s->shared_sigalgs);
1182 /* Free up if allocated */
1184 OPENSSL_free(s->ext.hostname);
1185 SSL_CTX_free(s->session_ctx);
1186 #ifndef OPENSSL_NO_EC
1187 OPENSSL_free(s->ext.ecpointformats);
1188 OPENSSL_free(s->ext.peer_ecpointformats);
1189 OPENSSL_free(s->ext.supportedgroups);
1190 OPENSSL_free(s->ext.peer_supportedgroups);
1191 #endif /* OPENSSL_NO_EC */
1192 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1193 #ifndef OPENSSL_NO_OCSP
1194 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1196 #ifndef OPENSSL_NO_CT
1197 SCT_LIST_free(s->scts);
1198 OPENSSL_free(s->ext.scts);
1200 OPENSSL_free(s->ext.ocsp.resp);
1201 OPENSSL_free(s->ext.alpn);
1202 OPENSSL_free(s->ext.tls13_cookie);
1203 if (s->clienthello != NULL)
1204 OPENSSL_free(s->clienthello->pre_proc_exts);
1205 OPENSSL_free(s->clienthello);
1206 OPENSSL_free(s->pha_context);
1207 EVP_MD_CTX_free(s->pha_dgst);
1209 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1210 sk_X509_NAME_pop_free(s->client_ca_names, X509_NAME_free);
1212 sk_X509_pop_free(s->verified_chain, X509_free);
1214 if (s->method != NULL)
1215 s->method->ssl_free(s);
1217 RECORD_LAYER_release(&s->rlayer);
1219 SSL_CTX_free(s->ctx);
1221 ASYNC_WAIT_CTX_free(s->waitctx);
1223 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1224 OPENSSL_free(s->ext.npn);
1227 #ifndef OPENSSL_NO_SRTP
1228 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1231 CRYPTO_THREAD_lock_free(s->lock);
1236 void SSL_set0_rbio(SSL *s, BIO *rbio)
1238 BIO_free_all(s->rbio);
1242 void SSL_set0_wbio(SSL *s, BIO *wbio)
1245 * If the output buffering BIO is still in place, remove it
1247 if (s->bbio != NULL)
1248 s->wbio = BIO_pop(s->wbio);
1250 BIO_free_all(s->wbio);
1253 /* Re-attach |bbio| to the new |wbio|. */
1254 if (s->bbio != NULL)
1255 s->wbio = BIO_push(s->bbio, s->wbio);
1258 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1261 * For historical reasons, this function has many different cases in
1262 * ownership handling.
1265 /* If nothing has changed, do nothing */
1266 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1270 * If the two arguments are equal then one fewer reference is granted by the
1271 * caller than we want to take
1273 if (rbio != NULL && rbio == wbio)
1277 * If only the wbio is changed only adopt one reference.
1279 if (rbio == SSL_get_rbio(s)) {
1280 SSL_set0_wbio(s, wbio);
1284 * There is an asymmetry here for historical reasons. If only the rbio is
1285 * changed AND the rbio and wbio were originally different, then we only
1286 * adopt one reference.
1288 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1289 SSL_set0_rbio(s, rbio);
1293 /* Otherwise, adopt both references. */
1294 SSL_set0_rbio(s, rbio);
1295 SSL_set0_wbio(s, wbio);
1298 BIO *SSL_get_rbio(const SSL *s)
1303 BIO *SSL_get_wbio(const SSL *s)
1305 if (s->bbio != NULL) {
1307 * If |bbio| is active, the true caller-configured BIO is its
1310 return BIO_next(s->bbio);
1315 int SSL_get_fd(const SSL *s)
1317 return SSL_get_rfd(s);
1320 int SSL_get_rfd(const SSL *s)
1325 b = SSL_get_rbio(s);
1326 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1328 BIO_get_fd(r, &ret);
1332 int SSL_get_wfd(const SSL *s)
1337 b = SSL_get_wbio(s);
1338 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1340 BIO_get_fd(r, &ret);
1344 #ifndef OPENSSL_NO_SOCK
1345 int SSL_set_fd(SSL *s, int fd)
1350 bio = BIO_new(BIO_s_socket());
1353 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1356 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1357 SSL_set_bio(s, bio, bio);
1363 int SSL_set_wfd(SSL *s, int fd)
1365 BIO *rbio = SSL_get_rbio(s);
1367 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1368 || (int)BIO_get_fd(rbio, NULL) != fd) {
1369 BIO *bio = BIO_new(BIO_s_socket());
1372 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1375 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1376 SSL_set0_wbio(s, bio);
1379 SSL_set0_wbio(s, rbio);
1384 int SSL_set_rfd(SSL *s, int fd)
1386 BIO *wbio = SSL_get_wbio(s);
1388 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1389 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1390 BIO *bio = BIO_new(BIO_s_socket());
1393 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1396 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1397 SSL_set0_rbio(s, bio);
1400 SSL_set0_rbio(s, wbio);
1407 /* return length of latest Finished message we sent, copy to 'buf' */
1408 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1412 if (s->s3 != NULL) {
1413 ret = s->s3->tmp.finish_md_len;
1416 memcpy(buf, s->s3->tmp.finish_md, count);
1421 /* return length of latest Finished message we expected, copy to 'buf' */
1422 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1426 if (s->s3 != NULL) {
1427 ret = s->s3->tmp.peer_finish_md_len;
1430 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1435 int SSL_get_verify_mode(const SSL *s)
1437 return s->verify_mode;
1440 int SSL_get_verify_depth(const SSL *s)
1442 return X509_VERIFY_PARAM_get_depth(s->param);
1445 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1446 return s->verify_callback;
1449 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1451 return ctx->verify_mode;
1454 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1456 return X509_VERIFY_PARAM_get_depth(ctx->param);
1459 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1460 return ctx->default_verify_callback;
1463 void SSL_set_verify(SSL *s, int mode,
1464 int (*callback) (int ok, X509_STORE_CTX *ctx))
1466 s->verify_mode = mode;
1467 if (callback != NULL)
1468 s->verify_callback = callback;
1471 void SSL_set_verify_depth(SSL *s, int depth)
1473 X509_VERIFY_PARAM_set_depth(s->param, depth);
1476 void SSL_set_read_ahead(SSL *s, int yes)
1478 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1481 int SSL_get_read_ahead(const SSL *s)
1483 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1486 int SSL_pending(const SSL *s)
1488 size_t pending = s->method->ssl_pending(s);
1491 * SSL_pending cannot work properly if read-ahead is enabled
1492 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1493 * impossible to fix since SSL_pending cannot report errors that may be
1494 * observed while scanning the new data. (Note that SSL_pending() is
1495 * often used as a boolean value, so we'd better not return -1.)
1497 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1498 * we just return INT_MAX.
1500 return pending < INT_MAX ? (int)pending : INT_MAX;
1503 int SSL_has_pending(const SSL *s)
1506 * Similar to SSL_pending() but returns a 1 to indicate that we have
1507 * unprocessed data available or 0 otherwise (as opposed to the number of
1508 * bytes available). Unlike SSL_pending() this will take into account
1509 * read_ahead data. A 1 return simply indicates that we have unprocessed
1510 * data. That data may not result in any application data, or we may fail
1511 * to parse the records for some reason.
1513 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1516 return RECORD_LAYER_read_pending(&s->rlayer);
1519 X509 *SSL_get_peer_certificate(const SSL *s)
1523 if ((s == NULL) || (s->session == NULL))
1526 r = s->session->peer;
1536 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1540 if ((s == NULL) || (s->session == NULL))
1543 r = s->session->peer_chain;
1546 * If we are a client, cert_chain includes the peer's own certificate; if
1547 * we are a server, it does not.
1554 * Now in theory, since the calling process own 't' it should be safe to
1555 * modify. We need to be able to read f without being hassled
1557 int SSL_copy_session_id(SSL *t, const SSL *f)
1560 /* Do we need to to SSL locking? */
1561 if (!SSL_set_session(t, SSL_get_session(f))) {
1566 * what if we are setup for one protocol version but want to talk another
1568 if (t->method != f->method) {
1569 t->method->ssl_free(t);
1570 t->method = f->method;
1571 if (t->method->ssl_new(t) == 0)
1575 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1576 ssl_cert_free(t->cert);
1578 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1585 /* Fix this so it checks all the valid key/cert options */
1586 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1588 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1589 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1592 if (ctx->cert->key->privatekey == NULL) {
1593 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1596 return X509_check_private_key
1597 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1600 /* Fix this function so that it takes an optional type parameter */
1601 int SSL_check_private_key(const SSL *ssl)
1604 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1607 if (ssl->cert->key->x509 == NULL) {
1608 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1611 if (ssl->cert->key->privatekey == NULL) {
1612 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1615 return X509_check_private_key(ssl->cert->key->x509,
1616 ssl->cert->key->privatekey);
1619 int SSL_waiting_for_async(SSL *s)
1627 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1629 ASYNC_WAIT_CTX *ctx = s->waitctx;
1633 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1636 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1637 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1639 ASYNC_WAIT_CTX *ctx = s->waitctx;
1643 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1647 int SSL_accept(SSL *s)
1649 if (s->handshake_func == NULL) {
1650 /* Not properly initialized yet */
1651 SSL_set_accept_state(s);
1654 return SSL_do_handshake(s);
1657 int SSL_connect(SSL *s)
1659 if (s->handshake_func == NULL) {
1660 /* Not properly initialized yet */
1661 SSL_set_connect_state(s);
1664 return SSL_do_handshake(s);
1667 long SSL_get_default_timeout(const SSL *s)
1669 return s->method->get_timeout();
1672 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1673 int (*func) (void *))
1676 if (s->waitctx == NULL) {
1677 s->waitctx = ASYNC_WAIT_CTX_new();
1678 if (s->waitctx == NULL)
1681 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1682 sizeof(struct ssl_async_args))) {
1684 s->rwstate = SSL_NOTHING;
1685 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1688 s->rwstate = SSL_ASYNC_PAUSED;
1691 s->rwstate = SSL_ASYNC_NO_JOBS;
1697 s->rwstate = SSL_NOTHING;
1698 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1699 /* Shouldn't happen */
1704 static int ssl_io_intern(void *vargs)
1706 struct ssl_async_args *args;
1711 args = (struct ssl_async_args *)vargs;
1715 switch (args->type) {
1717 return args->f.func_read(s, buf, num, &s->asyncrw);
1719 return args->f.func_write(s, buf, num, &s->asyncrw);
1721 return args->f.func_other(s);
1726 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1728 if (s->handshake_func == NULL) {
1729 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1733 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1734 s->rwstate = SSL_NOTHING;
1738 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1739 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1740 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1744 * If we are a client and haven't received the ServerHello etc then we
1747 ossl_statem_check_finish_init(s, 0);
1749 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1750 struct ssl_async_args args;
1756 args.type = READFUNC;
1757 args.f.func_read = s->method->ssl_read;
1759 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1760 *readbytes = s->asyncrw;
1763 return s->method->ssl_read(s, buf, num, readbytes);
1767 int SSL_read(SSL *s, void *buf, int num)
1773 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1777 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1780 * The cast is safe here because ret should be <= INT_MAX because num is
1784 ret = (int)readbytes;
1789 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1791 int ret = ssl_read_internal(s, buf, num, readbytes);
1798 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1803 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1804 return SSL_READ_EARLY_DATA_ERROR;
1807 switch (s->early_data_state) {
1808 case SSL_EARLY_DATA_NONE:
1809 if (!SSL_in_before(s)) {
1810 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1811 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1812 return SSL_READ_EARLY_DATA_ERROR;
1816 case SSL_EARLY_DATA_ACCEPT_RETRY:
1817 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1818 ret = SSL_accept(s);
1821 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1822 return SSL_READ_EARLY_DATA_ERROR;
1826 case SSL_EARLY_DATA_READ_RETRY:
1827 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1828 s->early_data_state = SSL_EARLY_DATA_READING;
1829 ret = SSL_read_ex(s, buf, num, readbytes);
1831 * State machine will update early_data_state to
1832 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1835 if (ret > 0 || (ret <= 0 && s->early_data_state
1836 != SSL_EARLY_DATA_FINISHED_READING)) {
1837 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1838 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1839 : SSL_READ_EARLY_DATA_ERROR;
1842 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1845 return SSL_READ_EARLY_DATA_FINISH;
1848 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1849 return SSL_READ_EARLY_DATA_ERROR;
1853 int SSL_get_early_data_status(const SSL *s)
1855 return s->ext.early_data;
1858 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1860 if (s->handshake_func == NULL) {
1861 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1865 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1868 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1869 struct ssl_async_args args;
1875 args.type = READFUNC;
1876 args.f.func_read = s->method->ssl_peek;
1878 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1879 *readbytes = s->asyncrw;
1882 return s->method->ssl_peek(s, buf, num, readbytes);
1886 int SSL_peek(SSL *s, void *buf, int num)
1892 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1896 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1899 * The cast is safe here because ret should be <= INT_MAX because num is
1903 ret = (int)readbytes;
1909 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1911 int ret = ssl_peek_internal(s, buf, num, readbytes);
1918 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1920 if (s->handshake_func == NULL) {
1921 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1925 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1926 s->rwstate = SSL_NOTHING;
1927 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1931 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1932 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1933 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1934 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1937 /* If we are a client and haven't sent the Finished we better do that */
1938 ossl_statem_check_finish_init(s, 1);
1940 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1942 struct ssl_async_args args;
1945 args.buf = (void *)buf;
1947 args.type = WRITEFUNC;
1948 args.f.func_write = s->method->ssl_write;
1950 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1951 *written = s->asyncrw;
1954 return s->method->ssl_write(s, buf, num, written);
1958 int SSL_write(SSL *s, const void *buf, int num)
1964 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1968 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1971 * The cast is safe here because ret should be <= INT_MAX because num is
1980 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1982 int ret = ssl_write_internal(s, buf, num, written);
1989 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1991 int ret, early_data_state;
1993 uint32_t partialwrite;
1995 switch (s->early_data_state) {
1996 case SSL_EARLY_DATA_NONE:
1998 || !SSL_in_before(s)
1999 || ((s->session == NULL || s->session->ext.max_early_data == 0)
2000 && (s->psk_use_session_cb == NULL))) {
2001 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
2002 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2007 case SSL_EARLY_DATA_CONNECT_RETRY:
2008 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
2009 ret = SSL_connect(s);
2012 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2017 case SSL_EARLY_DATA_WRITE_RETRY:
2018 s->early_data_state = SSL_EARLY_DATA_WRITING;
2020 * We disable partial write for early data because we don't keep track
2021 * of how many bytes we've written between the SSL_write_ex() call and
2022 * the flush if the flush needs to be retried)
2024 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2025 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2026 ret = SSL_write_ex(s, buf, num, &writtmp);
2027 s->mode |= partialwrite;
2029 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2032 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2035 case SSL_EARLY_DATA_WRITE_FLUSH:
2036 /* The buffering BIO is still in place so we need to flush it */
2037 if (statem_flush(s) != 1)
2040 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2043 case SSL_EARLY_DATA_FINISHED_READING:
2044 case SSL_EARLY_DATA_READ_RETRY:
2045 early_data_state = s->early_data_state;
2046 /* We are a server writing to an unauthenticated client */
2047 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2048 ret = SSL_write_ex(s, buf, num, written);
2049 /* The buffering BIO is still in place */
2051 (void)BIO_flush(s->wbio);
2052 s->early_data_state = early_data_state;
2056 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2061 int SSL_shutdown(SSL *s)
2064 * Note that this function behaves differently from what one might
2065 * expect. Return values are 0 for no success (yet), 1 for success; but
2066 * calling it once is usually not enough, even if blocking I/O is used
2067 * (see ssl3_shutdown).
2070 if (s->handshake_func == NULL) {
2071 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2075 if (!SSL_in_init(s)) {
2076 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2077 struct ssl_async_args args;
2080 args.type = OTHERFUNC;
2081 args.f.func_other = s->method->ssl_shutdown;
2083 return ssl_start_async_job(s, &args, ssl_io_intern);
2085 return s->method->ssl_shutdown(s);
2088 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2093 int SSL_key_update(SSL *s, int updatetype)
2096 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2097 * negotiated, and that it is appropriate to call SSL_key_update() instead
2098 * of SSL_renegotiate().
2100 if (!SSL_IS_TLS13(s)) {
2101 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2105 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2106 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2107 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2111 if (!SSL_is_init_finished(s)) {
2112 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2116 ossl_statem_set_in_init(s, 1);
2117 s->key_update = updatetype;
2121 int SSL_get_key_update_type(const SSL *s)
2123 return s->key_update;
2126 int SSL_renegotiate(SSL *s)
2128 if (SSL_IS_TLS13(s)) {
2129 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2133 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2134 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2141 return s->method->ssl_renegotiate(s);
2144 int SSL_renegotiate_abbreviated(SSL *s)
2146 if (SSL_IS_TLS13(s)) {
2147 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2151 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2152 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2159 return s->method->ssl_renegotiate(s);
2162 int SSL_renegotiate_pending(const SSL *s)
2165 * becomes true when negotiation is requested; false again once a
2166 * handshake has finished
2168 return (s->renegotiate != 0);
2171 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2176 case SSL_CTRL_GET_READ_AHEAD:
2177 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2178 case SSL_CTRL_SET_READ_AHEAD:
2179 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2180 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2183 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2184 s->msg_callback_arg = parg;
2188 return (s->mode |= larg);
2189 case SSL_CTRL_CLEAR_MODE:
2190 return (s->mode &= ~larg);
2191 case SSL_CTRL_GET_MAX_CERT_LIST:
2192 return (long)s->max_cert_list;
2193 case SSL_CTRL_SET_MAX_CERT_LIST:
2196 l = (long)s->max_cert_list;
2197 s->max_cert_list = (size_t)larg;
2199 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2200 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2202 s->max_send_fragment = larg;
2203 if (s->max_send_fragment < s->split_send_fragment)
2204 s->split_send_fragment = s->max_send_fragment;
2206 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2207 if ((size_t)larg > s->max_send_fragment || larg == 0)
2209 s->split_send_fragment = larg;
2211 case SSL_CTRL_SET_MAX_PIPELINES:
2212 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2214 s->max_pipelines = larg;
2216 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2218 case SSL_CTRL_GET_RI_SUPPORT:
2220 return s->s3->send_connection_binding;
2223 case SSL_CTRL_CERT_FLAGS:
2224 return (s->cert->cert_flags |= larg);
2225 case SSL_CTRL_CLEAR_CERT_FLAGS:
2226 return (s->cert->cert_flags &= ~larg);
2228 case SSL_CTRL_GET_RAW_CIPHERLIST:
2230 if (s->s3->tmp.ciphers_raw == NULL)
2232 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2233 return (int)s->s3->tmp.ciphers_rawlen;
2235 return TLS_CIPHER_LEN;
2237 case SSL_CTRL_GET_EXTMS_SUPPORT:
2238 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2240 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2244 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2245 return ssl_check_allowed_versions(larg, s->max_proto_version)
2246 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2247 &s->min_proto_version);
2248 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2249 return s->min_proto_version;
2250 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2251 return ssl_check_allowed_versions(s->min_proto_version, larg)
2252 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2253 &s->max_proto_version);
2254 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2255 return s->max_proto_version;
2257 return s->method->ssl_ctrl(s, cmd, larg, parg);
2261 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2264 case SSL_CTRL_SET_MSG_CALLBACK:
2265 s->msg_callback = (void (*)
2266 (int write_p, int version, int content_type,
2267 const void *buf, size_t len, SSL *ssl,
2272 return s->method->ssl_callback_ctrl(s, cmd, fp);
2276 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2278 return ctx->sessions;
2281 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2284 /* For some cases with ctx == NULL perform syntax checks */
2287 #ifndef OPENSSL_NO_EC
2288 case SSL_CTRL_SET_GROUPS_LIST:
2289 return tls1_set_groups_list(NULL, NULL, parg);
2291 case SSL_CTRL_SET_SIGALGS_LIST:
2292 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2293 return tls1_set_sigalgs_list(NULL, parg, 0);
2300 case SSL_CTRL_GET_READ_AHEAD:
2301 return ctx->read_ahead;
2302 case SSL_CTRL_SET_READ_AHEAD:
2303 l = ctx->read_ahead;
2304 ctx->read_ahead = larg;
2307 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2308 ctx->msg_callback_arg = parg;
2311 case SSL_CTRL_GET_MAX_CERT_LIST:
2312 return (long)ctx->max_cert_list;
2313 case SSL_CTRL_SET_MAX_CERT_LIST:
2316 l = (long)ctx->max_cert_list;
2317 ctx->max_cert_list = (size_t)larg;
2320 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2323 l = (long)ctx->session_cache_size;
2324 ctx->session_cache_size = (size_t)larg;
2326 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2327 return (long)ctx->session_cache_size;
2328 case SSL_CTRL_SET_SESS_CACHE_MODE:
2329 l = ctx->session_cache_mode;
2330 ctx->session_cache_mode = larg;
2332 case SSL_CTRL_GET_SESS_CACHE_MODE:
2333 return ctx->session_cache_mode;
2335 case SSL_CTRL_SESS_NUMBER:
2336 return lh_SSL_SESSION_num_items(ctx->sessions);
2337 case SSL_CTRL_SESS_CONNECT:
2338 return tsan_load(&ctx->stats.sess_connect);
2339 case SSL_CTRL_SESS_CONNECT_GOOD:
2340 return tsan_load(&ctx->stats.sess_connect_good);
2341 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2342 return tsan_load(&ctx->stats.sess_connect_renegotiate);
2343 case SSL_CTRL_SESS_ACCEPT:
2344 return tsan_load(&ctx->stats.sess_accept);
2345 case SSL_CTRL_SESS_ACCEPT_GOOD:
2346 return tsan_load(&ctx->stats.sess_accept_good);
2347 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2348 return tsan_load(&ctx->stats.sess_accept_renegotiate);
2349 case SSL_CTRL_SESS_HIT:
2350 return tsan_load(&ctx->stats.sess_hit);
2351 case SSL_CTRL_SESS_CB_HIT:
2352 return tsan_load(&ctx->stats.sess_cb_hit);
2353 case SSL_CTRL_SESS_MISSES:
2354 return tsan_load(&ctx->stats.sess_miss);
2355 case SSL_CTRL_SESS_TIMEOUTS:
2356 return tsan_load(&ctx->stats.sess_timeout);
2357 case SSL_CTRL_SESS_CACHE_FULL:
2358 return tsan_load(&ctx->stats.sess_cache_full);
2360 return (ctx->mode |= larg);
2361 case SSL_CTRL_CLEAR_MODE:
2362 return (ctx->mode &= ~larg);
2363 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2364 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2366 ctx->max_send_fragment = larg;
2367 if (ctx->max_send_fragment < ctx->split_send_fragment)
2368 ctx->split_send_fragment = ctx->max_send_fragment;
2370 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2371 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2373 ctx->split_send_fragment = larg;
2375 case SSL_CTRL_SET_MAX_PIPELINES:
2376 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2378 ctx->max_pipelines = larg;
2380 case SSL_CTRL_CERT_FLAGS:
2381 return (ctx->cert->cert_flags |= larg);
2382 case SSL_CTRL_CLEAR_CERT_FLAGS:
2383 return (ctx->cert->cert_flags &= ~larg);
2384 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2385 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2386 && ssl_set_version_bound(ctx->method->version, (int)larg,
2387 &ctx->min_proto_version);
2388 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2389 return ctx->min_proto_version;
2390 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2391 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2392 && ssl_set_version_bound(ctx->method->version, (int)larg,
2393 &ctx->max_proto_version);
2394 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2395 return ctx->max_proto_version;
2397 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2401 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2404 case SSL_CTRL_SET_MSG_CALLBACK:
2405 ctx->msg_callback = (void (*)
2406 (int write_p, int version, int content_type,
2407 const void *buf, size_t len, SSL *ssl,
2412 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2416 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2425 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2426 const SSL_CIPHER *const *bp)
2428 if ((*ap)->id > (*bp)->id)
2430 if ((*ap)->id < (*bp)->id)
2435 /** return a STACK of the ciphers available for the SSL and in order of
2437 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2440 if (s->cipher_list != NULL) {
2441 return s->cipher_list;
2442 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2443 return s->ctx->cipher_list;
2449 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2451 if ((s == NULL) || !s->server)
2453 return s->peer_ciphers;
2456 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2458 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2461 ciphers = SSL_get_ciphers(s);
2464 if (!ssl_set_client_disabled(s))
2466 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2467 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2468 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2470 sk = sk_SSL_CIPHER_new_null();
2473 if (!sk_SSL_CIPHER_push(sk, c)) {
2474 sk_SSL_CIPHER_free(sk);
2482 /** return a STACK of the ciphers available for the SSL and in order of
2484 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2487 if (s->cipher_list_by_id != NULL) {
2488 return s->cipher_list_by_id;
2489 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2490 return s->ctx->cipher_list_by_id;
2496 /** The old interface to get the same thing as SSL_get_ciphers() */
2497 const char *SSL_get_cipher_list(const SSL *s, int n)
2499 const SSL_CIPHER *c;
2500 STACK_OF(SSL_CIPHER) *sk;
2504 sk = SSL_get_ciphers(s);
2505 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2507 c = sk_SSL_CIPHER_value(sk, n);
2513 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2515 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2518 return ctx->cipher_list;
2523 * Distinguish between ciphers controlled by set_ciphersuite() and
2524 * set_cipher_list() when counting.
2526 static int cipher_list_tls12_num(STACK_OF(SSL_CIPHER) *sk)
2529 const SSL_CIPHER *c;
2533 for (i = 0; i < sk_SSL_CIPHER_num(sk); ++i) {
2534 c = sk_SSL_CIPHER_value(sk, i);
2535 if (c->min_tls >= TLS1_3_VERSION)
2542 /** specify the ciphers to be used by default by the SSL_CTX */
2543 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2545 STACK_OF(SSL_CIPHER) *sk;
2547 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2548 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2551 * ssl_create_cipher_list may return an empty stack if it was unable to
2552 * find a cipher matching the given rule string (for example if the rule
2553 * string specifies a cipher which has been disabled). This is not an
2554 * error as far as ssl_create_cipher_list is concerned, and hence
2555 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2559 else if (cipher_list_tls12_num(sk) == 0) {
2560 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2566 /** specify the ciphers to be used by the SSL */
2567 int SSL_set_cipher_list(SSL *s, const char *str)
2569 STACK_OF(SSL_CIPHER) *sk;
2571 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2572 &s->cipher_list, &s->cipher_list_by_id, str,
2574 /* see comment in SSL_CTX_set_cipher_list */
2577 else if (cipher_list_tls12_num(sk) == 0) {
2578 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2584 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2587 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2588 const SSL_CIPHER *c;
2592 || s->peer_ciphers == NULL
2597 clntsk = s->peer_ciphers;
2598 srvrsk = SSL_get_ciphers(s);
2599 if (clntsk == NULL || srvrsk == NULL)
2602 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2605 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2608 c = sk_SSL_CIPHER_value(clntsk, i);
2609 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2612 n = strlen(c->name);
2629 * Return the requested servername (SNI) value. Note that the behaviour varies
2631 * - whether this is called by the client or the server,
2632 * - if we are before or during/after the handshake,
2633 * - if a resumption or normal handshake is being attempted/has occurred
2634 * - whether we have negotiated TLSv1.2 (or below) or TLSv1.3
2636 * Note that only the host_name type is defined (RFC 3546).
2638 const char *SSL_get_servername(const SSL *s, const int type)
2641 * If we don't know if we are the client or the server yet then we assume
2644 int server = s->handshake_func == NULL ? 0 : s->server;
2645 if (type != TLSEXT_NAMETYPE_host_name)
2651 * In TLSv1.3 on the server SNI is not associated with the session
2652 * but in TLSv1.2 or below it is.
2654 * Before the handshake:
2657 * During/after the handshake (TLSv1.2 or below resumption occurred):
2658 * - If a servername was accepted by the server in the original
2659 * handshake then it will return that servername, or NULL otherwise.
2661 * During/after the handshake (TLSv1.2 or below resumption did not occur):
2662 * - The function will return the servername requested by the client in
2663 * this handshake or NULL if none was requested.
2665 if (s->hit && !SSL_IS_TLS13(s))
2666 return s->session->ext.hostname;
2671 * Before the handshake:
2672 * - If a servername has been set via a call to
2673 * SSL_set_tlsext_host_name() then it will return that servername
2674 * - If one has not been set, but a TLSv1.2 resumption is being
2675 * attempted and the session from the original handshake had a
2676 * servername accepted by the server then it will return that
2678 * - Otherwise it returns NULL
2680 * During/after the handshake (TLSv1.2 or below resumption occurred):
2681 * - If the session from the orignal handshake had a servername accepted
2682 * by the server then it will return that servername.
2683 * - Otherwise it returns the servername set via
2684 * SSL_set_tlsext_host_name() (or NULL if it was not called).
2686 * During/after the handshake (TLSv1.2 or below resumption did not occur):
2687 * - It will return the servername set via SSL_set_tlsext_host_name()
2688 * (or NULL if it was not called).
2690 if (SSL_in_before(s)) {
2691 if (s->ext.hostname == NULL
2692 && s->session != NULL
2693 && s->session->ssl_version != TLS1_3_VERSION)
2694 return s->session->ext.hostname;
2696 if (!SSL_IS_TLS13(s) && s->hit && s->session->ext.hostname != NULL)
2697 return s->session->ext.hostname;
2701 return s->ext.hostname;
2704 int SSL_get_servername_type(const SSL *s)
2706 if (SSL_get_servername(s, TLSEXT_NAMETYPE_host_name) != NULL)
2707 return TLSEXT_NAMETYPE_host_name;
2712 * SSL_select_next_proto implements the standard protocol selection. It is
2713 * expected that this function is called from the callback set by
2714 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2715 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2716 * not included in the length. A byte string of length 0 is invalid. No byte
2717 * string may be truncated. The current, but experimental algorithm for
2718 * selecting the protocol is: 1) If the server doesn't support NPN then this
2719 * is indicated to the callback. In this case, the client application has to
2720 * abort the connection or have a default application level protocol. 2) If
2721 * the server supports NPN, but advertises an empty list then the client
2722 * selects the first protocol in its list, but indicates via the API that this
2723 * fallback case was enacted. 3) Otherwise, the client finds the first
2724 * protocol in the server's list that it supports and selects this protocol.
2725 * This is because it's assumed that the server has better information about
2726 * which protocol a client should use. 4) If the client doesn't support any
2727 * of the server's advertised protocols, then this is treated the same as
2728 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2729 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2731 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2732 const unsigned char *server,
2733 unsigned int server_len,
2734 const unsigned char *client, unsigned int client_len)
2737 const unsigned char *result;
2738 int status = OPENSSL_NPN_UNSUPPORTED;
2741 * For each protocol in server preference order, see if we support it.
2743 for (i = 0; i < server_len;) {
2744 for (j = 0; j < client_len;) {
2745 if (server[i] == client[j] &&
2746 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2747 /* We found a match */
2748 result = &server[i];
2749 status = OPENSSL_NPN_NEGOTIATED;
2759 /* There's no overlap between our protocols and the server's list. */
2761 status = OPENSSL_NPN_NO_OVERLAP;
2764 *out = (unsigned char *)result + 1;
2765 *outlen = result[0];
2769 #ifndef OPENSSL_NO_NEXTPROTONEG
2771 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2772 * client's requested protocol for this connection and returns 0. If the
2773 * client didn't request any protocol, then *data is set to NULL. Note that
2774 * the client can request any protocol it chooses. The value returned from
2775 * this function need not be a member of the list of supported protocols
2776 * provided by the callback.
2778 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2785 *len = (unsigned int)s->ext.npn_len;
2790 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2791 * a TLS server needs a list of supported protocols for Next Protocol
2792 * Negotiation. The returned list must be in wire format. The list is
2793 * returned by setting |out| to point to it and |outlen| to its length. This
2794 * memory will not be modified, but one should assume that the SSL* keeps a
2795 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2796 * wishes to advertise. Otherwise, no such extension will be included in the
2799 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2800 SSL_CTX_npn_advertised_cb_func cb,
2803 ctx->ext.npn_advertised_cb = cb;
2804 ctx->ext.npn_advertised_cb_arg = arg;
2808 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2809 * client needs to select a protocol from the server's provided list. |out|
2810 * must be set to point to the selected protocol (which may be within |in|).
2811 * The length of the protocol name must be written into |outlen|. The
2812 * server's advertised protocols are provided in |in| and |inlen|. The
2813 * callback can assume that |in| is syntactically valid. The client must
2814 * select a protocol. It is fatal to the connection if this callback returns
2815 * a value other than SSL_TLSEXT_ERR_OK.
2817 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2818 SSL_CTX_npn_select_cb_func cb,
2821 ctx->ext.npn_select_cb = cb;
2822 ctx->ext.npn_select_cb_arg = arg;
2827 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2828 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2829 * length-prefixed strings). Returns 0 on success.
2831 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2832 unsigned int protos_len)
2834 OPENSSL_free(ctx->ext.alpn);
2835 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2836 if (ctx->ext.alpn == NULL) {
2837 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2840 ctx->ext.alpn_len = protos_len;
2846 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2847 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2848 * length-prefixed strings). Returns 0 on success.
2850 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2851 unsigned int protos_len)
2853 OPENSSL_free(ssl->ext.alpn);
2854 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2855 if (ssl->ext.alpn == NULL) {
2856 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2859 ssl->ext.alpn_len = protos_len;
2865 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2866 * called during ClientHello processing in order to select an ALPN protocol
2867 * from the client's list of offered protocols.
2869 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2870 SSL_CTX_alpn_select_cb_func cb,
2873 ctx->ext.alpn_select_cb = cb;
2874 ctx->ext.alpn_select_cb_arg = arg;
2878 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2879 * On return it sets |*data| to point to |*len| bytes of protocol name
2880 * (not including the leading length-prefix byte). If the server didn't
2881 * respond with a negotiated protocol then |*len| will be zero.
2883 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2888 *data = ssl->s3->alpn_selected;
2892 *len = (unsigned int)ssl->s3->alpn_selected_len;
2895 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2896 const char *label, size_t llen,
2897 const unsigned char *context, size_t contextlen,
2900 if (s->session == NULL
2901 || (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER))
2904 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2906 contextlen, use_context);
2909 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2910 const char *label, size_t llen,
2911 const unsigned char *context,
2914 if (s->version != TLS1_3_VERSION)
2917 return tls13_export_keying_material_early(s, out, olen, label, llen,
2918 context, contextlen);
2921 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2923 const unsigned char *session_id = a->session_id;
2925 unsigned char tmp_storage[4];
2927 if (a->session_id_length < sizeof(tmp_storage)) {
2928 memset(tmp_storage, 0, sizeof(tmp_storage));
2929 memcpy(tmp_storage, a->session_id, a->session_id_length);
2930 session_id = tmp_storage;
2934 ((unsigned long)session_id[0]) |
2935 ((unsigned long)session_id[1] << 8L) |
2936 ((unsigned long)session_id[2] << 16L) |
2937 ((unsigned long)session_id[3] << 24L);
2942 * NB: If this function (or indeed the hash function which uses a sort of
2943 * coarser function than this one) is changed, ensure
2944 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2945 * being able to construct an SSL_SESSION that will collide with any existing
2946 * session with a matching session ID.
2948 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2950 if (a->ssl_version != b->ssl_version)
2952 if (a->session_id_length != b->session_id_length)
2954 return memcmp(a->session_id, b->session_id, a->session_id_length);
2958 * These wrapper functions should remain rather than redeclaring
2959 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2960 * variable. The reason is that the functions aren't static, they're exposed
2964 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2966 SSL_CTX *ret = NULL;
2969 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2973 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2976 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2977 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2980 ret = OPENSSL_zalloc(sizeof(*ret));
2985 ret->min_proto_version = 0;
2986 ret->max_proto_version = 0;
2987 ret->mode = SSL_MODE_AUTO_RETRY;
2988 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2989 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2990 /* We take the system default. */
2991 ret->session_timeout = meth->get_timeout();
2992 ret->references = 1;
2993 ret->lock = CRYPTO_THREAD_lock_new();
2994 if (ret->lock == NULL) {
2995 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2999 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
3000 ret->verify_mode = SSL_VERIFY_NONE;
3001 if ((ret->cert = ssl_cert_new()) == NULL)
3004 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
3005 if (ret->sessions == NULL)
3007 ret->cert_store = X509_STORE_new();
3008 if (ret->cert_store == NULL)
3010 #ifndef OPENSSL_NO_CT
3011 ret->ctlog_store = CTLOG_STORE_new();
3012 if (ret->ctlog_store == NULL)
3016 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
3019 if (!ssl_create_cipher_list(ret->method,
3020 ret->tls13_ciphersuites,
3021 &ret->cipher_list, &ret->cipher_list_by_id,
3022 SSL_DEFAULT_CIPHER_LIST, ret->cert)
3023 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
3024 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
3028 ret->param = X509_VERIFY_PARAM_new();
3029 if (ret->param == NULL)
3032 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
3033 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
3036 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
3037 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
3041 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
3044 if ((ret->client_ca_names = sk_X509_NAME_new_null()) == NULL)
3047 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
3050 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
3053 /* No compression for DTLS */
3054 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
3055 ret->comp_methods = SSL_COMP_get_compression_methods();
3057 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3058 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3060 /* Setup RFC5077 ticket keys */
3061 if ((RAND_bytes(ret->ext.tick_key_name,
3062 sizeof(ret->ext.tick_key_name)) <= 0)
3063 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
3064 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
3065 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
3066 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
3067 ret->options |= SSL_OP_NO_TICKET;
3069 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
3070 sizeof(ret->ext.cookie_hmac_key)) <= 0)
3073 #ifndef OPENSSL_NO_SRP
3074 if (!SSL_CTX_SRP_CTX_init(ret))
3077 #ifndef OPENSSL_NO_ENGINE
3078 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3079 # define eng_strx(x) #x
3080 # define eng_str(x) eng_strx(x)
3081 /* Use specific client engine automatically... ignore errors */
3084 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3087 ENGINE_load_builtin_engines();
3088 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3090 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3096 * Default is to connect to non-RI servers. When RI is more widely
3097 * deployed might change this.
3099 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3101 * Disable compression by default to prevent CRIME. Applications can
3102 * re-enable compression by configuring
3103 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3104 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3105 * middlebox compatibility by default. This may be disabled by default in
3106 * a later OpenSSL version.
3108 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3110 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3113 * We cannot usefully set a default max_early_data here (which gets
3114 * propagated in SSL_new(), for the following reason: setting the
3115 * SSL field causes tls_construct_stoc_early_data() to tell the
3116 * client that early data will be accepted when constructing a TLS 1.3
3117 * session ticket, and the client will accordingly send us early data
3118 * when using that ticket (if the client has early data to send).
3119 * However, in order for the early data to actually be consumed by
3120 * the application, the application must also have calls to
3121 * SSL_read_early_data(); otherwise we'll just skip past the early data
3122 * and ignore it. So, since the application must add calls to
3123 * SSL_read_early_data(), we also require them to add
3124 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3125 * eliminating the bandwidth-wasting early data in the case described
3128 ret->max_early_data = 0;
3131 * Default recv_max_early_data is a fully loaded single record. Could be
3132 * split across multiple records in practice. We set this differently to
3133 * max_early_data so that, in the default case, we do not advertise any
3134 * support for early_data, but if a client were to send us some (e.g.
3135 * because of an old, stale ticket) then we will tolerate it and skip over
3138 ret->recv_max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
3140 /* By default we send two session tickets automatically in TLSv1.3 */
3141 ret->num_tickets = 2;
3143 ssl_ctx_system_config(ret);
3147 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3153 int SSL_CTX_up_ref(SSL_CTX *ctx)
3157 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3160 REF_PRINT_COUNT("SSL_CTX", ctx);
3161 REF_ASSERT_ISNT(i < 2);
3162 return ((i > 1) ? 1 : 0);
3165 void SSL_CTX_free(SSL_CTX *a)
3172 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3173 REF_PRINT_COUNT("SSL_CTX", a);
3176 REF_ASSERT_ISNT(i < 0);
3178 X509_VERIFY_PARAM_free(a->param);
3179 dane_ctx_final(&a->dane);
3182 * Free internal session cache. However: the remove_cb() may reference
3183 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3184 * after the sessions were flushed.
3185 * As the ex_data handling routines might also touch the session cache,
3186 * the most secure solution seems to be: empty (flush) the cache, then
3187 * free ex_data, then finally free the cache.
3188 * (See ticket [openssl.org #212].)
3190 if (a->sessions != NULL)
3191 SSL_CTX_flush_sessions(a, 0);
3193 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3194 lh_SSL_SESSION_free(a->sessions);
3195 X509_STORE_free(a->cert_store);
3196 #ifndef OPENSSL_NO_CT
3197 CTLOG_STORE_free(a->ctlog_store);
3199 sk_SSL_CIPHER_free(a->cipher_list);
3200 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3201 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3202 ssl_cert_free(a->cert);
3203 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3204 sk_X509_NAME_pop_free(a->client_ca_names, X509_NAME_free);
3205 sk_X509_pop_free(a->extra_certs, X509_free);
3206 a->comp_methods = NULL;
3207 #ifndef OPENSSL_NO_SRTP
3208 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3210 #ifndef OPENSSL_NO_SRP
3211 SSL_CTX_SRP_CTX_free(a);
3213 #ifndef OPENSSL_NO_ENGINE
3214 ENGINE_finish(a->client_cert_engine);
3217 #ifndef OPENSSL_NO_EC
3218 OPENSSL_free(a->ext.ecpointformats);
3219 OPENSSL_free(a->ext.supportedgroups);
3221 OPENSSL_free(a->ext.alpn);
3222 OPENSSL_secure_free(a->ext.secure);
3224 CRYPTO_THREAD_lock_free(a->lock);
3229 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3231 ctx->default_passwd_callback = cb;
3234 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3236 ctx->default_passwd_callback_userdata = u;
3239 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3241 return ctx->default_passwd_callback;
3244 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3246 return ctx->default_passwd_callback_userdata;
3249 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3251 s->default_passwd_callback = cb;
3254 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3256 s->default_passwd_callback_userdata = u;
3259 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3261 return s->default_passwd_callback;
3264 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3266 return s->default_passwd_callback_userdata;
3269 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3270 int (*cb) (X509_STORE_CTX *, void *),
3273 ctx->app_verify_callback = cb;
3274 ctx->app_verify_arg = arg;
3277 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3278 int (*cb) (int, X509_STORE_CTX *))
3280 ctx->verify_mode = mode;
3281 ctx->default_verify_callback = cb;
3284 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3286 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3289 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3291 ssl_cert_set_cert_cb(c->cert, cb, arg);
3294 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3296 ssl_cert_set_cert_cb(s->cert, cb, arg);
3299 void ssl_set_masks(SSL *s)
3302 uint32_t *pvalid = s->s3->tmp.valid_flags;
3303 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3304 unsigned long mask_k, mask_a;
3305 #ifndef OPENSSL_NO_EC
3306 int have_ecc_cert, ecdsa_ok;
3311 #ifndef OPENSSL_NO_DH
3312 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3317 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3318 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3319 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3320 #ifndef OPENSSL_NO_EC
3321 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3327 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3328 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3331 #ifndef OPENSSL_NO_GOST
3332 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3333 mask_k |= SSL_kGOST;
3334 mask_a |= SSL_aGOST12;
3336 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3337 mask_k |= SSL_kGOST;
3338 mask_a |= SSL_aGOST12;
3340 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3341 mask_k |= SSL_kGOST;
3342 mask_a |= SSL_aGOST01;
3353 * If we only have an RSA-PSS certificate allow RSA authentication
3354 * if TLS 1.2 and peer supports it.
3357 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3358 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3359 && TLS1_get_version(s) == TLS1_2_VERSION))
3366 mask_a |= SSL_aNULL;
3369 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3370 * depending on the key usage extension.
3372 #ifndef OPENSSL_NO_EC
3373 if (have_ecc_cert) {
3375 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3376 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3377 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3380 mask_a |= SSL_aECDSA;
3382 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3383 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3384 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3385 && TLS1_get_version(s) == TLS1_2_VERSION)
3386 mask_a |= SSL_aECDSA;
3388 /* Allow Ed448 for TLS 1.2 if peer supports it */
3389 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3390 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3391 && TLS1_get_version(s) == TLS1_2_VERSION)
3392 mask_a |= SSL_aECDSA;
3395 #ifndef OPENSSL_NO_EC
3396 mask_k |= SSL_kECDHE;
3399 #ifndef OPENSSL_NO_PSK
3402 if (mask_k & SSL_kRSA)
3403 mask_k |= SSL_kRSAPSK;
3404 if (mask_k & SSL_kDHE)
3405 mask_k |= SSL_kDHEPSK;
3406 if (mask_k & SSL_kECDHE)
3407 mask_k |= SSL_kECDHEPSK;
3410 s->s3->tmp.mask_k = mask_k;
3411 s->s3->tmp.mask_a = mask_a;
3414 #ifndef OPENSSL_NO_EC
3416 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3418 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3419 /* key usage, if present, must allow signing */
3420 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3421 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3422 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3426 return 1; /* all checks are ok */
3431 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3432 size_t *serverinfo_length)
3434 CERT_PKEY *cpk = s->s3->tmp.cert;
3435 *serverinfo_length = 0;
3437 if (cpk == NULL || cpk->serverinfo == NULL)
3440 *serverinfo = cpk->serverinfo;
3441 *serverinfo_length = cpk->serverinfo_length;
3445 void ssl_update_cache(SSL *s, int mode)
3450 * If the session_id_length is 0, we are not supposed to cache it, and it
3451 * would be rather hard to do anyway :-)
3453 if (s->session->session_id_length == 0)
3457 * If sid_ctx_length is 0 there is no specific application context
3458 * associated with this session, so when we try to resume it and
3459 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3460 * indication that this is actually a session for the proper application
3461 * context, and the *handshake* will fail, not just the resumption attempt.
3462 * Do not cache (on the server) these sessions that are not resumable
3463 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3465 if (s->server && s->session->sid_ctx_length == 0
3466 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3469 i = s->session_ctx->session_cache_mode;
3471 && (!s->hit || SSL_IS_TLS13(s))) {
3473 * Add the session to the internal cache. In server side TLSv1.3 we
3474 * normally don't do this because by default it's a full stateless ticket
3475 * with only a dummy session id so there is no reason to cache it,
3477 * - we are doing early_data, in which case we cache so that we can
3479 * - the application has set a remove_session_cb so needs to know about
3480 * session timeout events
3481 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3483 if ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0
3484 && (!SSL_IS_TLS13(s)
3486 || (s->max_early_data > 0
3487 && (s->options & SSL_OP_NO_ANTI_REPLAY) == 0)
3488 || s->session_ctx->remove_session_cb != NULL
3489 || (s->options & SSL_OP_NO_TICKET) != 0))
3490 SSL_CTX_add_session(s->session_ctx, s->session);
3493 * Add the session to the external cache. We do this even in server side
3494 * TLSv1.3 without early data because some applications just want to
3495 * know about the creation of a session and aren't doing a full cache.
3497 if (s->session_ctx->new_session_cb != NULL) {
3498 SSL_SESSION_up_ref(s->session);
3499 if (!s->session_ctx->new_session_cb(s, s->session))
3500 SSL_SESSION_free(s->session);
3504 /* auto flush every 255 connections */
3505 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3506 TSAN_QUALIFIER int *stat;
3507 if (mode & SSL_SESS_CACHE_CLIENT)
3508 stat = &s->session_ctx->stats.sess_connect_good;
3510 stat = &s->session_ctx->stats.sess_accept_good;
3511 if ((tsan_load(stat) & 0xff) == 0xff)
3512 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3516 const SSL_METHOD *SSL_CTX_get_ssl_method(const SSL_CTX *ctx)
3521 const SSL_METHOD *SSL_get_ssl_method(const SSL *s)
3526 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3530 if (s->method != meth) {
3531 const SSL_METHOD *sm = s->method;
3532 int (*hf) (SSL *) = s->handshake_func;
3534 if (sm->version == meth->version)
3539 ret = s->method->ssl_new(s);
3542 if (hf == sm->ssl_connect)
3543 s->handshake_func = meth->ssl_connect;
3544 else if (hf == sm->ssl_accept)
3545 s->handshake_func = meth->ssl_accept;
3550 int SSL_get_error(const SSL *s, int i)
3557 return SSL_ERROR_NONE;
3560 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3561 * where we do encode the error
3563 if ((l = ERR_peek_error()) != 0) {
3564 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3565 return SSL_ERROR_SYSCALL;
3567 return SSL_ERROR_SSL;
3570 if (SSL_want_read(s)) {
3571 bio = SSL_get_rbio(s);
3572 if (BIO_should_read(bio))
3573 return SSL_ERROR_WANT_READ;
3574 else if (BIO_should_write(bio))
3576 * This one doesn't make too much sense ... We never try to write
3577 * to the rbio, and an application program where rbio and wbio
3578 * are separate couldn't even know what it should wait for.
3579 * However if we ever set s->rwstate incorrectly (so that we have
3580 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3581 * wbio *are* the same, this test works around that bug; so it
3582 * might be safer to keep it.
3584 return SSL_ERROR_WANT_WRITE;
3585 else if (BIO_should_io_special(bio)) {
3586 reason = BIO_get_retry_reason(bio);
3587 if (reason == BIO_RR_CONNECT)
3588 return SSL_ERROR_WANT_CONNECT;
3589 else if (reason == BIO_RR_ACCEPT)
3590 return SSL_ERROR_WANT_ACCEPT;
3592 return SSL_ERROR_SYSCALL; /* unknown */
3596 if (SSL_want_write(s)) {
3597 /* Access wbio directly - in order to use the buffered bio if present */
3599 if (BIO_should_write(bio))
3600 return SSL_ERROR_WANT_WRITE;
3601 else if (BIO_should_read(bio))
3603 * See above (SSL_want_read(s) with BIO_should_write(bio))
3605 return SSL_ERROR_WANT_READ;
3606 else if (BIO_should_io_special(bio)) {
3607 reason = BIO_get_retry_reason(bio);
3608 if (reason == BIO_RR_CONNECT)
3609 return SSL_ERROR_WANT_CONNECT;
3610 else if (reason == BIO_RR_ACCEPT)
3611 return SSL_ERROR_WANT_ACCEPT;
3613 return SSL_ERROR_SYSCALL;
3616 if (SSL_want_x509_lookup(s))
3617 return SSL_ERROR_WANT_X509_LOOKUP;
3618 if (SSL_want_async(s))
3619 return SSL_ERROR_WANT_ASYNC;
3620 if (SSL_want_async_job(s))
3621 return SSL_ERROR_WANT_ASYNC_JOB;
3622 if (SSL_want_client_hello_cb(s))
3623 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3625 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3626 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3627 return SSL_ERROR_ZERO_RETURN;
3629 return SSL_ERROR_SYSCALL;
3632 static int ssl_do_handshake_intern(void *vargs)
3634 struct ssl_async_args *args;
3637 args = (struct ssl_async_args *)vargs;
3640 return s->handshake_func(s);
3643 int SSL_do_handshake(SSL *s)
3647 if (s->handshake_func == NULL) {
3648 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3652 ossl_statem_check_finish_init(s, -1);
3654 s->method->ssl_renegotiate_check(s, 0);
3656 if (SSL_in_init(s) || SSL_in_before(s)) {
3657 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3658 struct ssl_async_args args;
3662 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3664 ret = s->handshake_func(s);
3670 void SSL_set_accept_state(SSL *s)
3674 ossl_statem_clear(s);
3675 s->handshake_func = s->method->ssl_accept;
3679 void SSL_set_connect_state(SSL *s)
3683 ossl_statem_clear(s);
3684 s->handshake_func = s->method->ssl_connect;
3688 int ssl_undefined_function(SSL *s)
3690 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3694 int ssl_undefined_void_function(void)
3696 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3697 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3701 int ssl_undefined_const_function(const SSL *s)
3706 const SSL_METHOD *ssl_bad_method(int ver)
3708 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3712 const char *ssl_protocol_to_string(int version)
3716 case TLS1_3_VERSION:
3719 case TLS1_2_VERSION:
3722 case TLS1_1_VERSION:
3737 case DTLS1_2_VERSION:
3745 const char *SSL_get_version(const SSL *s)
3747 return ssl_protocol_to_string(s->version);
3750 static int dup_ca_names(STACK_OF(X509_NAME) **dst, STACK_OF(X509_NAME) *src)
3752 STACK_OF(X509_NAME) *sk;
3761 if ((sk = sk_X509_NAME_new_null()) == NULL)
3763 for (i = 0; i < sk_X509_NAME_num(src); i++) {
3764 xn = X509_NAME_dup(sk_X509_NAME_value(src, i));
3766 sk_X509_NAME_pop_free(sk, X509_NAME_free);
3769 if (sk_X509_NAME_insert(sk, xn, i) == 0) {
3771 sk_X509_NAME_pop_free(sk, X509_NAME_free);
3780 SSL *SSL_dup(SSL *s)
3785 /* If we're not quiescent, just up_ref! */
3786 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3787 CRYPTO_UP_REF(&s->references, &i, s->lock);
3792 * Otherwise, copy configuration state, and session if set.
3794 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3797 if (s->session != NULL) {
3799 * Arranges to share the same session via up_ref. This "copies"
3800 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3802 if (!SSL_copy_session_id(ret, s))
3806 * No session has been established yet, so we have to expect that
3807 * s->cert or ret->cert will be changed later -- they should not both
3808 * point to the same object, and thus we can't use
3809 * SSL_copy_session_id.
3811 if (!SSL_set_ssl_method(ret, s->method))
3814 if (s->cert != NULL) {
3815 ssl_cert_free(ret->cert);
3816 ret->cert = ssl_cert_dup(s->cert);
3817 if (ret->cert == NULL)
3821 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3822 (int)s->sid_ctx_length))
3826 if (!ssl_dane_dup(ret, s))
3828 ret->version = s->version;
3829 ret->options = s->options;
3830 ret->min_proto_version = s->min_proto_version;
3831 ret->max_proto_version = s->max_proto_version;
3832 ret->mode = s->mode;
3833 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3834 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3835 ret->msg_callback = s->msg_callback;
3836 ret->msg_callback_arg = s->msg_callback_arg;
3837 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3838 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3839 ret->generate_session_id = s->generate_session_id;
3841 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3843 /* copy app data, a little dangerous perhaps */
3844 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3847 ret->server = s->server;
3848 if (s->handshake_func) {
3850 SSL_set_accept_state(ret);
3852 SSL_set_connect_state(ret);
3854 ret->shutdown = s->shutdown;
3857 ret->default_passwd_callback = s->default_passwd_callback;
3858 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3860 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3862 /* dup the cipher_list and cipher_list_by_id stacks */
3863 if (s->cipher_list != NULL) {
3864 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3867 if (s->cipher_list_by_id != NULL)
3868 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3872 /* Dup the client_CA list */
3873 if (!dup_ca_names(&ret->ca_names, s->ca_names)
3874 || !dup_ca_names(&ret->client_ca_names, s->client_ca_names))
3884 void ssl_clear_cipher_ctx(SSL *s)
3886 if (s->enc_read_ctx != NULL) {
3887 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3888 s->enc_read_ctx = NULL;
3890 if (s->enc_write_ctx != NULL) {
3891 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3892 s->enc_write_ctx = NULL;
3894 #ifndef OPENSSL_NO_COMP
3895 COMP_CTX_free(s->expand);
3897 COMP_CTX_free(s->compress);
3902 X509 *SSL_get_certificate(const SSL *s)
3904 if (s->cert != NULL)
3905 return s->cert->key->x509;
3910 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3912 if (s->cert != NULL)
3913 return s->cert->key->privatekey;
3918 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3920 if (ctx->cert != NULL)
3921 return ctx->cert->key->x509;
3926 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3928 if (ctx->cert != NULL)
3929 return ctx->cert->key->privatekey;
3934 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3936 if ((s->session != NULL) && (s->session->cipher != NULL))
3937 return s->session->cipher;
3941 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3943 return s->s3->tmp.new_cipher;
3946 const COMP_METHOD *SSL_get_current_compression(const SSL *s)
3948 #ifndef OPENSSL_NO_COMP
3949 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3955 const COMP_METHOD *SSL_get_current_expansion(const SSL *s)
3957 #ifndef OPENSSL_NO_COMP
3958 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3964 int ssl_init_wbio_buffer(SSL *s)
3968 if (s->bbio != NULL) {
3969 /* Already buffered. */
3973 bbio = BIO_new(BIO_f_buffer());
3974 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3976 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3980 s->wbio = BIO_push(bbio, s->wbio);
3985 int ssl_free_wbio_buffer(SSL *s)
3987 /* callers ensure s is never null */
3988 if (s->bbio == NULL)
3991 s->wbio = BIO_pop(s->wbio);
3998 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
4000 ctx->quiet_shutdown = mode;
4003 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
4005 return ctx->quiet_shutdown;
4008 void SSL_set_quiet_shutdown(SSL *s, int mode)
4010 s->quiet_shutdown = mode;
4013 int SSL_get_quiet_shutdown(const SSL *s)
4015 return s->quiet_shutdown;
4018 void SSL_set_shutdown(SSL *s, int mode)
4023 int SSL_get_shutdown(const SSL *s)
4028 int SSL_version(const SSL *s)
4033 int SSL_client_version(const SSL *s)
4035 return s->client_version;
4038 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
4043 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
4046 if (ssl->ctx == ctx)
4049 ctx = ssl->session_ctx;
4050 new_cert = ssl_cert_dup(ctx->cert);
4051 if (new_cert == NULL) {
4055 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
4056 ssl_cert_free(new_cert);
4060 ssl_cert_free(ssl->cert);
4061 ssl->cert = new_cert;
4064 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
4065 * so setter APIs must prevent invalid lengths from entering the system.
4067 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
4071 * If the session ID context matches that of the parent SSL_CTX,
4072 * inherit it from the new SSL_CTX as well. If however the context does
4073 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4074 * leave it unchanged.
4076 if ((ssl->ctx != NULL) &&
4077 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
4078 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
4079 ssl->sid_ctx_length = ctx->sid_ctx_length;
4080 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
4083 SSL_CTX_up_ref(ctx);
4084 SSL_CTX_free(ssl->ctx); /* decrement reference count */
4090 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
4092 return X509_STORE_set_default_paths(ctx->cert_store);
4095 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
4097 X509_LOOKUP *lookup;
4099 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
4102 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
4104 /* Clear any errors if the default directory does not exist */
4110 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4112 X509_LOOKUP *lookup;
4114 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4118 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4120 /* Clear any errors if the default file does not exist */
4126 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4129 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4132 void SSL_set_info_callback(SSL *ssl,
4133 void (*cb) (const SSL *ssl, int type, int val))
4135 ssl->info_callback = cb;
4139 * One compiler (Diab DCC) doesn't like argument names in returned function
4142 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4145 return ssl->info_callback;
4148 void SSL_set_verify_result(SSL *ssl, long arg)
4150 ssl->verify_result = arg;
4153 long SSL_get_verify_result(const SSL *ssl)
4155 return ssl->verify_result;
4158 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4161 return sizeof(ssl->s3->client_random);
4162 if (outlen > sizeof(ssl->s3->client_random))
4163 outlen = sizeof(ssl->s3->client_random);
4164 memcpy(out, ssl->s3->client_random, outlen);
4168 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4171 return sizeof(ssl->s3->server_random);
4172 if (outlen > sizeof(ssl->s3->server_random))
4173 outlen = sizeof(ssl->s3->server_random);
4174 memcpy(out, ssl->s3->server_random, outlen);
4178 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4179 unsigned char *out, size_t outlen)
4182 return session->master_key_length;
4183 if (outlen > session->master_key_length)
4184 outlen = session->master_key_length;
4185 memcpy(out, session->master_key, outlen);
4189 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4192 if (len > sizeof(sess->master_key))
4195 memcpy(sess->master_key, in, len);
4196 sess->master_key_length = len;
4201 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4203 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4206 void *SSL_get_ex_data(const SSL *s, int idx)
4208 return CRYPTO_get_ex_data(&s->ex_data, idx);
4211 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4213 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4216 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4218 return CRYPTO_get_ex_data(&s->ex_data, idx);
4221 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4223 return ctx->cert_store;
4226 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4228 X509_STORE_free(ctx->cert_store);
4229 ctx->cert_store = store;
4232 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4235 X509_STORE_up_ref(store);
4236 SSL_CTX_set_cert_store(ctx, store);
4239 int SSL_want(const SSL *s)
4245 * \brief Set the callback for generating temporary DH keys.
4246 * \param ctx the SSL context.
4247 * \param dh the callback
4250 #ifndef OPENSSL_NO_DH
4251 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4252 DH *(*dh) (SSL *ssl, int is_export,
4255 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4258 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4261 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4265 #ifndef OPENSSL_NO_PSK
4266 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4268 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4269 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4272 OPENSSL_free(ctx->cert->psk_identity_hint);
4273 if (identity_hint != NULL) {
4274 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4275 if (ctx->cert->psk_identity_hint == NULL)
4278 ctx->cert->psk_identity_hint = NULL;
4282 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4287 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4288 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4291 OPENSSL_free(s->cert->psk_identity_hint);
4292 if (identity_hint != NULL) {
4293 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4294 if (s->cert->psk_identity_hint == NULL)
4297 s->cert->psk_identity_hint = NULL;
4301 const char *SSL_get_psk_identity_hint(const SSL *s)
4303 if (s == NULL || s->session == NULL)
4305 return s->session->psk_identity_hint;
4308 const char *SSL_get_psk_identity(const SSL *s)
4310 if (s == NULL || s->session == NULL)
4312 return s->session->psk_identity;
4315 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4317 s->psk_client_callback = cb;
4320 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4322 ctx->psk_client_callback = cb;
4325 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4327 s->psk_server_callback = cb;
4330 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4332 ctx->psk_server_callback = cb;
4336 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4338 s->psk_find_session_cb = cb;
4341 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4342 SSL_psk_find_session_cb_func cb)
4344 ctx->psk_find_session_cb = cb;
4347 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4349 s->psk_use_session_cb = cb;
4352 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4353 SSL_psk_use_session_cb_func cb)
4355 ctx->psk_use_session_cb = cb;
4358 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4359 void (*cb) (int write_p, int version,
4360 int content_type, const void *buf,
4361 size_t len, SSL *ssl, void *arg))
4363 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4366 void SSL_set_msg_callback(SSL *ssl,
4367 void (*cb) (int write_p, int version,
4368 int content_type, const void *buf,
4369 size_t len, SSL *ssl, void *arg))
4371 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4374 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4375 int (*cb) (SSL *ssl,
4379 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4380 (void (*)(void))cb);
4383 void SSL_set_not_resumable_session_callback(SSL *ssl,
4384 int (*cb) (SSL *ssl,
4385 int is_forward_secure))
4387 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4388 (void (*)(void))cb);
4391 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4392 size_t (*cb) (SSL *ssl, int type,
4393 size_t len, void *arg))
4395 ctx->record_padding_cb = cb;
4398 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4400 ctx->record_padding_arg = arg;
4403 void *SSL_CTX_get_record_padding_callback_arg(const SSL_CTX *ctx)
4405 return ctx->record_padding_arg;
4408 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4410 /* block size of 0 or 1 is basically no padding */
4411 if (block_size == 1)
4412 ctx->block_padding = 0;
4413 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4414 ctx->block_padding = block_size;
4420 void SSL_set_record_padding_callback(SSL *ssl,
4421 size_t (*cb) (SSL *ssl, int type,
4422 size_t len, void *arg))
4424 ssl->record_padding_cb = cb;
4427 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4429 ssl->record_padding_arg = arg;
4432 void *SSL_get_record_padding_callback_arg(const SSL *ssl)
4434 return ssl->record_padding_arg;
4437 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4439 /* block size of 0 or 1 is basically no padding */
4440 if (block_size == 1)
4441 ssl->block_padding = 0;
4442 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4443 ssl->block_padding = block_size;
4449 int SSL_set_num_tickets(SSL *s, size_t num_tickets)
4451 s->num_tickets = num_tickets;
4456 size_t SSL_get_num_tickets(const SSL *s)
4458 return s->num_tickets;
4461 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets)
4463 ctx->num_tickets = num_tickets;
4468 size_t SSL_CTX_get_num_tickets(const SSL_CTX *ctx)
4470 return ctx->num_tickets;
4474 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4475 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4476 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4477 * Returns the newly allocated ctx;
4480 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4482 ssl_clear_hash_ctx(hash);
4483 *hash = EVP_MD_CTX_new();
4484 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4485 EVP_MD_CTX_free(*hash);
4492 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4495 EVP_MD_CTX_free(*hash);
4499 /* Retrieve handshake hashes */
4500 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4503 EVP_MD_CTX *ctx = NULL;
4504 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4505 int hashleni = EVP_MD_CTX_size(hdgst);
4508 if (hashleni < 0 || (size_t)hashleni > outlen) {
4509 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4510 ERR_R_INTERNAL_ERROR);
4514 ctx = EVP_MD_CTX_new();
4518 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4519 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4520 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4521 ERR_R_INTERNAL_ERROR);
4525 *hashlen = hashleni;
4529 EVP_MD_CTX_free(ctx);
4533 int SSL_session_reused(const SSL *s)
4538 int SSL_is_server(const SSL *s)
4543 #if OPENSSL_API_COMPAT < 0x10100000L
4544 void SSL_set_debug(SSL *s, int debug)
4546 /* Old function was do-nothing anyway... */
4552 void SSL_set_security_level(SSL *s, int level)
4554 s->cert->sec_level = level;
4557 int SSL_get_security_level(const SSL *s)
4559 return s->cert->sec_level;
4562 void SSL_set_security_callback(SSL *s,
4563 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4564 int op, int bits, int nid,
4565 void *other, void *ex))
4567 s->cert->sec_cb = cb;
4570 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4571 const SSL_CTX *ctx, int op,
4572 int bits, int nid, void *other,
4574 return s->cert->sec_cb;
4577 void SSL_set0_security_ex_data(SSL *s, void *ex)
4579 s->cert->sec_ex = ex;
4582 void *SSL_get0_security_ex_data(const SSL *s)
4584 return s->cert->sec_ex;
4587 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4589 ctx->cert->sec_level = level;
4592 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4594 return ctx->cert->sec_level;
4597 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4598 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4599 int op, int bits, int nid,
4600 void *other, void *ex))
4602 ctx->cert->sec_cb = cb;
4605 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4611 return ctx->cert->sec_cb;
4614 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4616 ctx->cert->sec_ex = ex;
4619 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4621 return ctx->cert->sec_ex;
4625 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4626 * can return unsigned long, instead of the generic long return value from the
4627 * control interface.
4629 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4631 return ctx->options;
4634 unsigned long SSL_get_options(const SSL *s)
4639 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4641 return ctx->options |= op;
4644 unsigned long SSL_set_options(SSL *s, unsigned long op)
4646 return s->options |= op;
4649 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4651 return ctx->options &= ~op;
4654 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4656 return s->options &= ~op;
4659 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4661 return s->verified_chain;
4664 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4666 #ifndef OPENSSL_NO_CT
4669 * Moves SCTs from the |src| stack to the |dst| stack.
4670 * The source of each SCT will be set to |origin|.
4671 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4673 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4675 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4676 sct_source_t origin)
4682 *dst = sk_SCT_new_null();
4684 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4689 while ((sct = sk_SCT_pop(src)) != NULL) {
4690 if (SCT_set_source(sct, origin) != 1)
4693 if (sk_SCT_push(*dst, sct) <= 0)
4701 sk_SCT_push(src, sct); /* Put the SCT back */
4706 * Look for data collected during ServerHello and parse if found.
4707 * Returns the number of SCTs extracted.
4709 static int ct_extract_tls_extension_scts(SSL *s)
4711 int scts_extracted = 0;
4713 if (s->ext.scts != NULL) {
4714 const unsigned char *p = s->ext.scts;
4715 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4717 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4719 SCT_LIST_free(scts);
4722 return scts_extracted;
4726 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4727 * contains an SCT X509 extension. They will be stored in |s->scts|.
4729 * - The number of SCTs extracted, assuming an OCSP response exists.
4730 * - 0 if no OCSP response exists or it contains no SCTs.
4731 * - A negative integer if an error occurs.
4733 static int ct_extract_ocsp_response_scts(SSL *s)
4735 # ifndef OPENSSL_NO_OCSP
4736 int scts_extracted = 0;
4737 const unsigned char *p;
4738 OCSP_BASICRESP *br = NULL;
4739 OCSP_RESPONSE *rsp = NULL;
4740 STACK_OF(SCT) *scts = NULL;
4743 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4746 p = s->ext.ocsp.resp;
4747 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4751 br = OCSP_response_get1_basic(rsp);
4755 for (i = 0; i < OCSP_resp_count(br); ++i) {
4756 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4762 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4764 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4765 if (scts_extracted < 0)
4769 SCT_LIST_free(scts);
4770 OCSP_BASICRESP_free(br);
4771 OCSP_RESPONSE_free(rsp);
4772 return scts_extracted;
4774 /* Behave as if no OCSP response exists */
4780 * Attempts to extract SCTs from the peer certificate.
4781 * Return the number of SCTs extracted, or a negative integer if an error
4784 static int ct_extract_x509v3_extension_scts(SSL *s)
4786 int scts_extracted = 0;
4787 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4790 STACK_OF(SCT) *scts =
4791 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4794 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4796 SCT_LIST_free(scts);
4799 return scts_extracted;
4803 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4804 * response (if it exists) and X509v3 extensions in the certificate.
4805 * Returns NULL if an error occurs.
4807 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4809 if (!s->scts_parsed) {
4810 if (ct_extract_tls_extension_scts(s) < 0 ||
4811 ct_extract_ocsp_response_scts(s) < 0 ||
4812 ct_extract_x509v3_extension_scts(s) < 0)
4822 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4823 const STACK_OF(SCT) *scts, void *unused_arg)
4828 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4829 const STACK_OF(SCT) *scts, void *unused_arg)
4831 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4834 for (i = 0; i < count; ++i) {
4835 SCT *sct = sk_SCT_value(scts, i);
4836 int status = SCT_get_validation_status(sct);
4838 if (status == SCT_VALIDATION_STATUS_VALID)
4841 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4845 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4849 * Since code exists that uses the custom extension handler for CT, look
4850 * for this and throw an error if they have already registered to use CT.
4852 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4853 TLSEXT_TYPE_signed_certificate_timestamp))
4855 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4856 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4860 if (callback != NULL) {
4862 * If we are validating CT, then we MUST accept SCTs served via OCSP
4864 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4868 s->ct_validation_callback = callback;
4869 s->ct_validation_callback_arg = arg;
4874 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4875 ssl_ct_validation_cb callback, void *arg)
4878 * Since code exists that uses the custom extension handler for CT, look for
4879 * this and throw an error if they have already registered to use CT.
4881 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4882 TLSEXT_TYPE_signed_certificate_timestamp))
4884 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4885 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4889 ctx->ct_validation_callback = callback;
4890 ctx->ct_validation_callback_arg = arg;
4894 int SSL_ct_is_enabled(const SSL *s)
4896 return s->ct_validation_callback != NULL;
4899 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4901 return ctx->ct_validation_callback != NULL;
4904 int ssl_validate_ct(SSL *s)
4907 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4909 SSL_DANE *dane = &s->dane;
4910 CT_POLICY_EVAL_CTX *ctx = NULL;
4911 const STACK_OF(SCT) *scts;
4914 * If no callback is set, the peer is anonymous, or its chain is invalid,
4915 * skip SCT validation - just return success. Applications that continue
4916 * handshakes without certificates, with unverified chains, or pinned leaf
4917 * certificates are outside the scope of the WebPKI and CT.
4919 * The above exclusions notwithstanding the vast majority of peers will
4920 * have rather ordinary certificate chains validated by typical
4921 * applications that perform certificate verification and therefore will
4922 * process SCTs when enabled.
4924 if (s->ct_validation_callback == NULL || cert == NULL ||
4925 s->verify_result != X509_V_OK ||
4926 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4930 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4931 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4933 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4934 switch (dane->mtlsa->usage) {
4935 case DANETLS_USAGE_DANE_TA:
4936 case DANETLS_USAGE_DANE_EE:
4941 ctx = CT_POLICY_EVAL_CTX_new();
4943 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4944 ERR_R_MALLOC_FAILURE);
4948 issuer = sk_X509_value(s->verified_chain, 1);
4949 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4950 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4951 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4952 CT_POLICY_EVAL_CTX_set_time(
4953 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4955 scts = SSL_get0_peer_scts(s);
4958 * This function returns success (> 0) only when all the SCTs are valid, 0
4959 * when some are invalid, and < 0 on various internal errors (out of
4960 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4961 * reason to abort the handshake, that decision is up to the callback.
4962 * Therefore, we error out only in the unexpected case that the return
4963 * value is negative.
4965 * XXX: One might well argue that the return value of this function is an
4966 * unfortunate design choice. Its job is only to determine the validation
4967 * status of each of the provided SCTs. So long as it correctly separates
4968 * the wheat from the chaff it should return success. Failure in this case
4969 * ought to correspond to an inability to carry out its duties.
4971 if (SCT_LIST_validate(scts, ctx) < 0) {
4972 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4973 SSL_R_SCT_VERIFICATION_FAILED);
4977 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4979 ret = 0; /* This function returns 0 on failure */
4981 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4982 SSL_R_CALLBACK_FAILED);
4985 CT_POLICY_EVAL_CTX_free(ctx);
4987 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4988 * failure return code here. Also the application may wish the complete
4989 * the handshake, and then disconnect cleanly at a higher layer, after
4990 * checking the verification status of the completed connection.
4992 * We therefore force a certificate verification failure which will be
4993 * visible via SSL_get_verify_result() and cached as part of any resumed
4996 * Note: the permissive callback is for information gathering only, always
4997 * returns success, and does not affect verification status. Only the
4998 * strict callback or a custom application-specified callback can trigger
4999 * connection failure or record a verification error.
5002 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
5006 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
5008 switch (validation_mode) {
5010 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
5012 case SSL_CT_VALIDATION_PERMISSIVE:
5013 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
5014 case SSL_CT_VALIDATION_STRICT:
5015 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
5019 int SSL_enable_ct(SSL *s, int validation_mode)
5021 switch (validation_mode) {
5023 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
5025 case SSL_CT_VALIDATION_PERMISSIVE:
5026 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
5027 case SSL_CT_VALIDATION_STRICT:
5028 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
5032 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
5034 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
5037 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
5039 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
5042 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
5044 CTLOG_STORE_free(ctx->ctlog_store);
5045 ctx->ctlog_store = logs;
5048 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
5050 return ctx->ctlog_store;
5053 #endif /* OPENSSL_NO_CT */
5055 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
5058 c->client_hello_cb = cb;
5059 c->client_hello_cb_arg = arg;
5062 int SSL_client_hello_isv2(SSL *s)
5064 if (s->clienthello == NULL)
5066 return s->clienthello->isv2;
5069 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
5071 if (s->clienthello == NULL)
5073 return s->clienthello->legacy_version;
5076 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
5078 if (s->clienthello == NULL)
5081 *out = s->clienthello->random;
5082 return SSL3_RANDOM_SIZE;
5085 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
5087 if (s->clienthello == NULL)
5090 *out = s->clienthello->session_id;
5091 return s->clienthello->session_id_len;
5094 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
5096 if (s->clienthello == NULL)
5099 *out = PACKET_data(&s->clienthello->ciphersuites);
5100 return PACKET_remaining(&s->clienthello->ciphersuites);
5103 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
5105 if (s->clienthello == NULL)
5108 *out = s->clienthello->compressions;
5109 return s->clienthello->compressions_len;
5112 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5118 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5120 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5121 ext = s->clienthello->pre_proc_exts + i;
5130 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
5131 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
5132 ERR_R_MALLOC_FAILURE);
5135 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5136 ext = s->clienthello->pre_proc_exts + i;
5138 if (ext->received_order >= num)
5140 present[ext->received_order] = ext->type;
5147 OPENSSL_free(present);
5151 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5157 if (s->clienthello == NULL)
5159 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5160 r = s->clienthello->pre_proc_exts + i;
5161 if (r->present && r->type == type) {
5163 *out = PACKET_data(&r->data);
5165 *outlen = PACKET_remaining(&r->data);
5172 int SSL_free_buffers(SSL *ssl)
5174 RECORD_LAYER *rl = &ssl->rlayer;
5176 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5179 RECORD_LAYER_release(rl);
5183 int SSL_alloc_buffers(SSL *ssl)
5185 return ssl3_setup_buffers(ssl);
5188 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5190 ctx->keylog_callback = cb;
5193 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5195 return ctx->keylog_callback;
5198 static int nss_keylog_int(const char *prefix,
5200 const uint8_t *parameter_1,
5201 size_t parameter_1_len,
5202 const uint8_t *parameter_2,
5203 size_t parameter_2_len)
5206 char *cursor = NULL;
5211 if (ssl->ctx->keylog_callback == NULL)
5215 * Our output buffer will contain the following strings, rendered with
5216 * space characters in between, terminated by a NULL character: first the
5217 * prefix, then the first parameter, then the second parameter. The
5218 * meaning of each parameter depends on the specific key material being
5219 * logged. Note that the first and second parameters are encoded in
5220 * hexadecimal, so we need a buffer that is twice their lengths.
5222 prefix_len = strlen(prefix);
5223 out_len = prefix_len + (2 * parameter_1_len) + (2 * parameter_2_len) + 3;
5224 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5225 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5226 ERR_R_MALLOC_FAILURE);
5230 strcpy(cursor, prefix);
5231 cursor += prefix_len;
5234 for (i = 0; i < parameter_1_len; i++) {
5235 sprintf(cursor, "%02x", parameter_1[i]);
5240 for (i = 0; i < parameter_2_len; i++) {
5241 sprintf(cursor, "%02x", parameter_2[i]);
5246 ssl->ctx->keylog_callback(ssl, (const char *)out);
5247 OPENSSL_clear_free(out, out_len);
5252 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5253 const uint8_t *encrypted_premaster,
5254 size_t encrypted_premaster_len,
5255 const uint8_t *premaster,
5256 size_t premaster_len)
5258 if (encrypted_premaster_len < 8) {
5259 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5260 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5264 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5265 return nss_keylog_int("RSA",
5267 encrypted_premaster,
5273 int ssl_log_secret(SSL *ssl,
5275 const uint8_t *secret,
5278 return nss_keylog_int(label,
5280 ssl->s3->client_random,
5286 #define SSLV2_CIPHER_LEN 3
5288 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5292 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5294 if (PACKET_remaining(cipher_suites) == 0) {
5295 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5296 SSL_R_NO_CIPHERS_SPECIFIED);
5300 if (PACKET_remaining(cipher_suites) % n != 0) {
5301 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5302 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5306 OPENSSL_free(s->s3->tmp.ciphers_raw);
5307 s->s3->tmp.ciphers_raw = NULL;
5308 s->s3->tmp.ciphers_rawlen = 0;
5311 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5312 PACKET sslv2ciphers = *cipher_suites;
5313 unsigned int leadbyte;
5317 * We store the raw ciphers list in SSLv3+ format so we need to do some
5318 * preprocessing to convert the list first. If there are any SSLv2 only
5319 * ciphersuites with a non-zero leading byte then we are going to
5320 * slightly over allocate because we won't store those. But that isn't a
5323 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5324 s->s3->tmp.ciphers_raw = raw;
5326 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5327 ERR_R_MALLOC_FAILURE);
5330 for (s->s3->tmp.ciphers_rawlen = 0;
5331 PACKET_remaining(&sslv2ciphers) > 0;
5332 raw += TLS_CIPHER_LEN) {
5333 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5335 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5338 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5339 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5341 OPENSSL_free(s->s3->tmp.ciphers_raw);
5342 s->s3->tmp.ciphers_raw = NULL;
5343 s->s3->tmp.ciphers_rawlen = 0;
5347 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5349 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5350 &s->s3->tmp.ciphers_rawlen)) {
5351 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5352 ERR_R_INTERNAL_ERROR);
5358 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5359 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5360 STACK_OF(SSL_CIPHER) **scsvs)
5364 if (!PACKET_buf_init(&pkt, bytes, len))
5366 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5369 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5370 STACK_OF(SSL_CIPHER) **skp,
5371 STACK_OF(SSL_CIPHER) **scsvs_out,
5372 int sslv2format, int fatal)
5374 const SSL_CIPHER *c;
5375 STACK_OF(SSL_CIPHER) *sk = NULL;
5376 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5378 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5379 unsigned char cipher[SSLV2_CIPHER_LEN];
5381 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5383 if (PACKET_remaining(cipher_suites) == 0) {
5385 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5386 SSL_R_NO_CIPHERS_SPECIFIED);
5388 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5392 if (PACKET_remaining(cipher_suites) % n != 0) {
5394 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5395 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5397 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5398 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5402 sk = sk_SSL_CIPHER_new_null();
5403 scsvs = sk_SSL_CIPHER_new_null();
5404 if (sk == NULL || scsvs == NULL) {
5406 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5407 ERR_R_MALLOC_FAILURE);
5409 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5413 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5415 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5416 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5417 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5419 if (sslv2format && cipher[0] != '\0')
5422 /* For SSLv2-compat, ignore leading 0-byte. */
5423 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5425 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5426 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5428 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5429 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5431 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5436 if (PACKET_remaining(cipher_suites) > 0) {
5438 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5441 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5448 sk_SSL_CIPHER_free(sk);
5449 if (scsvs_out != NULL)
5452 sk_SSL_CIPHER_free(scsvs);
5455 sk_SSL_CIPHER_free(sk);
5456 sk_SSL_CIPHER_free(scsvs);
5460 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5462 ctx->max_early_data = max_early_data;
5467 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5469 return ctx->max_early_data;
5472 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5474 s->max_early_data = max_early_data;
5479 uint32_t SSL_get_max_early_data(const SSL *s)
5481 return s->max_early_data;
5484 int SSL_CTX_set_recv_max_early_data(SSL_CTX *ctx, uint32_t recv_max_early_data)
5486 ctx->recv_max_early_data = recv_max_early_data;
5491 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX *ctx)
5493 return ctx->recv_max_early_data;
5496 int SSL_set_recv_max_early_data(SSL *s, uint32_t recv_max_early_data)
5498 s->recv_max_early_data = recv_max_early_data;
5503 uint32_t SSL_get_recv_max_early_data(const SSL *s)
5505 return s->recv_max_early_data;
5508 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5510 /* Return any active Max Fragment Len extension */
5511 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5512 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5514 /* return current SSL connection setting */
5515 return ssl->max_send_fragment;
5518 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5520 /* Return a value regarding an active Max Fragment Len extension */
5521 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5522 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5523 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5525 /* else limit |split_send_fragment| to current |max_send_fragment| */
5526 if (ssl->split_send_fragment > ssl->max_send_fragment)
5527 return ssl->max_send_fragment;
5529 /* return current SSL connection setting */
5530 return ssl->split_send_fragment;
5533 int SSL_stateless(SSL *s)
5537 /* Ensure there is no state left over from a previous invocation */
5543 s->s3->flags |= TLS1_FLAGS_STATELESS;
5544 ret = SSL_accept(s);
5545 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5547 if (ret > 0 && s->ext.cookieok)
5550 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5556 void SSL_CTX_set_post_handshake_auth(SSL_CTX *ctx, int val)
5558 ctx->pha_enabled = val;
5561 void SSL_set_post_handshake_auth(SSL *ssl, int val)
5563 ssl->pha_enabled = val;
5566 int SSL_verify_client_post_handshake(SSL *ssl)
5568 if (!SSL_IS_TLS13(ssl)) {
5569 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5573 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5577 if (!SSL_is_init_finished(ssl)) {
5578 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5582 switch (ssl->post_handshake_auth) {
5584 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5587 case SSL_PHA_EXT_SENT:
5588 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5590 case SSL_PHA_EXT_RECEIVED:
5592 case SSL_PHA_REQUEST_PENDING:
5593 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5595 case SSL_PHA_REQUESTED:
5596 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5600 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5602 /* checks verify_mode and algorithm_auth */
5603 if (!send_certificate_request(ssl)) {
5604 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5605 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5609 ossl_statem_set_in_init(ssl, 1);
5613 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5614 SSL_CTX_generate_session_ticket_fn gen_cb,
5615 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5618 ctx->generate_ticket_cb = gen_cb;
5619 ctx->decrypt_ticket_cb = dec_cb;
5620 ctx->ticket_cb_data = arg;
5624 void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
5625 SSL_allow_early_data_cb_fn cb,
5628 ctx->allow_early_data_cb = cb;
5629 ctx->allow_early_data_cb_data = arg;
5632 void SSL_set_allow_early_data_cb(SSL *s,
5633 SSL_allow_early_data_cb_fn cb,
5636 s->allow_early_data_cb = cb;
5637 s->allow_early_data_cb_data = arg;