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)
1128 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1129 REF_PRINT_COUNT("SSL", s);
1132 REF_ASSERT_ISNT(i < 0);
1134 X509_VERIFY_PARAM_free(s->param);
1135 dane_final(&s->dane);
1136 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1138 /* Ignore return value */
1139 ssl_free_wbio_buffer(s);
1141 BIO_free_all(s->wbio);
1142 BIO_free_all(s->rbio);
1144 BUF_MEM_free(s->init_buf);
1146 /* add extra stuff */
1147 sk_SSL_CIPHER_free(s->cipher_list);
1148 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1149 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1151 /* Make the next call work :-) */
1152 if (s->session != NULL) {
1153 ssl_clear_bad_session(s);
1154 SSL_SESSION_free(s->session);
1156 SSL_SESSION_free(s->psksession);
1157 OPENSSL_free(s->psksession_id);
1161 ssl_cert_free(s->cert);
1162 /* Free up if allocated */
1164 OPENSSL_free(s->ext.hostname);
1165 SSL_CTX_free(s->session_ctx);
1166 #ifndef OPENSSL_NO_EC
1167 OPENSSL_free(s->ext.ecpointformats);
1168 OPENSSL_free(s->ext.supportedgroups);
1169 #endif /* OPENSSL_NO_EC */
1170 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1171 #ifndef OPENSSL_NO_OCSP
1172 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1174 #ifndef OPENSSL_NO_CT
1175 SCT_LIST_free(s->scts);
1176 OPENSSL_free(s->ext.scts);
1178 OPENSSL_free(s->ext.ocsp.resp);
1179 OPENSSL_free(s->ext.alpn);
1180 OPENSSL_free(s->ext.tls13_cookie);
1181 OPENSSL_free(s->clienthello);
1182 OPENSSL_free(s->pha_context);
1183 EVP_MD_CTX_free(s->pha_dgst);
1185 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1187 sk_X509_pop_free(s->verified_chain, X509_free);
1189 if (s->method != NULL)
1190 s->method->ssl_free(s);
1192 RECORD_LAYER_release(&s->rlayer);
1194 SSL_CTX_free(s->ctx);
1196 ASYNC_WAIT_CTX_free(s->waitctx);
1198 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1199 OPENSSL_free(s->ext.npn);
1202 #ifndef OPENSSL_NO_SRTP
1203 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1206 CRYPTO_THREAD_lock_free(s->lock);
1211 void SSL_set0_rbio(SSL *s, BIO *rbio)
1213 BIO_free_all(s->rbio);
1217 void SSL_set0_wbio(SSL *s, BIO *wbio)
1220 * If the output buffering BIO is still in place, remove it
1222 if (s->bbio != NULL)
1223 s->wbio = BIO_pop(s->wbio);
1225 BIO_free_all(s->wbio);
1228 /* Re-attach |bbio| to the new |wbio|. */
1229 if (s->bbio != NULL)
1230 s->wbio = BIO_push(s->bbio, s->wbio);
1233 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1236 * For historical reasons, this function has many different cases in
1237 * ownership handling.
1240 /* If nothing has changed, do nothing */
1241 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1245 * If the two arguments are equal then one fewer reference is granted by the
1246 * caller than we want to take
1248 if (rbio != NULL && rbio == wbio)
1252 * If only the wbio is changed only adopt one reference.
1254 if (rbio == SSL_get_rbio(s)) {
1255 SSL_set0_wbio(s, wbio);
1259 * There is an asymmetry here for historical reasons. If only the rbio is
1260 * changed AND the rbio and wbio were originally different, then we only
1261 * adopt one reference.
1263 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1264 SSL_set0_rbio(s, rbio);
1268 /* Otherwise, adopt both references. */
1269 SSL_set0_rbio(s, rbio);
1270 SSL_set0_wbio(s, wbio);
1273 BIO *SSL_get_rbio(const SSL *s)
1278 BIO *SSL_get_wbio(const SSL *s)
1280 if (s->bbio != NULL) {
1282 * If |bbio| is active, the true caller-configured BIO is its
1285 return BIO_next(s->bbio);
1290 int SSL_get_fd(const SSL *s)
1292 return SSL_get_rfd(s);
1295 int SSL_get_rfd(const SSL *s)
1300 b = SSL_get_rbio(s);
1301 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1303 BIO_get_fd(r, &ret);
1307 int SSL_get_wfd(const SSL *s)
1312 b = SSL_get_wbio(s);
1313 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1315 BIO_get_fd(r, &ret);
1319 #ifndef OPENSSL_NO_SOCK
1320 int SSL_set_fd(SSL *s, int fd)
1325 bio = BIO_new(BIO_s_socket());
1328 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1331 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1332 SSL_set_bio(s, bio, bio);
1338 int SSL_set_wfd(SSL *s, int fd)
1340 BIO *rbio = SSL_get_rbio(s);
1342 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1343 || (int)BIO_get_fd(rbio, NULL) != fd) {
1344 BIO *bio = BIO_new(BIO_s_socket());
1347 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1350 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1351 SSL_set0_wbio(s, bio);
1354 SSL_set0_wbio(s, rbio);
1359 int SSL_set_rfd(SSL *s, int fd)
1361 BIO *wbio = SSL_get_wbio(s);
1363 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1364 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1365 BIO *bio = BIO_new(BIO_s_socket());
1368 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1371 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1372 SSL_set0_rbio(s, bio);
1375 SSL_set0_rbio(s, wbio);
1382 /* return length of latest Finished message we sent, copy to 'buf' */
1383 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1387 if (s->s3 != NULL) {
1388 ret = s->s3->tmp.finish_md_len;
1391 memcpy(buf, s->s3->tmp.finish_md, count);
1396 /* return length of latest Finished message we expected, copy to 'buf' */
1397 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1401 if (s->s3 != NULL) {
1402 ret = s->s3->tmp.peer_finish_md_len;
1405 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1410 int SSL_get_verify_mode(const SSL *s)
1412 return s->verify_mode;
1415 int SSL_get_verify_depth(const SSL *s)
1417 return X509_VERIFY_PARAM_get_depth(s->param);
1420 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1421 return s->verify_callback;
1424 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1426 return ctx->verify_mode;
1429 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1431 return X509_VERIFY_PARAM_get_depth(ctx->param);
1434 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1435 return ctx->default_verify_callback;
1438 void SSL_set_verify(SSL *s, int mode,
1439 int (*callback) (int ok, X509_STORE_CTX *ctx))
1441 s->verify_mode = mode;
1442 if (callback != NULL)
1443 s->verify_callback = callback;
1446 void SSL_set_verify_depth(SSL *s, int depth)
1448 X509_VERIFY_PARAM_set_depth(s->param, depth);
1451 void SSL_set_read_ahead(SSL *s, int yes)
1453 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1456 int SSL_get_read_ahead(const SSL *s)
1458 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1461 int SSL_pending(const SSL *s)
1463 size_t pending = s->method->ssl_pending(s);
1466 * SSL_pending cannot work properly if read-ahead is enabled
1467 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1468 * impossible to fix since SSL_pending cannot report errors that may be
1469 * observed while scanning the new data. (Note that SSL_pending() is
1470 * often used as a boolean value, so we'd better not return -1.)
1472 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1473 * we just return INT_MAX.
1475 return pending < INT_MAX ? (int)pending : INT_MAX;
1478 int SSL_has_pending(const SSL *s)
1481 * Similar to SSL_pending() but returns a 1 to indicate that we have
1482 * unprocessed data available or 0 otherwise (as opposed to the number of
1483 * bytes available). Unlike SSL_pending() this will take into account
1484 * read_ahead data. A 1 return simply indicates that we have unprocessed
1485 * data. That data may not result in any application data, or we may fail
1486 * to parse the records for some reason.
1488 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1491 return RECORD_LAYER_read_pending(&s->rlayer);
1494 X509 *SSL_get_peer_certificate(const SSL *s)
1498 if ((s == NULL) || (s->session == NULL))
1501 r = s->session->peer;
1511 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1515 if ((s == NULL) || (s->session == NULL))
1518 r = s->session->peer_chain;
1521 * If we are a client, cert_chain includes the peer's own certificate; if
1522 * we are a server, it does not.
1529 * Now in theory, since the calling process own 't' it should be safe to
1530 * modify. We need to be able to read f without being hassled
1532 int SSL_copy_session_id(SSL *t, const SSL *f)
1535 /* Do we need to to SSL locking? */
1536 if (!SSL_set_session(t, SSL_get_session(f))) {
1541 * what if we are setup for one protocol version but want to talk another
1543 if (t->method != f->method) {
1544 t->method->ssl_free(t);
1545 t->method = f->method;
1546 if (t->method->ssl_new(t) == 0)
1550 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1551 ssl_cert_free(t->cert);
1553 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1560 /* Fix this so it checks all the valid key/cert options */
1561 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1563 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1564 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1567 if (ctx->cert->key->privatekey == NULL) {
1568 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1571 return X509_check_private_key
1572 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1575 /* Fix this function so that it takes an optional type parameter */
1576 int SSL_check_private_key(const SSL *ssl)
1579 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1582 if (ssl->cert->key->x509 == NULL) {
1583 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1586 if (ssl->cert->key->privatekey == NULL) {
1587 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1590 return X509_check_private_key(ssl->cert->key->x509,
1591 ssl->cert->key->privatekey);
1594 int SSL_waiting_for_async(SSL *s)
1602 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1604 ASYNC_WAIT_CTX *ctx = s->waitctx;
1608 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1611 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1612 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1614 ASYNC_WAIT_CTX *ctx = s->waitctx;
1618 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1622 int SSL_accept(SSL *s)
1624 if (s->handshake_func == NULL) {
1625 /* Not properly initialized yet */
1626 SSL_set_accept_state(s);
1629 return SSL_do_handshake(s);
1632 int SSL_connect(SSL *s)
1634 if (s->handshake_func == NULL) {
1635 /* Not properly initialized yet */
1636 SSL_set_connect_state(s);
1639 return SSL_do_handshake(s);
1642 long SSL_get_default_timeout(const SSL *s)
1644 return s->method->get_timeout();
1647 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1648 int (*func) (void *))
1651 if (s->waitctx == NULL) {
1652 s->waitctx = ASYNC_WAIT_CTX_new();
1653 if (s->waitctx == NULL)
1656 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1657 sizeof(struct ssl_async_args))) {
1659 s->rwstate = SSL_NOTHING;
1660 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1663 s->rwstate = SSL_ASYNC_PAUSED;
1666 s->rwstate = SSL_ASYNC_NO_JOBS;
1672 s->rwstate = SSL_NOTHING;
1673 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1674 /* Shouldn't happen */
1679 static int ssl_io_intern(void *vargs)
1681 struct ssl_async_args *args;
1686 args = (struct ssl_async_args *)vargs;
1690 switch (args->type) {
1692 return args->f.func_read(s, buf, num, &s->asyncrw);
1694 return args->f.func_write(s, buf, num, &s->asyncrw);
1696 return args->f.func_other(s);
1701 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1703 if (s->handshake_func == NULL) {
1704 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1708 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1709 s->rwstate = SSL_NOTHING;
1713 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1714 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1715 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1719 * If we are a client and haven't received the ServerHello etc then we
1722 ossl_statem_check_finish_init(s, 0);
1724 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1725 struct ssl_async_args args;
1731 args.type = READFUNC;
1732 args.f.func_read = s->method->ssl_read;
1734 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1735 *readbytes = s->asyncrw;
1738 return s->method->ssl_read(s, buf, num, readbytes);
1742 int SSL_read(SSL *s, void *buf, int num)
1748 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1752 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1755 * The cast is safe here because ret should be <= INT_MAX because num is
1759 ret = (int)readbytes;
1764 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1766 int ret = ssl_read_internal(s, buf, num, readbytes);
1773 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1778 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1779 return SSL_READ_EARLY_DATA_ERROR;
1782 switch (s->early_data_state) {
1783 case SSL_EARLY_DATA_NONE:
1784 if (!SSL_in_before(s)) {
1785 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1786 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1787 return SSL_READ_EARLY_DATA_ERROR;
1791 case SSL_EARLY_DATA_ACCEPT_RETRY:
1792 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1793 ret = SSL_accept(s);
1796 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1797 return SSL_READ_EARLY_DATA_ERROR;
1801 case SSL_EARLY_DATA_READ_RETRY:
1802 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1803 s->early_data_state = SSL_EARLY_DATA_READING;
1804 ret = SSL_read_ex(s, buf, num, readbytes);
1806 * State machine will update early_data_state to
1807 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1810 if (ret > 0 || (ret <= 0 && s->early_data_state
1811 != SSL_EARLY_DATA_FINISHED_READING)) {
1812 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1813 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1814 : SSL_READ_EARLY_DATA_ERROR;
1817 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1820 return SSL_READ_EARLY_DATA_FINISH;
1823 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1824 return SSL_READ_EARLY_DATA_ERROR;
1828 int SSL_get_early_data_status(const SSL *s)
1830 return s->ext.early_data;
1833 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1835 if (s->handshake_func == NULL) {
1836 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1840 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1843 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1844 struct ssl_async_args args;
1850 args.type = READFUNC;
1851 args.f.func_read = s->method->ssl_peek;
1853 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1854 *readbytes = s->asyncrw;
1857 return s->method->ssl_peek(s, buf, num, readbytes);
1861 int SSL_peek(SSL *s, void *buf, int num)
1867 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1871 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1874 * The cast is safe here because ret should be <= INT_MAX because num is
1878 ret = (int)readbytes;
1884 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1886 int ret = ssl_peek_internal(s, buf, num, readbytes);
1893 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1895 if (s->handshake_func == NULL) {
1896 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1900 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1901 s->rwstate = SSL_NOTHING;
1902 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1906 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1907 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1908 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1909 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1912 /* If we are a client and haven't sent the Finished we better do that */
1913 ossl_statem_check_finish_init(s, 1);
1915 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1917 struct ssl_async_args args;
1920 args.buf = (void *)buf;
1922 args.type = WRITEFUNC;
1923 args.f.func_write = s->method->ssl_write;
1925 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1926 *written = s->asyncrw;
1929 return s->method->ssl_write(s, buf, num, written);
1933 int SSL_write(SSL *s, const void *buf, int num)
1939 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1943 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1946 * The cast is safe here because ret should be <= INT_MAX because num is
1955 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1957 int ret = ssl_write_internal(s, buf, num, written);
1964 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1966 int ret, early_data_state;
1968 uint32_t partialwrite;
1970 switch (s->early_data_state) {
1971 case SSL_EARLY_DATA_NONE:
1973 || !SSL_in_before(s)
1974 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1975 && (s->psk_use_session_cb == NULL))) {
1976 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1977 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1982 case SSL_EARLY_DATA_CONNECT_RETRY:
1983 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1984 ret = SSL_connect(s);
1987 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1992 case SSL_EARLY_DATA_WRITE_RETRY:
1993 s->early_data_state = SSL_EARLY_DATA_WRITING;
1995 * We disable partial write for early data because we don't keep track
1996 * of how many bytes we've written between the SSL_write_ex() call and
1997 * the flush if the flush needs to be retried)
1999 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2000 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2001 ret = SSL_write_ex(s, buf, num, &writtmp);
2002 s->mode |= partialwrite;
2004 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2007 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2010 case SSL_EARLY_DATA_WRITE_FLUSH:
2011 /* The buffering BIO is still in place so we need to flush it */
2012 if (statem_flush(s) != 1)
2015 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2018 case SSL_EARLY_DATA_FINISHED_READING:
2019 case SSL_EARLY_DATA_READ_RETRY:
2020 early_data_state = s->early_data_state;
2021 /* We are a server writing to an unauthenticated client */
2022 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2023 ret = SSL_write_ex(s, buf, num, written);
2024 s->early_data_state = early_data_state;
2028 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2033 int SSL_shutdown(SSL *s)
2036 * Note that this function behaves differently from what one might
2037 * expect. Return values are 0 for no success (yet), 1 for success; but
2038 * calling it once is usually not enough, even if blocking I/O is used
2039 * (see ssl3_shutdown).
2042 if (s->handshake_func == NULL) {
2043 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2047 if (!SSL_in_init(s)) {
2048 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2049 struct ssl_async_args args;
2052 args.type = OTHERFUNC;
2053 args.f.func_other = s->method->ssl_shutdown;
2055 return ssl_start_async_job(s, &args, ssl_io_intern);
2057 return s->method->ssl_shutdown(s);
2060 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2065 int SSL_key_update(SSL *s, int updatetype)
2068 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2069 * negotiated, and that it is appropriate to call SSL_key_update() instead
2070 * of SSL_renegotiate().
2072 if (!SSL_IS_TLS13(s)) {
2073 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2077 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2078 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2079 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2083 if (!SSL_is_init_finished(s)) {
2084 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2088 ossl_statem_set_in_init(s, 1);
2089 s->key_update = updatetype;
2093 int SSL_get_key_update_type(SSL *s)
2095 return s->key_update;
2098 int SSL_renegotiate(SSL *s)
2100 if (SSL_IS_TLS13(s)) {
2101 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2105 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2106 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2113 return s->method->ssl_renegotiate(s);
2116 int SSL_renegotiate_abbreviated(SSL *s)
2118 if (SSL_IS_TLS13(s)) {
2119 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2123 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2124 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2131 return s->method->ssl_renegotiate(s);
2134 int SSL_renegotiate_pending(SSL *s)
2137 * becomes true when negotiation is requested; false again once a
2138 * handshake has finished
2140 return (s->renegotiate != 0);
2143 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2148 case SSL_CTRL_GET_READ_AHEAD:
2149 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2150 case SSL_CTRL_SET_READ_AHEAD:
2151 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2152 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2155 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2156 s->msg_callback_arg = parg;
2160 return (s->mode |= larg);
2161 case SSL_CTRL_CLEAR_MODE:
2162 return (s->mode &= ~larg);
2163 case SSL_CTRL_GET_MAX_CERT_LIST:
2164 return (long)s->max_cert_list;
2165 case SSL_CTRL_SET_MAX_CERT_LIST:
2168 l = (long)s->max_cert_list;
2169 s->max_cert_list = (size_t)larg;
2171 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2172 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2174 s->max_send_fragment = larg;
2175 if (s->max_send_fragment < s->split_send_fragment)
2176 s->split_send_fragment = s->max_send_fragment;
2178 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2179 if ((size_t)larg > s->max_send_fragment || larg == 0)
2181 s->split_send_fragment = larg;
2183 case SSL_CTRL_SET_MAX_PIPELINES:
2184 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2186 s->max_pipelines = larg;
2188 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2190 case SSL_CTRL_GET_RI_SUPPORT:
2192 return s->s3->send_connection_binding;
2195 case SSL_CTRL_CERT_FLAGS:
2196 return (s->cert->cert_flags |= larg);
2197 case SSL_CTRL_CLEAR_CERT_FLAGS:
2198 return (s->cert->cert_flags &= ~larg);
2200 case SSL_CTRL_GET_RAW_CIPHERLIST:
2202 if (s->s3->tmp.ciphers_raw == NULL)
2204 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2205 return (int)s->s3->tmp.ciphers_rawlen;
2207 return TLS_CIPHER_LEN;
2209 case SSL_CTRL_GET_EXTMS_SUPPORT:
2210 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2212 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2216 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2217 return ssl_check_allowed_versions(larg, s->max_proto_version)
2218 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2219 &s->min_proto_version);
2220 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2221 return s->min_proto_version;
2222 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2223 return ssl_check_allowed_versions(s->min_proto_version, larg)
2224 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2225 &s->max_proto_version);
2226 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2227 return s->max_proto_version;
2229 return s->method->ssl_ctrl(s, cmd, larg, parg);
2233 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2236 case SSL_CTRL_SET_MSG_CALLBACK:
2237 s->msg_callback = (void (*)
2238 (int write_p, int version, int content_type,
2239 const void *buf, size_t len, SSL *ssl,
2244 return s->method->ssl_callback_ctrl(s, cmd, fp);
2248 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2250 return ctx->sessions;
2253 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2257 /* For some cases with ctx == NULL perform syntax checks */
2260 #ifndef OPENSSL_NO_EC
2261 case SSL_CTRL_SET_GROUPS_LIST:
2262 return tls1_set_groups_list(NULL, NULL, parg);
2264 case SSL_CTRL_SET_SIGALGS_LIST:
2265 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2266 return tls1_set_sigalgs_list(NULL, parg, 0);
2273 case SSL_CTRL_GET_READ_AHEAD:
2274 return ctx->read_ahead;
2275 case SSL_CTRL_SET_READ_AHEAD:
2276 l = ctx->read_ahead;
2277 ctx->read_ahead = larg;
2280 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2281 ctx->msg_callback_arg = parg;
2284 case SSL_CTRL_GET_MAX_CERT_LIST:
2285 return (long)ctx->max_cert_list;
2286 case SSL_CTRL_SET_MAX_CERT_LIST:
2289 l = (long)ctx->max_cert_list;
2290 ctx->max_cert_list = (size_t)larg;
2293 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2296 l = (long)ctx->session_cache_size;
2297 ctx->session_cache_size = (size_t)larg;
2299 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2300 return (long)ctx->session_cache_size;
2301 case SSL_CTRL_SET_SESS_CACHE_MODE:
2302 l = ctx->session_cache_mode;
2303 ctx->session_cache_mode = larg;
2305 case SSL_CTRL_GET_SESS_CACHE_MODE:
2306 return ctx->session_cache_mode;
2308 case SSL_CTRL_SESS_NUMBER:
2309 return lh_SSL_SESSION_num_items(ctx->sessions);
2310 case SSL_CTRL_SESS_CONNECT:
2311 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2313 case SSL_CTRL_SESS_CONNECT_GOOD:
2314 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2316 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2317 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2320 case SSL_CTRL_SESS_ACCEPT:
2321 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2323 case SSL_CTRL_SESS_ACCEPT_GOOD:
2324 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2326 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2327 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2330 case SSL_CTRL_SESS_HIT:
2331 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2333 case SSL_CTRL_SESS_CB_HIT:
2334 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2336 case SSL_CTRL_SESS_MISSES:
2337 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2339 case SSL_CTRL_SESS_TIMEOUTS:
2340 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2342 case SSL_CTRL_SESS_CACHE_FULL:
2343 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2346 return (ctx->mode |= larg);
2347 case SSL_CTRL_CLEAR_MODE:
2348 return (ctx->mode &= ~larg);
2349 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2350 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2352 ctx->max_send_fragment = larg;
2353 if (ctx->max_send_fragment < ctx->split_send_fragment)
2354 ctx->split_send_fragment = ctx->max_send_fragment;
2356 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2357 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2359 ctx->split_send_fragment = larg;
2361 case SSL_CTRL_SET_MAX_PIPELINES:
2362 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2364 ctx->max_pipelines = larg;
2366 case SSL_CTRL_CERT_FLAGS:
2367 return (ctx->cert->cert_flags |= larg);
2368 case SSL_CTRL_CLEAR_CERT_FLAGS:
2369 return (ctx->cert->cert_flags &= ~larg);
2370 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2371 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2372 && ssl_set_version_bound(ctx->method->version, (int)larg,
2373 &ctx->min_proto_version);
2374 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2375 return ctx->min_proto_version;
2376 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2377 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2378 && ssl_set_version_bound(ctx->method->version, (int)larg,
2379 &ctx->max_proto_version);
2380 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2381 return ctx->max_proto_version;
2383 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2387 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2390 case SSL_CTRL_SET_MSG_CALLBACK:
2391 ctx->msg_callback = (void (*)
2392 (int write_p, int version, int content_type,
2393 const void *buf, size_t len, SSL *ssl,
2398 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2402 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2411 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2412 const SSL_CIPHER *const *bp)
2414 if ((*ap)->id > (*bp)->id)
2416 if ((*ap)->id < (*bp)->id)
2421 /** return a STACK of the ciphers available for the SSL and in order of
2423 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2426 if (s->cipher_list != NULL) {
2427 return s->cipher_list;
2428 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2429 return s->ctx->cipher_list;
2435 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2437 if ((s == NULL) || (s->session == NULL) || !s->server)
2439 return s->session->ciphers;
2442 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2444 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2447 ciphers = SSL_get_ciphers(s);
2450 if (!ssl_set_client_disabled(s))
2452 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2453 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2454 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2456 sk = sk_SSL_CIPHER_new_null();
2459 if (!sk_SSL_CIPHER_push(sk, c)) {
2460 sk_SSL_CIPHER_free(sk);
2468 /** return a STACK of the ciphers available for the SSL and in order of
2470 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2473 if (s->cipher_list_by_id != NULL) {
2474 return s->cipher_list_by_id;
2475 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2476 return s->ctx->cipher_list_by_id;
2482 /** The old interface to get the same thing as SSL_get_ciphers() */
2483 const char *SSL_get_cipher_list(const SSL *s, int n)
2485 const SSL_CIPHER *c;
2486 STACK_OF(SSL_CIPHER) *sk;
2490 sk = SSL_get_ciphers(s);
2491 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2493 c = sk_SSL_CIPHER_value(sk, n);
2499 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2501 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2504 return ctx->cipher_list;
2508 /** specify the ciphers to be used by default by the SSL_CTX */
2509 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2511 STACK_OF(SSL_CIPHER) *sk;
2513 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2514 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2517 * ssl_create_cipher_list may return an empty stack if it was unable to
2518 * find a cipher matching the given rule string (for example if the rule
2519 * string specifies a cipher which has been disabled). This is not an
2520 * error as far as ssl_create_cipher_list is concerned, and hence
2521 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2525 else if (sk_SSL_CIPHER_num(sk) == 0) {
2526 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2532 /** specify the ciphers to be used by the SSL */
2533 int SSL_set_cipher_list(SSL *s, const char *str)
2535 STACK_OF(SSL_CIPHER) *sk;
2537 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2538 &s->cipher_list, &s->cipher_list_by_id, str,
2540 /* see comment in SSL_CTX_set_cipher_list */
2543 else if (sk_SSL_CIPHER_num(sk) == 0) {
2544 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2550 static int ciphersuite_cb(const char *elem, int len, void *arg)
2552 STACK_OF(SSL_CIPHER) *ciphersuites = (STACK_OF(SSL_CIPHER) *)arg;
2553 const SSL_CIPHER *cipher;
2554 /* Arbitrary sized temp buffer for the cipher name. Should be big enough */
2557 if (len > (int)(sizeof(name) - 1)) {
2558 SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
2562 memcpy(name, elem, len);
2565 cipher = ssl3_get_cipher_by_std_name(name);
2566 if (cipher == NULL) {
2567 SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
2571 if (!sk_SSL_CIPHER_push(ciphersuites, cipher)) {
2572 SSLerr(SSL_F_CIPHERSUITE_CB, ERR_R_INTERNAL_ERROR);
2579 static int set_ciphersuites(STACK_OF(SSL_CIPHER) **currciphers, const char *str)
2581 STACK_OF(SSL_CIPHER) *newciphers = sk_SSL_CIPHER_new_null();
2583 if (newciphers == NULL)
2586 /* Parse the list. We explicitly allow an empty list */
2588 && !CONF_parse_list(str, ':', 1, ciphersuite_cb, newciphers)) {
2589 sk_SSL_CIPHER_free(newciphers);
2592 sk_SSL_CIPHER_free(*currciphers);
2593 *currciphers = newciphers;
2598 static int update_cipher_list(STACK_OF(SSL_CIPHER) *cipher_list,
2599 STACK_OF(SSL_CIPHER) *tls13_ciphersuites)
2604 * Delete any existing TLSv1.3 ciphersuites. These are always first in the
2607 while (sk_SSL_CIPHER_num(cipher_list) > 0
2608 && sk_SSL_CIPHER_value(cipher_list, 0)->min_tls == TLS1_3_VERSION)
2609 sk_SSL_CIPHER_delete(cipher_list, 0);
2611 /* Insert the new TLSv1.3 ciphersuites */
2612 for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++)
2613 sk_SSL_CIPHER_insert(cipher_list,
2614 sk_SSL_CIPHER_value(tls13_ciphersuites, i), i);
2619 int SSL_CTX_set_ciphersuites(SSL_CTX *ctx, const char *str)
2621 int ret = set_ciphersuites(&(ctx->tls13_ciphersuites), str);
2623 if (ret && ctx->cipher_list != NULL) {
2624 /* We already have a cipher_list, so we need to update it */
2625 return update_cipher_list(ctx->cipher_list, ctx->tls13_ciphersuites);
2631 int SSL_set_ciphersuites(SSL *s, const char *str)
2633 int ret = set_ciphersuites(&(s->tls13_ciphersuites), str);
2635 if (ret && s->cipher_list != NULL) {
2636 /* We already have a cipher_list, so we need to update it */
2637 return update_cipher_list(s->cipher_list, s->tls13_ciphersuites);
2643 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2646 STACK_OF(SSL_CIPHER) *sk;
2647 const SSL_CIPHER *c;
2650 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2654 sk = s->session->ciphers;
2656 if (sk_SSL_CIPHER_num(sk) == 0)
2659 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2662 c = sk_SSL_CIPHER_value(sk, i);
2663 n = strlen(c->name);
2679 /** return a servername extension value if provided in Client Hello, or NULL.
2680 * So far, only host_name types are defined (RFC 3546).
2683 const char *SSL_get_servername(const SSL *s, const int type)
2685 if (type != TLSEXT_NAMETYPE_host_name)
2688 return s->session && !s->ext.hostname ?
2689 s->session->ext.hostname : s->ext.hostname;
2692 int SSL_get_servername_type(const SSL *s)
2695 && (!s->ext.hostname ? s->session->
2696 ext.hostname : s->ext.hostname))
2697 return TLSEXT_NAMETYPE_host_name;
2702 * SSL_select_next_proto implements the standard protocol selection. It is
2703 * expected that this function is called from the callback set by
2704 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2705 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2706 * not included in the length. A byte string of length 0 is invalid. No byte
2707 * string may be truncated. The current, but experimental algorithm for
2708 * selecting the protocol is: 1) If the server doesn't support NPN then this
2709 * is indicated to the callback. In this case, the client application has to
2710 * abort the connection or have a default application level protocol. 2) If
2711 * the server supports NPN, but advertises an empty list then the client
2712 * selects the first protocol in its list, but indicates via the API that this
2713 * fallback case was enacted. 3) Otherwise, the client finds the first
2714 * protocol in the server's list that it supports and selects this protocol.
2715 * This is because it's assumed that the server has better information about
2716 * which protocol a client should use. 4) If the client doesn't support any
2717 * of the server's advertised protocols, then this is treated the same as
2718 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2719 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2721 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2722 const unsigned char *server,
2723 unsigned int server_len,
2724 const unsigned char *client, unsigned int client_len)
2727 const unsigned char *result;
2728 int status = OPENSSL_NPN_UNSUPPORTED;
2731 * For each protocol in server preference order, see if we support it.
2733 for (i = 0; i < server_len;) {
2734 for (j = 0; j < client_len;) {
2735 if (server[i] == client[j] &&
2736 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2737 /* We found a match */
2738 result = &server[i];
2739 status = OPENSSL_NPN_NEGOTIATED;
2749 /* There's no overlap between our protocols and the server's list. */
2751 status = OPENSSL_NPN_NO_OVERLAP;
2754 *out = (unsigned char *)result + 1;
2755 *outlen = result[0];
2759 #ifndef OPENSSL_NO_NEXTPROTONEG
2761 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2762 * client's requested protocol for this connection and returns 0. If the
2763 * client didn't request any protocol, then *data is set to NULL. Note that
2764 * the client can request any protocol it chooses. The value returned from
2765 * this function need not be a member of the list of supported protocols
2766 * provided by the callback.
2768 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2775 *len = (unsigned int)s->ext.npn_len;
2780 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2781 * a TLS server needs a list of supported protocols for Next Protocol
2782 * Negotiation. The returned list must be in wire format. The list is
2783 * returned by setting |out| to point to it and |outlen| to its length. This
2784 * memory will not be modified, but one should assume that the SSL* keeps a
2785 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2786 * wishes to advertise. Otherwise, no such extension will be included in the
2789 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2790 SSL_CTX_npn_advertised_cb_func cb,
2793 ctx->ext.npn_advertised_cb = cb;
2794 ctx->ext.npn_advertised_cb_arg = arg;
2798 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2799 * client needs to select a protocol from the server's provided list. |out|
2800 * must be set to point to the selected protocol (which may be within |in|).
2801 * The length of the protocol name must be written into |outlen|. The
2802 * server's advertised protocols are provided in |in| and |inlen|. The
2803 * callback can assume that |in| is syntactically valid. The client must
2804 * select a protocol. It is fatal to the connection if this callback returns
2805 * a value other than SSL_TLSEXT_ERR_OK.
2807 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2808 SSL_CTX_npn_select_cb_func cb,
2811 ctx->ext.npn_select_cb = cb;
2812 ctx->ext.npn_select_cb_arg = arg;
2817 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2818 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2819 * length-prefixed strings). Returns 0 on success.
2821 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2822 unsigned int protos_len)
2824 OPENSSL_free(ctx->ext.alpn);
2825 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2826 if (ctx->ext.alpn == NULL) {
2827 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2830 ctx->ext.alpn_len = protos_len;
2836 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2837 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2838 * length-prefixed strings). Returns 0 on success.
2840 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2841 unsigned int protos_len)
2843 OPENSSL_free(ssl->ext.alpn);
2844 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2845 if (ssl->ext.alpn == NULL) {
2846 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2849 ssl->ext.alpn_len = protos_len;
2855 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2856 * called during ClientHello processing in order to select an ALPN protocol
2857 * from the client's list of offered protocols.
2859 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2860 SSL_CTX_alpn_select_cb_func cb,
2863 ctx->ext.alpn_select_cb = cb;
2864 ctx->ext.alpn_select_cb_arg = arg;
2868 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2869 * On return it sets |*data| to point to |*len| bytes of protocol name
2870 * (not including the leading length-prefix byte). If the server didn't
2871 * respond with a negotiated protocol then |*len| will be zero.
2873 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2878 *data = ssl->s3->alpn_selected;
2882 *len = (unsigned int)ssl->s3->alpn_selected_len;
2885 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2886 const char *label, size_t llen,
2887 const unsigned char *context, size_t contextlen,
2890 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2893 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2895 contextlen, use_context);
2898 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2899 const char *label, size_t llen,
2900 const unsigned char *context,
2903 if (s->version != TLS1_3_VERSION)
2906 return tls13_export_keying_material_early(s, out, olen, label, llen,
2907 context, contextlen);
2910 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2912 const unsigned char *session_id = a->session_id;
2914 unsigned char tmp_storage[4];
2916 if (a->session_id_length < sizeof(tmp_storage)) {
2917 memset(tmp_storage, 0, sizeof(tmp_storage));
2918 memcpy(tmp_storage, a->session_id, a->session_id_length);
2919 session_id = tmp_storage;
2923 ((unsigned long)session_id[0]) |
2924 ((unsigned long)session_id[1] << 8L) |
2925 ((unsigned long)session_id[2] << 16L) |
2926 ((unsigned long)session_id[3] << 24L);
2931 * NB: If this function (or indeed the hash function which uses a sort of
2932 * coarser function than this one) is changed, ensure
2933 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2934 * being able to construct an SSL_SESSION that will collide with any existing
2935 * session with a matching session ID.
2937 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2939 if (a->ssl_version != b->ssl_version)
2941 if (a->session_id_length != b->session_id_length)
2943 return memcmp(a->session_id, b->session_id, a->session_id_length);
2947 * These wrapper functions should remain rather than redeclaring
2948 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2949 * variable. The reason is that the functions aren't static, they're exposed
2953 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2955 SSL_CTX *ret = NULL;
2958 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2962 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2965 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2966 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2969 ret = OPENSSL_zalloc(sizeof(*ret));
2974 ret->min_proto_version = 0;
2975 ret->max_proto_version = 0;
2976 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2977 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2978 /* We take the system default. */
2979 ret->session_timeout = meth->get_timeout();
2980 ret->references = 1;
2981 ret->lock = CRYPTO_THREAD_lock_new();
2982 if (ret->lock == NULL) {
2983 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2987 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2988 ret->verify_mode = SSL_VERIFY_NONE;
2989 if ((ret->cert = ssl_cert_new()) == NULL)
2992 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2993 if (ret->sessions == NULL)
2995 ret->cert_store = X509_STORE_new();
2996 if (ret->cert_store == NULL)
2998 #ifndef OPENSSL_NO_CT
2999 ret->ctlog_store = CTLOG_STORE_new();
3000 if (ret->ctlog_store == NULL)
3004 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
3007 if (!ssl_create_cipher_list(ret->method,
3008 ret->tls13_ciphersuites,
3009 &ret->cipher_list, &ret->cipher_list_by_id,
3010 SSL_DEFAULT_CIPHER_LIST, ret->cert)
3011 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
3012 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
3016 ret->param = X509_VERIFY_PARAM_new();
3017 if (ret->param == NULL)
3020 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
3021 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
3024 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
3025 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
3029 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
3032 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
3035 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
3038 /* No compression for DTLS */
3039 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
3040 ret->comp_methods = SSL_COMP_get_compression_methods();
3042 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3043 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
3045 /* Setup RFC5077 ticket keys */
3046 if ((RAND_bytes(ret->ext.tick_key_name,
3047 sizeof(ret->ext.tick_key_name)) <= 0)
3048 || (RAND_bytes(ret->ext.secure->tick_hmac_key,
3049 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
3050 || (RAND_bytes(ret->ext.secure->tick_aes_key,
3051 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
3052 ret->options |= SSL_OP_NO_TICKET;
3054 if (RAND_bytes(ret->ext.cookie_hmac_key,
3055 sizeof(ret->ext.cookie_hmac_key)) <= 0)
3058 #ifndef OPENSSL_NO_SRP
3059 if (!SSL_CTX_SRP_CTX_init(ret))
3062 #ifndef OPENSSL_NO_ENGINE
3063 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3064 # define eng_strx(x) #x
3065 # define eng_str(x) eng_strx(x)
3066 /* Use specific client engine automatically... ignore errors */
3069 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3072 ENGINE_load_builtin_engines();
3073 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3075 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3081 * Default is to connect to non-RI servers. When RI is more widely
3082 * deployed might change this.
3084 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3086 * Disable compression by default to prevent CRIME. Applications can
3087 * re-enable compression by configuring
3088 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3089 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3090 * middlebox compatibility by default. This may be disabled by default in
3091 * a later OpenSSL version.
3093 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3095 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3098 * We cannot usefully set a default max_early_data here (which gets
3099 * propagated in SSL_new(), for the following reason: setting the
3100 * SSL field causes tls_construct_stoc_early_data() to tell the
3101 * client that early data will be accepted when constructing a TLS 1.3
3102 * session ticket, and the client will accordingly send us early data
3103 * when using that ticket (if the client has early data to send).
3104 * However, in order for the early data to actually be consumed by
3105 * the application, the application must also have calls to
3106 * SSL_read_early_data(); otherwise we'll just skip past the early data
3107 * and ignore it. So, since the application must add calls to
3108 * SSL_read_early_data(), we also require them to add
3109 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3110 * eliminating the bandwidth-wasting early data in the case described
3113 ret->max_early_data = 0;
3115 ssl_ctx_system_config(ret);
3119 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3125 int SSL_CTX_up_ref(SSL_CTX *ctx)
3129 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3132 REF_PRINT_COUNT("SSL_CTX", ctx);
3133 REF_ASSERT_ISNT(i < 2);
3134 return ((i > 1) ? 1 : 0);
3137 void SSL_CTX_free(SSL_CTX *a)
3144 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3145 REF_PRINT_COUNT("SSL_CTX", a);
3148 REF_ASSERT_ISNT(i < 0);
3150 X509_VERIFY_PARAM_free(a->param);
3151 dane_ctx_final(&a->dane);
3154 * Free internal session cache. However: the remove_cb() may reference
3155 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3156 * after the sessions were flushed.
3157 * As the ex_data handling routines might also touch the session cache,
3158 * the most secure solution seems to be: empty (flush) the cache, then
3159 * free ex_data, then finally free the cache.
3160 * (See ticket [openssl.org #212].)
3162 if (a->sessions != NULL)
3163 SSL_CTX_flush_sessions(a, 0);
3165 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3166 lh_SSL_SESSION_free(a->sessions);
3167 X509_STORE_free(a->cert_store);
3168 #ifndef OPENSSL_NO_CT
3169 CTLOG_STORE_free(a->ctlog_store);
3171 sk_SSL_CIPHER_free(a->cipher_list);
3172 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3173 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3174 ssl_cert_free(a->cert);
3175 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3176 sk_X509_pop_free(a->extra_certs, X509_free);
3177 a->comp_methods = NULL;
3178 #ifndef OPENSSL_NO_SRTP
3179 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3181 #ifndef OPENSSL_NO_SRP
3182 SSL_CTX_SRP_CTX_free(a);
3184 #ifndef OPENSSL_NO_ENGINE
3185 ENGINE_finish(a->client_cert_engine);
3188 #ifndef OPENSSL_NO_EC
3189 OPENSSL_free(a->ext.ecpointformats);
3190 OPENSSL_free(a->ext.supportedgroups);
3192 OPENSSL_free(a->ext.alpn);
3193 OPENSSL_secure_free(a->ext.secure);
3195 CRYPTO_THREAD_lock_free(a->lock);
3200 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3202 ctx->default_passwd_callback = cb;
3205 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3207 ctx->default_passwd_callback_userdata = u;
3210 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3212 return ctx->default_passwd_callback;
3215 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3217 return ctx->default_passwd_callback_userdata;
3220 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3222 s->default_passwd_callback = cb;
3225 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3227 s->default_passwd_callback_userdata = u;
3230 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3232 return s->default_passwd_callback;
3235 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3237 return s->default_passwd_callback_userdata;
3240 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3241 int (*cb) (X509_STORE_CTX *, void *),
3244 ctx->app_verify_callback = cb;
3245 ctx->app_verify_arg = arg;
3248 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3249 int (*cb) (int, X509_STORE_CTX *))
3251 ctx->verify_mode = mode;
3252 ctx->default_verify_callback = cb;
3255 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3257 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3260 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3262 ssl_cert_set_cert_cb(c->cert, cb, arg);
3265 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3267 ssl_cert_set_cert_cb(s->cert, cb, arg);
3270 void ssl_set_masks(SSL *s)
3273 uint32_t *pvalid = s->s3->tmp.valid_flags;
3274 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3275 unsigned long mask_k, mask_a;
3276 #ifndef OPENSSL_NO_EC
3277 int have_ecc_cert, ecdsa_ok;
3282 #ifndef OPENSSL_NO_DH
3283 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3288 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3289 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3290 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3291 #ifndef OPENSSL_NO_EC
3292 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3298 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3299 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3302 #ifndef OPENSSL_NO_GOST
3303 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3304 mask_k |= SSL_kGOST;
3305 mask_a |= SSL_aGOST12;
3307 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3308 mask_k |= SSL_kGOST;
3309 mask_a |= SSL_aGOST12;
3311 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3312 mask_k |= SSL_kGOST;
3313 mask_a |= SSL_aGOST01;
3324 * If we only have an RSA-PSS certificate allow RSA authentication
3325 * if TLS 1.2 and peer supports it.
3328 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3329 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3330 && TLS1_get_version(s) == TLS1_2_VERSION))
3337 mask_a |= SSL_aNULL;
3340 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3341 * depending on the key usage extension.
3343 #ifndef OPENSSL_NO_EC
3344 if (have_ecc_cert) {
3346 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3347 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3348 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3351 mask_a |= SSL_aECDSA;
3353 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3354 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3355 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3356 && TLS1_get_version(s) == TLS1_2_VERSION)
3357 mask_a |= SSL_aECDSA;
3359 /* Allow Ed448 for TLS 1.2 if peer supports it */
3360 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3361 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3362 && TLS1_get_version(s) == TLS1_2_VERSION)
3363 mask_a |= SSL_aECDSA;
3366 #ifndef OPENSSL_NO_EC
3367 mask_k |= SSL_kECDHE;
3370 #ifndef OPENSSL_NO_PSK
3373 if (mask_k & SSL_kRSA)
3374 mask_k |= SSL_kRSAPSK;
3375 if (mask_k & SSL_kDHE)
3376 mask_k |= SSL_kDHEPSK;
3377 if (mask_k & SSL_kECDHE)
3378 mask_k |= SSL_kECDHEPSK;
3381 s->s3->tmp.mask_k = mask_k;
3382 s->s3->tmp.mask_a = mask_a;
3385 #ifndef OPENSSL_NO_EC
3387 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3389 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3390 /* key usage, if present, must allow signing */
3391 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3392 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3393 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3397 return 1; /* all checks are ok */
3402 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3403 size_t *serverinfo_length)
3405 CERT_PKEY *cpk = s->s3->tmp.cert;
3406 *serverinfo_length = 0;
3408 if (cpk == NULL || cpk->serverinfo == NULL)
3411 *serverinfo = cpk->serverinfo;
3412 *serverinfo_length = cpk->serverinfo_length;
3416 void ssl_update_cache(SSL *s, int mode)
3421 * If the session_id_length is 0, we are not supposed to cache it, and it
3422 * would be rather hard to do anyway :-)
3424 if (s->session->session_id_length == 0)
3428 * If sid_ctx_length is 0 there is no specific application context
3429 * associated with this session, so when we try to resume it and
3430 * SSL_VERIFY_PEER is requested, we have no indication that this is
3431 * actually a session for the proper application context, and the
3432 * *handshake* will fail, not just the resumption attempt.
3433 * Do not cache these sessions that are not resumable.
3435 if (s->session->sid_ctx_length == 0
3436 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3439 i = s->session_ctx->session_cache_mode;
3441 && (!s->hit || SSL_IS_TLS13(s))
3442 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) != 0
3443 || SSL_CTX_add_session(s->session_ctx, s->session))
3444 && s->session_ctx->new_session_cb != NULL) {
3445 SSL_SESSION_up_ref(s->session);
3446 if (!s->session_ctx->new_session_cb(s, s->session))
3447 SSL_SESSION_free(s->session);
3450 /* auto flush every 255 connections */
3451 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3453 if (mode & SSL_SESS_CACHE_CLIENT)
3454 stat = &s->session_ctx->stats.sess_connect_good;
3456 stat = &s->session_ctx->stats.sess_accept_good;
3457 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3458 && (val & 0xff) == 0xff)
3459 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3463 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3468 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3473 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3477 if (s->method != meth) {
3478 const SSL_METHOD *sm = s->method;
3479 int (*hf) (SSL *) = s->handshake_func;
3481 if (sm->version == meth->version)
3486 ret = s->method->ssl_new(s);
3489 if (hf == sm->ssl_connect)
3490 s->handshake_func = meth->ssl_connect;
3491 else if (hf == sm->ssl_accept)
3492 s->handshake_func = meth->ssl_accept;
3497 int SSL_get_error(const SSL *s, int i)
3504 return SSL_ERROR_NONE;
3507 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3508 * where we do encode the error
3510 if ((l = ERR_peek_error()) != 0) {
3511 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3512 return SSL_ERROR_SYSCALL;
3514 return SSL_ERROR_SSL;
3517 if (SSL_want_read(s)) {
3518 bio = SSL_get_rbio(s);
3519 if (BIO_should_read(bio))
3520 return SSL_ERROR_WANT_READ;
3521 else if (BIO_should_write(bio))
3523 * This one doesn't make too much sense ... We never try to write
3524 * to the rbio, and an application program where rbio and wbio
3525 * are separate couldn't even know what it should wait for.
3526 * However if we ever set s->rwstate incorrectly (so that we have
3527 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3528 * wbio *are* the same, this test works around that bug; so it
3529 * might be safer to keep it.
3531 return SSL_ERROR_WANT_WRITE;
3532 else if (BIO_should_io_special(bio)) {
3533 reason = BIO_get_retry_reason(bio);
3534 if (reason == BIO_RR_CONNECT)
3535 return SSL_ERROR_WANT_CONNECT;
3536 else if (reason == BIO_RR_ACCEPT)
3537 return SSL_ERROR_WANT_ACCEPT;
3539 return SSL_ERROR_SYSCALL; /* unknown */
3543 if (SSL_want_write(s)) {
3544 /* Access wbio directly - in order to use the buffered bio if present */
3546 if (BIO_should_write(bio))
3547 return SSL_ERROR_WANT_WRITE;
3548 else if (BIO_should_read(bio))
3550 * See above (SSL_want_read(s) with BIO_should_write(bio))
3552 return SSL_ERROR_WANT_READ;
3553 else if (BIO_should_io_special(bio)) {
3554 reason = BIO_get_retry_reason(bio);
3555 if (reason == BIO_RR_CONNECT)
3556 return SSL_ERROR_WANT_CONNECT;
3557 else if (reason == BIO_RR_ACCEPT)
3558 return SSL_ERROR_WANT_ACCEPT;
3560 return SSL_ERROR_SYSCALL;
3563 if (SSL_want_x509_lookup(s))
3564 return SSL_ERROR_WANT_X509_LOOKUP;
3565 if (SSL_want_async(s))
3566 return SSL_ERROR_WANT_ASYNC;
3567 if (SSL_want_async_job(s))
3568 return SSL_ERROR_WANT_ASYNC_JOB;
3569 if (SSL_want_client_hello_cb(s))
3570 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3572 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3573 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3574 return SSL_ERROR_ZERO_RETURN;
3576 return SSL_ERROR_SYSCALL;
3579 static int ssl_do_handshake_intern(void *vargs)
3581 struct ssl_async_args *args;
3584 args = (struct ssl_async_args *)vargs;
3587 return s->handshake_func(s);
3590 int SSL_do_handshake(SSL *s)
3594 if (s->handshake_func == NULL) {
3595 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3599 ossl_statem_check_finish_init(s, -1);
3601 s->method->ssl_renegotiate_check(s, 0);
3603 if (SSL_is_server(s)) {
3604 /* clear SNI settings at server-side */
3605 OPENSSL_free(s->ext.hostname);
3606 s->ext.hostname = NULL;
3609 if (SSL_in_init(s) || SSL_in_before(s)) {
3610 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3611 struct ssl_async_args args;
3615 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3617 ret = s->handshake_func(s);
3623 void SSL_set_accept_state(SSL *s)
3627 ossl_statem_clear(s);
3628 s->handshake_func = s->method->ssl_accept;
3632 void SSL_set_connect_state(SSL *s)
3636 ossl_statem_clear(s);
3637 s->handshake_func = s->method->ssl_connect;
3641 int ssl_undefined_function(SSL *s)
3643 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3647 int ssl_undefined_void_function(void)
3649 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3650 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3654 int ssl_undefined_const_function(const SSL *s)
3659 const SSL_METHOD *ssl_bad_method(int ver)
3661 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3665 const char *ssl_protocol_to_string(int version)
3669 case TLS1_3_VERSION:
3672 case TLS1_2_VERSION:
3675 case TLS1_1_VERSION:
3690 case DTLS1_2_VERSION:
3698 const char *SSL_get_version(const SSL *s)
3700 return ssl_protocol_to_string(s->version);
3703 SSL *SSL_dup(SSL *s)
3705 STACK_OF(X509_NAME) *sk;
3710 /* If we're not quiescent, just up_ref! */
3711 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3712 CRYPTO_UP_REF(&s->references, &i, s->lock);
3717 * Otherwise, copy configuration state, and session if set.
3719 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3722 if (s->session != NULL) {
3724 * Arranges to share the same session via up_ref. This "copies"
3725 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3727 if (!SSL_copy_session_id(ret, s))
3731 * No session has been established yet, so we have to expect that
3732 * s->cert or ret->cert will be changed later -- they should not both
3733 * point to the same object, and thus we can't use
3734 * SSL_copy_session_id.
3736 if (!SSL_set_ssl_method(ret, s->method))
3739 if (s->cert != NULL) {
3740 ssl_cert_free(ret->cert);
3741 ret->cert = ssl_cert_dup(s->cert);
3742 if (ret->cert == NULL)
3746 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3747 (int)s->sid_ctx_length))
3751 if (!ssl_dane_dup(ret, s))
3753 ret->version = s->version;
3754 ret->options = s->options;
3755 ret->mode = s->mode;
3756 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3757 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3758 ret->msg_callback = s->msg_callback;
3759 ret->msg_callback_arg = s->msg_callback_arg;
3760 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3761 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3762 ret->generate_session_id = s->generate_session_id;
3764 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3766 /* copy app data, a little dangerous perhaps */
3767 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3770 /* setup rbio, and wbio */
3771 if (s->rbio != NULL) {
3772 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3775 if (s->wbio != NULL) {
3776 if (s->wbio != s->rbio) {
3777 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3780 BIO_up_ref(ret->rbio);
3781 ret->wbio = ret->rbio;
3785 ret->server = s->server;
3786 if (s->handshake_func) {
3788 SSL_set_accept_state(ret);
3790 SSL_set_connect_state(ret);
3792 ret->shutdown = s->shutdown;
3795 ret->default_passwd_callback = s->default_passwd_callback;
3796 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3798 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3800 /* dup the cipher_list and cipher_list_by_id stacks */
3801 if (s->cipher_list != NULL) {
3802 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3805 if (s->cipher_list_by_id != NULL)
3806 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3810 /* Dup the client_CA list */
3811 if (s->ca_names != NULL) {
3812 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3815 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3816 xn = sk_X509_NAME_value(sk, i);
3817 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3830 void ssl_clear_cipher_ctx(SSL *s)
3832 if (s->enc_read_ctx != NULL) {
3833 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3834 s->enc_read_ctx = NULL;
3836 if (s->enc_write_ctx != NULL) {
3837 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3838 s->enc_write_ctx = NULL;
3840 #ifndef OPENSSL_NO_COMP
3841 COMP_CTX_free(s->expand);
3843 COMP_CTX_free(s->compress);
3848 X509 *SSL_get_certificate(const SSL *s)
3850 if (s->cert != NULL)
3851 return s->cert->key->x509;
3856 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3858 if (s->cert != NULL)
3859 return s->cert->key->privatekey;
3864 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3866 if (ctx->cert != NULL)
3867 return ctx->cert->key->x509;
3872 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3874 if (ctx->cert != NULL)
3875 return ctx->cert->key->privatekey;
3880 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3882 if ((s->session != NULL) && (s->session->cipher != NULL))
3883 return s->session->cipher;
3887 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3889 return s->s3->tmp.new_cipher;
3892 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3894 #ifndef OPENSSL_NO_COMP
3895 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3901 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3903 #ifndef OPENSSL_NO_COMP
3904 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3910 int ssl_init_wbio_buffer(SSL *s)
3914 if (s->bbio != NULL) {
3915 /* Already buffered. */
3919 bbio = BIO_new(BIO_f_buffer());
3920 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3922 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3926 s->wbio = BIO_push(bbio, s->wbio);
3931 int ssl_free_wbio_buffer(SSL *s)
3933 /* callers ensure s is never null */
3934 if (s->bbio == NULL)
3937 s->wbio = BIO_pop(s->wbio);
3938 if (!ossl_assert(s->wbio != NULL))
3946 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3948 ctx->quiet_shutdown = mode;
3951 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3953 return ctx->quiet_shutdown;
3956 void SSL_set_quiet_shutdown(SSL *s, int mode)
3958 s->quiet_shutdown = mode;
3961 int SSL_get_quiet_shutdown(const SSL *s)
3963 return s->quiet_shutdown;
3966 void SSL_set_shutdown(SSL *s, int mode)
3971 int SSL_get_shutdown(const SSL *s)
3976 int SSL_version(const SSL *s)
3981 int SSL_client_version(const SSL *s)
3983 return s->client_version;
3986 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3991 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3994 if (ssl->ctx == ctx)
3997 ctx = ssl->session_ctx;
3998 new_cert = ssl_cert_dup(ctx->cert);
3999 if (new_cert == NULL) {
4003 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
4004 ssl_cert_free(new_cert);
4008 ssl_cert_free(ssl->cert);
4009 ssl->cert = new_cert;
4012 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
4013 * so setter APIs must prevent invalid lengths from entering the system.
4015 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
4019 * If the session ID context matches that of the parent SSL_CTX,
4020 * inherit it from the new SSL_CTX as well. If however the context does
4021 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4022 * leave it unchanged.
4024 if ((ssl->ctx != NULL) &&
4025 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
4026 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
4027 ssl->sid_ctx_length = ctx->sid_ctx_length;
4028 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
4031 SSL_CTX_up_ref(ctx);
4032 SSL_CTX_free(ssl->ctx); /* decrement reference count */
4038 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
4040 return X509_STORE_set_default_paths(ctx->cert_store);
4043 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
4045 X509_LOOKUP *lookup;
4047 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
4050 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
4052 /* Clear any errors if the default directory does not exist */
4058 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4060 X509_LOOKUP *lookup;
4062 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4066 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4068 /* Clear any errors if the default file does not exist */
4074 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4077 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4080 void SSL_set_info_callback(SSL *ssl,
4081 void (*cb) (const SSL *ssl, int type, int val))
4083 ssl->info_callback = cb;
4087 * One compiler (Diab DCC) doesn't like argument names in returned function
4090 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4093 return ssl->info_callback;
4096 void SSL_set_verify_result(SSL *ssl, long arg)
4098 ssl->verify_result = arg;
4101 long SSL_get_verify_result(const SSL *ssl)
4103 return ssl->verify_result;
4106 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4109 return sizeof(ssl->s3->client_random);
4110 if (outlen > sizeof(ssl->s3->client_random))
4111 outlen = sizeof(ssl->s3->client_random);
4112 memcpy(out, ssl->s3->client_random, outlen);
4116 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4119 return sizeof(ssl->s3->server_random);
4120 if (outlen > sizeof(ssl->s3->server_random))
4121 outlen = sizeof(ssl->s3->server_random);
4122 memcpy(out, ssl->s3->server_random, outlen);
4126 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4127 unsigned char *out, size_t outlen)
4130 return session->master_key_length;
4131 if (outlen > session->master_key_length)
4132 outlen = session->master_key_length;
4133 memcpy(out, session->master_key, outlen);
4137 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4140 if (len > sizeof(sess->master_key))
4143 memcpy(sess->master_key, in, len);
4144 sess->master_key_length = len;
4149 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4151 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4154 void *SSL_get_ex_data(const SSL *s, int idx)
4156 return CRYPTO_get_ex_data(&s->ex_data, idx);
4159 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4161 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4164 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4166 return CRYPTO_get_ex_data(&s->ex_data, idx);
4169 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4171 return ctx->cert_store;
4174 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4176 X509_STORE_free(ctx->cert_store);
4177 ctx->cert_store = store;
4180 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4183 X509_STORE_up_ref(store);
4184 SSL_CTX_set_cert_store(ctx, store);
4187 int SSL_want(const SSL *s)
4193 * \brief Set the callback for generating temporary DH keys.
4194 * \param ctx the SSL context.
4195 * \param dh the callback
4198 #ifndef OPENSSL_NO_DH
4199 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4200 DH *(*dh) (SSL *ssl, int is_export,
4203 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4206 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4209 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4213 #ifndef OPENSSL_NO_PSK
4214 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4216 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4217 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4220 OPENSSL_free(ctx->cert->psk_identity_hint);
4221 if (identity_hint != NULL) {
4222 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4223 if (ctx->cert->psk_identity_hint == NULL)
4226 ctx->cert->psk_identity_hint = NULL;
4230 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4235 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4236 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4239 OPENSSL_free(s->cert->psk_identity_hint);
4240 if (identity_hint != NULL) {
4241 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4242 if (s->cert->psk_identity_hint == NULL)
4245 s->cert->psk_identity_hint = NULL;
4249 const char *SSL_get_psk_identity_hint(const SSL *s)
4251 if (s == NULL || s->session == NULL)
4253 return s->session->psk_identity_hint;
4256 const char *SSL_get_psk_identity(const SSL *s)
4258 if (s == NULL || s->session == NULL)
4260 return s->session->psk_identity;
4263 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4265 s->psk_client_callback = cb;
4268 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4270 ctx->psk_client_callback = cb;
4273 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4275 s->psk_server_callback = cb;
4278 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4280 ctx->psk_server_callback = cb;
4284 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4286 s->psk_find_session_cb = cb;
4289 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4290 SSL_psk_find_session_cb_func cb)
4292 ctx->psk_find_session_cb = cb;
4295 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4297 s->psk_use_session_cb = cb;
4300 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4301 SSL_psk_use_session_cb_func cb)
4303 ctx->psk_use_session_cb = cb;
4306 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4307 void (*cb) (int write_p, int version,
4308 int content_type, const void *buf,
4309 size_t len, SSL *ssl, void *arg))
4311 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4314 void SSL_set_msg_callback(SSL *ssl,
4315 void (*cb) (int write_p, int version,
4316 int content_type, const void *buf,
4317 size_t len, SSL *ssl, void *arg))
4319 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4322 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4323 int (*cb) (SSL *ssl,
4327 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4328 (void (*)(void))cb);
4331 void SSL_set_not_resumable_session_callback(SSL *ssl,
4332 int (*cb) (SSL *ssl,
4333 int is_forward_secure))
4335 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4336 (void (*)(void))cb);
4339 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4340 size_t (*cb) (SSL *ssl, int type,
4341 size_t len, void *arg))
4343 ctx->record_padding_cb = cb;
4346 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4348 ctx->record_padding_arg = arg;
4351 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4353 return ctx->record_padding_arg;
4356 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4358 /* block size of 0 or 1 is basically no padding */
4359 if (block_size == 1)
4360 ctx->block_padding = 0;
4361 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4362 ctx->block_padding = block_size;
4368 void SSL_set_record_padding_callback(SSL *ssl,
4369 size_t (*cb) (SSL *ssl, int type,
4370 size_t len, void *arg))
4372 ssl->record_padding_cb = cb;
4375 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4377 ssl->record_padding_arg = arg;
4380 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4382 return ssl->record_padding_arg;
4385 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4387 /* block size of 0 or 1 is basically no padding */
4388 if (block_size == 1)
4389 ssl->block_padding = 0;
4390 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4391 ssl->block_padding = block_size;
4398 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4399 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4400 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4401 * Returns the newly allocated ctx;
4404 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4406 ssl_clear_hash_ctx(hash);
4407 *hash = EVP_MD_CTX_new();
4408 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4409 EVP_MD_CTX_free(*hash);
4416 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4419 EVP_MD_CTX_free(*hash);
4423 /* Retrieve handshake hashes */
4424 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4427 EVP_MD_CTX *ctx = NULL;
4428 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4429 int hashleni = EVP_MD_CTX_size(hdgst);
4432 if (hashleni < 0 || (size_t)hashleni > outlen) {
4433 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4434 ERR_R_INTERNAL_ERROR);
4438 ctx = EVP_MD_CTX_new();
4442 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4443 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4444 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4445 ERR_R_INTERNAL_ERROR);
4449 *hashlen = hashleni;
4453 EVP_MD_CTX_free(ctx);
4457 int SSL_session_reused(SSL *s)
4462 int SSL_is_server(const SSL *s)
4467 #if OPENSSL_API_COMPAT < 0x10100000L
4468 void SSL_set_debug(SSL *s, int debug)
4470 /* Old function was do-nothing anyway... */
4476 void SSL_set_security_level(SSL *s, int level)
4478 s->cert->sec_level = level;
4481 int SSL_get_security_level(const SSL *s)
4483 return s->cert->sec_level;
4486 void SSL_set_security_callback(SSL *s,
4487 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4488 int op, int bits, int nid,
4489 void *other, void *ex))
4491 s->cert->sec_cb = cb;
4494 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4495 const SSL_CTX *ctx, int op,
4496 int bits, int nid, void *other,
4498 return s->cert->sec_cb;
4501 void SSL_set0_security_ex_data(SSL *s, void *ex)
4503 s->cert->sec_ex = ex;
4506 void *SSL_get0_security_ex_data(const SSL *s)
4508 return s->cert->sec_ex;
4511 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4513 ctx->cert->sec_level = level;
4516 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4518 return ctx->cert->sec_level;
4521 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4522 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4523 int op, int bits, int nid,
4524 void *other, void *ex))
4526 ctx->cert->sec_cb = cb;
4529 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4535 return ctx->cert->sec_cb;
4538 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4540 ctx->cert->sec_ex = ex;
4543 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4545 return ctx->cert->sec_ex;
4549 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4550 * can return unsigned long, instead of the generic long return value from the
4551 * control interface.
4553 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4555 return ctx->options;
4558 unsigned long SSL_get_options(const SSL *s)
4563 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4565 return ctx->options |= op;
4568 unsigned long SSL_set_options(SSL *s, unsigned long op)
4570 return s->options |= op;
4573 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4575 return ctx->options &= ~op;
4578 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4580 return s->options &= ~op;
4583 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4585 return s->verified_chain;
4588 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4590 #ifndef OPENSSL_NO_CT
4593 * Moves SCTs from the |src| stack to the |dst| stack.
4594 * The source of each SCT will be set to |origin|.
4595 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4597 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4599 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4600 sct_source_t origin)
4606 *dst = sk_SCT_new_null();
4608 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4613 while ((sct = sk_SCT_pop(src)) != NULL) {
4614 if (SCT_set_source(sct, origin) != 1)
4617 if (sk_SCT_push(*dst, sct) <= 0)
4625 sk_SCT_push(src, sct); /* Put the SCT back */
4630 * Look for data collected during ServerHello and parse if found.
4631 * Returns the number of SCTs extracted.
4633 static int ct_extract_tls_extension_scts(SSL *s)
4635 int scts_extracted = 0;
4637 if (s->ext.scts != NULL) {
4638 const unsigned char *p = s->ext.scts;
4639 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4641 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4643 SCT_LIST_free(scts);
4646 return scts_extracted;
4650 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4651 * contains an SCT X509 extension. They will be stored in |s->scts|.
4653 * - The number of SCTs extracted, assuming an OCSP response exists.
4654 * - 0 if no OCSP response exists or it contains no SCTs.
4655 * - A negative integer if an error occurs.
4657 static int ct_extract_ocsp_response_scts(SSL *s)
4659 # ifndef OPENSSL_NO_OCSP
4660 int scts_extracted = 0;
4661 const unsigned char *p;
4662 OCSP_BASICRESP *br = NULL;
4663 OCSP_RESPONSE *rsp = NULL;
4664 STACK_OF(SCT) *scts = NULL;
4667 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4670 p = s->ext.ocsp.resp;
4671 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4675 br = OCSP_response_get1_basic(rsp);
4679 for (i = 0; i < OCSP_resp_count(br); ++i) {
4680 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4686 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4688 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4689 if (scts_extracted < 0)
4693 SCT_LIST_free(scts);
4694 OCSP_BASICRESP_free(br);
4695 OCSP_RESPONSE_free(rsp);
4696 return scts_extracted;
4698 /* Behave as if no OCSP response exists */
4704 * Attempts to extract SCTs from the peer certificate.
4705 * Return the number of SCTs extracted, or a negative integer if an error
4708 static int ct_extract_x509v3_extension_scts(SSL *s)
4710 int scts_extracted = 0;
4711 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4714 STACK_OF(SCT) *scts =
4715 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4718 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4720 SCT_LIST_free(scts);
4723 return scts_extracted;
4727 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4728 * response (if it exists) and X509v3 extensions in the certificate.
4729 * Returns NULL if an error occurs.
4731 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4733 if (!s->scts_parsed) {
4734 if (ct_extract_tls_extension_scts(s) < 0 ||
4735 ct_extract_ocsp_response_scts(s) < 0 ||
4736 ct_extract_x509v3_extension_scts(s) < 0)
4746 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4747 const STACK_OF(SCT) *scts, void *unused_arg)
4752 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4753 const STACK_OF(SCT) *scts, void *unused_arg)
4755 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4758 for (i = 0; i < count; ++i) {
4759 SCT *sct = sk_SCT_value(scts, i);
4760 int status = SCT_get_validation_status(sct);
4762 if (status == SCT_VALIDATION_STATUS_VALID)
4765 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4769 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4773 * Since code exists that uses the custom extension handler for CT, look
4774 * for this and throw an error if they have already registered to use CT.
4776 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4777 TLSEXT_TYPE_signed_certificate_timestamp))
4779 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4780 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4784 if (callback != NULL) {
4786 * If we are validating CT, then we MUST accept SCTs served via OCSP
4788 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4792 s->ct_validation_callback = callback;
4793 s->ct_validation_callback_arg = arg;
4798 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4799 ssl_ct_validation_cb callback, void *arg)
4802 * Since code exists that uses the custom extension handler for CT, look for
4803 * this and throw an error if they have already registered to use CT.
4805 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4806 TLSEXT_TYPE_signed_certificate_timestamp))
4808 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4809 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4813 ctx->ct_validation_callback = callback;
4814 ctx->ct_validation_callback_arg = arg;
4818 int SSL_ct_is_enabled(const SSL *s)
4820 return s->ct_validation_callback != NULL;
4823 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4825 return ctx->ct_validation_callback != NULL;
4828 int ssl_validate_ct(SSL *s)
4831 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4833 SSL_DANE *dane = &s->dane;
4834 CT_POLICY_EVAL_CTX *ctx = NULL;
4835 const STACK_OF(SCT) *scts;
4838 * If no callback is set, the peer is anonymous, or its chain is invalid,
4839 * skip SCT validation - just return success. Applications that continue
4840 * handshakes without certificates, with unverified chains, or pinned leaf
4841 * certificates are outside the scope of the WebPKI and CT.
4843 * The above exclusions notwithstanding the vast majority of peers will
4844 * have rather ordinary certificate chains validated by typical
4845 * applications that perform certificate verification and therefore will
4846 * process SCTs when enabled.
4848 if (s->ct_validation_callback == NULL || cert == NULL ||
4849 s->verify_result != X509_V_OK ||
4850 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4854 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4855 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4857 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4858 switch (dane->mtlsa->usage) {
4859 case DANETLS_USAGE_DANE_TA:
4860 case DANETLS_USAGE_DANE_EE:
4865 ctx = CT_POLICY_EVAL_CTX_new();
4867 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4868 ERR_R_MALLOC_FAILURE);
4872 issuer = sk_X509_value(s->verified_chain, 1);
4873 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4874 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4875 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4876 CT_POLICY_EVAL_CTX_set_time(
4877 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4879 scts = SSL_get0_peer_scts(s);
4882 * This function returns success (> 0) only when all the SCTs are valid, 0
4883 * when some are invalid, and < 0 on various internal errors (out of
4884 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4885 * reason to abort the handshake, that decision is up to the callback.
4886 * Therefore, we error out only in the unexpected case that the return
4887 * value is negative.
4889 * XXX: One might well argue that the return value of this function is an
4890 * unfortunate design choice. Its job is only to determine the validation
4891 * status of each of the provided SCTs. So long as it correctly separates
4892 * the wheat from the chaff it should return success. Failure in this case
4893 * ought to correspond to an inability to carry out its duties.
4895 if (SCT_LIST_validate(scts, ctx) < 0) {
4896 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4897 SSL_R_SCT_VERIFICATION_FAILED);
4901 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4903 ret = 0; /* This function returns 0 on failure */
4905 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4906 SSL_R_CALLBACK_FAILED);
4909 CT_POLICY_EVAL_CTX_free(ctx);
4911 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4912 * failure return code here. Also the application may wish the complete
4913 * the handshake, and then disconnect cleanly at a higher layer, after
4914 * checking the verification status of the completed connection.
4916 * We therefore force a certificate verification failure which will be
4917 * visible via SSL_get_verify_result() and cached as part of any resumed
4920 * Note: the permissive callback is for information gathering only, always
4921 * returns success, and does not affect verification status. Only the
4922 * strict callback or a custom application-specified callback can trigger
4923 * connection failure or record a verification error.
4926 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4930 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4932 switch (validation_mode) {
4934 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4936 case SSL_CT_VALIDATION_PERMISSIVE:
4937 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4938 case SSL_CT_VALIDATION_STRICT:
4939 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4943 int SSL_enable_ct(SSL *s, int validation_mode)
4945 switch (validation_mode) {
4947 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4949 case SSL_CT_VALIDATION_PERMISSIVE:
4950 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4951 case SSL_CT_VALIDATION_STRICT:
4952 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4956 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4958 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4961 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4963 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4966 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4968 CTLOG_STORE_free(ctx->ctlog_store);
4969 ctx->ctlog_store = logs;
4972 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4974 return ctx->ctlog_store;
4977 #endif /* OPENSSL_NO_CT */
4979 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4982 c->client_hello_cb = cb;
4983 c->client_hello_cb_arg = arg;
4986 int SSL_client_hello_isv2(SSL *s)
4988 if (s->clienthello == NULL)
4990 return s->clienthello->isv2;
4993 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4995 if (s->clienthello == NULL)
4997 return s->clienthello->legacy_version;
5000 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
5002 if (s->clienthello == NULL)
5005 *out = s->clienthello->random;
5006 return SSL3_RANDOM_SIZE;
5009 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
5011 if (s->clienthello == NULL)
5014 *out = s->clienthello->session_id;
5015 return s->clienthello->session_id_len;
5018 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
5020 if (s->clienthello == NULL)
5023 *out = PACKET_data(&s->clienthello->ciphersuites);
5024 return PACKET_remaining(&s->clienthello->ciphersuites);
5027 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
5029 if (s->clienthello == NULL)
5032 *out = s->clienthello->compressions;
5033 return s->clienthello->compressions_len;
5036 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5042 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5044 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5045 ext = s->clienthello->pre_proc_exts + i;
5049 present = OPENSSL_malloc(sizeof(*present) * num);
5050 if (present == NULL)
5052 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5053 ext = s->clienthello->pre_proc_exts + i;
5055 if (ext->received_order >= num)
5057 present[ext->received_order] = ext->type;
5064 OPENSSL_free(present);
5068 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5074 if (s->clienthello == NULL)
5076 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5077 r = s->clienthello->pre_proc_exts + i;
5078 if (r->present && r->type == type) {
5080 *out = PACKET_data(&r->data);
5082 *outlen = PACKET_remaining(&r->data);
5089 int SSL_free_buffers(SSL *ssl)
5091 RECORD_LAYER *rl = &ssl->rlayer;
5093 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5096 RECORD_LAYER_release(rl);
5100 int SSL_alloc_buffers(SSL *ssl)
5102 return ssl3_setup_buffers(ssl);
5105 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5107 ctx->keylog_callback = cb;
5110 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5112 return ctx->keylog_callback;
5115 static int nss_keylog_int(const char *prefix,
5117 const uint8_t *parameter_1,
5118 size_t parameter_1_len,
5119 const uint8_t *parameter_2,
5120 size_t parameter_2_len)
5123 char *cursor = NULL;
5128 if (ssl->ctx->keylog_callback == NULL) return 1;
5131 * Our output buffer will contain the following strings, rendered with
5132 * space characters in between, terminated by a NULL character: first the
5133 * prefix, then the first parameter, then the second parameter. The
5134 * meaning of each parameter depends on the specific key material being
5135 * logged. Note that the first and second parameters are encoded in
5136 * hexadecimal, so we need a buffer that is twice their lengths.
5138 prefix_len = strlen(prefix);
5139 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
5140 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5141 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5142 ERR_R_MALLOC_FAILURE);
5146 strcpy(cursor, prefix);
5147 cursor += prefix_len;
5150 for (i = 0; i < parameter_1_len; i++) {
5151 sprintf(cursor, "%02x", parameter_1[i]);
5156 for (i = 0; i < parameter_2_len; i++) {
5157 sprintf(cursor, "%02x", parameter_2[i]);
5162 ssl->ctx->keylog_callback(ssl, (const char *)out);
5168 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5169 const uint8_t *encrypted_premaster,
5170 size_t encrypted_premaster_len,
5171 const uint8_t *premaster,
5172 size_t premaster_len)
5174 if (encrypted_premaster_len < 8) {
5175 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5176 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5180 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5181 return nss_keylog_int("RSA",
5183 encrypted_premaster,
5189 int ssl_log_secret(SSL *ssl,
5191 const uint8_t *secret,
5194 return nss_keylog_int(label,
5196 ssl->s3->client_random,
5202 #define SSLV2_CIPHER_LEN 3
5204 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5208 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5210 if (PACKET_remaining(cipher_suites) == 0) {
5211 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5212 SSL_R_NO_CIPHERS_SPECIFIED);
5216 if (PACKET_remaining(cipher_suites) % n != 0) {
5217 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5218 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5222 OPENSSL_free(s->s3->tmp.ciphers_raw);
5223 s->s3->tmp.ciphers_raw = NULL;
5224 s->s3->tmp.ciphers_rawlen = 0;
5227 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5228 PACKET sslv2ciphers = *cipher_suites;
5229 unsigned int leadbyte;
5233 * We store the raw ciphers list in SSLv3+ format so we need to do some
5234 * preprocessing to convert the list first. If there are any SSLv2 only
5235 * ciphersuites with a non-zero leading byte then we are going to
5236 * slightly over allocate because we won't store those. But that isn't a
5239 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5240 s->s3->tmp.ciphers_raw = raw;
5242 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5243 ERR_R_MALLOC_FAILURE);
5246 for (s->s3->tmp.ciphers_rawlen = 0;
5247 PACKET_remaining(&sslv2ciphers) > 0;
5248 raw += TLS_CIPHER_LEN) {
5249 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5251 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5254 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5255 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5257 OPENSSL_free(s->s3->tmp.ciphers_raw);
5258 s->s3->tmp.ciphers_raw = NULL;
5259 s->s3->tmp.ciphers_rawlen = 0;
5263 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5265 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5266 &s->s3->tmp.ciphers_rawlen)) {
5267 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5268 ERR_R_INTERNAL_ERROR);
5274 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5275 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5276 STACK_OF(SSL_CIPHER) **scsvs)
5280 if (!PACKET_buf_init(&pkt, bytes, len))
5282 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5285 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5286 STACK_OF(SSL_CIPHER) **skp,
5287 STACK_OF(SSL_CIPHER) **scsvs_out,
5288 int sslv2format, int fatal)
5290 const SSL_CIPHER *c;
5291 STACK_OF(SSL_CIPHER) *sk = NULL;
5292 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5294 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5295 unsigned char cipher[SSLV2_CIPHER_LEN];
5297 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5299 if (PACKET_remaining(cipher_suites) == 0) {
5301 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5302 SSL_R_NO_CIPHERS_SPECIFIED);
5304 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5308 if (PACKET_remaining(cipher_suites) % n != 0) {
5310 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5311 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5313 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5314 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5318 sk = sk_SSL_CIPHER_new_null();
5319 scsvs = sk_SSL_CIPHER_new_null();
5320 if (sk == NULL || scsvs == NULL) {
5322 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5323 ERR_R_MALLOC_FAILURE);
5325 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5329 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5331 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5332 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5333 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5335 if (sslv2format && cipher[0] != '\0')
5338 /* For SSLv2-compat, ignore leading 0-byte. */
5339 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5341 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5342 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5344 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5345 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5347 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5352 if (PACKET_remaining(cipher_suites) > 0) {
5354 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5357 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5364 sk_SSL_CIPHER_free(sk);
5365 if (scsvs_out != NULL)
5368 sk_SSL_CIPHER_free(scsvs);
5371 sk_SSL_CIPHER_free(sk);
5372 sk_SSL_CIPHER_free(scsvs);
5376 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5378 ctx->max_early_data = max_early_data;
5383 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5385 return ctx->max_early_data;
5388 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5390 s->max_early_data = max_early_data;
5395 uint32_t SSL_get_max_early_data(const SSL *s)
5397 return s->max_early_data;
5400 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5402 /* Return any active Max Fragment Len extension */
5403 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5404 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5406 /* return current SSL connection setting */
5407 return ssl->max_send_fragment;
5410 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5412 /* Return a value regarding an active Max Fragment Len extension */
5413 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5414 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5415 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5417 /* else limit |split_send_fragment| to current |max_send_fragment| */
5418 if (ssl->split_send_fragment > ssl->max_send_fragment)
5419 return ssl->max_send_fragment;
5421 /* return current SSL connection setting */
5422 return ssl->split_send_fragment;
5425 int SSL_stateless(SSL *s)
5429 /* Ensure there is no state left over from a previous invocation */
5435 s->s3->flags |= TLS1_FLAGS_STATELESS;
5436 ret = SSL_accept(s);
5437 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5439 if (ret > 0 && s->ext.cookieok)
5442 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5448 void SSL_force_post_handshake_auth(SSL *ssl)
5450 ssl->pha_forced = 1;
5453 int SSL_verify_client_post_handshake(SSL *ssl)
5455 if (!SSL_IS_TLS13(ssl)) {
5456 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5460 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5464 if (!SSL_is_init_finished(ssl)) {
5465 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5469 switch (ssl->post_handshake_auth) {
5471 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5474 case SSL_PHA_EXT_SENT:
5475 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5477 case SSL_PHA_EXT_RECEIVED:
5479 case SSL_PHA_REQUEST_PENDING:
5480 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5482 case SSL_PHA_REQUESTED:
5483 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5487 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5489 /* checks verify_mode and algorithm_auth */
5490 if (!send_certificate_request(ssl)) {
5491 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5492 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5496 ossl_statem_set_in_init(ssl, 1);
5500 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5501 SSL_CTX_generate_session_ticket_fn gen_cb,
5502 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5505 ctx->generate_ticket_cb = gen_cb;
5506 ctx->decrypt_ticket_cb = dec_cb;
5507 ctx->ticket_cb_data = arg;