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;
600 if (s->renegotiate) {
601 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
605 ossl_statem_clear(s);
607 s->version = s->method->version;
608 s->client_version = s->version;
609 s->rwstate = SSL_NOTHING;
611 BUF_MEM_free(s->init_buf);
616 s->key_update = SSL_KEY_UPDATE_NONE;
618 EVP_MD_CTX_free(s->pha_dgst);
621 /* Reset DANE verification result state */
624 X509_free(s->dane.mcert);
625 s->dane.mcert = NULL;
626 s->dane.mtlsa = NULL;
628 /* Clear the verification result peername */
629 X509_VERIFY_PARAM_move_peername(s->param, NULL);
632 * Check to see if we were changed into a different method, if so, revert
635 if (s->method != s->ctx->method) {
636 s->method->ssl_free(s);
637 s->method = s->ctx->method;
638 if (!s->method->ssl_new(s))
641 if (!s->method->ssl_clear(s))
645 RECORD_LAYER_clear(&s->rlayer);
650 /** Used to change an SSL_CTXs default SSL method type */
651 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
653 STACK_OF(SSL_CIPHER) *sk;
657 if (!SSL_CTX_set_ciphersuites(ctx, TLS_DEFAULT_CIPHERSUITES)) {
658 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
661 sk = ssl_create_cipher_list(ctx->method,
662 ctx->tls13_ciphersuites,
664 &(ctx->cipher_list_by_id),
665 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
666 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
667 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
673 SSL *SSL_new(SSL_CTX *ctx)
678 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
681 if (ctx->method == NULL) {
682 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
686 s = OPENSSL_zalloc(sizeof(*s));
691 s->lock = CRYPTO_THREAD_lock_new();
692 if (s->lock == NULL) {
698 RECORD_LAYER_init(&s->rlayer, s);
700 s->options = ctx->options;
701 s->dane.flags = ctx->dane.flags;
702 s->min_proto_version = ctx->min_proto_version;
703 s->max_proto_version = ctx->max_proto_version;
705 s->max_cert_list = ctx->max_cert_list;
706 s->max_early_data = ctx->max_early_data;
707 s->recv_max_early_data = ctx->recv_max_early_data;
708 s->num_tickets = ctx->num_tickets;
709 s->pha_enabled = ctx->pha_enabled;
711 /* Shallow copy of the ciphersuites stack */
712 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
713 if (s->tls13_ciphersuites == NULL)
717 * Earlier library versions used to copy the pointer to the CERT, not
718 * its contents; only when setting new parameters for the per-SSL
719 * copy, ssl_cert_new would be called (and the direct reference to
720 * the per-SSL_CTX settings would be lost, but those still were
721 * indirectly accessed for various purposes, and for that reason they
722 * used to be known as s->ctx->default_cert). Now we don't look at the
723 * SSL_CTX's CERT after having duplicated it once.
725 s->cert = ssl_cert_dup(ctx->cert);
729 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
730 s->msg_callback = ctx->msg_callback;
731 s->msg_callback_arg = ctx->msg_callback_arg;
732 s->verify_mode = ctx->verify_mode;
733 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
734 s->record_padding_cb = ctx->record_padding_cb;
735 s->record_padding_arg = ctx->record_padding_arg;
736 s->block_padding = ctx->block_padding;
737 s->sid_ctx_length = ctx->sid_ctx_length;
738 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
740 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
741 s->verify_callback = ctx->default_verify_callback;
742 s->generate_session_id = ctx->generate_session_id;
744 s->param = X509_VERIFY_PARAM_new();
745 if (s->param == NULL)
747 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
748 s->quiet_shutdown = ctx->quiet_shutdown;
750 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
751 s->max_send_fragment = ctx->max_send_fragment;
752 s->split_send_fragment = ctx->split_send_fragment;
753 s->max_pipelines = ctx->max_pipelines;
754 if (s->max_pipelines > 1)
755 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
756 if (ctx->default_read_buf_len > 0)
757 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
762 s->ext.debug_arg = NULL;
763 s->ext.ticket_expected = 0;
764 s->ext.status_type = ctx->ext.status_type;
765 s->ext.status_expected = 0;
766 s->ext.ocsp.ids = NULL;
767 s->ext.ocsp.exts = NULL;
768 s->ext.ocsp.resp = NULL;
769 s->ext.ocsp.resp_len = 0;
771 s->session_ctx = ctx;
772 #ifndef OPENSSL_NO_EC
773 if (ctx->ext.ecpointformats) {
774 s->ext.ecpointformats =
775 OPENSSL_memdup(ctx->ext.ecpointformats,
776 ctx->ext.ecpointformats_len);
777 if (!s->ext.ecpointformats)
779 s->ext.ecpointformats_len =
780 ctx->ext.ecpointformats_len;
782 if (ctx->ext.supportedgroups) {
783 s->ext.supportedgroups =
784 OPENSSL_memdup(ctx->ext.supportedgroups,
785 ctx->ext.supportedgroups_len
786 * sizeof(*ctx->ext.supportedgroups));
787 if (!s->ext.supportedgroups)
789 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
792 #ifndef OPENSSL_NO_NEXTPROTONEG
796 if (s->ctx->ext.alpn) {
797 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
798 if (s->ext.alpn == NULL)
800 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
801 s->ext.alpn_len = s->ctx->ext.alpn_len;
804 s->verified_chain = NULL;
805 s->verify_result = X509_V_OK;
807 s->default_passwd_callback = ctx->default_passwd_callback;
808 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
810 s->method = ctx->method;
812 s->key_update = SSL_KEY_UPDATE_NONE;
814 s->allow_early_data_cb = ctx->allow_early_data_cb;
815 s->allow_early_data_cb_data = ctx->allow_early_data_cb_data;
817 if (!s->method->ssl_new(s))
820 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
825 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
828 #ifndef OPENSSL_NO_PSK
829 s->psk_client_callback = ctx->psk_client_callback;
830 s->psk_server_callback = ctx->psk_server_callback;
832 s->psk_find_session_cb = ctx->psk_find_session_cb;
833 s->psk_use_session_cb = ctx->psk_use_session_cb;
837 #ifndef OPENSSL_NO_CT
838 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
839 ctx->ct_validation_callback_arg))
846 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
850 int SSL_is_dtls(const SSL *s)
852 return SSL_IS_DTLS(s) ? 1 : 0;
855 int SSL_up_ref(SSL *s)
859 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
862 REF_PRINT_COUNT("SSL", s);
863 REF_ASSERT_ISNT(i < 2);
864 return ((i > 1) ? 1 : 0);
867 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
868 unsigned int sid_ctx_len)
870 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
871 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
872 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
875 ctx->sid_ctx_length = sid_ctx_len;
876 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
881 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
882 unsigned int sid_ctx_len)
884 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
885 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
886 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
889 ssl->sid_ctx_length = sid_ctx_len;
890 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
895 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
897 CRYPTO_THREAD_write_lock(ctx->lock);
898 ctx->generate_session_id = cb;
899 CRYPTO_THREAD_unlock(ctx->lock);
903 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
905 CRYPTO_THREAD_write_lock(ssl->lock);
906 ssl->generate_session_id = cb;
907 CRYPTO_THREAD_unlock(ssl->lock);
911 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
915 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
916 * we can "construct" a session to give us the desired check - i.e. to
917 * find if there's a session in the hash table that would conflict with
918 * any new session built out of this id/id_len and the ssl_version in use
923 if (id_len > sizeof(r.session_id))
926 r.ssl_version = ssl->version;
927 r.session_id_length = id_len;
928 memcpy(r.session_id, id, id_len);
930 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
931 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
932 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
936 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
938 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
941 int SSL_set_purpose(SSL *s, int purpose)
943 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
946 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
948 return X509_VERIFY_PARAM_set_trust(s->param, trust);
951 int SSL_set_trust(SSL *s, int trust)
953 return X509_VERIFY_PARAM_set_trust(s->param, trust);
956 int SSL_set1_host(SSL *s, const char *hostname)
958 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
961 int SSL_add1_host(SSL *s, const char *hostname)
963 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
966 void SSL_set_hostflags(SSL *s, unsigned int flags)
968 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
971 const char *SSL_get0_peername(SSL *s)
973 return X509_VERIFY_PARAM_get0_peername(s->param);
976 int SSL_CTX_dane_enable(SSL_CTX *ctx)
978 return dane_ctx_enable(&ctx->dane);
981 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
983 unsigned long orig = ctx->dane.flags;
985 ctx->dane.flags |= flags;
989 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
991 unsigned long orig = ctx->dane.flags;
993 ctx->dane.flags &= ~flags;
997 int SSL_dane_enable(SSL *s, const char *basedomain)
999 SSL_DANE *dane = &s->dane;
1001 if (s->ctx->dane.mdmax == 0) {
1002 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
1005 if (dane->trecs != NULL) {
1006 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1011 * Default SNI name. This rejects empty names, while set1_host below
1012 * accepts them and disables host name checks. To avoid side-effects with
1013 * invalid input, set the SNI name first.
1015 if (s->ext.hostname == NULL) {
1016 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1017 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1022 /* Primary RFC6125 reference identifier */
1023 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1024 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1030 dane->dctx = &s->ctx->dane;
1031 dane->trecs = sk_danetls_record_new_null();
1033 if (dane->trecs == NULL) {
1034 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1040 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1042 unsigned long orig = ssl->dane.flags;
1044 ssl->dane.flags |= flags;
1048 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1050 unsigned long orig = ssl->dane.flags;
1052 ssl->dane.flags &= ~flags;
1056 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1058 SSL_DANE *dane = &s->dane;
1060 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1064 *mcert = dane->mcert;
1066 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1071 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1072 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1074 SSL_DANE *dane = &s->dane;
1076 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1080 *usage = dane->mtlsa->usage;
1082 *selector = dane->mtlsa->selector;
1084 *mtype = dane->mtlsa->mtype;
1086 *data = dane->mtlsa->data;
1088 *dlen = dane->mtlsa->dlen;
1093 SSL_DANE *SSL_get0_dane(SSL *s)
1098 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1099 uint8_t mtype, unsigned const char *data, size_t dlen)
1101 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1104 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1107 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1110 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1112 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1115 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1117 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1120 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1125 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1130 void SSL_certs_clear(SSL *s)
1132 ssl_cert_clear_certs(s->cert);
1135 void SSL_free(SSL *s)
1141 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1142 REF_PRINT_COUNT("SSL", s);
1145 REF_ASSERT_ISNT(i < 0);
1147 X509_VERIFY_PARAM_free(s->param);
1148 dane_final(&s->dane);
1149 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1151 /* Ignore return value */
1152 ssl_free_wbio_buffer(s);
1154 BIO_free_all(s->wbio);
1155 BIO_free_all(s->rbio);
1157 BUF_MEM_free(s->init_buf);
1159 /* add extra stuff */
1160 sk_SSL_CIPHER_free(s->cipher_list);
1161 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1162 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1164 /* Make the next call work :-) */
1165 if (s->session != NULL) {
1166 ssl_clear_bad_session(s);
1167 SSL_SESSION_free(s->session);
1169 SSL_SESSION_free(s->psksession);
1170 OPENSSL_free(s->psksession_id);
1174 ssl_cert_free(s->cert);
1175 /* Free up if allocated */
1177 OPENSSL_free(s->ext.hostname);
1178 SSL_CTX_free(s->session_ctx);
1179 #ifndef OPENSSL_NO_EC
1180 OPENSSL_free(s->ext.ecpointformats);
1181 OPENSSL_free(s->ext.supportedgroups);
1182 #endif /* OPENSSL_NO_EC */
1183 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1184 #ifndef OPENSSL_NO_OCSP
1185 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1187 #ifndef OPENSSL_NO_CT
1188 SCT_LIST_free(s->scts);
1189 OPENSSL_free(s->ext.scts);
1191 OPENSSL_free(s->ext.ocsp.resp);
1192 OPENSSL_free(s->ext.alpn);
1193 OPENSSL_free(s->ext.tls13_cookie);
1194 OPENSSL_free(s->clienthello);
1195 OPENSSL_free(s->pha_context);
1196 EVP_MD_CTX_free(s->pha_dgst);
1198 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1199 sk_X509_NAME_pop_free(s->client_ca_names, X509_NAME_free);
1201 sk_X509_pop_free(s->verified_chain, X509_free);
1203 if (s->method != NULL)
1204 s->method->ssl_free(s);
1206 RECORD_LAYER_release(&s->rlayer);
1208 SSL_CTX_free(s->ctx);
1210 ASYNC_WAIT_CTX_free(s->waitctx);
1212 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1213 OPENSSL_free(s->ext.npn);
1216 #ifndef OPENSSL_NO_SRTP
1217 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1220 CRYPTO_THREAD_lock_free(s->lock);
1225 void SSL_set0_rbio(SSL *s, BIO *rbio)
1227 BIO_free_all(s->rbio);
1231 void SSL_set0_wbio(SSL *s, BIO *wbio)
1234 * If the output buffering BIO is still in place, remove it
1236 if (s->bbio != NULL)
1237 s->wbio = BIO_pop(s->wbio);
1239 BIO_free_all(s->wbio);
1242 /* Re-attach |bbio| to the new |wbio|. */
1243 if (s->bbio != NULL)
1244 s->wbio = BIO_push(s->bbio, s->wbio);
1247 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1250 * For historical reasons, this function has many different cases in
1251 * ownership handling.
1254 /* If nothing has changed, do nothing */
1255 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1259 * If the two arguments are equal then one fewer reference is granted by the
1260 * caller than we want to take
1262 if (rbio != NULL && rbio == wbio)
1266 * If only the wbio is changed only adopt one reference.
1268 if (rbio == SSL_get_rbio(s)) {
1269 SSL_set0_wbio(s, wbio);
1273 * There is an asymmetry here for historical reasons. If only the rbio is
1274 * changed AND the rbio and wbio were originally different, then we only
1275 * adopt one reference.
1277 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1278 SSL_set0_rbio(s, rbio);
1282 /* Otherwise, adopt both references. */
1283 SSL_set0_rbio(s, rbio);
1284 SSL_set0_wbio(s, wbio);
1287 BIO *SSL_get_rbio(const SSL *s)
1292 BIO *SSL_get_wbio(const SSL *s)
1294 if (s->bbio != NULL) {
1296 * If |bbio| is active, the true caller-configured BIO is its
1299 return BIO_next(s->bbio);
1304 int SSL_get_fd(const SSL *s)
1306 return SSL_get_rfd(s);
1309 int SSL_get_rfd(const SSL *s)
1314 b = SSL_get_rbio(s);
1315 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1317 BIO_get_fd(r, &ret);
1321 int SSL_get_wfd(const SSL *s)
1326 b = SSL_get_wbio(s);
1327 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1329 BIO_get_fd(r, &ret);
1333 #ifndef OPENSSL_NO_SOCK
1334 int SSL_set_fd(SSL *s, int fd)
1339 bio = BIO_new(BIO_s_socket());
1342 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1345 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1346 SSL_set_bio(s, bio, bio);
1352 int SSL_set_wfd(SSL *s, int fd)
1354 BIO *rbio = SSL_get_rbio(s);
1356 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1357 || (int)BIO_get_fd(rbio, NULL) != fd) {
1358 BIO *bio = BIO_new(BIO_s_socket());
1361 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1364 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1365 SSL_set0_wbio(s, bio);
1368 SSL_set0_wbio(s, rbio);
1373 int SSL_set_rfd(SSL *s, int fd)
1375 BIO *wbio = SSL_get_wbio(s);
1377 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1378 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1379 BIO *bio = BIO_new(BIO_s_socket());
1382 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1385 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1386 SSL_set0_rbio(s, bio);
1389 SSL_set0_rbio(s, wbio);
1396 /* return length of latest Finished message we sent, copy to 'buf' */
1397 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1401 if (s->s3 != NULL) {
1402 ret = s->s3->tmp.finish_md_len;
1405 memcpy(buf, s->s3->tmp.finish_md, count);
1410 /* return length of latest Finished message we expected, copy to 'buf' */
1411 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1415 if (s->s3 != NULL) {
1416 ret = s->s3->tmp.peer_finish_md_len;
1419 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1424 int SSL_get_verify_mode(const SSL *s)
1426 return s->verify_mode;
1429 int SSL_get_verify_depth(const SSL *s)
1431 return X509_VERIFY_PARAM_get_depth(s->param);
1434 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1435 return s->verify_callback;
1438 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1440 return ctx->verify_mode;
1443 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1445 return X509_VERIFY_PARAM_get_depth(ctx->param);
1448 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1449 return ctx->default_verify_callback;
1452 void SSL_set_verify(SSL *s, int mode,
1453 int (*callback) (int ok, X509_STORE_CTX *ctx))
1455 s->verify_mode = mode;
1456 if (callback != NULL)
1457 s->verify_callback = callback;
1460 void SSL_set_verify_depth(SSL *s, int depth)
1462 X509_VERIFY_PARAM_set_depth(s->param, depth);
1465 void SSL_set_read_ahead(SSL *s, int yes)
1467 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1470 int SSL_get_read_ahead(const SSL *s)
1472 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1475 int SSL_pending(const SSL *s)
1477 size_t pending = s->method->ssl_pending(s);
1480 * SSL_pending cannot work properly if read-ahead is enabled
1481 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1482 * impossible to fix since SSL_pending cannot report errors that may be
1483 * observed while scanning the new data. (Note that SSL_pending() is
1484 * often used as a boolean value, so we'd better not return -1.)
1486 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1487 * we just return INT_MAX.
1489 return pending < INT_MAX ? (int)pending : INT_MAX;
1492 int SSL_has_pending(const SSL *s)
1495 * Similar to SSL_pending() but returns a 1 to indicate that we have
1496 * unprocessed data available or 0 otherwise (as opposed to the number of
1497 * bytes available). Unlike SSL_pending() this will take into account
1498 * read_ahead data. A 1 return simply indicates that we have unprocessed
1499 * data. That data may not result in any application data, or we may fail
1500 * to parse the records for some reason.
1502 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1505 return RECORD_LAYER_read_pending(&s->rlayer);
1508 X509 *SSL_get_peer_certificate(const SSL *s)
1512 if ((s == NULL) || (s->session == NULL))
1515 r = s->session->peer;
1525 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1529 if ((s == NULL) || (s->session == NULL))
1532 r = s->session->peer_chain;
1535 * If we are a client, cert_chain includes the peer's own certificate; if
1536 * we are a server, it does not.
1543 * Now in theory, since the calling process own 't' it should be safe to
1544 * modify. We need to be able to read f without being hassled
1546 int SSL_copy_session_id(SSL *t, const SSL *f)
1549 /* Do we need to to SSL locking? */
1550 if (!SSL_set_session(t, SSL_get_session(f))) {
1555 * what if we are setup for one protocol version but want to talk another
1557 if (t->method != f->method) {
1558 t->method->ssl_free(t);
1559 t->method = f->method;
1560 if (t->method->ssl_new(t) == 0)
1564 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1565 ssl_cert_free(t->cert);
1567 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1574 /* Fix this so it checks all the valid key/cert options */
1575 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1577 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1578 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1581 if (ctx->cert->key->privatekey == NULL) {
1582 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1585 return X509_check_private_key
1586 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1589 /* Fix this function so that it takes an optional type parameter */
1590 int SSL_check_private_key(const SSL *ssl)
1593 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1596 if (ssl->cert->key->x509 == NULL) {
1597 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1600 if (ssl->cert->key->privatekey == NULL) {
1601 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1604 return X509_check_private_key(ssl->cert->key->x509,
1605 ssl->cert->key->privatekey);
1608 int SSL_waiting_for_async(SSL *s)
1616 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1618 ASYNC_WAIT_CTX *ctx = s->waitctx;
1622 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1625 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1626 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1628 ASYNC_WAIT_CTX *ctx = s->waitctx;
1632 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1636 int SSL_accept(SSL *s)
1638 if (s->handshake_func == NULL) {
1639 /* Not properly initialized yet */
1640 SSL_set_accept_state(s);
1643 return SSL_do_handshake(s);
1646 int SSL_connect(SSL *s)
1648 if (s->handshake_func == NULL) {
1649 /* Not properly initialized yet */
1650 SSL_set_connect_state(s);
1653 return SSL_do_handshake(s);
1656 long SSL_get_default_timeout(const SSL *s)
1658 return s->method->get_timeout();
1661 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1662 int (*func) (void *))
1665 if (s->waitctx == NULL) {
1666 s->waitctx = ASYNC_WAIT_CTX_new();
1667 if (s->waitctx == NULL)
1670 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1671 sizeof(struct ssl_async_args))) {
1673 s->rwstate = SSL_NOTHING;
1674 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1677 s->rwstate = SSL_ASYNC_PAUSED;
1680 s->rwstate = SSL_ASYNC_NO_JOBS;
1686 s->rwstate = SSL_NOTHING;
1687 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1688 /* Shouldn't happen */
1693 static int ssl_io_intern(void *vargs)
1695 struct ssl_async_args *args;
1700 args = (struct ssl_async_args *)vargs;
1704 switch (args->type) {
1706 return args->f.func_read(s, buf, num, &s->asyncrw);
1708 return args->f.func_write(s, buf, num, &s->asyncrw);
1710 return args->f.func_other(s);
1715 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1717 if (s->handshake_func == NULL) {
1718 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1722 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1723 s->rwstate = SSL_NOTHING;
1727 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1728 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1729 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1733 * If we are a client and haven't received the ServerHello etc then we
1736 ossl_statem_check_finish_init(s, 0);
1738 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1739 struct ssl_async_args args;
1745 args.type = READFUNC;
1746 args.f.func_read = s->method->ssl_read;
1748 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1749 *readbytes = s->asyncrw;
1752 return s->method->ssl_read(s, buf, num, readbytes);
1756 int SSL_read(SSL *s, void *buf, int num)
1762 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1766 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1769 * The cast is safe here because ret should be <= INT_MAX because num is
1773 ret = (int)readbytes;
1778 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1780 int ret = ssl_read_internal(s, buf, num, readbytes);
1787 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1792 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1793 return SSL_READ_EARLY_DATA_ERROR;
1796 switch (s->early_data_state) {
1797 case SSL_EARLY_DATA_NONE:
1798 if (!SSL_in_before(s)) {
1799 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1800 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1801 return SSL_READ_EARLY_DATA_ERROR;
1805 case SSL_EARLY_DATA_ACCEPT_RETRY:
1806 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1807 ret = SSL_accept(s);
1810 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1811 return SSL_READ_EARLY_DATA_ERROR;
1815 case SSL_EARLY_DATA_READ_RETRY:
1816 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1817 s->early_data_state = SSL_EARLY_DATA_READING;
1818 ret = SSL_read_ex(s, buf, num, readbytes);
1820 * State machine will update early_data_state to
1821 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1824 if (ret > 0 || (ret <= 0 && s->early_data_state
1825 != SSL_EARLY_DATA_FINISHED_READING)) {
1826 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1827 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1828 : SSL_READ_EARLY_DATA_ERROR;
1831 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1834 return SSL_READ_EARLY_DATA_FINISH;
1837 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1838 return SSL_READ_EARLY_DATA_ERROR;
1842 int SSL_get_early_data_status(const SSL *s)
1844 return s->ext.early_data;
1847 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1849 if (s->handshake_func == NULL) {
1850 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1854 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1857 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1858 struct ssl_async_args args;
1864 args.type = READFUNC;
1865 args.f.func_read = s->method->ssl_peek;
1867 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1868 *readbytes = s->asyncrw;
1871 return s->method->ssl_peek(s, buf, num, readbytes);
1875 int SSL_peek(SSL *s, void *buf, int num)
1881 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1885 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1888 * The cast is safe here because ret should be <= INT_MAX because num is
1892 ret = (int)readbytes;
1898 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1900 int ret = ssl_peek_internal(s, buf, num, readbytes);
1907 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1909 if (s->handshake_func == NULL) {
1910 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1914 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1915 s->rwstate = SSL_NOTHING;
1916 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1920 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1921 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1922 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1923 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1926 /* If we are a client and haven't sent the Finished we better do that */
1927 ossl_statem_check_finish_init(s, 1);
1929 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1931 struct ssl_async_args args;
1934 args.buf = (void *)buf;
1936 args.type = WRITEFUNC;
1937 args.f.func_write = s->method->ssl_write;
1939 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1940 *written = s->asyncrw;
1943 return s->method->ssl_write(s, buf, num, written);
1947 int SSL_write(SSL *s, const void *buf, int num)
1953 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1957 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1960 * The cast is safe here because ret should be <= INT_MAX because num is
1969 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1971 int ret = ssl_write_internal(s, buf, num, written);
1978 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1980 int ret, early_data_state;
1982 uint32_t partialwrite;
1984 switch (s->early_data_state) {
1985 case SSL_EARLY_DATA_NONE:
1987 || !SSL_in_before(s)
1988 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1989 && (s->psk_use_session_cb == NULL))) {
1990 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1991 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1996 case SSL_EARLY_DATA_CONNECT_RETRY:
1997 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1998 ret = SSL_connect(s);
2001 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2006 case SSL_EARLY_DATA_WRITE_RETRY:
2007 s->early_data_state = SSL_EARLY_DATA_WRITING;
2009 * We disable partial write for early data because we don't keep track
2010 * of how many bytes we've written between the SSL_write_ex() call and
2011 * the flush if the flush needs to be retried)
2013 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2014 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2015 ret = SSL_write_ex(s, buf, num, &writtmp);
2016 s->mode |= partialwrite;
2018 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2021 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2024 case SSL_EARLY_DATA_WRITE_FLUSH:
2025 /* The buffering BIO is still in place so we need to flush it */
2026 if (statem_flush(s) != 1)
2029 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2032 case SSL_EARLY_DATA_FINISHED_READING:
2033 case SSL_EARLY_DATA_READ_RETRY:
2034 early_data_state = s->early_data_state;
2035 /* We are a server writing to an unauthenticated client */
2036 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2037 ret = SSL_write_ex(s, buf, num, written);
2038 /* The buffering BIO is still in place */
2040 (void)BIO_flush(s->wbio);
2041 s->early_data_state = early_data_state;
2045 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2050 int SSL_shutdown(SSL *s)
2053 * Note that this function behaves differently from what one might
2054 * expect. Return values are 0 for no success (yet), 1 for success; but
2055 * calling it once is usually not enough, even if blocking I/O is used
2056 * (see ssl3_shutdown).
2059 if (s->handshake_func == NULL) {
2060 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2064 if (!SSL_in_init(s)) {
2065 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2066 struct ssl_async_args args;
2069 args.type = OTHERFUNC;
2070 args.f.func_other = s->method->ssl_shutdown;
2072 return ssl_start_async_job(s, &args, ssl_io_intern);
2074 return s->method->ssl_shutdown(s);
2077 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2082 int SSL_key_update(SSL *s, int updatetype)
2085 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2086 * negotiated, and that it is appropriate to call SSL_key_update() instead
2087 * of SSL_renegotiate().
2089 if (!SSL_IS_TLS13(s)) {
2090 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2094 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2095 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2096 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2100 if (!SSL_is_init_finished(s)) {
2101 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2105 ossl_statem_set_in_init(s, 1);
2106 s->key_update = updatetype;
2110 int SSL_get_key_update_type(SSL *s)
2112 return s->key_update;
2115 int SSL_renegotiate(SSL *s)
2117 if (SSL_IS_TLS13(s)) {
2118 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2122 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2123 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2130 return s->method->ssl_renegotiate(s);
2133 int SSL_renegotiate_abbreviated(SSL *s)
2135 if (SSL_IS_TLS13(s)) {
2136 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2140 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2141 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2148 return s->method->ssl_renegotiate(s);
2151 int SSL_renegotiate_pending(SSL *s)
2154 * becomes true when negotiation is requested; false again once a
2155 * handshake has finished
2157 return (s->renegotiate != 0);
2160 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2165 case SSL_CTRL_GET_READ_AHEAD:
2166 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2167 case SSL_CTRL_SET_READ_AHEAD:
2168 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2169 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2172 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2173 s->msg_callback_arg = parg;
2177 return (s->mode |= larg);
2178 case SSL_CTRL_CLEAR_MODE:
2179 return (s->mode &= ~larg);
2180 case SSL_CTRL_GET_MAX_CERT_LIST:
2181 return (long)s->max_cert_list;
2182 case SSL_CTRL_SET_MAX_CERT_LIST:
2185 l = (long)s->max_cert_list;
2186 s->max_cert_list = (size_t)larg;
2188 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2189 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2191 s->max_send_fragment = larg;
2192 if (s->max_send_fragment < s->split_send_fragment)
2193 s->split_send_fragment = s->max_send_fragment;
2195 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2196 if ((size_t)larg > s->max_send_fragment || larg == 0)
2198 s->split_send_fragment = larg;
2200 case SSL_CTRL_SET_MAX_PIPELINES:
2201 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2203 s->max_pipelines = larg;
2205 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2207 case SSL_CTRL_GET_RI_SUPPORT:
2209 return s->s3->send_connection_binding;
2212 case SSL_CTRL_CERT_FLAGS:
2213 return (s->cert->cert_flags |= larg);
2214 case SSL_CTRL_CLEAR_CERT_FLAGS:
2215 return (s->cert->cert_flags &= ~larg);
2217 case SSL_CTRL_GET_RAW_CIPHERLIST:
2219 if (s->s3->tmp.ciphers_raw == NULL)
2221 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2222 return (int)s->s3->tmp.ciphers_rawlen;
2224 return TLS_CIPHER_LEN;
2226 case SSL_CTRL_GET_EXTMS_SUPPORT:
2227 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2229 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2233 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2234 return ssl_check_allowed_versions(larg, s->max_proto_version)
2235 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2236 &s->min_proto_version);
2237 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2238 return s->min_proto_version;
2239 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2240 return ssl_check_allowed_versions(s->min_proto_version, larg)
2241 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2242 &s->max_proto_version);
2243 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2244 return s->max_proto_version;
2246 return s->method->ssl_ctrl(s, cmd, larg, parg);
2250 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2253 case SSL_CTRL_SET_MSG_CALLBACK:
2254 s->msg_callback = (void (*)
2255 (int write_p, int version, int content_type,
2256 const void *buf, size_t len, SSL *ssl,
2261 return s->method->ssl_callback_ctrl(s, cmd, fp);
2265 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2267 return ctx->sessions;
2270 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2273 /* For some cases with ctx == NULL perform syntax checks */
2276 #ifndef OPENSSL_NO_EC
2277 case SSL_CTRL_SET_GROUPS_LIST:
2278 return tls1_set_groups_list(NULL, NULL, parg);
2280 case SSL_CTRL_SET_SIGALGS_LIST:
2281 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2282 return tls1_set_sigalgs_list(NULL, parg, 0);
2289 case SSL_CTRL_GET_READ_AHEAD:
2290 return ctx->read_ahead;
2291 case SSL_CTRL_SET_READ_AHEAD:
2292 l = ctx->read_ahead;
2293 ctx->read_ahead = larg;
2296 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2297 ctx->msg_callback_arg = parg;
2300 case SSL_CTRL_GET_MAX_CERT_LIST:
2301 return (long)ctx->max_cert_list;
2302 case SSL_CTRL_SET_MAX_CERT_LIST:
2305 l = (long)ctx->max_cert_list;
2306 ctx->max_cert_list = (size_t)larg;
2309 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2312 l = (long)ctx->session_cache_size;
2313 ctx->session_cache_size = (size_t)larg;
2315 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2316 return (long)ctx->session_cache_size;
2317 case SSL_CTRL_SET_SESS_CACHE_MODE:
2318 l = ctx->session_cache_mode;
2319 ctx->session_cache_mode = larg;
2321 case SSL_CTRL_GET_SESS_CACHE_MODE:
2322 return ctx->session_cache_mode;
2324 case SSL_CTRL_SESS_NUMBER:
2325 return lh_SSL_SESSION_num_items(ctx->sessions);
2326 case SSL_CTRL_SESS_CONNECT:
2327 return tsan_load(&ctx->stats.sess_connect);
2328 case SSL_CTRL_SESS_CONNECT_GOOD:
2329 return tsan_load(&ctx->stats.sess_connect_good);
2330 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2331 return tsan_load(&ctx->stats.sess_connect_renegotiate);
2332 case SSL_CTRL_SESS_ACCEPT:
2333 return tsan_load(&ctx->stats.sess_accept);
2334 case SSL_CTRL_SESS_ACCEPT_GOOD:
2335 return tsan_load(&ctx->stats.sess_accept_good);
2336 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2337 return tsan_load(&ctx->stats.sess_accept_renegotiate);
2338 case SSL_CTRL_SESS_HIT:
2339 return tsan_load(&ctx->stats.sess_hit);
2340 case SSL_CTRL_SESS_CB_HIT:
2341 return tsan_load(&ctx->stats.sess_cb_hit);
2342 case SSL_CTRL_SESS_MISSES:
2343 return tsan_load(&ctx->stats.sess_miss);
2344 case SSL_CTRL_SESS_TIMEOUTS:
2345 return tsan_load(&ctx->stats.sess_timeout);
2346 case SSL_CTRL_SESS_CACHE_FULL:
2347 return tsan_load(&ctx->stats.sess_cache_full);
2349 return (ctx->mode |= larg);
2350 case SSL_CTRL_CLEAR_MODE:
2351 return (ctx->mode &= ~larg);
2352 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2353 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2355 ctx->max_send_fragment = larg;
2356 if (ctx->max_send_fragment < ctx->split_send_fragment)
2357 ctx->split_send_fragment = ctx->max_send_fragment;
2359 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2360 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2362 ctx->split_send_fragment = larg;
2364 case SSL_CTRL_SET_MAX_PIPELINES:
2365 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2367 ctx->max_pipelines = larg;
2369 case SSL_CTRL_CERT_FLAGS:
2370 return (ctx->cert->cert_flags |= larg);
2371 case SSL_CTRL_CLEAR_CERT_FLAGS:
2372 return (ctx->cert->cert_flags &= ~larg);
2373 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2374 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2375 && ssl_set_version_bound(ctx->method->version, (int)larg,
2376 &ctx->min_proto_version);
2377 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2378 return ctx->min_proto_version;
2379 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2380 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2381 && ssl_set_version_bound(ctx->method->version, (int)larg,
2382 &ctx->max_proto_version);
2383 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2384 return ctx->max_proto_version;
2386 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2390 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2393 case SSL_CTRL_SET_MSG_CALLBACK:
2394 ctx->msg_callback = (void (*)
2395 (int write_p, int version, int content_type,
2396 const void *buf, size_t len, SSL *ssl,
2401 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2405 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2414 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2415 const SSL_CIPHER *const *bp)
2417 if ((*ap)->id > (*bp)->id)
2419 if ((*ap)->id < (*bp)->id)
2424 /** return a STACK of the ciphers available for the SSL and in order of
2426 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2429 if (s->cipher_list != NULL) {
2430 return s->cipher_list;
2431 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2432 return s->ctx->cipher_list;
2438 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2440 if ((s == NULL) || (s->session == NULL) || !s->server)
2442 return s->session->ciphers;
2445 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2447 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2450 ciphers = SSL_get_ciphers(s);
2453 if (!ssl_set_client_disabled(s))
2455 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2456 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2457 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2459 sk = sk_SSL_CIPHER_new_null();
2462 if (!sk_SSL_CIPHER_push(sk, c)) {
2463 sk_SSL_CIPHER_free(sk);
2471 /** return a STACK of the ciphers available for the SSL and in order of
2473 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2476 if (s->cipher_list_by_id != NULL) {
2477 return s->cipher_list_by_id;
2478 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2479 return s->ctx->cipher_list_by_id;
2485 /** The old interface to get the same thing as SSL_get_ciphers() */
2486 const char *SSL_get_cipher_list(const SSL *s, int n)
2488 const SSL_CIPHER *c;
2489 STACK_OF(SSL_CIPHER) *sk;
2493 sk = SSL_get_ciphers(s);
2494 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2496 c = sk_SSL_CIPHER_value(sk, n);
2502 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2504 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2507 return ctx->cipher_list;
2511 /** specify the ciphers to be used by default by the SSL_CTX */
2512 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2514 STACK_OF(SSL_CIPHER) *sk;
2516 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2517 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2520 * ssl_create_cipher_list may return an empty stack if it was unable to
2521 * find a cipher matching the given rule string (for example if the rule
2522 * string specifies a cipher which has been disabled). This is not an
2523 * error as far as ssl_create_cipher_list is concerned, and hence
2524 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2528 else if (sk_SSL_CIPHER_num(sk) == 0) {
2529 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2535 /** specify the ciphers to be used by the SSL */
2536 int SSL_set_cipher_list(SSL *s, const char *str)
2538 STACK_OF(SSL_CIPHER) *sk;
2540 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2541 &s->cipher_list, &s->cipher_list_by_id, str,
2543 /* see comment in SSL_CTX_set_cipher_list */
2546 else if (sk_SSL_CIPHER_num(sk) == 0) {
2547 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2553 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2556 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2557 const SSL_CIPHER *c;
2561 || s->session == NULL
2562 || s->session->ciphers == NULL
2567 clntsk = s->session->ciphers;
2568 srvrsk = SSL_get_ciphers(s);
2569 if (clntsk == NULL || srvrsk == NULL)
2572 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2575 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2578 c = sk_SSL_CIPHER_value(clntsk, i);
2579 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2582 n = strlen(c->name);
2598 /** return a servername extension value if provided in Client Hello, or NULL.
2599 * So far, only host_name types are defined (RFC 3546).
2602 const char *SSL_get_servername(const SSL *s, const int type)
2604 if (type != TLSEXT_NAMETYPE_host_name)
2608 * SNI is not negotiated in pre-TLS-1.3 resumption flows, so fake up an
2609 * SNI value to return if we are resuming/resumed. N.B. that we still
2610 * call the relevant callbacks for such resumption flows, and callbacks
2611 * might error out if there is not a SNI value available.
2614 return s->session->ext.hostname;
2615 return s->ext.hostname;
2618 int SSL_get_servername_type(const SSL *s)
2621 && (!s->ext.hostname ? s->session->
2622 ext.hostname : s->ext.hostname))
2623 return TLSEXT_NAMETYPE_host_name;
2628 * SSL_select_next_proto implements the standard protocol selection. It is
2629 * expected that this function is called from the callback set by
2630 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2631 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2632 * not included in the length. A byte string of length 0 is invalid. No byte
2633 * string may be truncated. The current, but experimental algorithm for
2634 * selecting the protocol is: 1) If the server doesn't support NPN then this
2635 * is indicated to the callback. In this case, the client application has to
2636 * abort the connection or have a default application level protocol. 2) If
2637 * the server supports NPN, but advertises an empty list then the client
2638 * selects the first protocol in its list, but indicates via the API that this
2639 * fallback case was enacted. 3) Otherwise, the client finds the first
2640 * protocol in the server's list that it supports and selects this protocol.
2641 * This is because it's assumed that the server has better information about
2642 * which protocol a client should use. 4) If the client doesn't support any
2643 * of the server's advertised protocols, then this is treated the same as
2644 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2645 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2647 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2648 const unsigned char *server,
2649 unsigned int server_len,
2650 const unsigned char *client, unsigned int client_len)
2653 const unsigned char *result;
2654 int status = OPENSSL_NPN_UNSUPPORTED;
2657 * For each protocol in server preference order, see if we support it.
2659 for (i = 0; i < server_len;) {
2660 for (j = 0; j < client_len;) {
2661 if (server[i] == client[j] &&
2662 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2663 /* We found a match */
2664 result = &server[i];
2665 status = OPENSSL_NPN_NEGOTIATED;
2675 /* There's no overlap between our protocols and the server's list. */
2677 status = OPENSSL_NPN_NO_OVERLAP;
2680 *out = (unsigned char *)result + 1;
2681 *outlen = result[0];
2685 #ifndef OPENSSL_NO_NEXTPROTONEG
2687 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2688 * client's requested protocol for this connection and returns 0. If the
2689 * client didn't request any protocol, then *data is set to NULL. Note that
2690 * the client can request any protocol it chooses. The value returned from
2691 * this function need not be a member of the list of supported protocols
2692 * provided by the callback.
2694 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2701 *len = (unsigned int)s->ext.npn_len;
2706 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2707 * a TLS server needs a list of supported protocols for Next Protocol
2708 * Negotiation. The returned list must be in wire format. The list is
2709 * returned by setting |out| to point to it and |outlen| to its length. This
2710 * memory will not be modified, but one should assume that the SSL* keeps a
2711 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2712 * wishes to advertise. Otherwise, no such extension will be included in the
2715 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2716 SSL_CTX_npn_advertised_cb_func cb,
2719 ctx->ext.npn_advertised_cb = cb;
2720 ctx->ext.npn_advertised_cb_arg = arg;
2724 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2725 * client needs to select a protocol from the server's provided list. |out|
2726 * must be set to point to the selected protocol (which may be within |in|).
2727 * The length of the protocol name must be written into |outlen|. The
2728 * server's advertised protocols are provided in |in| and |inlen|. The
2729 * callback can assume that |in| is syntactically valid. The client must
2730 * select a protocol. It is fatal to the connection if this callback returns
2731 * a value other than SSL_TLSEXT_ERR_OK.
2733 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2734 SSL_CTX_npn_select_cb_func cb,
2737 ctx->ext.npn_select_cb = cb;
2738 ctx->ext.npn_select_cb_arg = arg;
2743 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2744 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2745 * length-prefixed strings). Returns 0 on success.
2747 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2748 unsigned int protos_len)
2750 OPENSSL_free(ctx->ext.alpn);
2751 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2752 if (ctx->ext.alpn == NULL) {
2753 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2756 ctx->ext.alpn_len = protos_len;
2762 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2763 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2764 * length-prefixed strings). Returns 0 on success.
2766 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2767 unsigned int protos_len)
2769 OPENSSL_free(ssl->ext.alpn);
2770 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2771 if (ssl->ext.alpn == NULL) {
2772 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2775 ssl->ext.alpn_len = protos_len;
2781 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2782 * called during ClientHello processing in order to select an ALPN protocol
2783 * from the client's list of offered protocols.
2785 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2786 SSL_CTX_alpn_select_cb_func cb,
2789 ctx->ext.alpn_select_cb = cb;
2790 ctx->ext.alpn_select_cb_arg = arg;
2794 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2795 * On return it sets |*data| to point to |*len| bytes of protocol name
2796 * (not including the leading length-prefix byte). If the server didn't
2797 * respond with a negotiated protocol then |*len| will be zero.
2799 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2804 *data = ssl->s3->alpn_selected;
2808 *len = (unsigned int)ssl->s3->alpn_selected_len;
2811 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2812 const char *label, size_t llen,
2813 const unsigned char *context, size_t contextlen,
2816 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2819 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2821 contextlen, use_context);
2824 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2825 const char *label, size_t llen,
2826 const unsigned char *context,
2829 if (s->version != TLS1_3_VERSION)
2832 return tls13_export_keying_material_early(s, out, olen, label, llen,
2833 context, contextlen);
2836 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2838 const unsigned char *session_id = a->session_id;
2840 unsigned char tmp_storage[4];
2842 if (a->session_id_length < sizeof(tmp_storage)) {
2843 memset(tmp_storage, 0, sizeof(tmp_storage));
2844 memcpy(tmp_storage, a->session_id, a->session_id_length);
2845 session_id = tmp_storage;
2849 ((unsigned long)session_id[0]) |
2850 ((unsigned long)session_id[1] << 8L) |
2851 ((unsigned long)session_id[2] << 16L) |
2852 ((unsigned long)session_id[3] << 24L);
2857 * NB: If this function (or indeed the hash function which uses a sort of
2858 * coarser function than this one) is changed, ensure
2859 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2860 * being able to construct an SSL_SESSION that will collide with any existing
2861 * session with a matching session ID.
2863 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2865 if (a->ssl_version != b->ssl_version)
2867 if (a->session_id_length != b->session_id_length)
2869 return memcmp(a->session_id, b->session_id, a->session_id_length);
2873 * These wrapper functions should remain rather than redeclaring
2874 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2875 * variable. The reason is that the functions aren't static, they're exposed
2879 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2881 SSL_CTX *ret = NULL;
2884 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2888 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2891 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2892 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2895 ret = OPENSSL_zalloc(sizeof(*ret));
2900 ret->min_proto_version = 0;
2901 ret->max_proto_version = 0;
2902 ret->mode = SSL_MODE_AUTO_RETRY;
2903 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2904 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2905 /* We take the system default. */
2906 ret->session_timeout = meth->get_timeout();
2907 ret->references = 1;
2908 ret->lock = CRYPTO_THREAD_lock_new();
2909 if (ret->lock == NULL) {
2910 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2914 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2915 ret->verify_mode = SSL_VERIFY_NONE;
2916 if ((ret->cert = ssl_cert_new()) == NULL)
2919 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2920 if (ret->sessions == NULL)
2922 ret->cert_store = X509_STORE_new();
2923 if (ret->cert_store == NULL)
2925 #ifndef OPENSSL_NO_CT
2926 ret->ctlog_store = CTLOG_STORE_new();
2927 if (ret->ctlog_store == NULL)
2931 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
2934 if (!ssl_create_cipher_list(ret->method,
2935 ret->tls13_ciphersuites,
2936 &ret->cipher_list, &ret->cipher_list_by_id,
2937 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2938 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2939 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2943 ret->param = X509_VERIFY_PARAM_new();
2944 if (ret->param == NULL)
2947 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2948 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2951 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2952 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2956 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2959 if ((ret->client_ca_names = sk_X509_NAME_new_null()) == NULL)
2962 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2965 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
2968 /* No compression for DTLS */
2969 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2970 ret->comp_methods = SSL_COMP_get_compression_methods();
2972 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2973 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2975 /* Setup RFC5077 ticket keys */
2976 if ((RAND_bytes(ret->ext.tick_key_name,
2977 sizeof(ret->ext.tick_key_name)) <= 0)
2978 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
2979 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
2980 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
2981 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
2982 ret->options |= SSL_OP_NO_TICKET;
2984 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
2985 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2988 #ifndef OPENSSL_NO_SRP
2989 if (!SSL_CTX_SRP_CTX_init(ret))
2992 #ifndef OPENSSL_NO_ENGINE
2993 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2994 # define eng_strx(x) #x
2995 # define eng_str(x) eng_strx(x)
2996 /* Use specific client engine automatically... ignore errors */
2999 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3002 ENGINE_load_builtin_engines();
3003 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3005 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3011 * Default is to connect to non-RI servers. When RI is more widely
3012 * deployed might change this.
3014 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3016 * Disable compression by default to prevent CRIME. Applications can
3017 * re-enable compression by configuring
3018 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3019 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3020 * middlebox compatibility by default. This may be disabled by default in
3021 * a later OpenSSL version.
3023 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3025 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3028 * We cannot usefully set a default max_early_data here (which gets
3029 * propagated in SSL_new(), for the following reason: setting the
3030 * SSL field causes tls_construct_stoc_early_data() to tell the
3031 * client that early data will be accepted when constructing a TLS 1.3
3032 * session ticket, and the client will accordingly send us early data
3033 * when using that ticket (if the client has early data to send).
3034 * However, in order for the early data to actually be consumed by
3035 * the application, the application must also have calls to
3036 * SSL_read_early_data(); otherwise we'll just skip past the early data
3037 * and ignore it. So, since the application must add calls to
3038 * SSL_read_early_data(), we also require them to add
3039 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3040 * eliminating the bandwidth-wasting early data in the case described
3043 ret->max_early_data = 0;
3046 * Default recv_max_early_data is a fully loaded single record. Could be
3047 * split across multiple records in practice. We set this differently to
3048 * max_early_data so that, in the default case, we do not advertise any
3049 * support for early_data, but if a client were to send us some (e.g.
3050 * because of an old, stale ticket) then we will tolerate it and skip over
3053 ret->recv_max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
3055 /* By default we send two session tickets automatically in TLSv1.3 */
3056 ret->num_tickets = 2;
3058 ssl_ctx_system_config(ret);
3062 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3068 int SSL_CTX_up_ref(SSL_CTX *ctx)
3072 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3075 REF_PRINT_COUNT("SSL_CTX", ctx);
3076 REF_ASSERT_ISNT(i < 2);
3077 return ((i > 1) ? 1 : 0);
3080 void SSL_CTX_free(SSL_CTX *a)
3087 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3088 REF_PRINT_COUNT("SSL_CTX", a);
3091 REF_ASSERT_ISNT(i < 0);
3093 X509_VERIFY_PARAM_free(a->param);
3094 dane_ctx_final(&a->dane);
3097 * Free internal session cache. However: the remove_cb() may reference
3098 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3099 * after the sessions were flushed.
3100 * As the ex_data handling routines might also touch the session cache,
3101 * the most secure solution seems to be: empty (flush) the cache, then
3102 * free ex_data, then finally free the cache.
3103 * (See ticket [openssl.org #212].)
3105 if (a->sessions != NULL)
3106 SSL_CTX_flush_sessions(a, 0);
3108 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3109 lh_SSL_SESSION_free(a->sessions);
3110 X509_STORE_free(a->cert_store);
3111 #ifndef OPENSSL_NO_CT
3112 CTLOG_STORE_free(a->ctlog_store);
3114 sk_SSL_CIPHER_free(a->cipher_list);
3115 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3116 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3117 ssl_cert_free(a->cert);
3118 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3119 sk_X509_NAME_pop_free(a->client_ca_names, X509_NAME_free);
3120 sk_X509_pop_free(a->extra_certs, X509_free);
3121 a->comp_methods = NULL;
3122 #ifndef OPENSSL_NO_SRTP
3123 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3125 #ifndef OPENSSL_NO_SRP
3126 SSL_CTX_SRP_CTX_free(a);
3128 #ifndef OPENSSL_NO_ENGINE
3129 ENGINE_finish(a->client_cert_engine);
3132 #ifndef OPENSSL_NO_EC
3133 OPENSSL_free(a->ext.ecpointformats);
3134 OPENSSL_free(a->ext.supportedgroups);
3136 OPENSSL_free(a->ext.alpn);
3137 OPENSSL_secure_free(a->ext.secure);
3139 CRYPTO_THREAD_lock_free(a->lock);
3144 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3146 ctx->default_passwd_callback = cb;
3149 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3151 ctx->default_passwd_callback_userdata = u;
3154 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3156 return ctx->default_passwd_callback;
3159 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3161 return ctx->default_passwd_callback_userdata;
3164 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3166 s->default_passwd_callback = cb;
3169 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3171 s->default_passwd_callback_userdata = u;
3174 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3176 return s->default_passwd_callback;
3179 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3181 return s->default_passwd_callback_userdata;
3184 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3185 int (*cb) (X509_STORE_CTX *, void *),
3188 ctx->app_verify_callback = cb;
3189 ctx->app_verify_arg = arg;
3192 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3193 int (*cb) (int, X509_STORE_CTX *))
3195 ctx->verify_mode = mode;
3196 ctx->default_verify_callback = cb;
3199 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3201 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3204 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3206 ssl_cert_set_cert_cb(c->cert, cb, arg);
3209 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3211 ssl_cert_set_cert_cb(s->cert, cb, arg);
3214 void ssl_set_masks(SSL *s)
3217 uint32_t *pvalid = s->s3->tmp.valid_flags;
3218 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3219 unsigned long mask_k, mask_a;
3220 #ifndef OPENSSL_NO_EC
3221 int have_ecc_cert, ecdsa_ok;
3226 #ifndef OPENSSL_NO_DH
3227 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3232 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3233 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3234 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3235 #ifndef OPENSSL_NO_EC
3236 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3242 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3243 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3246 #ifndef OPENSSL_NO_GOST
3247 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3248 mask_k |= SSL_kGOST;
3249 mask_a |= SSL_aGOST12;
3251 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3252 mask_k |= SSL_kGOST;
3253 mask_a |= SSL_aGOST12;
3255 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3256 mask_k |= SSL_kGOST;
3257 mask_a |= SSL_aGOST01;
3268 * If we only have an RSA-PSS certificate allow RSA authentication
3269 * if TLS 1.2 and peer supports it.
3272 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3273 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3274 && TLS1_get_version(s) == TLS1_2_VERSION))
3281 mask_a |= SSL_aNULL;
3284 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3285 * depending on the key usage extension.
3287 #ifndef OPENSSL_NO_EC
3288 if (have_ecc_cert) {
3290 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3291 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3292 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3295 mask_a |= SSL_aECDSA;
3297 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3298 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3299 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3300 && TLS1_get_version(s) == TLS1_2_VERSION)
3301 mask_a |= SSL_aECDSA;
3303 /* Allow Ed448 for TLS 1.2 if peer supports it */
3304 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3305 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3306 && TLS1_get_version(s) == TLS1_2_VERSION)
3307 mask_a |= SSL_aECDSA;
3310 #ifndef OPENSSL_NO_EC
3311 mask_k |= SSL_kECDHE;
3314 #ifndef OPENSSL_NO_PSK
3317 if (mask_k & SSL_kRSA)
3318 mask_k |= SSL_kRSAPSK;
3319 if (mask_k & SSL_kDHE)
3320 mask_k |= SSL_kDHEPSK;
3321 if (mask_k & SSL_kECDHE)
3322 mask_k |= SSL_kECDHEPSK;
3325 s->s3->tmp.mask_k = mask_k;
3326 s->s3->tmp.mask_a = mask_a;
3329 #ifndef OPENSSL_NO_EC
3331 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3333 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3334 /* key usage, if present, must allow signing */
3335 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3336 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3337 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3341 return 1; /* all checks are ok */
3346 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3347 size_t *serverinfo_length)
3349 CERT_PKEY *cpk = s->s3->tmp.cert;
3350 *serverinfo_length = 0;
3352 if (cpk == NULL || cpk->serverinfo == NULL)
3355 *serverinfo = cpk->serverinfo;
3356 *serverinfo_length = cpk->serverinfo_length;
3360 void ssl_update_cache(SSL *s, int mode)
3365 * If the session_id_length is 0, we are not supposed to cache it, and it
3366 * would be rather hard to do anyway :-)
3368 if (s->session->session_id_length == 0)
3372 * If sid_ctx_length is 0 there is no specific application context
3373 * associated with this session, so when we try to resume it and
3374 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3375 * indication that this is actually a session for the proper application
3376 * context, and the *handshake* will fail, not just the resumption attempt.
3377 * Do not cache (on the server) these sessions that are not resumable
3378 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3380 if (s->server && s->session->sid_ctx_length == 0
3381 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3384 i = s->session_ctx->session_cache_mode;
3386 && (!s->hit || SSL_IS_TLS13(s))) {
3388 * Add the session to the internal cache. In server side TLSv1.3 we
3389 * normally don't do this because by default it's a full stateless ticket
3390 * with only a dummy session id so there is no reason to cache it,
3392 * - we are doing early_data, in which case we cache so that we can
3394 * - the application has set a remove_session_cb so needs to know about
3395 * session timeout events
3396 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3398 if ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0
3399 && (!SSL_IS_TLS13(s)
3401 || (s->max_early_data > 0
3402 && (s->options & SSL_OP_NO_ANTI_REPLAY) == 0)
3403 || s->session_ctx->remove_session_cb != NULL
3404 || (s->options & SSL_OP_NO_TICKET) != 0))
3405 SSL_CTX_add_session(s->session_ctx, s->session);
3408 * Add the session to the external cache. We do this even in server side
3409 * TLSv1.3 without early data because some applications just want to
3410 * know about the creation of a session and aren't doing a full cache.
3412 if (s->session_ctx->new_session_cb != NULL) {
3413 SSL_SESSION_up_ref(s->session);
3414 if (!s->session_ctx->new_session_cb(s, s->session))
3415 SSL_SESSION_free(s->session);
3419 /* auto flush every 255 connections */
3420 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3421 TSAN_QUALIFIER int *stat;
3422 if (mode & SSL_SESS_CACHE_CLIENT)
3423 stat = &s->session_ctx->stats.sess_connect_good;
3425 stat = &s->session_ctx->stats.sess_accept_good;
3426 if ((tsan_load(stat) & 0xff) == 0xff)
3427 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3431 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3436 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3441 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3445 if (s->method != meth) {
3446 const SSL_METHOD *sm = s->method;
3447 int (*hf) (SSL *) = s->handshake_func;
3449 if (sm->version == meth->version)
3454 ret = s->method->ssl_new(s);
3457 if (hf == sm->ssl_connect)
3458 s->handshake_func = meth->ssl_connect;
3459 else if (hf == sm->ssl_accept)
3460 s->handshake_func = meth->ssl_accept;
3465 int SSL_get_error(const SSL *s, int i)
3472 return SSL_ERROR_NONE;
3475 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3476 * where we do encode the error
3478 if ((l = ERR_peek_error()) != 0) {
3479 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3480 return SSL_ERROR_SYSCALL;
3482 return SSL_ERROR_SSL;
3485 if (SSL_want_read(s)) {
3486 bio = SSL_get_rbio(s);
3487 if (BIO_should_read(bio))
3488 return SSL_ERROR_WANT_READ;
3489 else if (BIO_should_write(bio))
3491 * This one doesn't make too much sense ... We never try to write
3492 * to the rbio, and an application program where rbio and wbio
3493 * are separate couldn't even know what it should wait for.
3494 * However if we ever set s->rwstate incorrectly (so that we have
3495 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3496 * wbio *are* the same, this test works around that bug; so it
3497 * might be safer to keep it.
3499 return SSL_ERROR_WANT_WRITE;
3500 else if (BIO_should_io_special(bio)) {
3501 reason = BIO_get_retry_reason(bio);
3502 if (reason == BIO_RR_CONNECT)
3503 return SSL_ERROR_WANT_CONNECT;
3504 else if (reason == BIO_RR_ACCEPT)
3505 return SSL_ERROR_WANT_ACCEPT;
3507 return SSL_ERROR_SYSCALL; /* unknown */
3511 if (SSL_want_write(s)) {
3512 /* Access wbio directly - in order to use the buffered bio if present */
3514 if (BIO_should_write(bio))
3515 return SSL_ERROR_WANT_WRITE;
3516 else if (BIO_should_read(bio))
3518 * See above (SSL_want_read(s) with BIO_should_write(bio))
3520 return SSL_ERROR_WANT_READ;
3521 else if (BIO_should_io_special(bio)) {
3522 reason = BIO_get_retry_reason(bio);
3523 if (reason == BIO_RR_CONNECT)
3524 return SSL_ERROR_WANT_CONNECT;
3525 else if (reason == BIO_RR_ACCEPT)
3526 return SSL_ERROR_WANT_ACCEPT;
3528 return SSL_ERROR_SYSCALL;
3531 if (SSL_want_x509_lookup(s))
3532 return SSL_ERROR_WANT_X509_LOOKUP;
3533 if (SSL_want_async(s))
3534 return SSL_ERROR_WANT_ASYNC;
3535 if (SSL_want_async_job(s))
3536 return SSL_ERROR_WANT_ASYNC_JOB;
3537 if (SSL_want_client_hello_cb(s))
3538 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3540 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3541 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3542 return SSL_ERROR_ZERO_RETURN;
3544 return SSL_ERROR_SYSCALL;
3547 static int ssl_do_handshake_intern(void *vargs)
3549 struct ssl_async_args *args;
3552 args = (struct ssl_async_args *)vargs;
3555 return s->handshake_func(s);
3558 int SSL_do_handshake(SSL *s)
3562 if (s->handshake_func == NULL) {
3563 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3567 ossl_statem_check_finish_init(s, -1);
3569 s->method->ssl_renegotiate_check(s, 0);
3571 if (SSL_in_init(s) || SSL_in_before(s)) {
3572 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3573 struct ssl_async_args args;
3577 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3579 ret = s->handshake_func(s);
3585 void SSL_set_accept_state(SSL *s)
3589 ossl_statem_clear(s);
3590 s->handshake_func = s->method->ssl_accept;
3594 void SSL_set_connect_state(SSL *s)
3598 ossl_statem_clear(s);
3599 s->handshake_func = s->method->ssl_connect;
3603 int ssl_undefined_function(SSL *s)
3605 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3609 int ssl_undefined_void_function(void)
3611 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3612 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3616 int ssl_undefined_const_function(const SSL *s)
3621 const SSL_METHOD *ssl_bad_method(int ver)
3623 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3627 const char *ssl_protocol_to_string(int version)
3631 case TLS1_3_VERSION:
3634 case TLS1_2_VERSION:
3637 case TLS1_1_VERSION:
3652 case DTLS1_2_VERSION:
3660 const char *SSL_get_version(const SSL *s)
3662 return ssl_protocol_to_string(s->version);
3665 static int dup_ca_names(STACK_OF(X509_NAME) **dst, STACK_OF(X509_NAME) *src)
3667 STACK_OF(X509_NAME) *sk;
3676 if ((sk = sk_X509_NAME_new_null()) == NULL)
3678 for (i = 0; i < sk_X509_NAME_num(src); i++) {
3679 xn = X509_NAME_dup(sk_X509_NAME_value(src, i));
3681 sk_X509_NAME_pop_free(sk, X509_NAME_free);
3684 if (sk_X509_NAME_insert(sk, xn, i) == 0) {
3686 sk_X509_NAME_pop_free(sk, X509_NAME_free);
3695 SSL *SSL_dup(SSL *s)
3700 /* If we're not quiescent, just up_ref! */
3701 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3702 CRYPTO_UP_REF(&s->references, &i, s->lock);
3707 * Otherwise, copy configuration state, and session if set.
3709 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3712 if (s->session != NULL) {
3714 * Arranges to share the same session via up_ref. This "copies"
3715 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3717 if (!SSL_copy_session_id(ret, s))
3721 * No session has been established yet, so we have to expect that
3722 * s->cert or ret->cert will be changed later -- they should not both
3723 * point to the same object, and thus we can't use
3724 * SSL_copy_session_id.
3726 if (!SSL_set_ssl_method(ret, s->method))
3729 if (s->cert != NULL) {
3730 ssl_cert_free(ret->cert);
3731 ret->cert = ssl_cert_dup(s->cert);
3732 if (ret->cert == NULL)
3736 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3737 (int)s->sid_ctx_length))
3741 if (!ssl_dane_dup(ret, s))
3743 ret->version = s->version;
3744 ret->options = s->options;
3745 ret->mode = s->mode;
3746 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3747 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3748 ret->msg_callback = s->msg_callback;
3749 ret->msg_callback_arg = s->msg_callback_arg;
3750 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3751 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3752 ret->generate_session_id = s->generate_session_id;
3754 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3756 /* copy app data, a little dangerous perhaps */
3757 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3760 /* setup rbio, and wbio */
3761 if (s->rbio != NULL) {
3762 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3765 if (s->wbio != NULL) {
3766 if (s->wbio != s->rbio) {
3767 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3770 BIO_up_ref(ret->rbio);
3771 ret->wbio = ret->rbio;
3775 ret->server = s->server;
3776 if (s->handshake_func) {
3778 SSL_set_accept_state(ret);
3780 SSL_set_connect_state(ret);
3782 ret->shutdown = s->shutdown;
3785 ret->default_passwd_callback = s->default_passwd_callback;
3786 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3788 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3790 /* dup the cipher_list and cipher_list_by_id stacks */
3791 if (s->cipher_list != NULL) {
3792 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3795 if (s->cipher_list_by_id != NULL)
3796 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3800 /* Dup the client_CA list */
3801 if (!dup_ca_names(&ret->ca_names, s->ca_names)
3802 || !dup_ca_names(&ret->client_ca_names, s->client_ca_names))
3812 void ssl_clear_cipher_ctx(SSL *s)
3814 if (s->enc_read_ctx != NULL) {
3815 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3816 s->enc_read_ctx = NULL;
3818 if (s->enc_write_ctx != NULL) {
3819 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3820 s->enc_write_ctx = NULL;
3822 #ifndef OPENSSL_NO_COMP
3823 COMP_CTX_free(s->expand);
3825 COMP_CTX_free(s->compress);
3830 X509 *SSL_get_certificate(const SSL *s)
3832 if (s->cert != NULL)
3833 return s->cert->key->x509;
3838 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3840 if (s->cert != NULL)
3841 return s->cert->key->privatekey;
3846 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3848 if (ctx->cert != NULL)
3849 return ctx->cert->key->x509;
3854 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3856 if (ctx->cert != NULL)
3857 return ctx->cert->key->privatekey;
3862 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3864 if ((s->session != NULL) && (s->session->cipher != NULL))
3865 return s->session->cipher;
3869 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3871 return s->s3->tmp.new_cipher;
3874 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3876 #ifndef OPENSSL_NO_COMP
3877 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3883 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3885 #ifndef OPENSSL_NO_COMP
3886 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3892 int ssl_init_wbio_buffer(SSL *s)
3896 if (s->bbio != NULL) {
3897 /* Already buffered. */
3901 bbio = BIO_new(BIO_f_buffer());
3902 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3904 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3908 s->wbio = BIO_push(bbio, s->wbio);
3913 int ssl_free_wbio_buffer(SSL *s)
3915 /* callers ensure s is never null */
3916 if (s->bbio == NULL)
3919 s->wbio = BIO_pop(s->wbio);
3926 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3928 ctx->quiet_shutdown = mode;
3931 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3933 return ctx->quiet_shutdown;
3936 void SSL_set_quiet_shutdown(SSL *s, int mode)
3938 s->quiet_shutdown = mode;
3941 int SSL_get_quiet_shutdown(const SSL *s)
3943 return s->quiet_shutdown;
3946 void SSL_set_shutdown(SSL *s, int mode)
3951 int SSL_get_shutdown(const SSL *s)
3956 int SSL_version(const SSL *s)
3961 int SSL_client_version(const SSL *s)
3963 return s->client_version;
3966 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3971 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3974 if (ssl->ctx == ctx)
3977 ctx = ssl->session_ctx;
3978 new_cert = ssl_cert_dup(ctx->cert);
3979 if (new_cert == NULL) {
3983 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3984 ssl_cert_free(new_cert);
3988 ssl_cert_free(ssl->cert);
3989 ssl->cert = new_cert;
3992 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3993 * so setter APIs must prevent invalid lengths from entering the system.
3995 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3999 * If the session ID context matches that of the parent SSL_CTX,
4000 * inherit it from the new SSL_CTX as well. If however the context does
4001 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4002 * leave it unchanged.
4004 if ((ssl->ctx != NULL) &&
4005 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
4006 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
4007 ssl->sid_ctx_length = ctx->sid_ctx_length;
4008 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
4011 SSL_CTX_up_ref(ctx);
4012 SSL_CTX_free(ssl->ctx); /* decrement reference count */
4018 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
4020 return X509_STORE_set_default_paths(ctx->cert_store);
4023 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
4025 X509_LOOKUP *lookup;
4027 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
4030 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
4032 /* Clear any errors if the default directory does not exist */
4038 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4040 X509_LOOKUP *lookup;
4042 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4046 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4048 /* Clear any errors if the default file does not exist */
4054 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4057 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4060 void SSL_set_info_callback(SSL *ssl,
4061 void (*cb) (const SSL *ssl, int type, int val))
4063 ssl->info_callback = cb;
4067 * One compiler (Diab DCC) doesn't like argument names in returned function
4070 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4073 return ssl->info_callback;
4076 void SSL_set_verify_result(SSL *ssl, long arg)
4078 ssl->verify_result = arg;
4081 long SSL_get_verify_result(const SSL *ssl)
4083 return ssl->verify_result;
4086 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4089 return sizeof(ssl->s3->client_random);
4090 if (outlen > sizeof(ssl->s3->client_random))
4091 outlen = sizeof(ssl->s3->client_random);
4092 memcpy(out, ssl->s3->client_random, outlen);
4096 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4099 return sizeof(ssl->s3->server_random);
4100 if (outlen > sizeof(ssl->s3->server_random))
4101 outlen = sizeof(ssl->s3->server_random);
4102 memcpy(out, ssl->s3->server_random, outlen);
4106 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4107 unsigned char *out, size_t outlen)
4110 return session->master_key_length;
4111 if (outlen > session->master_key_length)
4112 outlen = session->master_key_length;
4113 memcpy(out, session->master_key, outlen);
4117 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4120 if (len > sizeof(sess->master_key))
4123 memcpy(sess->master_key, in, len);
4124 sess->master_key_length = len;
4129 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4131 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4134 void *SSL_get_ex_data(const SSL *s, int idx)
4136 return CRYPTO_get_ex_data(&s->ex_data, idx);
4139 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4141 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4144 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4146 return CRYPTO_get_ex_data(&s->ex_data, idx);
4149 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4151 return ctx->cert_store;
4154 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4156 X509_STORE_free(ctx->cert_store);
4157 ctx->cert_store = store;
4160 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4163 X509_STORE_up_ref(store);
4164 SSL_CTX_set_cert_store(ctx, store);
4167 int SSL_want(const SSL *s)
4173 * \brief Set the callback for generating temporary DH keys.
4174 * \param ctx the SSL context.
4175 * \param dh the callback
4178 #ifndef OPENSSL_NO_DH
4179 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4180 DH *(*dh) (SSL *ssl, int is_export,
4183 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4186 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4189 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4193 #ifndef OPENSSL_NO_PSK
4194 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4196 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4197 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4200 OPENSSL_free(ctx->cert->psk_identity_hint);
4201 if (identity_hint != NULL) {
4202 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4203 if (ctx->cert->psk_identity_hint == NULL)
4206 ctx->cert->psk_identity_hint = NULL;
4210 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4215 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4216 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4219 OPENSSL_free(s->cert->psk_identity_hint);
4220 if (identity_hint != NULL) {
4221 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4222 if (s->cert->psk_identity_hint == NULL)
4225 s->cert->psk_identity_hint = NULL;
4229 const char *SSL_get_psk_identity_hint(const SSL *s)
4231 if (s == NULL || s->session == NULL)
4233 return s->session->psk_identity_hint;
4236 const char *SSL_get_psk_identity(const SSL *s)
4238 if (s == NULL || s->session == NULL)
4240 return s->session->psk_identity;
4243 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4245 s->psk_client_callback = cb;
4248 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4250 ctx->psk_client_callback = cb;
4253 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4255 s->psk_server_callback = cb;
4258 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4260 ctx->psk_server_callback = cb;
4264 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4266 s->psk_find_session_cb = cb;
4269 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4270 SSL_psk_find_session_cb_func cb)
4272 ctx->psk_find_session_cb = cb;
4275 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4277 s->psk_use_session_cb = cb;
4280 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4281 SSL_psk_use_session_cb_func cb)
4283 ctx->psk_use_session_cb = cb;
4286 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4287 void (*cb) (int write_p, int version,
4288 int content_type, const void *buf,
4289 size_t len, SSL *ssl, void *arg))
4291 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4294 void SSL_set_msg_callback(SSL *ssl,
4295 void (*cb) (int write_p, int version,
4296 int content_type, const void *buf,
4297 size_t len, SSL *ssl, void *arg))
4299 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4302 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4303 int (*cb) (SSL *ssl,
4307 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4308 (void (*)(void))cb);
4311 void SSL_set_not_resumable_session_callback(SSL *ssl,
4312 int (*cb) (SSL *ssl,
4313 int is_forward_secure))
4315 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4316 (void (*)(void))cb);
4319 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4320 size_t (*cb) (SSL *ssl, int type,
4321 size_t len, void *arg))
4323 ctx->record_padding_cb = cb;
4326 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4328 ctx->record_padding_arg = arg;
4331 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4333 return ctx->record_padding_arg;
4336 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4338 /* block size of 0 or 1 is basically no padding */
4339 if (block_size == 1)
4340 ctx->block_padding = 0;
4341 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4342 ctx->block_padding = block_size;
4348 void SSL_set_record_padding_callback(SSL *ssl,
4349 size_t (*cb) (SSL *ssl, int type,
4350 size_t len, void *arg))
4352 ssl->record_padding_cb = cb;
4355 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4357 ssl->record_padding_arg = arg;
4360 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4362 return ssl->record_padding_arg;
4365 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4367 /* block size of 0 or 1 is basically no padding */
4368 if (block_size == 1)
4369 ssl->block_padding = 0;
4370 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4371 ssl->block_padding = block_size;
4377 int SSL_set_num_tickets(SSL *s, size_t num_tickets)
4379 s->num_tickets = num_tickets;
4384 size_t SSL_get_num_tickets(SSL *s)
4386 return s->num_tickets;
4389 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets)
4391 ctx->num_tickets = num_tickets;
4396 size_t SSL_CTX_get_num_tickets(SSL_CTX *ctx)
4398 return ctx->num_tickets;
4402 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4403 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4404 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4405 * Returns the newly allocated ctx;
4408 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4410 ssl_clear_hash_ctx(hash);
4411 *hash = EVP_MD_CTX_new();
4412 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4413 EVP_MD_CTX_free(*hash);
4420 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4423 EVP_MD_CTX_free(*hash);
4427 /* Retrieve handshake hashes */
4428 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4431 EVP_MD_CTX *ctx = NULL;
4432 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4433 int hashleni = EVP_MD_CTX_size(hdgst);
4436 if (hashleni < 0 || (size_t)hashleni > outlen) {
4437 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4438 ERR_R_INTERNAL_ERROR);
4442 ctx = EVP_MD_CTX_new();
4446 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4447 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4448 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4449 ERR_R_INTERNAL_ERROR);
4453 *hashlen = hashleni;
4457 EVP_MD_CTX_free(ctx);
4461 int SSL_session_reused(SSL *s)
4466 int SSL_is_server(const SSL *s)
4471 #if OPENSSL_API_COMPAT < 0x10100000L
4472 void SSL_set_debug(SSL *s, int debug)
4474 /* Old function was do-nothing anyway... */
4480 void SSL_set_security_level(SSL *s, int level)
4482 s->cert->sec_level = level;
4485 int SSL_get_security_level(const SSL *s)
4487 return s->cert->sec_level;
4490 void SSL_set_security_callback(SSL *s,
4491 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4492 int op, int bits, int nid,
4493 void *other, void *ex))
4495 s->cert->sec_cb = cb;
4498 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4499 const SSL_CTX *ctx, int op,
4500 int bits, int nid, void *other,
4502 return s->cert->sec_cb;
4505 void SSL_set0_security_ex_data(SSL *s, void *ex)
4507 s->cert->sec_ex = ex;
4510 void *SSL_get0_security_ex_data(const SSL *s)
4512 return s->cert->sec_ex;
4515 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4517 ctx->cert->sec_level = level;
4520 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4522 return ctx->cert->sec_level;
4525 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4526 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4527 int op, int bits, int nid,
4528 void *other, void *ex))
4530 ctx->cert->sec_cb = cb;
4533 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4539 return ctx->cert->sec_cb;
4542 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4544 ctx->cert->sec_ex = ex;
4547 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4549 return ctx->cert->sec_ex;
4553 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4554 * can return unsigned long, instead of the generic long return value from the
4555 * control interface.
4557 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4559 return ctx->options;
4562 unsigned long SSL_get_options(const SSL *s)
4567 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4569 return ctx->options |= op;
4572 unsigned long SSL_set_options(SSL *s, unsigned long op)
4574 return s->options |= op;
4577 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4579 return ctx->options &= ~op;
4582 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4584 return s->options &= ~op;
4587 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4589 return s->verified_chain;
4592 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4594 #ifndef OPENSSL_NO_CT
4597 * Moves SCTs from the |src| stack to the |dst| stack.
4598 * The source of each SCT will be set to |origin|.
4599 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4601 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4603 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4604 sct_source_t origin)
4610 *dst = sk_SCT_new_null();
4612 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4617 while ((sct = sk_SCT_pop(src)) != NULL) {
4618 if (SCT_set_source(sct, origin) != 1)
4621 if (sk_SCT_push(*dst, sct) <= 0)
4629 sk_SCT_push(src, sct); /* Put the SCT back */
4634 * Look for data collected during ServerHello and parse if found.
4635 * Returns the number of SCTs extracted.
4637 static int ct_extract_tls_extension_scts(SSL *s)
4639 int scts_extracted = 0;
4641 if (s->ext.scts != NULL) {
4642 const unsigned char *p = s->ext.scts;
4643 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4645 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4647 SCT_LIST_free(scts);
4650 return scts_extracted;
4654 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4655 * contains an SCT X509 extension. They will be stored in |s->scts|.
4657 * - The number of SCTs extracted, assuming an OCSP response exists.
4658 * - 0 if no OCSP response exists or it contains no SCTs.
4659 * - A negative integer if an error occurs.
4661 static int ct_extract_ocsp_response_scts(SSL *s)
4663 # ifndef OPENSSL_NO_OCSP
4664 int scts_extracted = 0;
4665 const unsigned char *p;
4666 OCSP_BASICRESP *br = NULL;
4667 OCSP_RESPONSE *rsp = NULL;
4668 STACK_OF(SCT) *scts = NULL;
4671 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4674 p = s->ext.ocsp.resp;
4675 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4679 br = OCSP_response_get1_basic(rsp);
4683 for (i = 0; i < OCSP_resp_count(br); ++i) {
4684 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4690 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4692 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4693 if (scts_extracted < 0)
4697 SCT_LIST_free(scts);
4698 OCSP_BASICRESP_free(br);
4699 OCSP_RESPONSE_free(rsp);
4700 return scts_extracted;
4702 /* Behave as if no OCSP response exists */
4708 * Attempts to extract SCTs from the peer certificate.
4709 * Return the number of SCTs extracted, or a negative integer if an error
4712 static int ct_extract_x509v3_extension_scts(SSL *s)
4714 int scts_extracted = 0;
4715 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4718 STACK_OF(SCT) *scts =
4719 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4722 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4724 SCT_LIST_free(scts);
4727 return scts_extracted;
4731 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4732 * response (if it exists) and X509v3 extensions in the certificate.
4733 * Returns NULL if an error occurs.
4735 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4737 if (!s->scts_parsed) {
4738 if (ct_extract_tls_extension_scts(s) < 0 ||
4739 ct_extract_ocsp_response_scts(s) < 0 ||
4740 ct_extract_x509v3_extension_scts(s) < 0)
4750 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4751 const STACK_OF(SCT) *scts, void *unused_arg)
4756 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4757 const STACK_OF(SCT) *scts, void *unused_arg)
4759 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4762 for (i = 0; i < count; ++i) {
4763 SCT *sct = sk_SCT_value(scts, i);
4764 int status = SCT_get_validation_status(sct);
4766 if (status == SCT_VALIDATION_STATUS_VALID)
4769 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4773 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4777 * Since code exists that uses the custom extension handler for CT, look
4778 * for this and throw an error if they have already registered to use CT.
4780 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4781 TLSEXT_TYPE_signed_certificate_timestamp))
4783 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4784 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4788 if (callback != NULL) {
4790 * If we are validating CT, then we MUST accept SCTs served via OCSP
4792 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4796 s->ct_validation_callback = callback;
4797 s->ct_validation_callback_arg = arg;
4802 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4803 ssl_ct_validation_cb callback, void *arg)
4806 * Since code exists that uses the custom extension handler for CT, look for
4807 * this and throw an error if they have already registered to use CT.
4809 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4810 TLSEXT_TYPE_signed_certificate_timestamp))
4812 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4813 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4817 ctx->ct_validation_callback = callback;
4818 ctx->ct_validation_callback_arg = arg;
4822 int SSL_ct_is_enabled(const SSL *s)
4824 return s->ct_validation_callback != NULL;
4827 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4829 return ctx->ct_validation_callback != NULL;
4832 int ssl_validate_ct(SSL *s)
4835 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4837 SSL_DANE *dane = &s->dane;
4838 CT_POLICY_EVAL_CTX *ctx = NULL;
4839 const STACK_OF(SCT) *scts;
4842 * If no callback is set, the peer is anonymous, or its chain is invalid,
4843 * skip SCT validation - just return success. Applications that continue
4844 * handshakes without certificates, with unverified chains, or pinned leaf
4845 * certificates are outside the scope of the WebPKI and CT.
4847 * The above exclusions notwithstanding the vast majority of peers will
4848 * have rather ordinary certificate chains validated by typical
4849 * applications that perform certificate verification and therefore will
4850 * process SCTs when enabled.
4852 if (s->ct_validation_callback == NULL || cert == NULL ||
4853 s->verify_result != X509_V_OK ||
4854 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4858 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4859 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4861 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4862 switch (dane->mtlsa->usage) {
4863 case DANETLS_USAGE_DANE_TA:
4864 case DANETLS_USAGE_DANE_EE:
4869 ctx = CT_POLICY_EVAL_CTX_new();
4871 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4872 ERR_R_MALLOC_FAILURE);
4876 issuer = sk_X509_value(s->verified_chain, 1);
4877 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4878 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4879 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4880 CT_POLICY_EVAL_CTX_set_time(
4881 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4883 scts = SSL_get0_peer_scts(s);
4886 * This function returns success (> 0) only when all the SCTs are valid, 0
4887 * when some are invalid, and < 0 on various internal errors (out of
4888 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4889 * reason to abort the handshake, that decision is up to the callback.
4890 * Therefore, we error out only in the unexpected case that the return
4891 * value is negative.
4893 * XXX: One might well argue that the return value of this function is an
4894 * unfortunate design choice. Its job is only to determine the validation
4895 * status of each of the provided SCTs. So long as it correctly separates
4896 * the wheat from the chaff it should return success. Failure in this case
4897 * ought to correspond to an inability to carry out its duties.
4899 if (SCT_LIST_validate(scts, ctx) < 0) {
4900 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4901 SSL_R_SCT_VERIFICATION_FAILED);
4905 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4907 ret = 0; /* This function returns 0 on failure */
4909 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4910 SSL_R_CALLBACK_FAILED);
4913 CT_POLICY_EVAL_CTX_free(ctx);
4915 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4916 * failure return code here. Also the application may wish the complete
4917 * the handshake, and then disconnect cleanly at a higher layer, after
4918 * checking the verification status of the completed connection.
4920 * We therefore force a certificate verification failure which will be
4921 * visible via SSL_get_verify_result() and cached as part of any resumed
4924 * Note: the permissive callback is for information gathering only, always
4925 * returns success, and does not affect verification status. Only the
4926 * strict callback or a custom application-specified callback can trigger
4927 * connection failure or record a verification error.
4930 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4934 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4936 switch (validation_mode) {
4938 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4940 case SSL_CT_VALIDATION_PERMISSIVE:
4941 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4942 case SSL_CT_VALIDATION_STRICT:
4943 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4947 int SSL_enable_ct(SSL *s, int validation_mode)
4949 switch (validation_mode) {
4951 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4953 case SSL_CT_VALIDATION_PERMISSIVE:
4954 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4955 case SSL_CT_VALIDATION_STRICT:
4956 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4960 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4962 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4965 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4967 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4970 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4972 CTLOG_STORE_free(ctx->ctlog_store);
4973 ctx->ctlog_store = logs;
4976 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4978 return ctx->ctlog_store;
4981 #endif /* OPENSSL_NO_CT */
4983 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4986 c->client_hello_cb = cb;
4987 c->client_hello_cb_arg = arg;
4990 int SSL_client_hello_isv2(SSL *s)
4992 if (s->clienthello == NULL)
4994 return s->clienthello->isv2;
4997 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4999 if (s->clienthello == NULL)
5001 return s->clienthello->legacy_version;
5004 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
5006 if (s->clienthello == NULL)
5009 *out = s->clienthello->random;
5010 return SSL3_RANDOM_SIZE;
5013 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
5015 if (s->clienthello == NULL)
5018 *out = s->clienthello->session_id;
5019 return s->clienthello->session_id_len;
5022 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
5024 if (s->clienthello == NULL)
5027 *out = PACKET_data(&s->clienthello->ciphersuites);
5028 return PACKET_remaining(&s->clienthello->ciphersuites);
5031 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
5033 if (s->clienthello == NULL)
5036 *out = s->clienthello->compressions;
5037 return s->clienthello->compressions_len;
5040 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5046 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5048 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5049 ext = s->clienthello->pre_proc_exts + i;
5053 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
5054 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
5055 ERR_R_MALLOC_FAILURE);
5058 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5059 ext = s->clienthello->pre_proc_exts + i;
5061 if (ext->received_order >= num)
5063 present[ext->received_order] = ext->type;
5070 OPENSSL_free(present);
5074 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5080 if (s->clienthello == NULL)
5082 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5083 r = s->clienthello->pre_proc_exts + i;
5084 if (r->present && r->type == type) {
5086 *out = PACKET_data(&r->data);
5088 *outlen = PACKET_remaining(&r->data);
5095 int SSL_free_buffers(SSL *ssl)
5097 RECORD_LAYER *rl = &ssl->rlayer;
5099 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5102 RECORD_LAYER_release(rl);
5106 int SSL_alloc_buffers(SSL *ssl)
5108 return ssl3_setup_buffers(ssl);
5111 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5113 ctx->keylog_callback = cb;
5116 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5118 return ctx->keylog_callback;
5121 static int nss_keylog_int(const char *prefix,
5123 const uint8_t *parameter_1,
5124 size_t parameter_1_len,
5125 const uint8_t *parameter_2,
5126 size_t parameter_2_len)
5129 char *cursor = NULL;
5134 if (ssl->ctx->keylog_callback == NULL)
5138 * Our output buffer will contain the following strings, rendered with
5139 * space characters in between, terminated by a NULL character: first the
5140 * prefix, then the first parameter, then the second parameter. The
5141 * meaning of each parameter depends on the specific key material being
5142 * logged. Note that the first and second parameters are encoded in
5143 * hexadecimal, so we need a buffer that is twice their lengths.
5145 prefix_len = strlen(prefix);
5146 out_len = prefix_len + (2 * parameter_1_len) + (2 * parameter_2_len) + 3;
5147 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5148 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5149 ERR_R_MALLOC_FAILURE);
5153 strcpy(cursor, prefix);
5154 cursor += prefix_len;
5157 for (i = 0; i < parameter_1_len; i++) {
5158 sprintf(cursor, "%02x", parameter_1[i]);
5163 for (i = 0; i < parameter_2_len; i++) {
5164 sprintf(cursor, "%02x", parameter_2[i]);
5169 ssl->ctx->keylog_callback(ssl, (const char *)out);
5170 OPENSSL_clear_free(out, out_len);
5175 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5176 const uint8_t *encrypted_premaster,
5177 size_t encrypted_premaster_len,
5178 const uint8_t *premaster,
5179 size_t premaster_len)
5181 if (encrypted_premaster_len < 8) {
5182 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5183 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5187 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5188 return nss_keylog_int("RSA",
5190 encrypted_premaster,
5196 int ssl_log_secret(SSL *ssl,
5198 const uint8_t *secret,
5201 return nss_keylog_int(label,
5203 ssl->s3->client_random,
5209 #define SSLV2_CIPHER_LEN 3
5211 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5215 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5217 if (PACKET_remaining(cipher_suites) == 0) {
5218 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5219 SSL_R_NO_CIPHERS_SPECIFIED);
5223 if (PACKET_remaining(cipher_suites) % n != 0) {
5224 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5225 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5229 OPENSSL_free(s->s3->tmp.ciphers_raw);
5230 s->s3->tmp.ciphers_raw = NULL;
5231 s->s3->tmp.ciphers_rawlen = 0;
5234 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5235 PACKET sslv2ciphers = *cipher_suites;
5236 unsigned int leadbyte;
5240 * We store the raw ciphers list in SSLv3+ format so we need to do some
5241 * preprocessing to convert the list first. If there are any SSLv2 only
5242 * ciphersuites with a non-zero leading byte then we are going to
5243 * slightly over allocate because we won't store those. But that isn't a
5246 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5247 s->s3->tmp.ciphers_raw = raw;
5249 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5250 ERR_R_MALLOC_FAILURE);
5253 for (s->s3->tmp.ciphers_rawlen = 0;
5254 PACKET_remaining(&sslv2ciphers) > 0;
5255 raw += TLS_CIPHER_LEN) {
5256 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5258 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5261 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5262 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5264 OPENSSL_free(s->s3->tmp.ciphers_raw);
5265 s->s3->tmp.ciphers_raw = NULL;
5266 s->s3->tmp.ciphers_rawlen = 0;
5270 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5272 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5273 &s->s3->tmp.ciphers_rawlen)) {
5274 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5275 ERR_R_INTERNAL_ERROR);
5281 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5282 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5283 STACK_OF(SSL_CIPHER) **scsvs)
5287 if (!PACKET_buf_init(&pkt, bytes, len))
5289 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5292 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5293 STACK_OF(SSL_CIPHER) **skp,
5294 STACK_OF(SSL_CIPHER) **scsvs_out,
5295 int sslv2format, int fatal)
5297 const SSL_CIPHER *c;
5298 STACK_OF(SSL_CIPHER) *sk = NULL;
5299 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5301 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5302 unsigned char cipher[SSLV2_CIPHER_LEN];
5304 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5306 if (PACKET_remaining(cipher_suites) == 0) {
5308 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5309 SSL_R_NO_CIPHERS_SPECIFIED);
5311 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5315 if (PACKET_remaining(cipher_suites) % n != 0) {
5317 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5318 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5320 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5321 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5325 sk = sk_SSL_CIPHER_new_null();
5326 scsvs = sk_SSL_CIPHER_new_null();
5327 if (sk == NULL || scsvs == NULL) {
5329 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5330 ERR_R_MALLOC_FAILURE);
5332 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5336 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5338 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5339 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5340 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5342 if (sslv2format && cipher[0] != '\0')
5345 /* For SSLv2-compat, ignore leading 0-byte. */
5346 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5348 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5349 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5351 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5352 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5354 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5359 if (PACKET_remaining(cipher_suites) > 0) {
5361 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5364 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5371 sk_SSL_CIPHER_free(sk);
5372 if (scsvs_out != NULL)
5375 sk_SSL_CIPHER_free(scsvs);
5378 sk_SSL_CIPHER_free(sk);
5379 sk_SSL_CIPHER_free(scsvs);
5383 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5385 ctx->max_early_data = max_early_data;
5390 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5392 return ctx->max_early_data;
5395 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5397 s->max_early_data = max_early_data;
5402 uint32_t SSL_get_max_early_data(const SSL *s)
5404 return s->max_early_data;
5407 int SSL_CTX_set_recv_max_early_data(SSL_CTX *ctx, uint32_t recv_max_early_data)
5409 ctx->recv_max_early_data = recv_max_early_data;
5414 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX *ctx)
5416 return ctx->recv_max_early_data;
5419 int SSL_set_recv_max_early_data(SSL *s, uint32_t recv_max_early_data)
5421 s->recv_max_early_data = recv_max_early_data;
5426 uint32_t SSL_get_recv_max_early_data(const SSL *s)
5428 return s->recv_max_early_data;
5431 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5433 /* Return any active Max Fragment Len extension */
5434 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5435 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5437 /* return current SSL connection setting */
5438 return ssl->max_send_fragment;
5441 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5443 /* Return a value regarding an active Max Fragment Len extension */
5444 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5445 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5446 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5448 /* else limit |split_send_fragment| to current |max_send_fragment| */
5449 if (ssl->split_send_fragment > ssl->max_send_fragment)
5450 return ssl->max_send_fragment;
5452 /* return current SSL connection setting */
5453 return ssl->split_send_fragment;
5456 int SSL_stateless(SSL *s)
5460 /* Ensure there is no state left over from a previous invocation */
5466 s->s3->flags |= TLS1_FLAGS_STATELESS;
5467 ret = SSL_accept(s);
5468 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5470 if (ret > 0 && s->ext.cookieok)
5473 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5479 void SSL_CTX_set_post_handshake_auth(SSL_CTX *ctx, int val)
5481 ctx->pha_enabled = val;
5484 void SSL_set_post_handshake_auth(SSL *ssl, int val)
5486 ssl->pha_enabled = val;
5489 int SSL_verify_client_post_handshake(SSL *ssl)
5491 if (!SSL_IS_TLS13(ssl)) {
5492 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5496 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5500 if (!SSL_is_init_finished(ssl)) {
5501 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5505 switch (ssl->post_handshake_auth) {
5507 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5510 case SSL_PHA_EXT_SENT:
5511 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5513 case SSL_PHA_EXT_RECEIVED:
5515 case SSL_PHA_REQUEST_PENDING:
5516 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5518 case SSL_PHA_REQUESTED:
5519 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5523 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5525 /* checks verify_mode and algorithm_auth */
5526 if (!send_certificate_request(ssl)) {
5527 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5528 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5532 ossl_statem_set_in_init(ssl, 1);
5536 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5537 SSL_CTX_generate_session_ticket_fn gen_cb,
5538 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5541 ctx->generate_ticket_cb = gen_cb;
5542 ctx->decrypt_ticket_cb = dec_cb;
5543 ctx->ticket_cb_data = arg;
5547 void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
5548 SSL_allow_early_data_cb_fn cb,
5551 ctx->allow_early_data_cb = cb;
5552 ctx->allow_early_data_cb_data = arg;
5555 void SSL_set_allow_early_data_cb(SSL *s,
5556 SSL_allow_early_data_cb_fn cb,
5559 s->allow_early_data_cb = cb;
5560 s->allow_early_data_cb_data = arg;