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 OpenSSL license (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
14 #include <openssl/objects.h>
15 #include <openssl/x509v3.h>
16 #include <openssl/rand.h>
17 #include <openssl/rand_drbg.h>
18 #include <openssl/ocsp.h>
19 #include <openssl/dh.h>
20 #include <openssl/engine.h>
21 #include <openssl/async.h>
22 #include <openssl/ct.h>
23 #include "internal/cryptlib.h"
24 #include "internal/refcount.h"
26 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
28 static int ssl_undefined_function_1(SSL *ssl, SSL3_RECORD *r, size_t s, int t)
33 return ssl_undefined_function(ssl);
36 static int ssl_undefined_function_2(SSL *ssl, SSL3_RECORD *r, unsigned char *s,
42 return ssl_undefined_function(ssl);
45 static int ssl_undefined_function_3(SSL *ssl, unsigned char *r,
46 unsigned char *s, size_t t, size_t *u)
52 return ssl_undefined_function(ssl);
55 static int ssl_undefined_function_4(SSL *ssl, int r)
58 return ssl_undefined_function(ssl);
61 static size_t ssl_undefined_function_5(SSL *ssl, const char *r, size_t s,
67 return ssl_undefined_function(ssl);
70 static int ssl_undefined_function_6(int r)
73 return ssl_undefined_function(NULL);
76 static int ssl_undefined_function_7(SSL *ssl, unsigned char *r, size_t s,
77 const char *t, size_t u,
78 const unsigned char *v, size_t w, int x)
87 return ssl_undefined_function(ssl);
90 SSL3_ENC_METHOD ssl3_undef_enc_method = {
91 ssl_undefined_function_1,
92 ssl_undefined_function_2,
93 ssl_undefined_function,
94 ssl_undefined_function_3,
95 ssl_undefined_function_4,
96 ssl_undefined_function_5,
97 NULL, /* client_finished_label */
98 0, /* client_finished_label_len */
99 NULL, /* server_finished_label */
100 0, /* server_finished_label_len */
101 ssl_undefined_function_6,
102 ssl_undefined_function_7,
105 struct ssl_async_args {
109 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
111 int (*func_read) (SSL *, void *, size_t, size_t *);
112 int (*func_write) (SSL *, const void *, size_t, size_t *);
113 int (*func_other) (SSL *);
117 static const struct {
123 DANETLS_MATCHING_FULL, 0, NID_undef
126 DANETLS_MATCHING_2256, 1, NID_sha256
129 DANETLS_MATCHING_2512, 2, NID_sha512
133 static int dane_ctx_enable(struct dane_ctx_st *dctx)
135 const EVP_MD **mdevp;
137 uint8_t mdmax = DANETLS_MATCHING_LAST;
138 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
141 if (dctx->mdevp != NULL)
144 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
145 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
147 if (mdord == NULL || mdevp == NULL) {
150 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
154 /* Install default entries */
155 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
158 if (dane_mds[i].nid == NID_undef ||
159 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
161 mdevp[dane_mds[i].mtype] = md;
162 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
172 static void dane_ctx_final(struct dane_ctx_st *dctx)
174 OPENSSL_free(dctx->mdevp);
177 OPENSSL_free(dctx->mdord);
182 static void tlsa_free(danetls_record *t)
186 OPENSSL_free(t->data);
187 EVP_PKEY_free(t->spki);
191 static void dane_final(SSL_DANE *dane)
193 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
196 sk_X509_pop_free(dane->certs, X509_free);
199 X509_free(dane->mcert);
207 * dane_copy - Copy dane configuration, sans verification state.
209 static int ssl_dane_dup(SSL *to, SSL *from)
214 if (!DANETLS_ENABLED(&from->dane))
217 num = sk_danetls_record_num(from->dane.trecs);
218 dane_final(&to->dane);
219 to->dane.flags = from->dane.flags;
220 to->dane.dctx = &to->ctx->dane;
221 to->dane.trecs = sk_danetls_record_new_reserve(NULL, num);
223 if (to->dane.trecs == NULL) {
224 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
228 for (i = 0; i < num; ++i) {
229 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
231 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
232 t->data, t->dlen) <= 0)
238 static int dane_mtype_set(struct dane_ctx_st *dctx,
239 const EVP_MD *md, uint8_t mtype, uint8_t ord)
243 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
244 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
248 if (mtype > dctx->mdmax) {
249 const EVP_MD **mdevp;
251 int n = ((int)mtype) + 1;
253 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
255 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
260 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
262 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
267 /* Zero-fill any gaps */
268 for (i = dctx->mdmax + 1; i < mtype; ++i) {
276 dctx->mdevp[mtype] = md;
277 /* Coerce ordinal of disabled matching types to 0 */
278 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
283 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
285 if (mtype > dane->dctx->mdmax)
287 return dane->dctx->mdevp[mtype];
290 static int dane_tlsa_add(SSL_DANE *dane,
293 uint8_t mtype, unsigned const char *data, size_t dlen)
296 const EVP_MD *md = NULL;
297 int ilen = (int)dlen;
301 if (dane->trecs == NULL) {
302 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
306 if (ilen < 0 || dlen != (size_t)ilen) {
307 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
311 if (usage > DANETLS_USAGE_LAST) {
312 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
316 if (selector > DANETLS_SELECTOR_LAST) {
317 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
321 if (mtype != DANETLS_MATCHING_FULL) {
322 md = tlsa_md_get(dane, mtype);
324 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
329 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
330 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
334 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
338 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
339 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
344 t->selector = selector;
346 t->data = OPENSSL_malloc(dlen);
347 if (t->data == NULL) {
349 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
352 memcpy(t->data, data, dlen);
355 /* Validate and cache full certificate or public key */
356 if (mtype == DANETLS_MATCHING_FULL) {
357 const unsigned char *p = data;
359 EVP_PKEY *pkey = NULL;
362 case DANETLS_SELECTOR_CERT:
363 if (!d2i_X509(&cert, &p, ilen) || p < data ||
364 dlen != (size_t)(p - data)) {
366 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
369 if (X509_get0_pubkey(cert) == NULL) {
371 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
375 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
381 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
382 * records that contain full certificates of trust-anchors that are
383 * not present in the wire chain. For usage PKIX-TA(0), we augment
384 * the chain with untrusted Full(0) certificates from DNS, in case
385 * they are missing from the chain.
387 if ((dane->certs == NULL &&
388 (dane->certs = sk_X509_new_null()) == NULL) ||
389 !sk_X509_push(dane->certs, cert)) {
390 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
397 case DANETLS_SELECTOR_SPKI:
398 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
399 dlen != (size_t)(p - data)) {
401 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
406 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
407 * records that contain full bare keys of trust-anchors that are
408 * not present in the wire chain.
410 if (usage == DANETLS_USAGE_DANE_TA)
419 * Find the right insertion point for the new record.
421 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
422 * they can be processed first, as they require no chain building, and no
423 * expiration or hostname checks. Because DANE-EE(3) is numerically
424 * largest, this is accomplished via descending sort by "usage".
426 * We also sort in descending order by matching ordinal to simplify
427 * the implementation of digest agility in the verification code.
429 * The choice of order for the selector is not significant, so we
430 * use the same descending order for consistency.
432 num = sk_danetls_record_num(dane->trecs);
433 for (i = 0; i < num; ++i) {
434 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
436 if (rec->usage > usage)
438 if (rec->usage < usage)
440 if (rec->selector > selector)
442 if (rec->selector < selector)
444 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
449 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
451 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
454 dane->umask |= DANETLS_USAGE_BIT(usage);
460 * Return 0 if there is only one version configured and it was disabled
461 * at configure time. Return 1 otherwise.
463 static int ssl_check_allowed_versions(int min_version, int max_version)
465 int minisdtls = 0, maxisdtls = 0;
467 /* Figure out if we're doing DTLS versions or TLS versions */
468 if (min_version == DTLS1_BAD_VER
469 || min_version >> 8 == DTLS1_VERSION_MAJOR)
471 if (max_version == DTLS1_BAD_VER
472 || max_version >> 8 == DTLS1_VERSION_MAJOR)
474 /* A wildcard version of 0 could be DTLS or TLS. */
475 if ((minisdtls && !maxisdtls && max_version != 0)
476 || (maxisdtls && !minisdtls && min_version != 0)) {
477 /* Mixing DTLS and TLS versions will lead to sadness; deny it. */
481 if (minisdtls || maxisdtls) {
482 /* Do DTLS version checks. */
483 if (min_version == 0)
484 /* Ignore DTLS1_BAD_VER */
485 min_version = DTLS1_VERSION;
486 if (max_version == 0)
487 max_version = DTLS1_2_VERSION;
488 #ifdef OPENSSL_NO_DTLS1_2
489 if (max_version == DTLS1_2_VERSION)
490 max_version = DTLS1_VERSION;
492 #ifdef OPENSSL_NO_DTLS1
493 if (min_version == DTLS1_VERSION)
494 min_version = DTLS1_2_VERSION;
496 /* Done massaging versions; do the check. */
498 #ifdef OPENSSL_NO_DTLS1
499 || (DTLS_VERSION_GE(min_version, DTLS1_VERSION)
500 && DTLS_VERSION_GE(DTLS1_VERSION, max_version))
502 #ifdef OPENSSL_NO_DTLS1_2
503 || (DTLS_VERSION_GE(min_version, DTLS1_2_VERSION)
504 && DTLS_VERSION_GE(DTLS1_2_VERSION, max_version))
509 /* Regular TLS version checks. */
510 if (min_version == 0)
511 min_version = SSL3_VERSION;
512 if (max_version == 0)
513 max_version = TLS1_3_VERSION;
514 #ifdef OPENSSL_NO_TLS1_3
515 if (max_version == TLS1_3_VERSION)
516 max_version = TLS1_2_VERSION;
518 #ifdef OPENSSL_NO_TLS1_2
519 if (max_version == TLS1_2_VERSION)
520 max_version = TLS1_1_VERSION;
522 #ifdef OPENSSL_NO_TLS1_1
523 if (max_version == TLS1_1_VERSION)
524 max_version = TLS1_VERSION;
526 #ifdef OPENSSL_NO_TLS1
527 if (max_version == TLS1_VERSION)
528 max_version = SSL3_VERSION;
530 #ifdef OPENSSL_NO_SSL3
531 if (min_version == SSL3_VERSION)
532 min_version = TLS1_VERSION;
534 #ifdef OPENSSL_NO_TLS1
535 if (min_version == TLS1_VERSION)
536 min_version = TLS1_1_VERSION;
538 #ifdef OPENSSL_NO_TLS1_1
539 if (min_version == TLS1_1_VERSION)
540 min_version = TLS1_2_VERSION;
542 #ifdef OPENSSL_NO_TLS1_2
543 if (min_version == TLS1_2_VERSION)
544 min_version = TLS1_3_VERSION;
546 /* Done massaging versions; do the check. */
548 #ifdef OPENSSL_NO_SSL3
549 || (min_version <= SSL3_VERSION && SSL3_VERSION <= max_version)
551 #ifdef OPENSSL_NO_TLS1
552 || (min_version <= TLS1_VERSION && TLS1_VERSION <= max_version)
554 #ifdef OPENSSL_NO_TLS1_1
555 || (min_version <= TLS1_1_VERSION && TLS1_1_VERSION <= max_version)
557 #ifdef OPENSSL_NO_TLS1_2
558 || (min_version <= TLS1_2_VERSION && TLS1_2_VERSION <= max_version)
560 #ifdef OPENSSL_NO_TLS1_3
561 || (min_version <= TLS1_3_VERSION && TLS1_3_VERSION <= max_version)
569 static void clear_ciphers(SSL *s)
571 /* clear the current cipher */
572 ssl_clear_cipher_ctx(s);
573 ssl_clear_hash_ctx(&s->read_hash);
574 ssl_clear_hash_ctx(&s->write_hash);
577 int SSL_clear(SSL *s)
579 if (s->method == NULL) {
580 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
584 if (ssl_clear_bad_session(s)) {
585 SSL_SESSION_free(s->session);
588 SSL_SESSION_free(s->psksession);
589 s->psksession = NULL;
590 OPENSSL_free(s->psksession_id);
591 s->psksession_id = NULL;
592 s->psksession_id_len = 0;
593 s->hello_retry_request = 0;
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 sk = ssl_create_cipher_list(ctx->method,
657 ctx->tls13_ciphersuites,
659 &(ctx->cipher_list_by_id),
660 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
661 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
662 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
668 SSL *SSL_new(SSL_CTX *ctx)
673 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
676 if (ctx->method == NULL) {
677 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
681 s = OPENSSL_zalloc(sizeof(*s));
686 s->lock = CRYPTO_THREAD_lock_new();
687 if (s->lock == NULL) {
693 RECORD_LAYER_init(&s->rlayer, s);
695 s->options = ctx->options;
696 s->dane.flags = ctx->dane.flags;
697 s->min_proto_version = ctx->min_proto_version;
698 s->max_proto_version = ctx->max_proto_version;
700 s->max_cert_list = ctx->max_cert_list;
701 s->max_early_data = ctx->max_early_data;
703 /* Shallow copy of the ciphersuites stack */
704 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
705 if (s->tls13_ciphersuites == NULL)
709 * Earlier library versions used to copy the pointer to the CERT, not
710 * its contents; only when setting new parameters for the per-SSL
711 * copy, ssl_cert_new would be called (and the direct reference to
712 * the per-SSL_CTX settings would be lost, but those still were
713 * indirectly accessed for various purposes, and for that reason they
714 * used to be known as s->ctx->default_cert). Now we don't look at the
715 * SSL_CTX's CERT after having duplicated it once.
717 s->cert = ssl_cert_dup(ctx->cert);
721 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
722 s->msg_callback = ctx->msg_callback;
723 s->msg_callback_arg = ctx->msg_callback_arg;
724 s->verify_mode = ctx->verify_mode;
725 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
726 s->record_padding_cb = ctx->record_padding_cb;
727 s->record_padding_arg = ctx->record_padding_arg;
728 s->block_padding = ctx->block_padding;
729 s->sid_ctx_length = ctx->sid_ctx_length;
730 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
732 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
733 s->verify_callback = ctx->default_verify_callback;
734 s->generate_session_id = ctx->generate_session_id;
736 s->param = X509_VERIFY_PARAM_new();
737 if (s->param == NULL)
739 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
740 s->quiet_shutdown = ctx->quiet_shutdown;
742 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
743 s->max_send_fragment = ctx->max_send_fragment;
744 s->split_send_fragment = ctx->split_send_fragment;
745 s->max_pipelines = ctx->max_pipelines;
746 if (s->max_pipelines > 1)
747 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
748 if (ctx->default_read_buf_len > 0)
749 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
754 s->ext.debug_arg = NULL;
755 s->ext.ticket_expected = 0;
756 s->ext.status_type = ctx->ext.status_type;
757 s->ext.status_expected = 0;
758 s->ext.ocsp.ids = NULL;
759 s->ext.ocsp.exts = NULL;
760 s->ext.ocsp.resp = NULL;
761 s->ext.ocsp.resp_len = 0;
763 s->session_ctx = ctx;
764 #ifndef OPENSSL_NO_EC
765 if (ctx->ext.ecpointformats) {
766 s->ext.ecpointformats =
767 OPENSSL_memdup(ctx->ext.ecpointformats,
768 ctx->ext.ecpointformats_len);
769 if (!s->ext.ecpointformats)
771 s->ext.ecpointformats_len =
772 ctx->ext.ecpointformats_len;
774 if (ctx->ext.supportedgroups) {
775 s->ext.supportedgroups =
776 OPENSSL_memdup(ctx->ext.supportedgroups,
777 ctx->ext.supportedgroups_len
778 * sizeof(*ctx->ext.supportedgroups));
779 if (!s->ext.supportedgroups)
781 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
784 #ifndef OPENSSL_NO_NEXTPROTONEG
788 if (s->ctx->ext.alpn) {
789 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
790 if (s->ext.alpn == NULL)
792 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
793 s->ext.alpn_len = s->ctx->ext.alpn_len;
796 s->verified_chain = NULL;
797 s->verify_result = X509_V_OK;
799 s->default_passwd_callback = ctx->default_passwd_callback;
800 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
802 s->method = ctx->method;
804 s->key_update = SSL_KEY_UPDATE_NONE;
806 if (!s->method->ssl_new(s))
809 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
814 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
817 #ifndef OPENSSL_NO_PSK
818 s->psk_client_callback = ctx->psk_client_callback;
819 s->psk_server_callback = ctx->psk_server_callback;
821 s->psk_find_session_cb = ctx->psk_find_session_cb;
822 s->psk_use_session_cb = ctx->psk_use_session_cb;
826 #ifndef OPENSSL_NO_CT
827 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
828 ctx->ct_validation_callback_arg))
835 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
839 int SSL_is_dtls(const SSL *s)
841 return SSL_IS_DTLS(s) ? 1 : 0;
844 int SSL_up_ref(SSL *s)
848 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
851 REF_PRINT_COUNT("SSL", s);
852 REF_ASSERT_ISNT(i < 2);
853 return ((i > 1) ? 1 : 0);
856 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
857 unsigned int sid_ctx_len)
859 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
860 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
861 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
864 ctx->sid_ctx_length = sid_ctx_len;
865 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
870 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
871 unsigned int sid_ctx_len)
873 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
874 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
875 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
878 ssl->sid_ctx_length = sid_ctx_len;
879 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
884 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
886 CRYPTO_THREAD_write_lock(ctx->lock);
887 ctx->generate_session_id = cb;
888 CRYPTO_THREAD_unlock(ctx->lock);
892 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
894 CRYPTO_THREAD_write_lock(ssl->lock);
895 ssl->generate_session_id = cb;
896 CRYPTO_THREAD_unlock(ssl->lock);
900 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
904 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
905 * we can "construct" a session to give us the desired check - i.e. to
906 * find if there's a session in the hash table that would conflict with
907 * any new session built out of this id/id_len and the ssl_version in use
912 if (id_len > sizeof(r.session_id))
915 r.ssl_version = ssl->version;
916 r.session_id_length = id_len;
917 memcpy(r.session_id, id, id_len);
919 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
920 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
921 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
925 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
927 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
930 int SSL_set_purpose(SSL *s, int purpose)
932 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
935 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
937 return X509_VERIFY_PARAM_set_trust(s->param, trust);
940 int SSL_set_trust(SSL *s, int trust)
942 return X509_VERIFY_PARAM_set_trust(s->param, trust);
945 int SSL_set1_host(SSL *s, const char *hostname)
947 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
950 int SSL_add1_host(SSL *s, const char *hostname)
952 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
955 void SSL_set_hostflags(SSL *s, unsigned int flags)
957 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
960 const char *SSL_get0_peername(SSL *s)
962 return X509_VERIFY_PARAM_get0_peername(s->param);
965 int SSL_CTX_dane_enable(SSL_CTX *ctx)
967 return dane_ctx_enable(&ctx->dane);
970 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
972 unsigned long orig = ctx->dane.flags;
974 ctx->dane.flags |= flags;
978 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
980 unsigned long orig = ctx->dane.flags;
982 ctx->dane.flags &= ~flags;
986 int SSL_dane_enable(SSL *s, const char *basedomain)
988 SSL_DANE *dane = &s->dane;
990 if (s->ctx->dane.mdmax == 0) {
991 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
994 if (dane->trecs != NULL) {
995 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1000 * Default SNI name. This rejects empty names, while set1_host below
1001 * accepts them and disables host name checks. To avoid side-effects with
1002 * invalid input, set the SNI name first.
1004 if (s->ext.hostname == NULL) {
1005 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1006 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1011 /* Primary RFC6125 reference identifier */
1012 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1013 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1019 dane->dctx = &s->ctx->dane;
1020 dane->trecs = sk_danetls_record_new_null();
1022 if (dane->trecs == NULL) {
1023 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1029 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1031 unsigned long orig = ssl->dane.flags;
1033 ssl->dane.flags |= flags;
1037 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1039 unsigned long orig = ssl->dane.flags;
1041 ssl->dane.flags &= ~flags;
1045 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1047 SSL_DANE *dane = &s->dane;
1049 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1053 *mcert = dane->mcert;
1055 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1060 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1061 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1063 SSL_DANE *dane = &s->dane;
1065 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1069 *usage = dane->mtlsa->usage;
1071 *selector = dane->mtlsa->selector;
1073 *mtype = dane->mtlsa->mtype;
1075 *data = dane->mtlsa->data;
1077 *dlen = dane->mtlsa->dlen;
1082 SSL_DANE *SSL_get0_dane(SSL *s)
1087 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1088 uint8_t mtype, unsigned const char *data, size_t dlen)
1090 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1093 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1096 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1099 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1101 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1104 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1106 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1109 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1114 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1119 void SSL_certs_clear(SSL *s)
1121 ssl_cert_clear_certs(s->cert);
1124 void SSL_free(SSL *s)
1130 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1131 REF_PRINT_COUNT("SSL", s);
1134 REF_ASSERT_ISNT(i < 0);
1136 X509_VERIFY_PARAM_free(s->param);
1137 dane_final(&s->dane);
1138 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1140 /* Ignore return value */
1141 ssl_free_wbio_buffer(s);
1143 BIO_free_all(s->wbio);
1144 BIO_free_all(s->rbio);
1146 BUF_MEM_free(s->init_buf);
1148 /* add extra stuff */
1149 sk_SSL_CIPHER_free(s->cipher_list);
1150 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1151 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1153 /* Make the next call work :-) */
1154 if (s->session != NULL) {
1155 ssl_clear_bad_session(s);
1156 SSL_SESSION_free(s->session);
1158 SSL_SESSION_free(s->psksession);
1159 OPENSSL_free(s->psksession_id);
1163 ssl_cert_free(s->cert);
1164 /* Free up if allocated */
1166 OPENSSL_free(s->ext.hostname);
1167 SSL_CTX_free(s->session_ctx);
1168 #ifndef OPENSSL_NO_EC
1169 OPENSSL_free(s->ext.ecpointformats);
1170 OPENSSL_free(s->ext.supportedgroups);
1171 #endif /* OPENSSL_NO_EC */
1172 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1173 #ifndef OPENSSL_NO_OCSP
1174 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1176 #ifndef OPENSSL_NO_CT
1177 SCT_LIST_free(s->scts);
1178 OPENSSL_free(s->ext.scts);
1180 OPENSSL_free(s->ext.ocsp.resp);
1181 OPENSSL_free(s->ext.alpn);
1182 OPENSSL_free(s->ext.tls13_cookie);
1183 OPENSSL_free(s->clienthello);
1184 OPENSSL_free(s->pha_context);
1185 EVP_MD_CTX_free(s->pha_dgst);
1187 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1189 sk_X509_pop_free(s->verified_chain, X509_free);
1191 if (s->method != NULL)
1192 s->method->ssl_free(s);
1194 RECORD_LAYER_release(&s->rlayer);
1196 SSL_CTX_free(s->ctx);
1198 ASYNC_WAIT_CTX_free(s->waitctx);
1200 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1201 OPENSSL_free(s->ext.npn);
1204 #ifndef OPENSSL_NO_SRTP
1205 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1208 CRYPTO_THREAD_lock_free(s->lock);
1213 void SSL_set0_rbio(SSL *s, BIO *rbio)
1215 BIO_free_all(s->rbio);
1219 void SSL_set0_wbio(SSL *s, BIO *wbio)
1222 * If the output buffering BIO is still in place, remove it
1224 if (s->bbio != NULL)
1225 s->wbio = BIO_pop(s->wbio);
1227 BIO_free_all(s->wbio);
1230 /* Re-attach |bbio| to the new |wbio|. */
1231 if (s->bbio != NULL)
1232 s->wbio = BIO_push(s->bbio, s->wbio);
1235 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1238 * For historical reasons, this function has many different cases in
1239 * ownership handling.
1242 /* If nothing has changed, do nothing */
1243 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1247 * If the two arguments are equal then one fewer reference is granted by the
1248 * caller than we want to take
1250 if (rbio != NULL && rbio == wbio)
1254 * If only the wbio is changed only adopt one reference.
1256 if (rbio == SSL_get_rbio(s)) {
1257 SSL_set0_wbio(s, wbio);
1261 * There is an asymmetry here for historical reasons. If only the rbio is
1262 * changed AND the rbio and wbio were originally different, then we only
1263 * adopt one reference.
1265 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1266 SSL_set0_rbio(s, rbio);
1270 /* Otherwise, adopt both references. */
1271 SSL_set0_rbio(s, rbio);
1272 SSL_set0_wbio(s, wbio);
1275 BIO *SSL_get_rbio(const SSL *s)
1280 BIO *SSL_get_wbio(const SSL *s)
1282 if (s->bbio != NULL) {
1284 * If |bbio| is active, the true caller-configured BIO is its
1287 return BIO_next(s->bbio);
1292 int SSL_get_fd(const SSL *s)
1294 return SSL_get_rfd(s);
1297 int SSL_get_rfd(const SSL *s)
1302 b = SSL_get_rbio(s);
1303 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1305 BIO_get_fd(r, &ret);
1309 int SSL_get_wfd(const SSL *s)
1314 b = SSL_get_wbio(s);
1315 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1317 BIO_get_fd(r, &ret);
1321 #ifndef OPENSSL_NO_SOCK
1322 int SSL_set_fd(SSL *s, int fd)
1327 bio = BIO_new(BIO_s_socket());
1330 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1333 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1334 SSL_set_bio(s, bio, bio);
1340 int SSL_set_wfd(SSL *s, int fd)
1342 BIO *rbio = SSL_get_rbio(s);
1344 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1345 || (int)BIO_get_fd(rbio, NULL) != fd) {
1346 BIO *bio = BIO_new(BIO_s_socket());
1349 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1352 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1353 SSL_set0_wbio(s, bio);
1356 SSL_set0_wbio(s, rbio);
1361 int SSL_set_rfd(SSL *s, int fd)
1363 BIO *wbio = SSL_get_wbio(s);
1365 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1366 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1367 BIO *bio = BIO_new(BIO_s_socket());
1370 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1373 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1374 SSL_set0_rbio(s, bio);
1377 SSL_set0_rbio(s, wbio);
1384 /* return length of latest Finished message we sent, copy to 'buf' */
1385 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1389 if (s->s3 != NULL) {
1390 ret = s->s3->tmp.finish_md_len;
1393 memcpy(buf, s->s3->tmp.finish_md, count);
1398 /* return length of latest Finished message we expected, copy to 'buf' */
1399 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1403 if (s->s3 != NULL) {
1404 ret = s->s3->tmp.peer_finish_md_len;
1407 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1412 int SSL_get_verify_mode(const SSL *s)
1414 return s->verify_mode;
1417 int SSL_get_verify_depth(const SSL *s)
1419 return X509_VERIFY_PARAM_get_depth(s->param);
1422 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1423 return s->verify_callback;
1426 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1428 return ctx->verify_mode;
1431 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1433 return X509_VERIFY_PARAM_get_depth(ctx->param);
1436 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1437 return ctx->default_verify_callback;
1440 void SSL_set_verify(SSL *s, int mode,
1441 int (*callback) (int ok, X509_STORE_CTX *ctx))
1443 s->verify_mode = mode;
1444 if (callback != NULL)
1445 s->verify_callback = callback;
1448 void SSL_set_verify_depth(SSL *s, int depth)
1450 X509_VERIFY_PARAM_set_depth(s->param, depth);
1453 void SSL_set_read_ahead(SSL *s, int yes)
1455 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1458 int SSL_get_read_ahead(const SSL *s)
1460 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1463 int SSL_pending(const SSL *s)
1465 size_t pending = s->method->ssl_pending(s);
1468 * SSL_pending cannot work properly if read-ahead is enabled
1469 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1470 * impossible to fix since SSL_pending cannot report errors that may be
1471 * observed while scanning the new data. (Note that SSL_pending() is
1472 * often used as a boolean value, so we'd better not return -1.)
1474 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1475 * we just return INT_MAX.
1477 return pending < INT_MAX ? (int)pending : INT_MAX;
1480 int SSL_has_pending(const SSL *s)
1483 * Similar to SSL_pending() but returns a 1 to indicate that we have
1484 * unprocessed data available or 0 otherwise (as opposed to the number of
1485 * bytes available). Unlike SSL_pending() this will take into account
1486 * read_ahead data. A 1 return simply indicates that we have unprocessed
1487 * data. That data may not result in any application data, or we may fail
1488 * to parse the records for some reason.
1490 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1493 return RECORD_LAYER_read_pending(&s->rlayer);
1496 X509 *SSL_get_peer_certificate(const SSL *s)
1500 if ((s == NULL) || (s->session == NULL))
1503 r = s->session->peer;
1513 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1517 if ((s == NULL) || (s->session == NULL))
1520 r = s->session->peer_chain;
1523 * If we are a client, cert_chain includes the peer's own certificate; if
1524 * we are a server, it does not.
1531 * Now in theory, since the calling process own 't' it should be safe to
1532 * modify. We need to be able to read f without being hassled
1534 int SSL_copy_session_id(SSL *t, const SSL *f)
1537 /* Do we need to to SSL locking? */
1538 if (!SSL_set_session(t, SSL_get_session(f))) {
1543 * what if we are setup for one protocol version but want to talk another
1545 if (t->method != f->method) {
1546 t->method->ssl_free(t);
1547 t->method = f->method;
1548 if (t->method->ssl_new(t) == 0)
1552 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1553 ssl_cert_free(t->cert);
1555 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1562 /* Fix this so it checks all the valid key/cert options */
1563 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1565 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1566 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1569 if (ctx->cert->key->privatekey == NULL) {
1570 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1573 return X509_check_private_key
1574 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1577 /* Fix this function so that it takes an optional type parameter */
1578 int SSL_check_private_key(const SSL *ssl)
1581 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1584 if (ssl->cert->key->x509 == NULL) {
1585 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1588 if (ssl->cert->key->privatekey == NULL) {
1589 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1592 return X509_check_private_key(ssl->cert->key->x509,
1593 ssl->cert->key->privatekey);
1596 int SSL_waiting_for_async(SSL *s)
1604 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1606 ASYNC_WAIT_CTX *ctx = s->waitctx;
1610 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1613 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1614 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1616 ASYNC_WAIT_CTX *ctx = s->waitctx;
1620 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1624 int SSL_accept(SSL *s)
1626 if (s->handshake_func == NULL) {
1627 /* Not properly initialized yet */
1628 SSL_set_accept_state(s);
1631 return SSL_do_handshake(s);
1634 int SSL_connect(SSL *s)
1636 if (s->handshake_func == NULL) {
1637 /* Not properly initialized yet */
1638 SSL_set_connect_state(s);
1641 return SSL_do_handshake(s);
1644 long SSL_get_default_timeout(const SSL *s)
1646 return s->method->get_timeout();
1649 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1650 int (*func) (void *))
1653 if (s->waitctx == NULL) {
1654 s->waitctx = ASYNC_WAIT_CTX_new();
1655 if (s->waitctx == NULL)
1658 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1659 sizeof(struct ssl_async_args))) {
1661 s->rwstate = SSL_NOTHING;
1662 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1665 s->rwstate = SSL_ASYNC_PAUSED;
1668 s->rwstate = SSL_ASYNC_NO_JOBS;
1674 s->rwstate = SSL_NOTHING;
1675 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1676 /* Shouldn't happen */
1681 static int ssl_io_intern(void *vargs)
1683 struct ssl_async_args *args;
1688 args = (struct ssl_async_args *)vargs;
1692 switch (args->type) {
1694 return args->f.func_read(s, buf, num, &s->asyncrw);
1696 return args->f.func_write(s, buf, num, &s->asyncrw);
1698 return args->f.func_other(s);
1703 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1705 if (s->handshake_func == NULL) {
1706 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1710 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1711 s->rwstate = SSL_NOTHING;
1715 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1716 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1717 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1721 * If we are a client and haven't received the ServerHello etc then we
1724 ossl_statem_check_finish_init(s, 0);
1726 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1727 struct ssl_async_args args;
1733 args.type = READFUNC;
1734 args.f.func_read = s->method->ssl_read;
1736 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1737 *readbytes = s->asyncrw;
1740 return s->method->ssl_read(s, buf, num, readbytes);
1744 int SSL_read(SSL *s, void *buf, int num)
1750 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1754 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1757 * The cast is safe here because ret should be <= INT_MAX because num is
1761 ret = (int)readbytes;
1766 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1768 int ret = ssl_read_internal(s, buf, num, readbytes);
1775 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1780 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1781 return SSL_READ_EARLY_DATA_ERROR;
1784 switch (s->early_data_state) {
1785 case SSL_EARLY_DATA_NONE:
1786 if (!SSL_in_before(s)) {
1787 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1788 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1789 return SSL_READ_EARLY_DATA_ERROR;
1793 case SSL_EARLY_DATA_ACCEPT_RETRY:
1794 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1795 ret = SSL_accept(s);
1798 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1799 return SSL_READ_EARLY_DATA_ERROR;
1803 case SSL_EARLY_DATA_READ_RETRY:
1804 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1805 s->early_data_state = SSL_EARLY_DATA_READING;
1806 ret = SSL_read_ex(s, buf, num, readbytes);
1808 * State machine will update early_data_state to
1809 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1812 if (ret > 0 || (ret <= 0 && s->early_data_state
1813 != SSL_EARLY_DATA_FINISHED_READING)) {
1814 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1815 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1816 : SSL_READ_EARLY_DATA_ERROR;
1819 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1822 return SSL_READ_EARLY_DATA_FINISH;
1825 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1826 return SSL_READ_EARLY_DATA_ERROR;
1830 int SSL_get_early_data_status(const SSL *s)
1832 return s->ext.early_data;
1835 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1837 if (s->handshake_func == NULL) {
1838 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1842 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1845 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1846 struct ssl_async_args args;
1852 args.type = READFUNC;
1853 args.f.func_read = s->method->ssl_peek;
1855 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1856 *readbytes = s->asyncrw;
1859 return s->method->ssl_peek(s, buf, num, readbytes);
1863 int SSL_peek(SSL *s, void *buf, int num)
1869 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1873 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1876 * The cast is safe here because ret should be <= INT_MAX because num is
1880 ret = (int)readbytes;
1886 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1888 int ret = ssl_peek_internal(s, buf, num, readbytes);
1895 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1897 if (s->handshake_func == NULL) {
1898 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1902 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1903 s->rwstate = SSL_NOTHING;
1904 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1908 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1909 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1910 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1911 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1914 /* If we are a client and haven't sent the Finished we better do that */
1915 ossl_statem_check_finish_init(s, 1);
1917 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1919 struct ssl_async_args args;
1922 args.buf = (void *)buf;
1924 args.type = WRITEFUNC;
1925 args.f.func_write = s->method->ssl_write;
1927 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1928 *written = s->asyncrw;
1931 return s->method->ssl_write(s, buf, num, written);
1935 int SSL_write(SSL *s, const void *buf, int num)
1941 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1945 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1948 * The cast is safe here because ret should be <= INT_MAX because num is
1957 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1959 int ret = ssl_write_internal(s, buf, num, written);
1966 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1968 int ret, early_data_state;
1970 uint32_t partialwrite;
1972 switch (s->early_data_state) {
1973 case SSL_EARLY_DATA_NONE:
1975 || !SSL_in_before(s)
1976 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1977 && (s->psk_use_session_cb == NULL))) {
1978 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1979 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1984 case SSL_EARLY_DATA_CONNECT_RETRY:
1985 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1986 ret = SSL_connect(s);
1989 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1994 case SSL_EARLY_DATA_WRITE_RETRY:
1995 s->early_data_state = SSL_EARLY_DATA_WRITING;
1997 * We disable partial write for early data because we don't keep track
1998 * of how many bytes we've written between the SSL_write_ex() call and
1999 * the flush if the flush needs to be retried)
2001 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2002 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2003 ret = SSL_write_ex(s, buf, num, &writtmp);
2004 s->mode |= partialwrite;
2006 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2009 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2012 case SSL_EARLY_DATA_WRITE_FLUSH:
2013 /* The buffering BIO is still in place so we need to flush it */
2014 if (statem_flush(s) != 1)
2017 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2020 case SSL_EARLY_DATA_FINISHED_READING:
2021 case SSL_EARLY_DATA_READ_RETRY:
2022 early_data_state = s->early_data_state;
2023 /* We are a server writing to an unauthenticated client */
2024 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2025 ret = SSL_write_ex(s, buf, num, written);
2026 s->early_data_state = early_data_state;
2030 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2035 int SSL_shutdown(SSL *s)
2038 * Note that this function behaves differently from what one might
2039 * expect. Return values are 0 for no success (yet), 1 for success; but
2040 * calling it once is usually not enough, even if blocking I/O is used
2041 * (see ssl3_shutdown).
2044 if (s->handshake_func == NULL) {
2045 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2049 if (!SSL_in_init(s)) {
2050 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2051 struct ssl_async_args args;
2054 args.type = OTHERFUNC;
2055 args.f.func_other = s->method->ssl_shutdown;
2057 return ssl_start_async_job(s, &args, ssl_io_intern);
2059 return s->method->ssl_shutdown(s);
2062 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2067 int SSL_key_update(SSL *s, int updatetype)
2070 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2071 * negotiated, and that it is appropriate to call SSL_key_update() instead
2072 * of SSL_renegotiate().
2074 if (!SSL_IS_TLS13(s)) {
2075 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2079 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2080 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2081 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2085 if (!SSL_is_init_finished(s)) {
2086 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2090 ossl_statem_set_in_init(s, 1);
2091 s->key_update = updatetype;
2095 int SSL_get_key_update_type(SSL *s)
2097 return s->key_update;
2100 int SSL_renegotiate(SSL *s)
2102 if (SSL_IS_TLS13(s)) {
2103 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2107 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2108 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2115 return s->method->ssl_renegotiate(s);
2118 int SSL_renegotiate_abbreviated(SSL *s)
2120 if (SSL_IS_TLS13(s)) {
2121 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2125 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2126 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2133 return s->method->ssl_renegotiate(s);
2136 int SSL_renegotiate_pending(SSL *s)
2139 * becomes true when negotiation is requested; false again once a
2140 * handshake has finished
2142 return (s->renegotiate != 0);
2145 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2150 case SSL_CTRL_GET_READ_AHEAD:
2151 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2152 case SSL_CTRL_SET_READ_AHEAD:
2153 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2154 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2157 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2158 s->msg_callback_arg = parg;
2162 return (s->mode |= larg);
2163 case SSL_CTRL_CLEAR_MODE:
2164 return (s->mode &= ~larg);
2165 case SSL_CTRL_GET_MAX_CERT_LIST:
2166 return (long)s->max_cert_list;
2167 case SSL_CTRL_SET_MAX_CERT_LIST:
2170 l = (long)s->max_cert_list;
2171 s->max_cert_list = (size_t)larg;
2173 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2174 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2176 s->max_send_fragment = larg;
2177 if (s->max_send_fragment < s->split_send_fragment)
2178 s->split_send_fragment = s->max_send_fragment;
2180 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2181 if ((size_t)larg > s->max_send_fragment || larg == 0)
2183 s->split_send_fragment = larg;
2185 case SSL_CTRL_SET_MAX_PIPELINES:
2186 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2188 s->max_pipelines = larg;
2190 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2192 case SSL_CTRL_GET_RI_SUPPORT:
2194 return s->s3->send_connection_binding;
2197 case SSL_CTRL_CERT_FLAGS:
2198 return (s->cert->cert_flags |= larg);
2199 case SSL_CTRL_CLEAR_CERT_FLAGS:
2200 return (s->cert->cert_flags &= ~larg);
2202 case SSL_CTRL_GET_RAW_CIPHERLIST:
2204 if (s->s3->tmp.ciphers_raw == NULL)
2206 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2207 return (int)s->s3->tmp.ciphers_rawlen;
2209 return TLS_CIPHER_LEN;
2211 case SSL_CTRL_GET_EXTMS_SUPPORT:
2212 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2214 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2218 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2219 return ssl_check_allowed_versions(larg, s->max_proto_version)
2220 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2221 &s->min_proto_version);
2222 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2223 return s->min_proto_version;
2224 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2225 return ssl_check_allowed_versions(s->min_proto_version, larg)
2226 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2227 &s->max_proto_version);
2228 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2229 return s->max_proto_version;
2231 return s->method->ssl_ctrl(s, cmd, larg, parg);
2235 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2238 case SSL_CTRL_SET_MSG_CALLBACK:
2239 s->msg_callback = (void (*)
2240 (int write_p, int version, int content_type,
2241 const void *buf, size_t len, SSL *ssl,
2246 return s->method->ssl_callback_ctrl(s, cmd, fp);
2250 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2252 return ctx->sessions;
2255 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2259 /* For some cases with ctx == NULL perform syntax checks */
2262 #ifndef OPENSSL_NO_EC
2263 case SSL_CTRL_SET_GROUPS_LIST:
2264 return tls1_set_groups_list(NULL, NULL, parg);
2266 case SSL_CTRL_SET_SIGALGS_LIST:
2267 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2268 return tls1_set_sigalgs_list(NULL, parg, 0);
2275 case SSL_CTRL_GET_READ_AHEAD:
2276 return ctx->read_ahead;
2277 case SSL_CTRL_SET_READ_AHEAD:
2278 l = ctx->read_ahead;
2279 ctx->read_ahead = larg;
2282 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2283 ctx->msg_callback_arg = parg;
2286 case SSL_CTRL_GET_MAX_CERT_LIST:
2287 return (long)ctx->max_cert_list;
2288 case SSL_CTRL_SET_MAX_CERT_LIST:
2291 l = (long)ctx->max_cert_list;
2292 ctx->max_cert_list = (size_t)larg;
2295 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2298 l = (long)ctx->session_cache_size;
2299 ctx->session_cache_size = (size_t)larg;
2301 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2302 return (long)ctx->session_cache_size;
2303 case SSL_CTRL_SET_SESS_CACHE_MODE:
2304 l = ctx->session_cache_mode;
2305 ctx->session_cache_mode = larg;
2307 case SSL_CTRL_GET_SESS_CACHE_MODE:
2308 return ctx->session_cache_mode;
2310 case SSL_CTRL_SESS_NUMBER:
2311 return lh_SSL_SESSION_num_items(ctx->sessions);
2312 case SSL_CTRL_SESS_CONNECT:
2313 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2315 case SSL_CTRL_SESS_CONNECT_GOOD:
2316 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2318 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2319 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2322 case SSL_CTRL_SESS_ACCEPT:
2323 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2325 case SSL_CTRL_SESS_ACCEPT_GOOD:
2326 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2328 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2329 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2332 case SSL_CTRL_SESS_HIT:
2333 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2335 case SSL_CTRL_SESS_CB_HIT:
2336 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2338 case SSL_CTRL_SESS_MISSES:
2339 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2341 case SSL_CTRL_SESS_TIMEOUTS:
2342 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2344 case SSL_CTRL_SESS_CACHE_FULL:
2345 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2348 return (ctx->mode |= larg);
2349 case SSL_CTRL_CLEAR_MODE:
2350 return (ctx->mode &= ~larg);
2351 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2352 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2354 ctx->max_send_fragment = larg;
2355 if (ctx->max_send_fragment < ctx->split_send_fragment)
2356 ctx->split_send_fragment = ctx->max_send_fragment;
2358 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2359 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2361 ctx->split_send_fragment = larg;
2363 case SSL_CTRL_SET_MAX_PIPELINES:
2364 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2366 ctx->max_pipelines = larg;
2368 case SSL_CTRL_CERT_FLAGS:
2369 return (ctx->cert->cert_flags |= larg);
2370 case SSL_CTRL_CLEAR_CERT_FLAGS:
2371 return (ctx->cert->cert_flags &= ~larg);
2372 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2373 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2374 && ssl_set_version_bound(ctx->method->version, (int)larg,
2375 &ctx->min_proto_version);
2376 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2377 return ctx->min_proto_version;
2378 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2379 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2380 && ssl_set_version_bound(ctx->method->version, (int)larg,
2381 &ctx->max_proto_version);
2382 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2383 return ctx->max_proto_version;
2385 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2389 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2392 case SSL_CTRL_SET_MSG_CALLBACK:
2393 ctx->msg_callback = (void (*)
2394 (int write_p, int version, int content_type,
2395 const void *buf, size_t len, SSL *ssl,
2400 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2404 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2413 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2414 const SSL_CIPHER *const *bp)
2416 if ((*ap)->id > (*bp)->id)
2418 if ((*ap)->id < (*bp)->id)
2423 /** return a STACK of the ciphers available for the SSL and in order of
2425 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2428 if (s->cipher_list != NULL) {
2429 return s->cipher_list;
2430 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2431 return s->ctx->cipher_list;
2437 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2439 if ((s == NULL) || (s->session == NULL) || !s->server)
2441 return s->session->ciphers;
2444 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2446 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2449 ciphers = SSL_get_ciphers(s);
2452 if (!ssl_set_client_disabled(s))
2454 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2455 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2456 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2458 sk = sk_SSL_CIPHER_new_null();
2461 if (!sk_SSL_CIPHER_push(sk, c)) {
2462 sk_SSL_CIPHER_free(sk);
2470 /** return a STACK of the ciphers available for the SSL and in order of
2472 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2475 if (s->cipher_list_by_id != NULL) {
2476 return s->cipher_list_by_id;
2477 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2478 return s->ctx->cipher_list_by_id;
2484 /** The old interface to get the same thing as SSL_get_ciphers() */
2485 const char *SSL_get_cipher_list(const SSL *s, int n)
2487 const SSL_CIPHER *c;
2488 STACK_OF(SSL_CIPHER) *sk;
2492 sk = SSL_get_ciphers(s);
2493 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2495 c = sk_SSL_CIPHER_value(sk, n);
2501 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2503 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2506 return ctx->cipher_list;
2510 /** specify the ciphers to be used by default by the SSL_CTX */
2511 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2513 STACK_OF(SSL_CIPHER) *sk;
2515 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2516 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2519 * ssl_create_cipher_list may return an empty stack if it was unable to
2520 * find a cipher matching the given rule string (for example if the rule
2521 * string specifies a cipher which has been disabled). This is not an
2522 * error as far as ssl_create_cipher_list is concerned, and hence
2523 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2527 else if (sk_SSL_CIPHER_num(sk) == 0) {
2528 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2534 /** specify the ciphers to be used by the SSL */
2535 int SSL_set_cipher_list(SSL *s, const char *str)
2537 STACK_OF(SSL_CIPHER) *sk;
2539 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2540 &s->cipher_list, &s->cipher_list_by_id, str,
2542 /* see comment in SSL_CTX_set_cipher_list */
2545 else if (sk_SSL_CIPHER_num(sk) == 0) {
2546 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2552 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2555 STACK_OF(SSL_CIPHER) *sk;
2556 const SSL_CIPHER *c;
2559 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2563 sk = s->session->ciphers;
2565 if (sk_SSL_CIPHER_num(sk) == 0)
2568 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2571 c = sk_SSL_CIPHER_value(sk, i);
2572 n = strlen(c->name);
2588 /** return a servername extension value if provided in Client Hello, or NULL.
2589 * So far, only host_name types are defined (RFC 3546).
2592 const char *SSL_get_servername(const SSL *s, const int type)
2594 if (type != TLSEXT_NAMETYPE_host_name)
2597 return s->session && !s->ext.hostname ?
2598 s->session->ext.hostname : s->ext.hostname;
2601 int SSL_get_servername_type(const SSL *s)
2604 && (!s->ext.hostname ? s->session->
2605 ext.hostname : s->ext.hostname))
2606 return TLSEXT_NAMETYPE_host_name;
2611 * SSL_select_next_proto implements the standard protocol selection. It is
2612 * expected that this function is called from the callback set by
2613 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2614 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2615 * not included in the length. A byte string of length 0 is invalid. No byte
2616 * string may be truncated. The current, but experimental algorithm for
2617 * selecting the protocol is: 1) If the server doesn't support NPN then this
2618 * is indicated to the callback. In this case, the client application has to
2619 * abort the connection or have a default application level protocol. 2) If
2620 * the server supports NPN, but advertises an empty list then the client
2621 * selects the first protocol in its list, but indicates via the API that this
2622 * fallback case was enacted. 3) Otherwise, the client finds the first
2623 * protocol in the server's list that it supports and selects this protocol.
2624 * This is because it's assumed that the server has better information about
2625 * which protocol a client should use. 4) If the client doesn't support any
2626 * of the server's advertised protocols, then this is treated the same as
2627 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2628 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2630 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2631 const unsigned char *server,
2632 unsigned int server_len,
2633 const unsigned char *client, unsigned int client_len)
2636 const unsigned char *result;
2637 int status = OPENSSL_NPN_UNSUPPORTED;
2640 * For each protocol in server preference order, see if we support it.
2642 for (i = 0; i < server_len;) {
2643 for (j = 0; j < client_len;) {
2644 if (server[i] == client[j] &&
2645 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2646 /* We found a match */
2647 result = &server[i];
2648 status = OPENSSL_NPN_NEGOTIATED;
2658 /* There's no overlap between our protocols and the server's list. */
2660 status = OPENSSL_NPN_NO_OVERLAP;
2663 *out = (unsigned char *)result + 1;
2664 *outlen = result[0];
2668 #ifndef OPENSSL_NO_NEXTPROTONEG
2670 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2671 * client's requested protocol for this connection and returns 0. If the
2672 * client didn't request any protocol, then *data is set to NULL. Note that
2673 * the client can request any protocol it chooses. The value returned from
2674 * this function need not be a member of the list of supported protocols
2675 * provided by the callback.
2677 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2684 *len = (unsigned int)s->ext.npn_len;
2689 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2690 * a TLS server needs a list of supported protocols for Next Protocol
2691 * Negotiation. The returned list must be in wire format. The list is
2692 * returned by setting |out| to point to it and |outlen| to its length. This
2693 * memory will not be modified, but one should assume that the SSL* keeps a
2694 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2695 * wishes to advertise. Otherwise, no such extension will be included in the
2698 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2699 SSL_CTX_npn_advertised_cb_func cb,
2702 ctx->ext.npn_advertised_cb = cb;
2703 ctx->ext.npn_advertised_cb_arg = arg;
2707 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2708 * client needs to select a protocol from the server's provided list. |out|
2709 * must be set to point to the selected protocol (which may be within |in|).
2710 * The length of the protocol name must be written into |outlen|. The
2711 * server's advertised protocols are provided in |in| and |inlen|. The
2712 * callback can assume that |in| is syntactically valid. The client must
2713 * select a protocol. It is fatal to the connection if this callback returns
2714 * a value other than SSL_TLSEXT_ERR_OK.
2716 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2717 SSL_CTX_npn_select_cb_func cb,
2720 ctx->ext.npn_select_cb = cb;
2721 ctx->ext.npn_select_cb_arg = arg;
2726 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2727 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2728 * length-prefixed strings). Returns 0 on success.
2730 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2731 unsigned int protos_len)
2733 OPENSSL_free(ctx->ext.alpn);
2734 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2735 if (ctx->ext.alpn == NULL) {
2736 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2739 ctx->ext.alpn_len = protos_len;
2745 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2746 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2747 * length-prefixed strings). Returns 0 on success.
2749 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2750 unsigned int protos_len)
2752 OPENSSL_free(ssl->ext.alpn);
2753 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2754 if (ssl->ext.alpn == NULL) {
2755 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2758 ssl->ext.alpn_len = protos_len;
2764 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2765 * called during ClientHello processing in order to select an ALPN protocol
2766 * from the client's list of offered protocols.
2768 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2769 SSL_CTX_alpn_select_cb_func cb,
2772 ctx->ext.alpn_select_cb = cb;
2773 ctx->ext.alpn_select_cb_arg = arg;
2777 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2778 * On return it sets |*data| to point to |*len| bytes of protocol name
2779 * (not including the leading length-prefix byte). If the server didn't
2780 * respond with a negotiated protocol then |*len| will be zero.
2782 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2787 *data = ssl->s3->alpn_selected;
2791 *len = (unsigned int)ssl->s3->alpn_selected_len;
2794 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2795 const char *label, size_t llen,
2796 const unsigned char *context, size_t contextlen,
2799 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2802 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2804 contextlen, use_context);
2807 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2808 const char *label, size_t llen,
2809 const unsigned char *context,
2812 if (s->version != TLS1_3_VERSION)
2815 return tls13_export_keying_material_early(s, out, olen, label, llen,
2816 context, contextlen);
2819 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2821 const unsigned char *session_id = a->session_id;
2823 unsigned char tmp_storage[4];
2825 if (a->session_id_length < sizeof(tmp_storage)) {
2826 memset(tmp_storage, 0, sizeof(tmp_storage));
2827 memcpy(tmp_storage, a->session_id, a->session_id_length);
2828 session_id = tmp_storage;
2832 ((unsigned long)session_id[0]) |
2833 ((unsigned long)session_id[1] << 8L) |
2834 ((unsigned long)session_id[2] << 16L) |
2835 ((unsigned long)session_id[3] << 24L);
2840 * NB: If this function (or indeed the hash function which uses a sort of
2841 * coarser function than this one) is changed, ensure
2842 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2843 * being able to construct an SSL_SESSION that will collide with any existing
2844 * session with a matching session ID.
2846 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2848 if (a->ssl_version != b->ssl_version)
2850 if (a->session_id_length != b->session_id_length)
2852 return memcmp(a->session_id, b->session_id, a->session_id_length);
2856 * These wrapper functions should remain rather than redeclaring
2857 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2858 * variable. The reason is that the functions aren't static, they're exposed
2862 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2864 SSL_CTX *ret = NULL;
2867 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2871 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2874 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2875 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2878 ret = OPENSSL_zalloc(sizeof(*ret));
2883 ret->min_proto_version = 0;
2884 ret->max_proto_version = 0;
2885 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2886 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2887 /* We take the system default. */
2888 ret->session_timeout = meth->get_timeout();
2889 ret->references = 1;
2890 ret->lock = CRYPTO_THREAD_lock_new();
2891 if (ret->lock == NULL) {
2892 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2896 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2897 ret->verify_mode = SSL_VERIFY_NONE;
2898 if ((ret->cert = ssl_cert_new()) == NULL)
2901 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2902 if (ret->sessions == NULL)
2904 ret->cert_store = X509_STORE_new();
2905 if (ret->cert_store == NULL)
2907 #ifndef OPENSSL_NO_CT
2908 ret->ctlog_store = CTLOG_STORE_new();
2909 if (ret->ctlog_store == NULL)
2913 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
2916 if (!ssl_create_cipher_list(ret->method,
2917 ret->tls13_ciphersuites,
2918 &ret->cipher_list, &ret->cipher_list_by_id,
2919 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2920 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2921 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2925 ret->param = X509_VERIFY_PARAM_new();
2926 if (ret->param == NULL)
2929 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2930 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2933 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2934 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2938 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2941 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2944 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
2947 /* No compression for DTLS */
2948 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2949 ret->comp_methods = SSL_COMP_get_compression_methods();
2951 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2952 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2954 /* Setup RFC5077 ticket keys */
2955 if ((RAND_bytes(ret->ext.tick_key_name,
2956 sizeof(ret->ext.tick_key_name)) <= 0)
2957 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
2958 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
2959 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
2960 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
2961 ret->options |= SSL_OP_NO_TICKET;
2963 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
2964 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2967 #ifndef OPENSSL_NO_SRP
2968 if (!SSL_CTX_SRP_CTX_init(ret))
2971 #ifndef OPENSSL_NO_ENGINE
2972 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2973 # define eng_strx(x) #x
2974 # define eng_str(x) eng_strx(x)
2975 /* Use specific client engine automatically... ignore errors */
2978 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2981 ENGINE_load_builtin_engines();
2982 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2984 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2990 * Default is to connect to non-RI servers. When RI is more widely
2991 * deployed might change this.
2993 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2995 * Disable compression by default to prevent CRIME. Applications can
2996 * re-enable compression by configuring
2997 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2998 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
2999 * middlebox compatibility by default. This may be disabled by default in
3000 * a later OpenSSL version.
3002 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3004 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3007 * We cannot usefully set a default max_early_data here (which gets
3008 * propagated in SSL_new(), for the following reason: setting the
3009 * SSL field causes tls_construct_stoc_early_data() to tell the
3010 * client that early data will be accepted when constructing a TLS 1.3
3011 * session ticket, and the client will accordingly send us early data
3012 * when using that ticket (if the client has early data to send).
3013 * However, in order for the early data to actually be consumed by
3014 * the application, the application must also have calls to
3015 * SSL_read_early_data(); otherwise we'll just skip past the early data
3016 * and ignore it. So, since the application must add calls to
3017 * SSL_read_early_data(), we also require them to add
3018 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3019 * eliminating the bandwidth-wasting early data in the case described
3022 ret->max_early_data = 0;
3024 ssl_ctx_system_config(ret);
3028 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3034 int SSL_CTX_up_ref(SSL_CTX *ctx)
3038 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3041 REF_PRINT_COUNT("SSL_CTX", ctx);
3042 REF_ASSERT_ISNT(i < 2);
3043 return ((i > 1) ? 1 : 0);
3046 void SSL_CTX_free(SSL_CTX *a)
3053 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3054 REF_PRINT_COUNT("SSL_CTX", a);
3057 REF_ASSERT_ISNT(i < 0);
3059 X509_VERIFY_PARAM_free(a->param);
3060 dane_ctx_final(&a->dane);
3063 * Free internal session cache. However: the remove_cb() may reference
3064 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3065 * after the sessions were flushed.
3066 * As the ex_data handling routines might also touch the session cache,
3067 * the most secure solution seems to be: empty (flush) the cache, then
3068 * free ex_data, then finally free the cache.
3069 * (See ticket [openssl.org #212].)
3071 if (a->sessions != NULL)
3072 SSL_CTX_flush_sessions(a, 0);
3074 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3075 lh_SSL_SESSION_free(a->sessions);
3076 X509_STORE_free(a->cert_store);
3077 #ifndef OPENSSL_NO_CT
3078 CTLOG_STORE_free(a->ctlog_store);
3080 sk_SSL_CIPHER_free(a->cipher_list);
3081 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3082 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3083 ssl_cert_free(a->cert);
3084 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3085 sk_X509_pop_free(a->extra_certs, X509_free);
3086 a->comp_methods = NULL;
3087 #ifndef OPENSSL_NO_SRTP
3088 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3090 #ifndef OPENSSL_NO_SRP
3091 SSL_CTX_SRP_CTX_free(a);
3093 #ifndef OPENSSL_NO_ENGINE
3094 ENGINE_finish(a->client_cert_engine);
3097 #ifndef OPENSSL_NO_EC
3098 OPENSSL_free(a->ext.ecpointformats);
3099 OPENSSL_free(a->ext.supportedgroups);
3101 OPENSSL_free(a->ext.alpn);
3102 OPENSSL_secure_free(a->ext.secure);
3104 CRYPTO_THREAD_lock_free(a->lock);
3109 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3111 ctx->default_passwd_callback = cb;
3114 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3116 ctx->default_passwd_callback_userdata = u;
3119 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3121 return ctx->default_passwd_callback;
3124 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3126 return ctx->default_passwd_callback_userdata;
3129 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3131 s->default_passwd_callback = cb;
3134 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3136 s->default_passwd_callback_userdata = u;
3139 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3141 return s->default_passwd_callback;
3144 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3146 return s->default_passwd_callback_userdata;
3149 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3150 int (*cb) (X509_STORE_CTX *, void *),
3153 ctx->app_verify_callback = cb;
3154 ctx->app_verify_arg = arg;
3157 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3158 int (*cb) (int, X509_STORE_CTX *))
3160 ctx->verify_mode = mode;
3161 ctx->default_verify_callback = cb;
3164 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3166 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3169 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3171 ssl_cert_set_cert_cb(c->cert, cb, arg);
3174 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3176 ssl_cert_set_cert_cb(s->cert, cb, arg);
3179 void ssl_set_masks(SSL *s)
3182 uint32_t *pvalid = s->s3->tmp.valid_flags;
3183 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3184 unsigned long mask_k, mask_a;
3185 #ifndef OPENSSL_NO_EC
3186 int have_ecc_cert, ecdsa_ok;
3191 #ifndef OPENSSL_NO_DH
3192 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3197 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3198 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3199 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3200 #ifndef OPENSSL_NO_EC
3201 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3207 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3208 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3211 #ifndef OPENSSL_NO_GOST
3212 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3213 mask_k |= SSL_kGOST;
3214 mask_a |= SSL_aGOST12;
3216 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3217 mask_k |= SSL_kGOST;
3218 mask_a |= SSL_aGOST12;
3220 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3221 mask_k |= SSL_kGOST;
3222 mask_a |= SSL_aGOST01;
3233 * If we only have an RSA-PSS certificate allow RSA authentication
3234 * if TLS 1.2 and peer supports it.
3237 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3238 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3239 && TLS1_get_version(s) == TLS1_2_VERSION))
3246 mask_a |= SSL_aNULL;
3249 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3250 * depending on the key usage extension.
3252 #ifndef OPENSSL_NO_EC
3253 if (have_ecc_cert) {
3255 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3256 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3257 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3260 mask_a |= SSL_aECDSA;
3262 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3263 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3264 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3265 && TLS1_get_version(s) == TLS1_2_VERSION)
3266 mask_a |= SSL_aECDSA;
3268 /* Allow Ed448 for TLS 1.2 if peer supports it */
3269 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3270 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3271 && TLS1_get_version(s) == TLS1_2_VERSION)
3272 mask_a |= SSL_aECDSA;
3275 #ifndef OPENSSL_NO_EC
3276 mask_k |= SSL_kECDHE;
3279 #ifndef OPENSSL_NO_PSK
3282 if (mask_k & SSL_kRSA)
3283 mask_k |= SSL_kRSAPSK;
3284 if (mask_k & SSL_kDHE)
3285 mask_k |= SSL_kDHEPSK;
3286 if (mask_k & SSL_kECDHE)
3287 mask_k |= SSL_kECDHEPSK;
3290 s->s3->tmp.mask_k = mask_k;
3291 s->s3->tmp.mask_a = mask_a;
3294 #ifndef OPENSSL_NO_EC
3296 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3298 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3299 /* key usage, if present, must allow signing */
3300 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3301 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3302 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3306 return 1; /* all checks are ok */
3311 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3312 size_t *serverinfo_length)
3314 CERT_PKEY *cpk = s->s3->tmp.cert;
3315 *serverinfo_length = 0;
3317 if (cpk == NULL || cpk->serverinfo == NULL)
3320 *serverinfo = cpk->serverinfo;
3321 *serverinfo_length = cpk->serverinfo_length;
3325 void ssl_update_cache(SSL *s, int mode)
3330 * If the session_id_length is 0, we are not supposed to cache it, and it
3331 * would be rather hard to do anyway :-)
3333 if (s->session->session_id_length == 0)
3337 * If sid_ctx_length is 0 there is no specific application context
3338 * associated with this session, so when we try to resume it and
3339 * SSL_VERIFY_PEER is requested, we have no indication that this is
3340 * actually a session for the proper application context, and the
3341 * *handshake* will fail, not just the resumption attempt.
3342 * Do not cache these sessions that are not resumable.
3344 if (s->session->sid_ctx_length == 0
3345 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3348 i = s->session_ctx->session_cache_mode;
3350 && (!s->hit || SSL_IS_TLS13(s))
3351 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) != 0
3352 || SSL_CTX_add_session(s->session_ctx, s->session))
3353 && s->session_ctx->new_session_cb != NULL) {
3354 SSL_SESSION_up_ref(s->session);
3355 if (!s->session_ctx->new_session_cb(s, s->session))
3356 SSL_SESSION_free(s->session);
3359 /* auto flush every 255 connections */
3360 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3362 if (mode & SSL_SESS_CACHE_CLIENT)
3363 stat = &s->session_ctx->stats.sess_connect_good;
3365 stat = &s->session_ctx->stats.sess_accept_good;
3366 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3367 && (val & 0xff) == 0xff)
3368 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3372 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3377 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3382 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3386 if (s->method != meth) {
3387 const SSL_METHOD *sm = s->method;
3388 int (*hf) (SSL *) = s->handshake_func;
3390 if (sm->version == meth->version)
3395 ret = s->method->ssl_new(s);
3398 if (hf == sm->ssl_connect)
3399 s->handshake_func = meth->ssl_connect;
3400 else if (hf == sm->ssl_accept)
3401 s->handshake_func = meth->ssl_accept;
3406 int SSL_get_error(const SSL *s, int i)
3413 return SSL_ERROR_NONE;
3416 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3417 * where we do encode the error
3419 if ((l = ERR_peek_error()) != 0) {
3420 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3421 return SSL_ERROR_SYSCALL;
3423 return SSL_ERROR_SSL;
3426 if (SSL_want_read(s)) {
3427 bio = SSL_get_rbio(s);
3428 if (BIO_should_read(bio))
3429 return SSL_ERROR_WANT_READ;
3430 else if (BIO_should_write(bio))
3432 * This one doesn't make too much sense ... We never try to write
3433 * to the rbio, and an application program where rbio and wbio
3434 * are separate couldn't even know what it should wait for.
3435 * However if we ever set s->rwstate incorrectly (so that we have
3436 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3437 * wbio *are* the same, this test works around that bug; so it
3438 * might be safer to keep it.
3440 return SSL_ERROR_WANT_WRITE;
3441 else if (BIO_should_io_special(bio)) {
3442 reason = BIO_get_retry_reason(bio);
3443 if (reason == BIO_RR_CONNECT)
3444 return SSL_ERROR_WANT_CONNECT;
3445 else if (reason == BIO_RR_ACCEPT)
3446 return SSL_ERROR_WANT_ACCEPT;
3448 return SSL_ERROR_SYSCALL; /* unknown */
3452 if (SSL_want_write(s)) {
3453 /* Access wbio directly - in order to use the buffered bio if present */
3455 if (BIO_should_write(bio))
3456 return SSL_ERROR_WANT_WRITE;
3457 else if (BIO_should_read(bio))
3459 * See above (SSL_want_read(s) with BIO_should_write(bio))
3461 return SSL_ERROR_WANT_READ;
3462 else if (BIO_should_io_special(bio)) {
3463 reason = BIO_get_retry_reason(bio);
3464 if (reason == BIO_RR_CONNECT)
3465 return SSL_ERROR_WANT_CONNECT;
3466 else if (reason == BIO_RR_ACCEPT)
3467 return SSL_ERROR_WANT_ACCEPT;
3469 return SSL_ERROR_SYSCALL;
3472 if (SSL_want_x509_lookup(s))
3473 return SSL_ERROR_WANT_X509_LOOKUP;
3474 if (SSL_want_async(s))
3475 return SSL_ERROR_WANT_ASYNC;
3476 if (SSL_want_async_job(s))
3477 return SSL_ERROR_WANT_ASYNC_JOB;
3478 if (SSL_want_client_hello_cb(s))
3479 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3481 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3482 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3483 return SSL_ERROR_ZERO_RETURN;
3485 return SSL_ERROR_SYSCALL;
3488 static int ssl_do_handshake_intern(void *vargs)
3490 struct ssl_async_args *args;
3493 args = (struct ssl_async_args *)vargs;
3496 return s->handshake_func(s);
3499 int SSL_do_handshake(SSL *s)
3503 if (s->handshake_func == NULL) {
3504 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3508 ossl_statem_check_finish_init(s, -1);
3510 s->method->ssl_renegotiate_check(s, 0);
3512 if (SSL_is_server(s)) {
3513 /* clear SNI settings at server-side */
3514 OPENSSL_free(s->ext.hostname);
3515 s->ext.hostname = NULL;
3518 if (SSL_in_init(s) || SSL_in_before(s)) {
3519 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3520 struct ssl_async_args args;
3524 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3526 ret = s->handshake_func(s);
3532 void SSL_set_accept_state(SSL *s)
3536 ossl_statem_clear(s);
3537 s->handshake_func = s->method->ssl_accept;
3541 void SSL_set_connect_state(SSL *s)
3545 ossl_statem_clear(s);
3546 s->handshake_func = s->method->ssl_connect;
3550 int ssl_undefined_function(SSL *s)
3552 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3556 int ssl_undefined_void_function(void)
3558 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3559 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3563 int ssl_undefined_const_function(const SSL *s)
3568 const SSL_METHOD *ssl_bad_method(int ver)
3570 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3574 const char *ssl_protocol_to_string(int version)
3578 case TLS1_3_VERSION:
3581 case TLS1_2_VERSION:
3584 case TLS1_1_VERSION:
3599 case DTLS1_2_VERSION:
3607 const char *SSL_get_version(const SSL *s)
3609 return ssl_protocol_to_string(s->version);
3612 SSL *SSL_dup(SSL *s)
3614 STACK_OF(X509_NAME) *sk;
3619 /* If we're not quiescent, just up_ref! */
3620 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3621 CRYPTO_UP_REF(&s->references, &i, s->lock);
3626 * Otherwise, copy configuration state, and session if set.
3628 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3631 if (s->session != NULL) {
3633 * Arranges to share the same session via up_ref. This "copies"
3634 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3636 if (!SSL_copy_session_id(ret, s))
3640 * No session has been established yet, so we have to expect that
3641 * s->cert or ret->cert will be changed later -- they should not both
3642 * point to the same object, and thus we can't use
3643 * SSL_copy_session_id.
3645 if (!SSL_set_ssl_method(ret, s->method))
3648 if (s->cert != NULL) {
3649 ssl_cert_free(ret->cert);
3650 ret->cert = ssl_cert_dup(s->cert);
3651 if (ret->cert == NULL)
3655 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3656 (int)s->sid_ctx_length))
3660 if (!ssl_dane_dup(ret, s))
3662 ret->version = s->version;
3663 ret->options = s->options;
3664 ret->mode = s->mode;
3665 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3666 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3667 ret->msg_callback = s->msg_callback;
3668 ret->msg_callback_arg = s->msg_callback_arg;
3669 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3670 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3671 ret->generate_session_id = s->generate_session_id;
3673 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3675 /* copy app data, a little dangerous perhaps */
3676 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3679 /* setup rbio, and wbio */
3680 if (s->rbio != NULL) {
3681 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3684 if (s->wbio != NULL) {
3685 if (s->wbio != s->rbio) {
3686 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3689 BIO_up_ref(ret->rbio);
3690 ret->wbio = ret->rbio;
3694 ret->server = s->server;
3695 if (s->handshake_func) {
3697 SSL_set_accept_state(ret);
3699 SSL_set_connect_state(ret);
3701 ret->shutdown = s->shutdown;
3704 ret->default_passwd_callback = s->default_passwd_callback;
3705 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3707 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3709 /* dup the cipher_list and cipher_list_by_id stacks */
3710 if (s->cipher_list != NULL) {
3711 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3714 if (s->cipher_list_by_id != NULL)
3715 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3719 /* Dup the client_CA list */
3720 if (s->ca_names != NULL) {
3721 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3724 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3725 xn = sk_X509_NAME_value(sk, i);
3726 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3739 void ssl_clear_cipher_ctx(SSL *s)
3741 if (s->enc_read_ctx != NULL) {
3742 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3743 s->enc_read_ctx = NULL;
3745 if (s->enc_write_ctx != NULL) {
3746 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3747 s->enc_write_ctx = NULL;
3749 #ifndef OPENSSL_NO_COMP
3750 COMP_CTX_free(s->expand);
3752 COMP_CTX_free(s->compress);
3757 X509 *SSL_get_certificate(const SSL *s)
3759 if (s->cert != NULL)
3760 return s->cert->key->x509;
3765 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3767 if (s->cert != NULL)
3768 return s->cert->key->privatekey;
3773 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3775 if (ctx->cert != NULL)
3776 return ctx->cert->key->x509;
3781 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3783 if (ctx->cert != NULL)
3784 return ctx->cert->key->privatekey;
3789 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3791 if ((s->session != NULL) && (s->session->cipher != NULL))
3792 return s->session->cipher;
3796 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3798 return s->s3->tmp.new_cipher;
3801 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3803 #ifndef OPENSSL_NO_COMP
3804 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3810 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3812 #ifndef OPENSSL_NO_COMP
3813 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3819 int ssl_init_wbio_buffer(SSL *s)
3823 if (s->bbio != NULL) {
3824 /* Already buffered. */
3828 bbio = BIO_new(BIO_f_buffer());
3829 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3831 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3835 s->wbio = BIO_push(bbio, s->wbio);
3840 int ssl_free_wbio_buffer(SSL *s)
3842 /* callers ensure s is never null */
3843 if (s->bbio == NULL)
3846 s->wbio = BIO_pop(s->wbio);
3847 if (!ossl_assert(s->wbio != NULL))
3855 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3857 ctx->quiet_shutdown = mode;
3860 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3862 return ctx->quiet_shutdown;
3865 void SSL_set_quiet_shutdown(SSL *s, int mode)
3867 s->quiet_shutdown = mode;
3870 int SSL_get_quiet_shutdown(const SSL *s)
3872 return s->quiet_shutdown;
3875 void SSL_set_shutdown(SSL *s, int mode)
3880 int SSL_get_shutdown(const SSL *s)
3885 int SSL_version(const SSL *s)
3890 int SSL_client_version(const SSL *s)
3892 return s->client_version;
3895 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3900 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3903 if (ssl->ctx == ctx)
3906 ctx = ssl->session_ctx;
3907 new_cert = ssl_cert_dup(ctx->cert);
3908 if (new_cert == NULL) {
3912 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3913 ssl_cert_free(new_cert);
3917 ssl_cert_free(ssl->cert);
3918 ssl->cert = new_cert;
3921 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3922 * so setter APIs must prevent invalid lengths from entering the system.
3924 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3928 * If the session ID context matches that of the parent SSL_CTX,
3929 * inherit it from the new SSL_CTX as well. If however the context does
3930 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3931 * leave it unchanged.
3933 if ((ssl->ctx != NULL) &&
3934 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3935 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3936 ssl->sid_ctx_length = ctx->sid_ctx_length;
3937 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3940 SSL_CTX_up_ref(ctx);
3941 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3947 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3949 return X509_STORE_set_default_paths(ctx->cert_store);
3952 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3954 X509_LOOKUP *lookup;
3956 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3959 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3961 /* Clear any errors if the default directory does not exist */
3967 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3969 X509_LOOKUP *lookup;
3971 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3975 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3977 /* Clear any errors if the default file does not exist */
3983 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3986 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
3989 void SSL_set_info_callback(SSL *ssl,
3990 void (*cb) (const SSL *ssl, int type, int val))
3992 ssl->info_callback = cb;
3996 * One compiler (Diab DCC) doesn't like argument names in returned function
3999 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4002 return ssl->info_callback;
4005 void SSL_set_verify_result(SSL *ssl, long arg)
4007 ssl->verify_result = arg;
4010 long SSL_get_verify_result(const SSL *ssl)
4012 return ssl->verify_result;
4015 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4018 return sizeof(ssl->s3->client_random);
4019 if (outlen > sizeof(ssl->s3->client_random))
4020 outlen = sizeof(ssl->s3->client_random);
4021 memcpy(out, ssl->s3->client_random, outlen);
4025 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4028 return sizeof(ssl->s3->server_random);
4029 if (outlen > sizeof(ssl->s3->server_random))
4030 outlen = sizeof(ssl->s3->server_random);
4031 memcpy(out, ssl->s3->server_random, outlen);
4035 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4036 unsigned char *out, size_t outlen)
4039 return session->master_key_length;
4040 if (outlen > session->master_key_length)
4041 outlen = session->master_key_length;
4042 memcpy(out, session->master_key, outlen);
4046 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4049 if (len > sizeof(sess->master_key))
4052 memcpy(sess->master_key, in, len);
4053 sess->master_key_length = len;
4058 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4060 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4063 void *SSL_get_ex_data(const SSL *s, int idx)
4065 return CRYPTO_get_ex_data(&s->ex_data, idx);
4068 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4070 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4073 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4075 return CRYPTO_get_ex_data(&s->ex_data, idx);
4078 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4080 return ctx->cert_store;
4083 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4085 X509_STORE_free(ctx->cert_store);
4086 ctx->cert_store = store;
4089 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4092 X509_STORE_up_ref(store);
4093 SSL_CTX_set_cert_store(ctx, store);
4096 int SSL_want(const SSL *s)
4102 * \brief Set the callback for generating temporary DH keys.
4103 * \param ctx the SSL context.
4104 * \param dh the callback
4107 #ifndef OPENSSL_NO_DH
4108 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4109 DH *(*dh) (SSL *ssl, int is_export,
4112 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4115 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4118 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4122 #ifndef OPENSSL_NO_PSK
4123 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4125 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4126 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4129 OPENSSL_free(ctx->cert->psk_identity_hint);
4130 if (identity_hint != NULL) {
4131 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4132 if (ctx->cert->psk_identity_hint == NULL)
4135 ctx->cert->psk_identity_hint = NULL;
4139 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4144 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4145 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4148 OPENSSL_free(s->cert->psk_identity_hint);
4149 if (identity_hint != NULL) {
4150 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4151 if (s->cert->psk_identity_hint == NULL)
4154 s->cert->psk_identity_hint = NULL;
4158 const char *SSL_get_psk_identity_hint(const SSL *s)
4160 if (s == NULL || s->session == NULL)
4162 return s->session->psk_identity_hint;
4165 const char *SSL_get_psk_identity(const SSL *s)
4167 if (s == NULL || s->session == NULL)
4169 return s->session->psk_identity;
4172 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4174 s->psk_client_callback = cb;
4177 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4179 ctx->psk_client_callback = cb;
4182 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4184 s->psk_server_callback = cb;
4187 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4189 ctx->psk_server_callback = cb;
4193 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4195 s->psk_find_session_cb = cb;
4198 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4199 SSL_psk_find_session_cb_func cb)
4201 ctx->psk_find_session_cb = cb;
4204 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4206 s->psk_use_session_cb = cb;
4209 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4210 SSL_psk_use_session_cb_func cb)
4212 ctx->psk_use_session_cb = cb;
4215 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4216 void (*cb) (int write_p, int version,
4217 int content_type, const void *buf,
4218 size_t len, SSL *ssl, void *arg))
4220 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4223 void SSL_set_msg_callback(SSL *ssl,
4224 void (*cb) (int write_p, int version,
4225 int content_type, const void *buf,
4226 size_t len, SSL *ssl, void *arg))
4228 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4231 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4232 int (*cb) (SSL *ssl,
4236 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4237 (void (*)(void))cb);
4240 void SSL_set_not_resumable_session_callback(SSL *ssl,
4241 int (*cb) (SSL *ssl,
4242 int is_forward_secure))
4244 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4245 (void (*)(void))cb);
4248 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4249 size_t (*cb) (SSL *ssl, int type,
4250 size_t len, void *arg))
4252 ctx->record_padding_cb = cb;
4255 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4257 ctx->record_padding_arg = arg;
4260 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4262 return ctx->record_padding_arg;
4265 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4267 /* block size of 0 or 1 is basically no padding */
4268 if (block_size == 1)
4269 ctx->block_padding = 0;
4270 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4271 ctx->block_padding = block_size;
4277 void SSL_set_record_padding_callback(SSL *ssl,
4278 size_t (*cb) (SSL *ssl, int type,
4279 size_t len, void *arg))
4281 ssl->record_padding_cb = cb;
4284 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4286 ssl->record_padding_arg = arg;
4289 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4291 return ssl->record_padding_arg;
4294 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4296 /* block size of 0 or 1 is basically no padding */
4297 if (block_size == 1)
4298 ssl->block_padding = 0;
4299 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4300 ssl->block_padding = block_size;
4307 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4308 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4309 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4310 * Returns the newly allocated ctx;
4313 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4315 ssl_clear_hash_ctx(hash);
4316 *hash = EVP_MD_CTX_new();
4317 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4318 EVP_MD_CTX_free(*hash);
4325 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4328 EVP_MD_CTX_free(*hash);
4332 /* Retrieve handshake hashes */
4333 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4336 EVP_MD_CTX *ctx = NULL;
4337 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4338 int hashleni = EVP_MD_CTX_size(hdgst);
4341 if (hashleni < 0 || (size_t)hashleni > outlen) {
4342 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4343 ERR_R_INTERNAL_ERROR);
4347 ctx = EVP_MD_CTX_new();
4351 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4352 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4353 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4354 ERR_R_INTERNAL_ERROR);
4358 *hashlen = hashleni;
4362 EVP_MD_CTX_free(ctx);
4366 int SSL_session_reused(SSL *s)
4371 int SSL_is_server(const SSL *s)
4376 #if OPENSSL_API_COMPAT < 0x10100000L
4377 void SSL_set_debug(SSL *s, int debug)
4379 /* Old function was do-nothing anyway... */
4385 void SSL_set_security_level(SSL *s, int level)
4387 s->cert->sec_level = level;
4390 int SSL_get_security_level(const SSL *s)
4392 return s->cert->sec_level;
4395 void SSL_set_security_callback(SSL *s,
4396 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4397 int op, int bits, int nid,
4398 void *other, void *ex))
4400 s->cert->sec_cb = cb;
4403 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4404 const SSL_CTX *ctx, int op,
4405 int bits, int nid, void *other,
4407 return s->cert->sec_cb;
4410 void SSL_set0_security_ex_data(SSL *s, void *ex)
4412 s->cert->sec_ex = ex;
4415 void *SSL_get0_security_ex_data(const SSL *s)
4417 return s->cert->sec_ex;
4420 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4422 ctx->cert->sec_level = level;
4425 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4427 return ctx->cert->sec_level;
4430 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4431 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4432 int op, int bits, int nid,
4433 void *other, void *ex))
4435 ctx->cert->sec_cb = cb;
4438 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4444 return ctx->cert->sec_cb;
4447 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4449 ctx->cert->sec_ex = ex;
4452 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4454 return ctx->cert->sec_ex;
4458 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4459 * can return unsigned long, instead of the generic long return value from the
4460 * control interface.
4462 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4464 return ctx->options;
4467 unsigned long SSL_get_options(const SSL *s)
4472 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4474 return ctx->options |= op;
4477 unsigned long SSL_set_options(SSL *s, unsigned long op)
4479 return s->options |= op;
4482 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4484 return ctx->options &= ~op;
4487 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4489 return s->options &= ~op;
4492 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4494 return s->verified_chain;
4497 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4499 #ifndef OPENSSL_NO_CT
4502 * Moves SCTs from the |src| stack to the |dst| stack.
4503 * The source of each SCT will be set to |origin|.
4504 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4506 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4508 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4509 sct_source_t origin)
4515 *dst = sk_SCT_new_null();
4517 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4522 while ((sct = sk_SCT_pop(src)) != NULL) {
4523 if (SCT_set_source(sct, origin) != 1)
4526 if (sk_SCT_push(*dst, sct) <= 0)
4534 sk_SCT_push(src, sct); /* Put the SCT back */
4539 * Look for data collected during ServerHello and parse if found.
4540 * Returns the number of SCTs extracted.
4542 static int ct_extract_tls_extension_scts(SSL *s)
4544 int scts_extracted = 0;
4546 if (s->ext.scts != NULL) {
4547 const unsigned char *p = s->ext.scts;
4548 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4550 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4552 SCT_LIST_free(scts);
4555 return scts_extracted;
4559 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4560 * contains an SCT X509 extension. They will be stored in |s->scts|.
4562 * - The number of SCTs extracted, assuming an OCSP response exists.
4563 * - 0 if no OCSP response exists or it contains no SCTs.
4564 * - A negative integer if an error occurs.
4566 static int ct_extract_ocsp_response_scts(SSL *s)
4568 # ifndef OPENSSL_NO_OCSP
4569 int scts_extracted = 0;
4570 const unsigned char *p;
4571 OCSP_BASICRESP *br = NULL;
4572 OCSP_RESPONSE *rsp = NULL;
4573 STACK_OF(SCT) *scts = NULL;
4576 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4579 p = s->ext.ocsp.resp;
4580 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4584 br = OCSP_response_get1_basic(rsp);
4588 for (i = 0; i < OCSP_resp_count(br); ++i) {
4589 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4595 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4597 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4598 if (scts_extracted < 0)
4602 SCT_LIST_free(scts);
4603 OCSP_BASICRESP_free(br);
4604 OCSP_RESPONSE_free(rsp);
4605 return scts_extracted;
4607 /* Behave as if no OCSP response exists */
4613 * Attempts to extract SCTs from the peer certificate.
4614 * Return the number of SCTs extracted, or a negative integer if an error
4617 static int ct_extract_x509v3_extension_scts(SSL *s)
4619 int scts_extracted = 0;
4620 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4623 STACK_OF(SCT) *scts =
4624 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4627 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4629 SCT_LIST_free(scts);
4632 return scts_extracted;
4636 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4637 * response (if it exists) and X509v3 extensions in the certificate.
4638 * Returns NULL if an error occurs.
4640 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4642 if (!s->scts_parsed) {
4643 if (ct_extract_tls_extension_scts(s) < 0 ||
4644 ct_extract_ocsp_response_scts(s) < 0 ||
4645 ct_extract_x509v3_extension_scts(s) < 0)
4655 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4656 const STACK_OF(SCT) *scts, void *unused_arg)
4661 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4662 const STACK_OF(SCT) *scts, void *unused_arg)
4664 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4667 for (i = 0; i < count; ++i) {
4668 SCT *sct = sk_SCT_value(scts, i);
4669 int status = SCT_get_validation_status(sct);
4671 if (status == SCT_VALIDATION_STATUS_VALID)
4674 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4678 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4682 * Since code exists that uses the custom extension handler for CT, look
4683 * for this and throw an error if they have already registered to use CT.
4685 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4686 TLSEXT_TYPE_signed_certificate_timestamp))
4688 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4689 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4693 if (callback != NULL) {
4695 * If we are validating CT, then we MUST accept SCTs served via OCSP
4697 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4701 s->ct_validation_callback = callback;
4702 s->ct_validation_callback_arg = arg;
4707 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4708 ssl_ct_validation_cb callback, void *arg)
4711 * Since code exists that uses the custom extension handler for CT, look for
4712 * this and throw an error if they have already registered to use CT.
4714 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4715 TLSEXT_TYPE_signed_certificate_timestamp))
4717 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4718 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4722 ctx->ct_validation_callback = callback;
4723 ctx->ct_validation_callback_arg = arg;
4727 int SSL_ct_is_enabled(const SSL *s)
4729 return s->ct_validation_callback != NULL;
4732 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4734 return ctx->ct_validation_callback != NULL;
4737 int ssl_validate_ct(SSL *s)
4740 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4742 SSL_DANE *dane = &s->dane;
4743 CT_POLICY_EVAL_CTX *ctx = NULL;
4744 const STACK_OF(SCT) *scts;
4747 * If no callback is set, the peer is anonymous, or its chain is invalid,
4748 * skip SCT validation - just return success. Applications that continue
4749 * handshakes without certificates, with unverified chains, or pinned leaf
4750 * certificates are outside the scope of the WebPKI and CT.
4752 * The above exclusions notwithstanding the vast majority of peers will
4753 * have rather ordinary certificate chains validated by typical
4754 * applications that perform certificate verification and therefore will
4755 * process SCTs when enabled.
4757 if (s->ct_validation_callback == NULL || cert == NULL ||
4758 s->verify_result != X509_V_OK ||
4759 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4763 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4764 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4766 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4767 switch (dane->mtlsa->usage) {
4768 case DANETLS_USAGE_DANE_TA:
4769 case DANETLS_USAGE_DANE_EE:
4774 ctx = CT_POLICY_EVAL_CTX_new();
4776 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4777 ERR_R_MALLOC_FAILURE);
4781 issuer = sk_X509_value(s->verified_chain, 1);
4782 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4783 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4784 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4785 CT_POLICY_EVAL_CTX_set_time(
4786 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4788 scts = SSL_get0_peer_scts(s);
4791 * This function returns success (> 0) only when all the SCTs are valid, 0
4792 * when some are invalid, and < 0 on various internal errors (out of
4793 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4794 * reason to abort the handshake, that decision is up to the callback.
4795 * Therefore, we error out only in the unexpected case that the return
4796 * value is negative.
4798 * XXX: One might well argue that the return value of this function is an
4799 * unfortunate design choice. Its job is only to determine the validation
4800 * status of each of the provided SCTs. So long as it correctly separates
4801 * the wheat from the chaff it should return success. Failure in this case
4802 * ought to correspond to an inability to carry out its duties.
4804 if (SCT_LIST_validate(scts, ctx) < 0) {
4805 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4806 SSL_R_SCT_VERIFICATION_FAILED);
4810 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4812 ret = 0; /* This function returns 0 on failure */
4814 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4815 SSL_R_CALLBACK_FAILED);
4818 CT_POLICY_EVAL_CTX_free(ctx);
4820 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4821 * failure return code here. Also the application may wish the complete
4822 * the handshake, and then disconnect cleanly at a higher layer, after
4823 * checking the verification status of the completed connection.
4825 * We therefore force a certificate verification failure which will be
4826 * visible via SSL_get_verify_result() and cached as part of any resumed
4829 * Note: the permissive callback is for information gathering only, always
4830 * returns success, and does not affect verification status. Only the
4831 * strict callback or a custom application-specified callback can trigger
4832 * connection failure or record a verification error.
4835 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4839 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4841 switch (validation_mode) {
4843 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4845 case SSL_CT_VALIDATION_PERMISSIVE:
4846 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4847 case SSL_CT_VALIDATION_STRICT:
4848 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4852 int SSL_enable_ct(SSL *s, int validation_mode)
4854 switch (validation_mode) {
4856 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4858 case SSL_CT_VALIDATION_PERMISSIVE:
4859 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4860 case SSL_CT_VALIDATION_STRICT:
4861 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4865 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4867 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4870 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4872 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4875 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4877 CTLOG_STORE_free(ctx->ctlog_store);
4878 ctx->ctlog_store = logs;
4881 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4883 return ctx->ctlog_store;
4886 #endif /* OPENSSL_NO_CT */
4888 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4891 c->client_hello_cb = cb;
4892 c->client_hello_cb_arg = arg;
4895 int SSL_client_hello_isv2(SSL *s)
4897 if (s->clienthello == NULL)
4899 return s->clienthello->isv2;
4902 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4904 if (s->clienthello == NULL)
4906 return s->clienthello->legacy_version;
4909 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
4911 if (s->clienthello == NULL)
4914 *out = s->clienthello->random;
4915 return SSL3_RANDOM_SIZE;
4918 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
4920 if (s->clienthello == NULL)
4923 *out = s->clienthello->session_id;
4924 return s->clienthello->session_id_len;
4927 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
4929 if (s->clienthello == NULL)
4932 *out = PACKET_data(&s->clienthello->ciphersuites);
4933 return PACKET_remaining(&s->clienthello->ciphersuites);
4936 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
4938 if (s->clienthello == NULL)
4941 *out = s->clienthello->compressions;
4942 return s->clienthello->compressions_len;
4945 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
4951 if (s->clienthello == NULL || out == NULL || outlen == NULL)
4953 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
4954 ext = s->clienthello->pre_proc_exts + i;
4958 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
4959 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
4960 ERR_R_MALLOC_FAILURE);
4963 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
4964 ext = s->clienthello->pre_proc_exts + i;
4966 if (ext->received_order >= num)
4968 present[ext->received_order] = ext->type;
4975 OPENSSL_free(present);
4979 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4985 if (s->clienthello == NULL)
4987 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4988 r = s->clienthello->pre_proc_exts + i;
4989 if (r->present && r->type == type) {
4991 *out = PACKET_data(&r->data);
4993 *outlen = PACKET_remaining(&r->data);
5000 int SSL_free_buffers(SSL *ssl)
5002 RECORD_LAYER *rl = &ssl->rlayer;
5004 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5007 RECORD_LAYER_release(rl);
5011 int SSL_alloc_buffers(SSL *ssl)
5013 return ssl3_setup_buffers(ssl);
5016 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5018 ctx->keylog_callback = cb;
5021 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5023 return ctx->keylog_callback;
5026 static int nss_keylog_int(const char *prefix,
5028 const uint8_t *parameter_1,
5029 size_t parameter_1_len,
5030 const uint8_t *parameter_2,
5031 size_t parameter_2_len)
5034 char *cursor = NULL;
5039 if (ssl->ctx->keylog_callback == NULL) return 1;
5042 * Our output buffer will contain the following strings, rendered with
5043 * space characters in between, terminated by a NULL character: first the
5044 * prefix, then the first parameter, then the second parameter. The
5045 * meaning of each parameter depends on the specific key material being
5046 * logged. Note that the first and second parameters are encoded in
5047 * hexadecimal, so we need a buffer that is twice their lengths.
5049 prefix_len = strlen(prefix);
5050 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
5051 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5052 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5053 ERR_R_MALLOC_FAILURE);
5057 strcpy(cursor, prefix);
5058 cursor += prefix_len;
5061 for (i = 0; i < parameter_1_len; i++) {
5062 sprintf(cursor, "%02x", parameter_1[i]);
5067 for (i = 0; i < parameter_2_len; i++) {
5068 sprintf(cursor, "%02x", parameter_2[i]);
5073 ssl->ctx->keylog_callback(ssl, (const char *)out);
5079 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5080 const uint8_t *encrypted_premaster,
5081 size_t encrypted_premaster_len,
5082 const uint8_t *premaster,
5083 size_t premaster_len)
5085 if (encrypted_premaster_len < 8) {
5086 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5087 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5091 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5092 return nss_keylog_int("RSA",
5094 encrypted_premaster,
5100 int ssl_log_secret(SSL *ssl,
5102 const uint8_t *secret,
5105 return nss_keylog_int(label,
5107 ssl->s3->client_random,
5113 #define SSLV2_CIPHER_LEN 3
5115 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5119 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5121 if (PACKET_remaining(cipher_suites) == 0) {
5122 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5123 SSL_R_NO_CIPHERS_SPECIFIED);
5127 if (PACKET_remaining(cipher_suites) % n != 0) {
5128 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5129 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5133 OPENSSL_free(s->s3->tmp.ciphers_raw);
5134 s->s3->tmp.ciphers_raw = NULL;
5135 s->s3->tmp.ciphers_rawlen = 0;
5138 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5139 PACKET sslv2ciphers = *cipher_suites;
5140 unsigned int leadbyte;
5144 * We store the raw ciphers list in SSLv3+ format so we need to do some
5145 * preprocessing to convert the list first. If there are any SSLv2 only
5146 * ciphersuites with a non-zero leading byte then we are going to
5147 * slightly over allocate because we won't store those. But that isn't a
5150 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5151 s->s3->tmp.ciphers_raw = raw;
5153 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5154 ERR_R_MALLOC_FAILURE);
5157 for (s->s3->tmp.ciphers_rawlen = 0;
5158 PACKET_remaining(&sslv2ciphers) > 0;
5159 raw += TLS_CIPHER_LEN) {
5160 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5162 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5165 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5166 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5168 OPENSSL_free(s->s3->tmp.ciphers_raw);
5169 s->s3->tmp.ciphers_raw = NULL;
5170 s->s3->tmp.ciphers_rawlen = 0;
5174 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5176 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5177 &s->s3->tmp.ciphers_rawlen)) {
5178 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5179 ERR_R_INTERNAL_ERROR);
5185 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5186 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5187 STACK_OF(SSL_CIPHER) **scsvs)
5191 if (!PACKET_buf_init(&pkt, bytes, len))
5193 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5196 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5197 STACK_OF(SSL_CIPHER) **skp,
5198 STACK_OF(SSL_CIPHER) **scsvs_out,
5199 int sslv2format, int fatal)
5201 const SSL_CIPHER *c;
5202 STACK_OF(SSL_CIPHER) *sk = NULL;
5203 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5205 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5206 unsigned char cipher[SSLV2_CIPHER_LEN];
5208 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5210 if (PACKET_remaining(cipher_suites) == 0) {
5212 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5213 SSL_R_NO_CIPHERS_SPECIFIED);
5215 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5219 if (PACKET_remaining(cipher_suites) % n != 0) {
5221 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5222 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5224 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5225 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5229 sk = sk_SSL_CIPHER_new_null();
5230 scsvs = sk_SSL_CIPHER_new_null();
5231 if (sk == NULL || scsvs == NULL) {
5233 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5234 ERR_R_MALLOC_FAILURE);
5236 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5240 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5242 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5243 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5244 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5246 if (sslv2format && cipher[0] != '\0')
5249 /* For SSLv2-compat, ignore leading 0-byte. */
5250 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5252 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5253 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5255 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5256 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5258 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5263 if (PACKET_remaining(cipher_suites) > 0) {
5265 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5268 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5275 sk_SSL_CIPHER_free(sk);
5276 if (scsvs_out != NULL)
5279 sk_SSL_CIPHER_free(scsvs);
5282 sk_SSL_CIPHER_free(sk);
5283 sk_SSL_CIPHER_free(scsvs);
5287 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5289 ctx->max_early_data = max_early_data;
5294 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5296 return ctx->max_early_data;
5299 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5301 s->max_early_data = max_early_data;
5306 uint32_t SSL_get_max_early_data(const SSL *s)
5308 return s->max_early_data;
5311 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5313 /* Return any active Max Fragment Len extension */
5314 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5315 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5317 /* return current SSL connection setting */
5318 return ssl->max_send_fragment;
5321 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5323 /* Return a value regarding an active Max Fragment Len extension */
5324 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5325 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5326 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5328 /* else limit |split_send_fragment| to current |max_send_fragment| */
5329 if (ssl->split_send_fragment > ssl->max_send_fragment)
5330 return ssl->max_send_fragment;
5332 /* return current SSL connection setting */
5333 return ssl->split_send_fragment;
5336 int SSL_stateless(SSL *s)
5340 /* Ensure there is no state left over from a previous invocation */
5346 s->s3->flags |= TLS1_FLAGS_STATELESS;
5347 ret = SSL_accept(s);
5348 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5350 if (ret > 0 && s->ext.cookieok)
5353 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5359 void SSL_force_post_handshake_auth(SSL *ssl)
5361 ssl->pha_forced = 1;
5364 int SSL_verify_client_post_handshake(SSL *ssl)
5366 if (!SSL_IS_TLS13(ssl)) {
5367 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5371 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5375 if (!SSL_is_init_finished(ssl)) {
5376 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5380 switch (ssl->post_handshake_auth) {
5382 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5385 case SSL_PHA_EXT_SENT:
5386 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5388 case SSL_PHA_EXT_RECEIVED:
5390 case SSL_PHA_REQUEST_PENDING:
5391 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5393 case SSL_PHA_REQUESTED:
5394 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5398 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5400 /* checks verify_mode and algorithm_auth */
5401 if (!send_certificate_request(ssl)) {
5402 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5403 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5407 ossl_statem_set_in_init(ssl, 1);
5411 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5412 SSL_CTX_generate_session_ticket_fn gen_cb,
5413 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5416 ctx->generate_ticket_cb = gen_cb;
5417 ctx->decrypt_ticket_cb = dec_cb;
5418 ctx->ticket_cb_data = arg;