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/ocsp.h>
18 #include <openssl/dh.h>
19 #include <openssl/engine.h>
20 #include <openssl/async.h>
21 #include <openssl/ct.h>
22 #include "internal/cryptlib.h"
23 #include "internal/rand.h"
24 #include "internal/refcount.h"
26 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
28 static int ssl_undefined_function_1(SSL *ssl, SSL3_RECORD *r, size_t s, int t)
33 return ssl_undefined_function(ssl);
36 static int ssl_undefined_function_2(SSL *ssl, SSL3_RECORD *r, unsigned char *s,
42 return ssl_undefined_function(ssl);
45 static int ssl_undefined_function_3(SSL *ssl, unsigned char *r,
46 unsigned char *s, size_t t, size_t *u)
52 return ssl_undefined_function(ssl);
55 static int ssl_undefined_function_4(SSL *ssl, int r)
58 return ssl_undefined_function(ssl);
61 static size_t ssl_undefined_function_5(SSL *ssl, const char *r, size_t s,
67 return ssl_undefined_function(ssl);
70 static int ssl_undefined_function_6(int r)
73 return ssl_undefined_function(NULL);
76 static int ssl_undefined_function_7(SSL *ssl, unsigned char *r, size_t s,
77 const char *t, size_t u,
78 const unsigned char *v, size_t w, int x)
87 return ssl_undefined_function(ssl);
90 SSL3_ENC_METHOD ssl3_undef_enc_method = {
91 ssl_undefined_function_1,
92 ssl_undefined_function_2,
93 ssl_undefined_function,
94 ssl_undefined_function_3,
95 ssl_undefined_function_4,
96 ssl_undefined_function_5,
97 NULL, /* client_finished_label */
98 0, /* client_finished_label_len */
99 NULL, /* server_finished_label */
100 0, /* server_finished_label_len */
101 ssl_undefined_function_6,
102 ssl_undefined_function_7,
105 struct ssl_async_args {
109 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
111 int (*func_read) (SSL *, void *, size_t, size_t *);
112 int (*func_write) (SSL *, const void *, size_t, size_t *);
113 int (*func_other) (SSL *);
117 static const struct {
123 DANETLS_MATCHING_FULL, 0, NID_undef
126 DANETLS_MATCHING_2256, 1, NID_sha256
129 DANETLS_MATCHING_2512, 2, NID_sha512
133 static int dane_ctx_enable(struct dane_ctx_st *dctx)
135 const EVP_MD **mdevp;
137 uint8_t mdmax = DANETLS_MATCHING_LAST;
138 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
141 if (dctx->mdevp != NULL)
144 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
145 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
147 if (mdord == NULL || mdevp == NULL) {
150 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
154 /* Install default entries */
155 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
158 if (dane_mds[i].nid == NID_undef ||
159 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
161 mdevp[dane_mds[i].mtype] = md;
162 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
172 static void dane_ctx_final(struct dane_ctx_st *dctx)
174 OPENSSL_free(dctx->mdevp);
177 OPENSSL_free(dctx->mdord);
182 static void tlsa_free(danetls_record *t)
186 OPENSSL_free(t->data);
187 EVP_PKEY_free(t->spki);
191 static void dane_final(SSL_DANE *dane)
193 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
196 sk_X509_pop_free(dane->certs, X509_free);
199 X509_free(dane->mcert);
207 * dane_copy - Copy dane configuration, sans verification state.
209 static int ssl_dane_dup(SSL *to, SSL *from)
214 if (!DANETLS_ENABLED(&from->dane))
217 num = sk_danetls_record_num(from->dane.trecs);
218 dane_final(&to->dane);
219 to->dane.flags = from->dane.flags;
220 to->dane.dctx = &to->ctx->dane;
221 to->dane.trecs = sk_danetls_record_new_reserve(NULL, num);
223 if (to->dane.trecs == NULL) {
224 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
228 for (i = 0; i < num; ++i) {
229 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
231 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
232 t->data, t->dlen) <= 0)
238 static int dane_mtype_set(struct dane_ctx_st *dctx,
239 const EVP_MD *md, uint8_t mtype, uint8_t ord)
243 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
244 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
248 if (mtype > dctx->mdmax) {
249 const EVP_MD **mdevp;
251 int n = ((int)mtype) + 1;
253 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
255 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
260 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
262 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
267 /* Zero-fill any gaps */
268 for (i = dctx->mdmax + 1; i < mtype; ++i) {
276 dctx->mdevp[mtype] = md;
277 /* Coerce ordinal of disabled matching types to 0 */
278 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
283 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
285 if (mtype > dane->dctx->mdmax)
287 return dane->dctx->mdevp[mtype];
290 static int dane_tlsa_add(SSL_DANE *dane,
293 uint8_t mtype, unsigned const char *data, size_t dlen)
296 const EVP_MD *md = NULL;
297 int ilen = (int)dlen;
301 if (dane->trecs == NULL) {
302 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
306 if (ilen < 0 || dlen != (size_t)ilen) {
307 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
311 if (usage > DANETLS_USAGE_LAST) {
312 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
316 if (selector > DANETLS_SELECTOR_LAST) {
317 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
321 if (mtype != DANETLS_MATCHING_FULL) {
322 md = tlsa_md_get(dane, mtype);
324 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
329 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
330 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
334 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
338 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
339 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
344 t->selector = selector;
346 t->data = OPENSSL_malloc(dlen);
347 if (t->data == NULL) {
349 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
352 memcpy(t->data, data, dlen);
355 /* Validate and cache full certificate or public key */
356 if (mtype == DANETLS_MATCHING_FULL) {
357 const unsigned char *p = data;
359 EVP_PKEY *pkey = NULL;
362 case DANETLS_SELECTOR_CERT:
363 if (!d2i_X509(&cert, &p, ilen) || p < data ||
364 dlen != (size_t)(p - data)) {
366 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
369 if (X509_get0_pubkey(cert) == NULL) {
371 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
375 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
381 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
382 * records that contain full certificates of trust-anchors that are
383 * not present in the wire chain. For usage PKIX-TA(0), we augment
384 * the chain with untrusted Full(0) certificates from DNS, in case
385 * they are missing from the chain.
387 if ((dane->certs == NULL &&
388 (dane->certs = sk_X509_new_null()) == NULL) ||
389 !sk_X509_push(dane->certs, cert)) {
390 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
397 case DANETLS_SELECTOR_SPKI:
398 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
399 dlen != (size_t)(p - data)) {
401 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
406 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
407 * records that contain full bare keys of trust-anchors that are
408 * not present in the wire chain.
410 if (usage == DANETLS_USAGE_DANE_TA)
419 * Find the right insertion point for the new record.
421 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
422 * they can be processed first, as they require no chain building, and no
423 * expiration or hostname checks. Because DANE-EE(3) is numerically
424 * largest, this is accomplished via descending sort by "usage".
426 * We also sort in descending order by matching ordinal to simplify
427 * the implementation of digest agility in the verification code.
429 * The choice of order for the selector is not significant, so we
430 * use the same descending order for consistency.
432 num = sk_danetls_record_num(dane->trecs);
433 for (i = 0; i < num; ++i) {
434 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
436 if (rec->usage > usage)
438 if (rec->usage < usage)
440 if (rec->selector > selector)
442 if (rec->selector < selector)
444 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
449 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
451 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
454 dane->umask |= DANETLS_USAGE_BIT(usage);
460 * Return 0 if there is only one version configured and it was disabled
461 * at configure time. Return 1 otherwise.
463 static int ssl_check_allowed_versions(int min_version, int max_version)
465 int minisdtls = 0, maxisdtls = 0;
467 /* Figure out if we're doing DTLS versions or TLS versions */
468 if (min_version == DTLS1_BAD_VER
469 || min_version >> 8 == DTLS1_VERSION_MAJOR)
471 if (max_version == DTLS1_BAD_VER
472 || max_version >> 8 == DTLS1_VERSION_MAJOR)
474 /* A wildcard version of 0 could be DTLS or TLS. */
475 if ((minisdtls && !maxisdtls && max_version != 0)
476 || (maxisdtls && !minisdtls && min_version != 0)) {
477 /* Mixing DTLS and TLS versions will lead to sadness; deny it. */
481 if (minisdtls || maxisdtls) {
482 /* Do DTLS version checks. */
483 if (min_version == 0)
484 /* Ignore DTLS1_BAD_VER */
485 min_version = DTLS1_VERSION;
486 if (max_version == 0)
487 max_version = DTLS1_2_VERSION;
488 #ifdef OPENSSL_NO_DTLS1_2
489 if (max_version == DTLS1_2_VERSION)
490 max_version = DTLS1_VERSION;
492 #ifdef OPENSSL_NO_DTLS1
493 if (min_version == DTLS1_VERSION)
494 min_version = DTLS1_2_VERSION;
496 /* Done massaging versions; do the check. */
498 #ifdef OPENSSL_NO_DTLS1
499 || (DTLS_VERSION_GE(min_version, DTLS1_VERSION)
500 && DTLS_VERSION_GE(DTLS1_VERSION, max_version))
502 #ifdef OPENSSL_NO_DTLS1_2
503 || (DTLS_VERSION_GE(min_version, DTLS1_2_VERSION)
504 && DTLS_VERSION_GE(DTLS1_2_VERSION, max_version))
509 /* Regular TLS version checks. */
510 if (min_version == 0)
511 min_version = SSL3_VERSION;
512 if (max_version == 0)
513 max_version = TLS1_3_VERSION;
514 #ifdef OPENSSL_NO_TLS1_3
515 if (max_version == TLS1_3_VERSION)
516 max_version = TLS1_2_VERSION;
518 #ifdef OPENSSL_NO_TLS1_2
519 if (max_version == TLS1_2_VERSION)
520 max_version = TLS1_1_VERSION;
522 #ifdef OPENSSL_NO_TLS1_1
523 if (max_version == TLS1_1_VERSION)
524 max_version = TLS1_VERSION;
526 #ifdef OPENSSL_NO_TLS1
527 if (max_version == TLS1_VERSION)
528 max_version = SSL3_VERSION;
530 #ifdef OPENSSL_NO_SSL3
531 if (min_version == SSL3_VERSION)
532 min_version = TLS1_VERSION;
534 #ifdef OPENSSL_NO_TLS1
535 if (min_version == TLS1_VERSION)
536 min_version = TLS1_1_VERSION;
538 #ifdef OPENSSL_NO_TLS1_1
539 if (min_version == TLS1_1_VERSION)
540 min_version = TLS1_2_VERSION;
542 #ifdef OPENSSL_NO_TLS1_2
543 if (min_version == TLS1_2_VERSION)
544 min_version = TLS1_3_VERSION;
546 /* Done massaging versions; do the check. */
548 #ifdef OPENSSL_NO_SSL3
549 || (min_version <= SSL3_VERSION && SSL3_VERSION <= max_version)
551 #ifdef OPENSSL_NO_TLS1
552 || (min_version <= TLS1_VERSION && TLS1_VERSION <= max_version)
554 #ifdef OPENSSL_NO_TLS1_1
555 || (min_version <= TLS1_1_VERSION && TLS1_1_VERSION <= max_version)
557 #ifdef OPENSSL_NO_TLS1_2
558 || (min_version <= TLS1_2_VERSION && TLS1_2_VERSION <= max_version)
560 #ifdef OPENSSL_NO_TLS1_3
561 || (min_version <= TLS1_3_VERSION && TLS1_3_VERSION <= max_version)
569 static void clear_ciphers(SSL *s)
571 /* clear the current cipher */
572 ssl_clear_cipher_ctx(s);
573 ssl_clear_hash_ctx(&s->read_hash);
574 ssl_clear_hash_ctx(&s->write_hash);
577 int SSL_clear(SSL *s)
579 if (s->method == NULL) {
580 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
584 if (ssl_clear_bad_session(s)) {
585 SSL_SESSION_free(s->session);
588 SSL_SESSION_free(s->psksession);
589 s->psksession = NULL;
590 OPENSSL_free(s->psksession_id);
591 s->psksession_id = NULL;
592 s->psksession_id_len = 0;
593 s->hello_retry_request = 0;
599 if (s->renegotiate) {
600 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
604 ossl_statem_clear(s);
606 s->version = s->method->version;
607 s->client_version = s->version;
608 s->rwstate = SSL_NOTHING;
610 BUF_MEM_free(s->init_buf);
615 s->key_update = SSL_KEY_UPDATE_NONE;
617 EVP_MD_CTX_free(s->pha_dgst);
620 /* Reset DANE verification result state */
623 X509_free(s->dane.mcert);
624 s->dane.mcert = NULL;
625 s->dane.mtlsa = NULL;
627 /* Clear the verification result peername */
628 X509_VERIFY_PARAM_move_peername(s->param, NULL);
631 * Check to see if we were changed into a different method, if so, revert
634 if (s->method != s->ctx->method) {
635 s->method->ssl_free(s);
636 s->method = s->ctx->method;
637 if (!s->method->ssl_new(s))
640 if (!s->method->ssl_clear(s))
644 RECORD_LAYER_clear(&s->rlayer);
649 /** Used to change an SSL_CTXs default SSL method type */
650 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
652 STACK_OF(SSL_CIPHER) *sk;
656 sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
657 &(ctx->cipher_list_by_id),
658 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
659 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
660 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
666 SSL *SSL_new(SSL_CTX *ctx)
671 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
674 if (ctx->method == NULL) {
675 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
679 s = OPENSSL_zalloc(sizeof(*s));
684 s->lock = CRYPTO_THREAD_lock_new();
685 if (s->lock == NULL) {
692 * If not using the standard RAND (say for fuzzing), then don't use a
695 if (RAND_get_rand_method() == RAND_OpenSSL()) {
697 RAND_DRBG_new(RAND_DRBG_NID, 0, RAND_DRBG_get0_public());
699 || RAND_DRBG_instantiate(s->drbg,
700 (const unsigned char *) SSL_version_str,
701 sizeof(SSL_version_str) - 1) == 0)
705 RECORD_LAYER_init(&s->rlayer, s);
707 s->options = ctx->options;
708 s->dane.flags = ctx->dane.flags;
709 s->min_proto_version = ctx->min_proto_version;
710 s->max_proto_version = ctx->max_proto_version;
712 s->max_cert_list = ctx->max_cert_list;
713 s->max_early_data = ctx->max_early_data;
716 * Earlier library versions used to copy the pointer to the CERT, not
717 * its contents; only when setting new parameters for the per-SSL
718 * copy, ssl_cert_new would be called (and the direct reference to
719 * the per-SSL_CTX settings would be lost, but those still were
720 * indirectly accessed for various purposes, and for that reason they
721 * used to be known as s->ctx->default_cert). Now we don't look at the
722 * SSL_CTX's CERT after having duplicated it once.
724 s->cert = ssl_cert_dup(ctx->cert);
728 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
729 s->msg_callback = ctx->msg_callback;
730 s->msg_callback_arg = ctx->msg_callback_arg;
731 s->verify_mode = ctx->verify_mode;
732 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
733 s->record_padding_cb = ctx->record_padding_cb;
734 s->record_padding_arg = ctx->record_padding_arg;
735 s->block_padding = ctx->block_padding;
736 s->sid_ctx_length = ctx->sid_ctx_length;
737 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
739 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
740 s->verify_callback = ctx->default_verify_callback;
741 s->generate_session_id = ctx->generate_session_id;
743 s->param = X509_VERIFY_PARAM_new();
744 if (s->param == NULL)
746 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
747 s->quiet_shutdown = ctx->quiet_shutdown;
749 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
750 s->max_send_fragment = ctx->max_send_fragment;
751 s->split_send_fragment = ctx->split_send_fragment;
752 s->max_pipelines = ctx->max_pipelines;
753 if (s->max_pipelines > 1)
754 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
755 if (ctx->default_read_buf_len > 0)
756 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
761 s->ext.debug_arg = NULL;
762 s->ext.ticket_expected = 0;
763 s->ext.status_type = ctx->ext.status_type;
764 s->ext.status_expected = 0;
765 s->ext.ocsp.ids = NULL;
766 s->ext.ocsp.exts = NULL;
767 s->ext.ocsp.resp = NULL;
768 s->ext.ocsp.resp_len = 0;
770 s->session_ctx = ctx;
771 #ifndef OPENSSL_NO_EC
772 if (ctx->ext.ecpointformats) {
773 s->ext.ecpointformats =
774 OPENSSL_memdup(ctx->ext.ecpointformats,
775 ctx->ext.ecpointformats_len);
776 if (!s->ext.ecpointformats)
778 s->ext.ecpointformats_len =
779 ctx->ext.ecpointformats_len;
781 if (ctx->ext.supportedgroups) {
782 s->ext.supportedgroups =
783 OPENSSL_memdup(ctx->ext.supportedgroups,
784 ctx->ext.supportedgroups_len
785 * sizeof(*ctx->ext.supportedgroups));
786 if (!s->ext.supportedgroups)
788 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
791 #ifndef OPENSSL_NO_NEXTPROTONEG
795 if (s->ctx->ext.alpn) {
796 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
797 if (s->ext.alpn == NULL)
799 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
800 s->ext.alpn_len = s->ctx->ext.alpn_len;
803 s->verified_chain = NULL;
804 s->verify_result = X509_V_OK;
806 s->default_passwd_callback = ctx->default_passwd_callback;
807 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
809 s->method = ctx->method;
811 s->key_update = SSL_KEY_UPDATE_NONE;
813 if (!s->method->ssl_new(s))
816 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
821 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
824 #ifndef OPENSSL_NO_PSK
825 s->psk_client_callback = ctx->psk_client_callback;
826 s->psk_server_callback = ctx->psk_server_callback;
828 s->psk_find_session_cb = ctx->psk_find_session_cb;
829 s->psk_use_session_cb = ctx->psk_use_session_cb;
833 #ifndef OPENSSL_NO_CT
834 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
835 ctx->ct_validation_callback_arg))
842 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
846 int SSL_is_dtls(const SSL *s)
848 return SSL_IS_DTLS(s) ? 1 : 0;
851 int SSL_up_ref(SSL *s)
855 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
858 REF_PRINT_COUNT("SSL", s);
859 REF_ASSERT_ISNT(i < 2);
860 return ((i > 1) ? 1 : 0);
863 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
864 unsigned int sid_ctx_len)
866 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
867 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
868 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
871 ctx->sid_ctx_length = sid_ctx_len;
872 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
877 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
878 unsigned int sid_ctx_len)
880 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
881 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
882 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
885 ssl->sid_ctx_length = sid_ctx_len;
886 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
891 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
893 CRYPTO_THREAD_write_lock(ctx->lock);
894 ctx->generate_session_id = cb;
895 CRYPTO_THREAD_unlock(ctx->lock);
899 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
901 CRYPTO_THREAD_write_lock(ssl->lock);
902 ssl->generate_session_id = cb;
903 CRYPTO_THREAD_unlock(ssl->lock);
907 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
911 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
912 * we can "construct" a session to give us the desired check - i.e. to
913 * find if there's a session in the hash table that would conflict with
914 * any new session built out of this id/id_len and the ssl_version in use
919 if (id_len > sizeof(r.session_id))
922 r.ssl_version = ssl->version;
923 r.session_id_length = id_len;
924 memcpy(r.session_id, id, id_len);
926 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
927 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
928 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
932 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
934 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
937 int SSL_set_purpose(SSL *s, int purpose)
939 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
942 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
944 return X509_VERIFY_PARAM_set_trust(s->param, trust);
947 int SSL_set_trust(SSL *s, int trust)
949 return X509_VERIFY_PARAM_set_trust(s->param, trust);
952 int SSL_set1_host(SSL *s, const char *hostname)
954 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
957 int SSL_add1_host(SSL *s, const char *hostname)
959 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
962 void SSL_set_hostflags(SSL *s, unsigned int flags)
964 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
967 const char *SSL_get0_peername(SSL *s)
969 return X509_VERIFY_PARAM_get0_peername(s->param);
972 int SSL_CTX_dane_enable(SSL_CTX *ctx)
974 return dane_ctx_enable(&ctx->dane);
977 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
979 unsigned long orig = ctx->dane.flags;
981 ctx->dane.flags |= flags;
985 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
987 unsigned long orig = ctx->dane.flags;
989 ctx->dane.flags &= ~flags;
993 int SSL_dane_enable(SSL *s, const char *basedomain)
995 SSL_DANE *dane = &s->dane;
997 if (s->ctx->dane.mdmax == 0) {
998 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
1001 if (dane->trecs != NULL) {
1002 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1007 * Default SNI name. This rejects empty names, while set1_host below
1008 * accepts them and disables host name checks. To avoid side-effects with
1009 * invalid input, set the SNI name first.
1011 if (s->ext.hostname == NULL) {
1012 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1013 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1018 /* Primary RFC6125 reference identifier */
1019 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1020 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1026 dane->dctx = &s->ctx->dane;
1027 dane->trecs = sk_danetls_record_new_null();
1029 if (dane->trecs == NULL) {
1030 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1036 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1038 unsigned long orig = ssl->dane.flags;
1040 ssl->dane.flags |= flags;
1044 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1046 unsigned long orig = ssl->dane.flags;
1048 ssl->dane.flags &= ~flags;
1052 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1054 SSL_DANE *dane = &s->dane;
1056 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1060 *mcert = dane->mcert;
1062 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1067 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1068 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1070 SSL_DANE *dane = &s->dane;
1072 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1076 *usage = dane->mtlsa->usage;
1078 *selector = dane->mtlsa->selector;
1080 *mtype = dane->mtlsa->mtype;
1082 *data = dane->mtlsa->data;
1084 *dlen = dane->mtlsa->dlen;
1089 SSL_DANE *SSL_get0_dane(SSL *s)
1094 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1095 uint8_t mtype, unsigned const char *data, size_t dlen)
1097 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1100 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1103 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1106 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1108 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1111 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1113 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1116 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1121 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1126 void SSL_certs_clear(SSL *s)
1128 ssl_cert_clear_certs(s->cert);
1131 void SSL_free(SSL *s)
1138 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1139 REF_PRINT_COUNT("SSL", s);
1142 REF_ASSERT_ISNT(i < 0);
1144 X509_VERIFY_PARAM_free(s->param);
1145 dane_final(&s->dane);
1146 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1148 /* Ignore return value */
1149 ssl_free_wbio_buffer(s);
1151 BIO_free_all(s->wbio);
1152 BIO_free_all(s->rbio);
1154 BUF_MEM_free(s->init_buf);
1156 /* add extra stuff */
1157 sk_SSL_CIPHER_free(s->cipher_list);
1158 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1160 /* Make the next call work :-) */
1161 if (s->session != NULL) {
1162 ssl_clear_bad_session(s);
1163 SSL_SESSION_free(s->session);
1165 SSL_SESSION_free(s->psksession);
1166 OPENSSL_free(s->psksession_id);
1170 ssl_cert_free(s->cert);
1171 /* Free up if allocated */
1173 OPENSSL_free(s->ext.hostname);
1174 SSL_CTX_free(s->session_ctx);
1175 #ifndef OPENSSL_NO_EC
1176 OPENSSL_free(s->ext.ecpointformats);
1177 OPENSSL_free(s->ext.supportedgroups);
1178 #endif /* OPENSSL_NO_EC */
1179 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1180 #ifndef OPENSSL_NO_OCSP
1181 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1183 #ifndef OPENSSL_NO_CT
1184 SCT_LIST_free(s->scts);
1185 OPENSSL_free(s->ext.scts);
1187 OPENSSL_free(s->ext.ocsp.resp);
1188 OPENSSL_free(s->ext.alpn);
1189 OPENSSL_free(s->ext.tls13_cookie);
1190 OPENSSL_free(s->clienthello);
1191 OPENSSL_free(s->pha_context);
1192 EVP_MD_CTX_free(s->pha_dgst);
1194 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1196 sk_X509_pop_free(s->verified_chain, X509_free);
1198 if (s->method != NULL)
1199 s->method->ssl_free(s);
1201 RECORD_LAYER_release(&s->rlayer);
1203 SSL_CTX_free(s->ctx);
1205 ASYNC_WAIT_CTX_free(s->waitctx);
1207 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1208 OPENSSL_free(s->ext.npn);
1211 #ifndef OPENSSL_NO_SRTP
1212 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1215 RAND_DRBG_free(s->drbg);
1216 CRYPTO_THREAD_lock_free(s->lock);
1221 void SSL_set0_rbio(SSL *s, BIO *rbio)
1223 BIO_free_all(s->rbio);
1227 void SSL_set0_wbio(SSL *s, BIO *wbio)
1230 * If the output buffering BIO is still in place, remove it
1232 if (s->bbio != NULL)
1233 s->wbio = BIO_pop(s->wbio);
1235 BIO_free_all(s->wbio);
1238 /* Re-attach |bbio| to the new |wbio|. */
1239 if (s->bbio != NULL)
1240 s->wbio = BIO_push(s->bbio, s->wbio);
1243 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1246 * For historical reasons, this function has many different cases in
1247 * ownership handling.
1250 /* If nothing has changed, do nothing */
1251 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1255 * If the two arguments are equal then one fewer reference is granted by the
1256 * caller than we want to take
1258 if (rbio != NULL && rbio == wbio)
1262 * If only the wbio is changed only adopt one reference.
1264 if (rbio == SSL_get_rbio(s)) {
1265 SSL_set0_wbio(s, wbio);
1269 * There is an asymmetry here for historical reasons. If only the rbio is
1270 * changed AND the rbio and wbio were originally different, then we only
1271 * adopt one reference.
1273 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1274 SSL_set0_rbio(s, rbio);
1278 /* Otherwise, adopt both references. */
1279 SSL_set0_rbio(s, rbio);
1280 SSL_set0_wbio(s, wbio);
1283 BIO *SSL_get_rbio(const SSL *s)
1288 BIO *SSL_get_wbio(const SSL *s)
1290 if (s->bbio != NULL) {
1292 * If |bbio| is active, the true caller-configured BIO is its
1295 return BIO_next(s->bbio);
1300 int SSL_get_fd(const SSL *s)
1302 return SSL_get_rfd(s);
1305 int SSL_get_rfd(const SSL *s)
1310 b = SSL_get_rbio(s);
1311 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1313 BIO_get_fd(r, &ret);
1317 int SSL_get_wfd(const SSL *s)
1322 b = SSL_get_wbio(s);
1323 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1325 BIO_get_fd(r, &ret);
1329 #ifndef OPENSSL_NO_SOCK
1330 int SSL_set_fd(SSL *s, int fd)
1335 bio = BIO_new(BIO_s_socket());
1338 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1341 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1342 SSL_set_bio(s, bio, bio);
1348 int SSL_set_wfd(SSL *s, int fd)
1350 BIO *rbio = SSL_get_rbio(s);
1352 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1353 || (int)BIO_get_fd(rbio, NULL) != fd) {
1354 BIO *bio = BIO_new(BIO_s_socket());
1357 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1360 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1361 SSL_set0_wbio(s, bio);
1364 SSL_set0_wbio(s, rbio);
1369 int SSL_set_rfd(SSL *s, int fd)
1371 BIO *wbio = SSL_get_wbio(s);
1373 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1374 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1375 BIO *bio = BIO_new(BIO_s_socket());
1378 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1381 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1382 SSL_set0_rbio(s, bio);
1385 SSL_set0_rbio(s, wbio);
1392 /* return length of latest Finished message we sent, copy to 'buf' */
1393 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1397 if (s->s3 != NULL) {
1398 ret = s->s3->tmp.finish_md_len;
1401 memcpy(buf, s->s3->tmp.finish_md, count);
1406 /* return length of latest Finished message we expected, copy to 'buf' */
1407 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1411 if (s->s3 != NULL) {
1412 ret = s->s3->tmp.peer_finish_md_len;
1415 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1420 int SSL_get_verify_mode(const SSL *s)
1422 return s->verify_mode;
1425 int SSL_get_verify_depth(const SSL *s)
1427 return X509_VERIFY_PARAM_get_depth(s->param);
1430 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1431 return s->verify_callback;
1434 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1436 return ctx->verify_mode;
1439 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1441 return X509_VERIFY_PARAM_get_depth(ctx->param);
1444 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1445 return ctx->default_verify_callback;
1448 void SSL_set_verify(SSL *s, int mode,
1449 int (*callback) (int ok, X509_STORE_CTX *ctx))
1451 s->verify_mode = mode;
1452 if (callback != NULL)
1453 s->verify_callback = callback;
1456 void SSL_set_verify_depth(SSL *s, int depth)
1458 X509_VERIFY_PARAM_set_depth(s->param, depth);
1461 void SSL_set_read_ahead(SSL *s, int yes)
1463 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1466 int SSL_get_read_ahead(const SSL *s)
1468 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1471 int SSL_pending(const SSL *s)
1473 size_t pending = s->method->ssl_pending(s);
1476 * SSL_pending cannot work properly if read-ahead is enabled
1477 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1478 * impossible to fix since SSL_pending cannot report errors that may be
1479 * observed while scanning the new data. (Note that SSL_pending() is
1480 * often used as a boolean value, so we'd better not return -1.)
1482 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1483 * we just return INT_MAX.
1485 return pending < INT_MAX ? (int)pending : INT_MAX;
1488 int SSL_has_pending(const SSL *s)
1491 * Similar to SSL_pending() but returns a 1 to indicate that we have
1492 * unprocessed data available or 0 otherwise (as opposed to the number of
1493 * bytes available). Unlike SSL_pending() this will take into account
1494 * read_ahead data. A 1 return simply indicates that we have unprocessed
1495 * data. That data may not result in any application data, or we may fail
1496 * to parse the records for some reason.
1498 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1501 return RECORD_LAYER_read_pending(&s->rlayer);
1504 X509 *SSL_get_peer_certificate(const SSL *s)
1508 if ((s == NULL) || (s->session == NULL))
1511 r = s->session->peer;
1521 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1525 if ((s == NULL) || (s->session == NULL))
1528 r = s->session->peer_chain;
1531 * If we are a client, cert_chain includes the peer's own certificate; if
1532 * we are a server, it does not.
1539 * Now in theory, since the calling process own 't' it should be safe to
1540 * modify. We need to be able to read f without being hassled
1542 int SSL_copy_session_id(SSL *t, const SSL *f)
1545 /* Do we need to to SSL locking? */
1546 if (!SSL_set_session(t, SSL_get_session(f))) {
1551 * what if we are setup for one protocol version but want to talk another
1553 if (t->method != f->method) {
1554 t->method->ssl_free(t);
1555 t->method = f->method;
1556 if (t->method->ssl_new(t) == 0)
1560 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1561 ssl_cert_free(t->cert);
1563 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1570 /* Fix this so it checks all the valid key/cert options */
1571 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1573 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1574 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1577 if (ctx->cert->key->privatekey == NULL) {
1578 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1581 return X509_check_private_key
1582 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1585 /* Fix this function so that it takes an optional type parameter */
1586 int SSL_check_private_key(const SSL *ssl)
1589 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1592 if (ssl->cert->key->x509 == NULL) {
1593 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1596 if (ssl->cert->key->privatekey == NULL) {
1597 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1600 return X509_check_private_key(ssl->cert->key->x509,
1601 ssl->cert->key->privatekey);
1604 int SSL_waiting_for_async(SSL *s)
1612 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1614 ASYNC_WAIT_CTX *ctx = s->waitctx;
1618 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1621 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1622 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1624 ASYNC_WAIT_CTX *ctx = s->waitctx;
1628 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1632 int SSL_accept(SSL *s)
1634 if (s->handshake_func == NULL) {
1635 /* Not properly initialized yet */
1636 SSL_set_accept_state(s);
1639 return SSL_do_handshake(s);
1642 int SSL_connect(SSL *s)
1644 if (s->handshake_func == NULL) {
1645 /* Not properly initialized yet */
1646 SSL_set_connect_state(s);
1649 return SSL_do_handshake(s);
1652 long SSL_get_default_timeout(const SSL *s)
1654 return s->method->get_timeout();
1657 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1658 int (*func) (void *))
1661 if (s->waitctx == NULL) {
1662 s->waitctx = ASYNC_WAIT_CTX_new();
1663 if (s->waitctx == NULL)
1666 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1667 sizeof(struct ssl_async_args))) {
1669 s->rwstate = SSL_NOTHING;
1670 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1673 s->rwstate = SSL_ASYNC_PAUSED;
1676 s->rwstate = SSL_ASYNC_NO_JOBS;
1682 s->rwstate = SSL_NOTHING;
1683 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1684 /* Shouldn't happen */
1689 static int ssl_io_intern(void *vargs)
1691 struct ssl_async_args *args;
1696 args = (struct ssl_async_args *)vargs;
1700 switch (args->type) {
1702 return args->f.func_read(s, buf, num, &s->asyncrw);
1704 return args->f.func_write(s, buf, num, &s->asyncrw);
1706 return args->f.func_other(s);
1711 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1713 if (s->handshake_func == NULL) {
1714 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1718 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1719 s->rwstate = SSL_NOTHING;
1723 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1724 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1725 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1729 * If we are a client and haven't received the ServerHello etc then we
1732 ossl_statem_check_finish_init(s, 0);
1734 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1735 struct ssl_async_args args;
1741 args.type = READFUNC;
1742 args.f.func_read = s->method->ssl_read;
1744 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1745 *readbytes = s->asyncrw;
1748 return s->method->ssl_read(s, buf, num, readbytes);
1752 int SSL_read(SSL *s, void *buf, int num)
1758 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1762 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1765 * The cast is safe here because ret should be <= INT_MAX because num is
1769 ret = (int)readbytes;
1774 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1776 int ret = ssl_read_internal(s, buf, num, readbytes);
1783 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1788 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1789 return SSL_READ_EARLY_DATA_ERROR;
1792 switch (s->early_data_state) {
1793 case SSL_EARLY_DATA_NONE:
1794 if (!SSL_in_before(s)) {
1795 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1796 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1797 return SSL_READ_EARLY_DATA_ERROR;
1801 case SSL_EARLY_DATA_ACCEPT_RETRY:
1802 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1803 ret = SSL_accept(s);
1806 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1807 return SSL_READ_EARLY_DATA_ERROR;
1811 case SSL_EARLY_DATA_READ_RETRY:
1812 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1813 s->early_data_state = SSL_EARLY_DATA_READING;
1814 ret = SSL_read_ex(s, buf, num, readbytes);
1816 * State machine will update early_data_state to
1817 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1820 if (ret > 0 || (ret <= 0 && s->early_data_state
1821 != SSL_EARLY_DATA_FINISHED_READING)) {
1822 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1823 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1824 : SSL_READ_EARLY_DATA_ERROR;
1827 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1830 return SSL_READ_EARLY_DATA_FINISH;
1833 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1834 return SSL_READ_EARLY_DATA_ERROR;
1838 int SSL_get_early_data_status(const SSL *s)
1840 return s->ext.early_data;
1843 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1845 if (s->handshake_func == NULL) {
1846 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1850 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1853 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1854 struct ssl_async_args args;
1860 args.type = READFUNC;
1861 args.f.func_read = s->method->ssl_peek;
1863 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1864 *readbytes = s->asyncrw;
1867 return s->method->ssl_peek(s, buf, num, readbytes);
1871 int SSL_peek(SSL *s, void *buf, int num)
1877 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1881 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1884 * The cast is safe here because ret should be <= INT_MAX because num is
1888 ret = (int)readbytes;
1894 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1896 int ret = ssl_peek_internal(s, buf, num, readbytes);
1903 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1905 if (s->handshake_func == NULL) {
1906 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1910 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1911 s->rwstate = SSL_NOTHING;
1912 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1916 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1917 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1918 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1919 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1922 /* If we are a client and haven't sent the Finished we better do that */
1923 ossl_statem_check_finish_init(s, 1);
1925 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1927 struct ssl_async_args args;
1930 args.buf = (void *)buf;
1932 args.type = WRITEFUNC;
1933 args.f.func_write = s->method->ssl_write;
1935 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1936 *written = s->asyncrw;
1939 return s->method->ssl_write(s, buf, num, written);
1943 int SSL_write(SSL *s, const void *buf, int num)
1949 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1953 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1956 * The cast is safe here because ret should be <= INT_MAX because num is
1965 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1967 int ret = ssl_write_internal(s, buf, num, written);
1974 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1976 int ret, early_data_state;
1978 uint32_t partialwrite;
1980 switch (s->early_data_state) {
1981 case SSL_EARLY_DATA_NONE:
1983 || !SSL_in_before(s)
1984 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1985 && (s->psk_use_session_cb == NULL))) {
1986 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1987 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1992 case SSL_EARLY_DATA_CONNECT_RETRY:
1993 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1994 ret = SSL_connect(s);
1997 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2002 case SSL_EARLY_DATA_WRITE_RETRY:
2003 s->early_data_state = SSL_EARLY_DATA_WRITING;
2005 * We disable partial write for early data because we don't keep track
2006 * of how many bytes we've written between the SSL_write_ex() call and
2007 * the flush if the flush needs to be retried)
2009 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2010 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2011 ret = SSL_write_ex(s, buf, num, &writtmp);
2012 s->mode |= partialwrite;
2014 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2017 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2020 case SSL_EARLY_DATA_WRITE_FLUSH:
2021 /* The buffering BIO is still in place so we need to flush it */
2022 if (statem_flush(s) != 1)
2025 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2028 case SSL_EARLY_DATA_FINISHED_READING:
2029 case SSL_EARLY_DATA_READ_RETRY:
2030 early_data_state = s->early_data_state;
2031 /* We are a server writing to an unauthenticated client */
2032 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2033 ret = SSL_write_ex(s, buf, num, written);
2034 s->early_data_state = early_data_state;
2038 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2043 int SSL_shutdown(SSL *s)
2046 * Note that this function behaves differently from what one might
2047 * expect. Return values are 0 for no success (yet), 1 for success; but
2048 * calling it once is usually not enough, even if blocking I/O is used
2049 * (see ssl3_shutdown).
2052 if (s->handshake_func == NULL) {
2053 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2057 if (!SSL_in_init(s)) {
2058 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2059 struct ssl_async_args args;
2062 args.type = OTHERFUNC;
2063 args.f.func_other = s->method->ssl_shutdown;
2065 return ssl_start_async_job(s, &args, ssl_io_intern);
2067 return s->method->ssl_shutdown(s);
2070 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2075 int SSL_key_update(SSL *s, int updatetype)
2078 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2079 * negotiated, and that it is appropriate to call SSL_key_update() instead
2080 * of SSL_renegotiate().
2082 if (!SSL_IS_TLS13(s)) {
2083 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2087 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2088 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2089 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2093 if (!SSL_is_init_finished(s)) {
2094 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2098 ossl_statem_set_in_init(s, 1);
2099 s->key_update = updatetype;
2103 int SSL_get_key_update_type(SSL *s)
2105 return s->key_update;
2108 int SSL_renegotiate(SSL *s)
2110 if (SSL_IS_TLS13(s)) {
2111 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2115 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2116 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2123 return s->method->ssl_renegotiate(s);
2126 int SSL_renegotiate_abbreviated(SSL *s)
2128 if (SSL_IS_TLS13(s)) {
2129 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2133 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2134 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2141 return s->method->ssl_renegotiate(s);
2144 int SSL_renegotiate_pending(SSL *s)
2147 * becomes true when negotiation is requested; false again once a
2148 * handshake has finished
2150 return (s->renegotiate != 0);
2153 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2158 case SSL_CTRL_GET_READ_AHEAD:
2159 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2160 case SSL_CTRL_SET_READ_AHEAD:
2161 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2162 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2165 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2166 s->msg_callback_arg = parg;
2170 return (s->mode |= larg);
2171 case SSL_CTRL_CLEAR_MODE:
2172 return (s->mode &= ~larg);
2173 case SSL_CTRL_GET_MAX_CERT_LIST:
2174 return (long)s->max_cert_list;
2175 case SSL_CTRL_SET_MAX_CERT_LIST:
2178 l = (long)s->max_cert_list;
2179 s->max_cert_list = (size_t)larg;
2181 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2182 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2184 s->max_send_fragment = larg;
2185 if (s->max_send_fragment < s->split_send_fragment)
2186 s->split_send_fragment = s->max_send_fragment;
2188 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2189 if ((size_t)larg > s->max_send_fragment || larg == 0)
2191 s->split_send_fragment = larg;
2193 case SSL_CTRL_SET_MAX_PIPELINES:
2194 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2196 s->max_pipelines = larg;
2198 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2200 case SSL_CTRL_GET_RI_SUPPORT:
2202 return s->s3->send_connection_binding;
2205 case SSL_CTRL_CERT_FLAGS:
2206 return (s->cert->cert_flags |= larg);
2207 case SSL_CTRL_CLEAR_CERT_FLAGS:
2208 return (s->cert->cert_flags &= ~larg);
2210 case SSL_CTRL_GET_RAW_CIPHERLIST:
2212 if (s->s3->tmp.ciphers_raw == NULL)
2214 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2215 return (int)s->s3->tmp.ciphers_rawlen;
2217 return TLS_CIPHER_LEN;
2219 case SSL_CTRL_GET_EXTMS_SUPPORT:
2220 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2222 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2226 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2227 return ssl_check_allowed_versions(larg, s->max_proto_version)
2228 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2229 &s->min_proto_version);
2230 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2231 return s->min_proto_version;
2232 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2233 return ssl_check_allowed_versions(s->min_proto_version, larg)
2234 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2235 &s->max_proto_version);
2236 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2237 return s->max_proto_version;
2239 return s->method->ssl_ctrl(s, cmd, larg, parg);
2243 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2246 case SSL_CTRL_SET_MSG_CALLBACK:
2247 s->msg_callback = (void (*)
2248 (int write_p, int version, int content_type,
2249 const void *buf, size_t len, SSL *ssl,
2254 return s->method->ssl_callback_ctrl(s, cmd, fp);
2258 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2260 return ctx->sessions;
2263 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2267 /* For some cases with ctx == NULL perform syntax checks */
2270 #ifndef OPENSSL_NO_EC
2271 case SSL_CTRL_SET_GROUPS_LIST:
2272 return tls1_set_groups_list(NULL, NULL, parg);
2274 case SSL_CTRL_SET_SIGALGS_LIST:
2275 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2276 return tls1_set_sigalgs_list(NULL, parg, 0);
2283 case SSL_CTRL_GET_READ_AHEAD:
2284 return ctx->read_ahead;
2285 case SSL_CTRL_SET_READ_AHEAD:
2286 l = ctx->read_ahead;
2287 ctx->read_ahead = larg;
2290 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2291 ctx->msg_callback_arg = parg;
2294 case SSL_CTRL_GET_MAX_CERT_LIST:
2295 return (long)ctx->max_cert_list;
2296 case SSL_CTRL_SET_MAX_CERT_LIST:
2299 l = (long)ctx->max_cert_list;
2300 ctx->max_cert_list = (size_t)larg;
2303 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2306 l = (long)ctx->session_cache_size;
2307 ctx->session_cache_size = (size_t)larg;
2309 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2310 return (long)ctx->session_cache_size;
2311 case SSL_CTRL_SET_SESS_CACHE_MODE:
2312 l = ctx->session_cache_mode;
2313 ctx->session_cache_mode = larg;
2315 case SSL_CTRL_GET_SESS_CACHE_MODE:
2316 return ctx->session_cache_mode;
2318 case SSL_CTRL_SESS_NUMBER:
2319 return lh_SSL_SESSION_num_items(ctx->sessions);
2320 case SSL_CTRL_SESS_CONNECT:
2321 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2323 case SSL_CTRL_SESS_CONNECT_GOOD:
2324 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2326 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2327 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2330 case SSL_CTRL_SESS_ACCEPT:
2331 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2333 case SSL_CTRL_SESS_ACCEPT_GOOD:
2334 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2336 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2337 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2340 case SSL_CTRL_SESS_HIT:
2341 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2343 case SSL_CTRL_SESS_CB_HIT:
2344 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2346 case SSL_CTRL_SESS_MISSES:
2347 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2349 case SSL_CTRL_SESS_TIMEOUTS:
2350 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2352 case SSL_CTRL_SESS_CACHE_FULL:
2353 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2356 return (ctx->mode |= larg);
2357 case SSL_CTRL_CLEAR_MODE:
2358 return (ctx->mode &= ~larg);
2359 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2360 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2362 ctx->max_send_fragment = larg;
2363 if (ctx->max_send_fragment < ctx->split_send_fragment)
2364 ctx->split_send_fragment = ctx->max_send_fragment;
2366 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2367 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2369 ctx->split_send_fragment = larg;
2371 case SSL_CTRL_SET_MAX_PIPELINES:
2372 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2374 ctx->max_pipelines = larg;
2376 case SSL_CTRL_CERT_FLAGS:
2377 return (ctx->cert->cert_flags |= larg);
2378 case SSL_CTRL_CLEAR_CERT_FLAGS:
2379 return (ctx->cert->cert_flags &= ~larg);
2380 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2381 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2382 && ssl_set_version_bound(ctx->method->version, (int)larg,
2383 &ctx->min_proto_version);
2384 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2385 return ctx->min_proto_version;
2386 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2387 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2388 && ssl_set_version_bound(ctx->method->version, (int)larg,
2389 &ctx->max_proto_version);
2390 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2391 return ctx->max_proto_version;
2393 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2397 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2400 case SSL_CTRL_SET_MSG_CALLBACK:
2401 ctx->msg_callback = (void (*)
2402 (int write_p, int version, int content_type,
2403 const void *buf, size_t len, SSL *ssl,
2408 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2412 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2421 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2422 const SSL_CIPHER *const *bp)
2424 if ((*ap)->id > (*bp)->id)
2426 if ((*ap)->id < (*bp)->id)
2431 /** return a STACK of the ciphers available for the SSL and in order of
2433 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2436 if (s->cipher_list != NULL) {
2437 return s->cipher_list;
2438 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2439 return s->ctx->cipher_list;
2445 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2447 if ((s == NULL) || (s->session == NULL) || !s->server)
2449 return s->session->ciphers;
2452 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2454 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2457 ciphers = SSL_get_ciphers(s);
2460 if (!ssl_set_client_disabled(s))
2462 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2463 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2464 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2466 sk = sk_SSL_CIPHER_new_null();
2469 if (!sk_SSL_CIPHER_push(sk, c)) {
2470 sk_SSL_CIPHER_free(sk);
2478 /** return a STACK of the ciphers available for the SSL and in order of
2480 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2483 if (s->cipher_list_by_id != NULL) {
2484 return s->cipher_list_by_id;
2485 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2486 return s->ctx->cipher_list_by_id;
2492 /** The old interface to get the same thing as SSL_get_ciphers() */
2493 const char *SSL_get_cipher_list(const SSL *s, int n)
2495 const SSL_CIPHER *c;
2496 STACK_OF(SSL_CIPHER) *sk;
2500 sk = SSL_get_ciphers(s);
2501 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2503 c = sk_SSL_CIPHER_value(sk, n);
2509 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2511 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2514 return ctx->cipher_list;
2518 /** specify the ciphers to be used by default by the SSL_CTX */
2519 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2521 STACK_OF(SSL_CIPHER) *sk;
2523 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2524 &ctx->cipher_list_by_id, str, ctx->cert);
2526 * ssl_create_cipher_list may return an empty stack if it was unable to
2527 * find a cipher matching the given rule string (for example if the rule
2528 * string specifies a cipher which has been disabled). This is not an
2529 * error as far as ssl_create_cipher_list is concerned, and hence
2530 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2534 else if (sk_SSL_CIPHER_num(sk) == 0) {
2535 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2541 /** specify the ciphers to be used by the SSL */
2542 int SSL_set_cipher_list(SSL *s, const char *str)
2544 STACK_OF(SSL_CIPHER) *sk;
2546 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2547 &s->cipher_list_by_id, str, s->cert);
2548 /* see comment in SSL_CTX_set_cipher_list */
2551 else if (sk_SSL_CIPHER_num(sk) == 0) {
2552 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2558 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2561 STACK_OF(SSL_CIPHER) *sk;
2562 const SSL_CIPHER *c;
2565 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2569 sk = s->session->ciphers;
2571 if (sk_SSL_CIPHER_num(sk) == 0)
2574 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2577 c = sk_SSL_CIPHER_value(sk, i);
2578 n = strlen(c->name);
2594 /** return a servername extension value if provided in Client Hello, or NULL.
2595 * So far, only host_name types are defined (RFC 3546).
2598 const char *SSL_get_servername(const SSL *s, const int type)
2600 if (type != TLSEXT_NAMETYPE_host_name)
2603 return s->session && !s->ext.hostname ?
2604 s->session->ext.hostname : s->ext.hostname;
2607 int SSL_get_servername_type(const SSL *s)
2610 && (!s->ext.hostname ? s->session->
2611 ext.hostname : s->ext.hostname))
2612 return TLSEXT_NAMETYPE_host_name;
2617 * SSL_select_next_proto implements the standard protocol selection. It is
2618 * expected that this function is called from the callback set by
2619 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2620 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2621 * not included in the length. A byte string of length 0 is invalid. No byte
2622 * string may be truncated. The current, but experimental algorithm for
2623 * selecting the protocol is: 1) If the server doesn't support NPN then this
2624 * is indicated to the callback. In this case, the client application has to
2625 * abort the connection or have a default application level protocol. 2) If
2626 * the server supports NPN, but advertises an empty list then the client
2627 * selects the first protocol in its list, but indicates via the API that this
2628 * fallback case was enacted. 3) Otherwise, the client finds the first
2629 * protocol in the server's list that it supports and selects this protocol.
2630 * This is because it's assumed that the server has better information about
2631 * which protocol a client should use. 4) If the client doesn't support any
2632 * of the server's advertised protocols, then this is treated the same as
2633 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2634 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2636 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2637 const unsigned char *server,
2638 unsigned int server_len,
2639 const unsigned char *client, unsigned int client_len)
2642 const unsigned char *result;
2643 int status = OPENSSL_NPN_UNSUPPORTED;
2646 * For each protocol in server preference order, see if we support it.
2648 for (i = 0; i < server_len;) {
2649 for (j = 0; j < client_len;) {
2650 if (server[i] == client[j] &&
2651 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2652 /* We found a match */
2653 result = &server[i];
2654 status = OPENSSL_NPN_NEGOTIATED;
2664 /* There's no overlap between our protocols and the server's list. */
2666 status = OPENSSL_NPN_NO_OVERLAP;
2669 *out = (unsigned char *)result + 1;
2670 *outlen = result[0];
2674 #ifndef OPENSSL_NO_NEXTPROTONEG
2676 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2677 * client's requested protocol for this connection and returns 0. If the
2678 * client didn't request any protocol, then *data is set to NULL. Note that
2679 * the client can request any protocol it chooses. The value returned from
2680 * this function need not be a member of the list of supported protocols
2681 * provided by the callback.
2683 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2690 *len = (unsigned int)s->ext.npn_len;
2695 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2696 * a TLS server needs a list of supported protocols for Next Protocol
2697 * Negotiation. The returned list must be in wire format. The list is
2698 * returned by setting |out| to point to it and |outlen| to its length. This
2699 * memory will not be modified, but one should assume that the SSL* keeps a
2700 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2701 * wishes to advertise. Otherwise, no such extension will be included in the
2704 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2705 SSL_CTX_npn_advertised_cb_func cb,
2708 ctx->ext.npn_advertised_cb = cb;
2709 ctx->ext.npn_advertised_cb_arg = arg;
2713 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2714 * client needs to select a protocol from the server's provided list. |out|
2715 * must be set to point to the selected protocol (which may be within |in|).
2716 * The length of the protocol name must be written into |outlen|. The
2717 * server's advertised protocols are provided in |in| and |inlen|. The
2718 * callback can assume that |in| is syntactically valid. The client must
2719 * select a protocol. It is fatal to the connection if this callback returns
2720 * a value other than SSL_TLSEXT_ERR_OK.
2722 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2723 SSL_CTX_npn_select_cb_func cb,
2726 ctx->ext.npn_select_cb = cb;
2727 ctx->ext.npn_select_cb_arg = arg;
2732 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2733 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2734 * length-prefixed strings). Returns 0 on success.
2736 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2737 unsigned int protos_len)
2739 OPENSSL_free(ctx->ext.alpn);
2740 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2741 if (ctx->ext.alpn == NULL) {
2742 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2745 ctx->ext.alpn_len = protos_len;
2751 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2752 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2753 * length-prefixed strings). Returns 0 on success.
2755 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2756 unsigned int protos_len)
2758 OPENSSL_free(ssl->ext.alpn);
2759 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2760 if (ssl->ext.alpn == NULL) {
2761 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2764 ssl->ext.alpn_len = protos_len;
2770 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2771 * called during ClientHello processing in order to select an ALPN protocol
2772 * from the client's list of offered protocols.
2774 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2775 SSL_CTX_alpn_select_cb_func cb,
2778 ctx->ext.alpn_select_cb = cb;
2779 ctx->ext.alpn_select_cb_arg = arg;
2783 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2784 * On return it sets |*data| to point to |*len| bytes of protocol name
2785 * (not including the leading length-prefix byte). If the server didn't
2786 * respond with a negotiated protocol then |*len| will be zero.
2788 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2793 *data = ssl->s3->alpn_selected;
2797 *len = (unsigned int)ssl->s3->alpn_selected_len;
2800 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2801 const char *label, size_t llen,
2802 const unsigned char *context, size_t contextlen,
2805 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2808 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2810 contextlen, use_context);
2813 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2814 const char *label, size_t llen,
2815 const unsigned char *context,
2818 if (s->version != TLS1_3_VERSION)
2821 return tls13_export_keying_material_early(s, out, olen, label, llen,
2822 context, contextlen);
2825 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2827 const unsigned char *session_id = a->session_id;
2829 unsigned char tmp_storage[4];
2831 if (a->session_id_length < sizeof(tmp_storage)) {
2832 memset(tmp_storage, 0, sizeof(tmp_storage));
2833 memcpy(tmp_storage, a->session_id, a->session_id_length);
2834 session_id = tmp_storage;
2838 ((unsigned long)session_id[0]) |
2839 ((unsigned long)session_id[1] << 8L) |
2840 ((unsigned long)session_id[2] << 16L) |
2841 ((unsigned long)session_id[3] << 24L);
2846 * NB: If this function (or indeed the hash function which uses a sort of
2847 * coarser function than this one) is changed, ensure
2848 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2849 * being able to construct an SSL_SESSION that will collide with any existing
2850 * session with a matching session ID.
2852 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2854 if (a->ssl_version != b->ssl_version)
2856 if (a->session_id_length != b->session_id_length)
2858 return memcmp(a->session_id, b->session_id, a->session_id_length);
2862 * These wrapper functions should remain rather than redeclaring
2863 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2864 * variable. The reason is that the functions aren't static, they're exposed
2868 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2870 SSL_CTX *ret = NULL;
2873 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2877 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2880 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2881 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2884 ret = OPENSSL_zalloc(sizeof(*ret));
2889 ret->min_proto_version = 0;
2890 ret->max_proto_version = 0;
2891 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2892 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2893 /* We take the system default. */
2894 ret->session_timeout = meth->get_timeout();
2895 ret->references = 1;
2896 ret->lock = CRYPTO_THREAD_lock_new();
2897 if (ret->lock == NULL) {
2898 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2902 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2903 ret->verify_mode = SSL_VERIFY_NONE;
2904 if ((ret->cert = ssl_cert_new()) == NULL)
2907 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2908 if (ret->sessions == NULL)
2910 ret->cert_store = X509_STORE_new();
2911 if (ret->cert_store == NULL)
2913 #ifndef OPENSSL_NO_CT
2914 ret->ctlog_store = CTLOG_STORE_new();
2915 if (ret->ctlog_store == NULL)
2918 if (!ssl_create_cipher_list(ret->method,
2919 &ret->cipher_list, &ret->cipher_list_by_id,
2920 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2921 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2922 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2926 ret->param = X509_VERIFY_PARAM_new();
2927 if (ret->param == NULL)
2930 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2931 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2934 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2935 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2939 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2942 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2945 /* No compression for DTLS */
2946 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2947 ret->comp_methods = SSL_COMP_get_compression_methods();
2949 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2950 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2952 /* Setup RFC5077 ticket keys */
2953 if ((RAND_bytes(ret->ext.tick_key_name,
2954 sizeof(ret->ext.tick_key_name)) <= 0)
2955 || (RAND_bytes(ret->ext.tick_hmac_key,
2956 sizeof(ret->ext.tick_hmac_key)) <= 0)
2957 || (RAND_bytes(ret->ext.tick_aes_key,
2958 sizeof(ret->ext.tick_aes_key)) <= 0))
2959 ret->options |= SSL_OP_NO_TICKET;
2961 if (RAND_bytes(ret->ext.cookie_hmac_key,
2962 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2965 #ifndef OPENSSL_NO_SRP
2966 if (!SSL_CTX_SRP_CTX_init(ret))
2969 #ifndef OPENSSL_NO_ENGINE
2970 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2971 # define eng_strx(x) #x
2972 # define eng_str(x) eng_strx(x)
2973 /* Use specific client engine automatically... ignore errors */
2976 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2979 ENGINE_load_builtin_engines();
2980 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2982 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2988 * Default is to connect to non-RI servers. When RI is more widely
2989 * deployed might change this.
2991 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2993 * Disable compression by default to prevent CRIME. Applications can
2994 * re-enable compression by configuring
2995 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2996 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
2997 * middlebox compatibility by default. This may be disabled by default in
2998 * a later OpenSSL version.
3000 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3002 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3005 * We cannot usefully set a default max_early_data here (which gets
3006 * propagated in SSL_new(), for the following reason: setting the
3007 * SSL field causes tls_construct_stoc_early_data() to tell the
3008 * client that early data will be accepted when constructing a TLS 1.3
3009 * session ticket, and the client will accordingly send us early data
3010 * when using that ticket (if the client has early data to send).
3011 * However, in order for the early data to actually be consumed by
3012 * the application, the application must also have calls to
3013 * SSL_read_early_data(); otherwise we'll just skip past the early data
3014 * and ignore it. So, since the application must add calls to
3015 * SSL_read_early_data(), we also require them to add
3016 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3017 * eliminating the bandwidth-wasting early data in the case described
3020 ret->max_early_data = 0;
3024 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3030 int SSL_CTX_up_ref(SSL_CTX *ctx)
3034 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3037 REF_PRINT_COUNT("SSL_CTX", ctx);
3038 REF_ASSERT_ISNT(i < 2);
3039 return ((i > 1) ? 1 : 0);
3042 void SSL_CTX_free(SSL_CTX *a)
3049 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3050 REF_PRINT_COUNT("SSL_CTX", a);
3053 REF_ASSERT_ISNT(i < 0);
3055 X509_VERIFY_PARAM_free(a->param);
3056 dane_ctx_final(&a->dane);
3059 * Free internal session cache. However: the remove_cb() may reference
3060 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3061 * after the sessions were flushed.
3062 * As the ex_data handling routines might also touch the session cache,
3063 * the most secure solution seems to be: empty (flush) the cache, then
3064 * free ex_data, then finally free the cache.
3065 * (See ticket [openssl.org #212].)
3067 if (a->sessions != NULL)
3068 SSL_CTX_flush_sessions(a, 0);
3070 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3071 lh_SSL_SESSION_free(a->sessions);
3072 X509_STORE_free(a->cert_store);
3073 #ifndef OPENSSL_NO_CT
3074 CTLOG_STORE_free(a->ctlog_store);
3076 sk_SSL_CIPHER_free(a->cipher_list);
3077 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3078 ssl_cert_free(a->cert);
3079 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3080 sk_X509_pop_free(a->extra_certs, X509_free);
3081 a->comp_methods = NULL;
3082 #ifndef OPENSSL_NO_SRTP
3083 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3085 #ifndef OPENSSL_NO_SRP
3086 SSL_CTX_SRP_CTX_free(a);
3088 #ifndef OPENSSL_NO_ENGINE
3089 ENGINE_finish(a->client_cert_engine);
3092 #ifndef OPENSSL_NO_EC
3093 OPENSSL_free(a->ext.ecpointformats);
3094 OPENSSL_free(a->ext.supportedgroups);
3096 OPENSSL_free(a->ext.alpn);
3098 CRYPTO_THREAD_lock_free(a->lock);
3103 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3105 ctx->default_passwd_callback = cb;
3108 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3110 ctx->default_passwd_callback_userdata = u;
3113 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3115 return ctx->default_passwd_callback;
3118 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3120 return ctx->default_passwd_callback_userdata;
3123 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3125 s->default_passwd_callback = cb;
3128 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3130 s->default_passwd_callback_userdata = u;
3133 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3135 return s->default_passwd_callback;
3138 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3140 return s->default_passwd_callback_userdata;
3143 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3144 int (*cb) (X509_STORE_CTX *, void *),
3147 ctx->app_verify_callback = cb;
3148 ctx->app_verify_arg = arg;
3151 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3152 int (*cb) (int, X509_STORE_CTX *))
3154 ctx->verify_mode = mode;
3155 ctx->default_verify_callback = cb;
3158 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3160 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3163 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3165 ssl_cert_set_cert_cb(c->cert, cb, arg);
3168 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3170 ssl_cert_set_cert_cb(s->cert, cb, arg);
3173 void ssl_set_masks(SSL *s)
3176 uint32_t *pvalid = s->s3->tmp.valid_flags;
3177 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3178 unsigned long mask_k, mask_a;
3179 #ifndef OPENSSL_NO_EC
3180 int have_ecc_cert, ecdsa_ok;
3185 #ifndef OPENSSL_NO_DH
3186 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3191 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3192 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3193 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3194 #ifndef OPENSSL_NO_EC
3195 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3201 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3202 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3205 #ifndef OPENSSL_NO_GOST
3206 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3207 mask_k |= SSL_kGOST;
3208 mask_a |= SSL_aGOST12;
3210 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3211 mask_k |= SSL_kGOST;
3212 mask_a |= SSL_aGOST12;
3214 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3215 mask_k |= SSL_kGOST;
3216 mask_a |= SSL_aGOST01;
3227 * If we only have an RSA-PSS certificate allow RSA authentication
3228 * if TLS 1.2 and peer supports it.
3231 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3232 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3233 && TLS1_get_version(s) == TLS1_2_VERSION))
3240 mask_a |= SSL_aNULL;
3243 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3244 * depending on the key usage extension.
3246 #ifndef OPENSSL_NO_EC
3247 if (have_ecc_cert) {
3249 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3250 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3251 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3254 mask_a |= SSL_aECDSA;
3256 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3257 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3258 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3259 && TLS1_get_version(s) == TLS1_2_VERSION)
3260 mask_a |= SSL_aECDSA;
3262 /* Allow Ed448 for TLS 1.2 if peer supports it */
3263 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3264 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3265 && TLS1_get_version(s) == TLS1_2_VERSION)
3266 mask_a |= SSL_aECDSA;
3269 #ifndef OPENSSL_NO_EC
3270 mask_k |= SSL_kECDHE;
3273 #ifndef OPENSSL_NO_PSK
3276 if (mask_k & SSL_kRSA)
3277 mask_k |= SSL_kRSAPSK;
3278 if (mask_k & SSL_kDHE)
3279 mask_k |= SSL_kDHEPSK;
3280 if (mask_k & SSL_kECDHE)
3281 mask_k |= SSL_kECDHEPSK;
3284 s->s3->tmp.mask_k = mask_k;
3285 s->s3->tmp.mask_a = mask_a;
3288 #ifndef OPENSSL_NO_EC
3290 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3292 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3293 /* key usage, if present, must allow signing */
3294 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3295 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3296 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3300 return 1; /* all checks are ok */
3305 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3306 size_t *serverinfo_length)
3308 CERT_PKEY *cpk = s->s3->tmp.cert;
3309 *serverinfo_length = 0;
3311 if (cpk == NULL || cpk->serverinfo == NULL)
3314 *serverinfo = cpk->serverinfo;
3315 *serverinfo_length = cpk->serverinfo_length;
3319 void ssl_update_cache(SSL *s, int mode)
3324 * If the session_id_length is 0, we are not supposed to cache it, and it
3325 * would be rather hard to do anyway :-)
3327 if (s->session->session_id_length == 0)
3330 i = s->session_ctx->session_cache_mode;
3332 && (!s->hit || SSL_IS_TLS13(s))
3333 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) != 0
3334 || SSL_CTX_add_session(s->session_ctx, s->session))
3335 && s->session_ctx->new_session_cb != NULL) {
3336 SSL_SESSION_up_ref(s->session);
3337 if (!s->session_ctx->new_session_cb(s, s->session))
3338 SSL_SESSION_free(s->session);
3341 /* auto flush every 255 connections */
3342 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3344 if (mode & SSL_SESS_CACHE_CLIENT)
3345 stat = &s->session_ctx->stats.sess_connect_good;
3347 stat = &s->session_ctx->stats.sess_accept_good;
3348 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3349 && (val & 0xff) == 0xff)
3350 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3354 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3359 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3364 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3368 if (s->method != meth) {
3369 const SSL_METHOD *sm = s->method;
3370 int (*hf) (SSL *) = s->handshake_func;
3372 if (sm->version == meth->version)
3377 ret = s->method->ssl_new(s);
3380 if (hf == sm->ssl_connect)
3381 s->handshake_func = meth->ssl_connect;
3382 else if (hf == sm->ssl_accept)
3383 s->handshake_func = meth->ssl_accept;
3388 int SSL_get_error(const SSL *s, int i)
3395 return SSL_ERROR_NONE;
3398 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3399 * where we do encode the error
3401 if ((l = ERR_peek_error()) != 0) {
3402 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3403 return SSL_ERROR_SYSCALL;
3405 return SSL_ERROR_SSL;
3408 if (SSL_want_read(s)) {
3409 bio = SSL_get_rbio(s);
3410 if (BIO_should_read(bio))
3411 return SSL_ERROR_WANT_READ;
3412 else if (BIO_should_write(bio))
3414 * This one doesn't make too much sense ... We never try to write
3415 * to the rbio, and an application program where rbio and wbio
3416 * are separate couldn't even know what it should wait for.
3417 * However if we ever set s->rwstate incorrectly (so that we have
3418 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3419 * wbio *are* the same, this test works around that bug; so it
3420 * might be safer to keep it.
3422 return SSL_ERROR_WANT_WRITE;
3423 else if (BIO_should_io_special(bio)) {
3424 reason = BIO_get_retry_reason(bio);
3425 if (reason == BIO_RR_CONNECT)
3426 return SSL_ERROR_WANT_CONNECT;
3427 else if (reason == BIO_RR_ACCEPT)
3428 return SSL_ERROR_WANT_ACCEPT;
3430 return SSL_ERROR_SYSCALL; /* unknown */
3434 if (SSL_want_write(s)) {
3435 /* Access wbio directly - in order to use the buffered bio if present */
3437 if (BIO_should_write(bio))
3438 return SSL_ERROR_WANT_WRITE;
3439 else if (BIO_should_read(bio))
3441 * See above (SSL_want_read(s) with BIO_should_write(bio))
3443 return SSL_ERROR_WANT_READ;
3444 else if (BIO_should_io_special(bio)) {
3445 reason = BIO_get_retry_reason(bio);
3446 if (reason == BIO_RR_CONNECT)
3447 return SSL_ERROR_WANT_CONNECT;
3448 else if (reason == BIO_RR_ACCEPT)
3449 return SSL_ERROR_WANT_ACCEPT;
3451 return SSL_ERROR_SYSCALL;
3454 if (SSL_want_x509_lookup(s))
3455 return SSL_ERROR_WANT_X509_LOOKUP;
3456 if (SSL_want_async(s))
3457 return SSL_ERROR_WANT_ASYNC;
3458 if (SSL_want_async_job(s))
3459 return SSL_ERROR_WANT_ASYNC_JOB;
3460 if (SSL_want_client_hello_cb(s))
3461 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3463 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3464 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3465 return SSL_ERROR_ZERO_RETURN;
3467 return SSL_ERROR_SYSCALL;
3470 static int ssl_do_handshake_intern(void *vargs)
3472 struct ssl_async_args *args;
3475 args = (struct ssl_async_args *)vargs;
3478 return s->handshake_func(s);
3481 int SSL_do_handshake(SSL *s)
3485 if (s->handshake_func == NULL) {
3486 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3490 ossl_statem_check_finish_init(s, -1);
3492 s->method->ssl_renegotiate_check(s, 0);
3494 if (SSL_is_server(s)) {
3495 /* clear SNI settings at server-side */
3496 OPENSSL_free(s->ext.hostname);
3497 s->ext.hostname = NULL;
3500 if (SSL_in_init(s) || SSL_in_before(s)) {
3501 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3502 struct ssl_async_args args;
3506 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3508 ret = s->handshake_func(s);
3514 void SSL_set_accept_state(SSL *s)
3518 ossl_statem_clear(s);
3519 s->handshake_func = s->method->ssl_accept;
3523 void SSL_set_connect_state(SSL *s)
3527 ossl_statem_clear(s);
3528 s->handshake_func = s->method->ssl_connect;
3532 int ssl_undefined_function(SSL *s)
3534 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3538 int ssl_undefined_void_function(void)
3540 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3541 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3545 int ssl_undefined_const_function(const SSL *s)
3550 const SSL_METHOD *ssl_bad_method(int ver)
3552 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3556 const char *ssl_protocol_to_string(int version)
3560 case TLS1_3_VERSION:
3563 case TLS1_2_VERSION:
3566 case TLS1_1_VERSION:
3581 case DTLS1_2_VERSION:
3589 const char *SSL_get_version(const SSL *s)
3591 return ssl_protocol_to_string(s->version);
3594 SSL *SSL_dup(SSL *s)
3596 STACK_OF(X509_NAME) *sk;
3601 /* If we're not quiescent, just up_ref! */
3602 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3603 CRYPTO_UP_REF(&s->references, &i, s->lock);
3608 * Otherwise, copy configuration state, and session if set.
3610 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3613 if (s->session != NULL) {
3615 * Arranges to share the same session via up_ref. This "copies"
3616 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3618 if (!SSL_copy_session_id(ret, s))
3622 * No session has been established yet, so we have to expect that
3623 * s->cert or ret->cert will be changed later -- they should not both
3624 * point to the same object, and thus we can't use
3625 * SSL_copy_session_id.
3627 if (!SSL_set_ssl_method(ret, s->method))
3630 if (s->cert != NULL) {
3631 ssl_cert_free(ret->cert);
3632 ret->cert = ssl_cert_dup(s->cert);
3633 if (ret->cert == NULL)
3637 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3638 (int)s->sid_ctx_length))
3642 if (!ssl_dane_dup(ret, s))
3644 ret->version = s->version;
3645 ret->options = s->options;
3646 ret->mode = s->mode;
3647 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3648 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3649 ret->msg_callback = s->msg_callback;
3650 ret->msg_callback_arg = s->msg_callback_arg;
3651 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3652 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3653 ret->generate_session_id = s->generate_session_id;
3655 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3657 /* copy app data, a little dangerous perhaps */
3658 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3661 /* setup rbio, and wbio */
3662 if (s->rbio != NULL) {
3663 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3666 if (s->wbio != NULL) {
3667 if (s->wbio != s->rbio) {
3668 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3671 BIO_up_ref(ret->rbio);
3672 ret->wbio = ret->rbio;
3676 ret->server = s->server;
3677 if (s->handshake_func) {
3679 SSL_set_accept_state(ret);
3681 SSL_set_connect_state(ret);
3683 ret->shutdown = s->shutdown;
3686 ret->default_passwd_callback = s->default_passwd_callback;
3687 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3689 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3691 /* dup the cipher_list and cipher_list_by_id stacks */
3692 if (s->cipher_list != NULL) {
3693 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3696 if (s->cipher_list_by_id != NULL)
3697 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3701 /* Dup the client_CA list */
3702 if (s->ca_names != NULL) {
3703 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3706 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3707 xn = sk_X509_NAME_value(sk, i);
3708 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3721 void ssl_clear_cipher_ctx(SSL *s)
3723 if (s->enc_read_ctx != NULL) {
3724 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3725 s->enc_read_ctx = NULL;
3727 if (s->enc_write_ctx != NULL) {
3728 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3729 s->enc_write_ctx = NULL;
3731 #ifndef OPENSSL_NO_COMP
3732 COMP_CTX_free(s->expand);
3734 COMP_CTX_free(s->compress);
3739 X509 *SSL_get_certificate(const SSL *s)
3741 if (s->cert != NULL)
3742 return s->cert->key->x509;
3747 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3749 if (s->cert != NULL)
3750 return s->cert->key->privatekey;
3755 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3757 if (ctx->cert != NULL)
3758 return ctx->cert->key->x509;
3763 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3765 if (ctx->cert != NULL)
3766 return ctx->cert->key->privatekey;
3771 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3773 if ((s->session != NULL) && (s->session->cipher != NULL))
3774 return s->session->cipher;
3778 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3780 return s->s3->tmp.new_cipher;
3783 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3785 #ifndef OPENSSL_NO_COMP
3786 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3792 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3794 #ifndef OPENSSL_NO_COMP
3795 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3801 int ssl_init_wbio_buffer(SSL *s)
3805 if (s->bbio != NULL) {
3806 /* Already buffered. */
3810 bbio = BIO_new(BIO_f_buffer());
3811 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3813 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3817 s->wbio = BIO_push(bbio, s->wbio);
3822 int ssl_free_wbio_buffer(SSL *s)
3824 /* callers ensure s is never null */
3825 if (s->bbio == NULL)
3828 s->wbio = BIO_pop(s->wbio);
3829 if (!ossl_assert(s->wbio != NULL))
3837 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3839 ctx->quiet_shutdown = mode;
3842 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3844 return ctx->quiet_shutdown;
3847 void SSL_set_quiet_shutdown(SSL *s, int mode)
3849 s->quiet_shutdown = mode;
3852 int SSL_get_quiet_shutdown(const SSL *s)
3854 return s->quiet_shutdown;
3857 void SSL_set_shutdown(SSL *s, int mode)
3862 int SSL_get_shutdown(const SSL *s)
3867 int SSL_version(const SSL *s)
3872 int SSL_client_version(const SSL *s)
3874 return s->client_version;
3877 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3882 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3885 if (ssl->ctx == ctx)
3888 ctx = ssl->session_ctx;
3889 new_cert = ssl_cert_dup(ctx->cert);
3890 if (new_cert == NULL) {
3894 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3895 ssl_cert_free(new_cert);
3899 ssl_cert_free(ssl->cert);
3900 ssl->cert = new_cert;
3903 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3904 * so setter APIs must prevent invalid lengths from entering the system.
3906 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3910 * If the session ID context matches that of the parent SSL_CTX,
3911 * inherit it from the new SSL_CTX as well. If however the context does
3912 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3913 * leave it unchanged.
3915 if ((ssl->ctx != NULL) &&
3916 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3917 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3918 ssl->sid_ctx_length = ctx->sid_ctx_length;
3919 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3922 SSL_CTX_up_ref(ctx);
3923 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3929 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3931 return X509_STORE_set_default_paths(ctx->cert_store);
3934 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3936 X509_LOOKUP *lookup;
3938 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3941 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3943 /* Clear any errors if the default directory does not exist */
3949 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3951 X509_LOOKUP *lookup;
3953 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3957 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3959 /* Clear any errors if the default file does not exist */
3965 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3968 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
3971 void SSL_set_info_callback(SSL *ssl,
3972 void (*cb) (const SSL *ssl, int type, int val))
3974 ssl->info_callback = cb;
3978 * One compiler (Diab DCC) doesn't like argument names in returned function
3981 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3984 return ssl->info_callback;
3987 void SSL_set_verify_result(SSL *ssl, long arg)
3989 ssl->verify_result = arg;
3992 long SSL_get_verify_result(const SSL *ssl)
3994 return ssl->verify_result;
3997 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4000 return sizeof(ssl->s3->client_random);
4001 if (outlen > sizeof(ssl->s3->client_random))
4002 outlen = sizeof(ssl->s3->client_random);
4003 memcpy(out, ssl->s3->client_random, outlen);
4007 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4010 return sizeof(ssl->s3->server_random);
4011 if (outlen > sizeof(ssl->s3->server_random))
4012 outlen = sizeof(ssl->s3->server_random);
4013 memcpy(out, ssl->s3->server_random, outlen);
4017 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4018 unsigned char *out, size_t outlen)
4021 return session->master_key_length;
4022 if (outlen > session->master_key_length)
4023 outlen = session->master_key_length;
4024 memcpy(out, session->master_key, outlen);
4028 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4031 if (len > sizeof(sess->master_key))
4034 memcpy(sess->master_key, in, len);
4035 sess->master_key_length = len;
4040 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4042 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4045 void *SSL_get_ex_data(const SSL *s, int idx)
4047 return CRYPTO_get_ex_data(&s->ex_data, idx);
4050 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4052 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4055 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4057 return CRYPTO_get_ex_data(&s->ex_data, idx);
4060 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4062 return ctx->cert_store;
4065 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4067 X509_STORE_free(ctx->cert_store);
4068 ctx->cert_store = store;
4071 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4074 X509_STORE_up_ref(store);
4075 SSL_CTX_set_cert_store(ctx, store);
4078 int SSL_want(const SSL *s)
4084 * \brief Set the callback for generating temporary DH keys.
4085 * \param ctx the SSL context.
4086 * \param dh the callback
4089 #ifndef OPENSSL_NO_DH
4090 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4091 DH *(*dh) (SSL *ssl, int is_export,
4094 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4097 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4100 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4104 #ifndef OPENSSL_NO_PSK
4105 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4107 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4108 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4111 OPENSSL_free(ctx->cert->psk_identity_hint);
4112 if (identity_hint != NULL) {
4113 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4114 if (ctx->cert->psk_identity_hint == NULL)
4117 ctx->cert->psk_identity_hint = NULL;
4121 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4126 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4127 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4130 OPENSSL_free(s->cert->psk_identity_hint);
4131 if (identity_hint != NULL) {
4132 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4133 if (s->cert->psk_identity_hint == NULL)
4136 s->cert->psk_identity_hint = NULL;
4140 const char *SSL_get_psk_identity_hint(const SSL *s)
4142 if (s == NULL || s->session == NULL)
4144 return s->session->psk_identity_hint;
4147 const char *SSL_get_psk_identity(const SSL *s)
4149 if (s == NULL || s->session == NULL)
4151 return s->session->psk_identity;
4154 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4156 s->psk_client_callback = cb;
4159 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4161 ctx->psk_client_callback = cb;
4164 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4166 s->psk_server_callback = cb;
4169 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4171 ctx->psk_server_callback = cb;
4175 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4177 s->psk_find_session_cb = cb;
4180 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4181 SSL_psk_find_session_cb_func cb)
4183 ctx->psk_find_session_cb = cb;
4186 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4188 s->psk_use_session_cb = cb;
4191 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4192 SSL_psk_use_session_cb_func cb)
4194 ctx->psk_use_session_cb = cb;
4197 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4198 void (*cb) (int write_p, int version,
4199 int content_type, const void *buf,
4200 size_t len, SSL *ssl, void *arg))
4202 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4205 void SSL_set_msg_callback(SSL *ssl,
4206 void (*cb) (int write_p, int version,
4207 int content_type, const void *buf,
4208 size_t len, SSL *ssl, void *arg))
4210 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4213 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4214 int (*cb) (SSL *ssl,
4218 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4219 (void (*)(void))cb);
4222 void SSL_set_not_resumable_session_callback(SSL *ssl,
4223 int (*cb) (SSL *ssl,
4224 int is_forward_secure))
4226 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4227 (void (*)(void))cb);
4230 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4231 size_t (*cb) (SSL *ssl, int type,
4232 size_t len, void *arg))
4234 ctx->record_padding_cb = cb;
4237 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4239 ctx->record_padding_arg = arg;
4242 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4244 return ctx->record_padding_arg;
4247 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4249 /* block size of 0 or 1 is basically no padding */
4250 if (block_size == 1)
4251 ctx->block_padding = 0;
4252 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4253 ctx->block_padding = block_size;
4259 void SSL_set_record_padding_callback(SSL *ssl,
4260 size_t (*cb) (SSL *ssl, int type,
4261 size_t len, void *arg))
4263 ssl->record_padding_cb = cb;
4266 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4268 ssl->record_padding_arg = arg;
4271 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4273 return ssl->record_padding_arg;
4276 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4278 /* block size of 0 or 1 is basically no padding */
4279 if (block_size == 1)
4280 ssl->block_padding = 0;
4281 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4282 ssl->block_padding = block_size;
4289 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4290 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4291 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4292 * Returns the newly allocated ctx;
4295 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4297 ssl_clear_hash_ctx(hash);
4298 *hash = EVP_MD_CTX_new();
4299 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4300 EVP_MD_CTX_free(*hash);
4307 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4310 EVP_MD_CTX_free(*hash);
4314 /* Retrieve handshake hashes */
4315 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4318 EVP_MD_CTX *ctx = NULL;
4319 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4320 int hashleni = EVP_MD_CTX_size(hdgst);
4323 if (hashleni < 0 || (size_t)hashleni > outlen) {
4324 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4325 ERR_R_INTERNAL_ERROR);
4329 ctx = EVP_MD_CTX_new();
4333 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4334 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4335 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4336 ERR_R_INTERNAL_ERROR);
4340 *hashlen = hashleni;
4344 EVP_MD_CTX_free(ctx);
4348 int SSL_session_reused(SSL *s)
4353 int SSL_is_server(const SSL *s)
4358 #if OPENSSL_API_COMPAT < 0x10100000L
4359 void SSL_set_debug(SSL *s, int debug)
4361 /* Old function was do-nothing anyway... */
4367 void SSL_set_security_level(SSL *s, int level)
4369 s->cert->sec_level = level;
4372 int SSL_get_security_level(const SSL *s)
4374 return s->cert->sec_level;
4377 void SSL_set_security_callback(SSL *s,
4378 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4379 int op, int bits, int nid,
4380 void *other, void *ex))
4382 s->cert->sec_cb = cb;
4385 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4386 const SSL_CTX *ctx, int op,
4387 int bits, int nid, void *other,
4389 return s->cert->sec_cb;
4392 void SSL_set0_security_ex_data(SSL *s, void *ex)
4394 s->cert->sec_ex = ex;
4397 void *SSL_get0_security_ex_data(const SSL *s)
4399 return s->cert->sec_ex;
4402 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4404 ctx->cert->sec_level = level;
4407 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4409 return ctx->cert->sec_level;
4412 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4413 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4414 int op, int bits, int nid,
4415 void *other, void *ex))
4417 ctx->cert->sec_cb = cb;
4420 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4426 return ctx->cert->sec_cb;
4429 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4431 ctx->cert->sec_ex = ex;
4434 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4436 return ctx->cert->sec_ex;
4440 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4441 * can return unsigned long, instead of the generic long return value from the
4442 * control interface.
4444 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4446 return ctx->options;
4449 unsigned long SSL_get_options(const SSL *s)
4454 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4456 return ctx->options |= op;
4459 unsigned long SSL_set_options(SSL *s, unsigned long op)
4461 return s->options |= op;
4464 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4466 return ctx->options &= ~op;
4469 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4471 return s->options &= ~op;
4474 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4476 return s->verified_chain;
4479 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4481 #ifndef OPENSSL_NO_CT
4484 * Moves SCTs from the |src| stack to the |dst| stack.
4485 * The source of each SCT will be set to |origin|.
4486 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4488 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4490 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4491 sct_source_t origin)
4497 *dst = sk_SCT_new_null();
4499 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4504 while ((sct = sk_SCT_pop(src)) != NULL) {
4505 if (SCT_set_source(sct, origin) != 1)
4508 if (sk_SCT_push(*dst, sct) <= 0)
4516 sk_SCT_push(src, sct); /* Put the SCT back */
4521 * Look for data collected during ServerHello and parse if found.
4522 * Returns the number of SCTs extracted.
4524 static int ct_extract_tls_extension_scts(SSL *s)
4526 int scts_extracted = 0;
4528 if (s->ext.scts != NULL) {
4529 const unsigned char *p = s->ext.scts;
4530 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4532 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4534 SCT_LIST_free(scts);
4537 return scts_extracted;
4541 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4542 * contains an SCT X509 extension. They will be stored in |s->scts|.
4544 * - The number of SCTs extracted, assuming an OCSP response exists.
4545 * - 0 if no OCSP response exists or it contains no SCTs.
4546 * - A negative integer if an error occurs.
4548 static int ct_extract_ocsp_response_scts(SSL *s)
4550 # ifndef OPENSSL_NO_OCSP
4551 int scts_extracted = 0;
4552 const unsigned char *p;
4553 OCSP_BASICRESP *br = NULL;
4554 OCSP_RESPONSE *rsp = NULL;
4555 STACK_OF(SCT) *scts = NULL;
4558 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4561 p = s->ext.ocsp.resp;
4562 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4566 br = OCSP_response_get1_basic(rsp);
4570 for (i = 0; i < OCSP_resp_count(br); ++i) {
4571 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4577 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4579 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4580 if (scts_extracted < 0)
4584 SCT_LIST_free(scts);
4585 OCSP_BASICRESP_free(br);
4586 OCSP_RESPONSE_free(rsp);
4587 return scts_extracted;
4589 /* Behave as if no OCSP response exists */
4595 * Attempts to extract SCTs from the peer certificate.
4596 * Return the number of SCTs extracted, or a negative integer if an error
4599 static int ct_extract_x509v3_extension_scts(SSL *s)
4601 int scts_extracted = 0;
4602 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4605 STACK_OF(SCT) *scts =
4606 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4609 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4611 SCT_LIST_free(scts);
4614 return scts_extracted;
4618 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4619 * response (if it exists) and X509v3 extensions in the certificate.
4620 * Returns NULL if an error occurs.
4622 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4624 if (!s->scts_parsed) {
4625 if (ct_extract_tls_extension_scts(s) < 0 ||
4626 ct_extract_ocsp_response_scts(s) < 0 ||
4627 ct_extract_x509v3_extension_scts(s) < 0)
4637 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4638 const STACK_OF(SCT) *scts, void *unused_arg)
4643 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4644 const STACK_OF(SCT) *scts, void *unused_arg)
4646 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4649 for (i = 0; i < count; ++i) {
4650 SCT *sct = sk_SCT_value(scts, i);
4651 int status = SCT_get_validation_status(sct);
4653 if (status == SCT_VALIDATION_STATUS_VALID)
4656 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4660 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4664 * Since code exists that uses the custom extension handler for CT, look
4665 * for this and throw an error if they have already registered to use CT.
4667 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4668 TLSEXT_TYPE_signed_certificate_timestamp))
4670 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4671 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4675 if (callback != NULL) {
4677 * If we are validating CT, then we MUST accept SCTs served via OCSP
4679 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4683 s->ct_validation_callback = callback;
4684 s->ct_validation_callback_arg = arg;
4689 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4690 ssl_ct_validation_cb callback, void *arg)
4693 * Since code exists that uses the custom extension handler for CT, look for
4694 * this and throw an error if they have already registered to use CT.
4696 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4697 TLSEXT_TYPE_signed_certificate_timestamp))
4699 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4700 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4704 ctx->ct_validation_callback = callback;
4705 ctx->ct_validation_callback_arg = arg;
4709 int SSL_ct_is_enabled(const SSL *s)
4711 return s->ct_validation_callback != NULL;
4714 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4716 return ctx->ct_validation_callback != NULL;
4719 int ssl_validate_ct(SSL *s)
4722 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4724 SSL_DANE *dane = &s->dane;
4725 CT_POLICY_EVAL_CTX *ctx = NULL;
4726 const STACK_OF(SCT) *scts;
4729 * If no callback is set, the peer is anonymous, or its chain is invalid,
4730 * skip SCT validation - just return success. Applications that continue
4731 * handshakes without certificates, with unverified chains, or pinned leaf
4732 * certificates are outside the scope of the WebPKI and CT.
4734 * The above exclusions notwithstanding the vast majority of peers will
4735 * have rather ordinary certificate chains validated by typical
4736 * applications that perform certificate verification and therefore will
4737 * process SCTs when enabled.
4739 if (s->ct_validation_callback == NULL || cert == NULL ||
4740 s->verify_result != X509_V_OK ||
4741 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4745 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4746 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4748 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4749 switch (dane->mtlsa->usage) {
4750 case DANETLS_USAGE_DANE_TA:
4751 case DANETLS_USAGE_DANE_EE:
4756 ctx = CT_POLICY_EVAL_CTX_new();
4758 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4759 ERR_R_MALLOC_FAILURE);
4763 issuer = sk_X509_value(s->verified_chain, 1);
4764 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4765 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4766 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4767 CT_POLICY_EVAL_CTX_set_time(
4768 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4770 scts = SSL_get0_peer_scts(s);
4773 * This function returns success (> 0) only when all the SCTs are valid, 0
4774 * when some are invalid, and < 0 on various internal errors (out of
4775 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4776 * reason to abort the handshake, that decision is up to the callback.
4777 * Therefore, we error out only in the unexpected case that the return
4778 * value is negative.
4780 * XXX: One might well argue that the return value of this function is an
4781 * unfortunate design choice. Its job is only to determine the validation
4782 * status of each of the provided SCTs. So long as it correctly separates
4783 * the wheat from the chaff it should return success. Failure in this case
4784 * ought to correspond to an inability to carry out its duties.
4786 if (SCT_LIST_validate(scts, ctx) < 0) {
4787 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4788 SSL_R_SCT_VERIFICATION_FAILED);
4792 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4794 ret = 0; /* This function returns 0 on failure */
4796 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4797 SSL_R_CALLBACK_FAILED);
4800 CT_POLICY_EVAL_CTX_free(ctx);
4802 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4803 * failure return code here. Also the application may wish the complete
4804 * the handshake, and then disconnect cleanly at a higher layer, after
4805 * checking the verification status of the completed connection.
4807 * We therefore force a certificate verification failure which will be
4808 * visible via SSL_get_verify_result() and cached as part of any resumed
4811 * Note: the permissive callback is for information gathering only, always
4812 * returns success, and does not affect verification status. Only the
4813 * strict callback or a custom application-specified callback can trigger
4814 * connection failure or record a verification error.
4817 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4821 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4823 switch (validation_mode) {
4825 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4827 case SSL_CT_VALIDATION_PERMISSIVE:
4828 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4829 case SSL_CT_VALIDATION_STRICT:
4830 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4834 int SSL_enable_ct(SSL *s, int validation_mode)
4836 switch (validation_mode) {
4838 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4840 case SSL_CT_VALIDATION_PERMISSIVE:
4841 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4842 case SSL_CT_VALIDATION_STRICT:
4843 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4847 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4849 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4852 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4854 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4857 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4859 CTLOG_STORE_free(ctx->ctlog_store);
4860 ctx->ctlog_store = logs;
4863 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4865 return ctx->ctlog_store;
4868 #endif /* OPENSSL_NO_CT */
4870 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4873 c->client_hello_cb = cb;
4874 c->client_hello_cb_arg = arg;
4877 int SSL_client_hello_isv2(SSL *s)
4879 if (s->clienthello == NULL)
4881 return s->clienthello->isv2;
4884 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4886 if (s->clienthello == NULL)
4888 return s->clienthello->legacy_version;
4891 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
4893 if (s->clienthello == NULL)
4896 *out = s->clienthello->random;
4897 return SSL3_RANDOM_SIZE;
4900 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
4902 if (s->clienthello == NULL)
4905 *out = s->clienthello->session_id;
4906 return s->clienthello->session_id_len;
4909 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
4911 if (s->clienthello == NULL)
4914 *out = PACKET_data(&s->clienthello->ciphersuites);
4915 return PACKET_remaining(&s->clienthello->ciphersuites);
4918 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
4920 if (s->clienthello == NULL)
4923 *out = s->clienthello->compressions;
4924 return s->clienthello->compressions_len;
4927 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
4933 if (s->clienthello == NULL || out == NULL || outlen == NULL)
4935 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
4936 ext = s->clienthello->pre_proc_exts + i;
4940 present = OPENSSL_malloc(sizeof(*present) * num);
4941 if (present == NULL)
4943 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
4944 ext = s->clienthello->pre_proc_exts + i;
4946 if (ext->received_order >= num)
4948 present[ext->received_order] = ext->type;
4955 OPENSSL_free(present);
4959 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4965 if (s->clienthello == NULL)
4967 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4968 r = s->clienthello->pre_proc_exts + i;
4969 if (r->present && r->type == type) {
4971 *out = PACKET_data(&r->data);
4973 *outlen = PACKET_remaining(&r->data);
4980 int SSL_free_buffers(SSL *ssl)
4982 RECORD_LAYER *rl = &ssl->rlayer;
4984 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
4987 RECORD_LAYER_release(rl);
4991 int SSL_alloc_buffers(SSL *ssl)
4993 return ssl3_setup_buffers(ssl);
4996 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4998 ctx->keylog_callback = cb;
5001 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5003 return ctx->keylog_callback;
5006 static int nss_keylog_int(const char *prefix,
5008 const uint8_t *parameter_1,
5009 size_t parameter_1_len,
5010 const uint8_t *parameter_2,
5011 size_t parameter_2_len)
5014 char *cursor = NULL;
5019 if (ssl->ctx->keylog_callback == NULL) return 1;
5022 * Our output buffer will contain the following strings, rendered with
5023 * space characters in between, terminated by a NULL character: first the
5024 * prefix, then the first parameter, then the second parameter. The
5025 * meaning of each parameter depends on the specific key material being
5026 * logged. Note that the first and second parameters are encoded in
5027 * hexadecimal, so we need a buffer that is twice their lengths.
5029 prefix_len = strlen(prefix);
5030 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
5031 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5032 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5033 ERR_R_MALLOC_FAILURE);
5037 strcpy(cursor, prefix);
5038 cursor += prefix_len;
5041 for (i = 0; i < parameter_1_len; i++) {
5042 sprintf(cursor, "%02x", parameter_1[i]);
5047 for (i = 0; i < parameter_2_len; i++) {
5048 sprintf(cursor, "%02x", parameter_2[i]);
5053 ssl->ctx->keylog_callback(ssl, (const char *)out);
5059 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5060 const uint8_t *encrypted_premaster,
5061 size_t encrypted_premaster_len,
5062 const uint8_t *premaster,
5063 size_t premaster_len)
5065 if (encrypted_premaster_len < 8) {
5066 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5067 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5071 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5072 return nss_keylog_int("RSA",
5074 encrypted_premaster,
5080 int ssl_log_secret(SSL *ssl,
5082 const uint8_t *secret,
5085 return nss_keylog_int(label,
5087 ssl->s3->client_random,
5093 #define SSLV2_CIPHER_LEN 3
5095 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5099 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5101 if (PACKET_remaining(cipher_suites) == 0) {
5102 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5103 SSL_R_NO_CIPHERS_SPECIFIED);
5107 if (PACKET_remaining(cipher_suites) % n != 0) {
5108 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5109 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5113 OPENSSL_free(s->s3->tmp.ciphers_raw);
5114 s->s3->tmp.ciphers_raw = NULL;
5115 s->s3->tmp.ciphers_rawlen = 0;
5118 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5119 PACKET sslv2ciphers = *cipher_suites;
5120 unsigned int leadbyte;
5124 * We store the raw ciphers list in SSLv3+ format so we need to do some
5125 * preprocessing to convert the list first. If there are any SSLv2 only
5126 * ciphersuites with a non-zero leading byte then we are going to
5127 * slightly over allocate because we won't store those. But that isn't a
5130 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5131 s->s3->tmp.ciphers_raw = raw;
5133 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5134 ERR_R_MALLOC_FAILURE);
5137 for (s->s3->tmp.ciphers_rawlen = 0;
5138 PACKET_remaining(&sslv2ciphers) > 0;
5139 raw += TLS_CIPHER_LEN) {
5140 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5142 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5145 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5146 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5148 OPENSSL_free(s->s3->tmp.ciphers_raw);
5149 s->s3->tmp.ciphers_raw = NULL;
5150 s->s3->tmp.ciphers_rawlen = 0;
5154 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5156 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5157 &s->s3->tmp.ciphers_rawlen)) {
5158 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5159 ERR_R_INTERNAL_ERROR);
5165 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5166 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5167 STACK_OF(SSL_CIPHER) **scsvs)
5171 if (!PACKET_buf_init(&pkt, bytes, len))
5173 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5176 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5177 STACK_OF(SSL_CIPHER) **skp,
5178 STACK_OF(SSL_CIPHER) **scsvs_out,
5179 int sslv2format, int fatal)
5181 const SSL_CIPHER *c;
5182 STACK_OF(SSL_CIPHER) *sk = NULL;
5183 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5185 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5186 unsigned char cipher[SSLV2_CIPHER_LEN];
5188 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5190 if (PACKET_remaining(cipher_suites) == 0) {
5192 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5193 SSL_R_NO_CIPHERS_SPECIFIED);
5195 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5199 if (PACKET_remaining(cipher_suites) % n != 0) {
5201 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5202 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5204 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5205 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5209 sk = sk_SSL_CIPHER_new_null();
5210 scsvs = sk_SSL_CIPHER_new_null();
5211 if (sk == NULL || scsvs == NULL) {
5213 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5214 ERR_R_MALLOC_FAILURE);
5216 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5220 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5222 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5223 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5224 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5226 if (sslv2format && cipher[0] != '\0')
5229 /* For SSLv2-compat, ignore leading 0-byte. */
5230 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5232 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5233 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5235 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5236 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5238 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5243 if (PACKET_remaining(cipher_suites) > 0) {
5245 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5248 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5255 sk_SSL_CIPHER_free(sk);
5256 if (scsvs_out != NULL)
5259 sk_SSL_CIPHER_free(scsvs);
5262 sk_SSL_CIPHER_free(sk);
5263 sk_SSL_CIPHER_free(scsvs);
5267 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5269 ctx->max_early_data = max_early_data;
5274 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5276 return ctx->max_early_data;
5279 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5281 s->max_early_data = max_early_data;
5286 uint32_t SSL_get_max_early_data(const SSL *s)
5288 return s->max_early_data;
5291 int ssl_randbytes(SSL *s, unsigned char *rnd, size_t size)
5293 if (s->drbg != NULL) {
5295 * Currently, it's the duty of the caller to serialize the generate
5296 * requests to the DRBG. So formally we have to check whether
5297 * s->drbg->lock != NULL and take the lock if this is the case.
5298 * However, this DRBG is unique to a given SSL object, and we already
5299 * require that SSL objects are only accessed by a single thread at
5300 * a given time. Also, SSL DRBGs have no child DRBG, so there is
5301 * no risk that this DRBG is accessed by a child DRBG in parallel
5302 * for reseeding. As such, we can rely on the application's
5303 * serialization of SSL accesses for the needed concurrency protection
5306 return RAND_DRBG_bytes(s->drbg, rnd, size);
5310 return RAND_bytes(rnd, size);
5313 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5315 /* Return any active Max Fragment Len extension */
5316 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5317 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5319 /* return current SSL connection setting */
5320 return ssl->max_send_fragment;
5323 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5325 /* Return a value regarding an active Max Fragment Len extension */
5326 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5327 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5328 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5330 /* else limit |split_send_fragment| to current |max_send_fragment| */
5331 if (ssl->split_send_fragment > ssl->max_send_fragment)
5332 return ssl->max_send_fragment;
5334 /* return current SSL connection setting */
5335 return ssl->split_send_fragment;
5338 int SSL_stateless(SSL *s)
5342 /* Ensure there is no state left over from a previous invocation */
5348 s->s3->flags |= TLS1_FLAGS_STATELESS;
5349 ret = SSL_accept(s);
5350 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5352 if (ret > 0 && s->ext.cookieok)
5358 void SSL_force_post_handshake_auth(SSL *ssl)
5360 ssl->pha_forced = 1;
5363 int SSL_verify_client_post_handshake(SSL *ssl)
5365 if (!SSL_IS_TLS13(ssl)) {
5366 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5370 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5374 if (!SSL_is_init_finished(ssl)) {
5375 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5379 switch (ssl->post_handshake_auth) {
5381 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5384 case SSL_PHA_EXT_SENT:
5385 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5387 case SSL_PHA_EXT_RECEIVED:
5389 case SSL_PHA_REQUEST_PENDING:
5390 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5392 case SSL_PHA_REQUESTED:
5393 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5397 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5399 /* checks verify_mode and algorithm_auth */
5400 if (!send_certificate_request(ssl)) {
5401 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5402 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5406 ossl_statem_set_in_init(ssl, 1);