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 /* Reset DANE verification result state */
620 X509_free(s->dane.mcert);
621 s->dane.mcert = NULL;
622 s->dane.mtlsa = NULL;
624 /* Clear the verification result peername */
625 X509_VERIFY_PARAM_move_peername(s->param, NULL);
628 * Check to see if we were changed into a different method, if so, revert
631 if (s->method != s->ctx->method) {
632 s->method->ssl_free(s);
633 s->method = s->ctx->method;
634 if (!s->method->ssl_new(s))
637 if (!s->method->ssl_clear(s))
641 RECORD_LAYER_clear(&s->rlayer);
646 /** Used to change an SSL_CTXs default SSL method type */
647 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
649 STACK_OF(SSL_CIPHER) *sk;
653 sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
654 &(ctx->cipher_list_by_id),
655 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
656 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
657 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
663 SSL *SSL_new(SSL_CTX *ctx)
668 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
671 if (ctx->method == NULL) {
672 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
676 s = OPENSSL_zalloc(sizeof(*s));
681 s->lock = CRYPTO_THREAD_lock_new();
682 if (s->lock == NULL) {
689 * If not using the standard RAND (say for fuzzing), then don't use a
692 if (RAND_get_rand_method() == RAND_OpenSSL()) {
694 RAND_DRBG_new(RAND_DRBG_NID, RAND_DRBG_FLAG_CTR_USE_DF,
695 RAND_DRBG_get0_public());
697 || RAND_DRBG_instantiate(s->drbg,
698 (const unsigned char *) SSL_version_str,
699 sizeof(SSL_version_str) - 1) == 0)
703 RECORD_LAYER_init(&s->rlayer, s);
705 s->options = ctx->options;
706 s->dane.flags = ctx->dane.flags;
707 s->min_proto_version = ctx->min_proto_version;
708 s->max_proto_version = ctx->max_proto_version;
710 s->max_cert_list = ctx->max_cert_list;
711 s->max_early_data = ctx->max_early_data;
714 * Earlier library versions used to copy the pointer to the CERT, not
715 * its contents; only when setting new parameters for the per-SSL
716 * copy, ssl_cert_new would be called (and the direct reference to
717 * the per-SSL_CTX settings would be lost, but those still were
718 * indirectly accessed for various purposes, and for that reason they
719 * used to be known as s->ctx->default_cert). Now we don't look at the
720 * SSL_CTX's CERT after having duplicated it once.
722 s->cert = ssl_cert_dup(ctx->cert);
726 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
727 s->msg_callback = ctx->msg_callback;
728 s->msg_callback_arg = ctx->msg_callback_arg;
729 s->verify_mode = ctx->verify_mode;
730 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
731 s->record_padding_cb = ctx->record_padding_cb;
732 s->record_padding_arg = ctx->record_padding_arg;
733 s->block_padding = ctx->block_padding;
734 s->sid_ctx_length = ctx->sid_ctx_length;
735 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
737 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
738 s->verify_callback = ctx->default_verify_callback;
739 s->generate_session_id = ctx->generate_session_id;
741 s->param = X509_VERIFY_PARAM_new();
742 if (s->param == NULL)
744 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
745 s->quiet_shutdown = ctx->quiet_shutdown;
747 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
748 s->max_send_fragment = ctx->max_send_fragment;
749 s->split_send_fragment = ctx->split_send_fragment;
750 s->max_pipelines = ctx->max_pipelines;
751 if (s->max_pipelines > 1)
752 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
753 if (ctx->default_read_buf_len > 0)
754 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
759 s->ext.debug_arg = NULL;
760 s->ext.ticket_expected = 0;
761 s->ext.status_type = ctx->ext.status_type;
762 s->ext.status_expected = 0;
763 s->ext.ocsp.ids = NULL;
764 s->ext.ocsp.exts = NULL;
765 s->ext.ocsp.resp = NULL;
766 s->ext.ocsp.resp_len = 0;
768 s->session_ctx = ctx;
769 #ifndef OPENSSL_NO_EC
770 if (ctx->ext.ecpointformats) {
771 s->ext.ecpointformats =
772 OPENSSL_memdup(ctx->ext.ecpointformats,
773 ctx->ext.ecpointformats_len);
774 if (!s->ext.ecpointformats)
776 s->ext.ecpointformats_len =
777 ctx->ext.ecpointformats_len;
779 if (ctx->ext.supportedgroups) {
780 s->ext.supportedgroups =
781 OPENSSL_memdup(ctx->ext.supportedgroups,
782 ctx->ext.supportedgroups_len
783 * sizeof(*ctx->ext.supportedgroups));
784 if (!s->ext.supportedgroups)
786 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
789 #ifndef OPENSSL_NO_NEXTPROTONEG
793 if (s->ctx->ext.alpn) {
794 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
795 if (s->ext.alpn == NULL)
797 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
798 s->ext.alpn_len = s->ctx->ext.alpn_len;
801 s->verified_chain = NULL;
802 s->verify_result = X509_V_OK;
804 s->default_passwd_callback = ctx->default_passwd_callback;
805 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
807 s->method = ctx->method;
809 s->key_update = SSL_KEY_UPDATE_NONE;
811 if (!s->method->ssl_new(s))
814 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
819 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
822 #ifndef OPENSSL_NO_PSK
823 s->psk_client_callback = ctx->psk_client_callback;
824 s->psk_server_callback = ctx->psk_server_callback;
826 s->psk_find_session_cb = ctx->psk_find_session_cb;
827 s->psk_use_session_cb = ctx->psk_use_session_cb;
831 #ifndef OPENSSL_NO_CT
832 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
833 ctx->ct_validation_callback_arg))
840 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
844 int SSL_is_dtls(const SSL *s)
846 return SSL_IS_DTLS(s) ? 1 : 0;
849 int SSL_up_ref(SSL *s)
853 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
856 REF_PRINT_COUNT("SSL", s);
857 REF_ASSERT_ISNT(i < 2);
858 return ((i > 1) ? 1 : 0);
861 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
862 unsigned int sid_ctx_len)
864 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
865 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
866 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
869 ctx->sid_ctx_length = sid_ctx_len;
870 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
875 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
876 unsigned int sid_ctx_len)
878 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
879 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
880 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
883 ssl->sid_ctx_length = sid_ctx_len;
884 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
889 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
891 CRYPTO_THREAD_write_lock(ctx->lock);
892 ctx->generate_session_id = cb;
893 CRYPTO_THREAD_unlock(ctx->lock);
897 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
899 CRYPTO_THREAD_write_lock(ssl->lock);
900 ssl->generate_session_id = cb;
901 CRYPTO_THREAD_unlock(ssl->lock);
905 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
909 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
910 * we can "construct" a session to give us the desired check - i.e. to
911 * find if there's a session in the hash table that would conflict with
912 * any new session built out of this id/id_len and the ssl_version in use
917 if (id_len > sizeof(r.session_id))
920 r.ssl_version = ssl->version;
921 r.session_id_length = id_len;
922 memcpy(r.session_id, id, id_len);
924 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
925 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
926 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
930 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
932 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
935 int SSL_set_purpose(SSL *s, int purpose)
937 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
940 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
942 return X509_VERIFY_PARAM_set_trust(s->param, trust);
945 int SSL_set_trust(SSL *s, int trust)
947 return X509_VERIFY_PARAM_set_trust(s->param, trust);
950 int SSL_set1_host(SSL *s, const char *hostname)
952 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
955 int SSL_add1_host(SSL *s, const char *hostname)
957 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
960 void SSL_set_hostflags(SSL *s, unsigned int flags)
962 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
965 const char *SSL_get0_peername(SSL *s)
967 return X509_VERIFY_PARAM_get0_peername(s->param);
970 int SSL_CTX_dane_enable(SSL_CTX *ctx)
972 return dane_ctx_enable(&ctx->dane);
975 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
977 unsigned long orig = ctx->dane.flags;
979 ctx->dane.flags |= flags;
983 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
985 unsigned long orig = ctx->dane.flags;
987 ctx->dane.flags &= ~flags;
991 int SSL_dane_enable(SSL *s, const char *basedomain)
993 SSL_DANE *dane = &s->dane;
995 if (s->ctx->dane.mdmax == 0) {
996 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
999 if (dane->trecs != NULL) {
1000 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1005 * Default SNI name. This rejects empty names, while set1_host below
1006 * accepts them and disables host name checks. To avoid side-effects with
1007 * invalid input, set the SNI name first.
1009 if (s->ext.hostname == NULL) {
1010 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1011 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1016 /* Primary RFC6125 reference identifier */
1017 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1018 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1024 dane->dctx = &s->ctx->dane;
1025 dane->trecs = sk_danetls_record_new_null();
1027 if (dane->trecs == NULL) {
1028 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1034 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1036 unsigned long orig = ssl->dane.flags;
1038 ssl->dane.flags |= flags;
1042 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1044 unsigned long orig = ssl->dane.flags;
1046 ssl->dane.flags &= ~flags;
1050 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1052 SSL_DANE *dane = &s->dane;
1054 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1058 *mcert = dane->mcert;
1060 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1065 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1066 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1068 SSL_DANE *dane = &s->dane;
1070 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1074 *usage = dane->mtlsa->usage;
1076 *selector = dane->mtlsa->selector;
1078 *mtype = dane->mtlsa->mtype;
1080 *data = dane->mtlsa->data;
1082 *dlen = dane->mtlsa->dlen;
1087 SSL_DANE *SSL_get0_dane(SSL *s)
1092 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1093 uint8_t mtype, unsigned const char *data, size_t dlen)
1095 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1098 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1101 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1104 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1106 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1109 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1111 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1114 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1119 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1124 void SSL_certs_clear(SSL *s)
1126 ssl_cert_clear_certs(s->cert);
1129 void SSL_free(SSL *s)
1136 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1137 REF_PRINT_COUNT("SSL", s);
1140 REF_ASSERT_ISNT(i < 0);
1142 X509_VERIFY_PARAM_free(s->param);
1143 dane_final(&s->dane);
1144 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1146 /* Ignore return value */
1147 ssl_free_wbio_buffer(s);
1149 BIO_free_all(s->wbio);
1150 BIO_free_all(s->rbio);
1152 BUF_MEM_free(s->init_buf);
1154 /* add extra stuff */
1155 sk_SSL_CIPHER_free(s->cipher_list);
1156 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1158 /* Make the next call work :-) */
1159 if (s->session != NULL) {
1160 ssl_clear_bad_session(s);
1161 SSL_SESSION_free(s->session);
1163 SSL_SESSION_free(s->psksession);
1164 OPENSSL_free(s->psksession_id);
1168 ssl_cert_free(s->cert);
1169 /* Free up if allocated */
1171 OPENSSL_free(s->ext.hostname);
1172 SSL_CTX_free(s->session_ctx);
1173 #ifndef OPENSSL_NO_EC
1174 OPENSSL_free(s->ext.ecpointformats);
1175 OPENSSL_free(s->ext.supportedgroups);
1176 #endif /* OPENSSL_NO_EC */
1177 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1178 #ifndef OPENSSL_NO_OCSP
1179 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1181 #ifndef OPENSSL_NO_CT
1182 SCT_LIST_free(s->scts);
1183 OPENSSL_free(s->ext.scts);
1185 OPENSSL_free(s->ext.ocsp.resp);
1186 OPENSSL_free(s->ext.alpn);
1187 OPENSSL_free(s->ext.tls13_cookie);
1188 OPENSSL_free(s->clienthello);
1190 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1192 sk_X509_pop_free(s->verified_chain, X509_free);
1194 if (s->method != NULL)
1195 s->method->ssl_free(s);
1197 RECORD_LAYER_release(&s->rlayer);
1199 SSL_CTX_free(s->ctx);
1201 ASYNC_WAIT_CTX_free(s->waitctx);
1203 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1204 OPENSSL_free(s->ext.npn);
1207 #ifndef OPENSSL_NO_SRTP
1208 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1211 RAND_DRBG_free(s->drbg);
1212 CRYPTO_THREAD_lock_free(s->lock);
1217 void SSL_set0_rbio(SSL *s, BIO *rbio)
1219 BIO_free_all(s->rbio);
1223 void SSL_set0_wbio(SSL *s, BIO *wbio)
1226 * If the output buffering BIO is still in place, remove it
1228 if (s->bbio != NULL)
1229 s->wbio = BIO_pop(s->wbio);
1231 BIO_free_all(s->wbio);
1234 /* Re-attach |bbio| to the new |wbio|. */
1235 if (s->bbio != NULL)
1236 s->wbio = BIO_push(s->bbio, s->wbio);
1239 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1242 * For historical reasons, this function has many different cases in
1243 * ownership handling.
1246 /* If nothing has changed, do nothing */
1247 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1251 * If the two arguments are equal then one fewer reference is granted by the
1252 * caller than we want to take
1254 if (rbio != NULL && rbio == wbio)
1258 * If only the wbio is changed only adopt one reference.
1260 if (rbio == SSL_get_rbio(s)) {
1261 SSL_set0_wbio(s, wbio);
1265 * There is an asymmetry here for historical reasons. If only the rbio is
1266 * changed AND the rbio and wbio were originally different, then we only
1267 * adopt one reference.
1269 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1270 SSL_set0_rbio(s, rbio);
1274 /* Otherwise, adopt both references. */
1275 SSL_set0_rbio(s, rbio);
1276 SSL_set0_wbio(s, wbio);
1279 BIO *SSL_get_rbio(const SSL *s)
1284 BIO *SSL_get_wbio(const SSL *s)
1286 if (s->bbio != NULL) {
1288 * If |bbio| is active, the true caller-configured BIO is its
1291 return BIO_next(s->bbio);
1296 int SSL_get_fd(const SSL *s)
1298 return SSL_get_rfd(s);
1301 int SSL_get_rfd(const SSL *s)
1306 b = SSL_get_rbio(s);
1307 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1309 BIO_get_fd(r, &ret);
1313 int SSL_get_wfd(const SSL *s)
1318 b = SSL_get_wbio(s);
1319 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1321 BIO_get_fd(r, &ret);
1325 #ifndef OPENSSL_NO_SOCK
1326 int SSL_set_fd(SSL *s, int fd)
1331 bio = BIO_new(BIO_s_socket());
1334 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1337 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1338 SSL_set_bio(s, bio, bio);
1344 int SSL_set_wfd(SSL *s, int fd)
1346 BIO *rbio = SSL_get_rbio(s);
1348 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1349 || (int)BIO_get_fd(rbio, NULL) != fd) {
1350 BIO *bio = BIO_new(BIO_s_socket());
1353 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1356 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1357 SSL_set0_wbio(s, bio);
1360 SSL_set0_wbio(s, rbio);
1365 int SSL_set_rfd(SSL *s, int fd)
1367 BIO *wbio = SSL_get_wbio(s);
1369 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1370 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1371 BIO *bio = BIO_new(BIO_s_socket());
1374 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1377 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1378 SSL_set0_rbio(s, bio);
1381 SSL_set0_rbio(s, wbio);
1388 /* return length of latest Finished message we sent, copy to 'buf' */
1389 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1393 if (s->s3 != NULL) {
1394 ret = s->s3->tmp.finish_md_len;
1397 memcpy(buf, s->s3->tmp.finish_md, count);
1402 /* return length of latest Finished message we expected, copy to 'buf' */
1403 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1407 if (s->s3 != NULL) {
1408 ret = s->s3->tmp.peer_finish_md_len;
1411 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1416 int SSL_get_verify_mode(const SSL *s)
1418 return s->verify_mode;
1421 int SSL_get_verify_depth(const SSL *s)
1423 return X509_VERIFY_PARAM_get_depth(s->param);
1426 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1427 return s->verify_callback;
1430 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1432 return ctx->verify_mode;
1435 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1437 return X509_VERIFY_PARAM_get_depth(ctx->param);
1440 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1441 return ctx->default_verify_callback;
1444 void SSL_set_verify(SSL *s, int mode,
1445 int (*callback) (int ok, X509_STORE_CTX *ctx))
1447 s->verify_mode = mode;
1448 if (callback != NULL)
1449 s->verify_callback = callback;
1452 void SSL_set_verify_depth(SSL *s, int depth)
1454 X509_VERIFY_PARAM_set_depth(s->param, depth);
1457 void SSL_set_read_ahead(SSL *s, int yes)
1459 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1462 int SSL_get_read_ahead(const SSL *s)
1464 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1467 int SSL_pending(const SSL *s)
1469 size_t pending = s->method->ssl_pending(s);
1472 * SSL_pending cannot work properly if read-ahead is enabled
1473 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1474 * impossible to fix since SSL_pending cannot report errors that may be
1475 * observed while scanning the new data. (Note that SSL_pending() is
1476 * often used as a boolean value, so we'd better not return -1.)
1478 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1479 * we just return INT_MAX.
1481 return pending < INT_MAX ? (int)pending : INT_MAX;
1484 int SSL_has_pending(const SSL *s)
1487 * Similar to SSL_pending() but returns a 1 to indicate that we have
1488 * unprocessed data available or 0 otherwise (as opposed to the number of
1489 * bytes available). Unlike SSL_pending() this will take into account
1490 * read_ahead data. A 1 return simply indicates that we have unprocessed
1491 * data. That data may not result in any application data, or we may fail
1492 * to parse the records for some reason.
1494 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1497 return RECORD_LAYER_read_pending(&s->rlayer);
1500 X509 *SSL_get_peer_certificate(const SSL *s)
1504 if ((s == NULL) || (s->session == NULL))
1507 r = s->session->peer;
1517 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1521 if ((s == NULL) || (s->session == NULL))
1524 r = s->session->peer_chain;
1527 * If we are a client, cert_chain includes the peer's own certificate; if
1528 * we are a server, it does not.
1535 * Now in theory, since the calling process own 't' it should be safe to
1536 * modify. We need to be able to read f without being hassled
1538 int SSL_copy_session_id(SSL *t, const SSL *f)
1541 /* Do we need to to SSL locking? */
1542 if (!SSL_set_session(t, SSL_get_session(f))) {
1547 * what if we are setup for one protocol version but want to talk another
1549 if (t->method != f->method) {
1550 t->method->ssl_free(t);
1551 t->method = f->method;
1552 if (t->method->ssl_new(t) == 0)
1556 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1557 ssl_cert_free(t->cert);
1559 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1566 /* Fix this so it checks all the valid key/cert options */
1567 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1569 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1570 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1573 if (ctx->cert->key->privatekey == NULL) {
1574 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1577 return X509_check_private_key
1578 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1581 /* Fix this function so that it takes an optional type parameter */
1582 int SSL_check_private_key(const SSL *ssl)
1585 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1588 if (ssl->cert->key->x509 == NULL) {
1589 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1592 if (ssl->cert->key->privatekey == NULL) {
1593 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1596 return X509_check_private_key(ssl->cert->key->x509,
1597 ssl->cert->key->privatekey);
1600 int SSL_waiting_for_async(SSL *s)
1608 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1610 ASYNC_WAIT_CTX *ctx = s->waitctx;
1614 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1617 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1618 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1620 ASYNC_WAIT_CTX *ctx = s->waitctx;
1624 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1628 int SSL_accept(SSL *s)
1630 if (s->handshake_func == NULL) {
1631 /* Not properly initialized yet */
1632 SSL_set_accept_state(s);
1635 return SSL_do_handshake(s);
1638 int SSL_connect(SSL *s)
1640 if (s->handshake_func == NULL) {
1641 /* Not properly initialized yet */
1642 SSL_set_connect_state(s);
1645 return SSL_do_handshake(s);
1648 long SSL_get_default_timeout(const SSL *s)
1650 return s->method->get_timeout();
1653 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1654 int (*func) (void *))
1657 if (s->waitctx == NULL) {
1658 s->waitctx = ASYNC_WAIT_CTX_new();
1659 if (s->waitctx == NULL)
1662 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1663 sizeof(struct ssl_async_args))) {
1665 s->rwstate = SSL_NOTHING;
1666 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1669 s->rwstate = SSL_ASYNC_PAUSED;
1672 s->rwstate = SSL_ASYNC_NO_JOBS;
1678 s->rwstate = SSL_NOTHING;
1679 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1680 /* Shouldn't happen */
1685 static int ssl_io_intern(void *vargs)
1687 struct ssl_async_args *args;
1692 args = (struct ssl_async_args *)vargs;
1696 switch (args->type) {
1698 return args->f.func_read(s, buf, num, &s->asyncrw);
1700 return args->f.func_write(s, buf, num, &s->asyncrw);
1702 return args->f.func_other(s);
1707 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1709 if (s->handshake_func == NULL) {
1710 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1714 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1715 s->rwstate = SSL_NOTHING;
1719 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1720 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1721 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1725 * If we are a client and haven't received the ServerHello etc then we
1728 ossl_statem_check_finish_init(s, 0);
1730 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1731 struct ssl_async_args args;
1737 args.type = READFUNC;
1738 args.f.func_read = s->method->ssl_read;
1740 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1741 *readbytes = s->asyncrw;
1744 return s->method->ssl_read(s, buf, num, readbytes);
1748 int SSL_read(SSL *s, void *buf, int num)
1754 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1758 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1761 * The cast is safe here because ret should be <= INT_MAX because num is
1765 ret = (int)readbytes;
1770 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1772 int ret = ssl_read_internal(s, buf, num, readbytes);
1779 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1784 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1785 return SSL_READ_EARLY_DATA_ERROR;
1788 switch (s->early_data_state) {
1789 case SSL_EARLY_DATA_NONE:
1790 if (!SSL_in_before(s)) {
1791 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1792 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1793 return SSL_READ_EARLY_DATA_ERROR;
1797 case SSL_EARLY_DATA_ACCEPT_RETRY:
1798 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1799 ret = SSL_accept(s);
1802 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1803 return SSL_READ_EARLY_DATA_ERROR;
1807 case SSL_EARLY_DATA_READ_RETRY:
1808 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1809 s->early_data_state = SSL_EARLY_DATA_READING;
1810 ret = SSL_read_ex(s, buf, num, readbytes);
1812 * State machine will update early_data_state to
1813 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1816 if (ret > 0 || (ret <= 0 && s->early_data_state
1817 != SSL_EARLY_DATA_FINISHED_READING)) {
1818 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1819 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1820 : SSL_READ_EARLY_DATA_ERROR;
1823 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1826 return SSL_READ_EARLY_DATA_FINISH;
1829 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1830 return SSL_READ_EARLY_DATA_ERROR;
1834 int SSL_get_early_data_status(const SSL *s)
1836 return s->ext.early_data;
1839 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1841 if (s->handshake_func == NULL) {
1842 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1846 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1849 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1850 struct ssl_async_args args;
1856 args.type = READFUNC;
1857 args.f.func_read = s->method->ssl_peek;
1859 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1860 *readbytes = s->asyncrw;
1863 return s->method->ssl_peek(s, buf, num, readbytes);
1867 int SSL_peek(SSL *s, void *buf, int num)
1873 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1877 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1880 * The cast is safe here because ret should be <= INT_MAX because num is
1884 ret = (int)readbytes;
1890 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1892 int ret = ssl_peek_internal(s, buf, num, readbytes);
1899 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1901 if (s->handshake_func == NULL) {
1902 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1906 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1907 s->rwstate = SSL_NOTHING;
1908 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1912 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1913 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1914 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1915 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1918 /* If we are a client and haven't sent the Finished we better do that */
1919 ossl_statem_check_finish_init(s, 1);
1921 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1923 struct ssl_async_args args;
1926 args.buf = (void *)buf;
1928 args.type = WRITEFUNC;
1929 args.f.func_write = s->method->ssl_write;
1931 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1932 *written = s->asyncrw;
1935 return s->method->ssl_write(s, buf, num, written);
1939 int SSL_write(SSL *s, const void *buf, int num)
1945 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1949 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1952 * The cast is safe here because ret should be <= INT_MAX because num is
1961 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1963 int ret = ssl_write_internal(s, buf, num, written);
1970 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1972 int ret, early_data_state;
1974 uint32_t partialwrite;
1976 switch (s->early_data_state) {
1977 case SSL_EARLY_DATA_NONE:
1979 || !SSL_in_before(s)
1980 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1981 && (s->psk_use_session_cb == NULL))) {
1982 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1983 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1988 case SSL_EARLY_DATA_CONNECT_RETRY:
1989 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1990 ret = SSL_connect(s);
1993 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1998 case SSL_EARLY_DATA_WRITE_RETRY:
1999 s->early_data_state = SSL_EARLY_DATA_WRITING;
2001 * We disable partial write for early data because we don't keep track
2002 * of how many bytes we've written between the SSL_write_ex() call and
2003 * the flush if the flush needs to be retried)
2005 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2006 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2007 ret = SSL_write_ex(s, buf, num, &writtmp);
2008 s->mode |= partialwrite;
2010 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2013 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2016 case SSL_EARLY_DATA_WRITE_FLUSH:
2017 /* The buffering BIO is still in place so we need to flush it */
2018 if (statem_flush(s) != 1)
2021 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2024 case SSL_EARLY_DATA_FINISHED_READING:
2025 case SSL_EARLY_DATA_READ_RETRY:
2026 early_data_state = s->early_data_state;
2027 /* We are a server writing to an unauthenticated client */
2028 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2029 ret = SSL_write_ex(s, buf, num, written);
2030 s->early_data_state = early_data_state;
2034 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2039 int SSL_shutdown(SSL *s)
2042 * Note that this function behaves differently from what one might
2043 * expect. Return values are 0 for no success (yet), 1 for success; but
2044 * calling it once is usually not enough, even if blocking I/O is used
2045 * (see ssl3_shutdown).
2048 if (s->handshake_func == NULL) {
2049 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2053 if (!SSL_in_init(s)) {
2054 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2055 struct ssl_async_args args;
2058 args.type = OTHERFUNC;
2059 args.f.func_other = s->method->ssl_shutdown;
2061 return ssl_start_async_job(s, &args, ssl_io_intern);
2063 return s->method->ssl_shutdown(s);
2066 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2071 int SSL_key_update(SSL *s, int updatetype)
2074 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2075 * negotiated, and that it is appropriate to call SSL_key_update() instead
2076 * of SSL_renegotiate().
2078 if (!SSL_IS_TLS13(s)) {
2079 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2083 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2084 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2085 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2089 if (!SSL_is_init_finished(s)) {
2090 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2094 ossl_statem_set_in_init(s, 1);
2095 s->key_update = updatetype;
2099 int SSL_get_key_update_type(SSL *s)
2101 return s->key_update;
2104 int SSL_renegotiate(SSL *s)
2106 if (SSL_IS_TLS13(s)) {
2107 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2111 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2112 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2119 return s->method->ssl_renegotiate(s);
2122 int SSL_renegotiate_abbreviated(SSL *s)
2124 if (SSL_IS_TLS13(s)) {
2125 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2129 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2130 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2137 return s->method->ssl_renegotiate(s);
2140 int SSL_renegotiate_pending(SSL *s)
2143 * becomes true when negotiation is requested; false again once a
2144 * handshake has finished
2146 return (s->renegotiate != 0);
2149 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2154 case SSL_CTRL_GET_READ_AHEAD:
2155 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2156 case SSL_CTRL_SET_READ_AHEAD:
2157 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2158 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2161 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2162 s->msg_callback_arg = parg;
2166 return (s->mode |= larg);
2167 case SSL_CTRL_CLEAR_MODE:
2168 return (s->mode &= ~larg);
2169 case SSL_CTRL_GET_MAX_CERT_LIST:
2170 return (long)s->max_cert_list;
2171 case SSL_CTRL_SET_MAX_CERT_LIST:
2174 l = (long)s->max_cert_list;
2175 s->max_cert_list = (size_t)larg;
2177 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2178 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2180 s->max_send_fragment = larg;
2181 if (s->max_send_fragment < s->split_send_fragment)
2182 s->split_send_fragment = s->max_send_fragment;
2184 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2185 if ((size_t)larg > s->max_send_fragment || larg == 0)
2187 s->split_send_fragment = larg;
2189 case SSL_CTRL_SET_MAX_PIPELINES:
2190 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2192 s->max_pipelines = larg;
2194 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2196 case SSL_CTRL_GET_RI_SUPPORT:
2198 return s->s3->send_connection_binding;
2201 case SSL_CTRL_CERT_FLAGS:
2202 return (s->cert->cert_flags |= larg);
2203 case SSL_CTRL_CLEAR_CERT_FLAGS:
2204 return (s->cert->cert_flags &= ~larg);
2206 case SSL_CTRL_GET_RAW_CIPHERLIST:
2208 if (s->s3->tmp.ciphers_raw == NULL)
2210 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2211 return (int)s->s3->tmp.ciphers_rawlen;
2213 return TLS_CIPHER_LEN;
2215 case SSL_CTRL_GET_EXTMS_SUPPORT:
2216 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2218 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2222 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2223 return ssl_check_allowed_versions(larg, s->max_proto_version)
2224 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2225 &s->min_proto_version);
2226 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2227 return s->min_proto_version;
2228 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2229 return ssl_check_allowed_versions(s->min_proto_version, larg)
2230 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2231 &s->max_proto_version);
2232 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2233 return s->max_proto_version;
2235 return s->method->ssl_ctrl(s, cmd, larg, parg);
2239 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2242 case SSL_CTRL_SET_MSG_CALLBACK:
2243 s->msg_callback = (void (*)
2244 (int write_p, int version, int content_type,
2245 const void *buf, size_t len, SSL *ssl,
2250 return s->method->ssl_callback_ctrl(s, cmd, fp);
2254 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2256 return ctx->sessions;
2259 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2263 /* For some cases with ctx == NULL perform syntax checks */
2266 #ifndef OPENSSL_NO_EC
2267 case SSL_CTRL_SET_GROUPS_LIST:
2268 return tls1_set_groups_list(NULL, NULL, parg);
2270 case SSL_CTRL_SET_SIGALGS_LIST:
2271 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2272 return tls1_set_sigalgs_list(NULL, parg, 0);
2279 case SSL_CTRL_GET_READ_AHEAD:
2280 return ctx->read_ahead;
2281 case SSL_CTRL_SET_READ_AHEAD:
2282 l = ctx->read_ahead;
2283 ctx->read_ahead = larg;
2286 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2287 ctx->msg_callback_arg = parg;
2290 case SSL_CTRL_GET_MAX_CERT_LIST:
2291 return (long)ctx->max_cert_list;
2292 case SSL_CTRL_SET_MAX_CERT_LIST:
2295 l = (long)ctx->max_cert_list;
2296 ctx->max_cert_list = (size_t)larg;
2299 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2302 l = (long)ctx->session_cache_size;
2303 ctx->session_cache_size = (size_t)larg;
2305 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2306 return (long)ctx->session_cache_size;
2307 case SSL_CTRL_SET_SESS_CACHE_MODE:
2308 l = ctx->session_cache_mode;
2309 ctx->session_cache_mode = larg;
2311 case SSL_CTRL_GET_SESS_CACHE_MODE:
2312 return ctx->session_cache_mode;
2314 case SSL_CTRL_SESS_NUMBER:
2315 return lh_SSL_SESSION_num_items(ctx->sessions);
2316 case SSL_CTRL_SESS_CONNECT:
2317 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2319 case SSL_CTRL_SESS_CONNECT_GOOD:
2320 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2322 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2323 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2326 case SSL_CTRL_SESS_ACCEPT:
2327 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2329 case SSL_CTRL_SESS_ACCEPT_GOOD:
2330 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2332 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2333 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2336 case SSL_CTRL_SESS_HIT:
2337 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2339 case SSL_CTRL_SESS_CB_HIT:
2340 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2342 case SSL_CTRL_SESS_MISSES:
2343 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2345 case SSL_CTRL_SESS_TIMEOUTS:
2346 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2348 case SSL_CTRL_SESS_CACHE_FULL:
2349 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2352 return (ctx->mode |= larg);
2353 case SSL_CTRL_CLEAR_MODE:
2354 return (ctx->mode &= ~larg);
2355 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2356 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2358 ctx->max_send_fragment = larg;
2359 if (ctx->max_send_fragment < ctx->split_send_fragment)
2360 ctx->split_send_fragment = ctx->max_send_fragment;
2362 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2363 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2365 ctx->split_send_fragment = larg;
2367 case SSL_CTRL_SET_MAX_PIPELINES:
2368 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2370 ctx->max_pipelines = larg;
2372 case SSL_CTRL_CERT_FLAGS:
2373 return (ctx->cert->cert_flags |= larg);
2374 case SSL_CTRL_CLEAR_CERT_FLAGS:
2375 return (ctx->cert->cert_flags &= ~larg);
2376 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2377 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2378 && ssl_set_version_bound(ctx->method->version, (int)larg,
2379 &ctx->min_proto_version);
2380 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2381 return ctx->min_proto_version;
2382 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2383 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2384 && ssl_set_version_bound(ctx->method->version, (int)larg,
2385 &ctx->max_proto_version);
2386 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2387 return ctx->max_proto_version;
2389 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2393 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2396 case SSL_CTRL_SET_MSG_CALLBACK:
2397 ctx->msg_callback = (void (*)
2398 (int write_p, int version, int content_type,
2399 const void *buf, size_t len, SSL *ssl,
2404 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2408 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2417 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2418 const SSL_CIPHER *const *bp)
2420 if ((*ap)->id > (*bp)->id)
2422 if ((*ap)->id < (*bp)->id)
2427 /** return a STACK of the ciphers available for the SSL and in order of
2429 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2432 if (s->cipher_list != NULL) {
2433 return s->cipher_list;
2434 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2435 return s->ctx->cipher_list;
2441 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2443 if ((s == NULL) || (s->session == NULL) || !s->server)
2445 return s->session->ciphers;
2448 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2450 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2452 ciphers = SSL_get_ciphers(s);
2455 ssl_set_client_disabled(s);
2456 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2457 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2458 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2460 sk = sk_SSL_CIPHER_new_null();
2463 if (!sk_SSL_CIPHER_push(sk, c)) {
2464 sk_SSL_CIPHER_free(sk);
2472 /** return a STACK of the ciphers available for the SSL and in order of
2474 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2477 if (s->cipher_list_by_id != NULL) {
2478 return s->cipher_list_by_id;
2479 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2480 return s->ctx->cipher_list_by_id;
2486 /** The old interface to get the same thing as SSL_get_ciphers() */
2487 const char *SSL_get_cipher_list(const SSL *s, int n)
2489 const SSL_CIPHER *c;
2490 STACK_OF(SSL_CIPHER) *sk;
2494 sk = SSL_get_ciphers(s);
2495 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2497 c = sk_SSL_CIPHER_value(sk, n);
2503 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2505 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2508 return ctx->cipher_list;
2512 /** specify the ciphers to be used by default by the SSL_CTX */
2513 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2515 STACK_OF(SSL_CIPHER) *sk;
2517 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2518 &ctx->cipher_list_by_id, str, ctx->cert);
2520 * ssl_create_cipher_list may return an empty stack if it was unable to
2521 * find a cipher matching the given rule string (for example if the rule
2522 * string specifies a cipher which has been disabled). This is not an
2523 * error as far as ssl_create_cipher_list is concerned, and hence
2524 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2528 else if (sk_SSL_CIPHER_num(sk) == 0) {
2529 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2535 /** specify the ciphers to be used by the SSL */
2536 int SSL_set_cipher_list(SSL *s, const char *str)
2538 STACK_OF(SSL_CIPHER) *sk;
2540 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2541 &s->cipher_list_by_id, str, s->cert);
2542 /* see comment in SSL_CTX_set_cipher_list */
2545 else if (sk_SSL_CIPHER_num(sk) == 0) {
2546 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2552 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2555 STACK_OF(SSL_CIPHER) *sk;
2556 const SSL_CIPHER *c;
2559 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2563 sk = s->session->ciphers;
2565 if (sk_SSL_CIPHER_num(sk) == 0)
2568 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2571 c = sk_SSL_CIPHER_value(sk, i);
2572 n = strlen(c->name);
2588 /** return a servername extension value if provided in Client Hello, or NULL.
2589 * So far, only host_name types are defined (RFC 3546).
2592 const char *SSL_get_servername(const SSL *s, const int type)
2594 if (type != TLSEXT_NAMETYPE_host_name)
2597 return s->session && !s->ext.hostname ?
2598 s->session->ext.hostname : s->ext.hostname;
2601 int SSL_get_servername_type(const SSL *s)
2604 && (!s->ext.hostname ? s->session->
2605 ext.hostname : s->ext.hostname))
2606 return TLSEXT_NAMETYPE_host_name;
2611 * SSL_select_next_proto implements the standard protocol selection. It is
2612 * expected that this function is called from the callback set by
2613 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2614 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2615 * not included in the length. A byte string of length 0 is invalid. No byte
2616 * string may be truncated. The current, but experimental algorithm for
2617 * selecting the protocol is: 1) If the server doesn't support NPN then this
2618 * is indicated to the callback. In this case, the client application has to
2619 * abort the connection or have a default application level protocol. 2) If
2620 * the server supports NPN, but advertises an empty list then the client
2621 * selects the first protocol in its list, but indicates via the API that this
2622 * fallback case was enacted. 3) Otherwise, the client finds the first
2623 * protocol in the server's list that it supports and selects this protocol.
2624 * This is because it's assumed that the server has better information about
2625 * which protocol a client should use. 4) If the client doesn't support any
2626 * of the server's advertised protocols, then this is treated the same as
2627 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2628 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2630 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2631 const unsigned char *server,
2632 unsigned int server_len,
2633 const unsigned char *client, unsigned int client_len)
2636 const unsigned char *result;
2637 int status = OPENSSL_NPN_UNSUPPORTED;
2640 * For each protocol in server preference order, see if we support it.
2642 for (i = 0; i < server_len;) {
2643 for (j = 0; j < client_len;) {
2644 if (server[i] == client[j] &&
2645 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2646 /* We found a match */
2647 result = &server[i];
2648 status = OPENSSL_NPN_NEGOTIATED;
2658 /* There's no overlap between our protocols and the server's list. */
2660 status = OPENSSL_NPN_NO_OVERLAP;
2663 *out = (unsigned char *)result + 1;
2664 *outlen = result[0];
2668 #ifndef OPENSSL_NO_NEXTPROTONEG
2670 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2671 * client's requested protocol for this connection and returns 0. If the
2672 * client didn't request any protocol, then *data is set to NULL. Note that
2673 * the client can request any protocol it chooses. The value returned from
2674 * this function need not be a member of the list of supported protocols
2675 * provided by the callback.
2677 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2684 *len = (unsigned int)s->ext.npn_len;
2689 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2690 * a TLS server needs a list of supported protocols for Next Protocol
2691 * Negotiation. The returned list must be in wire format. The list is
2692 * returned by setting |out| to point to it and |outlen| to its length. This
2693 * memory will not be modified, but one should assume that the SSL* keeps a
2694 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2695 * wishes to advertise. Otherwise, no such extension will be included in the
2698 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2699 SSL_CTX_npn_advertised_cb_func cb,
2702 ctx->ext.npn_advertised_cb = cb;
2703 ctx->ext.npn_advertised_cb_arg = arg;
2707 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2708 * client needs to select a protocol from the server's provided list. |out|
2709 * must be set to point to the selected protocol (which may be within |in|).
2710 * The length of the protocol name must be written into |outlen|. The
2711 * server's advertised protocols are provided in |in| and |inlen|. The
2712 * callback can assume that |in| is syntactically valid. The client must
2713 * select a protocol. It is fatal to the connection if this callback returns
2714 * a value other than SSL_TLSEXT_ERR_OK.
2716 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2717 SSL_CTX_npn_select_cb_func cb,
2720 ctx->ext.npn_select_cb = cb;
2721 ctx->ext.npn_select_cb_arg = arg;
2726 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2727 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2728 * length-prefixed strings). Returns 0 on success.
2730 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2731 unsigned int protos_len)
2733 OPENSSL_free(ctx->ext.alpn);
2734 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2735 if (ctx->ext.alpn == NULL) {
2736 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2739 ctx->ext.alpn_len = protos_len;
2745 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2746 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2747 * length-prefixed strings). Returns 0 on success.
2749 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2750 unsigned int protos_len)
2752 OPENSSL_free(ssl->ext.alpn);
2753 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2754 if (ssl->ext.alpn == NULL) {
2755 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2758 ssl->ext.alpn_len = protos_len;
2764 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2765 * called during ClientHello processing in order to select an ALPN protocol
2766 * from the client's list of offered protocols.
2768 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2769 SSL_CTX_alpn_select_cb_func cb,
2772 ctx->ext.alpn_select_cb = cb;
2773 ctx->ext.alpn_select_cb_arg = arg;
2777 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2778 * On return it sets |*data| to point to |*len| bytes of protocol name
2779 * (not including the leading length-prefix byte). If the server didn't
2780 * respond with a negotiated protocol then |*len| will be zero.
2782 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2787 *data = ssl->s3->alpn_selected;
2791 *len = (unsigned int)ssl->s3->alpn_selected_len;
2794 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2795 const char *label, size_t llen,
2796 const unsigned char *context, size_t contextlen,
2799 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2802 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2804 contextlen, use_context);
2807 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2809 const unsigned char *session_id = a->session_id;
2811 unsigned char tmp_storage[4];
2813 if (a->session_id_length < sizeof(tmp_storage)) {
2814 memset(tmp_storage, 0, sizeof(tmp_storage));
2815 memcpy(tmp_storage, a->session_id, a->session_id_length);
2816 session_id = tmp_storage;
2820 ((unsigned long)session_id[0]) |
2821 ((unsigned long)session_id[1] << 8L) |
2822 ((unsigned long)session_id[2] << 16L) |
2823 ((unsigned long)session_id[3] << 24L);
2828 * NB: If this function (or indeed the hash function which uses a sort of
2829 * coarser function than this one) is changed, ensure
2830 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2831 * being able to construct an SSL_SESSION that will collide with any existing
2832 * session with a matching session ID.
2834 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2836 if (a->ssl_version != b->ssl_version)
2838 if (a->session_id_length != b->session_id_length)
2840 return memcmp(a->session_id, b->session_id, a->session_id_length);
2844 * These wrapper functions should remain rather than redeclaring
2845 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2846 * variable. The reason is that the functions aren't static, they're exposed
2850 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2852 SSL_CTX *ret = NULL;
2855 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2859 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2862 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2863 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2866 ret = OPENSSL_zalloc(sizeof(*ret));
2871 ret->min_proto_version = 0;
2872 ret->max_proto_version = 0;
2873 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2874 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2875 /* We take the system default. */
2876 ret->session_timeout = meth->get_timeout();
2877 ret->references = 1;
2878 ret->lock = CRYPTO_THREAD_lock_new();
2879 if (ret->lock == NULL) {
2880 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2884 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2885 ret->verify_mode = SSL_VERIFY_NONE;
2886 if ((ret->cert = ssl_cert_new()) == NULL)
2889 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2890 if (ret->sessions == NULL)
2892 ret->cert_store = X509_STORE_new();
2893 if (ret->cert_store == NULL)
2895 #ifndef OPENSSL_NO_CT
2896 ret->ctlog_store = CTLOG_STORE_new();
2897 if (ret->ctlog_store == NULL)
2900 if (!ssl_create_cipher_list(ret->method,
2901 &ret->cipher_list, &ret->cipher_list_by_id,
2902 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2903 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2904 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2908 ret->param = X509_VERIFY_PARAM_new();
2909 if (ret->param == NULL)
2912 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2913 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2916 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2917 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2921 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2924 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2927 /* No compression for DTLS */
2928 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2929 ret->comp_methods = SSL_COMP_get_compression_methods();
2931 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2932 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2934 /* Setup RFC5077 ticket keys */
2935 if ((RAND_bytes(ret->ext.tick_key_name,
2936 sizeof(ret->ext.tick_key_name)) <= 0)
2937 || (RAND_bytes(ret->ext.tick_hmac_key,
2938 sizeof(ret->ext.tick_hmac_key)) <= 0)
2939 || (RAND_bytes(ret->ext.tick_aes_key,
2940 sizeof(ret->ext.tick_aes_key)) <= 0))
2941 ret->options |= SSL_OP_NO_TICKET;
2943 if (RAND_bytes(ret->ext.cookie_hmac_key,
2944 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2947 #ifndef OPENSSL_NO_SRP
2948 if (!SSL_CTX_SRP_CTX_init(ret))
2951 #ifndef OPENSSL_NO_ENGINE
2952 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2953 # define eng_strx(x) #x
2954 # define eng_str(x) eng_strx(x)
2955 /* Use specific client engine automatically... ignore errors */
2958 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2961 ENGINE_load_builtin_engines();
2962 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2964 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2970 * Default is to connect to non-RI servers. When RI is more widely
2971 * deployed might change this.
2973 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2975 * Disable compression by default to prevent CRIME. Applications can
2976 * re-enable compression by configuring
2977 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2978 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
2979 * middlebox compatibility by default. This may be disabled by default in
2980 * a later OpenSSL version.
2982 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
2984 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2987 * Default max early data is a fully loaded single record. Could be split
2988 * across multiple records in practice
2990 ret->max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
2994 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3000 int SSL_CTX_up_ref(SSL_CTX *ctx)
3004 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3007 REF_PRINT_COUNT("SSL_CTX", ctx);
3008 REF_ASSERT_ISNT(i < 2);
3009 return ((i > 1) ? 1 : 0);
3012 void SSL_CTX_free(SSL_CTX *a)
3019 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3020 REF_PRINT_COUNT("SSL_CTX", a);
3023 REF_ASSERT_ISNT(i < 0);
3025 X509_VERIFY_PARAM_free(a->param);
3026 dane_ctx_final(&a->dane);
3029 * Free internal session cache. However: the remove_cb() may reference
3030 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3031 * after the sessions were flushed.
3032 * As the ex_data handling routines might also touch the session cache,
3033 * the most secure solution seems to be: empty (flush) the cache, then
3034 * free ex_data, then finally free the cache.
3035 * (See ticket [openssl.org #212].)
3037 if (a->sessions != NULL)
3038 SSL_CTX_flush_sessions(a, 0);
3040 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3041 lh_SSL_SESSION_free(a->sessions);
3042 X509_STORE_free(a->cert_store);
3043 #ifndef OPENSSL_NO_CT
3044 CTLOG_STORE_free(a->ctlog_store);
3046 sk_SSL_CIPHER_free(a->cipher_list);
3047 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3048 ssl_cert_free(a->cert);
3049 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3050 sk_X509_pop_free(a->extra_certs, X509_free);
3051 a->comp_methods = NULL;
3052 #ifndef OPENSSL_NO_SRTP
3053 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3055 #ifndef OPENSSL_NO_SRP
3056 SSL_CTX_SRP_CTX_free(a);
3058 #ifndef OPENSSL_NO_ENGINE
3059 ENGINE_finish(a->client_cert_engine);
3062 #ifndef OPENSSL_NO_EC
3063 OPENSSL_free(a->ext.ecpointformats);
3064 OPENSSL_free(a->ext.supportedgroups);
3066 OPENSSL_free(a->ext.alpn);
3068 CRYPTO_THREAD_lock_free(a->lock);
3073 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3075 ctx->default_passwd_callback = cb;
3078 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3080 ctx->default_passwd_callback_userdata = u;
3083 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3085 return ctx->default_passwd_callback;
3088 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3090 return ctx->default_passwd_callback_userdata;
3093 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3095 s->default_passwd_callback = cb;
3098 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3100 s->default_passwd_callback_userdata = u;
3103 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3105 return s->default_passwd_callback;
3108 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3110 return s->default_passwd_callback_userdata;
3113 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3114 int (*cb) (X509_STORE_CTX *, void *),
3117 ctx->app_verify_callback = cb;
3118 ctx->app_verify_arg = arg;
3121 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3122 int (*cb) (int, X509_STORE_CTX *))
3124 ctx->verify_mode = mode;
3125 ctx->default_verify_callback = cb;
3128 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3130 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3133 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3135 ssl_cert_set_cert_cb(c->cert, cb, arg);
3138 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3140 ssl_cert_set_cert_cb(s->cert, cb, arg);
3143 void ssl_set_masks(SSL *s)
3146 uint32_t *pvalid = s->s3->tmp.valid_flags;
3147 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3148 unsigned long mask_k, mask_a;
3149 #ifndef OPENSSL_NO_EC
3150 int have_ecc_cert, ecdsa_ok;
3155 #ifndef OPENSSL_NO_DH
3156 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3161 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3162 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3163 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3164 #ifndef OPENSSL_NO_EC
3165 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3171 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3172 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3175 #ifndef OPENSSL_NO_GOST
3176 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3177 mask_k |= SSL_kGOST;
3178 mask_a |= SSL_aGOST12;
3180 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3181 mask_k |= SSL_kGOST;
3182 mask_a |= SSL_aGOST12;
3184 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3185 mask_k |= SSL_kGOST;
3186 mask_a |= SSL_aGOST01;
3197 * If we only have an RSA-PSS certificate allow RSA authentication
3198 * if TLS 1.2 and peer supports it.
3201 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3202 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3203 && TLS1_get_version(s) == TLS1_2_VERSION))
3210 mask_a |= SSL_aNULL;
3213 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3214 * depending on the key usage extension.
3216 #ifndef OPENSSL_NO_EC
3217 if (have_ecc_cert) {
3219 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3220 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3221 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3224 mask_a |= SSL_aECDSA;
3226 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3227 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3228 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3229 && TLS1_get_version(s) == TLS1_2_VERSION)
3230 mask_a |= SSL_aECDSA;
3233 #ifndef OPENSSL_NO_EC
3234 mask_k |= SSL_kECDHE;
3237 #ifndef OPENSSL_NO_PSK
3240 if (mask_k & SSL_kRSA)
3241 mask_k |= SSL_kRSAPSK;
3242 if (mask_k & SSL_kDHE)
3243 mask_k |= SSL_kDHEPSK;
3244 if (mask_k & SSL_kECDHE)
3245 mask_k |= SSL_kECDHEPSK;
3248 s->s3->tmp.mask_k = mask_k;
3249 s->s3->tmp.mask_a = mask_a;
3252 #ifndef OPENSSL_NO_EC
3254 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3256 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3257 /* key usage, if present, must allow signing */
3258 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3259 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3260 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3264 return 1; /* all checks are ok */
3269 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3270 size_t *serverinfo_length)
3272 CERT_PKEY *cpk = s->s3->tmp.cert;
3273 *serverinfo_length = 0;
3275 if (cpk == NULL || cpk->serverinfo == NULL)
3278 *serverinfo = cpk->serverinfo;
3279 *serverinfo_length = cpk->serverinfo_length;
3283 void ssl_update_cache(SSL *s, int mode)
3288 * If the session_id_length is 0, we are not supposed to cache it, and it
3289 * would be rather hard to do anyway :-)
3291 if (s->session->session_id_length == 0)
3294 i = s->session_ctx->session_cache_mode;
3296 && (!s->hit || SSL_IS_TLS13(s))
3297 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) != 0
3298 || SSL_CTX_add_session(s->session_ctx, s->session))
3299 && s->session_ctx->new_session_cb != NULL) {
3300 SSL_SESSION_up_ref(s->session);
3301 if (!s->session_ctx->new_session_cb(s, s->session))
3302 SSL_SESSION_free(s->session);
3305 /* auto flush every 255 connections */
3306 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3308 if (mode & SSL_SESS_CACHE_CLIENT)
3309 stat = &s->session_ctx->stats.sess_connect_good;
3311 stat = &s->session_ctx->stats.sess_accept_good;
3312 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3313 && (val & 0xff) == 0xff)
3314 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3318 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3323 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3328 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3332 if (s->method != meth) {
3333 const SSL_METHOD *sm = s->method;
3334 int (*hf) (SSL *) = s->handshake_func;
3336 if (sm->version == meth->version)
3341 ret = s->method->ssl_new(s);
3344 if (hf == sm->ssl_connect)
3345 s->handshake_func = meth->ssl_connect;
3346 else if (hf == sm->ssl_accept)
3347 s->handshake_func = meth->ssl_accept;
3352 int SSL_get_error(const SSL *s, int i)
3359 return SSL_ERROR_NONE;
3362 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3363 * where we do encode the error
3365 if ((l = ERR_peek_error()) != 0) {
3366 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3367 return SSL_ERROR_SYSCALL;
3369 return SSL_ERROR_SSL;
3372 if (SSL_want_read(s)) {
3373 bio = SSL_get_rbio(s);
3374 if (BIO_should_read(bio))
3375 return SSL_ERROR_WANT_READ;
3376 else if (BIO_should_write(bio))
3378 * This one doesn't make too much sense ... We never try to write
3379 * to the rbio, and an application program where rbio and wbio
3380 * are separate couldn't even know what it should wait for.
3381 * However if we ever set s->rwstate incorrectly (so that we have
3382 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3383 * wbio *are* the same, this test works around that bug; so it
3384 * might be safer to keep it.
3386 return SSL_ERROR_WANT_WRITE;
3387 else if (BIO_should_io_special(bio)) {
3388 reason = BIO_get_retry_reason(bio);
3389 if (reason == BIO_RR_CONNECT)
3390 return SSL_ERROR_WANT_CONNECT;
3391 else if (reason == BIO_RR_ACCEPT)
3392 return SSL_ERROR_WANT_ACCEPT;
3394 return SSL_ERROR_SYSCALL; /* unknown */
3398 if (SSL_want_write(s)) {
3399 /* Access wbio directly - in order to use the buffered bio if present */
3401 if (BIO_should_write(bio))
3402 return SSL_ERROR_WANT_WRITE;
3403 else if (BIO_should_read(bio))
3405 * See above (SSL_want_read(s) with BIO_should_write(bio))
3407 return SSL_ERROR_WANT_READ;
3408 else if (BIO_should_io_special(bio)) {
3409 reason = BIO_get_retry_reason(bio);
3410 if (reason == BIO_RR_CONNECT)
3411 return SSL_ERROR_WANT_CONNECT;
3412 else if (reason == BIO_RR_ACCEPT)
3413 return SSL_ERROR_WANT_ACCEPT;
3415 return SSL_ERROR_SYSCALL;
3418 if (SSL_want_x509_lookup(s))
3419 return SSL_ERROR_WANT_X509_LOOKUP;
3420 if (SSL_want_async(s))
3421 return SSL_ERROR_WANT_ASYNC;
3422 if (SSL_want_async_job(s))
3423 return SSL_ERROR_WANT_ASYNC_JOB;
3424 if (SSL_want_client_hello_cb(s))
3425 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3427 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3428 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3429 return SSL_ERROR_ZERO_RETURN;
3431 return SSL_ERROR_SYSCALL;
3434 static int ssl_do_handshake_intern(void *vargs)
3436 struct ssl_async_args *args;
3439 args = (struct ssl_async_args *)vargs;
3442 return s->handshake_func(s);
3445 int SSL_do_handshake(SSL *s)
3449 if (s->handshake_func == NULL) {
3450 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3454 ossl_statem_check_finish_init(s, -1);
3456 s->method->ssl_renegotiate_check(s, 0);
3458 if (SSL_is_server(s)) {
3459 /* clear SNI settings at server-side */
3460 OPENSSL_free(s->ext.hostname);
3461 s->ext.hostname = NULL;
3464 if (SSL_in_init(s) || SSL_in_before(s)) {
3465 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3466 struct ssl_async_args args;
3470 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3472 ret = s->handshake_func(s);
3478 void SSL_set_accept_state(SSL *s)
3482 ossl_statem_clear(s);
3483 s->handshake_func = s->method->ssl_accept;
3487 void SSL_set_connect_state(SSL *s)
3491 ossl_statem_clear(s);
3492 s->handshake_func = s->method->ssl_connect;
3496 int ssl_undefined_function(SSL *s)
3498 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3502 int ssl_undefined_void_function(void)
3504 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3505 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3509 int ssl_undefined_const_function(const SSL *s)
3514 const SSL_METHOD *ssl_bad_method(int ver)
3516 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3520 const char *ssl_protocol_to_string(int version)
3524 case TLS1_3_VERSION:
3527 case TLS1_2_VERSION:
3530 case TLS1_1_VERSION:
3545 case DTLS1_2_VERSION:
3553 const char *SSL_get_version(const SSL *s)
3555 return ssl_protocol_to_string(s->version);
3558 SSL *SSL_dup(SSL *s)
3560 STACK_OF(X509_NAME) *sk;
3565 /* If we're not quiescent, just up_ref! */
3566 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3567 CRYPTO_UP_REF(&s->references, &i, s->lock);
3572 * Otherwise, copy configuration state, and session if set.
3574 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3577 if (s->session != NULL) {
3579 * Arranges to share the same session via up_ref. This "copies"
3580 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3582 if (!SSL_copy_session_id(ret, s))
3586 * No session has been established yet, so we have to expect that
3587 * s->cert or ret->cert will be changed later -- they should not both
3588 * point to the same object, and thus we can't use
3589 * SSL_copy_session_id.
3591 if (!SSL_set_ssl_method(ret, s->method))
3594 if (s->cert != NULL) {
3595 ssl_cert_free(ret->cert);
3596 ret->cert = ssl_cert_dup(s->cert);
3597 if (ret->cert == NULL)
3601 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3602 (int)s->sid_ctx_length))
3606 if (!ssl_dane_dup(ret, s))
3608 ret->version = s->version;
3609 ret->options = s->options;
3610 ret->mode = s->mode;
3611 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3612 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3613 ret->msg_callback = s->msg_callback;
3614 ret->msg_callback_arg = s->msg_callback_arg;
3615 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3616 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3617 ret->generate_session_id = s->generate_session_id;
3619 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3621 /* copy app data, a little dangerous perhaps */
3622 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3625 /* setup rbio, and wbio */
3626 if (s->rbio != NULL) {
3627 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3630 if (s->wbio != NULL) {
3631 if (s->wbio != s->rbio) {
3632 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3635 BIO_up_ref(ret->rbio);
3636 ret->wbio = ret->rbio;
3640 ret->server = s->server;
3641 if (s->handshake_func) {
3643 SSL_set_accept_state(ret);
3645 SSL_set_connect_state(ret);
3647 ret->shutdown = s->shutdown;
3650 ret->default_passwd_callback = s->default_passwd_callback;
3651 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3653 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3655 /* dup the cipher_list and cipher_list_by_id stacks */
3656 if (s->cipher_list != NULL) {
3657 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3660 if (s->cipher_list_by_id != NULL)
3661 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3665 /* Dup the client_CA list */
3666 if (s->ca_names != NULL) {
3667 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3670 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3671 xn = sk_X509_NAME_value(sk, i);
3672 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3685 void ssl_clear_cipher_ctx(SSL *s)
3687 if (s->enc_read_ctx != NULL) {
3688 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3689 s->enc_read_ctx = NULL;
3691 if (s->enc_write_ctx != NULL) {
3692 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3693 s->enc_write_ctx = NULL;
3695 #ifndef OPENSSL_NO_COMP
3696 COMP_CTX_free(s->expand);
3698 COMP_CTX_free(s->compress);
3703 X509 *SSL_get_certificate(const SSL *s)
3705 if (s->cert != NULL)
3706 return s->cert->key->x509;
3711 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3713 if (s->cert != NULL)
3714 return s->cert->key->privatekey;
3719 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3721 if (ctx->cert != NULL)
3722 return ctx->cert->key->x509;
3727 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3729 if (ctx->cert != NULL)
3730 return ctx->cert->key->privatekey;
3735 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3737 if ((s->session != NULL) && (s->session->cipher != NULL))
3738 return s->session->cipher;
3742 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3744 return s->s3->tmp.new_cipher;
3747 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3749 #ifndef OPENSSL_NO_COMP
3750 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3756 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3758 #ifndef OPENSSL_NO_COMP
3759 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3765 int ssl_init_wbio_buffer(SSL *s)
3769 if (s->bbio != NULL) {
3770 /* Already buffered. */
3774 bbio = BIO_new(BIO_f_buffer());
3775 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3777 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3781 s->wbio = BIO_push(bbio, s->wbio);
3786 int ssl_free_wbio_buffer(SSL *s)
3788 /* callers ensure s is never null */
3789 if (s->bbio == NULL)
3792 s->wbio = BIO_pop(s->wbio);
3793 if (!ossl_assert(s->wbio != NULL))
3801 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3803 ctx->quiet_shutdown = mode;
3806 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3808 return ctx->quiet_shutdown;
3811 void SSL_set_quiet_shutdown(SSL *s, int mode)
3813 s->quiet_shutdown = mode;
3816 int SSL_get_quiet_shutdown(const SSL *s)
3818 return s->quiet_shutdown;
3821 void SSL_set_shutdown(SSL *s, int mode)
3826 int SSL_get_shutdown(const SSL *s)
3831 int SSL_version(const SSL *s)
3836 int SSL_client_version(const SSL *s)
3838 return s->client_version;
3841 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3846 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3849 if (ssl->ctx == ctx)
3852 ctx = ssl->session_ctx;
3853 new_cert = ssl_cert_dup(ctx->cert);
3854 if (new_cert == NULL) {
3858 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3859 ssl_cert_free(new_cert);
3863 ssl_cert_free(ssl->cert);
3864 ssl->cert = new_cert;
3867 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3868 * so setter APIs must prevent invalid lengths from entering the system.
3870 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3874 * If the session ID context matches that of the parent SSL_CTX,
3875 * inherit it from the new SSL_CTX as well. If however the context does
3876 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3877 * leave it unchanged.
3879 if ((ssl->ctx != NULL) &&
3880 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3881 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3882 ssl->sid_ctx_length = ctx->sid_ctx_length;
3883 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3886 SSL_CTX_up_ref(ctx);
3887 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3893 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3895 return X509_STORE_set_default_paths(ctx->cert_store);
3898 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3900 X509_LOOKUP *lookup;
3902 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3905 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3907 /* Clear any errors if the default directory does not exist */
3913 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3915 X509_LOOKUP *lookup;
3917 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3921 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3923 /* Clear any errors if the default file does not exist */
3929 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3932 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
3935 void SSL_set_info_callback(SSL *ssl,
3936 void (*cb) (const SSL *ssl, int type, int val))
3938 ssl->info_callback = cb;
3942 * One compiler (Diab DCC) doesn't like argument names in returned function
3945 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3948 return ssl->info_callback;
3951 void SSL_set_verify_result(SSL *ssl, long arg)
3953 ssl->verify_result = arg;
3956 long SSL_get_verify_result(const SSL *ssl)
3958 return ssl->verify_result;
3961 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3964 return sizeof(ssl->s3->client_random);
3965 if (outlen > sizeof(ssl->s3->client_random))
3966 outlen = sizeof(ssl->s3->client_random);
3967 memcpy(out, ssl->s3->client_random, outlen);
3971 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3974 return sizeof(ssl->s3->server_random);
3975 if (outlen > sizeof(ssl->s3->server_random))
3976 outlen = sizeof(ssl->s3->server_random);
3977 memcpy(out, ssl->s3->server_random, outlen);
3981 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3982 unsigned char *out, size_t outlen)
3985 return session->master_key_length;
3986 if (outlen > session->master_key_length)
3987 outlen = session->master_key_length;
3988 memcpy(out, session->master_key, outlen);