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_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
)
2250 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2251 * negotiated, and that it is appropriate to call SSL_key_update() instead
2252 * of SSL_renegotiate().
2254 if (!SSL_IS_TLS13(s
)) {
2255 ERR_raise(ERR_LIB_SSL
, SSL_R_WRONG_SSL_VERSION
);
2259 if (updatetype
!= SSL_KEY_UPDATE_NOT_REQUESTED
2260 && updatetype
!= SSL_KEY_UPDATE_REQUESTED
) {
2261 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_KEY_UPDATE_TYPE
);
2265 if (!SSL_is_init_finished(s
)) {
2266 ERR_raise(ERR_LIB_SSL
, SSL_R_STILL_IN_INIT
);
2270 ossl_statem_set_in_init(s
, 1);
2271 s
->key_update
= updatetype
;
2275 int SSL_get_key_update_type(const SSL
*s
)
2277 return s
->key_update
;
2280 int SSL_renegotiate(SSL
*s
)
2282 if (SSL_IS_TLS13(s
)) {
2283 ERR_raise(ERR_LIB_SSL
, SSL_R_WRONG_SSL_VERSION
);
2287 if ((s
->options
& SSL_OP_NO_RENEGOTIATION
)) {
2288 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_RENEGOTIATION
);
2295 return s
->method
->ssl_renegotiate(s
);
2298 int SSL_renegotiate_abbreviated(SSL
*s
)
2300 if (SSL_IS_TLS13(s
)) {
2301 ERR_raise(ERR_LIB_SSL
, SSL_R_WRONG_SSL_VERSION
);
2305 if ((s
->options
& SSL_OP_NO_RENEGOTIATION
)) {
2306 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_RENEGOTIATION
);
2313 return s
->method
->ssl_renegotiate(s
);
2316 int SSL_renegotiate_pending(const SSL
*s
)
2319 * becomes true when negotiation is requested; false again once a
2320 * handshake has finished
2322 return (s
->renegotiate
!= 0);
2325 int SSL_new_session_ticket(SSL
*s
)
2327 if (SSL_in_init(s
) || SSL_IS_FIRST_HANDSHAKE(s
) || !s
->server
2328 || !SSL_IS_TLS13(s
))
2330 s
->ext
.extra_tickets_expected
++;
2334 long SSL_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
)
2339 case SSL_CTRL_GET_READ_AHEAD
:
2340 return RECORD_LAYER_get_read_ahead(&s
->rlayer
);
2341 case SSL_CTRL_SET_READ_AHEAD
:
2342 l
= RECORD_LAYER_get_read_ahead(&s
->rlayer
);
2343 RECORD_LAYER_set_read_ahead(&s
->rlayer
, larg
);
2346 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
2347 s
->msg_callback_arg
= parg
;
2351 return (s
->mode
|= larg
);
2352 case SSL_CTRL_CLEAR_MODE
:
2353 return (s
->mode
&= ~larg
);
2354 case SSL_CTRL_GET_MAX_CERT_LIST
:
2355 return (long)s
->max_cert_list
;
2356 case SSL_CTRL_SET_MAX_CERT_LIST
:
2359 l
= (long)s
->max_cert_list
;
2360 s
->max_cert_list
= (size_t)larg
;
2362 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
2363 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
2365 #ifndef OPENSSL_NO_KTLS
2366 if (s
->wbio
!= NULL
&& BIO_get_ktls_send(s
->wbio
))
2368 #endif /* OPENSSL_NO_KTLS */
2369 s
->max_send_fragment
= larg
;
2370 if (s
->max_send_fragment
< s
->split_send_fragment
)
2371 s
->split_send_fragment
= s
->max_send_fragment
;
2373 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
2374 if ((size_t)larg
> s
->max_send_fragment
|| larg
== 0)
2376 s
->split_send_fragment
= larg
;
2378 case SSL_CTRL_SET_MAX_PIPELINES
:
2379 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
2381 s
->max_pipelines
= larg
;
2383 RECORD_LAYER_set_read_ahead(&s
->rlayer
, 1);
2385 case SSL_CTRL_GET_RI_SUPPORT
:
2386 return s
->s3
.send_connection_binding
;
2387 case SSL_CTRL_CERT_FLAGS
:
2388 return (s
->cert
->cert_flags
|= larg
);
2389 case SSL_CTRL_CLEAR_CERT_FLAGS
:
2390 return (s
->cert
->cert_flags
&= ~larg
);
2392 case SSL_CTRL_GET_RAW_CIPHERLIST
:
2394 if (s
->s3
.tmp
.ciphers_raw
== NULL
)
2396 *(unsigned char **)parg
= s
->s3
.tmp
.ciphers_raw
;
2397 return (int)s
->s3
.tmp
.ciphers_rawlen
;
2399 return TLS_CIPHER_LEN
;
2401 case SSL_CTRL_GET_EXTMS_SUPPORT
:
2402 if (!s
->session
|| SSL_in_init(s
) || ossl_statem_get_in_handshake(s
))
2404 if (s
->session
->flags
& SSL_SESS_FLAG_EXTMS
)
2408 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
2409 return ssl_check_allowed_versions(larg
, s
->max_proto_version
)
2410 && ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
2411 &s
->min_proto_version
);
2412 case SSL_CTRL_GET_MIN_PROTO_VERSION
:
2413 return s
->min_proto_version
;
2414 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
2415 return ssl_check_allowed_versions(s
->min_proto_version
, larg
)
2416 && ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
2417 &s
->max_proto_version
);
2418 case SSL_CTRL_GET_MAX_PROTO_VERSION
:
2419 return s
->max_proto_version
;
2421 return s
->method
->ssl_ctrl(s
, cmd
, larg
, parg
);
2425 long SSL_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void))
2428 case SSL_CTRL_SET_MSG_CALLBACK
:
2429 s
->msg_callback
= (void (*)
2430 (int write_p
, int version
, int content_type
,
2431 const void *buf
, size_t len
, SSL
*ssl
,
2436 return s
->method
->ssl_callback_ctrl(s
, cmd
, fp
);
2440 LHASH_OF(SSL_SESSION
) *SSL_CTX_sessions(SSL_CTX
*ctx
)
2442 return ctx
->sessions
;
2445 long SSL_CTX_ctrl(SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
)
2448 /* For some cases with ctx == NULL perform syntax checks */
2451 case SSL_CTRL_SET_GROUPS_LIST
:
2452 return tls1_set_groups_list(ctx
, NULL
, NULL
, parg
);
2453 case SSL_CTRL_SET_SIGALGS_LIST
:
2454 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST
:
2455 return tls1_set_sigalgs_list(NULL
, parg
, 0);
2462 case SSL_CTRL_GET_READ_AHEAD
:
2463 return ctx
->read_ahead
;
2464 case SSL_CTRL_SET_READ_AHEAD
:
2465 l
= ctx
->read_ahead
;
2466 ctx
->read_ahead
= larg
;
2469 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
2470 ctx
->msg_callback_arg
= parg
;
2473 case SSL_CTRL_GET_MAX_CERT_LIST
:
2474 return (long)ctx
->max_cert_list
;
2475 case SSL_CTRL_SET_MAX_CERT_LIST
:
2478 l
= (long)ctx
->max_cert_list
;
2479 ctx
->max_cert_list
= (size_t)larg
;
2482 case SSL_CTRL_SET_SESS_CACHE_SIZE
:
2485 l
= (long)ctx
->session_cache_size
;
2486 ctx
->session_cache_size
= (size_t)larg
;
2488 case SSL_CTRL_GET_SESS_CACHE_SIZE
:
2489 return (long)ctx
->session_cache_size
;
2490 case SSL_CTRL_SET_SESS_CACHE_MODE
:
2491 l
= ctx
->session_cache_mode
;
2492 ctx
->session_cache_mode
= larg
;
2494 case SSL_CTRL_GET_SESS_CACHE_MODE
:
2495 return ctx
->session_cache_mode
;
2497 case SSL_CTRL_SESS_NUMBER
:
2498 return lh_SSL_SESSION_num_items(ctx
->sessions
);
2499 case SSL_CTRL_SESS_CONNECT
:
2500 return tsan_load(&ctx
->stats
.sess_connect
);
2501 case SSL_CTRL_SESS_CONNECT_GOOD
:
2502 return tsan_load(&ctx
->stats
.sess_connect_good
);
2503 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE
:
2504 return tsan_load(&ctx
->stats
.sess_connect_renegotiate
);
2505 case SSL_CTRL_SESS_ACCEPT
:
2506 return tsan_load(&ctx
->stats
.sess_accept
);
2507 case SSL_CTRL_SESS_ACCEPT_GOOD
:
2508 return tsan_load(&ctx
->stats
.sess_accept_good
);
2509 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE
:
2510 return tsan_load(&ctx
->stats
.sess_accept_renegotiate
);
2511 case SSL_CTRL_SESS_HIT
:
2512 return tsan_load(&ctx
->stats
.sess_hit
);
2513 case SSL_CTRL_SESS_CB_HIT
:
2514 return tsan_load(&ctx
->stats
.sess_cb_hit
);
2515 case SSL_CTRL_SESS_MISSES
:
2516 return tsan_load(&ctx
->stats
.sess_miss
);
2517 case SSL_CTRL_SESS_TIMEOUTS
:
2518 return tsan_load(&ctx
->stats
.sess_timeout
);
2519 case SSL_CTRL_SESS_CACHE_FULL
:
2520 return tsan_load(&ctx
->stats
.sess_cache_full
);
2522 return (ctx
->mode
|= larg
);
2523 case SSL_CTRL_CLEAR_MODE
:
2524 return (ctx
->mode
&= ~larg
);
2525 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
2526 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
2528 ctx
->max_send_fragment
= larg
;
2529 if (ctx
->max_send_fragment
< ctx
->split_send_fragment
)
2530 ctx
->split_send_fragment
= ctx
->max_send_fragment
;
2532 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
2533 if ((size_t)larg
> ctx
->max_send_fragment
|| larg
== 0)
2535 ctx
->split_send_fragment
= larg
;
2537 case SSL_CTRL_SET_MAX_PIPELINES
:
2538 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
2540 ctx
->max_pipelines
= larg
;
2542 case SSL_CTRL_CERT_FLAGS
:
2543 return (ctx
->cert
->cert_flags
|= larg
);
2544 case SSL_CTRL_CLEAR_CERT_FLAGS
:
2545 return (ctx
->cert
->cert_flags
&= ~larg
);
2546 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
2547 return ssl_check_allowed_versions(larg
, ctx
->max_proto_version
)
2548 && ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
2549 &ctx
->min_proto_version
);
2550 case SSL_CTRL_GET_MIN_PROTO_VERSION
:
2551 return ctx
->min_proto_version
;
2552 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
2553 return ssl_check_allowed_versions(ctx
->min_proto_version
, larg
)
2554 && ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
2555 &ctx
->max_proto_version
);
2556 case SSL_CTRL_GET_MAX_PROTO_VERSION
:
2557 return ctx
->max_proto_version
;
2559 return ctx
->method
->ssl_ctx_ctrl(ctx
, cmd
, larg
, parg
);
2563 long SSL_CTX_callback_ctrl(SSL_CTX
*ctx
, int cmd
, void (*fp
) (void))
2566 case SSL_CTRL_SET_MSG_CALLBACK
:
2567 ctx
->msg_callback
= (void (*)
2568 (int write_p
, int version
, int content_type
,
2569 const void *buf
, size_t len
, SSL
*ssl
,
2574 return ctx
->method
->ssl_ctx_callback_ctrl(ctx
, cmd
, fp
);
2578 int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
)
2587 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
2588 const SSL_CIPHER
*const *bp
)
2590 if ((*ap
)->id
> (*bp
)->id
)
2592 if ((*ap
)->id
< (*bp
)->id
)
2597 /** return a STACK of the ciphers available for the SSL and in order of
2599 STACK_OF(SSL_CIPHER
) *SSL_get_ciphers(const SSL
*s
)
2602 if (s
->cipher_list
!= NULL
) {
2603 return s
->cipher_list
;
2604 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list
!= NULL
)) {
2605 return s
->ctx
->cipher_list
;
2611 STACK_OF(SSL_CIPHER
) *SSL_get_client_ciphers(const SSL
*s
)
2613 if ((s
== NULL
) || !s
->server
)
2615 return s
->peer_ciphers
;
2618 STACK_OF(SSL_CIPHER
) *SSL_get1_supported_ciphers(SSL
*s
)
2620 STACK_OF(SSL_CIPHER
) *sk
= NULL
, *ciphers
;
2623 ciphers
= SSL_get_ciphers(s
);
2626 if (!ssl_set_client_disabled(s
))
2628 for (i
= 0; i
< sk_SSL_CIPHER_num(ciphers
); i
++) {
2629 const SSL_CIPHER
*c
= sk_SSL_CIPHER_value(ciphers
, i
);
2630 if (!ssl_cipher_disabled(s
, c
, SSL_SECOP_CIPHER_SUPPORTED
, 0)) {
2632 sk
= sk_SSL_CIPHER_new_null();
2635 if (!sk_SSL_CIPHER_push(sk
, c
)) {
2636 sk_SSL_CIPHER_free(sk
);
2644 /** return a STACK of the ciphers available for the SSL and in order of
2646 STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
)
2649 if (s
->cipher_list_by_id
!= NULL
) {
2650 return s
->cipher_list_by_id
;
2651 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list_by_id
!= NULL
)) {
2652 return s
->ctx
->cipher_list_by_id
;
2658 /** The old interface to get the same thing as SSL_get_ciphers() */
2659 const char *SSL_get_cipher_list(const SSL
*s
, int n
)
2661 const SSL_CIPHER
*c
;
2662 STACK_OF(SSL_CIPHER
) *sk
;
2666 sk
= SSL_get_ciphers(s
);
2667 if ((sk
== NULL
) || (sk_SSL_CIPHER_num(sk
) <= n
))
2669 c
= sk_SSL_CIPHER_value(sk
, n
);
2675 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2677 STACK_OF(SSL_CIPHER
) *SSL_CTX_get_ciphers(const SSL_CTX
*ctx
)
2680 return ctx
->cipher_list
;
2685 * Distinguish between ciphers controlled by set_ciphersuite() and
2686 * set_cipher_list() when counting.
2688 static int cipher_list_tls12_num(STACK_OF(SSL_CIPHER
) *sk
)
2691 const SSL_CIPHER
*c
;
2695 for (i
= 0; i
< sk_SSL_CIPHER_num(sk
); ++i
) {
2696 c
= sk_SSL_CIPHER_value(sk
, i
);
2697 if (c
->min_tls
>= TLS1_3_VERSION
)
2704 /** specify the ciphers to be used by default by the SSL_CTX */
2705 int SSL_CTX_set_cipher_list(SSL_CTX
*ctx
, const char *str
)
2707 STACK_OF(SSL_CIPHER
) *sk
;
2709 sk
= ssl_create_cipher_list(ctx
, ctx
->tls13_ciphersuites
,
2710 &ctx
->cipher_list
, &ctx
->cipher_list_by_id
, str
,
2713 * ssl_create_cipher_list may return an empty stack if it was unable to
2714 * find a cipher matching the given rule string (for example if the rule
2715 * string specifies a cipher which has been disabled). This is not an
2716 * error as far as ssl_create_cipher_list is concerned, and hence
2717 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2721 else if (cipher_list_tls12_num(sk
) == 0) {
2722 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CIPHER_MATCH
);
2728 /** specify the ciphers to be used by the SSL */
2729 int SSL_set_cipher_list(SSL
*s
, const char *str
)
2731 STACK_OF(SSL_CIPHER
) *sk
;
2733 sk
= ssl_create_cipher_list(s
->ctx
, s
->tls13_ciphersuites
,
2734 &s
->cipher_list
, &s
->cipher_list_by_id
, str
,
2736 /* see comment in SSL_CTX_set_cipher_list */
2739 else if (cipher_list_tls12_num(sk
) == 0) {
2740 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CIPHER_MATCH
);
2746 char *SSL_get_shared_ciphers(const SSL
*s
, char *buf
, int size
)
2749 STACK_OF(SSL_CIPHER
) *clntsk
, *srvrsk
;
2750 const SSL_CIPHER
*c
;
2754 || s
->peer_ciphers
== NULL
2759 clntsk
= s
->peer_ciphers
;
2760 srvrsk
= SSL_get_ciphers(s
);
2761 if (clntsk
== NULL
|| srvrsk
== NULL
)
2764 if (sk_SSL_CIPHER_num(clntsk
) == 0 || sk_SSL_CIPHER_num(srvrsk
) == 0)
2767 for (i
= 0; i
< sk_SSL_CIPHER_num(clntsk
); i
++) {
2770 c
= sk_SSL_CIPHER_value(clntsk
, i
);
2771 if (sk_SSL_CIPHER_find(srvrsk
, c
) < 0)
2774 n
= strlen(c
->name
);
2791 * Return the requested servername (SNI) value. Note that the behaviour varies
2793 * - whether this is called by the client or the server,
2794 * - if we are before or during/after the handshake,
2795 * - if a resumption or normal handshake is being attempted/has occurred
2796 * - whether we have negotiated TLSv1.2 (or below) or TLSv1.3
2798 * Note that only the host_name type is defined (RFC 3546).
2800 const char *SSL_get_servername(const SSL
*s
, const int type
)
2803 * If we don't know if we are the client or the server yet then we assume
2806 int server
= s
->handshake_func
== NULL
? 0 : s
->server
;
2807 if (type
!= TLSEXT_NAMETYPE_host_name
)
2813 * In TLSv1.3 on the server SNI is not associated with the session
2814 * but in TLSv1.2 or below it is.
2816 * Before the handshake:
2819 * During/after the handshake (TLSv1.2 or below resumption occurred):
2820 * - If a servername was accepted by the server in the original
2821 * handshake then it will return that servername, or NULL otherwise.
2823 * During/after the handshake (TLSv1.2 or below resumption did not occur):
2824 * - The function will return the servername requested by the client in
2825 * this handshake or NULL if none was requested.
2827 if (s
->hit
&& !SSL_IS_TLS13(s
))
2828 return s
->session
->ext
.hostname
;
2833 * Before the handshake:
2834 * - If a servername has been set via a call to
2835 * SSL_set_tlsext_host_name() then it will return that servername
2836 * - If one has not been set, but a TLSv1.2 resumption is being
2837 * attempted and the session from the original handshake had a
2838 * servername accepted by the server then it will return that
2840 * - Otherwise it returns NULL
2842 * During/after the handshake (TLSv1.2 or below resumption occurred):
2843 * - If the session from the original handshake had a servername accepted
2844 * by the server then it will return that servername.
2845 * - Otherwise it returns the servername set via
2846 * SSL_set_tlsext_host_name() (or NULL if it was not called).
2848 * During/after the handshake (TLSv1.2 or below resumption did not occur):
2849 * - It will return the servername set via SSL_set_tlsext_host_name()
2850 * (or NULL if it was not called).
2852 if (SSL_in_before(s
)) {
2853 if (s
->ext
.hostname
== NULL
2854 && s
->session
!= NULL
2855 && s
->session
->ssl_version
!= TLS1_3_VERSION
)
2856 return s
->session
->ext
.hostname
;
2858 if (!SSL_IS_TLS13(s
) && s
->hit
&& s
->session
->ext
.hostname
!= NULL
)
2859 return s
->session
->ext
.hostname
;
2863 return s
->ext
.hostname
;
2866 int SSL_get_servername_type(const SSL
*s
)
2868 if (SSL_get_servername(s
, TLSEXT_NAMETYPE_host_name
) != NULL
)
2869 return TLSEXT_NAMETYPE_host_name
;
2874 * SSL_select_next_proto implements the standard protocol selection. It is
2875 * expected that this function is called from the callback set by
2876 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2877 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2878 * not included in the length. A byte string of length 0 is invalid. No byte
2879 * string may be truncated. The current, but experimental algorithm for
2880 * selecting the protocol is: 1) If the server doesn't support NPN then this
2881 * is indicated to the callback. In this case, the client application has to
2882 * abort the connection or have a default application level protocol. 2) If
2883 * the server supports NPN, but advertises an empty list then the client
2884 * selects the first protocol in its list, but indicates via the API that this
2885 * fallback case was enacted. 3) Otherwise, the client finds the first
2886 * protocol in the server's list that it supports and selects this protocol.
2887 * This is because it's assumed that the server has better information about
2888 * which protocol a client should use. 4) If the client doesn't support any
2889 * of the server's advertised protocols, then this is treated the same as
2890 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2891 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2893 int SSL_select_next_proto(unsigned char **out
, unsigned char *outlen
,
2894 const unsigned char *server
,
2895 unsigned int server_len
,
2896 const unsigned char *client
, unsigned int client_len
)
2899 const unsigned char *result
;
2900 int status
= OPENSSL_NPN_UNSUPPORTED
;
2903 * For each protocol in server preference order, see if we support it.
2905 for (i
= 0; i
< server_len
;) {
2906 for (j
= 0; j
< client_len
;) {
2907 if (server
[i
] == client
[j
] &&
2908 memcmp(&server
[i
+ 1], &client
[j
+ 1], server
[i
]) == 0) {
2909 /* We found a match */
2910 result
= &server
[i
];
2911 status
= OPENSSL_NPN_NEGOTIATED
;
2921 /* There's no overlap between our protocols and the server's list. */
2923 status
= OPENSSL_NPN_NO_OVERLAP
;
2926 *out
= (unsigned char *)result
+ 1;
2927 *outlen
= result
[0];
2931 #ifndef OPENSSL_NO_NEXTPROTONEG
2933 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2934 * client's requested protocol for this connection and returns 0. If the
2935 * client didn't request any protocol, then *data is set to NULL. Note that
2936 * the client can request any protocol it chooses. The value returned from
2937 * this function need not be a member of the list of supported protocols
2938 * provided by the callback.
2940 void SSL_get0_next_proto_negotiated(const SSL
*s
, const unsigned char **data
,
2944 if (*data
== NULL
) {
2947 *len
= (unsigned int)s
->ext
.npn_len
;
2952 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2953 * a TLS server needs a list of supported protocols for Next Protocol
2954 * Negotiation. The returned list must be in wire format. The list is
2955 * returned by setting |out| to point to it and |outlen| to its length. This
2956 * memory will not be modified, but one should assume that the SSL* keeps a
2957 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2958 * wishes to advertise. Otherwise, no such extension will be included in the
2961 void SSL_CTX_set_npn_advertised_cb(SSL_CTX
*ctx
,
2962 SSL_CTX_npn_advertised_cb_func cb
,
2965 ctx
->ext
.npn_advertised_cb
= cb
;
2966 ctx
->ext
.npn_advertised_cb_arg
= arg
;
2970 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2971 * client needs to select a protocol from the server's provided list. |out|
2972 * must be set to point to the selected protocol (which may be within |in|).
2973 * The length of the protocol name must be written into |outlen|. The
2974 * server's advertised protocols are provided in |in| and |inlen|. The
2975 * callback can assume that |in| is syntactically valid. The client must
2976 * select a protocol. It is fatal to the connection if this callback returns
2977 * a value other than SSL_TLSEXT_ERR_OK.
2979 void SSL_CTX_set_npn_select_cb(SSL_CTX
*ctx
,
2980 SSL_CTX_npn_select_cb_func cb
,
2983 ctx
->ext
.npn_select_cb
= cb
;
2984 ctx
->ext
.npn_select_cb_arg
= arg
;
2988 static int alpn_value_ok(const unsigned char *protos
, unsigned int protos_len
)
2992 if (protos_len
< 2 || protos
== NULL
)
2995 for (idx
= 0; idx
< protos_len
; idx
+= protos
[idx
] + 1) {
2996 if (protos
[idx
] == 0)
2999 return idx
== protos_len
;
3002 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
3003 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
3004 * length-prefixed strings). Returns 0 on success.
3006 int SSL_CTX_set_alpn_protos(SSL_CTX
*ctx
, const unsigned char *protos
,
3007 unsigned int protos_len
)
3009 unsigned char *alpn
;
3011 if (protos_len
== 0 || protos
== NULL
) {
3012 OPENSSL_free(ctx
->ext
.alpn
);
3013 ctx
->ext
.alpn
= NULL
;
3014 ctx
->ext
.alpn_len
= 0;
3017 /* Not valid per RFC */
3018 if (!alpn_value_ok(protos
, protos_len
))
3021 alpn
= OPENSSL_memdup(protos
, protos_len
);
3023 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3026 OPENSSL_free(ctx
->ext
.alpn
);
3027 ctx
->ext
.alpn
= alpn
;
3028 ctx
->ext
.alpn_len
= protos_len
;
3034 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
3035 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
3036 * length-prefixed strings). Returns 0 on success.
3038 int SSL_set_alpn_protos(SSL
*ssl
, const unsigned char *protos
,
3039 unsigned int protos_len
)
3041 unsigned char *alpn
;
3043 if (protos_len
== 0 || protos
== NULL
) {
3044 OPENSSL_free(ssl
->ext
.alpn
);
3045 ssl
->ext
.alpn
= NULL
;
3046 ssl
->ext
.alpn_len
= 0;
3049 /* Not valid per RFC */
3050 if (!alpn_value_ok(protos
, protos_len
))
3053 alpn
= OPENSSL_memdup(protos
, protos_len
);
3055 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3058 OPENSSL_free(ssl
->ext
.alpn
);
3059 ssl
->ext
.alpn
= alpn
;
3060 ssl
->ext
.alpn_len
= protos_len
;
3066 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
3067 * called during ClientHello processing in order to select an ALPN protocol
3068 * from the client's list of offered protocols.
3070 void SSL_CTX_set_alpn_select_cb(SSL_CTX
*ctx
,
3071 SSL_CTX_alpn_select_cb_func cb
,
3074 ctx
->ext
.alpn_select_cb
= cb
;
3075 ctx
->ext
.alpn_select_cb_arg
= arg
;
3079 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
3080 * On return it sets |*data| to point to |*len| bytes of protocol name
3081 * (not including the leading length-prefix byte). If the server didn't
3082 * respond with a negotiated protocol then |*len| will be zero.
3084 void SSL_get0_alpn_selected(const SSL
*ssl
, const unsigned char **data
,
3087 *data
= ssl
->s3
.alpn_selected
;
3091 *len
= (unsigned int)ssl
->s3
.alpn_selected_len
;
3094 int SSL_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
3095 const char *label
, size_t llen
,
3096 const unsigned char *context
, size_t contextlen
,
3099 if (s
->session
== NULL
3100 || (s
->version
< TLS1_VERSION
&& s
->version
!= DTLS1_BAD_VER
))
3103 return s
->method
->ssl3_enc
->export_keying_material(s
, out
, olen
, label
,
3105 contextlen
, use_context
);
3108 int SSL_export_keying_material_early(SSL
*s
, unsigned char *out
, size_t olen
,
3109 const char *label
, size_t llen
,
3110 const unsigned char *context
,
3113 if (s
->version
!= TLS1_3_VERSION
)
3116 return tls13_export_keying_material_early(s
, out
, olen
, label
, llen
,
3117 context
, contextlen
);
3120 static unsigned long ssl_session_hash(const SSL_SESSION
*a
)
3122 const unsigned char *session_id
= a
->session_id
;
3124 unsigned char tmp_storage
[4];
3126 if (a
->session_id_length
< sizeof(tmp_storage
)) {
3127 memset(tmp_storage
, 0, sizeof(tmp_storage
));
3128 memcpy(tmp_storage
, a
->session_id
, a
->session_id_length
);
3129 session_id
= tmp_storage
;
3133 ((unsigned long)session_id
[0]) |
3134 ((unsigned long)session_id
[1] << 8L) |
3135 ((unsigned long)session_id
[2] << 16L) |
3136 ((unsigned long)session_id
[3] << 24L);
3141 * NB: If this function (or indeed the hash function which uses a sort of
3142 * coarser function than this one) is changed, ensure
3143 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
3144 * being able to construct an SSL_SESSION that will collide with any existing
3145 * session with a matching session ID.
3147 static int ssl_session_cmp(const SSL_SESSION
*a
, const SSL_SESSION
*b
)
3149 if (a
->ssl_version
!= b
->ssl_version
)
3151 if (a
->session_id_length
!= b
->session_id_length
)
3153 return memcmp(a
->session_id
, b
->session_id
, a
->session_id_length
);
3157 * These wrapper functions should remain rather than redeclaring
3158 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
3159 * variable. The reason is that the functions aren't static, they're exposed
3163 SSL_CTX
*SSL_CTX_new_ex(OSSL_LIB_CTX
*libctx
, const char *propq
,
3164 const SSL_METHOD
*meth
)
3166 SSL_CTX
*ret
= NULL
;
3169 ERR_raise(ERR_LIB_SSL
, SSL_R_NULL_SSL_METHOD_PASSED
);
3173 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS
, NULL
))
3176 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
3177 ERR_raise(ERR_LIB_SSL
, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS
);
3180 ret
= OPENSSL_zalloc(sizeof(*ret
));
3184 ret
->libctx
= libctx
;
3185 if (propq
!= NULL
) {
3186 ret
->propq
= OPENSSL_strdup(propq
);
3187 if (ret
->propq
== NULL
)
3192 ret
->min_proto_version
= 0;
3193 ret
->max_proto_version
= 0;
3194 ret
->mode
= SSL_MODE_AUTO_RETRY
;
3195 ret
->session_cache_mode
= SSL_SESS_CACHE_SERVER
;
3196 ret
->session_cache_size
= SSL_SESSION_CACHE_MAX_SIZE_DEFAULT
;
3197 /* We take the system default. */
3198 ret
->session_timeout
= meth
->get_timeout();
3199 ret
->references
= 1;
3200 ret
->lock
= CRYPTO_THREAD_lock_new();
3201 if (ret
->lock
== NULL
) {
3202 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3206 ret
->max_cert_list
= SSL_MAX_CERT_LIST_DEFAULT
;
3207 ret
->verify_mode
= SSL_VERIFY_NONE
;
3208 if ((ret
->cert
= ssl_cert_new()) == NULL
)
3211 ret
->sessions
= lh_SSL_SESSION_new(ssl_session_hash
, ssl_session_cmp
);
3212 if (ret
->sessions
== NULL
)
3214 ret
->cert_store
= X509_STORE_new();
3215 if (ret
->cert_store
== NULL
)
3217 #ifndef OPENSSL_NO_CT
3218 ret
->ctlog_store
= CTLOG_STORE_new_ex(libctx
, propq
);
3219 if (ret
->ctlog_store
== NULL
)
3223 /* initialize cipher/digest methods table */
3224 if (!ssl_load_ciphers(ret
))
3226 /* initialise sig algs */
3227 if (!ssl_setup_sig_algs(ret
))
3231 if (!ssl_load_groups(ret
))
3234 if (!SSL_CTX_set_ciphersuites(ret
, OSSL_default_ciphersuites()))
3237 if (!ssl_create_cipher_list(ret
,
3238 ret
->tls13_ciphersuites
,
3239 &ret
->cipher_list
, &ret
->cipher_list_by_id
,
3240 OSSL_default_cipher_list(), ret
->cert
)
3241 || sk_SSL_CIPHER_num(ret
->cipher_list
) <= 0) {
3242 ERR_raise(ERR_LIB_SSL
, SSL_R_LIBRARY_HAS_NO_CIPHERS
);
3246 ret
->param
= X509_VERIFY_PARAM_new();
3247 if (ret
->param
== NULL
)
3251 * If these aren't available from the provider we'll get NULL returns.
3252 * That's fine but will cause errors later if SSLv3 is negotiated
3254 ret
->md5
= ssl_evp_md_fetch(libctx
, NID_md5
, propq
);
3255 ret
->sha1
= ssl_evp_md_fetch(libctx
, NID_sha1
, propq
);
3257 if ((ret
->ca_names
= sk_X509_NAME_new_null()) == NULL
)
3260 if ((ret
->client_ca_names
= sk_X509_NAME_new_null()) == NULL
)
3263 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, ret
, &ret
->ex_data
))
3266 if ((ret
->ext
.secure
= OPENSSL_secure_zalloc(sizeof(*ret
->ext
.secure
))) == NULL
)
3269 /* No compression for DTLS */
3270 if (!(meth
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_DTLS
))
3271 ret
->comp_methods
= SSL_COMP_get_compression_methods();
3273 ret
->max_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
3274 ret
->split_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
3276 /* Setup RFC5077 ticket keys */
3277 if ((RAND_bytes_ex(libctx
, ret
->ext
.tick_key_name
,
3278 sizeof(ret
->ext
.tick_key_name
)) <= 0)
3279 || (RAND_priv_bytes_ex(libctx
, ret
->ext
.secure
->tick_hmac_key
,
3280 sizeof(ret
->ext
.secure
->tick_hmac_key
)) <= 0)
3281 || (RAND_priv_bytes_ex(libctx
, ret
->ext
.secure
->tick_aes_key
,
3282 sizeof(ret
->ext
.secure
->tick_aes_key
)) <= 0))
3283 ret
->options
|= SSL_OP_NO_TICKET
;
3285 if (RAND_priv_bytes_ex(libctx
, ret
->ext
.cookie_hmac_key
,
3286 sizeof(ret
->ext
.cookie_hmac_key
)) <= 0)
3289 #ifndef OPENSSL_NO_SRP
3290 if (!ssl_ctx_srp_ctx_init_intern(ret
))
3293 #ifndef OPENSSL_NO_ENGINE
3294 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
3295 # define eng_strx(x) #x
3296 # define eng_str(x) eng_strx(x)
3297 /* Use specific client engine automatically... ignore errors */
3300 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
3303 ENGINE_load_builtin_engines();
3304 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
3306 if (!eng
|| !SSL_CTX_set_client_cert_engine(ret
, eng
))
3312 * Default is to connect to non-RI servers. When RI is more widely
3313 * deployed might change this.
3315 ret
->options
|= SSL_OP_LEGACY_SERVER_CONNECT
;
3317 * Disable compression by default to prevent CRIME. Applications can
3318 * re-enable compression by configuring
3319 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3320 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3321 * middlebox compatibility by default. This may be disabled by default in
3322 * a later OpenSSL version.
3324 ret
->options
|= SSL_OP_NO_COMPRESSION
| SSL_OP_ENABLE_MIDDLEBOX_COMPAT
;
3326 ret
->ext
.status_type
= TLSEXT_STATUSTYPE_nothing
;
3329 * We cannot usefully set a default max_early_data here (which gets
3330 * propagated in SSL_new(), for the following reason: setting the
3331 * SSL field causes tls_construct_stoc_early_data() to tell the
3332 * client that early data will be accepted when constructing a TLS 1.3
3333 * session ticket, and the client will accordingly send us early data
3334 * when using that ticket (if the client has early data to send).
3335 * However, in order for the early data to actually be consumed by
3336 * the application, the application must also have calls to
3337 * SSL_read_early_data(); otherwise we'll just skip past the early data
3338 * and ignore it. So, since the application must add calls to
3339 * SSL_read_early_data(), we also require them to add
3340 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3341 * eliminating the bandwidth-wasting early data in the case described
3344 ret
->max_early_data
= 0;
3347 * Default recv_max_early_data is a fully loaded single record. Could be
3348 * split across multiple records in practice. We set this differently to
3349 * max_early_data so that, in the default case, we do not advertise any
3350 * support for early_data, but if a client were to send us some (e.g.
3351 * because of an old, stale ticket) then we will tolerate it and skip over
3354 ret
->recv_max_early_data
= SSL3_RT_MAX_PLAIN_LENGTH
;
3356 /* By default we send two session tickets automatically in TLSv1.3 */
3357 ret
->num_tickets
= 2;
3359 ssl_ctx_system_config(ret
);
3363 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
3369 SSL_CTX
*SSL_CTX_new(const SSL_METHOD
*meth
)
3371 return SSL_CTX_new_ex(NULL
, NULL
, meth
);
3374 int SSL_CTX_up_ref(SSL_CTX
*ctx
)
3378 if (CRYPTO_UP_REF(&ctx
->references
, &i
, ctx
->lock
) <= 0)
3381 REF_PRINT_COUNT("SSL_CTX", ctx
);
3382 REF_ASSERT_ISNT(i
< 2);
3383 return ((i
> 1) ? 1 : 0);
3386 void SSL_CTX_free(SSL_CTX
*a
)
3394 CRYPTO_DOWN_REF(&a
->references
, &i
, a
->lock
);
3395 REF_PRINT_COUNT("SSL_CTX", a
);
3398 REF_ASSERT_ISNT(i
< 0);
3400 X509_VERIFY_PARAM_free(a
->param
);
3401 dane_ctx_final(&a
->dane
);
3404 * Free internal session cache. However: the remove_cb() may reference
3405 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3406 * after the sessions were flushed.
3407 * As the ex_data handling routines might also touch the session cache,
3408 * the most secure solution seems to be: empty (flush) the cache, then
3409 * free ex_data, then finally free the cache.
3410 * (See ticket [openssl.org #212].)
3412 if (a
->sessions
!= NULL
)
3413 SSL_CTX_flush_sessions(a
, 0);
3415 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, a
, &a
->ex_data
);
3416 lh_SSL_SESSION_free(a
->sessions
);
3417 X509_STORE_free(a
->cert_store
);
3418 #ifndef OPENSSL_NO_CT
3419 CTLOG_STORE_free(a
->ctlog_store
);
3421 sk_SSL_CIPHER_free(a
->cipher_list
);
3422 sk_SSL_CIPHER_free(a
->cipher_list_by_id
);
3423 sk_SSL_CIPHER_free(a
->tls13_ciphersuites
);
3424 ssl_cert_free(a
->cert
);
3425 sk_X509_NAME_pop_free(a
->ca_names
, X509_NAME_free
);
3426 sk_X509_NAME_pop_free(a
->client_ca_names
, X509_NAME_free
);
3427 sk_X509_pop_free(a
->extra_certs
, X509_free
);
3428 a
->comp_methods
= NULL
;
3429 #ifndef OPENSSL_NO_SRTP
3430 sk_SRTP_PROTECTION_PROFILE_free(a
->srtp_profiles
);
3432 #ifndef OPENSSL_NO_SRP
3433 ssl_ctx_srp_ctx_free_intern(a
);
3435 #ifndef OPENSSL_NO_ENGINE
3436 tls_engine_finish(a
->client_cert_engine
);
3439 OPENSSL_free(a
->ext
.ecpointformats
);
3440 OPENSSL_free(a
->ext
.supportedgroups
);
3441 OPENSSL_free(a
->ext
.supported_groups_default
);
3442 OPENSSL_free(a
->ext
.alpn
);
3443 OPENSSL_secure_free(a
->ext
.secure
);
3445 ssl_evp_md_free(a
->md5
);
3446 ssl_evp_md_free(a
->sha1
);
3448 for (j
= 0; j
< SSL_ENC_NUM_IDX
; j
++)
3449 ssl_evp_cipher_free(a
->ssl_cipher_methods
[j
]);
3450 for (j
= 0; j
< SSL_MD_NUM_IDX
; j
++)
3451 ssl_evp_md_free(a
->ssl_digest_methods
[j
]);
3452 for (j
= 0; j
< a
->group_list_len
; j
++) {
3453 OPENSSL_free(a
->group_list
[j
].tlsname
);
3454 OPENSSL_free(a
->group_list
[j
].realname
);
3455 OPENSSL_free(a
->group_list
[j
].algorithm
);
3457 OPENSSL_free(a
->group_list
);
3459 OPENSSL_free(a
->sigalg_lookup_cache
);
3461 CRYPTO_THREAD_lock_free(a
->lock
);
3463 OPENSSL_free(a
->propq
);
3468 void SSL_CTX_set_default_passwd_cb(SSL_CTX
*ctx
, pem_password_cb
*cb
)
3470 ctx
->default_passwd_callback
= cb
;
3473 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX
*ctx
, void *u
)
3475 ctx
->default_passwd_callback_userdata
= u
;
3478 pem_password_cb
*SSL_CTX_get_default_passwd_cb(SSL_CTX
*ctx
)
3480 return ctx
->default_passwd_callback
;
3483 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX
*ctx
)
3485 return ctx
->default_passwd_callback_userdata
;
3488 void SSL_set_default_passwd_cb(SSL
*s
, pem_password_cb
*cb
)
3490 s
->default_passwd_callback
= cb
;
3493 void SSL_set_default_passwd_cb_userdata(SSL
*s
, void *u
)
3495 s
->default_passwd_callback_userdata
= u
;
3498 pem_password_cb
*SSL_get_default_passwd_cb(SSL
*s
)
3500 return s
->default_passwd_callback
;
3503 void *SSL_get_default_passwd_cb_userdata(SSL
*s
)
3505 return s
->default_passwd_callback_userdata
;
3508 void SSL_CTX_set_cert_verify_callback(SSL_CTX
*ctx
,
3509 int (*cb
) (X509_STORE_CTX
*, void *),
3512 ctx
->app_verify_callback
= cb
;
3513 ctx
->app_verify_arg
= arg
;
3516 void SSL_CTX_set_verify(SSL_CTX
*ctx
, int mode
,
3517 int (*cb
) (int, X509_STORE_CTX
*))
3519 ctx
->verify_mode
= mode
;
3520 ctx
->default_verify_callback
= cb
;
3523 void SSL_CTX_set_verify_depth(SSL_CTX
*ctx
, int depth
)
3525 X509_VERIFY_PARAM_set_depth(ctx
->param
, depth
);
3528 void SSL_CTX_set_cert_cb(SSL_CTX
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
3530 ssl_cert_set_cert_cb(c
->cert
, cb
, arg
);
3533 void SSL_set_cert_cb(SSL
*s
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
3535 ssl_cert_set_cert_cb(s
->cert
, cb
, arg
);
3538 void ssl_set_masks(SSL
*s
)
3541 uint32_t *pvalid
= s
->s3
.tmp
.valid_flags
;
3542 int rsa_enc
, rsa_sign
, dh_tmp
, dsa_sign
;
3543 unsigned long mask_k
, mask_a
;
3544 int have_ecc_cert
, ecdsa_ok
;
3549 dh_tmp
= (c
->dh_tmp
!= NULL
3550 || c
->dh_tmp_cb
!= NULL
3553 rsa_enc
= pvalid
[SSL_PKEY_RSA
] & CERT_PKEY_VALID
;
3554 rsa_sign
= pvalid
[SSL_PKEY_RSA
] & CERT_PKEY_VALID
;
3555 dsa_sign
= pvalid
[SSL_PKEY_DSA_SIGN
] & CERT_PKEY_VALID
;
3556 have_ecc_cert
= pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_VALID
;
3560 OSSL_TRACE4(TLS_CIPHER
, "dh_tmp=%d rsa_enc=%d rsa_sign=%d dsa_sign=%d\n",
3561 dh_tmp
, rsa_enc
, rsa_sign
, dsa_sign
);
3563 #ifndef OPENSSL_NO_GOST
3564 if (ssl_has_cert(s
, SSL_PKEY_GOST12_512
)) {
3565 mask_k
|= SSL_kGOST
| SSL_kGOST18
;
3566 mask_a
|= SSL_aGOST12
;
3568 if (ssl_has_cert(s
, SSL_PKEY_GOST12_256
)) {
3569 mask_k
|= SSL_kGOST
| SSL_kGOST18
;
3570 mask_a
|= SSL_aGOST12
;
3572 if (ssl_has_cert(s
, SSL_PKEY_GOST01
)) {
3573 mask_k
|= SSL_kGOST
;
3574 mask_a
|= SSL_aGOST01
;
3585 * If we only have an RSA-PSS certificate allow RSA authentication
3586 * if TLS 1.2 and peer supports it.
3589 if (rsa_enc
|| rsa_sign
|| (ssl_has_cert(s
, SSL_PKEY_RSA_PSS_SIGN
)
3590 && pvalid
[SSL_PKEY_RSA_PSS_SIGN
] & CERT_PKEY_EXPLICIT_SIGN
3591 && TLS1_get_version(s
) == TLS1_2_VERSION
))
3598 mask_a
|= SSL_aNULL
;
3601 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3602 * depending on the key usage extension.
3604 if (have_ecc_cert
) {
3606 ex_kusage
= X509_get_key_usage(c
->pkeys
[SSL_PKEY_ECC
].x509
);
3607 ecdsa_ok
= ex_kusage
& X509v3_KU_DIGITAL_SIGNATURE
;
3608 if (!(pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_SIGN
))
3611 mask_a
|= SSL_aECDSA
;
3613 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3614 if (!(mask_a
& SSL_aECDSA
) && ssl_has_cert(s
, SSL_PKEY_ED25519
)
3615 && pvalid
[SSL_PKEY_ED25519
] & CERT_PKEY_EXPLICIT_SIGN
3616 && TLS1_get_version(s
) == TLS1_2_VERSION
)
3617 mask_a
|= SSL_aECDSA
;
3619 /* Allow Ed448 for TLS 1.2 if peer supports it */
3620 if (!(mask_a
& SSL_aECDSA
) && ssl_has_cert(s
, SSL_PKEY_ED448
)
3621 && pvalid
[SSL_PKEY_ED448
] & CERT_PKEY_EXPLICIT_SIGN
3622 && TLS1_get_version(s
) == TLS1_2_VERSION
)
3623 mask_a
|= SSL_aECDSA
;
3625 mask_k
|= SSL_kECDHE
;
3627 #ifndef OPENSSL_NO_PSK
3630 if (mask_k
& SSL_kRSA
)
3631 mask_k
|= SSL_kRSAPSK
;
3632 if (mask_k
& SSL_kDHE
)
3633 mask_k
|= SSL_kDHEPSK
;
3634 if (mask_k
& SSL_kECDHE
)
3635 mask_k
|= SSL_kECDHEPSK
;
3638 s
->s3
.tmp
.mask_k
= mask_k
;
3639 s
->s3
.tmp
.mask_a
= mask_a
;
3642 int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
)
3644 if (s
->s3
.tmp
.new_cipher
->algorithm_auth
& SSL_aECDSA
) {
3645 /* key usage, if present, must allow signing */
3646 if (!(X509_get_key_usage(x
) & X509v3_KU_DIGITAL_SIGNATURE
)) {
3647 ERR_raise(ERR_LIB_SSL
, SSL_R_ECC_CERT_NOT_FOR_SIGNING
);
3651 return 1; /* all checks are ok */
3654 int ssl_get_server_cert_serverinfo(SSL
*s
, const unsigned char **serverinfo
,
3655 size_t *serverinfo_length
)
3657 CERT_PKEY
*cpk
= s
->s3
.tmp
.cert
;
3658 *serverinfo_length
= 0;
3660 if (cpk
== NULL
|| cpk
->serverinfo
== NULL
)
3663 *serverinfo
= cpk
->serverinfo
;
3664 *serverinfo_length
= cpk
->serverinfo_length
;
3668 void ssl_update_cache(SSL
*s
, int mode
)
3673 * If the session_id_length is 0, we are not supposed to cache it, and it
3674 * would be rather hard to do anyway :-)
3676 if (s
->session
->session_id_length
== 0)
3680 * If sid_ctx_length is 0 there is no specific application context
3681 * associated with this session, so when we try to resume it and
3682 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3683 * indication that this is actually a session for the proper application
3684 * context, and the *handshake* will fail, not just the resumption attempt.
3685 * Do not cache (on the server) these sessions that are not resumable
3686 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3688 if (s
->server
&& s
->session
->sid_ctx_length
== 0
3689 && (s
->verify_mode
& SSL_VERIFY_PEER
) != 0)
3692 i
= s
->session_ctx
->session_cache_mode
;
3694 && (!s
->hit
|| SSL_IS_TLS13(s
))) {
3696 * Add the session to the internal cache. In server side TLSv1.3 we
3697 * normally don't do this because by default it's a full stateless ticket
3698 * with only a dummy session id so there is no reason to cache it,
3700 * - we are doing early_data, in which case we cache so that we can
3702 * - the application has set a remove_session_cb so needs to know about
3703 * session timeout events
3704 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3706 if ((i
& SSL_SESS_CACHE_NO_INTERNAL_STORE
) == 0
3707 && (!SSL_IS_TLS13(s
)
3709 || (s
->max_early_data
> 0
3710 && (s
->options
& SSL_OP_NO_ANTI_REPLAY
) == 0)
3711 || s
->session_ctx
->remove_session_cb
!= NULL
3712 || (s
->options
& SSL_OP_NO_TICKET
) != 0))
3713 SSL_CTX_add_session(s
->session_ctx
, s
->session
);
3716 * Add the session to the external cache. We do this even in server side
3717 * TLSv1.3 without early data because some applications just want to
3718 * know about the creation of a session and aren't doing a full cache.
3720 if (s
->session_ctx
->new_session_cb
!= NULL
) {
3721 SSL_SESSION_up_ref(s
->session
);
3722 if (!s
->session_ctx
->new_session_cb(s
, s
->session
))
3723 SSL_SESSION_free(s
->session
);
3727 /* auto flush every 255 connections */
3728 if ((!(i
& SSL_SESS_CACHE_NO_AUTO_CLEAR
)) && ((i
& mode
) == mode
)) {
3729 TSAN_QUALIFIER
int *stat
;
3730 if (mode
& SSL_SESS_CACHE_CLIENT
)
3731 stat
= &s
->session_ctx
->stats
.sess_connect_good
;
3733 stat
= &s
->session_ctx
->stats
.sess_accept_good
;
3734 if ((tsan_load(stat
) & 0xff) == 0xff)
3735 SSL_CTX_flush_sessions(s
->session_ctx
, (unsigned long)time(NULL
));
3739 const SSL_METHOD
*SSL_CTX_get_ssl_method(const SSL_CTX
*ctx
)
3744 const SSL_METHOD
*SSL_get_ssl_method(const SSL
*s
)
3749 int SSL_set_ssl_method(SSL
*s
, const SSL_METHOD
*meth
)
3753 if (s
->method
!= meth
) {
3754 const SSL_METHOD
*sm
= s
->method
;
3755 int (*hf
) (SSL
*) = s
->handshake_func
;
3757 if (sm
->version
== meth
->version
)
3762 ret
= s
->method
->ssl_new(s
);
3765 if (hf
== sm
->ssl_connect
)
3766 s
->handshake_func
= meth
->ssl_connect
;
3767 else if (hf
== sm
->ssl_accept
)
3768 s
->handshake_func
= meth
->ssl_accept
;
3773 int SSL_get_error(const SSL
*s
, int i
)
3780 return SSL_ERROR_NONE
;
3783 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3784 * where we do encode the error
3786 if ((l
= ERR_peek_error()) != 0) {
3787 if (ERR_GET_LIB(l
) == ERR_LIB_SYS
)
3788 return SSL_ERROR_SYSCALL
;
3790 return SSL_ERROR_SSL
;
3793 if (SSL_want_read(s
)) {
3794 bio
= SSL_get_rbio(s
);
3795 if (BIO_should_read(bio
))
3796 return SSL_ERROR_WANT_READ
;
3797 else if (BIO_should_write(bio
))
3799 * This one doesn't make too much sense ... We never try to write
3800 * to the rbio, and an application program where rbio and wbio
3801 * are separate couldn't even know what it should wait for.
3802 * However if we ever set s->rwstate incorrectly (so that we have
3803 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3804 * wbio *are* the same, this test works around that bug; so it
3805 * might be safer to keep it.
3807 return SSL_ERROR_WANT_WRITE
;
3808 else if (BIO_should_io_special(bio
)) {
3809 reason
= BIO_get_retry_reason(bio
);
3810 if (reason
== BIO_RR_CONNECT
)
3811 return SSL_ERROR_WANT_CONNECT
;
3812 else if (reason
== BIO_RR_ACCEPT
)
3813 return SSL_ERROR_WANT_ACCEPT
;
3815 return SSL_ERROR_SYSCALL
; /* unknown */
3819 if (SSL_want_write(s
)) {
3820 /* Access wbio directly - in order to use the buffered bio if present */
3822 if (BIO_should_write(bio
))
3823 return SSL_ERROR_WANT_WRITE
;
3824 else if (BIO_should_read(bio
))
3826 * See above (SSL_want_read(s) with BIO_should_write(bio))
3828 return SSL_ERROR_WANT_READ
;
3829 else if (BIO_should_io_special(bio
)) {
3830 reason
= BIO_get_retry_reason(bio
);
3831 if (reason
== BIO_RR_CONNECT
)
3832 return SSL_ERROR_WANT_CONNECT
;
3833 else if (reason
== BIO_RR_ACCEPT
)
3834 return SSL_ERROR_WANT_ACCEPT
;
3836 return SSL_ERROR_SYSCALL
;
3839 if (SSL_want_x509_lookup(s
))
3840 return SSL_ERROR_WANT_X509_LOOKUP
;
3841 if (SSL_want_retry_verify(s
))
3842 return SSL_ERROR_WANT_RETRY_VERIFY
;
3843 if (SSL_want_async(s
))
3844 return SSL_ERROR_WANT_ASYNC
;
3845 if (SSL_want_async_job(s
))
3846 return SSL_ERROR_WANT_ASYNC_JOB
;
3847 if (SSL_want_client_hello_cb(s
))
3848 return SSL_ERROR_WANT_CLIENT_HELLO_CB
;
3850 if ((s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) &&
3851 (s
->s3
.warn_alert
== SSL_AD_CLOSE_NOTIFY
))
3852 return SSL_ERROR_ZERO_RETURN
;
3854 return SSL_ERROR_SYSCALL
;
3857 static int ssl_do_handshake_intern(void *vargs
)
3859 struct ssl_async_args
*args
;
3862 args
= (struct ssl_async_args
*)vargs
;
3865 return s
->handshake_func(s
);
3868 int SSL_do_handshake(SSL
*s
)
3872 if (s
->handshake_func
== NULL
) {
3873 ERR_raise(ERR_LIB_SSL
, SSL_R_CONNECTION_TYPE_NOT_SET
);
3877 ossl_statem_check_finish_init(s
, -1);
3879 s
->method
->ssl_renegotiate_check(s
, 0);
3881 if (SSL_in_init(s
) || SSL_in_before(s
)) {
3882 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
3883 struct ssl_async_args args
;
3887 ret
= ssl_start_async_job(s
, &args
, ssl_do_handshake_intern
);
3889 ret
= s
->handshake_func(s
);
3895 void SSL_set_accept_state(SSL
*s
)
3899 ossl_statem_clear(s
);
3900 s
->handshake_func
= s
->method
->ssl_accept
;
3904 void SSL_set_connect_state(SSL
*s
)
3908 ossl_statem_clear(s
);
3909 s
->handshake_func
= s
->method
->ssl_connect
;
3913 int ssl_undefined_function(SSL
*s
)
3915 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3919 int ssl_undefined_void_function(void)
3921 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3925 int ssl_undefined_const_function(const SSL
*s
)
3930 const SSL_METHOD
*ssl_bad_method(int ver
)
3932 ERR_raise(ERR_LIB_SSL
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3936 const char *ssl_protocol_to_string(int version
)
3940 case TLS1_3_VERSION
:
3943 case TLS1_2_VERSION
:
3946 case TLS1_1_VERSION
:
3961 case DTLS1_2_VERSION
:
3969 const char *SSL_get_version(const SSL
*s
)
3971 return ssl_protocol_to_string(s
->version
);
3974 static int dup_ca_names(STACK_OF(X509_NAME
) **dst
, STACK_OF(X509_NAME
) *src
)
3976 STACK_OF(X509_NAME
) *sk
;
3985 if ((sk
= sk_X509_NAME_new_null()) == NULL
)
3987 for (i
= 0; i
< sk_X509_NAME_num(src
); i
++) {
3988 xn
= X509_NAME_dup(sk_X509_NAME_value(src
, i
));
3990 sk_X509_NAME_pop_free(sk
, X509_NAME_free
);
3993 if (sk_X509_NAME_insert(sk
, xn
, i
) == 0) {
3995 sk_X509_NAME_pop_free(sk
, X509_NAME_free
);
4004 SSL
*SSL_dup(SSL
*s
)
4009 /* If we're not quiescent, just up_ref! */
4010 if (!SSL_in_init(s
) || !SSL_in_before(s
)) {
4011 CRYPTO_UP_REF(&s
->references
, &i
, s
->lock
);
4016 * Otherwise, copy configuration state, and session if set.
4018 if ((ret
= SSL_new(SSL_get_SSL_CTX(s
))) == NULL
)
4021 if (s
->session
!= NULL
) {
4023 * Arranges to share the same session via up_ref. This "copies"
4024 * session-id, SSL_METHOD, sid_ctx, and 'cert'
4026 if (!SSL_copy_session_id(ret
, s
))
4030 * No session has been established yet, so we have to expect that
4031 * s->cert or ret->cert will be changed later -- they should not both
4032 * point to the same object, and thus we can't use
4033 * SSL_copy_session_id.
4035 if (!SSL_set_ssl_method(ret
, s
->method
))
4038 if (s
->cert
!= NULL
) {
4039 ssl_cert_free(ret
->cert
);
4040 ret
->cert
= ssl_cert_dup(s
->cert
);
4041 if (ret
->cert
== NULL
)
4045 if (!SSL_set_session_id_context(ret
, s
->sid_ctx
,
4046 (int)s
->sid_ctx_length
))
4050 if (!ssl_dane_dup(ret
, s
))
4052 ret
->version
= s
->version
;
4053 ret
->options
= s
->options
;
4054 ret
->min_proto_version
= s
->min_proto_version
;
4055 ret
->max_proto_version
= s
->max_proto_version
;
4056 ret
->mode
= s
->mode
;
4057 SSL_set_max_cert_list(ret
, SSL_get_max_cert_list(s
));
4058 SSL_set_read_ahead(ret
, SSL_get_read_ahead(s
));
4059 ret
->msg_callback
= s
->msg_callback
;
4060 ret
->msg_callback_arg
= s
->msg_callback_arg
;
4061 SSL_set_verify(ret
, SSL_get_verify_mode(s
), SSL_get_verify_callback(s
));
4062 SSL_set_verify_depth(ret
, SSL_get_verify_depth(s
));
4063 ret
->generate_session_id
= s
->generate_session_id
;
4065 SSL_set_info_callback(ret
, SSL_get_info_callback(s
));
4067 /* copy app data, a little dangerous perhaps */
4068 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL
, &ret
->ex_data
, &s
->ex_data
))
4071 ret
->server
= s
->server
;
4072 if (s
->handshake_func
) {
4074 SSL_set_accept_state(ret
);
4076 SSL_set_connect_state(ret
);
4078 ret
->shutdown
= s
->shutdown
;
4081 ret
->default_passwd_callback
= s
->default_passwd_callback
;
4082 ret
->default_passwd_callback_userdata
= s
->default_passwd_callback_userdata
;
4084 X509_VERIFY_PARAM_inherit(ret
->param
, s
->param
);
4086 /* dup the cipher_list and cipher_list_by_id stacks */
4087 if (s
->cipher_list
!= NULL
) {
4088 if ((ret
->cipher_list
= sk_SSL_CIPHER_dup(s
->cipher_list
)) == NULL
)
4091 if (s
->cipher_list_by_id
!= NULL
)
4092 if ((ret
->cipher_list_by_id
= sk_SSL_CIPHER_dup(s
->cipher_list_by_id
))
4096 /* Dup the client_CA list */
4097 if (!dup_ca_names(&ret
->ca_names
, s
->ca_names
)
4098 || !dup_ca_names(&ret
->client_ca_names
, s
->client_ca_names
))
4108 void ssl_clear_cipher_ctx(SSL
*s
)
4110 if (s
->enc_read_ctx
!= NULL
) {
4111 EVP_CIPHER_CTX_free(s
->enc_read_ctx
);
4112 s
->enc_read_ctx
= NULL
;
4114 if (s
->enc_write_ctx
!= NULL
) {
4115 EVP_CIPHER_CTX_free(s
->enc_write_ctx
);
4116 s
->enc_write_ctx
= NULL
;
4118 #ifndef OPENSSL_NO_COMP
4119 COMP_CTX_free(s
->expand
);
4121 COMP_CTX_free(s
->compress
);
4126 X509
*SSL_get_certificate(const SSL
*s
)
4128 if (s
->cert
!= NULL
)
4129 return s
->cert
->key
->x509
;
4134 EVP_PKEY
*SSL_get_privatekey(const SSL
*s
)
4136 if (s
->cert
!= NULL
)
4137 return s
->cert
->key
->privatekey
;
4142 X509
*SSL_CTX_get0_certificate(const SSL_CTX
*ctx
)
4144 if (ctx
->cert
!= NULL
)
4145 return ctx
->cert
->key
->x509
;
4150 EVP_PKEY
*SSL_CTX_get0_privatekey(const SSL_CTX
*ctx
)
4152 if (ctx
->cert
!= NULL
)
4153 return ctx
->cert
->key
->privatekey
;
4158 const SSL_CIPHER
*SSL_get_current_cipher(const SSL
*s
)
4160 if ((s
->session
!= NULL
) && (s
->session
->cipher
!= NULL
))
4161 return s
->session
->cipher
;
4165 const SSL_CIPHER
*SSL_get_pending_cipher(const SSL
*s
)
4167 return s
->s3
.tmp
.new_cipher
;
4170 const COMP_METHOD
*SSL_get_current_compression(const SSL
*s
)
4172 #ifndef OPENSSL_NO_COMP
4173 return s
->compress
? COMP_CTX_get_method(s
->compress
) : NULL
;
4179 const COMP_METHOD
*SSL_get_current_expansion(const SSL
*s
)
4181 #ifndef OPENSSL_NO_COMP
4182 return s
->expand
? COMP_CTX_get_method(s
->expand
) : NULL
;
4188 int ssl_init_wbio_buffer(SSL
*s
)
4192 if (s
->bbio
!= NULL
) {
4193 /* Already buffered. */
4197 bbio
= BIO_new(BIO_f_buffer());
4198 if (bbio
== NULL
|| !BIO_set_read_buffer_size(bbio
, 1)) {
4200 ERR_raise(ERR_LIB_SSL
, ERR_R_BUF_LIB
);
4204 s
->wbio
= BIO_push(bbio
, s
->wbio
);
4209 int ssl_free_wbio_buffer(SSL
*s
)
4211 /* callers ensure s is never null */
4212 if (s
->bbio
== NULL
)
4215 s
->wbio
= BIO_pop(s
->wbio
);
4222 void SSL_CTX_set_quiet_shutdown(SSL_CTX
*ctx
, int mode
)
4224 ctx
->quiet_shutdown
= mode
;
4227 int SSL_CTX_get_quiet_shutdown(const SSL_CTX
*ctx
)
4229 return ctx
->quiet_shutdown
;
4232 void SSL_set_quiet_shutdown(SSL
*s
, int mode
)
4234 s
->quiet_shutdown
= mode
;
4237 int SSL_get_quiet_shutdown(const SSL
*s
)
4239 return s
->quiet_shutdown
;
4242 void SSL_set_shutdown(SSL
*s
, int mode
)
4247 int SSL_get_shutdown(const SSL
*s
)
4252 int SSL_version(const SSL
*s
)
4257 int SSL_client_version(const SSL
*s
)
4259 return s
->client_version
;
4262 SSL_CTX
*SSL_get_SSL_CTX(const SSL
*ssl
)
4267 SSL_CTX
*SSL_set_SSL_CTX(SSL
*ssl
, SSL_CTX
*ctx
)
4270 if (ssl
->ctx
== ctx
)
4273 ctx
= ssl
->session_ctx
;
4274 new_cert
= ssl_cert_dup(ctx
->cert
);
4275 if (new_cert
== NULL
) {
4279 if (!custom_exts_copy_flags(&new_cert
->custext
, &ssl
->cert
->custext
)) {
4280 ssl_cert_free(new_cert
);
4284 ssl_cert_free(ssl
->cert
);
4285 ssl
->cert
= new_cert
;
4288 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
4289 * so setter APIs must prevent invalid lengths from entering the system.
4291 if (!ossl_assert(ssl
->sid_ctx_length
<= sizeof(ssl
->sid_ctx
)))
4295 * If the session ID context matches that of the parent SSL_CTX,
4296 * inherit it from the new SSL_CTX as well. If however the context does
4297 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
4298 * leave it unchanged.
4300 if ((ssl
->ctx
!= NULL
) &&
4301 (ssl
->sid_ctx_length
== ssl
->ctx
->sid_ctx_length
) &&
4302 (memcmp(ssl
->sid_ctx
, ssl
->ctx
->sid_ctx
, ssl
->sid_ctx_length
) == 0)) {
4303 ssl
->sid_ctx_length
= ctx
->sid_ctx_length
;
4304 memcpy(&ssl
->sid_ctx
, &ctx
->sid_ctx
, sizeof(ssl
->sid_ctx
));
4307 SSL_CTX_up_ref(ctx
);
4308 SSL_CTX_free(ssl
->ctx
); /* decrement reference count */
4314 int SSL_CTX_set_default_verify_paths(SSL_CTX
*ctx
)
4316 return X509_STORE_set_default_paths_ex(ctx
->cert_store
, ctx
->libctx
,
4320 int SSL_CTX_set_default_verify_dir(SSL_CTX
*ctx
)
4322 X509_LOOKUP
*lookup
;
4324 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_hash_dir());
4328 /* We ignore errors, in case the directory doesn't exist */
4331 X509_LOOKUP_add_dir(lookup
, NULL
, X509_FILETYPE_DEFAULT
);
4338 int SSL_CTX_set_default_verify_file(SSL_CTX
*ctx
)
4340 X509_LOOKUP
*lookup
;
4342 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_file());
4346 /* We ignore errors, in case the file doesn't exist */
4349 X509_LOOKUP_load_file_ex(lookup
, NULL
, X509_FILETYPE_DEFAULT
, ctx
->libctx
,
4357 int SSL_CTX_set_default_verify_store(SSL_CTX
*ctx
)
4359 X509_LOOKUP
*lookup
;
4361 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_store());
4365 /* We ignore errors, in case the directory doesn't exist */
4368 X509_LOOKUP_add_store_ex(lookup
, NULL
, ctx
->libctx
, ctx
->propq
);
4375 int SSL_CTX_load_verify_file(SSL_CTX
*ctx
, const char *CAfile
)
4377 return X509_STORE_load_file_ex(ctx
->cert_store
, CAfile
, ctx
->libctx
,
4381 int SSL_CTX_load_verify_dir(SSL_CTX
*ctx
, const char *CApath
)
4383 return X509_STORE_load_path(ctx
->cert_store
, CApath
);
4386 int SSL_CTX_load_verify_store(SSL_CTX
*ctx
, const char *CAstore
)
4388 return X509_STORE_load_store_ex(ctx
->cert_store
, CAstore
, ctx
->libctx
,
4392 int SSL_CTX_load_verify_locations(SSL_CTX
*ctx
, const char *CAfile
,
4395 if (CAfile
== NULL
&& CApath
== NULL
)
4397 if (CAfile
!= NULL
&& !SSL_CTX_load_verify_file(ctx
, CAfile
))
4399 if (CApath
!= NULL
&& !SSL_CTX_load_verify_dir(ctx
, CApath
))
4404 void SSL_set_info_callback(SSL
*ssl
,
4405 void (*cb
) (const SSL
*ssl
, int type
, int val
))
4407 ssl
->info_callback
= cb
;
4411 * One compiler (Diab DCC) doesn't like argument names in returned function
4414 void (*SSL_get_info_callback(const SSL
*ssl
)) (const SSL
* /* ssl */ ,
4417 return ssl
->info_callback
;
4420 void SSL_set_verify_result(SSL
*ssl
, long arg
)
4422 ssl
->verify_result
= arg
;
4425 long SSL_get_verify_result(const SSL
*ssl
)
4427 return ssl
->verify_result
;
4430 size_t SSL_get_client_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
4433 return sizeof(ssl
->s3
.client_random
);
4434 if (outlen
> sizeof(ssl
->s3
.client_random
))
4435 outlen
= sizeof(ssl
->s3
.client_random
);
4436 memcpy(out
, ssl
->s3
.client_random
, outlen
);
4440 size_t SSL_get_server_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
4443 return sizeof(ssl
->s3
.server_random
);
4444 if (outlen
> sizeof(ssl
->s3
.server_random
))
4445 outlen
= sizeof(ssl
->s3
.server_random
);
4446 memcpy(out
, ssl
->s3
.server_random
, outlen
);
4450 size_t SSL_SESSION_get_master_key(const SSL_SESSION
*session
,
4451 unsigned char *out
, size_t outlen
)
4454 return session
->master_key_length
;
4455 if (outlen
> session
->master_key_length
)
4456 outlen
= session
->master_key_length
;
4457 memcpy(out
, session
->master_key
, outlen
);
4461 int SSL_SESSION_set1_master_key(SSL_SESSION
*sess
, const unsigned char *in
,
4464 if (len
> sizeof(sess
->master_key
))
4467 memcpy(sess
->master_key
, in
, len
);
4468 sess
->master_key_length
= len
;
4473 int SSL_set_ex_data(SSL
*s
, int idx
, void *arg
)
4475 return CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
);
4478 void *SSL_get_ex_data(const SSL
*s
, int idx
)
4480 return CRYPTO_get_ex_data(&s
->ex_data
, idx
);
4483 int SSL_CTX_set_ex_data(SSL_CTX
*s
, int idx
, void *arg
)
4485 return CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
);
4488 void *SSL_CTX_get_ex_data(const SSL_CTX
*s
, int idx
)
4490 return CRYPTO_get_ex_data(&s
->ex_data
, idx
);
4493 X509_STORE
*SSL_CTX_get_cert_store(const SSL_CTX
*ctx
)
4495 return ctx
->cert_store
;
4498 void SSL_CTX_set_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
4500 X509_STORE_free(ctx
->cert_store
);
4501 ctx
->cert_store
= store
;
4504 void SSL_CTX_set1_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
4507 X509_STORE_up_ref(store
);
4508 SSL_CTX_set_cert_store(ctx
, store
);
4511 int SSL_want(const SSL
*s
)
4516 #ifndef OPENSSL_NO_PSK
4517 int SSL_CTX_use_psk_identity_hint(SSL_CTX
*ctx
, const char *identity_hint
)
4519 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
4520 ERR_raise(ERR_LIB_SSL
, SSL_R_DATA_LENGTH_TOO_LONG
);
4523 OPENSSL_free(ctx
->cert
->psk_identity_hint
);
4524 if (identity_hint
!= NULL
) {
4525 ctx
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
4526 if (ctx
->cert
->psk_identity_hint
== NULL
)
4529 ctx
->cert
->psk_identity_hint
= NULL
;
4533 int SSL_use_psk_identity_hint(SSL
*s
, const char *identity_hint
)
4538 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
4539 ERR_raise(ERR_LIB_SSL
, SSL_R_DATA_LENGTH_TOO_LONG
);
4542 OPENSSL_free(s
->cert
->psk_identity_hint
);
4543 if (identity_hint
!= NULL
) {
4544 s
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
4545 if (s
->cert
->psk_identity_hint
== NULL
)
4548 s
->cert
->psk_identity_hint
= NULL
;
4552 const char *SSL_get_psk_identity_hint(const SSL
*s
)
4554 if (s
== NULL
|| s
->session
== NULL
)
4556 return s
->session
->psk_identity_hint
;
4559 const char *SSL_get_psk_identity(const SSL
*s
)
4561 if (s
== NULL
|| s
->session
== NULL
)
4563 return s
->session
->psk_identity
;
4566 void SSL_set_psk_client_callback(SSL
*s
, SSL_psk_client_cb_func cb
)
4568 s
->psk_client_callback
= cb
;
4571 void SSL_CTX_set_psk_client_callback(SSL_CTX
*ctx
, SSL_psk_client_cb_func cb
)
4573 ctx
->psk_client_callback
= cb
;
4576 void SSL_set_psk_server_callback(SSL
*s
, SSL_psk_server_cb_func cb
)
4578 s
->psk_server_callback
= cb
;
4581 void SSL_CTX_set_psk_server_callback(SSL_CTX
*ctx
, SSL_psk_server_cb_func cb
)
4583 ctx
->psk_server_callback
= cb
;
4587 void SSL_set_psk_find_session_callback(SSL
*s
, SSL_psk_find_session_cb_func cb
)
4589 s
->psk_find_session_cb
= cb
;
4592 void SSL_CTX_set_psk_find_session_callback(SSL_CTX
*ctx
,
4593 SSL_psk_find_session_cb_func cb
)
4595 ctx
->psk_find_session_cb
= cb
;
4598 void SSL_set_psk_use_session_callback(SSL
*s
, SSL_psk_use_session_cb_func cb
)
4600 s
->psk_use_session_cb
= cb
;
4603 void SSL_CTX_set_psk_use_session_callback(SSL_CTX
*ctx
,
4604 SSL_psk_use_session_cb_func cb
)
4606 ctx
->psk_use_session_cb
= cb
;
4609 void SSL_CTX_set_msg_callback(SSL_CTX
*ctx
,
4610 void (*cb
) (int write_p
, int version
,
4611 int content_type
, const void *buf
,
4612 size_t len
, SSL
*ssl
, void *arg
))
4614 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
4617 void SSL_set_msg_callback(SSL
*ssl
,
4618 void (*cb
) (int write_p
, int version
,
4619 int content_type
, const void *buf
,
4620 size_t len
, SSL
*ssl
, void *arg
))
4622 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
4625 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX
*ctx
,
4626 int (*cb
) (SSL
*ssl
,
4630 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
4631 (void (*)(void))cb
);
4634 void SSL_set_not_resumable_session_callback(SSL
*ssl
,
4635 int (*cb
) (SSL
*ssl
,
4636 int is_forward_secure
))
4638 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
4639 (void (*)(void))cb
);
4642 void SSL_CTX_set_record_padding_callback(SSL_CTX
*ctx
,
4643 size_t (*cb
) (SSL
*ssl
, int type
,
4644 size_t len
, void *arg
))
4646 ctx
->record_padding_cb
= cb
;
4649 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX
*ctx
, void *arg
)
4651 ctx
->record_padding_arg
= arg
;
4654 void *SSL_CTX_get_record_padding_callback_arg(const SSL_CTX
*ctx
)
4656 return ctx
->record_padding_arg
;
4659 int SSL_CTX_set_block_padding(SSL_CTX
*ctx
, size_t block_size
)
4661 /* block size of 0 or 1 is basically no padding */
4662 if (block_size
== 1)
4663 ctx
->block_padding
= 0;
4664 else if (block_size
<= SSL3_RT_MAX_PLAIN_LENGTH
)
4665 ctx
->block_padding
= block_size
;
4671 int SSL_set_record_padding_callback(SSL
*ssl
,
4672 size_t (*cb
) (SSL
*ssl
, int type
,
4673 size_t len
, void *arg
))
4677 b
= SSL_get_wbio(ssl
);
4678 if (b
== NULL
|| !BIO_get_ktls_send(b
)) {
4679 ssl
->record_padding_cb
= cb
;
4685 void SSL_set_record_padding_callback_arg(SSL
*ssl
, void *arg
)
4687 ssl
->record_padding_arg
= arg
;
4690 void *SSL_get_record_padding_callback_arg(const SSL
*ssl
)
4692 return ssl
->record_padding_arg
;
4695 int SSL_set_block_padding(SSL
*ssl
, size_t block_size
)
4697 /* block size of 0 or 1 is basically no padding */
4698 if (block_size
== 1)
4699 ssl
->block_padding
= 0;
4700 else if (block_size
<= SSL3_RT_MAX_PLAIN_LENGTH
)
4701 ssl
->block_padding
= block_size
;
4707 int SSL_set_num_tickets(SSL
*s
, size_t num_tickets
)
4709 s
->num_tickets
= num_tickets
;
4714 size_t SSL_get_num_tickets(const SSL
*s
)
4716 return s
->num_tickets
;
4719 int SSL_CTX_set_num_tickets(SSL_CTX
*ctx
, size_t num_tickets
)
4721 ctx
->num_tickets
= num_tickets
;
4726 size_t SSL_CTX_get_num_tickets(const SSL_CTX
*ctx
)
4728 return ctx
->num_tickets
;
4732 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4733 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4734 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4735 * Returns the newly allocated ctx;
4738 EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
)
4740 ssl_clear_hash_ctx(hash
);
4741 *hash
= EVP_MD_CTX_new();
4742 if (*hash
== NULL
|| (md
&& EVP_DigestInit_ex(*hash
, md
, NULL
) <= 0)) {
4743 EVP_MD_CTX_free(*hash
);
4750 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
)
4753 EVP_MD_CTX_free(*hash
);
4757 /* Retrieve handshake hashes */
4758 int ssl_handshake_hash(SSL
*s
, unsigned char *out
, size_t outlen
,
4761 EVP_MD_CTX
*ctx
= NULL
;
4762 EVP_MD_CTX
*hdgst
= s
->s3
.handshake_dgst
;
4763 int hashleni
= EVP_MD_CTX_size(hdgst
);
4766 if (hashleni
< 0 || (size_t)hashleni
> outlen
) {
4767 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
4771 ctx
= EVP_MD_CTX_new();
4775 if (!EVP_MD_CTX_copy_ex(ctx
, hdgst
)
4776 || EVP_DigestFinal_ex(ctx
, out
, NULL
) <= 0) {
4777 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
4781 *hashlen
= hashleni
;
4785 EVP_MD_CTX_free(ctx
);
4789 int SSL_session_reused(const SSL
*s
)
4794 int SSL_is_server(const SSL
*s
)
4799 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
4800 void SSL_set_debug(SSL
*s
, int debug
)
4802 /* Old function was do-nothing anyway... */
4808 void SSL_set_security_level(SSL
*s
, int level
)
4810 s
->cert
->sec_level
= level
;
4813 int SSL_get_security_level(const SSL
*s
)
4815 return s
->cert
->sec_level
;
4818 void SSL_set_security_callback(SSL
*s
,
4819 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
4820 int op
, int bits
, int nid
,
4821 void *other
, void *ex
))
4823 s
->cert
->sec_cb
= cb
;
4826 int (*SSL_get_security_callback(const SSL
*s
)) (const SSL
*s
,
4827 const SSL_CTX
*ctx
, int op
,
4828 int bits
, int nid
, void *other
,
4830 return s
->cert
->sec_cb
;
4833 void SSL_set0_security_ex_data(SSL
*s
, void *ex
)
4835 s
->cert
->sec_ex
= ex
;
4838 void *SSL_get0_security_ex_data(const SSL
*s
)
4840 return s
->cert
->sec_ex
;
4843 void SSL_CTX_set_security_level(SSL_CTX
*ctx
, int level
)
4845 ctx
->cert
->sec_level
= level
;
4848 int SSL_CTX_get_security_level(const SSL_CTX
*ctx
)
4850 return ctx
->cert
->sec_level
;
4853 void SSL_CTX_set_security_callback(SSL_CTX
*ctx
,
4854 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
4855 int op
, int bits
, int nid
,
4856 void *other
, void *ex
))
4858 ctx
->cert
->sec_cb
= cb
;
4861 int (*SSL_CTX_get_security_callback(const SSL_CTX
*ctx
)) (const SSL
*s
,
4867 return ctx
->cert
->sec_cb
;
4870 void SSL_CTX_set0_security_ex_data(SSL_CTX
*ctx
, void *ex
)
4872 ctx
->cert
->sec_ex
= ex
;
4875 void *SSL_CTX_get0_security_ex_data(const SSL_CTX
*ctx
)
4877 return ctx
->cert
->sec_ex
;
4881 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4882 * can return unsigned long, instead of the generic long return value from the
4883 * control interface.
4885 unsigned long SSL_CTX_get_options(const SSL_CTX
*ctx
)
4887 return ctx
->options
;
4890 unsigned long SSL_get_options(const SSL
*s
)
4895 unsigned long SSL_CTX_set_options(SSL_CTX
*ctx
, unsigned long op
)
4897 return ctx
->options
|= op
;
4900 unsigned long SSL_set_options(SSL
*s
, unsigned long op
)
4902 return s
->options
|= op
;
4905 unsigned long SSL_CTX_clear_options(SSL_CTX
*ctx
, unsigned long op
)
4907 return ctx
->options
&= ~op
;
4910 unsigned long SSL_clear_options(SSL
*s
, unsigned long op
)
4912 return s
->options
&= ~op
;
4915 STACK_OF(X509
) *SSL_get0_verified_chain(const SSL
*s
)
4917 return s
->verified_chain
;
4920 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
4922 #ifndef OPENSSL_NO_CT
4925 * Moves SCTs from the |src| stack to the |dst| stack.
4926 * The source of each SCT will be set to |origin|.
4927 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4929 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4931 static int ct_move_scts(STACK_OF(SCT
) **dst
, STACK_OF(SCT
) *src
,
4932 sct_source_t origin
)
4938 *dst
= sk_SCT_new_null();
4940 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
4945 while ((sct
= sk_SCT_pop(src
)) != NULL
) {
4946 if (SCT_set_source(sct
, origin
) != 1)
4949 if (sk_SCT_push(*dst
, sct
) <= 0)
4957 sk_SCT_push(src
, sct
); /* Put the SCT back */
4962 * Look for data collected during ServerHello and parse if found.
4963 * Returns the number of SCTs extracted.
4965 static int ct_extract_tls_extension_scts(SSL
*s
)
4967 int scts_extracted
= 0;
4969 if (s
->ext
.scts
!= NULL
) {
4970 const unsigned char *p
= s
->ext
.scts
;
4971 STACK_OF(SCT
) *scts
= o2i_SCT_LIST(NULL
, &p
, s
->ext
.scts_len
);
4973 scts_extracted
= ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_TLS_EXTENSION
);
4975 SCT_LIST_free(scts
);
4978 return scts_extracted
;
4982 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4983 * contains an SCT X509 extension. They will be stored in |s->scts|.
4985 * - The number of SCTs extracted, assuming an OCSP response exists.
4986 * - 0 if no OCSP response exists or it contains no SCTs.
4987 * - A negative integer if an error occurs.
4989 static int ct_extract_ocsp_response_scts(SSL
*s
)
4991 # ifndef OPENSSL_NO_OCSP
4992 int scts_extracted
= 0;
4993 const unsigned char *p
;
4994 OCSP_BASICRESP
*br
= NULL
;
4995 OCSP_RESPONSE
*rsp
= NULL
;
4996 STACK_OF(SCT
) *scts
= NULL
;
4999 if (s
->ext
.ocsp
.resp
== NULL
|| s
->ext
.ocsp
.resp_len
== 0)
5002 p
= s
->ext
.ocsp
.resp
;
5003 rsp
= d2i_OCSP_RESPONSE(NULL
, &p
, (int)s
->ext
.ocsp
.resp_len
);
5007 br
= OCSP_response_get1_basic(rsp
);
5011 for (i
= 0; i
< OCSP_resp_count(br
); ++i
) {
5012 OCSP_SINGLERESP
*single
= OCSP_resp_get0(br
, i
);
5018 OCSP_SINGLERESP_get1_ext_d2i(single
, NID_ct_cert_scts
, NULL
, NULL
);
5020 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_OCSP_STAPLED_RESPONSE
);
5021 if (scts_extracted
< 0)
5025 SCT_LIST_free(scts
);
5026 OCSP_BASICRESP_free(br
);
5027 OCSP_RESPONSE_free(rsp
);
5028 return scts_extracted
;
5030 /* Behave as if no OCSP response exists */
5036 * Attempts to extract SCTs from the peer certificate.
5037 * Return the number of SCTs extracted, or a negative integer if an error
5040 static int ct_extract_x509v3_extension_scts(SSL
*s
)
5042 int scts_extracted
= 0;
5043 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
5046 STACK_OF(SCT
) *scts
=
5047 X509_get_ext_d2i(cert
, NID_ct_precert_scts
, NULL
, NULL
);
5050 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_X509V3_EXTENSION
);
5052 SCT_LIST_free(scts
);
5055 return scts_extracted
;
5059 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
5060 * response (if it exists) and X509v3 extensions in the certificate.
5061 * Returns NULL if an error occurs.
5063 const STACK_OF(SCT
) *SSL_get0_peer_scts(SSL
*s
)
5065 if (!s
->scts_parsed
) {
5066 if (ct_extract_tls_extension_scts(s
) < 0 ||
5067 ct_extract_ocsp_response_scts(s
) < 0 ||
5068 ct_extract_x509v3_extension_scts(s
) < 0)
5078 static int ct_permissive(const CT_POLICY_EVAL_CTX
* ctx
,
5079 const STACK_OF(SCT
) *scts
, void *unused_arg
)
5084 static int ct_strict(const CT_POLICY_EVAL_CTX
* ctx
,
5085 const STACK_OF(SCT
) *scts
, void *unused_arg
)
5087 int count
= scts
!= NULL
? sk_SCT_num(scts
) : 0;
5090 for (i
= 0; i
< count
; ++i
) {
5091 SCT
*sct
= sk_SCT_value(scts
, i
);
5092 int status
= SCT_get_validation_status(sct
);
5094 if (status
== SCT_VALIDATION_STATUS_VALID
)
5097 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_VALID_SCTS
);
5101 int SSL_set_ct_validation_callback(SSL
*s
, ssl_ct_validation_cb callback
,
5105 * Since code exists that uses the custom extension handler for CT, look
5106 * for this and throw an error if they have already registered to use CT.
5108 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(s
->ctx
,
5109 TLSEXT_TYPE_signed_certificate_timestamp
))
5111 ERR_raise(ERR_LIB_SSL
, SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
5115 if (callback
!= NULL
) {
5117 * If we are validating CT, then we MUST accept SCTs served via OCSP
5119 if (!SSL_set_tlsext_status_type(s
, TLSEXT_STATUSTYPE_ocsp
))
5123 s
->ct_validation_callback
= callback
;
5124 s
->ct_validation_callback_arg
= arg
;
5129 int SSL_CTX_set_ct_validation_callback(SSL_CTX
*ctx
,
5130 ssl_ct_validation_cb callback
, void *arg
)
5133 * Since code exists that uses the custom extension handler for CT, look for
5134 * this and throw an error if they have already registered to use CT.
5136 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(ctx
,
5137 TLSEXT_TYPE_signed_certificate_timestamp
))
5139 ERR_raise(ERR_LIB_SSL
, SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
5143 ctx
->ct_validation_callback
= callback
;
5144 ctx
->ct_validation_callback_arg
= arg
;
5148 int SSL_ct_is_enabled(const SSL
*s
)
5150 return s
->ct_validation_callback
!= NULL
;
5153 int SSL_CTX_ct_is_enabled(const SSL_CTX
*ctx
)
5155 return ctx
->ct_validation_callback
!= NULL
;
5158 int ssl_validate_ct(SSL
*s
)
5161 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
5163 SSL_DANE
*dane
= &s
->dane
;
5164 CT_POLICY_EVAL_CTX
*ctx
= NULL
;
5165 const STACK_OF(SCT
) *scts
;
5168 * If no callback is set, the peer is anonymous, or its chain is invalid,
5169 * skip SCT validation - just return success. Applications that continue
5170 * handshakes without certificates, with unverified chains, or pinned leaf
5171 * certificates are outside the scope of the WebPKI and CT.
5173 * The above exclusions notwithstanding the vast majority of peers will
5174 * have rather ordinary certificate chains validated by typical
5175 * applications that perform certificate verification and therefore will
5176 * process SCTs when enabled.
5178 if (s
->ct_validation_callback
== NULL
|| cert
== NULL
||
5179 s
->verify_result
!= X509_V_OK
||
5180 s
->verified_chain
== NULL
|| sk_X509_num(s
->verified_chain
) <= 1)
5184 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
5185 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
5187 if (DANETLS_ENABLED(dane
) && dane
->mtlsa
!= NULL
) {
5188 switch (dane
->mtlsa
->usage
) {
5189 case DANETLS_USAGE_DANE_TA
:
5190 case DANETLS_USAGE_DANE_EE
:
5195 ctx
= CT_POLICY_EVAL_CTX_new_ex(s
->ctx
->libctx
, s
->ctx
->propq
);
5197 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5201 issuer
= sk_X509_value(s
->verified_chain
, 1);
5202 CT_POLICY_EVAL_CTX_set1_cert(ctx
, cert
);
5203 CT_POLICY_EVAL_CTX_set1_issuer(ctx
, issuer
);
5204 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx
, s
->ctx
->ctlog_store
);
5205 CT_POLICY_EVAL_CTX_set_time(
5206 ctx
, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s
)) * 1000);
5208 scts
= SSL_get0_peer_scts(s
);
5211 * This function returns success (> 0) only when all the SCTs are valid, 0
5212 * when some are invalid, and < 0 on various internal errors (out of
5213 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
5214 * reason to abort the handshake, that decision is up to the callback.
5215 * Therefore, we error out only in the unexpected case that the return
5216 * value is negative.
5218 * XXX: One might well argue that the return value of this function is an
5219 * unfortunate design choice. Its job is only to determine the validation
5220 * status of each of the provided SCTs. So long as it correctly separates
5221 * the wheat from the chaff it should return success. Failure in this case
5222 * ought to correspond to an inability to carry out its duties.
5224 if (SCT_LIST_validate(scts
, ctx
) < 0) {
5225 SSLfatal(s
, SSL_AD_HANDSHAKE_FAILURE
, SSL_R_SCT_VERIFICATION_FAILED
);
5229 ret
= s
->ct_validation_callback(ctx
, scts
, s
->ct_validation_callback_arg
);
5231 ret
= 0; /* This function returns 0 on failure */
5233 SSLfatal(s
, SSL_AD_HANDSHAKE_FAILURE
, SSL_R_CALLBACK_FAILED
);
5236 CT_POLICY_EVAL_CTX_free(ctx
);
5238 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
5239 * failure return code here. Also the application may wish the complete
5240 * the handshake, and then disconnect cleanly at a higher layer, after
5241 * checking the verification status of the completed connection.
5243 * We therefore force a certificate verification failure which will be
5244 * visible via SSL_get_verify_result() and cached as part of any resumed
5247 * Note: the permissive callback is for information gathering only, always
5248 * returns success, and does not affect verification status. Only the
5249 * strict callback or a custom application-specified callback can trigger
5250 * connection failure or record a verification error.
5253 s
->verify_result
= X509_V_ERR_NO_VALID_SCTS
;
5257 int SSL_CTX_enable_ct(SSL_CTX
*ctx
, int validation_mode
)
5259 switch (validation_mode
) {
5261 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
5263 case SSL_CT_VALIDATION_PERMISSIVE
:
5264 return SSL_CTX_set_ct_validation_callback(ctx
, ct_permissive
, NULL
);
5265 case SSL_CT_VALIDATION_STRICT
:
5266 return SSL_CTX_set_ct_validation_callback(ctx
, ct_strict
, NULL
);
5270 int SSL_enable_ct(SSL
*s
, int validation_mode
)
5272 switch (validation_mode
) {
5274 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
5276 case SSL_CT_VALIDATION_PERMISSIVE
:
5277 return SSL_set_ct_validation_callback(s
, ct_permissive
, NULL
);
5278 case SSL_CT_VALIDATION_STRICT
:
5279 return SSL_set_ct_validation_callback(s
, ct_strict
, NULL
);
5283 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX
*ctx
)
5285 return CTLOG_STORE_load_default_file(ctx
->ctlog_store
);
5288 int SSL_CTX_set_ctlog_list_file(SSL_CTX
*ctx
, const char *path
)
5290 return CTLOG_STORE_load_file(ctx
->ctlog_store
, path
);
5293 void SSL_CTX_set0_ctlog_store(SSL_CTX
*ctx
, CTLOG_STORE
* logs
)
5295 CTLOG_STORE_free(ctx
->ctlog_store
);
5296 ctx
->ctlog_store
= logs
;
5299 const CTLOG_STORE
*SSL_CTX_get0_ctlog_store(const SSL_CTX
*ctx
)
5301 return ctx
->ctlog_store
;
5304 #endif /* OPENSSL_NO_CT */
5306 void SSL_CTX_set_client_hello_cb(SSL_CTX
*c
, SSL_client_hello_cb_fn cb
,
5309 c
->client_hello_cb
= cb
;
5310 c
->client_hello_cb_arg
= arg
;
5313 int SSL_client_hello_isv2(SSL
*s
)
5315 if (s
->clienthello
== NULL
)
5317 return s
->clienthello
->isv2
;
5320 unsigned int SSL_client_hello_get0_legacy_version(SSL
*s
)
5322 if (s
->clienthello
== NULL
)
5324 return s
->clienthello
->legacy_version
;
5327 size_t SSL_client_hello_get0_random(SSL
*s
, const unsigned char **out
)
5329 if (s
->clienthello
== NULL
)
5332 *out
= s
->clienthello
->random
;
5333 return SSL3_RANDOM_SIZE
;
5336 size_t SSL_client_hello_get0_session_id(SSL
*s
, const unsigned char **out
)
5338 if (s
->clienthello
== NULL
)
5341 *out
= s
->clienthello
->session_id
;
5342 return s
->clienthello
->session_id_len
;
5345 size_t SSL_client_hello_get0_ciphers(SSL
*s
, const unsigned char **out
)
5347 if (s
->clienthello
== NULL
)
5350 *out
= PACKET_data(&s
->clienthello
->ciphersuites
);
5351 return PACKET_remaining(&s
->clienthello
->ciphersuites
);
5354 size_t SSL_client_hello_get0_compression_methods(SSL
*s
, const unsigned char **out
)
5356 if (s
->clienthello
== NULL
)
5359 *out
= s
->clienthello
->compressions
;
5360 return s
->clienthello
->compressions_len
;
5363 int SSL_client_hello_get1_extensions_present(SSL
*s
, int **out
, size_t *outlen
)
5369 if (s
->clienthello
== NULL
|| out
== NULL
|| outlen
== NULL
)
5371 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; i
++) {
5372 ext
= s
->clienthello
->pre_proc_exts
+ i
;
5381 if ((present
= OPENSSL_malloc(sizeof(*present
) * num
)) == NULL
) {
5382 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
5385 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; i
++) {
5386 ext
= s
->clienthello
->pre_proc_exts
+ i
;
5388 if (ext
->received_order
>= num
)
5390 present
[ext
->received_order
] = ext
->type
;
5397 OPENSSL_free(present
);
5401 int SSL_client_hello_get0_ext(SSL
*s
, unsigned int type
, const unsigned char **out
,
5407 if (s
->clienthello
== NULL
)
5409 for (i
= 0; i
< s
->clienthello
->pre_proc_exts_len
; ++i
) {
5410 r
= s
->clienthello
->pre_proc_exts
+ i
;
5411 if (r
->present
&& r
->type
== type
) {
5413 *out
= PACKET_data(&r
->data
);
5415 *outlen
= PACKET_remaining(&r
->data
);
5422 int SSL_free_buffers(SSL
*ssl
)
5424 RECORD_LAYER
*rl
= &ssl
->rlayer
;
5426 if (RECORD_LAYER_read_pending(rl
) || RECORD_LAYER_write_pending(rl
))
5429 RECORD_LAYER_release(rl
);
5433 int SSL_alloc_buffers(SSL
*ssl
)
5435 return ssl3_setup_buffers(ssl
);
5438 void SSL_CTX_set_keylog_callback(SSL_CTX
*ctx
, SSL_CTX_keylog_cb_func cb
)
5440 ctx
->keylog_callback
= cb
;
5443 SSL_CTX_keylog_cb_func
SSL_CTX_get_keylog_callback(const SSL_CTX
*ctx
)
5445 return ctx
->keylog_callback
;
5448 static int nss_keylog_int(const char *prefix
,
5450 const uint8_t *parameter_1
,
5451 size_t parameter_1_len
,
5452 const uint8_t *parameter_2
,
5453 size_t parameter_2_len
)
5456 char *cursor
= NULL
;
5461 if (ssl
->ctx
->keylog_callback
== NULL
)
5465 * Our output buffer will contain the following strings, rendered with
5466 * space characters in between, terminated by a NULL character: first the
5467 * prefix, then the first parameter, then the second parameter. The
5468 * meaning of each parameter depends on the specific key material being
5469 * logged. Note that the first and second parameters are encoded in
5470 * hexadecimal, so we need a buffer that is twice their lengths.
5472 prefix_len
= strlen(prefix
);
5473 out_len
= prefix_len
+ (2 * parameter_1_len
) + (2 * parameter_2_len
) + 3;
5474 if ((out
= cursor
= OPENSSL_malloc(out_len
)) == NULL
) {
5475 SSLfatal(ssl
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5479 strcpy(cursor
, prefix
);
5480 cursor
+= prefix_len
;
5483 for (i
= 0; i
< parameter_1_len
; i
++) {
5484 sprintf(cursor
, "%02x", parameter_1
[i
]);
5489 for (i
= 0; i
< parameter_2_len
; i
++) {
5490 sprintf(cursor
, "%02x", parameter_2
[i
]);
5495 ssl
->ctx
->keylog_callback(ssl
, (const char *)out
);
5496 OPENSSL_clear_free(out
, out_len
);
5501 int ssl_log_rsa_client_key_exchange(SSL
*ssl
,
5502 const uint8_t *encrypted_premaster
,
5503 size_t encrypted_premaster_len
,
5504 const uint8_t *premaster
,
5505 size_t premaster_len
)
5507 if (encrypted_premaster_len
< 8) {
5508 SSLfatal(ssl
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
5512 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5513 return nss_keylog_int("RSA",
5515 encrypted_premaster
,
5521 int ssl_log_secret(SSL
*ssl
,
5523 const uint8_t *secret
,
5526 return nss_keylog_int(label
,
5528 ssl
->s3
.client_random
,
5534 #define SSLV2_CIPHER_LEN 3
5536 int ssl_cache_cipherlist(SSL
*s
, PACKET
*cipher_suites
, int sslv2format
)
5540 n
= sslv2format
? SSLV2_CIPHER_LEN
: TLS_CIPHER_LEN
;
5542 if (PACKET_remaining(cipher_suites
) == 0) {
5543 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_R_NO_CIPHERS_SPECIFIED
);
5547 if (PACKET_remaining(cipher_suites
) % n
!= 0) {
5548 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5552 OPENSSL_free(s
->s3
.tmp
.ciphers_raw
);
5553 s
->s3
.tmp
.ciphers_raw
= NULL
;
5554 s
->s3
.tmp
.ciphers_rawlen
= 0;
5557 size_t numciphers
= PACKET_remaining(cipher_suites
) / n
;
5558 PACKET sslv2ciphers
= *cipher_suites
;
5559 unsigned int leadbyte
;
5563 * We store the raw ciphers list in SSLv3+ format so we need to do some
5564 * preprocessing to convert the list first. If there are any SSLv2 only
5565 * ciphersuites with a non-zero leading byte then we are going to
5566 * slightly over allocate because we won't store those. But that isn't a
5569 raw
= OPENSSL_malloc(numciphers
* TLS_CIPHER_LEN
);
5570 s
->s3
.tmp
.ciphers_raw
= raw
;
5572 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5575 for (s
->s3
.tmp
.ciphers_rawlen
= 0;
5576 PACKET_remaining(&sslv2ciphers
) > 0;
5577 raw
+= TLS_CIPHER_LEN
) {
5578 if (!PACKET_get_1(&sslv2ciphers
, &leadbyte
)
5580 && !PACKET_copy_bytes(&sslv2ciphers
, raw
,
5583 && !PACKET_forward(&sslv2ciphers
, TLS_CIPHER_LEN
))) {
5584 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_R_BAD_PACKET
);
5585 OPENSSL_free(s
->s3
.tmp
.ciphers_raw
);
5586 s
->s3
.tmp
.ciphers_raw
= NULL
;
5587 s
->s3
.tmp
.ciphers_rawlen
= 0;
5591 s
->s3
.tmp
.ciphers_rawlen
+= TLS_CIPHER_LEN
;
5593 } else if (!PACKET_memdup(cipher_suites
, &s
->s3
.tmp
.ciphers_raw
,
5594 &s
->s3
.tmp
.ciphers_rawlen
)) {
5595 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
5601 int SSL_bytes_to_cipher_list(SSL
*s
, const unsigned char *bytes
, size_t len
,
5602 int isv2format
, STACK_OF(SSL_CIPHER
) **sk
,
5603 STACK_OF(SSL_CIPHER
) **scsvs
)
5607 if (!PACKET_buf_init(&pkt
, bytes
, len
))
5609 return bytes_to_cipher_list(s
, &pkt
, sk
, scsvs
, isv2format
, 0);
5612 int bytes_to_cipher_list(SSL
*s
, PACKET
*cipher_suites
,
5613 STACK_OF(SSL_CIPHER
) **skp
,
5614 STACK_OF(SSL_CIPHER
) **scsvs_out
,
5615 int sslv2format
, int fatal
)
5617 const SSL_CIPHER
*c
;
5618 STACK_OF(SSL_CIPHER
) *sk
= NULL
;
5619 STACK_OF(SSL_CIPHER
) *scsvs
= NULL
;
5621 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5622 unsigned char cipher
[SSLV2_CIPHER_LEN
];
5624 n
= sslv2format
? SSLV2_CIPHER_LEN
: TLS_CIPHER_LEN
;
5626 if (PACKET_remaining(cipher_suites
) == 0) {
5628 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_R_NO_CIPHERS_SPECIFIED
);
5630 ERR_raise(ERR_LIB_SSL
, SSL_R_NO_CIPHERS_SPECIFIED
);
5634 if (PACKET_remaining(cipher_suites
) % n
!= 0) {
5636 SSLfatal(s
, SSL_AD_DECODE_ERROR
,
5637 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5639 ERR_raise(ERR_LIB_SSL
, SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST
);
5643 sk
= sk_SSL_CIPHER_new_null();
5644 scsvs
= sk_SSL_CIPHER_new_null();
5645 if (sk
== NULL
|| scsvs
== NULL
) {
5647 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5649 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
5653 while (PACKET_copy_bytes(cipher_suites
, cipher
, n
)) {
5655 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5656 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5657 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5659 if (sslv2format
&& cipher
[0] != '\0')
5662 /* For SSLv2-compat, ignore leading 0-byte. */
5663 c
= ssl_get_cipher_by_char(s
, sslv2format
? &cipher
[1] : cipher
, 1);
5665 if ((c
->valid
&& !sk_SSL_CIPHER_push(sk
, c
)) ||
5666 (!c
->valid
&& !sk_SSL_CIPHER_push(scsvs
, c
))) {
5668 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
5670 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
5675 if (PACKET_remaining(cipher_suites
) > 0) {
5677 SSLfatal(s
, SSL_AD_DECODE_ERROR
, SSL_R_BAD_LENGTH
);
5679 ERR_raise(ERR_LIB_SSL
, SSL_R_BAD_LENGTH
);
5686 sk_SSL_CIPHER_free(sk
);
5687 if (scsvs_out
!= NULL
)
5690 sk_SSL_CIPHER_free(scsvs
);
5693 sk_SSL_CIPHER_free(sk
);
5694 sk_SSL_CIPHER_free(scsvs
);
5698 int SSL_CTX_set_max_early_data(SSL_CTX
*ctx
, uint32_t max_early_data
)
5700 ctx
->max_early_data
= max_early_data
;
5705 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX
*ctx
)
5707 return ctx
->max_early_data
;
5710 int SSL_set_max_early_data(SSL
*s
, uint32_t max_early_data
)
5712 s
->max_early_data
= max_early_data
;
5717 uint32_t SSL_get_max_early_data(const SSL
*s
)
5719 return s
->max_early_data
;
5722 int SSL_CTX_set_recv_max_early_data(SSL_CTX
*ctx
, uint32_t recv_max_early_data
)
5724 ctx
->recv_max_early_data
= recv_max_early_data
;
5729 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX
*ctx
)
5731 return ctx
->recv_max_early_data
;
5734 int SSL_set_recv_max_early_data(SSL
*s
, uint32_t recv_max_early_data
)
5736 s
->recv_max_early_data
= recv_max_early_data
;
5741 uint32_t SSL_get_recv_max_early_data(const SSL
*s
)
5743 return s
->recv_max_early_data
;
5746 __owur
unsigned int ssl_get_max_send_fragment(const SSL
*ssl
)
5748 /* Return any active Max Fragment Len extension */
5749 if (ssl
->session
!= NULL
&& USE_MAX_FRAGMENT_LENGTH_EXT(ssl
->session
))
5750 return GET_MAX_FRAGMENT_LENGTH(ssl
->session
);
5752 /* return current SSL connection setting */
5753 return ssl
->max_send_fragment
;
5756 __owur
unsigned int ssl_get_split_send_fragment(const SSL
*ssl
)
5758 /* Return a value regarding an active Max Fragment Len extension */
5759 if (ssl
->session
!= NULL
&& USE_MAX_FRAGMENT_LENGTH_EXT(ssl
->session
)
5760 && ssl
->split_send_fragment
> GET_MAX_FRAGMENT_LENGTH(ssl
->session
))
5761 return GET_MAX_FRAGMENT_LENGTH(ssl
->session
);
5763 /* else limit |split_send_fragment| to current |max_send_fragment| */
5764 if (ssl
->split_send_fragment
> ssl
->max_send_fragment
)
5765 return ssl
->max_send_fragment
;
5767 /* return current SSL connection setting */
5768 return ssl
->split_send_fragment
;
5771 int SSL_stateless(SSL
*s
)
5775 /* Ensure there is no state left over from a previous invocation */
5781 s
->s3
.flags
|= TLS1_FLAGS_STATELESS
;
5782 ret
= SSL_accept(s
);
5783 s
->s3
.flags
&= ~TLS1_FLAGS_STATELESS
;
5785 if (ret
> 0 && s
->ext
.cookieok
)
5788 if (s
->hello_retry_request
== SSL_HRR_PENDING
&& !ossl_statem_in_error(s
))
5794 void SSL_CTX_set_post_handshake_auth(SSL_CTX
*ctx
, int val
)
5796 ctx
->pha_enabled
= val
;
5799 void SSL_set_post_handshake_auth(SSL
*ssl
, int val
)
5801 ssl
->pha_enabled
= val
;
5804 int SSL_verify_client_post_handshake(SSL
*ssl
)
5806 if (!SSL_IS_TLS13(ssl
)) {
5807 ERR_raise(ERR_LIB_SSL
, SSL_R_WRONG_SSL_VERSION
);
5811 ERR_raise(ERR_LIB_SSL
, SSL_R_NOT_SERVER
);
5815 if (!SSL_is_init_finished(ssl
)) {
5816 ERR_raise(ERR_LIB_SSL
, SSL_R_STILL_IN_INIT
);
5820 switch (ssl
->post_handshake_auth
) {
5822 ERR_raise(ERR_LIB_SSL
, SSL_R_EXTENSION_NOT_RECEIVED
);
5825 case SSL_PHA_EXT_SENT
:
5826 ERR_raise(ERR_LIB_SSL
, ERR_R_INTERNAL_ERROR
);
5828 case SSL_PHA_EXT_RECEIVED
:
5830 case SSL_PHA_REQUEST_PENDING
:
5831 ERR_raise(ERR_LIB_SSL
, SSL_R_REQUEST_PENDING
);
5833 case SSL_PHA_REQUESTED
:
5834 ERR_raise(ERR_LIB_SSL
, SSL_R_REQUEST_SENT
);
5838 ssl
->post_handshake_auth
= SSL_PHA_REQUEST_PENDING
;
5840 /* checks verify_mode and algorithm_auth */
5841 if (!send_certificate_request(ssl
)) {
5842 ssl
->post_handshake_auth
= SSL_PHA_EXT_RECEIVED
; /* restore on error */
5843 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_CONFIG
);
5847 ossl_statem_set_in_init(ssl
, 1);
5851 int SSL_CTX_set_session_ticket_cb(SSL_CTX
*ctx
,
5852 SSL_CTX_generate_session_ticket_fn gen_cb
,
5853 SSL_CTX_decrypt_session_ticket_fn dec_cb
,
5856 ctx
->generate_ticket_cb
= gen_cb
;
5857 ctx
->decrypt_ticket_cb
= dec_cb
;
5858 ctx
->ticket_cb_data
= arg
;
5862 void SSL_CTX_set_allow_early_data_cb(SSL_CTX
*ctx
,
5863 SSL_allow_early_data_cb_fn cb
,
5866 ctx
->allow_early_data_cb
= cb
;
5867 ctx
->allow_early_data_cb_data
= arg
;
5870 void SSL_set_allow_early_data_cb(SSL
*s
,
5871 SSL_allow_early_data_cb_fn cb
,
5874 s
->allow_early_data_cb
= cb
;
5875 s
->allow_early_data_cb_data
= arg
;
5878 const EVP_CIPHER
*ssl_evp_cipher_fetch(OSSL_LIB_CTX
*libctx
,
5880 const char *properties
)
5882 const EVP_CIPHER
*ciph
;
5884 ciph
= tls_get_cipher_from_engine(nid
);
5889 * If there is no engine cipher then we do an explicit fetch. This may fail
5890 * and that could be ok
5893 ciph
= EVP_CIPHER_fetch(libctx
, OBJ_nid2sn(nid
), properties
);
5899 int ssl_evp_cipher_up_ref(const EVP_CIPHER
*cipher
)
5901 /* Don't up-ref an implicit EVP_CIPHER */
5902 if (EVP_CIPHER_provider(cipher
) == NULL
)
5906 * The cipher was explicitly fetched and therefore it is safe to cast
5909 return EVP_CIPHER_up_ref((EVP_CIPHER
*)cipher
);
5912 void ssl_evp_cipher_free(const EVP_CIPHER
*cipher
)
5917 if (EVP_CIPHER_provider(cipher
) != NULL
) {
5919 * The cipher was explicitly fetched and therefore it is safe to cast
5922 EVP_CIPHER_free((EVP_CIPHER
*)cipher
);
5926 const EVP_MD
*ssl_evp_md_fetch(OSSL_LIB_CTX
*libctx
,
5928 const char *properties
)
5932 md
= tls_get_digest_from_engine(nid
);
5936 /* Otherwise we do an explicit fetch */
5938 md
= EVP_MD_fetch(libctx
, OBJ_nid2sn(nid
), properties
);
5943 int ssl_evp_md_up_ref(const EVP_MD
*md
)
5945 /* Don't up-ref an implicit EVP_MD */
5946 if (EVP_MD_provider(md
) == NULL
)
5950 * The digest was explicitly fetched and therefore it is safe to cast
5953 return EVP_MD_up_ref((EVP_MD
*)md
);
5956 void ssl_evp_md_free(const EVP_MD
*md
)
5961 if (EVP_MD_provider(md
) != NULL
) {
5963 * The digest was explicitly fetched and therefore it is safe to cast
5966 EVP_MD_free((EVP_MD
*)md
);
5970 int SSL_set0_tmp_dh_pkey(SSL
*s
, EVP_PKEY
*dhpkey
)
5972 if (!ssl_security(s
, SSL_SECOP_TMP_DH
,
5973 EVP_PKEY_security_bits(dhpkey
), 0, dhpkey
)) {
5974 ERR_raise(ERR_LIB_SSL
, SSL_R_DH_KEY_TOO_SMALL
);
5975 EVP_PKEY_free(dhpkey
);
5978 EVP_PKEY_free(s
->cert
->dh_tmp
);
5979 s
->cert
->dh_tmp
= dhpkey
;
5983 int SSL_CTX_set0_tmp_dh_pkey(SSL_CTX
*ctx
, EVP_PKEY
*dhpkey
)
5985 if (!ssl_ctx_security(ctx
, SSL_SECOP_TMP_DH
,
5986 EVP_PKEY_security_bits(dhpkey
), 0, dhpkey
)) {
5987 ERR_raise(ERR_LIB_SSL
, SSL_R_DH_KEY_TOO_SMALL
);
5988 EVP_PKEY_free(dhpkey
);
5991 EVP_PKEY_free(ctx
->cert
->dh_tmp
);
5992 ctx
->cert
->dh_tmp
= dhpkey
;