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 sk = ssl_create_cipher_list(ctx->method,
658 ctx->tls13_ciphersuites,
660 &(ctx->cipher_list_by_id),
661 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
662 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
663 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
669 SSL *SSL_new(SSL_CTX *ctx)
674 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
677 if (ctx->method == NULL) {
678 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
682 s = OPENSSL_zalloc(sizeof(*s));
687 s->lock = CRYPTO_THREAD_lock_new();
688 if (s->lock == NULL) {
694 RECORD_LAYER_init(&s->rlayer, s);
696 s->options = ctx->options;
697 s->dane.flags = ctx->dane.flags;
698 s->min_proto_version = ctx->min_proto_version;
699 s->max_proto_version = ctx->max_proto_version;
701 s->max_cert_list = ctx->max_cert_list;
702 s->max_early_data = ctx->max_early_data;
703 s->recv_max_early_data = ctx->recv_max_early_data;
704 s->num_tickets = ctx->num_tickets;
705 s->pha_enabled = ctx->pha_enabled;
707 /* Shallow copy of the ciphersuites stack */
708 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
709 if (s->tls13_ciphersuites == NULL)
713 * Earlier library versions used to copy the pointer to the CERT, not
714 * its contents; only when setting new parameters for the per-SSL
715 * copy, ssl_cert_new would be called (and the direct reference to
716 * the per-SSL_CTX settings would be lost, but those still were
717 * indirectly accessed for various purposes, and for that reason they
718 * used to be known as s->ctx->default_cert). Now we don't look at the
719 * SSL_CTX's CERT after having duplicated it once.
721 s->cert = ssl_cert_dup(ctx->cert);
725 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
726 s->msg_callback = ctx->msg_callback;
727 s->msg_callback_arg = ctx->msg_callback_arg;
728 s->verify_mode = ctx->verify_mode;
729 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
730 s->record_padding_cb = ctx->record_padding_cb;
731 s->record_padding_arg = ctx->record_padding_arg;
732 s->block_padding = ctx->block_padding;
733 s->sid_ctx_length = ctx->sid_ctx_length;
734 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
736 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
737 s->verify_callback = ctx->default_verify_callback;
738 s->generate_session_id = ctx->generate_session_id;
740 s->param = X509_VERIFY_PARAM_new();
741 if (s->param == NULL)
743 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
744 s->quiet_shutdown = ctx->quiet_shutdown;
746 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
747 s->max_send_fragment = ctx->max_send_fragment;
748 s->split_send_fragment = ctx->split_send_fragment;
749 s->max_pipelines = ctx->max_pipelines;
750 if (s->max_pipelines > 1)
751 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
752 if (ctx->default_read_buf_len > 0)
753 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
758 s->ext.debug_arg = NULL;
759 s->ext.ticket_expected = 0;
760 s->ext.status_type = ctx->ext.status_type;
761 s->ext.status_expected = 0;
762 s->ext.ocsp.ids = NULL;
763 s->ext.ocsp.exts = NULL;
764 s->ext.ocsp.resp = NULL;
765 s->ext.ocsp.resp_len = 0;
767 s->session_ctx = ctx;
768 #ifndef OPENSSL_NO_EC
769 if (ctx->ext.ecpointformats) {
770 s->ext.ecpointformats =
771 OPENSSL_memdup(ctx->ext.ecpointformats,
772 ctx->ext.ecpointformats_len);
773 if (!s->ext.ecpointformats)
775 s->ext.ecpointformats_len =
776 ctx->ext.ecpointformats_len;
778 if (ctx->ext.supportedgroups) {
779 s->ext.supportedgroups =
780 OPENSSL_memdup(ctx->ext.supportedgroups,
781 ctx->ext.supportedgroups_len
782 * sizeof(*ctx->ext.supportedgroups));
783 if (!s->ext.supportedgroups)
785 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
788 #ifndef OPENSSL_NO_NEXTPROTONEG
792 if (s->ctx->ext.alpn) {
793 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
794 if (s->ext.alpn == NULL)
796 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
797 s->ext.alpn_len = s->ctx->ext.alpn_len;
800 s->verified_chain = NULL;
801 s->verify_result = X509_V_OK;
803 s->default_passwd_callback = ctx->default_passwd_callback;
804 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
806 s->method = ctx->method;
808 s->key_update = SSL_KEY_UPDATE_NONE;
810 s->allow_early_data_cb = ctx->allow_early_data_cb;
811 s->allow_early_data_cb_data = ctx->allow_early_data_cb_data;
813 if (!s->method->ssl_new(s))
816 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
821 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
824 #ifndef OPENSSL_NO_PSK
825 s->psk_client_callback = ctx->psk_client_callback;
826 s->psk_server_callback = ctx->psk_server_callback;
828 s->psk_find_session_cb = ctx->psk_find_session_cb;
829 s->psk_use_session_cb = ctx->psk_use_session_cb;
833 #ifndef OPENSSL_NO_CT
834 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
835 ctx->ct_validation_callback_arg))
842 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
846 int SSL_is_dtls(const SSL *s)
848 return SSL_IS_DTLS(s) ? 1 : 0;
851 int SSL_up_ref(SSL *s)
855 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
858 REF_PRINT_COUNT("SSL", s);
859 REF_ASSERT_ISNT(i < 2);
860 return ((i > 1) ? 1 : 0);
863 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
864 unsigned int sid_ctx_len)
866 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
867 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
868 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
871 ctx->sid_ctx_length = sid_ctx_len;
872 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
877 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
878 unsigned int sid_ctx_len)
880 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
881 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
882 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
885 ssl->sid_ctx_length = sid_ctx_len;
886 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
891 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
893 CRYPTO_THREAD_write_lock(ctx->lock);
894 ctx->generate_session_id = cb;
895 CRYPTO_THREAD_unlock(ctx->lock);
899 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
901 CRYPTO_THREAD_write_lock(ssl->lock);
902 ssl->generate_session_id = cb;
903 CRYPTO_THREAD_unlock(ssl->lock);
907 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
911 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
912 * we can "construct" a session to give us the desired check - i.e. to
913 * find if there's a session in the hash table that would conflict with
914 * any new session built out of this id/id_len and the ssl_version in use
919 if (id_len > sizeof(r.session_id))
922 r.ssl_version = ssl->version;
923 r.session_id_length = id_len;
924 memcpy(r.session_id, id, id_len);
926 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
927 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
928 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
932 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
934 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
937 int SSL_set_purpose(SSL *s, int purpose)
939 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
942 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
944 return X509_VERIFY_PARAM_set_trust(s->param, trust);
947 int SSL_set_trust(SSL *s, int trust)
949 return X509_VERIFY_PARAM_set_trust(s->param, trust);
952 int SSL_set1_host(SSL *s, const char *hostname)
954 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
957 int SSL_add1_host(SSL *s, const char *hostname)
959 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
962 void SSL_set_hostflags(SSL *s, unsigned int flags)
964 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
967 const char *SSL_get0_peername(SSL *s)
969 return X509_VERIFY_PARAM_get0_peername(s->param);
972 int SSL_CTX_dane_enable(SSL_CTX *ctx)
974 return dane_ctx_enable(&ctx->dane);
977 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
979 unsigned long orig = ctx->dane.flags;
981 ctx->dane.flags |= flags;
985 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
987 unsigned long orig = ctx->dane.flags;
989 ctx->dane.flags &= ~flags;
993 int SSL_dane_enable(SSL *s, const char *basedomain)
995 SSL_DANE *dane = &s->dane;
997 if (s->ctx->dane.mdmax == 0) {
998 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
1001 if (dane->trecs != NULL) {
1002 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1007 * Default SNI name. This rejects empty names, while set1_host below
1008 * accepts them and disables host name checks. To avoid side-effects with
1009 * invalid input, set the SNI name first.
1011 if (s->ext.hostname == NULL) {
1012 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1013 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1018 /* Primary RFC6125 reference identifier */
1019 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1020 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1026 dane->dctx = &s->ctx->dane;
1027 dane->trecs = sk_danetls_record_new_null();
1029 if (dane->trecs == NULL) {
1030 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1036 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1038 unsigned long orig = ssl->dane.flags;
1040 ssl->dane.flags |= flags;
1044 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1046 unsigned long orig = ssl->dane.flags;
1048 ssl->dane.flags &= ~flags;
1052 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1054 SSL_DANE *dane = &s->dane;
1056 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1060 *mcert = dane->mcert;
1062 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1067 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1068 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1070 SSL_DANE *dane = &s->dane;
1072 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1076 *usage = dane->mtlsa->usage;
1078 *selector = dane->mtlsa->selector;
1080 *mtype = dane->mtlsa->mtype;
1082 *data = dane->mtlsa->data;
1084 *dlen = dane->mtlsa->dlen;
1089 SSL_DANE *SSL_get0_dane(SSL *s)
1094 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1095 uint8_t mtype, unsigned const char *data, size_t dlen)
1097 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1100 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1103 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1106 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1108 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1111 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1113 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1116 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1121 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1126 void SSL_certs_clear(SSL *s)
1128 ssl_cert_clear_certs(s->cert);
1131 void SSL_free(SSL *s)
1137 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1138 REF_PRINT_COUNT("SSL", s);
1141 REF_ASSERT_ISNT(i < 0);
1143 X509_VERIFY_PARAM_free(s->param);
1144 dane_final(&s->dane);
1145 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1147 /* Ignore return value */
1148 ssl_free_wbio_buffer(s);
1150 BIO_free_all(s->wbio);
1151 BIO_free_all(s->rbio);
1153 BUF_MEM_free(s->init_buf);
1155 /* add extra stuff */
1156 sk_SSL_CIPHER_free(s->cipher_list);
1157 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1158 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1160 /* Make the next call work :-) */
1161 if (s->session != NULL) {
1162 ssl_clear_bad_session(s);
1163 SSL_SESSION_free(s->session);
1165 SSL_SESSION_free(s->psksession);
1166 OPENSSL_free(s->psksession_id);
1170 ssl_cert_free(s->cert);
1171 /* Free up if allocated */
1173 OPENSSL_free(s->ext.hostname);
1174 SSL_CTX_free(s->session_ctx);
1175 #ifndef OPENSSL_NO_EC
1176 OPENSSL_free(s->ext.ecpointformats);
1177 OPENSSL_free(s->ext.supportedgroups);
1178 #endif /* OPENSSL_NO_EC */
1179 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1180 #ifndef OPENSSL_NO_OCSP
1181 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1183 #ifndef OPENSSL_NO_CT
1184 SCT_LIST_free(s->scts);
1185 OPENSSL_free(s->ext.scts);
1187 OPENSSL_free(s->ext.ocsp.resp);
1188 OPENSSL_free(s->ext.alpn);
1189 OPENSSL_free(s->ext.tls13_cookie);
1190 OPENSSL_free(s->clienthello);
1191 OPENSSL_free(s->pha_context);
1192 EVP_MD_CTX_free(s->pha_dgst);
1194 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1196 sk_X509_pop_free(s->verified_chain, X509_free);
1198 if (s->method != NULL)
1199 s->method->ssl_free(s);
1201 RECORD_LAYER_release(&s->rlayer);
1203 SSL_CTX_free(s->ctx);
1205 ASYNC_WAIT_CTX_free(s->waitctx);
1207 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1208 OPENSSL_free(s->ext.npn);
1211 #ifndef OPENSSL_NO_SRTP
1212 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1215 CRYPTO_THREAD_lock_free(s->lock);
1220 void SSL_set0_rbio(SSL *s, BIO *rbio)
1222 BIO_free_all(s->rbio);
1226 void SSL_set0_wbio(SSL *s, BIO *wbio)
1229 * If the output buffering BIO is still in place, remove it
1231 if (s->bbio != NULL)
1232 s->wbio = BIO_pop(s->wbio);
1234 BIO_free_all(s->wbio);
1237 /* Re-attach |bbio| to the new |wbio|. */
1238 if (s->bbio != NULL)
1239 s->wbio = BIO_push(s->bbio, s->wbio);
1242 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1245 * For historical reasons, this function has many different cases in
1246 * ownership handling.
1249 /* If nothing has changed, do nothing */
1250 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1254 * If the two arguments are equal then one fewer reference is granted by the
1255 * caller than we want to take
1257 if (rbio != NULL && rbio == wbio)
1261 * If only the wbio is changed only adopt one reference.
1263 if (rbio == SSL_get_rbio(s)) {
1264 SSL_set0_wbio(s, wbio);
1268 * There is an asymmetry here for historical reasons. If only the rbio is
1269 * changed AND the rbio and wbio were originally different, then we only
1270 * adopt one reference.
1272 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1273 SSL_set0_rbio(s, rbio);
1277 /* Otherwise, adopt both references. */
1278 SSL_set0_rbio(s, rbio);
1279 SSL_set0_wbio(s, wbio);
1282 BIO *SSL_get_rbio(const SSL *s)
1287 BIO *SSL_get_wbio(const SSL *s)
1289 if (s->bbio != NULL) {
1291 * If |bbio| is active, the true caller-configured BIO is its
1294 return BIO_next(s->bbio);
1299 int SSL_get_fd(const SSL *s)
1301 return SSL_get_rfd(s);
1304 int SSL_get_rfd(const SSL *s)
1309 b = SSL_get_rbio(s);
1310 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1312 BIO_get_fd(r, &ret);
1316 int SSL_get_wfd(const SSL *s)
1321 b = SSL_get_wbio(s);
1322 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1324 BIO_get_fd(r, &ret);
1328 #ifndef OPENSSL_NO_SOCK
1329 int SSL_set_fd(SSL *s, int fd)
1334 bio = BIO_new(BIO_s_socket());
1337 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1340 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1341 SSL_set_bio(s, bio, bio);
1347 int SSL_set_wfd(SSL *s, int fd)
1349 BIO *rbio = SSL_get_rbio(s);
1351 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1352 || (int)BIO_get_fd(rbio, NULL) != fd) {
1353 BIO *bio = BIO_new(BIO_s_socket());
1356 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1359 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1360 SSL_set0_wbio(s, bio);
1363 SSL_set0_wbio(s, rbio);
1368 int SSL_set_rfd(SSL *s, int fd)
1370 BIO *wbio = SSL_get_wbio(s);
1372 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1373 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1374 BIO *bio = BIO_new(BIO_s_socket());
1377 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1380 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1381 SSL_set0_rbio(s, bio);
1384 SSL_set0_rbio(s, wbio);
1391 /* return length of latest Finished message we sent, copy to 'buf' */
1392 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1396 if (s->s3 != NULL) {
1397 ret = s->s3->tmp.finish_md_len;
1400 memcpy(buf, s->s3->tmp.finish_md, count);
1405 /* return length of latest Finished message we expected, copy to 'buf' */
1406 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1410 if (s->s3 != NULL) {
1411 ret = s->s3->tmp.peer_finish_md_len;
1414 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1419 int SSL_get_verify_mode(const SSL *s)
1421 return s->verify_mode;
1424 int SSL_get_verify_depth(const SSL *s)
1426 return X509_VERIFY_PARAM_get_depth(s->param);
1429 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1430 return s->verify_callback;
1433 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1435 return ctx->verify_mode;
1438 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1440 return X509_VERIFY_PARAM_get_depth(ctx->param);
1443 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1444 return ctx->default_verify_callback;
1447 void SSL_set_verify(SSL *s, int mode,
1448 int (*callback) (int ok, X509_STORE_CTX *ctx))
1450 s->verify_mode = mode;
1451 if (callback != NULL)
1452 s->verify_callback = callback;
1455 void SSL_set_verify_depth(SSL *s, int depth)
1457 X509_VERIFY_PARAM_set_depth(s->param, depth);
1460 void SSL_set_read_ahead(SSL *s, int yes)
1462 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1465 int SSL_get_read_ahead(const SSL *s)
1467 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1470 int SSL_pending(const SSL *s)
1472 size_t pending = s->method->ssl_pending(s);
1475 * SSL_pending cannot work properly if read-ahead is enabled
1476 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1477 * impossible to fix since SSL_pending cannot report errors that may be
1478 * observed while scanning the new data. (Note that SSL_pending() is
1479 * often used as a boolean value, so we'd better not return -1.)
1481 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1482 * we just return INT_MAX.
1484 return pending < INT_MAX ? (int)pending : INT_MAX;
1487 int SSL_has_pending(const SSL *s)
1490 * Similar to SSL_pending() but returns a 1 to indicate that we have
1491 * unprocessed data available or 0 otherwise (as opposed to the number of
1492 * bytes available). Unlike SSL_pending() this will take into account
1493 * read_ahead data. A 1 return simply indicates that we have unprocessed
1494 * data. That data may not result in any application data, or we may fail
1495 * to parse the records for some reason.
1497 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1500 return RECORD_LAYER_read_pending(&s->rlayer);
1503 X509 *SSL_get_peer_certificate(const SSL *s)
1507 if ((s == NULL) || (s->session == NULL))
1510 r = s->session->peer;
1520 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1524 if ((s == NULL) || (s->session == NULL))
1527 r = s->session->peer_chain;
1530 * If we are a client, cert_chain includes the peer's own certificate; if
1531 * we are a server, it does not.
1538 * Now in theory, since the calling process own 't' it should be safe to
1539 * modify. We need to be able to read f without being hassled
1541 int SSL_copy_session_id(SSL *t, const SSL *f)
1544 /* Do we need to to SSL locking? */
1545 if (!SSL_set_session(t, SSL_get_session(f))) {
1550 * what if we are setup for one protocol version but want to talk another
1552 if (t->method != f->method) {
1553 t->method->ssl_free(t);
1554 t->method = f->method;
1555 if (t->method->ssl_new(t) == 0)
1559 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1560 ssl_cert_free(t->cert);
1562 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1569 /* Fix this so it checks all the valid key/cert options */
1570 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1572 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1573 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1576 if (ctx->cert->key->privatekey == NULL) {
1577 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1580 return X509_check_private_key
1581 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1584 /* Fix this function so that it takes an optional type parameter */
1585 int SSL_check_private_key(const SSL *ssl)
1588 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1591 if (ssl->cert->key->x509 == NULL) {
1592 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1595 if (ssl->cert->key->privatekey == NULL) {
1596 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1599 return X509_check_private_key(ssl->cert->key->x509,
1600 ssl->cert->key->privatekey);
1603 int SSL_waiting_for_async(SSL *s)
1611 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1613 ASYNC_WAIT_CTX *ctx = s->waitctx;
1617 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1620 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1621 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1623 ASYNC_WAIT_CTX *ctx = s->waitctx;
1627 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1631 int SSL_accept(SSL *s)
1633 if (s->handshake_func == NULL) {
1634 /* Not properly initialized yet */
1635 SSL_set_accept_state(s);
1638 return SSL_do_handshake(s);
1641 int SSL_connect(SSL *s)
1643 if (s->handshake_func == NULL) {
1644 /* Not properly initialized yet */
1645 SSL_set_connect_state(s);
1648 return SSL_do_handshake(s);
1651 long SSL_get_default_timeout(const SSL *s)
1653 return s->method->get_timeout();
1656 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1657 int (*func) (void *))
1660 if (s->waitctx == NULL) {
1661 s->waitctx = ASYNC_WAIT_CTX_new();
1662 if (s->waitctx == NULL)
1665 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1666 sizeof(struct ssl_async_args))) {
1668 s->rwstate = SSL_NOTHING;
1669 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1672 s->rwstate = SSL_ASYNC_PAUSED;
1675 s->rwstate = SSL_ASYNC_NO_JOBS;
1681 s->rwstate = SSL_NOTHING;
1682 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1683 /* Shouldn't happen */
1688 static int ssl_io_intern(void *vargs)
1690 struct ssl_async_args *args;
1695 args = (struct ssl_async_args *)vargs;
1699 switch (args->type) {
1701 return args->f.func_read(s, buf, num, &s->asyncrw);
1703 return args->f.func_write(s, buf, num, &s->asyncrw);
1705 return args->f.func_other(s);
1710 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1712 if (s->handshake_func == NULL) {
1713 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1717 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1718 s->rwstate = SSL_NOTHING;
1722 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1723 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1724 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1728 * If we are a client and haven't received the ServerHello etc then we
1731 ossl_statem_check_finish_init(s, 0);
1733 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1734 struct ssl_async_args args;
1740 args.type = READFUNC;
1741 args.f.func_read = s->method->ssl_read;
1743 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1744 *readbytes = s->asyncrw;
1747 return s->method->ssl_read(s, buf, num, readbytes);
1751 int SSL_read(SSL *s, void *buf, int num)
1757 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1761 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1764 * The cast is safe here because ret should be <= INT_MAX because num is
1768 ret = (int)readbytes;
1773 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1775 int ret = ssl_read_internal(s, buf, num, readbytes);
1782 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1787 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1788 return SSL_READ_EARLY_DATA_ERROR;
1791 switch (s->early_data_state) {
1792 case SSL_EARLY_DATA_NONE:
1793 if (!SSL_in_before(s)) {
1794 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1795 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1796 return SSL_READ_EARLY_DATA_ERROR;
1800 case SSL_EARLY_DATA_ACCEPT_RETRY:
1801 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1802 ret = SSL_accept(s);
1805 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1806 return SSL_READ_EARLY_DATA_ERROR;
1810 case SSL_EARLY_DATA_READ_RETRY:
1811 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1812 s->early_data_state = SSL_EARLY_DATA_READING;
1813 ret = SSL_read_ex(s, buf, num, readbytes);
1815 * State machine will update early_data_state to
1816 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1819 if (ret > 0 || (ret <= 0 && s->early_data_state
1820 != SSL_EARLY_DATA_FINISHED_READING)) {
1821 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1822 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1823 : SSL_READ_EARLY_DATA_ERROR;
1826 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1829 return SSL_READ_EARLY_DATA_FINISH;
1832 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1833 return SSL_READ_EARLY_DATA_ERROR;
1837 int SSL_get_early_data_status(const SSL *s)
1839 return s->ext.early_data;
1842 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1844 if (s->handshake_func == NULL) {
1845 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1849 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1852 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1853 struct ssl_async_args args;
1859 args.type = READFUNC;
1860 args.f.func_read = s->method->ssl_peek;
1862 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1863 *readbytes = s->asyncrw;
1866 return s->method->ssl_peek(s, buf, num, readbytes);
1870 int SSL_peek(SSL *s, void *buf, int num)
1876 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1880 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1883 * The cast is safe here because ret should be <= INT_MAX because num is
1887 ret = (int)readbytes;
1893 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1895 int ret = ssl_peek_internal(s, buf, num, readbytes);
1902 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1904 if (s->handshake_func == NULL) {
1905 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1909 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1910 s->rwstate = SSL_NOTHING;
1911 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1915 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1916 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1917 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1918 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1921 /* If we are a client and haven't sent the Finished we better do that */
1922 ossl_statem_check_finish_init(s, 1);
1924 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1926 struct ssl_async_args args;
1929 args.buf = (void *)buf;
1931 args.type = WRITEFUNC;
1932 args.f.func_write = s->method->ssl_write;
1934 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1935 *written = s->asyncrw;
1938 return s->method->ssl_write(s, buf, num, written);
1942 int SSL_write(SSL *s, const void *buf, int num)
1948 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1952 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1955 * The cast is safe here because ret should be <= INT_MAX because num is
1964 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1966 int ret = ssl_write_internal(s, buf, num, written);
1973 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1975 int ret, early_data_state;
1977 uint32_t partialwrite;
1979 switch (s->early_data_state) {
1980 case SSL_EARLY_DATA_NONE:
1982 || !SSL_in_before(s)
1983 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1984 && (s->psk_use_session_cb == NULL))) {
1985 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1986 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1991 case SSL_EARLY_DATA_CONNECT_RETRY:
1992 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1993 ret = SSL_connect(s);
1996 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2001 case SSL_EARLY_DATA_WRITE_RETRY:
2002 s->early_data_state = SSL_EARLY_DATA_WRITING;
2004 * We disable partial write for early data because we don't keep track
2005 * of how many bytes we've written between the SSL_write_ex() call and
2006 * the flush if the flush needs to be retried)
2008 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2009 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2010 ret = SSL_write_ex(s, buf, num, &writtmp);
2011 s->mode |= partialwrite;
2013 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2016 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2019 case SSL_EARLY_DATA_WRITE_FLUSH:
2020 /* The buffering BIO is still in place so we need to flush it */
2021 if (statem_flush(s) != 1)
2024 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2027 case SSL_EARLY_DATA_FINISHED_READING:
2028 case SSL_EARLY_DATA_READ_RETRY:
2029 early_data_state = s->early_data_state;
2030 /* We are a server writing to an unauthenticated client */
2031 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2032 ret = SSL_write_ex(s, buf, num, written);
2033 /* The buffering BIO is still in place */
2035 (void)BIO_flush(s->wbio);
2036 s->early_data_state = early_data_state;
2040 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2045 int SSL_shutdown(SSL *s)
2048 * Note that this function behaves differently from what one might
2049 * expect. Return values are 0 for no success (yet), 1 for success; but
2050 * calling it once is usually not enough, even if blocking I/O is used
2051 * (see ssl3_shutdown).
2054 if (s->handshake_func == NULL) {
2055 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2059 if (!SSL_in_init(s)) {
2060 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2061 struct ssl_async_args args;
2064 args.type = OTHERFUNC;
2065 args.f.func_other = s->method->ssl_shutdown;
2067 return ssl_start_async_job(s, &args, ssl_io_intern);
2069 return s->method->ssl_shutdown(s);
2072 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2077 int SSL_key_update(SSL *s, int updatetype)
2080 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2081 * negotiated, and that it is appropriate to call SSL_key_update() instead
2082 * of SSL_renegotiate().
2084 if (!SSL_IS_TLS13(s)) {
2085 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2089 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2090 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2091 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2095 if (!SSL_is_init_finished(s)) {
2096 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2100 ossl_statem_set_in_init(s, 1);
2101 s->key_update = updatetype;
2105 int SSL_get_key_update_type(SSL *s)
2107 return s->key_update;
2110 int SSL_renegotiate(SSL *s)
2112 if (SSL_IS_TLS13(s)) {
2113 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2117 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2118 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2125 return s->method->ssl_renegotiate(s);
2128 int SSL_renegotiate_abbreviated(SSL *s)
2130 if (SSL_IS_TLS13(s)) {
2131 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2135 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2136 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2143 return s->method->ssl_renegotiate(s);
2146 int SSL_renegotiate_pending(SSL *s)
2149 * becomes true when negotiation is requested; false again once a
2150 * handshake has finished
2152 return (s->renegotiate != 0);
2155 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2160 case SSL_CTRL_GET_READ_AHEAD:
2161 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2162 case SSL_CTRL_SET_READ_AHEAD:
2163 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2164 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2167 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2168 s->msg_callback_arg = parg;
2172 return (s->mode |= larg);
2173 case SSL_CTRL_CLEAR_MODE:
2174 return (s->mode &= ~larg);
2175 case SSL_CTRL_GET_MAX_CERT_LIST:
2176 return (long)s->max_cert_list;
2177 case SSL_CTRL_SET_MAX_CERT_LIST:
2180 l = (long)s->max_cert_list;
2181 s->max_cert_list = (size_t)larg;
2183 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2184 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2186 s->max_send_fragment = larg;
2187 if (s->max_send_fragment < s->split_send_fragment)
2188 s->split_send_fragment = s->max_send_fragment;
2190 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2191 if ((size_t)larg > s->max_send_fragment || larg == 0)
2193 s->split_send_fragment = larg;
2195 case SSL_CTRL_SET_MAX_PIPELINES:
2196 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2198 s->max_pipelines = larg;
2200 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2202 case SSL_CTRL_GET_RI_SUPPORT:
2204 return s->s3->send_connection_binding;
2207 case SSL_CTRL_CERT_FLAGS:
2208 return (s->cert->cert_flags |= larg);
2209 case SSL_CTRL_CLEAR_CERT_FLAGS:
2210 return (s->cert->cert_flags &= ~larg);
2212 case SSL_CTRL_GET_RAW_CIPHERLIST:
2214 if (s->s3->tmp.ciphers_raw == NULL)
2216 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2217 return (int)s->s3->tmp.ciphers_rawlen;
2219 return TLS_CIPHER_LEN;
2221 case SSL_CTRL_GET_EXTMS_SUPPORT:
2222 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2224 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2228 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2229 return ssl_check_allowed_versions(larg, s->max_proto_version)
2230 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2231 &s->min_proto_version);
2232 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2233 return s->min_proto_version;
2234 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2235 return ssl_check_allowed_versions(s->min_proto_version, larg)
2236 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2237 &s->max_proto_version);
2238 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2239 return s->max_proto_version;
2241 return s->method->ssl_ctrl(s, cmd, larg, parg);
2245 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2248 case SSL_CTRL_SET_MSG_CALLBACK:
2249 s->msg_callback = (void (*)
2250 (int write_p, int version, int content_type,
2251 const void *buf, size_t len, SSL *ssl,
2256 return s->method->ssl_callback_ctrl(s, cmd, fp);
2260 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2262 return ctx->sessions;
2265 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2268 /* For some cases with ctx == NULL perform syntax checks */
2271 #ifndef OPENSSL_NO_EC
2272 case SSL_CTRL_SET_GROUPS_LIST:
2273 return tls1_set_groups_list(NULL, NULL, parg);
2275 case SSL_CTRL_SET_SIGALGS_LIST:
2276 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2277 return tls1_set_sigalgs_list(NULL, parg, 0);
2284 case SSL_CTRL_GET_READ_AHEAD:
2285 return ctx->read_ahead;
2286 case SSL_CTRL_SET_READ_AHEAD:
2287 l = ctx->read_ahead;
2288 ctx->read_ahead = larg;
2291 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2292 ctx->msg_callback_arg = parg;
2295 case SSL_CTRL_GET_MAX_CERT_LIST:
2296 return (long)ctx->max_cert_list;
2297 case SSL_CTRL_SET_MAX_CERT_LIST:
2300 l = (long)ctx->max_cert_list;
2301 ctx->max_cert_list = (size_t)larg;
2304 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2307 l = (long)ctx->session_cache_size;
2308 ctx->session_cache_size = (size_t)larg;
2310 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2311 return (long)ctx->session_cache_size;
2312 case SSL_CTRL_SET_SESS_CACHE_MODE:
2313 l = ctx->session_cache_mode;
2314 ctx->session_cache_mode = larg;
2316 case SSL_CTRL_GET_SESS_CACHE_MODE:
2317 return ctx->session_cache_mode;
2319 case SSL_CTRL_SESS_NUMBER:
2320 return lh_SSL_SESSION_num_items(ctx->sessions);
2321 case SSL_CTRL_SESS_CONNECT:
2322 return tsan_load(&ctx->stats.sess_connect);
2323 case SSL_CTRL_SESS_CONNECT_GOOD:
2324 return tsan_load(&ctx->stats.sess_connect_good);
2325 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2326 return tsan_load(&ctx->stats.sess_connect_renegotiate);
2327 case SSL_CTRL_SESS_ACCEPT:
2328 return tsan_load(&ctx->stats.sess_accept);
2329 case SSL_CTRL_SESS_ACCEPT_GOOD:
2330 return tsan_load(&ctx->stats.sess_accept_good);
2331 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2332 return tsan_load(&ctx->stats.sess_accept_renegotiate);
2333 case SSL_CTRL_SESS_HIT:
2334 return tsan_load(&ctx->stats.sess_hit);
2335 case SSL_CTRL_SESS_CB_HIT:
2336 return tsan_load(&ctx->stats.sess_cb_hit);
2337 case SSL_CTRL_SESS_MISSES:
2338 return tsan_load(&ctx->stats.sess_miss);
2339 case SSL_CTRL_SESS_TIMEOUTS:
2340 return tsan_load(&ctx->stats.sess_timeout);
2341 case SSL_CTRL_SESS_CACHE_FULL:
2342 return tsan_load(&ctx->stats.sess_cache_full);
2344 return (ctx->mode |= larg);
2345 case SSL_CTRL_CLEAR_MODE:
2346 return (ctx->mode &= ~larg);
2347 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2348 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2350 ctx->max_send_fragment = larg;
2351 if (ctx->max_send_fragment < ctx->split_send_fragment)
2352 ctx->split_send_fragment = ctx->max_send_fragment;
2354 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2355 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2357 ctx->split_send_fragment = larg;
2359 case SSL_CTRL_SET_MAX_PIPELINES:
2360 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2362 ctx->max_pipelines = larg;
2364 case SSL_CTRL_CERT_FLAGS:
2365 return (ctx->cert->cert_flags |= larg);
2366 case SSL_CTRL_CLEAR_CERT_FLAGS:
2367 return (ctx->cert->cert_flags &= ~larg);
2368 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2369 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2370 && ssl_set_version_bound(ctx->method->version, (int)larg,
2371 &ctx->min_proto_version);
2372 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2373 return ctx->min_proto_version;
2374 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2375 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2376 && ssl_set_version_bound(ctx->method->version, (int)larg,
2377 &ctx->max_proto_version);
2378 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2379 return ctx->max_proto_version;
2381 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2385 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2388 case SSL_CTRL_SET_MSG_CALLBACK:
2389 ctx->msg_callback = (void (*)
2390 (int write_p, int version, int content_type,
2391 const void *buf, size_t len, SSL *ssl,
2396 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2400 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2409 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2410 const SSL_CIPHER *const *bp)
2412 if ((*ap)->id > (*bp)->id)
2414 if ((*ap)->id < (*bp)->id)
2419 /** return a STACK of the ciphers available for the SSL and in order of
2421 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2424 if (s->cipher_list != NULL) {
2425 return s->cipher_list;
2426 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2427 return s->ctx->cipher_list;
2433 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2435 if ((s == NULL) || (s->session == NULL) || !s->server)
2437 return s->session->ciphers;
2440 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2442 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2445 ciphers = SSL_get_ciphers(s);
2448 if (!ssl_set_client_disabled(s))
2450 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2451 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2452 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2454 sk = sk_SSL_CIPHER_new_null();
2457 if (!sk_SSL_CIPHER_push(sk, c)) {
2458 sk_SSL_CIPHER_free(sk);
2466 /** return a STACK of the ciphers available for the SSL and in order of
2468 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2471 if (s->cipher_list_by_id != NULL) {
2472 return s->cipher_list_by_id;
2473 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2474 return s->ctx->cipher_list_by_id;
2480 /** The old interface to get the same thing as SSL_get_ciphers() */
2481 const char *SSL_get_cipher_list(const SSL *s, int n)
2483 const SSL_CIPHER *c;
2484 STACK_OF(SSL_CIPHER) *sk;
2488 sk = SSL_get_ciphers(s);
2489 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2491 c = sk_SSL_CIPHER_value(sk, n);
2497 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2499 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2502 return ctx->cipher_list;
2506 /** specify the ciphers to be used by default by the SSL_CTX */
2507 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2509 STACK_OF(SSL_CIPHER) *sk;
2511 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2512 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2515 * ssl_create_cipher_list may return an empty stack if it was unable to
2516 * find a cipher matching the given rule string (for example if the rule
2517 * string specifies a cipher which has been disabled). This is not an
2518 * error as far as ssl_create_cipher_list is concerned, and hence
2519 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2523 else if (sk_SSL_CIPHER_num(sk) == 0) {
2524 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2530 /** specify the ciphers to be used by the SSL */
2531 int SSL_set_cipher_list(SSL *s, const char *str)
2533 STACK_OF(SSL_CIPHER) *sk;
2535 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2536 &s->cipher_list, &s->cipher_list_by_id, str,
2538 /* see comment in SSL_CTX_set_cipher_list */
2541 else if (sk_SSL_CIPHER_num(sk) == 0) {
2542 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2548 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2551 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2552 const SSL_CIPHER *c;
2556 || s->session == NULL
2557 || s->session->ciphers == NULL
2562 clntsk = s->session->ciphers;
2563 srvrsk = SSL_get_ciphers(s);
2564 if (clntsk == NULL || srvrsk == NULL)
2567 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2570 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2573 c = sk_SSL_CIPHER_value(clntsk, i);
2574 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2577 n = strlen(c->name);
2593 /** return a servername extension value if provided in Client Hello, or NULL.
2594 * So far, only host_name types are defined (RFC 3546).
2597 const char *SSL_get_servername(const SSL *s, const int type)
2599 if (type != TLSEXT_NAMETYPE_host_name)
2603 * TODO(OpenSSL1.2) clean up this compat mess. This API is
2604 * currently a mix of "what did I configure" and "what did the
2605 * peer send" and "what was actually negotiated"; we should have
2606 * a clear distinction amongst those three.
2608 if (SSL_in_init(s)) {
2610 return s->session->ext.hostname;
2611 return s->ext.hostname;
2613 return (s->session != NULL && s->ext.hostname == NULL) ?
2614 s->session->ext.hostname : s->ext.hostname;
2617 int SSL_get_servername_type(const SSL *s)
2620 && (!s->ext.hostname ? s->session->
2621 ext.hostname : s->ext.hostname))
2622 return TLSEXT_NAMETYPE_host_name;
2627 * SSL_select_next_proto implements the standard protocol selection. It is
2628 * expected that this function is called from the callback set by
2629 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2630 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2631 * not included in the length. A byte string of length 0 is invalid. No byte
2632 * string may be truncated. The current, but experimental algorithm for
2633 * selecting the protocol is: 1) If the server doesn't support NPN then this
2634 * is indicated to the callback. In this case, the client application has to
2635 * abort the connection or have a default application level protocol. 2) If
2636 * the server supports NPN, but advertises an empty list then the client
2637 * selects the first protocol in its list, but indicates via the API that this
2638 * fallback case was enacted. 3) Otherwise, the client finds the first
2639 * protocol in the server's list that it supports and selects this protocol.
2640 * This is because it's assumed that the server has better information about
2641 * which protocol a client should use. 4) If the client doesn't support any
2642 * of the server's advertised protocols, then this is treated the same as
2643 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2644 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2646 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2647 const unsigned char *server,
2648 unsigned int server_len,
2649 const unsigned char *client, unsigned int client_len)
2652 const unsigned char *result;
2653 int status = OPENSSL_NPN_UNSUPPORTED;
2656 * For each protocol in server preference order, see if we support it.
2658 for (i = 0; i < server_len;) {
2659 for (j = 0; j < client_len;) {
2660 if (server[i] == client[j] &&
2661 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2662 /* We found a match */
2663 result = &server[i];
2664 status = OPENSSL_NPN_NEGOTIATED;
2674 /* There's no overlap between our protocols and the server's list. */
2676 status = OPENSSL_NPN_NO_OVERLAP;
2679 *out = (unsigned char *)result + 1;
2680 *outlen = result[0];
2684 #ifndef OPENSSL_NO_NEXTPROTONEG
2686 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2687 * client's requested protocol for this connection and returns 0. If the
2688 * client didn't request any protocol, then *data is set to NULL. Note that
2689 * the client can request any protocol it chooses. The value returned from
2690 * this function need not be a member of the list of supported protocols
2691 * provided by the callback.
2693 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2700 *len = (unsigned int)s->ext.npn_len;
2705 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2706 * a TLS server needs a list of supported protocols for Next Protocol
2707 * Negotiation. The returned list must be in wire format. The list is
2708 * returned by setting |out| to point to it and |outlen| to its length. This
2709 * memory will not be modified, but one should assume that the SSL* keeps a
2710 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2711 * wishes to advertise. Otherwise, no such extension will be included in the
2714 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2715 SSL_CTX_npn_advertised_cb_func cb,
2718 ctx->ext.npn_advertised_cb = cb;
2719 ctx->ext.npn_advertised_cb_arg = arg;
2723 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2724 * client needs to select a protocol from the server's provided list. |out|
2725 * must be set to point to the selected protocol (which may be within |in|).
2726 * The length of the protocol name must be written into |outlen|. The
2727 * server's advertised protocols are provided in |in| and |inlen|. The
2728 * callback can assume that |in| is syntactically valid. The client must
2729 * select a protocol. It is fatal to the connection if this callback returns
2730 * a value other than SSL_TLSEXT_ERR_OK.
2732 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2733 SSL_CTX_npn_select_cb_func cb,
2736 ctx->ext.npn_select_cb = cb;
2737 ctx->ext.npn_select_cb_arg = arg;
2742 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2743 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2744 * length-prefixed strings). Returns 0 on success.
2746 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2747 unsigned int protos_len)
2749 OPENSSL_free(ctx->ext.alpn);
2750 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2751 if (ctx->ext.alpn == NULL) {
2752 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2755 ctx->ext.alpn_len = protos_len;
2761 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2762 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2763 * length-prefixed strings). Returns 0 on success.
2765 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2766 unsigned int protos_len)
2768 OPENSSL_free(ssl->ext.alpn);
2769 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2770 if (ssl->ext.alpn == NULL) {
2771 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2774 ssl->ext.alpn_len = protos_len;
2780 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2781 * called during ClientHello processing in order to select an ALPN protocol
2782 * from the client's list of offered protocols.
2784 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2785 SSL_CTX_alpn_select_cb_func cb,
2788 ctx->ext.alpn_select_cb = cb;
2789 ctx->ext.alpn_select_cb_arg = arg;
2793 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2794 * On return it sets |*data| to point to |*len| bytes of protocol name
2795 * (not including the leading length-prefix byte). If the server didn't
2796 * respond with a negotiated protocol then |*len| will be zero.
2798 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2803 *data = ssl->s3->alpn_selected;
2807 *len = (unsigned int)ssl->s3->alpn_selected_len;
2810 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2811 const char *label, size_t llen,
2812 const unsigned char *context, size_t contextlen,
2815 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2818 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2820 contextlen, use_context);
2823 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2824 const char *label, size_t llen,
2825 const unsigned char *context,
2828 if (s->version != TLS1_3_VERSION)
2831 return tls13_export_keying_material_early(s, out, olen, label, llen,
2832 context, contextlen);
2835 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2837 const unsigned char *session_id = a->session_id;
2839 unsigned char tmp_storage[4];
2841 if (a->session_id_length < sizeof(tmp_storage)) {
2842 memset(tmp_storage, 0, sizeof(tmp_storage));
2843 memcpy(tmp_storage, a->session_id, a->session_id_length);
2844 session_id = tmp_storage;
2848 ((unsigned long)session_id[0]) |
2849 ((unsigned long)session_id[1] << 8L) |
2850 ((unsigned long)session_id[2] << 16L) |
2851 ((unsigned long)session_id[3] << 24L);
2856 * NB: If this function (or indeed the hash function which uses a sort of
2857 * coarser function than this one) is changed, ensure
2858 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2859 * being able to construct an SSL_SESSION that will collide with any existing
2860 * session with a matching session ID.
2862 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2864 if (a->ssl_version != b->ssl_version)
2866 if (a->session_id_length != b->session_id_length)
2868 return memcmp(a->session_id, b->session_id, a->session_id_length);
2872 * These wrapper functions should remain rather than redeclaring
2873 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2874 * variable. The reason is that the functions aren't static, they're exposed
2878 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2880 SSL_CTX *ret = NULL;
2883 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2887 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2890 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2891 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2894 ret = OPENSSL_zalloc(sizeof(*ret));
2899 ret->min_proto_version = 0;
2900 ret->max_proto_version = 0;
2901 ret->mode = SSL_MODE_AUTO_RETRY;
2902 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2903 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2904 /* We take the system default. */
2905 ret->session_timeout = meth->get_timeout();
2906 ret->references = 1;
2907 ret->lock = CRYPTO_THREAD_lock_new();
2908 if (ret->lock == NULL) {
2909 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2913 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2914 ret->verify_mode = SSL_VERIFY_NONE;
2915 if ((ret->cert = ssl_cert_new()) == NULL)
2918 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2919 if (ret->sessions == NULL)
2921 ret->cert_store = X509_STORE_new();
2922 if (ret->cert_store == NULL)
2924 #ifndef OPENSSL_NO_CT
2925 ret->ctlog_store = CTLOG_STORE_new();
2926 if (ret->ctlog_store == NULL)
2930 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
2933 if (!ssl_create_cipher_list(ret->method,
2934 ret->tls13_ciphersuites,
2935 &ret->cipher_list, &ret->cipher_list_by_id,
2936 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2937 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2938 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2942 ret->param = X509_VERIFY_PARAM_new();
2943 if (ret->param == NULL)
2946 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2947 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2950 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2951 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2955 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2958 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2961 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
2964 /* No compression for DTLS */
2965 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2966 ret->comp_methods = SSL_COMP_get_compression_methods();
2968 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2969 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2971 /* Setup RFC5077 ticket keys */
2972 if ((RAND_bytes(ret->ext.tick_key_name,
2973 sizeof(ret->ext.tick_key_name)) <= 0)
2974 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
2975 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
2976 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
2977 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
2978 ret->options |= SSL_OP_NO_TICKET;
2980 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
2981 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2984 #ifndef OPENSSL_NO_SRP
2985 if (!SSL_CTX_SRP_CTX_init(ret))
2988 #ifndef OPENSSL_NO_ENGINE
2989 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2990 # define eng_strx(x) #x
2991 # define eng_str(x) eng_strx(x)
2992 /* Use specific client engine automatically... ignore errors */
2995 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2998 ENGINE_load_builtin_engines();
2999 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3001 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3007 * Default is to connect to non-RI servers. When RI is more widely
3008 * deployed might change this.
3010 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3012 * Disable compression by default to prevent CRIME. Applications can
3013 * re-enable compression by configuring
3014 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3015 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3016 * middlebox compatibility by default. This may be disabled by default in
3017 * a later OpenSSL version.
3019 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3021 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3024 * We cannot usefully set a default max_early_data here (which gets
3025 * propagated in SSL_new(), for the following reason: setting the
3026 * SSL field causes tls_construct_stoc_early_data() to tell the
3027 * client that early data will be accepted when constructing a TLS 1.3
3028 * session ticket, and the client will accordingly send us early data
3029 * when using that ticket (if the client has early data to send).
3030 * However, in order for the early data to actually be consumed by
3031 * the application, the application must also have calls to
3032 * SSL_read_early_data(); otherwise we'll just skip past the early data
3033 * and ignore it. So, since the application must add calls to
3034 * SSL_read_early_data(), we also require them to add
3035 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3036 * eliminating the bandwidth-wasting early data in the case described
3039 ret->max_early_data = 0;
3042 * Default recv_max_early_data is a fully loaded single record. Could be
3043 * split across multiple records in practice. We set this differently to
3044 * max_early_data so that, in the default case, we do not advertise any
3045 * support for early_data, but if a client were to send us some (e.g.
3046 * because of an old, stale ticket) then we will tolerate it and skip over
3049 ret->recv_max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
3051 /* By default we send two session tickets automatically in TLSv1.3 */
3052 ret->num_tickets = 2;
3054 ssl_ctx_system_config(ret);
3058 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3064 int SSL_CTX_up_ref(SSL_CTX *ctx)
3068 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3071 REF_PRINT_COUNT("SSL_CTX", ctx);
3072 REF_ASSERT_ISNT(i < 2);
3073 return ((i > 1) ? 1 : 0);
3076 void SSL_CTX_free(SSL_CTX *a)
3083 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3084 REF_PRINT_COUNT("SSL_CTX", a);
3087 REF_ASSERT_ISNT(i < 0);
3089 X509_VERIFY_PARAM_free(a->param);
3090 dane_ctx_final(&a->dane);
3093 * Free internal session cache. However: the remove_cb() may reference
3094 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3095 * after the sessions were flushed.
3096 * As the ex_data handling routines might also touch the session cache,
3097 * the most secure solution seems to be: empty (flush) the cache, then
3098 * free ex_data, then finally free the cache.
3099 * (See ticket [openssl.org #212].)
3101 if (a->sessions != NULL)
3102 SSL_CTX_flush_sessions(a, 0);
3104 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3105 lh_SSL_SESSION_free(a->sessions);
3106 X509_STORE_free(a->cert_store);
3107 #ifndef OPENSSL_NO_CT
3108 CTLOG_STORE_free(a->ctlog_store);
3110 sk_SSL_CIPHER_free(a->cipher_list);
3111 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3112 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3113 ssl_cert_free(a->cert);
3114 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3115 sk_X509_pop_free(a->extra_certs, X509_free);
3116 a->comp_methods = NULL;
3117 #ifndef OPENSSL_NO_SRTP
3118 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3120 #ifndef OPENSSL_NO_SRP
3121 SSL_CTX_SRP_CTX_free(a);
3123 #ifndef OPENSSL_NO_ENGINE
3124 ENGINE_finish(a->client_cert_engine);
3127 #ifndef OPENSSL_NO_EC
3128 OPENSSL_free(a->ext.ecpointformats);
3129 OPENSSL_free(a->ext.supportedgroups);
3131 OPENSSL_free(a->ext.alpn);
3132 OPENSSL_secure_free(a->ext.secure);
3134 CRYPTO_THREAD_lock_free(a->lock);
3139 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3141 ctx->default_passwd_callback = cb;
3144 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3146 ctx->default_passwd_callback_userdata = u;
3149 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3151 return ctx->default_passwd_callback;
3154 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3156 return ctx->default_passwd_callback_userdata;
3159 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3161 s->default_passwd_callback = cb;
3164 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3166 s->default_passwd_callback_userdata = u;
3169 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3171 return s->default_passwd_callback;
3174 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3176 return s->default_passwd_callback_userdata;
3179 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3180 int (*cb) (X509_STORE_CTX *, void *),
3183 ctx->app_verify_callback = cb;
3184 ctx->app_verify_arg = arg;
3187 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3188 int (*cb) (int, X509_STORE_CTX *))
3190 ctx->verify_mode = mode;
3191 ctx->default_verify_callback = cb;
3194 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3196 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3199 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3201 ssl_cert_set_cert_cb(c->cert, cb, arg);
3204 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3206 ssl_cert_set_cert_cb(s->cert, cb, arg);
3209 void ssl_set_masks(SSL *s)
3212 uint32_t *pvalid = s->s3->tmp.valid_flags;
3213 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3214 unsigned long mask_k, mask_a;
3215 #ifndef OPENSSL_NO_EC
3216 int have_ecc_cert, ecdsa_ok;
3221 #ifndef OPENSSL_NO_DH
3222 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3227 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3228 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3229 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3230 #ifndef OPENSSL_NO_EC
3231 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3237 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3238 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3241 #ifndef OPENSSL_NO_GOST
3242 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3243 mask_k |= SSL_kGOST;
3244 mask_a |= SSL_aGOST12;
3246 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3247 mask_k |= SSL_kGOST;
3248 mask_a |= SSL_aGOST12;
3250 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3251 mask_k |= SSL_kGOST;
3252 mask_a |= SSL_aGOST01;
3263 * If we only have an RSA-PSS certificate allow RSA authentication
3264 * if TLS 1.2 and peer supports it.
3267 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3268 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3269 && TLS1_get_version(s) == TLS1_2_VERSION))
3276 mask_a |= SSL_aNULL;
3279 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3280 * depending on the key usage extension.
3282 #ifndef OPENSSL_NO_EC
3283 if (have_ecc_cert) {
3285 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3286 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3287 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3290 mask_a |= SSL_aECDSA;
3292 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3293 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3294 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3295 && TLS1_get_version(s) == TLS1_2_VERSION)
3296 mask_a |= SSL_aECDSA;
3298 /* Allow Ed448 for TLS 1.2 if peer supports it */
3299 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3300 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3301 && TLS1_get_version(s) == TLS1_2_VERSION)
3302 mask_a |= SSL_aECDSA;
3305 #ifndef OPENSSL_NO_EC
3306 mask_k |= SSL_kECDHE;
3309 #ifndef OPENSSL_NO_PSK
3312 if (mask_k & SSL_kRSA)
3313 mask_k |= SSL_kRSAPSK;
3314 if (mask_k & SSL_kDHE)
3315 mask_k |= SSL_kDHEPSK;
3316 if (mask_k & SSL_kECDHE)
3317 mask_k |= SSL_kECDHEPSK;
3320 s->s3->tmp.mask_k = mask_k;
3321 s->s3->tmp.mask_a = mask_a;
3324 #ifndef OPENSSL_NO_EC
3326 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3328 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3329 /* key usage, if present, must allow signing */
3330 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3331 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3332 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3336 return 1; /* all checks are ok */
3341 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3342 size_t *serverinfo_length)
3344 CERT_PKEY *cpk = s->s3->tmp.cert;
3345 *serverinfo_length = 0;
3347 if (cpk == NULL || cpk->serverinfo == NULL)
3350 *serverinfo = cpk->serverinfo;
3351 *serverinfo_length = cpk->serverinfo_length;
3355 void ssl_update_cache(SSL *s, int mode)
3360 * If the session_id_length is 0, we are not supposed to cache it, and it
3361 * would be rather hard to do anyway :-)
3363 if (s->session->session_id_length == 0)
3367 * If sid_ctx_length is 0 there is no specific application context
3368 * associated with this session, so when we try to resume it and
3369 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3370 * indication that this is actually a session for the proper application
3371 * context, and the *handshake* will fail, not just the resumption attempt.
3372 * Do not cache (on the server) these sessions that are not resumable
3373 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3375 if (s->server && s->session->sid_ctx_length == 0
3376 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3379 i = s->session_ctx->session_cache_mode;
3381 && (!s->hit || SSL_IS_TLS13(s))) {
3383 * Add the session to the internal cache. In server side TLSv1.3 we
3384 * normally don't do this because by default it's a full stateless ticket
3385 * with only a dummy session id so there is no reason to cache it,
3387 * - we are doing early_data, in which case we cache so that we can
3389 * - the application has set a remove_session_cb so needs to know about
3390 * session timeout events
3391 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3393 if ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0
3394 && (!SSL_IS_TLS13(s)
3396 || (s->max_early_data > 0
3397 && (s->options & SSL_OP_NO_ANTI_REPLAY) == 0)
3398 || s->session_ctx->remove_session_cb != NULL
3399 || (s->options & SSL_OP_NO_TICKET) != 0))
3400 SSL_CTX_add_session(s->session_ctx, s->session);
3403 * Add the session to the external cache. We do this even in server side
3404 * TLSv1.3 without early data because some applications just want to
3405 * know about the creation of a session and aren't doing a full cache.
3407 if (s->session_ctx->new_session_cb != NULL) {
3408 SSL_SESSION_up_ref(s->session);
3409 if (!s->session_ctx->new_session_cb(s, s->session))
3410 SSL_SESSION_free(s->session);
3414 /* auto flush every 255 connections */
3415 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3416 TSAN_QUALIFIER int *stat;
3417 if (mode & SSL_SESS_CACHE_CLIENT)
3418 stat = &s->session_ctx->stats.sess_connect_good;
3420 stat = &s->session_ctx->stats.sess_accept_good;
3421 if ((tsan_load(stat) & 0xff) == 0xff)
3422 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3426 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3431 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3436 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3440 if (s->method != meth) {
3441 const SSL_METHOD *sm = s->method;
3442 int (*hf) (SSL *) = s->handshake_func;
3444 if (sm->version == meth->version)
3449 ret = s->method->ssl_new(s);
3452 if (hf == sm->ssl_connect)
3453 s->handshake_func = meth->ssl_connect;
3454 else if (hf == sm->ssl_accept)
3455 s->handshake_func = meth->ssl_accept;
3460 int SSL_get_error(const SSL *s, int i)
3467 return SSL_ERROR_NONE;
3470 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3471 * where we do encode the error
3473 if ((l = ERR_peek_error()) != 0) {
3474 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3475 return SSL_ERROR_SYSCALL;
3477 return SSL_ERROR_SSL;
3480 if (SSL_want_read(s)) {
3481 bio = SSL_get_rbio(s);
3482 if (BIO_should_read(bio))
3483 return SSL_ERROR_WANT_READ;
3484 else if (BIO_should_write(bio))
3486 * This one doesn't make too much sense ... We never try to write
3487 * to the rbio, and an application program where rbio and wbio
3488 * are separate couldn't even know what it should wait for.
3489 * However if we ever set s->rwstate incorrectly (so that we have
3490 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3491 * wbio *are* the same, this test works around that bug; so it
3492 * might be safer to keep it.
3494 return SSL_ERROR_WANT_WRITE;
3495 else if (BIO_should_io_special(bio)) {
3496 reason = BIO_get_retry_reason(bio);
3497 if (reason == BIO_RR_CONNECT)
3498 return SSL_ERROR_WANT_CONNECT;
3499 else if (reason == BIO_RR_ACCEPT)
3500 return SSL_ERROR_WANT_ACCEPT;
3502 return SSL_ERROR_SYSCALL; /* unknown */
3506 if (SSL_want_write(s)) {
3507 /* Access wbio directly - in order to use the buffered bio if present */
3509 if (BIO_should_write(bio))
3510 return SSL_ERROR_WANT_WRITE;
3511 else if (BIO_should_read(bio))
3513 * See above (SSL_want_read(s) with BIO_should_write(bio))
3515 return SSL_ERROR_WANT_READ;
3516 else if (BIO_should_io_special(bio)) {
3517 reason = BIO_get_retry_reason(bio);
3518 if (reason == BIO_RR_CONNECT)
3519 return SSL_ERROR_WANT_CONNECT;
3520 else if (reason == BIO_RR_ACCEPT)
3521 return SSL_ERROR_WANT_ACCEPT;
3523 return SSL_ERROR_SYSCALL;
3526 if (SSL_want_x509_lookup(s))
3527 return SSL_ERROR_WANT_X509_LOOKUP;
3528 if (SSL_want_async(s))
3529 return SSL_ERROR_WANT_ASYNC;
3530 if (SSL_want_async_job(s))
3531 return SSL_ERROR_WANT_ASYNC_JOB;
3532 if (SSL_want_client_hello_cb(s))
3533 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3535 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3536 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3537 return SSL_ERROR_ZERO_RETURN;
3539 return SSL_ERROR_SYSCALL;
3542 static int ssl_do_handshake_intern(void *vargs)
3544 struct ssl_async_args *args;
3547 args = (struct ssl_async_args *)vargs;
3550 return s->handshake_func(s);
3553 int SSL_do_handshake(SSL *s)
3557 if (s->handshake_func == NULL) {
3558 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3562 ossl_statem_check_finish_init(s, -1);
3564 s->method->ssl_renegotiate_check(s, 0);
3566 if (SSL_is_server(s)) {
3567 /* clear SNI settings at server-side */
3568 OPENSSL_free(s->ext.hostname);
3569 s->ext.hostname = NULL;
3572 if (SSL_in_init(s) || SSL_in_before(s)) {
3573 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3574 struct ssl_async_args args;
3578 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3580 ret = s->handshake_func(s);
3586 void SSL_set_accept_state(SSL *s)
3590 ossl_statem_clear(s);
3591 s->handshake_func = s->method->ssl_accept;
3595 void SSL_set_connect_state(SSL *s)
3599 ossl_statem_clear(s);
3600 s->handshake_func = s->method->ssl_connect;
3604 int ssl_undefined_function(SSL *s)
3606 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3610 int ssl_undefined_void_function(void)
3612 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3613 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3617 int ssl_undefined_const_function(const SSL *s)
3622 const SSL_METHOD *ssl_bad_method(int ver)
3624 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3628 const char *ssl_protocol_to_string(int version)
3632 case TLS1_3_VERSION:
3635 case TLS1_2_VERSION:
3638 case TLS1_1_VERSION:
3653 case DTLS1_2_VERSION:
3661 const char *SSL_get_version(const SSL *s)
3663 return ssl_protocol_to_string(s->version);
3666 SSL *SSL_dup(SSL *s)
3668 STACK_OF(X509_NAME) *sk;
3673 /* If we're not quiescent, just up_ref! */
3674 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3675 CRYPTO_UP_REF(&s->references, &i, s->lock);
3680 * Otherwise, copy configuration state, and session if set.
3682 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3685 if (s->session != NULL) {
3687 * Arranges to share the same session via up_ref. This "copies"
3688 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3690 if (!SSL_copy_session_id(ret, s))
3694 * No session has been established yet, so we have to expect that
3695 * s->cert or ret->cert will be changed later -- they should not both
3696 * point to the same object, and thus we can't use
3697 * SSL_copy_session_id.
3699 if (!SSL_set_ssl_method(ret, s->method))
3702 if (s->cert != NULL) {
3703 ssl_cert_free(ret->cert);
3704 ret->cert = ssl_cert_dup(s->cert);
3705 if (ret->cert == NULL)
3709 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3710 (int)s->sid_ctx_length))
3714 if (!ssl_dane_dup(ret, s))
3716 ret->version = s->version;
3717 ret->options = s->options;
3718 ret->mode = s->mode;
3719 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3720 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3721 ret->msg_callback = s->msg_callback;
3722 ret->msg_callback_arg = s->msg_callback_arg;
3723 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3724 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3725 ret->generate_session_id = s->generate_session_id;
3727 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3729 /* copy app data, a little dangerous perhaps */
3730 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3733 /* setup rbio, and wbio */
3734 if (s->rbio != NULL) {
3735 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3738 if (s->wbio != NULL) {
3739 if (s->wbio != s->rbio) {
3740 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3743 BIO_up_ref(ret->rbio);
3744 ret->wbio = ret->rbio;
3748 ret->server = s->server;
3749 if (s->handshake_func) {
3751 SSL_set_accept_state(ret);
3753 SSL_set_connect_state(ret);
3755 ret->shutdown = s->shutdown;
3758 ret->default_passwd_callback = s->default_passwd_callback;
3759 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3761 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3763 /* dup the cipher_list and cipher_list_by_id stacks */
3764 if (s->cipher_list != NULL) {
3765 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3768 if (s->cipher_list_by_id != NULL)
3769 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3773 /* Dup the client_CA list */
3774 if (s->ca_names != NULL) {
3775 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3778 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3779 xn = sk_X509_NAME_value(sk, i);
3780 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3793 void ssl_clear_cipher_ctx(SSL *s)
3795 if (s->enc_read_ctx != NULL) {
3796 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3797 s->enc_read_ctx = NULL;
3799 if (s->enc_write_ctx != NULL) {
3800 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3801 s->enc_write_ctx = NULL;
3803 #ifndef OPENSSL_NO_COMP
3804 COMP_CTX_free(s->expand);
3806 COMP_CTX_free(s->compress);
3811 X509 *SSL_get_certificate(const SSL *s)
3813 if (s->cert != NULL)
3814 return s->cert->key->x509;
3819 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3821 if (s->cert != NULL)
3822 return s->cert->key->privatekey;
3827 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3829 if (ctx->cert != NULL)
3830 return ctx->cert->key->x509;
3835 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3837 if (ctx->cert != NULL)
3838 return ctx->cert->key->privatekey;
3843 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3845 if ((s->session != NULL) && (s->session->cipher != NULL))
3846 return s->session->cipher;
3850 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3852 return s->s3->tmp.new_cipher;
3855 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3857 #ifndef OPENSSL_NO_COMP
3858 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3864 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3866 #ifndef OPENSSL_NO_COMP
3867 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3873 int ssl_init_wbio_buffer(SSL *s)
3877 if (s->bbio != NULL) {
3878 /* Already buffered. */
3882 bbio = BIO_new(BIO_f_buffer());
3883 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3885 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3889 s->wbio = BIO_push(bbio, s->wbio);
3894 int ssl_free_wbio_buffer(SSL *s)
3896 /* callers ensure s is never null */
3897 if (s->bbio == NULL)
3900 s->wbio = BIO_pop(s->wbio);
3907 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3909 ctx->quiet_shutdown = mode;
3912 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3914 return ctx->quiet_shutdown;
3917 void SSL_set_quiet_shutdown(SSL *s, int mode)
3919 s->quiet_shutdown = mode;
3922 int SSL_get_quiet_shutdown(const SSL *s)
3924 return s->quiet_shutdown;
3927 void SSL_set_shutdown(SSL *s, int mode)
3932 int SSL_get_shutdown(const SSL *s)
3937 int SSL_version(const SSL *s)
3942 int SSL_client_version(const SSL *s)
3944 return s->client_version;
3947 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3952 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3955 if (ssl->ctx == ctx)
3958 ctx = ssl->session_ctx;
3959 new_cert = ssl_cert_dup(ctx->cert);
3960 if (new_cert == NULL) {
3964 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3965 ssl_cert_free(new_cert);
3969 ssl_cert_free(ssl->cert);
3970 ssl->cert = new_cert;
3973 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3974 * so setter APIs must prevent invalid lengths from entering the system.
3976 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3980 * If the session ID context matches that of the parent SSL_CTX,
3981 * inherit it from the new SSL_CTX as well. If however the context does
3982 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3983 * leave it unchanged.
3985 if ((ssl->ctx != NULL) &&
3986 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3987 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3988 ssl->sid_ctx_length = ctx->sid_ctx_length;
3989 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3992 SSL_CTX_up_ref(ctx);
3993 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3999 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
4001 return X509_STORE_set_default_paths(ctx->cert_store);
4004 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
4006 X509_LOOKUP *lookup;
4008 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
4011 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
4013 /* Clear any errors if the default directory does not exist */
4019 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4021 X509_LOOKUP *lookup;
4023 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4027 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4029 /* Clear any errors if the default file does not exist */
4035 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4038 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4041 void SSL_set_info_callback(SSL *ssl,
4042 void (*cb) (const SSL *ssl, int type, int val))
4044 ssl->info_callback = cb;
4048 * One compiler (Diab DCC) doesn't like argument names in returned function
4051 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4054 return ssl->info_callback;
4057 void SSL_set_verify_result(SSL *ssl, long arg)
4059 ssl->verify_result = arg;
4062 long SSL_get_verify_result(const SSL *ssl)
4064 return ssl->verify_result;
4067 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4070 return sizeof(ssl->s3->client_random);
4071 if (outlen > sizeof(ssl->s3->client_random))
4072 outlen = sizeof(ssl->s3->client_random);
4073 memcpy(out, ssl->s3->client_random, outlen);
4077 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4080 return sizeof(ssl->s3->server_random);
4081 if (outlen > sizeof(ssl->s3->server_random))
4082 outlen = sizeof(ssl->s3->server_random);
4083 memcpy(out, ssl->s3->server_random, outlen);
4087 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4088 unsigned char *out, size_t outlen)
4091 return session->master_key_length;
4092 if (outlen > session->master_key_length)
4093 outlen = session->master_key_length;
4094 memcpy(out, session->master_key, outlen);
4098 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4101 if (len > sizeof(sess->master_key))
4104 memcpy(sess->master_key, in, len);
4105 sess->master_key_length = len;
4110 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4112 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4115 void *SSL_get_ex_data(const SSL *s, int idx)
4117 return CRYPTO_get_ex_data(&s->ex_data, idx);
4120 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4122 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4125 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4127 return CRYPTO_get_ex_data(&s->ex_data, idx);
4130 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4132 return ctx->cert_store;
4135 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4137 X509_STORE_free(ctx->cert_store);
4138 ctx->cert_store = store;
4141 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4144 X509_STORE_up_ref(store);
4145 SSL_CTX_set_cert_store(ctx, store);
4148 int SSL_want(const SSL *s)
4154 * \brief Set the callback for generating temporary DH keys.
4155 * \param ctx the SSL context.
4156 * \param dh the callback
4159 #ifndef OPENSSL_NO_DH
4160 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4161 DH *(*dh) (SSL *ssl, int is_export,
4164 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4167 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4170 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4174 #ifndef OPENSSL_NO_PSK
4175 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4177 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4178 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4181 OPENSSL_free(ctx->cert->psk_identity_hint);
4182 if (identity_hint != NULL) {
4183 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4184 if (ctx->cert->psk_identity_hint == NULL)
4187 ctx->cert->psk_identity_hint = NULL;
4191 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4196 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4197 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4200 OPENSSL_free(s->cert->psk_identity_hint);
4201 if (identity_hint != NULL) {
4202 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4203 if (s->cert->psk_identity_hint == NULL)
4206 s->cert->psk_identity_hint = NULL;
4210 const char *SSL_get_psk_identity_hint(const SSL *s)
4212 if (s == NULL || s->session == NULL)
4214 return s->session->psk_identity_hint;
4217 const char *SSL_get_psk_identity(const SSL *s)
4219 if (s == NULL || s->session == NULL)
4221 return s->session->psk_identity;
4224 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4226 s->psk_client_callback = cb;
4229 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4231 ctx->psk_client_callback = cb;
4234 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4236 s->psk_server_callback = cb;
4239 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4241 ctx->psk_server_callback = cb;
4245 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4247 s->psk_find_session_cb = cb;
4250 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4251 SSL_psk_find_session_cb_func cb)
4253 ctx->psk_find_session_cb = cb;
4256 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4258 s->psk_use_session_cb = cb;
4261 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4262 SSL_psk_use_session_cb_func cb)
4264 ctx->psk_use_session_cb = cb;
4267 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4268 void (*cb) (int write_p, int version,
4269 int content_type, const void *buf,
4270 size_t len, SSL *ssl, void *arg))
4272 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4275 void SSL_set_msg_callback(SSL *ssl,
4276 void (*cb) (int write_p, int version,
4277 int content_type, const void *buf,
4278 size_t len, SSL *ssl, void *arg))
4280 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4283 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4284 int (*cb) (SSL *ssl,
4288 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4289 (void (*)(void))cb);
4292 void SSL_set_not_resumable_session_callback(SSL *ssl,
4293 int (*cb) (SSL *ssl,
4294 int is_forward_secure))
4296 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4297 (void (*)(void))cb);
4300 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4301 size_t (*cb) (SSL *ssl, int type,
4302 size_t len, void *arg))
4304 ctx->record_padding_cb = cb;
4307 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4309 ctx->record_padding_arg = arg;
4312 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4314 return ctx->record_padding_arg;
4317 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4319 /* block size of 0 or 1 is basically no padding */
4320 if (block_size == 1)
4321 ctx->block_padding = 0;
4322 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4323 ctx->block_padding = block_size;
4329 void SSL_set_record_padding_callback(SSL *ssl,
4330 size_t (*cb) (SSL *ssl, int type,
4331 size_t len, void *arg))
4333 ssl->record_padding_cb = cb;
4336 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4338 ssl->record_padding_arg = arg;
4341 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4343 return ssl->record_padding_arg;
4346 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4348 /* block size of 0 or 1 is basically no padding */
4349 if (block_size == 1)
4350 ssl->block_padding = 0;
4351 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4352 ssl->block_padding = block_size;
4358 int SSL_set_num_tickets(SSL *s, size_t num_tickets)
4360 s->num_tickets = num_tickets;
4365 size_t SSL_get_num_tickets(SSL *s)
4367 return s->num_tickets;
4370 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets)
4372 ctx->num_tickets = num_tickets;
4377 size_t SSL_CTX_get_num_tickets(SSL_CTX *ctx)
4379 return ctx->num_tickets;
4383 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4384 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4385 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4386 * Returns the newly allocated ctx;
4389 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4391 ssl_clear_hash_ctx(hash);
4392 *hash = EVP_MD_CTX_new();
4393 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4394 EVP_MD_CTX_free(*hash);
4401 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4404 EVP_MD_CTX_free(*hash);
4408 /* Retrieve handshake hashes */
4409 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4412 EVP_MD_CTX *ctx = NULL;
4413 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4414 int hashleni = EVP_MD_CTX_size(hdgst);
4417 if (hashleni < 0 || (size_t)hashleni > outlen) {
4418 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4419 ERR_R_INTERNAL_ERROR);
4423 ctx = EVP_MD_CTX_new();
4427 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4428 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4429 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4430 ERR_R_INTERNAL_ERROR);
4434 *hashlen = hashleni;
4438 EVP_MD_CTX_free(ctx);
4442 int SSL_session_reused(SSL *s)
4447 int SSL_is_server(const SSL *s)
4452 #if OPENSSL_API_COMPAT < 0x10100000L
4453 void SSL_set_debug(SSL *s, int debug)
4455 /* Old function was do-nothing anyway... */
4461 void SSL_set_security_level(SSL *s, int level)
4463 s->cert->sec_level = level;
4466 int SSL_get_security_level(const SSL *s)
4468 return s->cert->sec_level;
4471 void SSL_set_security_callback(SSL *s,
4472 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4473 int op, int bits, int nid,
4474 void *other, void *ex))
4476 s->cert->sec_cb = cb;
4479 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4480 const SSL_CTX *ctx, int op,
4481 int bits, int nid, void *other,
4483 return s->cert->sec_cb;
4486 void SSL_set0_security_ex_data(SSL *s, void *ex)
4488 s->cert->sec_ex = ex;
4491 void *SSL_get0_security_ex_data(const SSL *s)
4493 return s->cert->sec_ex;
4496 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4498 ctx->cert->sec_level = level;
4501 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4503 return ctx->cert->sec_level;
4506 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4507 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4508 int op, int bits, int nid,
4509 void *other, void *ex))
4511 ctx->cert->sec_cb = cb;
4514 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4520 return ctx->cert->sec_cb;
4523 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4525 ctx->cert->sec_ex = ex;
4528 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4530 return ctx->cert->sec_ex;
4534 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4535 * can return unsigned long, instead of the generic long return value from the
4536 * control interface.
4538 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4540 return ctx->options;
4543 unsigned long SSL_get_options(const SSL *s)
4548 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4550 return ctx->options |= op;
4553 unsigned long SSL_set_options(SSL *s, unsigned long op)
4555 return s->options |= op;
4558 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4560 return ctx->options &= ~op;
4563 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4565 return s->options &= ~op;
4568 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4570 return s->verified_chain;
4573 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4575 #ifndef OPENSSL_NO_CT
4578 * Moves SCTs from the |src| stack to the |dst| stack.
4579 * The source of each SCT will be set to |origin|.
4580 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4582 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4584 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4585 sct_source_t origin)
4591 *dst = sk_SCT_new_null();
4593 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4598 while ((sct = sk_SCT_pop(src)) != NULL) {
4599 if (SCT_set_source(sct, origin) != 1)
4602 if (sk_SCT_push(*dst, sct) <= 0)
4610 sk_SCT_push(src, sct); /* Put the SCT back */
4615 * Look for data collected during ServerHello and parse if found.
4616 * Returns the number of SCTs extracted.
4618 static int ct_extract_tls_extension_scts(SSL *s)
4620 int scts_extracted = 0;
4622 if (s->ext.scts != NULL) {
4623 const unsigned char *p = s->ext.scts;
4624 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4626 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4628 SCT_LIST_free(scts);
4631 return scts_extracted;
4635 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4636 * contains an SCT X509 extension. They will be stored in |s->scts|.
4638 * - The number of SCTs extracted, assuming an OCSP response exists.
4639 * - 0 if no OCSP response exists or it contains no SCTs.
4640 * - A negative integer if an error occurs.
4642 static int ct_extract_ocsp_response_scts(SSL *s)
4644 # ifndef OPENSSL_NO_OCSP
4645 int scts_extracted = 0;
4646 const unsigned char *p;
4647 OCSP_BASICRESP *br = NULL;
4648 OCSP_RESPONSE *rsp = NULL;
4649 STACK_OF(SCT) *scts = NULL;
4652 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4655 p = s->ext.ocsp.resp;
4656 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4660 br = OCSP_response_get1_basic(rsp);
4664 for (i = 0; i < OCSP_resp_count(br); ++i) {
4665 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4671 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4673 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4674 if (scts_extracted < 0)
4678 SCT_LIST_free(scts);
4679 OCSP_BASICRESP_free(br);
4680 OCSP_RESPONSE_free(rsp);
4681 return scts_extracted;
4683 /* Behave as if no OCSP response exists */
4689 * Attempts to extract SCTs from the peer certificate.
4690 * Return the number of SCTs extracted, or a negative integer if an error
4693 static int ct_extract_x509v3_extension_scts(SSL *s)
4695 int scts_extracted = 0;
4696 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4699 STACK_OF(SCT) *scts =
4700 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4703 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4705 SCT_LIST_free(scts);
4708 return scts_extracted;
4712 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4713 * response (if it exists) and X509v3 extensions in the certificate.
4714 * Returns NULL if an error occurs.
4716 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4718 if (!s->scts_parsed) {
4719 if (ct_extract_tls_extension_scts(s) < 0 ||
4720 ct_extract_ocsp_response_scts(s) < 0 ||
4721 ct_extract_x509v3_extension_scts(s) < 0)
4731 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4732 const STACK_OF(SCT) *scts, void *unused_arg)
4737 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4738 const STACK_OF(SCT) *scts, void *unused_arg)
4740 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4743 for (i = 0; i < count; ++i) {
4744 SCT *sct = sk_SCT_value(scts, i);
4745 int status = SCT_get_validation_status(sct);
4747 if (status == SCT_VALIDATION_STATUS_VALID)
4750 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4754 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4758 * Since code exists that uses the custom extension handler for CT, look
4759 * for this and throw an error if they have already registered to use CT.
4761 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4762 TLSEXT_TYPE_signed_certificate_timestamp))
4764 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4765 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4769 if (callback != NULL) {
4771 * If we are validating CT, then we MUST accept SCTs served via OCSP
4773 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4777 s->ct_validation_callback = callback;
4778 s->ct_validation_callback_arg = arg;
4783 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4784 ssl_ct_validation_cb callback, void *arg)
4787 * Since code exists that uses the custom extension handler for CT, look for
4788 * this and throw an error if they have already registered to use CT.
4790 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4791 TLSEXT_TYPE_signed_certificate_timestamp))
4793 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4794 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4798 ctx->ct_validation_callback = callback;
4799 ctx->ct_validation_callback_arg = arg;
4803 int SSL_ct_is_enabled(const SSL *s)
4805 return s->ct_validation_callback != NULL;
4808 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4810 return ctx->ct_validation_callback != NULL;
4813 int ssl_validate_ct(SSL *s)
4816 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4818 SSL_DANE *dane = &s->dane;
4819 CT_POLICY_EVAL_CTX *ctx = NULL;
4820 const STACK_OF(SCT) *scts;
4823 * If no callback is set, the peer is anonymous, or its chain is invalid,
4824 * skip SCT validation - just return success. Applications that continue
4825 * handshakes without certificates, with unverified chains, or pinned leaf
4826 * certificates are outside the scope of the WebPKI and CT.
4828 * The above exclusions notwithstanding the vast majority of peers will
4829 * have rather ordinary certificate chains validated by typical
4830 * applications that perform certificate verification and therefore will
4831 * process SCTs when enabled.
4833 if (s->ct_validation_callback == NULL || cert == NULL ||
4834 s->verify_result != X509_V_OK ||
4835 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4839 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4840 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4842 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4843 switch (dane->mtlsa->usage) {
4844 case DANETLS_USAGE_DANE_TA:
4845 case DANETLS_USAGE_DANE_EE:
4850 ctx = CT_POLICY_EVAL_CTX_new();
4852 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4853 ERR_R_MALLOC_FAILURE);
4857 issuer = sk_X509_value(s->verified_chain, 1);
4858 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4859 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4860 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4861 CT_POLICY_EVAL_CTX_set_time(
4862 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4864 scts = SSL_get0_peer_scts(s);
4867 * This function returns success (> 0) only when all the SCTs are valid, 0
4868 * when some are invalid, and < 0 on various internal errors (out of
4869 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4870 * reason to abort the handshake, that decision is up to the callback.
4871 * Therefore, we error out only in the unexpected case that the return
4872 * value is negative.
4874 * XXX: One might well argue that the return value of this function is an
4875 * unfortunate design choice. Its job is only to determine the validation
4876 * status of each of the provided SCTs. So long as it correctly separates
4877 * the wheat from the chaff it should return success. Failure in this case
4878 * ought to correspond to an inability to carry out its duties.
4880 if (SCT_LIST_validate(scts, ctx) < 0) {
4881 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4882 SSL_R_SCT_VERIFICATION_FAILED);
4886 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4888 ret = 0; /* This function returns 0 on failure */
4890 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4891 SSL_R_CALLBACK_FAILED);
4894 CT_POLICY_EVAL_CTX_free(ctx);
4896 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4897 * failure return code here. Also the application may wish the complete
4898 * the handshake, and then disconnect cleanly at a higher layer, after
4899 * checking the verification status of the completed connection.
4901 * We therefore force a certificate verification failure which will be
4902 * visible via SSL_get_verify_result() and cached as part of any resumed
4905 * Note: the permissive callback is for information gathering only, always
4906 * returns success, and does not affect verification status. Only the
4907 * strict callback or a custom application-specified callback can trigger
4908 * connection failure or record a verification error.
4911 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4915 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4917 switch (validation_mode) {
4919 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4921 case SSL_CT_VALIDATION_PERMISSIVE:
4922 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4923 case SSL_CT_VALIDATION_STRICT:
4924 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4928 int SSL_enable_ct(SSL *s, int validation_mode)
4930 switch (validation_mode) {
4932 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4934 case SSL_CT_VALIDATION_PERMISSIVE:
4935 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4936 case SSL_CT_VALIDATION_STRICT:
4937 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4941 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4943 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4946 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4948 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4951 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4953 CTLOG_STORE_free(ctx->ctlog_store);
4954 ctx->ctlog_store = logs;
4957 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4959 return ctx->ctlog_store;
4962 #endif /* OPENSSL_NO_CT */
4964 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4967 c->client_hello_cb = cb;
4968 c->client_hello_cb_arg = arg;
4971 int SSL_client_hello_isv2(SSL *s)
4973 if (s->clienthello == NULL)
4975 return s->clienthello->isv2;
4978 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4980 if (s->clienthello == NULL)
4982 return s->clienthello->legacy_version;
4985 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
4987 if (s->clienthello == NULL)
4990 *out = s->clienthello->random;
4991 return SSL3_RANDOM_SIZE;
4994 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
4996 if (s->clienthello == NULL)
4999 *out = s->clienthello->session_id;
5000 return s->clienthello->session_id_len;
5003 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
5005 if (s->clienthello == NULL)
5008 *out = PACKET_data(&s->clienthello->ciphersuites);
5009 return PACKET_remaining(&s->clienthello->ciphersuites);
5012 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
5014 if (s->clienthello == NULL)
5017 *out = s->clienthello->compressions;
5018 return s->clienthello->compressions_len;
5021 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5027 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5029 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5030 ext = s->clienthello->pre_proc_exts + i;
5034 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
5035 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
5036 ERR_R_MALLOC_FAILURE);
5039 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5040 ext = s->clienthello->pre_proc_exts + i;
5042 if (ext->received_order >= num)
5044 present[ext->received_order] = ext->type;
5051 OPENSSL_free(present);
5055 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5061 if (s->clienthello == NULL)
5063 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5064 r = s->clienthello->pre_proc_exts + i;
5065 if (r->present && r->type == type) {
5067 *out = PACKET_data(&r->data);
5069 *outlen = PACKET_remaining(&r->data);
5076 int SSL_free_buffers(SSL *ssl)
5078 RECORD_LAYER *rl = &ssl->rlayer;
5080 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5083 RECORD_LAYER_release(rl);
5087 int SSL_alloc_buffers(SSL *ssl)
5089 return ssl3_setup_buffers(ssl);
5092 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5094 ctx->keylog_callback = cb;
5097 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5099 return ctx->keylog_callback;
5102 static int nss_keylog_int(const char *prefix,
5104 const uint8_t *parameter_1,
5105 size_t parameter_1_len,
5106 const uint8_t *parameter_2,
5107 size_t parameter_2_len)
5110 char *cursor = NULL;
5115 if (ssl->ctx->keylog_callback == NULL) return 1;
5118 * Our output buffer will contain the following strings, rendered with
5119 * space characters in between, terminated by a NULL character: first the
5120 * prefix, then the first parameter, then the second parameter. The
5121 * meaning of each parameter depends on the specific key material being
5122 * logged. Note that the first and second parameters are encoded in
5123 * hexadecimal, so we need a buffer that is twice their lengths.
5125 prefix_len = strlen(prefix);
5126 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
5127 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5128 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5129 ERR_R_MALLOC_FAILURE);
5133 strcpy(cursor, prefix);
5134 cursor += prefix_len;
5137 for (i = 0; i < parameter_1_len; i++) {
5138 sprintf(cursor, "%02x", parameter_1[i]);
5143 for (i = 0; i < parameter_2_len; i++) {
5144 sprintf(cursor, "%02x", parameter_2[i]);
5149 ssl->ctx->keylog_callback(ssl, (const char *)out);
5155 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5156 const uint8_t *encrypted_premaster,
5157 size_t encrypted_premaster_len,
5158 const uint8_t *premaster,
5159 size_t premaster_len)
5161 if (encrypted_premaster_len < 8) {
5162 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5163 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5167 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5168 return nss_keylog_int("RSA",
5170 encrypted_premaster,
5176 int ssl_log_secret(SSL *ssl,
5178 const uint8_t *secret,
5181 return nss_keylog_int(label,
5183 ssl->s3->client_random,
5189 #define SSLV2_CIPHER_LEN 3
5191 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5195 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5197 if (PACKET_remaining(cipher_suites) == 0) {
5198 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5199 SSL_R_NO_CIPHERS_SPECIFIED);
5203 if (PACKET_remaining(cipher_suites) % n != 0) {
5204 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5205 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5209 OPENSSL_free(s->s3->tmp.ciphers_raw);
5210 s->s3->tmp.ciphers_raw = NULL;
5211 s->s3->tmp.ciphers_rawlen = 0;
5214 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5215 PACKET sslv2ciphers = *cipher_suites;
5216 unsigned int leadbyte;
5220 * We store the raw ciphers list in SSLv3+ format so we need to do some
5221 * preprocessing to convert the list first. If there are any SSLv2 only
5222 * ciphersuites with a non-zero leading byte then we are going to
5223 * slightly over allocate because we won't store those. But that isn't a
5226 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5227 s->s3->tmp.ciphers_raw = raw;
5229 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5230 ERR_R_MALLOC_FAILURE);
5233 for (s->s3->tmp.ciphers_rawlen = 0;
5234 PACKET_remaining(&sslv2ciphers) > 0;
5235 raw += TLS_CIPHER_LEN) {
5236 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5238 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5241 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5242 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5244 OPENSSL_free(s->s3->tmp.ciphers_raw);
5245 s->s3->tmp.ciphers_raw = NULL;
5246 s->s3->tmp.ciphers_rawlen = 0;
5250 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5252 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5253 &s->s3->tmp.ciphers_rawlen)) {
5254 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5255 ERR_R_INTERNAL_ERROR);
5261 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5262 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5263 STACK_OF(SSL_CIPHER) **scsvs)
5267 if (!PACKET_buf_init(&pkt, bytes, len))
5269 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5272 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5273 STACK_OF(SSL_CIPHER) **skp,
5274 STACK_OF(SSL_CIPHER) **scsvs_out,
5275 int sslv2format, int fatal)
5277 const SSL_CIPHER *c;
5278 STACK_OF(SSL_CIPHER) *sk = NULL;
5279 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5281 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5282 unsigned char cipher[SSLV2_CIPHER_LEN];
5284 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5286 if (PACKET_remaining(cipher_suites) == 0) {
5288 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5289 SSL_R_NO_CIPHERS_SPECIFIED);
5291 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5295 if (PACKET_remaining(cipher_suites) % n != 0) {
5297 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5298 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5300 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5301 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5305 sk = sk_SSL_CIPHER_new_null();
5306 scsvs = sk_SSL_CIPHER_new_null();
5307 if (sk == NULL || scsvs == NULL) {
5309 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5310 ERR_R_MALLOC_FAILURE);
5312 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5316 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5318 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5319 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5320 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5322 if (sslv2format && cipher[0] != '\0')
5325 /* For SSLv2-compat, ignore leading 0-byte. */
5326 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5328 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5329 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5331 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5332 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5334 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5339 if (PACKET_remaining(cipher_suites) > 0) {
5341 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5344 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5351 sk_SSL_CIPHER_free(sk);
5352 if (scsvs_out != NULL)
5355 sk_SSL_CIPHER_free(scsvs);
5358 sk_SSL_CIPHER_free(sk);
5359 sk_SSL_CIPHER_free(scsvs);
5363 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5365 ctx->max_early_data = max_early_data;
5370 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5372 return ctx->max_early_data;
5375 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5377 s->max_early_data = max_early_data;
5382 uint32_t SSL_get_max_early_data(const SSL *s)
5384 return s->max_early_data;
5387 int SSL_CTX_set_recv_max_early_data(SSL_CTX *ctx, uint32_t recv_max_early_data)
5389 ctx->recv_max_early_data = recv_max_early_data;
5394 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX *ctx)
5396 return ctx->recv_max_early_data;
5399 int SSL_set_recv_max_early_data(SSL *s, uint32_t recv_max_early_data)
5401 s->recv_max_early_data = recv_max_early_data;
5406 uint32_t SSL_get_recv_max_early_data(const SSL *s)
5408 return s->recv_max_early_data;
5411 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5413 /* Return any active Max Fragment Len extension */
5414 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5415 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5417 /* return current SSL connection setting */
5418 return ssl->max_send_fragment;
5421 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5423 /* Return a value regarding an active Max Fragment Len extension */
5424 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5425 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5426 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5428 /* else limit |split_send_fragment| to current |max_send_fragment| */
5429 if (ssl->split_send_fragment > ssl->max_send_fragment)
5430 return ssl->max_send_fragment;
5432 /* return current SSL connection setting */
5433 return ssl->split_send_fragment;
5436 int SSL_stateless(SSL *s)
5440 /* Ensure there is no state left over from a previous invocation */
5446 s->s3->flags |= TLS1_FLAGS_STATELESS;
5447 ret = SSL_accept(s);
5448 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5450 if (ret > 0 && s->ext.cookieok)
5453 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5459 void SSL_CTX_set_post_handshake_auth(SSL_CTX *ctx, int val)
5461 ctx->pha_enabled = val;
5464 void SSL_set_post_handshake_auth(SSL *ssl, int val)
5466 ssl->pha_enabled = val;
5469 int SSL_verify_client_post_handshake(SSL *ssl)
5471 if (!SSL_IS_TLS13(ssl)) {
5472 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5476 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5480 if (!SSL_is_init_finished(ssl)) {
5481 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5485 switch (ssl->post_handshake_auth) {
5487 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5490 case SSL_PHA_EXT_SENT:
5491 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5493 case SSL_PHA_EXT_RECEIVED:
5495 case SSL_PHA_REQUEST_PENDING:
5496 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5498 case SSL_PHA_REQUESTED:
5499 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5503 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5505 /* checks verify_mode and algorithm_auth */
5506 if (!send_certificate_request(ssl)) {
5507 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5508 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5512 ossl_statem_set_in_init(ssl, 1);
5516 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5517 SSL_CTX_generate_session_ticket_fn gen_cb,
5518 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5521 ctx->generate_ticket_cb = gen_cb;
5522 ctx->decrypt_ticket_cb = dec_cb;
5523 ctx->ticket_cb_data = arg;
5527 void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
5528 SSL_allow_early_data_cb_fn cb,
5531 ctx->allow_early_data_cb = cb;
5532 ctx->allow_early_data_cb_data = arg;
5535 void SSL_set_allow_early_data_cb(SSL *s,
5536 SSL_allow_early_data_cb_fn cb,
5539 s->allow_early_data_cb = cb;
5540 s->allow_early_data_cb_data = arg;