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;
834 s->async_cb = ctx->async_cb;
835 s->async_cb_arg = ctx->async_cb_arg;
839 #ifndef OPENSSL_NO_CT
840 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
841 ctx->ct_validation_callback_arg))
848 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
852 int SSL_is_dtls(const SSL *s)
854 return SSL_IS_DTLS(s) ? 1 : 0;
857 int SSL_up_ref(SSL *s)
861 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
864 REF_PRINT_COUNT("SSL", s);
865 REF_ASSERT_ISNT(i < 2);
866 return ((i > 1) ? 1 : 0);
869 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
870 unsigned int sid_ctx_len)
872 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
873 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
874 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
877 ctx->sid_ctx_length = sid_ctx_len;
878 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
883 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
884 unsigned int sid_ctx_len)
886 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
887 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
888 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
891 ssl->sid_ctx_length = sid_ctx_len;
892 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
897 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
899 CRYPTO_THREAD_write_lock(ctx->lock);
900 ctx->generate_session_id = cb;
901 CRYPTO_THREAD_unlock(ctx->lock);
905 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
907 CRYPTO_THREAD_write_lock(ssl->lock);
908 ssl->generate_session_id = cb;
909 CRYPTO_THREAD_unlock(ssl->lock);
913 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
917 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
918 * we can "construct" a session to give us the desired check - i.e. to
919 * find if there's a session in the hash table that would conflict with
920 * any new session built out of this id/id_len and the ssl_version in use
925 if (id_len > sizeof(r.session_id))
928 r.ssl_version = ssl->version;
929 r.session_id_length = id_len;
930 memcpy(r.session_id, id, id_len);
932 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
933 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
934 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
938 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
940 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
943 int SSL_set_purpose(SSL *s, int purpose)
945 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
948 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
950 return X509_VERIFY_PARAM_set_trust(s->param, trust);
953 int SSL_set_trust(SSL *s, int trust)
955 return X509_VERIFY_PARAM_set_trust(s->param, trust);
958 int SSL_set1_host(SSL *s, const char *hostname)
960 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
963 int SSL_add1_host(SSL *s, const char *hostname)
965 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
968 void SSL_set_hostflags(SSL *s, unsigned int flags)
970 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
973 const char *SSL_get0_peername(SSL *s)
975 return X509_VERIFY_PARAM_get0_peername(s->param);
978 int SSL_CTX_dane_enable(SSL_CTX *ctx)
980 return dane_ctx_enable(&ctx->dane);
983 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
985 unsigned long orig = ctx->dane.flags;
987 ctx->dane.flags |= flags;
991 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
993 unsigned long orig = ctx->dane.flags;
995 ctx->dane.flags &= ~flags;
999 int SSL_dane_enable(SSL *s, const char *basedomain)
1001 SSL_DANE *dane = &s->dane;
1003 if (s->ctx->dane.mdmax == 0) {
1004 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
1007 if (dane->trecs != NULL) {
1008 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1013 * Default SNI name. This rejects empty names, while set1_host below
1014 * accepts them and disables host name checks. To avoid side-effects with
1015 * invalid input, set the SNI name first.
1017 if (s->ext.hostname == NULL) {
1018 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1019 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1024 /* Primary RFC6125 reference identifier */
1025 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1026 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1032 dane->dctx = &s->ctx->dane;
1033 dane->trecs = sk_danetls_record_new_null();
1035 if (dane->trecs == NULL) {
1036 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1042 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1044 unsigned long orig = ssl->dane.flags;
1046 ssl->dane.flags |= flags;
1050 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1052 unsigned long orig = ssl->dane.flags;
1054 ssl->dane.flags &= ~flags;
1058 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1060 SSL_DANE *dane = &s->dane;
1062 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1066 *mcert = dane->mcert;
1068 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1073 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1074 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1076 SSL_DANE *dane = &s->dane;
1078 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1082 *usage = dane->mtlsa->usage;
1084 *selector = dane->mtlsa->selector;
1086 *mtype = dane->mtlsa->mtype;
1088 *data = dane->mtlsa->data;
1090 *dlen = dane->mtlsa->dlen;
1095 SSL_DANE *SSL_get0_dane(SSL *s)
1100 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1101 uint8_t mtype, unsigned const char *data, size_t dlen)
1103 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1106 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1109 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1112 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1114 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1117 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1119 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1122 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1127 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1132 void SSL_certs_clear(SSL *s)
1134 ssl_cert_clear_certs(s->cert);
1137 void SSL_free(SSL *s)
1143 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1144 REF_PRINT_COUNT("SSL", s);
1147 REF_ASSERT_ISNT(i < 0);
1149 X509_VERIFY_PARAM_free(s->param);
1150 dane_final(&s->dane);
1151 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1153 RECORD_LAYER_release(&s->rlayer);
1155 /* Ignore return value */
1156 ssl_free_wbio_buffer(s);
1158 BIO_free_all(s->wbio);
1160 BIO_free_all(s->rbio);
1163 BUF_MEM_free(s->init_buf);
1165 /* add extra stuff */
1166 sk_SSL_CIPHER_free(s->cipher_list);
1167 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1168 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1170 /* Make the next call work :-) */
1171 if (s->session != NULL) {
1172 ssl_clear_bad_session(s);
1173 SSL_SESSION_free(s->session);
1175 SSL_SESSION_free(s->psksession);
1176 OPENSSL_free(s->psksession_id);
1180 ssl_cert_free(s->cert);
1181 /* Free up if allocated */
1183 OPENSSL_free(s->ext.hostname);
1184 SSL_CTX_free(s->session_ctx);
1185 #ifndef OPENSSL_NO_EC
1186 OPENSSL_free(s->ext.ecpointformats);
1187 OPENSSL_free(s->ext.supportedgroups);
1188 #endif /* OPENSSL_NO_EC */
1189 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1190 #ifndef OPENSSL_NO_OCSP
1191 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1193 #ifndef OPENSSL_NO_CT
1194 SCT_LIST_free(s->scts);
1195 OPENSSL_free(s->ext.scts);
1197 OPENSSL_free(s->ext.ocsp.resp);
1198 OPENSSL_free(s->ext.alpn);
1199 OPENSSL_free(s->ext.tls13_cookie);
1200 OPENSSL_free(s->clienthello);
1201 OPENSSL_free(s->pha_context);
1202 EVP_MD_CTX_free(s->pha_dgst);
1204 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1205 sk_X509_NAME_pop_free(s->client_ca_names, X509_NAME_free);
1207 sk_X509_pop_free(s->verified_chain, X509_free);
1209 if (s->method != NULL)
1210 s->method->ssl_free(s);
1212 SSL_CTX_free(s->ctx);
1214 ASYNC_WAIT_CTX_free(s->waitctx);
1216 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1217 OPENSSL_free(s->ext.npn);
1220 #ifndef OPENSSL_NO_SRTP
1221 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1224 CRYPTO_THREAD_lock_free(s->lock);
1229 void SSL_set0_rbio(SSL *s, BIO *rbio)
1231 BIO_free_all(s->rbio);
1235 void SSL_set0_wbio(SSL *s, BIO *wbio)
1238 * If the output buffering BIO is still in place, remove it
1240 if (s->bbio != NULL)
1241 s->wbio = BIO_pop(s->wbio);
1243 BIO_free_all(s->wbio);
1246 /* Re-attach |bbio| to the new |wbio|. */
1247 if (s->bbio != NULL)
1248 s->wbio = BIO_push(s->bbio, s->wbio);
1251 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1254 * For historical reasons, this function has many different cases in
1255 * ownership handling.
1258 /* If nothing has changed, do nothing */
1259 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1263 * If the two arguments are equal then one fewer reference is granted by the
1264 * caller than we want to take
1266 if (rbio != NULL && rbio == wbio)
1270 * If only the wbio is changed only adopt one reference.
1272 if (rbio == SSL_get_rbio(s)) {
1273 SSL_set0_wbio(s, wbio);
1277 * There is an asymmetry here for historical reasons. If only the rbio is
1278 * changed AND the rbio and wbio were originally different, then we only
1279 * adopt one reference.
1281 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1282 SSL_set0_rbio(s, rbio);
1286 /* Otherwise, adopt both references. */
1287 SSL_set0_rbio(s, rbio);
1288 SSL_set0_wbio(s, wbio);
1291 BIO *SSL_get_rbio(const SSL *s)
1296 BIO *SSL_get_wbio(const SSL *s)
1298 if (s->bbio != NULL) {
1300 * If |bbio| is active, the true caller-configured BIO is its
1303 return BIO_next(s->bbio);
1308 int SSL_get_fd(const SSL *s)
1310 return SSL_get_rfd(s);
1313 int SSL_get_rfd(const SSL *s)
1318 b = SSL_get_rbio(s);
1319 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1321 BIO_get_fd(r, &ret);
1325 int SSL_get_wfd(const SSL *s)
1330 b = SSL_get_wbio(s);
1331 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1333 BIO_get_fd(r, &ret);
1337 #ifndef OPENSSL_NO_SOCK
1338 int SSL_set_fd(SSL *s, int fd)
1343 bio = BIO_new(BIO_s_socket());
1346 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1349 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1350 SSL_set_bio(s, bio, bio);
1351 #ifndef OPENSSL_NO_KTLS
1353 * The new socket is created successfully regardless of ktls_enable.
1354 * ktls_enable doesn't change any functionality of the socket, except
1355 * changing the setsockopt to enable the processing of ktls_start.
1356 * Thus, it is not a problem to call it for non-TLS sockets.
1359 #endif /* OPENSSL_NO_KTLS */
1365 int SSL_set_wfd(SSL *s, int fd)
1367 BIO *rbio = SSL_get_rbio(s);
1369 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1370 || (int)BIO_get_fd(rbio, NULL) != fd) {
1371 BIO *bio = BIO_new(BIO_s_socket());
1374 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1377 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1378 SSL_set0_wbio(s, bio);
1379 #ifndef OPENSSL_NO_KTLS
1381 * The new socket is created successfully regardless of ktls_enable.
1382 * ktls_enable doesn't change any functionality of the socket, except
1383 * changing the setsockopt to enable the processing of ktls_start.
1384 * Thus, it is not a problem to call it for non-TLS sockets.
1387 #endif /* OPENSSL_NO_KTLS */
1390 SSL_set0_wbio(s, rbio);
1395 int SSL_set_rfd(SSL *s, int fd)
1397 BIO *wbio = SSL_get_wbio(s);
1399 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1400 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1401 BIO *bio = BIO_new(BIO_s_socket());
1404 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1407 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1408 SSL_set0_rbio(s, bio);
1411 SSL_set0_rbio(s, wbio);
1418 /* return length of latest Finished message we sent, copy to 'buf' */
1419 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1423 if (s->s3 != NULL) {
1424 ret = s->s3->tmp.finish_md_len;
1427 memcpy(buf, s->s3->tmp.finish_md, count);
1432 /* return length of latest Finished message we expected, copy to 'buf' */
1433 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1437 if (s->s3 != NULL) {
1438 ret = s->s3->tmp.peer_finish_md_len;
1441 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1446 int SSL_get_verify_mode(const SSL *s)
1448 return s->verify_mode;
1451 int SSL_get_verify_depth(const SSL *s)
1453 return X509_VERIFY_PARAM_get_depth(s->param);
1456 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1457 return s->verify_callback;
1460 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1462 return ctx->verify_mode;
1465 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1467 return X509_VERIFY_PARAM_get_depth(ctx->param);
1470 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1471 return ctx->default_verify_callback;
1474 void SSL_set_verify(SSL *s, int mode,
1475 int (*callback) (int ok, X509_STORE_CTX *ctx))
1477 s->verify_mode = mode;
1478 if (callback != NULL)
1479 s->verify_callback = callback;
1482 void SSL_set_verify_depth(SSL *s, int depth)
1484 X509_VERIFY_PARAM_set_depth(s->param, depth);
1487 void SSL_set_read_ahead(SSL *s, int yes)
1489 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1492 int SSL_get_read_ahead(const SSL *s)
1494 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1497 int SSL_pending(const SSL *s)
1499 size_t pending = s->method->ssl_pending(s);
1502 * SSL_pending cannot work properly if read-ahead is enabled
1503 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1504 * impossible to fix since SSL_pending cannot report errors that may be
1505 * observed while scanning the new data. (Note that SSL_pending() is
1506 * often used as a boolean value, so we'd better not return -1.)
1508 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1509 * we just return INT_MAX.
1511 return pending < INT_MAX ? (int)pending : INT_MAX;
1514 int SSL_has_pending(const SSL *s)
1517 * Similar to SSL_pending() but returns a 1 to indicate that we have
1518 * unprocessed data available or 0 otherwise (as opposed to the number of
1519 * bytes available). Unlike SSL_pending() this will take into account
1520 * read_ahead data. A 1 return simply indicates that we have unprocessed
1521 * data. That data may not result in any application data, or we may fail
1522 * to parse the records for some reason.
1524 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1527 return RECORD_LAYER_read_pending(&s->rlayer);
1530 X509 *SSL_get_peer_certificate(const SSL *s)
1534 if ((s == NULL) || (s->session == NULL))
1537 r = s->session->peer;
1547 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1551 if ((s == NULL) || (s->session == NULL))
1554 r = s->session->peer_chain;
1557 * If we are a client, cert_chain includes the peer's own certificate; if
1558 * we are a server, it does not.
1565 * Now in theory, since the calling process own 't' it should be safe to
1566 * modify. We need to be able to read f without being hassled
1568 int SSL_copy_session_id(SSL *t, const SSL *f)
1571 /* Do we need to to SSL locking? */
1572 if (!SSL_set_session(t, SSL_get_session(f))) {
1577 * what if we are setup for one protocol version but want to talk another
1579 if (t->method != f->method) {
1580 t->method->ssl_free(t);
1581 t->method = f->method;
1582 if (t->method->ssl_new(t) == 0)
1586 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1587 ssl_cert_free(t->cert);
1589 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1596 /* Fix this so it checks all the valid key/cert options */
1597 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1599 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1600 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1603 if (ctx->cert->key->privatekey == NULL) {
1604 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1607 return X509_check_private_key
1608 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1611 /* Fix this function so that it takes an optional type parameter */
1612 int SSL_check_private_key(const SSL *ssl)
1615 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1618 if (ssl->cert->key->x509 == NULL) {
1619 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1622 if (ssl->cert->key->privatekey == NULL) {
1623 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1626 return X509_check_private_key(ssl->cert->key->x509,
1627 ssl->cert->key->privatekey);
1630 int SSL_waiting_for_async(SSL *s)
1638 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1640 ASYNC_WAIT_CTX *ctx = s->waitctx;
1644 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1647 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1648 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1650 ASYNC_WAIT_CTX *ctx = s->waitctx;
1654 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1658 int SSL_CTX_set_async_callback(SSL_CTX *ctx, SSL_async_callback_fn callback)
1660 ctx->async_cb = callback;
1664 int SSL_CTX_set_async_callback_arg(SSL_CTX *ctx, void *arg)
1666 ctx->async_cb_arg = arg;
1670 int SSL_set_async_callback(SSL *s, SSL_async_callback_fn callback)
1672 s->async_cb = callback;
1676 int SSL_set_async_callback_arg(SSL *s, void *arg)
1678 s->async_cb_arg = arg;
1682 int SSL_get_async_status(SSL *s, int *status)
1684 ASYNC_WAIT_CTX *ctx = s->waitctx;
1688 *status = ASYNC_WAIT_CTX_get_status(ctx);
1692 int SSL_accept(SSL *s)
1694 if (s->handshake_func == NULL) {
1695 /* Not properly initialized yet */
1696 SSL_set_accept_state(s);
1699 return SSL_do_handshake(s);
1702 int SSL_connect(SSL *s)
1704 if (s->handshake_func == NULL) {
1705 /* Not properly initialized yet */
1706 SSL_set_connect_state(s);
1709 return SSL_do_handshake(s);
1712 long SSL_get_default_timeout(const SSL *s)
1714 return s->method->get_timeout();
1717 static int ssl_async_wait_ctx_cb(void *arg)
1719 SSL *s = (SSL *)arg;
1721 return s->async_cb(s, s->async_cb_arg);
1724 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1725 int (*func) (void *))
1728 if (s->waitctx == NULL) {
1729 s->waitctx = ASYNC_WAIT_CTX_new();
1730 if (s->waitctx == NULL)
1732 if (s->async_cb != NULL
1733 && !ASYNC_WAIT_CTX_set_callback
1734 (s->waitctx, ssl_async_wait_ctx_cb, s))
1737 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1738 sizeof(struct ssl_async_args))) {
1740 s->rwstate = SSL_NOTHING;
1741 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1744 s->rwstate = SSL_ASYNC_PAUSED;
1747 s->rwstate = SSL_ASYNC_NO_JOBS;
1753 s->rwstate = SSL_NOTHING;
1754 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1755 /* Shouldn't happen */
1760 static int ssl_io_intern(void *vargs)
1762 struct ssl_async_args *args;
1767 args = (struct ssl_async_args *)vargs;
1771 switch (args->type) {
1773 return args->f.func_read(s, buf, num, &s->asyncrw);
1775 return args->f.func_write(s, buf, num, &s->asyncrw);
1777 return args->f.func_other(s);
1782 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1784 if (s->handshake_func == NULL) {
1785 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1789 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1790 s->rwstate = SSL_NOTHING;
1794 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1795 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1796 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1800 * If we are a client and haven't received the ServerHello etc then we
1803 ossl_statem_check_finish_init(s, 0);
1805 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1806 struct ssl_async_args args;
1812 args.type = READFUNC;
1813 args.f.func_read = s->method->ssl_read;
1815 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1816 *readbytes = s->asyncrw;
1819 return s->method->ssl_read(s, buf, num, readbytes);
1823 int SSL_read(SSL *s, void *buf, int num)
1829 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1833 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1836 * The cast is safe here because ret should be <= INT_MAX because num is
1840 ret = (int)readbytes;
1845 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1847 int ret = ssl_read_internal(s, buf, num, readbytes);
1854 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1859 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1860 return SSL_READ_EARLY_DATA_ERROR;
1863 switch (s->early_data_state) {
1864 case SSL_EARLY_DATA_NONE:
1865 if (!SSL_in_before(s)) {
1866 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1867 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1868 return SSL_READ_EARLY_DATA_ERROR;
1872 case SSL_EARLY_DATA_ACCEPT_RETRY:
1873 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1874 ret = SSL_accept(s);
1877 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1878 return SSL_READ_EARLY_DATA_ERROR;
1882 case SSL_EARLY_DATA_READ_RETRY:
1883 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1884 s->early_data_state = SSL_EARLY_DATA_READING;
1885 ret = SSL_read_ex(s, buf, num, readbytes);
1887 * State machine will update early_data_state to
1888 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1891 if (ret > 0 || (ret <= 0 && s->early_data_state
1892 != SSL_EARLY_DATA_FINISHED_READING)) {
1893 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1894 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1895 : SSL_READ_EARLY_DATA_ERROR;
1898 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1901 return SSL_READ_EARLY_DATA_FINISH;
1904 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1905 return SSL_READ_EARLY_DATA_ERROR;
1909 int SSL_get_early_data_status(const SSL *s)
1911 return s->ext.early_data;
1914 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1916 if (s->handshake_func == NULL) {
1917 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1921 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1924 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1925 struct ssl_async_args args;
1931 args.type = READFUNC;
1932 args.f.func_read = s->method->ssl_peek;
1934 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1935 *readbytes = s->asyncrw;
1938 return s->method->ssl_peek(s, buf, num, readbytes);
1942 int SSL_peek(SSL *s, void *buf, int num)
1948 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1952 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1955 * The cast is safe here because ret should be <= INT_MAX because num is
1959 ret = (int)readbytes;
1965 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1967 int ret = ssl_peek_internal(s, buf, num, readbytes);
1974 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1976 if (s->handshake_func == NULL) {
1977 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1981 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1982 s->rwstate = SSL_NOTHING;
1983 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1987 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1988 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1989 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1990 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1993 /* If we are a client and haven't sent the Finished we better do that */
1994 ossl_statem_check_finish_init(s, 1);
1996 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1998 struct ssl_async_args args;
2001 args.buf = (void *)buf;
2003 args.type = WRITEFUNC;
2004 args.f.func_write = s->method->ssl_write;
2006 ret = ssl_start_async_job(s, &args, ssl_io_intern);
2007 *written = s->asyncrw;
2010 return s->method->ssl_write(s, buf, num, written);
2014 int SSL_write(SSL *s, const void *buf, int num)
2020 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
2024 ret = ssl_write_internal(s, buf, (size_t)num, &written);
2027 * The cast is safe here because ret should be <= INT_MAX because num is
2036 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
2038 int ret = ssl_write_internal(s, buf, num, written);
2045 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
2047 int ret, early_data_state;
2049 uint32_t partialwrite;
2051 switch (s->early_data_state) {
2052 case SSL_EARLY_DATA_NONE:
2054 || !SSL_in_before(s)
2055 || ((s->session == NULL || s->session->ext.max_early_data == 0)
2056 && (s->psk_use_session_cb == NULL))) {
2057 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
2058 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2063 case SSL_EARLY_DATA_CONNECT_RETRY:
2064 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
2065 ret = SSL_connect(s);
2068 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2073 case SSL_EARLY_DATA_WRITE_RETRY:
2074 s->early_data_state = SSL_EARLY_DATA_WRITING;
2076 * We disable partial write for early data because we don't keep track
2077 * of how many bytes we've written between the SSL_write_ex() call and
2078 * the flush if the flush needs to be retried)
2080 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2081 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2082 ret = SSL_write_ex(s, buf, num, &writtmp);
2083 s->mode |= partialwrite;
2085 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2088 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2091 case SSL_EARLY_DATA_WRITE_FLUSH:
2092 /* The buffering BIO is still in place so we need to flush it */
2093 if (statem_flush(s) != 1)
2096 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2099 case SSL_EARLY_DATA_FINISHED_READING:
2100 case SSL_EARLY_DATA_READ_RETRY:
2101 early_data_state = s->early_data_state;
2102 /* We are a server writing to an unauthenticated client */
2103 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2104 ret = SSL_write_ex(s, buf, num, written);
2105 /* The buffering BIO is still in place */
2107 (void)BIO_flush(s->wbio);
2108 s->early_data_state = early_data_state;
2112 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2117 int SSL_shutdown(SSL *s)
2120 * Note that this function behaves differently from what one might
2121 * expect. Return values are 0 for no success (yet), 1 for success; but
2122 * calling it once is usually not enough, even if blocking I/O is used
2123 * (see ssl3_shutdown).
2126 if (s->handshake_func == NULL) {
2127 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2131 if (!SSL_in_init(s)) {
2132 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2133 struct ssl_async_args args;
2136 args.type = OTHERFUNC;
2137 args.f.func_other = s->method->ssl_shutdown;
2139 return ssl_start_async_job(s, &args, ssl_io_intern);
2141 return s->method->ssl_shutdown(s);
2144 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2149 int SSL_key_update(SSL *s, int updatetype)
2152 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2153 * negotiated, and that it is appropriate to call SSL_key_update() instead
2154 * of SSL_renegotiate().
2156 if (!SSL_IS_TLS13(s)) {
2157 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2161 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2162 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2163 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2167 if (!SSL_is_init_finished(s)) {
2168 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2172 ossl_statem_set_in_init(s, 1);
2173 s->key_update = updatetype;
2177 int SSL_get_key_update_type(const SSL *s)
2179 return s->key_update;
2182 int SSL_renegotiate(SSL *s)
2184 if (SSL_IS_TLS13(s)) {
2185 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2189 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2190 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2197 return s->method->ssl_renegotiate(s);
2200 int SSL_renegotiate_abbreviated(SSL *s)
2202 if (SSL_IS_TLS13(s)) {
2203 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2207 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2208 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2215 return s->method->ssl_renegotiate(s);
2218 int SSL_renegotiate_pending(const SSL *s)
2221 * becomes true when negotiation is requested; false again once a
2222 * handshake has finished
2224 return (s->renegotiate != 0);
2227 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2232 case SSL_CTRL_GET_READ_AHEAD:
2233 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2234 case SSL_CTRL_SET_READ_AHEAD:
2235 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2236 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2239 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2240 s->msg_callback_arg = parg;
2244 return (s->mode |= larg);
2245 case SSL_CTRL_CLEAR_MODE:
2246 return (s->mode &= ~larg);
2247 case SSL_CTRL_GET_MAX_CERT_LIST:
2248 return (long)s->max_cert_list;
2249 case SSL_CTRL_SET_MAX_CERT_LIST:
2252 l = (long)s->max_cert_list;
2253 s->max_cert_list = (size_t)larg;
2255 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2256 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2258 #ifndef OPENSSL_NO_KTLS
2259 if (s->wbio != NULL && BIO_get_ktls_send(s->wbio))
2261 #endif /* OPENSSL_NO_KTLS */
2262 s->max_send_fragment = larg;
2263 if (s->max_send_fragment < s->split_send_fragment)
2264 s->split_send_fragment = s->max_send_fragment;
2266 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2267 if ((size_t)larg > s->max_send_fragment || larg == 0)
2269 s->split_send_fragment = larg;
2271 case SSL_CTRL_SET_MAX_PIPELINES:
2272 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2274 s->max_pipelines = larg;
2276 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2278 case SSL_CTRL_GET_RI_SUPPORT:
2280 return s->s3->send_connection_binding;
2283 case SSL_CTRL_CERT_FLAGS:
2284 return (s->cert->cert_flags |= larg);
2285 case SSL_CTRL_CLEAR_CERT_FLAGS:
2286 return (s->cert->cert_flags &= ~larg);
2288 case SSL_CTRL_GET_RAW_CIPHERLIST:
2290 if (s->s3->tmp.ciphers_raw == NULL)
2292 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2293 return (int)s->s3->tmp.ciphers_rawlen;
2295 return TLS_CIPHER_LEN;
2297 case SSL_CTRL_GET_EXTMS_SUPPORT:
2298 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2300 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2304 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2305 return ssl_check_allowed_versions(larg, s->max_proto_version)
2306 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2307 &s->min_proto_version);
2308 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2309 return s->min_proto_version;
2310 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2311 return ssl_check_allowed_versions(s->min_proto_version, larg)
2312 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2313 &s->max_proto_version);
2314 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2315 return s->max_proto_version;
2317 return s->method->ssl_ctrl(s, cmd, larg, parg);
2321 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2324 case SSL_CTRL_SET_MSG_CALLBACK:
2325 s->msg_callback = (void (*)
2326 (int write_p, int version, int content_type,
2327 const void *buf, size_t len, SSL *ssl,
2332 return s->method->ssl_callback_ctrl(s, cmd, fp);
2336 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2338 return ctx->sessions;
2341 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2344 /* For some cases with ctx == NULL perform syntax checks */
2347 #ifndef OPENSSL_NO_EC
2348 case SSL_CTRL_SET_GROUPS_LIST:
2349 return tls1_set_groups_list(NULL, NULL, parg);
2351 case SSL_CTRL_SET_SIGALGS_LIST:
2352 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2353 return tls1_set_sigalgs_list(NULL, parg, 0);
2360 case SSL_CTRL_GET_READ_AHEAD:
2361 return ctx->read_ahead;
2362 case SSL_CTRL_SET_READ_AHEAD:
2363 l = ctx->read_ahead;
2364 ctx->read_ahead = larg;
2367 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2368 ctx->msg_callback_arg = parg;
2371 case SSL_CTRL_GET_MAX_CERT_LIST:
2372 return (long)ctx->max_cert_list;
2373 case SSL_CTRL_SET_MAX_CERT_LIST:
2376 l = (long)ctx->max_cert_list;
2377 ctx->max_cert_list = (size_t)larg;
2380 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2383 l = (long)ctx->session_cache_size;
2384 ctx->session_cache_size = (size_t)larg;
2386 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2387 return (long)ctx->session_cache_size;
2388 case SSL_CTRL_SET_SESS_CACHE_MODE:
2389 l = ctx->session_cache_mode;
2390 ctx->session_cache_mode = larg;
2392 case SSL_CTRL_GET_SESS_CACHE_MODE:
2393 return ctx->session_cache_mode;
2395 case SSL_CTRL_SESS_NUMBER:
2396 return lh_SSL_SESSION_num_items(ctx->sessions);
2397 case SSL_CTRL_SESS_CONNECT:
2398 return tsan_load(&ctx->stats.sess_connect);
2399 case SSL_CTRL_SESS_CONNECT_GOOD:
2400 return tsan_load(&ctx->stats.sess_connect_good);
2401 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2402 return tsan_load(&ctx->stats.sess_connect_renegotiate);
2403 case SSL_CTRL_SESS_ACCEPT:
2404 return tsan_load(&ctx->stats.sess_accept);
2405 case SSL_CTRL_SESS_ACCEPT_GOOD:
2406 return tsan_load(&ctx->stats.sess_accept_good);
2407 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2408 return tsan_load(&ctx->stats.sess_accept_renegotiate);
2409 case SSL_CTRL_SESS_HIT:
2410 return tsan_load(&ctx->stats.sess_hit);
2411 case SSL_CTRL_SESS_CB_HIT:
2412 return tsan_load(&ctx->stats.sess_cb_hit);
2413 case SSL_CTRL_SESS_MISSES:
2414 return tsan_load(&ctx->stats.sess_miss);
2415 case SSL_CTRL_SESS_TIMEOUTS:
2416 return tsan_load(&ctx->stats.sess_timeout);
2417 case SSL_CTRL_SESS_CACHE_FULL:
2418 return tsan_load(&ctx->stats.sess_cache_full);
2420 return (ctx->mode |= larg);
2421 case SSL_CTRL_CLEAR_MODE:
2422 return (ctx->mode &= ~larg);
2423 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2424 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2426 ctx->max_send_fragment = larg;
2427 if (ctx->max_send_fragment < ctx->split_send_fragment)
2428 ctx->split_send_fragment = ctx->max_send_fragment;
2430 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2431 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2433 ctx->split_send_fragment = larg;
2435 case SSL_CTRL_SET_MAX_PIPELINES:
2436 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2438 ctx->max_pipelines = larg;
2440 case SSL_CTRL_CERT_FLAGS:
2441 return (ctx->cert->cert_flags |= larg);
2442 case SSL_CTRL_CLEAR_CERT_FLAGS:
2443 return (ctx->cert->cert_flags &= ~larg);
2444 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2445 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2446 && ssl_set_version_bound(ctx->method->version, (int)larg,
2447 &ctx->min_proto_version);
2448 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2449 return ctx->min_proto_version;
2450 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2451 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2452 && ssl_set_version_bound(ctx->method->version, (int)larg,
2453 &ctx->max_proto_version);
2454 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2455 return ctx->max_proto_version;
2457 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2461 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2464 case SSL_CTRL_SET_MSG_CALLBACK:
2465 ctx->msg_callback = (void (*)
2466 (int write_p, int version, int content_type,
2467 const void *buf, size_t len, SSL *ssl,
2472 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2476 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2485 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2486 const SSL_CIPHER *const *bp)
2488 if ((*ap)->id > (*bp)->id)
2490 if ((*ap)->id < (*bp)->id)
2495 /** return a STACK of the ciphers available for the SSL and in order of
2497 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2500 if (s->cipher_list != NULL) {
2501 return s->cipher_list;
2502 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2503 return s->ctx->cipher_list;
2509 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2511 if ((s == NULL) || (s->session == NULL) || !s->server)
2513 return s->session->ciphers;
2516 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2518 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2521 ciphers = SSL_get_ciphers(s);
2524 if (!ssl_set_client_disabled(s))
2526 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2527 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2528 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2530 sk = sk_SSL_CIPHER_new_null();
2533 if (!sk_SSL_CIPHER_push(sk, c)) {
2534 sk_SSL_CIPHER_free(sk);
2542 /** return a STACK of the ciphers available for the SSL and in order of
2544 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2547 if (s->cipher_list_by_id != NULL) {
2548 return s->cipher_list_by_id;
2549 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2550 return s->ctx->cipher_list_by_id;
2556 /** The old interface to get the same thing as SSL_get_ciphers() */
2557 const char *SSL_get_cipher_list(const SSL *s, int n)
2559 const SSL_CIPHER *c;
2560 STACK_OF(SSL_CIPHER) *sk;
2564 sk = SSL_get_ciphers(s);
2565 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2567 c = sk_SSL_CIPHER_value(sk, n);
2573 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2575 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2578 return ctx->cipher_list;
2582 /** specify the ciphers to be used by default by the SSL_CTX */
2583 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2585 STACK_OF(SSL_CIPHER) *sk;
2587 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2588 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2591 * ssl_create_cipher_list may return an empty stack if it was unable to
2592 * find a cipher matching the given rule string (for example if the rule
2593 * string specifies a cipher which has been disabled). This is not an
2594 * error as far as ssl_create_cipher_list is concerned, and hence
2595 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2599 else if (sk_SSL_CIPHER_num(sk) == 0) {
2600 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2606 /** specify the ciphers to be used by the SSL */
2607 int SSL_set_cipher_list(SSL *s, const char *str)
2609 STACK_OF(SSL_CIPHER) *sk;
2611 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2612 &s->cipher_list, &s->cipher_list_by_id, str,
2614 /* see comment in SSL_CTX_set_cipher_list */
2617 else if (sk_SSL_CIPHER_num(sk) == 0) {
2618 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2624 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2627 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2628 const SSL_CIPHER *c;
2632 || s->session == NULL
2633 || s->session->ciphers == NULL
2638 clntsk = s->session->ciphers;
2639 srvrsk = SSL_get_ciphers(s);
2640 if (clntsk == NULL || srvrsk == NULL)
2643 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2646 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2649 c = sk_SSL_CIPHER_value(clntsk, i);
2650 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2653 n = strlen(c->name);
2669 /** return a servername extension value if provided in Client Hello, or NULL.
2670 * So far, only host_name types are defined (RFC 3546).
2673 const char *SSL_get_servername(const SSL *s, const int type)
2675 if (type != TLSEXT_NAMETYPE_host_name)
2679 * SNI is not negotiated in pre-TLS-1.3 resumption flows, so fake up an
2680 * SNI value to return if we are resuming/resumed. N.B. that we still
2681 * call the relevant callbacks for such resumption flows, and callbacks
2682 * might error out if there is not a SNI value available.
2685 return s->session->ext.hostname;
2686 return s->ext.hostname;
2689 int SSL_get_servername_type(const SSL *s)
2692 && (!s->ext.hostname ? s->session->
2693 ext.hostname : s->ext.hostname))
2694 return TLSEXT_NAMETYPE_host_name;
2699 * SSL_select_next_proto implements the standard protocol selection. It is
2700 * expected that this function is called from the callback set by
2701 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2702 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2703 * not included in the length. A byte string of length 0 is invalid. No byte
2704 * string may be truncated. The current, but experimental algorithm for
2705 * selecting the protocol is: 1) If the server doesn't support NPN then this
2706 * is indicated to the callback. In this case, the client application has to
2707 * abort the connection or have a default application level protocol. 2) If
2708 * the server supports NPN, but advertises an empty list then the client
2709 * selects the first protocol in its list, but indicates via the API that this
2710 * fallback case was enacted. 3) Otherwise, the client finds the first
2711 * protocol in the server's list that it supports and selects this protocol.
2712 * This is because it's assumed that the server has better information about
2713 * which protocol a client should use. 4) If the client doesn't support any
2714 * of the server's advertised protocols, then this is treated the same as
2715 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2716 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2718 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2719 const unsigned char *server,
2720 unsigned int server_len,
2721 const unsigned char *client, unsigned int client_len)
2724 const unsigned char *result;
2725 int status = OPENSSL_NPN_UNSUPPORTED;
2728 * For each protocol in server preference order, see if we support it.
2730 for (i = 0; i < server_len;) {
2731 for (j = 0; j < client_len;) {
2732 if (server[i] == client[j] &&
2733 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2734 /* We found a match */
2735 result = &server[i];
2736 status = OPENSSL_NPN_NEGOTIATED;
2746 /* There's no overlap between our protocols and the server's list. */
2748 status = OPENSSL_NPN_NO_OVERLAP;
2751 *out = (unsigned char *)result + 1;
2752 *outlen = result[0];
2756 #ifndef OPENSSL_NO_NEXTPROTONEG
2758 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2759 * client's requested protocol for this connection and returns 0. If the
2760 * client didn't request any protocol, then *data is set to NULL. Note that
2761 * the client can request any protocol it chooses. The value returned from
2762 * this function need not be a member of the list of supported protocols
2763 * provided by the callback.
2765 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2772 *len = (unsigned int)s->ext.npn_len;
2777 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2778 * a TLS server needs a list of supported protocols for Next Protocol
2779 * Negotiation. The returned list must be in wire format. The list is
2780 * returned by setting |out| to point to it and |outlen| to its length. This
2781 * memory will not be modified, but one should assume that the SSL* keeps a
2782 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2783 * wishes to advertise. Otherwise, no such extension will be included in the
2786 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2787 SSL_CTX_npn_advertised_cb_func cb,
2790 ctx->ext.npn_advertised_cb = cb;
2791 ctx->ext.npn_advertised_cb_arg = arg;
2795 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2796 * client needs to select a protocol from the server's provided list. |out|
2797 * must be set to point to the selected protocol (which may be within |in|).
2798 * The length of the protocol name must be written into |outlen|. The
2799 * server's advertised protocols are provided in |in| and |inlen|. The
2800 * callback can assume that |in| is syntactically valid. The client must
2801 * select a protocol. It is fatal to the connection if this callback returns
2802 * a value other than SSL_TLSEXT_ERR_OK.
2804 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2805 SSL_CTX_npn_select_cb_func cb,
2808 ctx->ext.npn_select_cb = cb;
2809 ctx->ext.npn_select_cb_arg = arg;
2814 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2815 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2816 * length-prefixed strings). Returns 0 on success.
2818 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2819 unsigned int protos_len)
2821 OPENSSL_free(ctx->ext.alpn);
2822 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2823 if (ctx->ext.alpn == NULL) {
2824 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2827 ctx->ext.alpn_len = protos_len;
2833 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2834 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2835 * length-prefixed strings). Returns 0 on success.
2837 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2838 unsigned int protos_len)
2840 OPENSSL_free(ssl->ext.alpn);
2841 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2842 if (ssl->ext.alpn == NULL) {
2843 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2846 ssl->ext.alpn_len = protos_len;
2852 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2853 * called during ClientHello processing in order to select an ALPN protocol
2854 * from the client's list of offered protocols.
2856 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2857 SSL_CTX_alpn_select_cb_func cb,
2860 ctx->ext.alpn_select_cb = cb;
2861 ctx->ext.alpn_select_cb_arg = arg;
2865 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2866 * On return it sets |*data| to point to |*len| bytes of protocol name
2867 * (not including the leading length-prefix byte). If the server didn't
2868 * respond with a negotiated protocol then |*len| will be zero.
2870 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2875 *data = ssl->s3->alpn_selected;
2879 *len = (unsigned int)ssl->s3->alpn_selected_len;
2882 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2883 const char *label, size_t llen,
2884 const unsigned char *context, size_t contextlen,
2887 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2890 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2892 contextlen, use_context);
2895 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2896 const char *label, size_t llen,
2897 const unsigned char *context,
2900 if (s->version != TLS1_3_VERSION)
2903 return tls13_export_keying_material_early(s, out, olen, label, llen,
2904 context, contextlen);
2907 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2909 const unsigned char *session_id = a->session_id;
2911 unsigned char tmp_storage[4];
2913 if (a->session_id_length < sizeof(tmp_storage)) {
2914 memset(tmp_storage, 0, sizeof(tmp_storage));
2915 memcpy(tmp_storage, a->session_id, a->session_id_length);
2916 session_id = tmp_storage;
2920 ((unsigned long)session_id[0]) |
2921 ((unsigned long)session_id[1] << 8L) |
2922 ((unsigned long)session_id[2] << 16L) |
2923 ((unsigned long)session_id[3] << 24L);
2928 * NB: If this function (or indeed the hash function which uses a sort of
2929 * coarser function than this one) is changed, ensure
2930 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2931 * being able to construct an SSL_SESSION that will collide with any existing
2932 * session with a matching session ID.
2934 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2936 if (a->ssl_version != b->ssl_version)
2938 if (a->session_id_length != b->session_id_length)
2940 return memcmp(a->session_id, b->session_id, a->session_id_length);
2944 * These wrapper functions should remain rather than redeclaring
2945 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2946 * variable. The reason is that the functions aren't static, they're exposed
2950 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2952 SSL_CTX *ret = NULL;
2955 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2959 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2962 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2963 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2966 ret = OPENSSL_zalloc(sizeof(*ret));
2971 ret->min_proto_version = 0;
2972 ret->max_proto_version = 0;
2973 ret->mode = SSL_MODE_AUTO_RETRY;
2974 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2975 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2976 /* We take the system default. */
2977 ret->session_timeout = meth->get_timeout();
2978 ret->references = 1;
2979 ret->lock = CRYPTO_THREAD_lock_new();
2980 if (ret->lock == NULL) {
2981 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2985 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2986 ret->verify_mode = SSL_VERIFY_NONE;
2987 if ((ret->cert = ssl_cert_new()) == NULL)
2990 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2991 if (ret->sessions == NULL)
2993 ret->cert_store = X509_STORE_new();
2994 if (ret->cert_store == NULL)
2996 #ifndef OPENSSL_NO_CT
2997 ret->ctlog_store = CTLOG_STORE_new();
2998 if (ret->ctlog_store == NULL)
3002 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
3005 if (!ssl_create_cipher_list(ret->method,
3006 ret->tls13_ciphersuites,
3007 &ret->cipher_list, &ret->cipher_list_by_id,
3008 SSL_DEFAULT_CIPHER_LIST, ret->cert)
3009 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
3010 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
3014 ret->param = X509_VERIFY_PARAM_new();
3015 if (ret->param == NULL)
3018 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
3019 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
3022 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
3023 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
3027 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
3030 if ((ret->client_ca_names = sk_X509_NAME_new_null()) == NULL)
3033 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
3036 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
3039 /* No compression for DTLS */
3040 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
3041 ret->comp_methods = SSL_COMP_get_compression_methods();
3043 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3044 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3046 /* Setup RFC5077 ticket keys */
3047 if ((RAND_bytes(ret->ext.tick_key_name,
3048 sizeof(ret->ext.tick_key_name)) <= 0)
3049 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
3050 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
3051 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
3052 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
3053 ret->options |= SSL_OP_NO_TICKET;
3055 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
3056 sizeof(ret->ext.cookie_hmac_key)) <= 0)
3059 #ifndef OPENSSL_NO_SRP
3060 if (!SSL_CTX_SRP_CTX_init(ret))
3063 #ifndef OPENSSL_NO_ENGINE
3064 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3065 # define eng_strx(x) #x
3066 # define eng_str(x) eng_strx(x)
3067 /* Use specific client engine automatically... ignore errors */
3070 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3073 ENGINE_load_builtin_engines();
3074 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3076 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3082 * Default is to connect to non-RI servers. When RI is more widely
3083 * deployed might change this.
3085 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3087 * Disable compression by default to prevent CRIME. Applications can
3088 * re-enable compression by configuring
3089 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3090 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3091 * middlebox compatibility by default. This may be disabled by default in
3092 * a later OpenSSL version.
3094 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3096 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3099 * We cannot usefully set a default max_early_data here (which gets
3100 * propagated in SSL_new(), for the following reason: setting the
3101 * SSL field causes tls_construct_stoc_early_data() to tell the
3102 * client that early data will be accepted when constructing a TLS 1.3
3103 * session ticket, and the client will accordingly send us early data
3104 * when using that ticket (if the client has early data to send).
3105 * However, in order for the early data to actually be consumed by
3106 * the application, the application must also have calls to
3107 * SSL_read_early_data(); otherwise we'll just skip past the early data
3108 * and ignore it. So, since the application must add calls to
3109 * SSL_read_early_data(), we also require them to add
3110 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3111 * eliminating the bandwidth-wasting early data in the case described
3114 ret->max_early_data = 0;
3117 * Default recv_max_early_data is a fully loaded single record. Could be
3118 * split across multiple records in practice. We set this differently to
3119 * max_early_data so that, in the default case, we do not advertise any
3120 * support for early_data, but if a client were to send us some (e.g.
3121 * because of an old, stale ticket) then we will tolerate it and skip over
3124 ret->recv_max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
3126 /* By default we send two session tickets automatically in TLSv1.3 */
3127 ret->num_tickets = 2;
3129 ssl_ctx_system_config(ret);
3133 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3139 int SSL_CTX_up_ref(SSL_CTX *ctx)
3143 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3146 REF_PRINT_COUNT("SSL_CTX", ctx);
3147 REF_ASSERT_ISNT(i < 2);
3148 return ((i > 1) ? 1 : 0);
3151 void SSL_CTX_free(SSL_CTX *a)
3158 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3159 REF_PRINT_COUNT("SSL_CTX", a);
3162 REF_ASSERT_ISNT(i < 0);
3164 X509_VERIFY_PARAM_free(a->param);
3165 dane_ctx_final(&a->dane);
3168 * Free internal session cache. However: the remove_cb() may reference
3169 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3170 * after the sessions were flushed.
3171 * As the ex_data handling routines might also touch the session cache,
3172 * the most secure solution seems to be: empty (flush) the cache, then
3173 * free ex_data, then finally free the cache.
3174 * (See ticket [openssl.org #212].)
3176 if (a->sessions != NULL)
3177 SSL_CTX_flush_sessions(a, 0);
3179 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3180 lh_SSL_SESSION_free(a->sessions);
3181 X509_STORE_free(a->cert_store);
3182 #ifndef OPENSSL_NO_CT
3183 CTLOG_STORE_free(a->ctlog_store);
3185 sk_SSL_CIPHER_free(a->cipher_list);
3186 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3187 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3188 ssl_cert_free(a->cert);
3189 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3190 sk_X509_NAME_pop_free(a->client_ca_names, X509_NAME_free);
3191 sk_X509_pop_free(a->extra_certs, X509_free);
3192 a->comp_methods = NULL;
3193 #ifndef OPENSSL_NO_SRTP
3194 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3196 #ifndef OPENSSL_NO_SRP
3197 SSL_CTX_SRP_CTX_free(a);
3199 #ifndef OPENSSL_NO_ENGINE
3200 ENGINE_finish(a->client_cert_engine);
3203 #ifndef OPENSSL_NO_EC
3204 OPENSSL_free(a->ext.ecpointformats);
3205 OPENSSL_free(a->ext.supportedgroups);
3207 OPENSSL_free(a->ext.alpn);
3208 OPENSSL_secure_free(a->ext.secure);
3210 CRYPTO_THREAD_lock_free(a->lock);
3215 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3217 ctx->default_passwd_callback = cb;
3220 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3222 ctx->default_passwd_callback_userdata = u;
3225 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3227 return ctx->default_passwd_callback;
3230 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3232 return ctx->default_passwd_callback_userdata;
3235 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3237 s->default_passwd_callback = cb;
3240 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3242 s->default_passwd_callback_userdata = u;
3245 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3247 return s->default_passwd_callback;
3250 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3252 return s->default_passwd_callback_userdata;
3255 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3256 int (*cb) (X509_STORE_CTX *, void *),
3259 ctx->app_verify_callback = cb;
3260 ctx->app_verify_arg = arg;
3263 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3264 int (*cb) (int, X509_STORE_CTX *))
3266 ctx->verify_mode = mode;
3267 ctx->default_verify_callback = cb;
3270 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3272 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3275 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3277 ssl_cert_set_cert_cb(c->cert, cb, arg);
3280 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3282 ssl_cert_set_cert_cb(s->cert, cb, arg);
3285 void ssl_set_masks(SSL *s)
3288 uint32_t *pvalid = s->s3->tmp.valid_flags;
3289 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3290 unsigned long mask_k, mask_a;
3291 #ifndef OPENSSL_NO_EC
3292 int have_ecc_cert, ecdsa_ok;
3297 #ifndef OPENSSL_NO_DH
3298 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3303 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3304 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3305 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3306 #ifndef OPENSSL_NO_EC
3307 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3313 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3314 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3317 #ifndef OPENSSL_NO_GOST
3318 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3319 mask_k |= SSL_kGOST;
3320 mask_a |= SSL_aGOST12;
3322 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3323 mask_k |= SSL_kGOST;
3324 mask_a |= SSL_aGOST12;
3326 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3327 mask_k |= SSL_kGOST;
3328 mask_a |= SSL_aGOST01;
3339 * If we only have an RSA-PSS certificate allow RSA authentication
3340 * if TLS 1.2 and peer supports it.
3343 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3344 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3345 && TLS1_get_version(s) == TLS1_2_VERSION))
3352 mask_a |= SSL_aNULL;
3355 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3356 * depending on the key usage extension.
3358 #ifndef OPENSSL_NO_EC
3359 if (have_ecc_cert) {
3361 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3362 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3363 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3366 mask_a |= SSL_aECDSA;
3368 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3369 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3370 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3371 && TLS1_get_version(s) == TLS1_2_VERSION)
3372 mask_a |= SSL_aECDSA;
3374 /* Allow Ed448 for TLS 1.2 if peer supports it */
3375 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3376 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3377 && TLS1_get_version(s) == TLS1_2_VERSION)
3378 mask_a |= SSL_aECDSA;
3381 #ifndef OPENSSL_NO_EC
3382 mask_k |= SSL_kECDHE;
3385 #ifndef OPENSSL_NO_PSK
3388 if (mask_k & SSL_kRSA)
3389 mask_k |= SSL_kRSAPSK;
3390 if (mask_k & SSL_kDHE)
3391 mask_k |= SSL_kDHEPSK;
3392 if (mask_k & SSL_kECDHE)
3393 mask_k |= SSL_kECDHEPSK;
3396 s->s3->tmp.mask_k = mask_k;
3397 s->s3->tmp.mask_a = mask_a;
3400 #ifndef OPENSSL_NO_EC
3402 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3404 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3405 /* key usage, if present, must allow signing */
3406 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3407 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3408 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3412 return 1; /* all checks are ok */
3417 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3418 size_t *serverinfo_length)
3420 CERT_PKEY *cpk = s->s3->tmp.cert;
3421 *serverinfo_length = 0;
3423 if (cpk == NULL || cpk->serverinfo == NULL)
3426 *serverinfo = cpk->serverinfo;
3427 *serverinfo_length = cpk->serverinfo_length;
3431 void ssl_update_cache(SSL *s, int mode)
3436 * If the session_id_length is 0, we are not supposed to cache it, and it
3437 * would be rather hard to do anyway :-)
3439 if (s->session->session_id_length == 0)
3443 * If sid_ctx_length is 0 there is no specific application context
3444 * associated with this session, so when we try to resume it and
3445 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3446 * indication that this is actually a session for the proper application
3447 * context, and the *handshake* will fail, not just the resumption attempt.
3448 * Do not cache (on the server) these sessions that are not resumable
3449 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3451 if (s->server && s->session->sid_ctx_length == 0
3452 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3455 i = s->session_ctx->session_cache_mode;
3457 && (!s->hit || SSL_IS_TLS13(s))) {
3459 * Add the session to the internal cache. In server side TLSv1.3 we
3460 * normally don't do this because by default it's a full stateless ticket
3461 * with only a dummy session id so there is no reason to cache it,
3463 * - we are doing early_data, in which case we cache so that we can
3465 * - the application has set a remove_session_cb so needs to know about
3466 * session timeout events
3467 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3469 if ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0
3470 && (!SSL_IS_TLS13(s)
3472 || (s->max_early_data > 0
3473 && (s->options & SSL_OP_NO_ANTI_REPLAY) == 0)
3474 || s->session_ctx->remove_session_cb != NULL
3475 || (s->options & SSL_OP_NO_TICKET) != 0))
3476 SSL_CTX_add_session(s->session_ctx, s->session);
3479 * Add the session to the external cache. We do this even in server side
3480 * TLSv1.3 without early data because some applications just want to
3481 * know about the creation of a session and aren't doing a full cache.
3483 if (s->session_ctx->new_session_cb != NULL) {
3484 SSL_SESSION_up_ref(s->session);
3485 if (!s->session_ctx->new_session_cb(s, s->session))
3486 SSL_SESSION_free(s->session);
3490 /* auto flush every 255 connections */
3491 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3492 TSAN_QUALIFIER int *stat;
3493 if (mode & SSL_SESS_CACHE_CLIENT)
3494 stat = &s->session_ctx->stats.sess_connect_good;
3496 stat = &s->session_ctx->stats.sess_accept_good;
3497 if ((tsan_load(stat) & 0xff) == 0xff)
3498 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3502 const SSL_METHOD *SSL_CTX_get_ssl_method(const SSL_CTX *ctx)
3507 const SSL_METHOD *SSL_get_ssl_method(const SSL *s)
3512 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3516 if (s->method != meth) {
3517 const SSL_METHOD *sm = s->method;
3518 int (*hf) (SSL *) = s->handshake_func;
3520 if (sm->version == meth->version)
3525 ret = s->method->ssl_new(s);
3528 if (hf == sm->ssl_connect)
3529 s->handshake_func = meth->ssl_connect;
3530 else if (hf == sm->ssl_accept)
3531 s->handshake_func = meth->ssl_accept;
3536 int SSL_get_error(const SSL *s, int i)
3543 return SSL_ERROR_NONE;
3546 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3547 * where we do encode the error
3549 if ((l = ERR_peek_error()) != 0) {
3550 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3551 return SSL_ERROR_SYSCALL;
3553 return SSL_ERROR_SSL;
3556 if (SSL_want_read(s)) {
3557 bio = SSL_get_rbio(s);
3558 if (BIO_should_read(bio))
3559 return SSL_ERROR_WANT_READ;
3560 else if (BIO_should_write(bio))
3562 * This one doesn't make too much sense ... We never try to write
3563 * to the rbio, and an application program where rbio and wbio
3564 * are separate couldn't even know what it should wait for.
3565 * However if we ever set s->rwstate incorrectly (so that we have
3566 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3567 * wbio *are* the same, this test works around that bug; so it
3568 * might be safer to keep it.
3570 return SSL_ERROR_WANT_WRITE;
3571 else if (BIO_should_io_special(bio)) {
3572 reason = BIO_get_retry_reason(bio);
3573 if (reason == BIO_RR_CONNECT)
3574 return SSL_ERROR_WANT_CONNECT;
3575 else if (reason == BIO_RR_ACCEPT)
3576 return SSL_ERROR_WANT_ACCEPT;
3578 return SSL_ERROR_SYSCALL; /* unknown */
3582 if (SSL_want_write(s)) {
3583 /* Access wbio directly - in order to use the buffered bio if present */
3585 if (BIO_should_write(bio))
3586 return SSL_ERROR_WANT_WRITE;
3587 else if (BIO_should_read(bio))
3589 * See above (SSL_want_read(s) with BIO_should_write(bio))
3591 return SSL_ERROR_WANT_READ;
3592 else if (BIO_should_io_special(bio)) {
3593 reason = BIO_get_retry_reason(bio);
3594 if (reason == BIO_RR_CONNECT)
3595 return SSL_ERROR_WANT_CONNECT;
3596 else if (reason == BIO_RR_ACCEPT)
3597 return SSL_ERROR_WANT_ACCEPT;
3599 return SSL_ERROR_SYSCALL;
3602 if (SSL_want_x509_lookup(s))
3603 return SSL_ERROR_WANT_X509_LOOKUP;
3604 if (SSL_want_async(s))
3605 return SSL_ERROR_WANT_ASYNC;
3606 if (SSL_want_async_job(s))
3607 return SSL_ERROR_WANT_ASYNC_JOB;
3608 if (SSL_want_client_hello_cb(s))
3609 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3611 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3612 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3613 return SSL_ERROR_ZERO_RETURN;
3615 return SSL_ERROR_SYSCALL;
3618 static int ssl_do_handshake_intern(void *vargs)
3620 struct ssl_async_args *args;
3623 args = (struct ssl_async_args *)vargs;
3626 return s->handshake_func(s);
3629 int SSL_do_handshake(SSL *s)
3633 if (s->handshake_func == NULL) {
3634 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3638 ossl_statem_check_finish_init(s, -1);
3640 s->method->ssl_renegotiate_check(s, 0);
3642 if (SSL_in_init(s) || SSL_in_before(s)) {
3643 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3644 struct ssl_async_args args;
3648 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3650 ret = s->handshake_func(s);
3656 void SSL_set_accept_state(SSL *s)
3660 ossl_statem_clear(s);
3661 s->handshake_func = s->method->ssl_accept;
3665 void SSL_set_connect_state(SSL *s)
3669 ossl_statem_clear(s);
3670 s->handshake_func = s->method->ssl_connect;
3674 int ssl_undefined_function(SSL *s)
3676 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3680 int ssl_undefined_void_function(void)
3682 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3683 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3687 int ssl_undefined_const_function(const SSL *s)
3692 const SSL_METHOD *ssl_bad_method(int ver)
3694 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3698 const char *ssl_protocol_to_string(int version)
3702 case TLS1_3_VERSION:
3705 case TLS1_2_VERSION:
3708 case TLS1_1_VERSION:
3723 case DTLS1_2_VERSION:
3731 const char *SSL_get_version(const SSL *s)
3733 return ssl_protocol_to_string(s->version);
3736 static int dup_ca_names(STACK_OF(X509_NAME) **dst, STACK_OF(X509_NAME) *src)
3738 STACK_OF(X509_NAME) *sk;
3747 if ((sk = sk_X509_NAME_new_null()) == NULL)
3749 for (i = 0; i < sk_X509_NAME_num(src); i++) {
3750 xn = X509_NAME_dup(sk_X509_NAME_value(src, i));
3752 sk_X509_NAME_pop_free(sk, X509_NAME_free);
3755 if (sk_X509_NAME_insert(sk, xn, i) == 0) {
3757 sk_X509_NAME_pop_free(sk, X509_NAME_free);
3766 SSL *SSL_dup(SSL *s)
3771 /* If we're not quiescent, just up_ref! */
3772 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3773 CRYPTO_UP_REF(&s->references, &i, s->lock);
3778 * Otherwise, copy configuration state, and session if set.
3780 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3783 if (s->session != NULL) {
3785 * Arranges to share the same session via up_ref. This "copies"
3786 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3788 if (!SSL_copy_session_id(ret, s))
3792 * No session has been established yet, so we have to expect that
3793 * s->cert or ret->cert will be changed later -- they should not both
3794 * point to the same object, and thus we can't use
3795 * SSL_copy_session_id.
3797 if (!SSL_set_ssl_method(ret, s->method))
3800 if (s->cert != NULL) {
3801 ssl_cert_free(ret->cert);
3802 ret->cert = ssl_cert_dup(s->cert);
3803 if (ret->cert == NULL)
3807 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3808 (int)s->sid_ctx_length))
3812 if (!ssl_dane_dup(ret, s))
3814 ret->version = s->version;
3815 ret->options = s->options;
3816 ret->mode = s->mode;
3817 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3818 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3819 ret->msg_callback = s->msg_callback;
3820 ret->msg_callback_arg = s->msg_callback_arg;
3821 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3822 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3823 ret->generate_session_id = s->generate_session_id;
3825 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3827 /* copy app data, a little dangerous perhaps */
3828 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3831 /* setup rbio, and wbio */
3832 if (s->rbio != NULL) {
3833 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3836 if (s->wbio != NULL) {
3837 if (s->wbio != s->rbio) {
3838 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3841 BIO_up_ref(ret->rbio);
3842 ret->wbio = ret->rbio;
3846 ret->server = s->server;
3847 if (s->handshake_func) {
3849 SSL_set_accept_state(ret);
3851 SSL_set_connect_state(ret);
3853 ret->shutdown = s->shutdown;
3856 ret->default_passwd_callback = s->default_passwd_callback;
3857 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3859 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3861 /* dup the cipher_list and cipher_list_by_id stacks */
3862 if (s->cipher_list != NULL) {
3863 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3866 if (s->cipher_list_by_id != NULL)
3867 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3871 /* Dup the client_CA list */
3872 if (!dup_ca_names(&ret->ca_names, s->ca_names)
3873 || !dup_ca_names(&ret->client_ca_names, s->client_ca_names))
3883 void ssl_clear_cipher_ctx(SSL *s)
3885 if (s->enc_read_ctx != NULL) {
3886 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3887 s->enc_read_ctx = NULL;
3889 if (s->enc_write_ctx != NULL) {
3890 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3891 s->enc_write_ctx = NULL;
3893 #ifndef OPENSSL_NO_COMP
3894 COMP_CTX_free(s->expand);
3896 COMP_CTX_free(s->compress);
3901 X509 *SSL_get_certificate(const SSL *s)
3903 if (s->cert != NULL)
3904 return s->cert->key->x509;
3909 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3911 if (s->cert != NULL)
3912 return s->cert->key->privatekey;
3917 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3919 if (ctx->cert != NULL)
3920 return ctx->cert->key->x509;
3925 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3927 if (ctx->cert != NULL)
3928 return ctx->cert->key->privatekey;
3933 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3935 if ((s->session != NULL) && (s->session->cipher != NULL))
3936 return s->session->cipher;
3940 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3942 return s->s3->tmp.new_cipher;
3945 const COMP_METHOD *SSL_get_current_compression(const SSL *s)
3947 #ifndef OPENSSL_NO_COMP
3948 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3954 const COMP_METHOD *SSL_get_current_expansion(const SSL *s)
3956 #ifndef OPENSSL_NO_COMP
3957 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3963 int ssl_init_wbio_buffer(SSL *s)
3967 if (s->bbio != NULL) {
3968 /* Already buffered. */
3972 bbio = BIO_new(BIO_f_buffer());
3973 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3975 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3979 s->wbio = BIO_push(bbio, s->wbio);
3984 int ssl_free_wbio_buffer(SSL *s)
3986 /* callers ensure s is never null */
3987 if (s->bbio == NULL)
3990 s->wbio = BIO_pop(s->wbio);
3997 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3999 ctx->quiet_shutdown = mode;
4002 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
4004 return ctx->quiet_shutdown;
4007 void SSL_set_quiet_shutdown(SSL *s, int mode)
4009 s->quiet_shutdown = mode;
4012 int SSL_get_quiet_shutdown(const SSL *s)
4014 return s->quiet_shutdown;
4017 void SSL_set_shutdown(SSL *s, int mode)
4022 int SSL_get_shutdown(const SSL *s)
4027 int SSL_version(const SSL *s)
4032 int SSL_client_version(const SSL *s)
4034 return s->client_version;
4037 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
4042 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
4045 if (ssl->ctx == ctx)
4048 ctx = ssl->session_ctx;
4049 new_cert = ssl_cert_dup(ctx->cert);
4050 if (new_cert == NULL) {
4054 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
4055 ssl_cert_free(new_cert);
4059 ssl_cert_free(ssl->cert);
4060 ssl->cert = new_cert;
4063 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
4064 * so setter APIs must prevent invalid lengths from entering the system.
4066 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
4070 * If the session ID context matches that of the parent SSL_CTX,
4071 * inherit it from the new SSL_CTX as well. If however the context does
4072 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4073 * leave it unchanged.
4075 if ((ssl->ctx != NULL) &&
4076 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
4077 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
4078 ssl->sid_ctx_length = ctx->sid_ctx_length;
4079 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
4082 SSL_CTX_up_ref(ctx);
4083 SSL_CTX_free(ssl->ctx); /* decrement reference count */
4089 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
4091 return X509_STORE_set_default_paths(ctx->cert_store);
4094 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
4096 X509_LOOKUP *lookup;
4098 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
4101 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
4103 /* Clear any errors if the default directory does not exist */
4109 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4111 X509_LOOKUP *lookup;
4113 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4117 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4119 /* Clear any errors if the default file does not exist */
4125 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4128 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4131 void SSL_set_info_callback(SSL *ssl,
4132 void (*cb) (const SSL *ssl, int type, int val))
4134 ssl->info_callback = cb;
4138 * One compiler (Diab DCC) doesn't like argument names in returned function
4141 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4144 return ssl->info_callback;
4147 void SSL_set_verify_result(SSL *ssl, long arg)
4149 ssl->verify_result = arg;
4152 long SSL_get_verify_result(const SSL *ssl)
4154 return ssl->verify_result;
4157 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4160 return sizeof(ssl->s3->client_random);
4161 if (outlen > sizeof(ssl->s3->client_random))
4162 outlen = sizeof(ssl->s3->client_random);
4163 memcpy(out, ssl->s3->client_random, outlen);
4167 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4170 return sizeof(ssl->s3->server_random);
4171 if (outlen > sizeof(ssl->s3->server_random))
4172 outlen = sizeof(ssl->s3->server_random);
4173 memcpy(out, ssl->s3->server_random, outlen);
4177 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4178 unsigned char *out, size_t outlen)
4181 return session->master_key_length;
4182 if (outlen > session->master_key_length)
4183 outlen = session->master_key_length;
4184 memcpy(out, session->master_key, outlen);
4188 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4191 if (len > sizeof(sess->master_key))
4194 memcpy(sess->master_key, in, len);
4195 sess->master_key_length = len;
4200 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4202 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4205 void *SSL_get_ex_data(const SSL *s, int idx)
4207 return CRYPTO_get_ex_data(&s->ex_data, idx);
4210 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4212 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4215 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4217 return CRYPTO_get_ex_data(&s->ex_data, idx);
4220 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4222 return ctx->cert_store;
4225 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4227 X509_STORE_free(ctx->cert_store);
4228 ctx->cert_store = store;
4231 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4234 X509_STORE_up_ref(store);
4235 SSL_CTX_set_cert_store(ctx, store);
4238 int SSL_want(const SSL *s)
4244 * \brief Set the callback for generating temporary DH keys.
4245 * \param ctx the SSL context.
4246 * \param dh the callback
4249 #ifndef OPENSSL_NO_DH
4250 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4251 DH *(*dh) (SSL *ssl, int is_export,
4254 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4257 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4260 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4264 #ifndef OPENSSL_NO_PSK
4265 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4267 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4268 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4271 OPENSSL_free(ctx->cert->psk_identity_hint);
4272 if (identity_hint != NULL) {
4273 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4274 if (ctx->cert->psk_identity_hint == NULL)
4277 ctx->cert->psk_identity_hint = NULL;
4281 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4286 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4287 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4290 OPENSSL_free(s->cert->psk_identity_hint);
4291 if (identity_hint != NULL) {
4292 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4293 if (s->cert->psk_identity_hint == NULL)
4296 s->cert->psk_identity_hint = NULL;
4300 const char *SSL_get_psk_identity_hint(const SSL *s)
4302 if (s == NULL || s->session == NULL)
4304 return s->session->psk_identity_hint;
4307 const char *SSL_get_psk_identity(const SSL *s)
4309 if (s == NULL || s->session == NULL)
4311 return s->session->psk_identity;
4314 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4316 s->psk_client_callback = cb;
4319 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4321 ctx->psk_client_callback = cb;
4324 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4326 s->psk_server_callback = cb;
4329 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4331 ctx->psk_server_callback = cb;
4335 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4337 s->psk_find_session_cb = cb;
4340 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4341 SSL_psk_find_session_cb_func cb)
4343 ctx->psk_find_session_cb = cb;
4346 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4348 s->psk_use_session_cb = cb;
4351 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4352 SSL_psk_use_session_cb_func cb)
4354 ctx->psk_use_session_cb = cb;
4357 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4358 void (*cb) (int write_p, int version,
4359 int content_type, const void *buf,
4360 size_t len, SSL *ssl, void *arg))
4362 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4365 void SSL_set_msg_callback(SSL *ssl,
4366 void (*cb) (int write_p, int version,
4367 int content_type, const void *buf,
4368 size_t len, SSL *ssl, void *arg))
4370 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4373 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4374 int (*cb) (SSL *ssl,
4378 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4379 (void (*)(void))cb);
4382 void SSL_set_not_resumable_session_callback(SSL *ssl,
4383 int (*cb) (SSL *ssl,
4384 int is_forward_secure))
4386 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4387 (void (*)(void))cb);
4390 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4391 size_t (*cb) (SSL *ssl, int type,
4392 size_t len, void *arg))
4394 ctx->record_padding_cb = cb;
4397 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4399 ctx->record_padding_arg = arg;
4402 void *SSL_CTX_get_record_padding_callback_arg(const SSL_CTX *ctx)
4404 return ctx->record_padding_arg;
4407 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4409 /* block size of 0 or 1 is basically no padding */
4410 if (block_size == 1)
4411 ctx->block_padding = 0;
4412 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4413 ctx->block_padding = block_size;
4419 void SSL_set_record_padding_callback(SSL *ssl,
4420 size_t (*cb) (SSL *ssl, int type,
4421 size_t len, void *arg))
4423 ssl->record_padding_cb = cb;
4426 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4428 ssl->record_padding_arg = arg;
4431 void *SSL_get_record_padding_callback_arg(const SSL *ssl)
4433 return ssl->record_padding_arg;
4436 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4438 /* block size of 0 or 1 is basically no padding */
4439 if (block_size == 1)
4440 ssl->block_padding = 0;
4441 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4442 ssl->block_padding = block_size;
4448 int SSL_set_num_tickets(SSL *s, size_t num_tickets)
4450 s->num_tickets = num_tickets;
4455 size_t SSL_get_num_tickets(const SSL *s)
4457 return s->num_tickets;
4460 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets)
4462 ctx->num_tickets = num_tickets;
4467 size_t SSL_CTX_get_num_tickets(const SSL_CTX *ctx)
4469 return ctx->num_tickets;
4473 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4474 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4475 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4476 * Returns the newly allocated ctx;
4479 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4481 ssl_clear_hash_ctx(hash);
4482 *hash = EVP_MD_CTX_new();
4483 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4484 EVP_MD_CTX_free(*hash);
4491 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4494 EVP_MD_CTX_free(*hash);
4498 /* Retrieve handshake hashes */
4499 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4502 EVP_MD_CTX *ctx = NULL;
4503 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4504 int hashleni = EVP_MD_CTX_size(hdgst);
4507 if (hashleni < 0 || (size_t)hashleni > outlen) {
4508 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4509 ERR_R_INTERNAL_ERROR);
4513 ctx = EVP_MD_CTX_new();
4517 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4518 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4519 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4520 ERR_R_INTERNAL_ERROR);
4524 *hashlen = hashleni;
4528 EVP_MD_CTX_free(ctx);
4532 int SSL_session_reused(SSL *s)
4537 int SSL_is_server(const SSL *s)
4542 #if !OPENSSL_API_1_1_0
4543 void SSL_set_debug(SSL *s, int debug)
4545 /* Old function was do-nothing anyway... */
4551 void SSL_set_security_level(SSL *s, int level)
4553 s->cert->sec_level = level;
4556 int SSL_get_security_level(const SSL *s)
4558 return s->cert->sec_level;
4561 void SSL_set_security_callback(SSL *s,
4562 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4563 int op, int bits, int nid,
4564 void *other, void *ex))
4566 s->cert->sec_cb = cb;
4569 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4570 const SSL_CTX *ctx, int op,
4571 int bits, int nid, void *other,
4573 return s->cert->sec_cb;
4576 void SSL_set0_security_ex_data(SSL *s, void *ex)
4578 s->cert->sec_ex = ex;
4581 void *SSL_get0_security_ex_data(const SSL *s)
4583 return s->cert->sec_ex;
4586 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4588 ctx->cert->sec_level = level;
4591 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4593 return ctx->cert->sec_level;
4596 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4597 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4598 int op, int bits, int nid,
4599 void *other, void *ex))
4601 ctx->cert->sec_cb = cb;
4604 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4610 return ctx->cert->sec_cb;
4613 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4615 ctx->cert->sec_ex = ex;
4618 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4620 return ctx->cert->sec_ex;
4624 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4625 * can return unsigned long, instead of the generic long return value from the
4626 * control interface.
4628 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4630 return ctx->options;
4633 unsigned long SSL_get_options(const SSL *s)
4638 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4640 return ctx->options |= op;
4643 unsigned long SSL_set_options(SSL *s, unsigned long op)
4645 return s->options |= op;
4648 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4650 return ctx->options &= ~op;
4653 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4655 return s->options &= ~op;
4658 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4660 return s->verified_chain;
4663 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4665 #ifndef OPENSSL_NO_CT
4668 * Moves SCTs from the |src| stack to the |dst| stack.
4669 * The source of each SCT will be set to |origin|.
4670 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4672 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4674 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4675 sct_source_t origin)
4681 *dst = sk_SCT_new_null();
4683 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4688 while ((sct = sk_SCT_pop(src)) != NULL) {
4689 if (SCT_set_source(sct, origin) != 1)
4692 if (sk_SCT_push(*dst, sct) <= 0)
4700 sk_SCT_push(src, sct); /* Put the SCT back */
4705 * Look for data collected during ServerHello and parse if found.
4706 * Returns the number of SCTs extracted.
4708 static int ct_extract_tls_extension_scts(SSL *s)
4710 int scts_extracted = 0;
4712 if (s->ext.scts != NULL) {
4713 const unsigned char *p = s->ext.scts;
4714 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4716 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4718 SCT_LIST_free(scts);
4721 return scts_extracted;
4725 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4726 * contains an SCT X509 extension. They will be stored in |s->scts|.
4728 * - The number of SCTs extracted, assuming an OCSP response exists.
4729 * - 0 if no OCSP response exists or it contains no SCTs.
4730 * - A negative integer if an error occurs.
4732 static int ct_extract_ocsp_response_scts(SSL *s)
4734 # ifndef OPENSSL_NO_OCSP
4735 int scts_extracted = 0;
4736 const unsigned char *p;
4737 OCSP_BASICRESP *br = NULL;
4738 OCSP_RESPONSE *rsp = NULL;
4739 STACK_OF(SCT) *scts = NULL;
4742 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4745 p = s->ext.ocsp.resp;
4746 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4750 br = OCSP_response_get1_basic(rsp);
4754 for (i = 0; i < OCSP_resp_count(br); ++i) {
4755 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4761 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4763 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4764 if (scts_extracted < 0)
4768 SCT_LIST_free(scts);
4769 OCSP_BASICRESP_free(br);
4770 OCSP_RESPONSE_free(rsp);
4771 return scts_extracted;
4773 /* Behave as if no OCSP response exists */
4779 * Attempts to extract SCTs from the peer certificate.
4780 * Return the number of SCTs extracted, or a negative integer if an error
4783 static int ct_extract_x509v3_extension_scts(SSL *s)
4785 int scts_extracted = 0;
4786 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4789 STACK_OF(SCT) *scts =
4790 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4793 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4795 SCT_LIST_free(scts);
4798 return scts_extracted;
4802 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4803 * response (if it exists) and X509v3 extensions in the certificate.
4804 * Returns NULL if an error occurs.
4806 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4808 if (!s->scts_parsed) {
4809 if (ct_extract_tls_extension_scts(s) < 0 ||
4810 ct_extract_ocsp_response_scts(s) < 0 ||
4811 ct_extract_x509v3_extension_scts(s) < 0)
4821 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4822 const STACK_OF(SCT) *scts, void *unused_arg)
4827 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4828 const STACK_OF(SCT) *scts, void *unused_arg)
4830 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4833 for (i = 0; i < count; ++i) {
4834 SCT *sct = sk_SCT_value(scts, i);
4835 int status = SCT_get_validation_status(sct);
4837 if (status == SCT_VALIDATION_STATUS_VALID)
4840 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4844 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4848 * Since code exists that uses the custom extension handler for CT, look
4849 * for this and throw an error if they have already registered to use CT.
4851 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4852 TLSEXT_TYPE_signed_certificate_timestamp))
4854 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4855 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4859 if (callback != NULL) {
4861 * If we are validating CT, then we MUST accept SCTs served via OCSP
4863 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4867 s->ct_validation_callback = callback;
4868 s->ct_validation_callback_arg = arg;
4873 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4874 ssl_ct_validation_cb callback, void *arg)
4877 * Since code exists that uses the custom extension handler for CT, look for
4878 * this and throw an error if they have already registered to use CT.
4880 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4881 TLSEXT_TYPE_signed_certificate_timestamp))
4883 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4884 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4888 ctx->ct_validation_callback = callback;
4889 ctx->ct_validation_callback_arg = arg;
4893 int SSL_ct_is_enabled(const SSL *s)
4895 return s->ct_validation_callback != NULL;
4898 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4900 return ctx->ct_validation_callback != NULL;
4903 int ssl_validate_ct(SSL *s)
4906 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4908 SSL_DANE *dane = &s->dane;
4909 CT_POLICY_EVAL_CTX *ctx = NULL;
4910 const STACK_OF(SCT) *scts;
4913 * If no callback is set, the peer is anonymous, or its chain is invalid,
4914 * skip SCT validation - just return success. Applications that continue
4915 * handshakes without certificates, with unverified chains, or pinned leaf
4916 * certificates are outside the scope of the WebPKI and CT.
4918 * The above exclusions notwithstanding the vast majority of peers will
4919 * have rather ordinary certificate chains validated by typical
4920 * applications that perform certificate verification and therefore will
4921 * process SCTs when enabled.
4923 if (s->ct_validation_callback == NULL || cert == NULL ||
4924 s->verify_result != X509_V_OK ||
4925 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4929 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4930 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4932 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4933 switch (dane->mtlsa->usage) {
4934 case DANETLS_USAGE_DANE_TA:
4935 case DANETLS_USAGE_DANE_EE:
4940 ctx = CT_POLICY_EVAL_CTX_new();
4942 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4943 ERR_R_MALLOC_FAILURE);
4947 issuer = sk_X509_value(s->verified_chain, 1);
4948 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4949 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4950 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4951 CT_POLICY_EVAL_CTX_set_time(
4952 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4954 scts = SSL_get0_peer_scts(s);
4957 * This function returns success (> 0) only when all the SCTs are valid, 0
4958 * when some are invalid, and < 0 on various internal errors (out of
4959 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4960 * reason to abort the handshake, that decision is up to the callback.
4961 * Therefore, we error out only in the unexpected case that the return
4962 * value is negative.
4964 * XXX: One might well argue that the return value of this function is an
4965 * unfortunate design choice. Its job is only to determine the validation
4966 * status of each of the provided SCTs. So long as it correctly separates
4967 * the wheat from the chaff it should return success. Failure in this case
4968 * ought to correspond to an inability to carry out its duties.
4970 if (SCT_LIST_validate(scts, ctx) < 0) {
4971 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4972 SSL_R_SCT_VERIFICATION_FAILED);
4976 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4978 ret = 0; /* This function returns 0 on failure */
4980 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4981 SSL_R_CALLBACK_FAILED);
4984 CT_POLICY_EVAL_CTX_free(ctx);
4986 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4987 * failure return code here. Also the application may wish the complete
4988 * the handshake, and then disconnect cleanly at a higher layer, after
4989 * checking the verification status of the completed connection.
4991 * We therefore force a certificate verification failure which will be
4992 * visible via SSL_get_verify_result() and cached as part of any resumed
4995 * Note: the permissive callback is for information gathering only, always
4996 * returns success, and does not affect verification status. Only the
4997 * strict callback or a custom application-specified callback can trigger
4998 * connection failure or record a verification error.
5001 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
5005 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
5007 switch (validation_mode) {
5009 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
5011 case SSL_CT_VALIDATION_PERMISSIVE:
5012 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
5013 case SSL_CT_VALIDATION_STRICT:
5014 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
5018 int SSL_enable_ct(SSL *s, int validation_mode)
5020 switch (validation_mode) {
5022 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
5024 case SSL_CT_VALIDATION_PERMISSIVE:
5025 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
5026 case SSL_CT_VALIDATION_STRICT:
5027 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
5031 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
5033 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
5036 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
5038 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
5041 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
5043 CTLOG_STORE_free(ctx->ctlog_store);
5044 ctx->ctlog_store = logs;
5047 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
5049 return ctx->ctlog_store;
5052 #endif /* OPENSSL_NO_CT */
5054 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
5057 c->client_hello_cb = cb;
5058 c->client_hello_cb_arg = arg;
5061 int SSL_client_hello_isv2(SSL *s)
5063 if (s->clienthello == NULL)
5065 return s->clienthello->isv2;
5068 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
5070 if (s->clienthello == NULL)
5072 return s->clienthello->legacy_version;
5075 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
5077 if (s->clienthello == NULL)
5080 *out = s->clienthello->random;
5081 return SSL3_RANDOM_SIZE;
5084 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
5086 if (s->clienthello == NULL)
5089 *out = s->clienthello->session_id;
5090 return s->clienthello->session_id_len;
5093 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
5095 if (s->clienthello == NULL)
5098 *out = PACKET_data(&s->clienthello->ciphersuites);
5099 return PACKET_remaining(&s->clienthello->ciphersuites);
5102 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
5104 if (s->clienthello == NULL)
5107 *out = s->clienthello->compressions;
5108 return s->clienthello->compressions_len;
5111 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5117 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5119 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5120 ext = s->clienthello->pre_proc_exts + i;
5124 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
5125 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
5126 ERR_R_MALLOC_FAILURE);
5129 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5130 ext = s->clienthello->pre_proc_exts + i;
5132 if (ext->received_order >= num)
5134 present[ext->received_order] = ext->type;
5141 OPENSSL_free(present);
5145 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5151 if (s->clienthello == NULL)
5153 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5154 r = s->clienthello->pre_proc_exts + i;
5155 if (r->present && r->type == type) {
5157 *out = PACKET_data(&r->data);
5159 *outlen = PACKET_remaining(&r->data);
5166 int SSL_free_buffers(SSL *ssl)
5168 RECORD_LAYER *rl = &ssl->rlayer;
5170 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5173 RECORD_LAYER_release(rl);
5177 int SSL_alloc_buffers(SSL *ssl)
5179 return ssl3_setup_buffers(ssl);
5182 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5184 ctx->keylog_callback = cb;
5187 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5189 return ctx->keylog_callback;
5192 static int nss_keylog_int(const char *prefix,
5194 const uint8_t *parameter_1,
5195 size_t parameter_1_len,
5196 const uint8_t *parameter_2,
5197 size_t parameter_2_len)
5200 char *cursor = NULL;
5205 if (ssl->ctx->keylog_callback == NULL)
5209 * Our output buffer will contain the following strings, rendered with
5210 * space characters in between, terminated by a NULL character: first the
5211 * prefix, then the first parameter, then the second parameter. The
5212 * meaning of each parameter depends on the specific key material being
5213 * logged. Note that the first and second parameters are encoded in
5214 * hexadecimal, so we need a buffer that is twice their lengths.
5216 prefix_len = strlen(prefix);
5217 out_len = prefix_len + (2 * parameter_1_len) + (2 * parameter_2_len) + 3;
5218 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5219 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5220 ERR_R_MALLOC_FAILURE);
5224 strcpy(cursor, prefix);
5225 cursor += prefix_len;
5228 for (i = 0; i < parameter_1_len; i++) {
5229 sprintf(cursor, "%02x", parameter_1[i]);
5234 for (i = 0; i < parameter_2_len; i++) {
5235 sprintf(cursor, "%02x", parameter_2[i]);
5240 ssl->ctx->keylog_callback(ssl, (const char *)out);
5241 OPENSSL_clear_free(out, out_len);
5246 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5247 const uint8_t *encrypted_premaster,
5248 size_t encrypted_premaster_len,
5249 const uint8_t *premaster,
5250 size_t premaster_len)
5252 if (encrypted_premaster_len < 8) {
5253 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5254 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5258 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5259 return nss_keylog_int("RSA",
5261 encrypted_premaster,
5267 int ssl_log_secret(SSL *ssl,
5269 const uint8_t *secret,
5272 return nss_keylog_int(label,
5274 ssl->s3->client_random,
5280 #define SSLV2_CIPHER_LEN 3
5282 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5286 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5288 if (PACKET_remaining(cipher_suites) == 0) {
5289 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5290 SSL_R_NO_CIPHERS_SPECIFIED);
5294 if (PACKET_remaining(cipher_suites) % n != 0) {
5295 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5296 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5300 OPENSSL_free(s->s3->tmp.ciphers_raw);
5301 s->s3->tmp.ciphers_raw = NULL;
5302 s->s3->tmp.ciphers_rawlen = 0;
5305 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5306 PACKET sslv2ciphers = *cipher_suites;
5307 unsigned int leadbyte;
5311 * We store the raw ciphers list in SSLv3+ format so we need to do some
5312 * preprocessing to convert the list first. If there are any SSLv2 only
5313 * ciphersuites with a non-zero leading byte then we are going to
5314 * slightly over allocate because we won't store those. But that isn't a
5317 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5318 s->s3->tmp.ciphers_raw = raw;
5320 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5321 ERR_R_MALLOC_FAILURE);
5324 for (s->s3->tmp.ciphers_rawlen = 0;
5325 PACKET_remaining(&sslv2ciphers) > 0;
5326 raw += TLS_CIPHER_LEN) {
5327 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5329 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5332 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5333 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5335 OPENSSL_free(s->s3->tmp.ciphers_raw);
5336 s->s3->tmp.ciphers_raw = NULL;
5337 s->s3->tmp.ciphers_rawlen = 0;
5341 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5343 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5344 &s->s3->tmp.ciphers_rawlen)) {
5345 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5346 ERR_R_INTERNAL_ERROR);
5352 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5353 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5354 STACK_OF(SSL_CIPHER) **scsvs)
5358 if (!PACKET_buf_init(&pkt, bytes, len))
5360 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5363 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5364 STACK_OF(SSL_CIPHER) **skp,
5365 STACK_OF(SSL_CIPHER) **scsvs_out,
5366 int sslv2format, int fatal)
5368 const SSL_CIPHER *c;
5369 STACK_OF(SSL_CIPHER) *sk = NULL;
5370 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5372 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5373 unsigned char cipher[SSLV2_CIPHER_LEN];
5375 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5377 if (PACKET_remaining(cipher_suites) == 0) {
5379 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5380 SSL_R_NO_CIPHERS_SPECIFIED);
5382 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5386 if (PACKET_remaining(cipher_suites) % n != 0) {
5388 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5389 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5391 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5392 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5396 sk = sk_SSL_CIPHER_new_null();
5397 scsvs = sk_SSL_CIPHER_new_null();
5398 if (sk == NULL || scsvs == NULL) {
5400 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5401 ERR_R_MALLOC_FAILURE);
5403 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5407 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5409 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5410 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5411 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5413 if (sslv2format && cipher[0] != '\0')
5416 /* For SSLv2-compat, ignore leading 0-byte. */
5417 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5419 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5420 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5422 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5423 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5425 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5430 if (PACKET_remaining(cipher_suites) > 0) {
5432 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5435 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5442 sk_SSL_CIPHER_free(sk);
5443 if (scsvs_out != NULL)
5446 sk_SSL_CIPHER_free(scsvs);
5449 sk_SSL_CIPHER_free(sk);
5450 sk_SSL_CIPHER_free(scsvs);
5454 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5456 ctx->max_early_data = max_early_data;
5461 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5463 return ctx->max_early_data;
5466 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5468 s->max_early_data = max_early_data;
5473 uint32_t SSL_get_max_early_data(const SSL *s)
5475 return s->max_early_data;
5478 int SSL_CTX_set_recv_max_early_data(SSL_CTX *ctx, uint32_t recv_max_early_data)
5480 ctx->recv_max_early_data = recv_max_early_data;
5485 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX *ctx)
5487 return ctx->recv_max_early_data;
5490 int SSL_set_recv_max_early_data(SSL *s, uint32_t recv_max_early_data)
5492 s->recv_max_early_data = recv_max_early_data;
5497 uint32_t SSL_get_recv_max_early_data(const SSL *s)
5499 return s->recv_max_early_data;
5502 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5504 /* Return any active Max Fragment Len extension */
5505 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5506 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5508 /* return current SSL connection setting */
5509 return ssl->max_send_fragment;
5512 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5514 /* Return a value regarding an active Max Fragment Len extension */
5515 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5516 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5517 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5519 /* else limit |split_send_fragment| to current |max_send_fragment| */
5520 if (ssl->split_send_fragment > ssl->max_send_fragment)
5521 return ssl->max_send_fragment;
5523 /* return current SSL connection setting */
5524 return ssl->split_send_fragment;
5527 int SSL_stateless(SSL *s)
5531 /* Ensure there is no state left over from a previous invocation */
5537 s->s3->flags |= TLS1_FLAGS_STATELESS;
5538 ret = SSL_accept(s);
5539 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5541 if (ret > 0 && s->ext.cookieok)
5544 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5550 void SSL_CTX_set_post_handshake_auth(SSL_CTX *ctx, int val)
5552 ctx->pha_enabled = val;
5555 void SSL_set_post_handshake_auth(SSL *ssl, int val)
5557 ssl->pha_enabled = val;
5560 int SSL_verify_client_post_handshake(SSL *ssl)
5562 if (!SSL_IS_TLS13(ssl)) {
5563 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5567 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5571 if (!SSL_is_init_finished(ssl)) {
5572 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5576 switch (ssl->post_handshake_auth) {
5578 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5581 case SSL_PHA_EXT_SENT:
5582 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5584 case SSL_PHA_EXT_RECEIVED:
5586 case SSL_PHA_REQUEST_PENDING:
5587 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5589 case SSL_PHA_REQUESTED:
5590 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5594 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5596 /* checks verify_mode and algorithm_auth */
5597 if (!send_certificate_request(ssl)) {
5598 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5599 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5603 ossl_statem_set_in_init(ssl, 1);
5607 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5608 SSL_CTX_generate_session_ticket_fn gen_cb,
5609 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5612 ctx->generate_ticket_cb = gen_cb;
5613 ctx->decrypt_ticket_cb = dec_cb;
5614 ctx->ticket_cb_data = arg;
5618 void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
5619 SSL_allow_early_data_cb_fn cb,
5622 ctx->allow_early_data_cb = cb;
5623 ctx->allow_early_data_cb_data = arg;
5626 void SSL_set_allow_early_data_cb(SSL *s,
5627 SSL_allow_early_data_cb_fn cb,
5630 s->allow_early_data_cb = cb;
5631 s->allow_early_data_cb_data = arg;