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);
1189 OPENSSL_free(s->pha_context);
1190 EVP_MD_CTX_free(s->pha_dgst);
1192 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1194 sk_X509_pop_free(s->verified_chain, X509_free);
1196 if (s->method != NULL)
1197 s->method->ssl_free(s);
1199 RECORD_LAYER_release(&s->rlayer);
1201 SSL_CTX_free(s->ctx);
1203 ASYNC_WAIT_CTX_free(s->waitctx);
1205 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1206 OPENSSL_free(s->ext.npn);
1209 #ifndef OPENSSL_NO_SRTP
1210 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1213 RAND_DRBG_free(s->drbg);
1214 CRYPTO_THREAD_lock_free(s->lock);
1219 void SSL_set0_rbio(SSL *s, BIO *rbio)
1221 BIO_free_all(s->rbio);
1225 void SSL_set0_wbio(SSL *s, BIO *wbio)
1228 * If the output buffering BIO is still in place, remove it
1230 if (s->bbio != NULL)
1231 s->wbio = BIO_pop(s->wbio);
1233 BIO_free_all(s->wbio);
1236 /* Re-attach |bbio| to the new |wbio|. */
1237 if (s->bbio != NULL)
1238 s->wbio = BIO_push(s->bbio, s->wbio);
1241 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1244 * For historical reasons, this function has many different cases in
1245 * ownership handling.
1248 /* If nothing has changed, do nothing */
1249 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1253 * If the two arguments are equal then one fewer reference is granted by the
1254 * caller than we want to take
1256 if (rbio != NULL && rbio == wbio)
1260 * If only the wbio is changed only adopt one reference.
1262 if (rbio == SSL_get_rbio(s)) {
1263 SSL_set0_wbio(s, wbio);
1267 * There is an asymmetry here for historical reasons. If only the rbio is
1268 * changed AND the rbio and wbio were originally different, then we only
1269 * adopt one reference.
1271 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1272 SSL_set0_rbio(s, rbio);
1276 /* Otherwise, adopt both references. */
1277 SSL_set0_rbio(s, rbio);
1278 SSL_set0_wbio(s, wbio);
1281 BIO *SSL_get_rbio(const SSL *s)
1286 BIO *SSL_get_wbio(const SSL *s)
1288 if (s->bbio != NULL) {
1290 * If |bbio| is active, the true caller-configured BIO is its
1293 return BIO_next(s->bbio);
1298 int SSL_get_fd(const SSL *s)
1300 return SSL_get_rfd(s);
1303 int SSL_get_rfd(const SSL *s)
1308 b = SSL_get_rbio(s);
1309 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1311 BIO_get_fd(r, &ret);
1315 int SSL_get_wfd(const SSL *s)
1320 b = SSL_get_wbio(s);
1321 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1323 BIO_get_fd(r, &ret);
1327 #ifndef OPENSSL_NO_SOCK
1328 int SSL_set_fd(SSL *s, int fd)
1333 bio = BIO_new(BIO_s_socket());
1336 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1339 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1340 SSL_set_bio(s, bio, bio);
1346 int SSL_set_wfd(SSL *s, int fd)
1348 BIO *rbio = SSL_get_rbio(s);
1350 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1351 || (int)BIO_get_fd(rbio, NULL) != fd) {
1352 BIO *bio = BIO_new(BIO_s_socket());
1355 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1358 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1359 SSL_set0_wbio(s, bio);
1362 SSL_set0_wbio(s, rbio);
1367 int SSL_set_rfd(SSL *s, int fd)
1369 BIO *wbio = SSL_get_wbio(s);
1371 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1372 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1373 BIO *bio = BIO_new(BIO_s_socket());
1376 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1379 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1380 SSL_set0_rbio(s, bio);
1383 SSL_set0_rbio(s, wbio);
1390 /* return length of latest Finished message we sent, copy to 'buf' */
1391 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1395 if (s->s3 != NULL) {
1396 ret = s->s3->tmp.finish_md_len;
1399 memcpy(buf, s->s3->tmp.finish_md, count);
1404 /* return length of latest Finished message we expected, copy to 'buf' */
1405 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1409 if (s->s3 != NULL) {
1410 ret = s->s3->tmp.peer_finish_md_len;
1413 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1418 int SSL_get_verify_mode(const SSL *s)
1420 return s->verify_mode;
1423 int SSL_get_verify_depth(const SSL *s)
1425 return X509_VERIFY_PARAM_get_depth(s->param);
1428 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1429 return s->verify_callback;
1432 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1434 return ctx->verify_mode;
1437 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1439 return X509_VERIFY_PARAM_get_depth(ctx->param);
1442 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1443 return ctx->default_verify_callback;
1446 void SSL_set_verify(SSL *s, int mode,
1447 int (*callback) (int ok, X509_STORE_CTX *ctx))
1449 s->verify_mode = mode;
1450 if (callback != NULL)
1451 s->verify_callback = callback;
1454 void SSL_set_verify_depth(SSL *s, int depth)
1456 X509_VERIFY_PARAM_set_depth(s->param, depth);
1459 void SSL_set_read_ahead(SSL *s, int yes)
1461 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1464 int SSL_get_read_ahead(const SSL *s)
1466 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1469 int SSL_pending(const SSL *s)
1471 size_t pending = s->method->ssl_pending(s);
1474 * SSL_pending cannot work properly if read-ahead is enabled
1475 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1476 * impossible to fix since SSL_pending cannot report errors that may be
1477 * observed while scanning the new data. (Note that SSL_pending() is
1478 * often used as a boolean value, so we'd better not return -1.)
1480 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1481 * we just return INT_MAX.
1483 return pending < INT_MAX ? (int)pending : INT_MAX;
1486 int SSL_has_pending(const SSL *s)
1489 * Similar to SSL_pending() but returns a 1 to indicate that we have
1490 * unprocessed data available or 0 otherwise (as opposed to the number of
1491 * bytes available). Unlike SSL_pending() this will take into account
1492 * read_ahead data. A 1 return simply indicates that we have unprocessed
1493 * data. That data may not result in any application data, or we may fail
1494 * to parse the records for some reason.
1496 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1499 return RECORD_LAYER_read_pending(&s->rlayer);
1502 X509 *SSL_get_peer_certificate(const SSL *s)
1506 if ((s == NULL) || (s->session == NULL))
1509 r = s->session->peer;
1519 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1523 if ((s == NULL) || (s->session == NULL))
1526 r = s->session->peer_chain;
1529 * If we are a client, cert_chain includes the peer's own certificate; if
1530 * we are a server, it does not.
1537 * Now in theory, since the calling process own 't' it should be safe to
1538 * modify. We need to be able to read f without being hassled
1540 int SSL_copy_session_id(SSL *t, const SSL *f)
1543 /* Do we need to to SSL locking? */
1544 if (!SSL_set_session(t, SSL_get_session(f))) {
1549 * what if we are setup for one protocol version but want to talk another
1551 if (t->method != f->method) {
1552 t->method->ssl_free(t);
1553 t->method = f->method;
1554 if (t->method->ssl_new(t) == 0)
1558 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1559 ssl_cert_free(t->cert);
1561 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1568 /* Fix this so it checks all the valid key/cert options */
1569 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1571 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1572 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1575 if (ctx->cert->key->privatekey == NULL) {
1576 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1579 return X509_check_private_key
1580 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1583 /* Fix this function so that it takes an optional type parameter */
1584 int SSL_check_private_key(const SSL *ssl)
1587 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1590 if (ssl->cert->key->x509 == NULL) {
1591 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1594 if (ssl->cert->key->privatekey == NULL) {
1595 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1598 return X509_check_private_key(ssl->cert->key->x509,
1599 ssl->cert->key->privatekey);
1602 int SSL_waiting_for_async(SSL *s)
1610 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1612 ASYNC_WAIT_CTX *ctx = s->waitctx;
1616 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1619 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1620 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1622 ASYNC_WAIT_CTX *ctx = s->waitctx;
1626 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1630 int SSL_accept(SSL *s)
1632 if (s->handshake_func == NULL) {
1633 /* Not properly initialized yet */
1634 SSL_set_accept_state(s);
1637 return SSL_do_handshake(s);
1640 int SSL_connect(SSL *s)
1642 if (s->handshake_func == NULL) {
1643 /* Not properly initialized yet */
1644 SSL_set_connect_state(s);
1647 return SSL_do_handshake(s);
1650 long SSL_get_default_timeout(const SSL *s)
1652 return s->method->get_timeout();
1655 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1656 int (*func) (void *))
1659 if (s->waitctx == NULL) {
1660 s->waitctx = ASYNC_WAIT_CTX_new();
1661 if (s->waitctx == NULL)
1664 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1665 sizeof(struct ssl_async_args))) {
1667 s->rwstate = SSL_NOTHING;
1668 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1671 s->rwstate = SSL_ASYNC_PAUSED;
1674 s->rwstate = SSL_ASYNC_NO_JOBS;
1680 s->rwstate = SSL_NOTHING;
1681 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1682 /* Shouldn't happen */
1687 static int ssl_io_intern(void *vargs)
1689 struct ssl_async_args *args;
1694 args = (struct ssl_async_args *)vargs;
1698 switch (args->type) {
1700 return args->f.func_read(s, buf, num, &s->asyncrw);
1702 return args->f.func_write(s, buf, num, &s->asyncrw);
1704 return args->f.func_other(s);
1709 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1711 if (s->handshake_func == NULL) {
1712 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1716 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1717 s->rwstate = SSL_NOTHING;
1721 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1722 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1723 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1727 * If we are a client and haven't received the ServerHello etc then we
1730 ossl_statem_check_finish_init(s, 0);
1732 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1733 struct ssl_async_args args;
1739 args.type = READFUNC;
1740 args.f.func_read = s->method->ssl_read;
1742 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1743 *readbytes = s->asyncrw;
1746 return s->method->ssl_read(s, buf, num, readbytes);
1750 int SSL_read(SSL *s, void *buf, int num)
1756 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1760 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1763 * The cast is safe here because ret should be <= INT_MAX because num is
1767 ret = (int)readbytes;
1772 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1774 int ret = ssl_read_internal(s, buf, num, readbytes);
1781 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1786 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1787 return SSL_READ_EARLY_DATA_ERROR;
1790 switch (s->early_data_state) {
1791 case SSL_EARLY_DATA_NONE:
1792 if (!SSL_in_before(s)) {
1793 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1794 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1795 return SSL_READ_EARLY_DATA_ERROR;
1799 case SSL_EARLY_DATA_ACCEPT_RETRY:
1800 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1801 ret = SSL_accept(s);
1804 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1805 return SSL_READ_EARLY_DATA_ERROR;
1809 case SSL_EARLY_DATA_READ_RETRY:
1810 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1811 s->early_data_state = SSL_EARLY_DATA_READING;
1812 ret = SSL_read_ex(s, buf, num, readbytes);
1814 * State machine will update early_data_state to
1815 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1818 if (ret > 0 || (ret <= 0 && s->early_data_state
1819 != SSL_EARLY_DATA_FINISHED_READING)) {
1820 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1821 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1822 : SSL_READ_EARLY_DATA_ERROR;
1825 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1828 return SSL_READ_EARLY_DATA_FINISH;
1831 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1832 return SSL_READ_EARLY_DATA_ERROR;
1836 int SSL_get_early_data_status(const SSL *s)
1838 return s->ext.early_data;
1841 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1843 if (s->handshake_func == NULL) {
1844 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1848 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1851 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1852 struct ssl_async_args args;
1858 args.type = READFUNC;
1859 args.f.func_read = s->method->ssl_peek;
1861 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1862 *readbytes = s->asyncrw;
1865 return s->method->ssl_peek(s, buf, num, readbytes);
1869 int SSL_peek(SSL *s, void *buf, int num)
1875 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1879 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1882 * The cast is safe here because ret should be <= INT_MAX because num is
1886 ret = (int)readbytes;
1892 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1894 int ret = ssl_peek_internal(s, buf, num, readbytes);
1901 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1903 if (s->handshake_func == NULL) {
1904 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1908 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1909 s->rwstate = SSL_NOTHING;
1910 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1914 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1915 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1916 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1917 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1920 /* If we are a client and haven't sent the Finished we better do that */
1921 ossl_statem_check_finish_init(s, 1);
1923 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1925 struct ssl_async_args args;
1928 args.buf = (void *)buf;
1930 args.type = WRITEFUNC;
1931 args.f.func_write = s->method->ssl_write;
1933 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1934 *written = s->asyncrw;
1937 return s->method->ssl_write(s, buf, num, written);
1941 int SSL_write(SSL *s, const void *buf, int num)
1947 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1951 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1954 * The cast is safe here because ret should be <= INT_MAX because num is
1963 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1965 int ret = ssl_write_internal(s, buf, num, written);
1972 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1974 int ret, early_data_state;
1976 uint32_t partialwrite;
1978 switch (s->early_data_state) {
1979 case SSL_EARLY_DATA_NONE:
1981 || !SSL_in_before(s)
1982 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1983 && (s->psk_use_session_cb == NULL))) {
1984 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1985 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1990 case SSL_EARLY_DATA_CONNECT_RETRY:
1991 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1992 ret = SSL_connect(s);
1995 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2000 case SSL_EARLY_DATA_WRITE_RETRY:
2001 s->early_data_state = SSL_EARLY_DATA_WRITING;
2003 * We disable partial write for early data because we don't keep track
2004 * of how many bytes we've written between the SSL_write_ex() call and
2005 * the flush if the flush needs to be retried)
2007 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2008 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2009 ret = SSL_write_ex(s, buf, num, &writtmp);
2010 s->mode |= partialwrite;
2012 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2015 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2018 case SSL_EARLY_DATA_WRITE_FLUSH:
2019 /* The buffering BIO is still in place so we need to flush it */
2020 if (statem_flush(s) != 1)
2023 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2026 case SSL_EARLY_DATA_FINISHED_READING:
2027 case SSL_EARLY_DATA_READ_RETRY:
2028 early_data_state = s->early_data_state;
2029 /* We are a server writing to an unauthenticated client */
2030 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2031 ret = SSL_write_ex(s, buf, num, written);
2032 s->early_data_state = early_data_state;
2036 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2041 int SSL_shutdown(SSL *s)
2044 * Note that this function behaves differently from what one might
2045 * expect. Return values are 0 for no success (yet), 1 for success; but
2046 * calling it once is usually not enough, even if blocking I/O is used
2047 * (see ssl3_shutdown).
2050 if (s->handshake_func == NULL) {
2051 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2055 if (!SSL_in_init(s)) {
2056 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2057 struct ssl_async_args args;
2060 args.type = OTHERFUNC;
2061 args.f.func_other = s->method->ssl_shutdown;
2063 return ssl_start_async_job(s, &args, ssl_io_intern);
2065 return s->method->ssl_shutdown(s);
2068 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2073 int SSL_key_update(SSL *s, int updatetype)
2076 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2077 * negotiated, and that it is appropriate to call SSL_key_update() instead
2078 * of SSL_renegotiate().
2080 if (!SSL_IS_TLS13(s)) {
2081 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2085 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2086 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2087 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2091 if (!SSL_is_init_finished(s)) {
2092 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2096 ossl_statem_set_in_init(s, 1);
2097 s->key_update = updatetype;
2101 int SSL_get_key_update_type(SSL *s)
2103 return s->key_update;
2106 int SSL_renegotiate(SSL *s)
2108 if (SSL_IS_TLS13(s)) {
2109 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2113 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2114 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2121 return s->method->ssl_renegotiate(s);
2124 int SSL_renegotiate_abbreviated(SSL *s)
2126 if (SSL_IS_TLS13(s)) {
2127 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2131 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2132 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2139 return s->method->ssl_renegotiate(s);
2142 int SSL_renegotiate_pending(SSL *s)
2145 * becomes true when negotiation is requested; false again once a
2146 * handshake has finished
2148 return (s->renegotiate != 0);
2151 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2156 case SSL_CTRL_GET_READ_AHEAD:
2157 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2158 case SSL_CTRL_SET_READ_AHEAD:
2159 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2160 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2163 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2164 s->msg_callback_arg = parg;
2168 return (s->mode |= larg);
2169 case SSL_CTRL_CLEAR_MODE:
2170 return (s->mode &= ~larg);
2171 case SSL_CTRL_GET_MAX_CERT_LIST:
2172 return (long)s->max_cert_list;
2173 case SSL_CTRL_SET_MAX_CERT_LIST:
2176 l = (long)s->max_cert_list;
2177 s->max_cert_list = (size_t)larg;
2179 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2180 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2182 s->max_send_fragment = larg;
2183 if (s->max_send_fragment < s->split_send_fragment)
2184 s->split_send_fragment = s->max_send_fragment;
2186 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2187 if ((size_t)larg > s->max_send_fragment || larg == 0)
2189 s->split_send_fragment = larg;
2191 case SSL_CTRL_SET_MAX_PIPELINES:
2192 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2194 s->max_pipelines = larg;
2196 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2198 case SSL_CTRL_GET_RI_SUPPORT:
2200 return s->s3->send_connection_binding;
2203 case SSL_CTRL_CERT_FLAGS:
2204 return (s->cert->cert_flags |= larg);
2205 case SSL_CTRL_CLEAR_CERT_FLAGS:
2206 return (s->cert->cert_flags &= ~larg);
2208 case SSL_CTRL_GET_RAW_CIPHERLIST:
2210 if (s->s3->tmp.ciphers_raw == NULL)
2212 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2213 return (int)s->s3->tmp.ciphers_rawlen;
2215 return TLS_CIPHER_LEN;
2217 case SSL_CTRL_GET_EXTMS_SUPPORT:
2218 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2220 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2224 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2225 return ssl_check_allowed_versions(larg, s->max_proto_version)
2226 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2227 &s->min_proto_version);
2228 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2229 return s->min_proto_version;
2230 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2231 return ssl_check_allowed_versions(s->min_proto_version, larg)
2232 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2233 &s->max_proto_version);
2234 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2235 return s->max_proto_version;
2237 return s->method->ssl_ctrl(s, cmd, larg, parg);
2241 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2244 case SSL_CTRL_SET_MSG_CALLBACK:
2245 s->msg_callback = (void (*)
2246 (int write_p, int version, int content_type,
2247 const void *buf, size_t len, SSL *ssl,
2252 return s->method->ssl_callback_ctrl(s, cmd, fp);
2256 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2258 return ctx->sessions;
2261 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2265 /* For some cases with ctx == NULL perform syntax checks */
2268 #ifndef OPENSSL_NO_EC
2269 case SSL_CTRL_SET_GROUPS_LIST:
2270 return tls1_set_groups_list(NULL, NULL, parg);
2272 case SSL_CTRL_SET_SIGALGS_LIST:
2273 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2274 return tls1_set_sigalgs_list(NULL, parg, 0);
2281 case SSL_CTRL_GET_READ_AHEAD:
2282 return ctx->read_ahead;
2283 case SSL_CTRL_SET_READ_AHEAD:
2284 l = ctx->read_ahead;
2285 ctx->read_ahead = larg;
2288 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2289 ctx->msg_callback_arg = parg;
2292 case SSL_CTRL_GET_MAX_CERT_LIST:
2293 return (long)ctx->max_cert_list;
2294 case SSL_CTRL_SET_MAX_CERT_LIST:
2297 l = (long)ctx->max_cert_list;
2298 ctx->max_cert_list = (size_t)larg;
2301 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2304 l = (long)ctx->session_cache_size;
2305 ctx->session_cache_size = (size_t)larg;
2307 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2308 return (long)ctx->session_cache_size;
2309 case SSL_CTRL_SET_SESS_CACHE_MODE:
2310 l = ctx->session_cache_mode;
2311 ctx->session_cache_mode = larg;
2313 case SSL_CTRL_GET_SESS_CACHE_MODE:
2314 return ctx->session_cache_mode;
2316 case SSL_CTRL_SESS_NUMBER:
2317 return lh_SSL_SESSION_num_items(ctx->sessions);
2318 case SSL_CTRL_SESS_CONNECT:
2319 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2321 case SSL_CTRL_SESS_CONNECT_GOOD:
2322 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2324 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2325 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2328 case SSL_CTRL_SESS_ACCEPT:
2329 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2331 case SSL_CTRL_SESS_ACCEPT_GOOD:
2332 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2334 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2335 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2338 case SSL_CTRL_SESS_HIT:
2339 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2341 case SSL_CTRL_SESS_CB_HIT:
2342 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2344 case SSL_CTRL_SESS_MISSES:
2345 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2347 case SSL_CTRL_SESS_TIMEOUTS:
2348 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2350 case SSL_CTRL_SESS_CACHE_FULL:
2351 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2354 return (ctx->mode |= larg);
2355 case SSL_CTRL_CLEAR_MODE:
2356 return (ctx->mode &= ~larg);
2357 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2358 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2360 ctx->max_send_fragment = larg;
2361 if (ctx->max_send_fragment < ctx->split_send_fragment)
2362 ctx->split_send_fragment = ctx->max_send_fragment;
2364 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2365 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2367 ctx->split_send_fragment = larg;
2369 case SSL_CTRL_SET_MAX_PIPELINES:
2370 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2372 ctx->max_pipelines = larg;
2374 case SSL_CTRL_CERT_FLAGS:
2375 return (ctx->cert->cert_flags |= larg);
2376 case SSL_CTRL_CLEAR_CERT_FLAGS:
2377 return (ctx->cert->cert_flags &= ~larg);
2378 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2379 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2380 && ssl_set_version_bound(ctx->method->version, (int)larg,
2381 &ctx->min_proto_version);
2382 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2383 return ctx->min_proto_version;
2384 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2385 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2386 && ssl_set_version_bound(ctx->method->version, (int)larg,
2387 &ctx->max_proto_version);
2388 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2389 return ctx->max_proto_version;
2391 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2395 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2398 case SSL_CTRL_SET_MSG_CALLBACK:
2399 ctx->msg_callback = (void (*)
2400 (int write_p, int version, int content_type,
2401 const void *buf, size_t len, SSL *ssl,
2406 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2410 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2419 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2420 const SSL_CIPHER *const *bp)
2422 if ((*ap)->id > (*bp)->id)
2424 if ((*ap)->id < (*bp)->id)
2429 /** return a STACK of the ciphers available for the SSL and in order of
2431 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2434 if (s->cipher_list != NULL) {
2435 return s->cipher_list;
2436 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2437 return s->ctx->cipher_list;
2443 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2445 if ((s == NULL) || (s->session == NULL) || !s->server)
2447 return s->session->ciphers;
2450 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2452 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2454 ciphers = SSL_get_ciphers(s);
2457 ssl_set_client_disabled(s);
2458 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2459 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2460 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2462 sk = sk_SSL_CIPHER_new_null();
2465 if (!sk_SSL_CIPHER_push(sk, c)) {
2466 sk_SSL_CIPHER_free(sk);
2474 /** return a STACK of the ciphers available for the SSL and in order of
2476 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2479 if (s->cipher_list_by_id != NULL) {
2480 return s->cipher_list_by_id;
2481 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2482 return s->ctx->cipher_list_by_id;
2488 /** The old interface to get the same thing as SSL_get_ciphers() */
2489 const char *SSL_get_cipher_list(const SSL *s, int n)
2491 const SSL_CIPHER *c;
2492 STACK_OF(SSL_CIPHER) *sk;
2496 sk = SSL_get_ciphers(s);
2497 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2499 c = sk_SSL_CIPHER_value(sk, n);
2505 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2507 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2510 return ctx->cipher_list;
2514 /** specify the ciphers to be used by default by the SSL_CTX */
2515 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2517 STACK_OF(SSL_CIPHER) *sk;
2519 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2520 &ctx->cipher_list_by_id, str, ctx->cert);
2522 * ssl_create_cipher_list may return an empty stack if it was unable to
2523 * find a cipher matching the given rule string (for example if the rule
2524 * string specifies a cipher which has been disabled). This is not an
2525 * error as far as ssl_create_cipher_list is concerned, and hence
2526 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2530 else if (sk_SSL_CIPHER_num(sk) == 0) {
2531 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2537 /** specify the ciphers to be used by the SSL */
2538 int SSL_set_cipher_list(SSL *s, const char *str)
2540 STACK_OF(SSL_CIPHER) *sk;
2542 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2543 &s->cipher_list_by_id, str, s->cert);
2544 /* see comment in SSL_CTX_set_cipher_list */
2547 else if (sk_SSL_CIPHER_num(sk) == 0) {
2548 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2554 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2557 STACK_OF(SSL_CIPHER) *sk;
2558 const SSL_CIPHER *c;
2561 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2565 sk = s->session->ciphers;
2567 if (sk_SSL_CIPHER_num(sk) == 0)
2570 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2573 c = sk_SSL_CIPHER_value(sk, i);
2574 n = strlen(c->name);
2590 /** return a servername extension value if provided in Client Hello, or NULL.
2591 * So far, only host_name types are defined (RFC 3546).
2594 const char *SSL_get_servername(const SSL *s, const int type)
2596 if (type != TLSEXT_NAMETYPE_host_name)
2599 return s->session && !s->ext.hostname ?
2600 s->session->ext.hostname : s->ext.hostname;
2603 int SSL_get_servername_type(const SSL *s)
2606 && (!s->ext.hostname ? s->session->
2607 ext.hostname : s->ext.hostname))
2608 return TLSEXT_NAMETYPE_host_name;
2613 * SSL_select_next_proto implements the standard protocol selection. It is
2614 * expected that this function is called from the callback set by
2615 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2616 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2617 * not included in the length. A byte string of length 0 is invalid. No byte
2618 * string may be truncated. The current, but experimental algorithm for
2619 * selecting the protocol is: 1) If the server doesn't support NPN then this
2620 * is indicated to the callback. In this case, the client application has to
2621 * abort the connection or have a default application level protocol. 2) If
2622 * the server supports NPN, but advertises an empty list then the client
2623 * selects the first protocol in its list, but indicates via the API that this
2624 * fallback case was enacted. 3) Otherwise, the client finds the first
2625 * protocol in the server's list that it supports and selects this protocol.
2626 * This is because it's assumed that the server has better information about
2627 * which protocol a client should use. 4) If the client doesn't support any
2628 * of the server's advertised protocols, then this is treated the same as
2629 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2630 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2632 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2633 const unsigned char *server,
2634 unsigned int server_len,
2635 const unsigned char *client, unsigned int client_len)
2638 const unsigned char *result;
2639 int status = OPENSSL_NPN_UNSUPPORTED;
2642 * For each protocol in server preference order, see if we support it.
2644 for (i = 0; i < server_len;) {
2645 for (j = 0; j < client_len;) {
2646 if (server[i] == client[j] &&
2647 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2648 /* We found a match */
2649 result = &server[i];
2650 status = OPENSSL_NPN_NEGOTIATED;
2660 /* There's no overlap between our protocols and the server's list. */
2662 status = OPENSSL_NPN_NO_OVERLAP;
2665 *out = (unsigned char *)result + 1;
2666 *outlen = result[0];
2670 #ifndef OPENSSL_NO_NEXTPROTONEG
2672 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2673 * client's requested protocol for this connection and returns 0. If the
2674 * client didn't request any protocol, then *data is set to NULL. Note that
2675 * the client can request any protocol it chooses. The value returned from
2676 * this function need not be a member of the list of supported protocols
2677 * provided by the callback.
2679 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2686 *len = (unsigned int)s->ext.npn_len;
2691 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2692 * a TLS server needs a list of supported protocols for Next Protocol
2693 * Negotiation. The returned list must be in wire format. The list is
2694 * returned by setting |out| to point to it and |outlen| to its length. This
2695 * memory will not be modified, but one should assume that the SSL* keeps a
2696 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2697 * wishes to advertise. Otherwise, no such extension will be included in the
2700 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2701 SSL_CTX_npn_advertised_cb_func cb,
2704 ctx->ext.npn_advertised_cb = cb;
2705 ctx->ext.npn_advertised_cb_arg = arg;
2709 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2710 * client needs to select a protocol from the server's provided list. |out|
2711 * must be set to point to the selected protocol (which may be within |in|).
2712 * The length of the protocol name must be written into |outlen|. The
2713 * server's advertised protocols are provided in |in| and |inlen|. The
2714 * callback can assume that |in| is syntactically valid. The client must
2715 * select a protocol. It is fatal to the connection if this callback returns
2716 * a value other than SSL_TLSEXT_ERR_OK.
2718 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2719 SSL_CTX_npn_select_cb_func cb,
2722 ctx->ext.npn_select_cb = cb;
2723 ctx->ext.npn_select_cb_arg = arg;
2728 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2729 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2730 * length-prefixed strings). Returns 0 on success.
2732 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2733 unsigned int protos_len)
2735 OPENSSL_free(ctx->ext.alpn);
2736 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2737 if (ctx->ext.alpn == NULL) {
2738 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2741 ctx->ext.alpn_len = protos_len;
2747 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2748 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2749 * length-prefixed strings). Returns 0 on success.
2751 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2752 unsigned int protos_len)
2754 OPENSSL_free(ssl->ext.alpn);
2755 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2756 if (ssl->ext.alpn == NULL) {
2757 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2760 ssl->ext.alpn_len = protos_len;
2766 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2767 * called during ClientHello processing in order to select an ALPN protocol
2768 * from the client's list of offered protocols.
2770 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2771 SSL_CTX_alpn_select_cb_func cb,
2774 ctx->ext.alpn_select_cb = cb;
2775 ctx->ext.alpn_select_cb_arg = arg;
2779 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2780 * On return it sets |*data| to point to |*len| bytes of protocol name
2781 * (not including the leading length-prefix byte). If the server didn't
2782 * respond with a negotiated protocol then |*len| will be zero.
2784 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2789 *data = ssl->s3->alpn_selected;
2793 *len = (unsigned int)ssl->s3->alpn_selected_len;
2796 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2797 const char *label, size_t llen,
2798 const unsigned char *context, size_t contextlen,
2801 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2804 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2806 contextlen, use_context);
2809 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2811 const unsigned char *session_id = a->session_id;
2813 unsigned char tmp_storage[4];
2815 if (a->session_id_length < sizeof(tmp_storage)) {
2816 memset(tmp_storage, 0, sizeof(tmp_storage));
2817 memcpy(tmp_storage, a->session_id, a->session_id_length);
2818 session_id = tmp_storage;
2822 ((unsigned long)session_id[0]) |
2823 ((unsigned long)session_id[1] << 8L) |
2824 ((unsigned long)session_id[2] << 16L) |
2825 ((unsigned long)session_id[3] << 24L);
2830 * NB: If this function (or indeed the hash function which uses a sort of
2831 * coarser function than this one) is changed, ensure
2832 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2833 * being able to construct an SSL_SESSION that will collide with any existing
2834 * session with a matching session ID.
2836 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2838 if (a->ssl_version != b->ssl_version)
2840 if (a->session_id_length != b->session_id_length)
2842 return memcmp(a->session_id, b->session_id, a->session_id_length);
2846 * These wrapper functions should remain rather than redeclaring
2847 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2848 * variable. The reason is that the functions aren't static, they're exposed
2852 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2854 SSL_CTX *ret = NULL;
2857 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2861 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2864 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2865 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2868 ret = OPENSSL_zalloc(sizeof(*ret));
2873 ret->min_proto_version = 0;
2874 ret->max_proto_version = 0;
2875 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2876 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2877 /* We take the system default. */
2878 ret->session_timeout = meth->get_timeout();
2879 ret->references = 1;
2880 ret->lock = CRYPTO_THREAD_lock_new();
2881 if (ret->lock == NULL) {
2882 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2886 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2887 ret->verify_mode = SSL_VERIFY_NONE;
2888 if ((ret->cert = ssl_cert_new()) == NULL)
2891 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2892 if (ret->sessions == NULL)
2894 ret->cert_store = X509_STORE_new();
2895 if (ret->cert_store == NULL)
2897 #ifndef OPENSSL_NO_CT
2898 ret->ctlog_store = CTLOG_STORE_new();
2899 if (ret->ctlog_store == NULL)
2902 if (!ssl_create_cipher_list(ret->method,
2903 &ret->cipher_list, &ret->cipher_list_by_id,
2904 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2905 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2906 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2910 ret->param = X509_VERIFY_PARAM_new();
2911 if (ret->param == NULL)
2914 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2915 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2918 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2919 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2923 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2926 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2929 /* No compression for DTLS */
2930 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2931 ret->comp_methods = SSL_COMP_get_compression_methods();
2933 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2934 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2936 /* Setup RFC5077 ticket keys */
2937 if ((RAND_bytes(ret->ext.tick_key_name,
2938 sizeof(ret->ext.tick_key_name)) <= 0)
2939 || (RAND_bytes(ret->ext.tick_hmac_key,
2940 sizeof(ret->ext.tick_hmac_key)) <= 0)
2941 || (RAND_bytes(ret->ext.tick_aes_key,
2942 sizeof(ret->ext.tick_aes_key)) <= 0))
2943 ret->options |= SSL_OP_NO_TICKET;
2945 if (RAND_bytes(ret->ext.cookie_hmac_key,
2946 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2949 #ifndef OPENSSL_NO_SRP
2950 if (!SSL_CTX_SRP_CTX_init(ret))
2953 #ifndef OPENSSL_NO_ENGINE
2954 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2955 # define eng_strx(x) #x
2956 # define eng_str(x) eng_strx(x)
2957 /* Use specific client engine automatically... ignore errors */
2960 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2963 ENGINE_load_builtin_engines();
2964 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2966 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2972 * Default is to connect to non-RI servers. When RI is more widely
2973 * deployed might change this.
2975 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2977 * Disable compression by default to prevent CRIME. Applications can
2978 * re-enable compression by configuring
2979 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2980 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
2981 * middlebox compatibility by default. This may be disabled by default in
2982 * a later OpenSSL version.
2984 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
2986 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2989 * Default max early data is a fully loaded single record. Could be split
2990 * across multiple records in practice
2992 ret->max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
2996 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3002 int SSL_CTX_up_ref(SSL_CTX *ctx)
3006 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3009 REF_PRINT_COUNT("SSL_CTX", ctx);
3010 REF_ASSERT_ISNT(i < 2);
3011 return ((i > 1) ? 1 : 0);
3014 void SSL_CTX_free(SSL_CTX *a)
3021 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3022 REF_PRINT_COUNT("SSL_CTX", a);
3025 REF_ASSERT_ISNT(i < 0);
3027 X509_VERIFY_PARAM_free(a->param);
3028 dane_ctx_final(&a->dane);
3031 * Free internal session cache. However: the remove_cb() may reference
3032 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3033 * after the sessions were flushed.
3034 * As the ex_data handling routines might also touch the session cache,
3035 * the most secure solution seems to be: empty (flush) the cache, then
3036 * free ex_data, then finally free the cache.
3037 * (See ticket [openssl.org #212].)
3039 if (a->sessions != NULL)
3040 SSL_CTX_flush_sessions(a, 0);
3042 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3043 lh_SSL_SESSION_free(a->sessions);
3044 X509_STORE_free(a->cert_store);
3045 #ifndef OPENSSL_NO_CT
3046 CTLOG_STORE_free(a->ctlog_store);
3048 sk_SSL_CIPHER_free(a->cipher_list);
3049 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3050 ssl_cert_free(a->cert);
3051 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3052 sk_X509_pop_free(a->extra_certs, X509_free);
3053 a->comp_methods = NULL;
3054 #ifndef OPENSSL_NO_SRTP
3055 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3057 #ifndef OPENSSL_NO_SRP
3058 SSL_CTX_SRP_CTX_free(a);
3060 #ifndef OPENSSL_NO_ENGINE
3061 ENGINE_finish(a->client_cert_engine);
3064 #ifndef OPENSSL_NO_EC
3065 OPENSSL_free(a->ext.ecpointformats);
3066 OPENSSL_free(a->ext.supportedgroups);
3068 OPENSSL_free(a->ext.alpn);
3070 CRYPTO_THREAD_lock_free(a->lock);
3075 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3077 ctx->default_passwd_callback = cb;
3080 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3082 ctx->default_passwd_callback_userdata = u;
3085 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3087 return ctx->default_passwd_callback;
3090 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3092 return ctx->default_passwd_callback_userdata;
3095 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3097 s->default_passwd_callback = cb;
3100 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3102 s->default_passwd_callback_userdata = u;
3105 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3107 return s->default_passwd_callback;
3110 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3112 return s->default_passwd_callback_userdata;
3115 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3116 int (*cb) (X509_STORE_CTX *, void *),
3119 ctx->app_verify_callback = cb;
3120 ctx->app_verify_arg = arg;
3123 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3124 int (*cb) (int, X509_STORE_CTX *))
3126 ctx->verify_mode = mode;
3127 ctx->default_verify_callback = cb;
3130 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3132 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3135 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3137 ssl_cert_set_cert_cb(c->cert, cb, arg);
3140 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3142 ssl_cert_set_cert_cb(s->cert, cb, arg);
3145 void ssl_set_masks(SSL *s)
3148 uint32_t *pvalid = s->s3->tmp.valid_flags;
3149 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3150 unsigned long mask_k, mask_a;
3151 #ifndef OPENSSL_NO_EC
3152 int have_ecc_cert, ecdsa_ok;
3157 #ifndef OPENSSL_NO_DH
3158 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3163 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3164 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3165 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3166 #ifndef OPENSSL_NO_EC
3167 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3173 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3174 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3177 #ifndef OPENSSL_NO_GOST
3178 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3179 mask_k |= SSL_kGOST;
3180 mask_a |= SSL_aGOST12;
3182 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3183 mask_k |= SSL_kGOST;
3184 mask_a |= SSL_aGOST12;
3186 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3187 mask_k |= SSL_kGOST;
3188 mask_a |= SSL_aGOST01;
3199 * If we only have an RSA-PSS certificate allow RSA authentication
3200 * if TLS 1.2 and peer supports it.
3203 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3204 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3205 && TLS1_get_version(s) == TLS1_2_VERSION))
3212 mask_a |= SSL_aNULL;
3215 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3216 * depending on the key usage extension.
3218 #ifndef OPENSSL_NO_EC
3219 if (have_ecc_cert) {
3221 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3222 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3223 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3226 mask_a |= SSL_aECDSA;
3228 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3229 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3230 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3231 && TLS1_get_version(s) == TLS1_2_VERSION)
3232 mask_a |= SSL_aECDSA;
3235 #ifndef OPENSSL_NO_EC
3236 mask_k |= SSL_kECDHE;
3239 #ifndef OPENSSL_NO_PSK
3242 if (mask_k & SSL_kRSA)
3243 mask_k |= SSL_kRSAPSK;
3244 if (mask_k & SSL_kDHE)
3245 mask_k |= SSL_kDHEPSK;
3246 if (mask_k & SSL_kECDHE)
3247 mask_k |= SSL_kECDHEPSK;
3250 s->s3->tmp.mask_k = mask_k;
3251 s->s3->tmp.mask_a = mask_a;
3254 #ifndef OPENSSL_NO_EC
3256 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3258 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3259 /* key usage, if present, must allow signing */
3260 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3261 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3262 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3266 return 1; /* all checks are ok */
3271 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3272 size_t *serverinfo_length)
3274 CERT_PKEY *cpk = s->s3->tmp.cert;
3275 *serverinfo_length = 0;
3277 if (cpk == NULL || cpk->serverinfo == NULL)
3280 *serverinfo = cpk->serverinfo;
3281 *serverinfo_length = cpk->serverinfo_length;
3285 void ssl_update_cache(SSL *s, int mode)
3290 * If the session_id_length is 0, we are not supposed to cache it, and it
3291 * would be rather hard to do anyway :-)
3293 if (s->session->session_id_length == 0)
3296 i = s->session_ctx->session_cache_mode;
3298 && (!s->hit || SSL_IS_TLS13(s))
3299 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) != 0
3300 || SSL_CTX_add_session(s->session_ctx, s->session))
3301 && s->session_ctx->new_session_cb != NULL) {
3302 SSL_SESSION_up_ref(s->session);
3303 if (!s->session_ctx->new_session_cb(s, s->session))
3304 SSL_SESSION_free(s->session);
3307 /* auto flush every 255 connections */
3308 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3310 if (mode & SSL_SESS_CACHE_CLIENT)
3311 stat = &s->session_ctx->stats.sess_connect_good;
3313 stat = &s->session_ctx->stats.sess_accept_good;
3314 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3315 && (val & 0xff) == 0xff)
3316 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3320 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3325 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3330 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3334 if (s->method != meth) {
3335 const SSL_METHOD *sm = s->method;
3336 int (*hf) (SSL *) = s->handshake_func;
3338 if (sm->version == meth->version)
3343 ret = s->method->ssl_new(s);
3346 if (hf == sm->ssl_connect)
3347 s->handshake_func = meth->ssl_connect;
3348 else if (hf == sm->ssl_accept)
3349 s->handshake_func = meth->ssl_accept;
3354 int SSL_get_error(const SSL *s, int i)
3361 return SSL_ERROR_NONE;
3364 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3365 * where we do encode the error
3367 if ((l = ERR_peek_error()) != 0) {
3368 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3369 return SSL_ERROR_SYSCALL;
3371 return SSL_ERROR_SSL;
3374 if (SSL_want_read(s)) {
3375 bio = SSL_get_rbio(s);
3376 if (BIO_should_read(bio))
3377 return SSL_ERROR_WANT_READ;
3378 else if (BIO_should_write(bio))
3380 * This one doesn't make too much sense ... We never try to write
3381 * to the rbio, and an application program where rbio and wbio
3382 * are separate couldn't even know what it should wait for.
3383 * However if we ever set s->rwstate incorrectly (so that we have
3384 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3385 * wbio *are* the same, this test works around that bug; so it
3386 * might be safer to keep it.
3388 return SSL_ERROR_WANT_WRITE;
3389 else if (BIO_should_io_special(bio)) {
3390 reason = BIO_get_retry_reason(bio);
3391 if (reason == BIO_RR_CONNECT)
3392 return SSL_ERROR_WANT_CONNECT;
3393 else if (reason == BIO_RR_ACCEPT)
3394 return SSL_ERROR_WANT_ACCEPT;
3396 return SSL_ERROR_SYSCALL; /* unknown */
3400 if (SSL_want_write(s)) {
3401 /* Access wbio directly - in order to use the buffered bio if present */
3403 if (BIO_should_write(bio))
3404 return SSL_ERROR_WANT_WRITE;
3405 else if (BIO_should_read(bio))
3407 * See above (SSL_want_read(s) with BIO_should_write(bio))
3409 return SSL_ERROR_WANT_READ;
3410 else if (BIO_should_io_special(bio)) {
3411 reason = BIO_get_retry_reason(bio);
3412 if (reason == BIO_RR_CONNECT)
3413 return SSL_ERROR_WANT_CONNECT;
3414 else if (reason == BIO_RR_ACCEPT)
3415 return SSL_ERROR_WANT_ACCEPT;
3417 return SSL_ERROR_SYSCALL;
3420 if (SSL_want_x509_lookup(s))
3421 return SSL_ERROR_WANT_X509_LOOKUP;
3422 if (SSL_want_async(s))
3423 return SSL_ERROR_WANT_ASYNC;
3424 if (SSL_want_async_job(s))
3425 return SSL_ERROR_WANT_ASYNC_JOB;
3426 if (SSL_want_client_hello_cb(s))
3427 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3429 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3430 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3431 return SSL_ERROR_ZERO_RETURN;
3433 return SSL_ERROR_SYSCALL;
3436 static int ssl_do_handshake_intern(void *vargs)
3438 struct ssl_async_args *args;
3441 args = (struct ssl_async_args *)vargs;
3444 return s->handshake_func(s);
3447 int SSL_do_handshake(SSL *s)
3451 if (s->handshake_func == NULL) {
3452 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3456 ossl_statem_check_finish_init(s, -1);
3458 s->method->ssl_renegotiate_check(s, 0);
3460 if (SSL_is_server(s)) {
3461 /* clear SNI settings at server-side */
3462 OPENSSL_free(s->ext.hostname);
3463 s->ext.hostname = NULL;
3466 if (SSL_in_init(s) || SSL_in_before(s)) {
3467 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3468 struct ssl_async_args args;
3472 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3474 ret = s->handshake_func(s);
3480 void SSL_set_accept_state(SSL *s)
3484 ossl_statem_clear(s);
3485 s->handshake_func = s->method->ssl_accept;
3489 void SSL_set_connect_state(SSL *s)
3493 ossl_statem_clear(s);
3494 s->handshake_func = s->method->ssl_connect;
3498 int ssl_undefined_function(SSL *s)
3500 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3504 int ssl_undefined_void_function(void)
3506 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3507 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3511 int ssl_undefined_const_function(const SSL *s)
3516 const SSL_METHOD *ssl_bad_method(int ver)
3518 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3522 const char *ssl_protocol_to_string(int version)
3526 case TLS1_3_VERSION:
3529 case TLS1_2_VERSION:
3532 case TLS1_1_VERSION:
3547 case DTLS1_2_VERSION:
3555 const char *SSL_get_version(const SSL *s)
3557 return ssl_protocol_to_string(s->version);
3560 SSL *SSL_dup(SSL *s)
3562 STACK_OF(X509_NAME) *sk;
3567 /* If we're not quiescent, just up_ref! */
3568 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3569 CRYPTO_UP_REF(&s->references, &i, s->lock);
3574 * Otherwise, copy configuration state, and session if set.
3576 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3579 if (s->session != NULL) {
3581 * Arranges to share the same session via up_ref. This "copies"
3582 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3584 if (!SSL_copy_session_id(ret, s))
3588 * No session has been established yet, so we have to expect that
3589 * s->cert or ret->cert will be changed later -- they should not both
3590 * point to the same object, and thus we can't use
3591 * SSL_copy_session_id.
3593 if (!SSL_set_ssl_method(ret, s->method))
3596 if (s->cert != NULL) {
3597 ssl_cert_free(ret->cert);
3598 ret->cert = ssl_cert_dup(s->cert);
3599 if (ret->cert == NULL)
3603 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3604 (int)s->sid_ctx_length))
3608 if (!ssl_dane_dup(ret, s))
3610 ret->version = s->version;
3611 ret->options = s->options;
3612 ret->mode = s->mode;
3613 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3614 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3615 ret->msg_callback = s->msg_callback;
3616 ret->msg_callback_arg = s->msg_callback_arg;
3617 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3618 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3619 ret->generate_session_id = s->generate_session_id;
3621 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3623 /* copy app data, a little dangerous perhaps */
3624 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3627 /* setup rbio, and wbio */
3628 if (s->rbio != NULL) {
3629 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3632 if (s->wbio != NULL) {
3633 if (s->wbio != s->rbio) {
3634 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3637 BIO_up_ref(ret->rbio);
3638 ret->wbio = ret->rbio;
3642 ret->server = s->server;
3643 if (s->handshake_func) {
3645 SSL_set_accept_state(ret);
3647 SSL_set_connect_state(ret);
3649 ret->shutdown = s->shutdown;
3652 ret->default_passwd_callback = s->default_passwd_callback;
3653 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3655 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3657 /* dup the cipher_list and cipher_list_by_id stacks */
3658 if (s->cipher_list != NULL) {
3659 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3662 if (s->cipher_list_by_id != NULL)
3663 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3667 /* Dup the client_CA list */
3668 if (s->ca_names != NULL) {
3669 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3672 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3673 xn = sk_X509_NAME_value(sk, i);
3674 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3687 void ssl_clear_cipher_ctx(SSL *s)
3689 if (s->enc_read_ctx != NULL) {
3690 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3691 s->enc_read_ctx = NULL;
3693 if (s->enc_write_ctx != NULL) {
3694 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3695 s->enc_write_ctx = NULL;
3697 #ifndef OPENSSL_NO_COMP
3698 COMP_CTX_free(s->expand);
3700 COMP_CTX_free(s->compress);
3705 X509 *SSL_get_certificate(const SSL *s)
3707 if (s->cert != NULL)
3708 return s->cert->key->x509;
3713 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3715 if (s->cert != NULL)
3716 return s->cert->key->privatekey;
3721 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3723 if (ctx->cert != NULL)
3724 return ctx->cert->key->x509;
3729 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3731 if (ctx->cert != NULL)
3732 return ctx->cert->key->privatekey;
3737 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3739 if ((s->session != NULL) && (s->session->cipher != NULL))
3740 return s->session->cipher;
3744 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3746 return s->s3->tmp.new_cipher;
3749 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3751 #ifndef OPENSSL_NO_COMP
3752 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3758 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3760 #ifndef OPENSSL_NO_COMP
3761 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3767 int ssl_init_wbio_buffer(SSL *s)
3771 if (s->bbio != NULL) {
3772 /* Already buffered. */
3776 bbio = BIO_new(BIO_f_buffer());
3777 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3779 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3783 s->wbio = BIO_push(bbio, s->wbio);
3788 int ssl_free_wbio_buffer(SSL *s)
3790 /* callers ensure s is never null */
3791 if (s->bbio == NULL)
3794 s->wbio = BIO_pop(s->wbio);
3795 if (!ossl_assert(s->wbio != NULL))
3803 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3805 ctx->quiet_shutdown = mode;
3808 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3810 return ctx->quiet_shutdown;
3813 void SSL_set_quiet_shutdown(SSL *s, int mode)
3815 s->quiet_shutdown = mode;
3818 int SSL_get_quiet_shutdown(const SSL *s)
3820 return s->quiet_shutdown;
3823 void SSL_set_shutdown(SSL *s, int mode)
3828 int SSL_get_shutdown(const SSL *s)
3833 int SSL_version(const SSL *s)
3838 int SSL_client_version(const SSL *s)
3840 return s->client_version;
3843 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3848 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3851 if (ssl->ctx == ctx)
3854 ctx = ssl->session_ctx;
3855 new_cert = ssl_cert_dup(ctx->cert);
3856 if (new_cert == NULL) {
3860 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3861 ssl_cert_free(new_cert);
3865 ssl_cert_free(ssl->cert);
3866 ssl->cert = new_cert;
3869 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3870 * so setter APIs must prevent invalid lengths from entering the system.
3872 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3876 * If the session ID context matches that of the parent SSL_CTX,
3877 * inherit it from the new SSL_CTX as well. If however the context does
3878 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3879 * leave it unchanged.
3881 if ((ssl->ctx != NULL) &&
3882 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3883 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3884 ssl->sid_ctx_length = ctx->sid_ctx_length;
3885 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3888 SSL_CTX_up_ref(ctx);
3889 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3895 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3897 return X509_STORE_set_default_paths(ctx->cert_store);
3900 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3902 X509_LOOKUP *lookup;
3904 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3907 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3909 /* Clear any errors if the default directory does not exist */
3915 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3917 X509_LOOKUP *lookup;
3919 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3923 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3925 /* Clear any errors if the default file does not exist */
3931 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3934 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
3937 void SSL_set_info_callback(SSL *ssl,
3938 void (*cb) (const SSL *ssl, int type, int val))
3940 ssl->info_callback = cb;
3944 * One compiler (Diab DCC) doesn't like argument names in returned function
3947 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3950 return ssl->info_callback;
3953 void SSL_set_verify_result(SSL *ssl, long arg)
3955 ssl->verify_result = arg;
3958 long SSL_get_verify_result(const SSL *ssl)
3960 return ssl->verify_result;
3963 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3966 return sizeof(ssl->s3->client_random);
3967 if (outlen > sizeof(ssl->s3->client_random))
3968 outlen = sizeof(ssl->s3->client_random);
3969 memcpy(out, ssl->s3->client_random, outlen);
3973 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3976 return sizeof(ssl->s3->server_random);
3977 if (outlen > sizeof(ssl->s3->server_random))
3978 outlen = sizeof(ssl->s3->server_random);
3979 memcpy(out, ssl->s3->server_random, outlen);
3983 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3984 unsigned char *out, size_t outlen)
3987 return session->master_key_length;
3988 if (outlen > session->master_key_length)
3989 outlen = session->master_key_length;
3990 memcpy(out, session->master_key, outlen);
3994 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
3997 if (len > sizeof(sess->master_key))
4000 memcpy(sess->master_key, in, len);
4001 sess->master_key_length = len;
4006 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4008 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4011 void *SSL_get_ex_data(const SSL *s, int idx)
4013 return CRYPTO_get_ex_data(&s->ex_data, idx);
4016 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4018 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4021 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4023 return CRYPTO_get_ex_data(&s->ex_data, idx);
4026 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4028 return ctx->cert_store;
4031 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4033 X509_STORE_free(ctx->cert_store);
4034 ctx->cert_store = store;
4037 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4040 X509_STORE_up_ref(store);
4041 SSL_CTX_set_cert_store(ctx, store);
4044 int SSL_want(const SSL *s)
4050 * \brief Set the callback for generating temporary DH keys.
4051 * \param ctx the SSL context.
4052 * \param dh the callback
4055 #ifndef OPENSSL_NO_DH
4056 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4057 DH *(*dh) (SSL *ssl, int is_export,
4060 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4063 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4066 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4070 #ifndef OPENSSL_NO_PSK
4071 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4073 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4074 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4077 OPENSSL_free(ctx->cert->psk_identity_hint);
4078 if (identity_hint != NULL) {
4079 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4080 if (ctx->cert->psk_identity_hint == NULL)
4083 ctx->cert->psk_identity_hint = NULL;
4087 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4092 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4093 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4096 OPENSSL_free(s->cert->psk_identity_hint);
4097 if (identity_hint != NULL) {
4098 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4099 if (s->cert->psk_identity_hint == NULL)
4102 s->cert->psk_identity_hint = NULL;
4106 const char *SSL_get_psk_identity_hint(const SSL *s)
4108 if (s == NULL || s->session == NULL)
4110 return s->session->psk_identity_hint;
4113 const char *SSL_get_psk_identity(const SSL *s)
4115 if (s == NULL || s->session == NULL)
4117 return s->session->psk_identity;
4120 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4122 s->psk_client_callback = cb;
4125 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4127 ctx->psk_client_callback = cb;
4130 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4132 s->psk_server_callback = cb;
4135 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4137 ctx->psk_server_callback = cb;
4141 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4143 s->psk_find_session_cb = cb;
4146 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4147 SSL_psk_find_session_cb_func cb)
4149 ctx->psk_find_session_cb = cb;
4152 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4154 s->psk_use_session_cb = cb;
4157 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4158 SSL_psk_use_session_cb_func cb)
4160 ctx->psk_use_session_cb = cb;
4163 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4164 void (*cb) (int write_p, int version,
4165 int content_type, const void *buf,
4166 size_t len, SSL *ssl, void *arg))
4168 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4171 void SSL_set_msg_callback(SSL *ssl,
4172 void (*cb) (int write_p, int version,
4173 int content_type, const void *buf,
4174 size_t len, SSL *ssl, void *arg))
4176 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4179 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4180 int (*cb) (SSL *ssl,
4184 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4185 (void (*)(void))cb);
4188 void SSL_set_not_resumable_session_callback(SSL *ssl,
4189 int (*cb) (SSL *ssl,
4190 int is_forward_secure))
4192 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4193 (void (*)(void))cb);
4196 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4197 size_t (*cb) (SSL *ssl, int type,
4198 size_t len, void *arg))
4200 ctx->record_padding_cb = cb;
4203 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4205 ctx->record_padding_arg = arg;
4208 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4210 return ctx->record_padding_arg;
4213 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4215 /* block size of 0 or 1 is basically no padding */
4216 if (block_size == 1)
4217 ctx->block_padding = 0;
4218 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4219 ctx->block_padding = block_size;
4225 void SSL_set_record_padding_callback(SSL *ssl,
4226 size_t (*cb) (SSL *ssl, int type,
4227 size_t len, void *arg))
4229 ssl->record_padding_cb = cb;
4232 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4234 ssl->record_padding_arg = arg;
4237 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4239 return ssl->record_padding_arg;
4242 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4244 /* block size of 0 or 1 is basically no padding */
4245 if (block_size == 1)
4246 ssl->block_padding = 0;
4247 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4248 ssl->block_padding = block_size;
4255 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4256 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4257 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4258 * Returns the newly allocated ctx;
4261 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4263 ssl_clear_hash_ctx(hash);
4264 *hash = EVP_MD_CTX_new();
4265 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4266 EVP_MD_CTX_free(*hash);
4273 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4276 EVP_MD_CTX_free(*hash);
4280 /* Retrieve handshake hashes */
4281 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4284 EVP_MD_CTX *ctx = NULL;
4285 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4286 int hashleni = EVP_MD_CTX_size(hdgst);
4289 if (hashleni < 0 || (size_t)hashleni > outlen) {
4290 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4291 ERR_R_INTERNAL_ERROR);
4295 ctx = EVP_MD_CTX_new();
4299 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4300 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4301 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4302 ERR_R_INTERNAL_ERROR);
4306 *hashlen = hashleni;
4310 EVP_MD_CTX_free(ctx);
4314 int SSL_session_reused(SSL *s)
4319 int SSL_is_server(const SSL *s)
4324 #if OPENSSL_API_COMPAT < 0x10100000L
4325 void SSL_set_debug(SSL *s, int debug)
4327 /* Old function was do-nothing anyway... */
4333 void SSL_set_security_level(SSL *s, int level)
4335 s->cert->sec_level = level;
4338 int SSL_get_security_level(const SSL *s)
4340 return s->cert->sec_level;
4343 void SSL_set_security_callback(SSL *s,
4344 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4345 int op, int bits, int nid,
4346 void *other, void *ex))
4348 s->cert->sec_cb = cb;
4351 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4352 const SSL_CTX *ctx, int op,
4353 int bits, int nid, void *other,
4355 return s->cert->sec_cb;
4358 void SSL_set0_security_ex_data(SSL *s, void *ex)
4360 s->cert->sec_ex = ex;
4363 void *SSL_get0_security_ex_data(const SSL *s)
4365 return s->cert->sec_ex;
4368 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4370 ctx->cert->sec_level = level;
4373 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4375 return ctx->cert->sec_level;
4378 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4379 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4380 int op, int bits, int nid,
4381 void *other, void *ex))
4383 ctx->cert->sec_cb = cb;
4386 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4392 return ctx->cert->sec_cb;
4395 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4397 ctx->cert->sec_ex = ex;
4400 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4402 return ctx->cert->sec_ex;
4406 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4407 * can return unsigned long, instead of the generic long return value from the
4408 * control interface.
4410 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4412 return ctx->options;
4415 unsigned long SSL_get_options(const SSL *s)
4420 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4422 return ctx->options |= op;
4425 unsigned long SSL_set_options(SSL *s, unsigned long op)
4427 return s->options |= op;
4430 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4432 return ctx->options &= ~op;
4435 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4437 return s->options &= ~op;
4440 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4442 return s->verified_chain;
4445 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4447 #ifndef OPENSSL_NO_CT
4450 * Moves SCTs from the |src| stack to the |dst| stack.
4451 * The source of each SCT will be set to |origin|.
4452 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4454 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4456 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4457 sct_source_t origin)
4463 *dst = sk_SCT_new_null();
4465 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4470 while ((sct = sk_SCT_pop(src)) != NULL) {
4471 if (SCT_set_source(sct, origin) != 1)
4474 if (sk_SCT_push(*dst, sct) <= 0)
4482 sk_SCT_push(src, sct); /* Put the SCT back */
4487 * Look for data collected during ServerHello and parse if found.
4488 * Returns the number of SCTs extracted.
4490 static int ct_extract_tls_extension_scts(SSL *s)
4492 int scts_extracted = 0;
4494 if (s->ext.scts != NULL) {
4495 const unsigned char *p = s->ext.scts;
4496 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4498 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4500 SCT_LIST_free(scts);
4503 return scts_extracted;
4507 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4508 * contains an SCT X509 extension. They will be stored in |s->scts|.
4510 * - The number of SCTs extracted, assuming an OCSP response exists.
4511 * - 0 if no OCSP response exists or it contains no SCTs.
4512 * - A negative integer if an error occurs.
4514 static int ct_extract_ocsp_response_scts(SSL *s)
4516 # ifndef OPENSSL_NO_OCSP
4517 int scts_extracted = 0;
4518 const unsigned char *p;
4519 OCSP_BASICRESP *br = NULL;
4520 OCSP_RESPONSE *rsp = NULL;
4521 STACK_OF(SCT) *scts = NULL;
4524 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4527 p = s->ext.ocsp.resp;
4528 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4532 br = OCSP_response_get1_basic(rsp);
4536 for (i = 0; i < OCSP_resp_count(br); ++i) {
4537 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4543 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4545 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4546 if (scts_extracted < 0)
4550 SCT_LIST_free(scts);
4551 OCSP_BASICRESP_free(br);
4552 OCSP_RESPONSE_free(rsp);
4553 return scts_extracted;
4555 /* Behave as if no OCSP response exists */
4561 * Attempts to extract SCTs from the peer certificate.
4562 * Return the number of SCTs extracted, or a negative integer if an error
4565 static int ct_extract_x509v3_extension_scts(SSL *s)
4567 int scts_extracted = 0;
4568 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4571 STACK_OF(SCT) *scts =
4572 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4575 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4577 SCT_LIST_free(scts);
4580 return scts_extracted;
4584 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4585 * response (if it exists) and X509v3 extensions in the certificate.
4586 * Returns NULL if an error occurs.
4588 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4590 if (!s->scts_parsed) {
4591 if (ct_extract_tls_extension_scts(s) < 0 ||
4592 ct_extract_ocsp_response_scts(s) < 0 ||
4593 ct_extract_x509v3_extension_scts(s) < 0)
4603 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4604 const STACK_OF(SCT) *scts, void *unused_arg)
4609 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4610 const STACK_OF(SCT) *scts, void *unused_arg)
4612 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4615 for (i = 0; i < count; ++i) {
4616 SCT *sct = sk_SCT_value(scts, i);
4617 int status = SCT_get_validation_status(sct);
4619 if (status == SCT_VALIDATION_STATUS_VALID)
4622 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4626 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4630 * Since code exists that uses the custom extension handler for CT, look
4631 * for this and throw an error if they have already registered to use CT.
4633 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4634 TLSEXT_TYPE_signed_certificate_timestamp))
4636 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4637 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4641 if (callback != NULL) {
4643 * If we are validating CT, then we MUST accept SCTs served via OCSP
4645 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4649 s->ct_validation_callback = callback;
4650 s->ct_validation_callback_arg = arg;
4655 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4656 ssl_ct_validation_cb callback, void *arg)
4659 * Since code exists that uses the custom extension handler for CT, look for
4660 * this and throw an error if they have already registered to use CT.
4662 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4663 TLSEXT_TYPE_signed_certificate_timestamp))
4665 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4666 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4670 ctx->ct_validation_callback = callback;
4671 ctx->ct_validation_callback_arg = arg;
4675 int SSL_ct_is_enabled(const SSL *s)
4677 return s->ct_validation_callback != NULL;
4680 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4682 return ctx->ct_validation_callback != NULL;
4685 int ssl_validate_ct(SSL *s)
4688 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4690 SSL_DANE *dane = &s->dane;
4691 CT_POLICY_EVAL_CTX *ctx = NULL;
4692 const STACK_OF(SCT) *scts;
4695 * If no callback is set, the peer is anonymous, or its chain is invalid,
4696 * skip SCT validation - just return success. Applications that continue
4697 * handshakes without certificates, with unverified chains, or pinned leaf
4698 * certificates are outside the scope of the WebPKI and CT.
4700 * The above exclusions notwithstanding the vast majority of peers will
4701 * have rather ordinary certificate chains validated by typical
4702 * applications that perform certificate verification and therefore will
4703 * process SCTs when enabled.
4705 if (s->ct_validation_callback == NULL || cert == NULL ||
4706 s->verify_result != X509_V_OK ||
4707 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4711 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4712 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4714 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4715 switch (dane->mtlsa->usage) {
4716 case DANETLS_USAGE_DANE_TA:
4717 case DANETLS_USAGE_DANE_EE:
4722 ctx = CT_POLICY_EVAL_CTX_new();
4724 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4725 ERR_R_MALLOC_FAILURE);
4729 issuer = sk_X509_value(s->verified_chain, 1);
4730 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4731 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4732 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4733 CT_POLICY_EVAL_CTX_set_time(
4734 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4736 scts = SSL_get0_peer_scts(s);
4739 * This function returns success (> 0) only when all the SCTs are valid, 0
4740 * when some are invalid, and < 0 on various internal errors (out of
4741 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4742 * reason to abort the handshake, that decision is up to the callback.
4743 * Therefore, we error out only in the unexpected case that the return
4744 * value is negative.
4746 * XXX: One might well argue that the return value of this function is an
4747 * unfortunate design choice. Its job is only to determine the validation
4748 * status of each of the provided SCTs. So long as it correctly separates
4749 * the wheat from the chaff it should return success. Failure in this case
4750 * ought to correspond to an inability to carry out its duties.
4752 if (SCT_LIST_validate(scts, ctx) < 0) {
4753 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4754 SSL_R_SCT_VERIFICATION_FAILED);
4758 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4760 ret = 0; /* This function returns 0 on failure */
4762 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4763 SSL_R_CALLBACK_FAILED);
4766 CT_POLICY_EVAL_CTX_free(ctx);
4768 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4769 * failure return code here. Also the application may wish the complete
4770 * the handshake, and then disconnect cleanly at a higher layer, after
4771 * checking the verification status of the completed connection.
4773 * We therefore force a certificate verification failure which will be
4774 * visible via SSL_get_verify_result() and cached as part of any resumed
4777 * Note: the permissive callback is for information gathering only, always
4778 * returns success, and does not affect verification status. Only the
4779 * strict callback or a custom application-specified callback can trigger
4780 * connection failure or record a verification error.
4783 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4787 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4789 switch (validation_mode) {
4791 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4793 case SSL_CT_VALIDATION_PERMISSIVE:
4794 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4795 case SSL_CT_VALIDATION_STRICT:
4796 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4800 int SSL_enable_ct(SSL *s, int validation_mode)
4802 switch (validation_mode) {
4804 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4806 case SSL_CT_VALIDATION_PERMISSIVE:
4807 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4808 case SSL_CT_VALIDATION_STRICT:
4809 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4813 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4815 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4818 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4820 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4823 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4825 CTLOG_STORE_free(ctx->ctlog_store);
4826 ctx->ctlog_store = logs;
4829 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4831 return ctx->ctlog_store;
4834 #endif /* OPENSSL_NO_CT */
4836 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4839 c->client_hello_cb = cb;
4840 c->client_hello_cb_arg = arg;
4843 int SSL_client_hello_isv2(SSL *s)
4845 if (s->clienthello == NULL)
4847 return s->clienthello->isv2;
4850 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4852 if (s->clienthello == NULL)
4854 return s->clienthello->legacy_version;
4857 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
4859 if (s->clienthello == NULL)
4862 *out = s->clienthello->random;
4863 return SSL3_RANDOM_SIZE;
4866 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
4868 if (s->clienthello == NULL)
4871 *out = s->clienthello->session_id;
4872 return s->clienthello->session_id_len;
4875 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
4877 if (s->clienthello == NULL)
4880 *out = PACKET_data(&s->clienthello->ciphersuites);
4881 return PACKET_remaining(&s->clienthello->ciphersuites);
4884 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
4886 if (s->clienthello == NULL)
4889 *out = s->clienthello->compressions;
4890 return s->clienthello->compressions_len;
4893 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
4899 if (s->clienthello == NULL || out == NULL || outlen == NULL)
4901 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
4902 ext = s->clienthello->pre_proc_exts + i;
4906 present = OPENSSL_malloc(sizeof(*present) * num);
4907 if (present == NULL)
4909 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
4910 ext = s->clienthello->pre_proc_exts + i;
4912 if (ext->received_order >= num)
4914 present[ext->received_order] = ext->type;
4921 OPENSSL_free(present);
4925 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4931 if (s->clienthello == NULL)
4933 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4934 r = s->clienthello->pre_proc_exts + i;
4935 if (r->present && r->type == type) {
4937 *out = PACKET_data(&r->data);
4939 *outlen = PACKET_remaining(&r->data);
4946 int SSL_free_buffers(SSL *ssl)
4948 RECORD_LAYER *rl = &ssl->rlayer;
4950 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
4953 RECORD_LAYER_release(rl);
4957 int SSL_alloc_buffers(SSL *ssl)
4959 return ssl3_setup_buffers(ssl);
4962 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4964 ctx->keylog_callback = cb;
4967 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4969 return ctx->keylog_callback;
4972 static int nss_keylog_int(const char *prefix,
4974 const uint8_t *parameter_1,
4975 size_t parameter_1_len,
4976 const uint8_t *parameter_2,
4977 size_t parameter_2_len)
4980 char *cursor = NULL;
4985 if (ssl->ctx->keylog_callback == NULL) return 1;
4988 * Our output buffer will contain the following strings, rendered with
4989 * space characters in between, terminated by a NULL character: first the
4990 * prefix, then the first parameter, then the second parameter. The
4991 * meaning of each parameter depends on the specific key material being
4992 * logged. Note that the first and second parameters are encoded in
4993 * hexadecimal, so we need a buffer that is twice their lengths.
4995 prefix_len = strlen(prefix);
4996 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4997 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4998 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
4999 ERR_R_MALLOC_FAILURE);
5003 strcpy(cursor, prefix);
5004 cursor += prefix_len;
5007 for (i = 0; i < parameter_1_len; i++) {
5008 sprintf(cursor, "%02x", parameter_1[i]);
5013 for (i = 0; i < parameter_2_len; i++) {
5014 sprintf(cursor, "%02x", parameter_2[i]);
5019 ssl->ctx->keylog_callback(ssl, (const char *)out);
5025 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5026 const uint8_t *encrypted_premaster,
5027 size_t encrypted_premaster_len,
5028 const uint8_t *premaster,
5029 size_t premaster_len)
5031 if (encrypted_premaster_len < 8) {
5032 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5033 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5037 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5038 return nss_keylog_int("RSA",
5040 encrypted_premaster,
5046 int ssl_log_secret(SSL *ssl,
5048 const uint8_t *secret,
5051 return nss_keylog_int(label,
5053 ssl->s3->client_random,
5059 #define SSLV2_CIPHER_LEN 3
5061 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5065 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5067 if (PACKET_remaining(cipher_suites) == 0) {
5068 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5069 SSL_R_NO_CIPHERS_SPECIFIED);
5073 if (PACKET_remaining(cipher_suites) % n != 0) {
5074 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5075 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5079 OPENSSL_free(s->s3->tmp.ciphers_raw);
5080 s->s3->tmp.ciphers_raw = NULL;
5081 s->s3->tmp.ciphers_rawlen = 0;
5084 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5085 PACKET sslv2ciphers = *cipher_suites;
5086 unsigned int leadbyte;
5090 * We store the raw ciphers list in SSLv3+ format so we need to do some
5091 * preprocessing to convert the list first. If there are any SSLv2 only
5092 * ciphersuites with a non-zero leading byte then we are going to
5093 * slightly over allocate because we won't store those. But that isn't a
5096 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5097 s->s3->tmp.ciphers_raw = raw;
5099 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5100 ERR_R_MALLOC_FAILURE);
5103 for (s->s3->tmp.ciphers_rawlen = 0;
5104 PACKET_remaining(&sslv2ciphers) > 0;
5105 raw += TLS_CIPHER_LEN) {
5106 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5108 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5111 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5112 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5114 OPENSSL_free(s->s3->tmp.ciphers_raw);
5115 s->s3->tmp.ciphers_raw = NULL;
5116 s->s3->tmp.ciphers_rawlen = 0;
5120 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5122 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5123 &s->s3->tmp.ciphers_rawlen)) {
5124 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5125 ERR_R_INTERNAL_ERROR);
5131 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5132 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5133 STACK_OF(SSL_CIPHER) **scsvs)
5137 if (!PACKET_buf_init(&pkt, bytes, len))
5139 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5142 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5143 STACK_OF(SSL_CIPHER) **skp,
5144 STACK_OF(SSL_CIPHER) **scsvs_out,
5145 int sslv2format, int fatal)
5147 const SSL_CIPHER *c;
5148 STACK_OF(SSL_CIPHER) *sk = NULL;
5149 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5151 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5152 unsigned char cipher[SSLV2_CIPHER_LEN];
5154 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5156 if (PACKET_remaining(cipher_suites) == 0) {
5158 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5159 SSL_R_NO_CIPHERS_SPECIFIED);
5161 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5165 if (PACKET_remaining(cipher_suites) % n != 0) {
5167 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5168 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5170 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5171 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5175 sk = sk_SSL_CIPHER_new_null();
5176 scsvs = sk_SSL_CIPHER_new_null();
5177 if (sk == NULL || scsvs == NULL) {
5179 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5180 ERR_R_MALLOC_FAILURE);
5182 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5186 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5188 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5189 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5190 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5192 if (sslv2format && cipher[0] != '\0')
5195 /* For SSLv2-compat, ignore leading 0-byte. */
5196 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5198 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5199 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5201 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5202 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5204 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5209 if (PACKET_remaining(cipher_suites) > 0) {
5211 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5214 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5221 sk_SSL_CIPHER_free(sk);
5222 if (scsvs_out != NULL)
5225 sk_SSL_CIPHER_free(scsvs);
5228 sk_SSL_CIPHER_free(sk);
5229 sk_SSL_CIPHER_free(scsvs);
5233 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5235 ctx->max_early_data = max_early_data;
5240 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5242 return ctx->max_early_data;
5245 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5247 s->max_early_data = max_early_data;
5252 uint32_t SSL_get_max_early_data(const SSL *s)
5254 return s->max_early_data;
5257 int ssl_randbytes(SSL *s, unsigned char *rnd, size_t size)
5259 if (s->drbg != NULL) {
5261 * Currently, it's the duty of the caller to serialize the generate
5262 * requests to the DRBG. So formally we have to check whether
5263 * s->drbg->lock != NULL and take the lock if this is the case.
5264 * However, this DRBG is unique to a given SSL object, and we already
5265 * require that SSL objects are only accessed by a single thread at
5266 * a given time. Also, SSL DRBGs have no child DRBG, so there is
5267 * no risk that this DRBG is accessed by a child DRBG in parallel
5268 * for reseeding. As such, we can rely on the application's
5269 * serialization of SSL accesses for the needed concurrency protection
5272 return RAND_DRBG_bytes(s->drbg, rnd, size);
5276 return RAND_bytes(rnd, size);
5279 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5281 /* Return any active Max Fragment Len extension */
5282 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5283 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5285 /* return current SSL connection setting */
5286 return ssl->max_send_fragment;
5289 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5291 /* Return a value regarding an active Max Fragment Len extension */
5292 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5293 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5294 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5296 /* else limit |split_send_fragment| to current |max_send_fragment| */
5297 if (ssl->split_send_fragment > ssl->max_send_fragment)
5298 return ssl->max_send_fragment;
5300 /* return current SSL connection setting */
5301 return ssl->split_send_fragment;
5304 int SSL_stateless(SSL *s)
5308 /* Ensure there is no state left over from a previous invocation */
5314 s->s3->flags |= TLS1_FLAGS_STATELESS;
5315 ret = SSL_accept(s);
5316 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5318 if (ret > 0 && s->ext.cookieok)
5324 void SSL_force_post_handshake_auth(SSL *ssl)
5326 ssl->pha_forced = 1;
5329 int SSL_verify_client_post_handshake(SSL *ssl)
5331 if (!SSL_IS_TLS13(ssl)) {
5332 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5336 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5340 if (!SSL_is_init_finished(ssl)) {
5341 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5345 switch (ssl->post_handshake_auth) {
5347 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5350 case SSL_PHA_EXT_SENT:
5351 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5353 case SSL_PHA_EXT_RECEIVED:
5355 case SSL_PHA_REQUEST_PENDING:
5356 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5358 case SSL_PHA_REQUESTED:
5359 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5363 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5365 /* checks verify_mode and algorithm_auth */
5366 if (!send_certificate_request(ssl)) {
5367 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5368 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5372 ossl_statem_set_in_init(ssl, 1);