2 * Copyright 1995-2019 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;
600 if (s->renegotiate) {
601 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
605 ossl_statem_clear(s);
607 s->version = s->method->version;
608 s->client_version = s->version;
609 s->rwstate = SSL_NOTHING;
611 BUF_MEM_free(s->init_buf);
616 s->key_update = SSL_KEY_UPDATE_NONE;
618 EVP_MD_CTX_free(s->pha_dgst);
621 /* Reset DANE verification result state */
624 X509_free(s->dane.mcert);
625 s->dane.mcert = NULL;
626 s->dane.mtlsa = NULL;
628 /* Clear the verification result peername */
629 X509_VERIFY_PARAM_move_peername(s->param, NULL);
631 /* Clear any shared connection state */
632 OPENSSL_free(s->shared_sigalgs);
633 s->shared_sigalgs = NULL;
634 s->shared_sigalgslen = 0;
637 * Check to see if we were changed into a different method, if so, revert
640 if (s->method != s->ctx->method) {
641 s->method->ssl_free(s);
642 s->method = s->ctx->method;
643 if (!s->method->ssl_new(s))
646 if (!s->method->ssl_clear(s))
650 RECORD_LAYER_clear(&s->rlayer);
655 /** Used to change an SSL_CTXs default SSL method type */
656 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
658 STACK_OF(SSL_CIPHER) *sk;
662 if (!SSL_CTX_set_ciphersuites(ctx, TLS_DEFAULT_CIPHERSUITES)) {
663 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
666 sk = ssl_create_cipher_list(ctx->method,
667 ctx->tls13_ciphersuites,
669 &(ctx->cipher_list_by_id),
670 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
671 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
672 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
678 SSL *SSL_new(SSL_CTX *ctx)
683 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
686 if (ctx->method == NULL) {
687 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
691 s = OPENSSL_zalloc(sizeof(*s));
696 s->lock = CRYPTO_THREAD_lock_new();
697 if (s->lock == NULL) {
703 RECORD_LAYER_init(&s->rlayer, s);
705 s->options = ctx->options;
706 s->dane.flags = ctx->dane.flags;
707 s->min_proto_version = ctx->min_proto_version;
708 s->max_proto_version = ctx->max_proto_version;
710 s->max_cert_list = ctx->max_cert_list;
711 s->max_early_data = ctx->max_early_data;
712 s->recv_max_early_data = ctx->recv_max_early_data;
713 s->num_tickets = ctx->num_tickets;
714 s->pha_enabled = ctx->pha_enabled;
716 /* Shallow copy of the ciphersuites stack */
717 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
718 if (s->tls13_ciphersuites == NULL)
722 * Earlier library versions used to copy the pointer to the CERT, not
723 * its contents; only when setting new parameters for the per-SSL
724 * copy, ssl_cert_new would be called (and the direct reference to
725 * the per-SSL_CTX settings would be lost, but those still were
726 * indirectly accessed for various purposes, and for that reason they
727 * used to be known as s->ctx->default_cert). Now we don't look at the
728 * SSL_CTX's CERT after having duplicated it once.
730 s->cert = ssl_cert_dup(ctx->cert);
734 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
735 s->msg_callback = ctx->msg_callback;
736 s->msg_callback_arg = ctx->msg_callback_arg;
737 s->verify_mode = ctx->verify_mode;
738 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
739 s->record_padding_cb = ctx->record_padding_cb;
740 s->record_padding_arg = ctx->record_padding_arg;
741 s->block_padding = ctx->block_padding;
742 s->sid_ctx_length = ctx->sid_ctx_length;
743 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
745 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
746 s->verify_callback = ctx->default_verify_callback;
747 s->generate_session_id = ctx->generate_session_id;
749 s->param = X509_VERIFY_PARAM_new();
750 if (s->param == NULL)
752 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
753 s->quiet_shutdown = ctx->quiet_shutdown;
755 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
756 s->max_send_fragment = ctx->max_send_fragment;
757 s->split_send_fragment = ctx->split_send_fragment;
758 s->max_pipelines = ctx->max_pipelines;
759 if (s->max_pipelines > 1)
760 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
761 if (ctx->default_read_buf_len > 0)
762 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
767 s->ext.debug_arg = NULL;
768 s->ext.ticket_expected = 0;
769 s->ext.status_type = ctx->ext.status_type;
770 s->ext.status_expected = 0;
771 s->ext.ocsp.ids = NULL;
772 s->ext.ocsp.exts = NULL;
773 s->ext.ocsp.resp = NULL;
774 s->ext.ocsp.resp_len = 0;
776 s->session_ctx = ctx;
777 #ifndef OPENSSL_NO_EC
778 if (ctx->ext.ecpointformats) {
779 s->ext.ecpointformats =
780 OPENSSL_memdup(ctx->ext.ecpointformats,
781 ctx->ext.ecpointformats_len);
782 if (!s->ext.ecpointformats)
784 s->ext.ecpointformats_len =
785 ctx->ext.ecpointformats_len;
787 if (ctx->ext.supportedgroups) {
788 s->ext.supportedgroups =
789 OPENSSL_memdup(ctx->ext.supportedgroups,
790 ctx->ext.supportedgroups_len
791 * sizeof(*ctx->ext.supportedgroups));
792 if (!s->ext.supportedgroups)
794 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
797 #ifndef OPENSSL_NO_NEXTPROTONEG
801 if (s->ctx->ext.alpn) {
802 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
803 if (s->ext.alpn == NULL)
805 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
806 s->ext.alpn_len = s->ctx->ext.alpn_len;
809 s->verified_chain = NULL;
810 s->verify_result = X509_V_OK;
812 s->default_passwd_callback = ctx->default_passwd_callback;
813 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
815 s->method = ctx->method;
817 s->key_update = SSL_KEY_UPDATE_NONE;
819 s->allow_early_data_cb = ctx->allow_early_data_cb;
820 s->allow_early_data_cb_data = ctx->allow_early_data_cb_data;
822 if (!s->method->ssl_new(s))
825 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
830 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
833 #ifndef OPENSSL_NO_PSK
834 s->psk_client_callback = ctx->psk_client_callback;
835 s->psk_server_callback = ctx->psk_server_callback;
837 s->psk_find_session_cb = ctx->psk_find_session_cb;
838 s->psk_use_session_cb = ctx->psk_use_session_cb;
842 #ifndef OPENSSL_NO_CT
843 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
844 ctx->ct_validation_callback_arg))
851 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
855 int SSL_is_dtls(const SSL *s)
857 return SSL_IS_DTLS(s) ? 1 : 0;
860 int SSL_up_ref(SSL *s)
864 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
867 REF_PRINT_COUNT("SSL", s);
868 REF_ASSERT_ISNT(i < 2);
869 return ((i > 1) ? 1 : 0);
872 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
873 unsigned int sid_ctx_len)
875 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
876 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
877 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
880 ctx->sid_ctx_length = sid_ctx_len;
881 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
886 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
887 unsigned int sid_ctx_len)
889 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
890 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
891 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
894 ssl->sid_ctx_length = sid_ctx_len;
895 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
900 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
902 CRYPTO_THREAD_write_lock(ctx->lock);
903 ctx->generate_session_id = cb;
904 CRYPTO_THREAD_unlock(ctx->lock);
908 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
910 CRYPTO_THREAD_write_lock(ssl->lock);
911 ssl->generate_session_id = cb;
912 CRYPTO_THREAD_unlock(ssl->lock);
916 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
920 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
921 * we can "construct" a session to give us the desired check - i.e. to
922 * find if there's a session in the hash table that would conflict with
923 * any new session built out of this id/id_len and the ssl_version in use
928 if (id_len > sizeof(r.session_id))
931 r.ssl_version = ssl->version;
932 r.session_id_length = id_len;
933 memcpy(r.session_id, id, id_len);
935 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
936 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
937 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
941 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
943 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
946 int SSL_set_purpose(SSL *s, int purpose)
948 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
951 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
953 return X509_VERIFY_PARAM_set_trust(s->param, trust);
956 int SSL_set_trust(SSL *s, int trust)
958 return X509_VERIFY_PARAM_set_trust(s->param, trust);
961 int SSL_set1_host(SSL *s, const char *hostname)
963 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
966 int SSL_add1_host(SSL *s, const char *hostname)
968 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
971 void SSL_set_hostflags(SSL *s, unsigned int flags)
973 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
976 const char *SSL_get0_peername(SSL *s)
978 return X509_VERIFY_PARAM_get0_peername(s->param);
981 int SSL_CTX_dane_enable(SSL_CTX *ctx)
983 return dane_ctx_enable(&ctx->dane);
986 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
988 unsigned long orig = ctx->dane.flags;
990 ctx->dane.flags |= flags;
994 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
996 unsigned long orig = ctx->dane.flags;
998 ctx->dane.flags &= ~flags;
1002 int SSL_dane_enable(SSL *s, const char *basedomain)
1004 SSL_DANE *dane = &s->dane;
1006 if (s->ctx->dane.mdmax == 0) {
1007 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
1010 if (dane->trecs != NULL) {
1011 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1016 * Default SNI name. This rejects empty names, while set1_host below
1017 * accepts them and disables host name checks. To avoid side-effects with
1018 * invalid input, set the SNI name first.
1020 if (s->ext.hostname == NULL) {
1021 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1022 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1027 /* Primary RFC6125 reference identifier */
1028 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1029 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1035 dane->dctx = &s->ctx->dane;
1036 dane->trecs = sk_danetls_record_new_null();
1038 if (dane->trecs == NULL) {
1039 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1045 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1047 unsigned long orig = ssl->dane.flags;
1049 ssl->dane.flags |= flags;
1053 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1055 unsigned long orig = ssl->dane.flags;
1057 ssl->dane.flags &= ~flags;
1061 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1063 SSL_DANE *dane = &s->dane;
1065 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1069 *mcert = dane->mcert;
1071 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1076 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1077 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1079 SSL_DANE *dane = &s->dane;
1081 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1085 *usage = dane->mtlsa->usage;
1087 *selector = dane->mtlsa->selector;
1089 *mtype = dane->mtlsa->mtype;
1091 *data = dane->mtlsa->data;
1093 *dlen = dane->mtlsa->dlen;
1098 SSL_DANE *SSL_get0_dane(SSL *s)
1103 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1104 uint8_t mtype, unsigned const char *data, size_t dlen)
1106 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1109 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1112 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1115 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1117 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1120 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1122 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1125 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1130 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1135 void SSL_certs_clear(SSL *s)
1137 ssl_cert_clear_certs(s->cert);
1140 void SSL_free(SSL *s)
1146 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1147 REF_PRINT_COUNT("SSL", s);
1150 REF_ASSERT_ISNT(i < 0);
1152 X509_VERIFY_PARAM_free(s->param);
1153 dane_final(&s->dane);
1154 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1156 /* Ignore return value */
1157 ssl_free_wbio_buffer(s);
1159 BIO_free_all(s->wbio);
1160 BIO_free_all(s->rbio);
1162 BUF_MEM_free(s->init_buf);
1164 /* add extra stuff */
1165 sk_SSL_CIPHER_free(s->cipher_list);
1166 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1167 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1168 sk_SSL_CIPHER_free(s->peer_ciphers);
1170 /* Make the next call work :-) */
1171 if (s->session != NULL) {
1172 ssl_clear_bad_session(s);
1173 SSL_SESSION_free(s->session);
1175 SSL_SESSION_free(s->psksession);
1176 OPENSSL_free(s->psksession_id);
1180 ssl_cert_free(s->cert);
1181 OPENSSL_free(s->shared_sigalgs);
1182 /* Free up if allocated */
1184 OPENSSL_free(s->ext.hostname);
1185 SSL_CTX_free(s->session_ctx);
1186 #ifndef OPENSSL_NO_EC
1187 OPENSSL_free(s->ext.ecpointformats);
1188 OPENSSL_free(s->ext.peer_ecpointformats);
1189 OPENSSL_free(s->ext.supportedgroups);
1190 OPENSSL_free(s->ext.peer_supportedgroups);
1191 #endif /* OPENSSL_NO_EC */
1192 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1193 #ifndef OPENSSL_NO_OCSP
1194 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1196 #ifndef OPENSSL_NO_CT
1197 SCT_LIST_free(s->scts);
1198 OPENSSL_free(s->ext.scts);
1200 OPENSSL_free(s->ext.ocsp.resp);
1201 OPENSSL_free(s->ext.alpn);
1202 OPENSSL_free(s->ext.tls13_cookie);
1203 OPENSSL_free(s->clienthello);
1204 OPENSSL_free(s->pha_context);
1205 EVP_MD_CTX_free(s->pha_dgst);
1207 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1208 sk_X509_NAME_pop_free(s->client_ca_names, X509_NAME_free);
1210 sk_X509_pop_free(s->verified_chain, X509_free);
1212 if (s->method != NULL)
1213 s->method->ssl_free(s);
1215 RECORD_LAYER_release(&s->rlayer);
1217 SSL_CTX_free(s->ctx);
1219 ASYNC_WAIT_CTX_free(s->waitctx);
1221 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1222 OPENSSL_free(s->ext.npn);
1225 #ifndef OPENSSL_NO_SRTP
1226 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1229 CRYPTO_THREAD_lock_free(s->lock);
1234 void SSL_set0_rbio(SSL *s, BIO *rbio)
1236 BIO_free_all(s->rbio);
1240 void SSL_set0_wbio(SSL *s, BIO *wbio)
1243 * If the output buffering BIO is still in place, remove it
1245 if (s->bbio != NULL)
1246 s->wbio = BIO_pop(s->wbio);
1248 BIO_free_all(s->wbio);
1251 /* Re-attach |bbio| to the new |wbio|. */
1252 if (s->bbio != NULL)
1253 s->wbio = BIO_push(s->bbio, s->wbio);
1256 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1259 * For historical reasons, this function has many different cases in
1260 * ownership handling.
1263 /* If nothing has changed, do nothing */
1264 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1268 * If the two arguments are equal then one fewer reference is granted by the
1269 * caller than we want to take
1271 if (rbio != NULL && rbio == wbio)
1275 * If only the wbio is changed only adopt one reference.
1277 if (rbio == SSL_get_rbio(s)) {
1278 SSL_set0_wbio(s, wbio);
1282 * There is an asymmetry here for historical reasons. If only the rbio is
1283 * changed AND the rbio and wbio were originally different, then we only
1284 * adopt one reference.
1286 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1287 SSL_set0_rbio(s, rbio);
1291 /* Otherwise, adopt both references. */
1292 SSL_set0_rbio(s, rbio);
1293 SSL_set0_wbio(s, wbio);
1296 BIO *SSL_get_rbio(const SSL *s)
1301 BIO *SSL_get_wbio(const SSL *s)
1303 if (s->bbio != NULL) {
1305 * If |bbio| is active, the true caller-configured BIO is its
1308 return BIO_next(s->bbio);
1313 int SSL_get_fd(const SSL *s)
1315 return SSL_get_rfd(s);
1318 int SSL_get_rfd(const SSL *s)
1323 b = SSL_get_rbio(s);
1324 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1326 BIO_get_fd(r, &ret);
1330 int SSL_get_wfd(const SSL *s)
1335 b = SSL_get_wbio(s);
1336 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1338 BIO_get_fd(r, &ret);
1342 #ifndef OPENSSL_NO_SOCK
1343 int SSL_set_fd(SSL *s, int fd)
1348 bio = BIO_new(BIO_s_socket());
1351 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1354 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1355 SSL_set_bio(s, bio, bio);
1361 int SSL_set_wfd(SSL *s, int fd)
1363 BIO *rbio = SSL_get_rbio(s);
1365 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1366 || (int)BIO_get_fd(rbio, NULL) != fd) {
1367 BIO *bio = BIO_new(BIO_s_socket());
1370 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1373 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1374 SSL_set0_wbio(s, bio);
1377 SSL_set0_wbio(s, rbio);
1382 int SSL_set_rfd(SSL *s, int fd)
1384 BIO *wbio = SSL_get_wbio(s);
1386 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1387 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1388 BIO *bio = BIO_new(BIO_s_socket());
1391 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1394 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1395 SSL_set0_rbio(s, bio);
1398 SSL_set0_rbio(s, wbio);
1405 /* return length of latest Finished message we sent, copy to 'buf' */
1406 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1410 if (s->s3 != NULL) {
1411 ret = s->s3->tmp.finish_md_len;
1414 memcpy(buf, s->s3->tmp.finish_md, count);
1419 /* return length of latest Finished message we expected, copy to 'buf' */
1420 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1424 if (s->s3 != NULL) {
1425 ret = s->s3->tmp.peer_finish_md_len;
1428 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1433 int SSL_get_verify_mode(const SSL *s)
1435 return s->verify_mode;
1438 int SSL_get_verify_depth(const SSL *s)
1440 return X509_VERIFY_PARAM_get_depth(s->param);
1443 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1444 return s->verify_callback;
1447 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1449 return ctx->verify_mode;
1452 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1454 return X509_VERIFY_PARAM_get_depth(ctx->param);
1457 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1458 return ctx->default_verify_callback;
1461 void SSL_set_verify(SSL *s, int mode,
1462 int (*callback) (int ok, X509_STORE_CTX *ctx))
1464 s->verify_mode = mode;
1465 if (callback != NULL)
1466 s->verify_callback = callback;
1469 void SSL_set_verify_depth(SSL *s, int depth)
1471 X509_VERIFY_PARAM_set_depth(s->param, depth);
1474 void SSL_set_read_ahead(SSL *s, int yes)
1476 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1479 int SSL_get_read_ahead(const SSL *s)
1481 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1484 int SSL_pending(const SSL *s)
1486 size_t pending = s->method->ssl_pending(s);
1489 * SSL_pending cannot work properly if read-ahead is enabled
1490 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1491 * impossible to fix since SSL_pending cannot report errors that may be
1492 * observed while scanning the new data. (Note that SSL_pending() is
1493 * often used as a boolean value, so we'd better not return -1.)
1495 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1496 * we just return INT_MAX.
1498 return pending < INT_MAX ? (int)pending : INT_MAX;
1501 int SSL_has_pending(const SSL *s)
1504 * Similar to SSL_pending() but returns a 1 to indicate that we have
1505 * unprocessed data available or 0 otherwise (as opposed to the number of
1506 * bytes available). Unlike SSL_pending() this will take into account
1507 * read_ahead data. A 1 return simply indicates that we have unprocessed
1508 * data. That data may not result in any application data, or we may fail
1509 * to parse the records for some reason.
1511 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1514 return RECORD_LAYER_read_pending(&s->rlayer);
1517 X509 *SSL_get_peer_certificate(const SSL *s)
1521 if ((s == NULL) || (s->session == NULL))
1524 r = s->session->peer;
1534 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1538 if ((s == NULL) || (s->session == NULL))
1541 r = s->session->peer_chain;
1544 * If we are a client, cert_chain includes the peer's own certificate; if
1545 * we are a server, it does not.
1552 * Now in theory, since the calling process own 't' it should be safe to
1553 * modify. We need to be able to read f without being hassled
1555 int SSL_copy_session_id(SSL *t, const SSL *f)
1558 /* Do we need to to SSL locking? */
1559 if (!SSL_set_session(t, SSL_get_session(f))) {
1564 * what if we are setup for one protocol version but want to talk another
1566 if (t->method != f->method) {
1567 t->method->ssl_free(t);
1568 t->method = f->method;
1569 if (t->method->ssl_new(t) == 0)
1573 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1574 ssl_cert_free(t->cert);
1576 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1583 /* Fix this so it checks all the valid key/cert options */
1584 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1586 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1587 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1590 if (ctx->cert->key->privatekey == NULL) {
1591 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1594 return X509_check_private_key
1595 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1598 /* Fix this function so that it takes an optional type parameter */
1599 int SSL_check_private_key(const SSL *ssl)
1602 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1605 if (ssl->cert->key->x509 == NULL) {
1606 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1609 if (ssl->cert->key->privatekey == NULL) {
1610 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1613 return X509_check_private_key(ssl->cert->key->x509,
1614 ssl->cert->key->privatekey);
1617 int SSL_waiting_for_async(SSL *s)
1625 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1627 ASYNC_WAIT_CTX *ctx = s->waitctx;
1631 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1634 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1635 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1637 ASYNC_WAIT_CTX *ctx = s->waitctx;
1641 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1645 int SSL_accept(SSL *s)
1647 if (s->handshake_func == NULL) {
1648 /* Not properly initialized yet */
1649 SSL_set_accept_state(s);
1652 return SSL_do_handshake(s);
1655 int SSL_connect(SSL *s)
1657 if (s->handshake_func == NULL) {
1658 /* Not properly initialized yet */
1659 SSL_set_connect_state(s);
1662 return SSL_do_handshake(s);
1665 long SSL_get_default_timeout(const SSL *s)
1667 return s->method->get_timeout();
1670 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1671 int (*func) (void *))
1674 if (s->waitctx == NULL) {
1675 s->waitctx = ASYNC_WAIT_CTX_new();
1676 if (s->waitctx == NULL)
1679 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1680 sizeof(struct ssl_async_args))) {
1682 s->rwstate = SSL_NOTHING;
1683 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1686 s->rwstate = SSL_ASYNC_PAUSED;
1689 s->rwstate = SSL_ASYNC_NO_JOBS;
1695 s->rwstate = SSL_NOTHING;
1696 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1697 /* Shouldn't happen */
1702 static int ssl_io_intern(void *vargs)
1704 struct ssl_async_args *args;
1709 args = (struct ssl_async_args *)vargs;
1713 switch (args->type) {
1715 return args->f.func_read(s, buf, num, &s->asyncrw);
1717 return args->f.func_write(s, buf, num, &s->asyncrw);
1719 return args->f.func_other(s);
1724 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1726 if (s->handshake_func == NULL) {
1727 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1731 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1732 s->rwstate = SSL_NOTHING;
1736 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1737 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1738 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1742 * If we are a client and haven't received the ServerHello etc then we
1745 ossl_statem_check_finish_init(s, 0);
1747 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1748 struct ssl_async_args args;
1754 args.type = READFUNC;
1755 args.f.func_read = s->method->ssl_read;
1757 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1758 *readbytes = s->asyncrw;
1761 return s->method->ssl_read(s, buf, num, readbytes);
1765 int SSL_read(SSL *s, void *buf, int num)
1771 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1775 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1778 * The cast is safe here because ret should be <= INT_MAX because num is
1782 ret = (int)readbytes;
1787 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1789 int ret = ssl_read_internal(s, buf, num, readbytes);
1796 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1801 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1802 return SSL_READ_EARLY_DATA_ERROR;
1805 switch (s->early_data_state) {
1806 case SSL_EARLY_DATA_NONE:
1807 if (!SSL_in_before(s)) {
1808 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1809 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1810 return SSL_READ_EARLY_DATA_ERROR;
1814 case SSL_EARLY_DATA_ACCEPT_RETRY:
1815 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1816 ret = SSL_accept(s);
1819 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1820 return SSL_READ_EARLY_DATA_ERROR;
1824 case SSL_EARLY_DATA_READ_RETRY:
1825 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1826 s->early_data_state = SSL_EARLY_DATA_READING;
1827 ret = SSL_read_ex(s, buf, num, readbytes);
1829 * State machine will update early_data_state to
1830 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1833 if (ret > 0 || (ret <= 0 && s->early_data_state
1834 != SSL_EARLY_DATA_FINISHED_READING)) {
1835 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1836 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1837 : SSL_READ_EARLY_DATA_ERROR;
1840 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1843 return SSL_READ_EARLY_DATA_FINISH;
1846 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1847 return SSL_READ_EARLY_DATA_ERROR;
1851 int SSL_get_early_data_status(const SSL *s)
1853 return s->ext.early_data;
1856 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1858 if (s->handshake_func == NULL) {
1859 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1863 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1866 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1867 struct ssl_async_args args;
1873 args.type = READFUNC;
1874 args.f.func_read = s->method->ssl_peek;
1876 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1877 *readbytes = s->asyncrw;
1880 return s->method->ssl_peek(s, buf, num, readbytes);
1884 int SSL_peek(SSL *s, void *buf, int num)
1890 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1894 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1897 * The cast is safe here because ret should be <= INT_MAX because num is
1901 ret = (int)readbytes;
1907 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1909 int ret = ssl_peek_internal(s, buf, num, readbytes);
1916 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1918 if (s->handshake_func == NULL) {
1919 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1923 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1924 s->rwstate = SSL_NOTHING;
1925 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1929 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1930 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1931 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1932 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1935 /* If we are a client and haven't sent the Finished we better do that */
1936 ossl_statem_check_finish_init(s, 1);
1938 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1940 struct ssl_async_args args;
1943 args.buf = (void *)buf;
1945 args.type = WRITEFUNC;
1946 args.f.func_write = s->method->ssl_write;
1948 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1949 *written = s->asyncrw;
1952 return s->method->ssl_write(s, buf, num, written);
1956 int SSL_write(SSL *s, const void *buf, int num)
1962 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1966 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1969 * The cast is safe here because ret should be <= INT_MAX because num is
1978 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1980 int ret = ssl_write_internal(s, buf, num, written);
1987 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1989 int ret, early_data_state;
1991 uint32_t partialwrite;
1993 switch (s->early_data_state) {
1994 case SSL_EARLY_DATA_NONE:
1996 || !SSL_in_before(s)
1997 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1998 && (s->psk_use_session_cb == NULL))) {
1999 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
2000 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2005 case SSL_EARLY_DATA_CONNECT_RETRY:
2006 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
2007 ret = SSL_connect(s);
2010 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2015 case SSL_EARLY_DATA_WRITE_RETRY:
2016 s->early_data_state = SSL_EARLY_DATA_WRITING;
2018 * We disable partial write for early data because we don't keep track
2019 * of how many bytes we've written between the SSL_write_ex() call and
2020 * the flush if the flush needs to be retried)
2022 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2023 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2024 ret = SSL_write_ex(s, buf, num, &writtmp);
2025 s->mode |= partialwrite;
2027 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2030 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2033 case SSL_EARLY_DATA_WRITE_FLUSH:
2034 /* The buffering BIO is still in place so we need to flush it */
2035 if (statem_flush(s) != 1)
2038 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2041 case SSL_EARLY_DATA_FINISHED_READING:
2042 case SSL_EARLY_DATA_READ_RETRY:
2043 early_data_state = s->early_data_state;
2044 /* We are a server writing to an unauthenticated client */
2045 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2046 ret = SSL_write_ex(s, buf, num, written);
2047 /* The buffering BIO is still in place */
2049 (void)BIO_flush(s->wbio);
2050 s->early_data_state = early_data_state;
2054 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2059 int SSL_shutdown(SSL *s)
2062 * Note that this function behaves differently from what one might
2063 * expect. Return values are 0 for no success (yet), 1 for success; but
2064 * calling it once is usually not enough, even if blocking I/O is used
2065 * (see ssl3_shutdown).
2068 if (s->handshake_func == NULL) {
2069 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2073 if (!SSL_in_init(s)) {
2074 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2075 struct ssl_async_args args;
2078 args.type = OTHERFUNC;
2079 args.f.func_other = s->method->ssl_shutdown;
2081 return ssl_start_async_job(s, &args, ssl_io_intern);
2083 return s->method->ssl_shutdown(s);
2086 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2091 int SSL_key_update(SSL *s, int updatetype)
2094 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2095 * negotiated, and that it is appropriate to call SSL_key_update() instead
2096 * of SSL_renegotiate().
2098 if (!SSL_IS_TLS13(s)) {
2099 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2103 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2104 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2105 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2109 if (!SSL_is_init_finished(s)) {
2110 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2114 ossl_statem_set_in_init(s, 1);
2115 s->key_update = updatetype;
2119 int SSL_get_key_update_type(const SSL *s)
2121 return s->key_update;
2124 int SSL_renegotiate(SSL *s)
2126 if (SSL_IS_TLS13(s)) {
2127 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2131 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2132 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2139 return s->method->ssl_renegotiate(s);
2142 int SSL_renegotiate_abbreviated(SSL *s)
2144 if (SSL_IS_TLS13(s)) {
2145 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2149 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2150 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2157 return s->method->ssl_renegotiate(s);
2160 int SSL_renegotiate_pending(const SSL *s)
2163 * becomes true when negotiation is requested; false again once a
2164 * handshake has finished
2166 return (s->renegotiate != 0);
2169 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2174 case SSL_CTRL_GET_READ_AHEAD:
2175 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2176 case SSL_CTRL_SET_READ_AHEAD:
2177 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2178 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2181 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2182 s->msg_callback_arg = parg;
2186 return (s->mode |= larg);
2187 case SSL_CTRL_CLEAR_MODE:
2188 return (s->mode &= ~larg);
2189 case SSL_CTRL_GET_MAX_CERT_LIST:
2190 return (long)s->max_cert_list;
2191 case SSL_CTRL_SET_MAX_CERT_LIST:
2194 l = (long)s->max_cert_list;
2195 s->max_cert_list = (size_t)larg;
2197 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2198 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2200 s->max_send_fragment = larg;
2201 if (s->max_send_fragment < s->split_send_fragment)
2202 s->split_send_fragment = s->max_send_fragment;
2204 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2205 if ((size_t)larg > s->max_send_fragment || larg == 0)
2207 s->split_send_fragment = larg;
2209 case SSL_CTRL_SET_MAX_PIPELINES:
2210 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2212 s->max_pipelines = larg;
2214 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2216 case SSL_CTRL_GET_RI_SUPPORT:
2218 return s->s3->send_connection_binding;
2221 case SSL_CTRL_CERT_FLAGS:
2222 return (s->cert->cert_flags |= larg);
2223 case SSL_CTRL_CLEAR_CERT_FLAGS:
2224 return (s->cert->cert_flags &= ~larg);
2226 case SSL_CTRL_GET_RAW_CIPHERLIST:
2228 if (s->s3->tmp.ciphers_raw == NULL)
2230 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2231 return (int)s->s3->tmp.ciphers_rawlen;
2233 return TLS_CIPHER_LEN;
2235 case SSL_CTRL_GET_EXTMS_SUPPORT:
2236 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2238 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2242 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2243 return ssl_check_allowed_versions(larg, s->max_proto_version)
2244 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2245 &s->min_proto_version);
2246 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2247 return s->min_proto_version;
2248 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2249 return ssl_check_allowed_versions(s->min_proto_version, larg)
2250 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2251 &s->max_proto_version);
2252 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2253 return s->max_proto_version;
2255 return s->method->ssl_ctrl(s, cmd, larg, parg);
2259 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2262 case SSL_CTRL_SET_MSG_CALLBACK:
2263 s->msg_callback = (void (*)
2264 (int write_p, int version, int content_type,
2265 const void *buf, size_t len, SSL *ssl,
2270 return s->method->ssl_callback_ctrl(s, cmd, fp);
2274 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2276 return ctx->sessions;
2279 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2282 /* For some cases with ctx == NULL perform syntax checks */
2285 #ifndef OPENSSL_NO_EC
2286 case SSL_CTRL_SET_GROUPS_LIST:
2287 return tls1_set_groups_list(NULL, NULL, parg);
2289 case SSL_CTRL_SET_SIGALGS_LIST:
2290 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2291 return tls1_set_sigalgs_list(NULL, parg, 0);
2298 case SSL_CTRL_GET_READ_AHEAD:
2299 return ctx->read_ahead;
2300 case SSL_CTRL_SET_READ_AHEAD:
2301 l = ctx->read_ahead;
2302 ctx->read_ahead = larg;
2305 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2306 ctx->msg_callback_arg = parg;
2309 case SSL_CTRL_GET_MAX_CERT_LIST:
2310 return (long)ctx->max_cert_list;
2311 case SSL_CTRL_SET_MAX_CERT_LIST:
2314 l = (long)ctx->max_cert_list;
2315 ctx->max_cert_list = (size_t)larg;
2318 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2321 l = (long)ctx->session_cache_size;
2322 ctx->session_cache_size = (size_t)larg;
2324 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2325 return (long)ctx->session_cache_size;
2326 case SSL_CTRL_SET_SESS_CACHE_MODE:
2327 l = ctx->session_cache_mode;
2328 ctx->session_cache_mode = larg;
2330 case SSL_CTRL_GET_SESS_CACHE_MODE:
2331 return ctx->session_cache_mode;
2333 case SSL_CTRL_SESS_NUMBER:
2334 return lh_SSL_SESSION_num_items(ctx->sessions);
2335 case SSL_CTRL_SESS_CONNECT:
2336 return tsan_load(&ctx->stats.sess_connect);
2337 case SSL_CTRL_SESS_CONNECT_GOOD:
2338 return tsan_load(&ctx->stats.sess_connect_good);
2339 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2340 return tsan_load(&ctx->stats.sess_connect_renegotiate);
2341 case SSL_CTRL_SESS_ACCEPT:
2342 return tsan_load(&ctx->stats.sess_accept);
2343 case SSL_CTRL_SESS_ACCEPT_GOOD:
2344 return tsan_load(&ctx->stats.sess_accept_good);
2345 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2346 return tsan_load(&ctx->stats.sess_accept_renegotiate);
2347 case SSL_CTRL_SESS_HIT:
2348 return tsan_load(&ctx->stats.sess_hit);
2349 case SSL_CTRL_SESS_CB_HIT:
2350 return tsan_load(&ctx->stats.sess_cb_hit);
2351 case SSL_CTRL_SESS_MISSES:
2352 return tsan_load(&ctx->stats.sess_miss);
2353 case SSL_CTRL_SESS_TIMEOUTS:
2354 return tsan_load(&ctx->stats.sess_timeout);
2355 case SSL_CTRL_SESS_CACHE_FULL:
2356 return tsan_load(&ctx->stats.sess_cache_full);
2358 return (ctx->mode |= larg);
2359 case SSL_CTRL_CLEAR_MODE:
2360 return (ctx->mode &= ~larg);
2361 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2362 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2364 ctx->max_send_fragment = larg;
2365 if (ctx->max_send_fragment < ctx->split_send_fragment)
2366 ctx->split_send_fragment = ctx->max_send_fragment;
2368 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2369 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2371 ctx->split_send_fragment = larg;
2373 case SSL_CTRL_SET_MAX_PIPELINES:
2374 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2376 ctx->max_pipelines = larg;
2378 case SSL_CTRL_CERT_FLAGS:
2379 return (ctx->cert->cert_flags |= larg);
2380 case SSL_CTRL_CLEAR_CERT_FLAGS:
2381 return (ctx->cert->cert_flags &= ~larg);
2382 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2383 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2384 && ssl_set_version_bound(ctx->method->version, (int)larg,
2385 &ctx->min_proto_version);
2386 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2387 return ctx->min_proto_version;
2388 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2389 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2390 && ssl_set_version_bound(ctx->method->version, (int)larg,
2391 &ctx->max_proto_version);
2392 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2393 return ctx->max_proto_version;
2395 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2399 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2402 case SSL_CTRL_SET_MSG_CALLBACK:
2403 ctx->msg_callback = (void (*)
2404 (int write_p, int version, int content_type,
2405 const void *buf, size_t len, SSL *ssl,
2410 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2414 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2423 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2424 const SSL_CIPHER *const *bp)
2426 if ((*ap)->id > (*bp)->id)
2428 if ((*ap)->id < (*bp)->id)
2433 /** return a STACK of the ciphers available for the SSL and in order of
2435 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2438 if (s->cipher_list != NULL) {
2439 return s->cipher_list;
2440 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2441 return s->ctx->cipher_list;
2447 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2449 if ((s == NULL) || !s->server)
2451 return s->peer_ciphers;
2454 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2456 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2459 ciphers = SSL_get_ciphers(s);
2462 if (!ssl_set_client_disabled(s))
2464 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2465 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2466 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2468 sk = sk_SSL_CIPHER_new_null();
2471 if (!sk_SSL_CIPHER_push(sk, c)) {
2472 sk_SSL_CIPHER_free(sk);
2480 /** return a STACK of the ciphers available for the SSL and in order of
2482 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2485 if (s->cipher_list_by_id != NULL) {
2486 return s->cipher_list_by_id;
2487 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2488 return s->ctx->cipher_list_by_id;
2494 /** The old interface to get the same thing as SSL_get_ciphers() */
2495 const char *SSL_get_cipher_list(const SSL *s, int n)
2497 const SSL_CIPHER *c;
2498 STACK_OF(SSL_CIPHER) *sk;
2502 sk = SSL_get_ciphers(s);
2503 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2505 c = sk_SSL_CIPHER_value(sk, n);
2511 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2513 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2516 return ctx->cipher_list;
2521 * Distinguish between ciphers controlled by set_ciphersuite() and
2522 * set_cipher_list() when counting.
2524 static int cipher_list_tls12_num(STACK_OF(SSL_CIPHER) *sk)
2527 const SSL_CIPHER *c;
2531 for (i = 0; i < sk_SSL_CIPHER_num(sk); ++i) {
2532 c = sk_SSL_CIPHER_value(sk, i);
2533 if (c->min_tls >= TLS1_3_VERSION)
2540 /** specify the ciphers to be used by default by the SSL_CTX */
2541 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2543 STACK_OF(SSL_CIPHER) *sk;
2545 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2546 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2549 * ssl_create_cipher_list may return an empty stack if it was unable to
2550 * find a cipher matching the given rule string (for example if the rule
2551 * string specifies a cipher which has been disabled). This is not an
2552 * error as far as ssl_create_cipher_list is concerned, and hence
2553 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2557 else if (cipher_list_tls12_num(sk) == 0) {
2558 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2564 /** specify the ciphers to be used by the SSL */
2565 int SSL_set_cipher_list(SSL *s, const char *str)
2567 STACK_OF(SSL_CIPHER) *sk;
2569 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2570 &s->cipher_list, &s->cipher_list_by_id, str,
2572 /* see comment in SSL_CTX_set_cipher_list */
2575 else if (cipher_list_tls12_num(sk) == 0) {
2576 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2582 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2585 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2586 const SSL_CIPHER *c;
2590 || s->peer_ciphers == NULL
2595 clntsk = s->peer_ciphers;
2596 srvrsk = SSL_get_ciphers(s);
2597 if (clntsk == NULL || srvrsk == NULL)
2600 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2603 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2606 c = sk_SSL_CIPHER_value(clntsk, i);
2607 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2610 n = strlen(c->name);
2626 /** return a servername extension value if provided in Client Hello, or NULL.
2627 * So far, only host_name types are defined (RFC 3546).
2630 const char *SSL_get_servername(const SSL *s, const int type)
2632 if (type != TLSEXT_NAMETYPE_host_name)
2636 * SNI is not negotiated in pre-TLS-1.3 resumption flows, so fake up an
2637 * SNI value to return if we are resuming/resumed. N.B. that we still
2638 * call the relevant callbacks for such resumption flows, and callbacks
2639 * might error out if there is not a SNI value available.
2642 return s->session->ext.hostname;
2643 return s->ext.hostname;
2646 int SSL_get_servername_type(const SSL *s)
2649 && (!s->ext.hostname ? s->session->
2650 ext.hostname : s->ext.hostname))
2651 return TLSEXT_NAMETYPE_host_name;
2656 * SSL_select_next_proto implements the standard protocol selection. It is
2657 * expected that this function is called from the callback set by
2658 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2659 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2660 * not included in the length. A byte string of length 0 is invalid. No byte
2661 * string may be truncated. The current, but experimental algorithm for
2662 * selecting the protocol is: 1) If the server doesn't support NPN then this
2663 * is indicated to the callback. In this case, the client application has to
2664 * abort the connection or have a default application level protocol. 2) If
2665 * the server supports NPN, but advertises an empty list then the client
2666 * selects the first protocol in its list, but indicates via the API that this
2667 * fallback case was enacted. 3) Otherwise, the client finds the first
2668 * protocol in the server's list that it supports and selects this protocol.
2669 * This is because it's assumed that the server has better information about
2670 * which protocol a client should use. 4) If the client doesn't support any
2671 * of the server's advertised protocols, then this is treated the same as
2672 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2673 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2675 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2676 const unsigned char *server,
2677 unsigned int server_len,
2678 const unsigned char *client, unsigned int client_len)
2681 const unsigned char *result;
2682 int status = OPENSSL_NPN_UNSUPPORTED;
2685 * For each protocol in server preference order, see if we support it.
2687 for (i = 0; i < server_len;) {
2688 for (j = 0; j < client_len;) {
2689 if (server[i] == client[j] &&
2690 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2691 /* We found a match */
2692 result = &server[i];
2693 status = OPENSSL_NPN_NEGOTIATED;
2703 /* There's no overlap between our protocols and the server's list. */
2705 status = OPENSSL_NPN_NO_OVERLAP;
2708 *out = (unsigned char *)result + 1;
2709 *outlen = result[0];
2713 #ifndef OPENSSL_NO_NEXTPROTONEG
2715 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2716 * client's requested protocol for this connection and returns 0. If the
2717 * client didn't request any protocol, then *data is set to NULL. Note that
2718 * the client can request any protocol it chooses. The value returned from
2719 * this function need not be a member of the list of supported protocols
2720 * provided by the callback.
2722 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2729 *len = (unsigned int)s->ext.npn_len;
2734 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2735 * a TLS server needs a list of supported protocols for Next Protocol
2736 * Negotiation. The returned list must be in wire format. The list is
2737 * returned by setting |out| to point to it and |outlen| to its length. This
2738 * memory will not be modified, but one should assume that the SSL* keeps a
2739 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2740 * wishes to advertise. Otherwise, no such extension will be included in the
2743 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2744 SSL_CTX_npn_advertised_cb_func cb,
2747 ctx->ext.npn_advertised_cb = cb;
2748 ctx->ext.npn_advertised_cb_arg = arg;
2752 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2753 * client needs to select a protocol from the server's provided list. |out|
2754 * must be set to point to the selected protocol (which may be within |in|).
2755 * The length of the protocol name must be written into |outlen|. The
2756 * server's advertised protocols are provided in |in| and |inlen|. The
2757 * callback can assume that |in| is syntactically valid. The client must
2758 * select a protocol. It is fatal to the connection if this callback returns
2759 * a value other than SSL_TLSEXT_ERR_OK.
2761 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2762 SSL_CTX_npn_select_cb_func cb,
2765 ctx->ext.npn_select_cb = cb;
2766 ctx->ext.npn_select_cb_arg = arg;
2771 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2772 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2773 * length-prefixed strings). Returns 0 on success.
2775 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2776 unsigned int protos_len)
2778 OPENSSL_free(ctx->ext.alpn);
2779 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2780 if (ctx->ext.alpn == NULL) {
2781 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2784 ctx->ext.alpn_len = protos_len;
2790 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2791 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2792 * length-prefixed strings). Returns 0 on success.
2794 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2795 unsigned int protos_len)
2797 OPENSSL_free(ssl->ext.alpn);
2798 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2799 if (ssl->ext.alpn == NULL) {
2800 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2803 ssl->ext.alpn_len = protos_len;
2809 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2810 * called during ClientHello processing in order to select an ALPN protocol
2811 * from the client's list of offered protocols.
2813 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2814 SSL_CTX_alpn_select_cb_func cb,
2817 ctx->ext.alpn_select_cb = cb;
2818 ctx->ext.alpn_select_cb_arg = arg;
2822 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2823 * On return it sets |*data| to point to |*len| bytes of protocol name
2824 * (not including the leading length-prefix byte). If the server didn't
2825 * respond with a negotiated protocol then |*len| will be zero.
2827 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2832 *data = ssl->s3->alpn_selected;
2836 *len = (unsigned int)ssl->s3->alpn_selected_len;
2839 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2840 const char *label, size_t llen,
2841 const unsigned char *context, size_t contextlen,
2844 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2847 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2849 contextlen, use_context);
2852 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2853 const char *label, size_t llen,
2854 const unsigned char *context,
2857 if (s->version != TLS1_3_VERSION)
2860 return tls13_export_keying_material_early(s, out, olen, label, llen,
2861 context, contextlen);
2864 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2866 const unsigned char *session_id = a->session_id;
2868 unsigned char tmp_storage[4];
2870 if (a->session_id_length < sizeof(tmp_storage)) {
2871 memset(tmp_storage, 0, sizeof(tmp_storage));
2872 memcpy(tmp_storage, a->session_id, a->session_id_length);
2873 session_id = tmp_storage;
2877 ((unsigned long)session_id[0]) |
2878 ((unsigned long)session_id[1] << 8L) |
2879 ((unsigned long)session_id[2] << 16L) |
2880 ((unsigned long)session_id[3] << 24L);
2885 * NB: If this function (or indeed the hash function which uses a sort of
2886 * coarser function than this one) is changed, ensure
2887 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2888 * being able to construct an SSL_SESSION that will collide with any existing
2889 * session with a matching session ID.
2891 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2893 if (a->ssl_version != b->ssl_version)
2895 if (a->session_id_length != b->session_id_length)
2897 return memcmp(a->session_id, b->session_id, a->session_id_length);
2901 * These wrapper functions should remain rather than redeclaring
2902 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2903 * variable. The reason is that the functions aren't static, they're exposed
2907 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2909 SSL_CTX *ret = NULL;
2912 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2916 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2919 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2920 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2923 ret = OPENSSL_zalloc(sizeof(*ret));
2928 ret->min_proto_version = 0;
2929 ret->max_proto_version = 0;
2930 ret->mode = SSL_MODE_AUTO_RETRY;
2931 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2932 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2933 /* We take the system default. */
2934 ret->session_timeout = meth->get_timeout();
2935 ret->references = 1;
2936 ret->lock = CRYPTO_THREAD_lock_new();
2937 if (ret->lock == NULL) {
2938 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2942 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2943 ret->verify_mode = SSL_VERIFY_NONE;
2944 if ((ret->cert = ssl_cert_new()) == NULL)
2947 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2948 if (ret->sessions == NULL)
2950 ret->cert_store = X509_STORE_new();
2951 if (ret->cert_store == NULL)
2953 #ifndef OPENSSL_NO_CT
2954 ret->ctlog_store = CTLOG_STORE_new();
2955 if (ret->ctlog_store == NULL)
2959 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
2962 if (!ssl_create_cipher_list(ret->method,
2963 ret->tls13_ciphersuites,
2964 &ret->cipher_list, &ret->cipher_list_by_id,
2965 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2966 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2967 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2971 ret->param = X509_VERIFY_PARAM_new();
2972 if (ret->param == NULL)
2975 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2976 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2979 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2980 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2984 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2987 if ((ret->client_ca_names = sk_X509_NAME_new_null()) == NULL)
2990 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2993 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
2996 /* No compression for DTLS */
2997 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2998 ret->comp_methods = SSL_COMP_get_compression_methods();
3000 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3001 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3003 /* Setup RFC5077 ticket keys */
3004 if ((RAND_bytes(ret->ext.tick_key_name,
3005 sizeof(ret->ext.tick_key_name)) <= 0)
3006 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
3007 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
3008 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
3009 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
3010 ret->options |= SSL_OP_NO_TICKET;
3012 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
3013 sizeof(ret->ext.cookie_hmac_key)) <= 0)
3016 #ifndef OPENSSL_NO_SRP
3017 if (!SSL_CTX_SRP_CTX_init(ret))
3020 #ifndef OPENSSL_NO_ENGINE
3021 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3022 # define eng_strx(x) #x
3023 # define eng_str(x) eng_strx(x)
3024 /* Use specific client engine automatically... ignore errors */
3027 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3030 ENGINE_load_builtin_engines();
3031 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3033 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3039 * Default is to connect to non-RI servers. When RI is more widely
3040 * deployed might change this.
3042 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3044 * Disable compression by default to prevent CRIME. Applications can
3045 * re-enable compression by configuring
3046 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3047 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3048 * middlebox compatibility by default. This may be disabled by default in
3049 * a later OpenSSL version.
3051 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3053 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3056 * We cannot usefully set a default max_early_data here (which gets
3057 * propagated in SSL_new(), for the following reason: setting the
3058 * SSL field causes tls_construct_stoc_early_data() to tell the
3059 * client that early data will be accepted when constructing a TLS 1.3
3060 * session ticket, and the client will accordingly send us early data
3061 * when using that ticket (if the client has early data to send).
3062 * However, in order for the early data to actually be consumed by
3063 * the application, the application must also have calls to
3064 * SSL_read_early_data(); otherwise we'll just skip past the early data
3065 * and ignore it. So, since the application must add calls to
3066 * SSL_read_early_data(), we also require them to add
3067 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3068 * eliminating the bandwidth-wasting early data in the case described
3071 ret->max_early_data = 0;
3074 * Default recv_max_early_data is a fully loaded single record. Could be
3075 * split across multiple records in practice. We set this differently to
3076 * max_early_data so that, in the default case, we do not advertise any
3077 * support for early_data, but if a client were to send us some (e.g.
3078 * because of an old, stale ticket) then we will tolerate it and skip over
3081 ret->recv_max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
3083 /* By default we send two session tickets automatically in TLSv1.3 */
3084 ret->num_tickets = 2;
3086 ssl_ctx_system_config(ret);
3090 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3096 int SSL_CTX_up_ref(SSL_CTX *ctx)
3100 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3103 REF_PRINT_COUNT("SSL_CTX", ctx);
3104 REF_ASSERT_ISNT(i < 2);
3105 return ((i > 1) ? 1 : 0);
3108 void SSL_CTX_free(SSL_CTX *a)
3115 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3116 REF_PRINT_COUNT("SSL_CTX", a);
3119 REF_ASSERT_ISNT(i < 0);
3121 X509_VERIFY_PARAM_free(a->param);
3122 dane_ctx_final(&a->dane);
3125 * Free internal session cache. However: the remove_cb() may reference
3126 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3127 * after the sessions were flushed.
3128 * As the ex_data handling routines might also touch the session cache,
3129 * the most secure solution seems to be: empty (flush) the cache, then
3130 * free ex_data, then finally free the cache.
3131 * (See ticket [openssl.org #212].)
3133 if (a->sessions != NULL)
3134 SSL_CTX_flush_sessions(a, 0);
3136 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3137 lh_SSL_SESSION_free(a->sessions);
3138 X509_STORE_free(a->cert_store);
3139 #ifndef OPENSSL_NO_CT
3140 CTLOG_STORE_free(a->ctlog_store);
3142 sk_SSL_CIPHER_free(a->cipher_list);
3143 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3144 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3145 ssl_cert_free(a->cert);
3146 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3147 sk_X509_NAME_pop_free(a->client_ca_names, X509_NAME_free);
3148 sk_X509_pop_free(a->extra_certs, X509_free);
3149 a->comp_methods = NULL;
3150 #ifndef OPENSSL_NO_SRTP
3151 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3153 #ifndef OPENSSL_NO_SRP
3154 SSL_CTX_SRP_CTX_free(a);
3156 #ifndef OPENSSL_NO_ENGINE
3157 ENGINE_finish(a->client_cert_engine);
3160 #ifndef OPENSSL_NO_EC
3161 OPENSSL_free(a->ext.ecpointformats);
3162 OPENSSL_free(a->ext.supportedgroups);
3164 OPENSSL_free(a->ext.alpn);
3165 OPENSSL_secure_free(a->ext.secure);
3167 CRYPTO_THREAD_lock_free(a->lock);
3172 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3174 ctx->default_passwd_callback = cb;
3177 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3179 ctx->default_passwd_callback_userdata = u;
3182 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3184 return ctx->default_passwd_callback;
3187 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3189 return ctx->default_passwd_callback_userdata;
3192 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3194 s->default_passwd_callback = cb;
3197 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3199 s->default_passwd_callback_userdata = u;
3202 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3204 return s->default_passwd_callback;
3207 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3209 return s->default_passwd_callback_userdata;
3212 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3213 int (*cb) (X509_STORE_CTX *, void *),
3216 ctx->app_verify_callback = cb;
3217 ctx->app_verify_arg = arg;
3220 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3221 int (*cb) (int, X509_STORE_CTX *))
3223 ctx->verify_mode = mode;
3224 ctx->default_verify_callback = cb;
3227 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3229 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3232 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3234 ssl_cert_set_cert_cb(c->cert, cb, arg);
3237 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3239 ssl_cert_set_cert_cb(s->cert, cb, arg);
3242 void ssl_set_masks(SSL *s)
3245 uint32_t *pvalid = s->s3->tmp.valid_flags;
3246 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3247 unsigned long mask_k, mask_a;
3248 #ifndef OPENSSL_NO_EC
3249 int have_ecc_cert, ecdsa_ok;
3254 #ifndef OPENSSL_NO_DH
3255 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3260 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3261 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3262 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3263 #ifndef OPENSSL_NO_EC
3264 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3270 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3271 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3274 #ifndef OPENSSL_NO_GOST
3275 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3276 mask_k |= SSL_kGOST;
3277 mask_a |= SSL_aGOST12;
3279 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3280 mask_k |= SSL_kGOST;
3281 mask_a |= SSL_aGOST12;
3283 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3284 mask_k |= SSL_kGOST;
3285 mask_a |= SSL_aGOST01;
3296 * If we only have an RSA-PSS certificate allow RSA authentication
3297 * if TLS 1.2 and peer supports it.
3300 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3301 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3302 && TLS1_get_version(s) == TLS1_2_VERSION))
3309 mask_a |= SSL_aNULL;
3312 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3313 * depending on the key usage extension.
3315 #ifndef OPENSSL_NO_EC
3316 if (have_ecc_cert) {
3318 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3319 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3320 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3323 mask_a |= SSL_aECDSA;
3325 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3326 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3327 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3328 && TLS1_get_version(s) == TLS1_2_VERSION)
3329 mask_a |= SSL_aECDSA;
3331 /* Allow Ed448 for TLS 1.2 if peer supports it */
3332 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3333 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3334 && TLS1_get_version(s) == TLS1_2_VERSION)
3335 mask_a |= SSL_aECDSA;
3338 #ifndef OPENSSL_NO_EC
3339 mask_k |= SSL_kECDHE;
3342 #ifndef OPENSSL_NO_PSK
3345 if (mask_k & SSL_kRSA)
3346 mask_k |= SSL_kRSAPSK;
3347 if (mask_k & SSL_kDHE)
3348 mask_k |= SSL_kDHEPSK;
3349 if (mask_k & SSL_kECDHE)
3350 mask_k |= SSL_kECDHEPSK;
3353 s->s3->tmp.mask_k = mask_k;
3354 s->s3->tmp.mask_a = mask_a;
3357 #ifndef OPENSSL_NO_EC
3359 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3361 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3362 /* key usage, if present, must allow signing */
3363 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3364 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3365 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3369 return 1; /* all checks are ok */
3374 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3375 size_t *serverinfo_length)
3377 CERT_PKEY *cpk = s->s3->tmp.cert;
3378 *serverinfo_length = 0;
3380 if (cpk == NULL || cpk->serverinfo == NULL)
3383 *serverinfo = cpk->serverinfo;
3384 *serverinfo_length = cpk->serverinfo_length;
3388 void ssl_update_cache(SSL *s, int mode)
3393 * If the session_id_length is 0, we are not supposed to cache it, and it
3394 * would be rather hard to do anyway :-)
3396 if (s->session->session_id_length == 0)
3400 * If sid_ctx_length is 0 there is no specific application context
3401 * associated with this session, so when we try to resume it and
3402 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3403 * indication that this is actually a session for the proper application
3404 * context, and the *handshake* will fail, not just the resumption attempt.
3405 * Do not cache (on the server) these sessions that are not resumable
3406 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3408 if (s->server && s->session->sid_ctx_length == 0
3409 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3412 i = s->session_ctx->session_cache_mode;
3414 && (!s->hit || SSL_IS_TLS13(s))) {
3416 * Add the session to the internal cache. In server side TLSv1.3 we
3417 * normally don't do this because by default it's a full stateless ticket
3418 * with only a dummy session id so there is no reason to cache it,
3420 * - we are doing early_data, in which case we cache so that we can
3422 * - the application has set a remove_session_cb so needs to know about
3423 * session timeout events
3424 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3426 if ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0
3427 && (!SSL_IS_TLS13(s)
3429 || (s->max_early_data > 0
3430 && (s->options & SSL_OP_NO_ANTI_REPLAY) == 0)
3431 || s->session_ctx->remove_session_cb != NULL
3432 || (s->options & SSL_OP_NO_TICKET) != 0))
3433 SSL_CTX_add_session(s->session_ctx, s->session);
3436 * Add the session to the external cache. We do this even in server side
3437 * TLSv1.3 without early data because some applications just want to
3438 * know about the creation of a session and aren't doing a full cache.
3440 if (s->session_ctx->new_session_cb != NULL) {
3441 SSL_SESSION_up_ref(s->session);
3442 if (!s->session_ctx->new_session_cb(s, s->session))
3443 SSL_SESSION_free(s->session);
3447 /* auto flush every 255 connections */
3448 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3449 TSAN_QUALIFIER int *stat;
3450 if (mode & SSL_SESS_CACHE_CLIENT)
3451 stat = &s->session_ctx->stats.sess_connect_good;
3453 stat = &s->session_ctx->stats.sess_accept_good;
3454 if ((tsan_load(stat) & 0xff) == 0xff)
3455 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3459 const SSL_METHOD *SSL_CTX_get_ssl_method(const SSL_CTX *ctx)
3464 const SSL_METHOD *SSL_get_ssl_method(const SSL *s)
3469 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3473 if (s->method != meth) {
3474 const SSL_METHOD *sm = s->method;
3475 int (*hf) (SSL *) = s->handshake_func;
3477 if (sm->version == meth->version)
3482 ret = s->method->ssl_new(s);
3485 if (hf == sm->ssl_connect)
3486 s->handshake_func = meth->ssl_connect;
3487 else if (hf == sm->ssl_accept)
3488 s->handshake_func = meth->ssl_accept;
3493 int SSL_get_error(const SSL *s, int i)
3500 return SSL_ERROR_NONE;
3503 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3504 * where we do encode the error
3506 if ((l = ERR_peek_error()) != 0) {
3507 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3508 return SSL_ERROR_SYSCALL;
3510 return SSL_ERROR_SSL;
3513 if (SSL_want_read(s)) {
3514 bio = SSL_get_rbio(s);
3515 if (BIO_should_read(bio))
3516 return SSL_ERROR_WANT_READ;
3517 else if (BIO_should_write(bio))
3519 * This one doesn't make too much sense ... We never try to write
3520 * to the rbio, and an application program where rbio and wbio
3521 * are separate couldn't even know what it should wait for.
3522 * However if we ever set s->rwstate incorrectly (so that we have
3523 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3524 * wbio *are* the same, this test works around that bug; so it
3525 * might be safer to keep it.
3527 return SSL_ERROR_WANT_WRITE;
3528 else if (BIO_should_io_special(bio)) {
3529 reason = BIO_get_retry_reason(bio);
3530 if (reason == BIO_RR_CONNECT)
3531 return SSL_ERROR_WANT_CONNECT;
3532 else if (reason == BIO_RR_ACCEPT)
3533 return SSL_ERROR_WANT_ACCEPT;
3535 return SSL_ERROR_SYSCALL; /* unknown */
3539 if (SSL_want_write(s)) {
3540 /* Access wbio directly - in order to use the buffered bio if present */
3542 if (BIO_should_write(bio))
3543 return SSL_ERROR_WANT_WRITE;
3544 else if (BIO_should_read(bio))
3546 * See above (SSL_want_read(s) with BIO_should_write(bio))
3548 return SSL_ERROR_WANT_READ;
3549 else if (BIO_should_io_special(bio)) {
3550 reason = BIO_get_retry_reason(bio);
3551 if (reason == BIO_RR_CONNECT)
3552 return SSL_ERROR_WANT_CONNECT;
3553 else if (reason == BIO_RR_ACCEPT)
3554 return SSL_ERROR_WANT_ACCEPT;
3556 return SSL_ERROR_SYSCALL;
3559 if (SSL_want_x509_lookup(s))
3560 return SSL_ERROR_WANT_X509_LOOKUP;
3561 if (SSL_want_async(s))
3562 return SSL_ERROR_WANT_ASYNC;
3563 if (SSL_want_async_job(s))
3564 return SSL_ERROR_WANT_ASYNC_JOB;
3565 if (SSL_want_client_hello_cb(s))
3566 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3568 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3569 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3570 return SSL_ERROR_ZERO_RETURN;
3572 return SSL_ERROR_SYSCALL;
3575 static int ssl_do_handshake_intern(void *vargs)
3577 struct ssl_async_args *args;
3580 args = (struct ssl_async_args *)vargs;
3583 return s->handshake_func(s);
3586 int SSL_do_handshake(SSL *s)
3590 if (s->handshake_func == NULL) {
3591 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3595 ossl_statem_check_finish_init(s, -1);
3597 s->method->ssl_renegotiate_check(s, 0);
3599 if (SSL_in_init(s) || SSL_in_before(s)) {
3600 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3601 struct ssl_async_args args;
3605 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3607 ret = s->handshake_func(s);
3613 void SSL_set_accept_state(SSL *s)
3617 ossl_statem_clear(s);
3618 s->handshake_func = s->method->ssl_accept;
3622 void SSL_set_connect_state(SSL *s)
3626 ossl_statem_clear(s);
3627 s->handshake_func = s->method->ssl_connect;
3631 int ssl_undefined_function(SSL *s)
3633 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3637 int ssl_undefined_void_function(void)
3639 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3640 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3644 int ssl_undefined_const_function(const SSL *s)
3649 const SSL_METHOD *ssl_bad_method(int ver)
3651 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3655 const char *ssl_protocol_to_string(int version)
3659 case TLS1_3_VERSION:
3662 case TLS1_2_VERSION:
3665 case TLS1_1_VERSION:
3680 case DTLS1_2_VERSION:
3688 const char *SSL_get_version(const SSL *s)
3690 return ssl_protocol_to_string(s->version);
3693 static int dup_ca_names(STACK_OF(X509_NAME) **dst, STACK_OF(X509_NAME) *src)
3695 STACK_OF(X509_NAME) *sk;
3704 if ((sk = sk_X509_NAME_new_null()) == NULL)
3706 for (i = 0; i < sk_X509_NAME_num(src); i++) {
3707 xn = X509_NAME_dup(sk_X509_NAME_value(src, i));
3709 sk_X509_NAME_pop_free(sk, X509_NAME_free);
3712 if (sk_X509_NAME_insert(sk, xn, i) == 0) {
3714 sk_X509_NAME_pop_free(sk, X509_NAME_free);
3723 SSL *SSL_dup(SSL *s)
3728 /* If we're not quiescent, just up_ref! */
3729 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3730 CRYPTO_UP_REF(&s->references, &i, s->lock);
3735 * Otherwise, copy configuration state, and session if set.
3737 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3740 if (s->session != NULL) {
3742 * Arranges to share the same session via up_ref. This "copies"
3743 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3745 if (!SSL_copy_session_id(ret, s))
3749 * No session has been established yet, so we have to expect that
3750 * s->cert or ret->cert will be changed later -- they should not both
3751 * point to the same object, and thus we can't use
3752 * SSL_copy_session_id.
3754 if (!SSL_set_ssl_method(ret, s->method))
3757 if (s->cert != NULL) {
3758 ssl_cert_free(ret->cert);
3759 ret->cert = ssl_cert_dup(s->cert);
3760 if (ret->cert == NULL)
3764 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3765 (int)s->sid_ctx_length))
3769 if (!ssl_dane_dup(ret, s))
3771 ret->version = s->version;
3772 ret->options = s->options;
3773 ret->mode = s->mode;
3774 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3775 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3776 ret->msg_callback = s->msg_callback;
3777 ret->msg_callback_arg = s->msg_callback_arg;
3778 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3779 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3780 ret->generate_session_id = s->generate_session_id;
3782 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3784 /* copy app data, a little dangerous perhaps */
3785 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3788 /* setup rbio, and wbio */
3789 if (s->rbio != NULL) {
3790 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3793 if (s->wbio != NULL) {
3794 if (s->wbio != s->rbio) {
3795 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3798 BIO_up_ref(ret->rbio);
3799 ret->wbio = ret->rbio;
3803 ret->server = s->server;
3804 if (s->handshake_func) {
3806 SSL_set_accept_state(ret);
3808 SSL_set_connect_state(ret);
3810 ret->shutdown = s->shutdown;
3813 ret->default_passwd_callback = s->default_passwd_callback;
3814 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3816 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3818 /* dup the cipher_list and cipher_list_by_id stacks */
3819 if (s->cipher_list != NULL) {
3820 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3823 if (s->cipher_list_by_id != NULL)
3824 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3828 /* Dup the client_CA list */
3829 if (!dup_ca_names(&ret->ca_names, s->ca_names)
3830 || !dup_ca_names(&ret->client_ca_names, s->client_ca_names))
3840 void ssl_clear_cipher_ctx(SSL *s)
3842 if (s->enc_read_ctx != NULL) {
3843 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3844 s->enc_read_ctx = NULL;
3846 if (s->enc_write_ctx != NULL) {
3847 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3848 s->enc_write_ctx = NULL;
3850 #ifndef OPENSSL_NO_COMP
3851 COMP_CTX_free(s->expand);
3853 COMP_CTX_free(s->compress);
3858 X509 *SSL_get_certificate(const SSL *s)
3860 if (s->cert != NULL)
3861 return s->cert->key->x509;
3866 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3868 if (s->cert != NULL)
3869 return s->cert->key->privatekey;
3874 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3876 if (ctx->cert != NULL)
3877 return ctx->cert->key->x509;
3882 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3884 if (ctx->cert != NULL)
3885 return ctx->cert->key->privatekey;
3890 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3892 if ((s->session != NULL) && (s->session->cipher != NULL))
3893 return s->session->cipher;
3897 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3899 return s->s3->tmp.new_cipher;
3902 const COMP_METHOD *SSL_get_current_compression(const SSL *s)
3904 #ifndef OPENSSL_NO_COMP
3905 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3911 const COMP_METHOD *SSL_get_current_expansion(const SSL *s)
3913 #ifndef OPENSSL_NO_COMP
3914 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3920 int ssl_init_wbio_buffer(SSL *s)
3924 if (s->bbio != NULL) {
3925 /* Already buffered. */
3929 bbio = BIO_new(BIO_f_buffer());
3930 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3932 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3936 s->wbio = BIO_push(bbio, s->wbio);
3941 int ssl_free_wbio_buffer(SSL *s)
3943 /* callers ensure s is never null */
3944 if (s->bbio == NULL)
3947 s->wbio = BIO_pop(s->wbio);
3954 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3956 ctx->quiet_shutdown = mode;
3959 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3961 return ctx->quiet_shutdown;
3964 void SSL_set_quiet_shutdown(SSL *s, int mode)
3966 s->quiet_shutdown = mode;
3969 int SSL_get_quiet_shutdown(const SSL *s)
3971 return s->quiet_shutdown;
3974 void SSL_set_shutdown(SSL *s, int mode)
3979 int SSL_get_shutdown(const SSL *s)
3984 int SSL_version(const SSL *s)
3989 int SSL_client_version(const SSL *s)
3991 return s->client_version;
3994 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3999 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
4002 if (ssl->ctx == ctx)
4005 ctx = ssl->session_ctx;
4006 new_cert = ssl_cert_dup(ctx->cert);
4007 if (new_cert == NULL) {
4011 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
4012 ssl_cert_free(new_cert);
4016 ssl_cert_free(ssl->cert);
4017 ssl->cert = new_cert;
4020 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
4021 * so setter APIs must prevent invalid lengths from entering the system.
4023 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
4027 * If the session ID context matches that of the parent SSL_CTX,
4028 * inherit it from the new SSL_CTX as well. If however the context does
4029 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4030 * leave it unchanged.
4032 if ((ssl->ctx != NULL) &&
4033 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
4034 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
4035 ssl->sid_ctx_length = ctx->sid_ctx_length;
4036 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
4039 SSL_CTX_up_ref(ctx);
4040 SSL_CTX_free(ssl->ctx); /* decrement reference count */
4046 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
4048 return X509_STORE_set_default_paths(ctx->cert_store);
4051 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
4053 X509_LOOKUP *lookup;
4055 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
4058 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
4060 /* Clear any errors if the default directory does not exist */
4066 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4068 X509_LOOKUP *lookup;
4070 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4074 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4076 /* Clear any errors if the default file does not exist */
4082 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4085 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4088 void SSL_set_info_callback(SSL *ssl,
4089 void (*cb) (const SSL *ssl, int type, int val))
4091 ssl->info_callback = cb;
4095 * One compiler (Diab DCC) doesn't like argument names in returned function
4098 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4101 return ssl->info_callback;
4104 void SSL_set_verify_result(SSL *ssl, long arg)
4106 ssl->verify_result = arg;
4109 long SSL_get_verify_result(const SSL *ssl)
4111 return ssl->verify_result;
4114 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4117 return sizeof(ssl->s3->client_random);
4118 if (outlen > sizeof(ssl->s3->client_random))
4119 outlen = sizeof(ssl->s3->client_random);
4120 memcpy(out, ssl->s3->client_random, outlen);
4124 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4127 return sizeof(ssl->s3->server_random);
4128 if (outlen > sizeof(ssl->s3->server_random))
4129 outlen = sizeof(ssl->s3->server_random);
4130 memcpy(out, ssl->s3->server_random, outlen);
4134 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4135 unsigned char *out, size_t outlen)
4138 return session->master_key_length;
4139 if (outlen > session->master_key_length)
4140 outlen = session->master_key_length;
4141 memcpy(out, session->master_key, outlen);
4145 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4148 if (len > sizeof(sess->master_key))
4151 memcpy(sess->master_key, in, len);
4152 sess->master_key_length = len;
4157 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4159 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4162 void *SSL_get_ex_data(const SSL *s, int idx)
4164 return CRYPTO_get_ex_data(&s->ex_data, idx);
4167 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4169 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4172 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4174 return CRYPTO_get_ex_data(&s->ex_data, idx);
4177 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4179 return ctx->cert_store;
4182 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4184 X509_STORE_free(ctx->cert_store);
4185 ctx->cert_store = store;
4188 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4191 X509_STORE_up_ref(store);
4192 SSL_CTX_set_cert_store(ctx, store);
4195 int SSL_want(const SSL *s)
4201 * \brief Set the callback for generating temporary DH keys.
4202 * \param ctx the SSL context.
4203 * \param dh the callback
4206 #ifndef OPENSSL_NO_DH
4207 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4208 DH *(*dh) (SSL *ssl, int is_export,
4211 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4214 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4217 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4221 #ifndef OPENSSL_NO_PSK
4222 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4224 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4225 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4228 OPENSSL_free(ctx->cert->psk_identity_hint);
4229 if (identity_hint != NULL) {
4230 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4231 if (ctx->cert->psk_identity_hint == NULL)
4234 ctx->cert->psk_identity_hint = NULL;
4238 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4243 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4244 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4247 OPENSSL_free(s->cert->psk_identity_hint);
4248 if (identity_hint != NULL) {
4249 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4250 if (s->cert->psk_identity_hint == NULL)
4253 s->cert->psk_identity_hint = NULL;
4257 const char *SSL_get_psk_identity_hint(const SSL *s)
4259 if (s == NULL || s->session == NULL)
4261 return s->session->psk_identity_hint;
4264 const char *SSL_get_psk_identity(const SSL *s)
4266 if (s == NULL || s->session == NULL)
4268 return s->session->psk_identity;
4271 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4273 s->psk_client_callback = cb;
4276 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4278 ctx->psk_client_callback = cb;
4281 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4283 s->psk_server_callback = cb;
4286 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4288 ctx->psk_server_callback = cb;
4292 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4294 s->psk_find_session_cb = cb;
4297 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4298 SSL_psk_find_session_cb_func cb)
4300 ctx->psk_find_session_cb = cb;
4303 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4305 s->psk_use_session_cb = cb;
4308 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4309 SSL_psk_use_session_cb_func cb)
4311 ctx->psk_use_session_cb = cb;
4314 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4315 void (*cb) (int write_p, int version,
4316 int content_type, const void *buf,
4317 size_t len, SSL *ssl, void *arg))
4319 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4322 void SSL_set_msg_callback(SSL *ssl,
4323 void (*cb) (int write_p, int version,
4324 int content_type, const void *buf,
4325 size_t len, SSL *ssl, void *arg))
4327 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4330 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4331 int (*cb) (SSL *ssl,
4335 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4336 (void (*)(void))cb);
4339 void SSL_set_not_resumable_session_callback(SSL *ssl,
4340 int (*cb) (SSL *ssl,
4341 int is_forward_secure))
4343 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4344 (void (*)(void))cb);
4347 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4348 size_t (*cb) (SSL *ssl, int type,
4349 size_t len, void *arg))
4351 ctx->record_padding_cb = cb;
4354 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4356 ctx->record_padding_arg = arg;
4359 void *SSL_CTX_get_record_padding_callback_arg(const SSL_CTX *ctx)
4361 return ctx->record_padding_arg;
4364 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4366 /* block size of 0 or 1 is basically no padding */
4367 if (block_size == 1)
4368 ctx->block_padding = 0;
4369 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4370 ctx->block_padding = block_size;
4376 void SSL_set_record_padding_callback(SSL *ssl,
4377 size_t (*cb) (SSL *ssl, int type,
4378 size_t len, void *arg))
4380 ssl->record_padding_cb = cb;
4383 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4385 ssl->record_padding_arg = arg;
4388 void *SSL_get_record_padding_callback_arg(const SSL *ssl)
4390 return ssl->record_padding_arg;
4393 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4395 /* block size of 0 or 1 is basically no padding */
4396 if (block_size == 1)
4397 ssl->block_padding = 0;
4398 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4399 ssl->block_padding = block_size;
4405 int SSL_set_num_tickets(SSL *s, size_t num_tickets)
4407 s->num_tickets = num_tickets;
4412 size_t SSL_get_num_tickets(const SSL *s)
4414 return s->num_tickets;
4417 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets)
4419 ctx->num_tickets = num_tickets;
4424 size_t SSL_CTX_get_num_tickets(const SSL_CTX *ctx)
4426 return ctx->num_tickets;
4430 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4431 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4432 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4433 * Returns the newly allocated ctx;
4436 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4438 ssl_clear_hash_ctx(hash);
4439 *hash = EVP_MD_CTX_new();
4440 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4441 EVP_MD_CTX_free(*hash);
4448 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4451 EVP_MD_CTX_free(*hash);
4455 /* Retrieve handshake hashes */
4456 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4459 EVP_MD_CTX *ctx = NULL;
4460 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4461 int hashleni = EVP_MD_CTX_size(hdgst);
4464 if (hashleni < 0 || (size_t)hashleni > outlen) {
4465 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4466 ERR_R_INTERNAL_ERROR);
4470 ctx = EVP_MD_CTX_new();
4474 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4475 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4476 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4477 ERR_R_INTERNAL_ERROR);
4481 *hashlen = hashleni;
4485 EVP_MD_CTX_free(ctx);
4489 int SSL_session_reused(const SSL *s)
4494 int SSL_is_server(const SSL *s)
4499 #if OPENSSL_API_COMPAT < 0x10100000L
4500 void SSL_set_debug(SSL *s, int debug)
4502 /* Old function was do-nothing anyway... */
4508 void SSL_set_security_level(SSL *s, int level)
4510 s->cert->sec_level = level;
4513 int SSL_get_security_level(const SSL *s)
4515 return s->cert->sec_level;
4518 void SSL_set_security_callback(SSL *s,
4519 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4520 int op, int bits, int nid,
4521 void *other, void *ex))
4523 s->cert->sec_cb = cb;
4526 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4527 const SSL_CTX *ctx, int op,
4528 int bits, int nid, void *other,
4530 return s->cert->sec_cb;
4533 void SSL_set0_security_ex_data(SSL *s, void *ex)
4535 s->cert->sec_ex = ex;
4538 void *SSL_get0_security_ex_data(const SSL *s)
4540 return s->cert->sec_ex;
4543 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4545 ctx->cert->sec_level = level;
4548 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4550 return ctx->cert->sec_level;
4553 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4554 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4555 int op, int bits, int nid,
4556 void *other, void *ex))
4558 ctx->cert->sec_cb = cb;
4561 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4567 return ctx->cert->sec_cb;
4570 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4572 ctx->cert->sec_ex = ex;
4575 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4577 return ctx->cert->sec_ex;
4581 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4582 * can return unsigned long, instead of the generic long return value from the
4583 * control interface.
4585 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4587 return ctx->options;
4590 unsigned long SSL_get_options(const SSL *s)
4595 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4597 return ctx->options |= op;
4600 unsigned long SSL_set_options(SSL *s, unsigned long op)
4602 return s->options |= op;
4605 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4607 return ctx->options &= ~op;
4610 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4612 return s->options &= ~op;
4615 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4617 return s->verified_chain;
4620 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4622 #ifndef OPENSSL_NO_CT
4625 * Moves SCTs from the |src| stack to the |dst| stack.
4626 * The source of each SCT will be set to |origin|.
4627 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4629 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4631 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4632 sct_source_t origin)
4638 *dst = sk_SCT_new_null();
4640 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4645 while ((sct = sk_SCT_pop(src)) != NULL) {
4646 if (SCT_set_source(sct, origin) != 1)
4649 if (sk_SCT_push(*dst, sct) <= 0)
4657 sk_SCT_push(src, sct); /* Put the SCT back */
4662 * Look for data collected during ServerHello and parse if found.
4663 * Returns the number of SCTs extracted.
4665 static int ct_extract_tls_extension_scts(SSL *s)
4667 int scts_extracted = 0;
4669 if (s->ext.scts != NULL) {
4670 const unsigned char *p = s->ext.scts;
4671 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4673 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4675 SCT_LIST_free(scts);
4678 return scts_extracted;
4682 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4683 * contains an SCT X509 extension. They will be stored in |s->scts|.
4685 * - The number of SCTs extracted, assuming an OCSP response exists.
4686 * - 0 if no OCSP response exists or it contains no SCTs.
4687 * - A negative integer if an error occurs.
4689 static int ct_extract_ocsp_response_scts(SSL *s)
4691 # ifndef OPENSSL_NO_OCSP
4692 int scts_extracted = 0;
4693 const unsigned char *p;
4694 OCSP_BASICRESP *br = NULL;
4695 OCSP_RESPONSE *rsp = NULL;
4696 STACK_OF(SCT) *scts = NULL;
4699 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4702 p = s->ext.ocsp.resp;
4703 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4707 br = OCSP_response_get1_basic(rsp);
4711 for (i = 0; i < OCSP_resp_count(br); ++i) {
4712 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4718 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4720 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4721 if (scts_extracted < 0)
4725 SCT_LIST_free(scts);
4726 OCSP_BASICRESP_free(br);
4727 OCSP_RESPONSE_free(rsp);
4728 return scts_extracted;
4730 /* Behave as if no OCSP response exists */
4736 * Attempts to extract SCTs from the peer certificate.
4737 * Return the number of SCTs extracted, or a negative integer if an error
4740 static int ct_extract_x509v3_extension_scts(SSL *s)
4742 int scts_extracted = 0;
4743 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4746 STACK_OF(SCT) *scts =
4747 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4750 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4752 SCT_LIST_free(scts);
4755 return scts_extracted;
4759 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4760 * response (if it exists) and X509v3 extensions in the certificate.
4761 * Returns NULL if an error occurs.
4763 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4765 if (!s->scts_parsed) {
4766 if (ct_extract_tls_extension_scts(s) < 0 ||
4767 ct_extract_ocsp_response_scts(s) < 0 ||
4768 ct_extract_x509v3_extension_scts(s) < 0)
4778 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4779 const STACK_OF(SCT) *scts, void *unused_arg)
4784 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4785 const STACK_OF(SCT) *scts, void *unused_arg)
4787 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4790 for (i = 0; i < count; ++i) {
4791 SCT *sct = sk_SCT_value(scts, i);
4792 int status = SCT_get_validation_status(sct);
4794 if (status == SCT_VALIDATION_STATUS_VALID)
4797 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4801 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4805 * Since code exists that uses the custom extension handler for CT, look
4806 * for this and throw an error if they have already registered to use CT.
4808 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4809 TLSEXT_TYPE_signed_certificate_timestamp))
4811 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4812 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4816 if (callback != NULL) {
4818 * If we are validating CT, then we MUST accept SCTs served via OCSP
4820 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4824 s->ct_validation_callback = callback;
4825 s->ct_validation_callback_arg = arg;
4830 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4831 ssl_ct_validation_cb callback, void *arg)
4834 * Since code exists that uses the custom extension handler for CT, look for
4835 * this and throw an error if they have already registered to use CT.
4837 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4838 TLSEXT_TYPE_signed_certificate_timestamp))
4840 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4841 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4845 ctx->ct_validation_callback = callback;
4846 ctx->ct_validation_callback_arg = arg;
4850 int SSL_ct_is_enabled(const SSL *s)
4852 return s->ct_validation_callback != NULL;
4855 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4857 return ctx->ct_validation_callback != NULL;
4860 int ssl_validate_ct(SSL *s)
4863 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4865 SSL_DANE *dane = &s->dane;
4866 CT_POLICY_EVAL_CTX *ctx = NULL;
4867 const STACK_OF(SCT) *scts;
4870 * If no callback is set, the peer is anonymous, or its chain is invalid,
4871 * skip SCT validation - just return success. Applications that continue
4872 * handshakes without certificates, with unverified chains, or pinned leaf
4873 * certificates are outside the scope of the WebPKI and CT.
4875 * The above exclusions notwithstanding the vast majority of peers will
4876 * have rather ordinary certificate chains validated by typical
4877 * applications that perform certificate verification and therefore will
4878 * process SCTs when enabled.
4880 if (s->ct_validation_callback == NULL || cert == NULL ||
4881 s->verify_result != X509_V_OK ||
4882 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4886 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4887 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4889 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4890 switch (dane->mtlsa->usage) {
4891 case DANETLS_USAGE_DANE_TA:
4892 case DANETLS_USAGE_DANE_EE:
4897 ctx = CT_POLICY_EVAL_CTX_new();
4899 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4900 ERR_R_MALLOC_FAILURE);
4904 issuer = sk_X509_value(s->verified_chain, 1);
4905 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4906 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4907 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4908 CT_POLICY_EVAL_CTX_set_time(
4909 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4911 scts = SSL_get0_peer_scts(s);
4914 * This function returns success (> 0) only when all the SCTs are valid, 0
4915 * when some are invalid, and < 0 on various internal errors (out of
4916 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4917 * reason to abort the handshake, that decision is up to the callback.
4918 * Therefore, we error out only in the unexpected case that the return
4919 * value is negative.
4921 * XXX: One might well argue that the return value of this function is an
4922 * unfortunate design choice. Its job is only to determine the validation
4923 * status of each of the provided SCTs. So long as it correctly separates
4924 * the wheat from the chaff it should return success. Failure in this case
4925 * ought to correspond to an inability to carry out its duties.
4927 if (SCT_LIST_validate(scts, ctx) < 0) {
4928 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4929 SSL_R_SCT_VERIFICATION_FAILED);
4933 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4935 ret = 0; /* This function returns 0 on failure */
4937 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4938 SSL_R_CALLBACK_FAILED);
4941 CT_POLICY_EVAL_CTX_free(ctx);
4943 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4944 * failure return code here. Also the application may wish the complete
4945 * the handshake, and then disconnect cleanly at a higher layer, after
4946 * checking the verification status of the completed connection.
4948 * We therefore force a certificate verification failure which will be
4949 * visible via SSL_get_verify_result() and cached as part of any resumed
4952 * Note: the permissive callback is for information gathering only, always
4953 * returns success, and does not affect verification status. Only the
4954 * strict callback or a custom application-specified callback can trigger
4955 * connection failure or record a verification error.
4958 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4962 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4964 switch (validation_mode) {
4966 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4968 case SSL_CT_VALIDATION_PERMISSIVE:
4969 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4970 case SSL_CT_VALIDATION_STRICT:
4971 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4975 int SSL_enable_ct(SSL *s, int validation_mode)
4977 switch (validation_mode) {
4979 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4981 case SSL_CT_VALIDATION_PERMISSIVE:
4982 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4983 case SSL_CT_VALIDATION_STRICT:
4984 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4988 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4990 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4993 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4995 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4998 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
5000 CTLOG_STORE_free(ctx->ctlog_store);
5001 ctx->ctlog_store = logs;
5004 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
5006 return ctx->ctlog_store;
5009 #endif /* OPENSSL_NO_CT */
5011 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
5014 c->client_hello_cb = cb;
5015 c->client_hello_cb_arg = arg;
5018 int SSL_client_hello_isv2(SSL *s)
5020 if (s->clienthello == NULL)
5022 return s->clienthello->isv2;
5025 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
5027 if (s->clienthello == NULL)
5029 return s->clienthello->legacy_version;
5032 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
5034 if (s->clienthello == NULL)
5037 *out = s->clienthello->random;
5038 return SSL3_RANDOM_SIZE;
5041 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
5043 if (s->clienthello == NULL)
5046 *out = s->clienthello->session_id;
5047 return s->clienthello->session_id_len;
5050 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
5052 if (s->clienthello == NULL)
5055 *out = PACKET_data(&s->clienthello->ciphersuites);
5056 return PACKET_remaining(&s->clienthello->ciphersuites);
5059 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
5061 if (s->clienthello == NULL)
5064 *out = s->clienthello->compressions;
5065 return s->clienthello->compressions_len;
5068 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5074 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5076 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5077 ext = s->clienthello->pre_proc_exts + i;
5086 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
5087 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
5088 ERR_R_MALLOC_FAILURE);
5091 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5092 ext = s->clienthello->pre_proc_exts + i;
5094 if (ext->received_order >= num)
5096 present[ext->received_order] = ext->type;
5103 OPENSSL_free(present);
5107 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5113 if (s->clienthello == NULL)
5115 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5116 r = s->clienthello->pre_proc_exts + i;
5117 if (r->present && r->type == type) {
5119 *out = PACKET_data(&r->data);
5121 *outlen = PACKET_remaining(&r->data);
5128 int SSL_free_buffers(SSL *ssl)
5130 RECORD_LAYER *rl = &ssl->rlayer;
5132 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5135 RECORD_LAYER_release(rl);
5139 int SSL_alloc_buffers(SSL *ssl)
5141 return ssl3_setup_buffers(ssl);
5144 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5146 ctx->keylog_callback = cb;
5149 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5151 return ctx->keylog_callback;
5154 static int nss_keylog_int(const char *prefix,
5156 const uint8_t *parameter_1,
5157 size_t parameter_1_len,
5158 const uint8_t *parameter_2,
5159 size_t parameter_2_len)
5162 char *cursor = NULL;
5167 if (ssl->ctx->keylog_callback == NULL)
5171 * Our output buffer will contain the following strings, rendered with
5172 * space characters in between, terminated by a NULL character: first the
5173 * prefix, then the first parameter, then the second parameter. The
5174 * meaning of each parameter depends on the specific key material being
5175 * logged. Note that the first and second parameters are encoded in
5176 * hexadecimal, so we need a buffer that is twice their lengths.
5178 prefix_len = strlen(prefix);
5179 out_len = prefix_len + (2 * parameter_1_len) + (2 * parameter_2_len) + 3;
5180 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5181 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5182 ERR_R_MALLOC_FAILURE);
5186 strcpy(cursor, prefix);
5187 cursor += prefix_len;
5190 for (i = 0; i < parameter_1_len; i++) {
5191 sprintf(cursor, "%02x", parameter_1[i]);
5196 for (i = 0; i < parameter_2_len; i++) {
5197 sprintf(cursor, "%02x", parameter_2[i]);
5202 ssl->ctx->keylog_callback(ssl, (const char *)out);
5203 OPENSSL_clear_free(out, out_len);
5208 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5209 const uint8_t *encrypted_premaster,
5210 size_t encrypted_premaster_len,
5211 const uint8_t *premaster,
5212 size_t premaster_len)
5214 if (encrypted_premaster_len < 8) {
5215 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5216 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5220 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5221 return nss_keylog_int("RSA",
5223 encrypted_premaster,
5229 int ssl_log_secret(SSL *ssl,
5231 const uint8_t *secret,
5234 return nss_keylog_int(label,
5236 ssl->s3->client_random,
5242 #define SSLV2_CIPHER_LEN 3
5244 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5248 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5250 if (PACKET_remaining(cipher_suites) == 0) {
5251 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5252 SSL_R_NO_CIPHERS_SPECIFIED);
5256 if (PACKET_remaining(cipher_suites) % n != 0) {
5257 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5258 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5262 OPENSSL_free(s->s3->tmp.ciphers_raw);
5263 s->s3->tmp.ciphers_raw = NULL;
5264 s->s3->tmp.ciphers_rawlen = 0;
5267 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5268 PACKET sslv2ciphers = *cipher_suites;
5269 unsigned int leadbyte;
5273 * We store the raw ciphers list in SSLv3+ format so we need to do some
5274 * preprocessing to convert the list first. If there are any SSLv2 only
5275 * ciphersuites with a non-zero leading byte then we are going to
5276 * slightly over allocate because we won't store those. But that isn't a
5279 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5280 s->s3->tmp.ciphers_raw = raw;
5282 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5283 ERR_R_MALLOC_FAILURE);
5286 for (s->s3->tmp.ciphers_rawlen = 0;
5287 PACKET_remaining(&sslv2ciphers) > 0;
5288 raw += TLS_CIPHER_LEN) {
5289 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5291 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5294 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5295 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5297 OPENSSL_free(s->s3->tmp.ciphers_raw);
5298 s->s3->tmp.ciphers_raw = NULL;
5299 s->s3->tmp.ciphers_rawlen = 0;
5303 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5305 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5306 &s->s3->tmp.ciphers_rawlen)) {
5307 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5308 ERR_R_INTERNAL_ERROR);
5314 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5315 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5316 STACK_OF(SSL_CIPHER) **scsvs)
5320 if (!PACKET_buf_init(&pkt, bytes, len))
5322 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5325 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5326 STACK_OF(SSL_CIPHER) **skp,
5327 STACK_OF(SSL_CIPHER) **scsvs_out,
5328 int sslv2format, int fatal)
5330 const SSL_CIPHER *c;
5331 STACK_OF(SSL_CIPHER) *sk = NULL;
5332 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5334 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5335 unsigned char cipher[SSLV2_CIPHER_LEN];
5337 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5339 if (PACKET_remaining(cipher_suites) == 0) {
5341 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5342 SSL_R_NO_CIPHERS_SPECIFIED);
5344 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5348 if (PACKET_remaining(cipher_suites) % n != 0) {
5350 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5351 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5353 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5354 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5358 sk = sk_SSL_CIPHER_new_null();
5359 scsvs = sk_SSL_CIPHER_new_null();
5360 if (sk == NULL || scsvs == NULL) {
5362 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5363 ERR_R_MALLOC_FAILURE);
5365 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5369 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5371 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5372 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5373 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5375 if (sslv2format && cipher[0] != '\0')
5378 /* For SSLv2-compat, ignore leading 0-byte. */
5379 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5381 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5382 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5384 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5385 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5387 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5392 if (PACKET_remaining(cipher_suites) > 0) {
5394 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5397 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5404 sk_SSL_CIPHER_free(sk);
5405 if (scsvs_out != NULL)
5408 sk_SSL_CIPHER_free(scsvs);
5411 sk_SSL_CIPHER_free(sk);
5412 sk_SSL_CIPHER_free(scsvs);
5416 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5418 ctx->max_early_data = max_early_data;
5423 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5425 return ctx->max_early_data;
5428 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5430 s->max_early_data = max_early_data;
5435 uint32_t SSL_get_max_early_data(const SSL *s)
5437 return s->max_early_data;
5440 int SSL_CTX_set_recv_max_early_data(SSL_CTX *ctx, uint32_t recv_max_early_data)
5442 ctx->recv_max_early_data = recv_max_early_data;
5447 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX *ctx)
5449 return ctx->recv_max_early_data;
5452 int SSL_set_recv_max_early_data(SSL *s, uint32_t recv_max_early_data)
5454 s->recv_max_early_data = recv_max_early_data;
5459 uint32_t SSL_get_recv_max_early_data(const SSL *s)
5461 return s->recv_max_early_data;
5464 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5466 /* Return any active Max Fragment Len extension */
5467 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5468 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5470 /* return current SSL connection setting */
5471 return ssl->max_send_fragment;
5474 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5476 /* Return a value regarding an active Max Fragment Len extension */
5477 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5478 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5479 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5481 /* else limit |split_send_fragment| to current |max_send_fragment| */
5482 if (ssl->split_send_fragment > ssl->max_send_fragment)
5483 return ssl->max_send_fragment;
5485 /* return current SSL connection setting */
5486 return ssl->split_send_fragment;
5489 int SSL_stateless(SSL *s)
5493 /* Ensure there is no state left over from a previous invocation */
5499 s->s3->flags |= TLS1_FLAGS_STATELESS;
5500 ret = SSL_accept(s);
5501 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5503 if (ret > 0 && s->ext.cookieok)
5506 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5512 void SSL_CTX_set_post_handshake_auth(SSL_CTX *ctx, int val)
5514 ctx->pha_enabled = val;
5517 void SSL_set_post_handshake_auth(SSL *ssl, int val)
5519 ssl->pha_enabled = val;
5522 int SSL_verify_client_post_handshake(SSL *ssl)
5524 if (!SSL_IS_TLS13(ssl)) {
5525 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5529 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5533 if (!SSL_is_init_finished(ssl)) {
5534 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5538 switch (ssl->post_handshake_auth) {
5540 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5543 case SSL_PHA_EXT_SENT:
5544 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5546 case SSL_PHA_EXT_RECEIVED:
5548 case SSL_PHA_REQUEST_PENDING:
5549 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5551 case SSL_PHA_REQUESTED:
5552 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5556 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5558 /* checks verify_mode and algorithm_auth */
5559 if (!send_certificate_request(ssl)) {
5560 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5561 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5565 ossl_statem_set_in_init(ssl, 1);
5569 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5570 SSL_CTX_generate_session_ticket_fn gen_cb,
5571 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5574 ctx->generate_ticket_cb = gen_cb;
5575 ctx->decrypt_ticket_cb = dec_cb;
5576 ctx->ticket_cb_data = arg;
5580 void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
5581 SSL_allow_early_data_cb_fn cb,
5584 ctx->allow_early_data_cb = cb;
5585 ctx->allow_early_data_cb_data = arg;
5588 void SSL_set_allow_early_data_cb(SSL *s,
5589 SSL_allow_early_data_cb_fn cb,
5592 s->allow_early_data_cb = cb;
5593 s->allow_early_data_cb_data = arg;