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 /* The buffering BIO is still in place */
2028 (void)BIO_flush(s->wbio);
2029 s->early_data_state = early_data_state;
2033 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2038 int SSL_shutdown(SSL *s)
2041 * Note that this function behaves differently from what one might
2042 * expect. Return values are 0 for no success (yet), 1 for success; but
2043 * calling it once is usually not enough, even if blocking I/O is used
2044 * (see ssl3_shutdown).
2047 if (s->handshake_func == NULL) {
2048 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2052 if (!SSL_in_init(s)) {
2053 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2054 struct ssl_async_args args;
2057 args.type = OTHERFUNC;
2058 args.f.func_other = s->method->ssl_shutdown;
2060 return ssl_start_async_job(s, &args, ssl_io_intern);
2062 return s->method->ssl_shutdown(s);
2065 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2070 int SSL_key_update(SSL *s, int updatetype)
2073 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2074 * negotiated, and that it is appropriate to call SSL_key_update() instead
2075 * of SSL_renegotiate().
2077 if (!SSL_IS_TLS13(s)) {
2078 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2082 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2083 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2084 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2088 if (!SSL_is_init_finished(s)) {
2089 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2093 ossl_statem_set_in_init(s, 1);
2094 s->key_update = updatetype;
2098 int SSL_get_key_update_type(SSL *s)
2100 return s->key_update;
2103 int SSL_renegotiate(SSL *s)
2105 if (SSL_IS_TLS13(s)) {
2106 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2110 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2111 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2118 return s->method->ssl_renegotiate(s);
2121 int SSL_renegotiate_abbreviated(SSL *s)
2123 if (SSL_IS_TLS13(s)) {
2124 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2128 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2129 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2136 return s->method->ssl_renegotiate(s);
2139 int SSL_renegotiate_pending(SSL *s)
2142 * becomes true when negotiation is requested; false again once a
2143 * handshake has finished
2145 return (s->renegotiate != 0);
2148 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2153 case SSL_CTRL_GET_READ_AHEAD:
2154 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2155 case SSL_CTRL_SET_READ_AHEAD:
2156 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2157 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2160 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2161 s->msg_callback_arg = parg;
2165 return (s->mode |= larg);
2166 case SSL_CTRL_CLEAR_MODE:
2167 return (s->mode &= ~larg);
2168 case SSL_CTRL_GET_MAX_CERT_LIST:
2169 return (long)s->max_cert_list;
2170 case SSL_CTRL_SET_MAX_CERT_LIST:
2173 l = (long)s->max_cert_list;
2174 s->max_cert_list = (size_t)larg;
2176 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2177 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2179 s->max_send_fragment = larg;
2180 if (s->max_send_fragment < s->split_send_fragment)
2181 s->split_send_fragment = s->max_send_fragment;
2183 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2184 if ((size_t)larg > s->max_send_fragment || larg == 0)
2186 s->split_send_fragment = larg;
2188 case SSL_CTRL_SET_MAX_PIPELINES:
2189 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2191 s->max_pipelines = larg;
2193 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2195 case SSL_CTRL_GET_RI_SUPPORT:
2197 return s->s3->send_connection_binding;
2200 case SSL_CTRL_CERT_FLAGS:
2201 return (s->cert->cert_flags |= larg);
2202 case SSL_CTRL_CLEAR_CERT_FLAGS:
2203 return (s->cert->cert_flags &= ~larg);
2205 case SSL_CTRL_GET_RAW_CIPHERLIST:
2207 if (s->s3->tmp.ciphers_raw == NULL)
2209 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2210 return (int)s->s3->tmp.ciphers_rawlen;
2212 return TLS_CIPHER_LEN;
2214 case SSL_CTRL_GET_EXTMS_SUPPORT:
2215 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2217 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2221 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2222 return ssl_check_allowed_versions(larg, s->max_proto_version)
2223 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2224 &s->min_proto_version);
2225 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2226 return s->min_proto_version;
2227 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2228 return ssl_check_allowed_versions(s->min_proto_version, larg)
2229 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2230 &s->max_proto_version);
2231 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2232 return s->max_proto_version;
2234 return s->method->ssl_ctrl(s, cmd, larg, parg);
2238 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2241 case SSL_CTRL_SET_MSG_CALLBACK:
2242 s->msg_callback = (void (*)
2243 (int write_p, int version, int content_type,
2244 const void *buf, size_t len, SSL *ssl,
2249 return s->method->ssl_callback_ctrl(s, cmd, fp);
2253 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2255 return ctx->sessions;
2258 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2262 /* For some cases with ctx == NULL perform syntax checks */
2265 #ifndef OPENSSL_NO_EC
2266 case SSL_CTRL_SET_GROUPS_LIST:
2267 return tls1_set_groups_list(NULL, NULL, parg);
2269 case SSL_CTRL_SET_SIGALGS_LIST:
2270 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2271 return tls1_set_sigalgs_list(NULL, parg, 0);
2278 case SSL_CTRL_GET_READ_AHEAD:
2279 return ctx->read_ahead;
2280 case SSL_CTRL_SET_READ_AHEAD:
2281 l = ctx->read_ahead;
2282 ctx->read_ahead = larg;
2285 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2286 ctx->msg_callback_arg = parg;
2289 case SSL_CTRL_GET_MAX_CERT_LIST:
2290 return (long)ctx->max_cert_list;
2291 case SSL_CTRL_SET_MAX_CERT_LIST:
2294 l = (long)ctx->max_cert_list;
2295 ctx->max_cert_list = (size_t)larg;
2298 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2301 l = (long)ctx->session_cache_size;
2302 ctx->session_cache_size = (size_t)larg;
2304 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2305 return (long)ctx->session_cache_size;
2306 case SSL_CTRL_SET_SESS_CACHE_MODE:
2307 l = ctx->session_cache_mode;
2308 ctx->session_cache_mode = larg;
2310 case SSL_CTRL_GET_SESS_CACHE_MODE:
2311 return ctx->session_cache_mode;
2313 case SSL_CTRL_SESS_NUMBER:
2314 return lh_SSL_SESSION_num_items(ctx->sessions);
2315 case SSL_CTRL_SESS_CONNECT:
2316 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2318 case SSL_CTRL_SESS_CONNECT_GOOD:
2319 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2321 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2322 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2325 case SSL_CTRL_SESS_ACCEPT:
2326 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2328 case SSL_CTRL_SESS_ACCEPT_GOOD:
2329 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2331 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2332 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2335 case SSL_CTRL_SESS_HIT:
2336 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2338 case SSL_CTRL_SESS_CB_HIT:
2339 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2341 case SSL_CTRL_SESS_MISSES:
2342 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2344 case SSL_CTRL_SESS_TIMEOUTS:
2345 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2347 case SSL_CTRL_SESS_CACHE_FULL:
2348 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2351 return (ctx->mode |= larg);
2352 case SSL_CTRL_CLEAR_MODE:
2353 return (ctx->mode &= ~larg);
2354 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2355 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2357 ctx->max_send_fragment = larg;
2358 if (ctx->max_send_fragment < ctx->split_send_fragment)
2359 ctx->split_send_fragment = ctx->max_send_fragment;
2361 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2362 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2364 ctx->split_send_fragment = larg;
2366 case SSL_CTRL_SET_MAX_PIPELINES:
2367 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2369 ctx->max_pipelines = larg;
2371 case SSL_CTRL_CERT_FLAGS:
2372 return (ctx->cert->cert_flags |= larg);
2373 case SSL_CTRL_CLEAR_CERT_FLAGS:
2374 return (ctx->cert->cert_flags &= ~larg);
2375 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2376 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2377 && ssl_set_version_bound(ctx->method->version, (int)larg,
2378 &ctx->min_proto_version);
2379 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2380 return ctx->min_proto_version;
2381 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2382 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2383 && ssl_set_version_bound(ctx->method->version, (int)larg,
2384 &ctx->max_proto_version);
2385 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2386 return ctx->max_proto_version;
2388 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2392 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2395 case SSL_CTRL_SET_MSG_CALLBACK:
2396 ctx->msg_callback = (void (*)
2397 (int write_p, int version, int content_type,
2398 const void *buf, size_t len, SSL *ssl,
2403 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2407 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2416 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2417 const SSL_CIPHER *const *bp)
2419 if ((*ap)->id > (*bp)->id)
2421 if ((*ap)->id < (*bp)->id)
2426 /** return a STACK of the ciphers available for the SSL and in order of
2428 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2431 if (s->cipher_list != NULL) {
2432 return s->cipher_list;
2433 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2434 return s->ctx->cipher_list;
2440 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2442 if ((s == NULL) || (s->session == NULL) || !s->server)
2444 return s->session->ciphers;
2447 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2449 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2452 ciphers = SSL_get_ciphers(s);
2455 if (!ssl_set_client_disabled(s))
2457 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2458 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2459 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2461 sk = sk_SSL_CIPHER_new_null();
2464 if (!sk_SSL_CIPHER_push(sk, c)) {
2465 sk_SSL_CIPHER_free(sk);
2473 /** return a STACK of the ciphers available for the SSL and in order of
2475 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2478 if (s->cipher_list_by_id != NULL) {
2479 return s->cipher_list_by_id;
2480 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2481 return s->ctx->cipher_list_by_id;
2487 /** The old interface to get the same thing as SSL_get_ciphers() */
2488 const char *SSL_get_cipher_list(const SSL *s, int n)
2490 const SSL_CIPHER *c;
2491 STACK_OF(SSL_CIPHER) *sk;
2495 sk = SSL_get_ciphers(s);
2496 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2498 c = sk_SSL_CIPHER_value(sk, n);
2504 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2506 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2509 return ctx->cipher_list;
2513 /** specify the ciphers to be used by default by the SSL_CTX */
2514 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2516 STACK_OF(SSL_CIPHER) *sk;
2518 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2519 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2522 * ssl_create_cipher_list may return an empty stack if it was unable to
2523 * find a cipher matching the given rule string (for example if the rule
2524 * string specifies a cipher which has been disabled). This is not an
2525 * error as far as ssl_create_cipher_list is concerned, and hence
2526 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2530 else if (sk_SSL_CIPHER_num(sk) == 0) {
2531 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2537 /** specify the ciphers to be used by the SSL */
2538 int SSL_set_cipher_list(SSL *s, const char *str)
2540 STACK_OF(SSL_CIPHER) *sk;
2542 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2543 &s->cipher_list, &s->cipher_list_by_id, str,
2545 /* see comment in SSL_CTX_set_cipher_list */
2548 else if (sk_SSL_CIPHER_num(sk) == 0) {
2549 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2555 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2558 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2559 const SSL_CIPHER *c;
2563 || s->session == NULL
2564 || s->session->ciphers == NULL
2569 clntsk = s->session->ciphers;
2570 srvrsk = SSL_get_ciphers(s);
2571 if (clntsk == NULL || srvrsk == NULL)
2574 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2577 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2580 c = sk_SSL_CIPHER_value(clntsk, i);
2581 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2584 n = strlen(c->name);
2600 /** return a servername extension value if provided in Client Hello, or NULL.
2601 * So far, only host_name types are defined (RFC 3546).
2604 const char *SSL_get_servername(const SSL *s, const int type)
2606 if (type != TLSEXT_NAMETYPE_host_name)
2609 return s->session && !s->ext.hostname ?
2610 s->session->ext.hostname : s->ext.hostname;
2613 int SSL_get_servername_type(const SSL *s)
2616 && (!s->ext.hostname ? s->session->
2617 ext.hostname : s->ext.hostname))
2618 return TLSEXT_NAMETYPE_host_name;
2623 * SSL_select_next_proto implements the standard protocol selection. It is
2624 * expected that this function is called from the callback set by
2625 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2626 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2627 * not included in the length. A byte string of length 0 is invalid. No byte
2628 * string may be truncated. The current, but experimental algorithm for
2629 * selecting the protocol is: 1) If the server doesn't support NPN then this
2630 * is indicated to the callback. In this case, the client application has to
2631 * abort the connection or have a default application level protocol. 2) If
2632 * the server supports NPN, but advertises an empty list then the client
2633 * selects the first protocol in its list, but indicates via the API that this
2634 * fallback case was enacted. 3) Otherwise, the client finds the first
2635 * protocol in the server's list that it supports and selects this protocol.
2636 * This is because it's assumed that the server has better information about
2637 * which protocol a client should use. 4) If the client doesn't support any
2638 * of the server's advertised protocols, then this is treated the same as
2639 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2640 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2642 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2643 const unsigned char *server,
2644 unsigned int server_len,
2645 const unsigned char *client, unsigned int client_len)
2648 const unsigned char *result;
2649 int status = OPENSSL_NPN_UNSUPPORTED;
2652 * For each protocol in server preference order, see if we support it.
2654 for (i = 0; i < server_len;) {
2655 for (j = 0; j < client_len;) {
2656 if (server[i] == client[j] &&
2657 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2658 /* We found a match */
2659 result = &server[i];
2660 status = OPENSSL_NPN_NEGOTIATED;
2670 /* There's no overlap between our protocols and the server's list. */
2672 status = OPENSSL_NPN_NO_OVERLAP;
2675 *out = (unsigned char *)result + 1;
2676 *outlen = result[0];
2680 #ifndef OPENSSL_NO_NEXTPROTONEG
2682 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2683 * client's requested protocol for this connection and returns 0. If the
2684 * client didn't request any protocol, then *data is set to NULL. Note that
2685 * the client can request any protocol it chooses. The value returned from
2686 * this function need not be a member of the list of supported protocols
2687 * provided by the callback.
2689 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2696 *len = (unsigned int)s->ext.npn_len;
2701 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2702 * a TLS server needs a list of supported protocols for Next Protocol
2703 * Negotiation. The returned list must be in wire format. The list is
2704 * returned by setting |out| to point to it and |outlen| to its length. This
2705 * memory will not be modified, but one should assume that the SSL* keeps a
2706 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2707 * wishes to advertise. Otherwise, no such extension will be included in the
2710 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2711 SSL_CTX_npn_advertised_cb_func cb,
2714 ctx->ext.npn_advertised_cb = cb;
2715 ctx->ext.npn_advertised_cb_arg = arg;
2719 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2720 * client needs to select a protocol from the server's provided list. |out|
2721 * must be set to point to the selected protocol (which may be within |in|).
2722 * The length of the protocol name must be written into |outlen|. The
2723 * server's advertised protocols are provided in |in| and |inlen|. The
2724 * callback can assume that |in| is syntactically valid. The client must
2725 * select a protocol. It is fatal to the connection if this callback returns
2726 * a value other than SSL_TLSEXT_ERR_OK.
2728 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2729 SSL_CTX_npn_select_cb_func cb,
2732 ctx->ext.npn_select_cb = cb;
2733 ctx->ext.npn_select_cb_arg = arg;
2738 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2739 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2740 * length-prefixed strings). Returns 0 on success.
2742 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2743 unsigned int protos_len)
2745 OPENSSL_free(ctx->ext.alpn);
2746 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2747 if (ctx->ext.alpn == NULL) {
2748 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2751 ctx->ext.alpn_len = protos_len;
2757 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2758 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2759 * length-prefixed strings). Returns 0 on success.
2761 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2762 unsigned int protos_len)
2764 OPENSSL_free(ssl->ext.alpn);
2765 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2766 if (ssl->ext.alpn == NULL) {
2767 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2770 ssl->ext.alpn_len = protos_len;
2776 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2777 * called during ClientHello processing in order to select an ALPN protocol
2778 * from the client's list of offered protocols.
2780 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2781 SSL_CTX_alpn_select_cb_func cb,
2784 ctx->ext.alpn_select_cb = cb;
2785 ctx->ext.alpn_select_cb_arg = arg;
2789 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2790 * On return it sets |*data| to point to |*len| bytes of protocol name
2791 * (not including the leading length-prefix byte). If the server didn't
2792 * respond with a negotiated protocol then |*len| will be zero.
2794 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2799 *data = ssl->s3->alpn_selected;
2803 *len = (unsigned int)ssl->s3->alpn_selected_len;
2806 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2807 const char *label, size_t llen,
2808 const unsigned char *context, size_t contextlen,
2811 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2814 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2816 contextlen, use_context);
2819 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2820 const char *label, size_t llen,
2821 const unsigned char *context,
2824 if (s->version != TLS1_3_VERSION)
2827 return tls13_export_keying_material_early(s, out, olen, label, llen,
2828 context, contextlen);
2831 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2833 const unsigned char *session_id = a->session_id;
2835 unsigned char tmp_storage[4];
2837 if (a->session_id_length < sizeof(tmp_storage)) {
2838 memset(tmp_storage, 0, sizeof(tmp_storage));
2839 memcpy(tmp_storage, a->session_id, a->session_id_length);
2840 session_id = tmp_storage;
2844 ((unsigned long)session_id[0]) |
2845 ((unsigned long)session_id[1] << 8L) |
2846 ((unsigned long)session_id[2] << 16L) |
2847 ((unsigned long)session_id[3] << 24L);
2852 * NB: If this function (or indeed the hash function which uses a sort of
2853 * coarser function than this one) is changed, ensure
2854 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2855 * being able to construct an SSL_SESSION that will collide with any existing
2856 * session with a matching session ID.
2858 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2860 if (a->ssl_version != b->ssl_version)
2862 if (a->session_id_length != b->session_id_length)
2864 return memcmp(a->session_id, b->session_id, a->session_id_length);
2868 * These wrapper functions should remain rather than redeclaring
2869 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2870 * variable. The reason is that the functions aren't static, they're exposed
2874 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2876 SSL_CTX *ret = NULL;
2879 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2883 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2886 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2887 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2890 ret = OPENSSL_zalloc(sizeof(*ret));
2895 ret->min_proto_version = 0;
2896 ret->max_proto_version = 0;
2897 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2898 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2899 /* We take the system default. */
2900 ret->session_timeout = meth->get_timeout();
2901 ret->references = 1;
2902 ret->lock = CRYPTO_THREAD_lock_new();
2903 if (ret->lock == NULL) {
2904 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2908 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2909 ret->verify_mode = SSL_VERIFY_NONE;
2910 if ((ret->cert = ssl_cert_new()) == NULL)
2913 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2914 if (ret->sessions == NULL)
2916 ret->cert_store = X509_STORE_new();
2917 if (ret->cert_store == NULL)
2919 #ifndef OPENSSL_NO_CT
2920 ret->ctlog_store = CTLOG_STORE_new();
2921 if (ret->ctlog_store == NULL)
2925 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
2928 if (!ssl_create_cipher_list(ret->method,
2929 ret->tls13_ciphersuites,
2930 &ret->cipher_list, &ret->cipher_list_by_id,
2931 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2932 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2933 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2937 ret->param = X509_VERIFY_PARAM_new();
2938 if (ret->param == NULL)
2941 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2942 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2945 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2946 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2950 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2953 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2956 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
2959 /* No compression for DTLS */
2960 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2961 ret->comp_methods = SSL_COMP_get_compression_methods();
2963 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2964 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2966 /* Setup RFC5077 ticket keys */
2967 if ((RAND_bytes(ret->ext.tick_key_name,
2968 sizeof(ret->ext.tick_key_name)) <= 0)
2969 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
2970 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
2971 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
2972 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
2973 ret->options |= SSL_OP_NO_TICKET;
2975 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
2976 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2979 #ifndef OPENSSL_NO_SRP
2980 if (!SSL_CTX_SRP_CTX_init(ret))
2983 #ifndef OPENSSL_NO_ENGINE
2984 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2985 # define eng_strx(x) #x
2986 # define eng_str(x) eng_strx(x)
2987 /* Use specific client engine automatically... ignore errors */
2990 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2993 ENGINE_load_builtin_engines();
2994 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2996 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3002 * Default is to connect to non-RI servers. When RI is more widely
3003 * deployed might change this.
3005 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3007 * Disable compression by default to prevent CRIME. Applications can
3008 * re-enable compression by configuring
3009 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3010 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3011 * middlebox compatibility by default. This may be disabled by default in
3012 * a later OpenSSL version.
3014 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3016 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3019 * We cannot usefully set a default max_early_data here (which gets
3020 * propagated in SSL_new(), for the following reason: setting the
3021 * SSL field causes tls_construct_stoc_early_data() to tell the
3022 * client that early data will be accepted when constructing a TLS 1.3
3023 * session ticket, and the client will accordingly send us early data
3024 * when using that ticket (if the client has early data to send).
3025 * However, in order for the early data to actually be consumed by
3026 * the application, the application must also have calls to
3027 * SSL_read_early_data(); otherwise we'll just skip past the early data
3028 * and ignore it. So, since the application must add calls to
3029 * SSL_read_early_data(), we also require them to add
3030 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3031 * eliminating the bandwidth-wasting early data in the case described
3034 ret->max_early_data = 0;
3036 ssl_ctx_system_config(ret);
3040 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3046 int SSL_CTX_up_ref(SSL_CTX *ctx)
3050 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3053 REF_PRINT_COUNT("SSL_CTX", ctx);
3054 REF_ASSERT_ISNT(i < 2);
3055 return ((i > 1) ? 1 : 0);
3058 void SSL_CTX_free(SSL_CTX *a)
3065 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3066 REF_PRINT_COUNT("SSL_CTX", a);
3069 REF_ASSERT_ISNT(i < 0);
3071 X509_VERIFY_PARAM_free(a->param);
3072 dane_ctx_final(&a->dane);
3075 * Free internal session cache. However: the remove_cb() may reference
3076 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3077 * after the sessions were flushed.
3078 * As the ex_data handling routines might also touch the session cache,
3079 * the most secure solution seems to be: empty (flush) the cache, then
3080 * free ex_data, then finally free the cache.
3081 * (See ticket [openssl.org #212].)
3083 if (a->sessions != NULL)
3084 SSL_CTX_flush_sessions(a, 0);
3086 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3087 lh_SSL_SESSION_free(a->sessions);
3088 X509_STORE_free(a->cert_store);
3089 #ifndef OPENSSL_NO_CT
3090 CTLOG_STORE_free(a->ctlog_store);
3092 sk_SSL_CIPHER_free(a->cipher_list);
3093 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3094 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3095 ssl_cert_free(a->cert);
3096 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3097 sk_X509_pop_free(a->extra_certs, X509_free);
3098 a->comp_methods = NULL;
3099 #ifndef OPENSSL_NO_SRTP
3100 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3102 #ifndef OPENSSL_NO_SRP
3103 SSL_CTX_SRP_CTX_free(a);
3105 #ifndef OPENSSL_NO_ENGINE
3106 ENGINE_finish(a->client_cert_engine);
3109 #ifndef OPENSSL_NO_EC
3110 OPENSSL_free(a->ext.ecpointformats);
3111 OPENSSL_free(a->ext.supportedgroups);
3113 OPENSSL_free(a->ext.alpn);
3114 OPENSSL_secure_free(a->ext.secure);
3116 CRYPTO_THREAD_lock_free(a->lock);
3121 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3123 ctx->default_passwd_callback = cb;
3126 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3128 ctx->default_passwd_callback_userdata = u;
3131 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3133 return ctx->default_passwd_callback;
3136 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3138 return ctx->default_passwd_callback_userdata;
3141 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3143 s->default_passwd_callback = cb;
3146 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3148 s->default_passwd_callback_userdata = u;
3151 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3153 return s->default_passwd_callback;
3156 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3158 return s->default_passwd_callback_userdata;
3161 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3162 int (*cb) (X509_STORE_CTX *, void *),
3165 ctx->app_verify_callback = cb;
3166 ctx->app_verify_arg = arg;
3169 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3170 int (*cb) (int, X509_STORE_CTX *))
3172 ctx->verify_mode = mode;
3173 ctx->default_verify_callback = cb;
3176 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3178 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3181 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3183 ssl_cert_set_cert_cb(c->cert, cb, arg);
3186 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3188 ssl_cert_set_cert_cb(s->cert, cb, arg);
3191 void ssl_set_masks(SSL *s)
3194 uint32_t *pvalid = s->s3->tmp.valid_flags;
3195 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3196 unsigned long mask_k, mask_a;
3197 #ifndef OPENSSL_NO_EC
3198 int have_ecc_cert, ecdsa_ok;
3203 #ifndef OPENSSL_NO_DH
3204 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3209 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3210 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3211 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3212 #ifndef OPENSSL_NO_EC
3213 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3219 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3220 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3223 #ifndef OPENSSL_NO_GOST
3224 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3225 mask_k |= SSL_kGOST;
3226 mask_a |= SSL_aGOST12;
3228 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3229 mask_k |= SSL_kGOST;
3230 mask_a |= SSL_aGOST12;
3232 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3233 mask_k |= SSL_kGOST;
3234 mask_a |= SSL_aGOST01;
3245 * If we only have an RSA-PSS certificate allow RSA authentication
3246 * if TLS 1.2 and peer supports it.
3249 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3250 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3251 && TLS1_get_version(s) == TLS1_2_VERSION))
3258 mask_a |= SSL_aNULL;
3261 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3262 * depending on the key usage extension.
3264 #ifndef OPENSSL_NO_EC
3265 if (have_ecc_cert) {
3267 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3268 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3269 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3272 mask_a |= SSL_aECDSA;
3274 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3275 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3276 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3277 && TLS1_get_version(s) == TLS1_2_VERSION)
3278 mask_a |= SSL_aECDSA;
3280 /* Allow Ed448 for TLS 1.2 if peer supports it */
3281 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3282 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3283 && TLS1_get_version(s) == TLS1_2_VERSION)
3284 mask_a |= SSL_aECDSA;
3287 #ifndef OPENSSL_NO_EC
3288 mask_k |= SSL_kECDHE;
3291 #ifndef OPENSSL_NO_PSK
3294 if (mask_k & SSL_kRSA)
3295 mask_k |= SSL_kRSAPSK;
3296 if (mask_k & SSL_kDHE)
3297 mask_k |= SSL_kDHEPSK;
3298 if (mask_k & SSL_kECDHE)
3299 mask_k |= SSL_kECDHEPSK;
3302 s->s3->tmp.mask_k = mask_k;
3303 s->s3->tmp.mask_a = mask_a;
3306 #ifndef OPENSSL_NO_EC
3308 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3310 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3311 /* key usage, if present, must allow signing */
3312 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3313 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3314 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3318 return 1; /* all checks are ok */
3323 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3324 size_t *serverinfo_length)
3326 CERT_PKEY *cpk = s->s3->tmp.cert;
3327 *serverinfo_length = 0;
3329 if (cpk == NULL || cpk->serverinfo == NULL)
3332 *serverinfo = cpk->serverinfo;
3333 *serverinfo_length = cpk->serverinfo_length;
3337 void ssl_update_cache(SSL *s, int mode)
3342 * If the session_id_length is 0, we are not supposed to cache it, and it
3343 * would be rather hard to do anyway :-)
3345 if (s->session->session_id_length == 0)
3349 * If sid_ctx_length is 0 there is no specific application context
3350 * associated with this session, so when we try to resume it and
3351 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3352 * indication that this is actually a session for the proper application
3353 * context, and the *handshake* will fail, not just the resumption attempt.
3354 * Do not cache (on the server) these sessions that are not resumable
3355 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3357 if (s->server && s->session->sid_ctx_length == 0
3358 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3361 i = s->session_ctx->session_cache_mode;
3363 && (!s->hit || SSL_IS_TLS13(s))
3364 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) != 0
3365 || SSL_CTX_add_session(s->session_ctx, s->session))
3366 && s->session_ctx->new_session_cb != NULL) {
3367 SSL_SESSION_up_ref(s->session);
3368 if (!s->session_ctx->new_session_cb(s, s->session))
3369 SSL_SESSION_free(s->session);
3372 /* auto flush every 255 connections */
3373 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3375 if (mode & SSL_SESS_CACHE_CLIENT)
3376 stat = &s->session_ctx->stats.sess_connect_good;
3378 stat = &s->session_ctx->stats.sess_accept_good;
3379 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3380 && (val & 0xff) == 0xff)
3381 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3385 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3390 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3395 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3399 if (s->method != meth) {
3400 const SSL_METHOD *sm = s->method;
3401 int (*hf) (SSL *) = s->handshake_func;
3403 if (sm->version == meth->version)
3408 ret = s->method->ssl_new(s);
3411 if (hf == sm->ssl_connect)
3412 s->handshake_func = meth->ssl_connect;
3413 else if (hf == sm->ssl_accept)
3414 s->handshake_func = meth->ssl_accept;
3419 int SSL_get_error(const SSL *s, int i)
3426 return SSL_ERROR_NONE;
3429 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3430 * where we do encode the error
3432 if ((l = ERR_peek_error()) != 0) {
3433 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3434 return SSL_ERROR_SYSCALL;
3436 return SSL_ERROR_SSL;
3439 if (SSL_want_read(s)) {
3440 bio = SSL_get_rbio(s);
3441 if (BIO_should_read(bio))
3442 return SSL_ERROR_WANT_READ;
3443 else if (BIO_should_write(bio))
3445 * This one doesn't make too much sense ... We never try to write
3446 * to the rbio, and an application program where rbio and wbio
3447 * are separate couldn't even know what it should wait for.
3448 * However if we ever set s->rwstate incorrectly (so that we have
3449 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3450 * wbio *are* the same, this test works around that bug; so it
3451 * might be safer to keep it.
3453 return SSL_ERROR_WANT_WRITE;
3454 else if (BIO_should_io_special(bio)) {
3455 reason = BIO_get_retry_reason(bio);
3456 if (reason == BIO_RR_CONNECT)
3457 return SSL_ERROR_WANT_CONNECT;
3458 else if (reason == BIO_RR_ACCEPT)
3459 return SSL_ERROR_WANT_ACCEPT;
3461 return SSL_ERROR_SYSCALL; /* unknown */
3465 if (SSL_want_write(s)) {
3466 /* Access wbio directly - in order to use the buffered bio if present */
3468 if (BIO_should_write(bio))
3469 return SSL_ERROR_WANT_WRITE;
3470 else if (BIO_should_read(bio))
3472 * See above (SSL_want_read(s) with BIO_should_write(bio))
3474 return SSL_ERROR_WANT_READ;
3475 else if (BIO_should_io_special(bio)) {
3476 reason = BIO_get_retry_reason(bio);
3477 if (reason == BIO_RR_CONNECT)
3478 return SSL_ERROR_WANT_CONNECT;
3479 else if (reason == BIO_RR_ACCEPT)
3480 return SSL_ERROR_WANT_ACCEPT;
3482 return SSL_ERROR_SYSCALL;
3485 if (SSL_want_x509_lookup(s))
3486 return SSL_ERROR_WANT_X509_LOOKUP;
3487 if (SSL_want_async(s))
3488 return SSL_ERROR_WANT_ASYNC;
3489 if (SSL_want_async_job(s))
3490 return SSL_ERROR_WANT_ASYNC_JOB;
3491 if (SSL_want_client_hello_cb(s))
3492 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3494 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3495 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3496 return SSL_ERROR_ZERO_RETURN;
3498 return SSL_ERROR_SYSCALL;
3501 static int ssl_do_handshake_intern(void *vargs)
3503 struct ssl_async_args *args;
3506 args = (struct ssl_async_args *)vargs;
3509 return s->handshake_func(s);
3512 int SSL_do_handshake(SSL *s)
3516 if (s->handshake_func == NULL) {
3517 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3521 ossl_statem_check_finish_init(s, -1);
3523 s->method->ssl_renegotiate_check(s, 0);
3525 if (SSL_is_server(s)) {
3526 /* clear SNI settings at server-side */
3527 OPENSSL_free(s->ext.hostname);
3528 s->ext.hostname = NULL;
3531 if (SSL_in_init(s) || SSL_in_before(s)) {
3532 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3533 struct ssl_async_args args;
3537 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3539 ret = s->handshake_func(s);
3545 void SSL_set_accept_state(SSL *s)
3549 ossl_statem_clear(s);
3550 s->handshake_func = s->method->ssl_accept;
3554 void SSL_set_connect_state(SSL *s)
3558 ossl_statem_clear(s);
3559 s->handshake_func = s->method->ssl_connect;
3563 int ssl_undefined_function(SSL *s)
3565 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3569 int ssl_undefined_void_function(void)
3571 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3572 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3576 int ssl_undefined_const_function(const SSL *s)
3581 const SSL_METHOD *ssl_bad_method(int ver)
3583 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3587 const char *ssl_protocol_to_string(int version)
3591 case TLS1_3_VERSION:
3594 case TLS1_2_VERSION:
3597 case TLS1_1_VERSION:
3612 case DTLS1_2_VERSION:
3620 const char *SSL_get_version(const SSL *s)
3622 return ssl_protocol_to_string(s->version);
3625 SSL *SSL_dup(SSL *s)
3627 STACK_OF(X509_NAME) *sk;
3632 /* If we're not quiescent, just up_ref! */
3633 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3634 CRYPTO_UP_REF(&s->references, &i, s->lock);
3639 * Otherwise, copy configuration state, and session if set.
3641 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3644 if (s->session != NULL) {
3646 * Arranges to share the same session via up_ref. This "copies"
3647 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3649 if (!SSL_copy_session_id(ret, s))
3653 * No session has been established yet, so we have to expect that
3654 * s->cert or ret->cert will be changed later -- they should not both
3655 * point to the same object, and thus we can't use
3656 * SSL_copy_session_id.
3658 if (!SSL_set_ssl_method(ret, s->method))
3661 if (s->cert != NULL) {
3662 ssl_cert_free(ret->cert);
3663 ret->cert = ssl_cert_dup(s->cert);
3664 if (ret->cert == NULL)
3668 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3669 (int)s->sid_ctx_length))
3673 if (!ssl_dane_dup(ret, s))
3675 ret->version = s->version;
3676 ret->options = s->options;
3677 ret->mode = s->mode;
3678 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3679 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3680 ret->msg_callback = s->msg_callback;
3681 ret->msg_callback_arg = s->msg_callback_arg;
3682 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3683 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3684 ret->generate_session_id = s->generate_session_id;
3686 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3688 /* copy app data, a little dangerous perhaps */
3689 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3692 /* setup rbio, and wbio */
3693 if (s->rbio != NULL) {
3694 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3697 if (s->wbio != NULL) {
3698 if (s->wbio != s->rbio) {
3699 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3702 BIO_up_ref(ret->rbio);
3703 ret->wbio = ret->rbio;
3707 ret->server = s->server;
3708 if (s->handshake_func) {
3710 SSL_set_accept_state(ret);
3712 SSL_set_connect_state(ret);
3714 ret->shutdown = s->shutdown;
3717 ret->default_passwd_callback = s->default_passwd_callback;
3718 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3720 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3722 /* dup the cipher_list and cipher_list_by_id stacks */
3723 if (s->cipher_list != NULL) {
3724 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3727 if (s->cipher_list_by_id != NULL)
3728 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3732 /* Dup the client_CA list */
3733 if (s->ca_names != NULL) {
3734 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3737 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3738 xn = sk_X509_NAME_value(sk, i);
3739 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3752 void ssl_clear_cipher_ctx(SSL *s)
3754 if (s->enc_read_ctx != NULL) {
3755 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3756 s->enc_read_ctx = NULL;
3758 if (s->enc_write_ctx != NULL) {
3759 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3760 s->enc_write_ctx = NULL;
3762 #ifndef OPENSSL_NO_COMP
3763 COMP_CTX_free(s->expand);
3765 COMP_CTX_free(s->compress);
3770 X509 *SSL_get_certificate(const SSL *s)
3772 if (s->cert != NULL)
3773 return s->cert->key->x509;
3778 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3780 if (s->cert != NULL)
3781 return s->cert->key->privatekey;
3786 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3788 if (ctx->cert != NULL)
3789 return ctx->cert->key->x509;
3794 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3796 if (ctx->cert != NULL)
3797 return ctx->cert->key->privatekey;
3802 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3804 if ((s->session != NULL) && (s->session->cipher != NULL))
3805 return s->session->cipher;
3809 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3811 return s->s3->tmp.new_cipher;
3814 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3816 #ifndef OPENSSL_NO_COMP
3817 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3823 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3825 #ifndef OPENSSL_NO_COMP
3826 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3832 int ssl_init_wbio_buffer(SSL *s)
3836 if (s->bbio != NULL) {
3837 /* Already buffered. */
3841 bbio = BIO_new(BIO_f_buffer());
3842 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3844 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3848 s->wbio = BIO_push(bbio, s->wbio);
3853 int ssl_free_wbio_buffer(SSL *s)
3855 /* callers ensure s is never null */
3856 if (s->bbio == NULL)
3859 s->wbio = BIO_pop(s->wbio);
3866 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3868 ctx->quiet_shutdown = mode;
3871 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3873 return ctx->quiet_shutdown;
3876 void SSL_set_quiet_shutdown(SSL *s, int mode)
3878 s->quiet_shutdown = mode;
3881 int SSL_get_quiet_shutdown(const SSL *s)
3883 return s->quiet_shutdown;
3886 void SSL_set_shutdown(SSL *s, int mode)
3891 int SSL_get_shutdown(const SSL *s)
3896 int SSL_version(const SSL *s)
3901 int SSL_client_version(const SSL *s)
3903 return s->client_version;
3906 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3911 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3914 if (ssl->ctx == ctx)
3917 ctx = ssl->session_ctx;
3918 new_cert = ssl_cert_dup(ctx->cert);
3919 if (new_cert == NULL) {
3923 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3924 ssl_cert_free(new_cert);
3928 ssl_cert_free(ssl->cert);
3929 ssl->cert = new_cert;
3932 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3933 * so setter APIs must prevent invalid lengths from entering the system.
3935 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3939 * If the session ID context matches that of the parent SSL_CTX,
3940 * inherit it from the new SSL_CTX as well. If however the context does
3941 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3942 * leave it unchanged.
3944 if ((ssl->ctx != NULL) &&
3945 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3946 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3947 ssl->sid_ctx_length = ctx->sid_ctx_length;
3948 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3951 SSL_CTX_up_ref(ctx);
3952 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3958 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3960 return X509_STORE_set_default_paths(ctx->cert_store);
3963 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3965 X509_LOOKUP *lookup;
3967 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3970 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3972 /* Clear any errors if the default directory does not exist */
3978 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3980 X509_LOOKUP *lookup;
3982 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3986 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3988 /* Clear any errors if the default file does not exist */
3994 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3997 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4000 void SSL_set_info_callback(SSL *ssl,
4001 void (*cb) (const SSL *ssl, int type, int val))
4003 ssl->info_callback = cb;
4007 * One compiler (Diab DCC) doesn't like argument names in returned function
4010 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4013 return ssl->info_callback;
4016 void SSL_set_verify_result(SSL *ssl, long arg)
4018 ssl->verify_result = arg;
4021 long SSL_get_verify_result(const SSL *ssl)
4023 return ssl->verify_result;
4026 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4029 return sizeof(ssl->s3->client_random);
4030 if (outlen > sizeof(ssl->s3->client_random))
4031 outlen = sizeof(ssl->s3->client_random);
4032 memcpy(out, ssl->s3->client_random, outlen);
4036 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4039 return sizeof(ssl->s3->server_random);
4040 if (outlen > sizeof(ssl->s3->server_random))
4041 outlen = sizeof(ssl->s3->server_random);
4042 memcpy(out, ssl->s3->server_random, outlen);
4046 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4047 unsigned char *out, size_t outlen)
4050 return session->master_key_length;
4051 if (outlen > session->master_key_length)
4052 outlen = session->master_key_length;
4053 memcpy(out, session->master_key, outlen);
4057 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4060 if (len > sizeof(sess->master_key))
4063 memcpy(sess->master_key, in, len);
4064 sess->master_key_length = len;
4069 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4071 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4074 void *SSL_get_ex_data(const SSL *s, int idx)
4076 return CRYPTO_get_ex_data(&s->ex_data, idx);
4079 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4081 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4084 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4086 return CRYPTO_get_ex_data(&s->ex_data, idx);
4089 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4091 return ctx->cert_store;
4094 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4096 X509_STORE_free(ctx->cert_store);
4097 ctx->cert_store = store;
4100 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4103 X509_STORE_up_ref(store);
4104 SSL_CTX_set_cert_store(ctx, store);
4107 int SSL_want(const SSL *s)
4113 * \brief Set the callback for generating temporary DH keys.
4114 * \param ctx the SSL context.
4115 * \param dh the callback
4118 #ifndef OPENSSL_NO_DH
4119 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4120 DH *(*dh) (SSL *ssl, int is_export,
4123 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4126 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4129 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4133 #ifndef OPENSSL_NO_PSK
4134 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4136 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4137 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4140 OPENSSL_free(ctx->cert->psk_identity_hint);
4141 if (identity_hint != NULL) {
4142 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4143 if (ctx->cert->psk_identity_hint == NULL)
4146 ctx->cert->psk_identity_hint = NULL;
4150 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4155 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4156 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4159 OPENSSL_free(s->cert->psk_identity_hint);
4160 if (identity_hint != NULL) {
4161 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4162 if (s->cert->psk_identity_hint == NULL)
4165 s->cert->psk_identity_hint = NULL;
4169 const char *SSL_get_psk_identity_hint(const SSL *s)
4171 if (s == NULL || s->session == NULL)
4173 return s->session->psk_identity_hint;
4176 const char *SSL_get_psk_identity(const SSL *s)
4178 if (s == NULL || s->session == NULL)
4180 return s->session->psk_identity;
4183 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4185 s->psk_client_callback = cb;
4188 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4190 ctx->psk_client_callback = cb;
4193 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4195 s->psk_server_callback = cb;
4198 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4200 ctx->psk_server_callback = cb;
4204 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4206 s->psk_find_session_cb = cb;
4209 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4210 SSL_psk_find_session_cb_func cb)
4212 ctx->psk_find_session_cb = cb;
4215 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4217 s->psk_use_session_cb = cb;
4220 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4221 SSL_psk_use_session_cb_func cb)
4223 ctx->psk_use_session_cb = cb;
4226 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4227 void (*cb) (int write_p, int version,
4228 int content_type, const void *buf,
4229 size_t len, SSL *ssl, void *arg))
4231 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4234 void SSL_set_msg_callback(SSL *ssl,
4235 void (*cb) (int write_p, int version,
4236 int content_type, const void *buf,
4237 size_t len, SSL *ssl, void *arg))
4239 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4242 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4243 int (*cb) (SSL *ssl,
4247 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4248 (void (*)(void))cb);
4251 void SSL_set_not_resumable_session_callback(SSL *ssl,
4252 int (*cb) (SSL *ssl,
4253 int is_forward_secure))
4255 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4256 (void (*)(void))cb);
4259 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4260 size_t (*cb) (SSL *ssl, int type,
4261 size_t len, void *arg))
4263 ctx->record_padding_cb = cb;
4266 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4268 ctx->record_padding_arg = arg;
4271 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4273 return ctx->record_padding_arg;
4276 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4278 /* block size of 0 or 1 is basically no padding */
4279 if (block_size == 1)
4280 ctx->block_padding = 0;
4281 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4282 ctx->block_padding = block_size;
4288 void SSL_set_record_padding_callback(SSL *ssl,
4289 size_t (*cb) (SSL *ssl, int type,
4290 size_t len, void *arg))
4292 ssl->record_padding_cb = cb;
4295 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4297 ssl->record_padding_arg = arg;
4300 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4302 return ssl->record_padding_arg;
4305 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4307 /* block size of 0 or 1 is basically no padding */
4308 if (block_size == 1)
4309 ssl->block_padding = 0;
4310 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4311 ssl->block_padding = block_size;
4318 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4319 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4320 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4321 * Returns the newly allocated ctx;
4324 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4326 ssl_clear_hash_ctx(hash);
4327 *hash = EVP_MD_CTX_new();
4328 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4329 EVP_MD_CTX_free(*hash);
4336 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4339 EVP_MD_CTX_free(*hash);
4343 /* Retrieve handshake hashes */
4344 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4347 EVP_MD_CTX *ctx = NULL;
4348 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4349 int hashleni = EVP_MD_CTX_size(hdgst);
4352 if (hashleni < 0 || (size_t)hashleni > outlen) {
4353 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4354 ERR_R_INTERNAL_ERROR);
4358 ctx = EVP_MD_CTX_new();
4362 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4363 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4364 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4365 ERR_R_INTERNAL_ERROR);
4369 *hashlen = hashleni;
4373 EVP_MD_CTX_free(ctx);
4377 int SSL_session_reused(SSL *s)
4382 int SSL_is_server(const SSL *s)
4387 #if OPENSSL_API_COMPAT < 0x10100000L
4388 void SSL_set_debug(SSL *s, int debug)
4390 /* Old function was do-nothing anyway... */
4396 void SSL_set_security_level(SSL *s, int level)
4398 s->cert->sec_level = level;
4401 int SSL_get_security_level(const SSL *s)
4403 return s->cert->sec_level;
4406 void SSL_set_security_callback(SSL *s,
4407 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4408 int op, int bits, int nid,
4409 void *other, void *ex))
4411 s->cert->sec_cb = cb;
4414 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4415 const SSL_CTX *ctx, int op,
4416 int bits, int nid, void *other,
4418 return s->cert->sec_cb;
4421 void SSL_set0_security_ex_data(SSL *s, void *ex)
4423 s->cert->sec_ex = ex;
4426 void *SSL_get0_security_ex_data(const SSL *s)
4428 return s->cert->sec_ex;
4431 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4433 ctx->cert->sec_level = level;
4436 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4438 return ctx->cert->sec_level;
4441 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4442 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4443 int op, int bits, int nid,
4444 void *other, void *ex))
4446 ctx->cert->sec_cb = cb;
4449 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4455 return ctx->cert->sec_cb;
4458 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4460 ctx->cert->sec_ex = ex;
4463 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4465 return ctx->cert->sec_ex;
4469 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4470 * can return unsigned long, instead of the generic long return value from the
4471 * control interface.
4473 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4475 return ctx->options;
4478 unsigned long SSL_get_options(const SSL *s)
4483 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4485 return ctx->options |= op;
4488 unsigned long SSL_set_options(SSL *s, unsigned long op)
4490 return s->options |= op;
4493 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4495 return ctx->options &= ~op;
4498 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4500 return s->options &= ~op;
4503 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4505 return s->verified_chain;
4508 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4510 #ifndef OPENSSL_NO_CT
4513 * Moves SCTs from the |src| stack to the |dst| stack.
4514 * The source of each SCT will be set to |origin|.
4515 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4517 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4519 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4520 sct_source_t origin)
4526 *dst = sk_SCT_new_null();
4528 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4533 while ((sct = sk_SCT_pop(src)) != NULL) {
4534 if (SCT_set_source(sct, origin) != 1)
4537 if (sk_SCT_push(*dst, sct) <= 0)
4545 sk_SCT_push(src, sct); /* Put the SCT back */
4550 * Look for data collected during ServerHello and parse if found.
4551 * Returns the number of SCTs extracted.
4553 static int ct_extract_tls_extension_scts(SSL *s)
4555 int scts_extracted = 0;
4557 if (s->ext.scts != NULL) {
4558 const unsigned char *p = s->ext.scts;
4559 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4561 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4563 SCT_LIST_free(scts);
4566 return scts_extracted;
4570 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4571 * contains an SCT X509 extension. They will be stored in |s->scts|.
4573 * - The number of SCTs extracted, assuming an OCSP response exists.
4574 * - 0 if no OCSP response exists or it contains no SCTs.
4575 * - A negative integer if an error occurs.
4577 static int ct_extract_ocsp_response_scts(SSL *s)
4579 # ifndef OPENSSL_NO_OCSP
4580 int scts_extracted = 0;
4581 const unsigned char *p;
4582 OCSP_BASICRESP *br = NULL;
4583 OCSP_RESPONSE *rsp = NULL;
4584 STACK_OF(SCT) *scts = NULL;
4587 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4590 p = s->ext.ocsp.resp;
4591 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4595 br = OCSP_response_get1_basic(rsp);
4599 for (i = 0; i < OCSP_resp_count(br); ++i) {
4600 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4606 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4608 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4609 if (scts_extracted < 0)
4613 SCT_LIST_free(scts);
4614 OCSP_BASICRESP_free(br);
4615 OCSP_RESPONSE_free(rsp);
4616 return scts_extracted;
4618 /* Behave as if no OCSP response exists */
4624 * Attempts to extract SCTs from the peer certificate.
4625 * Return the number of SCTs extracted, or a negative integer if an error
4628 static int ct_extract_x509v3_extension_scts(SSL *s)
4630 int scts_extracted = 0;
4631 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4634 STACK_OF(SCT) *scts =
4635 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4638 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4640 SCT_LIST_free(scts);
4643 return scts_extracted;
4647 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4648 * response (if it exists) and X509v3 extensions in the certificate.
4649 * Returns NULL if an error occurs.
4651 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4653 if (!s->scts_parsed) {
4654 if (ct_extract_tls_extension_scts(s) < 0 ||
4655 ct_extract_ocsp_response_scts(s) < 0 ||
4656 ct_extract_x509v3_extension_scts(s) < 0)
4666 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4667 const STACK_OF(SCT) *scts, void *unused_arg)
4672 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4673 const STACK_OF(SCT) *scts, void *unused_arg)
4675 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4678 for (i = 0; i < count; ++i) {
4679 SCT *sct = sk_SCT_value(scts, i);
4680 int status = SCT_get_validation_status(sct);
4682 if (status == SCT_VALIDATION_STATUS_VALID)
4685 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4689 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4693 * Since code exists that uses the custom extension handler for CT, look
4694 * for this and throw an error if they have already registered to use CT.
4696 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4697 TLSEXT_TYPE_signed_certificate_timestamp))
4699 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4700 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4704 if (callback != NULL) {
4706 * If we are validating CT, then we MUST accept SCTs served via OCSP
4708 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4712 s->ct_validation_callback = callback;
4713 s->ct_validation_callback_arg = arg;
4718 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4719 ssl_ct_validation_cb callback, void *arg)
4722 * Since code exists that uses the custom extension handler for CT, look for
4723 * this and throw an error if they have already registered to use CT.
4725 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4726 TLSEXT_TYPE_signed_certificate_timestamp))
4728 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4729 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4733 ctx->ct_validation_callback = callback;
4734 ctx->ct_validation_callback_arg = arg;
4738 int SSL_ct_is_enabled(const SSL *s)
4740 return s->ct_validation_callback != NULL;
4743 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4745 return ctx->ct_validation_callback != NULL;
4748 int ssl_validate_ct(SSL *s)
4751 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4753 SSL_DANE *dane = &s->dane;
4754 CT_POLICY_EVAL_CTX *ctx = NULL;
4755 const STACK_OF(SCT) *scts;
4758 * If no callback is set, the peer is anonymous, or its chain is invalid,
4759 * skip SCT validation - just return success. Applications that continue
4760 * handshakes without certificates, with unverified chains, or pinned leaf
4761 * certificates are outside the scope of the WebPKI and CT.
4763 * The above exclusions notwithstanding the vast majority of peers will
4764 * have rather ordinary certificate chains validated by typical
4765 * applications that perform certificate verification and therefore will
4766 * process SCTs when enabled.
4768 if (s->ct_validation_callback == NULL || cert == NULL ||
4769 s->verify_result != X509_V_OK ||
4770 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4774 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4775 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4777 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4778 switch (dane->mtlsa->usage) {
4779 case DANETLS_USAGE_DANE_TA:
4780 case DANETLS_USAGE_DANE_EE:
4785 ctx = CT_POLICY_EVAL_CTX_new();
4787 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4788 ERR_R_MALLOC_FAILURE);
4792 issuer = sk_X509_value(s->verified_chain, 1);
4793 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4794 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4795 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4796 CT_POLICY_EVAL_CTX_set_time(
4797 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4799 scts = SSL_get0_peer_scts(s);
4802 * This function returns success (> 0) only when all the SCTs are valid, 0
4803 * when some are invalid, and < 0 on various internal errors (out of
4804 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4805 * reason to abort the handshake, that decision is up to the callback.
4806 * Therefore, we error out only in the unexpected case that the return
4807 * value is negative.
4809 * XXX: One might well argue that the return value of this function is an
4810 * unfortunate design choice. Its job is only to determine the validation
4811 * status of each of the provided SCTs. So long as it correctly separates
4812 * the wheat from the chaff it should return success. Failure in this case
4813 * ought to correspond to an inability to carry out its duties.
4815 if (SCT_LIST_validate(scts, ctx) < 0) {
4816 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4817 SSL_R_SCT_VERIFICATION_FAILED);
4821 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4823 ret = 0; /* This function returns 0 on failure */
4825 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4826 SSL_R_CALLBACK_FAILED);
4829 CT_POLICY_EVAL_CTX_free(ctx);
4831 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4832 * failure return code here. Also the application may wish the complete
4833 * the handshake, and then disconnect cleanly at a higher layer, after
4834 * checking the verification status of the completed connection.
4836 * We therefore force a certificate verification failure which will be
4837 * visible via SSL_get_verify_result() and cached as part of any resumed
4840 * Note: the permissive callback is for information gathering only, always
4841 * returns success, and does not affect verification status. Only the
4842 * strict callback or a custom application-specified callback can trigger
4843 * connection failure or record a verification error.
4846 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4850 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4852 switch (validation_mode) {
4854 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4856 case SSL_CT_VALIDATION_PERMISSIVE:
4857 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4858 case SSL_CT_VALIDATION_STRICT:
4859 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4863 int SSL_enable_ct(SSL *s, int validation_mode)
4865 switch (validation_mode) {
4867 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4869 case SSL_CT_VALIDATION_PERMISSIVE:
4870 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4871 case SSL_CT_VALIDATION_STRICT:
4872 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4876 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4878 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4881 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4883 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4886 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4888 CTLOG_STORE_free(ctx->ctlog_store);
4889 ctx->ctlog_store = logs;
4892 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4894 return ctx->ctlog_store;
4897 #endif /* OPENSSL_NO_CT */
4899 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4902 c->client_hello_cb = cb;
4903 c->client_hello_cb_arg = arg;
4906 int SSL_client_hello_isv2(SSL *s)
4908 if (s->clienthello == NULL)
4910 return s->clienthello->isv2;
4913 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4915 if (s->clienthello == NULL)
4917 return s->clienthello->legacy_version;
4920 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
4922 if (s->clienthello == NULL)
4925 *out = s->clienthello->random;
4926 return SSL3_RANDOM_SIZE;
4929 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
4931 if (s->clienthello == NULL)
4934 *out = s->clienthello->session_id;
4935 return s->clienthello->session_id_len;
4938 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
4940 if (s->clienthello == NULL)
4943 *out = PACKET_data(&s->clienthello->ciphersuites);
4944 return PACKET_remaining(&s->clienthello->ciphersuites);
4947 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
4949 if (s->clienthello == NULL)
4952 *out = s->clienthello->compressions;
4953 return s->clienthello->compressions_len;
4956 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
4962 if (s->clienthello == NULL || out == NULL || outlen == NULL)
4964 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
4965 ext = s->clienthello->pre_proc_exts + i;
4969 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
4970 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
4971 ERR_R_MALLOC_FAILURE);
4974 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
4975 ext = s->clienthello->pre_proc_exts + i;
4977 if (ext->received_order >= num)
4979 present[ext->received_order] = ext->type;
4986 OPENSSL_free(present);
4990 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4996 if (s->clienthello == NULL)
4998 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4999 r = s->clienthello->pre_proc_exts + i;
5000 if (r->present && r->type == type) {
5002 *out = PACKET_data(&r->data);
5004 *outlen = PACKET_remaining(&r->data);
5011 int SSL_free_buffers(SSL *ssl)
5013 RECORD_LAYER *rl = &ssl->rlayer;
5015 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5018 RECORD_LAYER_release(rl);
5022 int SSL_alloc_buffers(SSL *ssl)
5024 return ssl3_setup_buffers(ssl);
5027 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5029 ctx->keylog_callback = cb;
5032 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5034 return ctx->keylog_callback;
5037 static int nss_keylog_int(const char *prefix,
5039 const uint8_t *parameter_1,
5040 size_t parameter_1_len,
5041 const uint8_t *parameter_2,
5042 size_t parameter_2_len)
5045 char *cursor = NULL;
5050 if (ssl->ctx->keylog_callback == NULL) return 1;
5053 * Our output buffer will contain the following strings, rendered with
5054 * space characters in between, terminated by a NULL character: first the
5055 * prefix, then the first parameter, then the second parameter. The
5056 * meaning of each parameter depends on the specific key material being
5057 * logged. Note that the first and second parameters are encoded in
5058 * hexadecimal, so we need a buffer that is twice their lengths.
5060 prefix_len = strlen(prefix);
5061 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
5062 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5063 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5064 ERR_R_MALLOC_FAILURE);
5068 strcpy(cursor, prefix);
5069 cursor += prefix_len;
5072 for (i = 0; i < parameter_1_len; i++) {
5073 sprintf(cursor, "%02x", parameter_1[i]);
5078 for (i = 0; i < parameter_2_len; i++) {
5079 sprintf(cursor, "%02x", parameter_2[i]);
5084 ssl->ctx->keylog_callback(ssl, (const char *)out);
5090 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5091 const uint8_t *encrypted_premaster,
5092 size_t encrypted_premaster_len,
5093 const uint8_t *premaster,
5094 size_t premaster_len)
5096 if (encrypted_premaster_len < 8) {
5097 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5098 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5102 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5103 return nss_keylog_int("RSA",
5105 encrypted_premaster,
5111 int ssl_log_secret(SSL *ssl,
5113 const uint8_t *secret,
5116 return nss_keylog_int(label,
5118 ssl->s3->client_random,
5124 #define SSLV2_CIPHER_LEN 3
5126 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5130 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5132 if (PACKET_remaining(cipher_suites) == 0) {
5133 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5134 SSL_R_NO_CIPHERS_SPECIFIED);
5138 if (PACKET_remaining(cipher_suites) % n != 0) {
5139 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5140 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5144 OPENSSL_free(s->s3->tmp.ciphers_raw);
5145 s->s3->tmp.ciphers_raw = NULL;
5146 s->s3->tmp.ciphers_rawlen = 0;
5149 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5150 PACKET sslv2ciphers = *cipher_suites;
5151 unsigned int leadbyte;
5155 * We store the raw ciphers list in SSLv3+ format so we need to do some
5156 * preprocessing to convert the list first. If there are any SSLv2 only
5157 * ciphersuites with a non-zero leading byte then we are going to
5158 * slightly over allocate because we won't store those. But that isn't a
5161 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5162 s->s3->tmp.ciphers_raw = raw;
5164 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5165 ERR_R_MALLOC_FAILURE);
5168 for (s->s3->tmp.ciphers_rawlen = 0;
5169 PACKET_remaining(&sslv2ciphers) > 0;
5170 raw += TLS_CIPHER_LEN) {
5171 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5173 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5176 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5177 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5179 OPENSSL_free(s->s3->tmp.ciphers_raw);
5180 s->s3->tmp.ciphers_raw = NULL;
5181 s->s3->tmp.ciphers_rawlen = 0;
5185 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5187 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5188 &s->s3->tmp.ciphers_rawlen)) {
5189 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5190 ERR_R_INTERNAL_ERROR);
5196 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5197 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5198 STACK_OF(SSL_CIPHER) **scsvs)
5202 if (!PACKET_buf_init(&pkt, bytes, len))
5204 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5207 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5208 STACK_OF(SSL_CIPHER) **skp,
5209 STACK_OF(SSL_CIPHER) **scsvs_out,
5210 int sslv2format, int fatal)
5212 const SSL_CIPHER *c;
5213 STACK_OF(SSL_CIPHER) *sk = NULL;
5214 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5216 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5217 unsigned char cipher[SSLV2_CIPHER_LEN];
5219 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5221 if (PACKET_remaining(cipher_suites) == 0) {
5223 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5224 SSL_R_NO_CIPHERS_SPECIFIED);
5226 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5230 if (PACKET_remaining(cipher_suites) % n != 0) {
5232 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5233 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5235 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5236 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5240 sk = sk_SSL_CIPHER_new_null();
5241 scsvs = sk_SSL_CIPHER_new_null();
5242 if (sk == NULL || scsvs == NULL) {
5244 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5245 ERR_R_MALLOC_FAILURE);
5247 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5251 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5253 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5254 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5255 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5257 if (sslv2format && cipher[0] != '\0')
5260 /* For SSLv2-compat, ignore leading 0-byte. */
5261 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5263 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5264 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5266 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5267 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5269 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5274 if (PACKET_remaining(cipher_suites) > 0) {
5276 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5279 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5286 sk_SSL_CIPHER_free(sk);
5287 if (scsvs_out != NULL)
5290 sk_SSL_CIPHER_free(scsvs);
5293 sk_SSL_CIPHER_free(sk);
5294 sk_SSL_CIPHER_free(scsvs);
5298 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5300 ctx->max_early_data = max_early_data;
5305 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5307 return ctx->max_early_data;
5310 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5312 s->max_early_data = max_early_data;
5317 uint32_t SSL_get_max_early_data(const SSL *s)
5319 return s->max_early_data;
5322 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5324 /* Return any active Max Fragment Len extension */
5325 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5326 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5328 /* return current SSL connection setting */
5329 return ssl->max_send_fragment;
5332 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5334 /* Return a value regarding an active Max Fragment Len extension */
5335 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5336 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5337 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5339 /* else limit |split_send_fragment| to current |max_send_fragment| */
5340 if (ssl->split_send_fragment > ssl->max_send_fragment)
5341 return ssl->max_send_fragment;
5343 /* return current SSL connection setting */
5344 return ssl->split_send_fragment;
5347 int SSL_stateless(SSL *s)
5351 /* Ensure there is no state left over from a previous invocation */
5357 s->s3->flags |= TLS1_FLAGS_STATELESS;
5358 ret = SSL_accept(s);
5359 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5361 if (ret > 0 && s->ext.cookieok)
5364 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5370 void SSL_force_post_handshake_auth(SSL *ssl)
5372 ssl->pha_forced = 1;
5375 int SSL_verify_client_post_handshake(SSL *ssl)
5377 if (!SSL_IS_TLS13(ssl)) {
5378 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5382 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5386 if (!SSL_is_init_finished(ssl)) {
5387 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5391 switch (ssl->post_handshake_auth) {
5393 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5396 case SSL_PHA_EXT_SENT:
5397 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5399 case SSL_PHA_EXT_RECEIVED:
5401 case SSL_PHA_REQUEST_PENDING:
5402 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5404 case SSL_PHA_REQUESTED:
5405 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5409 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5411 /* checks verify_mode and algorithm_auth */
5412 if (!send_certificate_request(ssl)) {
5413 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5414 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5418 ossl_statem_set_in_init(ssl, 1);
5422 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5423 SSL_CTX_generate_session_ticket_fn gen_cb,
5424 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5427 ctx->generate_ticket_cb = gen_cb;
5428 ctx->decrypt_ticket_cb = dec_cb;
5429 ctx->ticket_cb_data = arg;