2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4 * Copyright 2005 Nokia. All rights reserved.
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
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"
25 #include "internal/ktls.h"
27 static int ssl_undefined_function_1(SSL *ssl, SSL3_RECORD *r, size_t s, int t)
32 return ssl_undefined_function(ssl);
35 static int ssl_undefined_function_2(SSL *ssl, SSL3_RECORD *r, unsigned char *s,
41 return ssl_undefined_function(ssl);
44 static int ssl_undefined_function_3(SSL *ssl, unsigned char *r,
45 unsigned char *s, size_t t, size_t *u)
51 return ssl_undefined_function(ssl);
54 static int ssl_undefined_function_4(SSL *ssl, int r)
57 return ssl_undefined_function(ssl);
60 static size_t ssl_undefined_function_5(SSL *ssl, const char *r, size_t s,
66 return ssl_undefined_function(ssl);
69 static int ssl_undefined_function_6(int r)
72 return ssl_undefined_function(NULL);
75 static int ssl_undefined_function_7(SSL *ssl, unsigned char *r, size_t s,
76 const char *t, size_t u,
77 const unsigned char *v, size_t w, int x)
86 return ssl_undefined_function(ssl);
89 SSL3_ENC_METHOD ssl3_undef_enc_method = {
90 ssl_undefined_function_1,
91 ssl_undefined_function_2,
92 ssl_undefined_function,
93 ssl_undefined_function_3,
94 ssl_undefined_function_4,
95 ssl_undefined_function_5,
96 NULL, /* client_finished_label */
97 0, /* client_finished_label_len */
98 NULL, /* server_finished_label */
99 0, /* server_finished_label_len */
100 ssl_undefined_function_6,
101 ssl_undefined_function_7,
104 struct ssl_async_args {
108 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
110 int (*func_read) (SSL *, void *, size_t, size_t *);
111 int (*func_write) (SSL *, const void *, size_t, size_t *);
112 int (*func_other) (SSL *);
116 static const struct {
122 DANETLS_MATCHING_FULL, 0, NID_undef
125 DANETLS_MATCHING_2256, 1, NID_sha256
128 DANETLS_MATCHING_2512, 2, NID_sha512
132 static int dane_ctx_enable(struct dane_ctx_st *dctx)
134 const EVP_MD **mdevp;
136 uint8_t mdmax = DANETLS_MATCHING_LAST;
137 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
140 if (dctx->mdevp != NULL)
143 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
144 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
146 if (mdord == NULL || mdevp == NULL) {
149 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
153 /* Install default entries */
154 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
157 if (dane_mds[i].nid == NID_undef ||
158 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
160 mdevp[dane_mds[i].mtype] = md;
161 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
171 static void dane_ctx_final(struct dane_ctx_st *dctx)
173 OPENSSL_free(dctx->mdevp);
176 OPENSSL_free(dctx->mdord);
181 static void tlsa_free(danetls_record *t)
185 OPENSSL_free(t->data);
186 EVP_PKEY_free(t->spki);
190 static void dane_final(SSL_DANE *dane)
192 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
195 sk_X509_pop_free(dane->certs, X509_free);
198 X509_free(dane->mcert);
206 * dane_copy - Copy dane configuration, sans verification state.
208 static int ssl_dane_dup(SSL *to, SSL *from)
213 if (!DANETLS_ENABLED(&from->dane))
216 num = sk_danetls_record_num(from->dane.trecs);
217 dane_final(&to->dane);
218 to->dane.flags = from->dane.flags;
219 to->dane.dctx = &to->ctx->dane;
220 to->dane.trecs = sk_danetls_record_new_reserve(NULL, num);
222 if (to->dane.trecs == NULL) {
223 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
227 for (i = 0; i < num; ++i) {
228 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
230 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
231 t->data, t->dlen) <= 0)
237 static int dane_mtype_set(struct dane_ctx_st *dctx,
238 const EVP_MD *md, uint8_t mtype, uint8_t ord)
242 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
243 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
247 if (mtype > dctx->mdmax) {
248 const EVP_MD **mdevp;
250 int n = ((int)mtype) + 1;
252 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
254 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
259 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
261 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
266 /* Zero-fill any gaps */
267 for (i = dctx->mdmax + 1; i < mtype; ++i) {
275 dctx->mdevp[mtype] = md;
276 /* Coerce ordinal of disabled matching types to 0 */
277 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
282 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
284 if (mtype > dane->dctx->mdmax)
286 return dane->dctx->mdevp[mtype];
289 static int dane_tlsa_add(SSL_DANE *dane,
292 uint8_t mtype, unsigned const char *data, size_t dlen)
295 const EVP_MD *md = NULL;
296 int ilen = (int)dlen;
300 if (dane->trecs == NULL) {
301 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
305 if (ilen < 0 || dlen != (size_t)ilen) {
306 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
310 if (usage > DANETLS_USAGE_LAST) {
311 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
315 if (selector > DANETLS_SELECTOR_LAST) {
316 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
320 if (mtype != DANETLS_MATCHING_FULL) {
321 md = tlsa_md_get(dane, mtype);
323 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
328 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
329 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
333 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
337 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
338 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
343 t->selector = selector;
345 t->data = OPENSSL_malloc(dlen);
346 if (t->data == NULL) {
348 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
351 memcpy(t->data, data, dlen);
354 /* Validate and cache full certificate or public key */
355 if (mtype == DANETLS_MATCHING_FULL) {
356 const unsigned char *p = data;
358 EVP_PKEY *pkey = NULL;
361 case DANETLS_SELECTOR_CERT:
362 if (!d2i_X509(&cert, &p, ilen) || p < data ||
363 dlen != (size_t)(p - data)) {
365 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
368 if (X509_get0_pubkey(cert) == NULL) {
370 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
374 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
380 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
381 * records that contain full certificates of trust-anchors that are
382 * not present in the wire chain. For usage PKIX-TA(0), we augment
383 * the chain with untrusted Full(0) certificates from DNS, in case
384 * they are missing from the chain.
386 if ((dane->certs == NULL &&
387 (dane->certs = sk_X509_new_null()) == NULL) ||
388 !sk_X509_push(dane->certs, cert)) {
389 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
396 case DANETLS_SELECTOR_SPKI:
397 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
398 dlen != (size_t)(p - data)) {
400 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
405 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
406 * records that contain full bare keys of trust-anchors that are
407 * not present in the wire chain.
409 if (usage == DANETLS_USAGE_DANE_TA)
418 * Find the right insertion point for the new record.
420 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
421 * they can be processed first, as they require no chain building, and no
422 * expiration or hostname checks. Because DANE-EE(3) is numerically
423 * largest, this is accomplished via descending sort by "usage".
425 * We also sort in descending order by matching ordinal to simplify
426 * the implementation of digest agility in the verification code.
428 * The choice of order for the selector is not significant, so we
429 * use the same descending order for consistency.
431 num = sk_danetls_record_num(dane->trecs);
432 for (i = 0; i < num; ++i) {
433 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
435 if (rec->usage > usage)
437 if (rec->usage < usage)
439 if (rec->selector > selector)
441 if (rec->selector < selector)
443 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
448 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
450 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
453 dane->umask |= DANETLS_USAGE_BIT(usage);
459 * Return 0 if there is only one version configured and it was disabled
460 * at configure time. Return 1 otherwise.
462 static int ssl_check_allowed_versions(int min_version, int max_version)
464 int minisdtls = 0, maxisdtls = 0;
466 /* Figure out if we're doing DTLS versions or TLS versions */
467 if (min_version == DTLS1_BAD_VER
468 || min_version >> 8 == DTLS1_VERSION_MAJOR)
470 if (max_version == DTLS1_BAD_VER
471 || max_version >> 8 == DTLS1_VERSION_MAJOR)
473 /* A wildcard version of 0 could be DTLS or TLS. */
474 if ((minisdtls && !maxisdtls && max_version != 0)
475 || (maxisdtls && !minisdtls && min_version != 0)) {
476 /* Mixing DTLS and TLS versions will lead to sadness; deny it. */
480 if (minisdtls || maxisdtls) {
481 /* Do DTLS version checks. */
482 if (min_version == 0)
483 /* Ignore DTLS1_BAD_VER */
484 min_version = DTLS1_VERSION;
485 if (max_version == 0)
486 max_version = DTLS1_2_VERSION;
487 #ifdef OPENSSL_NO_DTLS1_2
488 if (max_version == DTLS1_2_VERSION)
489 max_version = DTLS1_VERSION;
491 #ifdef OPENSSL_NO_DTLS1
492 if (min_version == DTLS1_VERSION)
493 min_version = DTLS1_2_VERSION;
495 /* Done massaging versions; do the check. */
497 #ifdef OPENSSL_NO_DTLS1
498 || (DTLS_VERSION_GE(min_version, DTLS1_VERSION)
499 && DTLS_VERSION_GE(DTLS1_VERSION, max_version))
501 #ifdef OPENSSL_NO_DTLS1_2
502 || (DTLS_VERSION_GE(min_version, DTLS1_2_VERSION)
503 && DTLS_VERSION_GE(DTLS1_2_VERSION, max_version))
508 /* Regular TLS version checks. */
509 if (min_version == 0)
510 min_version = SSL3_VERSION;
511 if (max_version == 0)
512 max_version = TLS1_3_VERSION;
513 #ifdef OPENSSL_NO_TLS1_3
514 if (max_version == TLS1_3_VERSION)
515 max_version = TLS1_2_VERSION;
517 #ifdef OPENSSL_NO_TLS1_2
518 if (max_version == TLS1_2_VERSION)
519 max_version = TLS1_1_VERSION;
521 #ifdef OPENSSL_NO_TLS1_1
522 if (max_version == TLS1_1_VERSION)
523 max_version = TLS1_VERSION;
525 #ifdef OPENSSL_NO_TLS1
526 if (max_version == TLS1_VERSION)
527 max_version = SSL3_VERSION;
529 #ifdef OPENSSL_NO_SSL3
530 if (min_version == SSL3_VERSION)
531 min_version = TLS1_VERSION;
533 #ifdef OPENSSL_NO_TLS1
534 if (min_version == TLS1_VERSION)
535 min_version = TLS1_1_VERSION;
537 #ifdef OPENSSL_NO_TLS1_1
538 if (min_version == TLS1_1_VERSION)
539 min_version = TLS1_2_VERSION;
541 #ifdef OPENSSL_NO_TLS1_2
542 if (min_version == TLS1_2_VERSION)
543 min_version = TLS1_3_VERSION;
545 /* Done massaging versions; do the check. */
547 #ifdef OPENSSL_NO_SSL3
548 || (min_version <= SSL3_VERSION && SSL3_VERSION <= max_version)
550 #ifdef OPENSSL_NO_TLS1
551 || (min_version <= TLS1_VERSION && TLS1_VERSION <= max_version)
553 #ifdef OPENSSL_NO_TLS1_1
554 || (min_version <= TLS1_1_VERSION && TLS1_1_VERSION <= max_version)
556 #ifdef OPENSSL_NO_TLS1_2
557 || (min_version <= TLS1_2_VERSION && TLS1_2_VERSION <= max_version)
559 #ifdef OPENSSL_NO_TLS1_3
560 || (min_version <= TLS1_3_VERSION && TLS1_3_VERSION <= max_version)
568 static void clear_ciphers(SSL *s)
570 /* clear the current cipher */
571 ssl_clear_cipher_ctx(s);
572 ssl_clear_hash_ctx(&s->read_hash);
573 ssl_clear_hash_ctx(&s->write_hash);
576 int SSL_clear(SSL *s)
578 if (s->method == NULL) {
579 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
583 if (ssl_clear_bad_session(s)) {
584 SSL_SESSION_free(s->session);
587 SSL_SESSION_free(s->psksession);
588 s->psksession = NULL;
589 OPENSSL_free(s->psksession_id);
590 s->psksession_id = NULL;
591 s->psksession_id_len = 0;
592 s->hello_retry_request = 0;
599 if (s->renegotiate) {
600 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
604 ossl_statem_clear(s);
606 s->version = s->method->version;
607 s->client_version = s->version;
608 s->rwstate = SSL_NOTHING;
610 BUF_MEM_free(s->init_buf);
615 s->key_update = SSL_KEY_UPDATE_NONE;
617 EVP_MD_CTX_free(s->pha_dgst);
620 /* Reset DANE verification result state */
623 X509_free(s->dane.mcert);
624 s->dane.mcert = NULL;
625 s->dane.mtlsa = NULL;
627 /* Clear the verification result peername */
628 X509_VERIFY_PARAM_move_peername(s->param, NULL);
631 * Check to see if we were changed into a different method, if so, revert
634 if (s->method != s->ctx->method) {
635 s->method->ssl_free(s);
636 s->method = s->ctx->method;
637 if (!s->method->ssl_new(s))
640 if (!s->method->ssl_clear(s))
644 RECORD_LAYER_clear(&s->rlayer);
649 /** Used to change an SSL_CTXs default SSL method type */
650 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
652 STACK_OF(SSL_CIPHER) *sk;
656 if (!SSL_CTX_set_ciphersuites(ctx, TLS_DEFAULT_CIPHERSUITES)) {
657 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
660 sk = ssl_create_cipher_list(ctx->method,
661 ctx->tls13_ciphersuites,
663 &(ctx->cipher_list_by_id),
664 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
665 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
666 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
672 SSL *SSL_new(SSL_CTX *ctx)
677 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
680 if (ctx->method == NULL) {
681 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
685 s = OPENSSL_zalloc(sizeof(*s));
690 s->lock = CRYPTO_THREAD_lock_new();
691 if (s->lock == NULL) {
697 RECORD_LAYER_init(&s->rlayer, s);
699 s->options = ctx->options;
700 s->dane.flags = ctx->dane.flags;
701 s->min_proto_version = ctx->min_proto_version;
702 s->max_proto_version = ctx->max_proto_version;
704 s->max_cert_list = ctx->max_cert_list;
705 s->max_early_data = ctx->max_early_data;
706 s->recv_max_early_data = ctx->recv_max_early_data;
707 s->num_tickets = ctx->num_tickets;
708 s->pha_enabled = ctx->pha_enabled;
710 /* Shallow copy of the ciphersuites stack */
711 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
712 if (s->tls13_ciphersuites == NULL)
716 * Earlier library versions used to copy the pointer to the CERT, not
717 * its contents; only when setting new parameters for the per-SSL
718 * copy, ssl_cert_new would be called (and the direct reference to
719 * the per-SSL_CTX settings would be lost, but those still were
720 * indirectly accessed for various purposes, and for that reason they
721 * used to be known as s->ctx->default_cert). Now we don't look at the
722 * SSL_CTX's CERT after having duplicated it once.
724 s->cert = ssl_cert_dup(ctx->cert);
728 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
729 s->msg_callback = ctx->msg_callback;
730 s->msg_callback_arg = ctx->msg_callback_arg;
731 s->verify_mode = ctx->verify_mode;
732 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
733 s->record_padding_cb = ctx->record_padding_cb;
734 s->record_padding_arg = ctx->record_padding_arg;
735 s->block_padding = ctx->block_padding;
736 s->sid_ctx_length = ctx->sid_ctx_length;
737 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
739 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
740 s->verify_callback = ctx->default_verify_callback;
741 s->generate_session_id = ctx->generate_session_id;
743 s->param = X509_VERIFY_PARAM_new();
744 if (s->param == NULL)
746 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
747 s->quiet_shutdown = ctx->quiet_shutdown;
749 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
750 s->max_send_fragment = ctx->max_send_fragment;
751 s->split_send_fragment = ctx->split_send_fragment;
752 s->max_pipelines = ctx->max_pipelines;
753 if (s->max_pipelines > 1)
754 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
755 if (ctx->default_read_buf_len > 0)
756 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
761 s->ext.debug_arg = NULL;
762 s->ext.ticket_expected = 0;
763 s->ext.status_type = ctx->ext.status_type;
764 s->ext.status_expected = 0;
765 s->ext.ocsp.ids = NULL;
766 s->ext.ocsp.exts = NULL;
767 s->ext.ocsp.resp = NULL;
768 s->ext.ocsp.resp_len = 0;
770 s->session_ctx = ctx;
771 #ifndef OPENSSL_NO_EC
772 if (ctx->ext.ecpointformats) {
773 s->ext.ecpointformats =
774 OPENSSL_memdup(ctx->ext.ecpointformats,
775 ctx->ext.ecpointformats_len);
776 if (!s->ext.ecpointformats)
778 s->ext.ecpointformats_len =
779 ctx->ext.ecpointformats_len;
781 if (ctx->ext.supportedgroups) {
782 s->ext.supportedgroups =
783 OPENSSL_memdup(ctx->ext.supportedgroups,
784 ctx->ext.supportedgroups_len
785 * sizeof(*ctx->ext.supportedgroups));
786 if (!s->ext.supportedgroups)
788 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
791 #ifndef OPENSSL_NO_NEXTPROTONEG
795 if (s->ctx->ext.alpn) {
796 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
797 if (s->ext.alpn == NULL)
799 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
800 s->ext.alpn_len = s->ctx->ext.alpn_len;
803 s->verified_chain = NULL;
804 s->verify_result = X509_V_OK;
806 s->default_passwd_callback = ctx->default_passwd_callback;
807 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
809 s->method = ctx->method;
811 s->key_update = SSL_KEY_UPDATE_NONE;
813 s->allow_early_data_cb = ctx->allow_early_data_cb;
814 s->allow_early_data_cb_data = ctx->allow_early_data_cb_data;
816 if (!s->method->ssl_new(s))
819 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
824 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
827 #ifndef OPENSSL_NO_PSK
828 s->psk_client_callback = ctx->psk_client_callback;
829 s->psk_server_callback = ctx->psk_server_callback;
831 s->psk_find_session_cb = ctx->psk_find_session_cb;
832 s->psk_use_session_cb = ctx->psk_use_session_cb;
836 #ifndef OPENSSL_NO_CT
837 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
838 ctx->ct_validation_callback_arg))
845 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
849 int SSL_is_dtls(const SSL *s)
851 return SSL_IS_DTLS(s) ? 1 : 0;
854 int SSL_up_ref(SSL *s)
858 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
861 REF_PRINT_COUNT("SSL", s);
862 REF_ASSERT_ISNT(i < 2);
863 return ((i > 1) ? 1 : 0);
866 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
867 unsigned int sid_ctx_len)
869 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
870 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
871 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
874 ctx->sid_ctx_length = sid_ctx_len;
875 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
880 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
881 unsigned int sid_ctx_len)
883 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
884 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
885 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
888 ssl->sid_ctx_length = sid_ctx_len;
889 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
894 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
896 CRYPTO_THREAD_write_lock(ctx->lock);
897 ctx->generate_session_id = cb;
898 CRYPTO_THREAD_unlock(ctx->lock);
902 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
904 CRYPTO_THREAD_write_lock(ssl->lock);
905 ssl->generate_session_id = cb;
906 CRYPTO_THREAD_unlock(ssl->lock);
910 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
914 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
915 * we can "construct" a session to give us the desired check - i.e. to
916 * find if there's a session in the hash table that would conflict with
917 * any new session built out of this id/id_len and the ssl_version in use
922 if (id_len > sizeof(r.session_id))
925 r.ssl_version = ssl->version;
926 r.session_id_length = id_len;
927 memcpy(r.session_id, id, id_len);
929 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
930 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
931 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
935 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
937 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
940 int SSL_set_purpose(SSL *s, int purpose)
942 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
945 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
947 return X509_VERIFY_PARAM_set_trust(s->param, trust);
950 int SSL_set_trust(SSL *s, int trust)
952 return X509_VERIFY_PARAM_set_trust(s->param, trust);
955 int SSL_set1_host(SSL *s, const char *hostname)
957 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
960 int SSL_add1_host(SSL *s, const char *hostname)
962 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
965 void SSL_set_hostflags(SSL *s, unsigned int flags)
967 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
970 const char *SSL_get0_peername(SSL *s)
972 return X509_VERIFY_PARAM_get0_peername(s->param);
975 int SSL_CTX_dane_enable(SSL_CTX *ctx)
977 return dane_ctx_enable(&ctx->dane);
980 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
982 unsigned long orig = ctx->dane.flags;
984 ctx->dane.flags |= flags;
988 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
990 unsigned long orig = ctx->dane.flags;
992 ctx->dane.flags &= ~flags;
996 int SSL_dane_enable(SSL *s, const char *basedomain)
998 SSL_DANE *dane = &s->dane;
1000 if (s->ctx->dane.mdmax == 0) {
1001 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
1004 if (dane->trecs != NULL) {
1005 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1010 * Default SNI name. This rejects empty names, while set1_host below
1011 * accepts them and disables host name checks. To avoid side-effects with
1012 * invalid input, set the SNI name first.
1014 if (s->ext.hostname == NULL) {
1015 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1016 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1021 /* Primary RFC6125 reference identifier */
1022 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1023 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1029 dane->dctx = &s->ctx->dane;
1030 dane->trecs = sk_danetls_record_new_null();
1032 if (dane->trecs == NULL) {
1033 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1039 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1041 unsigned long orig = ssl->dane.flags;
1043 ssl->dane.flags |= flags;
1047 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1049 unsigned long orig = ssl->dane.flags;
1051 ssl->dane.flags &= ~flags;
1055 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1057 SSL_DANE *dane = &s->dane;
1059 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1063 *mcert = dane->mcert;
1065 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1070 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1071 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1073 SSL_DANE *dane = &s->dane;
1075 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1079 *usage = dane->mtlsa->usage;
1081 *selector = dane->mtlsa->selector;
1083 *mtype = dane->mtlsa->mtype;
1085 *data = dane->mtlsa->data;
1087 *dlen = dane->mtlsa->dlen;
1092 SSL_DANE *SSL_get0_dane(SSL *s)
1097 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1098 uint8_t mtype, unsigned const char *data, size_t dlen)
1100 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1103 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1106 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1109 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1111 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1114 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1116 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1119 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1124 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1129 void SSL_certs_clear(SSL *s)
1131 ssl_cert_clear_certs(s->cert);
1134 void SSL_free(SSL *s)
1140 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1141 REF_PRINT_COUNT("SSL", s);
1144 REF_ASSERT_ISNT(i < 0);
1146 X509_VERIFY_PARAM_free(s->param);
1147 dane_final(&s->dane);
1148 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1150 RECORD_LAYER_release(&s->rlayer);
1152 /* Ignore return value */
1153 ssl_free_wbio_buffer(s);
1155 BIO_free_all(s->wbio);
1157 BIO_free_all(s->rbio);
1160 BUF_MEM_free(s->init_buf);
1162 /* add extra stuff */
1163 sk_SSL_CIPHER_free(s->cipher_list);
1164 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1165 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1167 /* Make the next call work :-) */
1168 if (s->session != NULL) {
1169 ssl_clear_bad_session(s);
1170 SSL_SESSION_free(s->session);
1172 SSL_SESSION_free(s->psksession);
1173 OPENSSL_free(s->psksession_id);
1177 ssl_cert_free(s->cert);
1178 /* Free up if allocated */
1180 OPENSSL_free(s->ext.hostname);
1181 SSL_CTX_free(s->session_ctx);
1182 #ifndef OPENSSL_NO_EC
1183 OPENSSL_free(s->ext.ecpointformats);
1184 OPENSSL_free(s->ext.supportedgroups);
1185 #endif /* OPENSSL_NO_EC */
1186 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1187 #ifndef OPENSSL_NO_OCSP
1188 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1190 #ifndef OPENSSL_NO_CT
1191 SCT_LIST_free(s->scts);
1192 OPENSSL_free(s->ext.scts);
1194 OPENSSL_free(s->ext.ocsp.resp);
1195 OPENSSL_free(s->ext.alpn);
1196 OPENSSL_free(s->ext.tls13_cookie);
1197 OPENSSL_free(s->clienthello);
1198 OPENSSL_free(s->pha_context);
1199 EVP_MD_CTX_free(s->pha_dgst);
1201 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1202 sk_X509_NAME_pop_free(s->client_ca_names, X509_NAME_free);
1204 sk_X509_pop_free(s->verified_chain, X509_free);
1206 if (s->method != NULL)
1207 s->method->ssl_free(s);
1209 SSL_CTX_free(s->ctx);
1211 ASYNC_WAIT_CTX_free(s->waitctx);
1213 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1214 OPENSSL_free(s->ext.npn);
1217 #ifndef OPENSSL_NO_SRTP
1218 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1221 CRYPTO_THREAD_lock_free(s->lock);
1226 void SSL_set0_rbio(SSL *s, BIO *rbio)
1228 BIO_free_all(s->rbio);
1232 void SSL_set0_wbio(SSL *s, BIO *wbio)
1235 * If the output buffering BIO is still in place, remove it
1237 if (s->bbio != NULL)
1238 s->wbio = BIO_pop(s->wbio);
1240 BIO_free_all(s->wbio);
1243 /* Re-attach |bbio| to the new |wbio|. */
1244 if (s->bbio != NULL)
1245 s->wbio = BIO_push(s->bbio, s->wbio);
1248 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1251 * For historical reasons, this function has many different cases in
1252 * ownership handling.
1255 /* If nothing has changed, do nothing */
1256 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1260 * If the two arguments are equal then one fewer reference is granted by the
1261 * caller than we want to take
1263 if (rbio != NULL && rbio == wbio)
1267 * If only the wbio is changed only adopt one reference.
1269 if (rbio == SSL_get_rbio(s)) {
1270 SSL_set0_wbio(s, wbio);
1274 * There is an asymmetry here for historical reasons. If only the rbio is
1275 * changed AND the rbio and wbio were originally different, then we only
1276 * adopt one reference.
1278 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1279 SSL_set0_rbio(s, rbio);
1283 /* Otherwise, adopt both references. */
1284 SSL_set0_rbio(s, rbio);
1285 SSL_set0_wbio(s, wbio);
1288 BIO *SSL_get_rbio(const SSL *s)
1293 BIO *SSL_get_wbio(const SSL *s)
1295 if (s->bbio != NULL) {
1297 * If |bbio| is active, the true caller-configured BIO is its
1300 return BIO_next(s->bbio);
1305 int SSL_get_fd(const SSL *s)
1307 return SSL_get_rfd(s);
1310 int SSL_get_rfd(const SSL *s)
1315 b = SSL_get_rbio(s);
1316 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1318 BIO_get_fd(r, &ret);
1322 int SSL_get_wfd(const SSL *s)
1327 b = SSL_get_wbio(s);
1328 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1330 BIO_get_fd(r, &ret);
1334 #ifndef OPENSSL_NO_SOCK
1335 int SSL_set_fd(SSL *s, int fd)
1340 bio = BIO_new(BIO_s_socket());
1343 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1346 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1347 SSL_set_bio(s, bio, bio);
1348 #ifndef OPENSSL_NO_KTLS
1350 * The new socket is created successfully regardless of ktls_enable.
1351 * ktls_enable doesn't change any functionality of the socket, except
1352 * changing the setsockopt to enable the processing of ktls_start.
1353 * Thus, it is not a problem to call it for non-TLS sockets.
1356 #endif /* OPENSSL_NO_KTLS */
1362 int SSL_set_wfd(SSL *s, int fd)
1364 BIO *rbio = SSL_get_rbio(s);
1366 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1367 || (int)BIO_get_fd(rbio, NULL) != fd) {
1368 BIO *bio = BIO_new(BIO_s_socket());
1371 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1374 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1375 SSL_set0_wbio(s, bio);
1376 #ifndef OPENSSL_NO_KTLS
1378 * The new socket is created successfully regardless of ktls_enable.
1379 * ktls_enable doesn't change any functionality of the socket, except
1380 * changing the setsockopt to enable the processing of ktls_start.
1381 * Thus, it is not a problem to call it for non-TLS sockets.
1384 #endif /* OPENSSL_NO_KTLS */
1387 SSL_set0_wbio(s, rbio);
1392 int SSL_set_rfd(SSL *s, int fd)
1394 BIO *wbio = SSL_get_wbio(s);
1396 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1397 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1398 BIO *bio = BIO_new(BIO_s_socket());
1401 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1404 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1405 SSL_set0_rbio(s, bio);
1408 SSL_set0_rbio(s, wbio);
1415 /* return length of latest Finished message we sent, copy to 'buf' */
1416 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1420 if (s->s3 != NULL) {
1421 ret = s->s3->tmp.finish_md_len;
1424 memcpy(buf, s->s3->tmp.finish_md, count);
1429 /* return length of latest Finished message we expected, copy to 'buf' */
1430 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1434 if (s->s3 != NULL) {
1435 ret = s->s3->tmp.peer_finish_md_len;
1438 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1443 int SSL_get_verify_mode(const SSL *s)
1445 return s->verify_mode;
1448 int SSL_get_verify_depth(const SSL *s)
1450 return X509_VERIFY_PARAM_get_depth(s->param);
1453 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1454 return s->verify_callback;
1457 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1459 return ctx->verify_mode;
1462 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1464 return X509_VERIFY_PARAM_get_depth(ctx->param);
1467 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1468 return ctx->default_verify_callback;
1471 void SSL_set_verify(SSL *s, int mode,
1472 int (*callback) (int ok, X509_STORE_CTX *ctx))
1474 s->verify_mode = mode;
1475 if (callback != NULL)
1476 s->verify_callback = callback;
1479 void SSL_set_verify_depth(SSL *s, int depth)
1481 X509_VERIFY_PARAM_set_depth(s->param, depth);
1484 void SSL_set_read_ahead(SSL *s, int yes)
1486 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1489 int SSL_get_read_ahead(const SSL *s)
1491 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1494 int SSL_pending(const SSL *s)
1496 size_t pending = s->method->ssl_pending(s);
1499 * SSL_pending cannot work properly if read-ahead is enabled
1500 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1501 * impossible to fix since SSL_pending cannot report errors that may be
1502 * observed while scanning the new data. (Note that SSL_pending() is
1503 * often used as a boolean value, so we'd better not return -1.)
1505 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1506 * we just return INT_MAX.
1508 return pending < INT_MAX ? (int)pending : INT_MAX;
1511 int SSL_has_pending(const SSL *s)
1514 * Similar to SSL_pending() but returns a 1 to indicate that we have
1515 * unprocessed data available or 0 otherwise (as opposed to the number of
1516 * bytes available). Unlike SSL_pending() this will take into account
1517 * read_ahead data. A 1 return simply indicates that we have unprocessed
1518 * data. That data may not result in any application data, or we may fail
1519 * to parse the records for some reason.
1521 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1524 return RECORD_LAYER_read_pending(&s->rlayer);
1527 X509 *SSL_get_peer_certificate(const SSL *s)
1531 if ((s == NULL) || (s->session == NULL))
1534 r = s->session->peer;
1544 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1548 if ((s == NULL) || (s->session == NULL))
1551 r = s->session->peer_chain;
1554 * If we are a client, cert_chain includes the peer's own certificate; if
1555 * we are a server, it does not.
1562 * Now in theory, since the calling process own 't' it should be safe to
1563 * modify. We need to be able to read f without being hassled
1565 int SSL_copy_session_id(SSL *t, const SSL *f)
1568 /* Do we need to to SSL locking? */
1569 if (!SSL_set_session(t, SSL_get_session(f))) {
1574 * what if we are setup for one protocol version but want to talk another
1576 if (t->method != f->method) {
1577 t->method->ssl_free(t);
1578 t->method = f->method;
1579 if (t->method->ssl_new(t) == 0)
1583 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1584 ssl_cert_free(t->cert);
1586 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1593 /* Fix this so it checks all the valid key/cert options */
1594 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1596 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1597 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1600 if (ctx->cert->key->privatekey == NULL) {
1601 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1604 return X509_check_private_key
1605 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1608 /* Fix this function so that it takes an optional type parameter */
1609 int SSL_check_private_key(const SSL *ssl)
1612 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1615 if (ssl->cert->key->x509 == NULL) {
1616 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1619 if (ssl->cert->key->privatekey == NULL) {
1620 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1623 return X509_check_private_key(ssl->cert->key->x509,
1624 ssl->cert->key->privatekey);
1627 int SSL_waiting_for_async(SSL *s)
1635 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1637 ASYNC_WAIT_CTX *ctx = s->waitctx;
1641 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1644 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1645 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1647 ASYNC_WAIT_CTX *ctx = s->waitctx;
1651 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1655 int SSL_accept(SSL *s)
1657 if (s->handshake_func == NULL) {
1658 /* Not properly initialized yet */
1659 SSL_set_accept_state(s);
1662 return SSL_do_handshake(s);
1665 int SSL_connect(SSL *s)
1667 if (s->handshake_func == NULL) {
1668 /* Not properly initialized yet */
1669 SSL_set_connect_state(s);
1672 return SSL_do_handshake(s);
1675 long SSL_get_default_timeout(const SSL *s)
1677 return s->method->get_timeout();
1680 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1681 int (*func) (void *))
1684 if (s->waitctx == NULL) {
1685 s->waitctx = ASYNC_WAIT_CTX_new();
1686 if (s->waitctx == NULL)
1689 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1690 sizeof(struct ssl_async_args))) {
1692 s->rwstate = SSL_NOTHING;
1693 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1696 s->rwstate = SSL_ASYNC_PAUSED;
1699 s->rwstate = SSL_ASYNC_NO_JOBS;
1705 s->rwstate = SSL_NOTHING;
1706 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1707 /* Shouldn't happen */
1712 static int ssl_io_intern(void *vargs)
1714 struct ssl_async_args *args;
1719 args = (struct ssl_async_args *)vargs;
1723 switch (args->type) {
1725 return args->f.func_read(s, buf, num, &s->asyncrw);
1727 return args->f.func_write(s, buf, num, &s->asyncrw);
1729 return args->f.func_other(s);
1734 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1736 if (s->handshake_func == NULL) {
1737 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1741 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1742 s->rwstate = SSL_NOTHING;
1746 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1747 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1748 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1752 * If we are a client and haven't received the ServerHello etc then we
1755 ossl_statem_check_finish_init(s, 0);
1757 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1758 struct ssl_async_args args;
1764 args.type = READFUNC;
1765 args.f.func_read = s->method->ssl_read;
1767 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1768 *readbytes = s->asyncrw;
1771 return s->method->ssl_read(s, buf, num, readbytes);
1775 int SSL_read(SSL *s, void *buf, int num)
1781 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1785 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1788 * The cast is safe here because ret should be <= INT_MAX because num is
1792 ret = (int)readbytes;
1797 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1799 int ret = ssl_read_internal(s, buf, num, readbytes);
1806 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1811 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1812 return SSL_READ_EARLY_DATA_ERROR;
1815 switch (s->early_data_state) {
1816 case SSL_EARLY_DATA_NONE:
1817 if (!SSL_in_before(s)) {
1818 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1819 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1820 return SSL_READ_EARLY_DATA_ERROR;
1824 case SSL_EARLY_DATA_ACCEPT_RETRY:
1825 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1826 ret = SSL_accept(s);
1829 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1830 return SSL_READ_EARLY_DATA_ERROR;
1834 case SSL_EARLY_DATA_READ_RETRY:
1835 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1836 s->early_data_state = SSL_EARLY_DATA_READING;
1837 ret = SSL_read_ex(s, buf, num, readbytes);
1839 * State machine will update early_data_state to
1840 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1843 if (ret > 0 || (ret <= 0 && s->early_data_state
1844 != SSL_EARLY_DATA_FINISHED_READING)) {
1845 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1846 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1847 : SSL_READ_EARLY_DATA_ERROR;
1850 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1853 return SSL_READ_EARLY_DATA_FINISH;
1856 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1857 return SSL_READ_EARLY_DATA_ERROR;
1861 int SSL_get_early_data_status(const SSL *s)
1863 return s->ext.early_data;
1866 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1868 if (s->handshake_func == NULL) {
1869 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1873 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1876 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1877 struct ssl_async_args args;
1883 args.type = READFUNC;
1884 args.f.func_read = s->method->ssl_peek;
1886 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1887 *readbytes = s->asyncrw;
1890 return s->method->ssl_peek(s, buf, num, readbytes);
1894 int SSL_peek(SSL *s, void *buf, int num)
1900 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1904 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1907 * The cast is safe here because ret should be <= INT_MAX because num is
1911 ret = (int)readbytes;
1917 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1919 int ret = ssl_peek_internal(s, buf, num, readbytes);
1926 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1928 if (s->handshake_func == NULL) {
1929 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1933 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1934 s->rwstate = SSL_NOTHING;
1935 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1939 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1940 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1941 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1942 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1945 /* If we are a client and haven't sent the Finished we better do that */
1946 ossl_statem_check_finish_init(s, 1);
1948 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1950 struct ssl_async_args args;
1953 args.buf = (void *)buf;
1955 args.type = WRITEFUNC;
1956 args.f.func_write = s->method->ssl_write;
1958 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1959 *written = s->asyncrw;
1962 return s->method->ssl_write(s, buf, num, written);
1966 int SSL_write(SSL *s, const void *buf, int num)
1972 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1976 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1979 * The cast is safe here because ret should be <= INT_MAX because num is
1988 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1990 int ret = ssl_write_internal(s, buf, num, written);
1997 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1999 int ret, early_data_state;
2001 uint32_t partialwrite;
2003 switch (s->early_data_state) {
2004 case SSL_EARLY_DATA_NONE:
2006 || !SSL_in_before(s)
2007 || ((s->session == NULL || s->session->ext.max_early_data == 0)
2008 && (s->psk_use_session_cb == NULL))) {
2009 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
2010 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2015 case SSL_EARLY_DATA_CONNECT_RETRY:
2016 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
2017 ret = SSL_connect(s);
2020 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2025 case SSL_EARLY_DATA_WRITE_RETRY:
2026 s->early_data_state = SSL_EARLY_DATA_WRITING;
2028 * We disable partial write for early data because we don't keep track
2029 * of how many bytes we've written between the SSL_write_ex() call and
2030 * the flush if the flush needs to be retried)
2032 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2033 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2034 ret = SSL_write_ex(s, buf, num, &writtmp);
2035 s->mode |= partialwrite;
2037 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2040 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2043 case SSL_EARLY_DATA_WRITE_FLUSH:
2044 /* The buffering BIO is still in place so we need to flush it */
2045 if (statem_flush(s) != 1)
2048 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2051 case SSL_EARLY_DATA_FINISHED_READING:
2052 case SSL_EARLY_DATA_READ_RETRY:
2053 early_data_state = s->early_data_state;
2054 /* We are a server writing to an unauthenticated client */
2055 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2056 ret = SSL_write_ex(s, buf, num, written);
2057 /* The buffering BIO is still in place */
2059 (void)BIO_flush(s->wbio);
2060 s->early_data_state = early_data_state;
2064 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2069 int SSL_shutdown(SSL *s)
2072 * Note that this function behaves differently from what one might
2073 * expect. Return values are 0 for no success (yet), 1 for success; but
2074 * calling it once is usually not enough, even if blocking I/O is used
2075 * (see ssl3_shutdown).
2078 if (s->handshake_func == NULL) {
2079 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2083 if (!SSL_in_init(s)) {
2084 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2085 struct ssl_async_args args;
2088 args.type = OTHERFUNC;
2089 args.f.func_other = s->method->ssl_shutdown;
2091 return ssl_start_async_job(s, &args, ssl_io_intern);
2093 return s->method->ssl_shutdown(s);
2096 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2101 int SSL_key_update(SSL *s, int updatetype)
2104 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2105 * negotiated, and that it is appropriate to call SSL_key_update() instead
2106 * of SSL_renegotiate().
2108 if (!SSL_IS_TLS13(s)) {
2109 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2113 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2114 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2115 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2119 if (!SSL_is_init_finished(s)) {
2120 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2124 ossl_statem_set_in_init(s, 1);
2125 s->key_update = updatetype;
2129 int SSL_get_key_update_type(SSL *s)
2131 return s->key_update;
2134 int SSL_renegotiate(SSL *s)
2136 if (SSL_IS_TLS13(s)) {
2137 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2141 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2142 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2149 return s->method->ssl_renegotiate(s);
2152 int SSL_renegotiate_abbreviated(SSL *s)
2154 if (SSL_IS_TLS13(s)) {
2155 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2159 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2160 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2167 return s->method->ssl_renegotiate(s);
2170 int SSL_renegotiate_pending(SSL *s)
2173 * becomes true when negotiation is requested; false again once a
2174 * handshake has finished
2176 return (s->renegotiate != 0);
2179 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2184 case SSL_CTRL_GET_READ_AHEAD:
2185 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2186 case SSL_CTRL_SET_READ_AHEAD:
2187 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2188 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2191 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2192 s->msg_callback_arg = parg;
2196 return (s->mode |= larg);
2197 case SSL_CTRL_CLEAR_MODE:
2198 return (s->mode &= ~larg);
2199 case SSL_CTRL_GET_MAX_CERT_LIST:
2200 return (long)s->max_cert_list;
2201 case SSL_CTRL_SET_MAX_CERT_LIST:
2204 l = (long)s->max_cert_list;
2205 s->max_cert_list = (size_t)larg;
2207 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2208 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2210 #ifndef OPENSSL_NO_KTLS
2211 if (s->wbio != NULL && BIO_get_ktls_send(s->wbio))
2213 #endif /* OPENSSL_NO_KTLS */
2214 s->max_send_fragment = larg;
2215 if (s->max_send_fragment < s->split_send_fragment)
2216 s->split_send_fragment = s->max_send_fragment;
2218 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2219 if ((size_t)larg > s->max_send_fragment || larg == 0)
2221 s->split_send_fragment = larg;
2223 case SSL_CTRL_SET_MAX_PIPELINES:
2224 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2226 s->max_pipelines = larg;
2228 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2230 case SSL_CTRL_GET_RI_SUPPORT:
2232 return s->s3->send_connection_binding;
2235 case SSL_CTRL_CERT_FLAGS:
2236 return (s->cert->cert_flags |= larg);
2237 case SSL_CTRL_CLEAR_CERT_FLAGS:
2238 return (s->cert->cert_flags &= ~larg);
2240 case SSL_CTRL_GET_RAW_CIPHERLIST:
2242 if (s->s3->tmp.ciphers_raw == NULL)
2244 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2245 return (int)s->s3->tmp.ciphers_rawlen;
2247 return TLS_CIPHER_LEN;
2249 case SSL_CTRL_GET_EXTMS_SUPPORT:
2250 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2252 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2256 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2257 return ssl_check_allowed_versions(larg, s->max_proto_version)
2258 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2259 &s->min_proto_version);
2260 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2261 return s->min_proto_version;
2262 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2263 return ssl_check_allowed_versions(s->min_proto_version, larg)
2264 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2265 &s->max_proto_version);
2266 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2267 return s->max_proto_version;
2269 return s->method->ssl_ctrl(s, cmd, larg, parg);
2273 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2276 case SSL_CTRL_SET_MSG_CALLBACK:
2277 s->msg_callback = (void (*)
2278 (int write_p, int version, int content_type,
2279 const void *buf, size_t len, SSL *ssl,
2284 return s->method->ssl_callback_ctrl(s, cmd, fp);
2288 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2290 return ctx->sessions;
2293 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2296 /* For some cases with ctx == NULL perform syntax checks */
2299 #ifndef OPENSSL_NO_EC
2300 case SSL_CTRL_SET_GROUPS_LIST:
2301 return tls1_set_groups_list(NULL, NULL, parg);
2303 case SSL_CTRL_SET_SIGALGS_LIST:
2304 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2305 return tls1_set_sigalgs_list(NULL, parg, 0);
2312 case SSL_CTRL_GET_READ_AHEAD:
2313 return ctx->read_ahead;
2314 case SSL_CTRL_SET_READ_AHEAD:
2315 l = ctx->read_ahead;
2316 ctx->read_ahead = larg;
2319 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2320 ctx->msg_callback_arg = parg;
2323 case SSL_CTRL_GET_MAX_CERT_LIST:
2324 return (long)ctx->max_cert_list;
2325 case SSL_CTRL_SET_MAX_CERT_LIST:
2328 l = (long)ctx->max_cert_list;
2329 ctx->max_cert_list = (size_t)larg;
2332 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2335 l = (long)ctx->session_cache_size;
2336 ctx->session_cache_size = (size_t)larg;
2338 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2339 return (long)ctx->session_cache_size;
2340 case SSL_CTRL_SET_SESS_CACHE_MODE:
2341 l = ctx->session_cache_mode;
2342 ctx->session_cache_mode = larg;
2344 case SSL_CTRL_GET_SESS_CACHE_MODE:
2345 return ctx->session_cache_mode;
2347 case SSL_CTRL_SESS_NUMBER:
2348 return lh_SSL_SESSION_num_items(ctx->sessions);
2349 case SSL_CTRL_SESS_CONNECT:
2350 return tsan_load(&ctx->stats.sess_connect);
2351 case SSL_CTRL_SESS_CONNECT_GOOD:
2352 return tsan_load(&ctx->stats.sess_connect_good);
2353 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2354 return tsan_load(&ctx->stats.sess_connect_renegotiate);
2355 case SSL_CTRL_SESS_ACCEPT:
2356 return tsan_load(&ctx->stats.sess_accept);
2357 case SSL_CTRL_SESS_ACCEPT_GOOD:
2358 return tsan_load(&ctx->stats.sess_accept_good);
2359 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2360 return tsan_load(&ctx->stats.sess_accept_renegotiate);
2361 case SSL_CTRL_SESS_HIT:
2362 return tsan_load(&ctx->stats.sess_hit);
2363 case SSL_CTRL_SESS_CB_HIT:
2364 return tsan_load(&ctx->stats.sess_cb_hit);
2365 case SSL_CTRL_SESS_MISSES:
2366 return tsan_load(&ctx->stats.sess_miss);
2367 case SSL_CTRL_SESS_TIMEOUTS:
2368 return tsan_load(&ctx->stats.sess_timeout);
2369 case SSL_CTRL_SESS_CACHE_FULL:
2370 return tsan_load(&ctx->stats.sess_cache_full);
2372 return (ctx->mode |= larg);
2373 case SSL_CTRL_CLEAR_MODE:
2374 return (ctx->mode &= ~larg);
2375 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2376 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2378 ctx->max_send_fragment = larg;
2379 if (ctx->max_send_fragment < ctx->split_send_fragment)
2380 ctx->split_send_fragment = ctx->max_send_fragment;
2382 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2383 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2385 ctx->split_send_fragment = larg;
2387 case SSL_CTRL_SET_MAX_PIPELINES:
2388 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2390 ctx->max_pipelines = larg;
2392 case SSL_CTRL_CERT_FLAGS:
2393 return (ctx->cert->cert_flags |= larg);
2394 case SSL_CTRL_CLEAR_CERT_FLAGS:
2395 return (ctx->cert->cert_flags &= ~larg);
2396 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2397 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2398 && ssl_set_version_bound(ctx->method->version, (int)larg,
2399 &ctx->min_proto_version);
2400 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2401 return ctx->min_proto_version;
2402 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2403 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2404 && ssl_set_version_bound(ctx->method->version, (int)larg,
2405 &ctx->max_proto_version);
2406 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2407 return ctx->max_proto_version;
2409 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2413 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2416 case SSL_CTRL_SET_MSG_CALLBACK:
2417 ctx->msg_callback = (void (*)
2418 (int write_p, int version, int content_type,
2419 const void *buf, size_t len, SSL *ssl,
2424 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2428 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2437 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2438 const SSL_CIPHER *const *bp)
2440 if ((*ap)->id > (*bp)->id)
2442 if ((*ap)->id < (*bp)->id)
2447 /** return a STACK of the ciphers available for the SSL and in order of
2449 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2452 if (s->cipher_list != NULL) {
2453 return s->cipher_list;
2454 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2455 return s->ctx->cipher_list;
2461 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2463 if ((s == NULL) || (s->session == NULL) || !s->server)
2465 return s->session->ciphers;
2468 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2470 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2473 ciphers = SSL_get_ciphers(s);
2476 if (!ssl_set_client_disabled(s))
2478 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2479 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2480 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2482 sk = sk_SSL_CIPHER_new_null();
2485 if (!sk_SSL_CIPHER_push(sk, c)) {
2486 sk_SSL_CIPHER_free(sk);
2494 /** return a STACK of the ciphers available for the SSL and in order of
2496 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2499 if (s->cipher_list_by_id != NULL) {
2500 return s->cipher_list_by_id;
2501 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2502 return s->ctx->cipher_list_by_id;
2508 /** The old interface to get the same thing as SSL_get_ciphers() */
2509 const char *SSL_get_cipher_list(const SSL *s, int n)
2511 const SSL_CIPHER *c;
2512 STACK_OF(SSL_CIPHER) *sk;
2516 sk = SSL_get_ciphers(s);
2517 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2519 c = sk_SSL_CIPHER_value(sk, n);
2525 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2527 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2530 return ctx->cipher_list;
2534 /** specify the ciphers to be used by default by the SSL_CTX */
2535 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2537 STACK_OF(SSL_CIPHER) *sk;
2539 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2540 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2543 * ssl_create_cipher_list may return an empty stack if it was unable to
2544 * find a cipher matching the given rule string (for example if the rule
2545 * string specifies a cipher which has been disabled). This is not an
2546 * error as far as ssl_create_cipher_list is concerned, and hence
2547 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2551 else if (sk_SSL_CIPHER_num(sk) == 0) {
2552 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2558 /** specify the ciphers to be used by the SSL */
2559 int SSL_set_cipher_list(SSL *s, const char *str)
2561 STACK_OF(SSL_CIPHER) *sk;
2563 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2564 &s->cipher_list, &s->cipher_list_by_id, str,
2566 /* see comment in SSL_CTX_set_cipher_list */
2569 else if (sk_SSL_CIPHER_num(sk) == 0) {
2570 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2576 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2579 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2580 const SSL_CIPHER *c;
2584 || s->session == NULL
2585 || s->session->ciphers == NULL
2590 clntsk = s->session->ciphers;
2591 srvrsk = SSL_get_ciphers(s);
2592 if (clntsk == NULL || srvrsk == NULL)
2595 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2598 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2601 c = sk_SSL_CIPHER_value(clntsk, i);
2602 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2605 n = strlen(c->name);
2621 /** return a servername extension value if provided in Client Hello, or NULL.
2622 * So far, only host_name types are defined (RFC 3546).
2625 const char *SSL_get_servername(const SSL *s, const int type)
2627 if (type != TLSEXT_NAMETYPE_host_name)
2631 * SNI is not negotiated in pre-TLS-1.3 resumption flows, so fake up an
2632 * SNI value to return if we are resuming/resumed. N.B. that we still
2633 * call the relevant callbacks for such resumption flows, and callbacks
2634 * might error out if there is not a SNI value available.
2637 return s->session->ext.hostname;
2638 return s->ext.hostname;
2641 int SSL_get_servername_type(const SSL *s)
2644 && (!s->ext.hostname ? s->session->
2645 ext.hostname : s->ext.hostname))
2646 return TLSEXT_NAMETYPE_host_name;
2651 * SSL_select_next_proto implements the standard protocol selection. It is
2652 * expected that this function is called from the callback set by
2653 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2654 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2655 * not included in the length. A byte string of length 0 is invalid. No byte
2656 * string may be truncated. The current, but experimental algorithm for
2657 * selecting the protocol is: 1) If the server doesn't support NPN then this
2658 * is indicated to the callback. In this case, the client application has to
2659 * abort the connection or have a default application level protocol. 2) If
2660 * the server supports NPN, but advertises an empty list then the client
2661 * selects the first protocol in its list, but indicates via the API that this
2662 * fallback case was enacted. 3) Otherwise, the client finds the first
2663 * protocol in the server's list that it supports and selects this protocol.
2664 * This is because it's assumed that the server has better information about
2665 * which protocol a client should use. 4) If the client doesn't support any
2666 * of the server's advertised protocols, then this is treated the same as
2667 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2668 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2670 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2671 const unsigned char *server,
2672 unsigned int server_len,
2673 const unsigned char *client, unsigned int client_len)
2676 const unsigned char *result;
2677 int status = OPENSSL_NPN_UNSUPPORTED;
2680 * For each protocol in server preference order, see if we support it.
2682 for (i = 0; i < server_len;) {
2683 for (j = 0; j < client_len;) {
2684 if (server[i] == client[j] &&
2685 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2686 /* We found a match */
2687 result = &server[i];
2688 status = OPENSSL_NPN_NEGOTIATED;
2698 /* There's no overlap between our protocols and the server's list. */
2700 status = OPENSSL_NPN_NO_OVERLAP;
2703 *out = (unsigned char *)result + 1;
2704 *outlen = result[0];
2708 #ifndef OPENSSL_NO_NEXTPROTONEG
2710 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2711 * client's requested protocol for this connection and returns 0. If the
2712 * client didn't request any protocol, then *data is set to NULL. Note that
2713 * the client can request any protocol it chooses. The value returned from
2714 * this function need not be a member of the list of supported protocols
2715 * provided by the callback.
2717 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2724 *len = (unsigned int)s->ext.npn_len;
2729 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2730 * a TLS server needs a list of supported protocols for Next Protocol
2731 * Negotiation. The returned list must be in wire format. The list is
2732 * returned by setting |out| to point to it and |outlen| to its length. This
2733 * memory will not be modified, but one should assume that the SSL* keeps a
2734 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2735 * wishes to advertise. Otherwise, no such extension will be included in the
2738 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2739 SSL_CTX_npn_advertised_cb_func cb,
2742 ctx->ext.npn_advertised_cb = cb;
2743 ctx->ext.npn_advertised_cb_arg = arg;
2747 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2748 * client needs to select a protocol from the server's provided list. |out|
2749 * must be set to point to the selected protocol (which may be within |in|).
2750 * The length of the protocol name must be written into |outlen|. The
2751 * server's advertised protocols are provided in |in| and |inlen|. The
2752 * callback can assume that |in| is syntactically valid. The client must
2753 * select a protocol. It is fatal to the connection if this callback returns
2754 * a value other than SSL_TLSEXT_ERR_OK.
2756 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2757 SSL_CTX_npn_select_cb_func cb,
2760 ctx->ext.npn_select_cb = cb;
2761 ctx->ext.npn_select_cb_arg = arg;
2766 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2767 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2768 * length-prefixed strings). Returns 0 on success.
2770 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2771 unsigned int protos_len)
2773 OPENSSL_free(ctx->ext.alpn);
2774 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2775 if (ctx->ext.alpn == NULL) {
2776 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2779 ctx->ext.alpn_len = protos_len;
2785 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2786 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2787 * length-prefixed strings). Returns 0 on success.
2789 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2790 unsigned int protos_len)
2792 OPENSSL_free(ssl->ext.alpn);
2793 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2794 if (ssl->ext.alpn == NULL) {
2795 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2798 ssl->ext.alpn_len = protos_len;
2804 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2805 * called during ClientHello processing in order to select an ALPN protocol
2806 * from the client's list of offered protocols.
2808 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2809 SSL_CTX_alpn_select_cb_func cb,
2812 ctx->ext.alpn_select_cb = cb;
2813 ctx->ext.alpn_select_cb_arg = arg;
2817 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2818 * On return it sets |*data| to point to |*len| bytes of protocol name
2819 * (not including the leading length-prefix byte). If the server didn't
2820 * respond with a negotiated protocol then |*len| will be zero.
2822 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2827 *data = ssl->s3->alpn_selected;
2831 *len = (unsigned int)ssl->s3->alpn_selected_len;
2834 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2835 const char *label, size_t llen,
2836 const unsigned char *context, size_t contextlen,
2839 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2842 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2844 contextlen, use_context);
2847 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2848 const char *label, size_t llen,
2849 const unsigned char *context,
2852 if (s->version != TLS1_3_VERSION)
2855 return tls13_export_keying_material_early(s, out, olen, label, llen,
2856 context, contextlen);
2859 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2861 const unsigned char *session_id = a->session_id;
2863 unsigned char tmp_storage[4];
2865 if (a->session_id_length < sizeof(tmp_storage)) {
2866 memset(tmp_storage, 0, sizeof(tmp_storage));
2867 memcpy(tmp_storage, a->session_id, a->session_id_length);
2868 session_id = tmp_storage;
2872 ((unsigned long)session_id[0]) |
2873 ((unsigned long)session_id[1] << 8L) |
2874 ((unsigned long)session_id[2] << 16L) |
2875 ((unsigned long)session_id[3] << 24L);
2880 * NB: If this function (or indeed the hash function which uses a sort of
2881 * coarser function than this one) is changed, ensure
2882 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2883 * being able to construct an SSL_SESSION that will collide with any existing
2884 * session with a matching session ID.
2886 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2888 if (a->ssl_version != b->ssl_version)
2890 if (a->session_id_length != b->session_id_length)
2892 return memcmp(a->session_id, b->session_id, a->session_id_length);
2896 * These wrapper functions should remain rather than redeclaring
2897 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2898 * variable. The reason is that the functions aren't static, they're exposed
2902 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2904 SSL_CTX *ret = NULL;
2907 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2911 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2914 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2915 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2918 ret = OPENSSL_zalloc(sizeof(*ret));
2923 ret->min_proto_version = 0;
2924 ret->max_proto_version = 0;
2925 ret->mode = SSL_MODE_AUTO_RETRY;
2926 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2927 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2928 /* We take the system default. */
2929 ret->session_timeout = meth->get_timeout();
2930 ret->references = 1;
2931 ret->lock = CRYPTO_THREAD_lock_new();
2932 if (ret->lock == NULL) {
2933 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2937 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2938 ret->verify_mode = SSL_VERIFY_NONE;
2939 if ((ret->cert = ssl_cert_new()) == NULL)
2942 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2943 if (ret->sessions == NULL)
2945 ret->cert_store = X509_STORE_new();
2946 if (ret->cert_store == NULL)
2948 #ifndef OPENSSL_NO_CT
2949 ret->ctlog_store = CTLOG_STORE_new();
2950 if (ret->ctlog_store == NULL)
2954 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
2957 if (!ssl_create_cipher_list(ret->method,
2958 ret->tls13_ciphersuites,
2959 &ret->cipher_list, &ret->cipher_list_by_id,
2960 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2961 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2962 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2966 ret->param = X509_VERIFY_PARAM_new();
2967 if (ret->param == NULL)
2970 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2971 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2974 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2975 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2979 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2982 if ((ret->client_ca_names = sk_X509_NAME_new_null()) == NULL)
2985 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2988 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
2991 /* No compression for DTLS */
2992 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2993 ret->comp_methods = SSL_COMP_get_compression_methods();
2995 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2996 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2998 /* Setup RFC5077 ticket keys */
2999 if ((RAND_bytes(ret->ext.tick_key_name,
3000 sizeof(ret->ext.tick_key_name)) <= 0)
3001 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
3002 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
3003 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
3004 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
3005 ret->options |= SSL_OP_NO_TICKET;
3007 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
3008 sizeof(ret->ext.cookie_hmac_key)) <= 0)
3011 #ifndef OPENSSL_NO_SRP
3012 if (!SSL_CTX_SRP_CTX_init(ret))
3015 #ifndef OPENSSL_NO_ENGINE
3016 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3017 # define eng_strx(x) #x
3018 # define eng_str(x) eng_strx(x)
3019 /* Use specific client engine automatically... ignore errors */
3022 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3025 ENGINE_load_builtin_engines();
3026 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3028 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3034 * Default is to connect to non-RI servers. When RI is more widely
3035 * deployed might change this.
3037 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3039 * Disable compression by default to prevent CRIME. Applications can
3040 * re-enable compression by configuring
3041 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3042 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3043 * middlebox compatibility by default. This may be disabled by default in
3044 * a later OpenSSL version.
3046 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3048 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3051 * We cannot usefully set a default max_early_data here (which gets
3052 * propagated in SSL_new(), for the following reason: setting the
3053 * SSL field causes tls_construct_stoc_early_data() to tell the
3054 * client that early data will be accepted when constructing a TLS 1.3
3055 * session ticket, and the client will accordingly send us early data
3056 * when using that ticket (if the client has early data to send).
3057 * However, in order for the early data to actually be consumed by
3058 * the application, the application must also have calls to
3059 * SSL_read_early_data(); otherwise we'll just skip past the early data
3060 * and ignore it. So, since the application must add calls to
3061 * SSL_read_early_data(), we also require them to add
3062 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3063 * eliminating the bandwidth-wasting early data in the case described
3066 ret->max_early_data = 0;
3069 * Default recv_max_early_data is a fully loaded single record. Could be
3070 * split across multiple records in practice. We set this differently to
3071 * max_early_data so that, in the default case, we do not advertise any
3072 * support for early_data, but if a client were to send us some (e.g.
3073 * because of an old, stale ticket) then we will tolerate it and skip over
3076 ret->recv_max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
3078 /* By default we send two session tickets automatically in TLSv1.3 */
3079 ret->num_tickets = 2;
3081 ssl_ctx_system_config(ret);
3085 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3091 int SSL_CTX_up_ref(SSL_CTX *ctx)
3095 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3098 REF_PRINT_COUNT("SSL_CTX", ctx);
3099 REF_ASSERT_ISNT(i < 2);
3100 return ((i > 1) ? 1 : 0);
3103 void SSL_CTX_free(SSL_CTX *a)
3110 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3111 REF_PRINT_COUNT("SSL_CTX", a);
3114 REF_ASSERT_ISNT(i < 0);
3116 X509_VERIFY_PARAM_free(a->param);
3117 dane_ctx_final(&a->dane);
3120 * Free internal session cache. However: the remove_cb() may reference
3121 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3122 * after the sessions were flushed.
3123 * As the ex_data handling routines might also touch the session cache,
3124 * the most secure solution seems to be: empty (flush) the cache, then
3125 * free ex_data, then finally free the cache.
3126 * (See ticket [openssl.org #212].)
3128 if (a->sessions != NULL)
3129 SSL_CTX_flush_sessions(a, 0);
3131 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3132 lh_SSL_SESSION_free(a->sessions);
3133 X509_STORE_free(a->cert_store);
3134 #ifndef OPENSSL_NO_CT
3135 CTLOG_STORE_free(a->ctlog_store);
3137 sk_SSL_CIPHER_free(a->cipher_list);
3138 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3139 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3140 ssl_cert_free(a->cert);
3141 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3142 sk_X509_NAME_pop_free(a->client_ca_names, X509_NAME_free);
3143 sk_X509_pop_free(a->extra_certs, X509_free);
3144 a->comp_methods = NULL;
3145 #ifndef OPENSSL_NO_SRTP
3146 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3148 #ifndef OPENSSL_NO_SRP
3149 SSL_CTX_SRP_CTX_free(a);
3151 #ifndef OPENSSL_NO_ENGINE
3152 ENGINE_finish(a->client_cert_engine);
3155 #ifndef OPENSSL_NO_EC
3156 OPENSSL_free(a->ext.ecpointformats);
3157 OPENSSL_free(a->ext.supportedgroups);
3159 OPENSSL_free(a->ext.alpn);
3160 OPENSSL_secure_free(a->ext.secure);
3162 CRYPTO_THREAD_lock_free(a->lock);
3167 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3169 ctx->default_passwd_callback = cb;
3172 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3174 ctx->default_passwd_callback_userdata = u;
3177 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3179 return ctx->default_passwd_callback;
3182 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3184 return ctx->default_passwd_callback_userdata;
3187 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3189 s->default_passwd_callback = cb;
3192 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3194 s->default_passwd_callback_userdata = u;
3197 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3199 return s->default_passwd_callback;
3202 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3204 return s->default_passwd_callback_userdata;
3207 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3208 int (*cb) (X509_STORE_CTX *, void *),
3211 ctx->app_verify_callback = cb;
3212 ctx->app_verify_arg = arg;
3215 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3216 int (*cb) (int, X509_STORE_CTX *))
3218 ctx->verify_mode = mode;
3219 ctx->default_verify_callback = cb;
3222 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3224 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3227 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3229 ssl_cert_set_cert_cb(c->cert, cb, arg);
3232 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3234 ssl_cert_set_cert_cb(s->cert, cb, arg);
3237 void ssl_set_masks(SSL *s)
3240 uint32_t *pvalid = s->s3->tmp.valid_flags;
3241 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3242 unsigned long mask_k, mask_a;
3243 #ifndef OPENSSL_NO_EC
3244 int have_ecc_cert, ecdsa_ok;
3249 #ifndef OPENSSL_NO_DH
3250 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3255 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3256 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3257 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3258 #ifndef OPENSSL_NO_EC
3259 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3265 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3266 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3269 #ifndef OPENSSL_NO_GOST
3270 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3271 mask_k |= SSL_kGOST;
3272 mask_a |= SSL_aGOST12;
3274 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3275 mask_k |= SSL_kGOST;
3276 mask_a |= SSL_aGOST12;
3278 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3279 mask_k |= SSL_kGOST;
3280 mask_a |= SSL_aGOST01;
3291 * If we only have an RSA-PSS certificate allow RSA authentication
3292 * if TLS 1.2 and peer supports it.
3295 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3296 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3297 && TLS1_get_version(s) == TLS1_2_VERSION))
3304 mask_a |= SSL_aNULL;
3307 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3308 * depending on the key usage extension.
3310 #ifndef OPENSSL_NO_EC
3311 if (have_ecc_cert) {
3313 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3314 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3315 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3318 mask_a |= SSL_aECDSA;
3320 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3321 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3322 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3323 && TLS1_get_version(s) == TLS1_2_VERSION)
3324 mask_a |= SSL_aECDSA;
3326 /* Allow Ed448 for TLS 1.2 if peer supports it */
3327 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3328 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3329 && TLS1_get_version(s) == TLS1_2_VERSION)
3330 mask_a |= SSL_aECDSA;
3333 #ifndef OPENSSL_NO_EC
3334 mask_k |= SSL_kECDHE;
3337 #ifndef OPENSSL_NO_PSK
3340 if (mask_k & SSL_kRSA)
3341 mask_k |= SSL_kRSAPSK;
3342 if (mask_k & SSL_kDHE)
3343 mask_k |= SSL_kDHEPSK;
3344 if (mask_k & SSL_kECDHE)
3345 mask_k |= SSL_kECDHEPSK;
3348 s->s3->tmp.mask_k = mask_k;
3349 s->s3->tmp.mask_a = mask_a;
3352 #ifndef OPENSSL_NO_EC
3354 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3356 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3357 /* key usage, if present, must allow signing */
3358 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3359 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3360 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3364 return 1; /* all checks are ok */
3369 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3370 size_t *serverinfo_length)
3372 CERT_PKEY *cpk = s->s3->tmp.cert;
3373 *serverinfo_length = 0;
3375 if (cpk == NULL || cpk->serverinfo == NULL)
3378 *serverinfo = cpk->serverinfo;
3379 *serverinfo_length = cpk->serverinfo_length;
3383 void ssl_update_cache(SSL *s, int mode)
3388 * If the session_id_length is 0, we are not supposed to cache it, and it
3389 * would be rather hard to do anyway :-)
3391 if (s->session->session_id_length == 0)
3395 * If sid_ctx_length is 0 there is no specific application context
3396 * associated with this session, so when we try to resume it and
3397 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3398 * indication that this is actually a session for the proper application
3399 * context, and the *handshake* will fail, not just the resumption attempt.
3400 * Do not cache (on the server) these sessions that are not resumable
3401 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3403 if (s->server && s->session->sid_ctx_length == 0
3404 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3407 i = s->session_ctx->session_cache_mode;
3409 && (!s->hit || SSL_IS_TLS13(s))) {
3411 * Add the session to the internal cache. In server side TLSv1.3 we
3412 * normally don't do this because by default it's a full stateless ticket
3413 * with only a dummy session id so there is no reason to cache it,
3415 * - we are doing early_data, in which case we cache so that we can
3417 * - the application has set a remove_session_cb so needs to know about
3418 * session timeout events
3419 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3421 if ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0
3422 && (!SSL_IS_TLS13(s)
3424 || (s->max_early_data > 0
3425 && (s->options & SSL_OP_NO_ANTI_REPLAY) == 0)
3426 || s->session_ctx->remove_session_cb != NULL
3427 || (s->options & SSL_OP_NO_TICKET) != 0))
3428 SSL_CTX_add_session(s->session_ctx, s->session);
3431 * Add the session to the external cache. We do this even in server side
3432 * TLSv1.3 without early data because some applications just want to
3433 * know about the creation of a session and aren't doing a full cache.
3435 if (s->session_ctx->new_session_cb != NULL) {
3436 SSL_SESSION_up_ref(s->session);
3437 if (!s->session_ctx->new_session_cb(s, s->session))
3438 SSL_SESSION_free(s->session);
3442 /* auto flush every 255 connections */
3443 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3444 TSAN_QUALIFIER int *stat;
3445 if (mode & SSL_SESS_CACHE_CLIENT)
3446 stat = &s->session_ctx->stats.sess_connect_good;
3448 stat = &s->session_ctx->stats.sess_accept_good;
3449 if ((tsan_load(stat) & 0xff) == 0xff)
3450 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3454 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3459 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3464 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3468 if (s->method != meth) {
3469 const SSL_METHOD *sm = s->method;
3470 int (*hf) (SSL *) = s->handshake_func;
3472 if (sm->version == meth->version)
3477 ret = s->method->ssl_new(s);
3480 if (hf == sm->ssl_connect)
3481 s->handshake_func = meth->ssl_connect;
3482 else if (hf == sm->ssl_accept)
3483 s->handshake_func = meth->ssl_accept;
3488 int SSL_get_error(const SSL *s, int i)
3495 return SSL_ERROR_NONE;
3498 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3499 * where we do encode the error
3501 if ((l = ERR_peek_error()) != 0) {
3502 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3503 return SSL_ERROR_SYSCALL;
3505 return SSL_ERROR_SSL;
3508 if (SSL_want_read(s)) {
3509 bio = SSL_get_rbio(s);
3510 if (BIO_should_read(bio))
3511 return SSL_ERROR_WANT_READ;
3512 else if (BIO_should_write(bio))
3514 * This one doesn't make too much sense ... We never try to write
3515 * to the rbio, and an application program where rbio and wbio
3516 * are separate couldn't even know what it should wait for.
3517 * However if we ever set s->rwstate incorrectly (so that we have
3518 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3519 * wbio *are* the same, this test works around that bug; so it
3520 * might be safer to keep it.
3522 return SSL_ERROR_WANT_WRITE;
3523 else if (BIO_should_io_special(bio)) {
3524 reason = BIO_get_retry_reason(bio);
3525 if (reason == BIO_RR_CONNECT)
3526 return SSL_ERROR_WANT_CONNECT;
3527 else if (reason == BIO_RR_ACCEPT)
3528 return SSL_ERROR_WANT_ACCEPT;
3530 return SSL_ERROR_SYSCALL; /* unknown */
3534 if (SSL_want_write(s)) {
3535 /* Access wbio directly - in order to use the buffered bio if present */
3537 if (BIO_should_write(bio))
3538 return SSL_ERROR_WANT_WRITE;
3539 else if (BIO_should_read(bio))
3541 * See above (SSL_want_read(s) with BIO_should_write(bio))
3543 return SSL_ERROR_WANT_READ;
3544 else if (BIO_should_io_special(bio)) {
3545 reason = BIO_get_retry_reason(bio);
3546 if (reason == BIO_RR_CONNECT)
3547 return SSL_ERROR_WANT_CONNECT;
3548 else if (reason == BIO_RR_ACCEPT)
3549 return SSL_ERROR_WANT_ACCEPT;
3551 return SSL_ERROR_SYSCALL;
3554 if (SSL_want_x509_lookup(s))
3555 return SSL_ERROR_WANT_X509_LOOKUP;
3556 if (SSL_want_async(s))
3557 return SSL_ERROR_WANT_ASYNC;
3558 if (SSL_want_async_job(s))
3559 return SSL_ERROR_WANT_ASYNC_JOB;
3560 if (SSL_want_client_hello_cb(s))
3561 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3563 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3564 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3565 return SSL_ERROR_ZERO_RETURN;
3567 return SSL_ERROR_SYSCALL;
3570 static int ssl_do_handshake_intern(void *vargs)
3572 struct ssl_async_args *args;
3575 args = (struct ssl_async_args *)vargs;
3578 return s->handshake_func(s);
3581 int SSL_do_handshake(SSL *s)
3585 if (s->handshake_func == NULL) {
3586 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3590 ossl_statem_check_finish_init(s, -1);
3592 s->method->ssl_renegotiate_check(s, 0);
3594 if (SSL_in_init(s) || SSL_in_before(s)) {
3595 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3596 struct ssl_async_args args;
3600 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3602 ret = s->handshake_func(s);
3608 void SSL_set_accept_state(SSL *s)
3612 ossl_statem_clear(s);
3613 s->handshake_func = s->method->ssl_accept;
3617 void SSL_set_connect_state(SSL *s)
3621 ossl_statem_clear(s);
3622 s->handshake_func = s->method->ssl_connect;
3626 int ssl_undefined_function(SSL *s)
3628 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3632 int ssl_undefined_void_function(void)
3634 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3635 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3639 int ssl_undefined_const_function(const SSL *s)
3644 const SSL_METHOD *ssl_bad_method(int ver)
3646 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3650 const char *ssl_protocol_to_string(int version)
3654 case TLS1_3_VERSION:
3657 case TLS1_2_VERSION:
3660 case TLS1_1_VERSION:
3675 case DTLS1_2_VERSION:
3683 const char *SSL_get_version(const SSL *s)
3685 return ssl_protocol_to_string(s->version);
3688 static int dup_ca_names(STACK_OF(X509_NAME) **dst, STACK_OF(X509_NAME) *src)
3690 STACK_OF(X509_NAME) *sk;
3699 if ((sk = sk_X509_NAME_new_null()) == NULL)
3701 for (i = 0; i < sk_X509_NAME_num(src); i++) {
3702 xn = X509_NAME_dup(sk_X509_NAME_value(src, i));
3704 sk_X509_NAME_pop_free(sk, X509_NAME_free);
3707 if (sk_X509_NAME_insert(sk, xn, i) == 0) {
3709 sk_X509_NAME_pop_free(sk, X509_NAME_free);
3718 SSL *SSL_dup(SSL *s)
3723 /* If we're not quiescent, just up_ref! */
3724 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3725 CRYPTO_UP_REF(&s->references, &i, s->lock);
3730 * Otherwise, copy configuration state, and session if set.
3732 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3735 if (s->session != NULL) {
3737 * Arranges to share the same session via up_ref. This "copies"
3738 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3740 if (!SSL_copy_session_id(ret, s))
3744 * No session has been established yet, so we have to expect that
3745 * s->cert or ret->cert will be changed later -- they should not both
3746 * point to the same object, and thus we can't use
3747 * SSL_copy_session_id.
3749 if (!SSL_set_ssl_method(ret, s->method))
3752 if (s->cert != NULL) {
3753 ssl_cert_free(ret->cert);
3754 ret->cert = ssl_cert_dup(s->cert);
3755 if (ret->cert == NULL)
3759 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3760 (int)s->sid_ctx_length))
3764 if (!ssl_dane_dup(ret, s))
3766 ret->version = s->version;
3767 ret->options = s->options;
3768 ret->mode = s->mode;
3769 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3770 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3771 ret->msg_callback = s->msg_callback;
3772 ret->msg_callback_arg = s->msg_callback_arg;
3773 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3774 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3775 ret->generate_session_id = s->generate_session_id;
3777 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3779 /* copy app data, a little dangerous perhaps */
3780 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3783 /* setup rbio, and wbio */
3784 if (s->rbio != NULL) {
3785 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3788 if (s->wbio != NULL) {
3789 if (s->wbio != s->rbio) {
3790 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3793 BIO_up_ref(ret->rbio);
3794 ret->wbio = ret->rbio;
3798 ret->server = s->server;
3799 if (s->handshake_func) {
3801 SSL_set_accept_state(ret);
3803 SSL_set_connect_state(ret);
3805 ret->shutdown = s->shutdown;
3808 ret->default_passwd_callback = s->default_passwd_callback;
3809 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3811 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3813 /* dup the cipher_list and cipher_list_by_id stacks */
3814 if (s->cipher_list != NULL) {
3815 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3818 if (s->cipher_list_by_id != NULL)
3819 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3823 /* Dup the client_CA list */
3824 if (!dup_ca_names(&ret->ca_names, s->ca_names)
3825 || !dup_ca_names(&ret->client_ca_names, s->client_ca_names))
3835 void ssl_clear_cipher_ctx(SSL *s)
3837 if (s->enc_read_ctx != NULL) {
3838 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3839 s->enc_read_ctx = NULL;
3841 if (s->enc_write_ctx != NULL) {
3842 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3843 s->enc_write_ctx = NULL;
3845 #ifndef OPENSSL_NO_COMP
3846 COMP_CTX_free(s->expand);
3848 COMP_CTX_free(s->compress);
3853 X509 *SSL_get_certificate(const SSL *s)
3855 if (s->cert != NULL)
3856 return s->cert->key->x509;
3861 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3863 if (s->cert != NULL)
3864 return s->cert->key->privatekey;
3869 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3871 if (ctx->cert != NULL)
3872 return ctx->cert->key->x509;
3877 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3879 if (ctx->cert != NULL)
3880 return ctx->cert->key->privatekey;
3885 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3887 if ((s->session != NULL) && (s->session->cipher != NULL))
3888 return s->session->cipher;
3892 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3894 return s->s3->tmp.new_cipher;
3897 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3899 #ifndef OPENSSL_NO_COMP
3900 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3906 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3908 #ifndef OPENSSL_NO_COMP
3909 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3915 int ssl_init_wbio_buffer(SSL *s)
3919 if (s->bbio != NULL) {
3920 /* Already buffered. */
3924 bbio = BIO_new(BIO_f_buffer());
3925 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3927 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3931 s->wbio = BIO_push(bbio, s->wbio);
3936 int ssl_free_wbio_buffer(SSL *s)
3938 /* callers ensure s is never null */
3939 if (s->bbio == NULL)
3942 s->wbio = BIO_pop(s->wbio);
3949 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3951 ctx->quiet_shutdown = mode;
3954 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3956 return ctx->quiet_shutdown;
3959 void SSL_set_quiet_shutdown(SSL *s, int mode)
3961 s->quiet_shutdown = mode;
3964 int SSL_get_quiet_shutdown(const SSL *s)
3966 return s->quiet_shutdown;
3969 void SSL_set_shutdown(SSL *s, int mode)
3974 int SSL_get_shutdown(const SSL *s)
3979 int SSL_version(const SSL *s)
3984 int SSL_client_version(const SSL *s)
3986 return s->client_version;
3989 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3994 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3997 if (ssl->ctx == ctx)
4000 ctx = ssl->session_ctx;
4001 new_cert = ssl_cert_dup(ctx->cert);
4002 if (new_cert == NULL) {
4006 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
4007 ssl_cert_free(new_cert);
4011 ssl_cert_free(ssl->cert);
4012 ssl->cert = new_cert;
4015 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
4016 * so setter APIs must prevent invalid lengths from entering the system.
4018 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
4022 * If the session ID context matches that of the parent SSL_CTX,
4023 * inherit it from the new SSL_CTX as well. If however the context does
4024 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4025 * leave it unchanged.
4027 if ((ssl->ctx != NULL) &&
4028 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
4029 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
4030 ssl->sid_ctx_length = ctx->sid_ctx_length;
4031 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
4034 SSL_CTX_up_ref(ctx);
4035 SSL_CTX_free(ssl->ctx); /* decrement reference count */
4041 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
4043 return X509_STORE_set_default_paths(ctx->cert_store);
4046 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
4048 X509_LOOKUP *lookup;
4050 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
4053 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
4055 /* Clear any errors if the default directory does not exist */
4061 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4063 X509_LOOKUP *lookup;
4065 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4069 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4071 /* Clear any errors if the default file does not exist */
4077 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4080 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4083 void SSL_set_info_callback(SSL *ssl,
4084 void (*cb) (const SSL *ssl, int type, int val))
4086 ssl->info_callback = cb;
4090 * One compiler (Diab DCC) doesn't like argument names in returned function
4093 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4096 return ssl->info_callback;
4099 void SSL_set_verify_result(SSL *ssl, long arg)
4101 ssl->verify_result = arg;
4104 long SSL_get_verify_result(const SSL *ssl)
4106 return ssl->verify_result;
4109 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4112 return sizeof(ssl->s3->client_random);
4113 if (outlen > sizeof(ssl->s3->client_random))
4114 outlen = sizeof(ssl->s3->client_random);
4115 memcpy(out, ssl->s3->client_random, outlen);
4119 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4122 return sizeof(ssl->s3->server_random);
4123 if (outlen > sizeof(ssl->s3->server_random))
4124 outlen = sizeof(ssl->s3->server_random);
4125 memcpy(out, ssl->s3->server_random, outlen);
4129 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4130 unsigned char *out, size_t outlen)
4133 return session->master_key_length;
4134 if (outlen > session->master_key_length)
4135 outlen = session->master_key_length;
4136 memcpy(out, session->master_key, outlen);
4140 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4143 if (len > sizeof(sess->master_key))
4146 memcpy(sess->master_key, in, len);
4147 sess->master_key_length = len;
4152 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4154 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4157 void *SSL_get_ex_data(const SSL *s, int idx)
4159 return CRYPTO_get_ex_data(&s->ex_data, idx);
4162 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4164 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4167 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4169 return CRYPTO_get_ex_data(&s->ex_data, idx);
4172 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4174 return ctx->cert_store;
4177 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4179 X509_STORE_free(ctx->cert_store);
4180 ctx->cert_store = store;
4183 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4186 X509_STORE_up_ref(store);
4187 SSL_CTX_set_cert_store(ctx, store);
4190 int SSL_want(const SSL *s)
4196 * \brief Set the callback for generating temporary DH keys.
4197 * \param ctx the SSL context.
4198 * \param dh the callback
4201 #ifndef OPENSSL_NO_DH
4202 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4203 DH *(*dh) (SSL *ssl, int is_export,
4206 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4209 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4212 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4216 #ifndef OPENSSL_NO_PSK
4217 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4219 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4220 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4223 OPENSSL_free(ctx->cert->psk_identity_hint);
4224 if (identity_hint != NULL) {
4225 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4226 if (ctx->cert->psk_identity_hint == NULL)
4229 ctx->cert->psk_identity_hint = NULL;
4233 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4238 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4239 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4242 OPENSSL_free(s->cert->psk_identity_hint);
4243 if (identity_hint != NULL) {
4244 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4245 if (s->cert->psk_identity_hint == NULL)
4248 s->cert->psk_identity_hint = NULL;
4252 const char *SSL_get_psk_identity_hint(const SSL *s)
4254 if (s == NULL || s->session == NULL)
4256 return s->session->psk_identity_hint;
4259 const char *SSL_get_psk_identity(const SSL *s)
4261 if (s == NULL || s->session == NULL)
4263 return s->session->psk_identity;
4266 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4268 s->psk_client_callback = cb;
4271 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4273 ctx->psk_client_callback = cb;
4276 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4278 s->psk_server_callback = cb;
4281 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4283 ctx->psk_server_callback = cb;
4287 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4289 s->psk_find_session_cb = cb;
4292 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4293 SSL_psk_find_session_cb_func cb)
4295 ctx->psk_find_session_cb = cb;
4298 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4300 s->psk_use_session_cb = cb;
4303 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4304 SSL_psk_use_session_cb_func cb)
4306 ctx->psk_use_session_cb = cb;
4309 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4310 void (*cb) (int write_p, int version,
4311 int content_type, const void *buf,
4312 size_t len, SSL *ssl, void *arg))
4314 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4317 void SSL_set_msg_callback(SSL *ssl,
4318 void (*cb) (int write_p, int version,
4319 int content_type, const void *buf,
4320 size_t len, SSL *ssl, void *arg))
4322 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4325 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4326 int (*cb) (SSL *ssl,
4330 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4331 (void (*)(void))cb);
4334 void SSL_set_not_resumable_session_callback(SSL *ssl,
4335 int (*cb) (SSL *ssl,
4336 int is_forward_secure))
4338 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4339 (void (*)(void))cb);
4342 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4343 size_t (*cb) (SSL *ssl, int type,
4344 size_t len, void *arg))
4346 ctx->record_padding_cb = cb;
4349 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4351 ctx->record_padding_arg = arg;
4354 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4356 return ctx->record_padding_arg;
4359 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4361 /* block size of 0 or 1 is basically no padding */
4362 if (block_size == 1)
4363 ctx->block_padding = 0;
4364 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4365 ctx->block_padding = block_size;
4371 void SSL_set_record_padding_callback(SSL *ssl,
4372 size_t (*cb) (SSL *ssl, int type,
4373 size_t len, void *arg))
4375 ssl->record_padding_cb = cb;
4378 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4380 ssl->record_padding_arg = arg;
4383 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4385 return ssl->record_padding_arg;
4388 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4390 /* block size of 0 or 1 is basically no padding */
4391 if (block_size == 1)
4392 ssl->block_padding = 0;
4393 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4394 ssl->block_padding = block_size;
4400 int SSL_set_num_tickets(SSL *s, size_t num_tickets)
4402 s->num_tickets = num_tickets;
4407 size_t SSL_get_num_tickets(SSL *s)
4409 return s->num_tickets;
4412 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets)
4414 ctx->num_tickets = num_tickets;
4419 size_t SSL_CTX_get_num_tickets(SSL_CTX *ctx)
4421 return ctx->num_tickets;
4425 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4426 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4427 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4428 * Returns the newly allocated ctx;
4431 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4433 ssl_clear_hash_ctx(hash);
4434 *hash = EVP_MD_CTX_new();
4435 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4436 EVP_MD_CTX_free(*hash);
4443 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4446 EVP_MD_CTX_free(*hash);
4450 /* Retrieve handshake hashes */
4451 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4454 EVP_MD_CTX *ctx = NULL;
4455 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4456 int hashleni = EVP_MD_CTX_size(hdgst);
4459 if (hashleni < 0 || (size_t)hashleni > outlen) {
4460 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4461 ERR_R_INTERNAL_ERROR);
4465 ctx = EVP_MD_CTX_new();
4469 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4470 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4471 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4472 ERR_R_INTERNAL_ERROR);
4476 *hashlen = hashleni;
4480 EVP_MD_CTX_free(ctx);
4484 int SSL_session_reused(SSL *s)
4489 int SSL_is_server(const SSL *s)
4494 #if !OPENSSL_API_1_1_0
4495 void SSL_set_debug(SSL *s, int debug)
4497 /* Old function was do-nothing anyway... */
4503 void SSL_set_security_level(SSL *s, int level)
4505 s->cert->sec_level = level;
4508 int SSL_get_security_level(const SSL *s)
4510 return s->cert->sec_level;
4513 void SSL_set_security_callback(SSL *s,
4514 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4515 int op, int bits, int nid,
4516 void *other, void *ex))
4518 s->cert->sec_cb = cb;
4521 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4522 const SSL_CTX *ctx, int op,
4523 int bits, int nid, void *other,
4525 return s->cert->sec_cb;
4528 void SSL_set0_security_ex_data(SSL *s, void *ex)
4530 s->cert->sec_ex = ex;
4533 void *SSL_get0_security_ex_data(const SSL *s)
4535 return s->cert->sec_ex;
4538 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4540 ctx->cert->sec_level = level;
4543 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4545 return ctx->cert->sec_level;
4548 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4549 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4550 int op, int bits, int nid,
4551 void *other, void *ex))
4553 ctx->cert->sec_cb = cb;
4556 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4562 return ctx->cert->sec_cb;
4565 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4567 ctx->cert->sec_ex = ex;
4570 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4572 return ctx->cert->sec_ex;
4576 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4577 * can return unsigned long, instead of the generic long return value from the
4578 * control interface.
4580 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4582 return ctx->options;
4585 unsigned long SSL_get_options(const SSL *s)
4590 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4592 return ctx->options |= op;
4595 unsigned long SSL_set_options(SSL *s, unsigned long op)
4597 return s->options |= op;
4600 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4602 return ctx->options &= ~op;
4605 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4607 return s->options &= ~op;
4610 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4612 return s->verified_chain;
4615 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4617 #ifndef OPENSSL_NO_CT
4620 * Moves SCTs from the |src| stack to the |dst| stack.
4621 * The source of each SCT will be set to |origin|.
4622 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4624 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4626 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4627 sct_source_t origin)
4633 *dst = sk_SCT_new_null();
4635 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4640 while ((sct = sk_SCT_pop(src)) != NULL) {
4641 if (SCT_set_source(sct, origin) != 1)
4644 if (sk_SCT_push(*dst, sct) <= 0)
4652 sk_SCT_push(src, sct); /* Put the SCT back */
4657 * Look for data collected during ServerHello and parse if found.
4658 * Returns the number of SCTs extracted.
4660 static int ct_extract_tls_extension_scts(SSL *s)
4662 int scts_extracted = 0;
4664 if (s->ext.scts != NULL) {
4665 const unsigned char *p = s->ext.scts;
4666 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4668 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4670 SCT_LIST_free(scts);
4673 return scts_extracted;
4677 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4678 * contains an SCT X509 extension. They will be stored in |s->scts|.
4680 * - The number of SCTs extracted, assuming an OCSP response exists.
4681 * - 0 if no OCSP response exists or it contains no SCTs.
4682 * - A negative integer if an error occurs.
4684 static int ct_extract_ocsp_response_scts(SSL *s)
4686 # ifndef OPENSSL_NO_OCSP
4687 int scts_extracted = 0;
4688 const unsigned char *p;
4689 OCSP_BASICRESP *br = NULL;
4690 OCSP_RESPONSE *rsp = NULL;
4691 STACK_OF(SCT) *scts = NULL;
4694 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4697 p = s->ext.ocsp.resp;
4698 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4702 br = OCSP_response_get1_basic(rsp);
4706 for (i = 0; i < OCSP_resp_count(br); ++i) {
4707 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4713 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4715 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4716 if (scts_extracted < 0)
4720 SCT_LIST_free(scts);
4721 OCSP_BASICRESP_free(br);
4722 OCSP_RESPONSE_free(rsp);
4723 return scts_extracted;
4725 /* Behave as if no OCSP response exists */
4731 * Attempts to extract SCTs from the peer certificate.
4732 * Return the number of SCTs extracted, or a negative integer if an error
4735 static int ct_extract_x509v3_extension_scts(SSL *s)
4737 int scts_extracted = 0;
4738 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4741 STACK_OF(SCT) *scts =
4742 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4745 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4747 SCT_LIST_free(scts);
4750 return scts_extracted;
4754 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4755 * response (if it exists) and X509v3 extensions in the certificate.
4756 * Returns NULL if an error occurs.
4758 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4760 if (!s->scts_parsed) {
4761 if (ct_extract_tls_extension_scts(s) < 0 ||
4762 ct_extract_ocsp_response_scts(s) < 0 ||
4763 ct_extract_x509v3_extension_scts(s) < 0)
4773 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4774 const STACK_OF(SCT) *scts, void *unused_arg)
4779 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4780 const STACK_OF(SCT) *scts, void *unused_arg)
4782 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4785 for (i = 0; i < count; ++i) {
4786 SCT *sct = sk_SCT_value(scts, i);
4787 int status = SCT_get_validation_status(sct);
4789 if (status == SCT_VALIDATION_STATUS_VALID)
4792 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4796 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4800 * Since code exists that uses the custom extension handler for CT, look
4801 * for this and throw an error if they have already registered to use CT.
4803 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4804 TLSEXT_TYPE_signed_certificate_timestamp))
4806 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4807 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4811 if (callback != NULL) {
4813 * If we are validating CT, then we MUST accept SCTs served via OCSP
4815 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4819 s->ct_validation_callback = callback;
4820 s->ct_validation_callback_arg = arg;
4825 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4826 ssl_ct_validation_cb callback, void *arg)
4829 * Since code exists that uses the custom extension handler for CT, look for
4830 * this and throw an error if they have already registered to use CT.
4832 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4833 TLSEXT_TYPE_signed_certificate_timestamp))
4835 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4836 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4840 ctx->ct_validation_callback = callback;
4841 ctx->ct_validation_callback_arg = arg;
4845 int SSL_ct_is_enabled(const SSL *s)
4847 return s->ct_validation_callback != NULL;
4850 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4852 return ctx->ct_validation_callback != NULL;
4855 int ssl_validate_ct(SSL *s)
4858 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4860 SSL_DANE *dane = &s->dane;
4861 CT_POLICY_EVAL_CTX *ctx = NULL;
4862 const STACK_OF(SCT) *scts;
4865 * If no callback is set, the peer is anonymous, or its chain is invalid,
4866 * skip SCT validation - just return success. Applications that continue
4867 * handshakes without certificates, with unverified chains, or pinned leaf
4868 * certificates are outside the scope of the WebPKI and CT.
4870 * The above exclusions notwithstanding the vast majority of peers will
4871 * have rather ordinary certificate chains validated by typical
4872 * applications that perform certificate verification and therefore will
4873 * process SCTs when enabled.
4875 if (s->ct_validation_callback == NULL || cert == NULL ||
4876 s->verify_result != X509_V_OK ||
4877 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4881 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4882 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4884 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4885 switch (dane->mtlsa->usage) {
4886 case DANETLS_USAGE_DANE_TA:
4887 case DANETLS_USAGE_DANE_EE:
4892 ctx = CT_POLICY_EVAL_CTX_new();
4894 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4895 ERR_R_MALLOC_FAILURE);
4899 issuer = sk_X509_value(s->verified_chain, 1);
4900 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4901 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4902 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4903 CT_POLICY_EVAL_CTX_set_time(
4904 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4906 scts = SSL_get0_peer_scts(s);
4909 * This function returns success (> 0) only when all the SCTs are valid, 0
4910 * when some are invalid, and < 0 on various internal errors (out of
4911 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4912 * reason to abort the handshake, that decision is up to the callback.
4913 * Therefore, we error out only in the unexpected case that the return
4914 * value is negative.
4916 * XXX: One might well argue that the return value of this function is an
4917 * unfortunate design choice. Its job is only to determine the validation
4918 * status of each of the provided SCTs. So long as it correctly separates
4919 * the wheat from the chaff it should return success. Failure in this case
4920 * ought to correspond to an inability to carry out its duties.
4922 if (SCT_LIST_validate(scts, ctx) < 0) {
4923 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4924 SSL_R_SCT_VERIFICATION_FAILED);
4928 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4930 ret = 0; /* This function returns 0 on failure */
4932 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4933 SSL_R_CALLBACK_FAILED);
4936 CT_POLICY_EVAL_CTX_free(ctx);
4938 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4939 * failure return code here. Also the application may wish the complete
4940 * the handshake, and then disconnect cleanly at a higher layer, after
4941 * checking the verification status of the completed connection.
4943 * We therefore force a certificate verification failure which will be
4944 * visible via SSL_get_verify_result() and cached as part of any resumed
4947 * Note: the permissive callback is for information gathering only, always
4948 * returns success, and does not affect verification status. Only the
4949 * strict callback or a custom application-specified callback can trigger
4950 * connection failure or record a verification error.
4953 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4957 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4959 switch (validation_mode) {
4961 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4963 case SSL_CT_VALIDATION_PERMISSIVE:
4964 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4965 case SSL_CT_VALIDATION_STRICT:
4966 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4970 int SSL_enable_ct(SSL *s, int validation_mode)
4972 switch (validation_mode) {
4974 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4976 case SSL_CT_VALIDATION_PERMISSIVE:
4977 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4978 case SSL_CT_VALIDATION_STRICT:
4979 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4983 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4985 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4988 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4990 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4993 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4995 CTLOG_STORE_free(ctx->ctlog_store);
4996 ctx->ctlog_store = logs;
4999 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
5001 return ctx->ctlog_store;
5004 #endif /* OPENSSL_NO_CT */
5006 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
5009 c->client_hello_cb = cb;
5010 c->client_hello_cb_arg = arg;
5013 int SSL_client_hello_isv2(SSL *s)
5015 if (s->clienthello == NULL)
5017 return s->clienthello->isv2;
5020 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
5022 if (s->clienthello == NULL)
5024 return s->clienthello->legacy_version;
5027 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
5029 if (s->clienthello == NULL)
5032 *out = s->clienthello->random;
5033 return SSL3_RANDOM_SIZE;
5036 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
5038 if (s->clienthello == NULL)
5041 *out = s->clienthello->session_id;
5042 return s->clienthello->session_id_len;
5045 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
5047 if (s->clienthello == NULL)
5050 *out = PACKET_data(&s->clienthello->ciphersuites);
5051 return PACKET_remaining(&s->clienthello->ciphersuites);
5054 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
5056 if (s->clienthello == NULL)
5059 *out = s->clienthello->compressions;
5060 return s->clienthello->compressions_len;
5063 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5069 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5071 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5072 ext = s->clienthello->pre_proc_exts + i;
5076 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
5077 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
5078 ERR_R_MALLOC_FAILURE);
5081 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5082 ext = s->clienthello->pre_proc_exts + i;
5084 if (ext->received_order >= num)
5086 present[ext->received_order] = ext->type;
5093 OPENSSL_free(present);
5097 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5103 if (s->clienthello == NULL)
5105 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5106 r = s->clienthello->pre_proc_exts + i;
5107 if (r->present && r->type == type) {
5109 *out = PACKET_data(&r->data);
5111 *outlen = PACKET_remaining(&r->data);
5118 int SSL_free_buffers(SSL *ssl)
5120 RECORD_LAYER *rl = &ssl->rlayer;
5122 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5125 RECORD_LAYER_release(rl);
5129 int SSL_alloc_buffers(SSL *ssl)
5131 return ssl3_setup_buffers(ssl);
5134 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5136 ctx->keylog_callback = cb;
5139 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5141 return ctx->keylog_callback;
5144 static int nss_keylog_int(const char *prefix,
5146 const uint8_t *parameter_1,
5147 size_t parameter_1_len,
5148 const uint8_t *parameter_2,
5149 size_t parameter_2_len)
5152 char *cursor = NULL;
5157 if (ssl->ctx->keylog_callback == NULL)
5161 * Our output buffer will contain the following strings, rendered with
5162 * space characters in between, terminated by a NULL character: first the
5163 * prefix, then the first parameter, then the second parameter. The
5164 * meaning of each parameter depends on the specific key material being
5165 * logged. Note that the first and second parameters are encoded in
5166 * hexadecimal, so we need a buffer that is twice their lengths.
5168 prefix_len = strlen(prefix);
5169 out_len = prefix_len + (2 * parameter_1_len) + (2 * parameter_2_len) + 3;
5170 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5171 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5172 ERR_R_MALLOC_FAILURE);
5176 strcpy(cursor, prefix);
5177 cursor += prefix_len;
5180 for (i = 0; i < parameter_1_len; i++) {
5181 sprintf(cursor, "%02x", parameter_1[i]);
5186 for (i = 0; i < parameter_2_len; i++) {
5187 sprintf(cursor, "%02x", parameter_2[i]);
5192 ssl->ctx->keylog_callback(ssl, (const char *)out);
5193 OPENSSL_clear_free(out, out_len);
5198 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5199 const uint8_t *encrypted_premaster,
5200 size_t encrypted_premaster_len,
5201 const uint8_t *premaster,
5202 size_t premaster_len)
5204 if (encrypted_premaster_len < 8) {
5205 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5206 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5210 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5211 return nss_keylog_int("RSA",
5213 encrypted_premaster,
5219 int ssl_log_secret(SSL *ssl,
5221 const uint8_t *secret,
5224 return nss_keylog_int(label,
5226 ssl->s3->client_random,
5232 #define SSLV2_CIPHER_LEN 3
5234 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5238 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5240 if (PACKET_remaining(cipher_suites) == 0) {
5241 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5242 SSL_R_NO_CIPHERS_SPECIFIED);
5246 if (PACKET_remaining(cipher_suites) % n != 0) {
5247 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5248 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5252 OPENSSL_free(s->s3->tmp.ciphers_raw);
5253 s->s3->tmp.ciphers_raw = NULL;
5254 s->s3->tmp.ciphers_rawlen = 0;
5257 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5258 PACKET sslv2ciphers = *cipher_suites;
5259 unsigned int leadbyte;
5263 * We store the raw ciphers list in SSLv3+ format so we need to do some
5264 * preprocessing to convert the list first. If there are any SSLv2 only
5265 * ciphersuites with a non-zero leading byte then we are going to
5266 * slightly over allocate because we won't store those. But that isn't a
5269 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5270 s->s3->tmp.ciphers_raw = raw;
5272 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5273 ERR_R_MALLOC_FAILURE);
5276 for (s->s3->tmp.ciphers_rawlen = 0;
5277 PACKET_remaining(&sslv2ciphers) > 0;
5278 raw += TLS_CIPHER_LEN) {
5279 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5281 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5284 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5285 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5287 OPENSSL_free(s->s3->tmp.ciphers_raw);
5288 s->s3->tmp.ciphers_raw = NULL;
5289 s->s3->tmp.ciphers_rawlen = 0;
5293 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5295 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5296 &s->s3->tmp.ciphers_rawlen)) {
5297 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5298 ERR_R_INTERNAL_ERROR);
5304 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5305 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5306 STACK_OF(SSL_CIPHER) **scsvs)
5310 if (!PACKET_buf_init(&pkt, bytes, len))
5312 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5315 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5316 STACK_OF(SSL_CIPHER) **skp,
5317 STACK_OF(SSL_CIPHER) **scsvs_out,
5318 int sslv2format, int fatal)
5320 const SSL_CIPHER *c;
5321 STACK_OF(SSL_CIPHER) *sk = NULL;
5322 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5324 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5325 unsigned char cipher[SSLV2_CIPHER_LEN];
5327 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5329 if (PACKET_remaining(cipher_suites) == 0) {
5331 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5332 SSL_R_NO_CIPHERS_SPECIFIED);
5334 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5338 if (PACKET_remaining(cipher_suites) % n != 0) {
5340 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5341 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5343 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5344 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5348 sk = sk_SSL_CIPHER_new_null();
5349 scsvs = sk_SSL_CIPHER_new_null();
5350 if (sk == NULL || scsvs == NULL) {
5352 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5353 ERR_R_MALLOC_FAILURE);
5355 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5359 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5361 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5362 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5363 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5365 if (sslv2format && cipher[0] != '\0')
5368 /* For SSLv2-compat, ignore leading 0-byte. */
5369 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5371 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5372 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5374 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5375 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5377 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5382 if (PACKET_remaining(cipher_suites) > 0) {
5384 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5387 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5394 sk_SSL_CIPHER_free(sk);
5395 if (scsvs_out != NULL)
5398 sk_SSL_CIPHER_free(scsvs);
5401 sk_SSL_CIPHER_free(sk);
5402 sk_SSL_CIPHER_free(scsvs);
5406 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5408 ctx->max_early_data = max_early_data;
5413 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5415 return ctx->max_early_data;
5418 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5420 s->max_early_data = max_early_data;
5425 uint32_t SSL_get_max_early_data(const SSL *s)
5427 return s->max_early_data;
5430 int SSL_CTX_set_recv_max_early_data(SSL_CTX *ctx, uint32_t recv_max_early_data)
5432 ctx->recv_max_early_data = recv_max_early_data;
5437 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX *ctx)
5439 return ctx->recv_max_early_data;
5442 int SSL_set_recv_max_early_data(SSL *s, uint32_t recv_max_early_data)
5444 s->recv_max_early_data = recv_max_early_data;
5449 uint32_t SSL_get_recv_max_early_data(const SSL *s)
5451 return s->recv_max_early_data;
5454 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5456 /* Return any active Max Fragment Len extension */
5457 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5458 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5460 /* return current SSL connection setting */
5461 return ssl->max_send_fragment;
5464 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5466 /* Return a value regarding an active Max Fragment Len extension */
5467 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5468 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5469 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5471 /* else limit |split_send_fragment| to current |max_send_fragment| */
5472 if (ssl->split_send_fragment > ssl->max_send_fragment)
5473 return ssl->max_send_fragment;
5475 /* return current SSL connection setting */
5476 return ssl->split_send_fragment;
5479 int SSL_stateless(SSL *s)
5483 /* Ensure there is no state left over from a previous invocation */
5489 s->s3->flags |= TLS1_FLAGS_STATELESS;
5490 ret = SSL_accept(s);
5491 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5493 if (ret > 0 && s->ext.cookieok)
5496 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5502 void SSL_CTX_set_post_handshake_auth(SSL_CTX *ctx, int val)
5504 ctx->pha_enabled = val;
5507 void SSL_set_post_handshake_auth(SSL *ssl, int val)
5509 ssl->pha_enabled = val;
5512 int SSL_verify_client_post_handshake(SSL *ssl)
5514 if (!SSL_IS_TLS13(ssl)) {
5515 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5519 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5523 if (!SSL_is_init_finished(ssl)) {
5524 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5528 switch (ssl->post_handshake_auth) {
5530 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5533 case SSL_PHA_EXT_SENT:
5534 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5536 case SSL_PHA_EXT_RECEIVED:
5538 case SSL_PHA_REQUEST_PENDING:
5539 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5541 case SSL_PHA_REQUESTED:
5542 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5546 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5548 /* checks verify_mode and algorithm_auth */
5549 if (!send_certificate_request(ssl)) {
5550 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5551 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5555 ossl_statem_set_in_init(ssl, 1);
5559 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5560 SSL_CTX_generate_session_ticket_fn gen_cb,
5561 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5564 ctx->generate_ticket_cb = gen_cb;
5565 ctx->decrypt_ticket_cb = dec_cb;
5566 ctx->ticket_cb_data = arg;
5570 void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
5571 SSL_allow_early_data_cb_fn cb,
5574 ctx->allow_early_data_cb = cb;
5575 ctx->allow_early_data_cb_data = arg;
5578 void SSL_set_allow_early_data_cb(SSL *s,
5579 SSL_allow_early_data_cb_fn cb,
5582 s->allow_early_data_cb = cb;
5583 s->allow_early_data_cb_data = arg;