2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4 * Copyright 2005 Nokia. All rights reserved.
6 * Licensed under the OpenSSL license (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
14 #include <openssl/objects.h>
15 #include <openssl/x509v3.h>
16 #include <openssl/rand.h>
17 #include <openssl/rand_drbg.h>
18 #include <openssl/ocsp.h>
19 #include <openssl/dh.h>
20 #include <openssl/engine.h>
21 #include <openssl/async.h>
22 #include <openssl/ct.h>
23 #include "internal/cryptlib.h"
24 #include "internal/refcount.h"
26 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
28 static int ssl_undefined_function_1(SSL *ssl, SSL3_RECORD *r, size_t s, int t)
33 return ssl_undefined_function(ssl);
36 static int ssl_undefined_function_2(SSL *ssl, SSL3_RECORD *r, unsigned char *s,
42 return ssl_undefined_function(ssl);
45 static int ssl_undefined_function_3(SSL *ssl, unsigned char *r,
46 unsigned char *s, size_t t, size_t *u)
52 return ssl_undefined_function(ssl);
55 static int ssl_undefined_function_4(SSL *ssl, int r)
58 return ssl_undefined_function(ssl);
61 static size_t ssl_undefined_function_5(SSL *ssl, const char *r, size_t s,
67 return ssl_undefined_function(ssl);
70 static int ssl_undefined_function_6(int r)
73 return ssl_undefined_function(NULL);
76 static int ssl_undefined_function_7(SSL *ssl, unsigned char *r, size_t s,
77 const char *t, size_t u,
78 const unsigned char *v, size_t w, int x)
87 return ssl_undefined_function(ssl);
90 SSL3_ENC_METHOD ssl3_undef_enc_method = {
91 ssl_undefined_function_1,
92 ssl_undefined_function_2,
93 ssl_undefined_function,
94 ssl_undefined_function_3,
95 ssl_undefined_function_4,
96 ssl_undefined_function_5,
97 NULL, /* client_finished_label */
98 0, /* client_finished_label_len */
99 NULL, /* server_finished_label */
100 0, /* server_finished_label_len */
101 ssl_undefined_function_6,
102 ssl_undefined_function_7,
105 struct ssl_async_args {
109 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
111 int (*func_read) (SSL *, void *, size_t, size_t *);
112 int (*func_write) (SSL *, const void *, size_t, size_t *);
113 int (*func_other) (SSL *);
117 static const struct {
123 DANETLS_MATCHING_FULL, 0, NID_undef
126 DANETLS_MATCHING_2256, 1, NID_sha256
129 DANETLS_MATCHING_2512, 2, NID_sha512
133 static int dane_ctx_enable(struct dane_ctx_st *dctx)
135 const EVP_MD **mdevp;
137 uint8_t mdmax = DANETLS_MATCHING_LAST;
138 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
141 if (dctx->mdevp != NULL)
144 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
145 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
147 if (mdord == NULL || mdevp == NULL) {
150 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
154 /* Install default entries */
155 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
158 if (dane_mds[i].nid == NID_undef ||
159 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
161 mdevp[dane_mds[i].mtype] = md;
162 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
172 static void dane_ctx_final(struct dane_ctx_st *dctx)
174 OPENSSL_free(dctx->mdevp);
177 OPENSSL_free(dctx->mdord);
182 static void tlsa_free(danetls_record *t)
186 OPENSSL_free(t->data);
187 EVP_PKEY_free(t->spki);
191 static void dane_final(SSL_DANE *dane)
193 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
196 sk_X509_pop_free(dane->certs, X509_free);
199 X509_free(dane->mcert);
207 * dane_copy - Copy dane configuration, sans verification state.
209 static int ssl_dane_dup(SSL *to, SSL *from)
214 if (!DANETLS_ENABLED(&from->dane))
217 num = sk_danetls_record_num(from->dane.trecs);
218 dane_final(&to->dane);
219 to->dane.flags = from->dane.flags;
220 to->dane.dctx = &to->ctx->dane;
221 to->dane.trecs = sk_danetls_record_new_reserve(NULL, num);
223 if (to->dane.trecs == NULL) {
224 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
228 for (i = 0; i < num; ++i) {
229 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
231 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
232 t->data, t->dlen) <= 0)
238 static int dane_mtype_set(struct dane_ctx_st *dctx,
239 const EVP_MD *md, uint8_t mtype, uint8_t ord)
243 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
244 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
248 if (mtype > dctx->mdmax) {
249 const EVP_MD **mdevp;
251 int n = ((int)mtype) + 1;
253 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
255 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
260 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
262 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
267 /* Zero-fill any gaps */
268 for (i = dctx->mdmax + 1; i < mtype; ++i) {
276 dctx->mdevp[mtype] = md;
277 /* Coerce ordinal of disabled matching types to 0 */
278 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
283 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
285 if (mtype > dane->dctx->mdmax)
287 return dane->dctx->mdevp[mtype];
290 static int dane_tlsa_add(SSL_DANE *dane,
293 uint8_t mtype, unsigned const char *data, size_t dlen)
296 const EVP_MD *md = NULL;
297 int ilen = (int)dlen;
301 if (dane->trecs == NULL) {
302 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
306 if (ilen < 0 || dlen != (size_t)ilen) {
307 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
311 if (usage > DANETLS_USAGE_LAST) {
312 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
316 if (selector > DANETLS_SELECTOR_LAST) {
317 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
321 if (mtype != DANETLS_MATCHING_FULL) {
322 md = tlsa_md_get(dane, mtype);
324 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
329 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
330 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
334 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
338 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
339 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
344 t->selector = selector;
346 t->data = OPENSSL_malloc(dlen);
347 if (t->data == NULL) {
349 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
352 memcpy(t->data, data, dlen);
355 /* Validate and cache full certificate or public key */
356 if (mtype == DANETLS_MATCHING_FULL) {
357 const unsigned char *p = data;
359 EVP_PKEY *pkey = NULL;
362 case DANETLS_SELECTOR_CERT:
363 if (!d2i_X509(&cert, &p, ilen) || p < data ||
364 dlen != (size_t)(p - data)) {
366 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
369 if (X509_get0_pubkey(cert) == NULL) {
371 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
375 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
381 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
382 * records that contain full certificates of trust-anchors that are
383 * not present in the wire chain. For usage PKIX-TA(0), we augment
384 * the chain with untrusted Full(0) certificates from DNS, in case
385 * they are missing from the chain.
387 if ((dane->certs == NULL &&
388 (dane->certs = sk_X509_new_null()) == NULL) ||
389 !sk_X509_push(dane->certs, cert)) {
390 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
397 case DANETLS_SELECTOR_SPKI:
398 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
399 dlen != (size_t)(p - data)) {
401 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
406 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
407 * records that contain full bare keys of trust-anchors that are
408 * not present in the wire chain.
410 if (usage == DANETLS_USAGE_DANE_TA)
419 * Find the right insertion point for the new record.
421 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
422 * they can be processed first, as they require no chain building, and no
423 * expiration or hostname checks. Because DANE-EE(3) is numerically
424 * largest, this is accomplished via descending sort by "usage".
426 * We also sort in descending order by matching ordinal to simplify
427 * the implementation of digest agility in the verification code.
429 * The choice of order for the selector is not significant, so we
430 * use the same descending order for consistency.
432 num = sk_danetls_record_num(dane->trecs);
433 for (i = 0; i < num; ++i) {
434 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
436 if (rec->usage > usage)
438 if (rec->usage < usage)
440 if (rec->selector > selector)
442 if (rec->selector < selector)
444 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
449 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
451 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
454 dane->umask |= DANETLS_USAGE_BIT(usage);
460 * Return 0 if there is only one version configured and it was disabled
461 * at configure time. Return 1 otherwise.
463 static int ssl_check_allowed_versions(int min_version, int max_version)
465 int minisdtls = 0, maxisdtls = 0;
467 /* Figure out if we're doing DTLS versions or TLS versions */
468 if (min_version == DTLS1_BAD_VER
469 || min_version >> 8 == DTLS1_VERSION_MAJOR)
471 if (max_version == DTLS1_BAD_VER
472 || max_version >> 8 == DTLS1_VERSION_MAJOR)
474 /* A wildcard version of 0 could be DTLS or TLS. */
475 if ((minisdtls && !maxisdtls && max_version != 0)
476 || (maxisdtls && !minisdtls && min_version != 0)) {
477 /* Mixing DTLS and TLS versions will lead to sadness; deny it. */
481 if (minisdtls || maxisdtls) {
482 /* Do DTLS version checks. */
483 if (min_version == 0)
484 /* Ignore DTLS1_BAD_VER */
485 min_version = DTLS1_VERSION;
486 if (max_version == 0)
487 max_version = DTLS1_2_VERSION;
488 #ifdef OPENSSL_NO_DTLS1_2
489 if (max_version == DTLS1_2_VERSION)
490 max_version = DTLS1_VERSION;
492 #ifdef OPENSSL_NO_DTLS1
493 if (min_version == DTLS1_VERSION)
494 min_version = DTLS1_2_VERSION;
496 /* Done massaging versions; do the check. */
498 #ifdef OPENSSL_NO_DTLS1
499 || (DTLS_VERSION_GE(min_version, DTLS1_VERSION)
500 && DTLS_VERSION_GE(DTLS1_VERSION, max_version))
502 #ifdef OPENSSL_NO_DTLS1_2
503 || (DTLS_VERSION_GE(min_version, DTLS1_2_VERSION)
504 && DTLS_VERSION_GE(DTLS1_2_VERSION, max_version))
509 /* Regular TLS version checks. */
510 if (min_version == 0)
511 min_version = SSL3_VERSION;
512 if (max_version == 0)
513 max_version = TLS1_3_VERSION;
514 #ifdef OPENSSL_NO_TLS1_3
515 if (max_version == TLS1_3_VERSION)
516 max_version = TLS1_2_VERSION;
518 #ifdef OPENSSL_NO_TLS1_2
519 if (max_version == TLS1_2_VERSION)
520 max_version = TLS1_1_VERSION;
522 #ifdef OPENSSL_NO_TLS1_1
523 if (max_version == TLS1_1_VERSION)
524 max_version = TLS1_VERSION;
526 #ifdef OPENSSL_NO_TLS1
527 if (max_version == TLS1_VERSION)
528 max_version = SSL3_VERSION;
530 #ifdef OPENSSL_NO_SSL3
531 if (min_version == SSL3_VERSION)
532 min_version = TLS1_VERSION;
534 #ifdef OPENSSL_NO_TLS1
535 if (min_version == TLS1_VERSION)
536 min_version = TLS1_1_VERSION;
538 #ifdef OPENSSL_NO_TLS1_1
539 if (min_version == TLS1_1_VERSION)
540 min_version = TLS1_2_VERSION;
542 #ifdef OPENSSL_NO_TLS1_2
543 if (min_version == TLS1_2_VERSION)
544 min_version = TLS1_3_VERSION;
546 /* Done massaging versions; do the check. */
548 #ifdef OPENSSL_NO_SSL3
549 || (min_version <= SSL3_VERSION && SSL3_VERSION <= max_version)
551 #ifdef OPENSSL_NO_TLS1
552 || (min_version <= TLS1_VERSION && TLS1_VERSION <= max_version)
554 #ifdef OPENSSL_NO_TLS1_1
555 || (min_version <= TLS1_1_VERSION && TLS1_1_VERSION <= max_version)
557 #ifdef OPENSSL_NO_TLS1_2
558 || (min_version <= TLS1_2_VERSION && TLS1_2_VERSION <= max_version)
560 #ifdef OPENSSL_NO_TLS1_3
561 || (min_version <= TLS1_3_VERSION && TLS1_3_VERSION <= max_version)
569 static void clear_ciphers(SSL *s)
571 /* clear the current cipher */
572 ssl_clear_cipher_ctx(s);
573 ssl_clear_hash_ctx(&s->read_hash);
574 ssl_clear_hash_ctx(&s->write_hash);
577 int SSL_clear(SSL *s)
579 if (s->method == NULL) {
580 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
584 if (ssl_clear_bad_session(s)) {
585 SSL_SESSION_free(s->session);
588 SSL_SESSION_free(s->psksession);
589 s->psksession = NULL;
590 OPENSSL_free(s->psksession_id);
591 s->psksession_id = NULL;
592 s->psksession_id_len = 0;
593 s->hello_retry_request = 0;
599 if (s->renegotiate) {
600 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
604 ossl_statem_clear(s);
606 s->version = s->method->version;
607 s->client_version = s->version;
608 s->rwstate = SSL_NOTHING;
610 BUF_MEM_free(s->init_buf);
615 s->key_update = SSL_KEY_UPDATE_NONE;
617 EVP_MD_CTX_free(s->pha_dgst);
620 /* Reset DANE verification result state */
623 X509_free(s->dane.mcert);
624 s->dane.mcert = NULL;
625 s->dane.mtlsa = NULL;
627 /* Clear the verification result peername */
628 X509_VERIFY_PARAM_move_peername(s->param, NULL);
631 * Check to see if we were changed into a different method, if so, revert
634 if (s->method != s->ctx->method) {
635 s->method->ssl_free(s);
636 s->method = s->ctx->method;
637 if (!s->method->ssl_new(s))
640 if (!s->method->ssl_clear(s))
644 RECORD_LAYER_clear(&s->rlayer);
649 /** Used to change an SSL_CTXs default SSL method type */
650 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
652 STACK_OF(SSL_CIPHER) *sk;
656 sk = ssl_create_cipher_list(ctx->method,
657 ctx->tls13_ciphersuites,
659 &(ctx->cipher_list_by_id),
660 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
661 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
662 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
668 SSL *SSL_new(SSL_CTX *ctx)
673 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
676 if (ctx->method == NULL) {
677 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
681 s = OPENSSL_zalloc(sizeof(*s));
686 s->lock = CRYPTO_THREAD_lock_new();
687 if (s->lock == NULL) {
693 RECORD_LAYER_init(&s->rlayer, s);
695 s->options = ctx->options;
696 s->dane.flags = ctx->dane.flags;
697 s->min_proto_version = ctx->min_proto_version;
698 s->max_proto_version = ctx->max_proto_version;
700 s->max_cert_list = ctx->max_cert_list;
701 s->max_early_data = ctx->max_early_data;
703 /* Shallow copy of the ciphersuites stack */
704 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
705 if (s->tls13_ciphersuites == NULL)
709 * Earlier library versions used to copy the pointer to the CERT, not
710 * its contents; only when setting new parameters for the per-SSL
711 * copy, ssl_cert_new would be called (and the direct reference to
712 * the per-SSL_CTX settings would be lost, but those still were
713 * indirectly accessed for various purposes, and for that reason they
714 * used to be known as s->ctx->default_cert). Now we don't look at the
715 * SSL_CTX's CERT after having duplicated it once.
717 s->cert = ssl_cert_dup(ctx->cert);
721 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
722 s->msg_callback = ctx->msg_callback;
723 s->msg_callback_arg = ctx->msg_callback_arg;
724 s->verify_mode = ctx->verify_mode;
725 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
726 s->record_padding_cb = ctx->record_padding_cb;
727 s->record_padding_arg = ctx->record_padding_arg;
728 s->block_padding = ctx->block_padding;
729 s->sid_ctx_length = ctx->sid_ctx_length;
730 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
732 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
733 s->verify_callback = ctx->default_verify_callback;
734 s->generate_session_id = ctx->generate_session_id;
736 s->param = X509_VERIFY_PARAM_new();
737 if (s->param == NULL)
739 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
740 s->quiet_shutdown = ctx->quiet_shutdown;
742 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
743 s->max_send_fragment = ctx->max_send_fragment;
744 s->split_send_fragment = ctx->split_send_fragment;
745 s->max_pipelines = ctx->max_pipelines;
746 if (s->max_pipelines > 1)
747 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
748 if (ctx->default_read_buf_len > 0)
749 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
754 s->ext.debug_arg = NULL;
755 s->ext.ticket_expected = 0;
756 s->ext.status_type = ctx->ext.status_type;
757 s->ext.status_expected = 0;
758 s->ext.ocsp.ids = NULL;
759 s->ext.ocsp.exts = NULL;
760 s->ext.ocsp.resp = NULL;
761 s->ext.ocsp.resp_len = 0;
763 s->session_ctx = ctx;
764 #ifndef OPENSSL_NO_EC
765 if (ctx->ext.ecpointformats) {
766 s->ext.ecpointformats =
767 OPENSSL_memdup(ctx->ext.ecpointformats,
768 ctx->ext.ecpointformats_len);
769 if (!s->ext.ecpointformats)
771 s->ext.ecpointformats_len =
772 ctx->ext.ecpointformats_len;
774 if (ctx->ext.supportedgroups) {
775 s->ext.supportedgroups =
776 OPENSSL_memdup(ctx->ext.supportedgroups,
777 ctx->ext.supportedgroups_len
778 * sizeof(*ctx->ext.supportedgroups));
779 if (!s->ext.supportedgroups)
781 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
784 #ifndef OPENSSL_NO_NEXTPROTONEG
788 if (s->ctx->ext.alpn) {
789 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
790 if (s->ext.alpn == NULL)
792 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
793 s->ext.alpn_len = s->ctx->ext.alpn_len;
796 s->verified_chain = NULL;
797 s->verify_result = X509_V_OK;
799 s->default_passwd_callback = ctx->default_passwd_callback;
800 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
802 s->method = ctx->method;
804 s->key_update = SSL_KEY_UPDATE_NONE;
806 if (!s->method->ssl_new(s))
809 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
814 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
817 #ifndef OPENSSL_NO_PSK
818 s->psk_client_callback = ctx->psk_client_callback;
819 s->psk_server_callback = ctx->psk_server_callback;
821 s->psk_find_session_cb = ctx->psk_find_session_cb;
822 s->psk_use_session_cb = ctx->psk_use_session_cb;
826 #ifndef OPENSSL_NO_CT
827 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
828 ctx->ct_validation_callback_arg))
835 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
839 int SSL_is_dtls(const SSL *s)
841 return SSL_IS_DTLS(s) ? 1 : 0;
844 int SSL_up_ref(SSL *s)
848 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
851 REF_PRINT_COUNT("SSL", s);
852 REF_ASSERT_ISNT(i < 2);
853 return ((i > 1) ? 1 : 0);
856 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
857 unsigned int sid_ctx_len)
859 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
860 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
861 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
864 ctx->sid_ctx_length = sid_ctx_len;
865 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
870 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
871 unsigned int sid_ctx_len)
873 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
874 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
875 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
878 ssl->sid_ctx_length = sid_ctx_len;
879 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
884 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
886 CRYPTO_THREAD_write_lock(ctx->lock);
887 ctx->generate_session_id = cb;
888 CRYPTO_THREAD_unlock(ctx->lock);
892 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
894 CRYPTO_THREAD_write_lock(ssl->lock);
895 ssl->generate_session_id = cb;
896 CRYPTO_THREAD_unlock(ssl->lock);
900 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
904 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
905 * we can "construct" a session to give us the desired check - i.e. to
906 * find if there's a session in the hash table that would conflict with
907 * any new session built out of this id/id_len and the ssl_version in use
912 if (id_len > sizeof(r.session_id))
915 r.ssl_version = ssl->version;
916 r.session_id_length = id_len;
917 memcpy(r.session_id, id, id_len);
919 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
920 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
921 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
925 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
927 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
930 int SSL_set_purpose(SSL *s, int purpose)
932 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
935 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
937 return X509_VERIFY_PARAM_set_trust(s->param, trust);
940 int SSL_set_trust(SSL *s, int trust)
942 return X509_VERIFY_PARAM_set_trust(s->param, trust);
945 int SSL_set1_host(SSL *s, const char *hostname)
947 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
950 int SSL_add1_host(SSL *s, const char *hostname)
952 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
955 void SSL_set_hostflags(SSL *s, unsigned int flags)
957 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
960 const char *SSL_get0_peername(SSL *s)
962 return X509_VERIFY_PARAM_get0_peername(s->param);
965 int SSL_CTX_dane_enable(SSL_CTX *ctx)
967 return dane_ctx_enable(&ctx->dane);
970 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
972 unsigned long orig = ctx->dane.flags;
974 ctx->dane.flags |= flags;
978 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
980 unsigned long orig = ctx->dane.flags;
982 ctx->dane.flags &= ~flags;
986 int SSL_dane_enable(SSL *s, const char *basedomain)
988 SSL_DANE *dane = &s->dane;
990 if (s->ctx->dane.mdmax == 0) {
991 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
994 if (dane->trecs != NULL) {
995 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1000 * Default SNI name. This rejects empty names, while set1_host below
1001 * accepts them and disables host name checks. To avoid side-effects with
1002 * invalid input, set the SNI name first.
1004 if (s->ext.hostname == NULL) {
1005 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1006 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1011 /* Primary RFC6125 reference identifier */
1012 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1013 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1019 dane->dctx = &s->ctx->dane;
1020 dane->trecs = sk_danetls_record_new_null();
1022 if (dane->trecs == NULL) {
1023 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1029 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1031 unsigned long orig = ssl->dane.flags;
1033 ssl->dane.flags |= flags;
1037 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1039 unsigned long orig = ssl->dane.flags;
1041 ssl->dane.flags &= ~flags;
1045 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1047 SSL_DANE *dane = &s->dane;
1049 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1053 *mcert = dane->mcert;
1055 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1060 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1061 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1063 SSL_DANE *dane = &s->dane;
1065 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1069 *usage = dane->mtlsa->usage;
1071 *selector = dane->mtlsa->selector;
1073 *mtype = dane->mtlsa->mtype;
1075 *data = dane->mtlsa->data;
1077 *dlen = dane->mtlsa->dlen;
1082 SSL_DANE *SSL_get0_dane(SSL *s)
1087 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1088 uint8_t mtype, unsigned const char *data, size_t dlen)
1090 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1093 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1096 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1099 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1101 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1104 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1106 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1109 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1114 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1119 void SSL_certs_clear(SSL *s)
1121 ssl_cert_clear_certs(s->cert);
1124 void SSL_free(SSL *s)
1131 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1132 REF_PRINT_COUNT("SSL", s);
1135 REF_ASSERT_ISNT(i < 0);
1137 X509_VERIFY_PARAM_free(s->param);
1138 dane_final(&s->dane);
1139 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1141 /* Ignore return value */
1142 ssl_free_wbio_buffer(s);
1144 BIO_free_all(s->wbio);
1145 BIO_free_all(s->rbio);
1147 BUF_MEM_free(s->init_buf);
1149 /* add extra stuff */
1150 sk_SSL_CIPHER_free(s->cipher_list);
1151 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1152 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1154 /* Make the next call work :-) */
1155 if (s->session != NULL) {
1156 ssl_clear_bad_session(s);
1157 SSL_SESSION_free(s->session);
1159 SSL_SESSION_free(s->psksession);
1160 OPENSSL_free(s->psksession_id);
1164 ssl_cert_free(s->cert);
1165 /* Free up if allocated */
1167 OPENSSL_free(s->ext.hostname);
1168 SSL_CTX_free(s->session_ctx);
1169 #ifndef OPENSSL_NO_EC
1170 OPENSSL_free(s->ext.ecpointformats);
1171 OPENSSL_free(s->ext.supportedgroups);
1172 #endif /* OPENSSL_NO_EC */
1173 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1174 #ifndef OPENSSL_NO_OCSP
1175 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1177 #ifndef OPENSSL_NO_CT
1178 SCT_LIST_free(s->scts);
1179 OPENSSL_free(s->ext.scts);
1181 OPENSSL_free(s->ext.ocsp.resp);
1182 OPENSSL_free(s->ext.alpn);
1183 OPENSSL_free(s->ext.tls13_cookie);
1184 OPENSSL_free(s->clienthello);
1185 OPENSSL_free(s->pha_context);
1186 EVP_MD_CTX_free(s->pha_dgst);
1188 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1190 sk_X509_pop_free(s->verified_chain, X509_free);
1192 if (s->method != NULL)
1193 s->method->ssl_free(s);
1195 RECORD_LAYER_release(&s->rlayer);
1197 SSL_CTX_free(s->ctx);
1199 ASYNC_WAIT_CTX_free(s->waitctx);
1201 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1202 OPENSSL_free(s->ext.npn);
1205 #ifndef OPENSSL_NO_SRTP
1206 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1209 CRYPTO_THREAD_lock_free(s->lock);
1214 void SSL_set0_rbio(SSL *s, BIO *rbio)
1216 BIO_free_all(s->rbio);
1220 void SSL_set0_wbio(SSL *s, BIO *wbio)
1223 * If the output buffering BIO is still in place, remove it
1225 if (s->bbio != NULL)
1226 s->wbio = BIO_pop(s->wbio);
1228 BIO_free_all(s->wbio);
1231 /* Re-attach |bbio| to the new |wbio|. */
1232 if (s->bbio != NULL)
1233 s->wbio = BIO_push(s->bbio, s->wbio);
1236 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1239 * For historical reasons, this function has many different cases in
1240 * ownership handling.
1243 /* If nothing has changed, do nothing */
1244 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1248 * If the two arguments are equal then one fewer reference is granted by the
1249 * caller than we want to take
1251 if (rbio != NULL && rbio == wbio)
1255 * If only the wbio is changed only adopt one reference.
1257 if (rbio == SSL_get_rbio(s)) {
1258 SSL_set0_wbio(s, wbio);
1262 * There is an asymmetry here for historical reasons. If only the rbio is
1263 * changed AND the rbio and wbio were originally different, then we only
1264 * adopt one reference.
1266 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1267 SSL_set0_rbio(s, rbio);
1271 /* Otherwise, adopt both references. */
1272 SSL_set0_rbio(s, rbio);
1273 SSL_set0_wbio(s, wbio);
1276 BIO *SSL_get_rbio(const SSL *s)
1281 BIO *SSL_get_wbio(const SSL *s)
1283 if (s->bbio != NULL) {
1285 * If |bbio| is active, the true caller-configured BIO is its
1288 return BIO_next(s->bbio);
1293 int SSL_get_fd(const SSL *s)
1295 return SSL_get_rfd(s);
1298 int SSL_get_rfd(const SSL *s)
1303 b = SSL_get_rbio(s);
1304 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1306 BIO_get_fd(r, &ret);
1310 int SSL_get_wfd(const SSL *s)
1315 b = SSL_get_wbio(s);
1316 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1318 BIO_get_fd(r, &ret);
1322 #ifndef OPENSSL_NO_SOCK
1323 int SSL_set_fd(SSL *s, int fd)
1328 bio = BIO_new(BIO_s_socket());
1331 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1334 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1335 SSL_set_bio(s, bio, bio);
1341 int SSL_set_wfd(SSL *s, int fd)
1343 BIO *rbio = SSL_get_rbio(s);
1345 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1346 || (int)BIO_get_fd(rbio, NULL) != fd) {
1347 BIO *bio = BIO_new(BIO_s_socket());
1350 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1353 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1354 SSL_set0_wbio(s, bio);
1357 SSL_set0_wbio(s, rbio);
1362 int SSL_set_rfd(SSL *s, int fd)
1364 BIO *wbio = SSL_get_wbio(s);
1366 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1367 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1368 BIO *bio = BIO_new(BIO_s_socket());
1371 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1374 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1375 SSL_set0_rbio(s, bio);
1378 SSL_set0_rbio(s, wbio);
1385 /* return length of latest Finished message we sent, copy to 'buf' */
1386 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1390 if (s->s3 != NULL) {
1391 ret = s->s3->tmp.finish_md_len;
1394 memcpy(buf, s->s3->tmp.finish_md, count);
1399 /* return length of latest Finished message we expected, copy to 'buf' */
1400 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1404 if (s->s3 != NULL) {
1405 ret = s->s3->tmp.peer_finish_md_len;
1408 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1413 int SSL_get_verify_mode(const SSL *s)
1415 return s->verify_mode;
1418 int SSL_get_verify_depth(const SSL *s)
1420 return X509_VERIFY_PARAM_get_depth(s->param);
1423 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1424 return s->verify_callback;
1427 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1429 return ctx->verify_mode;
1432 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1434 return X509_VERIFY_PARAM_get_depth(ctx->param);
1437 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1438 return ctx->default_verify_callback;
1441 void SSL_set_verify(SSL *s, int mode,
1442 int (*callback) (int ok, X509_STORE_CTX *ctx))
1444 s->verify_mode = mode;
1445 if (callback != NULL)
1446 s->verify_callback = callback;
1449 void SSL_set_verify_depth(SSL *s, int depth)
1451 X509_VERIFY_PARAM_set_depth(s->param, depth);
1454 void SSL_set_read_ahead(SSL *s, int yes)
1456 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1459 int SSL_get_read_ahead(const SSL *s)
1461 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1464 int SSL_pending(const SSL *s)
1466 size_t pending = s->method->ssl_pending(s);
1469 * SSL_pending cannot work properly if read-ahead is enabled
1470 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1471 * impossible to fix since SSL_pending cannot report errors that may be
1472 * observed while scanning the new data. (Note that SSL_pending() is
1473 * often used as a boolean value, so we'd better not return -1.)
1475 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1476 * we just return INT_MAX.
1478 return pending < INT_MAX ? (int)pending : INT_MAX;
1481 int SSL_has_pending(const SSL *s)
1484 * Similar to SSL_pending() but returns a 1 to indicate that we have
1485 * unprocessed data available or 0 otherwise (as opposed to the number of
1486 * bytes available). Unlike SSL_pending() this will take into account
1487 * read_ahead data. A 1 return simply indicates that we have unprocessed
1488 * data. That data may not result in any application data, or we may fail
1489 * to parse the records for some reason.
1491 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1494 return RECORD_LAYER_read_pending(&s->rlayer);
1497 X509 *SSL_get_peer_certificate(const SSL *s)
1501 if ((s == NULL) || (s->session == NULL))
1504 r = s->session->peer;
1514 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1518 if ((s == NULL) || (s->session == NULL))
1521 r = s->session->peer_chain;
1524 * If we are a client, cert_chain includes the peer's own certificate; if
1525 * we are a server, it does not.
1532 * Now in theory, since the calling process own 't' it should be safe to
1533 * modify. We need to be able to read f without being hassled
1535 int SSL_copy_session_id(SSL *t, const SSL *f)
1538 /* Do we need to to SSL locking? */
1539 if (!SSL_set_session(t, SSL_get_session(f))) {
1544 * what if we are setup for one protocol version but want to talk another
1546 if (t->method != f->method) {
1547 t->method->ssl_free(t);
1548 t->method = f->method;
1549 if (t->method->ssl_new(t) == 0)
1553 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1554 ssl_cert_free(t->cert);
1556 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1563 /* Fix this so it checks all the valid key/cert options */
1564 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1566 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1567 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1570 if (ctx->cert->key->privatekey == NULL) {
1571 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1574 return X509_check_private_key
1575 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1578 /* Fix this function so that it takes an optional type parameter */
1579 int SSL_check_private_key(const SSL *ssl)
1582 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1585 if (ssl->cert->key->x509 == NULL) {
1586 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1589 if (ssl->cert->key->privatekey == NULL) {
1590 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1593 return X509_check_private_key(ssl->cert->key->x509,
1594 ssl->cert->key->privatekey);
1597 int SSL_waiting_for_async(SSL *s)
1605 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1607 ASYNC_WAIT_CTX *ctx = s->waitctx;
1611 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1614 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1615 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1617 ASYNC_WAIT_CTX *ctx = s->waitctx;
1621 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1625 int SSL_accept(SSL *s)
1627 if (s->handshake_func == NULL) {
1628 /* Not properly initialized yet */
1629 SSL_set_accept_state(s);
1632 return SSL_do_handshake(s);
1635 int SSL_connect(SSL *s)
1637 if (s->handshake_func == NULL) {
1638 /* Not properly initialized yet */
1639 SSL_set_connect_state(s);
1642 return SSL_do_handshake(s);
1645 long SSL_get_default_timeout(const SSL *s)
1647 return s->method->get_timeout();
1650 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1651 int (*func) (void *))
1654 if (s->waitctx == NULL) {
1655 s->waitctx = ASYNC_WAIT_CTX_new();
1656 if (s->waitctx == NULL)
1659 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1660 sizeof(struct ssl_async_args))) {
1662 s->rwstate = SSL_NOTHING;
1663 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1666 s->rwstate = SSL_ASYNC_PAUSED;
1669 s->rwstate = SSL_ASYNC_NO_JOBS;
1675 s->rwstate = SSL_NOTHING;
1676 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1677 /* Shouldn't happen */
1682 static int ssl_io_intern(void *vargs)
1684 struct ssl_async_args *args;
1689 args = (struct ssl_async_args *)vargs;
1693 switch (args->type) {
1695 return args->f.func_read(s, buf, num, &s->asyncrw);
1697 return args->f.func_write(s, buf, num, &s->asyncrw);
1699 return args->f.func_other(s);
1704 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1706 if (s->handshake_func == NULL) {
1707 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1711 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1712 s->rwstate = SSL_NOTHING;
1716 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1717 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1718 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1722 * If we are a client and haven't received the ServerHello etc then we
1725 ossl_statem_check_finish_init(s, 0);
1727 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1728 struct ssl_async_args args;
1734 args.type = READFUNC;
1735 args.f.func_read = s->method->ssl_read;
1737 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1738 *readbytes = s->asyncrw;
1741 return s->method->ssl_read(s, buf, num, readbytes);
1745 int SSL_read(SSL *s, void *buf, int num)
1751 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1755 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1758 * The cast is safe here because ret should be <= INT_MAX because num is
1762 ret = (int)readbytes;
1767 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1769 int ret = ssl_read_internal(s, buf, num, readbytes);
1776 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1781 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1782 return SSL_READ_EARLY_DATA_ERROR;
1785 switch (s->early_data_state) {
1786 case SSL_EARLY_DATA_NONE:
1787 if (!SSL_in_before(s)) {
1788 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1789 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1790 return SSL_READ_EARLY_DATA_ERROR;
1794 case SSL_EARLY_DATA_ACCEPT_RETRY:
1795 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1796 ret = SSL_accept(s);
1799 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1800 return SSL_READ_EARLY_DATA_ERROR;
1804 case SSL_EARLY_DATA_READ_RETRY:
1805 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1806 s->early_data_state = SSL_EARLY_DATA_READING;
1807 ret = SSL_read_ex(s, buf, num, readbytes);
1809 * State machine will update early_data_state to
1810 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1813 if (ret > 0 || (ret <= 0 && s->early_data_state
1814 != SSL_EARLY_DATA_FINISHED_READING)) {
1815 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1816 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1817 : SSL_READ_EARLY_DATA_ERROR;
1820 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1823 return SSL_READ_EARLY_DATA_FINISH;
1826 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1827 return SSL_READ_EARLY_DATA_ERROR;
1831 int SSL_get_early_data_status(const SSL *s)
1833 return s->ext.early_data;
1836 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1838 if (s->handshake_func == NULL) {
1839 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1843 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1846 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1847 struct ssl_async_args args;
1853 args.type = READFUNC;
1854 args.f.func_read = s->method->ssl_peek;
1856 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1857 *readbytes = s->asyncrw;
1860 return s->method->ssl_peek(s, buf, num, readbytes);
1864 int SSL_peek(SSL *s, void *buf, int num)
1870 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1874 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1877 * The cast is safe here because ret should be <= INT_MAX because num is
1881 ret = (int)readbytes;
1887 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1889 int ret = ssl_peek_internal(s, buf, num, readbytes);
1896 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1898 if (s->handshake_func == NULL) {
1899 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1903 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1904 s->rwstate = SSL_NOTHING;
1905 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1909 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1910 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1911 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1912 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1915 /* If we are a client and haven't sent the Finished we better do that */
1916 ossl_statem_check_finish_init(s, 1);
1918 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1920 struct ssl_async_args args;
1923 args.buf = (void *)buf;
1925 args.type = WRITEFUNC;
1926 args.f.func_write = s->method->ssl_write;
1928 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1929 *written = s->asyncrw;
1932 return s->method->ssl_write(s, buf, num, written);
1936 int SSL_write(SSL *s, const void *buf, int num)
1942 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1946 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1949 * The cast is safe here because ret should be <= INT_MAX because num is
1958 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1960 int ret = ssl_write_internal(s, buf, num, written);
1967 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1969 int ret, early_data_state;
1971 uint32_t partialwrite;
1973 switch (s->early_data_state) {
1974 case SSL_EARLY_DATA_NONE:
1976 || !SSL_in_before(s)
1977 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1978 && (s->psk_use_session_cb == NULL))) {
1979 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1980 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1985 case SSL_EARLY_DATA_CONNECT_RETRY:
1986 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1987 ret = SSL_connect(s);
1990 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1995 case SSL_EARLY_DATA_WRITE_RETRY:
1996 s->early_data_state = SSL_EARLY_DATA_WRITING;
1998 * We disable partial write for early data because we don't keep track
1999 * of how many bytes we've written between the SSL_write_ex() call and
2000 * the flush if the flush needs to be retried)
2002 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2003 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2004 ret = SSL_write_ex(s, buf, num, &writtmp);
2005 s->mode |= partialwrite;
2007 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2010 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2013 case SSL_EARLY_DATA_WRITE_FLUSH:
2014 /* The buffering BIO is still in place so we need to flush it */
2015 if (statem_flush(s) != 1)
2018 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2021 case SSL_EARLY_DATA_FINISHED_READING:
2022 case SSL_EARLY_DATA_READ_RETRY:
2023 early_data_state = s->early_data_state;
2024 /* We are a server writing to an unauthenticated client */
2025 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2026 ret = SSL_write_ex(s, buf, num, written);
2027 s->early_data_state = early_data_state;
2031 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2036 int SSL_shutdown(SSL *s)
2039 * Note that this function behaves differently from what one might
2040 * expect. Return values are 0 for no success (yet), 1 for success; but
2041 * calling it once is usually not enough, even if blocking I/O is used
2042 * (see ssl3_shutdown).
2045 if (s->handshake_func == NULL) {
2046 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2050 if (!SSL_in_init(s)) {
2051 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2052 struct ssl_async_args args;
2055 args.type = OTHERFUNC;
2056 args.f.func_other = s->method->ssl_shutdown;
2058 return ssl_start_async_job(s, &args, ssl_io_intern);
2060 return s->method->ssl_shutdown(s);
2063 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2068 int SSL_key_update(SSL *s, int updatetype)
2071 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2072 * negotiated, and that it is appropriate to call SSL_key_update() instead
2073 * of SSL_renegotiate().
2075 if (!SSL_IS_TLS13(s)) {
2076 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2080 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2081 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2082 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2086 if (!SSL_is_init_finished(s)) {
2087 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2091 ossl_statem_set_in_init(s, 1);
2092 s->key_update = updatetype;
2096 int SSL_get_key_update_type(SSL *s)
2098 return s->key_update;
2101 int SSL_renegotiate(SSL *s)
2103 if (SSL_IS_TLS13(s)) {
2104 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2108 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2109 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2116 return s->method->ssl_renegotiate(s);
2119 int SSL_renegotiate_abbreviated(SSL *s)
2121 if (SSL_IS_TLS13(s)) {
2122 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2126 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2127 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2134 return s->method->ssl_renegotiate(s);
2137 int SSL_renegotiate_pending(SSL *s)
2140 * becomes true when negotiation is requested; false again once a
2141 * handshake has finished
2143 return (s->renegotiate != 0);
2146 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2151 case SSL_CTRL_GET_READ_AHEAD:
2152 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2153 case SSL_CTRL_SET_READ_AHEAD:
2154 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2155 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2158 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2159 s->msg_callback_arg = parg;
2163 return (s->mode |= larg);
2164 case SSL_CTRL_CLEAR_MODE:
2165 return (s->mode &= ~larg);
2166 case SSL_CTRL_GET_MAX_CERT_LIST:
2167 return (long)s->max_cert_list;
2168 case SSL_CTRL_SET_MAX_CERT_LIST:
2171 l = (long)s->max_cert_list;
2172 s->max_cert_list = (size_t)larg;
2174 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2175 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2177 s->max_send_fragment = larg;
2178 if (s->max_send_fragment < s->split_send_fragment)
2179 s->split_send_fragment = s->max_send_fragment;
2181 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2182 if ((size_t)larg > s->max_send_fragment || larg == 0)
2184 s->split_send_fragment = larg;
2186 case SSL_CTRL_SET_MAX_PIPELINES:
2187 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2189 s->max_pipelines = larg;
2191 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2193 case SSL_CTRL_GET_RI_SUPPORT:
2195 return s->s3->send_connection_binding;
2198 case SSL_CTRL_CERT_FLAGS:
2199 return (s->cert->cert_flags |= larg);
2200 case SSL_CTRL_CLEAR_CERT_FLAGS:
2201 return (s->cert->cert_flags &= ~larg);
2203 case SSL_CTRL_GET_RAW_CIPHERLIST:
2205 if (s->s3->tmp.ciphers_raw == NULL)
2207 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2208 return (int)s->s3->tmp.ciphers_rawlen;
2210 return TLS_CIPHER_LEN;
2212 case SSL_CTRL_GET_EXTMS_SUPPORT:
2213 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2215 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2219 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2220 return ssl_check_allowed_versions(larg, s->max_proto_version)
2221 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2222 &s->min_proto_version);
2223 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2224 return s->min_proto_version;
2225 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2226 return ssl_check_allowed_versions(s->min_proto_version, larg)
2227 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2228 &s->max_proto_version);
2229 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2230 return s->max_proto_version;
2232 return s->method->ssl_ctrl(s, cmd, larg, parg);
2236 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2239 case SSL_CTRL_SET_MSG_CALLBACK:
2240 s->msg_callback = (void (*)
2241 (int write_p, int version, int content_type,
2242 const void *buf, size_t len, SSL *ssl,
2247 return s->method->ssl_callback_ctrl(s, cmd, fp);
2251 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2253 return ctx->sessions;
2256 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2260 /* For some cases with ctx == NULL perform syntax checks */
2263 #ifndef OPENSSL_NO_EC
2264 case SSL_CTRL_SET_GROUPS_LIST:
2265 return tls1_set_groups_list(NULL, NULL, parg);
2267 case SSL_CTRL_SET_SIGALGS_LIST:
2268 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2269 return tls1_set_sigalgs_list(NULL, parg, 0);
2276 case SSL_CTRL_GET_READ_AHEAD:
2277 return ctx->read_ahead;
2278 case SSL_CTRL_SET_READ_AHEAD:
2279 l = ctx->read_ahead;
2280 ctx->read_ahead = larg;
2283 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2284 ctx->msg_callback_arg = parg;
2287 case SSL_CTRL_GET_MAX_CERT_LIST:
2288 return (long)ctx->max_cert_list;
2289 case SSL_CTRL_SET_MAX_CERT_LIST:
2292 l = (long)ctx->max_cert_list;
2293 ctx->max_cert_list = (size_t)larg;
2296 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2299 l = (long)ctx->session_cache_size;
2300 ctx->session_cache_size = (size_t)larg;
2302 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2303 return (long)ctx->session_cache_size;
2304 case SSL_CTRL_SET_SESS_CACHE_MODE:
2305 l = ctx->session_cache_mode;
2306 ctx->session_cache_mode = larg;
2308 case SSL_CTRL_GET_SESS_CACHE_MODE:
2309 return ctx->session_cache_mode;
2311 case SSL_CTRL_SESS_NUMBER:
2312 return lh_SSL_SESSION_num_items(ctx->sessions);
2313 case SSL_CTRL_SESS_CONNECT:
2314 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2316 case SSL_CTRL_SESS_CONNECT_GOOD:
2317 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2319 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2320 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2323 case SSL_CTRL_SESS_ACCEPT:
2324 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2326 case SSL_CTRL_SESS_ACCEPT_GOOD:
2327 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2329 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2330 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2333 case SSL_CTRL_SESS_HIT:
2334 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2336 case SSL_CTRL_SESS_CB_HIT:
2337 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2339 case SSL_CTRL_SESS_MISSES:
2340 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2342 case SSL_CTRL_SESS_TIMEOUTS:
2343 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2345 case SSL_CTRL_SESS_CACHE_FULL:
2346 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2349 return (ctx->mode |= larg);
2350 case SSL_CTRL_CLEAR_MODE:
2351 return (ctx->mode &= ~larg);
2352 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2353 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2355 ctx->max_send_fragment = larg;
2356 if (ctx->max_send_fragment < ctx->split_send_fragment)
2357 ctx->split_send_fragment = ctx->max_send_fragment;
2359 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2360 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2362 ctx->split_send_fragment = larg;
2364 case SSL_CTRL_SET_MAX_PIPELINES:
2365 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2367 ctx->max_pipelines = larg;
2369 case SSL_CTRL_CERT_FLAGS:
2370 return (ctx->cert->cert_flags |= larg);
2371 case SSL_CTRL_CLEAR_CERT_FLAGS:
2372 return (ctx->cert->cert_flags &= ~larg);
2373 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2374 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2375 && ssl_set_version_bound(ctx->method->version, (int)larg,
2376 &ctx->min_proto_version);
2377 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2378 return ctx->min_proto_version;
2379 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2380 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2381 && ssl_set_version_bound(ctx->method->version, (int)larg,
2382 &ctx->max_proto_version);
2383 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2384 return ctx->max_proto_version;
2386 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2390 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2393 case SSL_CTRL_SET_MSG_CALLBACK:
2394 ctx->msg_callback = (void (*)
2395 (int write_p, int version, int content_type,
2396 const void *buf, size_t len, SSL *ssl,
2401 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2405 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2414 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2415 const SSL_CIPHER *const *bp)
2417 if ((*ap)->id > (*bp)->id)
2419 if ((*ap)->id < (*bp)->id)
2424 /** return a STACK of the ciphers available for the SSL and in order of
2426 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2429 if (s->cipher_list != NULL) {
2430 return s->cipher_list;
2431 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2432 return s->ctx->cipher_list;
2438 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2440 if ((s == NULL) || (s->session == NULL) || !s->server)
2442 return s->session->ciphers;
2445 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2447 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2450 ciphers = SSL_get_ciphers(s);
2453 if (!ssl_set_client_disabled(s))
2455 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2456 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2457 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2459 sk = sk_SSL_CIPHER_new_null();
2462 if (!sk_SSL_CIPHER_push(sk, c)) {
2463 sk_SSL_CIPHER_free(sk);
2471 /** return a STACK of the ciphers available for the SSL and in order of
2473 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2476 if (s->cipher_list_by_id != NULL) {
2477 return s->cipher_list_by_id;
2478 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2479 return s->ctx->cipher_list_by_id;
2485 /** The old interface to get the same thing as SSL_get_ciphers() */
2486 const char *SSL_get_cipher_list(const SSL *s, int n)
2488 const SSL_CIPHER *c;
2489 STACK_OF(SSL_CIPHER) *sk;
2493 sk = SSL_get_ciphers(s);
2494 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2496 c = sk_SSL_CIPHER_value(sk, n);
2502 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2504 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2507 return ctx->cipher_list;
2511 /** specify the ciphers to be used by default by the SSL_CTX */
2512 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2514 STACK_OF(SSL_CIPHER) *sk;
2516 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2517 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2520 * ssl_create_cipher_list may return an empty stack if it was unable to
2521 * find a cipher matching the given rule string (for example if the rule
2522 * string specifies a cipher which has been disabled). This is not an
2523 * error as far as ssl_create_cipher_list is concerned, and hence
2524 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2528 else if (sk_SSL_CIPHER_num(sk) == 0) {
2529 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2535 /** specify the ciphers to be used by the SSL */
2536 int SSL_set_cipher_list(SSL *s, const char *str)
2538 STACK_OF(SSL_CIPHER) *sk;
2540 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2541 &s->cipher_list, &s->cipher_list_by_id, str,
2543 /* see comment in SSL_CTX_set_cipher_list */
2546 else if (sk_SSL_CIPHER_num(sk) == 0) {
2547 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2553 static int ciphersuite_cb(const char *elem, int len, void *arg)
2555 STACK_OF(SSL_CIPHER) *ciphersuites = (STACK_OF(SSL_CIPHER) *)arg;
2556 const SSL_CIPHER *cipher;
2557 /* Arbitrary sized temp buffer for the cipher name. Should be big enough */
2560 if (len > (int)(sizeof(name) - 1)) {
2561 SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
2565 memcpy(name, elem, len);
2568 cipher = ssl3_get_cipher_by_std_name(name);
2569 if (cipher == NULL) {
2570 SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
2574 if (!sk_SSL_CIPHER_push(ciphersuites, cipher)) {
2575 SSLerr(SSL_F_CIPHERSUITE_CB, ERR_R_INTERNAL_ERROR);
2582 static int set_ciphersuites(STACK_OF(SSL_CIPHER) **currciphers, const char *str)
2584 STACK_OF(SSL_CIPHER) *newciphers = sk_SSL_CIPHER_new_null();
2586 if (newciphers == NULL)
2589 /* Parse the list. We explicitly allow an empty list */
2591 && !CONF_parse_list(str, ':', 1, ciphersuite_cb, newciphers)) {
2592 sk_SSL_CIPHER_free(newciphers);
2595 sk_SSL_CIPHER_free(*currciphers);
2596 *currciphers = newciphers;
2601 static int update_cipher_list(STACK_OF(SSL_CIPHER) *cipher_list,
2602 STACK_OF(SSL_CIPHER) *tls13_ciphersuites)
2607 * Delete any existing TLSv1.3 ciphersuites. These are always first in the
2610 while (sk_SSL_CIPHER_num(cipher_list) > 0
2611 && sk_SSL_CIPHER_value(cipher_list, 0)->min_tls == TLS1_3_VERSION)
2612 sk_SSL_CIPHER_delete(cipher_list, 0);
2614 /* Insert the new TLSv1.3 ciphersuites */
2615 for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++)
2616 sk_SSL_CIPHER_insert(cipher_list,
2617 sk_SSL_CIPHER_value(tls13_ciphersuites, i), i);
2622 int SSL_CTX_set_ciphersuites(SSL_CTX *ctx, const char *str)
2624 int ret = set_ciphersuites(&(ctx->tls13_ciphersuites), str);
2626 if (ret && ctx->cipher_list != NULL) {
2627 /* We already have a cipher_list, so we need to update it */
2628 return update_cipher_list(ctx->cipher_list, ctx->tls13_ciphersuites);
2634 int SSL_set_ciphersuites(SSL *s, const char *str)
2636 int ret = set_ciphersuites(&(s->tls13_ciphersuites), str);
2638 if (ret && s->cipher_list != NULL) {
2639 /* We already have a cipher_list, so we need to update it */
2640 return update_cipher_list(s->cipher_list, s->tls13_ciphersuites);
2646 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2649 STACK_OF(SSL_CIPHER) *sk;
2650 const SSL_CIPHER *c;
2653 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2657 sk = s->session->ciphers;
2659 if (sk_SSL_CIPHER_num(sk) == 0)
2662 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2665 c = sk_SSL_CIPHER_value(sk, i);
2666 n = strlen(c->name);
2682 /** return a servername extension value if provided in Client Hello, or NULL.
2683 * So far, only host_name types are defined (RFC 3546).
2686 const char *SSL_get_servername(const SSL *s, const int type)
2688 if (type != TLSEXT_NAMETYPE_host_name)
2691 return s->session && !s->ext.hostname ?
2692 s->session->ext.hostname : s->ext.hostname;
2695 int SSL_get_servername_type(const SSL *s)
2698 && (!s->ext.hostname ? s->session->
2699 ext.hostname : s->ext.hostname))
2700 return TLSEXT_NAMETYPE_host_name;
2705 * SSL_select_next_proto implements the standard protocol selection. It is
2706 * expected that this function is called from the callback set by
2707 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2708 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2709 * not included in the length. A byte string of length 0 is invalid. No byte
2710 * string may be truncated. The current, but experimental algorithm for
2711 * selecting the protocol is: 1) If the server doesn't support NPN then this
2712 * is indicated to the callback. In this case, the client application has to
2713 * abort the connection or have a default application level protocol. 2) If
2714 * the server supports NPN, but advertises an empty list then the client
2715 * selects the first protocol in its list, but indicates via the API that this
2716 * fallback case was enacted. 3) Otherwise, the client finds the first
2717 * protocol in the server's list that it supports and selects this protocol.
2718 * This is because it's assumed that the server has better information about
2719 * which protocol a client should use. 4) If the client doesn't support any
2720 * of the server's advertised protocols, then this is treated the same as
2721 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2722 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2724 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2725 const unsigned char *server,
2726 unsigned int server_len,
2727 const unsigned char *client, unsigned int client_len)
2730 const unsigned char *result;
2731 int status = OPENSSL_NPN_UNSUPPORTED;
2734 * For each protocol in server preference order, see if we support it.
2736 for (i = 0; i < server_len;) {
2737 for (j = 0; j < client_len;) {
2738 if (server[i] == client[j] &&
2739 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2740 /* We found a match */
2741 result = &server[i];
2742 status = OPENSSL_NPN_NEGOTIATED;
2752 /* There's no overlap between our protocols and the server's list. */
2754 status = OPENSSL_NPN_NO_OVERLAP;
2757 *out = (unsigned char *)result + 1;
2758 *outlen = result[0];
2762 #ifndef OPENSSL_NO_NEXTPROTONEG
2764 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2765 * client's requested protocol for this connection and returns 0. If the
2766 * client didn't request any protocol, then *data is set to NULL. Note that
2767 * the client can request any protocol it chooses. The value returned from
2768 * this function need not be a member of the list of supported protocols
2769 * provided by the callback.
2771 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2778 *len = (unsigned int)s->ext.npn_len;
2783 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2784 * a TLS server needs a list of supported protocols for Next Protocol
2785 * Negotiation. The returned list must be in wire format. The list is
2786 * returned by setting |out| to point to it and |outlen| to its length. This
2787 * memory will not be modified, but one should assume that the SSL* keeps a
2788 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2789 * wishes to advertise. Otherwise, no such extension will be included in the
2792 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2793 SSL_CTX_npn_advertised_cb_func cb,
2796 ctx->ext.npn_advertised_cb = cb;
2797 ctx->ext.npn_advertised_cb_arg = arg;
2801 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2802 * client needs to select a protocol from the server's provided list. |out|
2803 * must be set to point to the selected protocol (which may be within |in|).
2804 * The length of the protocol name must be written into |outlen|. The
2805 * server's advertised protocols are provided in |in| and |inlen|. The
2806 * callback can assume that |in| is syntactically valid. The client must
2807 * select a protocol. It is fatal to the connection if this callback returns
2808 * a value other than SSL_TLSEXT_ERR_OK.
2810 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2811 SSL_CTX_npn_select_cb_func cb,
2814 ctx->ext.npn_select_cb = cb;
2815 ctx->ext.npn_select_cb_arg = arg;
2820 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2821 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2822 * length-prefixed strings). Returns 0 on success.
2824 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2825 unsigned int protos_len)
2827 OPENSSL_free(ctx->ext.alpn);
2828 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2829 if (ctx->ext.alpn == NULL) {
2830 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2833 ctx->ext.alpn_len = protos_len;
2839 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2840 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2841 * length-prefixed strings). Returns 0 on success.
2843 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2844 unsigned int protos_len)
2846 OPENSSL_free(ssl->ext.alpn);
2847 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2848 if (ssl->ext.alpn == NULL) {
2849 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2852 ssl->ext.alpn_len = protos_len;
2858 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2859 * called during ClientHello processing in order to select an ALPN protocol
2860 * from the client's list of offered protocols.
2862 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2863 SSL_CTX_alpn_select_cb_func cb,
2866 ctx->ext.alpn_select_cb = cb;
2867 ctx->ext.alpn_select_cb_arg = arg;
2871 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2872 * On return it sets |*data| to point to |*len| bytes of protocol name
2873 * (not including the leading length-prefix byte). If the server didn't
2874 * respond with a negotiated protocol then |*len| will be zero.
2876 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2881 *data = ssl->s3->alpn_selected;
2885 *len = (unsigned int)ssl->s3->alpn_selected_len;
2888 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2889 const char *label, size_t llen,
2890 const unsigned char *context, size_t contextlen,
2893 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2896 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2898 contextlen, use_context);
2901 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2902 const char *label, size_t llen,
2903 const unsigned char *context,
2906 if (s->version != TLS1_3_VERSION)
2909 return tls13_export_keying_material_early(s, out, olen, label, llen,
2910 context, contextlen);
2913 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2915 const unsigned char *session_id = a->session_id;
2917 unsigned char tmp_storage[4];
2919 if (a->session_id_length < sizeof(tmp_storage)) {
2920 memset(tmp_storage, 0, sizeof(tmp_storage));
2921 memcpy(tmp_storage, a->session_id, a->session_id_length);
2922 session_id = tmp_storage;
2926 ((unsigned long)session_id[0]) |
2927 ((unsigned long)session_id[1] << 8L) |
2928 ((unsigned long)session_id[2] << 16L) |
2929 ((unsigned long)session_id[3] << 24L);
2934 * NB: If this function (or indeed the hash function which uses a sort of
2935 * coarser function than this one) is changed, ensure
2936 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2937 * being able to construct an SSL_SESSION that will collide with any existing
2938 * session with a matching session ID.
2940 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2942 if (a->ssl_version != b->ssl_version)
2944 if (a->session_id_length != b->session_id_length)
2946 return memcmp(a->session_id, b->session_id, a->session_id_length);
2950 * These wrapper functions should remain rather than redeclaring
2951 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2952 * variable. The reason is that the functions aren't static, they're exposed
2956 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2958 SSL_CTX *ret = NULL;
2961 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2965 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2968 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2969 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2972 ret = OPENSSL_zalloc(sizeof(*ret));
2977 ret->min_proto_version = 0;
2978 ret->max_proto_version = 0;
2979 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2980 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2981 /* We take the system default. */
2982 ret->session_timeout = meth->get_timeout();
2983 ret->references = 1;
2984 ret->lock = CRYPTO_THREAD_lock_new();
2985 if (ret->lock == NULL) {
2986 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2990 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2991 ret->verify_mode = SSL_VERIFY_NONE;
2992 if ((ret->cert = ssl_cert_new()) == NULL)
2995 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2996 if (ret->sessions == NULL)
2998 ret->cert_store = X509_STORE_new();
2999 if (ret->cert_store == NULL)
3001 #ifndef OPENSSL_NO_CT
3002 ret->ctlog_store = CTLOG_STORE_new();
3003 if (ret->ctlog_store == NULL)
3007 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
3010 if (!ssl_create_cipher_list(ret->method,
3011 ret->tls13_ciphersuites,
3012 &ret->cipher_list, &ret->cipher_list_by_id,
3013 SSL_DEFAULT_CIPHER_LIST, ret->cert)
3014 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
3015 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
3019 ret->param = X509_VERIFY_PARAM_new();
3020 if (ret->param == NULL)
3023 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
3024 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
3027 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
3028 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
3032 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
3035 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
3038 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
3041 /* No compression for DTLS */
3042 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
3043 ret->comp_methods = SSL_COMP_get_compression_methods();
3045 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3046 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3048 /* Setup RFC5077 ticket keys */
3049 if ((RAND_bytes(ret->ext.tick_key_name,
3050 sizeof(ret->ext.tick_key_name)) <= 0)
3051 || (RAND_bytes(ret->ext.secure->tick_hmac_key,
3052 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
3053 || (RAND_bytes(ret->ext.secure->tick_aes_key,
3054 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
3055 ret->options |= SSL_OP_NO_TICKET;
3057 if (RAND_bytes(ret->ext.cookie_hmac_key,
3058 sizeof(ret->ext.cookie_hmac_key)) <= 0)
3061 #ifndef OPENSSL_NO_SRP
3062 if (!SSL_CTX_SRP_CTX_init(ret))
3065 #ifndef OPENSSL_NO_ENGINE
3066 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3067 # define eng_strx(x) #x
3068 # define eng_str(x) eng_strx(x)
3069 /* Use specific client engine automatically... ignore errors */
3072 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3075 ENGINE_load_builtin_engines();
3076 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3078 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3084 * Default is to connect to non-RI servers. When RI is more widely
3085 * deployed might change this.
3087 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3089 * Disable compression by default to prevent CRIME. Applications can
3090 * re-enable compression by configuring
3091 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3092 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3093 * middlebox compatibility by default. This may be disabled by default in
3094 * a later OpenSSL version.
3096 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3098 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3101 * We cannot usefully set a default max_early_data here (which gets
3102 * propagated in SSL_new(), for the following reason: setting the
3103 * SSL field causes tls_construct_stoc_early_data() to tell the
3104 * client that early data will be accepted when constructing a TLS 1.3
3105 * session ticket, and the client will accordingly send us early data
3106 * when using that ticket (if the client has early data to send).
3107 * However, in order for the early data to actually be consumed by
3108 * the application, the application must also have calls to
3109 * SSL_read_early_data(); otherwise we'll just skip past the early data
3110 * and ignore it. So, since the application must add calls to
3111 * SSL_read_early_data(), we also require them to add
3112 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3113 * eliminating the bandwidth-wasting early data in the case described
3116 ret->max_early_data = 0;
3118 ssl_ctx_system_config(ret);
3122 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3128 int SSL_CTX_up_ref(SSL_CTX *ctx)
3132 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3135 REF_PRINT_COUNT("SSL_CTX", ctx);
3136 REF_ASSERT_ISNT(i < 2);
3137 return ((i > 1) ? 1 : 0);
3140 void SSL_CTX_free(SSL_CTX *a)
3147 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3148 REF_PRINT_COUNT("SSL_CTX", a);
3151 REF_ASSERT_ISNT(i < 0);
3153 X509_VERIFY_PARAM_free(a->param);
3154 dane_ctx_final(&a->dane);
3157 * Free internal session cache. However: the remove_cb() may reference
3158 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3159 * after the sessions were flushed.
3160 * As the ex_data handling routines might also touch the session cache,
3161 * the most secure solution seems to be: empty (flush) the cache, then
3162 * free ex_data, then finally free the cache.
3163 * (See ticket [openssl.org #212].)
3165 if (a->sessions != NULL)
3166 SSL_CTX_flush_sessions(a, 0);
3168 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3169 lh_SSL_SESSION_free(a->sessions);
3170 X509_STORE_free(a->cert_store);
3171 #ifndef OPENSSL_NO_CT
3172 CTLOG_STORE_free(a->ctlog_store);
3174 sk_SSL_CIPHER_free(a->cipher_list);
3175 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3176 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3177 ssl_cert_free(a->cert);
3178 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3179 sk_X509_pop_free(a->extra_certs, X509_free);
3180 a->comp_methods = NULL;
3181 #ifndef OPENSSL_NO_SRTP
3182 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3184 #ifndef OPENSSL_NO_SRP
3185 SSL_CTX_SRP_CTX_free(a);
3187 #ifndef OPENSSL_NO_ENGINE
3188 ENGINE_finish(a->client_cert_engine);
3191 #ifndef OPENSSL_NO_EC
3192 OPENSSL_free(a->ext.ecpointformats);
3193 OPENSSL_free(a->ext.supportedgroups);
3195 OPENSSL_free(a->ext.alpn);
3196 OPENSSL_secure_free(a->ext.secure);
3198 CRYPTO_THREAD_lock_free(a->lock);
3203 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3205 ctx->default_passwd_callback = cb;
3208 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3210 ctx->default_passwd_callback_userdata = u;
3213 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3215 return ctx->default_passwd_callback;
3218 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3220 return ctx->default_passwd_callback_userdata;
3223 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3225 s->default_passwd_callback = cb;
3228 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3230 s->default_passwd_callback_userdata = u;
3233 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3235 return s->default_passwd_callback;
3238 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3240 return s->default_passwd_callback_userdata;
3243 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3244 int (*cb) (X509_STORE_CTX *, void *),
3247 ctx->app_verify_callback = cb;
3248 ctx->app_verify_arg = arg;
3251 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3252 int (*cb) (int, X509_STORE_CTX *))
3254 ctx->verify_mode = mode;
3255 ctx->default_verify_callback = cb;
3258 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3260 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3263 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3265 ssl_cert_set_cert_cb(c->cert, cb, arg);
3268 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3270 ssl_cert_set_cert_cb(s->cert, cb, arg);
3273 void ssl_set_masks(SSL *s)
3276 uint32_t *pvalid = s->s3->tmp.valid_flags;
3277 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3278 unsigned long mask_k, mask_a;
3279 #ifndef OPENSSL_NO_EC
3280 int have_ecc_cert, ecdsa_ok;
3285 #ifndef OPENSSL_NO_DH
3286 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3291 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3292 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3293 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3294 #ifndef OPENSSL_NO_EC
3295 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3301 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3302 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3305 #ifndef OPENSSL_NO_GOST
3306 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3307 mask_k |= SSL_kGOST;
3308 mask_a |= SSL_aGOST12;
3310 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3311 mask_k |= SSL_kGOST;
3312 mask_a |= SSL_aGOST12;
3314 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3315 mask_k |= SSL_kGOST;
3316 mask_a |= SSL_aGOST01;
3327 * If we only have an RSA-PSS certificate allow RSA authentication
3328 * if TLS 1.2 and peer supports it.
3331 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3332 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3333 && TLS1_get_version(s) == TLS1_2_VERSION))
3340 mask_a |= SSL_aNULL;
3343 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3344 * depending on the key usage extension.
3346 #ifndef OPENSSL_NO_EC
3347 if (have_ecc_cert) {
3349 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3350 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3351 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3354 mask_a |= SSL_aECDSA;
3356 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3357 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3358 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3359 && TLS1_get_version(s) == TLS1_2_VERSION)
3360 mask_a |= SSL_aECDSA;
3362 /* Allow Ed448 for TLS 1.2 if peer supports it */
3363 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3364 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3365 && TLS1_get_version(s) == TLS1_2_VERSION)
3366 mask_a |= SSL_aECDSA;
3369 #ifndef OPENSSL_NO_EC
3370 mask_k |= SSL_kECDHE;
3373 #ifndef OPENSSL_NO_PSK
3376 if (mask_k & SSL_kRSA)
3377 mask_k |= SSL_kRSAPSK;
3378 if (mask_k & SSL_kDHE)
3379 mask_k |= SSL_kDHEPSK;
3380 if (mask_k & SSL_kECDHE)
3381 mask_k |= SSL_kECDHEPSK;
3384 s->s3->tmp.mask_k = mask_k;
3385 s->s3->tmp.mask_a = mask_a;
3388 #ifndef OPENSSL_NO_EC
3390 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3392 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3393 /* key usage, if present, must allow signing */
3394 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3395 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3396 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3400 return 1; /* all checks are ok */
3405 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3406 size_t *serverinfo_length)
3408 CERT_PKEY *cpk = s->s3->tmp.cert;
3409 *serverinfo_length = 0;
3411 if (cpk == NULL || cpk->serverinfo == NULL)
3414 *serverinfo = cpk->serverinfo;
3415 *serverinfo_length = cpk->serverinfo_length;
3419 void ssl_update_cache(SSL *s, int mode)
3424 * If the session_id_length is 0, we are not supposed to cache it, and it
3425 * would be rather hard to do anyway :-)
3427 if (s->session->session_id_length == 0)
3431 * If sid_ctx_length is 0 there is no specific application context
3432 * associated with this session, so when we try to resume it and
3433 * SSL_VERIFY_PEER is requested, we have no indication that this is
3434 * actually a session for the proper application context, and the
3435 * *handshake* will fail, not just the resumption attempt.
3436 * Do not cache these sessions that are not resumable.
3438 if (s->session->sid_ctx_length == 0
3439 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3442 i = s->session_ctx->session_cache_mode;
3444 && (!s->hit || SSL_IS_TLS13(s))
3445 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) != 0
3446 || SSL_CTX_add_session(s->session_ctx, s->session))
3447 && s->session_ctx->new_session_cb != NULL) {
3448 SSL_SESSION_up_ref(s->session);
3449 if (!s->session_ctx->new_session_cb(s, s->session))
3450 SSL_SESSION_free(s->session);
3453 /* auto flush every 255 connections */
3454 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3456 if (mode & SSL_SESS_CACHE_CLIENT)
3457 stat = &s->session_ctx->stats.sess_connect_good;
3459 stat = &s->session_ctx->stats.sess_accept_good;
3460 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3461 && (val & 0xff) == 0xff)
3462 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3466 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3471 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3476 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3480 if (s->method != meth) {
3481 const SSL_METHOD *sm = s->method;
3482 int (*hf) (SSL *) = s->handshake_func;
3484 if (sm->version == meth->version)
3489 ret = s->method->ssl_new(s);
3492 if (hf == sm->ssl_connect)
3493 s->handshake_func = meth->ssl_connect;
3494 else if (hf == sm->ssl_accept)
3495 s->handshake_func = meth->ssl_accept;
3500 int SSL_get_error(const SSL *s, int i)
3507 return SSL_ERROR_NONE;
3510 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3511 * where we do encode the error
3513 if ((l = ERR_peek_error()) != 0) {
3514 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3515 return SSL_ERROR_SYSCALL;
3517 return SSL_ERROR_SSL;
3520 if (SSL_want_read(s)) {
3521 bio = SSL_get_rbio(s);
3522 if (BIO_should_read(bio))
3523 return SSL_ERROR_WANT_READ;
3524 else if (BIO_should_write(bio))
3526 * This one doesn't make too much sense ... We never try to write
3527 * to the rbio, and an application program where rbio and wbio
3528 * are separate couldn't even know what it should wait for.
3529 * However if we ever set s->rwstate incorrectly (so that we have
3530 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3531 * wbio *are* the same, this test works around that bug; so it
3532 * might be safer to keep it.
3534 return SSL_ERROR_WANT_WRITE;
3535 else if (BIO_should_io_special(bio)) {
3536 reason = BIO_get_retry_reason(bio);
3537 if (reason == BIO_RR_CONNECT)
3538 return SSL_ERROR_WANT_CONNECT;
3539 else if (reason == BIO_RR_ACCEPT)
3540 return SSL_ERROR_WANT_ACCEPT;
3542 return SSL_ERROR_SYSCALL; /* unknown */
3546 if (SSL_want_write(s)) {
3547 /* Access wbio directly - in order to use the buffered bio if present */
3549 if (BIO_should_write(bio))
3550 return SSL_ERROR_WANT_WRITE;
3551 else if (BIO_should_read(bio))
3553 * See above (SSL_want_read(s) with BIO_should_write(bio))
3555 return SSL_ERROR_WANT_READ;
3556 else if (BIO_should_io_special(bio)) {
3557 reason = BIO_get_retry_reason(bio);
3558 if (reason == BIO_RR_CONNECT)
3559 return SSL_ERROR_WANT_CONNECT;
3560 else if (reason == BIO_RR_ACCEPT)
3561 return SSL_ERROR_WANT_ACCEPT;
3563 return SSL_ERROR_SYSCALL;
3566 if (SSL_want_x509_lookup(s))
3567 return SSL_ERROR_WANT_X509_LOOKUP;
3568 if (SSL_want_async(s))
3569 return SSL_ERROR_WANT_ASYNC;
3570 if (SSL_want_async_job(s))
3571 return SSL_ERROR_WANT_ASYNC_JOB;
3572 if (SSL_want_client_hello_cb(s))
3573 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3575 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3576 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3577 return SSL_ERROR_ZERO_RETURN;
3579 return SSL_ERROR_SYSCALL;
3582 static int ssl_do_handshake_intern(void *vargs)
3584 struct ssl_async_args *args;
3587 args = (struct ssl_async_args *)vargs;
3590 return s->handshake_func(s);
3593 int SSL_do_handshake(SSL *s)
3597 if (s->handshake_func == NULL) {
3598 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3602 ossl_statem_check_finish_init(s, -1);
3604 s->method->ssl_renegotiate_check(s, 0);
3606 if (SSL_is_server(s)) {
3607 /* clear SNI settings at server-side */
3608 OPENSSL_free(s->ext.hostname);
3609 s->ext.hostname = NULL;
3612 if (SSL_in_init(s) || SSL_in_before(s)) {
3613 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3614 struct ssl_async_args args;
3618 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3620 ret = s->handshake_func(s);
3626 void SSL_set_accept_state(SSL *s)
3630 ossl_statem_clear(s);
3631 s->handshake_func = s->method->ssl_accept;
3635 void SSL_set_connect_state(SSL *s)
3639 ossl_statem_clear(s);
3640 s->handshake_func = s->method->ssl_connect;
3644 int ssl_undefined_function(SSL *s)
3646 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3650 int ssl_undefined_void_function(void)
3652 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3653 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3657 int ssl_undefined_const_function(const SSL *s)
3662 const SSL_METHOD *ssl_bad_method(int ver)
3664 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3668 const char *ssl_protocol_to_string(int version)
3672 case TLS1_3_VERSION:
3675 case TLS1_2_VERSION:
3678 case TLS1_1_VERSION:
3693 case DTLS1_2_VERSION:
3701 const char *SSL_get_version(const SSL *s)
3703 return ssl_protocol_to_string(s->version);
3706 SSL *SSL_dup(SSL *s)
3708 STACK_OF(X509_NAME) *sk;
3713 /* If we're not quiescent, just up_ref! */
3714 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3715 CRYPTO_UP_REF(&s->references, &i, s->lock);
3720 * Otherwise, copy configuration state, and session if set.
3722 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3725 if (s->session != NULL) {
3727 * Arranges to share the same session via up_ref. This "copies"
3728 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3730 if (!SSL_copy_session_id(ret, s))
3734 * No session has been established yet, so we have to expect that
3735 * s->cert or ret->cert will be changed later -- they should not both
3736 * point to the same object, and thus we can't use
3737 * SSL_copy_session_id.
3739 if (!SSL_set_ssl_method(ret, s->method))
3742 if (s->cert != NULL) {
3743 ssl_cert_free(ret->cert);
3744 ret->cert = ssl_cert_dup(s->cert);
3745 if (ret->cert == NULL)
3749 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3750 (int)s->sid_ctx_length))
3754 if (!ssl_dane_dup(ret, s))
3756 ret->version = s->version;
3757 ret->options = s->options;
3758 ret->mode = s->mode;
3759 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3760 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3761 ret->msg_callback = s->msg_callback;
3762 ret->msg_callback_arg = s->msg_callback_arg;
3763 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3764 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3765 ret->generate_session_id = s->generate_session_id;
3767 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3769 /* copy app data, a little dangerous perhaps */
3770 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3773 /* setup rbio, and wbio */
3774 if (s->rbio != NULL) {
3775 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3778 if (s->wbio != NULL) {
3779 if (s->wbio != s->rbio) {
3780 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3783 BIO_up_ref(ret->rbio);
3784 ret->wbio = ret->rbio;
3788 ret->server = s->server;
3789 if (s->handshake_func) {
3791 SSL_set_accept_state(ret);
3793 SSL_set_connect_state(ret);
3795 ret->shutdown = s->shutdown;
3798 ret->default_passwd_callback = s->default_passwd_callback;
3799 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3801 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3803 /* dup the cipher_list and cipher_list_by_id stacks */
3804 if (s->cipher_list != NULL) {
3805 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3808 if (s->cipher_list_by_id != NULL)
3809 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3813 /* Dup the client_CA list */
3814 if (s->ca_names != NULL) {
3815 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3818 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3819 xn = sk_X509_NAME_value(sk, i);
3820 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3833 void ssl_clear_cipher_ctx(SSL *s)
3835 if (s->enc_read_ctx != NULL) {
3836 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3837 s->enc_read_ctx = NULL;
3839 if (s->enc_write_ctx != NULL) {
3840 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3841 s->enc_write_ctx = NULL;
3843 #ifndef OPENSSL_NO_COMP
3844 COMP_CTX_free(s->expand);
3846 COMP_CTX_free(s->compress);
3851 X509 *SSL_get_certificate(const SSL *s)
3853 if (s->cert != NULL)
3854 return s->cert->key->x509;
3859 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3861 if (s->cert != NULL)
3862 return s->cert->key->privatekey;
3867 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3869 if (ctx->cert != NULL)
3870 return ctx->cert->key->x509;
3875 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3877 if (ctx->cert != NULL)
3878 return ctx->cert->key->privatekey;
3883 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3885 if ((s->session != NULL) && (s->session->cipher != NULL))
3886 return s->session->cipher;
3890 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3892 return s->s3->tmp.new_cipher;
3895 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3897 #ifndef OPENSSL_NO_COMP
3898 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3904 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3906 #ifndef OPENSSL_NO_COMP
3907 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3913 int ssl_init_wbio_buffer(SSL *s)
3917 if (s->bbio != NULL) {
3918 /* Already buffered. */
3922 bbio = BIO_new(BIO_f_buffer());
3923 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3925 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3929 s->wbio = BIO_push(bbio, s->wbio);
3934 int ssl_free_wbio_buffer(SSL *s)
3936 /* callers ensure s is never null */
3937 if (s->bbio == NULL)
3940 s->wbio = BIO_pop(s->wbio);
3941 if (!ossl_assert(s->wbio != NULL))
3949 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3951 ctx->quiet_shutdown = mode;
3954 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3956 return ctx->quiet_shutdown;
3959 void SSL_set_quiet_shutdown(SSL *s, int mode)
3961 s->quiet_shutdown = mode;
3964 int SSL_get_quiet_shutdown(const SSL *s)
3966 return s->quiet_shutdown;
3969 void SSL_set_shutdown(SSL *s, int mode)
3974 int SSL_get_shutdown(const SSL *s)
3979 int SSL_version(const SSL *s)
3984 int SSL_client_version(const SSL *s)
3986 return s->client_version;
3989 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3994 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3997 if (ssl->ctx == ctx)
4000 ctx = ssl->session_ctx;
4001 new_cert = ssl_cert_dup(ctx->cert);
4002 if (new_cert == NULL) {
4006 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
4007 ssl_cert_free(new_cert);
4011 ssl_cert_free(ssl->cert);
4012 ssl->cert = new_cert;
4015 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
4016 * so setter APIs must prevent invalid lengths from entering the system.
4018 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
4022 * If the session ID context matches that of the parent SSL_CTX,
4023 * inherit it from the new SSL_CTX as well. If however the context does
4024 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4025 * leave it unchanged.
4027 if ((ssl->ctx != NULL) &&
4028 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
4029 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
4030 ssl->sid_ctx_length = ctx->sid_ctx_length;
4031 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
4034 SSL_CTX_up_ref(ctx);
4035 SSL_CTX_free(ssl->ctx); /* decrement reference count */
4041 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
4043 return X509_STORE_set_default_paths(ctx->cert_store);
4046 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
4048 X509_LOOKUP *lookup;
4050 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
4053 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
4055 /* Clear any errors if the default directory does not exist */
4061 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4063 X509_LOOKUP *lookup;
4065 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4069 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4071 /* Clear any errors if the default file does not exist */
4077 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4080 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4083 void SSL_set_info_callback(SSL *ssl,
4084 void (*cb) (const SSL *ssl, int type, int val))
4086 ssl->info_callback = cb;
4090 * One compiler (Diab DCC) doesn't like argument names in returned function
4093 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4096 return ssl->info_callback;
4099 void SSL_set_verify_result(SSL *ssl, long arg)
4101 ssl->verify_result = arg;
4104 long SSL_get_verify_result(const SSL *ssl)
4106 return ssl->verify_result;
4109 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4112 return sizeof(ssl->s3->client_random);
4113 if (outlen > sizeof(ssl->s3->client_random))
4114 outlen = sizeof(ssl->s3->client_random);
4115 memcpy(out, ssl->s3->client_random, outlen);
4119 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4122 return sizeof(ssl->s3->server_random);
4123 if (outlen > sizeof(ssl->s3->server_random))
4124 outlen = sizeof(ssl->s3->server_random);
4125 memcpy(out, ssl->s3->server_random, outlen);
4129 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4130 unsigned char *out, size_t outlen)
4133 return session->master_key_length;
4134 if (outlen > session->master_key_length)
4135 outlen = session->master_key_length;
4136 memcpy(out, session->master_key, outlen);
4140 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4143 if (len > sizeof(sess->master_key))
4146 memcpy(sess->master_key, in, len);
4147 sess->master_key_length = len;
4152 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4154 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4157 void *SSL_get_ex_data(const SSL *s, int idx)
4159 return CRYPTO_get_ex_data(&s->ex_data, idx);
4162 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4164 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4167 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4169 return CRYPTO_get_ex_data(&s->ex_data, idx);
4172 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4174 return ctx->cert_store;
4177 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4179 X509_STORE_free(ctx->cert_store);
4180 ctx->cert_store = store;
4183 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4186 X509_STORE_up_ref(store);
4187 SSL_CTX_set_cert_store(ctx, store);
4190 int SSL_want(const SSL *s)
4196 * \brief Set the callback for generating temporary DH keys.
4197 * \param ctx the SSL context.
4198 * \param dh the callback
4201 #ifndef OPENSSL_NO_DH
4202 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4203 DH *(*dh) (SSL *ssl, int is_export,
4206 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4209 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4212 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4216 #ifndef OPENSSL_NO_PSK
4217 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4219 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4220 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4223 OPENSSL_free(ctx->cert->psk_identity_hint);
4224 if (identity_hint != NULL) {
4225 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4226 if (ctx->cert->psk_identity_hint == NULL)
4229 ctx->cert->psk_identity_hint = NULL;
4233 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4238 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4239 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4242 OPENSSL_free(s->cert->psk_identity_hint);
4243 if (identity_hint != NULL) {
4244 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4245 if (s->cert->psk_identity_hint == NULL)
4248 s->cert->psk_identity_hint = NULL;
4252 const char *SSL_get_psk_identity_hint(const SSL *s)
4254 if (s == NULL || s->session == NULL)
4256 return s->session->psk_identity_hint;
4259 const char *SSL_get_psk_identity(const SSL *s)
4261 if (s == NULL || s->session == NULL)
4263 return s->session->psk_identity;
4266 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4268 s->psk_client_callback = cb;
4271 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4273 ctx->psk_client_callback = cb;
4276 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4278 s->psk_server_callback = cb;
4281 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4283 ctx->psk_server_callback = cb;
4287 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4289 s->psk_find_session_cb = cb;
4292 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4293 SSL_psk_find_session_cb_func cb)
4295 ctx->psk_find_session_cb = cb;
4298 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4300 s->psk_use_session_cb = cb;
4303 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4304 SSL_psk_use_session_cb_func cb)
4306 ctx->psk_use_session_cb = cb;
4309 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4310 void (*cb) (int write_p, int version,
4311 int content_type, const void *buf,
4312 size_t len, SSL *ssl, void *arg))
4314 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4317 void SSL_set_msg_callback(SSL *ssl,
4318 void (*cb) (int write_p, int version,
4319 int content_type, const void *buf,
4320 size_t len, SSL *ssl, void *arg))
4322 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4325 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4326 int (*cb) (SSL *ssl,
4330 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4331 (void (*)(void))cb);
4334 void SSL_set_not_resumable_session_callback(SSL *ssl,
4335 int (*cb) (SSL *ssl,
4336 int is_forward_secure))
4338 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4339 (void (*)(void))cb);
4342 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4343 size_t (*cb) (SSL *ssl, int type,
4344 size_t len, void *arg))
4346 ctx->record_padding_cb = cb;
4349 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4351 ctx->record_padding_arg = arg;
4354 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4356 return ctx->record_padding_arg;
4359 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4361 /* block size of 0 or 1 is basically no padding */
4362 if (block_size == 1)
4363 ctx->block_padding = 0;
4364 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4365 ctx->block_padding = block_size;
4371 void SSL_set_record_padding_callback(SSL *ssl,
4372 size_t (*cb) (SSL *ssl, int type,
4373 size_t len, void *arg))
4375 ssl->record_padding_cb = cb;
4378 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4380 ssl->record_padding_arg = arg;
4383 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4385 return ssl->record_padding_arg;
4388 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4390 /* block size of 0 or 1 is basically no padding */
4391 if (block_size == 1)
4392 ssl->block_padding = 0;
4393 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4394 ssl->block_padding = block_size;
4401 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4402 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4403 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4404 * Returns the newly allocated ctx;
4407 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4409 ssl_clear_hash_ctx(hash);
4410 *hash = EVP_MD_CTX_new();
4411 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4412 EVP_MD_CTX_free(*hash);
4419 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4422 EVP_MD_CTX_free(*hash);
4426 /* Retrieve handshake hashes */
4427 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4430 EVP_MD_CTX *ctx = NULL;
4431 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4432 int hashleni = EVP_MD_CTX_size(hdgst);
4435 if (hashleni < 0 || (size_t)hashleni > outlen) {
4436 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4437 ERR_R_INTERNAL_ERROR);
4441 ctx = EVP_MD_CTX_new();
4445 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4446 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4447 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4448 ERR_R_INTERNAL_ERROR);
4452 *hashlen = hashleni;
4456 EVP_MD_CTX_free(ctx);
4460 int SSL_session_reused(SSL *s)
4465 int SSL_is_server(const SSL *s)
4470 #if OPENSSL_API_COMPAT < 0x10100000L
4471 void SSL_set_debug(SSL *s, int debug)
4473 /* Old function was do-nothing anyway... */
4479 void SSL_set_security_level(SSL *s, int level)
4481 s->cert->sec_level = level;
4484 int SSL_get_security_level(const SSL *s)
4486 return s->cert->sec_level;
4489 void SSL_set_security_callback(SSL *s,
4490 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4491 int op, int bits, int nid,
4492 void *other, void *ex))
4494 s->cert->sec_cb = cb;
4497 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4498 const SSL_CTX *ctx, int op,
4499 int bits, int nid, void *other,
4501 return s->cert->sec_cb;
4504 void SSL_set0_security_ex_data(SSL *s, void *ex)
4506 s->cert->sec_ex = ex;
4509 void *SSL_get0_security_ex_data(const SSL *s)
4511 return s->cert->sec_ex;
4514 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4516 ctx->cert->sec_level = level;
4519 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4521 return ctx->cert->sec_level;
4524 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4525 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4526 int op, int bits, int nid,
4527 void *other, void *ex))
4529 ctx->cert->sec_cb = cb;
4532 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4538 return ctx->cert->sec_cb;
4541 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4543 ctx->cert->sec_ex = ex;
4546 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4548 return ctx->cert->sec_ex;
4552 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4553 * can return unsigned long, instead of the generic long return value from the
4554 * control interface.
4556 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4558 return ctx->options;
4561 unsigned long SSL_get_options(const SSL *s)
4566 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4568 return ctx->options |= op;
4571 unsigned long SSL_set_options(SSL *s, unsigned long op)
4573 return s->options |= op;
4576 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4578 return ctx->options &= ~op;
4581 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4583 return s->options &= ~op;
4586 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4588 return s->verified_chain;
4591 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4593 #ifndef OPENSSL_NO_CT
4596 * Moves SCTs from the |src| stack to the |dst| stack.
4597 * The source of each SCT will be set to |origin|.
4598 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4600 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4602 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4603 sct_source_t origin)
4609 *dst = sk_SCT_new_null();
4611 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4616 while ((sct = sk_SCT_pop(src)) != NULL) {
4617 if (SCT_set_source(sct, origin) != 1)
4620 if (sk_SCT_push(*dst, sct) <= 0)
4628 sk_SCT_push(src, sct); /* Put the SCT back */
4633 * Look for data collected during ServerHello and parse if found.
4634 * Returns the number of SCTs extracted.
4636 static int ct_extract_tls_extension_scts(SSL *s)
4638 int scts_extracted = 0;
4640 if (s->ext.scts != NULL) {
4641 const unsigned char *p = s->ext.scts;
4642 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4644 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4646 SCT_LIST_free(scts);
4649 return scts_extracted;
4653 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4654 * contains an SCT X509 extension. They will be stored in |s->scts|.
4656 * - The number of SCTs extracted, assuming an OCSP response exists.
4657 * - 0 if no OCSP response exists or it contains no SCTs.
4658 * - A negative integer if an error occurs.
4660 static int ct_extract_ocsp_response_scts(SSL *s)
4662 # ifndef OPENSSL_NO_OCSP
4663 int scts_extracted = 0;
4664 const unsigned char *p;
4665 OCSP_BASICRESP *br = NULL;
4666 OCSP_RESPONSE *rsp = NULL;
4667 STACK_OF(SCT) *scts = NULL;
4670 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4673 p = s->ext.ocsp.resp;
4674 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4678 br = OCSP_response_get1_basic(rsp);
4682 for (i = 0; i < OCSP_resp_count(br); ++i) {
4683 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4689 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4691 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4692 if (scts_extracted < 0)
4696 SCT_LIST_free(scts);
4697 OCSP_BASICRESP_free(br);
4698 OCSP_RESPONSE_free(rsp);
4699 return scts_extracted;
4701 /* Behave as if no OCSP response exists */
4707 * Attempts to extract SCTs from the peer certificate.
4708 * Return the number of SCTs extracted, or a negative integer if an error
4711 static int ct_extract_x509v3_extension_scts(SSL *s)
4713 int scts_extracted = 0;
4714 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4717 STACK_OF(SCT) *scts =
4718 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4721 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4723 SCT_LIST_free(scts);
4726 return scts_extracted;
4730 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4731 * response (if it exists) and X509v3 extensions in the certificate.
4732 * Returns NULL if an error occurs.
4734 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4736 if (!s->scts_parsed) {
4737 if (ct_extract_tls_extension_scts(s) < 0 ||
4738 ct_extract_ocsp_response_scts(s) < 0 ||
4739 ct_extract_x509v3_extension_scts(s) < 0)
4749 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4750 const STACK_OF(SCT) *scts, void *unused_arg)
4755 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4756 const STACK_OF(SCT) *scts, void *unused_arg)
4758 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4761 for (i = 0; i < count; ++i) {
4762 SCT *sct = sk_SCT_value(scts, i);
4763 int status = SCT_get_validation_status(sct);
4765 if (status == SCT_VALIDATION_STATUS_VALID)
4768 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4772 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4776 * Since code exists that uses the custom extension handler for CT, look
4777 * for this and throw an error if they have already registered to use CT.
4779 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4780 TLSEXT_TYPE_signed_certificate_timestamp))
4782 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4783 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4787 if (callback != NULL) {
4789 * If we are validating CT, then we MUST accept SCTs served via OCSP
4791 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4795 s->ct_validation_callback = callback;
4796 s->ct_validation_callback_arg = arg;
4801 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4802 ssl_ct_validation_cb callback, void *arg)
4805 * Since code exists that uses the custom extension handler for CT, look for
4806 * this and throw an error if they have already registered to use CT.
4808 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4809 TLSEXT_TYPE_signed_certificate_timestamp))
4811 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4812 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4816 ctx->ct_validation_callback = callback;
4817 ctx->ct_validation_callback_arg = arg;
4821 int SSL_ct_is_enabled(const SSL *s)
4823 return s->ct_validation_callback != NULL;
4826 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4828 return ctx->ct_validation_callback != NULL;
4831 int ssl_validate_ct(SSL *s)
4834 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4836 SSL_DANE *dane = &s->dane;
4837 CT_POLICY_EVAL_CTX *ctx = NULL;
4838 const STACK_OF(SCT) *scts;
4841 * If no callback is set, the peer is anonymous, or its chain is invalid,
4842 * skip SCT validation - just return success. Applications that continue
4843 * handshakes without certificates, with unverified chains, or pinned leaf
4844 * certificates are outside the scope of the WebPKI and CT.
4846 * The above exclusions notwithstanding the vast majority of peers will
4847 * have rather ordinary certificate chains validated by typical
4848 * applications that perform certificate verification and therefore will
4849 * process SCTs when enabled.
4851 if (s->ct_validation_callback == NULL || cert == NULL ||
4852 s->verify_result != X509_V_OK ||
4853 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4857 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4858 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4860 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4861 switch (dane->mtlsa->usage) {
4862 case DANETLS_USAGE_DANE_TA:
4863 case DANETLS_USAGE_DANE_EE:
4868 ctx = CT_POLICY_EVAL_CTX_new();
4870 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4871 ERR_R_MALLOC_FAILURE);
4875 issuer = sk_X509_value(s->verified_chain, 1);
4876 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4877 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4878 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4879 CT_POLICY_EVAL_CTX_set_time(
4880 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4882 scts = SSL_get0_peer_scts(s);
4885 * This function returns success (> 0) only when all the SCTs are valid, 0
4886 * when some are invalid, and < 0 on various internal errors (out of
4887 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4888 * reason to abort the handshake, that decision is up to the callback.
4889 * Therefore, we error out only in the unexpected case that the return
4890 * value is negative.
4892 * XXX: One might well argue that the return value of this function is an
4893 * unfortunate design choice. Its job is only to determine the validation
4894 * status of each of the provided SCTs. So long as it correctly separates
4895 * the wheat from the chaff it should return success. Failure in this case
4896 * ought to correspond to an inability to carry out its duties.
4898 if (SCT_LIST_validate(scts, ctx) < 0) {
4899 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4900 SSL_R_SCT_VERIFICATION_FAILED);
4904 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4906 ret = 0; /* This function returns 0 on failure */
4908 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4909 SSL_R_CALLBACK_FAILED);
4912 CT_POLICY_EVAL_CTX_free(ctx);
4914 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4915 * failure return code here. Also the application may wish the complete
4916 * the handshake, and then disconnect cleanly at a higher layer, after
4917 * checking the verification status of the completed connection.
4919 * We therefore force a certificate verification failure which will be
4920 * visible via SSL_get_verify_result() and cached as part of any resumed
4923 * Note: the permissive callback is for information gathering only, always
4924 * returns success, and does not affect verification status. Only the
4925 * strict callback or a custom application-specified callback can trigger
4926 * connection failure or record a verification error.
4929 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4933 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4935 switch (validation_mode) {
4937 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4939 case SSL_CT_VALIDATION_PERMISSIVE:
4940 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4941 case SSL_CT_VALIDATION_STRICT:
4942 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4946 int SSL_enable_ct(SSL *s, int validation_mode)
4948 switch (validation_mode) {
4950 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4952 case SSL_CT_VALIDATION_PERMISSIVE:
4953 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4954 case SSL_CT_VALIDATION_STRICT:
4955 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4959 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4961 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4964 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4966 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4969 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4971 CTLOG_STORE_free(ctx->ctlog_store);
4972 ctx->ctlog_store = logs;
4975 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4977 return ctx->ctlog_store;
4980 #endif /* OPENSSL_NO_CT */
4982 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4985 c->client_hello_cb = cb;
4986 c->client_hello_cb_arg = arg;
4989 int SSL_client_hello_isv2(SSL *s)
4991 if (s->clienthello == NULL)
4993 return s->clienthello->isv2;
4996 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4998 if (s->clienthello == NULL)
5000 return s->clienthello->legacy_version;
5003 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
5005 if (s->clienthello == NULL)
5008 *out = s->clienthello->random;
5009 return SSL3_RANDOM_SIZE;
5012 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
5014 if (s->clienthello == NULL)
5017 *out = s->clienthello->session_id;
5018 return s->clienthello->session_id_len;
5021 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
5023 if (s->clienthello == NULL)
5026 *out = PACKET_data(&s->clienthello->ciphersuites);
5027 return PACKET_remaining(&s->clienthello->ciphersuites);
5030 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
5032 if (s->clienthello == NULL)
5035 *out = s->clienthello->compressions;
5036 return s->clienthello->compressions_len;
5039 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5045 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5047 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5048 ext = s->clienthello->pre_proc_exts + i;
5052 present = OPENSSL_malloc(sizeof(*present) * num);
5053 if (present == NULL)
5055 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5056 ext = s->clienthello->pre_proc_exts + i;
5058 if (ext->received_order >= num)
5060 present[ext->received_order] = ext->type;
5067 OPENSSL_free(present);
5071 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5077 if (s->clienthello == NULL)
5079 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5080 r = s->clienthello->pre_proc_exts + i;
5081 if (r->present && r->type == type) {
5083 *out = PACKET_data(&r->data);
5085 *outlen = PACKET_remaining(&r->data);
5092 int SSL_free_buffers(SSL *ssl)
5094 RECORD_LAYER *rl = &ssl->rlayer;
5096 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5099 RECORD_LAYER_release(rl);
5103 int SSL_alloc_buffers(SSL *ssl)
5105 return ssl3_setup_buffers(ssl);
5108 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5110 ctx->keylog_callback = cb;
5113 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5115 return ctx->keylog_callback;
5118 static int nss_keylog_int(const char *prefix,
5120 const uint8_t *parameter_1,
5121 size_t parameter_1_len,
5122 const uint8_t *parameter_2,
5123 size_t parameter_2_len)
5126 char *cursor = NULL;
5131 if (ssl->ctx->keylog_callback == NULL) return 1;
5134 * Our output buffer will contain the following strings, rendered with
5135 * space characters in between, terminated by a NULL character: first the
5136 * prefix, then the first parameter, then the second parameter. The
5137 * meaning of each parameter depends on the specific key material being
5138 * logged. Note that the first and second parameters are encoded in
5139 * hexadecimal, so we need a buffer that is twice their lengths.
5141 prefix_len = strlen(prefix);
5142 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
5143 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5144 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5145 ERR_R_MALLOC_FAILURE);
5149 strcpy(cursor, prefix);
5150 cursor += prefix_len;
5153 for (i = 0; i < parameter_1_len; i++) {
5154 sprintf(cursor, "%02x", parameter_1[i]);
5159 for (i = 0; i < parameter_2_len; i++) {
5160 sprintf(cursor, "%02x", parameter_2[i]);
5165 ssl->ctx->keylog_callback(ssl, (const char *)out);
5171 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5172 const uint8_t *encrypted_premaster,
5173 size_t encrypted_premaster_len,
5174 const uint8_t *premaster,
5175 size_t premaster_len)
5177 if (encrypted_premaster_len < 8) {
5178 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5179 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5183 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5184 return nss_keylog_int("RSA",
5186 encrypted_premaster,
5192 int ssl_log_secret(SSL *ssl,
5194 const uint8_t *secret,
5197 return nss_keylog_int(label,
5199 ssl->s3->client_random,
5205 #define SSLV2_CIPHER_LEN 3
5207 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5211 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5213 if (PACKET_remaining(cipher_suites) == 0) {
5214 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5215 SSL_R_NO_CIPHERS_SPECIFIED);
5219 if (PACKET_remaining(cipher_suites) % n != 0) {
5220 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5221 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5225 OPENSSL_free(s->s3->tmp.ciphers_raw);
5226 s->s3->tmp.ciphers_raw = NULL;
5227 s->s3->tmp.ciphers_rawlen = 0;
5230 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5231 PACKET sslv2ciphers = *cipher_suites;
5232 unsigned int leadbyte;
5236 * We store the raw ciphers list in SSLv3+ format so we need to do some
5237 * preprocessing to convert the list first. If there are any SSLv2 only
5238 * ciphersuites with a non-zero leading byte then we are going to
5239 * slightly over allocate because we won't store those. But that isn't a
5242 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5243 s->s3->tmp.ciphers_raw = raw;
5245 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5246 ERR_R_MALLOC_FAILURE);
5249 for (s->s3->tmp.ciphers_rawlen = 0;
5250 PACKET_remaining(&sslv2ciphers) > 0;
5251 raw += TLS_CIPHER_LEN) {
5252 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5254 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5257 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5258 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5260 OPENSSL_free(s->s3->tmp.ciphers_raw);
5261 s->s3->tmp.ciphers_raw = NULL;
5262 s->s3->tmp.ciphers_rawlen = 0;
5266 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5268 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5269 &s->s3->tmp.ciphers_rawlen)) {
5270 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5271 ERR_R_INTERNAL_ERROR);
5277 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5278 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5279 STACK_OF(SSL_CIPHER) **scsvs)
5283 if (!PACKET_buf_init(&pkt, bytes, len))
5285 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5288 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5289 STACK_OF(SSL_CIPHER) **skp,
5290 STACK_OF(SSL_CIPHER) **scsvs_out,
5291 int sslv2format, int fatal)
5293 const SSL_CIPHER *c;
5294 STACK_OF(SSL_CIPHER) *sk = NULL;
5295 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5297 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5298 unsigned char cipher[SSLV2_CIPHER_LEN];
5300 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5302 if (PACKET_remaining(cipher_suites) == 0) {
5304 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5305 SSL_R_NO_CIPHERS_SPECIFIED);
5307 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5311 if (PACKET_remaining(cipher_suites) % n != 0) {
5313 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5314 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5316 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5317 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5321 sk = sk_SSL_CIPHER_new_null();
5322 scsvs = sk_SSL_CIPHER_new_null();
5323 if (sk == NULL || scsvs == NULL) {
5325 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5326 ERR_R_MALLOC_FAILURE);
5328 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5332 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5334 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5335 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5336 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5338 if (sslv2format && cipher[0] != '\0')
5341 /* For SSLv2-compat, ignore leading 0-byte. */
5342 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5344 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5345 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5347 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5348 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5350 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5355 if (PACKET_remaining(cipher_suites) > 0) {
5357 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5360 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5367 sk_SSL_CIPHER_free(sk);
5368 if (scsvs_out != NULL)
5371 sk_SSL_CIPHER_free(scsvs);
5374 sk_SSL_CIPHER_free(sk);
5375 sk_SSL_CIPHER_free(scsvs);
5379 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5381 ctx->max_early_data = max_early_data;
5386 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5388 return ctx->max_early_data;
5391 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5393 s->max_early_data = max_early_data;
5398 uint32_t SSL_get_max_early_data(const SSL *s)
5400 return s->max_early_data;
5403 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5405 /* Return any active Max Fragment Len extension */
5406 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5407 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5409 /* return current SSL connection setting */
5410 return ssl->max_send_fragment;
5413 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5415 /* Return a value regarding an active Max Fragment Len extension */
5416 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5417 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5418 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5420 /* else limit |split_send_fragment| to current |max_send_fragment| */
5421 if (ssl->split_send_fragment > ssl->max_send_fragment)
5422 return ssl->max_send_fragment;
5424 /* return current SSL connection setting */
5425 return ssl->split_send_fragment;
5428 int SSL_stateless(SSL *s)
5432 /* Ensure there is no state left over from a previous invocation */
5438 s->s3->flags |= TLS1_FLAGS_STATELESS;
5439 ret = SSL_accept(s);
5440 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5442 if (ret > 0 && s->ext.cookieok)
5445 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5451 void SSL_force_post_handshake_auth(SSL *ssl)
5453 ssl->pha_forced = 1;
5456 int SSL_verify_client_post_handshake(SSL *ssl)
5458 if (!SSL_IS_TLS13(ssl)) {
5459 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5463 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5467 if (!SSL_is_init_finished(ssl)) {
5468 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5472 switch (ssl->post_handshake_auth) {
5474 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5477 case SSL_PHA_EXT_SENT:
5478 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5480 case SSL_PHA_EXT_RECEIVED:
5482 case SSL_PHA_REQUEST_PENDING:
5483 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5485 case SSL_PHA_REQUESTED:
5486 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5490 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5492 /* checks verify_mode and algorithm_auth */
5493 if (!send_certificate_request(ssl)) {
5494 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5495 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5499 ossl_statem_set_in_init(ssl, 1);
5503 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5504 SSL_CTX_generate_session_ticket_fn gen_cb,
5505 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5508 ctx->generate_ticket_cb = gen_cb;
5509 ctx->decrypt_ticket_cb = dec_cb;
5510 ctx->ticket_cb_data = arg;