2 * Copyright 1995-2021 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_get_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 if (ctx
->ext
.ecpointformats
) {
772 s
->ext
.ecpointformats
=
773 OPENSSL_memdup(ctx
->ext
.ecpointformats
,
774 ctx
->ext
.ecpointformats_len
);
775 if (!s
->ext
.ecpointformats
) {
776 s
->ext
.ecpointformats_len
= 0;
779 s
->ext
.ecpointformats_len
=
780 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
) {
788 s
->ext
.supportedgroups_len
= 0;
791 s
->ext
.supportedgroups_len
= ctx
->ext
.supportedgroups_len
;
794 #ifndef OPENSSL_NO_NEXTPROTONEG
798 if (s
->ctx
->ext
.alpn
) {
799 s
->ext
.alpn
= OPENSSL_malloc(s
->ctx
->ext
.alpn_len
);
800 if (s
->ext
.alpn
== NULL
) {
804 memcpy(s
->ext
.alpn
, s
->ctx
->ext
.alpn
, s
->ctx
->ext
.alpn_len
);
805 s
->ext
.alpn_len
= s
->ctx
->ext
.alpn_len
;
808 s
->verified_chain
= NULL
;
809 s
->verify_result
= X509_V_OK
;
811 s
->default_passwd_callback
= ctx
->default_passwd_callback
;
812 s
->default_passwd_callback_userdata
= ctx
->default_passwd_callback_userdata
;
814 s
->method
= ctx
->method
;
816 s
->key_update
= SSL_KEY_UPDATE_NONE
;
818 s
->allow_early_data_cb
= ctx
->allow_early_data_cb
;
819 s
->allow_early_data_cb_data
= ctx
->allow_early_data_cb_data
;
821 if (!s
->method
->ssl_new(s
))
824 s
->server
= (ctx
->method
->ssl_accept
== ssl_undefined_function
) ? 0 : 1;
829 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL
, s
, &s
->ex_data
))
832 #ifndef OPENSSL_NO_PSK
833 s
->psk_client_callback
= ctx
->psk_client_callback
;
834 s
->psk_server_callback
= ctx
->psk_server_callback
;
836 s
->psk_find_session_cb
= ctx
->psk_find_session_cb
;
837 s
->psk_use_session_cb
= ctx
->psk_use_session_cb
;
839 s
->async_cb
= ctx
->async_cb
;
840 s
->async_cb_arg
= ctx
->async_cb_arg
;
844 #ifndef OPENSSL_NO_CT
845 if (!SSL_set_ct_validation_callback(s
, ctx
->ct_validation_callback
,
846 ctx
->ct_validation_callback_arg
))
853 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
857 int SSL_is_dtls(const SSL
*s
)
859 return SSL_IS_DTLS(s
) ? 1 : 0;
862 int SSL_up_ref(SSL
*s
)
866 if (CRYPTO_UP_REF(&s
->references
, &i
, s
->lock
) <= 0)
869 REF_PRINT_COUNT("SSL", s
);
870 REF_ASSERT_ISNT(i
< 2);
871 return ((i
> 1) ? 1 : 0);
874 int SSL_CTX_set_session_id_context(SSL_CTX
*ctx
, const unsigned char *sid_ctx
,
875 unsigned int sid_ctx_len
)
877 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
878 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
881 ctx
->sid_ctx_length
= sid_ctx_len
;
882 memcpy(ctx
->sid_ctx
, sid_ctx
, sid_ctx_len
);
887 int SSL_set_session_id_context(SSL
*ssl
, const unsigned char *sid_ctx
,
888 unsigned int sid_ctx_len
)
890 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
891 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
894 ssl
->sid_ctx_length
= sid_ctx_len
;
895 memcpy(ssl
->sid_ctx
, sid_ctx
, sid_ctx_len
);
900 int SSL_CTX_set_generate_session_id(SSL_CTX
*ctx
, GEN_SESSION_CB cb
)
902 if (!CRYPTO_THREAD_write_lock(ctx
->lock
))
904 ctx
->generate_session_id
= cb
;
905 CRYPTO_THREAD_unlock(ctx
->lock
);
909 int SSL_set_generate_session_id(SSL
*ssl
, GEN_SESSION_CB cb
)
911 if (!CRYPTO_THREAD_write_lock(ssl
->lock
))
913 ssl
->generate_session_id
= cb
;
914 CRYPTO_THREAD_unlock(ssl
->lock
);
918 int SSL_has_matching_session_id(const SSL
*ssl
, const unsigned char *id
,
922 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
923 * we can "construct" a session to give us the desired check - i.e. to
924 * find if there's a session in the hash table that would conflict with
925 * any new session built out of this id/id_len and the ssl_version in use
930 if (id_len
> sizeof(r
.session_id
))
933 r
.ssl_version
= ssl
->version
;
934 r
.session_id_length
= id_len
;
935 memcpy(r
.session_id
, id
, id_len
);
937 if (!CRYPTO_THREAD_read_lock(ssl
->session_ctx
->lock
))
939 p
= lh_SSL_SESSION_retrieve(ssl
->session_ctx
->sessions
, &r
);
940 CRYPTO_THREAD_unlock(ssl
->session_ctx
->lock
);
944 int SSL_CTX_set_purpose(SSL_CTX
*s
, int purpose
)
946 return X509_VERIFY_PARAM_set_purpose(s
->param
, purpose
);
949 int SSL_set_purpose(SSL
*s
, int purpose
)
951 return X509_VERIFY_PARAM_set_purpose(s
->param
, purpose
);
954 int SSL_CTX_set_trust(SSL_CTX
*s
, int trust
)
956 return X509_VERIFY_PARAM_set_trust(s
->param
, trust
);
959 int SSL_set_trust(SSL
*s
, int trust
)
961 return X509_VERIFY_PARAM_set_trust(s
->param
, trust
);
964 int SSL_set1_host(SSL
*s
, const char *hostname
)
966 /* If a hostname is provided and parses as an IP address,
967 * treat it as such. */
968 if (hostname
&& X509_VERIFY_PARAM_set1_ip_asc(s
->param
, hostname
) == 1)
971 return X509_VERIFY_PARAM_set1_host(s
->param
, hostname
, 0);
974 int SSL_add1_host(SSL
*s
, const char *hostname
)
976 /* If a hostname is provided and parses as an IP address,
977 * treat it as such. */
980 ASN1_OCTET_STRING
*ip
;
983 ip
= a2i_IPADDRESS(hostname
);
985 /* We didn't want it; only to check if it *is* an IP address */
986 ASN1_OCTET_STRING_free(ip
);
988 old_ip
= X509_VERIFY_PARAM_get1_ip_asc(s
->param
);
991 OPENSSL_free(old_ip
);
992 /* There can be only one IP address */
996 return X509_VERIFY_PARAM_set1_ip_asc(s
->param
, hostname
);
1000 return X509_VERIFY_PARAM_add1_host(s
->param
, hostname
, 0);
1003 void SSL_set_hostflags(SSL
*s
, unsigned int flags
)
1005 X509_VERIFY_PARAM_set_hostflags(s
->param
, flags
);
1008 const char *SSL_get0_peername(SSL
*s
)
1010 return X509_VERIFY_PARAM_get0_peername(s
->param
);
1013 int SSL_CTX_dane_enable(SSL_CTX
*ctx
)
1015 return dane_ctx_enable(&ctx
->dane
);
1018 unsigned long SSL_CTX_dane_set_flags(SSL_CTX
*ctx
, unsigned long flags
)
1020 unsigned long orig
= ctx
->dane
.flags
;
1022 ctx
->dane
.flags
|= flags
;
1026 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX
*ctx
, unsigned long flags
)
1028 unsigned long orig
= ctx
->dane
.flags
;
1030 ctx
->dane
.flags
&= ~flags
;
1034 int SSL_dane_enable(SSL
*s
, const char *basedomain
)
1036 SSL_DANE
*dane
= &s
->dane
;
1038 if (s
->ctx
->dane
.mdmax
== 0) {
1039 ERR_raise(ERR_LIB_SSL
, SSL_R_CONTEXT_NOT_DANE_ENABLED
);
1042 if (dane
->trecs
!= NULL
) {
1043 ERR_raise(ERR_LIB_SSL
, SSL_R_DANE_ALREADY_ENABLED
);
1048 * Default SNI name. This rejects empty names, while set1_host below
1049 * accepts them and disables host name checks. To avoid side-effects with
1050 * invalid input, set the SNI name first.
1052 if (s
->ext
.hostname
== NULL
) {
1053 if (!SSL_set_tlsext_host_name(s
, basedomain
)) {
1054 ERR_raise(ERR_LIB_SSL
, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN
);
1059 /* Primary RFC6125 reference identifier */
1060 if (!X509_VERIFY_PARAM_set1_host(s
->param
, basedomain
, 0)) {
1061 ERR_raise(ERR_LIB_SSL
, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN
);
1067 dane
->dctx
= &s
->ctx
->dane
;
1068 dane
->trecs
= sk_danetls_record_new_null();
1070 if (dane
->trecs
== NULL
) {
1071 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
1077 unsigned long SSL_dane_set_flags(SSL
*ssl
, unsigned long flags
)
1079 unsigned long orig
= ssl
->dane
.flags
;
1081 ssl
->dane
.flags
|= flags
;
1085 unsigned long SSL_dane_clear_flags(SSL
*ssl
, unsigned long flags
)
1087 unsigned long orig
= ssl
->dane
.flags
;
1089 ssl
->dane
.flags
&= ~flags
;
1093 int SSL_get0_dane_authority(SSL
*s
, X509
**mcert
, EVP_PKEY
**mspki
)
1095 SSL_DANE
*dane
= &s
->dane
;
1097 if (!DANETLS_ENABLED(dane
) || s
->verify_result
!= X509_V_OK
)
1101 *mcert
= dane
->mcert
;
1103 *mspki
= (dane
->mcert
== NULL
) ? dane
->mtlsa
->spki
: NULL
;
1108 int SSL_get0_dane_tlsa(SSL
*s
, uint8_t *usage
, uint8_t *selector
,
1109 uint8_t *mtype
, const unsigned char **data
, size_t *dlen
)
1111 SSL_DANE
*dane
= &s
->dane
;
1113 if (!DANETLS_ENABLED(dane
) || s
->verify_result
!= X509_V_OK
)
1117 *usage
= dane
->mtlsa
->usage
;
1119 *selector
= dane
->mtlsa
->selector
;
1121 *mtype
= dane
->mtlsa
->mtype
;
1123 *data
= dane
->mtlsa
->data
;
1125 *dlen
= dane
->mtlsa
->dlen
;
1130 SSL_DANE
*SSL_get0_dane(SSL
*s
)
1135 int SSL_dane_tlsa_add(SSL
*s
, uint8_t usage
, uint8_t selector
,
1136 uint8_t mtype
, const unsigned char *data
, size_t dlen
)
1138 return dane_tlsa_add(&s
->dane
, usage
, selector
, mtype
, data
, dlen
);
1141 int SSL_CTX_dane_mtype_set(SSL_CTX
*ctx
, const EVP_MD
*md
, uint8_t mtype
,
1144 return dane_mtype_set(&ctx
->dane
, md
, mtype
, ord
);
1147 int SSL_CTX_set1_param(SSL_CTX
*ctx
, X509_VERIFY_PARAM
*vpm
)
1149 return X509_VERIFY_PARAM_set1(ctx
->param
, vpm
);
1152 int SSL_set1_param(SSL
*ssl
, X509_VERIFY_PARAM
*vpm
)
1154 return X509_VERIFY_PARAM_set1(ssl
->param
, vpm
);
1157 X509_VERIFY_PARAM
*SSL_CTX_get0_param(SSL_CTX
*ctx
)
1162 X509_VERIFY_PARAM
*SSL_get0_param(SSL
*ssl
)
1167 void SSL_certs_clear(SSL
*s
)
1169 ssl_cert_clear_certs(s
->cert
);
1172 void SSL_free(SSL
*s
)
1178 CRYPTO_DOWN_REF(&s
->references
, &i
, s
->lock
);
1179 REF_PRINT_COUNT("SSL", s
);
1182 REF_ASSERT_ISNT(i
< 0);
1184 X509_VERIFY_PARAM_free(s
->param
);
1185 dane_final(&s
->dane
);
1186 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL
, s
, &s
->ex_data
);
1188 RECORD_LAYER_release(&s
->rlayer
);
1190 /* Ignore return value */
1191 ssl_free_wbio_buffer(s
);
1193 BIO_free_all(s
->wbio
);
1195 BIO_free_all(s
->rbio
);
1198 BUF_MEM_free(s
->init_buf
);
1200 /* add extra stuff */
1201 sk_SSL_CIPHER_free(s
->cipher_list
);
1202 sk_SSL_CIPHER_free(s
->cipher_list_by_id
);
1203 sk_SSL_CIPHER_free(s
->tls13_ciphersuites
);
1204 sk_SSL_CIPHER_free(s
->peer_ciphers
);
1206 /* Make the next call work :-) */
1207 if (s
->session
!= NULL
) {
1208 ssl_clear_bad_session(s
);
1209 SSL_SESSION_free(s
->session
);
1211 SSL_SESSION_free(s
->psksession
);
1212 OPENSSL_free(s
->psksession_id
);
1216 ssl_cert_free(s
->cert
);
1217 OPENSSL_free(s
->shared_sigalgs
);
1218 /* Free up if allocated */
1220 OPENSSL_free(s
->ext
.hostname
);
1221 SSL_CTX_free(s
->session_ctx
);
1222 OPENSSL_free(s
->ext
.ecpointformats
);
1223 OPENSSL_free(s
->ext
.peer_ecpointformats
);
1224 OPENSSL_free(s
->ext
.supportedgroups
);
1225 OPENSSL_free(s
->ext
.peer_supportedgroups
);
1226 sk_X509_EXTENSION_pop_free(s
->ext
.ocsp
.exts
, X509_EXTENSION_free
);
1227 #ifndef OPENSSL_NO_OCSP
1228 sk_OCSP_RESPID_pop_free(s
->ext
.ocsp
.ids
, OCSP_RESPID_free
);
1230 #ifndef OPENSSL_NO_CT
1231 SCT_LIST_free(s
->scts
);
1232 OPENSSL_free(s
->ext
.scts
);
1234 OPENSSL_free(s
->ext
.ocsp
.resp
);
1235 OPENSSL_free(s
->ext
.alpn
);
1236 OPENSSL_free(s
->ext
.tls13_cookie
);
1237 if (s
->clienthello
!= NULL
)
1238 OPENSSL_free(s
->clienthello
->pre_proc_exts
);
1239 OPENSSL_free(s
->clienthello
);
1240 OPENSSL_free(s
->pha_context
);
1241 EVP_MD_CTX_free(s
->pha_dgst
);
1243 sk_X509_NAME_pop_free(s
->ca_names
, X509_NAME_free
);
1244 sk_X509_NAME_pop_free(s
->client_ca_names
, X509_NAME_free
);
1246 sk_X509_pop_free(s
->verified_chain
, X509_free
);
1248 if (s
->method
!= NULL
)
1249 s
->method
->ssl_free(s
);
1251 SSL_CTX_free(s
->ctx
);
1253 ASYNC_WAIT_CTX_free(s
->waitctx
);
1255 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1256 OPENSSL_free(s
->ext
.npn
);
1259 #ifndef OPENSSL_NO_SRTP
1260 sk_SRTP_PROTECTION_PROFILE_free(s
->srtp_profiles
);
1263 CRYPTO_THREAD_lock_free(s
->lock
);
1268 void SSL_set0_rbio(SSL
*s
, BIO
*rbio
)
1270 BIO_free_all(s
->rbio
);
1274 void SSL_set0_wbio(SSL
*s
, BIO
*wbio
)
1277 * If the output buffering BIO is still in place, remove it
1279 if (s
->bbio
!= NULL
)
1280 s
->wbio
= BIO_pop(s
->wbio
);
1282 BIO_free_all(s
->wbio
);
1285 /* Re-attach |bbio| to the new |wbio|. */
1286 if (s
->bbio
!= NULL
)
1287 s
->wbio
= BIO_push(s
->bbio
, s
->wbio
);
1290 void SSL_set_bio(SSL
*s
, BIO
*rbio
, BIO
*wbio
)
1293 * For historical reasons, this function has many different cases in
1294 * ownership handling.
1297 /* If nothing has changed, do nothing */
1298 if (rbio
== SSL_get_rbio(s
) && wbio
== SSL_get_wbio(s
))
1302 * If the two arguments are equal then one fewer reference is granted by the
1303 * caller than we want to take
1305 if (rbio
!= NULL
&& rbio
== wbio
)
1309 * If only the wbio is changed only adopt one reference.
1311 if (rbio
== SSL_get_rbio(s
)) {
1312 SSL_set0_wbio(s
, wbio
);
1316 * There is an asymmetry here for historical reasons. If only the rbio is
1317 * changed AND the rbio and wbio were originally different, then we only
1318 * adopt one reference.
1320 if (wbio
== SSL_get_wbio(s
) && SSL_get_rbio(s
) != SSL_get_wbio(s
)) {
1321 SSL_set0_rbio(s
, rbio
);
1325 /* Otherwise, adopt both references. */
1326 SSL_set0_rbio(s
, rbio
);
1327 SSL_set0_wbio(s
, wbio
);
1330 BIO
*SSL_get_rbio(const SSL
*s
)
1335 BIO
*SSL_get_wbio(const SSL
*s
)
1337 if (s
->bbio
!= NULL
) {
1339 * If |bbio| is active, the true caller-configured BIO is its
1342 return BIO_next(s
->bbio
);
1347 int SSL_get_fd(const SSL
*s
)
1349 return SSL_get_rfd(s
);
1352 int SSL_get_rfd(const SSL
*s
)
1357 b
= SSL_get_rbio(s
);
1358 r
= BIO_find_type(b
, BIO_TYPE_DESCRIPTOR
);
1360 BIO_get_fd(r
, &ret
);
1364 int SSL_get_wfd(const SSL
*s
)
1369 b
= SSL_get_wbio(s
);
1370 r
= BIO_find_type(b
, BIO_TYPE_DESCRIPTOR
);
1372 BIO_get_fd(r
, &ret
);
1376 #ifndef OPENSSL_NO_SOCK
1377 int SSL_set_fd(SSL
*s
, int fd
)
1382 bio
= BIO_new(BIO_s_socket());
1385 ERR_raise(ERR_LIB_SSL
, ERR_R_BUF_LIB
);
1388 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1389 SSL_set_bio(s
, bio
, bio
);
1390 #ifndef OPENSSL_NO_KTLS
1392 * The new socket is created successfully regardless of ktls_enable.
1393 * ktls_enable doesn't change any functionality of the socket, except
1394 * changing the setsockopt to enable the processing of ktls_start.
1395 * Thus, it is not a problem to call it for non-TLS sockets.
1398 #endif /* OPENSSL_NO_KTLS */
1404 int SSL_set_wfd(SSL
*s
, int fd
)
1406 BIO
*rbio
= SSL_get_rbio(s
);
1408 if (rbio
== NULL
|| BIO_method_type(rbio
) != BIO_TYPE_SOCKET
1409 || (int)BIO_get_fd(rbio
, NULL
) != fd
) {
1410 BIO
*bio
= BIO_new(BIO_s_socket());
1413 ERR_raise(ERR_LIB_SSL
, ERR_R_BUF_LIB
);
1416 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1417 SSL_set0_wbio(s
, bio
);
1418 #ifndef OPENSSL_NO_KTLS
1420 * The new socket is created successfully regardless of ktls_enable.
1421 * ktls_enable doesn't change any functionality of the socket, except
1422 * changing the setsockopt to enable the processing of ktls_start.
1423 * Thus, it is not a problem to call it for non-TLS sockets.
1426 #endif /* OPENSSL_NO_KTLS */
1429 SSL_set0_wbio(s
, rbio
);
1434 int SSL_set_rfd(SSL
*s
, int fd
)
1436 BIO
*wbio
= SSL_get_wbio(s
);
1438 if (wbio
== NULL
|| BIO_method_type(wbio
) != BIO_TYPE_SOCKET
1439 || ((int)BIO_get_fd(wbio
, NULL
) != fd
)) {
1440 BIO
*bio
= BIO_new(BIO_s_socket());
1443 ERR_raise(ERR_LIB_SSL
, ERR_R_BUF_LIB
);
1446 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1447 SSL_set0_rbio(s
, bio
);
1450 SSL_set0_rbio(s
, wbio
);
1457 /* return length of latest Finished message we sent, copy to 'buf' */
1458 size_t SSL_get_finished(const SSL
*s
, void *buf
, size_t count
)
1462 ret
= s
->s3
.tmp
.finish_md_len
;
1465 memcpy(buf
, s
->s3
.tmp
.finish_md
, count
);
1469 /* return length of latest Finished message we expected, copy to 'buf' */
1470 size_t SSL_get_peer_finished(const SSL
*s
, void *buf
, size_t count
)
1474 ret
= s
->s3
.tmp
.peer_finish_md_len
;
1477 memcpy(buf
, s
->s3
.tmp
.peer_finish_md
, count
);
1481 int SSL_get_verify_mode(const SSL
*s
)
1483 return s
->verify_mode
;
1486 int SSL_get_verify_depth(const SSL
*s
)
1488 return X509_VERIFY_PARAM_get_depth(s
->param
);
1491 int (*SSL_get_verify_callback(const SSL
*s
)) (int, X509_STORE_CTX
*) {
1492 return s
->verify_callback
;
1495 int SSL_CTX_get_verify_mode(const SSL_CTX
*ctx
)
1497 return ctx
->verify_mode
;
1500 int SSL_CTX_get_verify_depth(const SSL_CTX
*ctx
)
1502 return X509_VERIFY_PARAM_get_depth(ctx
->param
);
1505 int (*SSL_CTX_get_verify_callback(const SSL_CTX
*ctx
)) (int, X509_STORE_CTX
*) {
1506 return ctx
->default_verify_callback
;
1509 void SSL_set_verify(SSL
*s
, int mode
,
1510 int (*callback
) (int ok
, X509_STORE_CTX
*ctx
))
1512 s
->verify_mode
= mode
;
1513 if (callback
!= NULL
)
1514 s
->verify_callback
= callback
;
1517 void SSL_set_verify_depth(SSL
*s
, int depth
)
1519 X509_VERIFY_PARAM_set_depth(s
->param
, depth
);
1522 void SSL_set_read_ahead(SSL
*s
, int yes
)
1524 RECORD_LAYER_set_read_ahead(&s
->rlayer
, yes
);
1527 int SSL_get_read_ahead(const SSL
*s
)
1529 return RECORD_LAYER_get_read_ahead(&s
->rlayer
);
1532 int SSL_pending(const SSL
*s
)
1534 size_t pending
= s
->method
->ssl_pending(s
);
1537 * SSL_pending cannot work properly if read-ahead is enabled
1538 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1539 * impossible to fix since SSL_pending cannot report errors that may be
1540 * observed while scanning the new data. (Note that SSL_pending() is
1541 * often used as a boolean value, so we'd better not return -1.)
1543 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1544 * we just return INT_MAX.
1546 return pending
< INT_MAX
? (int)pending
: INT_MAX
;
1549 int SSL_has_pending(const SSL
*s
)
1552 * Similar to SSL_pending() but returns a 1 to indicate that we have
1553 * unprocessed data available or 0 otherwise (as opposed to the number of
1554 * bytes available). Unlike SSL_pending() this will take into account
1555 * read_ahead data. A 1 return simply indicates that we have unprocessed
1556 * data. That data may not result in any application data, or we may fail
1557 * to parse the records for some reason.
1559 if (RECORD_LAYER_processed_read_pending(&s
->rlayer
))
1562 return RECORD_LAYER_read_pending(&s
->rlayer
);
1565 X509
*SSL_get1_peer_certificate(const SSL
*s
)
1567 X509
*r
= SSL_get0_peer_certificate(s
);
1575 X509
*SSL_get0_peer_certificate(const SSL
*s
)
1577 if ((s
== NULL
) || (s
->session
== NULL
))
1580 return s
->session
->peer
;
1583 STACK_OF(X509
) *SSL_get_peer_cert_chain(const SSL
*s
)
1587 if ((s
== NULL
) || (s
->session
== NULL
))
1590 r
= s
->session
->peer_chain
;
1593 * If we are a client, cert_chain includes the peer's own certificate; if
1594 * we are a server, it does not.
1601 * Now in theory, since the calling process own 't' it should be safe to
1602 * modify. We need to be able to read f without being hassled
1604 int SSL_copy_session_id(SSL
*t
, const SSL
*f
)
1607 /* Do we need to do SSL locking? */
1608 if (!SSL_set_session(t
, SSL_get_session(f
))) {
1613 * what if we are setup for one protocol version but want to talk another
1615 if (t
->method
!= f
->method
) {
1616 t
->method
->ssl_free(t
);
1617 t
->method
= f
->method
;
1618 if (t
->method
->ssl_new(t
) == 0)
1622 CRYPTO_UP_REF(&f
->cert
->references
, &i
, f
->cert
->lock
);
1623 ssl_cert_free(t
->cert
);
1625 if (!SSL_set_session_id_context(t
, f
->sid_ctx
, (int)f
->sid_ctx_length
)) {
1632 /* Fix this so it checks all the valid key/cert options */
1633 int SSL_CTX_check_private_key(const SSL_CTX
*ctx
)
1635 if ((ctx
== NULL
) || (ctx
->cert
->key
->x509
== NULL
)) {
1636 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CERTIFICATE_ASSIGNED
);
1639 if (ctx
->cert
->key
->privatekey
== NULL
) {
1640 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_PRIVATE_KEY_ASSIGNED
);
1643 return X509_check_private_key
1644 (ctx
->cert
->key
->x509
, ctx
->cert
->key
->privatekey
);
1647 /* Fix this function so that it takes an optional type parameter */
1648 int SSL_check_private_key(const SSL
*ssl
)
1651 ERR_raise(ERR_LIB_SSL
, ERR_R_PASSED_NULL_PARAMETER
);
1654 if (ssl
->cert
->key
->x509
== NULL
) {
1655 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CERTIFICATE_ASSIGNED
);
1658 if (ssl
->cert
->key
->privatekey
== NULL
) {
1659 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_PRIVATE_KEY_ASSIGNED
);
1662 return X509_check_private_key(ssl
->cert
->key
->x509
,
1663 ssl
->cert
->key
->privatekey
);
1666 int SSL_waiting_for_async(SSL
*s
)
1674 int SSL_get_all_async_fds(SSL
*s
, OSSL_ASYNC_FD
*fds
, size_t *numfds
)
1676 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1680 return ASYNC_WAIT_CTX_get_all_fds(ctx
, fds
, numfds
);
1683 int SSL_get_changed_async_fds(SSL
*s
, OSSL_ASYNC_FD
*addfd
, size_t *numaddfds
,
1684 OSSL_ASYNC_FD
*delfd
, size_t *numdelfds
)
1686 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1690 return ASYNC_WAIT_CTX_get_changed_fds(ctx
, addfd
, numaddfds
, delfd
,
1694 int SSL_CTX_set_async_callback(SSL_CTX
*ctx
, SSL_async_callback_fn callback
)
1696 ctx
->async_cb
= callback
;
1700 int SSL_CTX_set_async_callback_arg(SSL_CTX
*ctx
, void *arg
)
1702 ctx
->async_cb_arg
= arg
;
1706 int SSL_set_async_callback(SSL
*s
, SSL_async_callback_fn callback
)
1708 s
->async_cb
= callback
;
1712 int SSL_set_async_callback_arg(SSL
*s
, void *arg
)
1714 s
->async_cb_arg
= arg
;
1718 int SSL_get_async_status(SSL
*s
, int *status
)
1720 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1724 *status
= ASYNC_WAIT_CTX_get_status(ctx
);
1728 int SSL_accept(SSL
*s
)
1730 if (s
->handshake_func
== NULL
) {
1731 /* Not properly initialized yet */
1732 SSL_set_accept_state(s
);
1735 return SSL_do_handshake(s
);
1738 int SSL_connect(SSL
*s
)
1740 if (s
->handshake_func
== NULL
) {
1741 /* Not properly initialized yet */
1742 SSL_set_connect_state(s
);
1745 return SSL_do_handshake(s
);
1748 long SSL_get_default_timeout(const SSL
*s
)
1750 return s
->method
->get_timeout();
1753 static int ssl_async_wait_ctx_cb(void *arg
)
1755 SSL
*s
= (SSL
*)arg
;
1757 return s
->async_cb(s
, s
->async_cb_arg
);
1760 static int ssl_start_async_job(SSL
*s
, struct ssl_async_args
*args
,
1761 int (*func
) (void *))
1764 if (s
->waitctx
== NULL
) {
1765 s
->waitctx
= ASYNC_WAIT_CTX_new();
1766 if (s
->waitctx
== NULL
)
1768 if (s
->async_cb
!= NULL
1769 && !ASYNC_WAIT_CTX_set_callback
1770 (s
->waitctx
, ssl_async_wait_ctx_cb
, s
))
1773 switch (ASYNC_start_job(&s
->job
, s
->waitctx
, &ret
, func
, args
,
1774 sizeof(struct ssl_async_args
))) {
1776 s
->rwstate
= SSL_NOTHING
;
1777 ERR_raise(ERR_LIB_SSL
, SSL_R_FAILED_TO_INIT_ASYNC
);
1780 s
->rwstate
= SSL_ASYNC_PAUSED
;
1783 s
->rwstate
= SSL_ASYNC_NO_JOBS
;
1789 s
->rwstate
= SSL_NOTHING
;
1790 ERR_raise(ERR_LIB_SSL
, ERR_R_INTERNAL_ERROR
);
1791 /* Shouldn't happen */
1796 static int ssl_io_intern(void *vargs
)
1798 struct ssl_async_args
*args
;
1803 args
= (struct ssl_async_args
*)vargs
;
1807 switch (args
->type
) {
1809 return args
->f
.func_read(s
, buf
, num
, &s
->asyncrw
);
1811 return args
->f
.func_write(s
, buf
, num
, &s
->asyncrw
);
1813 return args
->f
.func_other(s
);
1818 int ssl_read_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1820 if (s
->handshake_func
== NULL
) {
1821 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
1825 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1826 s
->rwstate
= SSL_NOTHING
;
1830 if (s
->early_data_state
== SSL_EARLY_DATA_CONNECT_RETRY
1831 || s
->early_data_state
== SSL_EARLY_DATA_ACCEPT_RETRY
) {
1832 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1836 * If we are a client and haven't received the ServerHello etc then we
1839 ossl_statem_check_finish_init(s
, 0);
1841 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1842 struct ssl_async_args args
;
1848 args
.type
= READFUNC
;
1849 args
.f
.func_read
= s
->method
->ssl_read
;
1851 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
1852 *readbytes
= s
->asyncrw
;
1855 return s
->method
->ssl_read(s
, buf
, num
, readbytes
);
1859 int SSL_read(SSL
*s
, void *buf
, int num
)
1865 ERR_raise(ERR_LIB_SSL
, SSL_R_BAD_LENGTH
);
1869 ret
= ssl_read_internal(s
, buf
, (size_t)num
, &readbytes
);
1872 * The cast is safe here because ret should be <= INT_MAX because num is
1876 ret
= (int)readbytes
;
1881 int SSL_read_ex(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1883 int ret
= ssl_read_internal(s
, buf
, num
, readbytes
);
1890 int SSL_read_early_data(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1895 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1896 return SSL_READ_EARLY_DATA_ERROR
;
1899 switch (s
->early_data_state
) {
1900 case SSL_EARLY_DATA_NONE
:
1901 if (!SSL_in_before(s
)) {
1902 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1903 return SSL_READ_EARLY_DATA_ERROR
;
1907 case SSL_EARLY_DATA_ACCEPT_RETRY
:
1908 s
->early_data_state
= SSL_EARLY_DATA_ACCEPTING
;
1909 ret
= SSL_accept(s
);
1912 s
->early_data_state
= SSL_EARLY_DATA_ACCEPT_RETRY
;
1913 return SSL_READ_EARLY_DATA_ERROR
;
1917 case SSL_EARLY_DATA_READ_RETRY
:
1918 if (s
->ext
.early_data
== SSL_EARLY_DATA_ACCEPTED
) {
1919 s
->early_data_state
= SSL_EARLY_DATA_READING
;
1920 ret
= SSL_read_ex(s
, buf
, num
, readbytes
);
1922 * State machine will update early_data_state to
1923 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1926 if (ret
> 0 || (ret
<= 0 && s
->early_data_state
1927 != SSL_EARLY_DATA_FINISHED_READING
)) {
1928 s
->early_data_state
= SSL_EARLY_DATA_READ_RETRY
;
1929 return ret
> 0 ? SSL_READ_EARLY_DATA_SUCCESS
1930 : SSL_READ_EARLY_DATA_ERROR
;
1933 s
->early_data_state
= SSL_EARLY_DATA_FINISHED_READING
;
1936 return SSL_READ_EARLY_DATA_FINISH
;
1939 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
1940 return SSL_READ_EARLY_DATA_ERROR
;
1944 int SSL_get_early_data_status(const SSL
*s
)
1946 return s
->ext
.early_data
;
1949 static int ssl_peek_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
1951 if (s
->handshake_func
== NULL
) {
1952 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
1956 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1959 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1960 struct ssl_async_args args
;
1966 args
.type
= READFUNC
;
1967 args
.f
.func_read
= s
->method
->ssl_peek
;
1969 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
1970 *readbytes
= s
->asyncrw
;
1973 return s
->method
->ssl_peek(s
, buf
, num
, readbytes
);
1977 int SSL_peek(SSL
*s
, void *buf
, int num
)
1983 ERR_raise(ERR_LIB_SSL
, SSL_R_BAD_LENGTH
);
1987 ret
= ssl_peek_internal(s
, buf
, (size_t)num
, &readbytes
);
1990 * The cast is safe here because ret should be <= INT_MAX because num is
1994 ret
= (int)readbytes
;
2000 int SSL_peek_ex(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
)
2002 int ret
= ssl_peek_internal(s
, buf
, num
, readbytes
);
2009 int ssl_write_internal(SSL
*s
, const void *buf
, size_t num
, size_t *written
)
2011 if (s
->handshake_func
== NULL
) {
2012 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
2016 if (s
->shutdown
& SSL_SENT_SHUTDOWN
) {
2017 s
->rwstate
= SSL_NOTHING
;
2018 ERR_raise(ERR_LIB_SSL
, SSL_R_PROTOCOL_IS_SHUTDOWN
);
2022 if (s
->early_data_state
== SSL_EARLY_DATA_CONNECT_RETRY
2023 || s
->early_data_state
== SSL_EARLY_DATA_ACCEPT_RETRY
2024 || s
->early_data_state
== SSL_EARLY_DATA_READ_RETRY
) {
2025 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
2028 /* If we are a client and haven't sent the Finished we better do that */
2029 ossl_statem_check_finish_init(s
, 1);
2031 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
2033 struct ssl_async_args args
;
2036 args
.buf
= (void *)buf
;
2038 args
.type
= WRITEFUNC
;
2039 args
.f
.func_write
= s
->method
->ssl_write
;
2041 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
2042 *written
= s
->asyncrw
;
2045 return s
->method
->ssl_write(s
, buf
, num
, written
);
2049 ossl_ssize_t
SSL_sendfile(SSL
*s
, int fd
, off_t offset
, size_t size
, int flags
)
2053 if (s
->handshake_func
== NULL
) {
2054 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
2058 if (s
->shutdown
& SSL_SENT_SHUTDOWN
) {
2059 s
->rwstate
= SSL_NOTHING
;
2060 ERR_raise(ERR_LIB_SSL
, SSL_R_PROTOCOL_IS_SHUTDOWN
);
2064 if (!BIO_get_ktls_send(s
->wbio
)) {
2065 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
2069 /* If we have an alert to send, lets send it */
2070 if (s
->s3
.alert_dispatch
) {
2071 ret
= (ossl_ssize_t
)s
->method
->ssl_dispatch_alert(s
);
2073 /* SSLfatal() already called if appropriate */
2076 /* if it went, fall through and send more stuff */
2079 s
->rwstate
= SSL_WRITING
;
2080 if (BIO_flush(s
->wbio
) <= 0) {
2081 if (!BIO_should_retry(s
->wbio
)) {
2082 s
->rwstate
= SSL_NOTHING
;
2085 set_sys_error(EAGAIN
);
2091 #ifdef OPENSSL_NO_KTLS
2092 ERR_raise_data(ERR_LIB_SSL
, ERR_R_INTERNAL_ERROR
,
2093 "can't call ktls_sendfile(), ktls disabled");
2096 ret
= ktls_sendfile(SSL_get_wfd(s
), fd
, offset
, size
, flags
);
2098 #if defined(EAGAIN) && defined(EINTR) && defined(EBUSY)
2099 if ((get_last_sys_error() == EAGAIN
) ||
2100 (get_last_sys_error() == EINTR
) ||
2101 (get_last_sys_error() == EBUSY
))
2102 BIO_set_retry_write(s
->wbio
);
2105 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
2108 s
->rwstate
= SSL_NOTHING
;
2113 int SSL_write(SSL
*s
, const void *buf
, int num
)
2119 ERR_raise(ERR_LIB_SSL
, SSL_R_BAD_LENGTH
);
2123 ret
= ssl_write_internal(s
, buf
, (size_t)num
, &written
);
2126 * The cast is safe here because ret should be <= INT_MAX because num is
2135 int SSL_write_ex(SSL
*s
, const void *buf
, size_t num
, size_t *written
)
2137 int ret
= ssl_write_internal(s
, buf
, num
, written
);
2144 int SSL_write_early_data(SSL
*s
, const void *buf
, size_t num
, size_t *written
)
2146 int ret
, early_data_state
;
2148 uint32_t partialwrite
;
2150 switch (s
->early_data_state
) {
2151 case SSL_EARLY_DATA_NONE
:
2153 || !SSL_in_before(s
)
2154 || ((s
->session
== NULL
|| s
->session
->ext
.max_early_data
== 0)
2155 && (s
->psk_use_session_cb
== NULL
))) {
2156 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
2161 case SSL_EARLY_DATA_CONNECT_RETRY
:
2162 s
->early_data_state
= SSL_EARLY_DATA_CONNECTING
;
2163 ret
= SSL_connect(s
);
2166 s
->early_data_state
= SSL_EARLY_DATA_CONNECT_RETRY
;
2171 case SSL_EARLY_DATA_WRITE_RETRY
:
2172 s
->early_data_state
= SSL_EARLY_DATA_WRITING
;
2174 * We disable partial write for early data because we don't keep track
2175 * of how many bytes we've written between the SSL_write_ex() call and
2176 * the flush if the flush needs to be retried)
2178 partialwrite
= s
->mode
& SSL_MODE_ENABLE_PARTIAL_WRITE
;
2179 s
->mode
&= ~SSL_MODE_ENABLE_PARTIAL_WRITE
;
2180 ret
= SSL_write_ex(s
, buf
, num
, &writtmp
);
2181 s
->mode
|= partialwrite
;
2183 s
->early_data_state
= SSL_EARLY_DATA_WRITE_RETRY
;
2186 s
->early_data_state
= SSL_EARLY_DATA_WRITE_FLUSH
;
2189 case SSL_EARLY_DATA_WRITE_FLUSH
:
2190 /* The buffering BIO is still in place so we need to flush it */
2191 if (statem_flush(s
) != 1)
2194 s
->early_data_state
= SSL_EARLY_DATA_WRITE_RETRY
;
2197 case SSL_EARLY_DATA_FINISHED_READING
:
2198 case SSL_EARLY_DATA_READ_RETRY
:
2199 early_data_state
= s
->early_data_state
;
2200 /* We are a server writing to an unauthenticated client */
2201 s
->early_data_state
= SSL_EARLY_DATA_UNAUTH_WRITING
;
2202 ret
= SSL_write_ex(s
, buf
, num
, written
);
2203 /* The buffering BIO is still in place */
2205 (void)BIO_flush(s
->wbio
);
2206 s
->early_data_state
= early_data_state
;
2210 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
2215 int SSL_shutdown(SSL
*s
)
2218 * Note that this function behaves differently from what one might
2219 * expect. Return values are 0 for no success (yet), 1 for success; but
2220 * calling it once is usually not enough, even if blocking I/O is used
2221 * (see ssl3_shutdown).
2224 if (s
->handshake_func
== NULL
) {
2225 ERR_raise(ERR_LIB_SSL
, SSL_R_UNINITIALIZED
);
2229 if (!SSL_in_init(s
)) {
2230 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
2231 struct ssl_async_args args
;
2234 args
.type
= OTHERFUNC
;
2235 args
.f
.func_other
= s
->method
->ssl_shutdown
;
2237 return ssl_start_async_job(s
, &args
, ssl_io_intern
);
2239 return s
->method
->ssl_shutdown(s
);
2242 ERR_raise(ERR_LIB_SSL
, SSL_R_SHUTDOWN_WHILE_IN_INIT
);
2247 int SSL_key_update(SSL
*s
, int updatetype
)
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
;
2276 * Can we accept a renegotiation request? If yes, set the flag and
2277 * return 1 if yes. If not, raise error and return 0.
2279 static int can_renegotiate(const SSL
*s
)
2281 if (SSL_IS_TLS13(s
)) {
2282 ERR_raise(ERR_LIB_SSL
, SSL_R_WRONG_SSL_VERSION
);
2286 if ((s
->options
& SSL_OP_NO_RENEGOTIATION
) != 0) {
2287 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_RENEGOTIATION
);
2294 int SSL_renegotiate(SSL
*s
)
2296 if (!can_renegotiate(s
))
2301 return s
->method
->ssl_renegotiate(s
);
2304 int SSL_renegotiate_abbreviated(SSL
*s
)
2306 if (!can_renegotiate(s
))
2311 return s
->method
->ssl_renegotiate(s
);
2314 int SSL_renegotiate_pending(const SSL
*s
)
2317 * becomes true when negotiation is requested; false again once a
2318 * handshake has finished
2320 return (s
->renegotiate
!= 0);
2323 int SSL_new_session_ticket(SSL
*s
)
2325 /* If we are in init because we're sending tickets, okay to send more. */
2326 if ((SSL_in_init(s
) && s
->ext
.extra_tickets_expected
== 0)
2327 || SSL_IS_FIRST_HANDSHAKE(s
) || !s
->server
2328 || !SSL_IS_TLS13(s
))
2330 s
->ext
.extra_tickets_expected
++;
2331 if (s
->rlayer
.wbuf
[0].left
== 0 && !SSL_in_init(s
))
2332 ossl_statem_set_in_init(s
, 1);
2336 long SSL_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
)
2341 case SSL_CTRL_GET_READ_AHEAD
:
2342 return RECORD_LAYER_get_read_ahead(&s
->rlayer
);
2343 case SSL_CTRL_SET_READ_AHEAD
:
2344 l
= RECORD_LAYER_get_read_ahead(&s
->rlayer
);
2345 RECORD_LAYER_set_read_ahead(&s
->rlayer
, larg
);
2348 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
2349 s
->msg_callback_arg
= parg
;
2353 return (s
->mode
|= larg
);
2354 case SSL_CTRL_CLEAR_MODE
:
2355 return (s
->mode
&= ~larg
);
2356 case SSL_CTRL_GET_MAX_CERT_LIST
:
2357 return (long)s
->max_cert_list
;
2358 case SSL_CTRL_SET_MAX_CERT_LIST
:
2361 l
= (long)s
->max_cert_list
;
2362 s
->max_cert_list
= (size_t)larg
;
2364 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
2365 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
2367 #ifndef OPENSSL_NO_KTLS
2368 if (s
->wbio
!= NULL
&& BIO_get_ktls_send(s
->wbio
))
2370 #endif /* OPENSSL_NO_KTLS */
2371 s
->max_send_fragment
= larg
;
2372 if (s
->max_send_fragment
< s
->split_send_fragment
)
2373 s
->split_send_fragment
= s
->max_send_fragment
;
2375 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
2376 if ((size_t)larg
> s
->max_send_fragment
|| larg
== 0)
2378 s
->split_send_fragment
= larg
;
2380 case SSL_CTRL_SET_MAX_PIPELINES
:
2381 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
2383 s
->max_pipelines
= larg
;
2385 RECORD_LAYER_set_read_ahead(&s
->rlayer
, 1);
2387 case SSL_CTRL_GET_RI_SUPPORT
:
2388 return s
->s3
.send_connection_binding
;
2389 case SSL_CTRL_CERT_FLAGS
:
2390 return (s
->cert
->cert_flags
|= larg
);
2391 case SSL_CTRL_CLEAR_CERT_FLAGS
:
2392 return (s
->cert
->cert_flags
&= ~larg
);
2394 case SSL_CTRL_GET_RAW_CIPHERLIST
:
2396 if (s
->s3
.tmp
.ciphers_raw
== NULL
)
2398 *(unsigned char **)parg
= s
->s3
.tmp
.ciphers_raw
;
2399 return (int)s
->s3
.tmp
.ciphers_rawlen
;
2401 return TLS_CIPHER_LEN
;
2403 case SSL_CTRL_GET_EXTMS_SUPPORT
:
2404 if (!s
->session
|| SSL_in_init(s
) || ossl_statem_get_in_handshake(s
))
2406 if (s
->session
->flags
& SSL_SESS_FLAG_EXTMS
)
2410 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
2411 return ssl_check_allowed_versions(larg
, s
->max_proto_version
)
2412 && ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
2413 &s
->min_proto_version
);
2414 case SSL_CTRL_GET_MIN_PROTO_VERSION
:
2415 return s
->min_proto_version
;
2416 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
2417 return ssl_check_allowed_versions(s
->min_proto_version
, larg
)
2418 && ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
2419 &s
->max_proto_version
);
2420 case SSL_CTRL_GET_MAX_PROTO_VERSION
:
2421 return s
->max_proto_version
;
2423 return s
->method
->ssl_ctrl(s
, cmd
, larg
, parg
);
2427 long SSL_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void))
2430 case SSL_CTRL_SET_MSG_CALLBACK
:
2431 s
->msg_callback
= (void (*)
2432 (int write_p
, int version
, int content_type
,
2433 const void *buf
, size_t len
, SSL
*ssl
,
2438 return s
->method
->ssl_callback_ctrl(s
, cmd
, fp
);
2442 LHASH_OF(SSL_SESSION
) *SSL_CTX_sessions(SSL_CTX
*ctx
)
2444 return ctx
->sessions
;
2447 long SSL_CTX_ctrl(SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
)
2450 /* For some cases with ctx == NULL perform syntax checks */
2453 case SSL_CTRL_SET_GROUPS_LIST
:
2454 return tls1_set_groups_list(ctx
, NULL
, NULL
, parg
);
2455 case SSL_CTRL_SET_SIGALGS_LIST
:
2456 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST
:
2457 return tls1_set_sigalgs_list(NULL
, parg
, 0);
2464 case SSL_CTRL_GET_READ_AHEAD
:
2465 return ctx
->read_ahead
;
2466 case SSL_CTRL_SET_READ_AHEAD
:
2467 l
= ctx
->read_ahead
;
2468 ctx
->read_ahead
= larg
;
2471 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
2472 ctx
->msg_callback_arg
= parg
;
2475 case SSL_CTRL_GET_MAX_CERT_LIST
:
2476 return (long)ctx
->max_cert_list
;
2477 case SSL_CTRL_SET_MAX_CERT_LIST
:
2480 l
= (long)ctx
->max_cert_list
;
2481 ctx
->max_cert_list
= (size_t)larg
;
2484 case SSL_CTRL_SET_SESS_CACHE_SIZE
:
2487 l
= (long)ctx
->session_cache_size
;
2488 ctx
->session_cache_size
= (size_t)larg
;
2490 case SSL_CTRL_GET_SESS_CACHE_SIZE
:
2491 return (long)ctx
->session_cache_size
;
2492 case SSL_CTRL_SET_SESS_CACHE_MODE
:
2493 l
= ctx
->session_cache_mode
;
2494 ctx
->session_cache_mode
= larg
;
2496 case SSL_CTRL_GET_SESS_CACHE_MODE
:
2497 return ctx
->session_cache_mode
;
2499 case SSL_CTRL_SESS_NUMBER
:
2500 return lh_SSL_SESSION_num_items(ctx
->sessions
);
2501 case SSL_CTRL_SESS_CONNECT
:
2502 return tsan_load(&ctx
->stats
.sess_connect
);
2503 case SSL_CTRL_SESS_CONNECT_GOOD
:
2504 return tsan_load(&ctx
->stats
.sess_connect_good
);
2505 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE
:
2506 return tsan_load(&ctx
->stats
.sess_connect_renegotiate
);
2507 case SSL_CTRL_SESS_ACCEPT
:
2508 return tsan_load(&ctx
->stats
.sess_accept
);
2509 case SSL_CTRL_SESS_ACCEPT_GOOD
:
2510 return tsan_load(&ctx
->stats
.sess_accept_good
);
2511 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE
:
2512 return tsan_load(&ctx
->stats
.sess_accept_renegotiate
);
2513 case SSL_CTRL_SESS_HIT
:
2514 return tsan_load(&ctx
->stats
.sess_hit
);
2515 case SSL_CTRL_SESS_CB_HIT
:
2516 return tsan_load(&ctx
->stats
.sess_cb_hit
);
2517 case SSL_CTRL_SESS_MISSES
:
2518 return tsan_load(&ctx
->stats
.sess_miss
);
2519 case SSL_CTRL_SESS_TIMEOUTS
:
2520 return tsan_load(&ctx
->stats
.sess_timeout
);
2521 case SSL_CTRL_SESS_CACHE_FULL
:
2522 return tsan_load(&ctx
->stats
.sess_cache_full
);
2524 return (ctx
->mode
|= larg
);
2525 case SSL_CTRL_CLEAR_MODE
:
2526 return (ctx
->mode
&= ~larg
);
2527 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
2528 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
2530 ctx
->max_send_fragment
= larg
;
2531 if (ctx
->max_send_fragment
< ctx
->split_send_fragment
)
2532 ctx
->split_send_fragment
= ctx
->max_send_fragment
;
2534 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
2535 if ((size_t)larg
> ctx
->max_send_fragment
|| larg
== 0)
2537 ctx
->split_send_fragment
= larg
;
2539 case SSL_CTRL_SET_MAX_PIPELINES
:
2540 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
2542 ctx
->max_pipelines
= larg
;
2544 case SSL_CTRL_CERT_FLAGS
:
2545 return (ctx
->cert
->cert_flags
|= larg
);
2546 case SSL_CTRL_CLEAR_CERT_FLAGS
:
2547 return (ctx
->cert
->cert_flags
&= ~larg
);
2548 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
2549 return ssl_check_allowed_versions(larg
, ctx
->max_proto_version
)
2550 && ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
2551 &ctx
->min_proto_version
);
2552 case SSL_CTRL_GET_MIN_PROTO_VERSION
:
2553 return ctx
->min_proto_version
;
2554 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
2555 return ssl_check_allowed_versions(ctx
->min_proto_version
, larg
)
2556 && ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
2557 &ctx
->max_proto_version
);
2558 case SSL_CTRL_GET_MAX_PROTO_VERSION
:
2559 return ctx
->max_proto_version
;
2561 return ctx
->method
->ssl_ctx_ctrl(ctx
, cmd
, larg
, parg
);
2565 long SSL_CTX_callback_ctrl(SSL_CTX
*ctx
, int cmd
, void (*fp
) (void))
2568 case SSL_CTRL_SET_MSG_CALLBACK
:
2569 ctx
->msg_callback
= (void (*)
2570 (int write_p
, int version
, int content_type
,
2571 const void *buf
, size_t len
, SSL
*ssl
,
2576 return ctx
->method
->ssl_ctx_callback_ctrl(ctx
, cmd
, fp
);
2580 int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
)
2589 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
2590 const SSL_CIPHER
*const *bp
)
2592 if ((*ap
)->id
> (*bp
)->id
)
2594 if ((*ap
)->id
< (*bp
)->id
)
2599 /** return a STACK of the ciphers available for the SSL and in order of
2601 STACK_OF(SSL_CIPHER
) *SSL_get_ciphers(const SSL
*s
)
2604 if (s
->cipher_list
!= NULL
) {
2605 return s
->cipher_list
;
2606 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list
!= NULL
)) {
2607 return s
->ctx
->cipher_list
;
2613 STACK_OF(SSL_CIPHER
) *SSL_get_client_ciphers(const SSL
*s
)
2615 if ((s
== NULL
) || !s
->server
)
2617 return s
->peer_ciphers
;
2620 STACK_OF(SSL_CIPHER
) *SSL_get1_supported_ciphers(SSL
*s
)
2622 STACK_OF(SSL_CIPHER
) *sk
= NULL
, *ciphers
;
2625 ciphers
= SSL_get_ciphers(s
);
2628 if (!ssl_set_client_disabled(s
))
2630 for (i
= 0; i
< sk_SSL_CIPHER_num(ciphers
); i
++) {
2631 const SSL_CIPHER
*c
= sk_SSL_CIPHER_value(ciphers
, i
);
2632 if (!ssl_cipher_disabled(s
, c
, SSL_SECOP_CIPHER_SUPPORTED
, 0)) {
2634 sk
= sk_SSL_CIPHER_new_null();
2637 if (!sk_SSL_CIPHER_push(sk
, c
)) {
2638 sk_SSL_CIPHER_free(sk
);
2646 /** return a STACK of the ciphers available for the SSL and in order of
2648 STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
)
2651 if (s
->cipher_list_by_id
!= NULL
) {
2652 return s
->cipher_list_by_id
;
2653 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list_by_id
!= NULL
)) {
2654 return s
->ctx
->cipher_list_by_id
;
2660 /** The old interface to get the same thing as SSL_get_ciphers() */
2661 const char *SSL_get_cipher_list(const SSL
*s
, int n
)
2663 const SSL_CIPHER
*c
;
2664 STACK_OF(SSL_CIPHER
) *sk
;
2668 sk
= SSL_get_ciphers(s
);
2669 if ((sk
== NULL
) || (sk_SSL_CIPHER_num(sk
) <= n
))
2671 c
= sk_SSL_CIPHER_value(sk
, n
);
2677 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2679 STACK_OF(SSL_CIPHER
) *SSL_CTX_get_ciphers(const SSL_CTX
*ctx
)
2682 return ctx
->cipher_list
;
2687 * Distinguish between ciphers controlled by set_ciphersuite() and
2688 * set_cipher_list() when counting.
2690 static int cipher_list_tls12_num(STACK_OF(SSL_CIPHER
) *sk
)
2693 const SSL_CIPHER
*c
;
2697 for (i
= 0; i
< sk_SSL_CIPHER_num(sk
); ++i
) {
2698 c
= sk_SSL_CIPHER_value(sk
, i
);
2699 if (c
->min_tls
>= TLS1_3_VERSION
)
2706 /** specify the ciphers to be used by default by the SSL_CTX */
2707 int SSL_CTX_set_cipher_list(SSL_CTX
*ctx
, const char *str
)
2709 STACK_OF(SSL_CIPHER
) *sk
;
2711 sk
= ssl_create_cipher_list(ctx
, ctx
->tls13_ciphersuites
,
2712 &ctx
->cipher_list
, &ctx
->cipher_list_by_id
, str
,
2715 * ssl_create_cipher_list may return an empty stack if it was unable to
2716 * find a cipher matching the given rule string (for example if the rule
2717 * string specifies a cipher which has been disabled). This is not an
2718 * error as far as ssl_create_cipher_list is concerned, and hence
2719 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2723 else if (cipher_list_tls12_num(sk
) == 0) {
2724 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CIPHER_MATCH
);
2730 /** specify the ciphers to be used by the SSL */
2731 int SSL_set_cipher_list(SSL
*s
, const char *str
)
2733 STACK_OF(SSL_CIPHER
) *sk
;
2735 sk
= ssl_create_cipher_list(s
->ctx
, s
->tls13_ciphersuites
,
2736 &s
->cipher_list
, &s
->cipher_list_by_id
, str
,
2738 /* see comment in SSL_CTX_set_cipher_list */
2741 else if (cipher_list_tls12_num(sk
) == 0) {
2742 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CIPHER_MATCH
);
2748 char *SSL_get_shared_ciphers(const SSL
*s
, char *buf
, int size
)
2751 STACK_OF(SSL_CIPHER
) *clntsk
, *srvrsk
;
2752 const SSL_CIPHER
*c
;
2756 || s
->peer_ciphers
== NULL
2761 clntsk
= s
->peer_ciphers
;
2762 srvrsk
= SSL_get_ciphers(s
);
2763 if (clntsk
== NULL
|| srvrsk
== NULL
)
2766 if (sk_SSL_CIPHER_num(clntsk
) == 0 || sk_SSL_CIPHER_num(srvrsk
) == 0)
2769 for (i
= 0; i
< sk_SSL_CIPHER_num(clntsk
); i
++) {
2772 c
= sk_SSL_CIPHER_value(clntsk
, i
);
2773 if (sk_SSL_CIPHER_find(srvrsk
, c
) < 0)
2776 n
= strlen(c
->name
);
2793 * Return the requested servername (SNI) value. Note that the behaviour varies
2795 * - whether this is called by the client or the server,
2796 * - if we are before or during/after the handshake,
2797 * - if a resumption or normal handshake is being attempted/has occurred
2798 * - whether we have negotiated TLSv1.2 (or below) or TLSv1.3
2800 * Note that only the host_name type is defined (RFC 3546).
2802 const char *SSL_get_servername(const SSL
*s
, const int type
)
2805 * If we don't know if we are the client or the server yet then we assume
2808 int server
= s
->handshake_func
== NULL
? 0 : s
->server
;
2809 if (type
!= TLSEXT_NAMETYPE_host_name
)
2815 * In TLSv1.3 on the server SNI is not associated with the session
2816 * but in TLSv1.2 or below it is.
2818 * Before the handshake:
2821 * During/after the handshake (TLSv1.2 or below resumption occurred):
2822 * - If a servername was accepted by the server in the original
2823 * handshake then it will return that servername, or NULL otherwise.
2825 * During/after the handshake (TLSv1.2 or below resumption did not occur):
2826 * - The function will return the servername requested by the client in
2827 * this handshake or NULL if none was requested.
2829 if (s
->hit
&& !SSL_IS_TLS13(s
))
2830 return s
->session
->ext
.hostname
;
2835 * Before the handshake:
2836 * - If a servername has been set via a call to
2837 * SSL_set_tlsext_host_name() then it will return that servername
2838 * - If one has not been set, but a TLSv1.2 resumption is being
2839 * attempted and the session from the original handshake had a
2840 * servername accepted by the server then it will return that
2842 * - Otherwise it returns NULL
2844 * During/after the handshake (TLSv1.2 or below resumption occurred):
2845 * - If the session from the original handshake had a servername accepted
2846 * by the server then it will return that servername.
2847 * - Otherwise it returns the servername set via
2848 * SSL_set_tlsext_host_name() (or NULL if it was not called).
2850 * During/after the handshake (TLSv1.2 or below resumption did not occur):
2851 * - It will return the servername set via SSL_set_tlsext_host_name()
2852 * (or NULL if it was not called).
2854 if (SSL_in_before(s
)) {
2855 if (s
->ext
.hostname
== NULL
2856 && s
->session
!= NULL
2857 && s
->session
->ssl_version
!= TLS1_3_VERSION
)
2858 return s
->session
->ext
.hostname
;
2860 if (!SSL_IS_TLS13(s
) && s
->hit
&& s
->session
->ext
.hostname
!= NULL
)
2861 return s
->session
->ext
.hostname
;
2865 return s
->ext
.hostname
;
2868 int SSL_get_servername_type(const SSL
*s
)
2870 if (SSL_get_servername(s
, TLSEXT_NAMETYPE_host_name
) != NULL
)
2871 return TLSEXT_NAMETYPE_host_name
;
2876 * SSL_select_next_proto implements the standard protocol selection. It is
2877 * expected that this function is called from the callback set by
2878 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2879 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2880 * not included in the length. A byte string of length 0 is invalid. No byte
2881 * string may be truncated. The current, but experimental algorithm for
2882 * selecting the protocol is: 1) If the server doesn't support NPN then this
2883 * is indicated to the callback. In this case, the client application has to
2884 * abort the connection or have a default application level protocol. 2) If
2885 * the server supports NPN, but advertises an empty list then the client
2886 * selects the first protocol in its list, but indicates via the API that this
2887 * fallback case was enacted. 3) Otherwise, the client finds the first
2888 * protocol in the server's list that it supports and selects this protocol.
2889 * This is because it's assumed that the server has better information about
2890 * which protocol a client should use. 4) If the client doesn't support any
2891 * of the server's advertised protocols, then this is treated the same as
2892 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2893 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2895 int SSL_select_next_proto(unsigned char **out
, unsigned char *outlen
,
2896 const unsigned char *server
,
2897 unsigned int server_len
,
2898 const unsigned char *client
, unsigned int client_len
)
2901 const unsigned char *result
;
2902 int status
= OPENSSL_NPN_UNSUPPORTED
;
2905 * For each protocol in server preference order, see if we support it.
2907 for (i
= 0; i
< server_len
;) {
2908 for (j
= 0; j
< client_len
;) {
2909 if (server
[i
] == client
[j
] &&
2910 memcmp(&server
[i
+ 1], &client
[j
+ 1], server
[i
]) == 0) {
2911 /* We found a match */
2912 result
= &server
[i
];
2913 status
= OPENSSL_NPN_NEGOTIATED
;
2923 /* There's no overlap between our protocols and the server's list. */
2925 status
= OPENSSL_NPN_NO_OVERLAP
;
2928 *out
= (unsigned char *)result
+ 1;
2929 *outlen
= result
[0];
2933 #ifndef OPENSSL_NO_NEXTPROTONEG
2935 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2936 * client's requested protocol for this connection and returns 0. If the
2937 * client didn't request any protocol, then *data is set to NULL. Note that
2938 * the client can request any protocol it chooses. The value returned from
2939 * this function need not be a member of the list of supported protocols
2940 * provided by the callback.
2942 void SSL_get0_next_proto_negotiated(const SSL
*s
, const unsigned char **data
,
2946 if (*data
== NULL
) {
2949 *len
= (unsigned int)s
->ext
.npn_len
;
2954 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2955 * a TLS server needs a list of supported protocols for Next Protocol
2956 * Negotiation. The returned list must be in wire format. The list is
2957 * returned by setting |out| to point to it and |outlen| to its length. This
2958 * memory will not be modified, but one should assume that the SSL* keeps a
2959 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2960 * wishes to advertise. Otherwise, no such extension will be included in the
2963 void SSL_CTX_set_npn_advertised_cb(SSL_CTX
*ctx
,
2964 SSL_CTX_npn_advertised_cb_func cb
,
2967 ctx
->ext
.npn_advertised_cb
= cb
;
2968 ctx
->ext
.npn_advertised_cb_arg
= arg
;
2972 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2973 * client needs to select a protocol from the server's provided list. |out|
2974 * must be set to point to the selected protocol (which may be within |in|).
2975 * The length of the protocol name must be written into |outlen|. The
2976 * server's advertised protocols are provided in |in| and |inlen|. The
2977 * callback can assume that |in| is syntactically valid. The client must
2978 * select a protocol. It is fatal to the connection if this callback returns
2979 * a value other than SSL_TLSEXT_ERR_OK.
2981 void SSL_CTX_set_npn_select_cb(SSL_CTX
*ctx
,
2982 SSL_CTX_npn_select_cb_func cb
,
2985 ctx
->ext
.npn_select_cb
= cb
;
2986 ctx
->ext
.npn_select_cb_arg
= arg
;
2990 static int alpn_value_ok(const unsigned char *protos
, unsigned int protos_len
)
2994 if (protos_len
< 2 || protos
== NULL
)
2997 for (idx
= 0; idx
< protos_len
; idx
+= protos
[idx
] + 1) {
2998 if (protos
[idx
] == 0)
3001 return idx
== protos_len
;
3004 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
3005 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
3006 * length-prefixed strings). Returns 0 on success.
3008 int SSL_CTX_set_alpn_protos(SSL_CTX
*ctx
, const unsigned char *protos
,
3009 unsigned int protos_len
)
3011 unsigned char *alpn
;
3013 if (protos_len
== 0 || protos
== NULL
) {
3014 OPENSSL_free(ctx
->ext
.alpn
);
3015 ctx
->ext
.alpn
= NULL
;
3016 ctx
->ext
.alpn_len
= 0;
3019 /* Not valid per RFC */
3020 if (!alpn_value_ok(protos
, protos_len
))
3023 alpn
= OPENSSL_memdup(protos
, protos_len
);
3025 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3028 OPENSSL_free(ctx
->ext
.alpn
);
3029 ctx
->ext
.alpn
= alpn
;
3030 ctx
->ext
.alpn_len
= protos_len
;
3036 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
3037 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
3038 * length-prefixed strings). Returns 0 on success.
3040 int SSL_set_alpn_protos(SSL
*ssl
, const unsigned char *protos
,
3041 unsigned int protos_len
)
3043 unsigned char *alpn
;
3045 if (protos_len
== 0 || protos
== NULL
) {
3046 OPENSSL_free(ssl
->ext
.alpn
);
3047 ssl
->ext
.alpn
= NULL
;
3048 ssl
->ext
.alpn_len
= 0;
3051 /* Not valid per RFC */
3052 if (!alpn_value_ok(protos
, protos_len
))
3055 alpn
= OPENSSL_memdup(protos
, protos_len
);
3057 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3060 OPENSSL_free(ssl
->ext
.alpn
);
3061 ssl
->ext
.alpn
= alpn
;
3062 ssl
->ext
.alpn_len
= protos_len
;
3068 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
3069 * called during ClientHello processing in order to select an ALPN protocol
3070 * from the client's list of offered protocols.
3072 void SSL_CTX_set_alpn_select_cb(SSL_CTX
*ctx
,
3073 SSL_CTX_alpn_select_cb_func cb
,
3076 ctx
->ext
.alpn_select_cb
= cb
;
3077 ctx
->ext
.alpn_select_cb_arg
= arg
;
3081 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
3082 * On return it sets |*data| to point to |*len| bytes of protocol name
3083 * (not including the leading length-prefix byte). If the server didn't
3084 * respond with a negotiated protocol then |*len| will be zero.
3086 void SSL_get0_alpn_selected(const SSL
*ssl
, const unsigned char **data
,
3089 *data
= ssl
->s3
.alpn_selected
;
3093 *len
= (unsigned int)ssl
->s3
.alpn_selected_len
;
3096 int SSL_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
3097 const char *label
, size_t llen
,
3098 const unsigned char *context
, size_t contextlen
,
3101 if (s
->session
== NULL
3102 || (s
->version
< TLS1_VERSION
&& s
->version
!= DTLS1_BAD_VER
))
3105 return s
->method
->ssl3_enc
->export_keying_material(s
, out
, olen
, label
,
3107 contextlen
, use_context
);
3110 int SSL_export_keying_material_early(SSL
*s
, unsigned char *out
, size_t olen
,
3111 const char *label
, size_t llen
,
3112 const unsigned char *context
,
3115 if (s
->version
!= TLS1_3_VERSION
)
3118 return tls13_export_keying_material_early(s
, out
, olen
, label
, llen
,
3119 context
, contextlen
);
3122 static unsigned long ssl_session_hash(const SSL_SESSION
*a
)
3124 const unsigned char *session_id
= a
->session_id
;
3126 unsigned char tmp_storage
[4];
3128 if (a
->session_id_length
< sizeof(tmp_storage
)) {
3129 memset(tmp_storage
, 0, sizeof(tmp_storage
));
3130 memcpy(tmp_storage
, a
->session_id
, a
->session_id_length
);
3131 session_id
= tmp_storage
;
3135 ((unsigned long)session_id
[0]) |
3136 ((unsigned long)session_id
[1] << 8L) |
3137 ((unsigned long)session_id
[2] << 16L) |
3138 ((unsigned long)session_id
[3] << 24L);
3143 * NB: If this function (or indeed the hash function which uses a sort of
3144 * coarser function than this one) is changed, ensure
3145 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
3146 * being able to construct an SSL_SESSION that will collide with any existing
3147 * session with a matching session ID.
3149 static int ssl_session_cmp(const SSL_SESSION
*a
, const SSL_SESSION
*b
)
3151 if (a
->ssl_version
!= b
->ssl_version
)
3153 if (a
->session_id_length
!= b
->session_id_length
)
3155 return memcmp(a
->session_id
, b
->session_id
, a
->session_id_length
);
3159 * These wrapper functions should remain rather than redeclaring
3160 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
3161 * variable. The reason is that the functions aren't static, they're exposed
3165 SSL_CTX
*SSL_CTX_new_ex(OSSL_LIB_CTX
*libctx
, const char *propq
,
3166 const SSL_METHOD
*meth
)
3168 SSL_CTX
*ret
= NULL
;
3171 ERR_raise(ERR_LIB_SSL
, SSL_R_NULL_SSL_METHOD_PASSED
);
3175 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS
, NULL
))
3178 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
3179 ERR_raise(ERR_LIB_SSL
, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS
);
3182 ret
= OPENSSL_zalloc(sizeof(*ret
));
3186 /* Init the reference counting before any call to SSL_CTX_free */
3187 ret
->references
= 1;
3188 ret
->lock
= CRYPTO_THREAD_lock_new();
3189 if (ret
->lock
== NULL
) {
3190 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3195 ret
->libctx
= libctx
;
3196 if (propq
!= NULL
) {
3197 ret
->propq
= OPENSSL_strdup(propq
);
3198 if (ret
->propq
== NULL
)
3203 ret
->min_proto_version
= 0;
3204 ret
->max_proto_version
= 0;
3205 ret
->mode
= SSL_MODE_AUTO_RETRY
;
3206 ret
->session_cache_mode
= SSL_SESS_CACHE_SERVER
;
3207 ret
->session_cache_size
= SSL_SESSION_CACHE_MAX_SIZE_DEFAULT
;
3208 /* We take the system default. */
3209 ret
->session_timeout
= meth
->get_timeout();
3210 ret
->max_cert_list
= SSL_MAX_CERT_LIST_DEFAULT
;
3211 ret
->verify_mode
= SSL_VERIFY_NONE
;
3212 if ((ret
->cert
= ssl_cert_new()) == NULL
)
3215 ret
->sessions
= lh_SSL_SESSION_new(ssl_session_hash
, ssl_session_cmp
);
3216 if (ret
->sessions
== NULL
)
3218 ret
->cert_store
= X509_STORE_new();
3219 if (ret
->cert_store
== NULL
)
3221 #ifndef OPENSSL_NO_CT
3222 ret
->ctlog_store
= CTLOG_STORE_new_ex(libctx
, propq
);
3223 if (ret
->ctlog_store
== NULL
)
3227 /* initialize cipher/digest methods table */
3228 if (!ssl_load_ciphers(ret
))
3230 /* initialise sig algs */
3231 if (!ssl_setup_sig_algs(ret
))
3235 if (!ssl_load_groups(ret
))
3238 if (!SSL_CTX_set_ciphersuites(ret
, OSSL_default_ciphersuites()))
3241 if (!ssl_create_cipher_list(ret
,
3242 ret
->tls13_ciphersuites
,
3243 &ret
->cipher_list
, &ret
->cipher_list_by_id
,
3244 OSSL_default_cipher_list(), ret
->cert
)
3245 || sk_SSL_CIPHER_num(ret
->cipher_list
) <= 0) {
3246 ERR_raise(ERR_LIB_SSL
, SSL_R_LIBRARY_HAS_NO_CIPHERS
);
3250 ret
->param
= X509_VERIFY_PARAM_new();
3251 if (ret
->param
== NULL
)
3255 * If these aren't available from the provider we'll get NULL returns.
3256 * That's fine but will cause errors later if SSLv3 is negotiated
3258 ret
->md5
= ssl_evp_md_fetch(libctx
, NID_md5
, propq
);
3259 ret
->sha1
= ssl_evp_md_fetch(libctx
, NID_sha1
, propq
);
3261 if ((ret
->ca_names
= sk_X509_NAME_new_null()) == NULL
)
3264 if ((ret
->client_ca_names
= sk_X509_NAME_new_null()) == NULL
)
3267 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, ret
, &ret
->ex_data
))
3270 if ((ret
->ext
.secure
= OPENSSL_secure_zalloc(sizeof(*ret
->ext
.secure
))) == NULL
)
3273 /* No compression for DTLS */
3274 if (!(meth
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_DTLS
))
3275 ret
->comp_methods
= SSL_COMP_get_compression_methods();
3277 ret
->max_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
3278 ret
->split_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
3280 /* Setup RFC5077 ticket keys */
3281 if ((RAND_bytes_ex(libctx
, ret
->ext
.tick_key_name
,
3282 sizeof(ret
->ext
.tick_key_name
), 0) <= 0)
3283 || (RAND_priv_bytes_ex(libctx
, ret
->ext
.secure
->tick_hmac_key
,
3284 sizeof(ret
->ext
.secure
->tick_hmac_key
), 0) <= 0)
3285 || (RAND_priv_bytes_ex(libctx
, ret
->ext
.secure
->tick_aes_key
,
3286 sizeof(ret
->ext
.secure
->tick_aes_key
), 0) <= 0))
3287 ret
->options
|= SSL_OP_NO_TICKET
;
3289 if (RAND_priv_bytes_ex(libctx
, ret
->ext
.cookie_hmac_key
,
3290 sizeof(ret
->ext
.cookie_hmac_key
), 0) <= 0)
3293 #ifndef OPENSSL_NO_SRP
3294 if (!ssl_ctx_srp_ctx_init_intern(ret
))
3297 #ifndef OPENSSL_NO_ENGINE
3298 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3299 # define eng_strx(x) #x
3300 # define eng_str(x) eng_strx(x)
3301 /* Use specific client engine automatically... ignore errors */
3304 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
3307 ENGINE_load_builtin_engines();
3308 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
3310 if (!eng
|| !SSL_CTX_set_client_cert_engine(ret
, eng
))
3316 * Disable compression by default to prevent CRIME. Applications can
3317 * re-enable compression by configuring
3318 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3319 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3320 * middlebox compatibility by default. This may be disabled by default in
3321 * a later OpenSSL version.
3323 ret
->options
|= SSL_OP_NO_COMPRESSION
| SSL_OP_ENABLE_MIDDLEBOX_COMPAT
;
3325 ret
->ext
.status_type
= TLSEXT_STATUSTYPE_nothing
;
3328 * We cannot usefully set a default max_early_data here (which gets
3329 * propagated in SSL_new(), for the following reason: setting the
3330 * SSL field causes tls_construct_stoc_early_data() to tell the
3331 * client that early data will be accepted when constructing a TLS 1.3
3332 * session ticket, and the client will accordingly send us early data
3333 * when using that ticket (if the client has early data to send).
3334 * However, in order for the early data to actually be consumed by
3335 * the application, the application must also have calls to
3336 * SSL_read_early_data(); otherwise we'll just skip past the early data
3337 * and ignore it. So, since the application must add calls to
3338 * SSL_read_early_data(), we also require them to add
3339 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3340 * eliminating the bandwidth-wasting early data in the case described
3343 ret
->max_early_data
= 0;
3346 * Default recv_max_early_data is a fully loaded single record. Could be
3347 * split across multiple records in practice. We set this differently to
3348 * max_early_data so that, in the default case, we do not advertise any
3349 * support for early_data, but if a client were to send us some (e.g.
3350 * because of an old, stale ticket) then we will tolerate it and skip over
3353 ret
->recv_max_early_data
= SSL3_RT_MAX_PLAIN_LENGTH
;
3355 /* By default we send two session tickets automatically in TLSv1.3 */
3356 ret
->num_tickets
= 2;
3358 ssl_ctx_system_config(ret
);
3362 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3368 SSL_CTX
*SSL_CTX_new(const SSL_METHOD
*meth
)
3370 return SSL_CTX_new_ex(NULL
, NULL
, meth
);
3373 int SSL_CTX_up_ref(SSL_CTX
*ctx
)
3377 if (CRYPTO_UP_REF(&ctx
->references
, &i
, ctx
->lock
) <= 0)
3380 REF_PRINT_COUNT("SSL_CTX", ctx
);
3381 REF_ASSERT_ISNT(i
< 2);
3382 return ((i
> 1) ? 1 : 0);
3385 void SSL_CTX_free(SSL_CTX
*a
)
3393 CRYPTO_DOWN_REF(&a
->references
, &i
, a
->lock
);
3394 REF_PRINT_COUNT("SSL_CTX", a
);
3397 REF_ASSERT_ISNT(i
< 0);
3399 X509_VERIFY_PARAM_free(a
->param
);
3400 dane_ctx_final(&a
->dane
);
3403 * Free internal session cache. However: the remove_cb() may reference
3404 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3405 * after the sessions were flushed.
3406 * As the ex_data handling routines might also touch the session cache,
3407 * the most secure solution seems to be: empty (flush) the cache, then
3408 * free ex_data, then finally free the cache.
3409 * (See ticket [openssl.org #212].)
3411 if (a
->sessions
!= NULL
)
3412 SSL_CTX_flush_sessions(a
, 0);
3414 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, a
, &a
->ex_data
);
3415 lh_SSL_SESSION_free(a
->sessions
);
3416 X509_STORE_free(a
->cert_store
);
3417 #ifndef OPENSSL_NO_CT
3418 CTLOG_STORE_free(a
->ctlog_store
);
3420 sk_SSL_CIPHER_free(a
->cipher_list
);
3421 sk_SSL_CIPHER_free(a
->cipher_list_by_id
);
3422 sk_SSL_CIPHER_free(a
->tls13_ciphersuites
);
3423 ssl_cert_free(a
->cert
);
3424 sk_X509_NAME_pop_free(a
->ca_names
, X509_NAME_free
);
3425 sk_X509_NAME_pop_free(a
->client_ca_names
, X509_NAME_free
);
3426 sk_X509_pop_free(a
->extra_certs
, X509_free
);
3427 a
->comp_methods
= NULL
;
3428 #ifndef OPENSSL_NO_SRTP
3429 sk_SRTP_PROTECTION_PROFILE_free(a
->srtp_profiles
);
3431 #ifndef OPENSSL_NO_SRP
3432 ssl_ctx_srp_ctx_free_intern(a
);
3434 #ifndef OPENSSL_NO_ENGINE
3435 tls_engine_finish(a
->client_cert_engine
);
3438 OPENSSL_free(a
->ext
.ecpointformats
);
3439 OPENSSL_free(a
->ext
.supportedgroups
);
3440 OPENSSL_free(a
->ext
.supported_groups_default
);
3441 OPENSSL_free(a
->ext
.alpn
);
3442 OPENSSL_secure_free(a
->ext
.secure
);
3444 ssl_evp_md_free(a
->md5
);
3445 ssl_evp_md_free(a
->sha1
);
3447 for (j
= 0; j
< SSL_ENC_NUM_IDX
; j
++)
3448 ssl_evp_cipher_free(a
->ssl_cipher_methods
[j
]);
3449 for (j
= 0; j
< SSL_MD_NUM_IDX
; j
++)
3450 ssl_evp_md_free(a
->ssl_digest_methods
[j
]);
3451 for (j
= 0; j
< a
->group_list_len
; j
++) {
3452 OPENSSL_free(a
->group_list
[j
].tlsname
);
3453 OPENSSL_free(a
->group_list
[j
].realname
);
3454 OPENSSL_free(a
->group_list
[j
].algorithm
);
3456 OPENSSL_free(a
->group_list
);
3458 OPENSSL_free(a
->sigalg_lookup_cache
);
3460 CRYPTO_THREAD_lock_free(a
->lock
);
3462 OPENSSL_free(a
->propq
);
3467 void SSL_CTX_set_default_passwd_cb(SSL_CTX
*ctx
, pem_password_cb
*cb
)
3469 ctx
->default_passwd_callback
= cb
;
3472 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX
*ctx
, void *u
)
3474 ctx
->default_passwd_callback_userdata
= u
;
3477 pem_password_cb
*SSL_CTX_get_default_passwd_cb(SSL_CTX
*ctx
)
3479 return ctx
->default_passwd_callback
;
3482 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX
*ctx
)
3484 return ctx
->default_passwd_callback_userdata
;
3487 void SSL_set_default_passwd_cb(SSL
*s
, pem_password_cb
*cb
)
3489 s
->default_passwd_callback
= cb
;
3492 void SSL_set_default_passwd_cb_userdata(SSL
*s
, void *u
)
3494 s
->default_passwd_callback_userdata
= u
;
3497 pem_password_cb
*SSL_get_default_passwd_cb(SSL
*s
)
3499 return s
->default_passwd_callback
;
3502 void *SSL_get_default_passwd_cb_userdata(SSL
*s
)
3504 return s
->default_passwd_callback_userdata
;
3507 void SSL_CTX_set_cert_verify_callback(SSL_CTX
*ctx
,
3508 int (*cb
) (X509_STORE_CTX
*, void *),
3511 ctx
->app_verify_callback
= cb
;
3512 ctx
->app_verify_arg
= arg
;
3515 void SSL_CTX_set_verify(SSL_CTX
*ctx
, int mode
,
3516 int (*cb
) (int, X509_STORE_CTX
*))
3518 ctx
->verify_mode
= mode
;
3519 ctx
->default_verify_callback
= cb
;
3522 void SSL_CTX_set_verify_depth(SSL_CTX
*ctx
, int depth
)
3524 X509_VERIFY_PARAM_set_depth(ctx
->param
, depth
);
3527 void SSL_CTX_set_cert_cb(SSL_CTX
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
3529 ssl_cert_set_cert_cb(c
->cert
, cb
, arg
);
3532 void SSL_set_cert_cb(SSL
*s
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
3534 ssl_cert_set_cert_cb(s
->cert
, cb
, arg
);
3537 void ssl_set_masks(SSL
*s
)
3540 uint32_t *pvalid
= s
->s3
.tmp
.valid_flags
;
3541 int rsa_enc
, rsa_sign
, dh_tmp
, dsa_sign
;
3542 unsigned long mask_k
, mask_a
;
3543 int have_ecc_cert
, ecdsa_ok
;
3548 dh_tmp
= (c
->dh_tmp
!= NULL
3549 || c
->dh_tmp_cb
!= NULL
3552 rsa_enc
= pvalid
[SSL_PKEY_RSA
] & CERT_PKEY_VALID
;
3553 rsa_sign
= pvalid
[SSL_PKEY_RSA
] & CERT_PKEY_VALID
;
3554 dsa_sign
= pvalid
[SSL_PKEY_DSA_SIGN
] & CERT_PKEY_VALID
;
3555 have_ecc_cert
= pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_VALID
;
3559 OSSL_TRACE4(TLS_CIPHER
, "dh_tmp=%d rsa_enc=%d rsa_sign=%d dsa_sign=%d\n",
3560 dh_tmp
, rsa_enc
, rsa_sign
, dsa_sign
);
3562 #ifndef OPENSSL_NO_GOST
3563 if (ssl_has_cert(s
, SSL_PKEY_GOST12_512
)) {
3564 mask_k
|= SSL_kGOST
| SSL_kGOST18
;
3565 mask_a
|= SSL_aGOST12
;
3567 if (ssl_has_cert(s
, SSL_PKEY_GOST12_256
)) {
3568 mask_k
|= SSL_kGOST
| SSL_kGOST18
;
3569 mask_a
|= SSL_aGOST12
;
3571 if (ssl_has_cert(s
, SSL_PKEY_GOST01
)) {
3572 mask_k
|= SSL_kGOST
;
3573 mask_a
|= SSL_aGOST01
;
3584 * If we only have an RSA-PSS certificate allow RSA authentication
3585 * if TLS 1.2 and peer supports it.
3588 if (rsa_enc
|| rsa_sign
|| (ssl_has_cert(s
, SSL_PKEY_RSA_PSS_SIGN
)
3589 && pvalid
[SSL_PKEY_RSA_PSS_SIGN
] & CERT_PKEY_EXPLICIT_SIGN
3590 && TLS1_get_version(s
) == TLS1_2_VERSION
))
3597 mask_a
|= SSL_aNULL
;
3600 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3601 * depending on the key usage extension.
3603 if (have_ecc_cert
) {
3605 ex_kusage
= X509_get_key_usage(c
->pkeys
[SSL_PKEY_ECC
].x509
);
3606 ecdsa_ok
= ex_kusage
& X509v3_KU_DIGITAL_SIGNATURE
;
3607 if (!(pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_SIGN
))
3610 mask_a
|= SSL_aECDSA
;
3612 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3613 if (!(mask_a
& SSL_aECDSA
) && ssl_has_cert(s
, SSL_PKEY_ED25519
)
3614 && pvalid
[SSL_PKEY_ED25519
] & CERT_PKEY_EXPLICIT_SIGN
3615 && TLS1_get_version(s
) == TLS1_2_VERSION
)
3616 mask_a
|= SSL_aECDSA
;
3618 /* Allow Ed448 for TLS 1.2 if peer supports it */
3619 if (!(mask_a
& SSL_aECDSA
) && ssl_has_cert(s
, SSL_PKEY_ED448
)
3620 && pvalid
[SSL_PKEY_ED448
] & CERT_PKEY_EXPLICIT_SIGN
3621 && TLS1_get_version(s
) == TLS1_2_VERSION
)
3622 mask_a
|= SSL_aECDSA
;
3624 mask_k
|= SSL_kECDHE
;
3626 #ifndef OPENSSL_NO_PSK
3629 if (mask_k
& SSL_kRSA
)
3630 mask_k
|= SSL_kRSAPSK
;
3631 if (mask_k
& SSL_kDHE
)
3632 mask_k
|= SSL_kDHEPSK
;
3633 if (mask_k
& SSL_kECDHE
)
3634 mask_k
|= SSL_kECDHEPSK
;
3637 s
->s3
.tmp
.mask_k
= mask_k
;
3638 s
->s3
.tmp
.mask_a
= mask_a
;
3641 int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
)
3643 if (s
->s3
.tmp
.new_cipher
->algorithm_auth
& SSL_aECDSA
) {
3644 /* key usage, if present, must allow signing */
3645 if (!(X509_get_key_usage(x
) & X509v3_KU_DIGITAL_SIGNATURE
)) {
3646 ERR_raise(ERR_LIB_SSL
, SSL_R_ECC_CERT_NOT_FOR_SIGNING
);
3650 return 1; /* all checks are ok */
3653 int ssl_get_server_cert_serverinfo(SSL
*s
, const unsigned char **serverinfo
,
3654 size_t *serverinfo_length
)
3656 CERT_PKEY
*cpk
= s
->s3
.tmp
.cert
;
3657 *serverinfo_length
= 0;
3659 if (cpk
== NULL
|| cpk
->serverinfo
== NULL
)
3662 *serverinfo
= cpk
->serverinfo
;
3663 *serverinfo_length
= cpk
->serverinfo_length
;
3667 void ssl_update_cache(SSL
*s
, int mode
)
3672 * If the session_id_length is 0, we are not supposed to cache it, and it
3673 * would be rather hard to do anyway :-)
3675 if (s
->session
->session_id_length
== 0)
3679 * If sid_ctx_length is 0 there is no specific application context
3680 * associated with this session, so when we try to resume it and
3681 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3682 * indication that this is actually a session for the proper application
3683 * context, and the *handshake* will fail, not just the resumption attempt.
3684 * Do not cache (on the server) these sessions that are not resumable
3685 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3687 if (s
->server
&& s
->session
->sid_ctx_length
== 0
3688 && (s
->verify_mode
& SSL_VERIFY_PEER
) != 0)
3691 i
= s
->session_ctx
->session_cache_mode
;
3693 && (!s
->hit
|| SSL_IS_TLS13(s
))) {
3695 * Add the session to the internal cache. In server side TLSv1.3 we
3696 * normally don't do this because by default it's a full stateless ticket
3697 * with only a dummy session id so there is no reason to cache it,
3699 * - we are doing early_data, in which case we cache so that we can
3701 * - the application has set a remove_session_cb so needs to know about
3702 * session timeout events
3703 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3705 if ((i
& SSL_SESS_CACHE_NO_INTERNAL_STORE
) == 0
3706 && (!SSL_IS_TLS13(s
)
3708 || (s
->max_early_data
> 0
3709 && (s
->options
& SSL_OP_NO_ANTI_REPLAY
) == 0)
3710 || s
->session_ctx
->remove_session_cb
!= NULL
3711 || (s
->options
& SSL_OP_NO_TICKET
) != 0))
3712 SSL_CTX_add_session(s
->session_ctx
, s
->session
);
3715 * Add the session to the external cache. We do this even in server side
3716 * TLSv1.3 without early data because some applications just want to
3717 * know about the creation of a session and aren't doing a full cache.
3719 if (s
->session_ctx
->new_session_cb
!= NULL
) {
3720 SSL_SESSION_up_ref(s
->session
);
3721 if (!s
->session_ctx
->new_session_cb(s
, s
->session
))
3722 SSL_SESSION_free(s
->session
);
3726 /* auto flush every 255 connections */
3727 if ((!(i
& SSL_SESS_CACHE_NO_AUTO_CLEAR
)) && ((i
& mode
) == mode
)) {
3728 TSAN_QUALIFIER
int *stat
;
3729 if (mode
& SSL_SESS_CACHE_CLIENT
)
3730 stat
= &s
->session_ctx
->stats
.sess_connect_good
;
3732 stat
= &s
->session_ctx
->stats
.sess_accept_good
;
3733 if ((tsan_load(stat
) & 0xff) == 0xff)
3734 SSL_CTX_flush_sessions(s
->session_ctx
, (unsigned long)time(NULL
));
3738 const SSL_METHOD
*SSL_CTX_get_ssl_method(const SSL_CTX
*ctx
)
3743 const SSL_METHOD
*SSL_get_ssl_method(const SSL
*s
)
3748 int SSL_set_ssl_method(SSL
*s
, const SSL_METHOD
*meth
)
3752 if (s
->method
!= meth
) {
3753 const SSL_METHOD
*sm
= s
->method
;
3754 int (*hf
) (SSL
*) = s
->handshake_func
;
3756 if (sm
->version
== meth
->version
)
3761 ret
= s
->method
->ssl_new(s
);
3764 if (hf
== sm
->ssl_connect
)
3765 s
->handshake_func
= meth
->ssl_connect
;
3766 else if (hf
== sm
->ssl_accept
)
3767 s
->handshake_func
= meth
->ssl_accept
;
3772 int SSL_get_error(const SSL
*s
, int i
)
3779 return SSL_ERROR_NONE
;
3782 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3783 * where we do encode the error
3785 if ((l
= ERR_peek_error()) != 0) {
3786 if (ERR_GET_LIB(l
) == ERR_LIB_SYS
)
3787 return SSL_ERROR_SYSCALL
;
3789 return SSL_ERROR_SSL
;
3792 if (SSL_want_read(s
)) {
3793 bio
= SSL_get_rbio(s
);
3794 if (BIO_should_read(bio
))
3795 return SSL_ERROR_WANT_READ
;
3796 else if (BIO_should_write(bio
))
3798 * This one doesn't make too much sense ... We never try to write
3799 * to the rbio, and an application program where rbio and wbio
3800 * are separate couldn't even know what it should wait for.
3801 * However if we ever set s->rwstate incorrectly (so that we have
3802 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3803 * wbio *are* the same, this test works around that bug; so it
3804 * might be safer to keep it.
3806 return SSL_ERROR_WANT_WRITE
;
3807 else if (BIO_should_io_special(bio
)) {
3808 reason
= BIO_get_retry_reason(bio
);
3809 if (reason
== BIO_RR_CONNECT
)
3810 return SSL_ERROR_WANT_CONNECT
;
3811 else if (reason
== BIO_RR_ACCEPT
)
3812 return SSL_ERROR_WANT_ACCEPT
;
3814 return SSL_ERROR_SYSCALL
; /* unknown */
3818 if (SSL_want_write(s
)) {
3819 /* Access wbio directly - in order to use the buffered bio if present */
3821 if (BIO_should_write(bio
))
3822 return SSL_ERROR_WANT_WRITE
;
3823 else if (BIO_should_read(bio
))
3825 * See above (SSL_want_read(s) with BIO_should_write(bio))
3827 return SSL_ERROR_WANT_READ
;
3828 else if (BIO_should_io_special(bio
)) {
3829 reason
= BIO_get_retry_reason(bio
);
3830 if (reason
== BIO_RR_CONNECT
)
3831 return SSL_ERROR_WANT_CONNECT
;
3832 else if (reason
== BIO_RR_ACCEPT
)
3833 return SSL_ERROR_WANT_ACCEPT
;
3835 return SSL_ERROR_SYSCALL
;
3838 if (SSL_want_x509_lookup(s
))
3839 return SSL_ERROR_WANT_X509_LOOKUP
;
3840 if (SSL_want_retry_verify(s
))
3841 return SSL_ERROR_WANT_RETRY_VERIFY
;
3842 if (SSL_want_async(s
))
3843 return SSL_ERROR_WANT_ASYNC
;
3844 if (SSL_want_async_job(s
))
3845 return SSL_ERROR_WANT_ASYNC_JOB
;
3846 if (SSL_want_client_hello_cb(s
))
3847 return SSL_ERROR_WANT_CLIENT_HELLO_CB
;
3849 if ((s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) &&
3850 (s
->s3
.warn_alert
== SSL_AD_CLOSE_NOTIFY
))
3851 return SSL_ERROR_ZERO_RETURN
;
3853 return SSL_ERROR_SYSCALL
;
3856 static int ssl_do_handshake_intern(void *vargs
)
3858 struct ssl_async_args
*args
;
3861 args
= (struct ssl_async_args
*)vargs
;
3864 return s
->handshake_func(s
);
3867 int SSL_do_handshake(SSL
*s
)
3871 if (s
->handshake_func
== NULL
) {
3872 ERR_raise(ERR_LIB_SSL
, SSL_R_CONNECTION_TYPE_NOT_SET
);
3876 ossl_statem_check_finish_init(s
, -1);
3878 s
->method
->ssl_renegotiate_check(s
, 0);
3880 if (SSL_in_init(s
) || SSL_in_before(s
)) {
3881 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
3882 struct ssl_async_args args
;
3886 ret
= ssl_start_async_job(s
, &args
, ssl_do_handshake_intern
);
3888 ret
= s
->handshake_func(s
);
3894 void SSL_set_accept_state(SSL
*s
)
3898 ossl_statem_clear(s
);
3899 s
->handshake_func
= s
->method
->ssl_accept
;
3903 void SSL_set_connect_state(SSL
*s
)
3907 ossl_statem_clear(s
);
3908 s
->handshake_func
= s
->method
->ssl_connect
;
3912 int ssl_undefined_function(SSL
*s
)
3914 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3918 int ssl_undefined_void_function(void)
3920 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3924 int ssl_undefined_const_function(const SSL
*s
)
3929 const SSL_METHOD
*ssl_bad_method(int ver
)
3931 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3935 const char *ssl_protocol_to_string(int version
)
3939 case TLS1_3_VERSION
:
3942 case TLS1_2_VERSION
:
3945 case TLS1_1_VERSION
:
3960 case DTLS1_2_VERSION
:
3968 const char *SSL_get_version(const SSL
*s
)
3970 return ssl_protocol_to_string(s
->version
);
3973 static int dup_ca_names(STACK_OF(X509_NAME
) **dst
, STACK_OF(X509_NAME
) *src
)
3975 STACK_OF(X509_NAME
) *sk
;
3984 if ((sk
= sk_X509_NAME_new_null()) == NULL
)
3986 for (i
= 0; i
< sk_X509_NAME_num(src
); i
++) {
3987 xn
= X509_NAME_dup(sk_X509_NAME_value(src
, i
));
3989 sk_X509_NAME_pop_free(sk
, X509_NAME_free
);
3992 if (sk_X509_NAME_insert(sk
, xn
, i
) == 0) {
3994 sk_X509_NAME_pop_free(sk
, X509_NAME_free
);
4003 SSL
*SSL_dup(SSL
*s
)
4008 /* If we're not quiescent, just up_ref! */
4009 if (!SSL_in_init(s
) || !SSL_in_before(s
)) {
4010 CRYPTO_UP_REF(&s
->references
, &i
, s
->lock
);
4015 * Otherwise, copy configuration state, and session if set.
4017 if ((ret
= SSL_new(SSL_get_SSL_CTX(s
))) == NULL
)
4020 if (s
->session
!= NULL
) {
4022 * Arranges to share the same session via up_ref. This "copies"
4023 * session-id, SSL_METHOD, sid_ctx, and 'cert'
4025 if (!SSL_copy_session_id(ret
, s
))
4029 * No session has been established yet, so we have to expect that
4030 * s->cert or ret->cert will be changed later -- they should not both
4031 * point to the same object, and thus we can't use
4032 * SSL_copy_session_id.
4034 if (!SSL_set_ssl_method(ret
, s
->method
))
4037 if (s
->cert
!= NULL
) {
4038 ssl_cert_free(ret
->cert
);
4039 ret
->cert
= ssl_cert_dup(s
->cert
);
4040 if (ret
->cert
== NULL
)
4044 if (!SSL_set_session_id_context(ret
, s
->sid_ctx
,
4045 (int)s
->sid_ctx_length
))
4049 if (!ssl_dane_dup(ret
, s
))
4051 ret
->version
= s
->version
;
4052 ret
->options
= s
->options
;
4053 ret
->min_proto_version
= s
->min_proto_version
;
4054 ret
->max_proto_version
= s
->max_proto_version
;
4055 ret
->mode
= s
->mode
;
4056 SSL_set_max_cert_list(ret
, SSL_get_max_cert_list(s
));
4057 SSL_set_read_ahead(ret
, SSL_get_read_ahead(s
));
4058 ret
->msg_callback
= s
->msg_callback
;
4059 ret
->msg_callback_arg
= s
->msg_callback_arg
;
4060 SSL_set_verify(ret
, SSL_get_verify_mode(s
), SSL_get_verify_callback(s
));
4061 SSL_set_verify_depth(ret
, SSL_get_verify_depth(s
));
4062 ret
->generate_session_id
= s
->generate_session_id
;
4064 SSL_set_info_callback(ret
, SSL_get_info_callback(s
));
4066 /* copy app data, a little dangerous perhaps */
4067 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL
, &ret
->ex_data
, &s
->ex_data
))
4070 ret
->server
= s
->server
;
4071 if (s
->handshake_func
) {
4073 SSL_set_accept_state(ret
);
4075 SSL_set_connect_state(ret
);
4077 ret
->shutdown
= s
->shutdown
;
4080 ret
->default_passwd_callback
= s
->default_passwd_callback
;
4081 ret
->default_passwd_callback_userdata
= s
->default_passwd_callback_userdata
;
4083 X509_VERIFY_PARAM_inherit(ret
->param
, s
->param
);
4085 /* dup the cipher_list and cipher_list_by_id stacks */
4086 if (s
->cipher_list
!= NULL
) {
4087 if ((ret
->cipher_list
= sk_SSL_CIPHER_dup(s
->cipher_list
)) == NULL
)
4090 if (s
->cipher_list_by_id
!= NULL
)
4091 if ((ret
->cipher_list_by_id
= sk_SSL_CIPHER_dup(s
->cipher_list_by_id
))
4095 /* Dup the client_CA list */
4096 if (!dup_ca_names(&ret
->ca_names
, s
->ca_names
)
4097 || !dup_ca_names(&ret
->client_ca_names
, s
->client_ca_names
))
4107 void ssl_clear_cipher_ctx(SSL
*s
)
4109 if (s
->enc_read_ctx
!= NULL
) {
4110 EVP_CIPHER_CTX_free(s
->enc_read_ctx
);
4111 s
->enc_read_ctx
= NULL
;
4113 if (s
->enc_write_ctx
!= NULL
) {
4114 EVP_CIPHER_CTX_free(s
->enc_write_ctx
);
4115 s
->enc_write_ctx
= NULL
;
4117 #ifndef OPENSSL_NO_COMP
4118 COMP_CTX_free(s
->expand
);
4120 COMP_CTX_free(s
->compress
);
4125 X509
*SSL_get_certificate(const SSL
*s
)
4127 if (s
->cert
!= NULL
)
4128 return s
->cert
->key
->x509
;
4133 EVP_PKEY
*SSL_get_privatekey(const SSL
*s
)
4135 if (s
->cert
!= NULL
)
4136 return s
->cert
->key
->privatekey
;
4141 X509
*SSL_CTX_get0_certificate(const SSL_CTX
*ctx
)
4143 if (ctx
->cert
!= NULL
)
4144 return ctx
->cert
->key
->x509
;
4149 EVP_PKEY
*SSL_CTX_get0_privatekey(const SSL_CTX
*ctx
)
4151 if (ctx
->cert
!= NULL
)
4152 return ctx
->cert
->key
->privatekey
;
4157 const SSL_CIPHER
*SSL_get_current_cipher(const SSL
*s
)
4159 if ((s
->session
!= NULL
) && (s
->session
->cipher
!= NULL
))
4160 return s
->session
->cipher
;
4164 const SSL_CIPHER
*SSL_get_pending_cipher(const SSL
*s
)
4166 return s
->s3
.tmp
.new_cipher
;
4169 const COMP_METHOD
*SSL_get_current_compression(const SSL
*s
)
4171 #ifndef OPENSSL_NO_COMP
4172 return s
->compress
? COMP_CTX_get_method(s
->compress
) : NULL
;
4178 const COMP_METHOD
*SSL_get_current_expansion(const SSL
*s
)
4180 #ifndef OPENSSL_NO_COMP
4181 return s
->expand
? COMP_CTX_get_method(s
->expand
) : NULL
;
4187 int ssl_init_wbio_buffer(SSL
*s
)
4191 if (s
->bbio
!= NULL
) {
4192 /* Already buffered. */
4196 bbio
= BIO_new(BIO_f_buffer());
4197 if (bbio
== NULL
|| !BIO_set_read_buffer_size(bbio
, 1)) {
4199 ERR_raise(ERR_LIB_SSL
, ERR_R_BUF_LIB
);
4203 s
->wbio
= BIO_push(bbio
, s
->wbio
);
4208 int ssl_free_wbio_buffer(SSL
*s
)
4210 /* callers ensure s is never null */
4211 if (s
->bbio
== NULL
)
4214 s
->wbio
= BIO_pop(s
->wbio
);
4221 void SSL_CTX_set_quiet_shutdown(SSL_CTX
*ctx
, int mode
)
4223 ctx
->quiet_shutdown
= mode
;
4226 int SSL_CTX_get_quiet_shutdown(const SSL_CTX
*ctx
)
4228 return ctx
->quiet_shutdown
;
4231 void SSL_set_quiet_shutdown(SSL
*s
, int mode
)
4233 s
->quiet_shutdown
= mode
;
4236 int SSL_get_quiet_shutdown(const SSL
*s
)
4238 return s
->quiet_shutdown
;
4241 void SSL_set_shutdown(SSL
*s
, int mode
)
4246 int SSL_get_shutdown(const SSL
*s
)
4251 int SSL_version(const SSL
*s
)
4256 int SSL_client_version(const SSL
*s
)
4258 return s
->client_version
;
4261 SSL_CTX
*SSL_get_SSL_CTX(const SSL
*ssl
)
4266 SSL_CTX
*SSL_set_SSL_CTX(SSL
*ssl
, SSL_CTX
*ctx
)
4269 if (ssl
->ctx
== ctx
)
4272 ctx
= ssl
->session_ctx
;
4273 new_cert
= ssl_cert_dup(ctx
->cert
);
4274 if (new_cert
== NULL
) {
4278 if (!custom_exts_copy_flags(&new_cert
->custext
, &ssl
->cert
->custext
)) {
4279 ssl_cert_free(new_cert
);
4283 ssl_cert_free(ssl
->cert
);
4284 ssl
->cert
= new_cert
;
4287 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
4288 * so setter APIs must prevent invalid lengths from entering the system.
4290 if (!ossl_assert(ssl
->sid_ctx_length
<= sizeof(ssl
->sid_ctx
)))
4294 * If the session ID context matches that of the parent SSL_CTX,
4295 * inherit it from the new SSL_CTX as well. If however the context does
4296 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4297 * leave it unchanged.
4299 if ((ssl
->ctx
!= NULL
) &&
4300 (ssl
->sid_ctx_length
== ssl
->ctx
->sid_ctx_length
) &&
4301 (memcmp(ssl
->sid_ctx
, ssl
->ctx
->sid_ctx
, ssl
->sid_ctx_length
) == 0)) {
4302 ssl
->sid_ctx_length
= ctx
->sid_ctx_length
;
4303 memcpy(&ssl
->sid_ctx
, &ctx
->sid_ctx
, sizeof(ssl
->sid_ctx
));
4306 SSL_CTX_up_ref(ctx
);
4307 SSL_CTX_free(ssl
->ctx
); /* decrement reference count */
4313 int SSL_CTX_set_default_verify_paths(SSL_CTX
*ctx
)
4315 return X509_STORE_set_default_paths_ex(ctx
->cert_store
, ctx
->libctx
,
4319 int SSL_CTX_set_default_verify_dir(SSL_CTX
*ctx
)
4321 X509_LOOKUP
*lookup
;
4323 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_hash_dir());
4327 /* We ignore errors, in case the directory doesn't exist */
4330 X509_LOOKUP_add_dir(lookup
, NULL
, X509_FILETYPE_DEFAULT
);
4337 int SSL_CTX_set_default_verify_file(SSL_CTX
*ctx
)
4339 X509_LOOKUP
*lookup
;
4341 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_file());
4345 /* We ignore errors, in case the file doesn't exist */
4348 X509_LOOKUP_load_file_ex(lookup
, NULL
, X509_FILETYPE_DEFAULT
, ctx
->libctx
,
4356 int SSL_CTX_set_default_verify_store(SSL_CTX
*ctx
)
4358 X509_LOOKUP
*lookup
;
4360 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_store());
4364 /* We ignore errors, in case the directory doesn't exist */
4367 X509_LOOKUP_add_store_ex(lookup
, NULL
, ctx
->libctx
, ctx
->propq
);
4374 int SSL_CTX_load_verify_file(SSL_CTX
*ctx
, const char *CAfile
)
4376 return X509_STORE_load_file_ex(ctx
->cert_store
, CAfile
, ctx
->libctx
,
4380 int SSL_CTX_load_verify_dir(SSL_CTX
*ctx
, const char *CApath
)
4382 return X509_STORE_load_path(ctx
->cert_store
, CApath
);
4385 int SSL_CTX_load_verify_store(SSL_CTX
*ctx
, const char *CAstore
)
4387 return X509_STORE_load_store_ex(ctx
->cert_store
, CAstore
, ctx
->libctx
,
4391 int SSL_CTX_load_verify_locations(SSL_CTX
*ctx
, const char *CAfile
,
4394 if (CAfile
== NULL
&& CApath
== NULL
)
4396 if (CAfile
!= NULL
&& !SSL_CTX_load_verify_file(ctx
, CAfile
))
4398 if (CApath
!= NULL
&& !SSL_CTX_load_verify_dir(ctx
, CApath
))
4403 void SSL_set_info_callback(SSL
*ssl
,
4404 void (*cb
) (const SSL
*ssl
, int type
, int val
))
4406 ssl
->info_callback
= cb
;
4410 * One compiler (Diab DCC) doesn't like argument names in returned function
4413 void (*SSL_get_info_callback(const SSL
*ssl
)) (const SSL
* /* ssl */ ,
4416 return ssl
->info_callback
;
4419 void SSL_set_verify_result(SSL
*ssl
, long arg
)
4421 ssl
->verify_result
= arg
;
4424 long SSL_get_verify_result(const SSL
*ssl
)
4426 return ssl
->verify_result
;
4429 size_t SSL_get_client_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
4432 return sizeof(ssl
->s3
.client_random
);
4433 if (outlen
> sizeof(ssl
->s3
.client_random
))
4434 outlen
= sizeof(ssl
->s3
.client_random
);
4435 memcpy(out
, ssl
->s3
.client_random
, outlen
);
4439 size_t SSL_get_server_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
4442 return sizeof(ssl
->s3
.server_random
);
4443 if (outlen
> sizeof(ssl
->s3
.server_random
))
4444 outlen
= sizeof(ssl
->s3
.server_random
);
4445 memcpy(out
, ssl
->s3
.server_random
, outlen
);
4449 size_t SSL_SESSION_get_master_key(const SSL_SESSION
*session
,
4450 unsigned char *out
, size_t outlen
)
4453 return session
->master_key_length
;
4454 if (outlen
> session
->master_key_length
)
4455 outlen
= session
->master_key_length
;
4456 memcpy(out
, session
->master_key
, outlen
);
4460 int SSL_SESSION_set1_master_key(SSL_SESSION
*sess
, const unsigned char *in
,
4463 if (len
> sizeof(sess
->master_key
))
4466 memcpy(sess
->master_key
, in
, len
);
4467 sess
->master_key_length
= len
;
4472 int SSL_set_ex_data(SSL
*s
, int idx
, void *arg
)
4474 return CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
);
4477 void *SSL_get_ex_data(const SSL
*s
, int idx
)
4479 return CRYPTO_get_ex_data(&s
->ex_data
, idx
);
4482 int SSL_CTX_set_ex_data(SSL_CTX
*s
, int idx
, void *arg
)
4484 return CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
);
4487 void *SSL_CTX_get_ex_data(const SSL_CTX
*s
, int idx
)
4489 return CRYPTO_get_ex_data(&s
->ex_data
, idx
);
4492 X509_STORE
*SSL_CTX_get_cert_store(const SSL_CTX
*ctx
)
4494 return ctx
->cert_store
;
4497 void SSL_CTX_set_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
4499 X509_STORE_free(ctx
->cert_store
);
4500 ctx
->cert_store
= store
;
4503 void SSL_CTX_set1_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
4506 X509_STORE_up_ref(store
);
4507 SSL_CTX_set_cert_store(ctx
, store
);
4510 int SSL_want(const SSL
*s
)
4515 #ifndef OPENSSL_NO_PSK
4516 int SSL_CTX_use_psk_identity_hint(SSL_CTX
*ctx
, const char *identity_hint
)
4518 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
4519 ERR_raise(ERR_LIB_SSL
, SSL_R_DATA_LENGTH_TOO_LONG
);
4522 OPENSSL_free(ctx
->cert
->psk_identity_hint
);
4523 if (identity_hint
!= NULL
) {
4524 ctx
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
4525 if (ctx
->cert
->psk_identity_hint
== NULL
)
4528 ctx
->cert
->psk_identity_hint
= NULL
;
4532 int SSL_use_psk_identity_hint(SSL
*s
, const char *identity_hint
)
4537 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
4538 ERR_raise(ERR_LIB_SSL
, SSL_R_DATA_LENGTH_TOO_LONG
);
4541 OPENSSL_free(s
->cert
->psk_identity_hint
);
4542 if (identity_hint
!= NULL
) {
4543 s
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
4544 if (s
->cert
->psk_identity_hint
== NULL
)
4547 s
->cert
->psk_identity_hint
= NULL
;
4551 const char *SSL_get_psk_identity_hint(const SSL
*s
)
4553 if (s
== NULL
|| s
->session
== NULL
)
4555 return s
->session
->psk_identity_hint
;
4558 const char *SSL_get_psk_identity(const SSL
*s
)
4560 if (s
== NULL
|| s
->session
== NULL
)
4562 return s
->session
->psk_identity
;
4565 void SSL_set_psk_client_callback(SSL
*s
, SSL_psk_client_cb_func cb
)
4567 s
->psk_client_callback
= cb
;
4570 void SSL_CTX_set_psk_client_callback(SSL_CTX
*ctx
, SSL_psk_client_cb_func cb
)
4572 ctx
->psk_client_callback
= cb
;
4575 void SSL_set_psk_server_callback(SSL
*s
, SSL_psk_server_cb_func cb
)
4577 s
->psk_server_callback
= cb
;
4580 void SSL_CTX_set_psk_server_callback(SSL_CTX
*ctx
, SSL_psk_server_cb_func cb
)
4582 ctx
->psk_server_callback
= cb
;
4586 void SSL_set_psk_find_session_callback(SSL
*s
, SSL_psk_find_session_cb_func cb
)
4588 s
->psk_find_session_cb
= cb
;
4591 void SSL_CTX_set_psk_find_session_callback(SSL_CTX
*ctx
,
4592 SSL_psk_find_session_cb_func cb
)
4594 ctx
->psk_find_session_cb
= cb
;
4597 void SSL_set_psk_use_session_callback(SSL
*s
, SSL_psk_use_session_cb_func cb
)
4599 s
->psk_use_session_cb
= cb
;
4602 void SSL_CTX_set_psk_use_session_callback(SSL_CTX
*ctx
,
4603 SSL_psk_use_session_cb_func cb
)
4605 ctx
->psk_use_session_cb
= cb
;
4608 void SSL_CTX_set_msg_callback(SSL_CTX
*ctx
,
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_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
4616 void SSL_set_msg_callback(SSL
*ssl
,
4617 void (*cb
) (int write_p
, int version
,
4618 int content_type
, const void *buf
,
4619 size_t len
, SSL
*ssl
, void *arg
))
4621 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
4624 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX
*ctx
,
4625 int (*cb
) (SSL
*ssl
,
4629 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
4630 (void (*)(void))cb
);
4633 void SSL_set_not_resumable_session_callback(SSL
*ssl
,
4634 int (*cb
) (SSL
*ssl
,
4635 int is_forward_secure
))
4637 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
4638 (void (*)(void))cb
);
4641 void SSL_CTX_set_record_padding_callback(SSL_CTX
*ctx
,
4642 size_t (*cb
) (SSL
*ssl
, int type
,
4643 size_t len
, void *arg
))
4645 ctx
->record_padding_cb
= cb
;
4648 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX
*ctx
, void *arg
)
4650 ctx
->record_padding_arg
= arg
;
4653 void *SSL_CTX_get_record_padding_callback_arg(const SSL_CTX
*ctx
)
4655 return ctx
->record_padding_arg
;
4658 int SSL_CTX_set_block_padding(SSL_CTX
*ctx
, size_t block_size
)
4660 /* block size of 0 or 1 is basically no padding */
4661 if (block_size
== 1)
4662 ctx
->block_padding
= 0;
4663 else if (block_size
<= SSL3_RT_MAX_PLAIN_LENGTH
)
4664 ctx
->block_padding
= block_size
;
4670 int SSL_set_record_padding_callback(SSL
*ssl
,
4671 size_t (*cb
) (SSL
*ssl
, int type
,
4672 size_t len
, void *arg
))
4676 b
= SSL_get_wbio(ssl
);
4677 if (b
== NULL
|| !BIO_get_ktls_send(b
)) {
4678 ssl
->record_padding_cb
= cb
;
4684 void SSL_set_record_padding_callback_arg(SSL
*ssl
, void *arg
)
4686 ssl
->record_padding_arg
= arg
;
4689 void *SSL_get_record_padding_callback_arg(const SSL
*ssl
)
4691 return ssl
->record_padding_arg
;
4694 int SSL_set_block_padding(SSL
*ssl
, size_t block_size
)
4696 /* block size of 0 or 1 is basically no padding */
4697 if (block_size
== 1)
4698 ssl
->block_padding
= 0;
4699 else if (block_size
<= SSL3_RT_MAX_PLAIN_LENGTH
)
4700 ssl
->block_padding
= block_size
;
4706 int SSL_set_num_tickets(SSL
*s
, size_t num_tickets
)
4708 s
->num_tickets
= num_tickets
;
4713 size_t SSL_get_num_tickets(const SSL
*s
)
4715 return s
->num_tickets
;
4718 int SSL_CTX_set_num_tickets(SSL_CTX
*ctx
, size_t num_tickets
)
4720 ctx
->num_tickets
= num_tickets
;
4725 size_t SSL_CTX_get_num_tickets(const SSL_CTX
*ctx
)
4727 return ctx
->num_tickets
;
4731 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4732 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4733 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4734 * Returns the newly allocated ctx;
4737 EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
)
4739 ssl_clear_hash_ctx(hash
);
4740 *hash
= EVP_MD_CTX_new();
4741 if (*hash
== NULL
|| (md
&& EVP_DigestInit_ex(*hash
, md
, NULL
) <= 0)) {
4742 EVP_MD_CTX_free(*hash
);
4749 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
)
4752 EVP_MD_CTX_free(*hash
);
4756 /* Retrieve handshake hashes */
4757 int ssl_handshake_hash(SSL
*s
, unsigned char *out
, size_t outlen
,
4760 EVP_MD_CTX
*ctx
= NULL
;
4761 EVP_MD_CTX
*hdgst
= s
->s3
.handshake_dgst
;
4762 int hashleni
= EVP_MD_CTX_get_size(hdgst
);
4765 if (hashleni
< 0 || (size_t)hashleni
> outlen
) {
4766 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
4770 ctx
= EVP_MD_CTX_new();
4772 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
4776 if (!EVP_MD_CTX_copy_ex(ctx
, hdgst
)
4777 || EVP_DigestFinal_ex(ctx
, out
, NULL
) <= 0) {
4778 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
4782 *hashlen
= hashleni
;
4786 EVP_MD_CTX_free(ctx
);
4790 int SSL_session_reused(const SSL
*s
)
4795 int SSL_is_server(const SSL
*s
)
4800 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
4801 void SSL_set_debug(SSL
*s
, int debug
)
4803 /* Old function was do-nothing anyway... */
4809 void SSL_set_security_level(SSL
*s
, int level
)
4811 s
->cert
->sec_level
= level
;
4814 int SSL_get_security_level(const SSL
*s
)
4816 return s
->cert
->sec_level
;
4819 void SSL_set_security_callback(SSL
*s
,
4820 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
4821 int op
, int bits
, int nid
,
4822 void *other
, void *ex
))
4824 s
->cert
->sec_cb
= cb
;
4827 int (*SSL_get_security_callback(const SSL
*s
)) (const SSL
*s
,
4828 const SSL_CTX
*ctx
, int op
,
4829 int bits
, int nid
, void *other
,
4831 return s
->cert
->sec_cb
;
4834 void SSL_set0_security_ex_data(SSL
*s
, void *ex
)
4836 s
->cert
->sec_ex
= ex
;
4839 void *SSL_get0_security_ex_data(const SSL
*s
)
4841 return s
->cert
->sec_ex
;
4844 void SSL_CTX_set_security_level(SSL_CTX
*ctx
, int level
)
4846 ctx
->cert
->sec_level
= level
;
4849 int SSL_CTX_get_security_level(const SSL_CTX
*ctx
)
4851 return ctx
->cert
->sec_level
;
4854 void SSL_CTX_set_security_callback(SSL_CTX
*ctx
,
4855 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
4856 int op
, int bits
, int nid
,
4857 void *other
, void *ex
))
4859 ctx
->cert
->sec_cb
= cb
;
4862 int (*SSL_CTX_get_security_callback(const SSL_CTX
*ctx
)) (const SSL
*s
,
4868 return ctx
->cert
->sec_cb
;
4871 void SSL_CTX_set0_security_ex_data(SSL_CTX
*ctx
, void *ex
)
4873 ctx
->cert
->sec_ex
= ex
;
4876 void *SSL_CTX_get0_security_ex_data(const SSL_CTX
*ctx
)
4878 return ctx
->cert
->sec_ex
;
4881 uint64_t SSL_CTX_get_options(const SSL_CTX
*ctx
)
4883 return ctx
->options
;
4886 uint64_t SSL_get_options(const SSL
*s
)
4891 uint64_t SSL_CTX_set_options(SSL_CTX
*ctx
, uint64_t op
)
4893 return ctx
->options
|= op
;
4896 uint64_t SSL_set_options(SSL
*s
, uint64_t op
)
4898 return s
->options
|= op
;
4901 uint64_t SSL_CTX_clear_options(SSL_CTX
*ctx
, uint64_t op
)
4903 return ctx
->options
&= ~op
;
4906 uint64_t SSL_clear_options(SSL
*s
, uint64_t op
)
4908 return s
->options
&= ~op
;
4911 STACK_OF(X509
) *SSL_get0_verified_chain(const SSL
*s
)
4913 return s
->verified_chain
;
4916 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
4918 #ifndef OPENSSL_NO_CT
4921 * Moves SCTs from the |src| stack to the |dst| stack.
4922 * The source of each SCT will be set to |origin|.
4923 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4925 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4927 static int ct_move_scts(STACK_OF(SCT
) **dst
, STACK_OF(SCT
) *src
,
4928 sct_source_t origin
)
4934 *dst
= sk_SCT_new_null();
4936 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
4941 while ((sct
= sk_SCT_pop(src
)) != NULL
) {
4942 if (SCT_set_source(sct
, origin
) != 1)
4945 if (sk_SCT_push(*dst
, sct
) <= 0)
4953 sk_SCT_push(src
, sct
); /* Put the SCT back */
4958 * Look for data collected during ServerHello and parse if found.
4959 * Returns the number of SCTs extracted.
4961 static int ct_extract_tls_extension_scts(SSL
*s
)
4963 int scts_extracted
= 0;
4965 if (s
->ext
.scts
!= NULL
) {
4966 const unsigned char *p
= s
->ext
.scts
;
4967 STACK_OF(SCT
) *scts
= o2i_SCT_LIST(NULL
, &p
, s
->ext
.scts_len
);
4969 scts_extracted
= ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_TLS_EXTENSION
);
4971 SCT_LIST_free(scts
);
4974 return scts_extracted
;
4978 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4979 * contains an SCT X509 extension. They will be stored in |s->scts|.
4981 * - The number of SCTs extracted, assuming an OCSP response exists.
4982 * - 0 if no OCSP response exists or it contains no SCTs.
4983 * - A negative integer if an error occurs.
4985 static int ct_extract_ocsp_response_scts(SSL
*s
)
4987 # ifndef OPENSSL_NO_OCSP
4988 int scts_extracted
= 0;
4989 const unsigned char *p
;
4990 OCSP_BASICRESP
*br
= NULL
;
4991 OCSP_RESPONSE
*rsp
= NULL
;
4992 STACK_OF(SCT
) *scts
= NULL
;
4995 if (s
->ext
.ocsp
.resp
== NULL
|| s
->ext
.ocsp
.resp_len
== 0)
4998 p
= s
->ext
.ocsp
.resp
;
4999 rsp
= d2i_OCSP_RESPONSE(NULL
, &p
, (int)s
->ext
.ocsp
.resp_len
);
5003 br
= OCSP_response_get1_basic(rsp
);
5007 for (i
= 0; i
< OCSP_resp_count(br
); ++i
) {
5008 OCSP_SINGLERESP
*single
= OCSP_resp_get0(br
, i
);
5014 OCSP_SINGLERESP_get1_ext_d2i(single
, NID_ct_cert_scts
, NULL
, NULL
);
5016 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_OCSP_STAPLED_RESPONSE
);
5017 if (scts_extracted
< 0)
5021 SCT_LIST_free(scts
);
5022 OCSP_BASICRESP_free(br
);
5023 OCSP_RESPONSE_free(rsp
);
5024 return scts_extracted
;
5026 /* Behave as if no OCSP response exists */
5032 * Attempts to extract SCTs from the peer certificate.
5033 * Return the number of SCTs extracted, or a negative integer if an error
5036 static int ct_extract_x509v3_extension_scts(SSL
*s
)
5038 int scts_extracted
= 0;
5039 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
5042 STACK_OF(SCT
) *scts
=
5043 X509_get_ext_d2i(cert
, NID_ct_precert_scts
, NULL
, NULL
);
5046 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_X509V3_EXTENSION
);
5048 SCT_LIST_free(scts
);
5051 return scts_extracted
;
5055 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
5056 * response (if it exists) and X509v3 extensions in the certificate.
5057 * Returns NULL if an error occurs.
5059 const STACK_OF(SCT
) *SSL_get0_peer_scts(SSL
*s
)
5061 if (!s
->scts_parsed
) {
5062 if (ct_extract_tls_extension_scts(s
) < 0 ||
5063 ct_extract_ocsp_response_scts(s
) < 0 ||
5064 ct_extract_x509v3_extension_scts(s
) < 0)
5074 static int ct_permissive(const CT_POLICY_EVAL_CTX
* ctx
,
5075 const STACK_OF(SCT
) *scts
, void *unused_arg
)
5080 static int ct_strict(const CT_POLICY_EVAL_CTX
* ctx
,
5081 const STACK_OF(SCT
) *scts
, void *unused_arg
)
5083 int count
= scts
!= NULL
? sk_SCT_num(scts
) : 0;
5086 for (i
= 0; i
< count
; ++i
) {
5087 SCT
*sct
= sk_SCT_value(scts
, i
);
5088 int status
= SCT_get_validation_status(sct
);
5090 if (status
== SCT_VALIDATION_STATUS_VALID
)
5093 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_VALID_SCTS
);
5097 int SSL_set_ct_validation_callback(SSL
*s
, ssl_ct_validation_cb callback
,
5101 * Since code exists that uses the custom extension handler for CT, look
5102 * for this and throw an error if they have already registered to use CT.
5104 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(s
->ctx
,
5105 TLSEXT_TYPE_signed_certificate_timestamp
))
5107 ERR_raise(ERR_LIB_SSL
, SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
5111 if (callback
!= NULL
) {
5113 * If we are validating CT, then we MUST accept SCTs served via OCSP
5115 if (!SSL_set_tlsext_status_type(s
, TLSEXT_STATUSTYPE_ocsp
))
5119 s
->ct_validation_callback
= callback
;
5120 s
->ct_validation_callback_arg
= arg
;
5125 int SSL_CTX_set_ct_validation_callback(SSL_CTX
*ctx
,
5126 ssl_ct_validation_cb callback
, void *arg
)
5129 * Since code exists that uses the custom extension handler for CT, look for
5130 * this and throw an error if they have already registered to use CT.
5132 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(ctx
,
5133 TLSEXT_TYPE_signed_certificate_timestamp
))
5135 ERR_raise(ERR_LIB_SSL
, SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
5139 ctx
->ct_validation_callback
= callback
;
5140 ctx
->ct_validation_callback_arg
= arg
;
5144 int SSL_ct_is_enabled(const SSL
*s
)
5146 return s
->ct_validation_callback
!= NULL
;
5149 int SSL_CTX_ct_is_enabled(const SSL_CTX
*ctx
)
5151 return ctx
->ct_validation_callback
!= NULL
;
5154 int ssl_validate_ct(SSL
*s
)
5157 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
5159 SSL_DANE
*dane
= &s
->dane
;
5160 CT_POLICY_EVAL_CTX
*ctx
= NULL
;
5161 const STACK_OF(SCT
) *scts
;
5164 * If no callback is set, the peer is anonymous, or its chain is invalid,
5165 * skip SCT validation - just return success. Applications that continue
5166 * handshakes without certificates, with unverified chains, or pinned leaf
5167 * certificates are outside the scope of the WebPKI and CT.
5169 * The above exclusions notwithstanding the vast majority of peers will
5170 * have rather ordinary certificate chains validated by typical
5171 * applications that perform certificate verification and therefore will
5172 * process SCTs when enabled.
5174 if (s
->ct_validation_callback
== NULL
|| cert
== NULL
||
5175 s
->verify_result
!= X509_V_OK
||
5176 s
->verified_chain
== NULL
|| sk_X509_num(s
->verified_chain
) <= 1)
5180 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
5181 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
5183 if (DANETLS_ENABLED(dane
) && dane
->mtlsa
!= NULL
) {
5184 switch (dane
->mtlsa
->usage
) {
5185 case DANETLS_USAGE_DANE_TA
:
5186 case DANETLS_USAGE_DANE_EE
:
5191 ctx
= CT_POLICY_EVAL_CTX_new_ex(s
->ctx
->libctx
, s
->ctx
->propq
);
5193 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5197 issuer
= sk_X509_value(s
->verified_chain
, 1);
5198 CT_POLICY_EVAL_CTX_set1_cert(ctx
, cert
);
5199 CT_POLICY_EVAL_CTX_set1_issuer(ctx
, issuer
);
5200 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx
, s
->ctx
->ctlog_store
);
5201 CT_POLICY_EVAL_CTX_set_time(
5202 ctx
, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s
)) * 1000);
5204 scts
= SSL_get0_peer_scts(s
);
5207 * This function returns success (> 0) only when all the SCTs are valid, 0
5208 * when some are invalid, and < 0 on various internal errors (out of
5209 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
5210 * reason to abort the handshake, that decision is up to the callback.
5211 * Therefore, we error out only in the unexpected case that the return
5212 * value is negative.
5214 * XXX: One might well argue that the return value of this function is an
5215 * unfortunate design choice. Its job is only to determine the validation
5216 * status of each of the provided SCTs. So long as it correctly separates
5217 * the wheat from the chaff it should return success. Failure in this case
5218 * ought to correspond to an inability to carry out its duties.
5220 if (SCT_LIST_validate(scts
, ctx
) < 0) {
5221 SSLfatal(s
, SSL_AD_HANDSHAKE_FAILURE
, SSL_R_SCT_VERIFICATION_FAILED
);
5225 ret
= s
->ct_validation_callback(ctx
, scts
, s
->ct_validation_callback_arg
);
5227 ret
= 0; /* This function returns 0 on failure */
5229 SSLfatal(s
, SSL_AD_HANDSHAKE_FAILURE
, SSL_R_CALLBACK_FAILED
);
5232 CT_POLICY_EVAL_CTX_free(ctx
);
5234 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
5235 * failure return code here. Also the application may wish the complete
5236 * the handshake, and then disconnect cleanly at a higher layer, after
5237 * checking the verification status of the completed connection.
5239 * We therefore force a certificate verification failure which will be
5240 * visible via SSL_get_verify_result() and cached as part of any resumed
5243 * Note: the permissive callback is for information gathering only, always
5244 * returns success, and does not affect verification status. Only the
5245 * strict callback or a custom application-specified callback can trigger
5246 * connection failure or record a verification error.
5249 s
->verify_result
= X509_V_ERR_NO_VALID_SCTS
;
5253 int SSL_CTX_enable_ct(SSL_CTX
*ctx
, int validation_mode
)
5255 switch (validation_mode
) {
5257 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
5259 case SSL_CT_VALIDATION_PERMISSIVE
:
5260 return SSL_CTX_set_ct_validation_callback(ctx
, ct_permissive
, NULL
);
5261 case SSL_CT_VALIDATION_STRICT
:
5262 return SSL_CTX_set_ct_validation_callback(ctx
, ct_strict
, NULL
);
5266 int SSL_enable_ct(SSL
*s
, int validation_mode
)
5268 switch (validation_mode
) {
5270 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
5272 case SSL_CT_VALIDATION_PERMISSIVE
:
5273 return SSL_set_ct_validation_callback(s
, ct_permissive
, NULL
);
5274 case SSL_CT_VALIDATION_STRICT
:
5275 return SSL_set_ct_validation_callback(s
, ct_strict
, NULL
);
5279 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX
*ctx
)
5281 return CTLOG_STORE_load_default_file(ctx
->ctlog_store
);
5284 int SSL_CTX_set_ctlog_list_file(SSL_CTX
*ctx
, const char *path
)
5286 return CTLOG_STORE_load_file(ctx
->ctlog_store
, path
);
5289 void SSL_CTX_set0_ctlog_store(SSL_CTX
*ctx
, CTLOG_STORE
* logs
)
5291 CTLOG_STORE_free(ctx
->ctlog_store
);
5292 ctx
->ctlog_store
= logs
;
5295 const CTLOG_STORE
*SSL_CTX_get0_ctlog_store(const SSL_CTX
*ctx
)
5297 return ctx
->ctlog_store
;
5300 #endif /* OPENSSL_NO_CT */
5302 void SSL_CTX_set_client_hello_cb(SSL_CTX
*c
, SSL_client_hello_cb_fn cb
,
5305 c
->client_hello_cb
= cb
;
5306 c
->client_hello_cb_arg
= arg
;
5309 int SSL_client_hello_isv2(SSL
*s
)
5311 if (s
->clienthello
== NULL
)
5313 return s
->clienthello
->isv2
;
5316 unsigned int SSL_client_hello_get0_legacy_version(SSL
*s
)
5318 if (s
->clienthello
== NULL
)
5320 return s
->clienthello
->legacy_version
;
5323 size_t SSL_client_hello_get0_random(SSL
*s
, const unsigned char **out
)
5325 if (s
->clienthello
== NULL
)
5328 *out
= s
->clienthello
->random
;
5329 return SSL3_RANDOM_SIZE
;
5332 size_t SSL_client_hello_get0_session_id(SSL
*s
, const unsigned char **out
)
5334 if (s
->clienthello
== NULL
)
5337 *out
= s
->clienthello
->session_id
;
5338 return s
->clienthello
->session_id_len
;
5341 size_t SSL_client_hello_get0_ciphers(SSL
*s
, const unsigned char **out
)
5343 if (s
->clienthello
== NULL
)
5346 *out
= PACKET_data(&s
->clienthello
->ciphersuites
);
5347 return PACKET_remaining(&s
->clienthello
->ciphersuites
);
5350 size_t SSL_client_hello_get0_compression_methods(SSL
*s
, const unsigned char **out
)
5352 if (s
->clienthello
== NULL
)
5355 *out
= s
->clienthello
->compressions
;
5356 return s
->clienthello
->compressions_len
;
5359 int SSL_client_hello_get1_extensions_present(SSL
*s
, int **out
, size_t *outlen
)
5365 if (s
->clienthello
== NULL
|| out
== NULL
|| outlen
== NULL
)
5367 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; i
++) {
5368 ext
= s
->clienthello
->pre_proc_exts
+ i
;
5377 if ((present
= OPENSSL_malloc(sizeof(*present
) * num
)) == NULL
) {
5378 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
5381 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; i
++) {
5382 ext
= s
->clienthello
->pre_proc_exts
+ i
;
5384 if (ext
->received_order
>= num
)
5386 present
[ext
->received_order
] = ext
->type
;
5393 OPENSSL_free(present
);
5397 int SSL_client_hello_get0_ext(SSL
*s
, unsigned int type
, const unsigned char **out
,
5403 if (s
->clienthello
== NULL
)
5405 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; ++i
) {
5406 r
= s
->clienthello
->pre_proc_exts
+ i
;
5407 if (r
->present
&& r
->type
== type
) {
5409 *out
= PACKET_data(&r
->data
);
5411 *outlen
= PACKET_remaining(&r
->data
);
5418 int SSL_free_buffers(SSL
*ssl
)
5420 RECORD_LAYER
*rl
= &ssl
->rlayer
;
5422 if (RECORD_LAYER_read_pending(rl
) || RECORD_LAYER_write_pending(rl
))
5425 RECORD_LAYER_release(rl
);
5429 int SSL_alloc_buffers(SSL
*ssl
)
5431 return ssl3_setup_buffers(ssl
);
5434 void SSL_CTX_set_keylog_callback(SSL_CTX
*ctx
, SSL_CTX_keylog_cb_func cb
)
5436 ctx
->keylog_callback
= cb
;
5439 SSL_CTX_keylog_cb_func
SSL_CTX_get_keylog_callback(const SSL_CTX
*ctx
)
5441 return ctx
->keylog_callback
;
5444 static int nss_keylog_int(const char *prefix
,
5446 const uint8_t *parameter_1
,
5447 size_t parameter_1_len
,
5448 const uint8_t *parameter_2
,
5449 size_t parameter_2_len
)
5452 char *cursor
= NULL
;
5457 if (ssl
->ctx
->keylog_callback
== NULL
)
5461 * Our output buffer will contain the following strings, rendered with
5462 * space characters in between, terminated by a NULL character: first the
5463 * prefix, then the first parameter, then the second parameter. The
5464 * meaning of each parameter depends on the specific key material being
5465 * logged. Note that the first and second parameters are encoded in
5466 * hexadecimal, so we need a buffer that is twice their lengths.
5468 prefix_len
= strlen(prefix
);
5469 out_len
= prefix_len
+ (2 * parameter_1_len
) + (2 * parameter_2_len
) + 3;
5470 if ((out
= cursor
= OPENSSL_malloc(out_len
)) == NULL
) {
5471 SSLfatal(ssl
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5475 strcpy(cursor
, prefix
);
5476 cursor
+= prefix_len
;
5479 for (i
= 0; i
< parameter_1_len
; i
++) {
5480 sprintf(cursor
, "%02x", parameter_1
[i
]);
5485 for (i
= 0; i
< parameter_2_len
; i
++) {
5486 sprintf(cursor
, "%02x", parameter_2
[i
]);
5491 ssl
->ctx
->keylog_callback(ssl
, (const char *)out
);
5492 OPENSSL_clear_free(out
, out_len
);
5497 int ssl_log_rsa_client_key_exchange(SSL
*ssl
,
5498 const uint8_t *encrypted_premaster
,
5499 size_t encrypted_premaster_len
,
5500 const uint8_t *premaster
,
5501 size_t premaster_len
)
5503 if (encrypted_premaster_len
< 8) {
5504 SSLfatal(ssl
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
5508 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5509 return nss_keylog_int("RSA",
5511 encrypted_premaster
,
5517 int ssl_log_secret(SSL
*ssl
,
5519 const uint8_t *secret
,
5522 return nss_keylog_int(label
,
5524 ssl
->s3
.client_random
,
5530 #define SSLV2_CIPHER_LEN 3
5532 int ssl_cache_cipherlist(SSL
*s
, PACKET
*cipher_suites
, int sslv2format
)
5536 n
= sslv2format
? SSLV2_CIPHER_LEN
: TLS_CIPHER_LEN
;
5538 if (PACKET_remaining(cipher_suites
) == 0) {
5539 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_R_NO_CIPHERS_SPECIFIED
);
5543 if (PACKET_remaining(cipher_suites
) % n
!= 0) {
5544 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5548 OPENSSL_free(s
->s3
.tmp
.ciphers_raw
);
5549 s
->s3
.tmp
.ciphers_raw
= NULL
;
5550 s
->s3
.tmp
.ciphers_rawlen
= 0;
5553 size_t numciphers
= PACKET_remaining(cipher_suites
) / n
;
5554 PACKET sslv2ciphers
= *cipher_suites
;
5555 unsigned int leadbyte
;
5559 * We store the raw ciphers list in SSLv3+ format so we need to do some
5560 * preprocessing to convert the list first. If there are any SSLv2 only
5561 * ciphersuites with a non-zero leading byte then we are going to
5562 * slightly over allocate because we won't store those. But that isn't a
5565 raw
= OPENSSL_malloc(numciphers
* TLS_CIPHER_LEN
);
5566 s
->s3
.tmp
.ciphers_raw
= raw
;
5568 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5571 for (s
->s3
.tmp
.ciphers_rawlen
= 0;
5572 PACKET_remaining(&sslv2ciphers
) > 0;
5573 raw
+= TLS_CIPHER_LEN
) {
5574 if (!PACKET_get_1(&sslv2ciphers
, &leadbyte
)
5576 && !PACKET_copy_bytes(&sslv2ciphers
, raw
,
5579 && !PACKET_forward(&sslv2ciphers
, TLS_CIPHER_LEN
))) {
5580 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_R_BAD_PACKET
);
5581 OPENSSL_free(s
->s3
.tmp
.ciphers_raw
);
5582 s
->s3
.tmp
.ciphers_raw
= NULL
;
5583 s
->s3
.tmp
.ciphers_rawlen
= 0;
5587 s
->s3
.tmp
.ciphers_rawlen
+= TLS_CIPHER_LEN
;
5589 } else if (!PACKET_memdup(cipher_suites
, &s
->s3
.tmp
.ciphers_raw
,
5590 &s
->s3
.tmp
.ciphers_rawlen
)) {
5591 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
5597 int SSL_bytes_to_cipher_list(SSL
*s
, const unsigned char *bytes
, size_t len
,
5598 int isv2format
, STACK_OF(SSL_CIPHER
) **sk
,
5599 STACK_OF(SSL_CIPHER
) **scsvs
)
5603 if (!PACKET_buf_init(&pkt
, bytes
, len
))
5605 return bytes_to_cipher_list(s
, &pkt
, sk
, scsvs
, isv2format
, 0);
5608 int bytes_to_cipher_list(SSL
*s
, PACKET
*cipher_suites
,
5609 STACK_OF(SSL_CIPHER
) **skp
,
5610 STACK_OF(SSL_CIPHER
) **scsvs_out
,
5611 int sslv2format
, int fatal
)
5613 const SSL_CIPHER
*c
;
5614 STACK_OF(SSL_CIPHER
) *sk
= NULL
;
5615 STACK_OF(SSL_CIPHER
) *scsvs
= NULL
;
5617 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5618 unsigned char cipher
[SSLV2_CIPHER_LEN
];
5620 n
= sslv2format
? SSLV2_CIPHER_LEN
: TLS_CIPHER_LEN
;
5622 if (PACKET_remaining(cipher_suites
) == 0) {
5624 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_R_NO_CIPHERS_SPECIFIED
);
5626 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CIPHERS_SPECIFIED
);
5630 if (PACKET_remaining(cipher_suites
) % n
!= 0) {
5632 SSLfatal(s
, SSL_AD_DECODE_ERROR
,
5633 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5635 ERR_raise(ERR_LIB_SSL
, SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5639 sk
= sk_SSL_CIPHER_new_null();
5640 scsvs
= sk_SSL_CIPHER_new_null();
5641 if (sk
== NULL
|| scsvs
== NULL
) {
5643 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5645 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
5649 while (PACKET_copy_bytes(cipher_suites
, cipher
, n
)) {
5651 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5652 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5653 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5655 if (sslv2format
&& cipher
[0] != '\0')
5658 /* For SSLv2-compat, ignore leading 0-byte. */
5659 c
= ssl_get_cipher_by_char(s
, sslv2format
? &cipher
[1] : cipher
, 1);
5661 if ((c
->valid
&& !sk_SSL_CIPHER_push(sk
, c
)) ||
5662 (!c
->valid
&& !sk_SSL_CIPHER_push(scsvs
, c
))) {
5664 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5666 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
5671 if (PACKET_remaining(cipher_suites
) > 0) {
5673 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_R_BAD_LENGTH
);
5675 ERR_raise(ERR_LIB_SSL
, SSL_R_BAD_LENGTH
);
5682 sk_SSL_CIPHER_free(sk
);
5683 if (scsvs_out
!= NULL
)
5686 sk_SSL_CIPHER_free(scsvs
);
5689 sk_SSL_CIPHER_free(sk
);
5690 sk_SSL_CIPHER_free(scsvs
);
5694 int SSL_CTX_set_max_early_data(SSL_CTX
*ctx
, uint32_t max_early_data
)
5696 ctx
->max_early_data
= max_early_data
;
5701 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX
*ctx
)
5703 return ctx
->max_early_data
;
5706 int SSL_set_max_early_data(SSL
*s
, uint32_t max_early_data
)
5708 s
->max_early_data
= max_early_data
;
5713 uint32_t SSL_get_max_early_data(const SSL
*s
)
5715 return s
->max_early_data
;
5718 int SSL_CTX_set_recv_max_early_data(SSL_CTX
*ctx
, uint32_t recv_max_early_data
)
5720 ctx
->recv_max_early_data
= recv_max_early_data
;
5725 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX
*ctx
)
5727 return ctx
->recv_max_early_data
;
5730 int SSL_set_recv_max_early_data(SSL
*s
, uint32_t recv_max_early_data
)
5732 s
->recv_max_early_data
= recv_max_early_data
;
5737 uint32_t SSL_get_recv_max_early_data(const SSL
*s
)
5739 return s
->recv_max_early_data
;
5742 __owur
unsigned int ssl_get_max_send_fragment(const SSL
*ssl
)
5744 /* Return any active Max Fragment Len extension */
5745 if (ssl
->session
!= NULL
&& USE_MAX_FRAGMENT_LENGTH_EXT(ssl
->session
))
5746 return GET_MAX_FRAGMENT_LENGTH(ssl
->session
);
5748 /* return current SSL connection setting */
5749 return ssl
->max_send_fragment
;
5752 __owur
unsigned int ssl_get_split_send_fragment(const SSL
*ssl
)
5754 /* Return a value regarding an active Max Fragment Len extension */
5755 if (ssl
->session
!= NULL
&& USE_MAX_FRAGMENT_LENGTH_EXT(ssl
->session
)
5756 && ssl
->split_send_fragment
> GET_MAX_FRAGMENT_LENGTH(ssl
->session
))
5757 return GET_MAX_FRAGMENT_LENGTH(ssl
->session
);
5759 /* else limit |split_send_fragment| to current |max_send_fragment| */
5760 if (ssl
->split_send_fragment
> ssl
->max_send_fragment
)
5761 return ssl
->max_send_fragment
;
5763 /* return current SSL connection setting */
5764 return ssl
->split_send_fragment
;
5767 int SSL_stateless(SSL
*s
)
5771 /* Ensure there is no state left over from a previous invocation */
5777 s
->s3
.flags
|= TLS1_FLAGS_STATELESS
;
5778 ret
= SSL_accept(s
);
5779 s
->s3
.flags
&= ~TLS1_FLAGS_STATELESS
;
5781 if (ret
> 0 && s
->ext
.cookieok
)
5784 if (s
->hello_retry_request
== SSL_HRR_PENDING
&& !ossl_statem_in_error(s
))
5790 void SSL_CTX_set_post_handshake_auth(SSL_CTX
*ctx
, int val
)
5792 ctx
->pha_enabled
= val
;
5795 void SSL_set_post_handshake_auth(SSL
*ssl
, int val
)
5797 ssl
->pha_enabled
= val
;
5800 int SSL_verify_client_post_handshake(SSL
*ssl
)
5802 if (!SSL_IS_TLS13(ssl
)) {
5803 ERR_raise(ERR_LIB_SSL
, SSL_R_WRONG_SSL_VERSION
);
5807 ERR_raise(ERR_LIB_SSL
, SSL_R_NOT_SERVER
);
5811 if (!SSL_is_init_finished(ssl
)) {
5812 ERR_raise(ERR_LIB_SSL
, SSL_R_STILL_IN_INIT
);
5816 switch (ssl
->post_handshake_auth
) {
5818 ERR_raise(ERR_LIB_SSL
, SSL_R_EXTENSION_NOT_RECEIVED
);
5821 case SSL_PHA_EXT_SENT
:
5822 ERR_raise(ERR_LIB_SSL
, ERR_R_INTERNAL_ERROR
);
5824 case SSL_PHA_EXT_RECEIVED
:
5826 case SSL_PHA_REQUEST_PENDING
:
5827 ERR_raise(ERR_LIB_SSL
, SSL_R_REQUEST_PENDING
);
5829 case SSL_PHA_REQUESTED
:
5830 ERR_raise(ERR_LIB_SSL
, SSL_R_REQUEST_SENT
);
5834 ssl
->post_handshake_auth
= SSL_PHA_REQUEST_PENDING
;
5836 /* checks verify_mode and algorithm_auth */
5837 if (!send_certificate_request(ssl
)) {
5838 ssl
->post_handshake_auth
= SSL_PHA_EXT_RECEIVED
; /* restore on error */
5839 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_CONFIG
);
5843 ossl_statem_set_in_init(ssl
, 1);
5847 int SSL_CTX_set_session_ticket_cb(SSL_CTX
*ctx
,
5848 SSL_CTX_generate_session_ticket_fn gen_cb
,
5849 SSL_CTX_decrypt_session_ticket_fn dec_cb
,
5852 ctx
->generate_ticket_cb
= gen_cb
;
5853 ctx
->decrypt_ticket_cb
= dec_cb
;
5854 ctx
->ticket_cb_data
= arg
;
5858 void SSL_CTX_set_allow_early_data_cb(SSL_CTX
*ctx
,
5859 SSL_allow_early_data_cb_fn cb
,
5862 ctx
->allow_early_data_cb
= cb
;
5863 ctx
->allow_early_data_cb_data
= arg
;
5866 void SSL_set_allow_early_data_cb(SSL
*s
,
5867 SSL_allow_early_data_cb_fn cb
,
5870 s
->allow_early_data_cb
= cb
;
5871 s
->allow_early_data_cb_data
= arg
;
5874 const EVP_CIPHER
*ssl_evp_cipher_fetch(OSSL_LIB_CTX
*libctx
,
5876 const char *properties
)
5878 const EVP_CIPHER
*ciph
;
5880 ciph
= tls_get_cipher_from_engine(nid
);
5885 * If there is no engine cipher then we do an explicit fetch. This may fail
5886 * and that could be ok
5889 ciph
= EVP_CIPHER_fetch(libctx
, OBJ_nid2sn(nid
), properties
);
5895 int ssl_evp_cipher_up_ref(const EVP_CIPHER
*cipher
)
5897 /* Don't up-ref an implicit EVP_CIPHER */
5898 if (EVP_CIPHER_get0_provider(cipher
) == NULL
)
5902 * The cipher was explicitly fetched and therefore it is safe to cast
5905 return EVP_CIPHER_up_ref((EVP_CIPHER
*)cipher
);
5908 void ssl_evp_cipher_free(const EVP_CIPHER
*cipher
)
5913 if (EVP_CIPHER_get0_provider(cipher
) != NULL
) {
5915 * The cipher was explicitly fetched and therefore it is safe to cast
5918 EVP_CIPHER_free((EVP_CIPHER
*)cipher
);
5922 const EVP_MD
*ssl_evp_md_fetch(OSSL_LIB_CTX
*libctx
,
5924 const char *properties
)
5928 md
= tls_get_digest_from_engine(nid
);
5932 /* Otherwise we do an explicit fetch */
5934 md
= EVP_MD_fetch(libctx
, OBJ_nid2sn(nid
), properties
);
5939 int ssl_evp_md_up_ref(const EVP_MD
*md
)
5941 /* Don't up-ref an implicit EVP_MD */
5942 if (EVP_MD_get0_provider(md
) == NULL
)
5946 * The digest was explicitly fetched and therefore it is safe to cast
5949 return EVP_MD_up_ref((EVP_MD
*)md
);
5952 void ssl_evp_md_free(const EVP_MD
*md
)
5957 if (EVP_MD_get0_provider(md
) != NULL
) {
5959 * The digest was explicitly fetched and therefore it is safe to cast
5962 EVP_MD_free((EVP_MD
*)md
);
5966 int SSL_set0_tmp_dh_pkey(SSL
*s
, EVP_PKEY
*dhpkey
)
5968 if (!ssl_security(s
, SSL_SECOP_TMP_DH
,
5969 EVP_PKEY_get_security_bits(dhpkey
), 0, dhpkey
)) {
5970 ERR_raise(ERR_LIB_SSL
, SSL_R_DH_KEY_TOO_SMALL
);
5971 EVP_PKEY_free(dhpkey
);
5974 EVP_PKEY_free(s
->cert
->dh_tmp
);
5975 s
->cert
->dh_tmp
= dhpkey
;
5979 int SSL_CTX_set0_tmp_dh_pkey(SSL_CTX
*ctx
, EVP_PKEY
*dhpkey
)
5981 if (!ssl_ctx_security(ctx
, SSL_SECOP_TMP_DH
,
5982 EVP_PKEY_get_security_bits(dhpkey
), 0, dhpkey
)) {
5983 ERR_raise(ERR_LIB_SSL
, SSL_R_DH_KEY_TOO_SMALL
);
5984 EVP_PKEY_free(dhpkey
);
5987 EVP_PKEY_free(ctx
->cert
->dh_tmp
);
5988 ctx
->cert
->dh_tmp
= dhpkey
;