2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 * ECC cipher suite support in OpenSSL originally developed by
13 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
15 /* ====================================================================
16 * Copyright 2005 Nokia. All rights reserved.
18 * The portions of the attached software ("Contribution") is developed by
19 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
22 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24 * support (see RFC 4279) to OpenSSL.
26 * No patent licenses or other rights except those expressly stated in
27 * the OpenSSL open source license shall be deemed granted or received
28 * expressly, by implication, estoppel, or otherwise.
30 * No assurances are provided by Nokia that the Contribution does not
31 * infringe the patent or other intellectual property rights of any third
32 * party or that the license provides you with all the necessary rights
33 * to make use of the Contribution.
35 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
45 #include <openssl/objects.h>
46 #include <openssl/lhash.h>
47 #include <openssl/x509v3.h>
48 #include <openssl/rand.h>
49 #include <openssl/ocsp.h>
50 #include <openssl/dh.h>
51 #include <openssl/engine.h>
52 #include <openssl/async.h>
53 #include <openssl/ct.h>
55 const char SSL_version_str
[] = OPENSSL_VERSION_TEXT
;
57 SSL3_ENC_METHOD ssl3_undef_enc_method
= {
59 * evil casts, but these functions are only called if there's a library
62 (int (*)(SSL
*, SSL3_RECORD
*, unsigned int, int))ssl_undefined_function
,
63 (int (*)(SSL
*, SSL3_RECORD
*, unsigned char *, int))ssl_undefined_function
,
64 ssl_undefined_function
,
65 (int (*)(SSL
*, unsigned char *, unsigned char *, int))
66 ssl_undefined_function
,
67 (int (*)(SSL
*, int))ssl_undefined_function
,
68 (int (*)(SSL
*, const char *, int, unsigned char *))
69 ssl_undefined_function
,
70 0, /* finish_mac_length */
71 NULL
, /* client_finished_label */
72 0, /* client_finished_label_len */
73 NULL
, /* server_finished_label */
74 0, /* server_finished_label_len */
75 (int (*)(int))ssl_undefined_function
,
76 (int (*)(SSL
*, unsigned char *, size_t, const char *,
77 size_t, const unsigned char *, size_t,
78 int use_context
))ssl_undefined_function
,
81 struct ssl_async_args
{
85 enum { READFUNC
, WRITEFUNC
, OTHERFUNC
} type
;
87 int (*func_read
) (SSL
*, void *, size_t, size_t *);
88 int (*func_write
) (SSL
*, const void *, size_t, size_t *);
89 int (*func_other
) (SSL
*);
99 DANETLS_MATCHING_FULL
, 0, NID_undef
102 DANETLS_MATCHING_2256
, 1, NID_sha256
105 DANETLS_MATCHING_2512
, 2, NID_sha512
109 static int dane_ctx_enable(struct dane_ctx_st
*dctx
)
111 const EVP_MD
**mdevp
;
113 uint8_t mdmax
= DANETLS_MATCHING_LAST
;
114 int n
= ((int)mdmax
) + 1; /* int to handle PrivMatch(255) */
117 if (dctx
->mdevp
!= NULL
)
120 mdevp
= OPENSSL_zalloc(n
* sizeof(*mdevp
));
121 mdord
= OPENSSL_zalloc(n
* sizeof(*mdord
));
123 if (mdord
== NULL
|| mdevp
== NULL
) {
126 SSLerr(SSL_F_DANE_CTX_ENABLE
, ERR_R_MALLOC_FAILURE
);
130 /* Install default entries */
131 for (i
= 0; i
< OSSL_NELEM(dane_mds
); ++i
) {
134 if (dane_mds
[i
].nid
== NID_undef
||
135 (md
= EVP_get_digestbynid(dane_mds
[i
].nid
)) == NULL
)
137 mdevp
[dane_mds
[i
].mtype
] = md
;
138 mdord
[dane_mds
[i
].mtype
] = dane_mds
[i
].ord
;
148 static void dane_ctx_final(struct dane_ctx_st
*dctx
)
150 OPENSSL_free(dctx
->mdevp
);
153 OPENSSL_free(dctx
->mdord
);
158 static void tlsa_free(danetls_record
*t
)
162 OPENSSL_free(t
->data
);
163 EVP_PKEY_free(t
->spki
);
167 static void dane_final(SSL_DANE
*dane
)
169 sk_danetls_record_pop_free(dane
->trecs
, tlsa_free
);
172 sk_X509_pop_free(dane
->certs
, X509_free
);
175 X509_free(dane
->mcert
);
183 * dane_copy - Copy dane configuration, sans verification state.
185 static int ssl_dane_dup(SSL
*to
, SSL
*from
)
190 if (!DANETLS_ENABLED(&from
->dane
))
193 dane_final(&to
->dane
);
194 to
->dane
.flags
= from
->dane
.flags
;
195 to
->dane
.dctx
= &to
->ctx
->dane
;
196 to
->dane
.trecs
= sk_danetls_record_new_null();
198 if (to
->dane
.trecs
== NULL
) {
199 SSLerr(SSL_F_SSL_DANE_DUP
, ERR_R_MALLOC_FAILURE
);
203 num
= sk_danetls_record_num(from
->dane
.trecs
);
204 for (i
= 0; i
< num
; ++i
) {
205 danetls_record
*t
= sk_danetls_record_value(from
->dane
.trecs
, i
);
207 if (SSL_dane_tlsa_add(to
, t
->usage
, t
->selector
, t
->mtype
,
208 t
->data
, t
->dlen
) <= 0)
214 static int dane_mtype_set(struct dane_ctx_st
*dctx
,
215 const EVP_MD
*md
, uint8_t mtype
, uint8_t ord
)
219 if (mtype
== DANETLS_MATCHING_FULL
&& md
!= NULL
) {
220 SSLerr(SSL_F_DANE_MTYPE_SET
, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL
);
224 if (mtype
> dctx
->mdmax
) {
225 const EVP_MD
**mdevp
;
227 int n
= ((int)mtype
) + 1;
229 mdevp
= OPENSSL_realloc(dctx
->mdevp
, n
* sizeof(*mdevp
));
231 SSLerr(SSL_F_DANE_MTYPE_SET
, ERR_R_MALLOC_FAILURE
);
236 mdord
= OPENSSL_realloc(dctx
->mdord
, n
* sizeof(*mdord
));
238 SSLerr(SSL_F_DANE_MTYPE_SET
, ERR_R_MALLOC_FAILURE
);
243 /* Zero-fill any gaps */
244 for (i
= dctx
->mdmax
+ 1; i
< mtype
; ++i
) {
252 dctx
->mdevp
[mtype
] = md
;
253 /* Coerce ordinal of disabled matching types to 0 */
254 dctx
->mdord
[mtype
] = (md
== NULL
) ? 0 : ord
;
259 static const EVP_MD
*tlsa_md_get(SSL_DANE
*dane
, uint8_t mtype
)
261 if (mtype
> dane
->dctx
->mdmax
)
263 return dane
->dctx
->mdevp
[mtype
];
266 static int dane_tlsa_add(SSL_DANE
*dane
,
269 uint8_t mtype
, unsigned char *data
, size_t dlen
)
272 const EVP_MD
*md
= NULL
;
273 int ilen
= (int)dlen
;
277 if (dane
->trecs
== NULL
) {
278 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_NOT_ENABLED
);
282 if (ilen
< 0 || dlen
!= (size_t)ilen
) {
283 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_DATA_LENGTH
);
287 if (usage
> DANETLS_USAGE_LAST
) {
288 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE
);
292 if (selector
> DANETLS_SELECTOR_LAST
) {
293 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_SELECTOR
);
297 if (mtype
!= DANETLS_MATCHING_FULL
) {
298 md
= tlsa_md_get(dane
, mtype
);
300 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE
);
305 if (md
!= NULL
&& dlen
!= (size_t)EVP_MD_size(md
)) {
306 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH
);
310 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_NULL_DATA
);
314 if ((t
= OPENSSL_zalloc(sizeof(*t
))) == NULL
) {
315 SSLerr(SSL_F_DANE_TLSA_ADD
, ERR_R_MALLOC_FAILURE
);
320 t
->selector
= selector
;
322 t
->data
= OPENSSL_malloc(ilen
);
323 if (t
->data
== NULL
) {
325 SSLerr(SSL_F_DANE_TLSA_ADD
, ERR_R_MALLOC_FAILURE
);
328 memcpy(t
->data
, data
, ilen
);
331 /* Validate and cache full certificate or public key */
332 if (mtype
== DANETLS_MATCHING_FULL
) {
333 const unsigned char *p
= data
;
335 EVP_PKEY
*pkey
= NULL
;
338 case DANETLS_SELECTOR_CERT
:
339 if (!d2i_X509(&cert
, &p
, dlen
) || p
< data
||
340 dlen
!= (size_t)(p
- data
)) {
342 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_CERTIFICATE
);
345 if (X509_get0_pubkey(cert
) == NULL
) {
347 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_CERTIFICATE
);
351 if ((DANETLS_USAGE_BIT(usage
) & DANETLS_TA_MASK
) == 0) {
357 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
358 * records that contain full certificates of trust-anchors that are
359 * not present in the wire chain. For usage PKIX-TA(0), we augment
360 * the chain with untrusted Full(0) certificates from DNS, in case
361 * they are missing from the chain.
363 if ((dane
->certs
== NULL
&&
364 (dane
->certs
= sk_X509_new_null()) == NULL
) ||
365 !sk_X509_push(dane
->certs
, cert
)) {
366 SSLerr(SSL_F_DANE_TLSA_ADD
, ERR_R_MALLOC_FAILURE
);
373 case DANETLS_SELECTOR_SPKI
:
374 if (!d2i_PUBKEY(&pkey
, &p
, dlen
) || p
< data
||
375 dlen
!= (size_t)(p
- data
)) {
377 SSLerr(SSL_F_DANE_TLSA_ADD
, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY
);
382 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
383 * records that contain full bare keys of trust-anchors that are
384 * not present in the wire chain.
386 if (usage
== DANETLS_USAGE_DANE_TA
)
395 * Find the right insertion point for the new record.
397 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
398 * they can be processed first, as they require no chain building, and no
399 * expiration or hostname checks. Because DANE-EE(3) is numerically
400 * largest, this is accomplished via descending sort by "usage".
402 * We also sort in descending order by matching ordinal to simplify
403 * the implementation of digest agility in the verification code.
405 * The choice of order for the selector is not significant, so we
406 * use the same descending order for consistency.
408 num
= sk_danetls_record_num(dane
->trecs
);
409 for (i
= 0; i
< num
; ++i
) {
410 danetls_record
*rec
= sk_danetls_record_value(dane
->trecs
, i
);
412 if (rec
->usage
> usage
)
414 if (rec
->usage
< usage
)
416 if (rec
->selector
> selector
)
418 if (rec
->selector
< selector
)
420 if (dane
->dctx
->mdord
[rec
->mtype
] > dane
->dctx
->mdord
[mtype
])
425 if (!sk_danetls_record_insert(dane
->trecs
, t
, i
)) {
427 SSLerr(SSL_F_DANE_TLSA_ADD
, ERR_R_MALLOC_FAILURE
);
430 dane
->umask
|= DANETLS_USAGE_BIT(usage
);
435 static void clear_ciphers(SSL
*s
)
437 /* clear the current cipher */
438 ssl_clear_cipher_ctx(s
);
439 ssl_clear_hash_ctx(&s
->read_hash
);
440 ssl_clear_hash_ctx(&s
->write_hash
);
443 int SSL_clear(SSL
*s
)
445 if (s
->method
== NULL
) {
446 SSLerr(SSL_F_SSL_CLEAR
, SSL_R_NO_METHOD_SPECIFIED
);
450 if (ssl_clear_bad_session(s
)) {
451 SSL_SESSION_free(s
->session
);
459 if (s
->renegotiate
) {
460 SSLerr(SSL_F_SSL_CLEAR
, ERR_R_INTERNAL_ERROR
);
464 ossl_statem_clear(s
);
466 s
->version
= s
->method
->version
;
467 s
->client_version
= s
->version
;
468 s
->rwstate
= SSL_NOTHING
;
470 BUF_MEM_free(s
->init_buf
);
475 /* Reset DANE verification result state */
478 X509_free(s
->dane
.mcert
);
479 s
->dane
.mcert
= NULL
;
480 s
->dane
.mtlsa
= NULL
;
482 /* Clear the verification result peername */
483 X509_VERIFY_PARAM_move_peername(s
->param
, NULL
);
486 * Check to see if we were changed into a different method, if so, revert
487 * back if we are not doing session-id reuse.
489 if (!ossl_statem_get_in_handshake(s
) && (s
->session
== NULL
)
490 && (s
->method
!= s
->ctx
->method
)) {
491 s
->method
->ssl_free(s
);
492 s
->method
= s
->ctx
->method
;
493 if (!s
->method
->ssl_new(s
))
496 s
->method
->ssl_clear(s
);
498 RECORD_LAYER_clear(&s
->rlayer
);
503 /** Used to change an SSL_CTXs default SSL method type */
504 int SSL_CTX_set_ssl_version(SSL_CTX
*ctx
, const SSL_METHOD
*meth
)
506 STACK_OF(SSL_CIPHER
) *sk
;
510 sk
= ssl_create_cipher_list(ctx
->method
, &(ctx
->cipher_list
),
511 &(ctx
->cipher_list_by_id
),
512 SSL_DEFAULT_CIPHER_LIST
, ctx
->cert
);
513 if ((sk
== NULL
) || (sk_SSL_CIPHER_num(sk
) <= 0)) {
514 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION
, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS
);
520 SSL
*SSL_new(SSL_CTX
*ctx
)
525 SSLerr(SSL_F_SSL_NEW
, SSL_R_NULL_SSL_CTX
);
528 if (ctx
->method
== NULL
) {
529 SSLerr(SSL_F_SSL_NEW
, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION
);
533 s
= OPENSSL_zalloc(sizeof(*s
));
537 s
->lock
= CRYPTO_THREAD_lock_new();
538 if (s
->lock
== NULL
) {
539 SSLerr(SSL_F_SSL_NEW
, ERR_R_MALLOC_FAILURE
);
544 RECORD_LAYER_init(&s
->rlayer
, s
);
546 s
->options
= ctx
->options
;
547 s
->dane
.flags
= ctx
->dane
.flags
;
548 s
->min_proto_version
= ctx
->min_proto_version
;
549 s
->max_proto_version
= ctx
->max_proto_version
;
551 s
->max_cert_list
= ctx
->max_cert_list
;
555 * Earlier library versions used to copy the pointer to the CERT, not
556 * its contents; only when setting new parameters for the per-SSL
557 * copy, ssl_cert_new would be called (and the direct reference to
558 * the per-SSL_CTX settings would be lost, but those still were
559 * indirectly accessed for various purposes, and for that reason they
560 * used to be known as s->ctx->default_cert). Now we don't look at the
561 * SSL_CTX's CERT after having duplicated it once.
563 s
->cert
= ssl_cert_dup(ctx
->cert
);
567 RECORD_LAYER_set_read_ahead(&s
->rlayer
, ctx
->read_ahead
);
568 s
->msg_callback
= ctx
->msg_callback
;
569 s
->msg_callback_arg
= ctx
->msg_callback_arg
;
570 s
->verify_mode
= ctx
->verify_mode
;
571 s
->not_resumable_session_cb
= ctx
->not_resumable_session_cb
;
572 s
->sid_ctx_length
= ctx
->sid_ctx_length
;
573 OPENSSL_assert(s
->sid_ctx_length
<= sizeof s
->sid_ctx
);
574 memcpy(&s
->sid_ctx
, &ctx
->sid_ctx
, sizeof(s
->sid_ctx
));
575 s
->verify_callback
= ctx
->default_verify_callback
;
576 s
->generate_session_id
= ctx
->generate_session_id
;
578 s
->param
= X509_VERIFY_PARAM_new();
579 if (s
->param
== NULL
)
581 X509_VERIFY_PARAM_inherit(s
->param
, ctx
->param
);
582 s
->quiet_shutdown
= ctx
->quiet_shutdown
;
583 s
->max_send_fragment
= ctx
->max_send_fragment
;
584 s
->split_send_fragment
= ctx
->split_send_fragment
;
585 s
->max_pipelines
= ctx
->max_pipelines
;
586 if (s
->max_pipelines
> 1)
587 RECORD_LAYER_set_read_ahead(&s
->rlayer
, 1);
588 if (ctx
->default_read_buf_len
> 0)
589 SSL_set_default_read_buffer_len(s
, ctx
->default_read_buf_len
);
593 s
->tlsext_debug_cb
= 0;
594 s
->tlsext_debug_arg
= NULL
;
595 s
->tlsext_ticket_expected
= 0;
596 s
->tlsext_status_type
= ctx
->tlsext_status_type
;
597 s
->tlsext_status_expected
= 0;
598 s
->tlsext_ocsp_ids
= NULL
;
599 s
->tlsext_ocsp_exts
= NULL
;
600 s
->tlsext_ocsp_resp
= NULL
;
601 s
->tlsext_ocsp_resplen
= -1;
603 s
->initial_ctx
= ctx
;
604 #ifndef OPENSSL_NO_EC
605 if (ctx
->tlsext_ecpointformatlist
) {
606 s
->tlsext_ecpointformatlist
=
607 OPENSSL_memdup(ctx
->tlsext_ecpointformatlist
,
608 ctx
->tlsext_ecpointformatlist_length
);
609 if (!s
->tlsext_ecpointformatlist
)
611 s
->tlsext_ecpointformatlist_length
=
612 ctx
->tlsext_ecpointformatlist_length
;
614 if (ctx
->tlsext_ellipticcurvelist
) {
615 s
->tlsext_ellipticcurvelist
=
616 OPENSSL_memdup(ctx
->tlsext_ellipticcurvelist
,
617 ctx
->tlsext_ellipticcurvelist_length
);
618 if (!s
->tlsext_ellipticcurvelist
)
620 s
->tlsext_ellipticcurvelist_length
=
621 ctx
->tlsext_ellipticcurvelist_length
;
624 #ifndef OPENSSL_NO_NEXTPROTONEG
625 s
->next_proto_negotiated
= NULL
;
628 if (s
->ctx
->alpn_client_proto_list
) {
629 s
->alpn_client_proto_list
=
630 OPENSSL_malloc(s
->ctx
->alpn_client_proto_list_len
);
631 if (s
->alpn_client_proto_list
== NULL
)
633 memcpy(s
->alpn_client_proto_list
, s
->ctx
->alpn_client_proto_list
,
634 s
->ctx
->alpn_client_proto_list_len
);
635 s
->alpn_client_proto_list_len
= s
->ctx
->alpn_client_proto_list_len
;
638 s
->verified_chain
= NULL
;
639 s
->verify_result
= X509_V_OK
;
641 s
->default_passwd_callback
= ctx
->default_passwd_callback
;
642 s
->default_passwd_callback_userdata
= ctx
->default_passwd_callback_userdata
;
644 s
->method
= ctx
->method
;
646 if (!s
->method
->ssl_new(s
))
649 s
->server
= (ctx
->method
->ssl_accept
== ssl_undefined_function
) ? 0 : 1;
654 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL
, s
, &s
->ex_data
))
657 #ifndef OPENSSL_NO_PSK
658 s
->psk_client_callback
= ctx
->psk_client_callback
;
659 s
->psk_server_callback
= ctx
->psk_server_callback
;
664 #ifndef OPENSSL_NO_CT
665 if (!SSL_set_ct_validation_callback(s
, ctx
->ct_validation_callback
,
666 ctx
->ct_validation_callback_arg
))
673 SSLerr(SSL_F_SSL_NEW
, ERR_R_MALLOC_FAILURE
);
677 int SSL_is_dtls(const SSL
*s
)
679 return SSL_IS_DTLS(s
) ? 1 : 0;
682 int SSL_up_ref(SSL
*s
)
686 if (CRYPTO_atomic_add(&s
->references
, 1, &i
, s
->lock
) <= 0)
689 REF_PRINT_COUNT("SSL", s
);
690 REF_ASSERT_ISNT(i
< 2);
691 return ((i
> 1) ? 1 : 0);
694 int SSL_CTX_set_session_id_context(SSL_CTX
*ctx
, const unsigned char *sid_ctx
,
695 unsigned int sid_ctx_len
)
697 if (sid_ctx_len
> sizeof ctx
->sid_ctx
) {
698 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT
,
699 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
702 ctx
->sid_ctx_length
= sid_ctx_len
;
703 memcpy(ctx
->sid_ctx
, sid_ctx
, sid_ctx_len
);
708 int SSL_set_session_id_context(SSL
*ssl
, const unsigned char *sid_ctx
,
709 unsigned int sid_ctx_len
)
711 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
712 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT
,
713 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
716 ssl
->sid_ctx_length
= sid_ctx_len
;
717 memcpy(ssl
->sid_ctx
, sid_ctx
, sid_ctx_len
);
722 int SSL_CTX_set_generate_session_id(SSL_CTX
*ctx
, GEN_SESSION_CB cb
)
724 CRYPTO_THREAD_write_lock(ctx
->lock
);
725 ctx
->generate_session_id
= cb
;
726 CRYPTO_THREAD_unlock(ctx
->lock
);
730 int SSL_set_generate_session_id(SSL
*ssl
, GEN_SESSION_CB cb
)
732 CRYPTO_THREAD_write_lock(ssl
->lock
);
733 ssl
->generate_session_id
= cb
;
734 CRYPTO_THREAD_unlock(ssl
->lock
);
738 int SSL_has_matching_session_id(const SSL
*ssl
, const unsigned char *id
,
742 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
743 * we can "construct" a session to give us the desired check - ie. to
744 * find if there's a session in the hash table that would conflict with
745 * any new session built out of this id/id_len and the ssl_version in use
750 if (id_len
> sizeof r
.session_id
)
753 r
.ssl_version
= ssl
->version
;
754 r
.session_id_length
= id_len
;
755 memcpy(r
.session_id
, id
, id_len
);
757 CRYPTO_THREAD_read_lock(ssl
->session_ctx
->lock
);
758 p
= lh_SSL_SESSION_retrieve(ssl
->session_ctx
->sessions
, &r
);
759 CRYPTO_THREAD_unlock(ssl
->session_ctx
->lock
);
763 int SSL_CTX_set_purpose(SSL_CTX
*s
, int purpose
)
765 return X509_VERIFY_PARAM_set_purpose(s
->param
, purpose
);
768 int SSL_set_purpose(SSL
*s
, int purpose
)
770 return X509_VERIFY_PARAM_set_purpose(s
->param
, purpose
);
773 int SSL_CTX_set_trust(SSL_CTX
*s
, int trust
)
775 return X509_VERIFY_PARAM_set_trust(s
->param
, trust
);
778 int SSL_set_trust(SSL
*s
, int trust
)
780 return X509_VERIFY_PARAM_set_trust(s
->param
, trust
);
783 int SSL_set1_host(SSL
*s
, const char *hostname
)
785 return X509_VERIFY_PARAM_set1_host(s
->param
, hostname
, 0);
788 int SSL_add1_host(SSL
*s
, const char *hostname
)
790 return X509_VERIFY_PARAM_add1_host(s
->param
, hostname
, 0);
793 void SSL_set_hostflags(SSL
*s
, unsigned int flags
)
795 X509_VERIFY_PARAM_set_hostflags(s
->param
, flags
);
798 const char *SSL_get0_peername(SSL
*s
)
800 return X509_VERIFY_PARAM_get0_peername(s
->param
);
803 int SSL_CTX_dane_enable(SSL_CTX
*ctx
)
805 return dane_ctx_enable(&ctx
->dane
);
808 unsigned long SSL_CTX_dane_set_flags(SSL_CTX
*ctx
, unsigned long flags
)
810 unsigned long orig
= ctx
->dane
.flags
;
812 ctx
->dane
.flags
|= flags
;
816 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX
*ctx
, unsigned long flags
)
818 unsigned long orig
= ctx
->dane
.flags
;
820 ctx
->dane
.flags
&= ~flags
;
824 int SSL_dane_enable(SSL
*s
, const char *basedomain
)
826 SSL_DANE
*dane
= &s
->dane
;
828 if (s
->ctx
->dane
.mdmax
== 0) {
829 SSLerr(SSL_F_SSL_DANE_ENABLE
, SSL_R_CONTEXT_NOT_DANE_ENABLED
);
832 if (dane
->trecs
!= NULL
) {
833 SSLerr(SSL_F_SSL_DANE_ENABLE
, SSL_R_DANE_ALREADY_ENABLED
);
838 * Default SNI name. This rejects empty names, while set1_host below
839 * accepts them and disables host name checks. To avoid side-effects with
840 * invalid input, set the SNI name first.
842 if (s
->tlsext_hostname
== NULL
) {
843 if (!SSL_set_tlsext_host_name(s
, basedomain
)) {
844 SSLerr(SSL_F_SSL_DANE_ENABLE
, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN
);
849 /* Primary RFC6125 reference identifier */
850 if (!X509_VERIFY_PARAM_set1_host(s
->param
, basedomain
, 0)) {
851 SSLerr(SSL_F_SSL_DANE_ENABLE
, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN
);
857 dane
->dctx
= &s
->ctx
->dane
;
858 dane
->trecs
= sk_danetls_record_new_null();
860 if (dane
->trecs
== NULL
) {
861 SSLerr(SSL_F_SSL_DANE_ENABLE
, ERR_R_MALLOC_FAILURE
);
867 unsigned long SSL_dane_set_flags(SSL
*ssl
, unsigned long flags
)
869 unsigned long orig
= ssl
->dane
.flags
;
871 ssl
->dane
.flags
|= flags
;
875 unsigned long SSL_dane_clear_flags(SSL
*ssl
, unsigned long flags
)
877 unsigned long orig
= ssl
->dane
.flags
;
879 ssl
->dane
.flags
&= ~flags
;
883 int SSL_get0_dane_authority(SSL
*s
, X509
**mcert
, EVP_PKEY
**mspki
)
885 SSL_DANE
*dane
= &s
->dane
;
887 if (!DANETLS_ENABLED(dane
) || s
->verify_result
!= X509_V_OK
)
891 *mcert
= dane
->mcert
;
893 *mspki
= (dane
->mcert
== NULL
) ? dane
->mtlsa
->spki
: NULL
;
898 int SSL_get0_dane_tlsa(SSL
*s
, uint8_t *usage
, uint8_t *selector
,
899 uint8_t *mtype
, unsigned const char **data
, size_t *dlen
)
901 SSL_DANE
*dane
= &s
->dane
;
903 if (!DANETLS_ENABLED(dane
) || s
->verify_result
!= X509_V_OK
)
907 *usage
= dane
->mtlsa
->usage
;
909 *selector
= dane
->mtlsa
->selector
;
911 *mtype
= dane
->mtlsa
->mtype
;
913 *data
= dane
->mtlsa
->data
;
915 *dlen
= dane
->mtlsa
->dlen
;
920 SSL_DANE
*SSL_get0_dane(SSL
*s
)
925 int SSL_dane_tlsa_add(SSL
*s
, uint8_t usage
, uint8_t selector
,
926 uint8_t mtype
, unsigned char *data
, size_t dlen
)
928 return dane_tlsa_add(&s
->dane
, usage
, selector
, mtype
, data
, dlen
);
931 int SSL_CTX_dane_mtype_set(SSL_CTX
*ctx
, const EVP_MD
*md
, uint8_t mtype
,
934 return dane_mtype_set(&ctx
->dane
, md
, mtype
, ord
);
937 int SSL_CTX_set1_param(SSL_CTX
*ctx
, X509_VERIFY_PARAM
*vpm
)
939 return X509_VERIFY_PARAM_set1(ctx
->param
, vpm
);
942 int SSL_set1_param(SSL
*ssl
, X509_VERIFY_PARAM
*vpm
)
944 return X509_VERIFY_PARAM_set1(ssl
->param
, vpm
);
947 X509_VERIFY_PARAM
*SSL_CTX_get0_param(SSL_CTX
*ctx
)
952 X509_VERIFY_PARAM
*SSL_get0_param(SSL
*ssl
)
957 void SSL_certs_clear(SSL
*s
)
959 ssl_cert_clear_certs(s
->cert
);
962 void SSL_free(SSL
*s
)
969 CRYPTO_atomic_add(&s
->references
, -1, &i
, s
->lock
);
970 REF_PRINT_COUNT("SSL", s
);
973 REF_ASSERT_ISNT(i
< 0);
975 X509_VERIFY_PARAM_free(s
->param
);
976 dane_final(&s
->dane
);
977 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL
, s
, &s
->ex_data
);
979 ssl_free_wbio_buffer(s
);
981 BIO_free_all(s
->wbio
);
982 BIO_free_all(s
->rbio
);
984 BUF_MEM_free(s
->init_buf
);
986 /* add extra stuff */
987 sk_SSL_CIPHER_free(s
->cipher_list
);
988 sk_SSL_CIPHER_free(s
->cipher_list_by_id
);
990 /* Make the next call work :-) */
991 if (s
->session
!= NULL
) {
992 ssl_clear_bad_session(s
);
993 SSL_SESSION_free(s
->session
);
998 ssl_cert_free(s
->cert
);
999 /* Free up if allocated */
1001 OPENSSL_free(s
->tlsext_hostname
);
1002 SSL_CTX_free(s
->initial_ctx
);
1003 #ifndef OPENSSL_NO_EC
1004 OPENSSL_free(s
->tlsext_ecpointformatlist
);
1005 OPENSSL_free(s
->tlsext_ellipticcurvelist
);
1006 #endif /* OPENSSL_NO_EC */
1007 sk_X509_EXTENSION_pop_free(s
->tlsext_ocsp_exts
, X509_EXTENSION_free
);
1008 #ifndef OPENSSL_NO_OCSP
1009 sk_OCSP_RESPID_pop_free(s
->tlsext_ocsp_ids
, OCSP_RESPID_free
);
1011 #ifndef OPENSSL_NO_CT
1012 SCT_LIST_free(s
->scts
);
1013 OPENSSL_free(s
->tlsext_scts
);
1015 OPENSSL_free(s
->tlsext_ocsp_resp
);
1016 OPENSSL_free(s
->alpn_client_proto_list
);
1018 sk_X509_NAME_pop_free(s
->client_CA
, X509_NAME_free
);
1020 sk_X509_pop_free(s
->verified_chain
, X509_free
);
1022 if (s
->method
!= NULL
)
1023 s
->method
->ssl_free(s
);
1025 RECORD_LAYER_release(&s
->rlayer
);
1027 SSL_CTX_free(s
->ctx
);
1029 ASYNC_WAIT_CTX_free(s
->waitctx
);
1031 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1032 OPENSSL_free(s
->next_proto_negotiated
);
1035 #ifndef OPENSSL_NO_SRTP
1036 sk_SRTP_PROTECTION_PROFILE_free(s
->srtp_profiles
);
1039 CRYPTO_THREAD_lock_free(s
->lock
);
1044 void SSL_set0_rbio(SSL
*s
, BIO
*rbio
)
1046 BIO_free_all(s
->rbio
);
1050 void SSL_set0_wbio(SSL
*s
, BIO
*wbio
)
1053 * If the output buffering BIO is still in place, remove it
1055 if (s
->bbio
!= NULL
)
1056 s
->wbio
= BIO_pop(s
->wbio
);
1058 BIO_free_all(s
->wbio
);
1061 /* Re-attach |bbio| to the new |wbio|. */
1062 if (s
->bbio
!= NULL
)
1063 s
->wbio
= BIO_push(s
->bbio
, s
->wbio
);
1066 void SSL_set_bio(SSL
*s
, BIO
*rbio
, BIO
*wbio
)
1069 * For historical reasons, this function has many different cases in
1070 * ownership handling.
1073 /* If nothing has changed, do nothing */
1074 if (rbio
== SSL_get_rbio(s
) && wbio
== SSL_get_wbio(s
))
1078 * If the two arguments are equal then one fewer reference is granted by the
1079 * caller than we want to take
1081 if (rbio
!= NULL
&& rbio
== wbio
)
1085 * If only the wbio is changed only adopt one reference.
1087 if (rbio
== SSL_get_rbio(s
)) {
1088 SSL_set0_wbio(s
, wbio
);
1092 * There is an asymmetry here for historical reasons. If only the rbio is
1093 * changed AND the rbio and wbio were originally different, then we only
1094 * adopt one reference.
1096 if (wbio
== SSL_get_wbio(s
) && SSL_get_rbio(s
) != SSL_get_wbio(s
)) {
1097 SSL_set0_rbio(s
, rbio
);
1101 /* Otherwise, adopt both references. */
1102 SSL_set0_rbio(s
, rbio
);
1103 SSL_set0_wbio(s
, wbio
);
1106 BIO
*SSL_get_rbio(const SSL
*s
)
1111 BIO
*SSL_get_wbio(const SSL
*s
)
1113 if (s
->bbio
!= NULL
) {
1115 * If |bbio| is active, the true caller-configured BIO is its
1118 return BIO_next(s
->bbio
);
1123 int SSL_get_fd(const SSL
*s
)
1125 return SSL_get_rfd(s
);
1128 int SSL_get_rfd(const SSL
*s
)
1133 b
= SSL_get_rbio(s
);
1134 r
= BIO_find_type(b
, BIO_TYPE_DESCRIPTOR
);
1136 BIO_get_fd(r
, &ret
);
1140 int SSL_get_wfd(const SSL
*s
)
1145 b
= SSL_get_wbio(s
);
1146 r
= BIO_find_type(b
, BIO_TYPE_DESCRIPTOR
);
1148 BIO_get_fd(r
, &ret
);
1152 #ifndef OPENSSL_NO_SOCK
1153 int SSL_set_fd(SSL
*s
, int fd
)
1158 bio
= BIO_new(BIO_s_socket());
1161 SSLerr(SSL_F_SSL_SET_FD
, ERR_R_BUF_LIB
);
1164 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1165 SSL_set_bio(s
, bio
, bio
);
1171 int SSL_set_wfd(SSL
*s
, int fd
)
1173 BIO
*rbio
= SSL_get_rbio(s
);
1175 if (rbio
== NULL
|| BIO_method_type(rbio
) != BIO_TYPE_SOCKET
1176 || (int)BIO_get_fd(rbio
, NULL
) != fd
) {
1177 BIO
*bio
= BIO_new(BIO_s_socket());
1180 SSLerr(SSL_F_SSL_SET_WFD
, ERR_R_BUF_LIB
);
1183 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1184 SSL_set0_wbio(s
, bio
);
1187 SSL_set0_wbio(s
, rbio
);
1192 int SSL_set_rfd(SSL
*s
, int fd
)
1194 BIO
*wbio
= SSL_get_wbio(s
);
1196 if (wbio
== NULL
|| BIO_method_type(wbio
) != BIO_TYPE_SOCKET
1197 || ((int)BIO_get_fd(wbio
, NULL
) != fd
)) {
1198 BIO
*bio
= BIO_new(BIO_s_socket());
1201 SSLerr(SSL_F_SSL_SET_RFD
, ERR_R_BUF_LIB
);
1204 BIO_set_fd(bio
, fd
, BIO_NOCLOSE
);
1205 SSL_set0_rbio(s
, bio
);
1208 SSL_set0_rbio(s
, wbio
);
1215 /* return length of latest Finished message we sent, copy to 'buf' */
1216 size_t SSL_get_finished(const SSL
*s
, void *buf
, size_t count
)
1220 if (s
->s3
!= NULL
) {
1221 ret
= s
->s3
->tmp
.finish_md_len
;
1224 memcpy(buf
, s
->s3
->tmp
.finish_md
, count
);
1229 /* return length of latest Finished message we expected, copy to 'buf' */
1230 size_t SSL_get_peer_finished(const SSL
*s
, void *buf
, size_t count
)
1234 if (s
->s3
!= NULL
) {
1235 ret
= s
->s3
->tmp
.peer_finish_md_len
;
1238 memcpy(buf
, s
->s3
->tmp
.peer_finish_md
, count
);
1243 int SSL_get_verify_mode(const SSL
*s
)
1245 return (s
->verify_mode
);
1248 int SSL_get_verify_depth(const SSL
*s
)
1250 return X509_VERIFY_PARAM_get_depth(s
->param
);
1253 int (*SSL_get_verify_callback(const SSL
*s
)) (int, X509_STORE_CTX
*) {
1254 return (s
->verify_callback
);
1257 int SSL_CTX_get_verify_mode(const SSL_CTX
*ctx
)
1259 return (ctx
->verify_mode
);
1262 int SSL_CTX_get_verify_depth(const SSL_CTX
*ctx
)
1264 return X509_VERIFY_PARAM_get_depth(ctx
->param
);
1267 int (*SSL_CTX_get_verify_callback(const SSL_CTX
*ctx
)) (int, X509_STORE_CTX
*) {
1268 return (ctx
->default_verify_callback
);
1271 void SSL_set_verify(SSL
*s
, int mode
,
1272 int (*callback
) (int ok
, X509_STORE_CTX
*ctx
))
1274 s
->verify_mode
= mode
;
1275 if (callback
!= NULL
)
1276 s
->verify_callback
= callback
;
1279 void SSL_set_verify_depth(SSL
*s
, int depth
)
1281 X509_VERIFY_PARAM_set_depth(s
->param
, depth
);
1284 void SSL_set_read_ahead(SSL
*s
, int yes
)
1286 RECORD_LAYER_set_read_ahead(&s
->rlayer
, yes
);
1289 int SSL_get_read_ahead(const SSL
*s
)
1291 return RECORD_LAYER_get_read_ahead(&s
->rlayer
);
1294 int SSL_pending(const SSL
*s
)
1297 * SSL_pending cannot work properly if read-ahead is enabled
1298 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1299 * impossible to fix since SSL_pending cannot report errors that may be
1300 * observed while scanning the new data. (Note that SSL_pending() is
1301 * often used as a boolean value, so we'd better not return -1.)
1303 return (s
->method
->ssl_pending(s
));
1306 int SSL_has_pending(const SSL
*s
)
1309 * Similar to SSL_pending() but returns a 1 to indicate that we have
1310 * unprocessed data available or 0 otherwise (as opposed to the number of
1311 * bytes available). Unlike SSL_pending() this will take into account
1312 * read_ahead data. A 1 return simply indicates that we have unprocessed
1313 * data. That data may not result in any application data, or we may fail
1314 * to parse the records for some reason.
1319 return RECORD_LAYER_read_pending(&s
->rlayer
);
1322 X509
*SSL_get_peer_certificate(const SSL
*s
)
1326 if ((s
== NULL
) || (s
->session
== NULL
))
1329 r
= s
->session
->peer
;
1339 STACK_OF(X509
) *SSL_get_peer_cert_chain(const SSL
*s
)
1343 if ((s
== NULL
) || (s
->session
== NULL
))
1346 r
= s
->session
->peer_chain
;
1349 * If we are a client, cert_chain includes the peer's own certificate; if
1350 * we are a server, it does not.
1357 * Now in theory, since the calling process own 't' it should be safe to
1358 * modify. We need to be able to read f without being hassled
1360 int SSL_copy_session_id(SSL
*t
, const SSL
*f
)
1363 /* Do we need to to SSL locking? */
1364 if (!SSL_set_session(t
, SSL_get_session(f
))) {
1369 * what if we are setup for one protocol version but want to talk another
1371 if (t
->method
!= f
->method
) {
1372 t
->method
->ssl_free(t
);
1373 t
->method
= f
->method
;
1374 if (t
->method
->ssl_new(t
) == 0)
1378 CRYPTO_atomic_add(&f
->cert
->references
, 1, &i
, f
->cert
->lock
);
1379 ssl_cert_free(t
->cert
);
1381 if (!SSL_set_session_id_context(t
, f
->sid_ctx
, f
->sid_ctx_length
)) {
1388 /* Fix this so it checks all the valid key/cert options */
1389 int SSL_CTX_check_private_key(const SSL_CTX
*ctx
)
1391 if ((ctx
== NULL
) || (ctx
->cert
->key
->x509
== NULL
)) {
1392 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY
, SSL_R_NO_CERTIFICATE_ASSIGNED
);
1395 if (ctx
->cert
->key
->privatekey
== NULL
) {
1396 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY
, SSL_R_NO_PRIVATE_KEY_ASSIGNED
);
1399 return (X509_check_private_key
1400 (ctx
->cert
->key
->x509
, ctx
->cert
->key
->privatekey
));
1403 /* Fix this function so that it takes an optional type parameter */
1404 int SSL_check_private_key(const SSL
*ssl
)
1407 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY
, ERR_R_PASSED_NULL_PARAMETER
);
1410 if (ssl
->cert
->key
->x509
== NULL
) {
1411 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY
, SSL_R_NO_CERTIFICATE_ASSIGNED
);
1414 if (ssl
->cert
->key
->privatekey
== NULL
) {
1415 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY
, SSL_R_NO_PRIVATE_KEY_ASSIGNED
);
1418 return (X509_check_private_key(ssl
->cert
->key
->x509
,
1419 ssl
->cert
->key
->privatekey
));
1422 int SSL_waiting_for_async(SSL
*s
)
1430 int SSL_get_all_async_fds(SSL
*s
, OSSL_ASYNC_FD
*fds
, size_t *numfds
)
1432 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1436 return ASYNC_WAIT_CTX_get_all_fds(ctx
, fds
, numfds
);
1439 int SSL_get_changed_async_fds(SSL
*s
, OSSL_ASYNC_FD
*addfd
, size_t *numaddfds
,
1440 OSSL_ASYNC_FD
*delfd
, size_t *numdelfds
)
1442 ASYNC_WAIT_CTX
*ctx
= s
->waitctx
;
1446 return ASYNC_WAIT_CTX_get_changed_fds(ctx
, addfd
, numaddfds
, delfd
,
1450 int SSL_accept(SSL
*s
)
1452 if (s
->handshake_func
== NULL
) {
1453 /* Not properly initialized yet */
1454 SSL_set_accept_state(s
);
1457 return SSL_do_handshake(s
);
1460 int SSL_connect(SSL
*s
)
1462 if (s
->handshake_func
== NULL
) {
1463 /* Not properly initialized yet */
1464 SSL_set_connect_state(s
);
1467 return SSL_do_handshake(s
);
1470 long SSL_get_default_timeout(const SSL
*s
)
1472 return (s
->method
->get_timeout());
1475 static int ssl_start_async_job(SSL
*s
, struct ssl_async_args
*args
,
1476 int (*func
) (void *))
1479 if (s
->waitctx
== NULL
) {
1480 s
->waitctx
= ASYNC_WAIT_CTX_new();
1481 if (s
->waitctx
== NULL
)
1484 switch (ASYNC_start_job(&s
->job
, s
->waitctx
, &ret
, func
, args
,
1485 sizeof(struct ssl_async_args
))) {
1487 s
->rwstate
= SSL_NOTHING
;
1488 SSLerr(SSL_F_SSL_START_ASYNC_JOB
, SSL_R_FAILED_TO_INIT_ASYNC
);
1491 s
->rwstate
= SSL_ASYNC_PAUSED
;
1494 s
->rwstate
= SSL_ASYNC_NO_JOBS
;
1500 s
->rwstate
= SSL_NOTHING
;
1501 SSLerr(SSL_F_SSL_START_ASYNC_JOB
, ERR_R_INTERNAL_ERROR
);
1502 /* Shouldn't happen */
1507 static int ssl_io_intern(void *vargs
)
1509 struct ssl_async_args
*args
;
1514 args
= (struct ssl_async_args
*)vargs
;
1518 switch (args
->type
) {
1520 return args
->f
.func_read(s
, buf
, num
, &s
->asyncrw
);
1522 return args
->f
.func_write(s
, buf
, num
, &s
->asyncrw
);
1524 return args
->f
.func_other(s
);
1529 int SSL_read(SSL
*s
, void *buf
, int num
)
1535 SSLerr(SSL_F_SSL_READ
, SSL_R_BAD_LENGTH
);
1539 ret
= SSL_read_ex(s
, buf
, (size_t)num
, &read
);
1542 * The cast is safe here because ret should be <= INT_MAX because num is
1551 int SSL_read_ex(SSL
*s
, void *buf
, size_t num
, size_t *read
)
1553 if (s
->handshake_func
== NULL
) {
1554 SSLerr(SSL_F_SSL_READ_EX
, SSL_R_UNINITIALIZED
);
1558 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1559 s
->rwstate
= SSL_NOTHING
;
1563 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1564 struct ssl_async_args args
;
1570 args
.type
= READFUNC
;
1571 args
.f
.func_read
= s
->method
->ssl_read
;
1573 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
1577 return s
->method
->ssl_read(s
, buf
, num
, read
);
1581 int SSL_peek(SSL
*s
, void *buf
, int num
)
1587 SSLerr(SSL_F_SSL_PEEK
, SSL_R_BAD_LENGTH
);
1591 ret
= SSL_peek_ex(s
, buf
, (size_t)num
, &read
);
1594 * The cast is safe here because ret should be <= INT_MAX because num is
1603 int SSL_peek_ex(SSL
*s
, void *buf
, size_t num
, size_t *read
)
1605 if (s
->handshake_func
== NULL
) {
1606 SSLerr(SSL_F_SSL_PEEK_EX
, SSL_R_UNINITIALIZED
);
1610 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1613 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1614 struct ssl_async_args args
;
1620 args
.type
= READFUNC
;
1621 args
.f
.func_read
= s
->method
->ssl_peek
;
1623 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
1627 return s
->method
->ssl_peek(s
, buf
, num
, read
);
1631 int SSL_write(SSL
*s
, const void *buf
, int num
)
1637 SSLerr(SSL_F_SSL_WRITE
, SSL_R_BAD_LENGTH
);
1641 ret
= SSL_write_ex(s
, buf
, (size_t)num
, &written
);
1644 * The cast is safe here because ret should be <= INT_MAX because num is
1653 int SSL_write_ex(SSL
*s
, const void *buf
, size_t num
, size_t *written
)
1655 if (s
->handshake_func
== NULL
) {
1656 SSLerr(SSL_F_SSL_WRITE_EX
, SSL_R_UNINITIALIZED
);
1660 if (s
->shutdown
& SSL_SENT_SHUTDOWN
) {
1661 s
->rwstate
= SSL_NOTHING
;
1662 SSLerr(SSL_F_SSL_WRITE_EX
, SSL_R_PROTOCOL_IS_SHUTDOWN
);
1666 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1668 struct ssl_async_args args
;
1671 args
.buf
= (void *)buf
;
1673 args
.type
= WRITEFUNC
;
1674 args
.f
.func_write
= s
->method
->ssl_write
;
1676 ret
= ssl_start_async_job(s
, &args
, ssl_io_intern
);
1677 *written
= s
->asyncrw
;
1680 return s
->method
->ssl_write(s
, buf
, num
, written
);
1684 int SSL_shutdown(SSL
*s
)
1687 * Note that this function behaves differently from what one might
1688 * expect. Return values are 0 for no success (yet), 1 for success; but
1689 * calling it once is usually not enough, even if blocking I/O is used
1690 * (see ssl3_shutdown).
1693 if (s
->handshake_func
== NULL
) {
1694 SSLerr(SSL_F_SSL_SHUTDOWN
, SSL_R_UNINITIALIZED
);
1698 if (!SSL_in_init(s
)) {
1699 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1700 struct ssl_async_args args
;
1703 args
.type
= OTHERFUNC
;
1704 args
.f
.func_other
= s
->method
->ssl_shutdown
;
1706 return ssl_start_async_job(s
, &args
, ssl_io_intern
);
1708 return s
->method
->ssl_shutdown(s
);
1711 SSLerr(SSL_F_SSL_SHUTDOWN
, SSL_R_SHUTDOWN_WHILE_IN_INIT
);
1716 int SSL_renegotiate(SSL
*s
)
1718 if (s
->renegotiate
== 0)
1723 return (s
->method
->ssl_renegotiate(s
));
1726 int SSL_renegotiate_abbreviated(SSL
*s
)
1728 if (s
->renegotiate
== 0)
1733 return (s
->method
->ssl_renegotiate(s
));
1736 int SSL_renegotiate_pending(SSL
*s
)
1739 * becomes true when negotiation is requested; false again once a
1740 * handshake has finished
1742 return (s
->renegotiate
!= 0);
1745 long SSL_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
)
1750 case SSL_CTRL_GET_READ_AHEAD
:
1751 return (RECORD_LAYER_get_read_ahead(&s
->rlayer
));
1752 case SSL_CTRL_SET_READ_AHEAD
:
1753 l
= RECORD_LAYER_get_read_ahead(&s
->rlayer
);
1754 RECORD_LAYER_set_read_ahead(&s
->rlayer
, larg
);
1757 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
1758 s
->msg_callback_arg
= parg
;
1762 return (s
->mode
|= larg
);
1763 case SSL_CTRL_CLEAR_MODE
:
1764 return (s
->mode
&= ~larg
);
1765 case SSL_CTRL_GET_MAX_CERT_LIST
:
1766 return (s
->max_cert_list
);
1767 case SSL_CTRL_SET_MAX_CERT_LIST
:
1768 l
= s
->max_cert_list
;
1769 s
->max_cert_list
= larg
;
1771 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
1772 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
1774 s
->max_send_fragment
= larg
;
1775 if (s
->max_send_fragment
< s
->split_send_fragment
)
1776 s
->split_send_fragment
= s
->max_send_fragment
;
1778 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
1779 if ((size_t)larg
> s
->max_send_fragment
|| larg
== 0)
1781 s
->split_send_fragment
= larg
;
1783 case SSL_CTRL_SET_MAX_PIPELINES
:
1784 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
1786 s
->max_pipelines
= larg
;
1788 RECORD_LAYER_set_read_ahead(&s
->rlayer
, 1);
1790 case SSL_CTRL_GET_RI_SUPPORT
:
1792 return s
->s3
->send_connection_binding
;
1795 case SSL_CTRL_CERT_FLAGS
:
1796 return (s
->cert
->cert_flags
|= larg
);
1797 case SSL_CTRL_CLEAR_CERT_FLAGS
:
1798 return (s
->cert
->cert_flags
&= ~larg
);
1800 case SSL_CTRL_GET_RAW_CIPHERLIST
:
1802 if (s
->s3
->tmp
.ciphers_raw
== NULL
)
1804 *(unsigned char **)parg
= s
->s3
->tmp
.ciphers_raw
;
1805 return (int)s
->s3
->tmp
.ciphers_rawlen
;
1807 return TLS_CIPHER_LEN
;
1809 case SSL_CTRL_GET_EXTMS_SUPPORT
:
1810 if (!s
->session
|| SSL_in_init(s
) || ossl_statem_get_in_handshake(s
))
1812 if (s
->session
->flags
& SSL_SESS_FLAG_EXTMS
)
1816 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
1817 return ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
1818 &s
->min_proto_version
);
1819 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
1820 return ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
1821 &s
->max_proto_version
);
1823 return (s
->method
->ssl_ctrl(s
, cmd
, larg
, parg
));
1827 long SSL_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void))
1830 case SSL_CTRL_SET_MSG_CALLBACK
:
1831 s
->msg_callback
= (void (*)
1832 (int write_p
, int version
, int content_type
,
1833 const void *buf
, size_t len
, SSL
*ssl
,
1838 return (s
->method
->ssl_callback_ctrl(s
, cmd
, fp
));
1842 LHASH_OF(SSL_SESSION
) *SSL_CTX_sessions(SSL_CTX
*ctx
)
1844 return ctx
->sessions
;
1847 long SSL_CTX_ctrl(SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
)
1850 /* For some cases with ctx == NULL perform syntax checks */
1853 #ifndef OPENSSL_NO_EC
1854 case SSL_CTRL_SET_CURVES_LIST
:
1855 return tls1_set_curves_list(NULL
, NULL
, parg
);
1857 case SSL_CTRL_SET_SIGALGS_LIST
:
1858 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST
:
1859 return tls1_set_sigalgs_list(NULL
, parg
, 0);
1866 case SSL_CTRL_GET_READ_AHEAD
:
1867 return (ctx
->read_ahead
);
1868 case SSL_CTRL_SET_READ_AHEAD
:
1869 l
= ctx
->read_ahead
;
1870 ctx
->read_ahead
= larg
;
1873 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
1874 ctx
->msg_callback_arg
= parg
;
1877 case SSL_CTRL_GET_MAX_CERT_LIST
:
1878 return (ctx
->max_cert_list
);
1879 case SSL_CTRL_SET_MAX_CERT_LIST
:
1880 l
= ctx
->max_cert_list
;
1881 ctx
->max_cert_list
= larg
;
1884 case SSL_CTRL_SET_SESS_CACHE_SIZE
:
1885 l
= ctx
->session_cache_size
;
1886 ctx
->session_cache_size
= larg
;
1888 case SSL_CTRL_GET_SESS_CACHE_SIZE
:
1889 return (ctx
->session_cache_size
);
1890 case SSL_CTRL_SET_SESS_CACHE_MODE
:
1891 l
= ctx
->session_cache_mode
;
1892 ctx
->session_cache_mode
= larg
;
1894 case SSL_CTRL_GET_SESS_CACHE_MODE
:
1895 return (ctx
->session_cache_mode
);
1897 case SSL_CTRL_SESS_NUMBER
:
1898 return (lh_SSL_SESSION_num_items(ctx
->sessions
));
1899 case SSL_CTRL_SESS_CONNECT
:
1900 return (ctx
->stats
.sess_connect
);
1901 case SSL_CTRL_SESS_CONNECT_GOOD
:
1902 return (ctx
->stats
.sess_connect_good
);
1903 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE
:
1904 return (ctx
->stats
.sess_connect_renegotiate
);
1905 case SSL_CTRL_SESS_ACCEPT
:
1906 return (ctx
->stats
.sess_accept
);
1907 case SSL_CTRL_SESS_ACCEPT_GOOD
:
1908 return (ctx
->stats
.sess_accept_good
);
1909 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE
:
1910 return (ctx
->stats
.sess_accept_renegotiate
);
1911 case SSL_CTRL_SESS_HIT
:
1912 return (ctx
->stats
.sess_hit
);
1913 case SSL_CTRL_SESS_CB_HIT
:
1914 return (ctx
->stats
.sess_cb_hit
);
1915 case SSL_CTRL_SESS_MISSES
:
1916 return (ctx
->stats
.sess_miss
);
1917 case SSL_CTRL_SESS_TIMEOUTS
:
1918 return (ctx
->stats
.sess_timeout
);
1919 case SSL_CTRL_SESS_CACHE_FULL
:
1920 return (ctx
->stats
.sess_cache_full
);
1922 return (ctx
->mode
|= larg
);
1923 case SSL_CTRL_CLEAR_MODE
:
1924 return (ctx
->mode
&= ~larg
);
1925 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
1926 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
1928 ctx
->max_send_fragment
= larg
;
1929 if (ctx
->max_send_fragment
< ctx
->split_send_fragment
)
1930 ctx
->split_send_fragment
= ctx
->max_send_fragment
;
1932 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
1933 if ((size_t)larg
> ctx
->max_send_fragment
|| larg
== 0)
1935 ctx
->split_send_fragment
= larg
;
1937 case SSL_CTRL_SET_MAX_PIPELINES
:
1938 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
1940 ctx
->max_pipelines
= larg
;
1942 case SSL_CTRL_CERT_FLAGS
:
1943 return (ctx
->cert
->cert_flags
|= larg
);
1944 case SSL_CTRL_CLEAR_CERT_FLAGS
:
1945 return (ctx
->cert
->cert_flags
&= ~larg
);
1946 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
1947 return ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
1948 &ctx
->min_proto_version
);
1949 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
1950 return ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
1951 &ctx
->max_proto_version
);
1953 return (ctx
->method
->ssl_ctx_ctrl(ctx
, cmd
, larg
, parg
));
1957 long SSL_CTX_callback_ctrl(SSL_CTX
*ctx
, int cmd
, void (*fp
) (void))
1960 case SSL_CTRL_SET_MSG_CALLBACK
:
1961 ctx
->msg_callback
= (void (*)
1962 (int write_p
, int version
, int content_type
,
1963 const void *buf
, size_t len
, SSL
*ssl
,
1968 return (ctx
->method
->ssl_ctx_callback_ctrl(ctx
, cmd
, fp
));
1972 int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
)
1981 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
1982 const SSL_CIPHER
*const *bp
)
1984 if ((*ap
)->id
> (*bp
)->id
)
1986 if ((*ap
)->id
< (*bp
)->id
)
1991 /** return a STACK of the ciphers available for the SSL and in order of
1993 STACK_OF(SSL_CIPHER
) *SSL_get_ciphers(const SSL
*s
)
1996 if (s
->cipher_list
!= NULL
) {
1997 return (s
->cipher_list
);
1998 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list
!= NULL
)) {
1999 return (s
->ctx
->cipher_list
);
2005 STACK_OF(SSL_CIPHER
) *SSL_get_client_ciphers(const SSL
*s
)
2007 if ((s
== NULL
) || (s
->session
== NULL
) || !s
->server
)
2009 return s
->session
->ciphers
;
2012 STACK_OF(SSL_CIPHER
) *SSL_get1_supported_ciphers(SSL
*s
)
2014 STACK_OF(SSL_CIPHER
) *sk
= NULL
, *ciphers
;
2016 ciphers
= SSL_get_ciphers(s
);
2019 ssl_set_client_disabled(s
);
2020 for (i
= 0; i
< sk_SSL_CIPHER_num(ciphers
); i
++) {
2021 const SSL_CIPHER
*c
= sk_SSL_CIPHER_value(ciphers
, i
);
2022 if (!ssl_cipher_disabled(s
, c
, SSL_SECOP_CIPHER_SUPPORTED
)) {
2024 sk
= sk_SSL_CIPHER_new_null();
2027 if (!sk_SSL_CIPHER_push(sk
, c
)) {
2028 sk_SSL_CIPHER_free(sk
);
2036 /** return a STACK of the ciphers available for the SSL and in order of
2038 STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
)
2041 if (s
->cipher_list_by_id
!= NULL
) {
2042 return (s
->cipher_list_by_id
);
2043 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list_by_id
!= NULL
)) {
2044 return (s
->ctx
->cipher_list_by_id
);
2050 /** The old interface to get the same thing as SSL_get_ciphers() */
2051 const char *SSL_get_cipher_list(const SSL
*s
, int n
)
2053 const SSL_CIPHER
*c
;
2054 STACK_OF(SSL_CIPHER
) *sk
;
2058 sk
= SSL_get_ciphers(s
);
2059 if ((sk
== NULL
) || (sk_SSL_CIPHER_num(sk
) <= n
))
2061 c
= sk_SSL_CIPHER_value(sk
, n
);
2067 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2069 STACK_OF(SSL_CIPHER
) *SSL_CTX_get_ciphers(const SSL_CTX
*ctx
)
2072 return ctx
->cipher_list
;
2076 /** specify the ciphers to be used by default by the SSL_CTX */
2077 int SSL_CTX_set_cipher_list(SSL_CTX
*ctx
, const char *str
)
2079 STACK_OF(SSL_CIPHER
) *sk
;
2081 sk
= ssl_create_cipher_list(ctx
->method
, &ctx
->cipher_list
,
2082 &ctx
->cipher_list_by_id
, str
, ctx
->cert
);
2084 * ssl_create_cipher_list may return an empty stack if it was unable to
2085 * find a cipher matching the given rule string (for example if the rule
2086 * string specifies a cipher which has been disabled). This is not an
2087 * error as far as ssl_create_cipher_list is concerned, and hence
2088 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2092 else if (sk_SSL_CIPHER_num(sk
) == 0) {
2093 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST
, SSL_R_NO_CIPHER_MATCH
);
2099 /** specify the ciphers to be used by the SSL */
2100 int SSL_set_cipher_list(SSL
*s
, const char *str
)
2102 STACK_OF(SSL_CIPHER
) *sk
;
2104 sk
= ssl_create_cipher_list(s
->ctx
->method
, &s
->cipher_list
,
2105 &s
->cipher_list_by_id
, str
, s
->cert
);
2106 /* see comment in SSL_CTX_set_cipher_list */
2109 else if (sk_SSL_CIPHER_num(sk
) == 0) {
2110 SSLerr(SSL_F_SSL_SET_CIPHER_LIST
, SSL_R_NO_CIPHER_MATCH
);
2116 char *SSL_get_shared_ciphers(const SSL
*s
, char *buf
, int len
)
2119 STACK_OF(SSL_CIPHER
) *sk
;
2120 const SSL_CIPHER
*c
;
2123 if ((s
->session
== NULL
) || (s
->session
->ciphers
== NULL
) || (len
< 2))
2127 sk
= s
->session
->ciphers
;
2129 if (sk_SSL_CIPHER_num(sk
) == 0)
2132 for (i
= 0; i
< sk_SSL_CIPHER_num(sk
); i
++) {
2135 c
= sk_SSL_CIPHER_value(sk
, i
);
2136 n
= strlen(c
->name
);
2143 memcpy(p
, c
->name
, n
+ 1);
2152 /** return a servername extension value if provided in Client Hello, or NULL.
2153 * So far, only host_name types are defined (RFC 3546).
2156 const char *SSL_get_servername(const SSL
*s
, const int type
)
2158 if (type
!= TLSEXT_NAMETYPE_host_name
)
2161 return s
->session
&& !s
->tlsext_hostname
?
2162 s
->session
->tlsext_hostname
: s
->tlsext_hostname
;
2165 int SSL_get_servername_type(const SSL
*s
)
2168 && (!s
->tlsext_hostname
? s
->session
->
2169 tlsext_hostname
: s
->tlsext_hostname
))
2170 return TLSEXT_NAMETYPE_host_name
;
2175 * SSL_select_next_proto implements the standard protocol selection. It is
2176 * expected that this function is called from the callback set by
2177 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2178 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2179 * not included in the length. A byte string of length 0 is invalid. No byte
2180 * string may be truncated. The current, but experimental algorithm for
2181 * selecting the protocol is: 1) If the server doesn't support NPN then this
2182 * is indicated to the callback. In this case, the client application has to
2183 * abort the connection or have a default application level protocol. 2) If
2184 * the server supports NPN, but advertises an empty list then the client
2185 * selects the first protocol in its list, but indicates via the API that this
2186 * fallback case was enacted. 3) Otherwise, the client finds the first
2187 * protocol in the server's list that it supports and selects this protocol.
2188 * This is because it's assumed that the server has better information about
2189 * which protocol a client should use. 4) If the client doesn't support any
2190 * of the server's advertised protocols, then this is treated the same as
2191 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2192 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2194 int SSL_select_next_proto(unsigned char **out
, unsigned char *outlen
,
2195 const unsigned char *server
,
2196 unsigned int server_len
,
2197 const unsigned char *client
, unsigned int client_len
)
2200 const unsigned char *result
;
2201 int status
= OPENSSL_NPN_UNSUPPORTED
;
2204 * For each protocol in server preference order, see if we support it.
2206 for (i
= 0; i
< server_len
;) {
2207 for (j
= 0; j
< client_len
;) {
2208 if (server
[i
] == client
[j
] &&
2209 memcmp(&server
[i
+ 1], &client
[j
+ 1], server
[i
]) == 0) {
2210 /* We found a match */
2211 result
= &server
[i
];
2212 status
= OPENSSL_NPN_NEGOTIATED
;
2222 /* There's no overlap between our protocols and the server's list. */
2224 status
= OPENSSL_NPN_NO_OVERLAP
;
2227 *out
= (unsigned char *)result
+ 1;
2228 *outlen
= result
[0];
2232 #ifndef OPENSSL_NO_NEXTPROTONEG
2234 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2235 * client's requested protocol for this connection and returns 0. If the
2236 * client didn't request any protocol, then *data is set to NULL. Note that
2237 * the client can request any protocol it chooses. The value returned from
2238 * this function need not be a member of the list of supported protocols
2239 * provided by the callback.
2241 void SSL_get0_next_proto_negotiated(const SSL
*s
, const unsigned char **data
,
2244 *data
= s
->next_proto_negotiated
;
2248 *len
= s
->next_proto_negotiated_len
;
2253 * SSL_CTX_set_next_protos_advertised_cb sets a callback that is called when
2254 * a TLS server needs a list of supported protocols for Next Protocol
2255 * Negotiation. The returned list must be in wire format. The list is
2256 * returned by setting |out| to point to it and |outlen| to its length. This
2257 * memory will not be modified, but one should assume that the SSL* keeps a
2258 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2259 * wishes to advertise. Otherwise, no such extension will be included in the
2262 void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX
*ctx
,
2263 int (*cb
) (SSL
*ssl
,
2266 unsigned int *outlen
,
2267 void *arg
), void *arg
)
2269 ctx
->next_protos_advertised_cb
= cb
;
2270 ctx
->next_protos_advertised_cb_arg
= arg
;
2274 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2275 * client needs to select a protocol from the server's provided list. |out|
2276 * must be set to point to the selected protocol (which may be within |in|).
2277 * The length of the protocol name must be written into |outlen|. The
2278 * server's advertised protocols are provided in |in| and |inlen|. The
2279 * callback can assume that |in| is syntactically valid. The client must
2280 * select a protocol. It is fatal to the connection if this callback returns
2281 * a value other than SSL_TLSEXT_ERR_OK.
2283 void SSL_CTX_set_next_proto_select_cb(SSL_CTX
*ctx
,
2284 int (*cb
) (SSL
*s
, unsigned char **out
,
2285 unsigned char *outlen
,
2286 const unsigned char *in
,
2288 void *arg
), void *arg
)
2290 ctx
->next_proto_select_cb
= cb
;
2291 ctx
->next_proto_select_cb_arg
= arg
;
2296 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2297 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2298 * length-prefixed strings). Returns 0 on success.
2300 int SSL_CTX_set_alpn_protos(SSL_CTX
*ctx
, const unsigned char *protos
,
2301 unsigned int protos_len
)
2303 OPENSSL_free(ctx
->alpn_client_proto_list
);
2304 ctx
->alpn_client_proto_list
= OPENSSL_memdup(protos
, protos_len
);
2305 if (ctx
->alpn_client_proto_list
== NULL
) {
2306 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS
, ERR_R_MALLOC_FAILURE
);
2309 ctx
->alpn_client_proto_list_len
= protos_len
;
2315 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2316 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2317 * length-prefixed strings). Returns 0 on success.
2319 int SSL_set_alpn_protos(SSL
*ssl
, const unsigned char *protos
,
2320 unsigned int protos_len
)
2322 OPENSSL_free(ssl
->alpn_client_proto_list
);
2323 ssl
->alpn_client_proto_list
= OPENSSL_memdup(protos
, protos_len
);
2324 if (ssl
->alpn_client_proto_list
== NULL
) {
2325 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS
, ERR_R_MALLOC_FAILURE
);
2328 ssl
->alpn_client_proto_list_len
= protos_len
;
2334 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2335 * called during ClientHello processing in order to select an ALPN protocol
2336 * from the client's list of offered protocols.
2338 void SSL_CTX_set_alpn_select_cb(SSL_CTX
*ctx
,
2339 int (*cb
) (SSL
*ssl
,
2340 const unsigned char **out
,
2341 unsigned char *outlen
,
2342 const unsigned char *in
,
2344 void *arg
), void *arg
)
2346 ctx
->alpn_select_cb
= cb
;
2347 ctx
->alpn_select_cb_arg
= arg
;
2351 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2352 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2353 * (not including the leading length-prefix byte). If the server didn't
2354 * respond with a negotiated protocol then |*len| will be zero.
2356 void SSL_get0_alpn_selected(const SSL
*ssl
, const unsigned char **data
,
2361 *data
= ssl
->s3
->alpn_selected
;
2365 *len
= ssl
->s3
->alpn_selected_len
;
2368 int SSL_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2369 const char *label
, size_t llen
,
2370 const unsigned char *p
, size_t plen
,
2373 if (s
->version
< TLS1_VERSION
&& s
->version
!= DTLS1_BAD_VER
)
2376 return s
->method
->ssl3_enc
->export_keying_material(s
, out
, olen
, label
,
2381 static unsigned long ssl_session_hash(const SSL_SESSION
*a
)
2386 ((unsigned int)a
->session_id
[0]) |
2387 ((unsigned int)a
->session_id
[1] << 8L) |
2388 ((unsigned long)a
->session_id
[2] << 16L) |
2389 ((unsigned long)a
->session_id
[3] << 24L);
2394 * NB: If this function (or indeed the hash function which uses a sort of
2395 * coarser function than this one) is changed, ensure
2396 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2397 * being able to construct an SSL_SESSION that will collide with any existing
2398 * session with a matching session ID.
2400 static int ssl_session_cmp(const SSL_SESSION
*a
, const SSL_SESSION
*b
)
2402 if (a
->ssl_version
!= b
->ssl_version
)
2404 if (a
->session_id_length
!= b
->session_id_length
)
2406 return (memcmp(a
->session_id
, b
->session_id
, a
->session_id_length
));
2410 * These wrapper functions should remain rather than redeclaring
2411 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2412 * variable. The reason is that the functions aren't static, they're exposed
2416 SSL_CTX
*SSL_CTX_new(const SSL_METHOD
*meth
)
2418 SSL_CTX
*ret
= NULL
;
2421 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_NULL_SSL_METHOD_PASSED
);
2425 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS
, NULL
))
2428 if (FIPS_mode() && (meth
->version
< TLS1_VERSION
)) {
2429 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE
);
2433 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2434 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS
);
2437 ret
= OPENSSL_zalloc(sizeof(*ret
));
2442 ret
->min_proto_version
= 0;
2443 ret
->max_proto_version
= 0;
2444 ret
->session_cache_mode
= SSL_SESS_CACHE_SERVER
;
2445 ret
->session_cache_size
= SSL_SESSION_CACHE_MAX_SIZE_DEFAULT
;
2446 /* We take the system default. */
2447 ret
->session_timeout
= meth
->get_timeout();
2448 ret
->references
= 1;
2449 ret
->lock
= CRYPTO_THREAD_lock_new();
2450 if (ret
->lock
== NULL
) {
2451 SSLerr(SSL_F_SSL_CTX_NEW
, ERR_R_MALLOC_FAILURE
);
2455 ret
->max_cert_list
= SSL_MAX_CERT_LIST_DEFAULT
;
2456 ret
->verify_mode
= SSL_VERIFY_NONE
;
2457 if ((ret
->cert
= ssl_cert_new()) == NULL
)
2460 ret
->sessions
= lh_SSL_SESSION_new(ssl_session_hash
, ssl_session_cmp
);
2461 if (ret
->sessions
== NULL
)
2463 ret
->cert_store
= X509_STORE_new();
2464 if (ret
->cert_store
== NULL
)
2466 #ifndef OPENSSL_NO_CT
2467 ret
->ctlog_store
= CTLOG_STORE_new();
2468 if (ret
->ctlog_store
== NULL
)
2471 if (!ssl_create_cipher_list(ret
->method
,
2472 &ret
->cipher_list
, &ret
->cipher_list_by_id
,
2473 SSL_DEFAULT_CIPHER_LIST
, ret
->cert
)
2474 || sk_SSL_CIPHER_num(ret
->cipher_list
) <= 0) {
2475 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_LIBRARY_HAS_NO_CIPHERS
);
2479 ret
->param
= X509_VERIFY_PARAM_new();
2480 if (ret
->param
== NULL
)
2483 if ((ret
->md5
= EVP_get_digestbyname("ssl3-md5")) == NULL
) {
2484 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES
);
2487 if ((ret
->sha1
= EVP_get_digestbyname("ssl3-sha1")) == NULL
) {
2488 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES
);
2492 if ((ret
->client_CA
= sk_X509_NAME_new_null()) == NULL
)
2495 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, ret
, &ret
->ex_data
))
2498 /* No compression for DTLS */
2499 if (!(meth
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_DTLS
))
2500 ret
->comp_methods
= SSL_COMP_get_compression_methods();
2502 ret
->max_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
2503 ret
->split_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
2505 /* Setup RFC5077 ticket keys */
2506 if ((RAND_bytes(ret
->tlsext_tick_key_name
,
2507 sizeof(ret
->tlsext_tick_key_name
)) <= 0)
2508 || (RAND_bytes(ret
->tlsext_tick_hmac_key
,
2509 sizeof(ret
->tlsext_tick_hmac_key
)) <= 0)
2510 || (RAND_bytes(ret
->tlsext_tick_aes_key
,
2511 sizeof(ret
->tlsext_tick_aes_key
)) <= 0))
2512 ret
->options
|= SSL_OP_NO_TICKET
;
2514 #ifndef OPENSSL_NO_SRP
2515 if (!SSL_CTX_SRP_CTX_init(ret
))
2518 #ifndef OPENSSL_NO_ENGINE
2519 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2520 # define eng_strx(x) #x
2521 # define eng_str(x) eng_strx(x)
2522 /* Use specific client engine automatically... ignore errors */
2525 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
2528 ENGINE_load_builtin_engines();
2529 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
2531 if (!eng
|| !SSL_CTX_set_client_cert_engine(ret
, eng
))
2537 * Default is to connect to non-RI servers. When RI is more widely
2538 * deployed might change this.
2540 ret
->options
|= SSL_OP_LEGACY_SERVER_CONNECT
;
2542 * Disable compression by default to prevent CRIME. Applications can
2543 * re-enable compression by configuring
2544 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2545 * or by using the SSL_CONF library.
2547 ret
->options
|= SSL_OP_NO_COMPRESSION
;
2549 ret
->tlsext_status_type
= -1;
2553 SSLerr(SSL_F_SSL_CTX_NEW
, ERR_R_MALLOC_FAILURE
);
2559 int SSL_CTX_up_ref(SSL_CTX
*ctx
)
2563 if (CRYPTO_atomic_add(&ctx
->references
, 1, &i
, ctx
->lock
) <= 0)
2566 REF_PRINT_COUNT("SSL_CTX", ctx
);
2567 REF_ASSERT_ISNT(i
< 2);
2568 return ((i
> 1) ? 1 : 0);
2571 void SSL_CTX_free(SSL_CTX
*a
)
2578 CRYPTO_atomic_add(&a
->references
, -1, &i
, a
->lock
);
2579 REF_PRINT_COUNT("SSL_CTX", a
);
2582 REF_ASSERT_ISNT(i
< 0);
2584 X509_VERIFY_PARAM_free(a
->param
);
2585 dane_ctx_final(&a
->dane
);
2588 * Free internal session cache. However: the remove_cb() may reference
2589 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2590 * after the sessions were flushed.
2591 * As the ex_data handling routines might also touch the session cache,
2592 * the most secure solution seems to be: empty (flush) the cache, then
2593 * free ex_data, then finally free the cache.
2594 * (See ticket [openssl.org #212].)
2596 if (a
->sessions
!= NULL
)
2597 SSL_CTX_flush_sessions(a
, 0);
2599 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, a
, &a
->ex_data
);
2600 lh_SSL_SESSION_free(a
->sessions
);
2601 X509_STORE_free(a
->cert_store
);
2602 #ifndef OPENSSL_NO_CT
2603 CTLOG_STORE_free(a
->ctlog_store
);
2605 sk_SSL_CIPHER_free(a
->cipher_list
);
2606 sk_SSL_CIPHER_free(a
->cipher_list_by_id
);
2607 ssl_cert_free(a
->cert
);
2608 sk_X509_NAME_pop_free(a
->client_CA
, X509_NAME_free
);
2609 sk_X509_pop_free(a
->extra_certs
, X509_free
);
2610 a
->comp_methods
= NULL
;
2611 #ifndef OPENSSL_NO_SRTP
2612 sk_SRTP_PROTECTION_PROFILE_free(a
->srtp_profiles
);
2614 #ifndef OPENSSL_NO_SRP
2615 SSL_CTX_SRP_CTX_free(a
);
2617 #ifndef OPENSSL_NO_ENGINE
2618 ENGINE_finish(a
->client_cert_engine
);
2621 #ifndef OPENSSL_NO_EC
2622 OPENSSL_free(a
->tlsext_ecpointformatlist
);
2623 OPENSSL_free(a
->tlsext_ellipticcurvelist
);
2625 OPENSSL_free(a
->alpn_client_proto_list
);
2627 CRYPTO_THREAD_lock_free(a
->lock
);
2632 void SSL_CTX_set_default_passwd_cb(SSL_CTX
*ctx
, pem_password_cb
*cb
)
2634 ctx
->default_passwd_callback
= cb
;
2637 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX
*ctx
, void *u
)
2639 ctx
->default_passwd_callback_userdata
= u
;
2642 pem_password_cb
*SSL_CTX_get_default_passwd_cb(SSL_CTX
*ctx
)
2644 return ctx
->default_passwd_callback
;
2647 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX
*ctx
)
2649 return ctx
->default_passwd_callback_userdata
;
2652 void SSL_set_default_passwd_cb(SSL
*s
, pem_password_cb
*cb
)
2654 s
->default_passwd_callback
= cb
;
2657 void SSL_set_default_passwd_cb_userdata(SSL
*s
, void *u
)
2659 s
->default_passwd_callback_userdata
= u
;
2662 pem_password_cb
*SSL_get_default_passwd_cb(SSL
*s
)
2664 return s
->default_passwd_callback
;
2667 void *SSL_get_default_passwd_cb_userdata(SSL
*s
)
2669 return s
->default_passwd_callback_userdata
;
2672 void SSL_CTX_set_cert_verify_callback(SSL_CTX
*ctx
,
2673 int (*cb
) (X509_STORE_CTX
*, void *),
2676 ctx
->app_verify_callback
= cb
;
2677 ctx
->app_verify_arg
= arg
;
2680 void SSL_CTX_set_verify(SSL_CTX
*ctx
, int mode
,
2681 int (*cb
) (int, X509_STORE_CTX
*))
2683 ctx
->verify_mode
= mode
;
2684 ctx
->default_verify_callback
= cb
;
2687 void SSL_CTX_set_verify_depth(SSL_CTX
*ctx
, int depth
)
2689 X509_VERIFY_PARAM_set_depth(ctx
->param
, depth
);
2692 void SSL_CTX_set_cert_cb(SSL_CTX
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
2694 ssl_cert_set_cert_cb(c
->cert
, cb
, arg
);
2697 void SSL_set_cert_cb(SSL
*s
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
2699 ssl_cert_set_cert_cb(s
->cert
, cb
, arg
);
2702 void ssl_set_masks(SSL
*s
)
2704 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_GOST)
2708 uint32_t *pvalid
= s
->s3
->tmp
.valid_flags
;
2709 int rsa_enc
, rsa_sign
, dh_tmp
, dsa_sign
;
2710 unsigned long mask_k
, mask_a
;
2711 #ifndef OPENSSL_NO_EC
2712 int have_ecc_cert
, ecdsa_ok
;
2718 #ifndef OPENSSL_NO_DH
2719 dh_tmp
= (c
->dh_tmp
!= NULL
|| c
->dh_tmp_cb
!= NULL
|| c
->dh_tmp_auto
);
2724 rsa_enc
= pvalid
[SSL_PKEY_RSA_ENC
] & CERT_PKEY_VALID
;
2725 rsa_sign
= pvalid
[SSL_PKEY_RSA_SIGN
] & CERT_PKEY_SIGN
;
2726 dsa_sign
= pvalid
[SSL_PKEY_DSA_SIGN
] & CERT_PKEY_SIGN
;
2727 #ifndef OPENSSL_NO_EC
2728 have_ecc_cert
= pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_VALID
;
2734 fprintf(stderr
, "dht=%d re=%d rs=%d ds=%d\n",
2735 dh_tmp
, rsa_enc
, rsa_sign
, dsa_sign
);
2738 #ifndef OPENSSL_NO_GOST
2739 cpk
= &(c
->pkeys
[SSL_PKEY_GOST12_512
]);
2740 if (cpk
->x509
!= NULL
&& cpk
->privatekey
!= NULL
) {
2741 mask_k
|= SSL_kGOST
;
2742 mask_a
|= SSL_aGOST12
;
2744 cpk
= &(c
->pkeys
[SSL_PKEY_GOST12_256
]);
2745 if (cpk
->x509
!= NULL
&& cpk
->privatekey
!= NULL
) {
2746 mask_k
|= SSL_kGOST
;
2747 mask_a
|= SSL_aGOST12
;
2749 cpk
= &(c
->pkeys
[SSL_PKEY_GOST01
]);
2750 if (cpk
->x509
!= NULL
&& cpk
->privatekey
!= NULL
) {
2751 mask_k
|= SSL_kGOST
;
2752 mask_a
|= SSL_aGOST01
;
2762 if (rsa_enc
|| rsa_sign
) {
2770 mask_a
|= SSL_aNULL
;
2773 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2774 * depending on the key usage extension.
2776 #ifndef OPENSSL_NO_EC
2777 if (have_ecc_cert
) {
2779 cpk
= &c
->pkeys
[SSL_PKEY_ECC
];
2781 ex_kusage
= X509_get_key_usage(x
);
2782 ecdsa_ok
= ex_kusage
& X509v3_KU_DIGITAL_SIGNATURE
;
2783 if (!(pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_SIGN
))
2786 mask_a
|= SSL_aECDSA
;
2790 #ifndef OPENSSL_NO_EC
2791 mask_k
|= SSL_kECDHE
;
2794 #ifndef OPENSSL_NO_PSK
2797 if (mask_k
& SSL_kRSA
)
2798 mask_k
|= SSL_kRSAPSK
;
2799 if (mask_k
& SSL_kDHE
)
2800 mask_k
|= SSL_kDHEPSK
;
2801 if (mask_k
& SSL_kECDHE
)
2802 mask_k
|= SSL_kECDHEPSK
;
2805 s
->s3
->tmp
.mask_k
= mask_k
;
2806 s
->s3
->tmp
.mask_a
= mask_a
;
2809 #ifndef OPENSSL_NO_EC
2811 int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
)
2813 if (s
->s3
->tmp
.new_cipher
->algorithm_auth
& SSL_aECDSA
) {
2814 /* key usage, if present, must allow signing */
2815 if (!(X509_get_key_usage(x
) & X509v3_KU_DIGITAL_SIGNATURE
)) {
2816 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG
,
2817 SSL_R_ECC_CERT_NOT_FOR_SIGNING
);
2821 return 1; /* all checks are ok */
2826 static int ssl_get_server_cert_index(const SSL
*s
)
2829 idx
= ssl_cipher_get_cert_index(s
->s3
->tmp
.new_cipher
);
2830 if (idx
== SSL_PKEY_RSA_ENC
&& !s
->cert
->pkeys
[SSL_PKEY_RSA_ENC
].x509
)
2831 idx
= SSL_PKEY_RSA_SIGN
;
2832 if (idx
== SSL_PKEY_GOST_EC
) {
2833 if (s
->cert
->pkeys
[SSL_PKEY_GOST12_512
].x509
)
2834 idx
= SSL_PKEY_GOST12_512
;
2835 else if (s
->cert
->pkeys
[SSL_PKEY_GOST12_256
].x509
)
2836 idx
= SSL_PKEY_GOST12_256
;
2837 else if (s
->cert
->pkeys
[SSL_PKEY_GOST01
].x509
)
2838 idx
= SSL_PKEY_GOST01
;
2843 SSLerr(SSL_F_SSL_GET_SERVER_CERT_INDEX
, ERR_R_INTERNAL_ERROR
);
2847 CERT_PKEY
*ssl_get_server_send_pkey(SSL
*s
)
2853 if (!s
->s3
|| !s
->s3
->tmp
.new_cipher
)
2857 i
= ssl_get_server_cert_index(s
);
2859 /* This may or may not be an error. */
2864 return &c
->pkeys
[i
];
2867 EVP_PKEY
*ssl_get_sign_pkey(SSL
*s
, const SSL_CIPHER
*cipher
,
2870 unsigned long alg_a
;
2874 alg_a
= cipher
->algorithm_auth
;
2877 if ((alg_a
& SSL_aDSS
) && (c
->pkeys
[SSL_PKEY_DSA_SIGN
].privatekey
!= NULL
))
2878 idx
= SSL_PKEY_DSA_SIGN
;
2879 else if (alg_a
& SSL_aRSA
) {
2880 if (c
->pkeys
[SSL_PKEY_RSA_SIGN
].privatekey
!= NULL
)
2881 idx
= SSL_PKEY_RSA_SIGN
;
2882 else if (c
->pkeys
[SSL_PKEY_RSA_ENC
].privatekey
!= NULL
)
2883 idx
= SSL_PKEY_RSA_ENC
;
2884 } else if ((alg_a
& SSL_aECDSA
) &&
2885 (c
->pkeys
[SSL_PKEY_ECC
].privatekey
!= NULL
))
2888 SSLerr(SSL_F_SSL_GET_SIGN_PKEY
, ERR_R_INTERNAL_ERROR
);
2892 *pmd
= s
->s3
->tmp
.md
[idx
];
2893 return c
->pkeys
[idx
].privatekey
;
2896 int ssl_get_server_cert_serverinfo(SSL
*s
, const unsigned char **serverinfo
,
2897 size_t *serverinfo_length
)
2901 *serverinfo_length
= 0;
2904 i
= ssl_get_server_cert_index(s
);
2908 if (c
->pkeys
[i
].serverinfo
== NULL
)
2911 *serverinfo
= c
->pkeys
[i
].serverinfo
;
2912 *serverinfo_length
= c
->pkeys
[i
].serverinfo_length
;
2916 void ssl_update_cache(SSL
*s
, int mode
)
2921 * If the session_id_length is 0, we are not supposed to cache it, and it
2922 * would be rather hard to do anyway :-)
2924 if (s
->session
->session_id_length
== 0)
2927 i
= s
->session_ctx
->session_cache_mode
;
2928 if ((i
& mode
) && (!s
->hit
)
2929 && ((i
& SSL_SESS_CACHE_NO_INTERNAL_STORE
)
2930 || SSL_CTX_add_session(s
->session_ctx
, s
->session
))
2931 && (s
->session_ctx
->new_session_cb
!= NULL
)) {
2932 SSL_SESSION_up_ref(s
->session
);
2933 if (!s
->session_ctx
->new_session_cb(s
, s
->session
))
2934 SSL_SESSION_free(s
->session
);
2937 /* auto flush every 255 connections */
2938 if ((!(i
& SSL_SESS_CACHE_NO_AUTO_CLEAR
)) && ((i
& mode
) == mode
)) {
2939 if ((((mode
& SSL_SESS_CACHE_CLIENT
)
2940 ? s
->session_ctx
->stats
.sess_connect_good
2941 : s
->session_ctx
->stats
.sess_accept_good
) & 0xff) == 0xff) {
2942 SSL_CTX_flush_sessions(s
->session_ctx
, (unsigned long)time(NULL
));
2947 const SSL_METHOD
*SSL_CTX_get_ssl_method(SSL_CTX
*ctx
)
2952 const SSL_METHOD
*SSL_get_ssl_method(SSL
*s
)
2957 int SSL_set_ssl_method(SSL
*s
, const SSL_METHOD
*meth
)
2961 if (s
->method
!= meth
) {
2962 const SSL_METHOD
*sm
= s
->method
;
2963 int (*hf
) (SSL
*) = s
->handshake_func
;
2965 if (sm
->version
== meth
->version
)
2970 ret
= s
->method
->ssl_new(s
);
2973 if (hf
== sm
->ssl_connect
)
2974 s
->handshake_func
= meth
->ssl_connect
;
2975 else if (hf
== sm
->ssl_accept
)
2976 s
->handshake_func
= meth
->ssl_accept
;
2981 int SSL_get_error(const SSL
*s
, int i
)
2988 return (SSL_ERROR_NONE
);
2991 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
2992 * where we do encode the error
2994 if ((l
= ERR_peek_error()) != 0) {
2995 if (ERR_GET_LIB(l
) == ERR_LIB_SYS
)
2996 return (SSL_ERROR_SYSCALL
);
2998 return (SSL_ERROR_SSL
);
3002 if (SSL_want_read(s
)) {
3003 bio
= SSL_get_rbio(s
);
3004 if (BIO_should_read(bio
))
3005 return (SSL_ERROR_WANT_READ
);
3006 else if (BIO_should_write(bio
))
3008 * This one doesn't make too much sense ... We never try to write
3009 * to the rbio, and an application program where rbio and wbio
3010 * are separate couldn't even know what it should wait for.
3011 * However if we ever set s->rwstate incorrectly (so that we have
3012 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3013 * wbio *are* the same, this test works around that bug; so it
3014 * might be safer to keep it.
3016 return (SSL_ERROR_WANT_WRITE
);
3017 else if (BIO_should_io_special(bio
)) {
3018 reason
= BIO_get_retry_reason(bio
);
3019 if (reason
== BIO_RR_CONNECT
)
3020 return (SSL_ERROR_WANT_CONNECT
);
3021 else if (reason
== BIO_RR_ACCEPT
)
3022 return (SSL_ERROR_WANT_ACCEPT
);
3024 return (SSL_ERROR_SYSCALL
); /* unknown */
3028 if (SSL_want_write(s
)) {
3030 * Access wbio directly - in order to use the buffered bio if
3034 if (BIO_should_write(bio
))
3035 return (SSL_ERROR_WANT_WRITE
);
3036 else if (BIO_should_read(bio
))
3038 * See above (SSL_want_read(s) with BIO_should_write(bio))
3040 return (SSL_ERROR_WANT_READ
);
3041 else if (BIO_should_io_special(bio
)) {
3042 reason
= BIO_get_retry_reason(bio
);
3043 if (reason
== BIO_RR_CONNECT
)
3044 return (SSL_ERROR_WANT_CONNECT
);
3045 else if (reason
== BIO_RR_ACCEPT
)
3046 return (SSL_ERROR_WANT_ACCEPT
);
3048 return (SSL_ERROR_SYSCALL
);
3051 if (SSL_want_x509_lookup(s
)) {
3052 return (SSL_ERROR_WANT_X509_LOOKUP
);
3054 if (SSL_want_async(s
)) {
3055 return SSL_ERROR_WANT_ASYNC
;
3057 if (SSL_want_async_job(s
)) {
3058 return SSL_ERROR_WANT_ASYNC_JOB
;
3063 if ((s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) &&
3064 (s
->s3
->warn_alert
== SSL_AD_CLOSE_NOTIFY
))
3065 return (SSL_ERROR_ZERO_RETURN
);
3067 return (SSL_ERROR_SYSCALL
);
3070 static int ssl_do_handshake_intern(void *vargs
)
3072 struct ssl_async_args
*args
;
3075 args
= (struct ssl_async_args
*)vargs
;
3078 return s
->handshake_func(s
);
3081 int SSL_do_handshake(SSL
*s
)
3085 if (s
->handshake_func
== NULL
) {
3086 SSLerr(SSL_F_SSL_DO_HANDSHAKE
, SSL_R_CONNECTION_TYPE_NOT_SET
);
3090 s
->method
->ssl_renegotiate_check(s
);
3092 if (SSL_in_init(s
) || SSL_in_before(s
)) {
3093 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
3094 struct ssl_async_args args
;
3098 ret
= ssl_start_async_job(s
, &args
, ssl_do_handshake_intern
);
3100 ret
= s
->handshake_func(s
);
3106 void SSL_set_accept_state(SSL
*s
)
3110 ossl_statem_clear(s
);
3111 s
->handshake_func
= s
->method
->ssl_accept
;
3115 void SSL_set_connect_state(SSL
*s
)
3119 ossl_statem_clear(s
);
3120 s
->handshake_func
= s
->method
->ssl_connect
;
3124 int ssl_undefined_function(SSL
*s
)
3126 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3130 int ssl_undefined_void_function(void)
3132 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION
,
3133 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3137 int ssl_undefined_const_function(const SSL
*s
)
3142 const SSL_METHOD
*ssl_bad_method(int ver
)
3144 SSLerr(SSL_F_SSL_BAD_METHOD
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3148 const char *ssl_protocol_to_string(int version
)
3152 case TLS1_3_VERSION
:
3155 case TLS1_2_VERSION
:
3158 case TLS1_1_VERSION
:
3173 case DTLS1_2_VERSION
:
3181 const char *SSL_get_version(const SSL
*s
)
3183 return ssl_protocol_to_string(s
->version
);
3186 SSL
*SSL_dup(SSL
*s
)
3188 STACK_OF(X509_NAME
) *sk
;
3193 /* If we're not quiescent, just up_ref! */
3194 if (!SSL_in_init(s
) || !SSL_in_before(s
)) {
3195 CRYPTO_atomic_add(&s
->references
, 1, &i
, s
->lock
);
3200 * Otherwise, copy configuration state, and session if set.
3202 if ((ret
= SSL_new(SSL_get_SSL_CTX(s
))) == NULL
)
3205 if (s
->session
!= NULL
) {
3207 * Arranges to share the same session via up_ref. This "copies"
3208 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3210 if (!SSL_copy_session_id(ret
, s
))
3214 * No session has been established yet, so we have to expect that
3215 * s->cert or ret->cert will be changed later -- they should not both
3216 * point to the same object, and thus we can't use
3217 * SSL_copy_session_id.
3219 if (!SSL_set_ssl_method(ret
, s
->method
))
3222 if (s
->cert
!= NULL
) {
3223 ssl_cert_free(ret
->cert
);
3224 ret
->cert
= ssl_cert_dup(s
->cert
);
3225 if (ret
->cert
== NULL
)
3229 if (!SSL_set_session_id_context(ret
, s
->sid_ctx
, s
->sid_ctx_length
))
3233 if (!ssl_dane_dup(ret
, s
))
3235 ret
->version
= s
->version
;
3236 ret
->options
= s
->options
;
3237 ret
->mode
= s
->mode
;
3238 SSL_set_max_cert_list(ret
, SSL_get_max_cert_list(s
));
3239 SSL_set_read_ahead(ret
, SSL_get_read_ahead(s
));
3240 ret
->msg_callback
= s
->msg_callback
;
3241 ret
->msg_callback_arg
= s
->msg_callback_arg
;
3242 SSL_set_verify(ret
, SSL_get_verify_mode(s
), SSL_get_verify_callback(s
));
3243 SSL_set_verify_depth(ret
, SSL_get_verify_depth(s
));
3244 ret
->generate_session_id
= s
->generate_session_id
;
3246 SSL_set_info_callback(ret
, SSL_get_info_callback(s
));
3248 /* copy app data, a little dangerous perhaps */
3249 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL
, &ret
->ex_data
, &s
->ex_data
))
3252 /* setup rbio, and wbio */
3253 if (s
->rbio
!= NULL
) {
3254 if (!BIO_dup_state(s
->rbio
, (char *)&ret
->rbio
))
3257 if (s
->wbio
!= NULL
) {
3258 if (s
->wbio
!= s
->rbio
) {
3259 if (!BIO_dup_state(s
->wbio
, (char *)&ret
->wbio
))
3262 BIO_up_ref(ret
->rbio
);
3263 ret
->wbio
= ret
->rbio
;
3267 ret
->server
= s
->server
;
3268 if (s
->handshake_func
) {
3270 SSL_set_accept_state(ret
);
3272 SSL_set_connect_state(ret
);
3274 ret
->shutdown
= s
->shutdown
;
3277 ret
->default_passwd_callback
= s
->default_passwd_callback
;
3278 ret
->default_passwd_callback_userdata
= s
->default_passwd_callback_userdata
;
3280 X509_VERIFY_PARAM_inherit(ret
->param
, s
->param
);
3282 /* dup the cipher_list and cipher_list_by_id stacks */
3283 if (s
->cipher_list
!= NULL
) {
3284 if ((ret
->cipher_list
= sk_SSL_CIPHER_dup(s
->cipher_list
)) == NULL
)
3287 if (s
->cipher_list_by_id
!= NULL
)
3288 if ((ret
->cipher_list_by_id
= sk_SSL_CIPHER_dup(s
->cipher_list_by_id
))
3292 /* Dup the client_CA list */
3293 if (s
->client_CA
!= NULL
) {
3294 if ((sk
= sk_X509_NAME_dup(s
->client_CA
)) == NULL
)
3296 ret
->client_CA
= sk
;
3297 for (i
= 0; i
< sk_X509_NAME_num(sk
); i
++) {
3298 xn
= sk_X509_NAME_value(sk
, i
);
3299 if (sk_X509_NAME_set(sk
, i
, X509_NAME_dup(xn
)) == NULL
) {
3312 void ssl_clear_cipher_ctx(SSL
*s
)
3314 if (s
->enc_read_ctx
!= NULL
) {
3315 EVP_CIPHER_CTX_free(s
->enc_read_ctx
);
3316 s
->enc_read_ctx
= NULL
;
3318 if (s
->enc_write_ctx
!= NULL
) {
3319 EVP_CIPHER_CTX_free(s
->enc_write_ctx
);
3320 s
->enc_write_ctx
= NULL
;
3322 #ifndef OPENSSL_NO_COMP
3323 COMP_CTX_free(s
->expand
);
3325 COMP_CTX_free(s
->compress
);
3330 X509
*SSL_get_certificate(const SSL
*s
)
3332 if (s
->cert
!= NULL
)
3333 return (s
->cert
->key
->x509
);
3338 EVP_PKEY
*SSL_get_privatekey(const SSL
*s
)
3340 if (s
->cert
!= NULL
)
3341 return (s
->cert
->key
->privatekey
);
3346 X509
*SSL_CTX_get0_certificate(const SSL_CTX
*ctx
)
3348 if (ctx
->cert
!= NULL
)
3349 return ctx
->cert
->key
->x509
;
3354 EVP_PKEY
*SSL_CTX_get0_privatekey(const SSL_CTX
*ctx
)
3356 if (ctx
->cert
!= NULL
)
3357 return ctx
->cert
->key
->privatekey
;
3362 const SSL_CIPHER
*SSL_get_current_cipher(const SSL
*s
)
3364 if ((s
->session
!= NULL
) && (s
->session
->cipher
!= NULL
))
3365 return (s
->session
->cipher
);
3369 const COMP_METHOD
*SSL_get_current_compression(SSL
*s
)
3371 #ifndef OPENSSL_NO_COMP
3372 return s
->compress
? COMP_CTX_get_method(s
->compress
) : NULL
;
3378 const COMP_METHOD
*SSL_get_current_expansion(SSL
*s
)
3380 #ifndef OPENSSL_NO_COMP
3381 return s
->expand
? COMP_CTX_get_method(s
->expand
) : NULL
;
3387 int ssl_init_wbio_buffer(SSL
*s
)
3391 if (s
->bbio
!= NULL
) {
3392 /* Already buffered. */
3396 bbio
= BIO_new(BIO_f_buffer());
3397 if (bbio
== NULL
|| !BIO_set_read_buffer_size(bbio
, 1)) {
3399 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER
, ERR_R_BUF_LIB
);
3403 s
->wbio
= BIO_push(bbio
, s
->wbio
);
3408 void ssl_free_wbio_buffer(SSL
*s
)
3410 /* callers ensure s is never null */
3411 if (s
->bbio
== NULL
)
3414 s
->wbio
= BIO_pop(s
->wbio
);
3415 assert(s
->wbio
!= NULL
);
3420 void SSL_CTX_set_quiet_shutdown(SSL_CTX
*ctx
, int mode
)
3422 ctx
->quiet_shutdown
= mode
;
3425 int SSL_CTX_get_quiet_shutdown(const SSL_CTX
*ctx
)
3427 return (ctx
->quiet_shutdown
);
3430 void SSL_set_quiet_shutdown(SSL
*s
, int mode
)
3432 s
->quiet_shutdown
= mode
;
3435 int SSL_get_quiet_shutdown(const SSL
*s
)
3437 return (s
->quiet_shutdown
);
3440 void SSL_set_shutdown(SSL
*s
, int mode
)
3445 int SSL_get_shutdown(const SSL
*s
)
3450 int SSL_version(const SSL
*s
)
3455 int SSL_client_version(const SSL
*s
)
3457 return s
->client_version
;
3460 SSL_CTX
*SSL_get_SSL_CTX(const SSL
*ssl
)
3465 SSL_CTX
*SSL_set_SSL_CTX(SSL
*ssl
, SSL_CTX
*ctx
)
3468 if (ssl
->ctx
== ctx
)
3471 ctx
= ssl
->initial_ctx
;
3472 new_cert
= ssl_cert_dup(ctx
->cert
);
3473 if (new_cert
== NULL
) {
3476 ssl_cert_free(ssl
->cert
);
3477 ssl
->cert
= new_cert
;
3480 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3481 * so setter APIs must prevent invalid lengths from entering the system.
3483 OPENSSL_assert(ssl
->sid_ctx_length
<= sizeof(ssl
->sid_ctx
));
3486 * If the session ID context matches that of the parent SSL_CTX,
3487 * inherit it from the new SSL_CTX as well. If however the context does
3488 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3489 * leave it unchanged.
3491 if ((ssl
->ctx
!= NULL
) &&
3492 (ssl
->sid_ctx_length
== ssl
->ctx
->sid_ctx_length
) &&
3493 (memcmp(ssl
->sid_ctx
, ssl
->ctx
->sid_ctx
, ssl
->sid_ctx_length
) == 0)) {
3494 ssl
->sid_ctx_length
= ctx
->sid_ctx_length
;
3495 memcpy(&ssl
->sid_ctx
, &ctx
->sid_ctx
, sizeof(ssl
->sid_ctx
));
3498 SSL_CTX_up_ref(ctx
);
3499 SSL_CTX_free(ssl
->ctx
); /* decrement reference count */
3505 int SSL_CTX_set_default_verify_paths(SSL_CTX
*ctx
)
3507 return (X509_STORE_set_default_paths(ctx
->cert_store
));
3510 int SSL_CTX_set_default_verify_dir(SSL_CTX
*ctx
)
3512 X509_LOOKUP
*lookup
;
3514 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_hash_dir());
3517 X509_LOOKUP_add_dir(lookup
, NULL
, X509_FILETYPE_DEFAULT
);
3519 /* Clear any errors if the default directory does not exist */
3525 int SSL_CTX_set_default_verify_file(SSL_CTX
*ctx
)
3527 X509_LOOKUP
*lookup
;
3529 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_file());
3533 X509_LOOKUP_load_file(lookup
, NULL
, X509_FILETYPE_DEFAULT
);
3535 /* Clear any errors if the default file does not exist */
3541 int SSL_CTX_load_verify_locations(SSL_CTX
*ctx
, const char *CAfile
,
3544 return (X509_STORE_load_locations(ctx
->cert_store
, CAfile
, CApath
));
3547 void SSL_set_info_callback(SSL
*ssl
,
3548 void (*cb
) (const SSL
*ssl
, int type
, int val
))
3550 ssl
->info_callback
= cb
;
3554 * One compiler (Diab DCC) doesn't like argument names in returned function
3557 void (*SSL_get_info_callback(const SSL
*ssl
)) (const SSL
* /* ssl */ ,
3560 return ssl
->info_callback
;
3563 void SSL_set_verify_result(SSL
*ssl
, long arg
)
3565 ssl
->verify_result
= arg
;
3568 long SSL_get_verify_result(const SSL
*ssl
)
3570 return (ssl
->verify_result
);
3573 size_t SSL_get_client_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
3576 return sizeof(ssl
->s3
->client_random
);
3577 if (outlen
> sizeof(ssl
->s3
->client_random
))
3578 outlen
= sizeof(ssl
->s3
->client_random
);
3579 memcpy(out
, ssl
->s3
->client_random
, outlen
);
3583 size_t SSL_get_server_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
3586 return sizeof(ssl
->s3
->server_random
);
3587 if (outlen
> sizeof(ssl
->s3
->server_random
))
3588 outlen
= sizeof(ssl
->s3
->server_random
);
3589 memcpy(out
, ssl
->s3
->server_random
, outlen
);
3593 size_t SSL_SESSION_get_master_key(const SSL_SESSION
*session
,
3594 unsigned char *out
, size_t outlen
)
3596 if (session
->master_key_length
< 0) {
3597 /* Should never happen */
3601 return session
->master_key_length
;
3602 if (outlen
> (size_t)session
->master_key_length
)
3603 outlen
= session
->master_key_length
;
3604 memcpy(out
, session
->master_key
, outlen
);
3608 int SSL_set_ex_data(SSL
*s
, int idx
, void *arg
)
3610 return (CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
));
3613 void *SSL_get_ex_data(const SSL
*s
, int idx
)
3615 return (CRYPTO_get_ex_data(&s
->ex_data
, idx
));
3618 int SSL_CTX_set_ex_data(SSL_CTX
*s
, int idx
, void *arg
)
3620 return (CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
));
3623 void *SSL_CTX_get_ex_data(const SSL_CTX
*s
, int idx
)
3625 return (CRYPTO_get_ex_data(&s
->ex_data
, idx
));
3633 X509_STORE
*SSL_CTX_get_cert_store(const SSL_CTX
*ctx
)
3635 return (ctx
->cert_store
);
3638 void SSL_CTX_set_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
3640 X509_STORE_free(ctx
->cert_store
);
3641 ctx
->cert_store
= store
;
3644 void SSL_CTX_set1_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
3647 X509_STORE_up_ref(store
);
3648 SSL_CTX_set_cert_store(ctx
, store
);
3651 int SSL_want(const SSL
*s
)
3653 return (s
->rwstate
);
3657 * \brief Set the callback for generating temporary DH keys.
3658 * \param ctx the SSL context.
3659 * \param dh the callback
3662 #ifndef OPENSSL_NO_DH
3663 void SSL_CTX_set_tmp_dh_callback(SSL_CTX
*ctx
,
3664 DH
*(*dh
) (SSL
*ssl
, int is_export
,
3667 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_TMP_DH_CB
, (void (*)(void))dh
);
3670 void SSL_set_tmp_dh_callback(SSL
*ssl
, DH
*(*dh
) (SSL
*ssl
, int is_export
,
3673 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_TMP_DH_CB
, (void (*)(void))dh
);
3677 #ifndef OPENSSL_NO_PSK
3678 int SSL_CTX_use_psk_identity_hint(SSL_CTX
*ctx
, const char *identity_hint
)
3680 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
3681 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT
, SSL_R_DATA_LENGTH_TOO_LONG
);
3684 OPENSSL_free(ctx
->cert
->psk_identity_hint
);
3685 if (identity_hint
!= NULL
) {
3686 ctx
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
3687 if (ctx
->cert
->psk_identity_hint
== NULL
)
3690 ctx
->cert
->psk_identity_hint
= NULL
;
3694 int SSL_use_psk_identity_hint(SSL
*s
, const char *identity_hint
)
3699 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
3700 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT
, SSL_R_DATA_LENGTH_TOO_LONG
);
3703 OPENSSL_free(s
->cert
->psk_identity_hint
);
3704 if (identity_hint
!= NULL
) {
3705 s
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
3706 if (s
->cert
->psk_identity_hint
== NULL
)
3709 s
->cert
->psk_identity_hint
= NULL
;
3713 const char *SSL_get_psk_identity_hint(const SSL
*s
)
3715 if (s
== NULL
|| s
->session
== NULL
)
3717 return (s
->session
->psk_identity_hint
);
3720 const char *SSL_get_psk_identity(const SSL
*s
)
3722 if (s
== NULL
|| s
->session
== NULL
)
3724 return (s
->session
->psk_identity
);
3727 void SSL_set_psk_client_callback(SSL
*s
,
3728 unsigned int (*cb
) (SSL
*ssl
,
3734 unsigned int max_psk_len
))
3736 s
->psk_client_callback
= cb
;
3739 void SSL_CTX_set_psk_client_callback(SSL_CTX
*ctx
,
3740 unsigned int (*cb
) (SSL
*ssl
,
3749 ctx
->psk_client_callback
= cb
;
3752 void SSL_set_psk_server_callback(SSL
*s
,
3753 unsigned int (*cb
) (SSL
*ssl
,
3754 const char *identity
,
3756 unsigned int max_psk_len
))
3758 s
->psk_server_callback
= cb
;
3761 void SSL_CTX_set_psk_server_callback(SSL_CTX
*ctx
,
3762 unsigned int (*cb
) (SSL
*ssl
,
3763 const char *identity
,
3768 ctx
->psk_server_callback
= cb
;
3772 void SSL_CTX_set_msg_callback(SSL_CTX
*ctx
,
3773 void (*cb
) (int write_p
, int version
,
3774 int content_type
, const void *buf
,
3775 size_t len
, SSL
*ssl
, void *arg
))
3777 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
3780 void SSL_set_msg_callback(SSL
*ssl
,
3781 void (*cb
) (int write_p
, int version
,
3782 int content_type
, const void *buf
,
3783 size_t len
, SSL
*ssl
, void *arg
))
3785 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
3788 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX
*ctx
,
3789 int (*cb
) (SSL
*ssl
,
3793 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
3794 (void (*)(void))cb
);
3797 void SSL_set_not_resumable_session_callback(SSL
*ssl
,
3798 int (*cb
) (SSL
*ssl
,
3799 int is_forward_secure
))
3801 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
3802 (void (*)(void))cb
);
3806 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3807 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3808 * If EVP_MD pointer is passed, initializes ctx with this md Returns newly
3812 EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
)
3814 ssl_clear_hash_ctx(hash
);
3815 *hash
= EVP_MD_CTX_new();
3816 if (*hash
== NULL
|| (md
&& EVP_DigestInit_ex(*hash
, md
, NULL
) <= 0)) {
3817 EVP_MD_CTX_free(*hash
);
3824 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
)
3828 EVP_MD_CTX_free(*hash
);
3832 /* Retrieve handshake hashes */
3833 int ssl_handshake_hash(SSL
*s
, unsigned char *out
, int outlen
)
3835 EVP_MD_CTX
*ctx
= NULL
;
3836 EVP_MD_CTX
*hdgst
= s
->s3
->handshake_dgst
;
3837 int ret
= EVP_MD_CTX_size(hdgst
);
3838 if (ret
< 0 || ret
> outlen
) {
3842 ctx
= EVP_MD_CTX_new();
3847 if (!EVP_MD_CTX_copy_ex(ctx
, hdgst
)
3848 || EVP_DigestFinal_ex(ctx
, out
, NULL
) <= 0)
3851 EVP_MD_CTX_free(ctx
);
3855 int SSL_session_reused(SSL
*s
)
3860 int SSL_is_server(SSL
*s
)
3865 #if OPENSSL_API_COMPAT < 0x10100000L
3866 void SSL_set_debug(SSL
*s
, int debug
)
3868 /* Old function was do-nothing anyway... */
3874 void SSL_set_security_level(SSL
*s
, int level
)
3876 s
->cert
->sec_level
= level
;
3879 int SSL_get_security_level(const SSL
*s
)
3881 return s
->cert
->sec_level
;
3884 void SSL_set_security_callback(SSL
*s
,
3885 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
3886 int op
, int bits
, int nid
,
3887 void *other
, void *ex
))
3889 s
->cert
->sec_cb
= cb
;
3892 int (*SSL_get_security_callback(const SSL
*s
)) (const SSL
*s
,
3893 const SSL_CTX
*ctx
, int op
,
3894 int bits
, int nid
, void *other
,
3896 return s
->cert
->sec_cb
;
3899 void SSL_set0_security_ex_data(SSL
*s
, void *ex
)
3901 s
->cert
->sec_ex
= ex
;
3904 void *SSL_get0_security_ex_data(const SSL
*s
)
3906 return s
->cert
->sec_ex
;
3909 void SSL_CTX_set_security_level(SSL_CTX
*ctx
, int level
)
3911 ctx
->cert
->sec_level
= level
;
3914 int SSL_CTX_get_security_level(const SSL_CTX
*ctx
)
3916 return ctx
->cert
->sec_level
;
3919 void SSL_CTX_set_security_callback(SSL_CTX
*ctx
,
3920 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
3921 int op
, int bits
, int nid
,
3922 void *other
, void *ex
))
3924 ctx
->cert
->sec_cb
= cb
;
3927 int (*SSL_CTX_get_security_callback(const SSL_CTX
*ctx
)) (const SSL
*s
,
3933 return ctx
->cert
->sec_cb
;
3936 void SSL_CTX_set0_security_ex_data(SSL_CTX
*ctx
, void *ex
)
3938 ctx
->cert
->sec_ex
= ex
;
3941 void *SSL_CTX_get0_security_ex_data(const SSL_CTX
*ctx
)
3943 return ctx
->cert
->sec_ex
;
3947 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3948 * can return unsigned long, instead of the generic long return value from the
3949 * control interface.
3951 unsigned long SSL_CTX_get_options(const SSL_CTX
*ctx
)
3953 return ctx
->options
;
3956 unsigned long SSL_get_options(const SSL
*s
)
3961 unsigned long SSL_CTX_set_options(SSL_CTX
*ctx
, unsigned long op
)
3963 return ctx
->options
|= op
;
3966 unsigned long SSL_set_options(SSL
*s
, unsigned long op
)
3968 return s
->options
|= op
;
3971 unsigned long SSL_CTX_clear_options(SSL_CTX
*ctx
, unsigned long op
)
3973 return ctx
->options
&= ~op
;
3976 unsigned long SSL_clear_options(SSL
*s
, unsigned long op
)
3978 return s
->options
&= ~op
;
3981 STACK_OF(X509
) *SSL_get0_verified_chain(const SSL
*s
)
3983 return s
->verified_chain
;
3986 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
3988 #ifndef OPENSSL_NO_CT
3991 * Moves SCTs from the |src| stack to the |dst| stack.
3992 * The source of each SCT will be set to |origin|.
3993 * If |dst| points to a NULL pointer, a new stack will be created and owned by
3995 * Returns the number of SCTs moved, or a negative integer if an error occurs.
3997 static int ct_move_scts(STACK_OF(SCT
) **dst
, STACK_OF(SCT
) *src
,
3998 sct_source_t origin
)
4004 *dst
= sk_SCT_new_null();
4006 SSLerr(SSL_F_CT_MOVE_SCTS
, ERR_R_MALLOC_FAILURE
);
4011 while ((sct
= sk_SCT_pop(src
)) != NULL
) {
4012 if (SCT_set_source(sct
, origin
) != 1)
4015 if (sk_SCT_push(*dst
, sct
) <= 0)
4023 sk_SCT_push(src
, sct
); /* Put the SCT back */
4028 * Look for data collected during ServerHello and parse if found.
4029 * Returns the number of SCTs extracted.
4031 static int ct_extract_tls_extension_scts(SSL
*s
)
4033 int scts_extracted
= 0;
4035 if (s
->tlsext_scts
!= NULL
) {
4036 const unsigned char *p
= s
->tlsext_scts
;
4037 STACK_OF(SCT
) *scts
= o2i_SCT_LIST(NULL
, &p
, s
->tlsext_scts_len
);
4039 scts_extracted
= ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_TLS_EXTENSION
);
4041 SCT_LIST_free(scts
);
4044 return scts_extracted
;
4048 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4049 * contains an SCT X509 extension. They will be stored in |s->scts|.
4051 * - The number of SCTs extracted, assuming an OCSP response exists.
4052 * - 0 if no OCSP response exists or it contains no SCTs.
4053 * - A negative integer if an error occurs.
4055 static int ct_extract_ocsp_response_scts(SSL
*s
)
4057 # ifndef OPENSSL_NO_OCSP
4058 int scts_extracted
= 0;
4059 const unsigned char *p
;
4060 OCSP_BASICRESP
*br
= NULL
;
4061 OCSP_RESPONSE
*rsp
= NULL
;
4062 STACK_OF(SCT
) *scts
= NULL
;
4065 if (s
->tlsext_ocsp_resp
== NULL
|| s
->tlsext_ocsp_resplen
== 0)
4068 p
= s
->tlsext_ocsp_resp
;
4069 rsp
= d2i_OCSP_RESPONSE(NULL
, &p
, s
->tlsext_ocsp_resplen
);
4073 br
= OCSP_response_get1_basic(rsp
);
4077 for (i
= 0; i
< OCSP_resp_count(br
); ++i
) {
4078 OCSP_SINGLERESP
*single
= OCSP_resp_get0(br
, i
);
4084 OCSP_SINGLERESP_get1_ext_d2i(single
, NID_ct_cert_scts
, NULL
, NULL
);
4086 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_OCSP_STAPLED_RESPONSE
);
4087 if (scts_extracted
< 0)
4091 SCT_LIST_free(scts
);
4092 OCSP_BASICRESP_free(br
);
4093 OCSP_RESPONSE_free(rsp
);
4094 return scts_extracted
;
4096 /* Behave as if no OCSP response exists */
4102 * Attempts to extract SCTs from the peer certificate.
4103 * Return the number of SCTs extracted, or a negative integer if an error
4106 static int ct_extract_x509v3_extension_scts(SSL
*s
)
4108 int scts_extracted
= 0;
4109 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
4112 STACK_OF(SCT
) *scts
=
4113 X509_get_ext_d2i(cert
, NID_ct_precert_scts
, NULL
, NULL
);
4116 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_X509V3_EXTENSION
);
4118 SCT_LIST_free(scts
);
4121 return scts_extracted
;
4125 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4126 * response (if it exists) and X509v3 extensions in the certificate.
4127 * Returns NULL if an error occurs.
4129 const STACK_OF(SCT
) *SSL_get0_peer_scts(SSL
*s
)
4131 if (!s
->scts_parsed
) {
4132 if (ct_extract_tls_extension_scts(s
) < 0 ||
4133 ct_extract_ocsp_response_scts(s
) < 0 ||
4134 ct_extract_x509v3_extension_scts(s
) < 0)
4144 static int ct_permissive(const CT_POLICY_EVAL_CTX
* ctx
,
4145 const STACK_OF(SCT
) *scts
, void *unused_arg
)
4150 static int ct_strict(const CT_POLICY_EVAL_CTX
* ctx
,
4151 const STACK_OF(SCT
) *scts
, void *unused_arg
)
4153 int count
= scts
!= NULL
? sk_SCT_num(scts
) : 0;
4156 for (i
= 0; i
< count
; ++i
) {
4157 SCT
*sct
= sk_SCT_value(scts
, i
);
4158 int status
= SCT_get_validation_status(sct
);
4160 if (status
== SCT_VALIDATION_STATUS_VALID
)
4163 SSLerr(SSL_F_CT_STRICT
, SSL_R_NO_VALID_SCTS
);
4167 int SSL_set_ct_validation_callback(SSL
*s
, ssl_ct_validation_cb callback
,
4171 * Since code exists that uses the custom extension handler for CT, look
4172 * for this and throw an error if they have already registered to use CT.
4174 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(s
->ctx
,
4175 TLSEXT_TYPE_signed_certificate_timestamp
))
4177 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK
,
4178 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
4182 if (callback
!= NULL
) {
4184 * If we are validating CT, then we MUST accept SCTs served via OCSP
4186 if (!SSL_set_tlsext_status_type(s
, TLSEXT_STATUSTYPE_ocsp
))
4190 s
->ct_validation_callback
= callback
;
4191 s
->ct_validation_callback_arg
= arg
;
4196 int SSL_CTX_set_ct_validation_callback(SSL_CTX
*ctx
,
4197 ssl_ct_validation_cb callback
, void *arg
)
4200 * Since code exists that uses the custom extension handler for CT, look for
4201 * this and throw an error if they have already registered to use CT.
4203 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(ctx
,
4204 TLSEXT_TYPE_signed_certificate_timestamp
))
4206 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK
,
4207 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
4211 ctx
->ct_validation_callback
= callback
;
4212 ctx
->ct_validation_callback_arg
= arg
;
4216 int SSL_ct_is_enabled(const SSL
*s
)
4218 return s
->ct_validation_callback
!= NULL
;
4221 int SSL_CTX_ct_is_enabled(const SSL_CTX
*ctx
)
4223 return ctx
->ct_validation_callback
!= NULL
;
4226 int ssl_validate_ct(SSL
*s
)
4229 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
4231 SSL_DANE
*dane
= &s
->dane
;
4232 CT_POLICY_EVAL_CTX
*ctx
= NULL
;
4233 const STACK_OF(SCT
) *scts
;
4236 * If no callback is set, the peer is anonymous, or its chain is invalid,
4237 * skip SCT validation - just return success. Applications that continue
4238 * handshakes without certificates, with unverified chains, or pinned leaf
4239 * certificates are outside the scope of the WebPKI and CT.
4241 * The above exclusions notwithstanding the vast majority of peers will
4242 * have rather ordinary certificate chains validated by typical
4243 * applications that perform certificate verification and therefore will
4244 * process SCTs when enabled.
4246 if (s
->ct_validation_callback
== NULL
|| cert
== NULL
||
4247 s
->verify_result
!= X509_V_OK
||
4248 s
->verified_chain
== NULL
|| sk_X509_num(s
->verified_chain
) <= 1)
4252 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4253 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4255 if (DANETLS_ENABLED(dane
) && dane
->mtlsa
!= NULL
) {
4256 switch (dane
->mtlsa
->usage
) {
4257 case DANETLS_USAGE_DANE_TA
:
4258 case DANETLS_USAGE_DANE_EE
:
4263 ctx
= CT_POLICY_EVAL_CTX_new();
4265 SSLerr(SSL_F_SSL_VALIDATE_CT
, ERR_R_MALLOC_FAILURE
);
4269 issuer
= sk_X509_value(s
->verified_chain
, 1);
4270 CT_POLICY_EVAL_CTX_set1_cert(ctx
, cert
);
4271 CT_POLICY_EVAL_CTX_set1_issuer(ctx
, issuer
);
4272 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx
, s
->ctx
->ctlog_store
);
4274 scts
= SSL_get0_peer_scts(s
);
4277 * This function returns success (> 0) only when all the SCTs are valid, 0
4278 * when some are invalid, and < 0 on various internal errors (out of
4279 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4280 * reason to abort the handshake, that decision is up to the callback.
4281 * Therefore, we error out only in the unexpected case that the return
4282 * value is negative.
4284 * XXX: One might well argue that the return value of this function is an
4285 * unfortunate design choice. Its job is only to determine the validation
4286 * status of each of the provided SCTs. So long as it correctly separates
4287 * the wheat from the chaff it should return success. Failure in this case
4288 * ought to correspond to an inability to carry out its duties.
4290 if (SCT_LIST_validate(scts
, ctx
) < 0) {
4291 SSLerr(SSL_F_SSL_VALIDATE_CT
, SSL_R_SCT_VERIFICATION_FAILED
);
4295 ret
= s
->ct_validation_callback(ctx
, scts
, s
->ct_validation_callback_arg
);
4297 ret
= 0; /* This function returns 0 on failure */
4300 CT_POLICY_EVAL_CTX_free(ctx
);
4302 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4303 * failure return code here. Also the application may wish the complete
4304 * the handshake, and then disconnect cleanly at a higher layer, after
4305 * checking the verification status of the completed connection.
4307 * We therefore force a certificate verification failure which will be
4308 * visible via SSL_get_verify_result() and cached as part of any resumed
4311 * Note: the permissive callback is for information gathering only, always
4312 * returns success, and does not affect verification status. Only the
4313 * strict callback or a custom application-specified callback can trigger
4314 * connection failure or record a verification error.
4317 s
->verify_result
= X509_V_ERR_NO_VALID_SCTS
;
4321 int SSL_CTX_enable_ct(SSL_CTX
*ctx
, int validation_mode
)
4323 switch (validation_mode
) {
4325 SSLerr(SSL_F_SSL_CTX_ENABLE_CT
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
4327 case SSL_CT_VALIDATION_PERMISSIVE
:
4328 return SSL_CTX_set_ct_validation_callback(ctx
, ct_permissive
, NULL
);
4329 case SSL_CT_VALIDATION_STRICT
:
4330 return SSL_CTX_set_ct_validation_callback(ctx
, ct_strict
, NULL
);
4334 int SSL_enable_ct(SSL
*s
, int validation_mode
)
4336 switch (validation_mode
) {
4338 SSLerr(SSL_F_SSL_ENABLE_CT
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
4340 case SSL_CT_VALIDATION_PERMISSIVE
:
4341 return SSL_set_ct_validation_callback(s
, ct_permissive
, NULL
);
4342 case SSL_CT_VALIDATION_STRICT
:
4343 return SSL_set_ct_validation_callback(s
, ct_strict
, NULL
);
4347 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX
*ctx
)
4349 return CTLOG_STORE_load_default_file(ctx
->ctlog_store
);
4352 int SSL_CTX_set_ctlog_list_file(SSL_CTX
*ctx
, const char *path
)
4354 return CTLOG_STORE_load_file(ctx
->ctlog_store
, path
);
4357 void SSL_CTX_set0_ctlog_store(SSL_CTX
*ctx
, CTLOG_STORE
* logs
)
4359 CTLOG_STORE_free(ctx
->ctlog_store
);
4360 ctx
->ctlog_store
= logs
;
4363 const CTLOG_STORE
*SSL_CTX_get0_ctlog_store(const SSL_CTX
*ctx
)
4365 return ctx
->ctlog_store
;