2 * Copyright 1995-2020 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 Apache License 2.0 (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
13 #include "ssl_local.h"
15 #include <openssl/objects.h>
16 #include <openssl/x509v3.h>
17 #include <openssl/rand.h>
18 #include <openssl/rand_drbg.h>
19 #include <openssl/ocsp.h>
20 #include <openssl/dh.h>
21 #include <openssl/engine.h>
22 #include <openssl/async.h>
23 #include <openssl/ct.h>
24 #include <openssl/trace.h>
25 #include "internal/cryptlib.h"
26 #include "internal/refcount.h"
27 #include "internal/ktls.h"
30 DEFINE_STACK_OF(X509_NAME
)
31 DEFINE_STACK_OF_CONST(SSL_CIPHER
)
32 DEFINE_STACK_OF(X509_EXTENSION
)
33 DEFINE_STACK_OF(OCSP_RESPID
)
34 DEFINE_STACK_OF(SRTP_PROTECTION_PROFILE
)
37 static int ssl_undefined_function_1(SSL
*ssl
, SSL3_RECORD
*r
, size_t s
, int t
)
42 return ssl_undefined_function(ssl
);
45 static int ssl_undefined_function_2(SSL
*ssl
, SSL3_RECORD
*r
, unsigned char *s
,
51 return ssl_undefined_function(ssl
);
54 static int ssl_undefined_function_3(SSL
*ssl
, unsigned char *r
,
55 unsigned char *s
, size_t t
, size_t *u
)
61 return ssl_undefined_function(ssl
);
64 static int ssl_undefined_function_4(SSL
*ssl
, int r
)
67 return ssl_undefined_function(ssl
);
70 static size_t ssl_undefined_function_5(SSL
*ssl
, const char *r
, size_t s
,
76 return ssl_undefined_function(ssl
);
79 static int ssl_undefined_function_6(int r
)
82 return ssl_undefined_function(NULL
);
85 static int ssl_undefined_function_7(SSL
*ssl
, unsigned char *r
, size_t s
,
86 const char *t
, size_t u
,
87 const unsigned char *v
, size_t w
, int x
)
96 return ssl_undefined_function(ssl
);
99 SSL3_ENC_METHOD ssl3_undef_enc_method
= {
100 ssl_undefined_function_1
,
101 ssl_undefined_function_2
,
102 ssl_undefined_function
,
103 ssl_undefined_function_3
,
104 ssl_undefined_function_4
,
105 ssl_undefined_function_5
,
106 NULL
, /* client_finished_label */
107 0, /* client_finished_label_len */
108 NULL
, /* server_finished_label */
109 0, /* server_finished_label_len */
110 ssl_undefined_function_6
,
111 ssl_undefined_function_7
,
114 struct ssl_async_args
{
118 enum { READFUNC
, WRITEFUNC
, OTHERFUNC
} type
;
120 int (*func_read
) (SSL
*, void *, size_t, size_t *);
121 int (*func_write
) (SSL
*, const void *, size_t, size_t *);
122 int (*func_other
) (SSL
*);
126 static const struct {
132 DANETLS_MATCHING_FULL
, 0, NID_undef
135 DANETLS_MATCHING_2256
, 1, NID_sha256
138 DANETLS_MATCHING_2512
, 2, NID_sha512
142 static int dane_ctx_enable(struct dane_ctx_st
*dctx
)
144 const EVP_MD
**mdevp
;
146 uint8_t mdmax
= DANETLS_MATCHING_LAST
;
147 int n
= ((int)mdmax
) + 1; /* int to handle PrivMatch(255) */
150 if (dctx
->mdevp
!= NULL
)
153 mdevp
= OPENSSL_zalloc(n
* sizeof(*mdevp
));
154 mdord
= OPENSSL_zalloc(n
* sizeof(*mdord
));
156 if (mdord
== NULL
|| mdevp
== NULL
) {
159 SSLerr(SSL_F_DANE_CTX_ENABLE
, ERR_R_MALLOC_FAILURE
);
163 /* Install default entries */
164 for (i
= 0; i
< OSSL_NELEM(dane_mds
); ++i
) {
167 if (dane_mds
[i
].nid
== NID_undef
||
168 (md
= EVP_get_digestbynid(dane_mds
[i
].nid
)) == NULL
)
170 mdevp
[dane_mds
[i
].mtype
] = md
;
171 mdord
[dane_mds
[i
].mtype
] = dane_mds
[i
].ord
;
181 static void dane_ctx_final(struct dane_ctx_st
*dctx
)
183 OPENSSL_free(dctx
->mdevp
);
186 OPENSSL_free(dctx
->mdord
);
191 static void tlsa_free(danetls_record
*t
)
195 OPENSSL_free(t
->data
);
196 EVP_PKEY_free(t
->spki
);
200 static void dane_final(SSL_DANE
*dane
)
202 sk_danetls_record_pop_free(dane
->trecs
, tlsa_free
);
205 sk_X509_pop_free(dane
->certs
, X509_free
);
208 X509_free(dane
->mcert
);
216 * dane_copy - Copy dane configuration, sans verification state.
218 static int ssl_dane_dup(SSL
*to
, SSL
*from
)
223 if (!DANETLS_ENABLED(&from
->dane
))
226 num
= sk_danetls_record_num(from
->dane
.trecs
);
227 dane_final(&to
->dane
);
228 to
->dane
.flags
= from
->dane
.flags
;
229 to
->dane
.dctx
= &to
->ctx
->dane
;
230 to
->dane
.trecs
= sk_danetls_record_new_reserve(NULL
, num
);
232 if (to
->dane
.trecs
== NULL
) {
233 SSLerr(SSL_F_SSL_DANE_DUP
, ERR_R_MALLOC_FAILURE
);
237 for (i
= 0; i
< num
; ++i
) {
238 danetls_record
*t
= sk_danetls_record_value(from
->dane
.trecs
, i
);
240 if (SSL_dane_tlsa_add(to
, t
->usage
, t
->selector
, t
->mtype
,
241 t
->data
, t
->dlen
) <= 0)
247 static int dane_mtype_set(struct dane_ctx_st
*dctx
,
248 const EVP_MD
*md
, uint8_t mtype
, uint8_t ord
)
252 if (mtype
== DANETLS_MATCHING_FULL
&& md
!= NULL
) {
253 SSLerr(SSL_F_DANE_MTYPE_SET
, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL
);
257 if (mtype
> dctx
->mdmax
) {
258 const EVP_MD
**mdevp
;
260 int n
= ((int)mtype
) + 1;
262 mdevp
= OPENSSL_realloc(dctx
->mdevp
, n
* sizeof(*mdevp
));
264 SSLerr(SSL_F_DANE_MTYPE_SET
, ERR_R_MALLOC_FAILURE
);
269 mdord
= OPENSSL_realloc(dctx
->mdord
, n
* sizeof(*mdord
));
271 SSLerr(SSL_F_DANE_MTYPE_SET
, ERR_R_MALLOC_FAILURE
);
276 /* Zero-fill any gaps */
277 for (i
= dctx
->mdmax
+ 1; i
< mtype
; ++i
) {
285 dctx
->mdevp
[mtype
] = md
;
286 /* Coerce ordinal of disabled matching types to 0 */
287 dctx
->mdord
[mtype
] = (md
== NULL
) ? 0 : ord
;
292 static const EVP_MD
*tlsa_md_get(SSL_DANE
*dane
, uint8_t mtype
)
294 if (mtype
> dane
->dctx
->mdmax
)
296 return dane
->dctx
->mdevp
[mtype
];
299 static int dane_tlsa_add(SSL_DANE
*dane
,
302 uint8_t mtype
, unsigned const char *data
, size_t dlen
)
305 const EVP_MD
*md
= NULL
;
306 int ilen
= (int)dlen
;
310 if (dane
->trecs
== NULL
) {
311 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_NOT_ENABLED
);
315 if (ilen
< 0 || dlen
!= (size_t)ilen
) {
316 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_DATA_LENGTH
);
320 if (usage
> DANETLS_USAGE_LAST
) {
321 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE
);
325 if (selector
> DANETLS_SELECTOR_LAST
) {
326 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_SELECTOR
);
330 if (mtype
!= DANETLS_MATCHING_FULL
) {
331 md
= tlsa_md_get(dane
, mtype
);
333 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE
);
338 if (md
!= NULL
&& dlen
!= (size_t)EVP_MD_size(md
)) {
339 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH
);
343 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_NULL_DATA
);
347 if ((t
= OPENSSL_zalloc(sizeof(*t
))) == NULL
) {
348 SSLerr(SSL_F_DANE_TLSA_ADD
, ERR_R_MALLOC_FAILURE
);
353 t
->selector
= selector
;
355 t
->data
= OPENSSL_malloc(dlen
);
356 if (t
->data
== NULL
) {
358 SSLerr(SSL_F_DANE_TLSA_ADD
, ERR_R_MALLOC_FAILURE
);
361 memcpy(t
->data
, data
, dlen
);
364 /* Validate and cache full certificate or public key */
365 if (mtype
== DANETLS_MATCHING_FULL
) {
366 const unsigned char *p
= data
;
368 EVP_PKEY
*pkey
= NULL
;
371 case DANETLS_SELECTOR_CERT
:
372 if (!d2i_X509(&cert
, &p
, ilen
) || p
< data
||
373 dlen
!= (size_t)(p
- data
)) {
375 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_CERTIFICATE
);
378 if (X509_get0_pubkey(cert
) == NULL
) {
380 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_CERTIFICATE
);
384 if ((DANETLS_USAGE_BIT(usage
) & DANETLS_TA_MASK
) == 0) {
390 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
391 * records that contain full certificates of trust-anchors that are
392 * not present in the wire chain. For usage PKIX-TA(0), we augment
393 * the chain with untrusted Full(0) certificates from DNS, in case
394 * they are missing from the chain.
396 if ((dane
->certs
== NULL
&&
397 (dane
->certs
= sk_X509_new_null()) == NULL
) ||
398 !sk_X509_push(dane
->certs
, cert
)) {
399 SSLerr(SSL_F_DANE_TLSA_ADD
, ERR_R_MALLOC_FAILURE
);
406 case DANETLS_SELECTOR_SPKI
:
407 if (!d2i_PUBKEY(&pkey
, &p
, ilen
) || p
< data
||
408 dlen
!= (size_t)(p
- data
)) {
410 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY
);
415 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
416 * records that contain full bare keys of trust-anchors that are
417 * not present in the wire chain.
419 if (usage
== DANETLS_USAGE_DANE_TA
)
428 * Find the right insertion point for the new record.
430 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
431 * they can be processed first, as they require no chain building, and no
432 * expiration or hostname checks. Because DANE-EE(3) is numerically
433 * largest, this is accomplished via descending sort by "usage".
435 * We also sort in descending order by matching ordinal to simplify
436 * the implementation of digest agility in the verification code.
438 * The choice of order for the selector is not significant, so we
439 * use the same descending order for consistency.
441 num
= sk_danetls_record_num(dane
->trecs
);
442 for (i
= 0; i
< num
; ++i
) {
443 danetls_record
*rec
= sk_danetls_record_value(dane
->trecs
, i
);
445 if (rec
->usage
> usage
)
447 if (rec
->usage
< usage
)
449 if (rec
->selector
> selector
)
451 if (rec
->selector
< selector
)
453 if (dane
->dctx
->mdord
[rec
->mtype
] > dane
->dctx
->mdord
[mtype
])
458 if (!sk_danetls_record_insert(dane
->trecs
, t
, i
)) {
460 SSLerr(SSL_F_DANE_TLSA_ADD
, ERR_R_MALLOC_FAILURE
);
463 dane
->umask
|= DANETLS_USAGE_BIT(usage
);
469 * Return 0 if there is only one version configured and it was disabled
470 * at configure time. Return 1 otherwise.
472 static int ssl_check_allowed_versions(int min_version
, int max_version
)
474 int minisdtls
= 0, maxisdtls
= 0;
476 /* Figure out if we're doing DTLS versions or TLS versions */
477 if (min_version
== DTLS1_BAD_VER
478 || min_version
>> 8 == DTLS1_VERSION_MAJOR
)
480 if (max_version
== DTLS1_BAD_VER
481 || max_version
>> 8 == DTLS1_VERSION_MAJOR
)
483 /* A wildcard version of 0 could be DTLS or TLS. */
484 if ((minisdtls
&& !maxisdtls
&& max_version
!= 0)
485 || (maxisdtls
&& !minisdtls
&& min_version
!= 0)) {
486 /* Mixing DTLS and TLS versions will lead to sadness; deny it. */
490 if (minisdtls
|| maxisdtls
) {
491 /* Do DTLS version checks. */
492 if (min_version
== 0)
493 /* Ignore DTLS1_BAD_VER */
494 min_version
= DTLS1_VERSION
;
495 if (max_version
== 0)
496 max_version
= DTLS1_2_VERSION
;
497 #ifdef OPENSSL_NO_DTLS1_2
498 if (max_version
== DTLS1_2_VERSION
)
499 max_version
= DTLS1_VERSION
;
501 #ifdef OPENSSL_NO_DTLS1
502 if (min_version
== DTLS1_VERSION
)
503 min_version
= DTLS1_2_VERSION
;
505 /* Done massaging versions; do the check. */
507 #ifdef OPENSSL_NO_DTLS1
508 || (DTLS_VERSION_GE(min_version
, DTLS1_VERSION
)
509 && DTLS_VERSION_GE(DTLS1_VERSION
, max_version
))
511 #ifdef OPENSSL_NO_DTLS1_2
512 || (DTLS_VERSION_GE(min_version
, DTLS1_2_VERSION
)
513 && DTLS_VERSION_GE(DTLS1_2_VERSION
, max_version
))
518 /* Regular TLS version checks. */
519 if (min_version
== 0)
520 min_version
= SSL3_VERSION
;
521 if (max_version
== 0)
522 max_version
= TLS1_3_VERSION
;
523 #ifdef OPENSSL_NO_TLS1_3
524 if (max_version
== TLS1_3_VERSION
)
525 max_version
= TLS1_2_VERSION
;
527 #ifdef OPENSSL_NO_TLS1_2
528 if (max_version
== TLS1_2_VERSION
)
529 max_version
= TLS1_1_VERSION
;
531 #ifdef OPENSSL_NO_TLS1_1
532 if (max_version
== TLS1_1_VERSION
)
533 max_version
= TLS1_VERSION
;
535 #ifdef OPENSSL_NO_TLS1
536 if (max_version
== TLS1_VERSION
)
537 max_version
= SSL3_VERSION
;
539 #ifdef OPENSSL_NO_SSL3
540 if (min_version
== SSL3_VERSION
)
541 min_version
= TLS1_VERSION
;
543 #ifdef OPENSSL_NO_TLS1
544 if (min_version
== TLS1_VERSION
)
545 min_version
= TLS1_1_VERSION
;
547 #ifdef OPENSSL_NO_TLS1_1
548 if (min_version
== TLS1_1_VERSION
)
549 min_version
= TLS1_2_VERSION
;
551 #ifdef OPENSSL_NO_TLS1_2
552 if (min_version
== TLS1_2_VERSION
)
553 min_version
= TLS1_3_VERSION
;
555 /* Done massaging versions; do the check. */
557 #ifdef OPENSSL_NO_SSL3
558 || (min_version
<= SSL3_VERSION
&& SSL3_VERSION
<= max_version
)
560 #ifdef OPENSSL_NO_TLS1
561 || (min_version
<= TLS1_VERSION
&& TLS1_VERSION
<= max_version
)
563 #ifdef OPENSSL_NO_TLS1_1
564 || (min_version
<= TLS1_1_VERSION
&& TLS1_1_VERSION
<= max_version
)
566 #ifdef OPENSSL_NO_TLS1_2
567 || (min_version
<= TLS1_2_VERSION
&& TLS1_2_VERSION
<= max_version
)
569 #ifdef OPENSSL_NO_TLS1_3
570 || (min_version
<= TLS1_3_VERSION
&& TLS1_3_VERSION
<= max_version
)
578 static void clear_ciphers(SSL
*s
)
580 /* clear the current cipher */
581 ssl_clear_cipher_ctx(s
);
582 ssl_clear_hash_ctx(&s
->read_hash
);
583 ssl_clear_hash_ctx(&s
->write_hash
);
586 int SSL_clear(SSL
*s
)
588 if (s
->method
== NULL
) {
589 SSLerr(SSL_F_SSL_CLEAR
, SSL_R_NO_METHOD_SPECIFIED
);
593 if (ssl_clear_bad_session(s
)) {
594 SSL_SESSION_free(s
->session
);
597 SSL_SESSION_free(s
->psksession
);
598 s
->psksession
= NULL
;
599 OPENSSL_free(s
->psksession_id
);
600 s
->psksession_id
= NULL
;
601 s
->psksession_id_len
= 0;
602 s
->hello_retry_request
= 0;
609 if (s
->renegotiate
) {
610 SSLerr(SSL_F_SSL_CLEAR
, ERR_R_INTERNAL_ERROR
);
614 ossl_statem_clear(s
);
616 s
->version
= s
->method
->version
;
617 s
->client_version
= s
->version
;
618 s
->rwstate
= SSL_NOTHING
;
620 BUF_MEM_free(s
->init_buf
);
625 s
->key_update
= SSL_KEY_UPDATE_NONE
;
627 EVP_MD_CTX_free(s
->pha_dgst
);
630 /* Reset DANE verification result state */
633 X509_free(s
->dane
.mcert
);
634 s
->dane
.mcert
= NULL
;
635 s
->dane
.mtlsa
= NULL
;
637 /* Clear the verification result peername */
638 X509_VERIFY_PARAM_move_peername(s
->param
, NULL
);
640 /* Clear any shared connection state */
641 OPENSSL_free(s
->shared_sigalgs
);
642 s
->shared_sigalgs
= NULL
;
643 s
->shared_sigalgslen
= 0;
646 * Check to see if we were changed into a different method, if so, revert
649 if (s
->method
!= s
->ctx
->method
) {
650 s
->method
->ssl_free(s
);
651 s
->method
= s
->ctx
->method
;
652 if (!s
->method
->ssl_new(s
))
655 if (!s
->method
->ssl_clear(s
))
659 RECORD_LAYER_clear(&s
->rlayer
);
664 /** Used to change an SSL_CTXs default SSL method type */
665 int SSL_CTX_set_ssl_version(SSL_CTX
*ctx
, const SSL_METHOD
*meth
)
667 STACK_OF(SSL_CIPHER
) *sk
;
671 if (!SSL_CTX_set_ciphersuites(ctx
, OSSL_default_ciphersuites())) {
672 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION
, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS
);
675 sk
= ssl_create_cipher_list(ctx
->method
,
676 ctx
->tls13_ciphersuites
,
678 &(ctx
->cipher_list_by_id
),
679 OSSL_default_cipher_list(), ctx
->cert
);
680 if ((sk
== NULL
) || (sk_SSL_CIPHER_num(sk
) <= 0)) {
681 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION
, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS
);
687 SSL
*SSL_new(SSL_CTX
*ctx
)
692 SSLerr(SSL_F_SSL_NEW
, SSL_R_NULL_SSL_CTX
);
695 if (ctx
->method
== NULL
) {
696 SSLerr(SSL_F_SSL_NEW
, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION
);
700 s
= OPENSSL_zalloc(sizeof(*s
));
705 s
->lock
= CRYPTO_THREAD_lock_new();
706 if (s
->lock
== NULL
) {
712 RECORD_LAYER_init(&s
->rlayer
, s
);
714 s
->options
= ctx
->options
;
715 s
->dane
.flags
= ctx
->dane
.flags
;
716 s
->min_proto_version
= ctx
->min_proto_version
;
717 s
->max_proto_version
= ctx
->max_proto_version
;
719 s
->max_cert_list
= ctx
->max_cert_list
;
720 s
->max_early_data
= ctx
->max_early_data
;
721 s
->recv_max_early_data
= ctx
->recv_max_early_data
;
722 s
->num_tickets
= ctx
->num_tickets
;
723 s
->pha_enabled
= ctx
->pha_enabled
;
725 /* Shallow copy of the ciphersuites stack */
726 s
->tls13_ciphersuites
= sk_SSL_CIPHER_dup(ctx
->tls13_ciphersuites
);
727 if (s
->tls13_ciphersuites
== NULL
)
731 * Earlier library versions used to copy the pointer to the CERT, not
732 * its contents; only when setting new parameters for the per-SSL
733 * copy, ssl_cert_new would be called (and the direct reference to
734 * the per-SSL_CTX settings would be lost, but those still were
735 * indirectly accessed for various purposes, and for that reason they
736 * used to be known as s->ctx->default_cert). Now we don't look at the
737 * SSL_CTX's CERT after having duplicated it once.
739 s
->cert
= ssl_cert_dup(ctx
->cert
);
743 RECORD_LAYER_set_read_ahead(&s
->rlayer
, ctx
->read_ahead
);
744 s
->msg_callback
= ctx
->msg_callback
;
745 s
->msg_callback_arg
= ctx
->msg_callback_arg
;
746 s
->verify_mode
= ctx
->verify_mode
;
747 s
->not_resumable_session_cb
= ctx
->not_resumable_session_cb
;
748 s
->record_padding_cb
= ctx
->record_padding_cb
;
749 s
->record_padding_arg
= ctx
->record_padding_arg
;
750 s
->block_padding
= ctx
->block_padding
;
751 s
->sid_ctx_length
= ctx
->sid_ctx_length
;
752 if (!ossl_assert(s
->sid_ctx_length
<= sizeof(s
->sid_ctx
)))
754 memcpy(&s
->sid_ctx
, &ctx
->sid_ctx
, sizeof(s
->sid_ctx
));
755 s
->verify_callback
= ctx
->default_verify_callback
;
756 s
->generate_session_id
= ctx
->generate_session_id
;
758 s
->param
= X509_VERIFY_PARAM_new();
759 if (s
->param
== NULL
)
761 X509_VERIFY_PARAM_inherit(s
->param
, ctx
->param
);
762 s
->quiet_shutdown
= ctx
->quiet_shutdown
;
764 s
->ext
.max_fragment_len_mode
= ctx
->ext
.max_fragment_len_mode
;
765 s
->max_send_fragment
= ctx
->max_send_fragment
;
766 s
->split_send_fragment
= ctx
->split_send_fragment
;
767 s
->max_pipelines
= ctx
->max_pipelines
;
768 if (s
->max_pipelines
> 1)
769 RECORD_LAYER_set_read_ahead(&s
->rlayer
, 1);
770 if (ctx
->default_read_buf_len
> 0)
771 SSL_set_default_read_buffer_len(s
, ctx
->default_read_buf_len
);
776 s
->ext
.debug_arg
= NULL
;
777 s
->ext
.ticket_expected
= 0;
778 s
->ext
.status_type
= ctx
->ext
.status_type
;
779 s
->ext
.status_expected
= 0;
780 s
->ext
.ocsp
.ids
= NULL
;
781 s
->ext
.ocsp
.exts
= NULL
;
782 s
->ext
.ocsp
.resp
= NULL
;
783 s
->ext
.ocsp
.resp_len
= 0;
785 s
->session_ctx
= ctx
;
786 #ifndef OPENSSL_NO_EC
787 if (ctx
->ext
.ecpointformats
) {
788 s
->ext
.ecpointformats
=
789 OPENSSL_memdup(ctx
->ext
.ecpointformats
,
790 ctx
->ext
.ecpointformats_len
);
791 if (!s
->ext
.ecpointformats
)
793 s
->ext
.ecpointformats_len
=
794 ctx
->ext
.ecpointformats_len
;
797 if (ctx
->ext
.supportedgroups
) {
798 s
->ext
.supportedgroups
=
799 OPENSSL_memdup(ctx
->ext
.supportedgroups
,
800 ctx
->ext
.supportedgroups_len
801 * sizeof(*ctx
->ext
.supportedgroups
));
802 if (!s
->ext
.supportedgroups
)
804 s
->ext
.supportedgroups_len
= ctx
->ext
.supportedgroups_len
;
807 #ifndef OPENSSL_NO_NEXTPROTONEG
811 if (s
->ctx
->ext
.alpn
) {
812 s
->ext
.alpn
= OPENSSL_malloc(s
->ctx
->ext
.alpn_len
);
813 if (s
->ext
.alpn
== NULL
)
815 memcpy(s
->ext
.alpn
, s
->ctx
->ext
.alpn
, s
->ctx
->ext
.alpn_len
);
816 s
->ext
.alpn_len
= s
->ctx
->ext
.alpn_len
;
819 s
->verified_chain
= NULL
;
820 s
->verify_result
= X509_V_OK
;
822 s
->default_passwd_callback
= ctx
->default_passwd_callback
;
823 s
->default_passwd_callback_userdata
= ctx
->default_passwd_callback_userdata
;
825 s
->method
= ctx
->method
;
827 s
->key_update
= SSL_KEY_UPDATE_NONE
;
829 s
->allow_early_data_cb
= ctx
->allow_early_data_cb
;
830 s
->allow_early_data_cb_data
= ctx
->allow_early_data_cb_data
;
832 if (!s
->method
->ssl_new(s
))
835 s
->server
= (ctx
->method
->ssl_accept
== ssl_undefined_function
) ? 0 : 1;
840 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL
, s
, &s
->ex_data
))
843 #ifndef OPENSSL_NO_PSK
844 s
->psk_client_callback
= ctx
->psk_client_callback
;
845 s
->psk_server_callback
= ctx
->psk_server_callback
;
847 s
->psk_find_session_cb
= ctx
->psk_find_session_cb
;
848 s
->psk_use_session_cb
= ctx
->psk_use_session_cb
;
850 s
->async_cb
= ctx
->async_cb
;
851 s
->async_cb_arg
= ctx
->async_cb_arg
;
855 #ifndef OPENSSL_NO_CT
856 if (!SSL_set_ct_validation_callback(s
, ctx
->ct_validation_callback
,
857 ctx
->ct_validation_callback_arg
))
864 SSLerr(SSL_F_SSL_NEW
, ERR_R_MALLOC_FAILURE
);
868 int SSL_is_dtls(const SSL
*s
)
870 return SSL_IS_DTLS(s
) ? 1 : 0;
873 int SSL_up_ref(SSL
*s
)
877 if (CRYPTO_UP_REF(&s
->references
, &i
, s
->lock
) <= 0)
880 REF_PRINT_COUNT("SSL", s
);
881 REF_ASSERT_ISNT(i
< 2);
882 return ((i
> 1) ? 1 : 0);
885 int SSL_CTX_set_session_id_context(SSL_CTX
*ctx
, const unsigned char *sid_ctx
,
886 unsigned int sid_ctx_len
)
888 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
889 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT
,
890 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
893 ctx
->sid_ctx_length
= sid_ctx_len
;
894 memcpy(ctx
->sid_ctx
, sid_ctx
, sid_ctx_len
);
899 int SSL_set_session_id_context(SSL
*ssl
, const unsigned char *sid_ctx
,
900 unsigned int sid_ctx_len
)
902 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
903 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT
,
904 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
907 ssl
->sid_ctx_length
= sid_ctx_len
;
908 memcpy(ssl
->sid_ctx
, sid_ctx
, sid_ctx_len
);
913 int SSL_CTX_set_generate_session_id(SSL_CTX
*ctx
, GEN_SESSION_CB cb
)
915 CRYPTO_THREAD_write_lock(ctx
->lock
);
916 ctx
->generate_session_id
= cb
;
917 CRYPTO_THREAD_unlock(ctx
->lock
);
921 int SSL_set_generate_session_id(SSL
*ssl
, GEN_SESSION_CB cb
)
923 CRYPTO_THREAD_write_lock(ssl
->lock
);
924 ssl
->generate_session_id
= cb
;
925 CRYPTO_THREAD_unlock(ssl
->lock
);
929 int SSL_has_matching_session_id(const SSL
*ssl
, const unsigned char *id
,
933 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
934 * we can "construct" a session to give us the desired check - i.e. to
935 * find if there's a session in the hash table that would conflict with
936 * any new session built out of this id/id_len and the ssl_version in use
941 if (id_len
> sizeof(r
.session_id
))
944 r
.ssl_version
= ssl
->version
;
945 r
.session_id_length
= id_len
;
946 memcpy(r
.session_id
, id
, id_len
);
948 CRYPTO_THREAD_read_lock(ssl
->session_ctx
->lock
);
949 p
= lh_SSL_SESSION_retrieve(ssl
->session_ctx
->sessions
, &r
);
950 CRYPTO_THREAD_unlock(ssl
->session_ctx
->lock
);
954 int SSL_CTX_set_purpose(SSL_CTX
*s
, int purpose
)
956 return X509_VERIFY_PARAM_set_purpose(s
->param
, purpose
);
959 int SSL_set_purpose(SSL
*s
, int purpose
)
961 return X509_VERIFY_PARAM_set_purpose(s
->param
, purpose
);
964 int SSL_CTX_set_trust(SSL_CTX
*s
, int trust
)
966 return X509_VERIFY_PARAM_set_trust(s
->param
, trust
);
969 int SSL_set_trust(SSL
*s
, int trust
)
971 return X509_VERIFY_PARAM_set_trust(s
->param
, trust
);
974 int SSL_set1_host(SSL
*s
, const char *hostname
)
976 return X509_VERIFY_PARAM_set1_host(s
->param
, hostname
, 0);
979 int SSL_add1_host(SSL
*s
, const char *hostname
)
981 return X509_VERIFY_PARAM_add1_host(s
->param
, hostname
, 0);
984 void SSL_set_hostflags(SSL
*s
, unsigned int flags
)
986 X509_VERIFY_PARAM_set_hostflags(s
->param
, flags
);
989 const char *SSL_get0_peername(SSL
*s
)
991 return X509_VERIFY_PARAM_get0_peername(s
->param
);
994 int SSL_CTX_dane_enable(SSL_CTX
*ctx
)
996 return dane_ctx_enable(&ctx
->dane
);
999 unsigned long SSL_CTX_dane_set_flags(SSL_CTX
*ctx
, unsigned long flags
)
1001 unsigned long orig
= ctx
->dane
.flags
;
1003 ctx
->dane
.flags
|= flags
;
1007 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX
*ctx
, unsigned long flags
)
1009 unsigned long orig
= ctx
->dane
.flags
;
1011 ctx
->dane
.flags
&= ~flags
;
1015 int SSL_dane_enable(SSL
*s
, const char *basedomain
)
1017 SSL_DANE
*dane
= &s
->dane
;
1019 if (s
->ctx
->dane
.mdmax
== 0) {
1020 SSLerr(SSL_F_SSL_DANE_ENABLE
, SSL_R_CONTEXT_NOT_DANE_ENABLED
);
1023 if (dane
->trecs
!= NULL
) {
1024 SSLerr(SSL_F_SSL_DANE_ENABLE
, SSL_R_DANE_ALREADY_ENABLED
);
1029 * Default SNI name. This rejects empty names, while set1_host below
1030 * accepts them and disables host name checks. To avoid side-effects with
1031 * invalid input, set the SNI name first.
1033 if (s
->ext
.hostname
== NULL
) {
1034 if (!SSL_set_tlsext_host_name(s
, basedomain
)) {
1035 SSLerr(SSL_F_SSL_DANE_ENABLE
, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN
);
1040 /* Primary RFC6125 reference identifier */
1041 if (!X509_VERIFY_PARAM_set1_host(s
->param
, basedomain
, 0)) {
1042 SSLerr(SSL_F_SSL_DANE_ENABLE
, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN
);
1048 dane
->dctx
= &s
->ctx
->dane
;
1049 dane
->trecs
= sk_danetls_record_new_null();
1051 if (dane
->trecs
== NULL
) {
1052 SSLerr(SSL_F_SSL_DANE_ENABLE
, ERR_R_MALLOC_FAILURE
);
1058 unsigned long SSL_dane_set_flags(SSL
*ssl
, unsigned long flags
)
1060 unsigned long orig
= ssl
->dane
.flags
;
1062 ssl
->dane
.flags
|= flags
;
1066 unsigned long SSL_dane_clear_flags(SSL
*ssl
, unsigned long flags
)
1068 unsigned long orig
= ssl
->dane
.flags
;
1070 ssl
->dane
.flags
&= ~flags
;
1074 int SSL_get0_dane_authority(SSL
*s
, X509
**mcert
, EVP_PKEY
**mspki
)
1076 SSL_DANE
*dane
= &s
->dane
;
1078 if (!DANETLS_ENABLED(dane
) || s
->verify_result
!= X509_V_OK
)
1082 *mcert
= dane
->mcert
;
1084 *mspki
= (dane
->mcert
== NULL
) ? dane
->mtlsa
->spki
: NULL
;
1089 int SSL_get0_dane_tlsa(SSL
*s
, uint8_t *usage
, uint8_t *selector
,
1090 uint8_t *mtype
, unsigned const char **data
, size_t *dlen
)
1092 SSL_DANE
*dane
= &s
->dane
;
1094 if (!DANETLS_ENABLED(dane
) || s
->verify_result
!= X509_V_OK
)
1098 *usage
= dane
->mtlsa
->usage
;
1100 *selector
= dane
->mtlsa
->selector
;
1102 *mtype
= dane
->mtlsa
->mtype
;
1104 *data
= dane
->mtlsa
->data
;
1106 *dlen
= dane
->mtlsa
->dlen
;
1111 SSL_DANE
*SSL_get0_dane(SSL
*s
)
1116 int SSL_dane_tlsa_add(SSL
*s
, uint8_t usage
, uint8_t selector
,
1117 uint8_t mtype
, unsigned const char *data
, size_t dlen
)
1119 return dane_tlsa_add(&s
->dane
, usage
, selector
, mtype
, data
, dlen
);
1122 int SSL_CTX_dane_mtype_set(SSL_CTX
*ctx
, const EVP_MD
*md
, uint8_t mtype
,
1125 return dane_mtype_set(&ctx
->dane
, md
, mtype
, ord
);
1128 int SSL_CTX_set1_param(SSL_CTX
*ctx
, X509_VERIFY_PARAM
*vpm
)
1130 return X509_VERIFY_PARAM_set1(ctx
->param
, vpm
);
1133 int SSL_set1_param(SSL
*ssl
, X509_VERIFY_PARAM
*vpm
)
1135 return X509_VERIFY_PARAM_set1(ssl
->param
, vpm
);
1138 X509_VERIFY_PARAM
*SSL_CTX_get0_param(SSL_CTX
*ctx
)
1143 X509_VERIFY_PARAM
*SSL_get0_param(SSL
*ssl
)
1148 void SSL_certs_clear(SSL
*s
)
1150 ssl_cert_clear_certs(s
->cert
);
1153 void SSL_free(SSL
*s
)
1159 CRYPTO_DOWN_REF(&s
->references
, &i
, s
->lock
);
1160 REF_PRINT_COUNT("SSL", s
);
1163 REF_ASSERT_ISNT(i
< 0);
1165 X509_VERIFY_PARAM_free(s
->param
);
1166 dane_final(&s
->dane
);
1167 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL
, s
, &s
->ex_data
);
1169 RECORD_LAYER_release(&s
->rlayer
);
1171 /* Ignore return value */
1172 ssl_free_wbio_buffer(s
);
1174 BIO_free_all(s
->wbio
);
1176 BIO_free_all(s
->rbio
);
1179 BUF_MEM_free(s
->init_buf
);
1181 /* add extra stuff */
1182 sk_SSL_CIPHER_free(s
->cipher_list
);
1183 sk_SSL_CIPHER_free(s
->cipher_list_by_id
);
1184 sk_SSL_CIPHER_free(s
->tls13_ciphersuites
);
1185 sk_SSL_CIPHER_free(s
->peer_ciphers
);
1187 /* Make the next call work :-) */
1188 if (s
->session
!= NULL
) {
1189 ssl_clear_bad_session(s
);
1190 SSL_SESSION_free(s
->session
);
1192 SSL_SESSION_free(s
->psksession
);
1193 OPENSSL_free(s
->psksession_id
);
1197 ssl_cert_free(s
->cert
);
1198 OPENSSL_free(s
->shared_sigalgs
);
1199 /* Free up if allocated */
1201 OPENSSL_free(s
->ext
.hostname
);
1202 SSL_CTX_free(s
->session_ctx
);
1203 #ifndef OPENSSL_NO_EC
1204 OPENSSL_free(s
->ext
.ecpointformats
);
1205 OPENSSL_free(s
->ext
.peer_ecpointformats
);
1206 #endif /* OPENSSL_NO_EC */
1207 OPENSSL_free(s
->ext
.supportedgroups
);
1208 OPENSSL_free(s
->ext
.peer_supportedgroups
);
1209 sk_X509_EXTENSION_pop_free(s
->ext
.ocsp
.exts
, X509_EXTENSION_free
);
1210 #ifndef OPENSSL_NO_OCSP
1211 sk_OCSP_RESPID_pop_free(s
->ext
.ocsp
.ids
, OCSP_RESPID_free
);
1213 #ifndef OPENSSL_NO_CT
1214 SCT_LIST_free(s
->scts
);
1215 OPENSSL_free(s
->ext
.scts
);
1217 OPENSSL_free(s
->ext
.ocsp
.resp
);
1218 OPENSSL_free(s
->ext
.alpn
);
1219 OPENSSL_free(s
->ext
.tls13_cookie
);
1220 OPENSSL_free(s
->clienthello
);
1221 OPENSSL_free(s
->pha_context
);
1222 EVP_MD_CTX_free(s
->pha_dgst
);
1224 sk_X509_NAME_pop_free(s
->ca_names
, X509_NAME_free
);
1225 sk_X509_NAME_pop_free(s
->client_ca_names
, X509_NAME_free
);
1227 sk_X509_pop_free(s
->verified_chain
, X509_free
);
1229 if (s
->method
!= NULL
)
1230 s
->method
->ssl_free(s
);
1232 SSL_CTX_free(s
->ctx
);
1234 ASYNC_WAIT_CTX_free(s
->waitctx
);
1236 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1237 OPENSSL_free(s
->ext
.npn
);
1240 #ifndef OPENSSL_NO_SRTP
1241 sk_SRTP_PROTECTION_PROFILE_free(s
->srtp_profiles
);
1244 CRYPTO_THREAD_lock_free(s
->lock
);
1249 void SSL_set0_rbio(SSL
*s
, BIO
*rbio
)
1251 BIO_free_all(s
->rbio
);
1255 void SSL_set0_wbio(SSL
*s
, BIO
*wbio
)
1258 * If the output buffering BIO is still in place, remove it
1260 if (s
->bbio
!= NULL
)
1261 s
->wbio
= BIO_pop(s
->wbio
);
1263 BIO_free_all(s
->wbio
);
1266 /* Re-attach |bbio| to the new |wbio|. */
1267 if (s
->bbio
!= NULL
)
1268 s
->wbio
= BIO_push(s
->bbio
, s
->wbio
);
1271 void SSL_set_bio(SSL
*s
, BIO
*rbio
, BIO
*wbio
)
1274 * For historical reasons, this function has many different cases in
1275 * ownership handling.
1278 /* If nothing has changed, do nothing */
1279 if (rbio
== SSL_get_rbio(s
) && wbio
== SSL_get_wbio(s
))
1283 * If the two arguments are equal then one fewer reference is granted by the
1284 * caller than we want to take
1286 if (rbio
!= NULL
&& rbio
== wbio
)
1290 * If only the wbio is changed only adopt one reference.
1292 if (rbio
== SSL_get_rbio(s
)) {
1293 SSL_set0_wbio(s
, wbio
);
1297 * There is an asymmetry here for historical reasons. If only the rbio is
1298 * changed AND the rbio and wbio were originally different, then we only
1299 * adopt one reference.
1301 if (wbio
== SSL_get_wbio(s
) && SSL_get_rbio(s
) != SSL_get_wbio(s
)) {
1302 SSL_set0_rbio(s
, rbio
);
1306 /* Otherwise, adopt both references. */
1307 SSL_set0_rbio(s
, rbio
);
1308 SSL_set0_wbio(s
, wbio
);
1311 BIO
*SSL_get_rbio(const SSL
*s
)
1316 BIO
*SSL_get_wbio(const SSL
*s
)
1318 if (s
->bbio
!= NULL
) {
1320 * If |bbio| is active, the true caller-configured BIO is its
1323 return BIO_next(s
->bbio
);
1328 int SSL_get_fd(const SSL
*s
)
1330 return SSL_get_rfd(s
);
1333 int SSL_get_rfd(const SSL
*s
)
1338 b
= SSL_get_rbio(s
);
1339 r
= BIO_find_type(b
, BIO_TYPE_DESCRIPTOR
);
1341 BIO_get_fd(r
, &ret
);
1345 int SSL_get_wfd(const SSL
*s
)
1350 b
= SSL_get_wbio(s
);
1351 r
= BIO_find_type(b
, BIO_TYPE_DESCRIPTOR
);
1353 BIO_get_fd(r
, &ret
);
1357 #ifndef OPENSSL_NO_SOCK
1358 int SSL_set_fd(SSL
*s
, int fd
)
1363 bio
= BIO_new(BIO_s_socket());
1366 SSLerr(SSL_F_SSL_SET_FD
, ERR_R_BUF_LIB
);
1369 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1370 SSL_set_bio(s
, bio
, bio
);
1371 #ifndef OPENSSL_NO_KTLS
1373 * The new socket is created successfully regardless of ktls_enable.
1374 * ktls_enable doesn't change any functionality of the socket, except
1375 * changing the setsockopt to enable the processing of ktls_start.
1376 * Thus, it is not a problem to call it for non-TLS sockets.
1379 #endif /* OPENSSL_NO_KTLS */
1385 int SSL_set_wfd(SSL
*s
, int fd
)
1387 BIO
*rbio
= SSL_get_rbio(s
);
1389 if (rbio
== NULL
|| BIO_method_type(rbio
) != BIO_TYPE_SOCKET
1390 || (int)BIO_get_fd(rbio
, NULL
) != fd
) {
1391 BIO
*bio
= BIO_new(BIO_s_socket());
1394 SSLerr(SSL_F_SSL_SET_WFD
, ERR_R_BUF_LIB
);
1397 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1398 SSL_set0_wbio(s
, bio
);
1399 #ifndef OPENSSL_NO_KTLS
1401 * The new socket is created successfully regardless of ktls_enable.
1402 * ktls_enable doesn't change any functionality of the socket, except
1403 * changing the setsockopt to enable the processing of ktls_start.
1404 * Thus, it is not a problem to call it for non-TLS sockets.
1407 #endif /* OPENSSL_NO_KTLS */
1410 SSL_set0_wbio(s
, rbio
);
1415 int SSL_set_rfd(SSL
*s
, int fd
)
1417 BIO
*wbio
= SSL_get_wbio(s
);
1419 if (wbio
== NULL
|| BIO_method_type(wbio
) != BIO_TYPE_SOCKET
1420 || ((int)BIO_get_fd(wbio
, NULL
) != fd
)) {
1421 BIO
*bio
= BIO_new(BIO_s_socket());
1424 SSLerr(SSL_F_SSL_SET_RFD
, ERR_R_BUF_LIB
);
1427 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1428 SSL_set0_rbio(s
, bio
);
1431 SSL_set0_rbio(s
, wbio
);
1438 /* return length of latest Finished message we sent, copy to 'buf' */
1439 size_t SSL_get_finished(const SSL
*s
, void *buf
, size_t count
)
1443 ret
= s
->s3
.tmp
.finish_md_len
;
1446 memcpy(buf
, s
->s3
.tmp
.finish_md
, count
);
1450 /* return length of latest Finished message we expected, copy to 'buf' */
1451 size_t SSL_get_peer_finished(const SSL
*s
, void *buf
, size_t count
)
1455 ret
= s
->s3
.tmp
.peer_finish_md_len
;
1458 memcpy(buf
, s
->s3
.tmp
.peer_finish_md
, count
);
1462 int SSL_get_verify_mode(const SSL
*s
)
1464 return s
->verify_mode
;
1467 int SSL_get_verify_depth(const SSL
*s
)
1469 return X509_VERIFY_PARAM_get_depth(s
->param
);
1472 int (*SSL_get_verify_callback(const SSL
*s
)) (int, X509_STORE_CTX
*) {
1473 return s
->verify_callback
;
1476 int SSL_CTX_get_verify_mode(const SSL_CTX
*ctx
)
1478 return ctx
->verify_mode
;
1481 int SSL_CTX_get_verify_depth(const SSL_CTX
*ctx
)
1483 return X509_VERIFY_PARAM_get_depth(ctx
->param
);
1486 int (*SSL_CTX_get_verify_callback(const SSL_CTX
*ctx
)) (int, X509_STORE_CTX
*) {
1487 return ctx
->default_verify_callback
;
1490 void SSL_set_verify(SSL
*s
, int mode
,
1491 int (*callback
) (int ok
, X509_STORE_CTX
*ctx
))
1493 s
->verify_mode
= mode
;
1494 if (callback
!= NULL
)
1495 s
->verify_callback
= callback
;
1498 void SSL_set_verify_depth(SSL
*s
, int depth
)
1500 X509_VERIFY_PARAM_set_depth(s
->param
, depth
);
1503 void SSL_set_read_ahead(SSL
*s
, int yes
)
1505 RECORD_LAYER_set_read_ahead(&s
->rlayer
, yes
);
1508 int SSL_get_read_ahead(const SSL
*s
)
1510 return RECORD_LAYER_get_read_ahead(&s
->rlayer
);
1513 int SSL_pending(const SSL
*s
)
1515 size_t pending
= s
->method
->ssl_pending(s
);
1518 * SSL_pending cannot work properly if read-ahead is enabled
1519 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1520 * impossible to fix since SSL_pending cannot report errors that may be
1521 * observed while scanning the new data. (Note that SSL_pending() is
1522 * often used as a boolean value, so we'd better not return -1.)
1524 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1525 * we just return INT_MAX.
1527 return pending
< INT_MAX
? (int)pending
: INT_MAX
;
1530 int SSL_has_pending(const SSL
*s
)
1533 * Similar to SSL_pending() but returns a 1 to indicate that we have
1534 * unprocessed data available or 0 otherwise (as opposed to the number of
1535 * bytes available). Unlike SSL_pending() this will take into account
1536 * read_ahead data. A 1 return simply indicates that we have unprocessed
1537 * data. That data may not result in any application data, or we may fail
1538 * to parse the records for some reason.
1540 if (RECORD_LAYER_processed_read_pending(&s
->rlayer
))
1543 return RECORD_LAYER_read_pending(&s
->rlayer
);
1546 X509
*SSL_get_peer_certificate(const SSL
*s
)
1550 if ((s
== NULL
) || (s
->session
== NULL
))
1553 r
= s
->session
->peer
;
1563 STACK_OF(X509
) *SSL_get_peer_cert_chain(const SSL
*s
)
1567 if ((s
== NULL
) || (s
->session
== NULL
))
1570 r
= s
->session
->peer_chain
;
1573 * If we are a client, cert_chain includes the peer's own certificate; if
1574 * we are a server, it does not.
1581 * Now in theory, since the calling process own 't' it should be safe to
1582 * modify. We need to be able to read f without being hassled
1584 int SSL_copy_session_id(SSL
*t
, const SSL
*f
)
1587 /* Do we need to to SSL locking? */
1588 if (!SSL_set_session(t
, SSL_get_session(f
))) {
1593 * what if we are setup for one protocol version but want to talk another
1595 if (t
->method
!= f
->method
) {
1596 t
->method
->ssl_free(t
);
1597 t
->method
= f
->method
;
1598 if (t
->method
->ssl_new(t
) == 0)
1602 CRYPTO_UP_REF(&f
->cert
->references
, &i
, f
->cert
->lock
);
1603 ssl_cert_free(t
->cert
);
1605 if (!SSL_set_session_id_context(t
, f
->sid_ctx
, (int)f
->sid_ctx_length
)) {
1612 /* Fix this so it checks all the valid key/cert options */
1613 int SSL_CTX_check_private_key(const SSL_CTX
*ctx
)
1615 if ((ctx
== NULL
) || (ctx
->cert
->key
->x509
== NULL
)) {
1616 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY
, SSL_R_NO_CERTIFICATE_ASSIGNED
);
1619 if (ctx
->cert
->key
->privatekey
== NULL
) {
1620 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY
, SSL_R_NO_PRIVATE_KEY_ASSIGNED
);
1623 return X509_check_private_key
1624 (ctx
->cert
->key
->x509
, ctx
->cert
->key
->privatekey
);
1627 /* Fix this function so that it takes an optional type parameter */
1628 int SSL_check_private_key(const SSL
*ssl
)
1631 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY
, ERR_R_PASSED_NULL_PARAMETER
);
1634 if (ssl
->cert
->key
->x509
== NULL
) {
1635 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY
, SSL_R_NO_CERTIFICATE_ASSIGNED
);
1638 if (ssl
->cert
->key
->privatekey
== NULL
) {
1639 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY
, SSL_R_NO_PRIVATE_KEY_ASSIGNED
);
1642 return X509_check_private_key(ssl
->cert
->key
->x509
,
1643 ssl
->cert
->key
->privatekey
);
1646 int SSL_waiting_for_async(SSL
*s
)
1654 int SSL_get_all_async_fds(SSL
*s
, OSSL_ASYNC_FD
*fds
, size_t *numfds
)
1656 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1660 return ASYNC_WAIT_CTX_get_all_fds(ctx
, fds
, numfds
);
1663 int SSL_get_changed_async_fds(SSL
*s
, OSSL_ASYNC_FD
*addfd
, size_t *numaddfds
,
1664 OSSL_ASYNC_FD
*delfd
, size_t *numdelfds
)
1666 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1670 return ASYNC_WAIT_CTX_get_changed_fds(ctx
, addfd
, numaddfds
, delfd
,
1674 int SSL_CTX_set_async_callback(SSL_CTX
*ctx
, SSL_async_callback_fn callback
)
1676 ctx
->async_cb
= callback
;
1680 int SSL_CTX_set_async_callback_arg(SSL_CTX
*ctx
, void *arg
)
1682 ctx
->async_cb_arg
= arg
;
1686 int SSL_set_async_callback(SSL
*s
, SSL_async_callback_fn callback
)
1688 s
->async_cb
= callback
;
1692 int SSL_set_async_callback_arg(SSL
*s
, void *arg
)
1694 s
->async_cb_arg
= arg
;
1698 int SSL_get_async_status(SSL
*s
, int *status
)
1700 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1704 *status
= ASYNC_WAIT_CTX_get_status(ctx
);
1708 int SSL_accept(SSL
*s
)
1710 if (s
->handshake_func
== NULL
) {
1711 /* Not properly initialized yet */
1712 SSL_set_accept_state(s
);
1715 return SSL_do_handshake(s
);
1718 int SSL_connect(SSL
*s
)
1720 if (s
->handshake_func
== NULL
) {
1721 /* Not properly initialized yet */
1722 SSL_set_connect_state(s
);
1725 return SSL_do_handshake(s
);
1728 long SSL_get_default_timeout(const SSL
*s
)
1730 return s
->method
->get_timeout();
1733 static int ssl_async_wait_ctx_cb(void *arg
)
1735 SSL
*s
= (SSL
*)arg
;
1737 return s
->async_cb(s
, s
->async_cb_arg
);
1740 static int ssl_start_async_job(SSL
*s
, struct ssl_async_args
*args
,
1741 int (*func
) (void *))
1744 if (s
->waitctx
== NULL
) {
1745 s
->waitctx
= ASYNC_WAIT_CTX_new();
1746 if (s
->waitctx
== NULL
)
1748 if (s
->async_cb
!= NULL
1749 && !ASYNC_WAIT_CTX_set_callback
1750 (s
->waitctx
, ssl_async_wait_ctx_cb
, s
))
1753 switch (ASYNC_start_job(&s
->job
, s
->waitctx
, &ret
, func
, args
,
1754 sizeof(struct ssl_async_args
))) {
1756 s
->rwstate
= SSL_NOTHING
;
1757 SSLerr(SSL_F_SSL_START_ASYNC_JOB
, SSL_R_FAILED_TO_INIT_ASYNC
);
1760 s
->rwstate
= SSL_ASYNC_PAUSED
;
1763 s
->rwstate
= SSL_ASYNC_NO_JOBS
;
1769 s
->rwstate
= SSL_NOTHING
;
1770 SSLerr(SSL_F_SSL_START_ASYNC_JOB
, ERR_R_INTERNAL_ERROR
);
1771 /* Shouldn't happen */
1776 static int ssl_io_intern(void *vargs
)
1778 struct ssl_async_args
*args
;
1783 args
= (struct ssl_async_args
*)vargs
;
1787 switch (args
->type
) {
1789 return args
->f
.func_read(s
, buf
, num
, &s
->asyncrw
);
1791 return args
->f
.func_write(s
, buf
, num
, &s
->asyncrw
);
1793 return args
->f
.func_other(s
);
1798 int ssl_read_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1800 if (s
->handshake_func
== NULL
) {
1801 SSLerr(SSL_F_SSL_READ_INTERNAL
, SSL_R_UNINITIALIZED
);
1805 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1806 s
->rwstate
= SSL_NOTHING
;
1810 if (s
->early_data_state
== SSL_EARLY_DATA_CONNECT_RETRY
1811 || s
->early_data_state
== SSL_EARLY_DATA_ACCEPT_RETRY
) {
1812 SSLerr(SSL_F_SSL_READ_INTERNAL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1816 * If we are a client and haven't received the ServerHello etc then we
1819 ossl_statem_check_finish_init(s
, 0);
1821 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1822 struct ssl_async_args args
;
1828 args
.type
= READFUNC
;
1829 args
.f
.func_read
= s
->method
->ssl_read
;
1831 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
1832 *readbytes
= s
->asyncrw
;
1835 return s
->method
->ssl_read(s
, buf
, num
, readbytes
);
1839 int SSL_read(SSL
*s
, void *buf
, int num
)
1845 SSLerr(SSL_F_SSL_READ
, SSL_R_BAD_LENGTH
);
1849 ret
= ssl_read_internal(s
, buf
, (size_t)num
, &readbytes
);
1852 * The cast is safe here because ret should be <= INT_MAX because num is
1856 ret
= (int)readbytes
;
1861 int SSL_read_ex(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1863 int ret
= ssl_read_internal(s
, buf
, num
, readbytes
);
1870 int SSL_read_early_data(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1875 SSLerr(SSL_F_SSL_READ_EARLY_DATA
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1876 return SSL_READ_EARLY_DATA_ERROR
;
1879 switch (s
->early_data_state
) {
1880 case SSL_EARLY_DATA_NONE
:
1881 if (!SSL_in_before(s
)) {
1882 SSLerr(SSL_F_SSL_READ_EARLY_DATA
,
1883 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1884 return SSL_READ_EARLY_DATA_ERROR
;
1888 case SSL_EARLY_DATA_ACCEPT_RETRY
:
1889 s
->early_data_state
= SSL_EARLY_DATA_ACCEPTING
;
1890 ret
= SSL_accept(s
);
1893 s
->early_data_state
= SSL_EARLY_DATA_ACCEPT_RETRY
;
1894 return SSL_READ_EARLY_DATA_ERROR
;
1898 case SSL_EARLY_DATA_READ_RETRY
:
1899 if (s
->ext
.early_data
== SSL_EARLY_DATA_ACCEPTED
) {
1900 s
->early_data_state
= SSL_EARLY_DATA_READING
;
1901 ret
= SSL_read_ex(s
, buf
, num
, readbytes
);
1903 * State machine will update early_data_state to
1904 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1907 if (ret
> 0 || (ret
<= 0 && s
->early_data_state
1908 != SSL_EARLY_DATA_FINISHED_READING
)) {
1909 s
->early_data_state
= SSL_EARLY_DATA_READ_RETRY
;
1910 return ret
> 0 ? SSL_READ_EARLY_DATA_SUCCESS
1911 : SSL_READ_EARLY_DATA_ERROR
;
1914 s
->early_data_state
= SSL_EARLY_DATA_FINISHED_READING
;
1917 return SSL_READ_EARLY_DATA_FINISH
;
1920 SSLerr(SSL_F_SSL_READ_EARLY_DATA
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1921 return SSL_READ_EARLY_DATA_ERROR
;
1925 int SSL_get_early_data_status(const SSL
*s
)
1927 return s
->ext
.early_data
;
1930 static int ssl_peek_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1932 if (s
->handshake_func
== NULL
) {
1933 SSLerr(SSL_F_SSL_PEEK_INTERNAL
, SSL_R_UNINITIALIZED
);
1937 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1940 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1941 struct ssl_async_args args
;
1947 args
.type
= READFUNC
;
1948 args
.f
.func_read
= s
->method
->ssl_peek
;
1950 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
1951 *readbytes
= s
->asyncrw
;
1954 return s
->method
->ssl_peek(s
, buf
, num
, readbytes
);
1958 int SSL_peek(SSL
*s
, void *buf
, int num
)
1964 SSLerr(SSL_F_SSL_PEEK
, SSL_R_BAD_LENGTH
);
1968 ret
= ssl_peek_internal(s
, buf
, (size_t)num
, &readbytes
);
1971 * The cast is safe here because ret should be <= INT_MAX because num is
1975 ret
= (int)readbytes
;
1981 int SSL_peek_ex(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1983 int ret
= ssl_peek_internal(s
, buf
, num
, readbytes
);
1990 int ssl_write_internal(SSL
*s
, const void *buf
, size_t num
, size_t *written
)
1992 if (s
->handshake_func
== NULL
) {
1993 SSLerr(SSL_F_SSL_WRITE_INTERNAL
, SSL_R_UNINITIALIZED
);
1997 if (s
->shutdown
& SSL_SENT_SHUTDOWN
) {
1998 s
->rwstate
= SSL_NOTHING
;
1999 SSLerr(SSL_F_SSL_WRITE_INTERNAL
, SSL_R_PROTOCOL_IS_SHUTDOWN
);
2003 if (s
->early_data_state
== SSL_EARLY_DATA_CONNECT_RETRY
2004 || s
->early_data_state
== SSL_EARLY_DATA_ACCEPT_RETRY
2005 || s
->early_data_state
== SSL_EARLY_DATA_READ_RETRY
) {
2006 SSLerr(SSL_F_SSL_WRITE_INTERNAL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
2009 /* If we are a client and haven't sent the Finished we better do that */
2010 ossl_statem_check_finish_init(s
, 1);
2012 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
2014 struct ssl_async_args args
;
2017 args
.buf
= (void *)buf
;
2019 args
.type
= WRITEFUNC
;
2020 args
.f
.func_write
= s
->method
->ssl_write
;
2022 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
2023 *written
= s
->asyncrw
;
2026 return s
->method
->ssl_write(s
, buf
, num
, written
);
2030 ossl_ssize_t
SSL_sendfile(SSL
*s
, int fd
, off_t offset
, size_t size
, int flags
)
2034 if (s
->handshake_func
== NULL
) {
2035 SSLerr(SSL_F_SSL_SENDFILE
, SSL_R_UNINITIALIZED
);
2039 if (s
->shutdown
& SSL_SENT_SHUTDOWN
) {
2040 s
->rwstate
= SSL_NOTHING
;
2041 SSLerr(SSL_F_SSL_SENDFILE
, SSL_R_PROTOCOL_IS_SHUTDOWN
);
2045 if (!BIO_get_ktls_send(s
->wbio
)) {
2046 SSLerr(SSL_F_SSL_SENDFILE
, SSL_R_UNINITIALIZED
);
2050 /* If we have an alert to send, lets send it */
2051 if (s
->s3
.alert_dispatch
) {
2052 ret
= (ossl_ssize_t
)s
->method
->ssl_dispatch_alert(s
);
2054 /* SSLfatal() already called if appropriate */
2057 /* if it went, fall through and send more stuff */
2060 s
->rwstate
= SSL_WRITING
;
2061 if (BIO_flush(s
->wbio
) <= 0) {
2062 if (!BIO_should_retry(s
->wbio
)) {
2063 s
->rwstate
= SSL_NOTHING
;
2066 set_sys_error(EAGAIN
);
2072 #ifdef OPENSSL_NO_KTLS
2073 ERR_raise_data(ERR_LIB_SYS
, ERR_R_INTERNAL_ERROR
, "calling sendfile()");
2076 ret
= ktls_sendfile(SSL_get_wfd(s
), fd
, offset
, size
, flags
);
2078 #if defined(EAGAIN) && defined(EINTR) && defined(EBUSY)
2079 if ((get_last_sys_error() == EAGAIN
) ||
2080 (get_last_sys_error() == EINTR
) ||
2081 (get_last_sys_error() == EBUSY
))
2082 BIO_set_retry_write(s
->wbio
);
2085 SSLerr(SSL_F_SSL_SENDFILE
, SSL_R_UNINITIALIZED
);
2088 s
->rwstate
= SSL_NOTHING
;
2093 int SSL_write(SSL
*s
, const void *buf
, int num
)
2099 SSLerr(SSL_F_SSL_WRITE
, SSL_R_BAD_LENGTH
);
2103 ret
= ssl_write_internal(s
, buf
, (size_t)num
, &written
);
2106 * The cast is safe here because ret should be <= INT_MAX because num is
2115 int SSL_write_ex(SSL
*s
, const void *buf
, size_t num
, size_t *written
)
2117 int ret
= ssl_write_internal(s
, buf
, num
, written
);
2124 int SSL_write_early_data(SSL
*s
, const void *buf
, size_t num
, size_t *written
)
2126 int ret
, early_data_state
;
2128 uint32_t partialwrite
;
2130 switch (s
->early_data_state
) {
2131 case SSL_EARLY_DATA_NONE
:
2133 || !SSL_in_before(s
)
2134 || ((s
->session
== NULL
|| s
->session
->ext
.max_early_data
== 0)
2135 && (s
->psk_use_session_cb
== NULL
))) {
2136 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA
,
2137 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
2142 case SSL_EARLY_DATA_CONNECT_RETRY
:
2143 s
->early_data_state
= SSL_EARLY_DATA_CONNECTING
;
2144 ret
= SSL_connect(s
);
2147 s
->early_data_state
= SSL_EARLY_DATA_CONNECT_RETRY
;
2152 case SSL_EARLY_DATA_WRITE_RETRY
:
2153 s
->early_data_state
= SSL_EARLY_DATA_WRITING
;
2155 * We disable partial write for early data because we don't keep track
2156 * of how many bytes we've written between the SSL_write_ex() call and
2157 * the flush if the flush needs to be retried)
2159 partialwrite
= s
->mode
& SSL_MODE_ENABLE_PARTIAL_WRITE
;
2160 s
->mode
&= ~SSL_MODE_ENABLE_PARTIAL_WRITE
;
2161 ret
= SSL_write_ex(s
, buf
, num
, &writtmp
);
2162 s
->mode
|= partialwrite
;
2164 s
->early_data_state
= SSL_EARLY_DATA_WRITE_RETRY
;
2167 s
->early_data_state
= SSL_EARLY_DATA_WRITE_FLUSH
;
2170 case SSL_EARLY_DATA_WRITE_FLUSH
:
2171 /* The buffering BIO is still in place so we need to flush it */
2172 if (statem_flush(s
) != 1)
2175 s
->early_data_state
= SSL_EARLY_DATA_WRITE_RETRY
;
2178 case SSL_EARLY_DATA_FINISHED_READING
:
2179 case SSL_EARLY_DATA_READ_RETRY
:
2180 early_data_state
= s
->early_data_state
;
2181 /* We are a server writing to an unauthenticated client */
2182 s
->early_data_state
= SSL_EARLY_DATA_UNAUTH_WRITING
;
2183 ret
= SSL_write_ex(s
, buf
, num
, written
);
2184 /* The buffering BIO is still in place */
2186 (void)BIO_flush(s
->wbio
);
2187 s
->early_data_state
= early_data_state
;
2191 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
2196 int SSL_shutdown(SSL
*s
)
2199 * Note that this function behaves differently from what one might
2200 * expect. Return values are 0 for no success (yet), 1 for success; but
2201 * calling it once is usually not enough, even if blocking I/O is used
2202 * (see ssl3_shutdown).
2205 if (s
->handshake_func
== NULL
) {
2206 SSLerr(SSL_F_SSL_SHUTDOWN
, SSL_R_UNINITIALIZED
);
2210 if (!SSL_in_init(s
)) {
2211 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
2212 struct ssl_async_args args
;
2215 args
.type
= OTHERFUNC
;
2216 args
.f
.func_other
= s
->method
->ssl_shutdown
;
2218 return ssl_start_async_job(s
, &args
, ssl_io_intern
);
2220 return s
->method
->ssl_shutdown(s
);
2223 SSLerr(SSL_F_SSL_SHUTDOWN
, SSL_R_SHUTDOWN_WHILE_IN_INIT
);
2228 int SSL_key_update(SSL
*s
, int updatetype
)
2231 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2232 * negotiated, and that it is appropriate to call SSL_key_update() instead
2233 * of SSL_renegotiate().
2235 if (!SSL_IS_TLS13(s
)) {
2236 SSLerr(SSL_F_SSL_KEY_UPDATE
, SSL_R_WRONG_SSL_VERSION
);
2240 if (updatetype
!= SSL_KEY_UPDATE_NOT_REQUESTED
2241 && updatetype
!= SSL_KEY_UPDATE_REQUESTED
) {
2242 SSLerr(SSL_F_SSL_KEY_UPDATE
, SSL_R_INVALID_KEY_UPDATE_TYPE
);
2246 if (!SSL_is_init_finished(s
)) {
2247 SSLerr(SSL_F_SSL_KEY_UPDATE
, SSL_R_STILL_IN_INIT
);
2251 ossl_statem_set_in_init(s
, 1);
2252 s
->key_update
= updatetype
;
2256 int SSL_get_key_update_type(const SSL
*s
)
2258 return s
->key_update
;
2261 int SSL_renegotiate(SSL
*s
)
2263 if (SSL_IS_TLS13(s
)) {
2264 SSLerr(SSL_F_SSL_RENEGOTIATE
, SSL_R_WRONG_SSL_VERSION
);
2268 if ((s
->options
& SSL_OP_NO_RENEGOTIATION
)) {
2269 SSLerr(SSL_F_SSL_RENEGOTIATE
, SSL_R_NO_RENEGOTIATION
);
2276 return s
->method
->ssl_renegotiate(s
);
2279 int SSL_renegotiate_abbreviated(SSL
*s
)
2281 if (SSL_IS_TLS13(s
)) {
2282 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED
, SSL_R_WRONG_SSL_VERSION
);
2286 if ((s
->options
& SSL_OP_NO_RENEGOTIATION
)) {
2287 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED
, SSL_R_NO_RENEGOTIATION
);
2294 return s
->method
->ssl_renegotiate(s
);
2297 int SSL_renegotiate_pending(const SSL
*s
)
2300 * becomes true when negotiation is requested; false again once a
2301 * handshake has finished
2303 return (s
->renegotiate
!= 0);
2306 int SSL_new_session_ticket(SSL
*s
)
2308 if (SSL_in_init(s
) || SSL_IS_FIRST_HANDSHAKE(s
) || !s
->server
2309 || !SSL_IS_TLS13(s
))
2311 s
->ext
.extra_tickets_expected
++;
2315 long SSL_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
)
2320 case SSL_CTRL_GET_READ_AHEAD
:
2321 return RECORD_LAYER_get_read_ahead(&s
->rlayer
);
2322 case SSL_CTRL_SET_READ_AHEAD
:
2323 l
= RECORD_LAYER_get_read_ahead(&s
->rlayer
);
2324 RECORD_LAYER_set_read_ahead(&s
->rlayer
, larg
);
2327 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
2328 s
->msg_callback_arg
= parg
;
2332 return (s
->mode
|= larg
);
2333 case SSL_CTRL_CLEAR_MODE
:
2334 return (s
->mode
&= ~larg
);
2335 case SSL_CTRL_GET_MAX_CERT_LIST
:
2336 return (long)s
->max_cert_list
;
2337 case SSL_CTRL_SET_MAX_CERT_LIST
:
2340 l
= (long)s
->max_cert_list
;
2341 s
->max_cert_list
= (size_t)larg
;
2343 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
2344 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
2346 #ifndef OPENSSL_NO_KTLS
2347 if (s
->wbio
!= NULL
&& BIO_get_ktls_send(s
->wbio
))
2349 #endif /* OPENSSL_NO_KTLS */
2350 s
->max_send_fragment
= larg
;
2351 if (s
->max_send_fragment
< s
->split_send_fragment
)
2352 s
->split_send_fragment
= s
->max_send_fragment
;
2354 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
2355 if ((size_t)larg
> s
->max_send_fragment
|| larg
== 0)
2357 s
->split_send_fragment
= larg
;
2359 case SSL_CTRL_SET_MAX_PIPELINES
:
2360 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
2362 s
->max_pipelines
= larg
;
2364 RECORD_LAYER_set_read_ahead(&s
->rlayer
, 1);
2366 case SSL_CTRL_GET_RI_SUPPORT
:
2367 return s
->s3
.send_connection_binding
;
2368 case SSL_CTRL_CERT_FLAGS
:
2369 return (s
->cert
->cert_flags
|= larg
);
2370 case SSL_CTRL_CLEAR_CERT_FLAGS
:
2371 return (s
->cert
->cert_flags
&= ~larg
);
2373 case SSL_CTRL_GET_RAW_CIPHERLIST
:
2375 if (s
->s3
.tmp
.ciphers_raw
== NULL
)
2377 *(unsigned char **)parg
= s
->s3
.tmp
.ciphers_raw
;
2378 return (int)s
->s3
.tmp
.ciphers_rawlen
;
2380 return TLS_CIPHER_LEN
;
2382 case SSL_CTRL_GET_EXTMS_SUPPORT
:
2383 if (!s
->session
|| SSL_in_init(s
) || ossl_statem_get_in_handshake(s
))
2385 if (s
->session
->flags
& SSL_SESS_FLAG_EXTMS
)
2389 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
2390 return ssl_check_allowed_versions(larg
, s
->max_proto_version
)
2391 && ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
2392 &s
->min_proto_version
);
2393 case SSL_CTRL_GET_MIN_PROTO_VERSION
:
2394 return s
->min_proto_version
;
2395 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
2396 return ssl_check_allowed_versions(s
->min_proto_version
, larg
)
2397 && ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
2398 &s
->max_proto_version
);
2399 case SSL_CTRL_GET_MAX_PROTO_VERSION
:
2400 return s
->max_proto_version
;
2402 return s
->method
->ssl_ctrl(s
, cmd
, larg
, parg
);
2406 long SSL_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void))
2409 case SSL_CTRL_SET_MSG_CALLBACK
:
2410 s
->msg_callback
= (void (*)
2411 (int write_p
, int version
, int content_type
,
2412 const void *buf
, size_t len
, SSL
*ssl
,
2417 return s
->method
->ssl_callback_ctrl(s
, cmd
, fp
);
2421 LHASH_OF(SSL_SESSION
) *SSL_CTX_sessions(SSL_CTX
*ctx
)
2423 return ctx
->sessions
;
2426 long SSL_CTX_ctrl(SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
)
2429 /* For some cases with ctx == NULL perform syntax checks */
2432 #ifndef OPENSSL_NO_EC
2433 case SSL_CTRL_SET_GROUPS_LIST
:
2434 return tls1_set_groups_list(NULL
, NULL
, parg
);
2436 case SSL_CTRL_SET_SIGALGS_LIST
:
2437 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST
:
2438 return tls1_set_sigalgs_list(NULL
, parg
, 0);
2445 case SSL_CTRL_GET_READ_AHEAD
:
2446 return ctx
->read_ahead
;
2447 case SSL_CTRL_SET_READ_AHEAD
:
2448 l
= ctx
->read_ahead
;
2449 ctx
->read_ahead
= larg
;
2452 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
2453 ctx
->msg_callback_arg
= parg
;
2456 case SSL_CTRL_GET_MAX_CERT_LIST
:
2457 return (long)ctx
->max_cert_list
;
2458 case SSL_CTRL_SET_MAX_CERT_LIST
:
2461 l
= (long)ctx
->max_cert_list
;
2462 ctx
->max_cert_list
= (size_t)larg
;
2465 case SSL_CTRL_SET_SESS_CACHE_SIZE
:
2468 l
= (long)ctx
->session_cache_size
;
2469 ctx
->session_cache_size
= (size_t)larg
;
2471 case SSL_CTRL_GET_SESS_CACHE_SIZE
:
2472 return (long)ctx
->session_cache_size
;
2473 case SSL_CTRL_SET_SESS_CACHE_MODE
:
2474 l
= ctx
->session_cache_mode
;
2475 ctx
->session_cache_mode
= larg
;
2477 case SSL_CTRL_GET_SESS_CACHE_MODE
:
2478 return ctx
->session_cache_mode
;
2480 case SSL_CTRL_SESS_NUMBER
:
2481 return lh_SSL_SESSION_num_items(ctx
->sessions
);
2482 case SSL_CTRL_SESS_CONNECT
:
2483 return tsan_load(&ctx
->stats
.sess_connect
);
2484 case SSL_CTRL_SESS_CONNECT_GOOD
:
2485 return tsan_load(&ctx
->stats
.sess_connect_good
);
2486 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE
:
2487 return tsan_load(&ctx
->stats
.sess_connect_renegotiate
);
2488 case SSL_CTRL_SESS_ACCEPT
:
2489 return tsan_load(&ctx
->stats
.sess_accept
);
2490 case SSL_CTRL_SESS_ACCEPT_GOOD
:
2491 return tsan_load(&ctx
->stats
.sess_accept_good
);
2492 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE
:
2493 return tsan_load(&ctx
->stats
.sess_accept_renegotiate
);
2494 case SSL_CTRL_SESS_HIT
:
2495 return tsan_load(&ctx
->stats
.sess_hit
);
2496 case SSL_CTRL_SESS_CB_HIT
:
2497 return tsan_load(&ctx
->stats
.sess_cb_hit
);
2498 case SSL_CTRL_SESS_MISSES
:
2499 return tsan_load(&ctx
->stats
.sess_miss
);
2500 case SSL_CTRL_SESS_TIMEOUTS
:
2501 return tsan_load(&ctx
->stats
.sess_timeout
);
2502 case SSL_CTRL_SESS_CACHE_FULL
:
2503 return tsan_load(&ctx
->stats
.sess_cache_full
);
2505 return (ctx
->mode
|= larg
);
2506 case SSL_CTRL_CLEAR_MODE
:
2507 return (ctx
->mode
&= ~larg
);
2508 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
2509 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
2511 ctx
->max_send_fragment
= larg
;
2512 if (ctx
->max_send_fragment
< ctx
->split_send_fragment
)
2513 ctx
->split_send_fragment
= ctx
->max_send_fragment
;
2515 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
2516 if ((size_t)larg
> ctx
->max_send_fragment
|| larg
== 0)
2518 ctx
->split_send_fragment
= larg
;
2520 case SSL_CTRL_SET_MAX_PIPELINES
:
2521 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
2523 ctx
->max_pipelines
= larg
;
2525 case SSL_CTRL_CERT_FLAGS
:
2526 return (ctx
->cert
->cert_flags
|= larg
);
2527 case SSL_CTRL_CLEAR_CERT_FLAGS
:
2528 return (ctx
->cert
->cert_flags
&= ~larg
);
2529 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
2530 return ssl_check_allowed_versions(larg
, ctx
->max_proto_version
)
2531 && ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
2532 &ctx
->min_proto_version
);
2533 case SSL_CTRL_GET_MIN_PROTO_VERSION
:
2534 return ctx
->min_proto_version
;
2535 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
2536 return ssl_check_allowed_versions(ctx
->min_proto_version
, larg
)
2537 && ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
2538 &ctx
->max_proto_version
);
2539 case SSL_CTRL_GET_MAX_PROTO_VERSION
:
2540 return ctx
->max_proto_version
;
2542 return ctx
->method
->ssl_ctx_ctrl(ctx
, cmd
, larg
, parg
);
2546 long SSL_CTX_callback_ctrl(SSL_CTX
*ctx
, int cmd
, void (*fp
) (void))
2549 case SSL_CTRL_SET_MSG_CALLBACK
:
2550 ctx
->msg_callback
= (void (*)
2551 (int write_p
, int version
, int content_type
,
2552 const void *buf
, size_t len
, SSL
*ssl
,
2557 return ctx
->method
->ssl_ctx_callback_ctrl(ctx
, cmd
, fp
);
2561 int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
)
2570 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
2571 const SSL_CIPHER
*const *bp
)
2573 if ((*ap
)->id
> (*bp
)->id
)
2575 if ((*ap
)->id
< (*bp
)->id
)
2580 /** return a STACK of the ciphers available for the SSL and in order of
2582 STACK_OF(SSL_CIPHER
) *SSL_get_ciphers(const SSL
*s
)
2585 if (s
->cipher_list
!= NULL
) {
2586 return s
->cipher_list
;
2587 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list
!= NULL
)) {
2588 return s
->ctx
->cipher_list
;
2594 STACK_OF(SSL_CIPHER
) *SSL_get_client_ciphers(const SSL
*s
)
2596 if ((s
== NULL
) || !s
->server
)
2598 return s
->peer_ciphers
;
2601 STACK_OF(SSL_CIPHER
) *SSL_get1_supported_ciphers(SSL
*s
)
2603 STACK_OF(SSL_CIPHER
) *sk
= NULL
, *ciphers
;
2606 ciphers
= SSL_get_ciphers(s
);
2609 if (!ssl_set_client_disabled(s
))
2611 for (i
= 0; i
< sk_SSL_CIPHER_num(ciphers
); i
++) {
2612 const SSL_CIPHER
*c
= sk_SSL_CIPHER_value(ciphers
, i
);
2613 if (!ssl_cipher_disabled(s
, c
, SSL_SECOP_CIPHER_SUPPORTED
, 0)) {
2615 sk
= sk_SSL_CIPHER_new_null();
2618 if (!sk_SSL_CIPHER_push(sk
, c
)) {
2619 sk_SSL_CIPHER_free(sk
);
2627 /** return a STACK of the ciphers available for the SSL and in order of
2629 STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
)
2632 if (s
->cipher_list_by_id
!= NULL
) {
2633 return s
->cipher_list_by_id
;
2634 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list_by_id
!= NULL
)) {
2635 return s
->ctx
->cipher_list_by_id
;
2641 /** The old interface to get the same thing as SSL_get_ciphers() */
2642 const char *SSL_get_cipher_list(const SSL
*s
, int n
)
2644 const SSL_CIPHER
*c
;
2645 STACK_OF(SSL_CIPHER
) *sk
;
2649 sk
= SSL_get_ciphers(s
);
2650 if ((sk
== NULL
) || (sk_SSL_CIPHER_num(sk
) <= n
))
2652 c
= sk_SSL_CIPHER_value(sk
, n
);
2658 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2660 STACK_OF(SSL_CIPHER
) *SSL_CTX_get_ciphers(const SSL_CTX
*ctx
)
2663 return ctx
->cipher_list
;
2668 * Distinguish between ciphers controlled by set_ciphersuite() and
2669 * set_cipher_list() when counting.
2671 static int cipher_list_tls12_num(STACK_OF(SSL_CIPHER
) *sk
)
2674 const SSL_CIPHER
*c
;
2678 for (i
= 0; i
< sk_SSL_CIPHER_num(sk
); ++i
) {
2679 c
= sk_SSL_CIPHER_value(sk
, i
);
2680 if (c
->min_tls
>= TLS1_3_VERSION
)
2687 /** specify the ciphers to be used by default by the SSL_CTX */
2688 int SSL_CTX_set_cipher_list(SSL_CTX
*ctx
, const char *str
)
2690 STACK_OF(SSL_CIPHER
) *sk
;
2692 sk
= ssl_create_cipher_list(ctx
->method
, ctx
->tls13_ciphersuites
,
2693 &ctx
->cipher_list
, &ctx
->cipher_list_by_id
, str
,
2696 * ssl_create_cipher_list may return an empty stack if it was unable to
2697 * find a cipher matching the given rule string (for example if the rule
2698 * string specifies a cipher which has been disabled). This is not an
2699 * error as far as ssl_create_cipher_list is concerned, and hence
2700 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2704 else if (cipher_list_tls12_num(sk
) == 0) {
2705 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST
, SSL_R_NO_CIPHER_MATCH
);
2711 /** specify the ciphers to be used by the SSL */
2712 int SSL_set_cipher_list(SSL
*s
, const char *str
)
2714 STACK_OF(SSL_CIPHER
) *sk
;
2716 sk
= ssl_create_cipher_list(s
->ctx
->method
, s
->tls13_ciphersuites
,
2717 &s
->cipher_list
, &s
->cipher_list_by_id
, str
,
2719 /* see comment in SSL_CTX_set_cipher_list */
2722 else if (cipher_list_tls12_num(sk
) == 0) {
2723 SSLerr(SSL_F_SSL_SET_CIPHER_LIST
, SSL_R_NO_CIPHER_MATCH
);
2729 char *SSL_get_shared_ciphers(const SSL
*s
, char *buf
, int size
)
2732 STACK_OF(SSL_CIPHER
) *clntsk
, *srvrsk
;
2733 const SSL_CIPHER
*c
;
2737 || s
->peer_ciphers
== NULL
2742 clntsk
= s
->peer_ciphers
;
2743 srvrsk
= SSL_get_ciphers(s
);
2744 if (clntsk
== NULL
|| srvrsk
== NULL
)
2747 if (sk_SSL_CIPHER_num(clntsk
) == 0 || sk_SSL_CIPHER_num(srvrsk
) == 0)
2750 for (i
= 0; i
< sk_SSL_CIPHER_num(clntsk
); i
++) {
2753 c
= sk_SSL_CIPHER_value(clntsk
, i
);
2754 if (sk_SSL_CIPHER_find(srvrsk
, c
) < 0)
2757 n
= strlen(c
->name
);
2774 * Return the requested servername (SNI) value. Note that the behaviour varies
2776 * - whether this is called by the client or the server,
2777 * - if we are before or during/after the handshake,
2778 * - if a resumption or normal handshake is being attempted/has occurred
2779 * - whether we have negotiated TLSv1.2 (or below) or TLSv1.3
2781 * Note that only the host_name type is defined (RFC 3546).
2783 const char *SSL_get_servername(const SSL
*s
, const int type
)
2786 * If we don't know if we are the client or the server yet then we assume
2789 int server
= s
->handshake_func
== NULL
? 0 : s
->server
;
2790 if (type
!= TLSEXT_NAMETYPE_host_name
)
2796 * In TLSv1.3 on the server SNI is not associated with the session
2797 * but in TLSv1.2 or below it is.
2799 * Before the handshake:
2802 * During/after the handshake (TLSv1.2 or below resumption occurred):
2803 * - If a servername was accepted by the server in the original
2804 * handshake then it will return that servername, or NULL otherwise.
2806 * During/after the handshake (TLSv1.2 or below resumption did not occur):
2807 * - The function will return the servername requested by the client in
2808 * this handshake or NULL if none was requested.
2810 if (s
->hit
&& !SSL_IS_TLS13(s
))
2811 return s
->session
->ext
.hostname
;
2816 * Before the handshake:
2817 * - If a servername has been set via a call to
2818 * SSL_set_tlsext_host_name() then it will return that servername
2819 * - If one has not been set, but a TLSv1.2 resumption is being
2820 * attempted and the session from the original handshake had a
2821 * servername accepted by the server then it will return that
2823 * - Otherwise it returns NULL
2825 * During/after the handshake (TLSv1.2 or below resumption occurred):
2826 * - If the session from the orignal handshake had a servername accepted
2827 * by the server then it will return that servername.
2828 * - Otherwise it returns the servername set via
2829 * SSL_set_tlsext_host_name() (or NULL if it was not called).
2831 * During/after the handshake (TLSv1.2 or below resumption did not occur):
2832 * - It will return the servername set via SSL_set_tlsext_host_name()
2833 * (or NULL if it was not called).
2835 if (SSL_in_before(s
)) {
2836 if (s
->ext
.hostname
== NULL
2837 && s
->session
!= NULL
2838 && s
->session
->ssl_version
!= TLS1_3_VERSION
)
2839 return s
->session
->ext
.hostname
;
2841 if (!SSL_IS_TLS13(s
) && s
->hit
&& s
->session
->ext
.hostname
!= NULL
)
2842 return s
->session
->ext
.hostname
;
2846 return s
->ext
.hostname
;
2849 int SSL_get_servername_type(const SSL
*s
)
2851 if (SSL_get_servername(s
, TLSEXT_NAMETYPE_host_name
) != NULL
)
2852 return TLSEXT_NAMETYPE_host_name
;
2857 * SSL_select_next_proto implements the standard protocol selection. It is
2858 * expected that this function is called from the callback set by
2859 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2860 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2861 * not included in the length. A byte string of length 0 is invalid. No byte
2862 * string may be truncated. The current, but experimental algorithm for
2863 * selecting the protocol is: 1) If the server doesn't support NPN then this
2864 * is indicated to the callback. In this case, the client application has to
2865 * abort the connection or have a default application level protocol. 2) If
2866 * the server supports NPN, but advertises an empty list then the client
2867 * selects the first protocol in its list, but indicates via the API that this
2868 * fallback case was enacted. 3) Otherwise, the client finds the first
2869 * protocol in the server's list that it supports and selects this protocol.
2870 * This is because it's assumed that the server has better information about
2871 * which protocol a client should use. 4) If the client doesn't support any
2872 * of the server's advertised protocols, then this is treated the same as
2873 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2874 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2876 int SSL_select_next_proto(unsigned char **out
, unsigned char *outlen
,
2877 const unsigned char *server
,
2878 unsigned int server_len
,
2879 const unsigned char *client
, unsigned int client_len
)
2882 const unsigned char *result
;
2883 int status
= OPENSSL_NPN_UNSUPPORTED
;
2886 * For each protocol in server preference order, see if we support it.
2888 for (i
= 0; i
< server_len
;) {
2889 for (j
= 0; j
< client_len
;) {
2890 if (server
[i
] == client
[j
] &&
2891 memcmp(&server
[i
+ 1], &client
[j
+ 1], server
[i
]) == 0) {
2892 /* We found a match */
2893 result
= &server
[i
];
2894 status
= OPENSSL_NPN_NEGOTIATED
;
2904 /* There's no overlap between our protocols and the server's list. */
2906 status
= OPENSSL_NPN_NO_OVERLAP
;
2909 *out
= (unsigned char *)result
+ 1;
2910 *outlen
= result
[0];
2914 #ifndef OPENSSL_NO_NEXTPROTONEG
2916 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2917 * client's requested protocol for this connection and returns 0. If the
2918 * client didn't request any protocol, then *data is set to NULL. Note that
2919 * the client can request any protocol it chooses. The value returned from
2920 * this function need not be a member of the list of supported protocols
2921 * provided by the callback.
2923 void SSL_get0_next_proto_negotiated(const SSL
*s
, const unsigned char **data
,
2927 if (*data
== NULL
) {
2930 *len
= (unsigned int)s
->ext
.npn_len
;
2935 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2936 * a TLS server needs a list of supported protocols for Next Protocol
2937 * Negotiation. The returned list must be in wire format. The list is
2938 * returned by setting |out| to point to it and |outlen| to its length. This
2939 * memory will not be modified, but one should assume that the SSL* keeps a
2940 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2941 * wishes to advertise. Otherwise, no such extension will be included in the
2944 void SSL_CTX_set_npn_advertised_cb(SSL_CTX
*ctx
,
2945 SSL_CTX_npn_advertised_cb_func cb
,
2948 ctx
->ext
.npn_advertised_cb
= cb
;
2949 ctx
->ext
.npn_advertised_cb_arg
= arg
;
2953 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2954 * client needs to select a protocol from the server's provided list. |out|
2955 * must be set to point to the selected protocol (which may be within |in|).
2956 * The length of the protocol name must be written into |outlen|. The
2957 * server's advertised protocols are provided in |in| and |inlen|. The
2958 * callback can assume that |in| is syntactically valid. The client must
2959 * select a protocol. It is fatal to the connection if this callback returns
2960 * a value other than SSL_TLSEXT_ERR_OK.
2962 void SSL_CTX_set_npn_select_cb(SSL_CTX
*ctx
,
2963 SSL_CTX_npn_select_cb_func cb
,
2966 ctx
->ext
.npn_select_cb
= cb
;
2967 ctx
->ext
.npn_select_cb_arg
= arg
;
2972 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2973 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2974 * length-prefixed strings). Returns 0 on success.
2976 int SSL_CTX_set_alpn_protos(SSL_CTX
*ctx
, const unsigned char *protos
,
2977 unsigned int protos_len
)
2979 OPENSSL_free(ctx
->ext
.alpn
);
2980 ctx
->ext
.alpn
= OPENSSL_memdup(protos
, protos_len
);
2981 if (ctx
->ext
.alpn
== NULL
) {
2982 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS
, ERR_R_MALLOC_FAILURE
);
2985 ctx
->ext
.alpn_len
= protos_len
;
2991 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2992 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2993 * length-prefixed strings). Returns 0 on success.
2995 int SSL_set_alpn_protos(SSL
*ssl
, const unsigned char *protos
,
2996 unsigned int protos_len
)
2998 OPENSSL_free(ssl
->ext
.alpn
);
2999 ssl
->ext
.alpn
= OPENSSL_memdup(protos
, protos_len
);
3000 if (ssl
->ext
.alpn
== NULL
) {
3001 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS
, ERR_R_MALLOC_FAILURE
);
3004 ssl
->ext
.alpn_len
= protos_len
;
3010 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
3011 * called during ClientHello processing in order to select an ALPN protocol
3012 * from the client's list of offered protocols.
3014 void SSL_CTX_set_alpn_select_cb(SSL_CTX
*ctx
,
3015 SSL_CTX_alpn_select_cb_func cb
,
3018 ctx
->ext
.alpn_select_cb
= cb
;
3019 ctx
->ext
.alpn_select_cb_arg
= arg
;
3023 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
3024 * On return it sets |*data| to point to |*len| bytes of protocol name
3025 * (not including the leading length-prefix byte). If the server didn't
3026 * respond with a negotiated protocol then |*len| will be zero.
3028 void SSL_get0_alpn_selected(const SSL
*ssl
, const unsigned char **data
,
3031 *data
= ssl
->s3
.alpn_selected
;
3035 *len
= (unsigned int)ssl
->s3
.alpn_selected_len
;
3038 int SSL_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
3039 const char *label
, size_t llen
,
3040 const unsigned char *context
, size_t contextlen
,
3043 if (s
->version
< TLS1_VERSION
&& s
->version
!= DTLS1_BAD_VER
)
3046 return s
->method
->ssl3_enc
->export_keying_material(s
, out
, olen
, label
,
3048 contextlen
, use_context
);
3051 int SSL_export_keying_material_early(SSL
*s
, unsigned char *out
, size_t olen
,
3052 const char *label
, size_t llen
,
3053 const unsigned char *context
,
3056 if (s
->version
!= TLS1_3_VERSION
)
3059 return tls13_export_keying_material_early(s
, out
, olen
, label
, llen
,
3060 context
, contextlen
);
3063 static unsigned long ssl_session_hash(const SSL_SESSION
*a
)
3065 const unsigned char *session_id
= a
->session_id
;
3067 unsigned char tmp_storage
[4];
3069 if (a
->session_id_length
< sizeof(tmp_storage
)) {
3070 memset(tmp_storage
, 0, sizeof(tmp_storage
));
3071 memcpy(tmp_storage
, a
->session_id
, a
->session_id_length
);
3072 session_id
= tmp_storage
;
3076 ((unsigned long)session_id
[0]) |
3077 ((unsigned long)session_id
[1] << 8L) |
3078 ((unsigned long)session_id
[2] << 16L) |
3079 ((unsigned long)session_id
[3] << 24L);
3084 * NB: If this function (or indeed the hash function which uses a sort of
3085 * coarser function than this one) is changed, ensure
3086 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
3087 * being able to construct an SSL_SESSION that will collide with any existing
3088 * session with a matching session ID.
3090 static int ssl_session_cmp(const SSL_SESSION
*a
, const SSL_SESSION
*b
)
3092 if (a
->ssl_version
!= b
->ssl_version
)
3094 if (a
->session_id_length
!= b
->session_id_length
)
3096 return memcmp(a
->session_id
, b
->session_id
, a
->session_id_length
);
3100 * These wrapper functions should remain rather than redeclaring
3101 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
3102 * variable. The reason is that the functions aren't static, they're exposed
3106 SSL_CTX
*SSL_CTX_new_with_libctx(OPENSSL_CTX
*libctx
, const char *propq
,
3107 const SSL_METHOD
*meth
)
3109 SSL_CTX
*ret
= NULL
;
3112 SSLerr(0, SSL_R_NULL_SSL_METHOD_PASSED
);
3116 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS
, NULL
))
3119 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
3120 SSLerr(0, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS
);
3123 ret
= OPENSSL_zalloc(sizeof(*ret
));
3127 ret
->libctx
= libctx
;
3128 if (propq
!= NULL
) {
3129 ret
->propq
= OPENSSL_strdup(propq
);
3130 if (ret
->propq
== NULL
)
3135 ret
->min_proto_version
= 0;
3136 ret
->max_proto_version
= 0;
3137 ret
->mode
= SSL_MODE_AUTO_RETRY
;
3138 ret
->session_cache_mode
= SSL_SESS_CACHE_SERVER
;
3139 ret
->session_cache_size
= SSL_SESSION_CACHE_MAX_SIZE_DEFAULT
;
3140 /* We take the system default. */
3141 ret
->session_timeout
= meth
->get_timeout();
3142 ret
->references
= 1;
3143 ret
->lock
= CRYPTO_THREAD_lock_new();
3144 if (ret
->lock
== NULL
) {
3145 SSLerr(0, ERR_R_MALLOC_FAILURE
);
3149 ret
->max_cert_list
= SSL_MAX_CERT_LIST_DEFAULT
;
3150 ret
->verify_mode
= SSL_VERIFY_NONE
;
3151 if ((ret
->cert
= ssl_cert_new()) == NULL
)
3154 ret
->sessions
= lh_SSL_SESSION_new(ssl_session_hash
, ssl_session_cmp
);
3155 if (ret
->sessions
== NULL
)
3157 ret
->cert_store
= X509_STORE_new();
3158 if (ret
->cert_store
== NULL
)
3160 #ifndef OPENSSL_NO_CT
3161 ret
->ctlog_store
= CTLOG_STORE_new_with_libctx(libctx
, propq
);
3162 if (ret
->ctlog_store
== NULL
)
3166 /* initialize cipher/digest methods table */
3167 if (!ssl_load_ciphers(ret
))
3170 if (!SSL_CTX_set_ciphersuites(ret
, OSSL_default_ciphersuites()))
3173 if (!ssl_create_cipher_list(ret
->method
,
3174 ret
->tls13_ciphersuites
,
3175 &ret
->cipher_list
, &ret
->cipher_list_by_id
,
3176 OSSL_default_cipher_list(), ret
->cert
)
3177 || sk_SSL_CIPHER_num(ret
->cipher_list
) <= 0) {
3178 SSLerr(0, SSL_R_LIBRARY_HAS_NO_CIPHERS
);
3182 ret
->param
= X509_VERIFY_PARAM_new();
3183 if (ret
->param
== NULL
)
3187 * If these aren't available from the provider we'll get NULL returns.
3188 * That's fine but will cause errors later if SSLv3 is negotiated
3190 ret
->md5
= ssl_evp_md_fetch(libctx
, NID_md5
, propq
);
3191 ret
->sha1
= ssl_evp_md_fetch(libctx
, NID_sha1
, propq
);
3193 if ((ret
->ca_names
= sk_X509_NAME_new_null()) == NULL
)
3196 if ((ret
->client_ca_names
= sk_X509_NAME_new_null()) == NULL
)
3199 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, ret
, &ret
->ex_data
))
3202 if ((ret
->ext
.secure
= OPENSSL_secure_zalloc(sizeof(*ret
->ext
.secure
))) == NULL
)
3205 /* No compression for DTLS */
3206 if (!(meth
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_DTLS
))
3207 ret
->comp_methods
= SSL_COMP_get_compression_methods();
3209 ret
->max_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
3210 ret
->split_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
3212 /* Setup RFC5077 ticket keys */
3213 if ((RAND_bytes_ex(libctx
, ret
->ext
.tick_key_name
,
3214 sizeof(ret
->ext
.tick_key_name
)) <= 0)
3215 || (RAND_priv_bytes_ex(libctx
, ret
->ext
.secure
->tick_hmac_key
,
3216 sizeof(ret
->ext
.secure
->tick_hmac_key
)) <= 0)
3217 || (RAND_priv_bytes_ex(libctx
, ret
->ext
.secure
->tick_aes_key
,
3218 sizeof(ret
->ext
.secure
->tick_aes_key
)) <= 0))
3219 ret
->options
|= SSL_OP_NO_TICKET
;
3221 if (RAND_priv_bytes_ex(libctx
, ret
->ext
.cookie_hmac_key
,
3222 sizeof(ret
->ext
.cookie_hmac_key
)) <= 0)
3225 #ifndef OPENSSL_NO_SRP
3226 if (!SSL_CTX_SRP_CTX_init(ret
))
3229 #ifndef OPENSSL_NO_ENGINE
3230 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3231 # define eng_strx(x) #x
3232 # define eng_str(x) eng_strx(x)
3233 /* Use specific client engine automatically... ignore errors */
3236 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
3239 ENGINE_load_builtin_engines();
3240 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
3242 if (!eng
|| !SSL_CTX_set_client_cert_engine(ret
, eng
))
3248 * Default is to connect to non-RI servers. When RI is more widely
3249 * deployed might change this.
3251 ret
->options
|= SSL_OP_LEGACY_SERVER_CONNECT
;
3253 * Disable compression by default to prevent CRIME. Applications can
3254 * re-enable compression by configuring
3255 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3256 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3257 * middlebox compatibility by default. This may be disabled by default in
3258 * a later OpenSSL version.
3260 ret
->options
|= SSL_OP_NO_COMPRESSION
| SSL_OP_ENABLE_MIDDLEBOX_COMPAT
;
3262 ret
->ext
.status_type
= TLSEXT_STATUSTYPE_nothing
;
3265 * We cannot usefully set a default max_early_data here (which gets
3266 * propagated in SSL_new(), for the following reason: setting the
3267 * SSL field causes tls_construct_stoc_early_data() to tell the
3268 * client that early data will be accepted when constructing a TLS 1.3
3269 * session ticket, and the client will accordingly send us early data
3270 * when using that ticket (if the client has early data to send).
3271 * However, in order for the early data to actually be consumed by
3272 * the application, the application must also have calls to
3273 * SSL_read_early_data(); otherwise we'll just skip past the early data
3274 * and ignore it. So, since the application must add calls to
3275 * SSL_read_early_data(), we also require them to add
3276 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3277 * eliminating the bandwidth-wasting early data in the case described
3280 ret
->max_early_data
= 0;
3283 * Default recv_max_early_data is a fully loaded single record. Could be
3284 * split across multiple records in practice. We set this differently to
3285 * max_early_data so that, in the default case, we do not advertise any
3286 * support for early_data, but if a client were to send us some (e.g.
3287 * because of an old, stale ticket) then we will tolerate it and skip over
3290 ret
->recv_max_early_data
= SSL3_RT_MAX_PLAIN_LENGTH
;
3292 /* By default we send two session tickets automatically in TLSv1.3 */
3293 ret
->num_tickets
= 2;
3295 ssl_ctx_system_config(ret
);
3299 SSLerr(0, ERR_R_MALLOC_FAILURE
);
3305 SSL_CTX
*SSL_CTX_new(const SSL_METHOD
*meth
)
3307 return SSL_CTX_new_with_libctx(NULL
, NULL
, meth
);
3310 int SSL_CTX_up_ref(SSL_CTX
*ctx
)
3314 if (CRYPTO_UP_REF(&ctx
->references
, &i
, ctx
->lock
) <= 0)
3317 REF_PRINT_COUNT("SSL_CTX", ctx
);
3318 REF_ASSERT_ISNT(i
< 2);
3319 return ((i
> 1) ? 1 : 0);
3322 void SSL_CTX_free(SSL_CTX
*a
)
3329 CRYPTO_DOWN_REF(&a
->references
, &i
, a
->lock
);
3330 REF_PRINT_COUNT("SSL_CTX", a
);
3333 REF_ASSERT_ISNT(i
< 0);
3335 X509_VERIFY_PARAM_free(a
->param
);
3336 dane_ctx_final(&a
->dane
);
3339 * Free internal session cache. However: the remove_cb() may reference
3340 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3341 * after the sessions were flushed.
3342 * As the ex_data handling routines might also touch the session cache,
3343 * the most secure solution seems to be: empty (flush) the cache, then
3344 * free ex_data, then finally free the cache.
3345 * (See ticket [openssl.org #212].)
3347 if (a
->sessions
!= NULL
)
3348 SSL_CTX_flush_sessions(a
, 0);
3350 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, a
, &a
->ex_data
);
3351 lh_SSL_SESSION_free(a
->sessions
);
3352 X509_STORE_free(a
->cert_store
);
3353 #ifndef OPENSSL_NO_CT
3354 CTLOG_STORE_free(a
->ctlog_store
);
3356 sk_SSL_CIPHER_free(a
->cipher_list
);
3357 sk_SSL_CIPHER_free(a
->cipher_list_by_id
);
3358 sk_SSL_CIPHER_free(a
->tls13_ciphersuites
);
3359 ssl_cert_free(a
->cert
);
3360 sk_X509_NAME_pop_free(a
->ca_names
, X509_NAME_free
);
3361 sk_X509_NAME_pop_free(a
->client_ca_names
, X509_NAME_free
);
3362 sk_X509_pop_free(a
->extra_certs
, X509_free
);
3363 a
->comp_methods
= NULL
;
3364 #ifndef OPENSSL_NO_SRTP
3365 sk_SRTP_PROTECTION_PROFILE_free(a
->srtp_profiles
);
3367 #ifndef OPENSSL_NO_SRP
3368 SSL_CTX_SRP_CTX_free(a
);
3370 #ifndef OPENSSL_NO_ENGINE
3371 ENGINE_finish(a
->client_cert_engine
);
3374 #ifndef OPENSSL_NO_EC
3375 OPENSSL_free(a
->ext
.ecpointformats
);
3377 OPENSSL_free(a
->ext
.supportedgroups
);
3378 OPENSSL_free(a
->ext
.alpn
);
3379 OPENSSL_secure_free(a
->ext
.secure
);
3381 ssl_evp_md_free(a
->md5
);
3382 ssl_evp_md_free(a
->sha1
);
3384 for (i
= 0; i
< SSL_ENC_NUM_IDX
; i
++)
3385 ssl_evp_cipher_free(a
->ssl_cipher_methods
[i
]);
3386 for (i
= 0; i
< SSL_MD_NUM_IDX
; i
++)
3387 ssl_evp_md_free(a
->ssl_digest_methods
[i
]);
3389 CRYPTO_THREAD_lock_free(a
->lock
);
3391 OPENSSL_free(a
->propq
);
3396 void SSL_CTX_set_default_passwd_cb(SSL_CTX
*ctx
, pem_password_cb
*cb
)
3398 ctx
->default_passwd_callback
= cb
;
3401 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX
*ctx
, void *u
)
3403 ctx
->default_passwd_callback_userdata
= u
;
3406 pem_password_cb
*SSL_CTX_get_default_passwd_cb(SSL_CTX
*ctx
)
3408 return ctx
->default_passwd_callback
;
3411 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX
*ctx
)
3413 return ctx
->default_passwd_callback_userdata
;
3416 void SSL_set_default_passwd_cb(SSL
*s
, pem_password_cb
*cb
)
3418 s
->default_passwd_callback
= cb
;
3421 void SSL_set_default_passwd_cb_userdata(SSL
*s
, void *u
)
3423 s
->default_passwd_callback_userdata
= u
;
3426 pem_password_cb
*SSL_get_default_passwd_cb(SSL
*s
)
3428 return s
->default_passwd_callback
;
3431 void *SSL_get_default_passwd_cb_userdata(SSL
*s
)
3433 return s
->default_passwd_callback_userdata
;
3436 void SSL_CTX_set_cert_verify_callback(SSL_CTX
*ctx
,
3437 int (*cb
) (X509_STORE_CTX
*, void *),
3440 ctx
->app_verify_callback
= cb
;
3441 ctx
->app_verify_arg
= arg
;
3444 void SSL_CTX_set_verify(SSL_CTX
*ctx
, int mode
,
3445 int (*cb
) (int, X509_STORE_CTX
*))
3447 ctx
->verify_mode
= mode
;
3448 ctx
->default_verify_callback
= cb
;
3451 void SSL_CTX_set_verify_depth(SSL_CTX
*ctx
, int depth
)
3453 X509_VERIFY_PARAM_set_depth(ctx
->param
, depth
);
3456 void SSL_CTX_set_cert_cb(SSL_CTX
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
3458 ssl_cert_set_cert_cb(c
->cert
, cb
, arg
);
3461 void SSL_set_cert_cb(SSL
*s
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
3463 ssl_cert_set_cert_cb(s
->cert
, cb
, arg
);
3466 void ssl_set_masks(SSL
*s
)
3469 uint32_t *pvalid
= s
->s3
.tmp
.valid_flags
;
3470 int rsa_enc
, rsa_sign
, dh_tmp
, dsa_sign
;
3471 unsigned long mask_k
, mask_a
;
3472 #ifndef OPENSSL_NO_EC
3473 int have_ecc_cert
, ecdsa_ok
;
3478 #ifndef OPENSSL_NO_DH
3479 dh_tmp
= (c
->dh_tmp
!= NULL
|| c
->dh_tmp_cb
!= NULL
|| c
->dh_tmp_auto
);
3484 rsa_enc
= pvalid
[SSL_PKEY_RSA
] & CERT_PKEY_VALID
;
3485 rsa_sign
= pvalid
[SSL_PKEY_RSA
] & CERT_PKEY_VALID
;
3486 dsa_sign
= pvalid
[SSL_PKEY_DSA_SIGN
] & CERT_PKEY_VALID
;
3487 #ifndef OPENSSL_NO_EC
3488 have_ecc_cert
= pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_VALID
;
3493 OSSL_TRACE4(TLS_CIPHER
, "dh_tmp=%d rsa_enc=%d rsa_sign=%d dsa_sign=%d\n",
3494 dh_tmp
, rsa_enc
, rsa_sign
, dsa_sign
);
3496 #ifndef OPENSSL_NO_GOST
3497 if (ssl_has_cert(s
, SSL_PKEY_GOST12_512
)) {
3498 mask_k
|= SSL_kGOST
;
3499 mask_a
|= SSL_aGOST12
;
3501 if (ssl_has_cert(s
, SSL_PKEY_GOST12_256
)) {
3502 mask_k
|= SSL_kGOST
;
3503 mask_a
|= SSL_aGOST12
;
3505 if (ssl_has_cert(s
, SSL_PKEY_GOST01
)) {
3506 mask_k
|= SSL_kGOST
;
3507 mask_a
|= SSL_aGOST01
;
3518 * If we only have an RSA-PSS certificate allow RSA authentication
3519 * if TLS 1.2 and peer supports it.
3522 if (rsa_enc
|| rsa_sign
|| (ssl_has_cert(s
, SSL_PKEY_RSA_PSS_SIGN
)
3523 && pvalid
[SSL_PKEY_RSA_PSS_SIGN
] & CERT_PKEY_EXPLICIT_SIGN
3524 && TLS1_get_version(s
) == TLS1_2_VERSION
))
3531 mask_a
|= SSL_aNULL
;
3534 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3535 * depending on the key usage extension.
3537 #ifndef OPENSSL_NO_EC
3538 if (have_ecc_cert
) {
3540 ex_kusage
= X509_get_key_usage(c
->pkeys
[SSL_PKEY_ECC
].x509
);
3541 ecdsa_ok
= ex_kusage
& X509v3_KU_DIGITAL_SIGNATURE
;
3542 if (!(pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_SIGN
))
3545 mask_a
|= SSL_aECDSA
;
3547 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3548 if (!(mask_a
& SSL_aECDSA
) && ssl_has_cert(s
, SSL_PKEY_ED25519
)
3549 && pvalid
[SSL_PKEY_ED25519
] & CERT_PKEY_EXPLICIT_SIGN
3550 && TLS1_get_version(s
) == TLS1_2_VERSION
)
3551 mask_a
|= SSL_aECDSA
;
3553 /* Allow Ed448 for TLS 1.2 if peer supports it */
3554 if (!(mask_a
& SSL_aECDSA
) && ssl_has_cert(s
, SSL_PKEY_ED448
)
3555 && pvalid
[SSL_PKEY_ED448
] & CERT_PKEY_EXPLICIT_SIGN
3556 && TLS1_get_version(s
) == TLS1_2_VERSION
)
3557 mask_a
|= SSL_aECDSA
;
3560 #ifndef OPENSSL_NO_EC
3561 mask_k
|= SSL_kECDHE
;
3564 #ifndef OPENSSL_NO_PSK
3567 if (mask_k
& SSL_kRSA
)
3568 mask_k
|= SSL_kRSAPSK
;
3569 if (mask_k
& SSL_kDHE
)
3570 mask_k
|= SSL_kDHEPSK
;
3571 if (mask_k
& SSL_kECDHE
)
3572 mask_k
|= SSL_kECDHEPSK
;
3575 s
->s3
.tmp
.mask_k
= mask_k
;
3576 s
->s3
.tmp
.mask_a
= mask_a
;
3579 #ifndef OPENSSL_NO_EC
3581 int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
)
3583 if (s
->s3
.tmp
.new_cipher
->algorithm_auth
& SSL_aECDSA
) {
3584 /* key usage, if present, must allow signing */
3585 if (!(X509_get_key_usage(x
) & X509v3_KU_DIGITAL_SIGNATURE
)) {
3586 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG
,
3587 SSL_R_ECC_CERT_NOT_FOR_SIGNING
);
3591 return 1; /* all checks are ok */
3596 int ssl_get_server_cert_serverinfo(SSL
*s
, const unsigned char **serverinfo
,
3597 size_t *serverinfo_length
)
3599 CERT_PKEY
*cpk
= s
->s3
.tmp
.cert
;
3600 *serverinfo_length
= 0;
3602 if (cpk
== NULL
|| cpk
->serverinfo
== NULL
)
3605 *serverinfo
= cpk
->serverinfo
;
3606 *serverinfo_length
= cpk
->serverinfo_length
;
3610 void ssl_update_cache(SSL
*s
, int mode
)
3615 * If the session_id_length is 0, we are not supposed to cache it, and it
3616 * would be rather hard to do anyway :-)
3618 if (s
->session
->session_id_length
== 0)
3622 * If sid_ctx_length is 0 there is no specific application context
3623 * associated with this session, so when we try to resume it and
3624 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3625 * indication that this is actually a session for the proper application
3626 * context, and the *handshake* will fail, not just the resumption attempt.
3627 * Do not cache (on the server) these sessions that are not resumable
3628 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3630 if (s
->server
&& s
->session
->sid_ctx_length
== 0
3631 && (s
->verify_mode
& SSL_VERIFY_PEER
) != 0)
3634 i
= s
->session_ctx
->session_cache_mode
;
3636 && (!s
->hit
|| SSL_IS_TLS13(s
))) {
3638 * Add the session to the internal cache. In server side TLSv1.3 we
3639 * normally don't do this because by default it's a full stateless ticket
3640 * with only a dummy session id so there is no reason to cache it,
3642 * - we are doing early_data, in which case we cache so that we can
3644 * - the application has set a remove_session_cb so needs to know about
3645 * session timeout events
3646 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3648 if ((i
& SSL_SESS_CACHE_NO_INTERNAL_STORE
) == 0
3649 && (!SSL_IS_TLS13(s
)
3651 || (s
->max_early_data
> 0
3652 && (s
->options
& SSL_OP_NO_ANTI_REPLAY
) == 0)
3653 || s
->session_ctx
->remove_session_cb
!= NULL
3654 || (s
->options
& SSL_OP_NO_TICKET
) != 0))
3655 SSL_CTX_add_session(s
->session_ctx
, s
->session
);
3658 * Add the session to the external cache. We do this even in server side
3659 * TLSv1.3 without early data because some applications just want to
3660 * know about the creation of a session and aren't doing a full cache.
3662 if (s
->session_ctx
->new_session_cb
!= NULL
) {
3663 SSL_SESSION_up_ref(s
->session
);
3664 if (!s
->session_ctx
->new_session_cb(s
, s
->session
))
3665 SSL_SESSION_free(s
->session
);
3669 /* auto flush every 255 connections */
3670 if ((!(i
& SSL_SESS_CACHE_NO_AUTO_CLEAR
)) && ((i
& mode
) == mode
)) {
3671 TSAN_QUALIFIER
int *stat
;
3672 if (mode
& SSL_SESS_CACHE_CLIENT
)
3673 stat
= &s
->session_ctx
->stats
.sess_connect_good
;
3675 stat
= &s
->session_ctx
->stats
.sess_accept_good
;
3676 if ((tsan_load(stat
) & 0xff) == 0xff)
3677 SSL_CTX_flush_sessions(s
->session_ctx
, (unsigned long)time(NULL
));
3681 const SSL_METHOD
*SSL_CTX_get_ssl_method(const SSL_CTX
*ctx
)
3686 const SSL_METHOD
*SSL_get_ssl_method(const SSL
*s
)
3691 int SSL_set_ssl_method(SSL
*s
, const SSL_METHOD
*meth
)
3695 if (s
->method
!= meth
) {
3696 const SSL_METHOD
*sm
= s
->method
;
3697 int (*hf
) (SSL
*) = s
->handshake_func
;
3699 if (sm
->version
== meth
->version
)
3704 ret
= s
->method
->ssl_new(s
);
3707 if (hf
== sm
->ssl_connect
)
3708 s
->handshake_func
= meth
->ssl_connect
;
3709 else if (hf
== sm
->ssl_accept
)
3710 s
->handshake_func
= meth
->ssl_accept
;
3715 int SSL_get_error(const SSL
*s
, int i
)
3722 return SSL_ERROR_NONE
;
3725 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3726 * where we do encode the error
3728 if ((l
= ERR_peek_error()) != 0) {
3729 if (ERR_GET_LIB(l
) == ERR_LIB_SYS
)
3730 return SSL_ERROR_SYSCALL
;
3732 return SSL_ERROR_SSL
;
3735 if (SSL_want_read(s
)) {
3736 bio
= SSL_get_rbio(s
);
3737 if (BIO_should_read(bio
))
3738 return SSL_ERROR_WANT_READ
;
3739 else if (BIO_should_write(bio
))
3741 * This one doesn't make too much sense ... We never try to write
3742 * to the rbio, and an application program where rbio and wbio
3743 * are separate couldn't even know what it should wait for.
3744 * However if we ever set s->rwstate incorrectly (so that we have
3745 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3746 * wbio *are* the same, this test works around that bug; so it
3747 * might be safer to keep it.
3749 return SSL_ERROR_WANT_WRITE
;
3750 else if (BIO_should_io_special(bio
)) {
3751 reason
= BIO_get_retry_reason(bio
);
3752 if (reason
== BIO_RR_CONNECT
)
3753 return SSL_ERROR_WANT_CONNECT
;
3754 else if (reason
== BIO_RR_ACCEPT
)
3755 return SSL_ERROR_WANT_ACCEPT
;
3757 return SSL_ERROR_SYSCALL
; /* unknown */
3761 if (SSL_want_write(s
)) {
3762 /* Access wbio directly - in order to use the buffered bio if present */
3764 if (BIO_should_write(bio
))
3765 return SSL_ERROR_WANT_WRITE
;
3766 else if (BIO_should_read(bio
))
3768 * See above (SSL_want_read(s) with BIO_should_write(bio))
3770 return SSL_ERROR_WANT_READ
;
3771 else if (BIO_should_io_special(bio
)) {
3772 reason
= BIO_get_retry_reason(bio
);
3773 if (reason
== BIO_RR_CONNECT
)
3774 return SSL_ERROR_WANT_CONNECT
;
3775 else if (reason
== BIO_RR_ACCEPT
)
3776 return SSL_ERROR_WANT_ACCEPT
;
3778 return SSL_ERROR_SYSCALL
;
3781 if (SSL_want_x509_lookup(s
))
3782 return SSL_ERROR_WANT_X509_LOOKUP
;
3783 if (SSL_want_async(s
))
3784 return SSL_ERROR_WANT_ASYNC
;
3785 if (SSL_want_async_job(s
))
3786 return SSL_ERROR_WANT_ASYNC_JOB
;
3787 if (SSL_want_client_hello_cb(s
))
3788 return SSL_ERROR_WANT_CLIENT_HELLO_CB
;
3790 if ((s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) &&
3791 (s
->s3
.warn_alert
== SSL_AD_CLOSE_NOTIFY
))
3792 return SSL_ERROR_ZERO_RETURN
;
3794 return SSL_ERROR_SYSCALL
;
3797 static int ssl_do_handshake_intern(void *vargs
)
3799 struct ssl_async_args
*args
;
3802 args
= (struct ssl_async_args
*)vargs
;
3805 return s
->handshake_func(s
);
3808 int SSL_do_handshake(SSL
*s
)
3812 if (s
->handshake_func
== NULL
) {
3813 SSLerr(SSL_F_SSL_DO_HANDSHAKE
, SSL_R_CONNECTION_TYPE_NOT_SET
);
3817 ossl_statem_check_finish_init(s
, -1);
3819 s
->method
->ssl_renegotiate_check(s
, 0);
3821 if (SSL_in_init(s
) || SSL_in_before(s
)) {
3822 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
3823 struct ssl_async_args args
;
3827 ret
= ssl_start_async_job(s
, &args
, ssl_do_handshake_intern
);
3829 ret
= s
->handshake_func(s
);
3835 void SSL_set_accept_state(SSL
*s
)
3839 ossl_statem_clear(s
);
3840 s
->handshake_func
= s
->method
->ssl_accept
;
3844 void SSL_set_connect_state(SSL
*s
)
3848 ossl_statem_clear(s
);
3849 s
->handshake_func
= s
->method
->ssl_connect
;
3853 int ssl_undefined_function(SSL
*s
)
3855 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3859 int ssl_undefined_void_function(void)
3861 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION
,
3862 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3866 int ssl_undefined_const_function(const SSL
*s
)
3871 const SSL_METHOD
*ssl_bad_method(int ver
)
3873 SSLerr(SSL_F_SSL_BAD_METHOD
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3877 const char *ssl_protocol_to_string(int version
)
3881 case TLS1_3_VERSION
:
3884 case TLS1_2_VERSION
:
3887 case TLS1_1_VERSION
:
3902 case DTLS1_2_VERSION
:
3910 const char *SSL_get_version(const SSL
*s
)
3912 return ssl_protocol_to_string(s
->version
);
3915 static int dup_ca_names(STACK_OF(X509_NAME
) **dst
, STACK_OF(X509_NAME
) *src
)
3917 STACK_OF(X509_NAME
) *sk
;
3926 if ((sk
= sk_X509_NAME_new_null()) == NULL
)
3928 for (i
= 0; i
< sk_X509_NAME_num(src
); i
++) {
3929 xn
= X509_NAME_dup(sk_X509_NAME_value(src
, i
));
3931 sk_X509_NAME_pop_free(sk
, X509_NAME_free
);
3934 if (sk_X509_NAME_insert(sk
, xn
, i
) == 0) {
3936 sk_X509_NAME_pop_free(sk
, X509_NAME_free
);
3945 SSL
*SSL_dup(SSL
*s
)
3950 /* If we're not quiescent, just up_ref! */
3951 if (!SSL_in_init(s
) || !SSL_in_before(s
)) {
3952 CRYPTO_UP_REF(&s
->references
, &i
, s
->lock
);
3957 * Otherwise, copy configuration state, and session if set.
3959 if ((ret
= SSL_new(SSL_get_SSL_CTX(s
))) == NULL
)
3962 if (s
->session
!= NULL
) {
3964 * Arranges to share the same session via up_ref. This "copies"
3965 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3967 if (!SSL_copy_session_id(ret
, s
))
3971 * No session has been established yet, so we have to expect that
3972 * s->cert or ret->cert will be changed later -- they should not both
3973 * point to the same object, and thus we can't use
3974 * SSL_copy_session_id.
3976 if (!SSL_set_ssl_method(ret
, s
->method
))
3979 if (s
->cert
!= NULL
) {
3980 ssl_cert_free(ret
->cert
);
3981 ret
->cert
= ssl_cert_dup(s
->cert
);
3982 if (ret
->cert
== NULL
)
3986 if (!SSL_set_session_id_context(ret
, s
->sid_ctx
,
3987 (int)s
->sid_ctx_length
))
3991 if (!ssl_dane_dup(ret
, s
))
3993 ret
->version
= s
->version
;
3994 ret
->options
= s
->options
;
3995 ret
->mode
= s
->mode
;
3996 SSL_set_max_cert_list(ret
, SSL_get_max_cert_list(s
));
3997 SSL_set_read_ahead(ret
, SSL_get_read_ahead(s
));
3998 ret
->msg_callback
= s
->msg_callback
;
3999 ret
->msg_callback_arg
= s
->msg_callback_arg
;
4000 SSL_set_verify(ret
, SSL_get_verify_mode(s
), SSL_get_verify_callback(s
));
4001 SSL_set_verify_depth(ret
, SSL_get_verify_depth(s
));
4002 ret
->generate_session_id
= s
->generate_session_id
;
4004 SSL_set_info_callback(ret
, SSL_get_info_callback(s
));
4006 /* copy app data, a little dangerous perhaps */
4007 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL
, &ret
->ex_data
, &s
->ex_data
))
4010 /* setup rbio, and wbio */
4011 if (s
->rbio
!= NULL
) {
4012 if (!BIO_dup_state(s
->rbio
, (char *)&ret
->rbio
))
4015 if (s
->wbio
!= NULL
) {
4016 if (s
->wbio
!= s
->rbio
) {
4017 if (!BIO_dup_state(s
->wbio
, (char *)&ret
->wbio
))
4020 BIO_up_ref(ret
->rbio
);
4021 ret
->wbio
= ret
->rbio
;
4025 ret
->server
= s
->server
;
4026 if (s
->handshake_func
) {
4028 SSL_set_accept_state(ret
);
4030 SSL_set_connect_state(ret
);
4032 ret
->shutdown
= s
->shutdown
;
4035 ret
->default_passwd_callback
= s
->default_passwd_callback
;
4036 ret
->default_passwd_callback_userdata
= s
->default_passwd_callback_userdata
;
4038 X509_VERIFY_PARAM_inherit(ret
->param
, s
->param
);
4040 /* dup the cipher_list and cipher_list_by_id stacks */
4041 if (s
->cipher_list
!= NULL
) {
4042 if ((ret
->cipher_list
= sk_SSL_CIPHER_dup(s
->cipher_list
)) == NULL
)
4045 if (s
->cipher_list_by_id
!= NULL
)
4046 if ((ret
->cipher_list_by_id
= sk_SSL_CIPHER_dup(s
->cipher_list_by_id
))
4050 /* Dup the client_CA list */
4051 if (!dup_ca_names(&ret
->ca_names
, s
->ca_names
)
4052 || !dup_ca_names(&ret
->client_ca_names
, s
->client_ca_names
))
4062 void ssl_clear_cipher_ctx(SSL
*s
)
4064 if (s
->enc_read_ctx
!= NULL
) {
4065 EVP_CIPHER_CTX_free(s
->enc_read_ctx
);
4066 s
->enc_read_ctx
= NULL
;
4068 if (s
->enc_write_ctx
!= NULL
) {
4069 EVP_CIPHER_CTX_free(s
->enc_write_ctx
);
4070 s
->enc_write_ctx
= NULL
;
4072 #ifndef OPENSSL_NO_COMP
4073 COMP_CTX_free(s
->expand
);
4075 COMP_CTX_free(s
->compress
);
4080 X509
*SSL_get_certificate(const SSL
*s
)
4082 if (s
->cert
!= NULL
)
4083 return s
->cert
->key
->x509
;
4088 EVP_PKEY
*SSL_get_privatekey(const SSL
*s
)
4090 if (s
->cert
!= NULL
)
4091 return s
->cert
->key
->privatekey
;
4096 X509
*SSL_CTX_get0_certificate(const SSL_CTX
*ctx
)
4098 if (ctx
->cert
!= NULL
)
4099 return ctx
->cert
->key
->x509
;
4104 EVP_PKEY
*SSL_CTX_get0_privatekey(const SSL_CTX
*ctx
)
4106 if (ctx
->cert
!= NULL
)
4107 return ctx
->cert
->key
->privatekey
;
4112 const SSL_CIPHER
*SSL_get_current_cipher(const SSL
*s
)
4114 if ((s
->session
!= NULL
) && (s
->session
->cipher
!= NULL
))
4115 return s
->session
->cipher
;
4119 const SSL_CIPHER
*SSL_get_pending_cipher(const SSL
*s
)
4121 return s
->s3
.tmp
.new_cipher
;
4124 const COMP_METHOD
*SSL_get_current_compression(const SSL
*s
)
4126 #ifndef OPENSSL_NO_COMP
4127 return s
->compress
? COMP_CTX_get_method(s
->compress
) : NULL
;
4133 const COMP_METHOD
*SSL_get_current_expansion(const SSL
*s
)
4135 #ifndef OPENSSL_NO_COMP
4136 return s
->expand
? COMP_CTX_get_method(s
->expand
) : NULL
;
4142 int ssl_init_wbio_buffer(SSL
*s
)
4146 if (s
->bbio
!= NULL
) {
4147 /* Already buffered. */
4151 bbio
= BIO_new(BIO_f_buffer());
4152 if (bbio
== NULL
|| !BIO_set_read_buffer_size(bbio
, 1)) {
4154 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER
, ERR_R_BUF_LIB
);
4158 s
->wbio
= BIO_push(bbio
, s
->wbio
);
4163 int ssl_free_wbio_buffer(SSL
*s
)
4165 /* callers ensure s is never null */
4166 if (s
->bbio
== NULL
)
4169 s
->wbio
= BIO_pop(s
->wbio
);
4176 void SSL_CTX_set_quiet_shutdown(SSL_CTX
*ctx
, int mode
)
4178 ctx
->quiet_shutdown
= mode
;
4181 int SSL_CTX_get_quiet_shutdown(const SSL_CTX
*ctx
)
4183 return ctx
->quiet_shutdown
;
4186 void SSL_set_quiet_shutdown(SSL
*s
, int mode
)
4188 s
->quiet_shutdown
= mode
;
4191 int SSL_get_quiet_shutdown(const SSL
*s
)
4193 return s
->quiet_shutdown
;
4196 void SSL_set_shutdown(SSL
*s
, int mode
)
4201 int SSL_get_shutdown(const SSL
*s
)
4206 int SSL_version(const SSL
*s
)
4211 int SSL_client_version(const SSL
*s
)
4213 return s
->client_version
;
4216 SSL_CTX
*SSL_get_SSL_CTX(const SSL
*ssl
)
4221 SSL_CTX
*SSL_set_SSL_CTX(SSL
*ssl
, SSL_CTX
*ctx
)
4224 if (ssl
->ctx
== ctx
)
4227 ctx
= ssl
->session_ctx
;
4228 new_cert
= ssl_cert_dup(ctx
->cert
);
4229 if (new_cert
== NULL
) {
4233 if (!custom_exts_copy_flags(&new_cert
->custext
, &ssl
->cert
->custext
)) {
4234 ssl_cert_free(new_cert
);
4238 ssl_cert_free(ssl
->cert
);
4239 ssl
->cert
= new_cert
;
4242 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
4243 * so setter APIs must prevent invalid lengths from entering the system.
4245 if (!ossl_assert(ssl
->sid_ctx_length
<= sizeof(ssl
->sid_ctx
)))
4249 * If the session ID context matches that of the parent SSL_CTX,
4250 * inherit it from the new SSL_CTX as well. If however the context does
4251 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4252 * leave it unchanged.
4254 if ((ssl
->ctx
!= NULL
) &&
4255 (ssl
->sid_ctx_length
== ssl
->ctx
->sid_ctx_length
) &&
4256 (memcmp(ssl
->sid_ctx
, ssl
->ctx
->sid_ctx
, ssl
->sid_ctx_length
) == 0)) {
4257 ssl
->sid_ctx_length
= ctx
->sid_ctx_length
;
4258 memcpy(&ssl
->sid_ctx
, &ctx
->sid_ctx
, sizeof(ssl
->sid_ctx
));
4261 SSL_CTX_up_ref(ctx
);
4262 SSL_CTX_free(ssl
->ctx
); /* decrement reference count */
4268 int SSL_CTX_set_default_verify_paths(SSL_CTX
*ctx
)
4270 return X509_STORE_set_default_paths(ctx
->cert_store
);
4273 int SSL_CTX_set_default_verify_dir(SSL_CTX
*ctx
)
4275 X509_LOOKUP
*lookup
;
4277 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_hash_dir());
4281 /* We ignore errors, in case the directory doesn't exist */
4284 X509_LOOKUP_add_dir(lookup
, NULL
, X509_FILETYPE_DEFAULT
);
4291 int SSL_CTX_set_default_verify_file(SSL_CTX
*ctx
)
4293 X509_LOOKUP
*lookup
;
4295 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_file());
4299 /* We ignore errors, in case the directory doesn't exist */
4302 X509_LOOKUP_load_file(lookup
, NULL
, X509_FILETYPE_DEFAULT
);
4309 int SSL_CTX_set_default_verify_store(SSL_CTX
*ctx
)
4311 X509_LOOKUP
*lookup
;
4313 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_store());
4317 /* We ignore errors, in case the directory doesn't exist */
4320 X509_LOOKUP_add_store(lookup
, NULL
);
4327 int SSL_CTX_load_verify_file(SSL_CTX
*ctx
, const char *CAfile
)
4329 return X509_STORE_load_file(ctx
->cert_store
, CAfile
);
4332 int SSL_CTX_load_verify_dir(SSL_CTX
*ctx
, const char *CApath
)
4334 return X509_STORE_load_path(ctx
->cert_store
, CApath
);
4337 int SSL_CTX_load_verify_store(SSL_CTX
*ctx
, const char *CAstore
)
4339 return X509_STORE_load_store(ctx
->cert_store
, CAstore
);
4342 #ifndef OPENSSL_NO_DEPRECATED_3_0
4343 int SSL_CTX_load_verify_locations(SSL_CTX
*ctx
, const char *CAfile
,
4346 if (CAfile
== NULL
&& CApath
== NULL
)
4348 if (CAfile
!= NULL
&& !SSL_CTX_load_verify_file(ctx
, CAfile
))
4350 if (CApath
!= NULL
&& !SSL_CTX_load_verify_dir(ctx
, CApath
))
4356 void SSL_set_info_callback(SSL
*ssl
,
4357 void (*cb
) (const SSL
*ssl
, int type
, int val
))
4359 ssl
->info_callback
= cb
;
4363 * One compiler (Diab DCC) doesn't like argument names in returned function
4366 void (*SSL_get_info_callback(const SSL
*ssl
)) (const SSL
* /* ssl */ ,
4369 return ssl
->info_callback
;
4372 void SSL_set_verify_result(SSL
*ssl
, long arg
)
4374 ssl
->verify_result
= arg
;
4377 long SSL_get_verify_result(const SSL
*ssl
)
4379 return ssl
->verify_result
;
4382 size_t SSL_get_client_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
4385 return sizeof(ssl
->s3
.client_random
);
4386 if (outlen
> sizeof(ssl
->s3
.client_random
))
4387 outlen
= sizeof(ssl
->s3
.client_random
);
4388 memcpy(out
, ssl
->s3
.client_random
, outlen
);
4392 size_t SSL_get_server_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
4395 return sizeof(ssl
->s3
.server_random
);
4396 if (outlen
> sizeof(ssl
->s3
.server_random
))
4397 outlen
= sizeof(ssl
->s3
.server_random
);
4398 memcpy(out
, ssl
->s3
.server_random
, outlen
);
4402 size_t SSL_SESSION_get_master_key(const SSL_SESSION
*session
,
4403 unsigned char *out
, size_t outlen
)
4406 return session
->master_key_length
;
4407 if (outlen
> session
->master_key_length
)
4408 outlen
= session
->master_key_length
;
4409 memcpy(out
, session
->master_key
, outlen
);
4413 int SSL_SESSION_set1_master_key(SSL_SESSION
*sess
, const unsigned char *in
,
4416 if (len
> sizeof(sess
->master_key
))
4419 memcpy(sess
->master_key
, in
, len
);
4420 sess
->master_key_length
= len
;
4425 int SSL_set_ex_data(SSL
*s
, int idx
, void *arg
)
4427 return CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
);
4430 void *SSL_get_ex_data(const SSL
*s
, int idx
)
4432 return CRYPTO_get_ex_data(&s
->ex_data
, idx
);
4435 int SSL_CTX_set_ex_data(SSL_CTX
*s
, int idx
, void *arg
)
4437 return CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
);
4440 void *SSL_CTX_get_ex_data(const SSL_CTX
*s
, int idx
)
4442 return CRYPTO_get_ex_data(&s
->ex_data
, idx
);
4445 X509_STORE
*SSL_CTX_get_cert_store(const SSL_CTX
*ctx
)
4447 return ctx
->cert_store
;
4450 void SSL_CTX_set_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
4452 X509_STORE_free(ctx
->cert_store
);
4453 ctx
->cert_store
= store
;
4456 void SSL_CTX_set1_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
4459 X509_STORE_up_ref(store
);
4460 SSL_CTX_set_cert_store(ctx
, store
);
4463 int SSL_want(const SSL
*s
)
4469 * \brief Set the callback for generating temporary DH keys.
4470 * \param ctx the SSL context.
4471 * \param dh the callback
4474 #ifndef OPENSSL_NO_DH
4475 void SSL_CTX_set_tmp_dh_callback(SSL_CTX
*ctx
,
4476 DH
*(*dh
) (SSL
*ssl
, int is_export
,
4479 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_TMP_DH_CB
, (void (*)(void))dh
);
4482 void SSL_set_tmp_dh_callback(SSL
*ssl
, DH
*(*dh
) (SSL
*ssl
, int is_export
,
4485 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_TMP_DH_CB
, (void (*)(void))dh
);
4489 #ifndef OPENSSL_NO_PSK
4490 int SSL_CTX_use_psk_identity_hint(SSL_CTX
*ctx
, const char *identity_hint
)
4492 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
4493 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT
, SSL_R_DATA_LENGTH_TOO_LONG
);
4496 OPENSSL_free(ctx
->cert
->psk_identity_hint
);
4497 if (identity_hint
!= NULL
) {
4498 ctx
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
4499 if (ctx
->cert
->psk_identity_hint
== NULL
)
4502 ctx
->cert
->psk_identity_hint
= NULL
;
4506 int SSL_use_psk_identity_hint(SSL
*s
, const char *identity_hint
)
4511 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
4512 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT
, SSL_R_DATA_LENGTH_TOO_LONG
);
4515 OPENSSL_free(s
->cert
->psk_identity_hint
);
4516 if (identity_hint
!= NULL
) {
4517 s
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
4518 if (s
->cert
->psk_identity_hint
== NULL
)
4521 s
->cert
->psk_identity_hint
= NULL
;
4525 const char *SSL_get_psk_identity_hint(const SSL
*s
)
4527 if (s
== NULL
|| s
->session
== NULL
)
4529 return s
->session
->psk_identity_hint
;
4532 const char *SSL_get_psk_identity(const SSL
*s
)
4534 if (s
== NULL
|| s
->session
== NULL
)
4536 return s
->session
->psk_identity
;
4539 void SSL_set_psk_client_callback(SSL
*s
, SSL_psk_client_cb_func cb
)
4541 s
->psk_client_callback
= cb
;
4544 void SSL_CTX_set_psk_client_callback(SSL_CTX
*ctx
, SSL_psk_client_cb_func cb
)
4546 ctx
->psk_client_callback
= cb
;
4549 void SSL_set_psk_server_callback(SSL
*s
, SSL_psk_server_cb_func cb
)
4551 s
->psk_server_callback
= cb
;
4554 void SSL_CTX_set_psk_server_callback(SSL_CTX
*ctx
, SSL_psk_server_cb_func cb
)
4556 ctx
->psk_server_callback
= cb
;
4560 void SSL_set_psk_find_session_callback(SSL
*s
, SSL_psk_find_session_cb_func cb
)
4562 s
->psk_find_session_cb
= cb
;
4565 void SSL_CTX_set_psk_find_session_callback(SSL_CTX
*ctx
,
4566 SSL_psk_find_session_cb_func cb
)
4568 ctx
->psk_find_session_cb
= cb
;
4571 void SSL_set_psk_use_session_callback(SSL
*s
, SSL_psk_use_session_cb_func cb
)
4573 s
->psk_use_session_cb
= cb
;
4576 void SSL_CTX_set_psk_use_session_callback(SSL_CTX
*ctx
,
4577 SSL_psk_use_session_cb_func cb
)
4579 ctx
->psk_use_session_cb
= cb
;
4582 void SSL_CTX_set_msg_callback(SSL_CTX
*ctx
,
4583 void (*cb
) (int write_p
, int version
,
4584 int content_type
, const void *buf
,
4585 size_t len
, SSL
*ssl
, void *arg
))
4587 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
4590 void SSL_set_msg_callback(SSL
*ssl
,
4591 void (*cb
) (int write_p
, int version
,
4592 int content_type
, const void *buf
,
4593 size_t len
, SSL
*ssl
, void *arg
))
4595 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
4598 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX
*ctx
,
4599 int (*cb
) (SSL
*ssl
,
4603 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
4604 (void (*)(void))cb
);
4607 void SSL_set_not_resumable_session_callback(SSL
*ssl
,
4608 int (*cb
) (SSL
*ssl
,
4609 int is_forward_secure
))
4611 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
4612 (void (*)(void))cb
);
4615 void SSL_CTX_set_record_padding_callback(SSL_CTX
*ctx
,
4616 size_t (*cb
) (SSL
*ssl
, int type
,
4617 size_t len
, void *arg
))
4619 ctx
->record_padding_cb
= cb
;
4622 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX
*ctx
, void *arg
)
4624 ctx
->record_padding_arg
= arg
;
4627 void *SSL_CTX_get_record_padding_callback_arg(const SSL_CTX
*ctx
)
4629 return ctx
->record_padding_arg
;
4632 int SSL_CTX_set_block_padding(SSL_CTX
*ctx
, size_t block_size
)
4634 /* block size of 0 or 1 is basically no padding */
4635 if (block_size
== 1)
4636 ctx
->block_padding
= 0;
4637 else if (block_size
<= SSL3_RT_MAX_PLAIN_LENGTH
)
4638 ctx
->block_padding
= block_size
;
4644 void SSL_set_record_padding_callback(SSL
*ssl
,
4645 size_t (*cb
) (SSL
*ssl
, int type
,
4646 size_t len
, void *arg
))
4648 ssl
->record_padding_cb
= cb
;
4651 void SSL_set_record_padding_callback_arg(SSL
*ssl
, void *arg
)
4653 ssl
->record_padding_arg
= arg
;
4656 void *SSL_get_record_padding_callback_arg(const SSL
*ssl
)
4658 return ssl
->record_padding_arg
;
4661 int SSL_set_block_padding(SSL
*ssl
, size_t block_size
)
4663 /* block size of 0 or 1 is basically no padding */
4664 if (block_size
== 1)
4665 ssl
->block_padding
= 0;
4666 else if (block_size
<= SSL3_RT_MAX_PLAIN_LENGTH
)
4667 ssl
->block_padding
= block_size
;
4673 int SSL_set_num_tickets(SSL
*s
, size_t num_tickets
)
4675 s
->num_tickets
= num_tickets
;
4680 size_t SSL_get_num_tickets(const SSL
*s
)
4682 return s
->num_tickets
;
4685 int SSL_CTX_set_num_tickets(SSL_CTX
*ctx
, size_t num_tickets
)
4687 ctx
->num_tickets
= num_tickets
;
4692 size_t SSL_CTX_get_num_tickets(const SSL_CTX
*ctx
)
4694 return ctx
->num_tickets
;
4698 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4699 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4700 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4701 * Returns the newly allocated ctx;
4704 EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
)
4706 ssl_clear_hash_ctx(hash
);
4707 *hash
= EVP_MD_CTX_new();
4708 if (*hash
== NULL
|| (md
&& EVP_DigestInit_ex(*hash
, md
, NULL
) <= 0)) {
4709 EVP_MD_CTX_free(*hash
);
4716 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
)
4719 EVP_MD_CTX_free(*hash
);
4723 /* Retrieve handshake hashes */
4724 int ssl_handshake_hash(SSL
*s
, unsigned char *out
, size_t outlen
,
4727 EVP_MD_CTX
*ctx
= NULL
;
4728 EVP_MD_CTX
*hdgst
= s
->s3
.handshake_dgst
;
4729 int hashleni
= EVP_MD_CTX_size(hdgst
);
4732 if (hashleni
< 0 || (size_t)hashleni
> outlen
) {
4733 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL_HANDSHAKE_HASH
,
4734 ERR_R_INTERNAL_ERROR
);
4738 ctx
= EVP_MD_CTX_new();
4742 if (!EVP_MD_CTX_copy_ex(ctx
, hdgst
)
4743 || EVP_DigestFinal_ex(ctx
, out
, NULL
) <= 0) {
4744 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL_HANDSHAKE_HASH
,
4745 ERR_R_INTERNAL_ERROR
);
4749 *hashlen
= hashleni
;
4753 EVP_MD_CTX_free(ctx
);
4757 int SSL_session_reused(const SSL
*s
)
4762 int SSL_is_server(const SSL
*s
)
4767 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
4768 void SSL_set_debug(SSL
*s
, int debug
)
4770 /* Old function was do-nothing anyway... */
4776 void SSL_set_security_level(SSL
*s
, int level
)
4778 s
->cert
->sec_level
= level
;
4781 int SSL_get_security_level(const SSL
*s
)
4783 return s
->cert
->sec_level
;
4786 void SSL_set_security_callback(SSL
*s
,
4787 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
4788 int op
, int bits
, int nid
,
4789 void *other
, void *ex
))
4791 s
->cert
->sec_cb
= cb
;
4794 int (*SSL_get_security_callback(const SSL
*s
)) (const SSL
*s
,
4795 const SSL_CTX
*ctx
, int op
,
4796 int bits
, int nid
, void *other
,
4798 return s
->cert
->sec_cb
;
4801 void SSL_set0_security_ex_data(SSL
*s
, void *ex
)
4803 s
->cert
->sec_ex
= ex
;
4806 void *SSL_get0_security_ex_data(const SSL
*s
)
4808 return s
->cert
->sec_ex
;
4811 void SSL_CTX_set_security_level(SSL_CTX
*ctx
, int level
)
4813 ctx
->cert
->sec_level
= level
;
4816 int SSL_CTX_get_security_level(const SSL_CTX
*ctx
)
4818 return ctx
->cert
->sec_level
;
4821 void SSL_CTX_set_security_callback(SSL_CTX
*ctx
,
4822 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
4823 int op
, int bits
, int nid
,
4824 void *other
, void *ex
))
4826 ctx
->cert
->sec_cb
= cb
;
4829 int (*SSL_CTX_get_security_callback(const SSL_CTX
*ctx
)) (const SSL
*s
,
4835 return ctx
->cert
->sec_cb
;
4838 void SSL_CTX_set0_security_ex_data(SSL_CTX
*ctx
, void *ex
)
4840 ctx
->cert
->sec_ex
= ex
;
4843 void *SSL_CTX_get0_security_ex_data(const SSL_CTX
*ctx
)
4845 return ctx
->cert
->sec_ex
;
4849 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4850 * can return unsigned long, instead of the generic long return value from the
4851 * control interface.
4853 unsigned long SSL_CTX_get_options(const SSL_CTX
*ctx
)
4855 return ctx
->options
;
4858 unsigned long SSL_get_options(const SSL
*s
)
4863 unsigned long SSL_CTX_set_options(SSL_CTX
*ctx
, unsigned long op
)
4865 return ctx
->options
|= op
;
4868 unsigned long SSL_set_options(SSL
*s
, unsigned long op
)
4870 return s
->options
|= op
;
4873 unsigned long SSL_CTX_clear_options(SSL_CTX
*ctx
, unsigned long op
)
4875 return ctx
->options
&= ~op
;
4878 unsigned long SSL_clear_options(SSL
*s
, unsigned long op
)
4880 return s
->options
&= ~op
;
4883 STACK_OF(X509
) *SSL_get0_verified_chain(const SSL
*s
)
4885 return s
->verified_chain
;
4888 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
4890 #ifndef OPENSSL_NO_CT
4893 * Moves SCTs from the |src| stack to the |dst| stack.
4894 * The source of each SCT will be set to |origin|.
4895 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4897 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4899 static int ct_move_scts(STACK_OF(SCT
) **dst
, STACK_OF(SCT
) *src
,
4900 sct_source_t origin
)
4906 *dst
= sk_SCT_new_null();
4908 SSLerr(SSL_F_CT_MOVE_SCTS
, ERR_R_MALLOC_FAILURE
);
4913 while ((sct
= sk_SCT_pop(src
)) != NULL
) {
4914 if (SCT_set_source(sct
, origin
) != 1)
4917 if (sk_SCT_push(*dst
, sct
) <= 0)
4925 sk_SCT_push(src
, sct
); /* Put the SCT back */
4930 * Look for data collected during ServerHello and parse if found.
4931 * Returns the number of SCTs extracted.
4933 static int ct_extract_tls_extension_scts(SSL
*s
)
4935 int scts_extracted
= 0;
4937 if (s
->ext
.scts
!= NULL
) {
4938 const unsigned char *p
= s
->ext
.scts
;
4939 STACK_OF(SCT
) *scts
= o2i_SCT_LIST(NULL
, &p
, s
->ext
.scts_len
);
4941 scts_extracted
= ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_TLS_EXTENSION
);
4943 SCT_LIST_free(scts
);
4946 return scts_extracted
;
4950 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4951 * contains an SCT X509 extension. They will be stored in |s->scts|.
4953 * - The number of SCTs extracted, assuming an OCSP response exists.
4954 * - 0 if no OCSP response exists or it contains no SCTs.
4955 * - A negative integer if an error occurs.
4957 static int ct_extract_ocsp_response_scts(SSL
*s
)
4959 # ifndef OPENSSL_NO_OCSP
4960 int scts_extracted
= 0;
4961 const unsigned char *p
;
4962 OCSP_BASICRESP
*br
= NULL
;
4963 OCSP_RESPONSE
*rsp
= NULL
;
4964 STACK_OF(SCT
) *scts
= NULL
;
4967 if (s
->ext
.ocsp
.resp
== NULL
|| s
->ext
.ocsp
.resp_len
== 0)
4970 p
= s
->ext
.ocsp
.resp
;
4971 rsp
= d2i_OCSP_RESPONSE(NULL
, &p
, (int)s
->ext
.ocsp
.resp_len
);
4975 br
= OCSP_response_get1_basic(rsp
);
4979 for (i
= 0; i
< OCSP_resp_count(br
); ++i
) {
4980 OCSP_SINGLERESP
*single
= OCSP_resp_get0(br
, i
);
4986 OCSP_SINGLERESP_get1_ext_d2i(single
, NID_ct_cert_scts
, NULL
, NULL
);
4988 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_OCSP_STAPLED_RESPONSE
);
4989 if (scts_extracted
< 0)
4993 SCT_LIST_free(scts
);
4994 OCSP_BASICRESP_free(br
);
4995 OCSP_RESPONSE_free(rsp
);
4996 return scts_extracted
;
4998 /* Behave as if no OCSP response exists */
5004 * Attempts to extract SCTs from the peer certificate.
5005 * Return the number of SCTs extracted, or a negative integer if an error
5008 static int ct_extract_x509v3_extension_scts(SSL
*s
)
5010 int scts_extracted
= 0;
5011 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
5014 STACK_OF(SCT
) *scts
=
5015 X509_get_ext_d2i(cert
, NID_ct_precert_scts
, NULL
, NULL
);
5018 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_X509V3_EXTENSION
);
5020 SCT_LIST_free(scts
);
5023 return scts_extracted
;
5027 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
5028 * response (if it exists) and X509v3 extensions in the certificate.
5029 * Returns NULL if an error occurs.
5031 const STACK_OF(SCT
) *SSL_get0_peer_scts(SSL
*s
)
5033 if (!s
->scts_parsed
) {
5034 if (ct_extract_tls_extension_scts(s
) < 0 ||
5035 ct_extract_ocsp_response_scts(s
) < 0 ||
5036 ct_extract_x509v3_extension_scts(s
) < 0)
5046 static int ct_permissive(const CT_POLICY_EVAL_CTX
* ctx
,
5047 const STACK_OF(SCT
) *scts
, void *unused_arg
)
5052 static int ct_strict(const CT_POLICY_EVAL_CTX
* ctx
,
5053 const STACK_OF(SCT
) *scts
, void *unused_arg
)
5055 int count
= scts
!= NULL
? sk_SCT_num(scts
) : 0;
5058 for (i
= 0; i
< count
; ++i
) {
5059 SCT
*sct
= sk_SCT_value(scts
, i
);
5060 int status
= SCT_get_validation_status(sct
);
5062 if (status
== SCT_VALIDATION_STATUS_VALID
)
5065 SSLerr(SSL_F_CT_STRICT
, SSL_R_NO_VALID_SCTS
);
5069 int SSL_set_ct_validation_callback(SSL
*s
, ssl_ct_validation_cb callback
,
5073 * Since code exists that uses the custom extension handler for CT, look
5074 * for this and throw an error if they have already registered to use CT.
5076 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(s
->ctx
,
5077 TLSEXT_TYPE_signed_certificate_timestamp
))
5079 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK
,
5080 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
5084 if (callback
!= NULL
) {
5086 * If we are validating CT, then we MUST accept SCTs served via OCSP
5088 if (!SSL_set_tlsext_status_type(s
, TLSEXT_STATUSTYPE_ocsp
))
5092 s
->ct_validation_callback
= callback
;
5093 s
->ct_validation_callback_arg
= arg
;
5098 int SSL_CTX_set_ct_validation_callback(SSL_CTX
*ctx
,
5099 ssl_ct_validation_cb callback
, void *arg
)
5102 * Since code exists that uses the custom extension handler for CT, look for
5103 * this and throw an error if they have already registered to use CT.
5105 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(ctx
,
5106 TLSEXT_TYPE_signed_certificate_timestamp
))
5108 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK
,
5109 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
5113 ctx
->ct_validation_callback
= callback
;
5114 ctx
->ct_validation_callback_arg
= arg
;
5118 int SSL_ct_is_enabled(const SSL
*s
)
5120 return s
->ct_validation_callback
!= NULL
;
5123 int SSL_CTX_ct_is_enabled(const SSL_CTX
*ctx
)
5125 return ctx
->ct_validation_callback
!= NULL
;
5128 int ssl_validate_ct(SSL
*s
)
5131 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
5133 SSL_DANE
*dane
= &s
->dane
;
5134 CT_POLICY_EVAL_CTX
*ctx
= NULL
;
5135 const STACK_OF(SCT
) *scts
;
5138 * If no callback is set, the peer is anonymous, or its chain is invalid,
5139 * skip SCT validation - just return success. Applications that continue
5140 * handshakes without certificates, with unverified chains, or pinned leaf
5141 * certificates are outside the scope of the WebPKI and CT.
5143 * The above exclusions notwithstanding the vast majority of peers will
5144 * have rather ordinary certificate chains validated by typical
5145 * applications that perform certificate verification and therefore will
5146 * process SCTs when enabled.
5148 if (s
->ct_validation_callback
== NULL
|| cert
== NULL
||
5149 s
->verify_result
!= X509_V_OK
||
5150 s
->verified_chain
== NULL
|| sk_X509_num(s
->verified_chain
) <= 1)
5154 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
5155 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
5157 if (DANETLS_ENABLED(dane
) && dane
->mtlsa
!= NULL
) {
5158 switch (dane
->mtlsa
->usage
) {
5159 case DANETLS_USAGE_DANE_TA
:
5160 case DANETLS_USAGE_DANE_EE
:
5165 ctx
= CT_POLICY_EVAL_CTX_new_with_libctx(s
->ctx
->libctx
, s
->ctx
->propq
);
5167 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL_VALIDATE_CT
,
5168 ERR_R_MALLOC_FAILURE
);
5172 issuer
= sk_X509_value(s
->verified_chain
, 1);
5173 CT_POLICY_EVAL_CTX_set1_cert(ctx
, cert
);
5174 CT_POLICY_EVAL_CTX_set1_issuer(ctx
, issuer
);
5175 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx
, s
->ctx
->ctlog_store
);
5176 CT_POLICY_EVAL_CTX_set_time(
5177 ctx
, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s
)) * 1000);
5179 scts
= SSL_get0_peer_scts(s
);
5182 * This function returns success (> 0) only when all the SCTs are valid, 0
5183 * when some are invalid, and < 0 on various internal errors (out of
5184 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
5185 * reason to abort the handshake, that decision is up to the callback.
5186 * Therefore, we error out only in the unexpected case that the return
5187 * value is negative.
5189 * XXX: One might well argue that the return value of this function is an
5190 * unfortunate design choice. Its job is only to determine the validation
5191 * status of each of the provided SCTs. So long as it correctly separates
5192 * the wheat from the chaff it should return success. Failure in this case
5193 * ought to correspond to an inability to carry out its duties.
5195 if (SCT_LIST_validate(scts
, ctx
) < 0) {
5196 SSLfatal(s
, SSL_AD_HANDSHAKE_FAILURE
, SSL_F_SSL_VALIDATE_CT
,
5197 SSL_R_SCT_VERIFICATION_FAILED
);
5201 ret
= s
->ct_validation_callback(ctx
, scts
, s
->ct_validation_callback_arg
);
5203 ret
= 0; /* This function returns 0 on failure */
5205 SSLfatal(s
, SSL_AD_HANDSHAKE_FAILURE
, SSL_F_SSL_VALIDATE_CT
,
5206 SSL_R_CALLBACK_FAILED
);
5209 CT_POLICY_EVAL_CTX_free(ctx
);
5211 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
5212 * failure return code here. Also the application may wish the complete
5213 * the handshake, and then disconnect cleanly at a higher layer, after
5214 * checking the verification status of the completed connection.
5216 * We therefore force a certificate verification failure which will be
5217 * visible via SSL_get_verify_result() and cached as part of any resumed
5220 * Note: the permissive callback is for information gathering only, always
5221 * returns success, and does not affect verification status. Only the
5222 * strict callback or a custom application-specified callback can trigger
5223 * connection failure or record a verification error.
5226 s
->verify_result
= X509_V_ERR_NO_VALID_SCTS
;
5230 int SSL_CTX_enable_ct(SSL_CTX
*ctx
, int validation_mode
)
5232 switch (validation_mode
) {
5234 SSLerr(SSL_F_SSL_CTX_ENABLE_CT
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
5236 case SSL_CT_VALIDATION_PERMISSIVE
:
5237 return SSL_CTX_set_ct_validation_callback(ctx
, ct_permissive
, NULL
);
5238 case SSL_CT_VALIDATION_STRICT
:
5239 return SSL_CTX_set_ct_validation_callback(ctx
, ct_strict
, NULL
);
5243 int SSL_enable_ct(SSL
*s
, int validation_mode
)
5245 switch (validation_mode
) {
5247 SSLerr(SSL_F_SSL_ENABLE_CT
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
5249 case SSL_CT_VALIDATION_PERMISSIVE
:
5250 return SSL_set_ct_validation_callback(s
, ct_permissive
, NULL
);
5251 case SSL_CT_VALIDATION_STRICT
:
5252 return SSL_set_ct_validation_callback(s
, ct_strict
, NULL
);
5256 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX
*ctx
)
5258 return CTLOG_STORE_load_default_file(ctx
->ctlog_store
);
5261 int SSL_CTX_set_ctlog_list_file(SSL_CTX
*ctx
, const char *path
)
5263 return CTLOG_STORE_load_file(ctx
->ctlog_store
, path
);
5266 void SSL_CTX_set0_ctlog_store(SSL_CTX
*ctx
, CTLOG_STORE
* logs
)
5268 CTLOG_STORE_free(ctx
->ctlog_store
);
5269 ctx
->ctlog_store
= logs
;
5272 const CTLOG_STORE
*SSL_CTX_get0_ctlog_store(const SSL_CTX
*ctx
)
5274 return ctx
->ctlog_store
;
5277 #endif /* OPENSSL_NO_CT */
5279 void SSL_CTX_set_client_hello_cb(SSL_CTX
*c
, SSL_client_hello_cb_fn cb
,
5282 c
->client_hello_cb
= cb
;
5283 c
->client_hello_cb_arg
= arg
;
5286 int SSL_client_hello_isv2(SSL
*s
)
5288 if (s
->clienthello
== NULL
)
5290 return s
->clienthello
->isv2
;
5293 unsigned int SSL_client_hello_get0_legacy_version(SSL
*s
)
5295 if (s
->clienthello
== NULL
)
5297 return s
->clienthello
->legacy_version
;
5300 size_t SSL_client_hello_get0_random(SSL
*s
, const unsigned char **out
)
5302 if (s
->clienthello
== NULL
)
5305 *out
= s
->clienthello
->random
;
5306 return SSL3_RANDOM_SIZE
;
5309 size_t SSL_client_hello_get0_session_id(SSL
*s
, const unsigned char **out
)
5311 if (s
->clienthello
== NULL
)
5314 *out
= s
->clienthello
->session_id
;
5315 return s
->clienthello
->session_id_len
;
5318 size_t SSL_client_hello_get0_ciphers(SSL
*s
, const unsigned char **out
)
5320 if (s
->clienthello
== NULL
)
5323 *out
= PACKET_data(&s
->clienthello
->ciphersuites
);
5324 return PACKET_remaining(&s
->clienthello
->ciphersuites
);
5327 size_t SSL_client_hello_get0_compression_methods(SSL
*s
, const unsigned char **out
)
5329 if (s
->clienthello
== NULL
)
5332 *out
= s
->clienthello
->compressions
;
5333 return s
->clienthello
->compressions_len
;
5336 int SSL_client_hello_get1_extensions_present(SSL
*s
, int **out
, size_t *outlen
)
5342 if (s
->clienthello
== NULL
|| out
== NULL
|| outlen
== NULL
)
5344 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; i
++) {
5345 ext
= s
->clienthello
->pre_proc_exts
+ i
;
5354 if ((present
= OPENSSL_malloc(sizeof(*present
) * num
)) == NULL
) {
5355 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT
,
5356 ERR_R_MALLOC_FAILURE
);
5359 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; i
++) {
5360 ext
= s
->clienthello
->pre_proc_exts
+ i
;
5362 if (ext
->received_order
>= num
)
5364 present
[ext
->received_order
] = ext
->type
;
5371 OPENSSL_free(present
);
5375 int SSL_client_hello_get0_ext(SSL
*s
, unsigned int type
, const unsigned char **out
,
5381 if (s
->clienthello
== NULL
)
5383 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; ++i
) {
5384 r
= s
->clienthello
->pre_proc_exts
+ i
;
5385 if (r
->present
&& r
->type
== type
) {
5387 *out
= PACKET_data(&r
->data
);
5389 *outlen
= PACKET_remaining(&r
->data
);
5396 int SSL_free_buffers(SSL
*ssl
)
5398 RECORD_LAYER
*rl
= &ssl
->rlayer
;
5400 if (RECORD_LAYER_read_pending(rl
) || RECORD_LAYER_write_pending(rl
))
5403 RECORD_LAYER_release(rl
);
5407 int SSL_alloc_buffers(SSL
*ssl
)
5409 return ssl3_setup_buffers(ssl
);
5412 void SSL_CTX_set_keylog_callback(SSL_CTX
*ctx
, SSL_CTX_keylog_cb_func cb
)
5414 ctx
->keylog_callback
= cb
;
5417 SSL_CTX_keylog_cb_func
SSL_CTX_get_keylog_callback(const SSL_CTX
*ctx
)
5419 return ctx
->keylog_callback
;
5422 static int nss_keylog_int(const char *prefix
,
5424 const uint8_t *parameter_1
,
5425 size_t parameter_1_len
,
5426 const uint8_t *parameter_2
,
5427 size_t parameter_2_len
)
5430 char *cursor
= NULL
;
5435 if (ssl
->ctx
->keylog_callback
== NULL
)
5439 * Our output buffer will contain the following strings, rendered with
5440 * space characters in between, terminated by a NULL character: first the
5441 * prefix, then the first parameter, then the second parameter. The
5442 * meaning of each parameter depends on the specific key material being
5443 * logged. Note that the first and second parameters are encoded in
5444 * hexadecimal, so we need a buffer that is twice their lengths.
5446 prefix_len
= strlen(prefix
);
5447 out_len
= prefix_len
+ (2 * parameter_1_len
) + (2 * parameter_2_len
) + 3;
5448 if ((out
= cursor
= OPENSSL_malloc(out_len
)) == NULL
) {
5449 SSLfatal(ssl
, SSL_AD_INTERNAL_ERROR
, SSL_F_NSS_KEYLOG_INT
,
5450 ERR_R_MALLOC_FAILURE
);
5454 strcpy(cursor
, prefix
);
5455 cursor
+= prefix_len
;
5458 for (i
= 0; i
< parameter_1_len
; i
++) {
5459 sprintf(cursor
, "%02x", parameter_1
[i
]);
5464 for (i
= 0; i
< parameter_2_len
; i
++) {
5465 sprintf(cursor
, "%02x", parameter_2
[i
]);
5470 ssl
->ctx
->keylog_callback(ssl
, (const char *)out
);
5471 OPENSSL_clear_free(out
, out_len
);
5476 int ssl_log_rsa_client_key_exchange(SSL
*ssl
,
5477 const uint8_t *encrypted_premaster
,
5478 size_t encrypted_premaster_len
,
5479 const uint8_t *premaster
,
5480 size_t premaster_len
)
5482 if (encrypted_premaster_len
< 8) {
5483 SSLfatal(ssl
, SSL_AD_INTERNAL_ERROR
,
5484 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE
, ERR_R_INTERNAL_ERROR
);
5488 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5489 return nss_keylog_int("RSA",
5491 encrypted_premaster
,
5497 int ssl_log_secret(SSL
*ssl
,
5499 const uint8_t *secret
,
5502 return nss_keylog_int(label
,
5504 ssl
->s3
.client_random
,
5510 #define SSLV2_CIPHER_LEN 3
5512 int ssl_cache_cipherlist(SSL
*s
, PACKET
*cipher_suites
, int sslv2format
)
5516 n
= sslv2format
? SSLV2_CIPHER_LEN
: TLS_CIPHER_LEN
;
5518 if (PACKET_remaining(cipher_suites
) == 0) {
5519 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_F_SSL_CACHE_CIPHERLIST
,
5520 SSL_R_NO_CIPHERS_SPECIFIED
);
5524 if (PACKET_remaining(cipher_suites
) % n
!= 0) {
5525 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_F_SSL_CACHE_CIPHERLIST
,
5526 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5530 OPENSSL_free(s
->s3
.tmp
.ciphers_raw
);
5531 s
->s3
.tmp
.ciphers_raw
= NULL
;
5532 s
->s3
.tmp
.ciphers_rawlen
= 0;
5535 size_t numciphers
= PACKET_remaining(cipher_suites
) / n
;
5536 PACKET sslv2ciphers
= *cipher_suites
;
5537 unsigned int leadbyte
;
5541 * We store the raw ciphers list in SSLv3+ format so we need to do some
5542 * preprocessing to convert the list first. If there are any SSLv2 only
5543 * ciphersuites with a non-zero leading byte then we are going to
5544 * slightly over allocate because we won't store those. But that isn't a
5547 raw
= OPENSSL_malloc(numciphers
* TLS_CIPHER_LEN
);
5548 s
->s3
.tmp
.ciphers_raw
= raw
;
5550 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL_CACHE_CIPHERLIST
,
5551 ERR_R_MALLOC_FAILURE
);
5554 for (s
->s3
.tmp
.ciphers_rawlen
= 0;
5555 PACKET_remaining(&sslv2ciphers
) > 0;
5556 raw
+= TLS_CIPHER_LEN
) {
5557 if (!PACKET_get_1(&sslv2ciphers
, &leadbyte
)
5559 && !PACKET_copy_bytes(&sslv2ciphers
, raw
,
5562 && !PACKET_forward(&sslv2ciphers
, TLS_CIPHER_LEN
))) {
5563 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_F_SSL_CACHE_CIPHERLIST
,
5565 OPENSSL_free(s
->s3
.tmp
.ciphers_raw
);
5566 s
->s3
.tmp
.ciphers_raw
= NULL
;
5567 s
->s3
.tmp
.ciphers_rawlen
= 0;
5571 s
->s3
.tmp
.ciphers_rawlen
+= TLS_CIPHER_LEN
;
5573 } else if (!PACKET_memdup(cipher_suites
, &s
->s3
.tmp
.ciphers_raw
,
5574 &s
->s3
.tmp
.ciphers_rawlen
)) {
5575 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL_CACHE_CIPHERLIST
,
5576 ERR_R_INTERNAL_ERROR
);
5582 int SSL_bytes_to_cipher_list(SSL
*s
, const unsigned char *bytes
, size_t len
,
5583 int isv2format
, STACK_OF(SSL_CIPHER
) **sk
,
5584 STACK_OF(SSL_CIPHER
) **scsvs
)
5588 if (!PACKET_buf_init(&pkt
, bytes
, len
))
5590 return bytes_to_cipher_list(s
, &pkt
, sk
, scsvs
, isv2format
, 0);
5593 int bytes_to_cipher_list(SSL
*s
, PACKET
*cipher_suites
,
5594 STACK_OF(SSL_CIPHER
) **skp
,
5595 STACK_OF(SSL_CIPHER
) **scsvs_out
,
5596 int sslv2format
, int fatal
)
5598 const SSL_CIPHER
*c
;
5599 STACK_OF(SSL_CIPHER
) *sk
= NULL
;
5600 STACK_OF(SSL_CIPHER
) *scsvs
= NULL
;
5602 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5603 unsigned char cipher
[SSLV2_CIPHER_LEN
];
5605 n
= sslv2format
? SSLV2_CIPHER_LEN
: TLS_CIPHER_LEN
;
5607 if (PACKET_remaining(cipher_suites
) == 0) {
5609 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_F_BYTES_TO_CIPHER_LIST
,
5610 SSL_R_NO_CIPHERS_SPECIFIED
);
5612 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST
, SSL_R_NO_CIPHERS_SPECIFIED
);
5616 if (PACKET_remaining(cipher_suites
) % n
!= 0) {
5618 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_F_BYTES_TO_CIPHER_LIST
,
5619 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5621 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST
,
5622 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5626 sk
= sk_SSL_CIPHER_new_null();
5627 scsvs
= sk_SSL_CIPHER_new_null();
5628 if (sk
== NULL
|| scsvs
== NULL
) {
5630 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_BYTES_TO_CIPHER_LIST
,
5631 ERR_R_MALLOC_FAILURE
);
5633 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST
, ERR_R_MALLOC_FAILURE
);
5637 while (PACKET_copy_bytes(cipher_suites
, cipher
, n
)) {
5639 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5640 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5641 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5643 if (sslv2format
&& cipher
[0] != '\0')
5646 /* For SSLv2-compat, ignore leading 0-byte. */
5647 c
= ssl_get_cipher_by_char(s
, sslv2format
? &cipher
[1] : cipher
, 1);
5649 if ((c
->valid
&& !sk_SSL_CIPHER_push(sk
, c
)) ||
5650 (!c
->valid
&& !sk_SSL_CIPHER_push(scsvs
, c
))) {
5652 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
5653 SSL_F_BYTES_TO_CIPHER_LIST
, ERR_R_MALLOC_FAILURE
);
5655 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST
, ERR_R_MALLOC_FAILURE
);
5660 if (PACKET_remaining(cipher_suites
) > 0) {
5662 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_F_BYTES_TO_CIPHER_LIST
,
5665 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST
, SSL_R_BAD_LENGTH
);
5672 sk_SSL_CIPHER_free(sk
);
5673 if (scsvs_out
!= NULL
)
5676 sk_SSL_CIPHER_free(scsvs
);
5679 sk_SSL_CIPHER_free(sk
);
5680 sk_SSL_CIPHER_free(scsvs
);
5684 int SSL_CTX_set_max_early_data(SSL_CTX
*ctx
, uint32_t max_early_data
)
5686 ctx
->max_early_data
= max_early_data
;
5691 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX
*ctx
)
5693 return ctx
->max_early_data
;
5696 int SSL_set_max_early_data(SSL
*s
, uint32_t max_early_data
)
5698 s
->max_early_data
= max_early_data
;
5703 uint32_t SSL_get_max_early_data(const SSL
*s
)
5705 return s
->max_early_data
;
5708 int SSL_CTX_set_recv_max_early_data(SSL_CTX
*ctx
, uint32_t recv_max_early_data
)
5710 ctx
->recv_max_early_data
= recv_max_early_data
;
5715 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX
*ctx
)
5717 return ctx
->recv_max_early_data
;
5720 int SSL_set_recv_max_early_data(SSL
*s
, uint32_t recv_max_early_data
)
5722 s
->recv_max_early_data
= recv_max_early_data
;
5727 uint32_t SSL_get_recv_max_early_data(const SSL
*s
)
5729 return s
->recv_max_early_data
;
5732 __owur
unsigned int ssl_get_max_send_fragment(const SSL
*ssl
)
5734 /* Return any active Max Fragment Len extension */
5735 if (ssl
->session
!= NULL
&& USE_MAX_FRAGMENT_LENGTH_EXT(ssl
->session
))
5736 return GET_MAX_FRAGMENT_LENGTH(ssl
->session
);
5738 /* return current SSL connection setting */
5739 return ssl
->max_send_fragment
;
5742 __owur
unsigned int ssl_get_split_send_fragment(const SSL
*ssl
)
5744 /* Return a value regarding an active Max Fragment Len extension */
5745 if (ssl
->session
!= NULL
&& USE_MAX_FRAGMENT_LENGTH_EXT(ssl
->session
)
5746 && ssl
->split_send_fragment
> GET_MAX_FRAGMENT_LENGTH(ssl
->session
))
5747 return GET_MAX_FRAGMENT_LENGTH(ssl
->session
);
5749 /* else limit |split_send_fragment| to current |max_send_fragment| */
5750 if (ssl
->split_send_fragment
> ssl
->max_send_fragment
)
5751 return ssl
->max_send_fragment
;
5753 /* return current SSL connection setting */
5754 return ssl
->split_send_fragment
;
5757 int SSL_stateless(SSL
*s
)
5761 /* Ensure there is no state left over from a previous invocation */
5767 s
->s3
.flags
|= TLS1_FLAGS_STATELESS
;
5768 ret
= SSL_accept(s
);
5769 s
->s3
.flags
&= ~TLS1_FLAGS_STATELESS
;
5771 if (ret
> 0 && s
->ext
.cookieok
)
5774 if (s
->hello_retry_request
== SSL_HRR_PENDING
&& !ossl_statem_in_error(s
))
5780 void SSL_CTX_set_post_handshake_auth(SSL_CTX
*ctx
, int val
)
5782 ctx
->pha_enabled
= val
;
5785 void SSL_set_post_handshake_auth(SSL
*ssl
, int val
)
5787 ssl
->pha_enabled
= val
;
5790 int SSL_verify_client_post_handshake(SSL
*ssl
)
5792 if (!SSL_IS_TLS13(ssl
)) {
5793 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE
, SSL_R_WRONG_SSL_VERSION
);
5797 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE
, SSL_R_NOT_SERVER
);
5801 if (!SSL_is_init_finished(ssl
)) {
5802 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE
, SSL_R_STILL_IN_INIT
);
5806 switch (ssl
->post_handshake_auth
) {
5808 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE
, SSL_R_EXTENSION_NOT_RECEIVED
);
5811 case SSL_PHA_EXT_SENT
:
5812 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE
, ERR_R_INTERNAL_ERROR
);
5814 case SSL_PHA_EXT_RECEIVED
:
5816 case SSL_PHA_REQUEST_PENDING
:
5817 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE
, SSL_R_REQUEST_PENDING
);
5819 case SSL_PHA_REQUESTED
:
5820 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE
, SSL_R_REQUEST_SENT
);
5824 ssl
->post_handshake_auth
= SSL_PHA_REQUEST_PENDING
;
5826 /* checks verify_mode and algorithm_auth */
5827 if (!send_certificate_request(ssl
)) {
5828 ssl
->post_handshake_auth
= SSL_PHA_EXT_RECEIVED
; /* restore on error */
5829 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE
, SSL_R_INVALID_CONFIG
);
5833 ossl_statem_set_in_init(ssl
, 1);
5837 int SSL_CTX_set_session_ticket_cb(SSL_CTX
*ctx
,
5838 SSL_CTX_generate_session_ticket_fn gen_cb
,
5839 SSL_CTX_decrypt_session_ticket_fn dec_cb
,
5842 ctx
->generate_ticket_cb
= gen_cb
;
5843 ctx
->decrypt_ticket_cb
= dec_cb
;
5844 ctx
->ticket_cb_data
= arg
;
5848 void SSL_CTX_set_allow_early_data_cb(SSL_CTX
*ctx
,
5849 SSL_allow_early_data_cb_fn cb
,
5852 ctx
->allow_early_data_cb
= cb
;
5853 ctx
->allow_early_data_cb_data
= arg
;
5856 void SSL_set_allow_early_data_cb(SSL
*s
,
5857 SSL_allow_early_data_cb_fn cb
,
5860 s
->allow_early_data_cb
= cb
;
5861 s
->allow_early_data_cb_data
= arg
;
5864 const EVP_CIPHER
*ssl_evp_cipher_fetch(OPENSSL_CTX
*libctx
,
5866 const char *properties
)
5870 #ifndef OPENSSL_NO_ENGINE
5874 * If there is an Engine available for this cipher we use the "implicit"
5875 * form to ensure we use that engine later.
5877 eng
= ENGINE_get_cipher_engine(nid
);
5880 return EVP_get_cipherbynid(nid
);
5884 /* Otherwise we do an explicit fetch. This may fail and that could be ok */
5886 ciph
= EVP_CIPHER_fetch(libctx
, OBJ_nid2sn(nid
), properties
);
5892 int ssl_evp_cipher_up_ref(const EVP_CIPHER
*cipher
)
5894 /* Don't up-ref an implicit EVP_CIPHER */
5895 if (EVP_CIPHER_provider(cipher
) == NULL
)
5899 * The cipher was explicitly fetched and therefore it is safe to cast
5902 return EVP_CIPHER_up_ref((EVP_CIPHER
*)cipher
);
5905 void ssl_evp_cipher_free(const EVP_CIPHER
*cipher
)
5910 if (EVP_CIPHER_provider(cipher
) != NULL
) {
5912 * The cipher was explicitly fetched and therefore it is safe to cast
5915 EVP_CIPHER_free((EVP_CIPHER
*)cipher
);
5919 const EVP_MD
*ssl_evp_md_fetch(OPENSSL_CTX
*libctx
,
5921 const char *properties
)
5925 #ifndef OPENSSL_NO_ENGINE
5929 * If there is an Engine available for this digest we use the "implicit"
5930 * form to ensure we use that engine later.
5932 eng
= ENGINE_get_digest_engine(nid
);
5935 return EVP_get_digestbynid(nid
);
5939 /* Otherwise we do an explicit fetch */
5941 md
= EVP_MD_fetch(libctx
, OBJ_nid2sn(nid
), properties
);
5946 int ssl_evp_md_up_ref(const EVP_MD
*md
)
5948 /* Don't up-ref an implicit EVP_MD */
5949 if (EVP_MD_provider(md
) == NULL
)
5953 * The digest was explicitly fetched and therefore it is safe to cast
5956 return EVP_MD_up_ref((EVP_MD
*)md
);
5959 void ssl_evp_md_free(const EVP_MD
*md
)
5964 if (EVP_MD_provider(md
) != NULL
) {
5966 * The digest was explicitly fetched and therefore it is safe to cast
5969 EVP_MD_free((EVP_MD
*)md
);