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/ocsp.h>
19 #include <openssl/dh.h>
20 #include <openssl/engine.h>
21 #include <openssl/async.h>
22 #include <openssl/ct.h>
23 #include <openssl/trace.h>
24 #include "internal/cryptlib.h"
25 #include "internal/refcount.h"
26 #include "internal/ktls.h"
28 static int ssl_undefined_function_1(SSL
*ssl
, SSL3_RECORD
*r
, size_t s
, int t
,
29 SSL_MAC_BUF
*mac
, size_t macsize
)
31 return ssl_undefined_function(ssl
);
34 static int ssl_undefined_function_2(SSL
*ssl
, SSL3_RECORD
*r
, unsigned char *s
,
37 return ssl_undefined_function(ssl
);
40 static int ssl_undefined_function_3(SSL
*ssl
, unsigned char *r
,
41 unsigned char *s
, size_t t
, size_t *u
)
43 return ssl_undefined_function(ssl
);
46 static int ssl_undefined_function_4(SSL
*ssl
, int r
)
48 return ssl_undefined_function(ssl
);
51 static size_t ssl_undefined_function_5(SSL
*ssl
, const char *r
, size_t s
,
54 return ssl_undefined_function(ssl
);
57 static int ssl_undefined_function_6(int r
)
59 return ssl_undefined_function(NULL
);
62 static int ssl_undefined_function_7(SSL
*ssl
, unsigned char *r
, size_t s
,
63 const char *t
, size_t u
,
64 const unsigned char *v
, size_t w
, int x
)
66 return ssl_undefined_function(ssl
);
69 SSL3_ENC_METHOD ssl3_undef_enc_method
= {
70 ssl_undefined_function_1
,
71 ssl_undefined_function_2
,
72 ssl_undefined_function
,
73 ssl_undefined_function_3
,
74 ssl_undefined_function_4
,
75 ssl_undefined_function_5
,
76 NULL
, /* client_finished_label */
77 0, /* client_finished_label_len */
78 NULL
, /* server_finished_label */
79 0, /* server_finished_label_len */
80 ssl_undefined_function_6
,
81 ssl_undefined_function_7
,
84 struct ssl_async_args
{
88 enum { READFUNC
, WRITEFUNC
, OTHERFUNC
} type
;
90 int (*func_read
) (SSL
*, void *, size_t, size_t *);
91 int (*func_write
) (SSL
*, const void *, size_t, size_t *);
92 int (*func_other
) (SSL
*);
102 DANETLS_MATCHING_FULL
, 0, NID_undef
105 DANETLS_MATCHING_2256
, 1, NID_sha256
108 DANETLS_MATCHING_2512
, 2, NID_sha512
112 static int dane_ctx_enable(struct dane_ctx_st
*dctx
)
114 const EVP_MD
**mdevp
;
116 uint8_t mdmax
= DANETLS_MATCHING_LAST
;
117 int n
= ((int)mdmax
) + 1; /* int to handle PrivMatch(255) */
120 if (dctx
->mdevp
!= NULL
)
123 mdevp
= OPENSSL_zalloc(n
* sizeof(*mdevp
));
124 mdord
= OPENSSL_zalloc(n
* sizeof(*mdord
));
126 if (mdord
== NULL
|| mdevp
== NULL
) {
129 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
133 /* Install default entries */
134 for (i
= 0; i
< OSSL_NELEM(dane_mds
); ++i
) {
137 if (dane_mds
[i
].nid
== NID_undef
||
138 (md
= EVP_get_digestbynid(dane_mds
[i
].nid
)) == NULL
)
140 mdevp
[dane_mds
[i
].mtype
] = md
;
141 mdord
[dane_mds
[i
].mtype
] = dane_mds
[i
].ord
;
151 static void dane_ctx_final(struct dane_ctx_st
*dctx
)
153 OPENSSL_free(dctx
->mdevp
);
156 OPENSSL_free(dctx
->mdord
);
161 static void tlsa_free(danetls_record
*t
)
165 OPENSSL_free(t
->data
);
166 EVP_PKEY_free(t
->spki
);
170 static void dane_final(SSL_DANE
*dane
)
172 sk_danetls_record_pop_free(dane
->trecs
, tlsa_free
);
175 sk_X509_pop_free(dane
->certs
, X509_free
);
178 X509_free(dane
->mcert
);
186 * dane_copy - Copy dane configuration, sans verification state.
188 static int ssl_dane_dup(SSL
*to
, SSL
*from
)
193 if (!DANETLS_ENABLED(&from
->dane
))
196 num
= sk_danetls_record_num(from
->dane
.trecs
);
197 dane_final(&to
->dane
);
198 to
->dane
.flags
= from
->dane
.flags
;
199 to
->dane
.dctx
= &to
->ctx
->dane
;
200 to
->dane
.trecs
= sk_danetls_record_new_reserve(NULL
, num
);
202 if (to
->dane
.trecs
== NULL
) {
203 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
207 for (i
= 0; i
< num
; ++i
) {
208 danetls_record
*t
= sk_danetls_record_value(from
->dane
.trecs
, i
);
210 if (SSL_dane_tlsa_add(to
, t
->usage
, t
->selector
, t
->mtype
,
211 t
->data
, t
->dlen
) <= 0)
217 static int dane_mtype_set(struct dane_ctx_st
*dctx
,
218 const EVP_MD
*md
, uint8_t mtype
, uint8_t ord
)
222 if (mtype
== DANETLS_MATCHING_FULL
&& md
!= NULL
) {
223 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL
);
227 if (mtype
> dctx
->mdmax
) {
228 const EVP_MD
**mdevp
;
230 int n
= ((int)mtype
) + 1;
232 mdevp
= OPENSSL_realloc(dctx
->mdevp
, n
* sizeof(*mdevp
));
234 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
239 mdord
= OPENSSL_realloc(dctx
->mdord
, n
* sizeof(*mdord
));
241 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
246 /* Zero-fill any gaps */
247 for (i
= dctx
->mdmax
+ 1; i
< mtype
; ++i
) {
255 dctx
->mdevp
[mtype
] = md
;
256 /* Coerce ordinal of disabled matching types to 0 */
257 dctx
->mdord
[mtype
] = (md
== NULL
) ? 0 : ord
;
262 static const EVP_MD
*tlsa_md_get(SSL_DANE
*dane
, uint8_t mtype
)
264 if (mtype
> dane
->dctx
->mdmax
)
266 return dane
->dctx
->mdevp
[mtype
];
269 static int dane_tlsa_add(SSL_DANE
*dane
,
272 uint8_t mtype
, const unsigned char *data
, size_t dlen
)
275 const EVP_MD
*md
= NULL
;
276 int ilen
= (int)dlen
;
280 if (dane
->trecs
== NULL
) {
281 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_NOT_ENABLED
);
285 if (ilen
< 0 || dlen
!= (size_t)ilen
) {
286 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_TLSA_BAD_DATA_LENGTH
);
290 if (usage
> DANETLS_USAGE_LAST
) {
291 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE
);
295 if (selector
> DANETLS_SELECTOR_LAST
) {
296 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_TLSA_BAD_SELECTOR
);
300 if (mtype
!= DANETLS_MATCHING_FULL
) {
301 md
= tlsa_md_get(dane
, mtype
);
303 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE
);
308 if (md
!= NULL
&& dlen
!= (size_t)EVP_MD_size(md
)) {
309 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH
);
313 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_TLSA_NULL_DATA
);
317 if ((t
= OPENSSL_zalloc(sizeof(*t
))) == NULL
) {
318 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
323 t
->selector
= selector
;
325 t
->data
= OPENSSL_malloc(dlen
);
326 if (t
->data
== NULL
) {
328 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
331 memcpy(t
->data
, data
, dlen
);
334 /* Validate and cache full certificate or public key */
335 if (mtype
== DANETLS_MATCHING_FULL
) {
336 const unsigned char *p
= data
;
338 EVP_PKEY
*pkey
= NULL
;
341 case DANETLS_SELECTOR_CERT
:
342 if (!d2i_X509(&cert
, &p
, ilen
) || p
< data
||
343 dlen
!= (size_t)(p
- data
)) {
345 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_TLSA_BAD_CERTIFICATE
);
348 if (X509_get0_pubkey(cert
) == NULL
) {
350 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_TLSA_BAD_CERTIFICATE
);
354 if ((DANETLS_USAGE_BIT(usage
) & DANETLS_TA_MASK
) == 0) {
360 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
361 * records that contain full certificates of trust-anchors that are
362 * not present in the wire chain. For usage PKIX-TA(0), we augment
363 * the chain with untrusted Full(0) certificates from DNS, in case
364 * they are missing from the chain.
366 if ((dane
->certs
== NULL
&&
367 (dane
->certs
= sk_X509_new_null()) == NULL
) ||
368 !sk_X509_push(dane
->certs
, cert
)) {
369 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
376 case DANETLS_SELECTOR_SPKI
:
377 if (!d2i_PUBKEY(&pkey
, &p
, ilen
) || p
< data
||
378 dlen
!= (size_t)(p
- data
)) {
380 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY
);
385 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
386 * records that contain full bare keys of trust-anchors that are
387 * not present in the wire chain.
389 if (usage
== DANETLS_USAGE_DANE_TA
)
398 * Find the right insertion point for the new record.
400 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
401 * they can be processed first, as they require no chain building, and no
402 * expiration or hostname checks. Because DANE-EE(3) is numerically
403 * largest, this is accomplished via descending sort by "usage".
405 * We also sort in descending order by matching ordinal to simplify
406 * the implementation of digest agility in the verification code.
408 * The choice of order for the selector is not significant, so we
409 * use the same descending order for consistency.
411 num
= sk_danetls_record_num(dane
->trecs
);
412 for (i
= 0; i
< num
; ++i
) {
413 danetls_record
*rec
= sk_danetls_record_value(dane
->trecs
, i
);
415 if (rec
->usage
> usage
)
417 if (rec
->usage
< usage
)
419 if (rec
->selector
> selector
)
421 if (rec
->selector
< selector
)
423 if (dane
->dctx
->mdord
[rec
->mtype
] > dane
->dctx
->mdord
[mtype
])
428 if (!sk_danetls_record_insert(dane
->trecs
, t
, i
)) {
430 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
433 dane
->umask
|= DANETLS_USAGE_BIT(usage
);
439 * Return 0 if there is only one version configured and it was disabled
440 * at configure time. Return 1 otherwise.
442 static int ssl_check_allowed_versions(int min_version
, int max_version
)
444 int minisdtls
= 0, maxisdtls
= 0;
446 /* Figure out if we're doing DTLS versions or TLS versions */
447 if (min_version
== DTLS1_BAD_VER
448 || min_version
>> 8 == DTLS1_VERSION_MAJOR
)
450 if (max_version
== DTLS1_BAD_VER
451 || max_version
>> 8 == DTLS1_VERSION_MAJOR
)
453 /* A wildcard version of 0 could be DTLS or TLS. */
454 if ((minisdtls
&& !maxisdtls
&& max_version
!= 0)
455 || (maxisdtls
&& !minisdtls
&& min_version
!= 0)) {
456 /* Mixing DTLS and TLS versions will lead to sadness; deny it. */
460 if (minisdtls
|| maxisdtls
) {
461 /* Do DTLS version checks. */
462 if (min_version
== 0)
463 /* Ignore DTLS1_BAD_VER */
464 min_version
= DTLS1_VERSION
;
465 if (max_version
== 0)
466 max_version
= DTLS1_2_VERSION
;
467 #ifdef OPENSSL_NO_DTLS1_2
468 if (max_version
== DTLS1_2_VERSION
)
469 max_version
= DTLS1_VERSION
;
471 #ifdef OPENSSL_NO_DTLS1
472 if (min_version
== DTLS1_VERSION
)
473 min_version
= DTLS1_2_VERSION
;
475 /* Done massaging versions; do the check. */
477 #ifdef OPENSSL_NO_DTLS1
478 || (DTLS_VERSION_GE(min_version
, DTLS1_VERSION
)
479 && DTLS_VERSION_GE(DTLS1_VERSION
, max_version
))
481 #ifdef OPENSSL_NO_DTLS1_2
482 || (DTLS_VERSION_GE(min_version
, DTLS1_2_VERSION
)
483 && DTLS_VERSION_GE(DTLS1_2_VERSION
, max_version
))
488 /* Regular TLS version checks. */
489 if (min_version
== 0)
490 min_version
= SSL3_VERSION
;
491 if (max_version
== 0)
492 max_version
= TLS1_3_VERSION
;
493 #ifdef OPENSSL_NO_TLS1_3
494 if (max_version
== TLS1_3_VERSION
)
495 max_version
= TLS1_2_VERSION
;
497 #ifdef OPENSSL_NO_TLS1_2
498 if (max_version
== TLS1_2_VERSION
)
499 max_version
= TLS1_1_VERSION
;
501 #ifdef OPENSSL_NO_TLS1_1
502 if (max_version
== TLS1_1_VERSION
)
503 max_version
= TLS1_VERSION
;
505 #ifdef OPENSSL_NO_TLS1
506 if (max_version
== TLS1_VERSION
)
507 max_version
= SSL3_VERSION
;
509 #ifdef OPENSSL_NO_SSL3
510 if (min_version
== SSL3_VERSION
)
511 min_version
= TLS1_VERSION
;
513 #ifdef OPENSSL_NO_TLS1
514 if (min_version
== TLS1_VERSION
)
515 min_version
= TLS1_1_VERSION
;
517 #ifdef OPENSSL_NO_TLS1_1
518 if (min_version
== TLS1_1_VERSION
)
519 min_version
= TLS1_2_VERSION
;
521 #ifdef OPENSSL_NO_TLS1_2
522 if (min_version
== TLS1_2_VERSION
)
523 min_version
= TLS1_3_VERSION
;
525 /* Done massaging versions; do the check. */
527 #ifdef OPENSSL_NO_SSL3
528 || (min_version
<= SSL3_VERSION
&& SSL3_VERSION
<= max_version
)
530 #ifdef OPENSSL_NO_TLS1
531 || (min_version
<= TLS1_VERSION
&& TLS1_VERSION
<= max_version
)
533 #ifdef OPENSSL_NO_TLS1_1
534 || (min_version
<= TLS1_1_VERSION
&& TLS1_1_VERSION
<= max_version
)
536 #ifdef OPENSSL_NO_TLS1_2
537 || (min_version
<= TLS1_2_VERSION
&& TLS1_2_VERSION
<= max_version
)
539 #ifdef OPENSSL_NO_TLS1_3
540 || (min_version
<= TLS1_3_VERSION
&& TLS1_3_VERSION
<= max_version
)
548 #if defined(__TANDEM) && defined(OPENSSL_VPROC)
550 * Define a VPROC function for HP NonStop build ssl library.
551 * This is used by platform version identification tools.
552 * Do not inline this procedure or make it static.
554 # define OPENSSL_VPROC_STRING_(x) x##_SSL
555 # define OPENSSL_VPROC_STRING(x) OPENSSL_VPROC_STRING_(x)
556 # define OPENSSL_VPROC_FUNC OPENSSL_VPROC_STRING(OPENSSL_VPROC)
557 void OPENSSL_VPROC_FUNC(void) {}
561 static void clear_ciphers(SSL
*s
)
563 /* clear the current cipher */
564 ssl_clear_cipher_ctx(s
);
565 ssl_clear_hash_ctx(&s
->read_hash
);
566 ssl_clear_hash_ctx(&s
->write_hash
);
569 int SSL_clear(SSL
*s
)
571 if (s
->method
== NULL
) {
572 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_METHOD_SPECIFIED
);
576 if (ssl_clear_bad_session(s
)) {
577 SSL_SESSION_free(s
->session
);
580 SSL_SESSION_free(s
->psksession
);
581 s
->psksession
= NULL
;
582 OPENSSL_free(s
->psksession_id
);
583 s
->psksession_id
= NULL
;
584 s
->psksession_id_len
= 0;
585 s
->hello_retry_request
= 0;
592 if (s
->renegotiate
) {
593 ERR_raise(ERR_LIB_SSL
, ERR_R_INTERNAL_ERROR
);
597 ossl_statem_clear(s
);
599 s
->version
= s
->method
->version
;
600 s
->client_version
= s
->version
;
601 s
->rwstate
= SSL_NOTHING
;
603 BUF_MEM_free(s
->init_buf
);
608 s
->key_update
= SSL_KEY_UPDATE_NONE
;
610 EVP_MD_CTX_free(s
->pha_dgst
);
613 /* Reset DANE verification result state */
616 X509_free(s
->dane
.mcert
);
617 s
->dane
.mcert
= NULL
;
618 s
->dane
.mtlsa
= NULL
;
620 /* Clear the verification result peername */
621 X509_VERIFY_PARAM_move_peername(s
->param
, NULL
);
623 /* Clear any shared connection state */
624 OPENSSL_free(s
->shared_sigalgs
);
625 s
->shared_sigalgs
= NULL
;
626 s
->shared_sigalgslen
= 0;
629 * Check to see if we were changed into a different method, if so, revert
632 if (s
->method
!= s
->ctx
->method
) {
633 s
->method
->ssl_free(s
);
634 s
->method
= s
->ctx
->method
;
635 if (!s
->method
->ssl_new(s
))
638 if (!s
->method
->ssl_clear(s
))
642 RECORD_LAYER_clear(&s
->rlayer
);
647 #ifndef OPENSSL_NO_DEPRECATED_3_0
648 /** Used to change an SSL_CTXs default SSL method type */
649 int SSL_CTX_set_ssl_version(SSL_CTX
*ctx
, const SSL_METHOD
*meth
)
651 STACK_OF(SSL_CIPHER
) *sk
;
655 if (!SSL_CTX_set_ciphersuites(ctx
, OSSL_default_ciphersuites())) {
656 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS
);
659 sk
= ssl_create_cipher_list(ctx
,
660 ctx
->tls13_ciphersuites
,
662 &(ctx
->cipher_list_by_id
),
663 OSSL_default_cipher_list(), ctx
->cert
);
664 if ((sk
== NULL
) || (sk_SSL_CIPHER_num(sk
) <= 0)) {
665 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS
);
672 SSL
*SSL_new(SSL_CTX
*ctx
)
677 ERR_raise(ERR_LIB_SSL
, SSL_R_NULL_SSL_CTX
);
680 if (ctx
->method
== NULL
) {
681 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION
);
685 s
= OPENSSL_zalloc(sizeof(*s
));
690 s
->lock
= CRYPTO_THREAD_lock_new();
691 if (s
->lock
== NULL
) {
697 RECORD_LAYER_init(&s
->rlayer
, s
);
699 s
->options
= ctx
->options
;
700 s
->dane
.flags
= ctx
->dane
.flags
;
701 s
->min_proto_version
= ctx
->min_proto_version
;
702 s
->max_proto_version
= ctx
->max_proto_version
;
704 s
->max_cert_list
= ctx
->max_cert_list
;
705 s
->max_early_data
= ctx
->max_early_data
;
706 s
->recv_max_early_data
= ctx
->recv_max_early_data
;
707 s
->num_tickets
= ctx
->num_tickets
;
708 s
->pha_enabled
= ctx
->pha_enabled
;
710 /* Shallow copy of the ciphersuites stack */
711 s
->tls13_ciphersuites
= sk_SSL_CIPHER_dup(ctx
->tls13_ciphersuites
);
712 if (s
->tls13_ciphersuites
== NULL
)
716 * Earlier library versions used to copy the pointer to the CERT, not
717 * its contents; only when setting new parameters for the per-SSL
718 * copy, ssl_cert_new would be called (and the direct reference to
719 * the per-SSL_CTX settings would be lost, but those still were
720 * indirectly accessed for various purposes, and for that reason they
721 * used to be known as s->ctx->default_cert). Now we don't look at the
722 * SSL_CTX's CERT after having duplicated it once.
724 s
->cert
= ssl_cert_dup(ctx
->cert
);
728 RECORD_LAYER_set_read_ahead(&s
->rlayer
, ctx
->read_ahead
);
729 s
->msg_callback
= ctx
->msg_callback
;
730 s
->msg_callback_arg
= ctx
->msg_callback_arg
;
731 s
->verify_mode
= ctx
->verify_mode
;
732 s
->not_resumable_session_cb
= ctx
->not_resumable_session_cb
;
733 s
->record_padding_cb
= ctx
->record_padding_cb
;
734 s
->record_padding_arg
= ctx
->record_padding_arg
;
735 s
->block_padding
= ctx
->block_padding
;
736 s
->sid_ctx_length
= ctx
->sid_ctx_length
;
737 if (!ossl_assert(s
->sid_ctx_length
<= sizeof(s
->sid_ctx
)))
739 memcpy(&s
->sid_ctx
, &ctx
->sid_ctx
, sizeof(s
->sid_ctx
));
740 s
->verify_callback
= ctx
->default_verify_callback
;
741 s
->generate_session_id
= ctx
->generate_session_id
;
743 s
->param
= X509_VERIFY_PARAM_new();
744 if (s
->param
== NULL
)
746 X509_VERIFY_PARAM_inherit(s
->param
, ctx
->param
);
747 s
->quiet_shutdown
= ctx
->quiet_shutdown
;
749 s
->ext
.max_fragment_len_mode
= ctx
->ext
.max_fragment_len_mode
;
750 s
->max_send_fragment
= ctx
->max_send_fragment
;
751 s
->split_send_fragment
= ctx
->split_send_fragment
;
752 s
->max_pipelines
= ctx
->max_pipelines
;
753 if (s
->max_pipelines
> 1)
754 RECORD_LAYER_set_read_ahead(&s
->rlayer
, 1);
755 if (ctx
->default_read_buf_len
> 0)
756 SSL_set_default_read_buffer_len(s
, ctx
->default_read_buf_len
);
761 s
->ext
.debug_arg
= NULL
;
762 s
->ext
.ticket_expected
= 0;
763 s
->ext
.status_type
= ctx
->ext
.status_type
;
764 s
->ext
.status_expected
= 0;
765 s
->ext
.ocsp
.ids
= NULL
;
766 s
->ext
.ocsp
.exts
= NULL
;
767 s
->ext
.ocsp
.resp
= NULL
;
768 s
->ext
.ocsp
.resp_len
= 0;
770 s
->session_ctx
= ctx
;
771 #ifndef OPENSSL_NO_EC
772 if (ctx
->ext
.ecpointformats
) {
773 s
->ext
.ecpointformats
=
774 OPENSSL_memdup(ctx
->ext
.ecpointformats
,
775 ctx
->ext
.ecpointformats_len
);
776 if (!s
->ext
.ecpointformats
)
778 s
->ext
.ecpointformats_len
=
779 ctx
->ext
.ecpointformats_len
;
782 if (ctx
->ext
.supportedgroups
) {
783 s
->ext
.supportedgroups
=
784 OPENSSL_memdup(ctx
->ext
.supportedgroups
,
785 ctx
->ext
.supportedgroups_len
786 * sizeof(*ctx
->ext
.supportedgroups
));
787 if (!s
->ext
.supportedgroups
)
789 s
->ext
.supportedgroups_len
= ctx
->ext
.supportedgroups_len
;
792 #ifndef OPENSSL_NO_NEXTPROTONEG
796 if (s
->ctx
->ext
.alpn
) {
797 s
->ext
.alpn
= OPENSSL_malloc(s
->ctx
->ext
.alpn_len
);
798 if (s
->ext
.alpn
== NULL
)
800 memcpy(s
->ext
.alpn
, s
->ctx
->ext
.alpn
, s
->ctx
->ext
.alpn_len
);
801 s
->ext
.alpn_len
= s
->ctx
->ext
.alpn_len
;
804 s
->verified_chain
= NULL
;
805 s
->verify_result
= X509_V_OK
;
807 s
->default_passwd_callback
= ctx
->default_passwd_callback
;
808 s
->default_passwd_callback_userdata
= ctx
->default_passwd_callback_userdata
;
810 s
->method
= ctx
->method
;
812 s
->key_update
= SSL_KEY_UPDATE_NONE
;
814 s
->allow_early_data_cb
= ctx
->allow_early_data_cb
;
815 s
->allow_early_data_cb_data
= ctx
->allow_early_data_cb_data
;
817 if (!s
->method
->ssl_new(s
))
820 s
->server
= (ctx
->method
->ssl_accept
== ssl_undefined_function
) ? 0 : 1;
825 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL
, s
, &s
->ex_data
))
828 #ifndef OPENSSL_NO_PSK
829 s
->psk_client_callback
= ctx
->psk_client_callback
;
830 s
->psk_server_callback
= ctx
->psk_server_callback
;
832 s
->psk_find_session_cb
= ctx
->psk_find_session_cb
;
833 s
->psk_use_session_cb
= ctx
->psk_use_session_cb
;
835 s
->async_cb
= ctx
->async_cb
;
836 s
->async_cb_arg
= ctx
->async_cb_arg
;
840 #ifndef OPENSSL_NO_CT
841 if (!SSL_set_ct_validation_callback(s
, ctx
->ct_validation_callback
,
842 ctx
->ct_validation_callback_arg
))
849 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
853 int SSL_is_dtls(const SSL
*s
)
855 return SSL_IS_DTLS(s
) ? 1 : 0;
858 int SSL_up_ref(SSL
*s
)
862 if (CRYPTO_UP_REF(&s
->references
, &i
, s
->lock
) <= 0)
865 REF_PRINT_COUNT("SSL", s
);
866 REF_ASSERT_ISNT(i
< 2);
867 return ((i
> 1) ? 1 : 0);
870 int SSL_CTX_set_session_id_context(SSL_CTX
*ctx
, const unsigned char *sid_ctx
,
871 unsigned int sid_ctx_len
)
873 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
874 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
877 ctx
->sid_ctx_length
= sid_ctx_len
;
878 memcpy(ctx
->sid_ctx
, sid_ctx
, sid_ctx_len
);
883 int SSL_set_session_id_context(SSL
*ssl
, const unsigned char *sid_ctx
,
884 unsigned int sid_ctx_len
)
886 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
887 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
890 ssl
->sid_ctx_length
= sid_ctx_len
;
891 memcpy(ssl
->sid_ctx
, sid_ctx
, sid_ctx_len
);
896 int SSL_CTX_set_generate_session_id(SSL_CTX
*ctx
, GEN_SESSION_CB cb
)
898 CRYPTO_THREAD_write_lock(ctx
->lock
);
899 ctx
->generate_session_id
= cb
;
900 CRYPTO_THREAD_unlock(ctx
->lock
);
904 int SSL_set_generate_session_id(SSL
*ssl
, GEN_SESSION_CB cb
)
906 CRYPTO_THREAD_write_lock(ssl
->lock
);
907 ssl
->generate_session_id
= cb
;
908 CRYPTO_THREAD_unlock(ssl
->lock
);
912 int SSL_has_matching_session_id(const SSL
*ssl
, const unsigned char *id
,
916 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
917 * we can "construct" a session to give us the desired check - i.e. to
918 * find if there's a session in the hash table that would conflict with
919 * any new session built out of this id/id_len and the ssl_version in use
924 if (id_len
> sizeof(r
.session_id
))
927 r
.ssl_version
= ssl
->version
;
928 r
.session_id_length
= id_len
;
929 memcpy(r
.session_id
, id
, id_len
);
931 CRYPTO_THREAD_read_lock(ssl
->session_ctx
->lock
);
932 p
= lh_SSL_SESSION_retrieve(ssl
->session_ctx
->sessions
, &r
);
933 CRYPTO_THREAD_unlock(ssl
->session_ctx
->lock
);
937 int SSL_CTX_set_purpose(SSL_CTX
*s
, int purpose
)
939 return X509_VERIFY_PARAM_set_purpose(s
->param
, purpose
);
942 int SSL_set_purpose(SSL
*s
, int purpose
)
944 return X509_VERIFY_PARAM_set_purpose(s
->param
, purpose
);
947 int SSL_CTX_set_trust(SSL_CTX
*s
, int trust
)
949 return X509_VERIFY_PARAM_set_trust(s
->param
, trust
);
952 int SSL_set_trust(SSL
*s
, int trust
)
954 return X509_VERIFY_PARAM_set_trust(s
->param
, trust
);
957 int SSL_set1_host(SSL
*s
, const char *hostname
)
959 /* If a hostname is provided and parses as an IP address,
960 * treat it as such. */
961 if (hostname
&& X509_VERIFY_PARAM_set1_ip_asc(s
->param
, hostname
) == 1)
964 return X509_VERIFY_PARAM_set1_host(s
->param
, hostname
, 0);
967 int SSL_add1_host(SSL
*s
, const char *hostname
)
969 /* If a hostname is provided and parses as an IP address,
970 * treat it as such. */
973 ASN1_OCTET_STRING
*ip
;
976 ip
= a2i_IPADDRESS(hostname
);
978 /* We didn't want it; only to check if it *is* an IP address */
979 ASN1_OCTET_STRING_free(ip
);
981 old_ip
= X509_VERIFY_PARAM_get1_ip_asc(s
->param
);
984 OPENSSL_free(old_ip
);
985 /* There can be only one IP address */
989 return X509_VERIFY_PARAM_set1_ip_asc(s
->param
, hostname
);
993 return X509_VERIFY_PARAM_add1_host(s
->param
, hostname
, 0);
996 void SSL_set_hostflags(SSL
*s
, unsigned int flags
)
998 X509_VERIFY_PARAM_set_hostflags(s
->param
, flags
);
1001 const char *SSL_get0_peername(SSL
*s
)
1003 return X509_VERIFY_PARAM_get0_peername(s
->param
);
1006 int SSL_CTX_dane_enable(SSL_CTX
*ctx
)
1008 return dane_ctx_enable(&ctx
->dane
);
1011 unsigned long SSL_CTX_dane_set_flags(SSL_CTX
*ctx
, unsigned long flags
)
1013 unsigned long orig
= ctx
->dane
.flags
;
1015 ctx
->dane
.flags
|= flags
;
1019 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX
*ctx
, unsigned long flags
)
1021 unsigned long orig
= ctx
->dane
.flags
;
1023 ctx
->dane
.flags
&= ~flags
;
1027 int SSL_dane_enable(SSL
*s
, const char *basedomain
)
1029 SSL_DANE
*dane
= &s
->dane
;
1031 if (s
->ctx
->dane
.mdmax
== 0) {
1032 ERR_raise(ERR_LIB_SSL
, SSL_R_CONTEXT_NOT_DANE_ENABLED
);
1035 if (dane
->trecs
!= NULL
) {
1036 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_ALREADY_ENABLED
);
1041 * Default SNI name. This rejects empty names, while set1_host below
1042 * accepts them and disables host name checks. To avoid side-effects with
1043 * invalid input, set the SNI name first.
1045 if (s
->ext
.hostname
== NULL
) {
1046 if (!SSL_set_tlsext_host_name(s
, basedomain
)) {
1047 ERR_raise(ERR_LIB_SSL
, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN
);
1052 /* Primary RFC6125 reference identifier */
1053 if (!X509_VERIFY_PARAM_set1_host(s
->param
, basedomain
, 0)) {
1054 ERR_raise(ERR_LIB_SSL
, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN
);
1060 dane
->dctx
= &s
->ctx
->dane
;
1061 dane
->trecs
= sk_danetls_record_new_null();
1063 if (dane
->trecs
== NULL
) {
1064 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
1070 unsigned long SSL_dane_set_flags(SSL
*ssl
, unsigned long flags
)
1072 unsigned long orig
= ssl
->dane
.flags
;
1074 ssl
->dane
.flags
|= flags
;
1078 unsigned long SSL_dane_clear_flags(SSL
*ssl
, unsigned long flags
)
1080 unsigned long orig
= ssl
->dane
.flags
;
1082 ssl
->dane
.flags
&= ~flags
;
1086 int SSL_get0_dane_authority(SSL
*s
, X509
**mcert
, EVP_PKEY
**mspki
)
1088 SSL_DANE
*dane
= &s
->dane
;
1090 if (!DANETLS_ENABLED(dane
) || s
->verify_result
!= X509_V_OK
)
1094 *mcert
= dane
->mcert
;
1096 *mspki
= (dane
->mcert
== NULL
) ? dane
->mtlsa
->spki
: NULL
;
1101 int SSL_get0_dane_tlsa(SSL
*s
, uint8_t *usage
, uint8_t *selector
,
1102 uint8_t *mtype
, const unsigned char **data
, size_t *dlen
)
1104 SSL_DANE
*dane
= &s
->dane
;
1106 if (!DANETLS_ENABLED(dane
) || s
->verify_result
!= X509_V_OK
)
1110 *usage
= dane
->mtlsa
->usage
;
1112 *selector
= dane
->mtlsa
->selector
;
1114 *mtype
= dane
->mtlsa
->mtype
;
1116 *data
= dane
->mtlsa
->data
;
1118 *dlen
= dane
->mtlsa
->dlen
;
1123 SSL_DANE
*SSL_get0_dane(SSL
*s
)
1128 int SSL_dane_tlsa_add(SSL
*s
, uint8_t usage
, uint8_t selector
,
1129 uint8_t mtype
, const unsigned char *data
, size_t dlen
)
1131 return dane_tlsa_add(&s
->dane
, usage
, selector
, mtype
, data
, dlen
);
1134 int SSL_CTX_dane_mtype_set(SSL_CTX
*ctx
, const EVP_MD
*md
, uint8_t mtype
,
1137 return dane_mtype_set(&ctx
->dane
, md
, mtype
, ord
);
1140 int SSL_CTX_set1_param(SSL_CTX
*ctx
, X509_VERIFY_PARAM
*vpm
)
1142 return X509_VERIFY_PARAM_set1(ctx
->param
, vpm
);
1145 int SSL_set1_param(SSL
*ssl
, X509_VERIFY_PARAM
*vpm
)
1147 return X509_VERIFY_PARAM_set1(ssl
->param
, vpm
);
1150 X509_VERIFY_PARAM
*SSL_CTX_get0_param(SSL_CTX
*ctx
)
1155 X509_VERIFY_PARAM
*SSL_get0_param(SSL
*ssl
)
1160 void SSL_certs_clear(SSL
*s
)
1162 ssl_cert_clear_certs(s
->cert
);
1165 void SSL_free(SSL
*s
)
1171 CRYPTO_DOWN_REF(&s
->references
, &i
, s
->lock
);
1172 REF_PRINT_COUNT("SSL", s
);
1175 REF_ASSERT_ISNT(i
< 0);
1177 X509_VERIFY_PARAM_free(s
->param
);
1178 dane_final(&s
->dane
);
1179 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL
, s
, &s
->ex_data
);
1181 RECORD_LAYER_release(&s
->rlayer
);
1183 /* Ignore return value */
1184 ssl_free_wbio_buffer(s
);
1186 BIO_free_all(s
->wbio
);
1188 BIO_free_all(s
->rbio
);
1191 BUF_MEM_free(s
->init_buf
);
1193 /* add extra stuff */
1194 sk_SSL_CIPHER_free(s
->cipher_list
);
1195 sk_SSL_CIPHER_free(s
->cipher_list_by_id
);
1196 sk_SSL_CIPHER_free(s
->tls13_ciphersuites
);
1197 sk_SSL_CIPHER_free(s
->peer_ciphers
);
1199 /* Make the next call work :-) */
1200 if (s
->session
!= NULL
) {
1201 ssl_clear_bad_session(s
);
1202 SSL_SESSION_free(s
->session
);
1204 SSL_SESSION_free(s
->psksession
);
1205 OPENSSL_free(s
->psksession_id
);
1209 ssl_cert_free(s
->cert
);
1210 OPENSSL_free(s
->shared_sigalgs
);
1211 /* Free up if allocated */
1213 OPENSSL_free(s
->ext
.hostname
);
1214 SSL_CTX_free(s
->session_ctx
);
1215 #ifndef OPENSSL_NO_EC
1216 OPENSSL_free(s
->ext
.ecpointformats
);
1217 OPENSSL_free(s
->ext
.peer_ecpointformats
);
1218 #endif /* OPENSSL_NO_EC */
1219 OPENSSL_free(s
->ext
.supportedgroups
);
1220 OPENSSL_free(s
->ext
.peer_supportedgroups
);
1221 sk_X509_EXTENSION_pop_free(s
->ext
.ocsp
.exts
, X509_EXTENSION_free
);
1222 #ifndef OPENSSL_NO_OCSP
1223 sk_OCSP_RESPID_pop_free(s
->ext
.ocsp
.ids
, OCSP_RESPID_free
);
1225 #ifndef OPENSSL_NO_CT
1226 SCT_LIST_free(s
->scts
);
1227 OPENSSL_free(s
->ext
.scts
);
1229 OPENSSL_free(s
->ext
.ocsp
.resp
);
1230 OPENSSL_free(s
->ext
.alpn
);
1231 OPENSSL_free(s
->ext
.tls13_cookie
);
1232 if (s
->clienthello
!= NULL
)
1233 OPENSSL_free(s
->clienthello
->pre_proc_exts
);
1234 OPENSSL_free(s
->clienthello
);
1235 OPENSSL_free(s
->pha_context
);
1236 EVP_MD_CTX_free(s
->pha_dgst
);
1238 sk_X509_NAME_pop_free(s
->ca_names
, X509_NAME_free
);
1239 sk_X509_NAME_pop_free(s
->client_ca_names
, X509_NAME_free
);
1241 sk_X509_pop_free(s
->verified_chain
, X509_free
);
1243 if (s
->method
!= NULL
)
1244 s
->method
->ssl_free(s
);
1246 SSL_CTX_free(s
->ctx
);
1248 ASYNC_WAIT_CTX_free(s
->waitctx
);
1250 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1251 OPENSSL_free(s
->ext
.npn
);
1254 #ifndef OPENSSL_NO_SRTP
1255 sk_SRTP_PROTECTION_PROFILE_free(s
->srtp_profiles
);
1258 CRYPTO_THREAD_lock_free(s
->lock
);
1263 void SSL_set0_rbio(SSL
*s
, BIO
*rbio
)
1265 BIO_free_all(s
->rbio
);
1269 void SSL_set0_wbio(SSL
*s
, BIO
*wbio
)
1272 * If the output buffering BIO is still in place, remove it
1274 if (s
->bbio
!= NULL
)
1275 s
->wbio
= BIO_pop(s
->wbio
);
1277 BIO_free_all(s
->wbio
);
1280 /* Re-attach |bbio| to the new |wbio|. */
1281 if (s
->bbio
!= NULL
)
1282 s
->wbio
= BIO_push(s
->bbio
, s
->wbio
);
1285 void SSL_set_bio(SSL
*s
, BIO
*rbio
, BIO
*wbio
)
1288 * For historical reasons, this function has many different cases in
1289 * ownership handling.
1292 /* If nothing has changed, do nothing */
1293 if (rbio
== SSL_get_rbio(s
) && wbio
== SSL_get_wbio(s
))
1297 * If the two arguments are equal then one fewer reference is granted by the
1298 * caller than we want to take
1300 if (rbio
!= NULL
&& rbio
== wbio
)
1304 * If only the wbio is changed only adopt one reference.
1306 if (rbio
== SSL_get_rbio(s
)) {
1307 SSL_set0_wbio(s
, wbio
);
1311 * There is an asymmetry here for historical reasons. If only the rbio is
1312 * changed AND the rbio and wbio were originally different, then we only
1313 * adopt one reference.
1315 if (wbio
== SSL_get_wbio(s
) && SSL_get_rbio(s
) != SSL_get_wbio(s
)) {
1316 SSL_set0_rbio(s
, rbio
);
1320 /* Otherwise, adopt both references. */
1321 SSL_set0_rbio(s
, rbio
);
1322 SSL_set0_wbio(s
, wbio
);
1325 BIO
*SSL_get_rbio(const SSL
*s
)
1330 BIO
*SSL_get_wbio(const SSL
*s
)
1332 if (s
->bbio
!= NULL
) {
1334 * If |bbio| is active, the true caller-configured BIO is its
1337 return BIO_next(s
->bbio
);
1342 int SSL_get_fd(const SSL
*s
)
1344 return SSL_get_rfd(s
);
1347 int SSL_get_rfd(const SSL
*s
)
1352 b
= SSL_get_rbio(s
);
1353 r
= BIO_find_type(b
, BIO_TYPE_DESCRIPTOR
);
1355 BIO_get_fd(r
, &ret
);
1359 int SSL_get_wfd(const SSL
*s
)
1364 b
= SSL_get_wbio(s
);
1365 r
= BIO_find_type(b
, BIO_TYPE_DESCRIPTOR
);
1367 BIO_get_fd(r
, &ret
);
1371 #ifndef OPENSSL_NO_SOCK
1372 int SSL_set_fd(SSL
*s
, int fd
)
1377 bio
= BIO_new(BIO_s_socket());
1380 ERR_raise(ERR_LIB_SSL
, ERR_R_BUF_LIB
);
1383 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1384 SSL_set_bio(s
, bio
, bio
);
1385 #ifndef OPENSSL_NO_KTLS
1387 * The new socket is created successfully regardless of ktls_enable.
1388 * ktls_enable doesn't change any functionality of the socket, except
1389 * changing the setsockopt to enable the processing of ktls_start.
1390 * Thus, it is not a problem to call it for non-TLS sockets.
1393 #endif /* OPENSSL_NO_KTLS */
1399 int SSL_set_wfd(SSL
*s
, int fd
)
1401 BIO
*rbio
= SSL_get_rbio(s
);
1403 if (rbio
== NULL
|| BIO_method_type(rbio
) != BIO_TYPE_SOCKET
1404 || (int)BIO_get_fd(rbio
, NULL
) != fd
) {
1405 BIO
*bio
= BIO_new(BIO_s_socket());
1408 ERR_raise(ERR_LIB_SSL
, ERR_R_BUF_LIB
);
1411 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1412 SSL_set0_wbio(s
, bio
);
1413 #ifndef OPENSSL_NO_KTLS
1415 * The new socket is created successfully regardless of ktls_enable.
1416 * ktls_enable doesn't change any functionality of the socket, except
1417 * changing the setsockopt to enable the processing of ktls_start.
1418 * Thus, it is not a problem to call it for non-TLS sockets.
1421 #endif /* OPENSSL_NO_KTLS */
1424 SSL_set0_wbio(s
, rbio
);
1429 int SSL_set_rfd(SSL
*s
, int fd
)
1431 BIO
*wbio
= SSL_get_wbio(s
);
1433 if (wbio
== NULL
|| BIO_method_type(wbio
) != BIO_TYPE_SOCKET
1434 || ((int)BIO_get_fd(wbio
, NULL
) != fd
)) {
1435 BIO
*bio
= BIO_new(BIO_s_socket());
1438 ERR_raise(ERR_LIB_SSL
, ERR_R_BUF_LIB
);
1441 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1442 SSL_set0_rbio(s
, bio
);
1445 SSL_set0_rbio(s
, wbio
);
1452 /* return length of latest Finished message we sent, copy to 'buf' */
1453 size_t SSL_get_finished(const SSL
*s
, void *buf
, size_t count
)
1457 ret
= s
->s3
.tmp
.finish_md_len
;
1460 memcpy(buf
, s
->s3
.tmp
.finish_md
, count
);
1464 /* return length of latest Finished message we expected, copy to 'buf' */
1465 size_t SSL_get_peer_finished(const SSL
*s
, void *buf
, size_t count
)
1469 ret
= s
->s3
.tmp
.peer_finish_md_len
;
1472 memcpy(buf
, s
->s3
.tmp
.peer_finish_md
, count
);
1476 int SSL_get_verify_mode(const SSL
*s
)
1478 return s
->verify_mode
;
1481 int SSL_get_verify_depth(const SSL
*s
)
1483 return X509_VERIFY_PARAM_get_depth(s
->param
);
1486 int (*SSL_get_verify_callback(const SSL
*s
)) (int, X509_STORE_CTX
*) {
1487 return s
->verify_callback
;
1490 int SSL_CTX_get_verify_mode(const SSL_CTX
*ctx
)
1492 return ctx
->verify_mode
;
1495 int SSL_CTX_get_verify_depth(const SSL_CTX
*ctx
)
1497 return X509_VERIFY_PARAM_get_depth(ctx
->param
);
1500 int (*SSL_CTX_get_verify_callback(const SSL_CTX
*ctx
)) (int, X509_STORE_CTX
*) {
1501 return ctx
->default_verify_callback
;
1504 void SSL_set_verify(SSL
*s
, int mode
,
1505 int (*callback
) (int ok
, X509_STORE_CTX
*ctx
))
1507 s
->verify_mode
= mode
;
1508 if (callback
!= NULL
)
1509 s
->verify_callback
= callback
;
1512 void SSL_set_verify_depth(SSL
*s
, int depth
)
1514 X509_VERIFY_PARAM_set_depth(s
->param
, depth
);
1517 void SSL_set_read_ahead(SSL
*s
, int yes
)
1519 RECORD_LAYER_set_read_ahead(&s
->rlayer
, yes
);
1522 int SSL_get_read_ahead(const SSL
*s
)
1524 return RECORD_LAYER_get_read_ahead(&s
->rlayer
);
1527 int SSL_pending(const SSL
*s
)
1529 size_t pending
= s
->method
->ssl_pending(s
);
1532 * SSL_pending cannot work properly if read-ahead is enabled
1533 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1534 * impossible to fix since SSL_pending cannot report errors that may be
1535 * observed while scanning the new data. (Note that SSL_pending() is
1536 * often used as a boolean value, so we'd better not return -1.)
1538 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1539 * we just return INT_MAX.
1541 return pending
< INT_MAX
? (int)pending
: INT_MAX
;
1544 int SSL_has_pending(const SSL
*s
)
1547 * Similar to SSL_pending() but returns a 1 to indicate that we have
1548 * unprocessed data available or 0 otherwise (as opposed to the number of
1549 * bytes available). Unlike SSL_pending() this will take into account
1550 * read_ahead data. A 1 return simply indicates that we have unprocessed
1551 * data. That data may not result in any application data, or we may fail
1552 * to parse the records for some reason.
1554 if (RECORD_LAYER_processed_read_pending(&s
->rlayer
))
1557 return RECORD_LAYER_read_pending(&s
->rlayer
);
1560 X509
*SSL_get1_peer_certificate(const SSL
*s
)
1562 X509
*r
= SSL_get0_peer_certificate(s
);
1570 X509
*SSL_get0_peer_certificate(const SSL
*s
)
1572 if ((s
== NULL
) || (s
->session
== NULL
))
1575 return s
->session
->peer
;
1578 STACK_OF(X509
) *SSL_get_peer_cert_chain(const SSL
*s
)
1582 if ((s
== NULL
) || (s
->session
== NULL
))
1585 r
= s
->session
->peer_chain
;
1588 * If we are a client, cert_chain includes the peer's own certificate; if
1589 * we are a server, it does not.
1596 * Now in theory, since the calling process own 't' it should be safe to
1597 * modify. We need to be able to read f without being hassled
1599 int SSL_copy_session_id(SSL
*t
, const SSL
*f
)
1602 /* Do we need to to SSL locking? */
1603 if (!SSL_set_session(t
, SSL_get_session(f
))) {
1608 * what if we are setup for one protocol version but want to talk another
1610 if (t
->method
!= f
->method
) {
1611 t
->method
->ssl_free(t
);
1612 t
->method
= f
->method
;
1613 if (t
->method
->ssl_new(t
) == 0)
1617 CRYPTO_UP_REF(&f
->cert
->references
, &i
, f
->cert
->lock
);
1618 ssl_cert_free(t
->cert
);
1620 if (!SSL_set_session_id_context(t
, f
->sid_ctx
, (int)f
->sid_ctx_length
)) {
1627 /* Fix this so it checks all the valid key/cert options */
1628 int SSL_CTX_check_private_key(const SSL_CTX
*ctx
)
1630 if ((ctx
== NULL
) || (ctx
->cert
->key
->x509
== NULL
)) {
1631 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CERTIFICATE_ASSIGNED
);
1634 if (ctx
->cert
->key
->privatekey
== NULL
) {
1635 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_PRIVATE_KEY_ASSIGNED
);
1638 return X509_check_private_key
1639 (ctx
->cert
->key
->x509
, ctx
->cert
->key
->privatekey
);
1642 /* Fix this function so that it takes an optional type parameter */
1643 int SSL_check_private_key(const SSL
*ssl
)
1646 ERR_raise(ERR_LIB_SSL
, ERR_R_PASSED_NULL_PARAMETER
);
1649 if (ssl
->cert
->key
->x509
== NULL
) {
1650 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CERTIFICATE_ASSIGNED
);
1653 if (ssl
->cert
->key
->privatekey
== NULL
) {
1654 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_PRIVATE_KEY_ASSIGNED
);
1657 return X509_check_private_key(ssl
->cert
->key
->x509
,
1658 ssl
->cert
->key
->privatekey
);
1661 int SSL_waiting_for_async(SSL
*s
)
1669 int SSL_get_all_async_fds(SSL
*s
, OSSL_ASYNC_FD
*fds
, size_t *numfds
)
1671 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1675 return ASYNC_WAIT_CTX_get_all_fds(ctx
, fds
, numfds
);
1678 int SSL_get_changed_async_fds(SSL
*s
, OSSL_ASYNC_FD
*addfd
, size_t *numaddfds
,
1679 OSSL_ASYNC_FD
*delfd
, size_t *numdelfds
)
1681 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1685 return ASYNC_WAIT_CTX_get_changed_fds(ctx
, addfd
, numaddfds
, delfd
,
1689 int SSL_CTX_set_async_callback(SSL_CTX
*ctx
, SSL_async_callback_fn callback
)
1691 ctx
->async_cb
= callback
;
1695 int SSL_CTX_set_async_callback_arg(SSL_CTX
*ctx
, void *arg
)
1697 ctx
->async_cb_arg
= arg
;
1701 int SSL_set_async_callback(SSL
*s
, SSL_async_callback_fn callback
)
1703 s
->async_cb
= callback
;
1707 int SSL_set_async_callback_arg(SSL
*s
, void *arg
)
1709 s
->async_cb_arg
= arg
;
1713 int SSL_get_async_status(SSL
*s
, int *status
)
1715 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1719 *status
= ASYNC_WAIT_CTX_get_status(ctx
);
1723 int SSL_accept(SSL
*s
)
1725 if (s
->handshake_func
== NULL
) {
1726 /* Not properly initialized yet */
1727 SSL_set_accept_state(s
);
1730 return SSL_do_handshake(s
);
1733 int SSL_connect(SSL
*s
)
1735 if (s
->handshake_func
== NULL
) {
1736 /* Not properly initialized yet */
1737 SSL_set_connect_state(s
);
1740 return SSL_do_handshake(s
);
1743 long SSL_get_default_timeout(const SSL
*s
)
1745 return s
->method
->get_timeout();
1748 static int ssl_async_wait_ctx_cb(void *arg
)
1750 SSL
*s
= (SSL
*)arg
;
1752 return s
->async_cb(s
, s
->async_cb_arg
);
1755 static int ssl_start_async_job(SSL
*s
, struct ssl_async_args
*args
,
1756 int (*func
) (void *))
1759 if (s
->waitctx
== NULL
) {
1760 s
->waitctx
= ASYNC_WAIT_CTX_new();
1761 if (s
->waitctx
== NULL
)
1763 if (s
->async_cb
!= NULL
1764 && !ASYNC_WAIT_CTX_set_callback
1765 (s
->waitctx
, ssl_async_wait_ctx_cb
, s
))
1768 switch (ASYNC_start_job(&s
->job
, s
->waitctx
, &ret
, func
, args
,
1769 sizeof(struct ssl_async_args
))) {
1771 s
->rwstate
= SSL_NOTHING
;
1772 ERR_raise(ERR_LIB_SSL
, SSL_R_FAILED_TO_INIT_ASYNC
);
1775 s
->rwstate
= SSL_ASYNC_PAUSED
;
1778 s
->rwstate
= SSL_ASYNC_NO_JOBS
;
1784 s
->rwstate
= SSL_NOTHING
;
1785 ERR_raise(ERR_LIB_SSL
, ERR_R_INTERNAL_ERROR
);
1786 /* Shouldn't happen */
1791 static int ssl_io_intern(void *vargs
)
1793 struct ssl_async_args
*args
;
1798 args
= (struct ssl_async_args
*)vargs
;
1802 switch (args
->type
) {
1804 return args
->f
.func_read(s
, buf
, num
, &s
->asyncrw
);
1806 return args
->f
.func_write(s
, buf
, num
, &s
->asyncrw
);
1808 return args
->f
.func_other(s
);
1813 int ssl_read_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1815 if (s
->handshake_func
== NULL
) {
1816 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
1820 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1821 s
->rwstate
= SSL_NOTHING
;
1825 if (s
->early_data_state
== SSL_EARLY_DATA_CONNECT_RETRY
1826 || s
->early_data_state
== SSL_EARLY_DATA_ACCEPT_RETRY
) {
1827 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1831 * If we are a client and haven't received the ServerHello etc then we
1834 ossl_statem_check_finish_init(s
, 0);
1836 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1837 struct ssl_async_args args
;
1843 args
.type
= READFUNC
;
1844 args
.f
.func_read
= s
->method
->ssl_read
;
1846 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
1847 *readbytes
= s
->asyncrw
;
1850 return s
->method
->ssl_read(s
, buf
, num
, readbytes
);
1854 int SSL_read(SSL
*s
, void *buf
, int num
)
1860 ERR_raise(ERR_LIB_SSL
, SSL_R_BAD_LENGTH
);
1864 ret
= ssl_read_internal(s
, buf
, (size_t)num
, &readbytes
);
1867 * The cast is safe here because ret should be <= INT_MAX because num is
1871 ret
= (int)readbytes
;
1876 int SSL_read_ex(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1878 int ret
= ssl_read_internal(s
, buf
, num
, readbytes
);
1885 int SSL_read_early_data(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1890 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1891 return SSL_READ_EARLY_DATA_ERROR
;
1894 switch (s
->early_data_state
) {
1895 case SSL_EARLY_DATA_NONE
:
1896 if (!SSL_in_before(s
)) {
1897 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1898 return SSL_READ_EARLY_DATA_ERROR
;
1902 case SSL_EARLY_DATA_ACCEPT_RETRY
:
1903 s
->early_data_state
= SSL_EARLY_DATA_ACCEPTING
;
1904 ret
= SSL_accept(s
);
1907 s
->early_data_state
= SSL_EARLY_DATA_ACCEPT_RETRY
;
1908 return SSL_READ_EARLY_DATA_ERROR
;
1912 case SSL_EARLY_DATA_READ_RETRY
:
1913 if (s
->ext
.early_data
== SSL_EARLY_DATA_ACCEPTED
) {
1914 s
->early_data_state
= SSL_EARLY_DATA_READING
;
1915 ret
= SSL_read_ex(s
, buf
, num
, readbytes
);
1917 * State machine will update early_data_state to
1918 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1921 if (ret
> 0 || (ret
<= 0 && s
->early_data_state
1922 != SSL_EARLY_DATA_FINISHED_READING
)) {
1923 s
->early_data_state
= SSL_EARLY_DATA_READ_RETRY
;
1924 return ret
> 0 ? SSL_READ_EARLY_DATA_SUCCESS
1925 : SSL_READ_EARLY_DATA_ERROR
;
1928 s
->early_data_state
= SSL_EARLY_DATA_FINISHED_READING
;
1931 return SSL_READ_EARLY_DATA_FINISH
;
1934 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1935 return SSL_READ_EARLY_DATA_ERROR
;
1939 int SSL_get_early_data_status(const SSL
*s
)
1941 return s
->ext
.early_data
;
1944 static int ssl_peek_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1946 if (s
->handshake_func
== NULL
) {
1947 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
1951 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1954 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1955 struct ssl_async_args args
;
1961 args
.type
= READFUNC
;
1962 args
.f
.func_read
= s
->method
->ssl_peek
;
1964 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
1965 *readbytes
= s
->asyncrw
;
1968 return s
->method
->ssl_peek(s
, buf
, num
, readbytes
);
1972 int SSL_peek(SSL
*s
, void *buf
, int num
)
1978 ERR_raise(ERR_LIB_SSL
, SSL_R_BAD_LENGTH
);
1982 ret
= ssl_peek_internal(s
, buf
, (size_t)num
, &readbytes
);
1985 * The cast is safe here because ret should be <= INT_MAX because num is
1989 ret
= (int)readbytes
;
1995 int SSL_peek_ex(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1997 int ret
= ssl_peek_internal(s
, buf
, num
, readbytes
);
2004 int ssl_write_internal(SSL
*s
, const void *buf
, size_t num
, size_t *written
)
2006 if (s
->handshake_func
== NULL
) {
2007 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
2011 if (s
->shutdown
& SSL_SENT_SHUTDOWN
) {
2012 s
->rwstate
= SSL_NOTHING
;
2013 ERR_raise(ERR_LIB_SSL
, SSL_R_PROTOCOL_IS_SHUTDOWN
);
2017 if (s
->early_data_state
== SSL_EARLY_DATA_CONNECT_RETRY
2018 || s
->early_data_state
== SSL_EARLY_DATA_ACCEPT_RETRY
2019 || s
->early_data_state
== SSL_EARLY_DATA_READ_RETRY
) {
2020 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
2023 /* If we are a client and haven't sent the Finished we better do that */
2024 ossl_statem_check_finish_init(s
, 1);
2026 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
2028 struct ssl_async_args args
;
2031 args
.buf
= (void *)buf
;
2033 args
.type
= WRITEFUNC
;
2034 args
.f
.func_write
= s
->method
->ssl_write
;
2036 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
2037 *written
= s
->asyncrw
;
2040 return s
->method
->ssl_write(s
, buf
, num
, written
);
2044 ossl_ssize_t
SSL_sendfile(SSL
*s
, int fd
, off_t offset
, size_t size
, int flags
)
2048 if (s
->handshake_func
== NULL
) {
2049 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
2053 if (s
->shutdown
& SSL_SENT_SHUTDOWN
) {
2054 s
->rwstate
= SSL_NOTHING
;
2055 ERR_raise(ERR_LIB_SSL
, SSL_R_PROTOCOL_IS_SHUTDOWN
);
2059 if (!BIO_get_ktls_send(s
->wbio
)) {
2060 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
2064 /* If we have an alert to send, lets send it */
2065 if (s
->s3
.alert_dispatch
) {
2066 ret
= (ossl_ssize_t
)s
->method
->ssl_dispatch_alert(s
);
2068 /* SSLfatal() already called if appropriate */
2071 /* if it went, fall through and send more stuff */
2074 s
->rwstate
= SSL_WRITING
;
2075 if (BIO_flush(s
->wbio
) <= 0) {
2076 if (!BIO_should_retry(s
->wbio
)) {
2077 s
->rwstate
= SSL_NOTHING
;
2080 set_sys_error(EAGAIN
);
2086 #ifdef OPENSSL_NO_KTLS
2087 ERR_raise_data(ERR_LIB_SSL
, ERR_R_INTERNAL_ERROR
,
2088 "can't call ktls_sendfile(), ktls disabled");
2091 ret
= ktls_sendfile(SSL_get_wfd(s
), fd
, offset
, size
, flags
);
2093 #if defined(EAGAIN) && defined(EINTR) && defined(EBUSY)
2094 if ((get_last_sys_error() == EAGAIN
) ||
2095 (get_last_sys_error() == EINTR
) ||
2096 (get_last_sys_error() == EBUSY
))
2097 BIO_set_retry_write(s
->wbio
);
2100 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
2103 s
->rwstate
= SSL_NOTHING
;
2108 int SSL_write(SSL
*s
, const void *buf
, int num
)
2114 ERR_raise(ERR_LIB_SSL
, SSL_R_BAD_LENGTH
);
2118 ret
= ssl_write_internal(s
, buf
, (size_t)num
, &written
);
2121 * The cast is safe here because ret should be <= INT_MAX because num is
2130 int SSL_write_ex(SSL
*s
, const void *buf
, size_t num
, size_t *written
)
2132 int ret
= ssl_write_internal(s
, buf
, num
, written
);
2139 int SSL_write_early_data(SSL
*s
, const void *buf
, size_t num
, size_t *written
)
2141 int ret
, early_data_state
;
2143 uint32_t partialwrite
;
2145 switch (s
->early_data_state
) {
2146 case SSL_EARLY_DATA_NONE
:
2148 || !SSL_in_before(s
)
2149 || ((s
->session
== NULL
|| s
->session
->ext
.max_early_data
== 0)
2150 && (s
->psk_use_session_cb
== NULL
))) {
2151 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
2156 case SSL_EARLY_DATA_CONNECT_RETRY
:
2157 s
->early_data_state
= SSL_EARLY_DATA_CONNECTING
;
2158 ret
= SSL_connect(s
);
2161 s
->early_data_state
= SSL_EARLY_DATA_CONNECT_RETRY
;
2166 case SSL_EARLY_DATA_WRITE_RETRY
:
2167 s
->early_data_state
= SSL_EARLY_DATA_WRITING
;
2169 * We disable partial write for early data because we don't keep track
2170 * of how many bytes we've written between the SSL_write_ex() call and
2171 * the flush if the flush needs to be retried)
2173 partialwrite
= s
->mode
& SSL_MODE_ENABLE_PARTIAL_WRITE
;
2174 s
->mode
&= ~SSL_MODE_ENABLE_PARTIAL_WRITE
;
2175 ret
= SSL_write_ex(s
, buf
, num
, &writtmp
);
2176 s
->mode
|= partialwrite
;
2178 s
->early_data_state
= SSL_EARLY_DATA_WRITE_RETRY
;
2181 s
->early_data_state
= SSL_EARLY_DATA_WRITE_FLUSH
;
2184 case SSL_EARLY_DATA_WRITE_FLUSH
:
2185 /* The buffering BIO is still in place so we need to flush it */
2186 if (statem_flush(s
) != 1)
2189 s
->early_data_state
= SSL_EARLY_DATA_WRITE_RETRY
;
2192 case SSL_EARLY_DATA_FINISHED_READING
:
2193 case SSL_EARLY_DATA_READ_RETRY
:
2194 early_data_state
= s
->early_data_state
;
2195 /* We are a server writing to an unauthenticated client */
2196 s
->early_data_state
= SSL_EARLY_DATA_UNAUTH_WRITING
;
2197 ret
= SSL_write_ex(s
, buf
, num
, written
);
2198 /* The buffering BIO is still in place */
2200 (void)BIO_flush(s
->wbio
);
2201 s
->early_data_state
= early_data_state
;
2205 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
2210 int SSL_shutdown(SSL
*s
)
2213 * Note that this function behaves differently from what one might
2214 * expect. Return values are 0 for no success (yet), 1 for success; but
2215 * calling it once is usually not enough, even if blocking I/O is used
2216 * (see ssl3_shutdown).
2219 if (s
->handshake_func
== NULL
) {
2220 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
2224 if (!SSL_in_init(s
)) {
2225 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
2226 struct ssl_async_args args
;
2229 args
.type
= OTHERFUNC
;
2230 args
.f
.func_other
= s
->method
->ssl_shutdown
;
2232 return ssl_start_async_job(s
, &args
, ssl_io_intern
);
2234 return s
->method
->ssl_shutdown(s
);
2237 ERR_raise(ERR_LIB_SSL
, SSL_R_SHUTDOWN_WHILE_IN_INIT
);
2242 int SSL_key_update(SSL
*s
, int updatetype
)
2245 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2246 * negotiated, and that it is appropriate to call SSL_key_update() instead
2247 * of SSL_renegotiate().
2249 if (!SSL_IS_TLS13(s
)) {
2250 ERR_raise(ERR_LIB_SSL
, SSL_R_WRONG_SSL_VERSION
);
2254 if (updatetype
!= SSL_KEY_UPDATE_NOT_REQUESTED
2255 && updatetype
!= SSL_KEY_UPDATE_REQUESTED
) {
2256 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_KEY_UPDATE_TYPE
);
2260 if (!SSL_is_init_finished(s
)) {
2261 ERR_raise(ERR_LIB_SSL
, SSL_R_STILL_IN_INIT
);
2265 ossl_statem_set_in_init(s
, 1);
2266 s
->key_update
= updatetype
;
2270 int SSL_get_key_update_type(const SSL
*s
)
2272 return s
->key_update
;
2275 int SSL_renegotiate(SSL
*s
)
2277 if (SSL_IS_TLS13(s
)) {
2278 ERR_raise(ERR_LIB_SSL
, SSL_R_WRONG_SSL_VERSION
);
2282 if ((s
->options
& SSL_OP_NO_RENEGOTIATION
)) {
2283 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_RENEGOTIATION
);
2290 return s
->method
->ssl_renegotiate(s
);
2293 int SSL_renegotiate_abbreviated(SSL
*s
)
2295 if (SSL_IS_TLS13(s
)) {
2296 ERR_raise(ERR_LIB_SSL
, SSL_R_WRONG_SSL_VERSION
);
2300 if ((s
->options
& SSL_OP_NO_RENEGOTIATION
)) {
2301 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_RENEGOTIATION
);
2308 return s
->method
->ssl_renegotiate(s
);
2311 int SSL_renegotiate_pending(const SSL
*s
)
2314 * becomes true when negotiation is requested; false again once a
2315 * handshake has finished
2317 return (s
->renegotiate
!= 0);
2320 int SSL_new_session_ticket(SSL
*s
)
2322 if (SSL_in_init(s
) || SSL_IS_FIRST_HANDSHAKE(s
) || !s
->server
2323 || !SSL_IS_TLS13(s
))
2325 s
->ext
.extra_tickets_expected
++;
2329 long SSL_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
)
2334 case SSL_CTRL_GET_READ_AHEAD
:
2335 return RECORD_LAYER_get_read_ahead(&s
->rlayer
);
2336 case SSL_CTRL_SET_READ_AHEAD
:
2337 l
= RECORD_LAYER_get_read_ahead(&s
->rlayer
);
2338 RECORD_LAYER_set_read_ahead(&s
->rlayer
, larg
);
2341 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
2342 s
->msg_callback_arg
= parg
;
2346 return (s
->mode
|= larg
);
2347 case SSL_CTRL_CLEAR_MODE
:
2348 return (s
->mode
&= ~larg
);
2349 case SSL_CTRL_GET_MAX_CERT_LIST
:
2350 return (long)s
->max_cert_list
;
2351 case SSL_CTRL_SET_MAX_CERT_LIST
:
2354 l
= (long)s
->max_cert_list
;
2355 s
->max_cert_list
= (size_t)larg
;
2357 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
2358 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
2360 #ifndef OPENSSL_NO_KTLS
2361 if (s
->wbio
!= NULL
&& BIO_get_ktls_send(s
->wbio
))
2363 #endif /* OPENSSL_NO_KTLS */
2364 s
->max_send_fragment
= larg
;
2365 if (s
->max_send_fragment
< s
->split_send_fragment
)
2366 s
->split_send_fragment
= s
->max_send_fragment
;
2368 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
2369 if ((size_t)larg
> s
->max_send_fragment
|| larg
== 0)
2371 s
->split_send_fragment
= larg
;
2373 case SSL_CTRL_SET_MAX_PIPELINES
:
2374 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
2376 s
->max_pipelines
= larg
;
2378 RECORD_LAYER_set_read_ahead(&s
->rlayer
, 1);
2380 case SSL_CTRL_GET_RI_SUPPORT
:
2381 return s
->s3
.send_connection_binding
;
2382 case SSL_CTRL_CERT_FLAGS
:
2383 return (s
->cert
->cert_flags
|= larg
);
2384 case SSL_CTRL_CLEAR_CERT_FLAGS
:
2385 return (s
->cert
->cert_flags
&= ~larg
);
2387 case SSL_CTRL_GET_RAW_CIPHERLIST
:
2389 if (s
->s3
.tmp
.ciphers_raw
== NULL
)
2391 *(unsigned char **)parg
= s
->s3
.tmp
.ciphers_raw
;
2392 return (int)s
->s3
.tmp
.ciphers_rawlen
;
2394 return TLS_CIPHER_LEN
;
2396 case SSL_CTRL_GET_EXTMS_SUPPORT
:
2397 if (!s
->session
|| SSL_in_init(s
) || ossl_statem_get_in_handshake(s
))
2399 if (s
->session
->flags
& SSL_SESS_FLAG_EXTMS
)
2403 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
2404 return ssl_check_allowed_versions(larg
, s
->max_proto_version
)
2405 && ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
2406 &s
->min_proto_version
);
2407 case SSL_CTRL_GET_MIN_PROTO_VERSION
:
2408 return s
->min_proto_version
;
2409 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
2410 return ssl_check_allowed_versions(s
->min_proto_version
, larg
)
2411 && ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
2412 &s
->max_proto_version
);
2413 case SSL_CTRL_GET_MAX_PROTO_VERSION
:
2414 return s
->max_proto_version
;
2416 return s
->method
->ssl_ctrl(s
, cmd
, larg
, parg
);
2420 long SSL_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void))
2423 case SSL_CTRL_SET_MSG_CALLBACK
:
2424 s
->msg_callback
= (void (*)
2425 (int write_p
, int version
, int content_type
,
2426 const void *buf
, size_t len
, SSL
*ssl
,
2431 return s
->method
->ssl_callback_ctrl(s
, cmd
, fp
);
2435 LHASH_OF(SSL_SESSION
) *SSL_CTX_sessions(SSL_CTX
*ctx
)
2437 return ctx
->sessions
;
2440 long SSL_CTX_ctrl(SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
)
2443 /* For some cases with ctx == NULL perform syntax checks */
2446 case SSL_CTRL_SET_GROUPS_LIST
:
2447 return tls1_set_groups_list(ctx
, NULL
, NULL
, parg
);
2448 case SSL_CTRL_SET_SIGALGS_LIST
:
2449 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST
:
2450 return tls1_set_sigalgs_list(NULL
, parg
, 0);
2457 case SSL_CTRL_GET_READ_AHEAD
:
2458 return ctx
->read_ahead
;
2459 case SSL_CTRL_SET_READ_AHEAD
:
2460 l
= ctx
->read_ahead
;
2461 ctx
->read_ahead
= larg
;
2464 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
2465 ctx
->msg_callback_arg
= parg
;
2468 case SSL_CTRL_GET_MAX_CERT_LIST
:
2469 return (long)ctx
->max_cert_list
;
2470 case SSL_CTRL_SET_MAX_CERT_LIST
:
2473 l
= (long)ctx
->max_cert_list
;
2474 ctx
->max_cert_list
= (size_t)larg
;
2477 case SSL_CTRL_SET_SESS_CACHE_SIZE
:
2480 l
= (long)ctx
->session_cache_size
;
2481 ctx
->session_cache_size
= (size_t)larg
;
2483 case SSL_CTRL_GET_SESS_CACHE_SIZE
:
2484 return (long)ctx
->session_cache_size
;
2485 case SSL_CTRL_SET_SESS_CACHE_MODE
:
2486 l
= ctx
->session_cache_mode
;
2487 ctx
->session_cache_mode
= larg
;
2489 case SSL_CTRL_GET_SESS_CACHE_MODE
:
2490 return ctx
->session_cache_mode
;
2492 case SSL_CTRL_SESS_NUMBER
:
2493 return lh_SSL_SESSION_num_items(ctx
->sessions
);
2494 case SSL_CTRL_SESS_CONNECT
:
2495 return tsan_load(&ctx
->stats
.sess_connect
);
2496 case SSL_CTRL_SESS_CONNECT_GOOD
:
2497 return tsan_load(&ctx
->stats
.sess_connect_good
);
2498 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE
:
2499 return tsan_load(&ctx
->stats
.sess_connect_renegotiate
);
2500 case SSL_CTRL_SESS_ACCEPT
:
2501 return tsan_load(&ctx
->stats
.sess_accept
);
2502 case SSL_CTRL_SESS_ACCEPT_GOOD
:
2503 return tsan_load(&ctx
->stats
.sess_accept_good
);
2504 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE
:
2505 return tsan_load(&ctx
->stats
.sess_accept_renegotiate
);
2506 case SSL_CTRL_SESS_HIT
:
2507 return tsan_load(&ctx
->stats
.sess_hit
);
2508 case SSL_CTRL_SESS_CB_HIT
:
2509 return tsan_load(&ctx
->stats
.sess_cb_hit
);
2510 case SSL_CTRL_SESS_MISSES
:
2511 return tsan_load(&ctx
->stats
.sess_miss
);
2512 case SSL_CTRL_SESS_TIMEOUTS
:
2513 return tsan_load(&ctx
->stats
.sess_timeout
);
2514 case SSL_CTRL_SESS_CACHE_FULL
:
2515 return tsan_load(&ctx
->stats
.sess_cache_full
);
2517 return (ctx
->mode
|= larg
);
2518 case SSL_CTRL_CLEAR_MODE
:
2519 return (ctx
->mode
&= ~larg
);
2520 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
2521 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
2523 ctx
->max_send_fragment
= larg
;
2524 if (ctx
->max_send_fragment
< ctx
->split_send_fragment
)
2525 ctx
->split_send_fragment
= ctx
->max_send_fragment
;
2527 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
2528 if ((size_t)larg
> ctx
->max_send_fragment
|| larg
== 0)
2530 ctx
->split_send_fragment
= larg
;
2532 case SSL_CTRL_SET_MAX_PIPELINES
:
2533 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
2535 ctx
->max_pipelines
= larg
;
2537 case SSL_CTRL_CERT_FLAGS
:
2538 return (ctx
->cert
->cert_flags
|= larg
);
2539 case SSL_CTRL_CLEAR_CERT_FLAGS
:
2540 return (ctx
->cert
->cert_flags
&= ~larg
);
2541 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
2542 return ssl_check_allowed_versions(larg
, ctx
->max_proto_version
)
2543 && ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
2544 &ctx
->min_proto_version
);
2545 case SSL_CTRL_GET_MIN_PROTO_VERSION
:
2546 return ctx
->min_proto_version
;
2547 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
2548 return ssl_check_allowed_versions(ctx
->min_proto_version
, larg
)
2549 && ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
2550 &ctx
->max_proto_version
);
2551 case SSL_CTRL_GET_MAX_PROTO_VERSION
:
2552 return ctx
->max_proto_version
;
2554 return ctx
->method
->ssl_ctx_ctrl(ctx
, cmd
, larg
, parg
);
2558 long SSL_CTX_callback_ctrl(SSL_CTX
*ctx
, int cmd
, void (*fp
) (void))
2561 case SSL_CTRL_SET_MSG_CALLBACK
:
2562 ctx
->msg_callback
= (void (*)
2563 (int write_p
, int version
, int content_type
,
2564 const void *buf
, size_t len
, SSL
*ssl
,
2569 return ctx
->method
->ssl_ctx_callback_ctrl(ctx
, cmd
, fp
);
2573 int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
)
2582 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
2583 const SSL_CIPHER
*const *bp
)
2585 if ((*ap
)->id
> (*bp
)->id
)
2587 if ((*ap
)->id
< (*bp
)->id
)
2592 /** return a STACK of the ciphers available for the SSL and in order of
2594 STACK_OF(SSL_CIPHER
) *SSL_get_ciphers(const SSL
*s
)
2597 if (s
->cipher_list
!= NULL
) {
2598 return s
->cipher_list
;
2599 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list
!= NULL
)) {
2600 return s
->ctx
->cipher_list
;
2606 STACK_OF(SSL_CIPHER
) *SSL_get_client_ciphers(const SSL
*s
)
2608 if ((s
== NULL
) || !s
->server
)
2610 return s
->peer_ciphers
;
2613 STACK_OF(SSL_CIPHER
) *SSL_get1_supported_ciphers(SSL
*s
)
2615 STACK_OF(SSL_CIPHER
) *sk
= NULL
, *ciphers
;
2618 ciphers
= SSL_get_ciphers(s
);
2621 if (!ssl_set_client_disabled(s
))
2623 for (i
= 0; i
< sk_SSL_CIPHER_num(ciphers
); i
++) {
2624 const SSL_CIPHER
*c
= sk_SSL_CIPHER_value(ciphers
, i
);
2625 if (!ssl_cipher_disabled(s
, c
, SSL_SECOP_CIPHER_SUPPORTED
, 0)) {
2627 sk
= sk_SSL_CIPHER_new_null();
2630 if (!sk_SSL_CIPHER_push(sk
, c
)) {
2631 sk_SSL_CIPHER_free(sk
);
2639 /** return a STACK of the ciphers available for the SSL and in order of
2641 STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
)
2644 if (s
->cipher_list_by_id
!= NULL
) {
2645 return s
->cipher_list_by_id
;
2646 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list_by_id
!= NULL
)) {
2647 return s
->ctx
->cipher_list_by_id
;
2653 /** The old interface to get the same thing as SSL_get_ciphers() */
2654 const char *SSL_get_cipher_list(const SSL
*s
, int n
)
2656 const SSL_CIPHER
*c
;
2657 STACK_OF(SSL_CIPHER
) *sk
;
2661 sk
= SSL_get_ciphers(s
);
2662 if ((sk
== NULL
) || (sk_SSL_CIPHER_num(sk
) <= n
))
2664 c
= sk_SSL_CIPHER_value(sk
, n
);
2670 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2672 STACK_OF(SSL_CIPHER
) *SSL_CTX_get_ciphers(const SSL_CTX
*ctx
)
2675 return ctx
->cipher_list
;
2680 * Distinguish between ciphers controlled by set_ciphersuite() and
2681 * set_cipher_list() when counting.
2683 static int cipher_list_tls12_num(STACK_OF(SSL_CIPHER
) *sk
)
2686 const SSL_CIPHER
*c
;
2690 for (i
= 0; i
< sk_SSL_CIPHER_num(sk
); ++i
) {
2691 c
= sk_SSL_CIPHER_value(sk
, i
);
2692 if (c
->min_tls
>= TLS1_3_VERSION
)
2699 /** specify the ciphers to be used by default by the SSL_CTX */
2700 int SSL_CTX_set_cipher_list(SSL_CTX
*ctx
, const char *str
)
2702 STACK_OF(SSL_CIPHER
) *sk
;
2704 sk
= ssl_create_cipher_list(ctx
, ctx
->tls13_ciphersuites
,
2705 &ctx
->cipher_list
, &ctx
->cipher_list_by_id
, str
,
2708 * ssl_create_cipher_list may return an empty stack if it was unable to
2709 * find a cipher matching the given rule string (for example if the rule
2710 * string specifies a cipher which has been disabled). This is not an
2711 * error as far as ssl_create_cipher_list is concerned, and hence
2712 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2716 else if (cipher_list_tls12_num(sk
) == 0) {
2717 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CIPHER_MATCH
);
2723 /** specify the ciphers to be used by the SSL */
2724 int SSL_set_cipher_list(SSL
*s
, const char *str
)
2726 STACK_OF(SSL_CIPHER
) *sk
;
2728 sk
= ssl_create_cipher_list(s
->ctx
, s
->tls13_ciphersuites
,
2729 &s
->cipher_list
, &s
->cipher_list_by_id
, str
,
2731 /* see comment in SSL_CTX_set_cipher_list */
2734 else if (cipher_list_tls12_num(sk
) == 0) {
2735 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CIPHER_MATCH
);
2741 char *SSL_get_shared_ciphers(const SSL
*s
, char *buf
, int size
)
2744 STACK_OF(SSL_CIPHER
) *clntsk
, *srvrsk
;
2745 const SSL_CIPHER
*c
;
2749 || s
->peer_ciphers
== NULL
2754 clntsk
= s
->peer_ciphers
;
2755 srvrsk
= SSL_get_ciphers(s
);
2756 if (clntsk
== NULL
|| srvrsk
== NULL
)
2759 if (sk_SSL_CIPHER_num(clntsk
) == 0 || sk_SSL_CIPHER_num(srvrsk
) == 0)
2762 for (i
= 0; i
< sk_SSL_CIPHER_num(clntsk
); i
++) {
2765 c
= sk_SSL_CIPHER_value(clntsk
, i
);
2766 if (sk_SSL_CIPHER_find(srvrsk
, c
) < 0)
2769 n
= strlen(c
->name
);
2786 * Return the requested servername (SNI) value. Note that the behaviour varies
2788 * - whether this is called by the client or the server,
2789 * - if we are before or during/after the handshake,
2790 * - if a resumption or normal handshake is being attempted/has occurred
2791 * - whether we have negotiated TLSv1.2 (or below) or TLSv1.3
2793 * Note that only the host_name type is defined (RFC 3546).
2795 const char *SSL_get_servername(const SSL
*s
, const int type
)
2798 * If we don't know if we are the client or the server yet then we assume
2801 int server
= s
->handshake_func
== NULL
? 0 : s
->server
;
2802 if (type
!= TLSEXT_NAMETYPE_host_name
)
2808 * In TLSv1.3 on the server SNI is not associated with the session
2809 * but in TLSv1.2 or below it is.
2811 * Before the handshake:
2814 * During/after the handshake (TLSv1.2 or below resumption occurred):
2815 * - If a servername was accepted by the server in the original
2816 * handshake then it will return that servername, or NULL otherwise.
2818 * During/after the handshake (TLSv1.2 or below resumption did not occur):
2819 * - The function will return the servername requested by the client in
2820 * this handshake or NULL if none was requested.
2822 if (s
->hit
&& !SSL_IS_TLS13(s
))
2823 return s
->session
->ext
.hostname
;
2828 * Before the handshake:
2829 * - If a servername has been set via a call to
2830 * SSL_set_tlsext_host_name() then it will return that servername
2831 * - If one has not been set, but a TLSv1.2 resumption is being
2832 * attempted and the session from the original handshake had a
2833 * servername accepted by the server then it will return that
2835 * - Otherwise it returns NULL
2837 * During/after the handshake (TLSv1.2 or below resumption occurred):
2838 * - If the session from the original handshake had a servername accepted
2839 * by the server then it will return that servername.
2840 * - Otherwise it returns the servername set via
2841 * SSL_set_tlsext_host_name() (or NULL if it was not called).
2843 * During/after the handshake (TLSv1.2 or below resumption did not occur):
2844 * - It will return the servername set via SSL_set_tlsext_host_name()
2845 * (or NULL if it was not called).
2847 if (SSL_in_before(s
)) {
2848 if (s
->ext
.hostname
== NULL
2849 && s
->session
!= NULL
2850 && s
->session
->ssl_version
!= TLS1_3_VERSION
)
2851 return s
->session
->ext
.hostname
;
2853 if (!SSL_IS_TLS13(s
) && s
->hit
&& s
->session
->ext
.hostname
!= NULL
)
2854 return s
->session
->ext
.hostname
;
2858 return s
->ext
.hostname
;
2861 int SSL_get_servername_type(const SSL
*s
)
2863 if (SSL_get_servername(s
, TLSEXT_NAMETYPE_host_name
) != NULL
)
2864 return TLSEXT_NAMETYPE_host_name
;
2869 * SSL_select_next_proto implements the standard protocol selection. It is
2870 * expected that this function is called from the callback set by
2871 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2872 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2873 * not included in the length. A byte string of length 0 is invalid. No byte
2874 * string may be truncated. The current, but experimental algorithm for
2875 * selecting the protocol is: 1) If the server doesn't support NPN then this
2876 * is indicated to the callback. In this case, the client application has to
2877 * abort the connection or have a default application level protocol. 2) If
2878 * the server supports NPN, but advertises an empty list then the client
2879 * selects the first protocol in its list, but indicates via the API that this
2880 * fallback case was enacted. 3) Otherwise, the client finds the first
2881 * protocol in the server's list that it supports and selects this protocol.
2882 * This is because it's assumed that the server has better information about
2883 * which protocol a client should use. 4) If the client doesn't support any
2884 * of the server's advertised protocols, then this is treated the same as
2885 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2886 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2888 int SSL_select_next_proto(unsigned char **out
, unsigned char *outlen
,
2889 const unsigned char *server
,
2890 unsigned int server_len
,
2891 const unsigned char *client
, unsigned int client_len
)
2894 const unsigned char *result
;
2895 int status
= OPENSSL_NPN_UNSUPPORTED
;
2898 * For each protocol in server preference order, see if we support it.
2900 for (i
= 0; i
< server_len
;) {
2901 for (j
= 0; j
< client_len
;) {
2902 if (server
[i
] == client
[j
] &&
2903 memcmp(&server
[i
+ 1], &client
[j
+ 1], server
[i
]) == 0) {
2904 /* We found a match */
2905 result
= &server
[i
];
2906 status
= OPENSSL_NPN_NEGOTIATED
;
2916 /* There's no overlap between our protocols and the server's list. */
2918 status
= OPENSSL_NPN_NO_OVERLAP
;
2921 *out
= (unsigned char *)result
+ 1;
2922 *outlen
= result
[0];
2926 #ifndef OPENSSL_NO_NEXTPROTONEG
2928 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2929 * client's requested protocol for this connection and returns 0. If the
2930 * client didn't request any protocol, then *data is set to NULL. Note that
2931 * the client can request any protocol it chooses. The value returned from
2932 * this function need not be a member of the list of supported protocols
2933 * provided by the callback.
2935 void SSL_get0_next_proto_negotiated(const SSL
*s
, const unsigned char **data
,
2939 if (*data
== NULL
) {
2942 *len
= (unsigned int)s
->ext
.npn_len
;
2947 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2948 * a TLS server needs a list of supported protocols for Next Protocol
2949 * Negotiation. The returned list must be in wire format. The list is
2950 * returned by setting |out| to point to it and |outlen| to its length. This
2951 * memory will not be modified, but one should assume that the SSL* keeps a
2952 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2953 * wishes to advertise. Otherwise, no such extension will be included in the
2956 void SSL_CTX_set_npn_advertised_cb(SSL_CTX
*ctx
,
2957 SSL_CTX_npn_advertised_cb_func cb
,
2960 ctx
->ext
.npn_advertised_cb
= cb
;
2961 ctx
->ext
.npn_advertised_cb_arg
= arg
;
2965 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2966 * client needs to select a protocol from the server's provided list. |out|
2967 * must be set to point to the selected protocol (which may be within |in|).
2968 * The length of the protocol name must be written into |outlen|. The
2969 * server's advertised protocols are provided in |in| and |inlen|. The
2970 * callback can assume that |in| is syntactically valid. The client must
2971 * select a protocol. It is fatal to the connection if this callback returns
2972 * a value other than SSL_TLSEXT_ERR_OK.
2974 void SSL_CTX_set_npn_select_cb(SSL_CTX
*ctx
,
2975 SSL_CTX_npn_select_cb_func cb
,
2978 ctx
->ext
.npn_select_cb
= cb
;
2979 ctx
->ext
.npn_select_cb_arg
= arg
;
2984 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2985 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2986 * length-prefixed strings). Returns 0 on success.
2988 int SSL_CTX_set_alpn_protos(SSL_CTX
*ctx
, const unsigned char *protos
,
2989 unsigned int protos_len
)
2991 OPENSSL_free(ctx
->ext
.alpn
);
2992 ctx
->ext
.alpn
= OPENSSL_memdup(protos
, protos_len
);
2993 if (ctx
->ext
.alpn
== NULL
) {
2994 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
2997 ctx
->ext
.alpn_len
= protos_len
;
3003 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
3004 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
3005 * length-prefixed strings). Returns 0 on success.
3007 int SSL_set_alpn_protos(SSL
*ssl
, const unsigned char *protos
,
3008 unsigned int protos_len
)
3010 OPENSSL_free(ssl
->ext
.alpn
);
3011 ssl
->ext
.alpn
= OPENSSL_memdup(protos
, protos_len
);
3012 if (ssl
->ext
.alpn
== NULL
) {
3013 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3016 ssl
->ext
.alpn_len
= protos_len
;
3022 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
3023 * called during ClientHello processing in order to select an ALPN protocol
3024 * from the client's list of offered protocols.
3026 void SSL_CTX_set_alpn_select_cb(SSL_CTX
*ctx
,
3027 SSL_CTX_alpn_select_cb_func cb
,
3030 ctx
->ext
.alpn_select_cb
= cb
;
3031 ctx
->ext
.alpn_select_cb_arg
= arg
;
3035 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
3036 * On return it sets |*data| to point to |*len| bytes of protocol name
3037 * (not including the leading length-prefix byte). If the server didn't
3038 * respond with a negotiated protocol then |*len| will be zero.
3040 void SSL_get0_alpn_selected(const SSL
*ssl
, const unsigned char **data
,
3043 *data
= ssl
->s3
.alpn_selected
;
3047 *len
= (unsigned int)ssl
->s3
.alpn_selected_len
;
3050 int SSL_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
3051 const char *label
, size_t llen
,
3052 const unsigned char *context
, size_t contextlen
,
3055 if (s
->session
== NULL
3056 || (s
->version
< TLS1_VERSION
&& s
->version
!= DTLS1_BAD_VER
))
3059 return s
->method
->ssl3_enc
->export_keying_material(s
, out
, olen
, label
,
3061 contextlen
, use_context
);
3064 int SSL_export_keying_material_early(SSL
*s
, unsigned char *out
, size_t olen
,
3065 const char *label
, size_t llen
,
3066 const unsigned char *context
,
3069 if (s
->version
!= TLS1_3_VERSION
)
3072 return tls13_export_keying_material_early(s
, out
, olen
, label
, llen
,
3073 context
, contextlen
);
3076 static unsigned long ssl_session_hash(const SSL_SESSION
*a
)
3078 const unsigned char *session_id
= a
->session_id
;
3080 unsigned char tmp_storage
[4];
3082 if (a
->session_id_length
< sizeof(tmp_storage
)) {
3083 memset(tmp_storage
, 0, sizeof(tmp_storage
));
3084 memcpy(tmp_storage
, a
->session_id
, a
->session_id_length
);
3085 session_id
= tmp_storage
;
3089 ((unsigned long)session_id
[0]) |
3090 ((unsigned long)session_id
[1] << 8L) |
3091 ((unsigned long)session_id
[2] << 16L) |
3092 ((unsigned long)session_id
[3] << 24L);
3097 * NB: If this function (or indeed the hash function which uses a sort of
3098 * coarser function than this one) is changed, ensure
3099 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
3100 * being able to construct an SSL_SESSION that will collide with any existing
3101 * session with a matching session ID.
3103 static int ssl_session_cmp(const SSL_SESSION
*a
, const SSL_SESSION
*b
)
3105 if (a
->ssl_version
!= b
->ssl_version
)
3107 if (a
->session_id_length
!= b
->session_id_length
)
3109 return memcmp(a
->session_id
, b
->session_id
, a
->session_id_length
);
3113 * These wrapper functions should remain rather than redeclaring
3114 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
3115 * variable. The reason is that the functions aren't static, they're exposed
3119 SSL_CTX
*SSL_CTX_new_ex(OSSL_LIB_CTX
*libctx
, const char *propq
,
3120 const SSL_METHOD
*meth
)
3122 SSL_CTX
*ret
= NULL
;
3125 ERR_raise(ERR_LIB_SSL
, SSL_R_NULL_SSL_METHOD_PASSED
);
3129 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS
, NULL
))
3132 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
3133 ERR_raise(ERR_LIB_SSL
, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS
);
3136 ret
= OPENSSL_zalloc(sizeof(*ret
));
3140 ret
->libctx
= libctx
;
3141 if (propq
!= NULL
) {
3142 ret
->propq
= OPENSSL_strdup(propq
);
3143 if (ret
->propq
== NULL
)
3148 ret
->min_proto_version
= 0;
3149 ret
->max_proto_version
= 0;
3150 ret
->mode
= SSL_MODE_AUTO_RETRY
;
3151 ret
->session_cache_mode
= SSL_SESS_CACHE_SERVER
;
3152 ret
->session_cache_size
= SSL_SESSION_CACHE_MAX_SIZE_DEFAULT
;
3153 /* We take the system default. */
3154 ret
->session_timeout
= meth
->get_timeout();
3155 ret
->references
= 1;
3156 ret
->lock
= CRYPTO_THREAD_lock_new();
3157 if (ret
->lock
== NULL
) {
3158 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3162 ret
->max_cert_list
= SSL_MAX_CERT_LIST_DEFAULT
;
3163 ret
->verify_mode
= SSL_VERIFY_NONE
;
3164 if ((ret
->cert
= ssl_cert_new()) == NULL
)
3167 ret
->sessions
= lh_SSL_SESSION_new(ssl_session_hash
, ssl_session_cmp
);
3168 if (ret
->sessions
== NULL
)
3170 ret
->cert_store
= X509_STORE_new();
3171 if (ret
->cert_store
== NULL
)
3173 #ifndef OPENSSL_NO_CT
3174 ret
->ctlog_store
= CTLOG_STORE_new_ex(libctx
, propq
);
3175 if (ret
->ctlog_store
== NULL
)
3179 /* initialize cipher/digest methods table */
3180 if (!ssl_load_ciphers(ret
))
3182 /* initialise sig algs */
3183 if (!ssl_setup_sig_algs(ret
))
3187 if (!ssl_load_groups(ret
))
3190 if (!SSL_CTX_set_ciphersuites(ret
, OSSL_default_ciphersuites()))
3193 if (!ssl_create_cipher_list(ret
,
3194 ret
->tls13_ciphersuites
,
3195 &ret
->cipher_list
, &ret
->cipher_list_by_id
,
3196 OSSL_default_cipher_list(), ret
->cert
)
3197 || sk_SSL_CIPHER_num(ret
->cipher_list
) <= 0) {
3198 ERR_raise(ERR_LIB_SSL
, SSL_R_LIBRARY_HAS_NO_CIPHERS
);
3202 ret
->param
= X509_VERIFY_PARAM_new();
3203 if (ret
->param
== NULL
)
3207 * If these aren't available from the provider we'll get NULL returns.
3208 * That's fine but will cause errors later if SSLv3 is negotiated
3210 ret
->md5
= ssl_evp_md_fetch(libctx
, NID_md5
, propq
);
3211 ret
->sha1
= ssl_evp_md_fetch(libctx
, NID_sha1
, propq
);
3213 if ((ret
->ca_names
= sk_X509_NAME_new_null()) == NULL
)
3216 if ((ret
->client_ca_names
= sk_X509_NAME_new_null()) == NULL
)
3219 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, ret
, &ret
->ex_data
))
3222 if ((ret
->ext
.secure
= OPENSSL_secure_zalloc(sizeof(*ret
->ext
.secure
))) == NULL
)
3225 /* No compression for DTLS */
3226 if (!(meth
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_DTLS
))
3227 ret
->comp_methods
= SSL_COMP_get_compression_methods();
3229 ret
->max_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
3230 ret
->split_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
3232 /* Setup RFC5077 ticket keys */
3233 if ((RAND_bytes_ex(libctx
, ret
->ext
.tick_key_name
,
3234 sizeof(ret
->ext
.tick_key_name
)) <= 0)
3235 || (RAND_priv_bytes_ex(libctx
, ret
->ext
.secure
->tick_hmac_key
,
3236 sizeof(ret
->ext
.secure
->tick_hmac_key
)) <= 0)
3237 || (RAND_priv_bytes_ex(libctx
, ret
->ext
.secure
->tick_aes_key
,
3238 sizeof(ret
->ext
.secure
->tick_aes_key
)) <= 0))
3239 ret
->options
|= SSL_OP_NO_TICKET
;
3241 if (RAND_priv_bytes_ex(libctx
, ret
->ext
.cookie_hmac_key
,
3242 sizeof(ret
->ext
.cookie_hmac_key
)) <= 0)
3245 #ifndef OPENSSL_NO_SRP
3246 if (!SSL_CTX_SRP_CTX_init(ret
))
3249 #ifndef OPENSSL_NO_ENGINE
3250 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3251 # define eng_strx(x) #x
3252 # define eng_str(x) eng_strx(x)
3253 /* Use specific client engine automatically... ignore errors */
3256 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
3259 ENGINE_load_builtin_engines();
3260 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
3262 if (!eng
|| !SSL_CTX_set_client_cert_engine(ret
, eng
))
3268 * Default is to connect to non-RI servers. When RI is more widely
3269 * deployed might change this.
3271 ret
->options
|= SSL_OP_LEGACY_SERVER_CONNECT
;
3273 * Disable compression by default to prevent CRIME. Applications can
3274 * re-enable compression by configuring
3275 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3276 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3277 * middlebox compatibility by default. This may be disabled by default in
3278 * a later OpenSSL version.
3280 ret
->options
|= SSL_OP_NO_COMPRESSION
| SSL_OP_ENABLE_MIDDLEBOX_COMPAT
;
3282 ret
->ext
.status_type
= TLSEXT_STATUSTYPE_nothing
;
3285 * We cannot usefully set a default max_early_data here (which gets
3286 * propagated in SSL_new(), for the following reason: setting the
3287 * SSL field causes tls_construct_stoc_early_data() to tell the
3288 * client that early data will be accepted when constructing a TLS 1.3
3289 * session ticket, and the client will accordingly send us early data
3290 * when using that ticket (if the client has early data to send).
3291 * However, in order for the early data to actually be consumed by
3292 * the application, the application must also have calls to
3293 * SSL_read_early_data(); otherwise we'll just skip past the early data
3294 * and ignore it. So, since the application must add calls to
3295 * SSL_read_early_data(), we also require them to add
3296 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3297 * eliminating the bandwidth-wasting early data in the case described
3300 ret
->max_early_data
= 0;
3303 * Default recv_max_early_data is a fully loaded single record. Could be
3304 * split across multiple records in practice. We set this differently to
3305 * max_early_data so that, in the default case, we do not advertise any
3306 * support for early_data, but if a client were to send us some (e.g.
3307 * because of an old, stale ticket) then we will tolerate it and skip over
3310 ret
->recv_max_early_data
= SSL3_RT_MAX_PLAIN_LENGTH
;
3312 /* By default we send two session tickets automatically in TLSv1.3 */
3313 ret
->num_tickets
= 2;
3315 ssl_ctx_system_config(ret
);
3319 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3325 SSL_CTX
*SSL_CTX_new(const SSL_METHOD
*meth
)
3327 return SSL_CTX_new_ex(NULL
, NULL
, meth
);
3330 int SSL_CTX_up_ref(SSL_CTX
*ctx
)
3334 if (CRYPTO_UP_REF(&ctx
->references
, &i
, ctx
->lock
) <= 0)
3337 REF_PRINT_COUNT("SSL_CTX", ctx
);
3338 REF_ASSERT_ISNT(i
< 2);
3339 return ((i
> 1) ? 1 : 0);
3342 void SSL_CTX_free(SSL_CTX
*a
)
3350 CRYPTO_DOWN_REF(&a
->references
, &i
, a
->lock
);
3351 REF_PRINT_COUNT("SSL_CTX", a
);
3354 REF_ASSERT_ISNT(i
< 0);
3356 X509_VERIFY_PARAM_free(a
->param
);
3357 dane_ctx_final(&a
->dane
);
3360 * Free internal session cache. However: the remove_cb() may reference
3361 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3362 * after the sessions were flushed.
3363 * As the ex_data handling routines might also touch the session cache,
3364 * the most secure solution seems to be: empty (flush) the cache, then
3365 * free ex_data, then finally free the cache.
3366 * (See ticket [openssl.org #212].)
3368 if (a
->sessions
!= NULL
)
3369 SSL_CTX_flush_sessions(a
, 0);
3371 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, a
, &a
->ex_data
);
3372 lh_SSL_SESSION_free(a
->sessions
);
3373 X509_STORE_free(a
->cert_store
);
3374 #ifndef OPENSSL_NO_CT
3375 CTLOG_STORE_free(a
->ctlog_store
);
3377 sk_SSL_CIPHER_free(a
->cipher_list
);
3378 sk_SSL_CIPHER_free(a
->cipher_list_by_id
);
3379 sk_SSL_CIPHER_free(a
->tls13_ciphersuites
);
3380 ssl_cert_free(a
->cert
);
3381 sk_X509_NAME_pop_free(a
->ca_names
, X509_NAME_free
);
3382 sk_X509_NAME_pop_free(a
->client_ca_names
, X509_NAME_free
);
3383 sk_X509_pop_free(a
->extra_certs
, X509_free
);
3384 a
->comp_methods
= NULL
;
3385 #ifndef OPENSSL_NO_SRTP
3386 sk_SRTP_PROTECTION_PROFILE_free(a
->srtp_profiles
);
3388 #ifndef OPENSSL_NO_SRP
3389 SSL_CTX_SRP_CTX_free(a
);
3391 #ifndef OPENSSL_NO_ENGINE
3392 tls_engine_finish(a
->client_cert_engine
);
3395 #ifndef OPENSSL_NO_EC
3396 OPENSSL_free(a
->ext
.ecpointformats
);
3398 OPENSSL_free(a
->ext
.supportedgroups
);
3399 OPENSSL_free(a
->ext
.alpn
);
3400 OPENSSL_secure_free(a
->ext
.secure
);
3402 ssl_evp_md_free(a
->md5
);
3403 ssl_evp_md_free(a
->sha1
);
3405 for (j
= 0; j
< SSL_ENC_NUM_IDX
; j
++)
3406 ssl_evp_cipher_free(a
->ssl_cipher_methods
[j
]);
3407 for (j
= 0; j
< SSL_MD_NUM_IDX
; j
++)
3408 ssl_evp_md_free(a
->ssl_digest_methods
[j
]);
3409 for (j
= 0; j
< a
->group_list_len
; j
++) {
3410 OPENSSL_free(a
->group_list
[j
].tlsname
);
3411 OPENSSL_free(a
->group_list
[j
].realname
);
3412 OPENSSL_free(a
->group_list
[j
].algorithm
);
3414 OPENSSL_free(a
->group_list
);
3416 OPENSSL_free(a
->sigalg_lookup_cache
);
3418 CRYPTO_THREAD_lock_free(a
->lock
);
3420 OPENSSL_free(a
->propq
);
3425 void SSL_CTX_set_default_passwd_cb(SSL_CTX
*ctx
, pem_password_cb
*cb
)
3427 ctx
->default_passwd_callback
= cb
;
3430 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX
*ctx
, void *u
)
3432 ctx
->default_passwd_callback_userdata
= u
;
3435 pem_password_cb
*SSL_CTX_get_default_passwd_cb(SSL_CTX
*ctx
)
3437 return ctx
->default_passwd_callback
;
3440 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX
*ctx
)
3442 return ctx
->default_passwd_callback_userdata
;
3445 void SSL_set_default_passwd_cb(SSL
*s
, pem_password_cb
*cb
)
3447 s
->default_passwd_callback
= cb
;
3450 void SSL_set_default_passwd_cb_userdata(SSL
*s
, void *u
)
3452 s
->default_passwd_callback_userdata
= u
;
3455 pem_password_cb
*SSL_get_default_passwd_cb(SSL
*s
)
3457 return s
->default_passwd_callback
;
3460 void *SSL_get_default_passwd_cb_userdata(SSL
*s
)
3462 return s
->default_passwd_callback_userdata
;
3465 void SSL_CTX_set_cert_verify_callback(SSL_CTX
*ctx
,
3466 int (*cb
) (X509_STORE_CTX
*, void *),
3469 ctx
->app_verify_callback
= cb
;
3470 ctx
->app_verify_arg
= arg
;
3473 void SSL_CTX_set_verify(SSL_CTX
*ctx
, int mode
,
3474 int (*cb
) (int, X509_STORE_CTX
*))
3476 ctx
->verify_mode
= mode
;
3477 ctx
->default_verify_callback
= cb
;
3480 void SSL_CTX_set_verify_depth(SSL_CTX
*ctx
, int depth
)
3482 X509_VERIFY_PARAM_set_depth(ctx
->param
, depth
);
3485 void SSL_CTX_set_cert_cb(SSL_CTX
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
3487 ssl_cert_set_cert_cb(c
->cert
, cb
, arg
);
3490 void SSL_set_cert_cb(SSL
*s
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
3492 ssl_cert_set_cert_cb(s
->cert
, cb
, arg
);
3495 void ssl_set_masks(SSL
*s
)
3498 uint32_t *pvalid
= s
->s3
.tmp
.valid_flags
;
3499 int rsa_enc
, rsa_sign
, dh_tmp
, dsa_sign
;
3500 unsigned long mask_k
, mask_a
;
3501 #ifndef OPENSSL_NO_EC
3502 int have_ecc_cert
, ecdsa_ok
;
3507 dh_tmp
= (c
->dh_tmp
!= NULL
3508 #ifndef OPENSSL_NO_DH
3509 || c
->dh_tmp_cb
!= NULL
3513 rsa_enc
= pvalid
[SSL_PKEY_RSA
] & CERT_PKEY_VALID
;
3514 rsa_sign
= pvalid
[SSL_PKEY_RSA
] & CERT_PKEY_VALID
;
3515 dsa_sign
= pvalid
[SSL_PKEY_DSA_SIGN
] & CERT_PKEY_VALID
;
3516 #ifndef OPENSSL_NO_EC
3517 have_ecc_cert
= pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_VALID
;
3522 OSSL_TRACE4(TLS_CIPHER
, "dh_tmp=%d rsa_enc=%d rsa_sign=%d dsa_sign=%d\n",
3523 dh_tmp
, rsa_enc
, rsa_sign
, dsa_sign
);
3525 #ifndef OPENSSL_NO_GOST
3526 if (ssl_has_cert(s
, SSL_PKEY_GOST12_512
)) {
3527 mask_k
|= SSL_kGOST
| SSL_kGOST18
;
3528 mask_a
|= SSL_aGOST12
;
3530 if (ssl_has_cert(s
, SSL_PKEY_GOST12_256
)) {
3531 mask_k
|= SSL_kGOST
| SSL_kGOST18
;
3532 mask_a
|= SSL_aGOST12
;
3534 if (ssl_has_cert(s
, SSL_PKEY_GOST01
)) {
3535 mask_k
|= SSL_kGOST
;
3536 mask_a
|= SSL_aGOST01
;
3547 * If we only have an RSA-PSS certificate allow RSA authentication
3548 * if TLS 1.2 and peer supports it.
3551 if (rsa_enc
|| rsa_sign
|| (ssl_has_cert(s
, SSL_PKEY_RSA_PSS_SIGN
)
3552 && pvalid
[SSL_PKEY_RSA_PSS_SIGN
] & CERT_PKEY_EXPLICIT_SIGN
3553 && TLS1_get_version(s
) == TLS1_2_VERSION
))
3560 mask_a
|= SSL_aNULL
;
3563 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3564 * depending on the key usage extension.
3566 #ifndef OPENSSL_NO_EC
3567 if (have_ecc_cert
) {
3569 ex_kusage
= X509_get_key_usage(c
->pkeys
[SSL_PKEY_ECC
].x509
);
3570 ecdsa_ok
= ex_kusage
& X509v3_KU_DIGITAL_SIGNATURE
;
3571 if (!(pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_SIGN
))
3574 mask_a
|= SSL_aECDSA
;
3576 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3577 if (!(mask_a
& SSL_aECDSA
) && ssl_has_cert(s
, SSL_PKEY_ED25519
)
3578 && pvalid
[SSL_PKEY_ED25519
] & CERT_PKEY_EXPLICIT_SIGN
3579 && TLS1_get_version(s
) == TLS1_2_VERSION
)
3580 mask_a
|= SSL_aECDSA
;
3582 /* Allow Ed448 for TLS 1.2 if peer supports it */
3583 if (!(mask_a
& SSL_aECDSA
) && ssl_has_cert(s
, SSL_PKEY_ED448
)
3584 && pvalid
[SSL_PKEY_ED448
] & CERT_PKEY_EXPLICIT_SIGN
3585 && TLS1_get_version(s
) == TLS1_2_VERSION
)
3586 mask_a
|= SSL_aECDSA
;
3589 #ifndef OPENSSL_NO_EC
3590 mask_k
|= SSL_kECDHE
;
3593 #ifndef OPENSSL_NO_PSK
3596 if (mask_k
& SSL_kRSA
)
3597 mask_k
|= SSL_kRSAPSK
;
3598 if (mask_k
& SSL_kDHE
)
3599 mask_k
|= SSL_kDHEPSK
;
3600 if (mask_k
& SSL_kECDHE
)
3601 mask_k
|= SSL_kECDHEPSK
;
3604 s
->s3
.tmp
.mask_k
= mask_k
;
3605 s
->s3
.tmp
.mask_a
= mask_a
;
3608 #ifndef OPENSSL_NO_EC
3610 int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
)
3612 if (s
->s3
.tmp
.new_cipher
->algorithm_auth
& SSL_aECDSA
) {
3613 /* key usage, if present, must allow signing */
3614 if (!(X509_get_key_usage(x
) & X509v3_KU_DIGITAL_SIGNATURE
)) {
3615 ERR_raise(ERR_LIB_SSL
, SSL_R_ECC_CERT_NOT_FOR_SIGNING
);
3619 return 1; /* all checks are ok */
3624 int ssl_get_server_cert_serverinfo(SSL
*s
, const unsigned char **serverinfo
,
3625 size_t *serverinfo_length
)
3627 CERT_PKEY
*cpk
= s
->s3
.tmp
.cert
;
3628 *serverinfo_length
= 0;
3630 if (cpk
== NULL
|| cpk
->serverinfo
== NULL
)
3633 *serverinfo
= cpk
->serverinfo
;
3634 *serverinfo_length
= cpk
->serverinfo_length
;
3638 void ssl_update_cache(SSL
*s
, int mode
)
3643 * If the session_id_length is 0, we are not supposed to cache it, and it
3644 * would be rather hard to do anyway :-)
3646 if (s
->session
->session_id_length
== 0)
3650 * If sid_ctx_length is 0 there is no specific application context
3651 * associated with this session, so when we try to resume it and
3652 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3653 * indication that this is actually a session for the proper application
3654 * context, and the *handshake* will fail, not just the resumption attempt.
3655 * Do not cache (on the server) these sessions that are not resumable
3656 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3658 if (s
->server
&& s
->session
->sid_ctx_length
== 0
3659 && (s
->verify_mode
& SSL_VERIFY_PEER
) != 0)
3662 i
= s
->session_ctx
->session_cache_mode
;
3664 && (!s
->hit
|| SSL_IS_TLS13(s
))) {
3666 * Add the session to the internal cache. In server side TLSv1.3 we
3667 * normally don't do this because by default it's a full stateless ticket
3668 * with only a dummy session id so there is no reason to cache it,
3670 * - we are doing early_data, in which case we cache so that we can
3672 * - the application has set a remove_session_cb so needs to know about
3673 * session timeout events
3674 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3676 if ((i
& SSL_SESS_CACHE_NO_INTERNAL_STORE
) == 0
3677 && (!SSL_IS_TLS13(s
)
3679 || (s
->max_early_data
> 0
3680 && (s
->options
& SSL_OP_NO_ANTI_REPLAY
) == 0)
3681 || s
->session_ctx
->remove_session_cb
!= NULL
3682 || (s
->options
& SSL_OP_NO_TICKET
) != 0))
3683 SSL_CTX_add_session(s
->session_ctx
, s
->session
);
3686 * Add the session to the external cache. We do this even in server side
3687 * TLSv1.3 without early data because some applications just want to
3688 * know about the creation of a session and aren't doing a full cache.
3690 if (s
->session_ctx
->new_session_cb
!= NULL
) {
3691 SSL_SESSION_up_ref(s
->session
);
3692 if (!s
->session_ctx
->new_session_cb(s
, s
->session
))
3693 SSL_SESSION_free(s
->session
);
3697 /* auto flush every 255 connections */
3698 if ((!(i
& SSL_SESS_CACHE_NO_AUTO_CLEAR
)) && ((i
& mode
) == mode
)) {
3699 TSAN_QUALIFIER
int *stat
;
3700 if (mode
& SSL_SESS_CACHE_CLIENT
)
3701 stat
= &s
->session_ctx
->stats
.sess_connect_good
;
3703 stat
= &s
->session_ctx
->stats
.sess_accept_good
;
3704 if ((tsan_load(stat
) & 0xff) == 0xff)
3705 SSL_CTX_flush_sessions(s
->session_ctx
, (unsigned long)time(NULL
));
3709 const SSL_METHOD
*SSL_CTX_get_ssl_method(const SSL_CTX
*ctx
)
3714 const SSL_METHOD
*SSL_get_ssl_method(const SSL
*s
)
3719 int SSL_set_ssl_method(SSL
*s
, const SSL_METHOD
*meth
)
3723 if (s
->method
!= meth
) {
3724 const SSL_METHOD
*sm
= s
->method
;
3725 int (*hf
) (SSL
*) = s
->handshake_func
;
3727 if (sm
->version
== meth
->version
)
3732 ret
= s
->method
->ssl_new(s
);
3735 if (hf
== sm
->ssl_connect
)
3736 s
->handshake_func
= meth
->ssl_connect
;
3737 else if (hf
== sm
->ssl_accept
)
3738 s
->handshake_func
= meth
->ssl_accept
;
3743 int SSL_get_error(const SSL
*s
, int i
)
3750 return SSL_ERROR_NONE
;
3753 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3754 * where we do encode the error
3756 if ((l
= ERR_peek_error()) != 0) {
3757 if (ERR_GET_LIB(l
) == ERR_LIB_SYS
)
3758 return SSL_ERROR_SYSCALL
;
3760 return SSL_ERROR_SSL
;
3763 if (SSL_want_read(s
)) {
3764 bio
= SSL_get_rbio(s
);
3765 if (BIO_should_read(bio
))
3766 return SSL_ERROR_WANT_READ
;
3767 else if (BIO_should_write(bio
))
3769 * This one doesn't make too much sense ... We never try to write
3770 * to the rbio, and an application program where rbio and wbio
3771 * are separate couldn't even know what it should wait for.
3772 * However if we ever set s->rwstate incorrectly (so that we have
3773 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3774 * wbio *are* the same, this test works around that bug; so it
3775 * might be safer to keep it.
3777 return SSL_ERROR_WANT_WRITE
;
3778 else if (BIO_should_io_special(bio
)) {
3779 reason
= BIO_get_retry_reason(bio
);
3780 if (reason
== BIO_RR_CONNECT
)
3781 return SSL_ERROR_WANT_CONNECT
;
3782 else if (reason
== BIO_RR_ACCEPT
)
3783 return SSL_ERROR_WANT_ACCEPT
;
3785 return SSL_ERROR_SYSCALL
; /* unknown */
3789 if (SSL_want_write(s
)) {
3790 /* Access wbio directly - in order to use the buffered bio if present */
3792 if (BIO_should_write(bio
))
3793 return SSL_ERROR_WANT_WRITE
;
3794 else if (BIO_should_read(bio
))
3796 * See above (SSL_want_read(s) with BIO_should_write(bio))
3798 return SSL_ERROR_WANT_READ
;
3799 else if (BIO_should_io_special(bio
)) {
3800 reason
= BIO_get_retry_reason(bio
);
3801 if (reason
== BIO_RR_CONNECT
)
3802 return SSL_ERROR_WANT_CONNECT
;
3803 else if (reason
== BIO_RR_ACCEPT
)
3804 return SSL_ERROR_WANT_ACCEPT
;
3806 return SSL_ERROR_SYSCALL
;
3809 if (SSL_want_x509_lookup(s
))
3810 return SSL_ERROR_WANT_X509_LOOKUP
;
3811 if (SSL_want_retry_verify(s
))
3812 return SSL_ERROR_WANT_RETRY_VERIFY
;
3813 if (SSL_want_async(s
))
3814 return SSL_ERROR_WANT_ASYNC
;
3815 if (SSL_want_async_job(s
))
3816 return SSL_ERROR_WANT_ASYNC_JOB
;
3817 if (SSL_want_client_hello_cb(s
))
3818 return SSL_ERROR_WANT_CLIENT_HELLO_CB
;
3820 if ((s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) &&
3821 (s
->s3
.warn_alert
== SSL_AD_CLOSE_NOTIFY
))
3822 return SSL_ERROR_ZERO_RETURN
;
3824 return SSL_ERROR_SYSCALL
;
3827 static int ssl_do_handshake_intern(void *vargs
)
3829 struct ssl_async_args
*args
;
3832 args
= (struct ssl_async_args
*)vargs
;
3835 return s
->handshake_func(s
);
3838 int SSL_do_handshake(SSL
*s
)
3842 if (s
->handshake_func
== NULL
) {
3843 ERR_raise(ERR_LIB_SSL
, SSL_R_CONNECTION_TYPE_NOT_SET
);
3847 ossl_statem_check_finish_init(s
, -1);
3849 s
->method
->ssl_renegotiate_check(s
, 0);
3851 if (SSL_in_init(s
) || SSL_in_before(s
)) {
3852 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
3853 struct ssl_async_args args
;
3857 ret
= ssl_start_async_job(s
, &args
, ssl_do_handshake_intern
);
3859 ret
= s
->handshake_func(s
);
3865 void SSL_set_accept_state(SSL
*s
)
3869 ossl_statem_clear(s
);
3870 s
->handshake_func
= s
->method
->ssl_accept
;
3874 void SSL_set_connect_state(SSL
*s
)
3878 ossl_statem_clear(s
);
3879 s
->handshake_func
= s
->method
->ssl_connect
;
3883 int ssl_undefined_function(SSL
*s
)
3885 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3889 int ssl_undefined_void_function(void)
3891 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3895 int ssl_undefined_const_function(const SSL
*s
)
3900 const SSL_METHOD
*ssl_bad_method(int ver
)
3902 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3906 const char *ssl_protocol_to_string(int version
)
3910 case TLS1_3_VERSION
:
3913 case TLS1_2_VERSION
:
3916 case TLS1_1_VERSION
:
3931 case DTLS1_2_VERSION
:
3939 const char *SSL_get_version(const SSL
*s
)
3941 return ssl_protocol_to_string(s
->version
);
3944 static int dup_ca_names(STACK_OF(X509_NAME
) **dst
, STACK_OF(X509_NAME
) *src
)
3946 STACK_OF(X509_NAME
) *sk
;
3955 if ((sk
= sk_X509_NAME_new_null()) == NULL
)
3957 for (i
= 0; i
< sk_X509_NAME_num(src
); i
++) {
3958 xn
= X509_NAME_dup(sk_X509_NAME_value(src
, i
));
3960 sk_X509_NAME_pop_free(sk
, X509_NAME_free
);
3963 if (sk_X509_NAME_insert(sk
, xn
, i
) == 0) {
3965 sk_X509_NAME_pop_free(sk
, X509_NAME_free
);
3974 SSL
*SSL_dup(SSL
*s
)
3979 /* If we're not quiescent, just up_ref! */
3980 if (!SSL_in_init(s
) || !SSL_in_before(s
)) {
3981 CRYPTO_UP_REF(&s
->references
, &i
, s
->lock
);
3986 * Otherwise, copy configuration state, and session if set.
3988 if ((ret
= SSL_new(SSL_get_SSL_CTX(s
))) == NULL
)
3991 if (s
->session
!= NULL
) {
3993 * Arranges to share the same session via up_ref. This "copies"
3994 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3996 if (!SSL_copy_session_id(ret
, s
))
4000 * No session has been established yet, so we have to expect that
4001 * s->cert or ret->cert will be changed later -- they should not both
4002 * point to the same object, and thus we can't use
4003 * SSL_copy_session_id.
4005 if (!SSL_set_ssl_method(ret
, s
->method
))
4008 if (s
->cert
!= NULL
) {
4009 ssl_cert_free(ret
->cert
);
4010 ret
->cert
= ssl_cert_dup(s
->cert
);
4011 if (ret
->cert
== NULL
)
4015 if (!SSL_set_session_id_context(ret
, s
->sid_ctx
,
4016 (int)s
->sid_ctx_length
))
4020 if (!ssl_dane_dup(ret
, s
))
4022 ret
->version
= s
->version
;
4023 ret
->options
= s
->options
;
4024 ret
->min_proto_version
= s
->min_proto_version
;
4025 ret
->max_proto_version
= s
->max_proto_version
;
4026 ret
->mode
= s
->mode
;
4027 SSL_set_max_cert_list(ret
, SSL_get_max_cert_list(s
));
4028 SSL_set_read_ahead(ret
, SSL_get_read_ahead(s
));
4029 ret
->msg_callback
= s
->msg_callback
;
4030 ret
->msg_callback_arg
= s
->msg_callback_arg
;
4031 SSL_set_verify(ret
, SSL_get_verify_mode(s
), SSL_get_verify_callback(s
));
4032 SSL_set_verify_depth(ret
, SSL_get_verify_depth(s
));
4033 ret
->generate_session_id
= s
->generate_session_id
;
4035 SSL_set_info_callback(ret
, SSL_get_info_callback(s
));
4037 /* copy app data, a little dangerous perhaps */
4038 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL
, &ret
->ex_data
, &s
->ex_data
))
4041 ret
->server
= s
->server
;
4042 if (s
->handshake_func
) {
4044 SSL_set_accept_state(ret
);
4046 SSL_set_connect_state(ret
);
4048 ret
->shutdown
= s
->shutdown
;
4051 ret
->default_passwd_callback
= s
->default_passwd_callback
;
4052 ret
->default_passwd_callback_userdata
= s
->default_passwd_callback_userdata
;
4054 X509_VERIFY_PARAM_inherit(ret
->param
, s
->param
);
4056 /* dup the cipher_list and cipher_list_by_id stacks */
4057 if (s
->cipher_list
!= NULL
) {
4058 if ((ret
->cipher_list
= sk_SSL_CIPHER_dup(s
->cipher_list
)) == NULL
)
4061 if (s
->cipher_list_by_id
!= NULL
)
4062 if ((ret
->cipher_list_by_id
= sk_SSL_CIPHER_dup(s
->cipher_list_by_id
))
4066 /* Dup the client_CA list */
4067 if (!dup_ca_names(&ret
->ca_names
, s
->ca_names
)
4068 || !dup_ca_names(&ret
->client_ca_names
, s
->client_ca_names
))
4078 void ssl_clear_cipher_ctx(SSL
*s
)
4080 if (s
->enc_read_ctx
!= NULL
) {
4081 EVP_CIPHER_CTX_free(s
->enc_read_ctx
);
4082 s
->enc_read_ctx
= NULL
;
4084 if (s
->enc_write_ctx
!= NULL
) {
4085 EVP_CIPHER_CTX_free(s
->enc_write_ctx
);
4086 s
->enc_write_ctx
= NULL
;
4088 #ifndef OPENSSL_NO_COMP
4089 COMP_CTX_free(s
->expand
);
4091 COMP_CTX_free(s
->compress
);
4096 X509
*SSL_get_certificate(const SSL
*s
)
4098 if (s
->cert
!= NULL
)
4099 return s
->cert
->key
->x509
;
4104 EVP_PKEY
*SSL_get_privatekey(const SSL
*s
)
4106 if (s
->cert
!= NULL
)
4107 return s
->cert
->key
->privatekey
;
4112 X509
*SSL_CTX_get0_certificate(const SSL_CTX
*ctx
)
4114 if (ctx
->cert
!= NULL
)
4115 return ctx
->cert
->key
->x509
;
4120 EVP_PKEY
*SSL_CTX_get0_privatekey(const SSL_CTX
*ctx
)
4122 if (ctx
->cert
!= NULL
)
4123 return ctx
->cert
->key
->privatekey
;
4128 const SSL_CIPHER
*SSL_get_current_cipher(const SSL
*s
)
4130 if ((s
->session
!= NULL
) && (s
->session
->cipher
!= NULL
))
4131 return s
->session
->cipher
;
4135 const SSL_CIPHER
*SSL_get_pending_cipher(const SSL
*s
)
4137 return s
->s3
.tmp
.new_cipher
;
4140 const COMP_METHOD
*SSL_get_current_compression(const SSL
*s
)
4142 #ifndef OPENSSL_NO_COMP
4143 return s
->compress
? COMP_CTX_get_method(s
->compress
) : NULL
;
4149 const COMP_METHOD
*SSL_get_current_expansion(const SSL
*s
)
4151 #ifndef OPENSSL_NO_COMP
4152 return s
->expand
? COMP_CTX_get_method(s
->expand
) : NULL
;
4158 int ssl_init_wbio_buffer(SSL
*s
)
4162 if (s
->bbio
!= NULL
) {
4163 /* Already buffered. */
4167 bbio
= BIO_new(BIO_f_buffer());
4168 if (bbio
== NULL
|| !BIO_set_read_buffer_size(bbio
, 1)) {
4170 ERR_raise(ERR_LIB_SSL
, ERR_R_BUF_LIB
);
4174 s
->wbio
= BIO_push(bbio
, s
->wbio
);
4179 int ssl_free_wbio_buffer(SSL
*s
)
4181 /* callers ensure s is never null */
4182 if (s
->bbio
== NULL
)
4185 s
->wbio
= BIO_pop(s
->wbio
);
4192 void SSL_CTX_set_quiet_shutdown(SSL_CTX
*ctx
, int mode
)
4194 ctx
->quiet_shutdown
= mode
;
4197 int SSL_CTX_get_quiet_shutdown(const SSL_CTX
*ctx
)
4199 return ctx
->quiet_shutdown
;
4202 void SSL_set_quiet_shutdown(SSL
*s
, int mode
)
4204 s
->quiet_shutdown
= mode
;
4207 int SSL_get_quiet_shutdown(const SSL
*s
)
4209 return s
->quiet_shutdown
;
4212 void SSL_set_shutdown(SSL
*s
, int mode
)
4217 int SSL_get_shutdown(const SSL
*s
)
4222 int SSL_version(const SSL
*s
)
4227 int SSL_client_version(const SSL
*s
)
4229 return s
->client_version
;
4232 SSL_CTX
*SSL_get_SSL_CTX(const SSL
*ssl
)
4237 SSL_CTX
*SSL_set_SSL_CTX(SSL
*ssl
, SSL_CTX
*ctx
)
4240 if (ssl
->ctx
== ctx
)
4243 ctx
= ssl
->session_ctx
;
4244 new_cert
= ssl_cert_dup(ctx
->cert
);
4245 if (new_cert
== NULL
) {
4249 if (!custom_exts_copy_flags(&new_cert
->custext
, &ssl
->cert
->custext
)) {
4250 ssl_cert_free(new_cert
);
4254 ssl_cert_free(ssl
->cert
);
4255 ssl
->cert
= new_cert
;
4258 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
4259 * so setter APIs must prevent invalid lengths from entering the system.
4261 if (!ossl_assert(ssl
->sid_ctx_length
<= sizeof(ssl
->sid_ctx
)))
4265 * If the session ID context matches that of the parent SSL_CTX,
4266 * inherit it from the new SSL_CTX as well. If however the context does
4267 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4268 * leave it unchanged.
4270 if ((ssl
->ctx
!= NULL
) &&
4271 (ssl
->sid_ctx_length
== ssl
->ctx
->sid_ctx_length
) &&
4272 (memcmp(ssl
->sid_ctx
, ssl
->ctx
->sid_ctx
, ssl
->sid_ctx_length
) == 0)) {
4273 ssl
->sid_ctx_length
= ctx
->sid_ctx_length
;
4274 memcpy(&ssl
->sid_ctx
, &ctx
->sid_ctx
, sizeof(ssl
->sid_ctx
));
4277 SSL_CTX_up_ref(ctx
);
4278 SSL_CTX_free(ssl
->ctx
); /* decrement reference count */
4284 int SSL_CTX_set_default_verify_paths(SSL_CTX
*ctx
)
4286 return X509_STORE_set_default_paths_ex(ctx
->cert_store
, ctx
->libctx
,
4290 int SSL_CTX_set_default_verify_dir(SSL_CTX
*ctx
)
4292 X509_LOOKUP
*lookup
;
4294 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_hash_dir());
4298 /* We ignore errors, in case the directory doesn't exist */
4301 X509_LOOKUP_add_dir(lookup
, NULL
, X509_FILETYPE_DEFAULT
);
4308 int SSL_CTX_set_default_verify_file(SSL_CTX
*ctx
)
4310 X509_LOOKUP
*lookup
;
4312 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_file());
4316 /* We ignore errors, in case the directory doesn't exist */
4319 X509_LOOKUP_load_file_ex(lookup
, NULL
, X509_FILETYPE_DEFAULT
, ctx
->libctx
,
4327 int SSL_CTX_set_default_verify_store(SSL_CTX
*ctx
)
4329 X509_LOOKUP
*lookup
;
4331 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_store());
4335 /* We ignore errors, in case the directory doesn't exist */
4338 X509_LOOKUP_add_store_ex(lookup
, NULL
, ctx
->libctx
, ctx
->propq
);
4345 int SSL_CTX_load_verify_file(SSL_CTX
*ctx
, const char *CAfile
)
4347 return X509_STORE_load_file_ex(ctx
->cert_store
, CAfile
, ctx
->libctx
,
4351 int SSL_CTX_load_verify_dir(SSL_CTX
*ctx
, const char *CApath
)
4353 return X509_STORE_load_path(ctx
->cert_store
, CApath
);
4356 int SSL_CTX_load_verify_store(SSL_CTX
*ctx
, const char *CAstore
)
4358 return X509_STORE_load_store_ex(ctx
->cert_store
, CAstore
, ctx
->libctx
,
4362 int SSL_CTX_load_verify_locations(SSL_CTX
*ctx
, const char *CAfile
,
4365 if (CAfile
== NULL
&& CApath
== NULL
)
4367 if (CAfile
!= NULL
&& !SSL_CTX_load_verify_file(ctx
, CAfile
))
4369 if (CApath
!= NULL
&& !SSL_CTX_load_verify_dir(ctx
, CApath
))
4374 void SSL_set_info_callback(SSL
*ssl
,
4375 void (*cb
) (const SSL
*ssl
, int type
, int val
))
4377 ssl
->info_callback
= cb
;
4381 * One compiler (Diab DCC) doesn't like argument names in returned function
4384 void (*SSL_get_info_callback(const SSL
*ssl
)) (const SSL
* /* ssl */ ,
4387 return ssl
->info_callback
;
4390 void SSL_set_verify_result(SSL
*ssl
, long arg
)
4392 ssl
->verify_result
= arg
;
4395 long SSL_get_verify_result(const SSL
*ssl
)
4397 return ssl
->verify_result
;
4400 size_t SSL_get_client_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
4403 return sizeof(ssl
->s3
.client_random
);
4404 if (outlen
> sizeof(ssl
->s3
.client_random
))
4405 outlen
= sizeof(ssl
->s3
.client_random
);
4406 memcpy(out
, ssl
->s3
.client_random
, outlen
);
4410 size_t SSL_get_server_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
4413 return sizeof(ssl
->s3
.server_random
);
4414 if (outlen
> sizeof(ssl
->s3
.server_random
))
4415 outlen
= sizeof(ssl
->s3
.server_random
);
4416 memcpy(out
, ssl
->s3
.server_random
, outlen
);
4420 size_t SSL_SESSION_get_master_key(const SSL_SESSION
*session
,
4421 unsigned char *out
, size_t outlen
)
4424 return session
->master_key_length
;
4425 if (outlen
> session
->master_key_length
)
4426 outlen
= session
->master_key_length
;
4427 memcpy(out
, session
->master_key
, outlen
);
4431 int SSL_SESSION_set1_master_key(SSL_SESSION
*sess
, const unsigned char *in
,
4434 if (len
> sizeof(sess
->master_key
))
4437 memcpy(sess
->master_key
, in
, len
);
4438 sess
->master_key_length
= len
;
4443 int SSL_set_ex_data(SSL
*s
, int idx
, void *arg
)
4445 return CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
);
4448 void *SSL_get_ex_data(const SSL
*s
, int idx
)
4450 return CRYPTO_get_ex_data(&s
->ex_data
, idx
);
4453 int SSL_CTX_set_ex_data(SSL_CTX
*s
, int idx
, void *arg
)
4455 return CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
);
4458 void *SSL_CTX_get_ex_data(const SSL_CTX
*s
, int idx
)
4460 return CRYPTO_get_ex_data(&s
->ex_data
, idx
);
4463 X509_STORE
*SSL_CTX_get_cert_store(const SSL_CTX
*ctx
)
4465 return ctx
->cert_store
;
4468 void SSL_CTX_set_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
4470 X509_STORE_free(ctx
->cert_store
);
4471 ctx
->cert_store
= store
;
4474 void SSL_CTX_set1_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
4477 X509_STORE_up_ref(store
);
4478 SSL_CTX_set_cert_store(ctx
, store
);
4481 int SSL_want(const SSL
*s
)
4487 * \brief Set the callback for generating temporary DH keys.
4488 * \param ctx the SSL context.
4489 * \param dh the callback
4492 #if !defined(OPENSSL_NO_DH) && !defined(OPENSSL_NO_DEPRECATED_3_0)
4493 void SSL_CTX_set_tmp_dh_callback(SSL_CTX
*ctx
,
4494 DH
*(*dh
) (SSL
*ssl
, int is_export
,
4497 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_TMP_DH_CB
, (void (*)(void))dh
);
4500 void SSL_set_tmp_dh_callback(SSL
*ssl
, DH
*(*dh
) (SSL
*ssl
, int is_export
,
4503 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_TMP_DH_CB
, (void (*)(void))dh
);
4507 #ifndef OPENSSL_NO_PSK
4508 int SSL_CTX_use_psk_identity_hint(SSL_CTX
*ctx
, const char *identity_hint
)
4510 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
4511 ERR_raise(ERR_LIB_SSL
, SSL_R_DATA_LENGTH_TOO_LONG
);
4514 OPENSSL_free(ctx
->cert
->psk_identity_hint
);
4515 if (identity_hint
!= NULL
) {
4516 ctx
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
4517 if (ctx
->cert
->psk_identity_hint
== NULL
)
4520 ctx
->cert
->psk_identity_hint
= NULL
;
4524 int SSL_use_psk_identity_hint(SSL
*s
, const char *identity_hint
)
4529 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
4530 ERR_raise(ERR_LIB_SSL
, SSL_R_DATA_LENGTH_TOO_LONG
);
4533 OPENSSL_free(s
->cert
->psk_identity_hint
);
4534 if (identity_hint
!= NULL
) {
4535 s
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
4536 if (s
->cert
->psk_identity_hint
== NULL
)
4539 s
->cert
->psk_identity_hint
= NULL
;
4543 const char *SSL_get_psk_identity_hint(const SSL
*s
)
4545 if (s
== NULL
|| s
->session
== NULL
)
4547 return s
->session
->psk_identity_hint
;
4550 const char *SSL_get_psk_identity(const SSL
*s
)
4552 if (s
== NULL
|| s
->session
== NULL
)
4554 return s
->session
->psk_identity
;
4557 void SSL_set_psk_client_callback(SSL
*s
, SSL_psk_client_cb_func cb
)
4559 s
->psk_client_callback
= cb
;
4562 void SSL_CTX_set_psk_client_callback(SSL_CTX
*ctx
, SSL_psk_client_cb_func cb
)
4564 ctx
->psk_client_callback
= cb
;
4567 void SSL_set_psk_server_callback(SSL
*s
, SSL_psk_server_cb_func cb
)
4569 s
->psk_server_callback
= cb
;
4572 void SSL_CTX_set_psk_server_callback(SSL_CTX
*ctx
, SSL_psk_server_cb_func cb
)
4574 ctx
->psk_server_callback
= cb
;
4578 void SSL_set_psk_find_session_callback(SSL
*s
, SSL_psk_find_session_cb_func cb
)
4580 s
->psk_find_session_cb
= cb
;
4583 void SSL_CTX_set_psk_find_session_callback(SSL_CTX
*ctx
,
4584 SSL_psk_find_session_cb_func cb
)
4586 ctx
->psk_find_session_cb
= cb
;
4589 void SSL_set_psk_use_session_callback(SSL
*s
, SSL_psk_use_session_cb_func cb
)
4591 s
->psk_use_session_cb
= cb
;
4594 void SSL_CTX_set_psk_use_session_callback(SSL_CTX
*ctx
,
4595 SSL_psk_use_session_cb_func cb
)
4597 ctx
->psk_use_session_cb
= cb
;
4600 void SSL_CTX_set_msg_callback(SSL_CTX
*ctx
,
4601 void (*cb
) (int write_p
, int version
,
4602 int content_type
, const void *buf
,
4603 size_t len
, SSL
*ssl
, void *arg
))
4605 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
4608 void SSL_set_msg_callback(SSL
*ssl
,
4609 void (*cb
) (int write_p
, int version
,
4610 int content_type
, const void *buf
,
4611 size_t len
, SSL
*ssl
, void *arg
))
4613 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
4616 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX
*ctx
,
4617 int (*cb
) (SSL
*ssl
,
4621 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
4622 (void (*)(void))cb
);
4625 void SSL_set_not_resumable_session_callback(SSL
*ssl
,
4626 int (*cb
) (SSL
*ssl
,
4627 int is_forward_secure
))
4629 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
4630 (void (*)(void))cb
);
4633 void SSL_CTX_set_record_padding_callback(SSL_CTX
*ctx
,
4634 size_t (*cb
) (SSL
*ssl
, int type
,
4635 size_t len
, void *arg
))
4637 ctx
->record_padding_cb
= cb
;
4640 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX
*ctx
, void *arg
)
4642 ctx
->record_padding_arg
= arg
;
4645 void *SSL_CTX_get_record_padding_callback_arg(const SSL_CTX
*ctx
)
4647 return ctx
->record_padding_arg
;
4650 int SSL_CTX_set_block_padding(SSL_CTX
*ctx
, size_t block_size
)
4652 /* block size of 0 or 1 is basically no padding */
4653 if (block_size
== 1)
4654 ctx
->block_padding
= 0;
4655 else if (block_size
<= SSL3_RT_MAX_PLAIN_LENGTH
)
4656 ctx
->block_padding
= block_size
;
4662 int SSL_set_record_padding_callback(SSL
*ssl
,
4663 size_t (*cb
) (SSL
*ssl
, int type
,
4664 size_t len
, void *arg
))
4668 b
= SSL_get_wbio(ssl
);
4669 if (b
== NULL
|| !BIO_get_ktls_send(b
)) {
4670 ssl
->record_padding_cb
= cb
;
4676 void SSL_set_record_padding_callback_arg(SSL
*ssl
, void *arg
)
4678 ssl
->record_padding_arg
= arg
;
4681 void *SSL_get_record_padding_callback_arg(const SSL
*ssl
)
4683 return ssl
->record_padding_arg
;
4686 int SSL_set_block_padding(SSL
*ssl
, size_t block_size
)
4688 /* block size of 0 or 1 is basically no padding */
4689 if (block_size
== 1)
4690 ssl
->block_padding
= 0;
4691 else if (block_size
<= SSL3_RT_MAX_PLAIN_LENGTH
)
4692 ssl
->block_padding
= block_size
;
4698 int SSL_set_num_tickets(SSL
*s
, size_t num_tickets
)
4700 s
->num_tickets
= num_tickets
;
4705 size_t SSL_get_num_tickets(const SSL
*s
)
4707 return s
->num_tickets
;
4710 int SSL_CTX_set_num_tickets(SSL_CTX
*ctx
, size_t num_tickets
)
4712 ctx
->num_tickets
= num_tickets
;
4717 size_t SSL_CTX_get_num_tickets(const SSL_CTX
*ctx
)
4719 return ctx
->num_tickets
;
4723 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4724 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4725 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4726 * Returns the newly allocated ctx;
4729 EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
)
4731 ssl_clear_hash_ctx(hash
);
4732 *hash
= EVP_MD_CTX_new();
4733 if (*hash
== NULL
|| (md
&& EVP_DigestInit_ex(*hash
, md
, NULL
) <= 0)) {
4734 EVP_MD_CTX_free(*hash
);
4741 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
)
4744 EVP_MD_CTX_free(*hash
);
4748 /* Retrieve handshake hashes */
4749 int ssl_handshake_hash(SSL
*s
, unsigned char *out
, size_t outlen
,
4752 EVP_MD_CTX
*ctx
= NULL
;
4753 EVP_MD_CTX
*hdgst
= s
->s3
.handshake_dgst
;
4754 int hashleni
= EVP_MD_CTX_size(hdgst
);
4757 if (hashleni
< 0 || (size_t)hashleni
> outlen
) {
4758 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
4762 ctx
= EVP_MD_CTX_new();
4766 if (!EVP_MD_CTX_copy_ex(ctx
, hdgst
)
4767 || EVP_DigestFinal_ex(ctx
, out
, NULL
) <= 0) {
4768 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
4772 *hashlen
= hashleni
;
4776 EVP_MD_CTX_free(ctx
);
4780 int SSL_session_reused(const SSL
*s
)
4785 int SSL_is_server(const SSL
*s
)
4790 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
4791 void SSL_set_debug(SSL
*s
, int debug
)
4793 /* Old function was do-nothing anyway... */
4799 void SSL_set_security_level(SSL
*s
, int level
)
4801 s
->cert
->sec_level
= level
;
4804 int SSL_get_security_level(const SSL
*s
)
4806 return s
->cert
->sec_level
;
4809 void SSL_set_security_callback(SSL
*s
,
4810 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
4811 int op
, int bits
, int nid
,
4812 void *other
, void *ex
))
4814 s
->cert
->sec_cb
= cb
;
4817 int (*SSL_get_security_callback(const SSL
*s
)) (const SSL
*s
,
4818 const SSL_CTX
*ctx
, int op
,
4819 int bits
, int nid
, void *other
,
4821 return s
->cert
->sec_cb
;
4824 void SSL_set0_security_ex_data(SSL
*s
, void *ex
)
4826 s
->cert
->sec_ex
= ex
;
4829 void *SSL_get0_security_ex_data(const SSL
*s
)
4831 return s
->cert
->sec_ex
;
4834 void SSL_CTX_set_security_level(SSL_CTX
*ctx
, int level
)
4836 ctx
->cert
->sec_level
= level
;
4839 int SSL_CTX_get_security_level(const SSL_CTX
*ctx
)
4841 return ctx
->cert
->sec_level
;
4844 void SSL_CTX_set_security_callback(SSL_CTX
*ctx
,
4845 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
4846 int op
, int bits
, int nid
,
4847 void *other
, void *ex
))
4849 ctx
->cert
->sec_cb
= cb
;
4852 int (*SSL_CTX_get_security_callback(const SSL_CTX
*ctx
)) (const SSL
*s
,
4858 return ctx
->cert
->sec_cb
;
4861 void SSL_CTX_set0_security_ex_data(SSL_CTX
*ctx
, void *ex
)
4863 ctx
->cert
->sec_ex
= ex
;
4866 void *SSL_CTX_get0_security_ex_data(const SSL_CTX
*ctx
)
4868 return ctx
->cert
->sec_ex
;
4872 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4873 * can return unsigned long, instead of the generic long return value from the
4874 * control interface.
4876 unsigned long SSL_CTX_get_options(const SSL_CTX
*ctx
)
4878 return ctx
->options
;
4881 unsigned long SSL_get_options(const SSL
*s
)
4886 unsigned long SSL_CTX_set_options(SSL_CTX
*ctx
, unsigned long op
)
4888 return ctx
->options
|= op
;
4891 unsigned long SSL_set_options(SSL
*s
, unsigned long op
)
4893 return s
->options
|= op
;
4896 unsigned long SSL_CTX_clear_options(SSL_CTX
*ctx
, unsigned long op
)
4898 return ctx
->options
&= ~op
;
4901 unsigned long SSL_clear_options(SSL
*s
, unsigned long op
)
4903 return s
->options
&= ~op
;
4906 STACK_OF(X509
) *SSL_get0_verified_chain(const SSL
*s
)
4908 return s
->verified_chain
;
4911 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
4913 #ifndef OPENSSL_NO_CT
4916 * Moves SCTs from the |src| stack to the |dst| stack.
4917 * The source of each SCT will be set to |origin|.
4918 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4920 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4922 static int ct_move_scts(STACK_OF(SCT
) **dst
, STACK_OF(SCT
) *src
,
4923 sct_source_t origin
)
4929 *dst
= sk_SCT_new_null();
4931 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
4936 while ((sct
= sk_SCT_pop(src
)) != NULL
) {
4937 if (SCT_set_source(sct
, origin
) != 1)
4940 if (sk_SCT_push(*dst
, sct
) <= 0)
4948 sk_SCT_push(src
, sct
); /* Put the SCT back */
4953 * Look for data collected during ServerHello and parse if found.
4954 * Returns the number of SCTs extracted.
4956 static int ct_extract_tls_extension_scts(SSL
*s
)
4958 int scts_extracted
= 0;
4960 if (s
->ext
.scts
!= NULL
) {
4961 const unsigned char *p
= s
->ext
.scts
;
4962 STACK_OF(SCT
) *scts
= o2i_SCT_LIST(NULL
, &p
, s
->ext
.scts_len
);
4964 scts_extracted
= ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_TLS_EXTENSION
);
4966 SCT_LIST_free(scts
);
4969 return scts_extracted
;
4973 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4974 * contains an SCT X509 extension. They will be stored in |s->scts|.
4976 * - The number of SCTs extracted, assuming an OCSP response exists.
4977 * - 0 if no OCSP response exists or it contains no SCTs.
4978 * - A negative integer if an error occurs.
4980 static int ct_extract_ocsp_response_scts(SSL
*s
)
4982 # ifndef OPENSSL_NO_OCSP
4983 int scts_extracted
= 0;
4984 const unsigned char *p
;
4985 OCSP_BASICRESP
*br
= NULL
;
4986 OCSP_RESPONSE
*rsp
= NULL
;
4987 STACK_OF(SCT
) *scts
= NULL
;
4990 if (s
->ext
.ocsp
.resp
== NULL
|| s
->ext
.ocsp
.resp_len
== 0)
4993 p
= s
->ext
.ocsp
.resp
;
4994 rsp
= d2i_OCSP_RESPONSE(NULL
, &p
, (int)s
->ext
.ocsp
.resp_len
);
4998 br
= OCSP_response_get1_basic(rsp
);
5002 for (i
= 0; i
< OCSP_resp_count(br
); ++i
) {
5003 OCSP_SINGLERESP
*single
= OCSP_resp_get0(br
, i
);
5009 OCSP_SINGLERESP_get1_ext_d2i(single
, NID_ct_cert_scts
, NULL
, NULL
);
5011 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_OCSP_STAPLED_RESPONSE
);
5012 if (scts_extracted
< 0)
5016 SCT_LIST_free(scts
);
5017 OCSP_BASICRESP_free(br
);
5018 OCSP_RESPONSE_free(rsp
);
5019 return scts_extracted
;
5021 /* Behave as if no OCSP response exists */
5027 * Attempts to extract SCTs from the peer certificate.
5028 * Return the number of SCTs extracted, or a negative integer if an error
5031 static int ct_extract_x509v3_extension_scts(SSL
*s
)
5033 int scts_extracted
= 0;
5034 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
5037 STACK_OF(SCT
) *scts
=
5038 X509_get_ext_d2i(cert
, NID_ct_precert_scts
, NULL
, NULL
);
5041 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_X509V3_EXTENSION
);
5043 SCT_LIST_free(scts
);
5046 return scts_extracted
;
5050 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
5051 * response (if it exists) and X509v3 extensions in the certificate.
5052 * Returns NULL if an error occurs.
5054 const STACK_OF(SCT
) *SSL_get0_peer_scts(SSL
*s
)
5056 if (!s
->scts_parsed
) {
5057 if (ct_extract_tls_extension_scts(s
) < 0 ||
5058 ct_extract_ocsp_response_scts(s
) < 0 ||
5059 ct_extract_x509v3_extension_scts(s
) < 0)
5069 static int ct_permissive(const CT_POLICY_EVAL_CTX
* ctx
,
5070 const STACK_OF(SCT
) *scts
, void *unused_arg
)
5075 static int ct_strict(const CT_POLICY_EVAL_CTX
* ctx
,
5076 const STACK_OF(SCT
) *scts
, void *unused_arg
)
5078 int count
= scts
!= NULL
? sk_SCT_num(scts
) : 0;
5081 for (i
= 0; i
< count
; ++i
) {
5082 SCT
*sct
= sk_SCT_value(scts
, i
);
5083 int status
= SCT_get_validation_status(sct
);
5085 if (status
== SCT_VALIDATION_STATUS_VALID
)
5088 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_VALID_SCTS
);
5092 int SSL_set_ct_validation_callback(SSL
*s
, ssl_ct_validation_cb callback
,
5096 * Since code exists that uses the custom extension handler for CT, look
5097 * for this and throw an error if they have already registered to use CT.
5099 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(s
->ctx
,
5100 TLSEXT_TYPE_signed_certificate_timestamp
))
5102 ERR_raise(ERR_LIB_SSL
, SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
5106 if (callback
!= NULL
) {
5108 * If we are validating CT, then we MUST accept SCTs served via OCSP
5110 if (!SSL_set_tlsext_status_type(s
, TLSEXT_STATUSTYPE_ocsp
))
5114 s
->ct_validation_callback
= callback
;
5115 s
->ct_validation_callback_arg
= arg
;
5120 int SSL_CTX_set_ct_validation_callback(SSL_CTX
*ctx
,
5121 ssl_ct_validation_cb callback
, void *arg
)
5124 * Since code exists that uses the custom extension handler for CT, look for
5125 * this and throw an error if they have already registered to use CT.
5127 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(ctx
,
5128 TLSEXT_TYPE_signed_certificate_timestamp
))
5130 ERR_raise(ERR_LIB_SSL
, SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
5134 ctx
->ct_validation_callback
= callback
;
5135 ctx
->ct_validation_callback_arg
= arg
;
5139 int SSL_ct_is_enabled(const SSL
*s
)
5141 return s
->ct_validation_callback
!= NULL
;
5144 int SSL_CTX_ct_is_enabled(const SSL_CTX
*ctx
)
5146 return ctx
->ct_validation_callback
!= NULL
;
5149 int ssl_validate_ct(SSL
*s
)
5152 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
5154 SSL_DANE
*dane
= &s
->dane
;
5155 CT_POLICY_EVAL_CTX
*ctx
= NULL
;
5156 const STACK_OF(SCT
) *scts
;
5159 * If no callback is set, the peer is anonymous, or its chain is invalid,
5160 * skip SCT validation - just return success. Applications that continue
5161 * handshakes without certificates, with unverified chains, or pinned leaf
5162 * certificates are outside the scope of the WebPKI and CT.
5164 * The above exclusions notwithstanding the vast majority of peers will
5165 * have rather ordinary certificate chains validated by typical
5166 * applications that perform certificate verification and therefore will
5167 * process SCTs when enabled.
5169 if (s
->ct_validation_callback
== NULL
|| cert
== NULL
||
5170 s
->verify_result
!= X509_V_OK
||
5171 s
->verified_chain
== NULL
|| sk_X509_num(s
->verified_chain
) <= 1)
5175 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
5176 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
5178 if (DANETLS_ENABLED(dane
) && dane
->mtlsa
!= NULL
) {
5179 switch (dane
->mtlsa
->usage
) {
5180 case DANETLS_USAGE_DANE_TA
:
5181 case DANETLS_USAGE_DANE_EE
:
5186 ctx
= CT_POLICY_EVAL_CTX_new_ex(s
->ctx
->libctx
, s
->ctx
->propq
);
5188 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5192 issuer
= sk_X509_value(s
->verified_chain
, 1);
5193 CT_POLICY_EVAL_CTX_set1_cert(ctx
, cert
);
5194 CT_POLICY_EVAL_CTX_set1_issuer(ctx
, issuer
);
5195 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx
, s
->ctx
->ctlog_store
);
5196 CT_POLICY_EVAL_CTX_set_time(
5197 ctx
, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s
)) * 1000);
5199 scts
= SSL_get0_peer_scts(s
);
5202 * This function returns success (> 0) only when all the SCTs are valid, 0
5203 * when some are invalid, and < 0 on various internal errors (out of
5204 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
5205 * reason to abort the handshake, that decision is up to the callback.
5206 * Therefore, we error out only in the unexpected case that the return
5207 * value is negative.
5209 * XXX: One might well argue that the return value of this function is an
5210 * unfortunate design choice. Its job is only to determine the validation
5211 * status of each of the provided SCTs. So long as it correctly separates
5212 * the wheat from the chaff it should return success. Failure in this case
5213 * ought to correspond to an inability to carry out its duties.
5215 if (SCT_LIST_validate(scts
, ctx
) < 0) {
5216 SSLfatal(s
, SSL_AD_HANDSHAKE_FAILURE
, SSL_R_SCT_VERIFICATION_FAILED
);
5220 ret
= s
->ct_validation_callback(ctx
, scts
, s
->ct_validation_callback_arg
);
5222 ret
= 0; /* This function returns 0 on failure */
5224 SSLfatal(s
, SSL_AD_HANDSHAKE_FAILURE
, SSL_R_CALLBACK_FAILED
);
5227 CT_POLICY_EVAL_CTX_free(ctx
);
5229 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
5230 * failure return code here. Also the application may wish the complete
5231 * the handshake, and then disconnect cleanly at a higher layer, after
5232 * checking the verification status of the completed connection.
5234 * We therefore force a certificate verification failure which will be
5235 * visible via SSL_get_verify_result() and cached as part of any resumed
5238 * Note: the permissive callback is for information gathering only, always
5239 * returns success, and does not affect verification status. Only the
5240 * strict callback or a custom application-specified callback can trigger
5241 * connection failure or record a verification error.
5244 s
->verify_result
= X509_V_ERR_NO_VALID_SCTS
;
5248 int SSL_CTX_enable_ct(SSL_CTX
*ctx
, int validation_mode
)
5250 switch (validation_mode
) {
5252 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
5254 case SSL_CT_VALIDATION_PERMISSIVE
:
5255 return SSL_CTX_set_ct_validation_callback(ctx
, ct_permissive
, NULL
);
5256 case SSL_CT_VALIDATION_STRICT
:
5257 return SSL_CTX_set_ct_validation_callback(ctx
, ct_strict
, NULL
);
5261 int SSL_enable_ct(SSL
*s
, int validation_mode
)
5263 switch (validation_mode
) {
5265 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
5267 case SSL_CT_VALIDATION_PERMISSIVE
:
5268 return SSL_set_ct_validation_callback(s
, ct_permissive
, NULL
);
5269 case SSL_CT_VALIDATION_STRICT
:
5270 return SSL_set_ct_validation_callback(s
, ct_strict
, NULL
);
5274 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX
*ctx
)
5276 return CTLOG_STORE_load_default_file(ctx
->ctlog_store
);
5279 int SSL_CTX_set_ctlog_list_file(SSL_CTX
*ctx
, const char *path
)
5281 return CTLOG_STORE_load_file(ctx
->ctlog_store
, path
);
5284 void SSL_CTX_set0_ctlog_store(SSL_CTX
*ctx
, CTLOG_STORE
* logs
)
5286 CTLOG_STORE_free(ctx
->ctlog_store
);
5287 ctx
->ctlog_store
= logs
;
5290 const CTLOG_STORE
*SSL_CTX_get0_ctlog_store(const SSL_CTX
*ctx
)
5292 return ctx
->ctlog_store
;
5295 #endif /* OPENSSL_NO_CT */
5297 void SSL_CTX_set_client_hello_cb(SSL_CTX
*c
, SSL_client_hello_cb_fn cb
,
5300 c
->client_hello_cb
= cb
;
5301 c
->client_hello_cb_arg
= arg
;
5304 int SSL_client_hello_isv2(SSL
*s
)
5306 if (s
->clienthello
== NULL
)
5308 return s
->clienthello
->isv2
;
5311 unsigned int SSL_client_hello_get0_legacy_version(SSL
*s
)
5313 if (s
->clienthello
== NULL
)
5315 return s
->clienthello
->legacy_version
;
5318 size_t SSL_client_hello_get0_random(SSL
*s
, const unsigned char **out
)
5320 if (s
->clienthello
== NULL
)
5323 *out
= s
->clienthello
->random
;
5324 return SSL3_RANDOM_SIZE
;
5327 size_t SSL_client_hello_get0_session_id(SSL
*s
, const unsigned char **out
)
5329 if (s
->clienthello
== NULL
)
5332 *out
= s
->clienthello
->session_id
;
5333 return s
->clienthello
->session_id_len
;
5336 size_t SSL_client_hello_get0_ciphers(SSL
*s
, const unsigned char **out
)
5338 if (s
->clienthello
== NULL
)
5341 *out
= PACKET_data(&s
->clienthello
->ciphersuites
);
5342 return PACKET_remaining(&s
->clienthello
->ciphersuites
);
5345 size_t SSL_client_hello_get0_compression_methods(SSL
*s
, const unsigned char **out
)
5347 if (s
->clienthello
== NULL
)
5350 *out
= s
->clienthello
->compressions
;
5351 return s
->clienthello
->compressions_len
;
5354 int SSL_client_hello_get1_extensions_present(SSL
*s
, int **out
, size_t *outlen
)
5360 if (s
->clienthello
== NULL
|| out
== NULL
|| outlen
== NULL
)
5362 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; i
++) {
5363 ext
= s
->clienthello
->pre_proc_exts
+ i
;
5372 if ((present
= OPENSSL_malloc(sizeof(*present
) * num
)) == NULL
) {
5373 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
5376 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; i
++) {
5377 ext
= s
->clienthello
->pre_proc_exts
+ i
;
5379 if (ext
->received_order
>= num
)
5381 present
[ext
->received_order
] = ext
->type
;
5388 OPENSSL_free(present
);
5392 int SSL_client_hello_get0_ext(SSL
*s
, unsigned int type
, const unsigned char **out
,
5398 if (s
->clienthello
== NULL
)
5400 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; ++i
) {
5401 r
= s
->clienthello
->pre_proc_exts
+ i
;
5402 if (r
->present
&& r
->type
== type
) {
5404 *out
= PACKET_data(&r
->data
);
5406 *outlen
= PACKET_remaining(&r
->data
);
5413 int SSL_free_buffers(SSL
*ssl
)
5415 RECORD_LAYER
*rl
= &ssl
->rlayer
;
5417 if (RECORD_LAYER_read_pending(rl
) || RECORD_LAYER_write_pending(rl
))
5420 RECORD_LAYER_release(rl
);
5424 int SSL_alloc_buffers(SSL
*ssl
)
5426 return ssl3_setup_buffers(ssl
);
5429 void SSL_CTX_set_keylog_callback(SSL_CTX
*ctx
, SSL_CTX_keylog_cb_func cb
)
5431 ctx
->keylog_callback
= cb
;
5434 SSL_CTX_keylog_cb_func
SSL_CTX_get_keylog_callback(const SSL_CTX
*ctx
)
5436 return ctx
->keylog_callback
;
5439 static int nss_keylog_int(const char *prefix
,
5441 const uint8_t *parameter_1
,
5442 size_t parameter_1_len
,
5443 const uint8_t *parameter_2
,
5444 size_t parameter_2_len
)
5447 char *cursor
= NULL
;
5452 if (ssl
->ctx
->keylog_callback
== NULL
)
5456 * Our output buffer will contain the following strings, rendered with
5457 * space characters in between, terminated by a NULL character: first the
5458 * prefix, then the first parameter, then the second parameter. The
5459 * meaning of each parameter depends on the specific key material being
5460 * logged. Note that the first and second parameters are encoded in
5461 * hexadecimal, so we need a buffer that is twice their lengths.
5463 prefix_len
= strlen(prefix
);
5464 out_len
= prefix_len
+ (2 * parameter_1_len
) + (2 * parameter_2_len
) + 3;
5465 if ((out
= cursor
= OPENSSL_malloc(out_len
)) == NULL
) {
5466 SSLfatal(ssl
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5470 strcpy(cursor
, prefix
);
5471 cursor
+= prefix_len
;
5474 for (i
= 0; i
< parameter_1_len
; i
++) {
5475 sprintf(cursor
, "%02x", parameter_1
[i
]);
5480 for (i
= 0; i
< parameter_2_len
; i
++) {
5481 sprintf(cursor
, "%02x", parameter_2
[i
]);
5486 ssl
->ctx
->keylog_callback(ssl
, (const char *)out
);
5487 OPENSSL_clear_free(out
, out_len
);
5492 int ssl_log_rsa_client_key_exchange(SSL
*ssl
,
5493 const uint8_t *encrypted_premaster
,
5494 size_t encrypted_premaster_len
,
5495 const uint8_t *premaster
,
5496 size_t premaster_len
)
5498 if (encrypted_premaster_len
< 8) {
5499 SSLfatal(ssl
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
5503 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5504 return nss_keylog_int("RSA",
5506 encrypted_premaster
,
5512 int ssl_log_secret(SSL
*ssl
,
5514 const uint8_t *secret
,
5517 return nss_keylog_int(label
,
5519 ssl
->s3
.client_random
,
5525 #define SSLV2_CIPHER_LEN 3
5527 int ssl_cache_cipherlist(SSL
*s
, PACKET
*cipher_suites
, int sslv2format
)
5531 n
= sslv2format
? SSLV2_CIPHER_LEN
: TLS_CIPHER_LEN
;
5533 if (PACKET_remaining(cipher_suites
) == 0) {
5534 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_R_NO_CIPHERS_SPECIFIED
);
5538 if (PACKET_remaining(cipher_suites
) % n
!= 0) {
5539 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5543 OPENSSL_free(s
->s3
.tmp
.ciphers_raw
);
5544 s
->s3
.tmp
.ciphers_raw
= NULL
;
5545 s
->s3
.tmp
.ciphers_rawlen
= 0;
5548 size_t numciphers
= PACKET_remaining(cipher_suites
) / n
;
5549 PACKET sslv2ciphers
= *cipher_suites
;
5550 unsigned int leadbyte
;
5554 * We store the raw ciphers list in SSLv3+ format so we need to do some
5555 * preprocessing to convert the list first. If there are any SSLv2 only
5556 * ciphersuites with a non-zero leading byte then we are going to
5557 * slightly over allocate because we won't store those. But that isn't a
5560 raw
= OPENSSL_malloc(numciphers
* TLS_CIPHER_LEN
);
5561 s
->s3
.tmp
.ciphers_raw
= raw
;
5563 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5566 for (s
->s3
.tmp
.ciphers_rawlen
= 0;
5567 PACKET_remaining(&sslv2ciphers
) > 0;
5568 raw
+= TLS_CIPHER_LEN
) {
5569 if (!PACKET_get_1(&sslv2ciphers
, &leadbyte
)
5571 && !PACKET_copy_bytes(&sslv2ciphers
, raw
,
5574 && !PACKET_forward(&sslv2ciphers
, TLS_CIPHER_LEN
))) {
5575 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_R_BAD_PACKET
);
5576 OPENSSL_free(s
->s3
.tmp
.ciphers_raw
);
5577 s
->s3
.tmp
.ciphers_raw
= NULL
;
5578 s
->s3
.tmp
.ciphers_rawlen
= 0;
5582 s
->s3
.tmp
.ciphers_rawlen
+= TLS_CIPHER_LEN
;
5584 } else if (!PACKET_memdup(cipher_suites
, &s
->s3
.tmp
.ciphers_raw
,
5585 &s
->s3
.tmp
.ciphers_rawlen
)) {
5586 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
5592 int SSL_bytes_to_cipher_list(SSL
*s
, const unsigned char *bytes
, size_t len
,
5593 int isv2format
, STACK_OF(SSL_CIPHER
) **sk
,
5594 STACK_OF(SSL_CIPHER
) **scsvs
)
5598 if (!PACKET_buf_init(&pkt
, bytes
, len
))
5600 return bytes_to_cipher_list(s
, &pkt
, sk
, scsvs
, isv2format
, 0);
5603 int bytes_to_cipher_list(SSL
*s
, PACKET
*cipher_suites
,
5604 STACK_OF(SSL_CIPHER
) **skp
,
5605 STACK_OF(SSL_CIPHER
) **scsvs_out
,
5606 int sslv2format
, int fatal
)
5608 const SSL_CIPHER
*c
;
5609 STACK_OF(SSL_CIPHER
) *sk
= NULL
;
5610 STACK_OF(SSL_CIPHER
) *scsvs
= NULL
;
5612 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5613 unsigned char cipher
[SSLV2_CIPHER_LEN
];
5615 n
= sslv2format
? SSLV2_CIPHER_LEN
: TLS_CIPHER_LEN
;
5617 if (PACKET_remaining(cipher_suites
) == 0) {
5619 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_R_NO_CIPHERS_SPECIFIED
);
5621 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CIPHERS_SPECIFIED
);
5625 if (PACKET_remaining(cipher_suites
) % n
!= 0) {
5627 SSLfatal(s
, SSL_AD_DECODE_ERROR
,
5628 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5630 ERR_raise(ERR_LIB_SSL
, SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5634 sk
= sk_SSL_CIPHER_new_null();
5635 scsvs
= sk_SSL_CIPHER_new_null();
5636 if (sk
== NULL
|| scsvs
== NULL
) {
5638 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5640 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
5644 while (PACKET_copy_bytes(cipher_suites
, cipher
, n
)) {
5646 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5647 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5648 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5650 if (sslv2format
&& cipher
[0] != '\0')
5653 /* For SSLv2-compat, ignore leading 0-byte. */
5654 c
= ssl_get_cipher_by_char(s
, sslv2format
? &cipher
[1] : cipher
, 1);
5656 if ((c
->valid
&& !sk_SSL_CIPHER_push(sk
, c
)) ||
5657 (!c
->valid
&& !sk_SSL_CIPHER_push(scsvs
, c
))) {
5659 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5661 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
5666 if (PACKET_remaining(cipher_suites
) > 0) {
5668 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_R_BAD_LENGTH
);
5670 ERR_raise(ERR_LIB_SSL
, SSL_R_BAD_LENGTH
);
5677 sk_SSL_CIPHER_free(sk
);
5678 if (scsvs_out
!= NULL
)
5681 sk_SSL_CIPHER_free(scsvs
);
5684 sk_SSL_CIPHER_free(sk
);
5685 sk_SSL_CIPHER_free(scsvs
);
5689 int SSL_CTX_set_max_early_data(SSL_CTX
*ctx
, uint32_t max_early_data
)
5691 ctx
->max_early_data
= max_early_data
;
5696 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX
*ctx
)
5698 return ctx
->max_early_data
;
5701 int SSL_set_max_early_data(SSL
*s
, uint32_t max_early_data
)
5703 s
->max_early_data
= max_early_data
;
5708 uint32_t SSL_get_max_early_data(const SSL
*s
)
5710 return s
->max_early_data
;
5713 int SSL_CTX_set_recv_max_early_data(SSL_CTX
*ctx
, uint32_t recv_max_early_data
)
5715 ctx
->recv_max_early_data
= recv_max_early_data
;
5720 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX
*ctx
)
5722 return ctx
->recv_max_early_data
;
5725 int SSL_set_recv_max_early_data(SSL
*s
, uint32_t recv_max_early_data
)
5727 s
->recv_max_early_data
= recv_max_early_data
;
5732 uint32_t SSL_get_recv_max_early_data(const SSL
*s
)
5734 return s
->recv_max_early_data
;
5737 __owur
unsigned int ssl_get_max_send_fragment(const SSL
*ssl
)
5739 /* Return any active Max Fragment Len extension */
5740 if (ssl
->session
!= NULL
&& USE_MAX_FRAGMENT_LENGTH_EXT(ssl
->session
))
5741 return GET_MAX_FRAGMENT_LENGTH(ssl
->session
);
5743 /* return current SSL connection setting */
5744 return ssl
->max_send_fragment
;
5747 __owur
unsigned int ssl_get_split_send_fragment(const SSL
*ssl
)
5749 /* Return a value regarding an active Max Fragment Len extension */
5750 if (ssl
->session
!= NULL
&& USE_MAX_FRAGMENT_LENGTH_EXT(ssl
->session
)
5751 && ssl
->split_send_fragment
> GET_MAX_FRAGMENT_LENGTH(ssl
->session
))
5752 return GET_MAX_FRAGMENT_LENGTH(ssl
->session
);
5754 /* else limit |split_send_fragment| to current |max_send_fragment| */
5755 if (ssl
->split_send_fragment
> ssl
->max_send_fragment
)
5756 return ssl
->max_send_fragment
;
5758 /* return current SSL connection setting */
5759 return ssl
->split_send_fragment
;
5762 int SSL_stateless(SSL
*s
)
5766 /* Ensure there is no state left over from a previous invocation */
5772 s
->s3
.flags
|= TLS1_FLAGS_STATELESS
;
5773 ret
= SSL_accept(s
);
5774 s
->s3
.flags
&= ~TLS1_FLAGS_STATELESS
;
5776 if (ret
> 0 && s
->ext
.cookieok
)
5779 if (s
->hello_retry_request
== SSL_HRR_PENDING
&& !ossl_statem_in_error(s
))
5785 void SSL_CTX_set_post_handshake_auth(SSL_CTX
*ctx
, int val
)
5787 ctx
->pha_enabled
= val
;
5790 void SSL_set_post_handshake_auth(SSL
*ssl
, int val
)
5792 ssl
->pha_enabled
= val
;
5795 int SSL_verify_client_post_handshake(SSL
*ssl
)
5797 if (!SSL_IS_TLS13(ssl
)) {
5798 ERR_raise(ERR_LIB_SSL
, SSL_R_WRONG_SSL_VERSION
);
5802 ERR_raise(ERR_LIB_SSL
, SSL_R_NOT_SERVER
);
5806 if (!SSL_is_init_finished(ssl
)) {
5807 ERR_raise(ERR_LIB_SSL
, SSL_R_STILL_IN_INIT
);
5811 switch (ssl
->post_handshake_auth
) {
5813 ERR_raise(ERR_LIB_SSL
, SSL_R_EXTENSION_NOT_RECEIVED
);
5816 case SSL_PHA_EXT_SENT
:
5817 ERR_raise(ERR_LIB_SSL
, ERR_R_INTERNAL_ERROR
);
5819 case SSL_PHA_EXT_RECEIVED
:
5821 case SSL_PHA_REQUEST_PENDING
:
5822 ERR_raise(ERR_LIB_SSL
, SSL_R_REQUEST_PENDING
);
5824 case SSL_PHA_REQUESTED
:
5825 ERR_raise(ERR_LIB_SSL
, SSL_R_REQUEST_SENT
);
5829 ssl
->post_handshake_auth
= SSL_PHA_REQUEST_PENDING
;
5831 /* checks verify_mode and algorithm_auth */
5832 if (!send_certificate_request(ssl
)) {
5833 ssl
->post_handshake_auth
= SSL_PHA_EXT_RECEIVED
; /* restore on error */
5834 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_CONFIG
);
5838 ossl_statem_set_in_init(ssl
, 1);
5842 int SSL_CTX_set_session_ticket_cb(SSL_CTX
*ctx
,
5843 SSL_CTX_generate_session_ticket_fn gen_cb
,
5844 SSL_CTX_decrypt_session_ticket_fn dec_cb
,
5847 ctx
->generate_ticket_cb
= gen_cb
;
5848 ctx
->decrypt_ticket_cb
= dec_cb
;
5849 ctx
->ticket_cb_data
= arg
;
5853 void SSL_CTX_set_allow_early_data_cb(SSL_CTX
*ctx
,
5854 SSL_allow_early_data_cb_fn cb
,
5857 ctx
->allow_early_data_cb
= cb
;
5858 ctx
->allow_early_data_cb_data
= arg
;
5861 void SSL_set_allow_early_data_cb(SSL
*s
,
5862 SSL_allow_early_data_cb_fn cb
,
5865 s
->allow_early_data_cb
= cb
;
5866 s
->allow_early_data_cb_data
= arg
;
5869 const EVP_CIPHER
*ssl_evp_cipher_fetch(OSSL_LIB_CTX
*libctx
,
5871 const char *properties
)
5873 const EVP_CIPHER
*ciph
;
5875 ciph
= tls_get_cipher_from_engine(nid
);
5880 * If there is no engine cipher then we do an explicit fetch. This may fail
5881 * and that could be ok
5884 ciph
= EVP_CIPHER_fetch(libctx
, OBJ_nid2sn(nid
), properties
);
5890 int ssl_evp_cipher_up_ref(const EVP_CIPHER
*cipher
)
5892 /* Don't up-ref an implicit EVP_CIPHER */
5893 if (EVP_CIPHER_provider(cipher
) == NULL
)
5897 * The cipher was explicitly fetched and therefore it is safe to cast
5900 return EVP_CIPHER_up_ref((EVP_CIPHER
*)cipher
);
5903 void ssl_evp_cipher_free(const EVP_CIPHER
*cipher
)
5908 if (EVP_CIPHER_provider(cipher
) != NULL
) {
5910 * The cipher was explicitly fetched and therefore it is safe to cast
5913 EVP_CIPHER_free((EVP_CIPHER
*)cipher
);
5917 const EVP_MD
*ssl_evp_md_fetch(OSSL_LIB_CTX
*libctx
,
5919 const char *properties
)
5923 md
= tls_get_digest_from_engine(nid
);
5927 /* Otherwise we do an explicit fetch */
5929 md
= EVP_MD_fetch(libctx
, OBJ_nid2sn(nid
), properties
);
5934 int ssl_evp_md_up_ref(const EVP_MD
*md
)
5936 /* Don't up-ref an implicit EVP_MD */
5937 if (EVP_MD_provider(md
) == NULL
)
5941 * The digest was explicitly fetched and therefore it is safe to cast
5944 return EVP_MD_up_ref((EVP_MD
*)md
);
5947 void ssl_evp_md_free(const EVP_MD
*md
)
5952 if (EVP_MD_provider(md
) != NULL
) {
5954 * The digest was explicitly fetched and therefore it is safe to cast
5957 EVP_MD_free((EVP_MD
*)md
);
5961 int SSL_set0_tmp_dh_pkey(SSL
*s
, EVP_PKEY
*dhpkey
)
5963 if (!ssl_security(s
, SSL_SECOP_TMP_DH
,
5964 EVP_PKEY_security_bits(dhpkey
), 0, dhpkey
)) {
5965 ERR_raise(ERR_LIB_SSL
, SSL_R_DH_KEY_TOO_SMALL
);
5966 EVP_PKEY_free(dhpkey
);
5969 EVP_PKEY_free(s
->cert
->dh_tmp
);
5970 s
->cert
->dh_tmp
= dhpkey
;
5974 int SSL_CTX_set0_tmp_dh_pkey(SSL_CTX
*ctx
, EVP_PKEY
*dhpkey
)
5976 if (!ssl_ctx_security(ctx
, SSL_SECOP_TMP_DH
,
5977 EVP_PKEY_security_bits(dhpkey
), 0, dhpkey
)) {
5978 ERR_raise(ERR_LIB_SSL
, SSL_R_DH_KEY_TOO_SMALL
);
5979 EVP_PKEY_free(dhpkey
);
5982 EVP_PKEY_free(ctx
->cert
->dh_tmp
);
5983 ctx
->cert
->dh_tmp
= dhpkey
;