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->num_tickets = ctx->num_tickets;
705 /* Shallow copy of the ciphersuites stack */
706 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
707 if (s->tls13_ciphersuites == NULL)
711 * Earlier library versions used to copy the pointer to the CERT, not
712 * its contents; only when setting new parameters for the per-SSL
713 * copy, ssl_cert_new would be called (and the direct reference to
714 * the per-SSL_CTX settings would be lost, but those still were
715 * indirectly accessed for various purposes, and for that reason they
716 * used to be known as s->ctx->default_cert). Now we don't look at the
717 * SSL_CTX's CERT after having duplicated it once.
719 s->cert = ssl_cert_dup(ctx->cert);
723 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
724 s->msg_callback = ctx->msg_callback;
725 s->msg_callback_arg = ctx->msg_callback_arg;
726 s->verify_mode = ctx->verify_mode;
727 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
728 s->record_padding_cb = ctx->record_padding_cb;
729 s->record_padding_arg = ctx->record_padding_arg;
730 s->block_padding = ctx->block_padding;
731 s->sid_ctx_length = ctx->sid_ctx_length;
732 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
734 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
735 s->verify_callback = ctx->default_verify_callback;
736 s->generate_session_id = ctx->generate_session_id;
738 s->param = X509_VERIFY_PARAM_new();
739 if (s->param == NULL)
741 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
742 s->quiet_shutdown = ctx->quiet_shutdown;
744 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
745 s->max_send_fragment = ctx->max_send_fragment;
746 s->split_send_fragment = ctx->split_send_fragment;
747 s->max_pipelines = ctx->max_pipelines;
748 if (s->max_pipelines > 1)
749 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
750 if (ctx->default_read_buf_len > 0)
751 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
756 s->ext.debug_arg = NULL;
757 s->ext.ticket_expected = 0;
758 s->ext.status_type = ctx->ext.status_type;
759 s->ext.status_expected = 0;
760 s->ext.ocsp.ids = NULL;
761 s->ext.ocsp.exts = NULL;
762 s->ext.ocsp.resp = NULL;
763 s->ext.ocsp.resp_len = 0;
765 s->session_ctx = ctx;
766 #ifndef OPENSSL_NO_EC
767 if (ctx->ext.ecpointformats) {
768 s->ext.ecpointformats =
769 OPENSSL_memdup(ctx->ext.ecpointformats,
770 ctx->ext.ecpointformats_len);
771 if (!s->ext.ecpointformats)
773 s->ext.ecpointformats_len =
774 ctx->ext.ecpointformats_len;
776 if (ctx->ext.supportedgroups) {
777 s->ext.supportedgroups =
778 OPENSSL_memdup(ctx->ext.supportedgroups,
779 ctx->ext.supportedgroups_len
780 * sizeof(*ctx->ext.supportedgroups));
781 if (!s->ext.supportedgroups)
783 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
786 #ifndef OPENSSL_NO_NEXTPROTONEG
790 if (s->ctx->ext.alpn) {
791 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
792 if (s->ext.alpn == NULL)
794 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
795 s->ext.alpn_len = s->ctx->ext.alpn_len;
798 s->verified_chain = NULL;
799 s->verify_result = X509_V_OK;
801 s->default_passwd_callback = ctx->default_passwd_callback;
802 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
804 s->method = ctx->method;
806 s->key_update = SSL_KEY_UPDATE_NONE;
808 if (!s->method->ssl_new(s))
811 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
816 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
819 #ifndef OPENSSL_NO_PSK
820 s->psk_client_callback = ctx->psk_client_callback;
821 s->psk_server_callback = ctx->psk_server_callback;
823 s->psk_find_session_cb = ctx->psk_find_session_cb;
824 s->psk_use_session_cb = ctx->psk_use_session_cb;
828 #ifndef OPENSSL_NO_CT
829 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
830 ctx->ct_validation_callback_arg))
837 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
841 int SSL_is_dtls(const SSL *s)
843 return SSL_IS_DTLS(s) ? 1 : 0;
846 int SSL_up_ref(SSL *s)
850 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
853 REF_PRINT_COUNT("SSL", s);
854 REF_ASSERT_ISNT(i < 2);
855 return ((i > 1) ? 1 : 0);
858 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
859 unsigned int sid_ctx_len)
861 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
862 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
863 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
866 ctx->sid_ctx_length = sid_ctx_len;
867 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
872 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
873 unsigned int sid_ctx_len)
875 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
876 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
877 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
880 ssl->sid_ctx_length = sid_ctx_len;
881 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
886 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
888 CRYPTO_THREAD_write_lock(ctx->lock);
889 ctx->generate_session_id = cb;
890 CRYPTO_THREAD_unlock(ctx->lock);
894 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
896 CRYPTO_THREAD_write_lock(ssl->lock);
897 ssl->generate_session_id = cb;
898 CRYPTO_THREAD_unlock(ssl->lock);
902 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
906 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
907 * we can "construct" a session to give us the desired check - i.e. to
908 * find if there's a session in the hash table that would conflict with
909 * any new session built out of this id/id_len and the ssl_version in use
914 if (id_len > sizeof(r.session_id))
917 r.ssl_version = ssl->version;
918 r.session_id_length = id_len;
919 memcpy(r.session_id, id, id_len);
921 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
922 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
923 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
927 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
929 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
932 int SSL_set_purpose(SSL *s, int purpose)
934 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
937 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
939 return X509_VERIFY_PARAM_set_trust(s->param, trust);
942 int SSL_set_trust(SSL *s, int trust)
944 return X509_VERIFY_PARAM_set_trust(s->param, trust);
947 int SSL_set1_host(SSL *s, const char *hostname)
949 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
952 int SSL_add1_host(SSL *s, const char *hostname)
954 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
957 void SSL_set_hostflags(SSL *s, unsigned int flags)
959 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
962 const char *SSL_get0_peername(SSL *s)
964 return X509_VERIFY_PARAM_get0_peername(s->param);
967 int SSL_CTX_dane_enable(SSL_CTX *ctx)
969 return dane_ctx_enable(&ctx->dane);
972 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
974 unsigned long orig = ctx->dane.flags;
976 ctx->dane.flags |= flags;
980 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
982 unsigned long orig = ctx->dane.flags;
984 ctx->dane.flags &= ~flags;
988 int SSL_dane_enable(SSL *s, const char *basedomain)
990 SSL_DANE *dane = &s->dane;
992 if (s->ctx->dane.mdmax == 0) {
993 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
996 if (dane->trecs != NULL) {
997 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1002 * Default SNI name. This rejects empty names, while set1_host below
1003 * accepts them and disables host name checks. To avoid side-effects with
1004 * invalid input, set the SNI name first.
1006 if (s->ext.hostname == NULL) {
1007 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1008 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1013 /* Primary RFC6125 reference identifier */
1014 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1015 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1021 dane->dctx = &s->ctx->dane;
1022 dane->trecs = sk_danetls_record_new_null();
1024 if (dane->trecs == NULL) {
1025 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1031 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1033 unsigned long orig = ssl->dane.flags;
1035 ssl->dane.flags |= flags;
1039 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1041 unsigned long orig = ssl->dane.flags;
1043 ssl->dane.flags &= ~flags;
1047 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1049 SSL_DANE *dane = &s->dane;
1051 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1055 *mcert = dane->mcert;
1057 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1062 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1063 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1065 SSL_DANE *dane = &s->dane;
1067 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1071 *usage = dane->mtlsa->usage;
1073 *selector = dane->mtlsa->selector;
1075 *mtype = dane->mtlsa->mtype;
1077 *data = dane->mtlsa->data;
1079 *dlen = dane->mtlsa->dlen;
1084 SSL_DANE *SSL_get0_dane(SSL *s)
1089 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1090 uint8_t mtype, unsigned const char *data, size_t dlen)
1092 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1095 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1098 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1101 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1103 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1106 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1108 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1111 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1116 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1121 void SSL_certs_clear(SSL *s)
1123 ssl_cert_clear_certs(s->cert);
1126 void SSL_free(SSL *s)
1132 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1133 REF_PRINT_COUNT("SSL", s);
1136 REF_ASSERT_ISNT(i < 0);
1138 X509_VERIFY_PARAM_free(s->param);
1139 dane_final(&s->dane);
1140 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1142 /* Ignore return value */
1143 ssl_free_wbio_buffer(s);
1145 BIO_free_all(s->wbio);
1146 BIO_free_all(s->rbio);
1148 BUF_MEM_free(s->init_buf);
1150 /* add extra stuff */
1151 sk_SSL_CIPHER_free(s->cipher_list);
1152 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1153 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1155 /* Make the next call work :-) */
1156 if (s->session != NULL) {
1157 ssl_clear_bad_session(s);
1158 SSL_SESSION_free(s->session);
1160 SSL_SESSION_free(s->psksession);
1161 OPENSSL_free(s->psksession_id);
1165 ssl_cert_free(s->cert);
1166 /* Free up if allocated */
1168 OPENSSL_free(s->ext.hostname);
1169 SSL_CTX_free(s->session_ctx);
1170 #ifndef OPENSSL_NO_EC
1171 OPENSSL_free(s->ext.ecpointformats);
1172 OPENSSL_free(s->ext.supportedgroups);
1173 #endif /* OPENSSL_NO_EC */
1174 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1175 #ifndef OPENSSL_NO_OCSP
1176 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1178 #ifndef OPENSSL_NO_CT
1179 SCT_LIST_free(s->scts);
1180 OPENSSL_free(s->ext.scts);
1182 OPENSSL_free(s->ext.ocsp.resp);
1183 OPENSSL_free(s->ext.alpn);
1184 OPENSSL_free(s->ext.tls13_cookie);
1185 OPENSSL_free(s->clienthello);
1186 OPENSSL_free(s->pha_context);
1187 EVP_MD_CTX_free(s->pha_dgst);
1189 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1191 sk_X509_pop_free(s->verified_chain, X509_free);
1193 if (s->method != NULL)
1194 s->method->ssl_free(s);
1196 RECORD_LAYER_release(&s->rlayer);
1198 SSL_CTX_free(s->ctx);
1200 ASYNC_WAIT_CTX_free(s->waitctx);
1202 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1203 OPENSSL_free(s->ext.npn);
1206 #ifndef OPENSSL_NO_SRTP
1207 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1210 CRYPTO_THREAD_lock_free(s->lock);
1215 void SSL_set0_rbio(SSL *s, BIO *rbio)
1217 BIO_free_all(s->rbio);
1221 void SSL_set0_wbio(SSL *s, BIO *wbio)
1224 * If the output buffering BIO is still in place, remove it
1226 if (s->bbio != NULL)
1227 s->wbio = BIO_pop(s->wbio);
1229 BIO_free_all(s->wbio);
1232 /* Re-attach |bbio| to the new |wbio|. */
1233 if (s->bbio != NULL)
1234 s->wbio = BIO_push(s->bbio, s->wbio);
1237 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1240 * For historical reasons, this function has many different cases in
1241 * ownership handling.
1244 /* If nothing has changed, do nothing */
1245 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1249 * If the two arguments are equal then one fewer reference is granted by the
1250 * caller than we want to take
1252 if (rbio != NULL && rbio == wbio)
1256 * If only the wbio is changed only adopt one reference.
1258 if (rbio == SSL_get_rbio(s)) {
1259 SSL_set0_wbio(s, wbio);
1263 * There is an asymmetry here for historical reasons. If only the rbio is
1264 * changed AND the rbio and wbio were originally different, then we only
1265 * adopt one reference.
1267 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1268 SSL_set0_rbio(s, rbio);
1272 /* Otherwise, adopt both references. */
1273 SSL_set0_rbio(s, rbio);
1274 SSL_set0_wbio(s, wbio);
1277 BIO *SSL_get_rbio(const SSL *s)
1282 BIO *SSL_get_wbio(const SSL *s)
1284 if (s->bbio != NULL) {
1286 * If |bbio| is active, the true caller-configured BIO is its
1289 return BIO_next(s->bbio);
1294 int SSL_get_fd(const SSL *s)
1296 return SSL_get_rfd(s);
1299 int SSL_get_rfd(const SSL *s)
1304 b = SSL_get_rbio(s);
1305 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1307 BIO_get_fd(r, &ret);
1311 int SSL_get_wfd(const SSL *s)
1316 b = SSL_get_wbio(s);
1317 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1319 BIO_get_fd(r, &ret);
1323 #ifndef OPENSSL_NO_SOCK
1324 int SSL_set_fd(SSL *s, int fd)
1329 bio = BIO_new(BIO_s_socket());
1332 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1335 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1336 SSL_set_bio(s, bio, bio);
1342 int SSL_set_wfd(SSL *s, int fd)
1344 BIO *rbio = SSL_get_rbio(s);
1346 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1347 || (int)BIO_get_fd(rbio, NULL) != fd) {
1348 BIO *bio = BIO_new(BIO_s_socket());
1351 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1354 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1355 SSL_set0_wbio(s, bio);
1358 SSL_set0_wbio(s, rbio);
1363 int SSL_set_rfd(SSL *s, int fd)
1365 BIO *wbio = SSL_get_wbio(s);
1367 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1368 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1369 BIO *bio = BIO_new(BIO_s_socket());
1372 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1375 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1376 SSL_set0_rbio(s, bio);
1379 SSL_set0_rbio(s, wbio);
1386 /* return length of latest Finished message we sent, copy to 'buf' */
1387 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1391 if (s->s3 != NULL) {
1392 ret = s->s3->tmp.finish_md_len;
1395 memcpy(buf, s->s3->tmp.finish_md, count);
1400 /* return length of latest Finished message we expected, copy to 'buf' */
1401 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1405 if (s->s3 != NULL) {
1406 ret = s->s3->tmp.peer_finish_md_len;
1409 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1414 int SSL_get_verify_mode(const SSL *s)
1416 return s->verify_mode;
1419 int SSL_get_verify_depth(const SSL *s)
1421 return X509_VERIFY_PARAM_get_depth(s->param);
1424 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1425 return s->verify_callback;
1428 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1430 return ctx->verify_mode;
1433 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1435 return X509_VERIFY_PARAM_get_depth(ctx->param);
1438 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1439 return ctx->default_verify_callback;
1442 void SSL_set_verify(SSL *s, int mode,
1443 int (*callback) (int ok, X509_STORE_CTX *ctx))
1445 s->verify_mode = mode;
1446 if (callback != NULL)
1447 s->verify_callback = callback;
1450 void SSL_set_verify_depth(SSL *s, int depth)
1452 X509_VERIFY_PARAM_set_depth(s->param, depth);
1455 void SSL_set_read_ahead(SSL *s, int yes)
1457 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1460 int SSL_get_read_ahead(const SSL *s)
1462 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1465 int SSL_pending(const SSL *s)
1467 size_t pending = s->method->ssl_pending(s);
1470 * SSL_pending cannot work properly if read-ahead is enabled
1471 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1472 * impossible to fix since SSL_pending cannot report errors that may be
1473 * observed while scanning the new data. (Note that SSL_pending() is
1474 * often used as a boolean value, so we'd better not return -1.)
1476 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1477 * we just return INT_MAX.
1479 return pending < INT_MAX ? (int)pending : INT_MAX;
1482 int SSL_has_pending(const SSL *s)
1485 * Similar to SSL_pending() but returns a 1 to indicate that we have
1486 * unprocessed data available or 0 otherwise (as opposed to the number of
1487 * bytes available). Unlike SSL_pending() this will take into account
1488 * read_ahead data. A 1 return simply indicates that we have unprocessed
1489 * data. That data may not result in any application data, or we may fail
1490 * to parse the records for some reason.
1492 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1495 return RECORD_LAYER_read_pending(&s->rlayer);
1498 X509 *SSL_get_peer_certificate(const SSL *s)
1502 if ((s == NULL) || (s->session == NULL))
1505 r = s->session->peer;
1515 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1519 if ((s == NULL) || (s->session == NULL))
1522 r = s->session->peer_chain;
1525 * If we are a client, cert_chain includes the peer's own certificate; if
1526 * we are a server, it does not.
1533 * Now in theory, since the calling process own 't' it should be safe to
1534 * modify. We need to be able to read f without being hassled
1536 int SSL_copy_session_id(SSL *t, const SSL *f)
1539 /* Do we need to to SSL locking? */
1540 if (!SSL_set_session(t, SSL_get_session(f))) {
1545 * what if we are setup for one protocol version but want to talk another
1547 if (t->method != f->method) {
1548 t->method->ssl_free(t);
1549 t->method = f->method;
1550 if (t->method->ssl_new(t) == 0)
1554 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1555 ssl_cert_free(t->cert);
1557 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1564 /* Fix this so it checks all the valid key/cert options */
1565 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1567 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1568 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1571 if (ctx->cert->key->privatekey == NULL) {
1572 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1575 return X509_check_private_key
1576 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1579 /* Fix this function so that it takes an optional type parameter */
1580 int SSL_check_private_key(const SSL *ssl)
1583 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1586 if (ssl->cert->key->x509 == NULL) {
1587 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1590 if (ssl->cert->key->privatekey == NULL) {
1591 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1594 return X509_check_private_key(ssl->cert->key->x509,
1595 ssl->cert->key->privatekey);
1598 int SSL_waiting_for_async(SSL *s)
1606 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1608 ASYNC_WAIT_CTX *ctx = s->waitctx;
1612 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1615 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1616 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1618 ASYNC_WAIT_CTX *ctx = s->waitctx;
1622 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1626 int SSL_accept(SSL *s)
1628 if (s->handshake_func == NULL) {
1629 /* Not properly initialized yet */
1630 SSL_set_accept_state(s);
1633 return SSL_do_handshake(s);
1636 int SSL_connect(SSL *s)
1638 if (s->handshake_func == NULL) {
1639 /* Not properly initialized yet */
1640 SSL_set_connect_state(s);
1643 return SSL_do_handshake(s);
1646 long SSL_get_default_timeout(const SSL *s)
1648 return s->method->get_timeout();
1651 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1652 int (*func) (void *))
1655 if (s->waitctx == NULL) {
1656 s->waitctx = ASYNC_WAIT_CTX_new();
1657 if (s->waitctx == NULL)
1660 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1661 sizeof(struct ssl_async_args))) {
1663 s->rwstate = SSL_NOTHING;
1664 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1667 s->rwstate = SSL_ASYNC_PAUSED;
1670 s->rwstate = SSL_ASYNC_NO_JOBS;
1676 s->rwstate = SSL_NOTHING;
1677 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1678 /* Shouldn't happen */
1683 static int ssl_io_intern(void *vargs)
1685 struct ssl_async_args *args;
1690 args = (struct ssl_async_args *)vargs;
1694 switch (args->type) {
1696 return args->f.func_read(s, buf, num, &s->asyncrw);
1698 return args->f.func_write(s, buf, num, &s->asyncrw);
1700 return args->f.func_other(s);
1705 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1707 if (s->handshake_func == NULL) {
1708 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1712 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1713 s->rwstate = SSL_NOTHING;
1717 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1718 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1719 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1723 * If we are a client and haven't received the ServerHello etc then we
1726 ossl_statem_check_finish_init(s, 0);
1728 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1729 struct ssl_async_args args;
1735 args.type = READFUNC;
1736 args.f.func_read = s->method->ssl_read;
1738 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1739 *readbytes = s->asyncrw;
1742 return s->method->ssl_read(s, buf, num, readbytes);
1746 int SSL_read(SSL *s, void *buf, int num)
1752 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1756 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1759 * The cast is safe here because ret should be <= INT_MAX because num is
1763 ret = (int)readbytes;
1768 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1770 int ret = ssl_read_internal(s, buf, num, readbytes);
1777 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1782 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1783 return SSL_READ_EARLY_DATA_ERROR;
1786 switch (s->early_data_state) {
1787 case SSL_EARLY_DATA_NONE:
1788 if (!SSL_in_before(s)) {
1789 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1790 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1791 return SSL_READ_EARLY_DATA_ERROR;
1795 case SSL_EARLY_DATA_ACCEPT_RETRY:
1796 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1797 ret = SSL_accept(s);
1800 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1801 return SSL_READ_EARLY_DATA_ERROR;
1805 case SSL_EARLY_DATA_READ_RETRY:
1806 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1807 s->early_data_state = SSL_EARLY_DATA_READING;
1808 ret = SSL_read_ex(s, buf, num, readbytes);
1810 * State machine will update early_data_state to
1811 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1814 if (ret > 0 || (ret <= 0 && s->early_data_state
1815 != SSL_EARLY_DATA_FINISHED_READING)) {
1816 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1817 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1818 : SSL_READ_EARLY_DATA_ERROR;
1821 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1824 return SSL_READ_EARLY_DATA_FINISH;
1827 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1828 return SSL_READ_EARLY_DATA_ERROR;
1832 int SSL_get_early_data_status(const SSL *s)
1834 return s->ext.early_data;
1837 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1839 if (s->handshake_func == NULL) {
1840 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1844 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1847 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1848 struct ssl_async_args args;
1854 args.type = READFUNC;
1855 args.f.func_read = s->method->ssl_peek;
1857 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1858 *readbytes = s->asyncrw;
1861 return s->method->ssl_peek(s, buf, num, readbytes);
1865 int SSL_peek(SSL *s, void *buf, int num)
1871 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1875 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1878 * The cast is safe here because ret should be <= INT_MAX because num is
1882 ret = (int)readbytes;
1888 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1890 int ret = ssl_peek_internal(s, buf, num, readbytes);
1897 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1899 if (s->handshake_func == NULL) {
1900 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1904 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1905 s->rwstate = SSL_NOTHING;
1906 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1910 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1911 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1912 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1913 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1916 /* If we are a client and haven't sent the Finished we better do that */
1917 ossl_statem_check_finish_init(s, 1);
1919 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1921 struct ssl_async_args args;
1924 args.buf = (void *)buf;
1926 args.type = WRITEFUNC;
1927 args.f.func_write = s->method->ssl_write;
1929 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1930 *written = s->asyncrw;
1933 return s->method->ssl_write(s, buf, num, written);
1937 int SSL_write(SSL *s, const void *buf, int num)
1943 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1947 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1950 * The cast is safe here because ret should be <= INT_MAX because num is
1959 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1961 int ret = ssl_write_internal(s, buf, num, written);
1968 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1970 int ret, early_data_state;
1972 uint32_t partialwrite;
1974 switch (s->early_data_state) {
1975 case SSL_EARLY_DATA_NONE:
1977 || !SSL_in_before(s)
1978 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1979 && (s->psk_use_session_cb == NULL))) {
1980 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1981 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1986 case SSL_EARLY_DATA_CONNECT_RETRY:
1987 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1988 ret = SSL_connect(s);
1991 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1996 case SSL_EARLY_DATA_WRITE_RETRY:
1997 s->early_data_state = SSL_EARLY_DATA_WRITING;
1999 * We disable partial write for early data because we don't keep track
2000 * of how many bytes we've written between the SSL_write_ex() call and
2001 * the flush if the flush needs to be retried)
2003 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2004 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2005 ret = SSL_write_ex(s, buf, num, &writtmp);
2006 s->mode |= partialwrite;
2008 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2011 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2014 case SSL_EARLY_DATA_WRITE_FLUSH:
2015 /* The buffering BIO is still in place so we need to flush it */
2016 if (statem_flush(s) != 1)
2019 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2022 case SSL_EARLY_DATA_FINISHED_READING:
2023 case SSL_EARLY_DATA_READ_RETRY:
2024 early_data_state = s->early_data_state;
2025 /* We are a server writing to an unauthenticated client */
2026 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2027 ret = SSL_write_ex(s, buf, num, written);
2028 /* The buffering BIO is still in place */
2030 (void)BIO_flush(s->wbio);
2031 s->early_data_state = early_data_state;
2035 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2040 int SSL_shutdown(SSL *s)
2043 * Note that this function behaves differently from what one might
2044 * expect. Return values are 0 for no success (yet), 1 for success; but
2045 * calling it once is usually not enough, even if blocking I/O is used
2046 * (see ssl3_shutdown).
2049 if (s->handshake_func == NULL) {
2050 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2054 if (!SSL_in_init(s)) {
2055 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2056 struct ssl_async_args args;
2059 args.type = OTHERFUNC;
2060 args.f.func_other = s->method->ssl_shutdown;
2062 return ssl_start_async_job(s, &args, ssl_io_intern);
2064 return s->method->ssl_shutdown(s);
2067 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2072 int SSL_key_update(SSL *s, int updatetype)
2075 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2076 * negotiated, and that it is appropriate to call SSL_key_update() instead
2077 * of SSL_renegotiate().
2079 if (!SSL_IS_TLS13(s)) {
2080 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2084 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2085 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2086 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2090 if (!SSL_is_init_finished(s)) {
2091 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2095 ossl_statem_set_in_init(s, 1);
2096 s->key_update = updatetype;
2100 int SSL_get_key_update_type(SSL *s)
2102 return s->key_update;
2105 int SSL_renegotiate(SSL *s)
2107 if (SSL_IS_TLS13(s)) {
2108 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2112 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2113 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2120 return s->method->ssl_renegotiate(s);
2123 int SSL_renegotiate_abbreviated(SSL *s)
2125 if (SSL_IS_TLS13(s)) {
2126 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2130 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2131 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2138 return s->method->ssl_renegotiate(s);
2141 int SSL_renegotiate_pending(SSL *s)
2144 * becomes true when negotiation is requested; false again once a
2145 * handshake has finished
2147 return (s->renegotiate != 0);
2150 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2155 case SSL_CTRL_GET_READ_AHEAD:
2156 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2157 case SSL_CTRL_SET_READ_AHEAD:
2158 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2159 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2162 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2163 s->msg_callback_arg = parg;
2167 return (s->mode |= larg);
2168 case SSL_CTRL_CLEAR_MODE:
2169 return (s->mode &= ~larg);
2170 case SSL_CTRL_GET_MAX_CERT_LIST:
2171 return (long)s->max_cert_list;
2172 case SSL_CTRL_SET_MAX_CERT_LIST:
2175 l = (long)s->max_cert_list;
2176 s->max_cert_list = (size_t)larg;
2178 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2179 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2181 s->max_send_fragment = larg;
2182 if (s->max_send_fragment < s->split_send_fragment)
2183 s->split_send_fragment = s->max_send_fragment;
2185 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2186 if ((size_t)larg > s->max_send_fragment || larg == 0)
2188 s->split_send_fragment = larg;
2190 case SSL_CTRL_SET_MAX_PIPELINES:
2191 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2193 s->max_pipelines = larg;
2195 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2197 case SSL_CTRL_GET_RI_SUPPORT:
2199 return s->s3->send_connection_binding;
2202 case SSL_CTRL_CERT_FLAGS:
2203 return (s->cert->cert_flags |= larg);
2204 case SSL_CTRL_CLEAR_CERT_FLAGS:
2205 return (s->cert->cert_flags &= ~larg);
2207 case SSL_CTRL_GET_RAW_CIPHERLIST:
2209 if (s->s3->tmp.ciphers_raw == NULL)
2211 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2212 return (int)s->s3->tmp.ciphers_rawlen;
2214 return TLS_CIPHER_LEN;
2216 case SSL_CTRL_GET_EXTMS_SUPPORT:
2217 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2219 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2223 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2224 return ssl_check_allowed_versions(larg, s->max_proto_version)
2225 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2226 &s->min_proto_version);
2227 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2228 return s->min_proto_version;
2229 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2230 return ssl_check_allowed_versions(s->min_proto_version, larg)
2231 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2232 &s->max_proto_version);
2233 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2234 return s->max_proto_version;
2236 return s->method->ssl_ctrl(s, cmd, larg, parg);
2240 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2243 case SSL_CTRL_SET_MSG_CALLBACK:
2244 s->msg_callback = (void (*)
2245 (int write_p, int version, int content_type,
2246 const void *buf, size_t len, SSL *ssl,
2251 return s->method->ssl_callback_ctrl(s, cmd, fp);
2255 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2257 return ctx->sessions;
2260 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2264 /* For some cases with ctx == NULL perform syntax checks */
2267 #ifndef OPENSSL_NO_EC
2268 case SSL_CTRL_SET_GROUPS_LIST:
2269 return tls1_set_groups_list(NULL, NULL, parg);
2271 case SSL_CTRL_SET_SIGALGS_LIST:
2272 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2273 return tls1_set_sigalgs_list(NULL, parg, 0);
2280 case SSL_CTRL_GET_READ_AHEAD:
2281 return ctx->read_ahead;
2282 case SSL_CTRL_SET_READ_AHEAD:
2283 l = ctx->read_ahead;
2284 ctx->read_ahead = larg;
2287 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2288 ctx->msg_callback_arg = parg;
2291 case SSL_CTRL_GET_MAX_CERT_LIST:
2292 return (long)ctx->max_cert_list;
2293 case SSL_CTRL_SET_MAX_CERT_LIST:
2296 l = (long)ctx->max_cert_list;
2297 ctx->max_cert_list = (size_t)larg;
2300 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2303 l = (long)ctx->session_cache_size;
2304 ctx->session_cache_size = (size_t)larg;
2306 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2307 return (long)ctx->session_cache_size;
2308 case SSL_CTRL_SET_SESS_CACHE_MODE:
2309 l = ctx->session_cache_mode;
2310 ctx->session_cache_mode = larg;
2312 case SSL_CTRL_GET_SESS_CACHE_MODE:
2313 return ctx->session_cache_mode;
2315 case SSL_CTRL_SESS_NUMBER:
2316 return lh_SSL_SESSION_num_items(ctx->sessions);
2317 case SSL_CTRL_SESS_CONNECT:
2318 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2320 case SSL_CTRL_SESS_CONNECT_GOOD:
2321 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2323 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2324 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2327 case SSL_CTRL_SESS_ACCEPT:
2328 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2330 case SSL_CTRL_SESS_ACCEPT_GOOD:
2331 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2333 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2334 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2337 case SSL_CTRL_SESS_HIT:
2338 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2340 case SSL_CTRL_SESS_CB_HIT:
2341 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2343 case SSL_CTRL_SESS_MISSES:
2344 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2346 case SSL_CTRL_SESS_TIMEOUTS:
2347 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2349 case SSL_CTRL_SESS_CACHE_FULL:
2350 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2353 return (ctx->mode |= larg);
2354 case SSL_CTRL_CLEAR_MODE:
2355 return (ctx->mode &= ~larg);
2356 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2357 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2359 ctx->max_send_fragment = larg;
2360 if (ctx->max_send_fragment < ctx->split_send_fragment)
2361 ctx->split_send_fragment = ctx->max_send_fragment;
2363 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2364 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2366 ctx->split_send_fragment = larg;
2368 case SSL_CTRL_SET_MAX_PIPELINES:
2369 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2371 ctx->max_pipelines = larg;
2373 case SSL_CTRL_CERT_FLAGS:
2374 return (ctx->cert->cert_flags |= larg);
2375 case SSL_CTRL_CLEAR_CERT_FLAGS:
2376 return (ctx->cert->cert_flags &= ~larg);
2377 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2378 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2379 && ssl_set_version_bound(ctx->method->version, (int)larg,
2380 &ctx->min_proto_version);
2381 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2382 return ctx->min_proto_version;
2383 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2384 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2385 && ssl_set_version_bound(ctx->method->version, (int)larg,
2386 &ctx->max_proto_version);
2387 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2388 return ctx->max_proto_version;
2390 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2394 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2397 case SSL_CTRL_SET_MSG_CALLBACK:
2398 ctx->msg_callback = (void (*)
2399 (int write_p, int version, int content_type,
2400 const void *buf, size_t len, SSL *ssl,
2405 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2409 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2418 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2419 const SSL_CIPHER *const *bp)
2421 if ((*ap)->id > (*bp)->id)
2423 if ((*ap)->id < (*bp)->id)
2428 /** return a STACK of the ciphers available for the SSL and in order of
2430 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2433 if (s->cipher_list != NULL) {
2434 return s->cipher_list;
2435 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2436 return s->ctx->cipher_list;
2442 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2444 if ((s == NULL) || (s->session == NULL) || !s->server)
2446 return s->session->ciphers;
2449 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2451 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2454 ciphers = SSL_get_ciphers(s);
2457 if (!ssl_set_client_disabled(s))
2459 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2460 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2461 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2463 sk = sk_SSL_CIPHER_new_null();
2466 if (!sk_SSL_CIPHER_push(sk, c)) {
2467 sk_SSL_CIPHER_free(sk);
2475 /** return a STACK of the ciphers available for the SSL and in order of
2477 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2480 if (s->cipher_list_by_id != NULL) {
2481 return s->cipher_list_by_id;
2482 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2483 return s->ctx->cipher_list_by_id;
2489 /** The old interface to get the same thing as SSL_get_ciphers() */
2490 const char *SSL_get_cipher_list(const SSL *s, int n)
2492 const SSL_CIPHER *c;
2493 STACK_OF(SSL_CIPHER) *sk;
2497 sk = SSL_get_ciphers(s);
2498 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2500 c = sk_SSL_CIPHER_value(sk, n);
2506 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2508 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2511 return ctx->cipher_list;
2515 /** specify the ciphers to be used by default by the SSL_CTX */
2516 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2518 STACK_OF(SSL_CIPHER) *sk;
2520 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2521 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2524 * ssl_create_cipher_list may return an empty stack if it was unable to
2525 * find a cipher matching the given rule string (for example if the rule
2526 * string specifies a cipher which has been disabled). This is not an
2527 * error as far as ssl_create_cipher_list is concerned, and hence
2528 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2532 else if (sk_SSL_CIPHER_num(sk) == 0) {
2533 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2539 /** specify the ciphers to be used by the SSL */
2540 int SSL_set_cipher_list(SSL *s, const char *str)
2542 STACK_OF(SSL_CIPHER) *sk;
2544 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2545 &s->cipher_list, &s->cipher_list_by_id, str,
2547 /* see comment in SSL_CTX_set_cipher_list */
2550 else if (sk_SSL_CIPHER_num(sk) == 0) {
2551 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2557 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2560 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2561 const SSL_CIPHER *c;
2565 || s->session == NULL
2566 || s->session->ciphers == NULL
2571 clntsk = s->session->ciphers;
2572 srvrsk = SSL_get_ciphers(s);
2573 if (clntsk == NULL || srvrsk == NULL)
2576 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2579 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2582 c = sk_SSL_CIPHER_value(clntsk, i);
2583 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2586 n = strlen(c->name);
2602 /** return a servername extension value if provided in Client Hello, or NULL.
2603 * So far, only host_name types are defined (RFC 3546).
2606 const char *SSL_get_servername(const SSL *s, const int type)
2608 if (type != TLSEXT_NAMETYPE_host_name)
2611 return s->session && !s->ext.hostname ?
2612 s->session->ext.hostname : s->ext.hostname;
2615 int SSL_get_servername_type(const SSL *s)
2618 && (!s->ext.hostname ? s->session->
2619 ext.hostname : s->ext.hostname))
2620 return TLSEXT_NAMETYPE_host_name;
2625 * SSL_select_next_proto implements the standard protocol selection. It is
2626 * expected that this function is called from the callback set by
2627 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2628 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2629 * not included in the length. A byte string of length 0 is invalid. No byte
2630 * string may be truncated. The current, but experimental algorithm for
2631 * selecting the protocol is: 1) If the server doesn't support NPN then this
2632 * is indicated to the callback. In this case, the client application has to
2633 * abort the connection or have a default application level protocol. 2) If
2634 * the server supports NPN, but advertises an empty list then the client
2635 * selects the first protocol in its list, but indicates via the API that this
2636 * fallback case was enacted. 3) Otherwise, the client finds the first
2637 * protocol in the server's list that it supports and selects this protocol.
2638 * This is because it's assumed that the server has better information about
2639 * which protocol a client should use. 4) If the client doesn't support any
2640 * of the server's advertised protocols, then this is treated the same as
2641 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2642 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2644 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2645 const unsigned char *server,
2646 unsigned int server_len,
2647 const unsigned char *client, unsigned int client_len)
2650 const unsigned char *result;
2651 int status = OPENSSL_NPN_UNSUPPORTED;
2654 * For each protocol in server preference order, see if we support it.
2656 for (i = 0; i < server_len;) {
2657 for (j = 0; j < client_len;) {
2658 if (server[i] == client[j] &&
2659 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2660 /* We found a match */
2661 result = &server[i];
2662 status = OPENSSL_NPN_NEGOTIATED;
2672 /* There's no overlap between our protocols and the server's list. */
2674 status = OPENSSL_NPN_NO_OVERLAP;
2677 *out = (unsigned char *)result + 1;
2678 *outlen = result[0];
2682 #ifndef OPENSSL_NO_NEXTPROTONEG
2684 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2685 * client's requested protocol for this connection and returns 0. If the
2686 * client didn't request any protocol, then *data is set to NULL. Note that
2687 * the client can request any protocol it chooses. The value returned from
2688 * this function need not be a member of the list of supported protocols
2689 * provided by the callback.
2691 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2698 *len = (unsigned int)s->ext.npn_len;
2703 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2704 * a TLS server needs a list of supported protocols for Next Protocol
2705 * Negotiation. The returned list must be in wire format. The list is
2706 * returned by setting |out| to point to it and |outlen| to its length. This
2707 * memory will not be modified, but one should assume that the SSL* keeps a
2708 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2709 * wishes to advertise. Otherwise, no such extension will be included in the
2712 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2713 SSL_CTX_npn_advertised_cb_func cb,
2716 ctx->ext.npn_advertised_cb = cb;
2717 ctx->ext.npn_advertised_cb_arg = arg;
2721 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2722 * client needs to select a protocol from the server's provided list. |out|
2723 * must be set to point to the selected protocol (which may be within |in|).
2724 * The length of the protocol name must be written into |outlen|. The
2725 * server's advertised protocols are provided in |in| and |inlen|. The
2726 * callback can assume that |in| is syntactically valid. The client must
2727 * select a protocol. It is fatal to the connection if this callback returns
2728 * a value other than SSL_TLSEXT_ERR_OK.
2730 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2731 SSL_CTX_npn_select_cb_func cb,
2734 ctx->ext.npn_select_cb = cb;
2735 ctx->ext.npn_select_cb_arg = arg;
2740 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2741 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2742 * length-prefixed strings). Returns 0 on success.
2744 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2745 unsigned int protos_len)
2747 OPENSSL_free(ctx->ext.alpn);
2748 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2749 if (ctx->ext.alpn == NULL) {
2750 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2753 ctx->ext.alpn_len = protos_len;
2759 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2760 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2761 * length-prefixed strings). Returns 0 on success.
2763 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2764 unsigned int protos_len)
2766 OPENSSL_free(ssl->ext.alpn);
2767 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2768 if (ssl->ext.alpn == NULL) {
2769 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2772 ssl->ext.alpn_len = protos_len;
2778 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2779 * called during ClientHello processing in order to select an ALPN protocol
2780 * from the client's list of offered protocols.
2782 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2783 SSL_CTX_alpn_select_cb_func cb,
2786 ctx->ext.alpn_select_cb = cb;
2787 ctx->ext.alpn_select_cb_arg = arg;
2791 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2792 * On return it sets |*data| to point to |*len| bytes of protocol name
2793 * (not including the leading length-prefix byte). If the server didn't
2794 * respond with a negotiated protocol then |*len| will be zero.
2796 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2801 *data = ssl->s3->alpn_selected;
2805 *len = (unsigned int)ssl->s3->alpn_selected_len;
2808 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2809 const char *label, size_t llen,
2810 const unsigned char *context, size_t contextlen,
2813 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2816 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2818 contextlen, use_context);
2821 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2822 const char *label, size_t llen,
2823 const unsigned char *context,
2826 if (s->version != TLS1_3_VERSION)
2829 return tls13_export_keying_material_early(s, out, olen, label, llen,
2830 context, contextlen);
2833 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2835 const unsigned char *session_id = a->session_id;
2837 unsigned char tmp_storage[4];
2839 if (a->session_id_length < sizeof(tmp_storage)) {
2840 memset(tmp_storage, 0, sizeof(tmp_storage));
2841 memcpy(tmp_storage, a->session_id, a->session_id_length);
2842 session_id = tmp_storage;
2846 ((unsigned long)session_id[0]) |
2847 ((unsigned long)session_id[1] << 8L) |
2848 ((unsigned long)session_id[2] << 16L) |
2849 ((unsigned long)session_id[3] << 24L);
2854 * NB: If this function (or indeed the hash function which uses a sort of
2855 * coarser function than this one) is changed, ensure
2856 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2857 * being able to construct an SSL_SESSION that will collide with any existing
2858 * session with a matching session ID.
2860 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2862 if (a->ssl_version != b->ssl_version)
2864 if (a->session_id_length != b->session_id_length)
2866 return memcmp(a->session_id, b->session_id, a->session_id_length);
2870 * These wrapper functions should remain rather than redeclaring
2871 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2872 * variable. The reason is that the functions aren't static, they're exposed
2876 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2878 SSL_CTX *ret = NULL;
2881 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2885 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2888 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2889 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2892 ret = OPENSSL_zalloc(sizeof(*ret));
2897 ret->min_proto_version = 0;
2898 ret->max_proto_version = 0;
2899 ret->mode = SSL_MODE_AUTO_RETRY;
2900 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2901 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2902 /* We take the system default. */
2903 ret->session_timeout = meth->get_timeout();
2904 ret->references = 1;
2905 ret->lock = CRYPTO_THREAD_lock_new();
2906 if (ret->lock == NULL) {
2907 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2911 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2912 ret->verify_mode = SSL_VERIFY_NONE;
2913 if ((ret->cert = ssl_cert_new()) == NULL)
2916 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2917 if (ret->sessions == NULL)
2919 ret->cert_store = X509_STORE_new();
2920 if (ret->cert_store == NULL)
2922 #ifndef OPENSSL_NO_CT
2923 ret->ctlog_store = CTLOG_STORE_new();
2924 if (ret->ctlog_store == NULL)
2928 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
2931 if (!ssl_create_cipher_list(ret->method,
2932 ret->tls13_ciphersuites,
2933 &ret->cipher_list, &ret->cipher_list_by_id,
2934 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2935 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2936 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2940 ret->param = X509_VERIFY_PARAM_new();
2941 if (ret->param == NULL)
2944 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2945 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2948 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2949 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2953 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2956 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2959 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
2962 /* No compression for DTLS */
2963 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2964 ret->comp_methods = SSL_COMP_get_compression_methods();
2966 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2967 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2969 /* Setup RFC5077 ticket keys */
2970 if ((RAND_bytes(ret->ext.tick_key_name,
2971 sizeof(ret->ext.tick_key_name)) <= 0)
2972 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
2973 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
2974 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
2975 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
2976 ret->options |= SSL_OP_NO_TICKET;
2978 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
2979 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2982 #ifndef OPENSSL_NO_SRP
2983 if (!SSL_CTX_SRP_CTX_init(ret))
2986 #ifndef OPENSSL_NO_ENGINE
2987 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2988 # define eng_strx(x) #x
2989 # define eng_str(x) eng_strx(x)
2990 /* Use specific client engine automatically... ignore errors */
2993 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2996 ENGINE_load_builtin_engines();
2997 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2999 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3005 * Default is to connect to non-RI servers. When RI is more widely
3006 * deployed might change this.
3008 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3010 * Disable compression by default to prevent CRIME. Applications can
3011 * re-enable compression by configuring
3012 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3013 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3014 * middlebox compatibility by default. This may be disabled by default in
3015 * a later OpenSSL version.
3017 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3019 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3022 * We cannot usefully set a default max_early_data here (which gets
3023 * propagated in SSL_new(), for the following reason: setting the
3024 * SSL field causes tls_construct_stoc_early_data() to tell the
3025 * client that early data will be accepted when constructing a TLS 1.3
3026 * session ticket, and the client will accordingly send us early data
3027 * when using that ticket (if the client has early data to send).
3028 * However, in order for the early data to actually be consumed by
3029 * the application, the application must also have calls to
3030 * SSL_read_early_data(); otherwise we'll just skip past the early data
3031 * and ignore it. So, since the application must add calls to
3032 * SSL_read_early_data(), we also require them to add
3033 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3034 * eliminating the bandwidth-wasting early data in the case described
3037 ret->max_early_data = 0;
3039 /* By default we send two session tickets automatically in TLSv1.3 */
3040 ret->num_tickets = 2;
3042 ssl_ctx_system_config(ret);
3046 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3052 int SSL_CTX_up_ref(SSL_CTX *ctx)
3056 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3059 REF_PRINT_COUNT("SSL_CTX", ctx);
3060 REF_ASSERT_ISNT(i < 2);
3061 return ((i > 1) ? 1 : 0);
3064 void SSL_CTX_free(SSL_CTX *a)
3071 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3072 REF_PRINT_COUNT("SSL_CTX", a);
3075 REF_ASSERT_ISNT(i < 0);
3077 X509_VERIFY_PARAM_free(a->param);
3078 dane_ctx_final(&a->dane);
3081 * Free internal session cache. However: the remove_cb() may reference
3082 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3083 * after the sessions were flushed.
3084 * As the ex_data handling routines might also touch the session cache,
3085 * the most secure solution seems to be: empty (flush) the cache, then
3086 * free ex_data, then finally free the cache.
3087 * (See ticket [openssl.org #212].)
3089 if (a->sessions != NULL)
3090 SSL_CTX_flush_sessions(a, 0);
3092 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3093 lh_SSL_SESSION_free(a->sessions);
3094 X509_STORE_free(a->cert_store);
3095 #ifndef OPENSSL_NO_CT
3096 CTLOG_STORE_free(a->ctlog_store);
3098 sk_SSL_CIPHER_free(a->cipher_list);
3099 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3100 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3101 ssl_cert_free(a->cert);
3102 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3103 sk_X509_pop_free(a->extra_certs, X509_free);
3104 a->comp_methods = NULL;
3105 #ifndef OPENSSL_NO_SRTP
3106 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3108 #ifndef OPENSSL_NO_SRP
3109 SSL_CTX_SRP_CTX_free(a);
3111 #ifndef OPENSSL_NO_ENGINE
3112 ENGINE_finish(a->client_cert_engine);
3115 #ifndef OPENSSL_NO_EC
3116 OPENSSL_free(a->ext.ecpointformats);
3117 OPENSSL_free(a->ext.supportedgroups);
3119 OPENSSL_free(a->ext.alpn);
3120 OPENSSL_secure_free(a->ext.secure);
3122 CRYPTO_THREAD_lock_free(a->lock);
3127 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3129 ctx->default_passwd_callback = cb;
3132 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3134 ctx->default_passwd_callback_userdata = u;
3137 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3139 return ctx->default_passwd_callback;
3142 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3144 return ctx->default_passwd_callback_userdata;
3147 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3149 s->default_passwd_callback = cb;
3152 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3154 s->default_passwd_callback_userdata = u;
3157 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3159 return s->default_passwd_callback;
3162 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3164 return s->default_passwd_callback_userdata;
3167 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3168 int (*cb) (X509_STORE_CTX *, void *),
3171 ctx->app_verify_callback = cb;
3172 ctx->app_verify_arg = arg;
3175 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3176 int (*cb) (int, X509_STORE_CTX *))
3178 ctx->verify_mode = mode;
3179 ctx->default_verify_callback = cb;
3182 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3184 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3187 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3189 ssl_cert_set_cert_cb(c->cert, cb, arg);
3192 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3194 ssl_cert_set_cert_cb(s->cert, cb, arg);
3197 void ssl_set_masks(SSL *s)
3200 uint32_t *pvalid = s->s3->tmp.valid_flags;
3201 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3202 unsigned long mask_k, mask_a;
3203 #ifndef OPENSSL_NO_EC
3204 int have_ecc_cert, ecdsa_ok;
3209 #ifndef OPENSSL_NO_DH
3210 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3215 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3216 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3217 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3218 #ifndef OPENSSL_NO_EC
3219 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3225 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3226 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3229 #ifndef OPENSSL_NO_GOST
3230 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3231 mask_k |= SSL_kGOST;
3232 mask_a |= SSL_aGOST12;
3234 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3235 mask_k |= SSL_kGOST;
3236 mask_a |= SSL_aGOST12;
3238 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3239 mask_k |= SSL_kGOST;
3240 mask_a |= SSL_aGOST01;
3251 * If we only have an RSA-PSS certificate allow RSA authentication
3252 * if TLS 1.2 and peer supports it.
3255 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3256 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3257 && TLS1_get_version(s) == TLS1_2_VERSION))
3264 mask_a |= SSL_aNULL;
3267 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3268 * depending on the key usage extension.
3270 #ifndef OPENSSL_NO_EC
3271 if (have_ecc_cert) {
3273 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3274 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3275 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3278 mask_a |= SSL_aECDSA;
3280 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3281 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3282 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3283 && TLS1_get_version(s) == TLS1_2_VERSION)
3284 mask_a |= SSL_aECDSA;
3286 /* Allow Ed448 for TLS 1.2 if peer supports it */
3287 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3288 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3289 && TLS1_get_version(s) == TLS1_2_VERSION)
3290 mask_a |= SSL_aECDSA;
3293 #ifndef OPENSSL_NO_EC
3294 mask_k |= SSL_kECDHE;
3297 #ifndef OPENSSL_NO_PSK
3300 if (mask_k & SSL_kRSA)
3301 mask_k |= SSL_kRSAPSK;
3302 if (mask_k & SSL_kDHE)
3303 mask_k |= SSL_kDHEPSK;
3304 if (mask_k & SSL_kECDHE)
3305 mask_k |= SSL_kECDHEPSK;
3308 s->s3->tmp.mask_k = mask_k;
3309 s->s3->tmp.mask_a = mask_a;
3312 #ifndef OPENSSL_NO_EC
3314 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3316 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3317 /* key usage, if present, must allow signing */
3318 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3319 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3320 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3324 return 1; /* all checks are ok */
3329 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3330 size_t *serverinfo_length)
3332 CERT_PKEY *cpk = s->s3->tmp.cert;
3333 *serverinfo_length = 0;
3335 if (cpk == NULL || cpk->serverinfo == NULL)
3338 *serverinfo = cpk->serverinfo;
3339 *serverinfo_length = cpk->serverinfo_length;
3343 void ssl_update_cache(SSL *s, int mode)
3348 * If the session_id_length is 0, we are not supposed to cache it, and it
3349 * would be rather hard to do anyway :-)
3351 if (s->session->session_id_length == 0)
3355 * If sid_ctx_length is 0 there is no specific application context
3356 * associated with this session, so when we try to resume it and
3357 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3358 * indication that this is actually a session for the proper application
3359 * context, and the *handshake* will fail, not just the resumption attempt.
3360 * Do not cache (on the server) these sessions that are not resumable
3361 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3363 if (s->server && s->session->sid_ctx_length == 0
3364 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3367 i = s->session_ctx->session_cache_mode;
3369 && (!s->hit || SSL_IS_TLS13(s))) {
3371 * Add the session to the internal cache. In server side TLSv1.3 we
3372 * normally don't do this because its a full stateless ticket with only
3373 * a dummy session id so there is no reason to cache it, unless:
3374 * - we are doing early_data, in which case we cache so that we can
3376 * - the application has set a remove_session_cb so needs to know about
3377 * session timeout events
3379 if ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0
3380 && (!SSL_IS_TLS13(s)
3382 || s->max_early_data > 0
3383 || s->session_ctx->remove_session_cb != NULL))
3384 SSL_CTX_add_session(s->session_ctx, s->session);
3387 * Add the session to the external cache. We do this even in server side
3388 * TLSv1.3 without early data because some applications just want to
3389 * know about the creation of a session and aren't doing a full cache.
3391 if (s->session_ctx->new_session_cb != NULL) {
3392 SSL_SESSION_up_ref(s->session);
3393 if (!s->session_ctx->new_session_cb(s, s->session))
3394 SSL_SESSION_free(s->session);
3398 /* auto flush every 255 connections */
3399 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3401 if (mode & SSL_SESS_CACHE_CLIENT)
3402 stat = &s->session_ctx->stats.sess_connect_good;
3404 stat = &s->session_ctx->stats.sess_accept_good;
3405 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3406 && (val & 0xff) == 0xff)
3407 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3411 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3416 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3421 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3425 if (s->method != meth) {
3426 const SSL_METHOD *sm = s->method;
3427 int (*hf) (SSL *) = s->handshake_func;
3429 if (sm->version == meth->version)
3434 ret = s->method->ssl_new(s);
3437 if (hf == sm->ssl_connect)
3438 s->handshake_func = meth->ssl_connect;
3439 else if (hf == sm->ssl_accept)
3440 s->handshake_func = meth->ssl_accept;
3445 int SSL_get_error(const SSL *s, int i)
3452 return SSL_ERROR_NONE;
3455 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3456 * where we do encode the error
3458 if ((l = ERR_peek_error()) != 0) {
3459 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3460 return SSL_ERROR_SYSCALL;
3462 return SSL_ERROR_SSL;
3465 if (SSL_want_read(s)) {
3466 bio = SSL_get_rbio(s);
3467 if (BIO_should_read(bio))
3468 return SSL_ERROR_WANT_READ;
3469 else if (BIO_should_write(bio))
3471 * This one doesn't make too much sense ... We never try to write
3472 * to the rbio, and an application program where rbio and wbio
3473 * are separate couldn't even know what it should wait for.
3474 * However if we ever set s->rwstate incorrectly (so that we have
3475 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3476 * wbio *are* the same, this test works around that bug; so it
3477 * might be safer to keep it.
3479 return SSL_ERROR_WANT_WRITE;
3480 else if (BIO_should_io_special(bio)) {
3481 reason = BIO_get_retry_reason(bio);
3482 if (reason == BIO_RR_CONNECT)
3483 return SSL_ERROR_WANT_CONNECT;
3484 else if (reason == BIO_RR_ACCEPT)
3485 return SSL_ERROR_WANT_ACCEPT;
3487 return SSL_ERROR_SYSCALL; /* unknown */
3491 if (SSL_want_write(s)) {
3492 /* Access wbio directly - in order to use the buffered bio if present */
3494 if (BIO_should_write(bio))
3495 return SSL_ERROR_WANT_WRITE;
3496 else if (BIO_should_read(bio))
3498 * See above (SSL_want_read(s) with BIO_should_write(bio))
3500 return SSL_ERROR_WANT_READ;
3501 else if (BIO_should_io_special(bio)) {
3502 reason = BIO_get_retry_reason(bio);
3503 if (reason == BIO_RR_CONNECT)
3504 return SSL_ERROR_WANT_CONNECT;
3505 else if (reason == BIO_RR_ACCEPT)
3506 return SSL_ERROR_WANT_ACCEPT;
3508 return SSL_ERROR_SYSCALL;
3511 if (SSL_want_x509_lookup(s))
3512 return SSL_ERROR_WANT_X509_LOOKUP;
3513 if (SSL_want_async(s))
3514 return SSL_ERROR_WANT_ASYNC;
3515 if (SSL_want_async_job(s))
3516 return SSL_ERROR_WANT_ASYNC_JOB;
3517 if (SSL_want_client_hello_cb(s))
3518 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3520 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3521 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3522 return SSL_ERROR_ZERO_RETURN;
3524 return SSL_ERROR_SYSCALL;
3527 static int ssl_do_handshake_intern(void *vargs)
3529 struct ssl_async_args *args;
3532 args = (struct ssl_async_args *)vargs;
3535 return s->handshake_func(s);
3538 int SSL_do_handshake(SSL *s)
3542 if (s->handshake_func == NULL) {
3543 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3547 ossl_statem_check_finish_init(s, -1);
3549 s->method->ssl_renegotiate_check(s, 0);
3551 if (SSL_is_server(s)) {
3552 /* clear SNI settings at server-side */
3553 OPENSSL_free(s->ext.hostname);
3554 s->ext.hostname = NULL;
3557 if (SSL_in_init(s) || SSL_in_before(s)) {
3558 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3559 struct ssl_async_args args;
3563 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3565 ret = s->handshake_func(s);
3571 void SSL_set_accept_state(SSL *s)
3575 ossl_statem_clear(s);
3576 s->handshake_func = s->method->ssl_accept;
3580 void SSL_set_connect_state(SSL *s)
3584 ossl_statem_clear(s);
3585 s->handshake_func = s->method->ssl_connect;
3589 int ssl_undefined_function(SSL *s)
3591 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3595 int ssl_undefined_void_function(void)
3597 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3598 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3602 int ssl_undefined_const_function(const SSL *s)
3607 const SSL_METHOD *ssl_bad_method(int ver)
3609 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3613 const char *ssl_protocol_to_string(int version)
3617 case TLS1_3_VERSION:
3620 case TLS1_2_VERSION:
3623 case TLS1_1_VERSION:
3638 case DTLS1_2_VERSION:
3646 const char *SSL_get_version(const SSL *s)
3648 return ssl_protocol_to_string(s->version);
3651 SSL *SSL_dup(SSL *s)
3653 STACK_OF(X509_NAME) *sk;
3658 /* If we're not quiescent, just up_ref! */
3659 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3660 CRYPTO_UP_REF(&s->references, &i, s->lock);
3665 * Otherwise, copy configuration state, and session if set.
3667 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3670 if (s->session != NULL) {
3672 * Arranges to share the same session via up_ref. This "copies"
3673 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3675 if (!SSL_copy_session_id(ret, s))
3679 * No session has been established yet, so we have to expect that
3680 * s->cert or ret->cert will be changed later -- they should not both
3681 * point to the same object, and thus we can't use
3682 * SSL_copy_session_id.
3684 if (!SSL_set_ssl_method(ret, s->method))
3687 if (s->cert != NULL) {
3688 ssl_cert_free(ret->cert);
3689 ret->cert = ssl_cert_dup(s->cert);
3690 if (ret->cert == NULL)
3694 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3695 (int)s->sid_ctx_length))
3699 if (!ssl_dane_dup(ret, s))
3701 ret->version = s->version;
3702 ret->options = s->options;
3703 ret->mode = s->mode;
3704 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3705 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3706 ret->msg_callback = s->msg_callback;
3707 ret->msg_callback_arg = s->msg_callback_arg;
3708 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3709 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3710 ret->generate_session_id = s->generate_session_id;
3712 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3714 /* copy app data, a little dangerous perhaps */
3715 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3718 /* setup rbio, and wbio */
3719 if (s->rbio != NULL) {
3720 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3723 if (s->wbio != NULL) {
3724 if (s->wbio != s->rbio) {
3725 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3728 BIO_up_ref(ret->rbio);
3729 ret->wbio = ret->rbio;
3733 ret->server = s->server;
3734 if (s->handshake_func) {
3736 SSL_set_accept_state(ret);
3738 SSL_set_connect_state(ret);
3740 ret->shutdown = s->shutdown;
3743 ret->default_passwd_callback = s->default_passwd_callback;
3744 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3746 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3748 /* dup the cipher_list and cipher_list_by_id stacks */
3749 if (s->cipher_list != NULL) {
3750 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3753 if (s->cipher_list_by_id != NULL)
3754 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3758 /* Dup the client_CA list */
3759 if (s->ca_names != NULL) {
3760 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3763 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3764 xn = sk_X509_NAME_value(sk, i);
3765 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3778 void ssl_clear_cipher_ctx(SSL *s)
3780 if (s->enc_read_ctx != NULL) {
3781 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3782 s->enc_read_ctx = NULL;
3784 if (s->enc_write_ctx != NULL) {
3785 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3786 s->enc_write_ctx = NULL;
3788 #ifndef OPENSSL_NO_COMP
3789 COMP_CTX_free(s->expand);
3791 COMP_CTX_free(s->compress);
3796 X509 *SSL_get_certificate(const SSL *s)
3798 if (s->cert != NULL)
3799 return s->cert->key->x509;
3804 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3806 if (s->cert != NULL)
3807 return s->cert->key->privatekey;
3812 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3814 if (ctx->cert != NULL)
3815 return ctx->cert->key->x509;
3820 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3822 if (ctx->cert != NULL)
3823 return ctx->cert->key->privatekey;
3828 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3830 if ((s->session != NULL) && (s->session->cipher != NULL))
3831 return s->session->cipher;
3835 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3837 return s->s3->tmp.new_cipher;
3840 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3842 #ifndef OPENSSL_NO_COMP
3843 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3849 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3851 #ifndef OPENSSL_NO_COMP
3852 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3858 int ssl_init_wbio_buffer(SSL *s)
3862 if (s->bbio != NULL) {
3863 /* Already buffered. */
3867 bbio = BIO_new(BIO_f_buffer());
3868 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3870 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3874 s->wbio = BIO_push(bbio, s->wbio);
3879 int ssl_free_wbio_buffer(SSL *s)
3881 /* callers ensure s is never null */
3882 if (s->bbio == NULL)
3885 s->wbio = BIO_pop(s->wbio);
3892 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3894 ctx->quiet_shutdown = mode;
3897 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3899 return ctx->quiet_shutdown;
3902 void SSL_set_quiet_shutdown(SSL *s, int mode)
3904 s->quiet_shutdown = mode;
3907 int SSL_get_quiet_shutdown(const SSL *s)
3909 return s->quiet_shutdown;
3912 void SSL_set_shutdown(SSL *s, int mode)
3917 int SSL_get_shutdown(const SSL *s)
3922 int SSL_version(const SSL *s)
3927 int SSL_client_version(const SSL *s)
3929 return s->client_version;
3932 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3937 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3940 if (ssl->ctx == ctx)
3943 ctx = ssl->session_ctx;
3944 new_cert = ssl_cert_dup(ctx->cert);
3945 if (new_cert == NULL) {
3949 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3950 ssl_cert_free(new_cert);
3954 ssl_cert_free(ssl->cert);
3955 ssl->cert = new_cert;
3958 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3959 * so setter APIs must prevent invalid lengths from entering the system.
3961 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3965 * If the session ID context matches that of the parent SSL_CTX,
3966 * inherit it from the new SSL_CTX as well. If however the context does
3967 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3968 * leave it unchanged.
3970 if ((ssl->ctx != NULL) &&
3971 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3972 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3973 ssl->sid_ctx_length = ctx->sid_ctx_length;
3974 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3977 SSL_CTX_up_ref(ctx);
3978 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3984 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3986 return X509_STORE_set_default_paths(ctx->cert_store);
3989 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3991 X509_LOOKUP *lookup;
3993 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3996 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3998 /* Clear any errors if the default directory does not exist */
4004 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4006 X509_LOOKUP *lookup;
4008 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4012 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4014 /* Clear any errors if the default file does not exist */
4020 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4023 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4026 void SSL_set_info_callback(SSL *ssl,
4027 void (*cb) (const SSL *ssl, int type, int val))
4029 ssl->info_callback = cb;
4033 * One compiler (Diab DCC) doesn't like argument names in returned function
4036 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4039 return ssl->info_callback;
4042 void SSL_set_verify_result(SSL *ssl, long arg)
4044 ssl->verify_result = arg;
4047 long SSL_get_verify_result(const SSL *ssl)
4049 return ssl->verify_result;
4052 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4055 return sizeof(ssl->s3->client_random);
4056 if (outlen > sizeof(ssl->s3->client_random))
4057 outlen = sizeof(ssl->s3->client_random);
4058 memcpy(out, ssl->s3->client_random, outlen);
4062 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4065 return sizeof(ssl->s3->server_random);
4066 if (outlen > sizeof(ssl->s3->server_random))
4067 outlen = sizeof(ssl->s3->server_random);
4068 memcpy(out, ssl->s3->server_random, outlen);
4072 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4073 unsigned char *out, size_t outlen)
4076 return session->master_key_length;
4077 if (outlen > session->master_key_length)
4078 outlen = session->master_key_length;
4079 memcpy(out, session->master_key, outlen);
4083 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4086 if (len > sizeof(sess->master_key))
4089 memcpy(sess->master_key, in, len);
4090 sess->master_key_length = len;
4095 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4097 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4100 void *SSL_get_ex_data(const SSL *s, int idx)
4102 return CRYPTO_get_ex_data(&s->ex_data, idx);
4105 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4107 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4110 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4112 return CRYPTO_get_ex_data(&s->ex_data, idx);
4115 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4117 return ctx->cert_store;
4120 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4122 X509_STORE_free(ctx->cert_store);
4123 ctx->cert_store = store;
4126 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4129 X509_STORE_up_ref(store);
4130 SSL_CTX_set_cert_store(ctx, store);
4133 int SSL_want(const SSL *s)
4139 * \brief Set the callback for generating temporary DH keys.
4140 * \param ctx the SSL context.
4141 * \param dh the callback
4144 #ifndef OPENSSL_NO_DH
4145 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4146 DH *(*dh) (SSL *ssl, int is_export,
4149 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4152 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4155 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4159 #ifndef OPENSSL_NO_PSK
4160 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4162 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4163 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4166 OPENSSL_free(ctx->cert->psk_identity_hint);
4167 if (identity_hint != NULL) {
4168 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4169 if (ctx->cert->psk_identity_hint == NULL)
4172 ctx->cert->psk_identity_hint = NULL;
4176 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4181 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4182 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4185 OPENSSL_free(s->cert->psk_identity_hint);
4186 if (identity_hint != NULL) {
4187 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4188 if (s->cert->psk_identity_hint == NULL)
4191 s->cert->psk_identity_hint = NULL;
4195 const char *SSL_get_psk_identity_hint(const SSL *s)
4197 if (s == NULL || s->session == NULL)
4199 return s->session->psk_identity_hint;
4202 const char *SSL_get_psk_identity(const SSL *s)
4204 if (s == NULL || s->session == NULL)
4206 return s->session->psk_identity;
4209 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4211 s->psk_client_callback = cb;
4214 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4216 ctx->psk_client_callback = cb;
4219 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4221 s->psk_server_callback = cb;
4224 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4226 ctx->psk_server_callback = cb;
4230 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4232 s->psk_find_session_cb = cb;
4235 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4236 SSL_psk_find_session_cb_func cb)
4238 ctx->psk_find_session_cb = cb;
4241 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4243 s->psk_use_session_cb = cb;
4246 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4247 SSL_psk_use_session_cb_func cb)
4249 ctx->psk_use_session_cb = cb;
4252 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4253 void (*cb) (int write_p, int version,
4254 int content_type, const void *buf,
4255 size_t len, SSL *ssl, void *arg))
4257 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4260 void SSL_set_msg_callback(SSL *ssl,
4261 void (*cb) (int write_p, int version,
4262 int content_type, const void *buf,
4263 size_t len, SSL *ssl, void *arg))
4265 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4268 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4269 int (*cb) (SSL *ssl,
4273 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4274 (void (*)(void))cb);
4277 void SSL_set_not_resumable_session_callback(SSL *ssl,
4278 int (*cb) (SSL *ssl,
4279 int is_forward_secure))
4281 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4282 (void (*)(void))cb);
4285 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4286 size_t (*cb) (SSL *ssl, int type,
4287 size_t len, void *arg))
4289 ctx->record_padding_cb = cb;
4292 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4294 ctx->record_padding_arg = arg;
4297 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4299 return ctx->record_padding_arg;
4302 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4304 /* block size of 0 or 1 is basically no padding */
4305 if (block_size == 1)
4306 ctx->block_padding = 0;
4307 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4308 ctx->block_padding = block_size;
4314 void SSL_set_record_padding_callback(SSL *ssl,
4315 size_t (*cb) (SSL *ssl, int type,
4316 size_t len, void *arg))
4318 ssl->record_padding_cb = cb;
4321 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4323 ssl->record_padding_arg = arg;
4326 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4328 return ssl->record_padding_arg;
4331 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4333 /* block size of 0 or 1 is basically no padding */
4334 if (block_size == 1)
4335 ssl->block_padding = 0;
4336 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4337 ssl->block_padding = block_size;
4343 int SSL_set_num_tickets(SSL *s, size_t num_tickets)
4345 s->num_tickets = num_tickets;
4350 size_t SSL_get_num_tickets(SSL *s)
4352 return s->num_tickets;
4355 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets)
4357 ctx->num_tickets = num_tickets;
4362 size_t SSL_CTX_get_num_tickets(SSL_CTX *ctx)
4364 return ctx->num_tickets;
4368 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4369 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4370 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4371 * Returns the newly allocated ctx;
4374 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4376 ssl_clear_hash_ctx(hash);
4377 *hash = EVP_MD_CTX_new();
4378 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4379 EVP_MD_CTX_free(*hash);
4386 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4389 EVP_MD_CTX_free(*hash);
4393 /* Retrieve handshake hashes */
4394 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4397 EVP_MD_CTX *ctx = NULL;
4398 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4399 int hashleni = EVP_MD_CTX_size(hdgst);
4402 if (hashleni < 0 || (size_t)hashleni > outlen) {
4403 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4404 ERR_R_INTERNAL_ERROR);
4408 ctx = EVP_MD_CTX_new();
4412 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4413 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4414 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4415 ERR_R_INTERNAL_ERROR);
4419 *hashlen = hashleni;
4423 EVP_MD_CTX_free(ctx);
4427 int SSL_session_reused(SSL *s)
4432 int SSL_is_server(const SSL *s)
4437 #if OPENSSL_API_COMPAT < 0x10100000L
4438 void SSL_set_debug(SSL *s, int debug)
4440 /* Old function was do-nothing anyway... */
4446 void SSL_set_security_level(SSL *s, int level)
4448 s->cert->sec_level = level;
4451 int SSL_get_security_level(const SSL *s)
4453 return s->cert->sec_level;
4456 void SSL_set_security_callback(SSL *s,
4457 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4458 int op, int bits, int nid,
4459 void *other, void *ex))
4461 s->cert->sec_cb = cb;
4464 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4465 const SSL_CTX *ctx, int op,
4466 int bits, int nid, void *other,
4468 return s->cert->sec_cb;
4471 void SSL_set0_security_ex_data(SSL *s, void *ex)
4473 s->cert->sec_ex = ex;
4476 void *SSL_get0_security_ex_data(const SSL *s)
4478 return s->cert->sec_ex;
4481 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4483 ctx->cert->sec_level = level;
4486 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4488 return ctx->cert->sec_level;
4491 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4492 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4493 int op, int bits, int nid,
4494 void *other, void *ex))
4496 ctx->cert->sec_cb = cb;
4499 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4505 return ctx->cert->sec_cb;
4508 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4510 ctx->cert->sec_ex = ex;
4513 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4515 return ctx->cert->sec_ex;
4519 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4520 * can return unsigned long, instead of the generic long return value from the
4521 * control interface.
4523 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4525 return ctx->options;
4528 unsigned long SSL_get_options(const SSL *s)
4533 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4535 return ctx->options |= op;
4538 unsigned long SSL_set_options(SSL *s, unsigned long op)
4540 return s->options |= op;
4543 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4545 return ctx->options &= ~op;
4548 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4550 return s->options &= ~op;
4553 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4555 return s->verified_chain;
4558 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4560 #ifndef OPENSSL_NO_CT
4563 * Moves SCTs from the |src| stack to the |dst| stack.
4564 * The source of each SCT will be set to |origin|.
4565 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4567 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4569 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4570 sct_source_t origin)
4576 *dst = sk_SCT_new_null();
4578 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4583 while ((sct = sk_SCT_pop(src)) != NULL) {
4584 if (SCT_set_source(sct, origin) != 1)
4587 if (sk_SCT_push(*dst, sct) <= 0)
4595 sk_SCT_push(src, sct); /* Put the SCT back */
4600 * Look for data collected during ServerHello and parse if found.
4601 * Returns the number of SCTs extracted.
4603 static int ct_extract_tls_extension_scts(SSL *s)
4605 int scts_extracted = 0;
4607 if (s->ext.scts != NULL) {
4608 const unsigned char *p = s->ext.scts;
4609 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4611 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4613 SCT_LIST_free(scts);
4616 return scts_extracted;
4620 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4621 * contains an SCT X509 extension. They will be stored in |s->scts|.
4623 * - The number of SCTs extracted, assuming an OCSP response exists.
4624 * - 0 if no OCSP response exists or it contains no SCTs.
4625 * - A negative integer if an error occurs.
4627 static int ct_extract_ocsp_response_scts(SSL *s)
4629 # ifndef OPENSSL_NO_OCSP
4630 int scts_extracted = 0;
4631 const unsigned char *p;
4632 OCSP_BASICRESP *br = NULL;
4633 OCSP_RESPONSE *rsp = NULL;
4634 STACK_OF(SCT) *scts = NULL;
4637 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4640 p = s->ext.ocsp.resp;
4641 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4645 br = OCSP_response_get1_basic(rsp);
4649 for (i = 0; i < OCSP_resp_count(br); ++i) {
4650 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4656 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4658 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4659 if (scts_extracted < 0)
4663 SCT_LIST_free(scts);
4664 OCSP_BASICRESP_free(br);
4665 OCSP_RESPONSE_free(rsp);
4666 return scts_extracted;
4668 /* Behave as if no OCSP response exists */
4674 * Attempts to extract SCTs from the peer certificate.
4675 * Return the number of SCTs extracted, or a negative integer if an error
4678 static int ct_extract_x509v3_extension_scts(SSL *s)
4680 int scts_extracted = 0;
4681 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4684 STACK_OF(SCT) *scts =
4685 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4688 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4690 SCT_LIST_free(scts);
4693 return scts_extracted;
4697 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4698 * response (if it exists) and X509v3 extensions in the certificate.
4699 * Returns NULL if an error occurs.
4701 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4703 if (!s->scts_parsed) {
4704 if (ct_extract_tls_extension_scts(s) < 0 ||
4705 ct_extract_ocsp_response_scts(s) < 0 ||
4706 ct_extract_x509v3_extension_scts(s) < 0)
4716 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4717 const STACK_OF(SCT) *scts, void *unused_arg)
4722 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4723 const STACK_OF(SCT) *scts, void *unused_arg)
4725 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4728 for (i = 0; i < count; ++i) {
4729 SCT *sct = sk_SCT_value(scts, i);
4730 int status = SCT_get_validation_status(sct);
4732 if (status == SCT_VALIDATION_STATUS_VALID)
4735 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4739 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4743 * Since code exists that uses the custom extension handler for CT, look
4744 * for this and throw an error if they have already registered to use CT.
4746 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4747 TLSEXT_TYPE_signed_certificate_timestamp))
4749 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4750 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4754 if (callback != NULL) {
4756 * If we are validating CT, then we MUST accept SCTs served via OCSP
4758 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4762 s->ct_validation_callback = callback;
4763 s->ct_validation_callback_arg = arg;
4768 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4769 ssl_ct_validation_cb callback, void *arg)
4772 * Since code exists that uses the custom extension handler for CT, look for
4773 * this and throw an error if they have already registered to use CT.
4775 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4776 TLSEXT_TYPE_signed_certificate_timestamp))
4778 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4779 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4783 ctx->ct_validation_callback = callback;
4784 ctx->ct_validation_callback_arg = arg;
4788 int SSL_ct_is_enabled(const SSL *s)
4790 return s->ct_validation_callback != NULL;
4793 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4795 return ctx->ct_validation_callback != NULL;
4798 int ssl_validate_ct(SSL *s)
4801 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4803 SSL_DANE *dane = &s->dane;
4804 CT_POLICY_EVAL_CTX *ctx = NULL;
4805 const STACK_OF(SCT) *scts;
4808 * If no callback is set, the peer is anonymous, or its chain is invalid,
4809 * skip SCT validation - just return success. Applications that continue
4810 * handshakes without certificates, with unverified chains, or pinned leaf
4811 * certificates are outside the scope of the WebPKI and CT.
4813 * The above exclusions notwithstanding the vast majority of peers will
4814 * have rather ordinary certificate chains validated by typical
4815 * applications that perform certificate verification and therefore will
4816 * process SCTs when enabled.
4818 if (s->ct_validation_callback == NULL || cert == NULL ||
4819 s->verify_result != X509_V_OK ||
4820 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4824 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4825 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4827 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4828 switch (dane->mtlsa->usage) {
4829 case DANETLS_USAGE_DANE_TA:
4830 case DANETLS_USAGE_DANE_EE:
4835 ctx = CT_POLICY_EVAL_CTX_new();
4837 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4838 ERR_R_MALLOC_FAILURE);
4842 issuer = sk_X509_value(s->verified_chain, 1);
4843 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4844 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4845 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4846 CT_POLICY_EVAL_CTX_set_time(
4847 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4849 scts = SSL_get0_peer_scts(s);
4852 * This function returns success (> 0) only when all the SCTs are valid, 0
4853 * when some are invalid, and < 0 on various internal errors (out of
4854 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4855 * reason to abort the handshake, that decision is up to the callback.
4856 * Therefore, we error out only in the unexpected case that the return
4857 * value is negative.
4859 * XXX: One might well argue that the return value of this function is an
4860 * unfortunate design choice. Its job is only to determine the validation
4861 * status of each of the provided SCTs. So long as it correctly separates
4862 * the wheat from the chaff it should return success. Failure in this case
4863 * ought to correspond to an inability to carry out its duties.
4865 if (SCT_LIST_validate(scts, ctx) < 0) {
4866 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4867 SSL_R_SCT_VERIFICATION_FAILED);
4871 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4873 ret = 0; /* This function returns 0 on failure */
4875 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4876 SSL_R_CALLBACK_FAILED);
4879 CT_POLICY_EVAL_CTX_free(ctx);
4881 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4882 * failure return code here. Also the application may wish the complete
4883 * the handshake, and then disconnect cleanly at a higher layer, after
4884 * checking the verification status of the completed connection.
4886 * We therefore force a certificate verification failure which will be
4887 * visible via SSL_get_verify_result() and cached as part of any resumed
4890 * Note: the permissive callback is for information gathering only, always
4891 * returns success, and does not affect verification status. Only the
4892 * strict callback or a custom application-specified callback can trigger
4893 * connection failure or record a verification error.
4896 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4900 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4902 switch (validation_mode) {
4904 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4906 case SSL_CT_VALIDATION_PERMISSIVE:
4907 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4908 case SSL_CT_VALIDATION_STRICT:
4909 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4913 int SSL_enable_ct(SSL *s, int validation_mode)
4915 switch (validation_mode) {
4917 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4919 case SSL_CT_VALIDATION_PERMISSIVE:
4920 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4921 case SSL_CT_VALIDATION_STRICT:
4922 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4926 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4928 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4931 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4933 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4936 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4938 CTLOG_STORE_free(ctx->ctlog_store);
4939 ctx->ctlog_store = logs;
4942 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4944 return ctx->ctlog_store;
4947 #endif /* OPENSSL_NO_CT */
4949 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4952 c->client_hello_cb = cb;
4953 c->client_hello_cb_arg = arg;
4956 int SSL_client_hello_isv2(SSL *s)
4958 if (s->clienthello == NULL)
4960 return s->clienthello->isv2;
4963 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4965 if (s->clienthello == NULL)
4967 return s->clienthello->legacy_version;
4970 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
4972 if (s->clienthello == NULL)
4975 *out = s->clienthello->random;
4976 return SSL3_RANDOM_SIZE;
4979 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
4981 if (s->clienthello == NULL)
4984 *out = s->clienthello->session_id;
4985 return s->clienthello->session_id_len;
4988 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
4990 if (s->clienthello == NULL)
4993 *out = PACKET_data(&s->clienthello->ciphersuites);
4994 return PACKET_remaining(&s->clienthello->ciphersuites);
4997 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
4999 if (s->clienthello == NULL)
5002 *out = s->clienthello->compressions;
5003 return s->clienthello->compressions_len;
5006 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5012 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5014 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5015 ext = s->clienthello->pre_proc_exts + i;
5019 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
5020 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
5021 ERR_R_MALLOC_FAILURE);
5024 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5025 ext = s->clienthello->pre_proc_exts + i;
5027 if (ext->received_order >= num)
5029 present[ext->received_order] = ext->type;
5036 OPENSSL_free(present);
5040 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5046 if (s->clienthello == NULL)
5048 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5049 r = s->clienthello->pre_proc_exts + i;
5050 if (r->present && r->type == type) {
5052 *out = PACKET_data(&r->data);
5054 *outlen = PACKET_remaining(&r->data);
5061 int SSL_free_buffers(SSL *ssl)
5063 RECORD_LAYER *rl = &ssl->rlayer;
5065 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5068 RECORD_LAYER_release(rl);
5072 int SSL_alloc_buffers(SSL *ssl)
5074 return ssl3_setup_buffers(ssl);
5077 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5079 ctx->keylog_callback = cb;
5082 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5084 return ctx->keylog_callback;
5087 static int nss_keylog_int(const char *prefix,
5089 const uint8_t *parameter_1,
5090 size_t parameter_1_len,
5091 const uint8_t *parameter_2,
5092 size_t parameter_2_len)
5095 char *cursor = NULL;
5100 if (ssl->ctx->keylog_callback == NULL) return 1;
5103 * Our output buffer will contain the following strings, rendered with
5104 * space characters in between, terminated by a NULL character: first the
5105 * prefix, then the first parameter, then the second parameter. The
5106 * meaning of each parameter depends on the specific key material being
5107 * logged. Note that the first and second parameters are encoded in
5108 * hexadecimal, so we need a buffer that is twice their lengths.
5110 prefix_len = strlen(prefix);
5111 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
5112 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5113 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5114 ERR_R_MALLOC_FAILURE);
5118 strcpy(cursor, prefix);
5119 cursor += prefix_len;
5122 for (i = 0; i < parameter_1_len; i++) {
5123 sprintf(cursor, "%02x", parameter_1[i]);
5128 for (i = 0; i < parameter_2_len; i++) {
5129 sprintf(cursor, "%02x", parameter_2[i]);
5134 ssl->ctx->keylog_callback(ssl, (const char *)out);
5140 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5141 const uint8_t *encrypted_premaster,
5142 size_t encrypted_premaster_len,
5143 const uint8_t *premaster,
5144 size_t premaster_len)
5146 if (encrypted_premaster_len < 8) {
5147 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5148 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5152 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5153 return nss_keylog_int("RSA",
5155 encrypted_premaster,
5161 int ssl_log_secret(SSL *ssl,
5163 const uint8_t *secret,
5166 return nss_keylog_int(label,
5168 ssl->s3->client_random,
5174 #define SSLV2_CIPHER_LEN 3
5176 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5180 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5182 if (PACKET_remaining(cipher_suites) == 0) {
5183 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5184 SSL_R_NO_CIPHERS_SPECIFIED);
5188 if (PACKET_remaining(cipher_suites) % n != 0) {
5189 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5190 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5194 OPENSSL_free(s->s3->tmp.ciphers_raw);
5195 s->s3->tmp.ciphers_raw = NULL;
5196 s->s3->tmp.ciphers_rawlen = 0;
5199 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5200 PACKET sslv2ciphers = *cipher_suites;
5201 unsigned int leadbyte;
5205 * We store the raw ciphers list in SSLv3+ format so we need to do some
5206 * preprocessing to convert the list first. If there are any SSLv2 only
5207 * ciphersuites with a non-zero leading byte then we are going to
5208 * slightly over allocate because we won't store those. But that isn't a
5211 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5212 s->s3->tmp.ciphers_raw = raw;
5214 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5215 ERR_R_MALLOC_FAILURE);
5218 for (s->s3->tmp.ciphers_rawlen = 0;
5219 PACKET_remaining(&sslv2ciphers) > 0;
5220 raw += TLS_CIPHER_LEN) {
5221 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5223 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5226 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5227 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5229 OPENSSL_free(s->s3->tmp.ciphers_raw);
5230 s->s3->tmp.ciphers_raw = NULL;
5231 s->s3->tmp.ciphers_rawlen = 0;
5235 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5237 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5238 &s->s3->tmp.ciphers_rawlen)) {
5239 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5240 ERR_R_INTERNAL_ERROR);
5246 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5247 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5248 STACK_OF(SSL_CIPHER) **scsvs)
5252 if (!PACKET_buf_init(&pkt, bytes, len))
5254 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5257 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5258 STACK_OF(SSL_CIPHER) **skp,
5259 STACK_OF(SSL_CIPHER) **scsvs_out,
5260 int sslv2format, int fatal)
5262 const SSL_CIPHER *c;
5263 STACK_OF(SSL_CIPHER) *sk = NULL;
5264 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5266 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5267 unsigned char cipher[SSLV2_CIPHER_LEN];
5269 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5271 if (PACKET_remaining(cipher_suites) == 0) {
5273 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5274 SSL_R_NO_CIPHERS_SPECIFIED);
5276 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5280 if (PACKET_remaining(cipher_suites) % n != 0) {
5282 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5283 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5285 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5286 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5290 sk = sk_SSL_CIPHER_new_null();
5291 scsvs = sk_SSL_CIPHER_new_null();
5292 if (sk == NULL || scsvs == NULL) {
5294 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5295 ERR_R_MALLOC_FAILURE);
5297 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5301 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5303 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5304 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5305 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5307 if (sslv2format && cipher[0] != '\0')
5310 /* For SSLv2-compat, ignore leading 0-byte. */
5311 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5313 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5314 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5316 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5317 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5319 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5324 if (PACKET_remaining(cipher_suites) > 0) {
5326 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5329 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5336 sk_SSL_CIPHER_free(sk);
5337 if (scsvs_out != NULL)
5340 sk_SSL_CIPHER_free(scsvs);
5343 sk_SSL_CIPHER_free(sk);
5344 sk_SSL_CIPHER_free(scsvs);
5348 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5350 ctx->max_early_data = max_early_data;
5355 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5357 return ctx->max_early_data;
5360 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5362 s->max_early_data = max_early_data;
5367 uint32_t SSL_get_max_early_data(const SSL *s)
5369 return s->max_early_data;
5372 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5374 /* Return any active Max Fragment Len extension */
5375 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5376 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5378 /* return current SSL connection setting */
5379 return ssl->max_send_fragment;
5382 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5384 /* Return a value regarding an active Max Fragment Len extension */
5385 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5386 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5387 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5389 /* else limit |split_send_fragment| to current |max_send_fragment| */
5390 if (ssl->split_send_fragment > ssl->max_send_fragment)
5391 return ssl->max_send_fragment;
5393 /* return current SSL connection setting */
5394 return ssl->split_send_fragment;
5397 int SSL_stateless(SSL *s)
5401 /* Ensure there is no state left over from a previous invocation */
5407 s->s3->flags |= TLS1_FLAGS_STATELESS;
5408 ret = SSL_accept(s);
5409 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5411 if (ret > 0 && s->ext.cookieok)
5414 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5420 void SSL_force_post_handshake_auth(SSL *ssl)
5422 ssl->pha_forced = 1;
5425 int SSL_verify_client_post_handshake(SSL *ssl)
5427 if (!SSL_IS_TLS13(ssl)) {
5428 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5432 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5436 if (!SSL_is_init_finished(ssl)) {
5437 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5441 switch (ssl->post_handshake_auth) {
5443 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5446 case SSL_PHA_EXT_SENT:
5447 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5449 case SSL_PHA_EXT_RECEIVED:
5451 case SSL_PHA_REQUEST_PENDING:
5452 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5454 case SSL_PHA_REQUESTED:
5455 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5459 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5461 /* checks verify_mode and algorithm_auth */
5462 if (!send_certificate_request(ssl)) {
5463 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5464 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5468 ossl_statem_set_in_init(ssl, 1);
5472 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5473 SSL_CTX_generate_session_ticket_fn gen_cb,
5474 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5477 ctx->generate_ticket_cb = gen_cb;
5478 ctx->decrypt_ticket_cb = dec_cb;
5479 ctx->ticket_cb_data = arg;