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 *, int);
88 int (*func_write
) (SSL
*, const void *, int);
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
);
1522 return args
->f
.func_write(s
, buf
, num
);
1524 return args
->f
.func_other(s
);
1529 int SSL_read(SSL
*s
, void *buf
, int num
)
1531 if (s
->handshake_func
== NULL
) {
1532 SSLerr(SSL_F_SSL_READ
, SSL_R_UNINITIALIZED
);
1536 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1537 s
->rwstate
= SSL_NOTHING
;
1541 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1542 struct ssl_async_args args
;
1547 args
.type
= READFUNC
;
1548 args
.f
.func_read
= s
->method
->ssl_read
;
1550 return ssl_start_async_job(s
, &args
, ssl_io_intern
);
1552 return s
->method
->ssl_read(s
, buf
, num
);
1556 int SSL_peek(SSL
*s
, void *buf
, int num
)
1558 if (s
->handshake_func
== NULL
) {
1559 SSLerr(SSL_F_SSL_PEEK
, SSL_R_UNINITIALIZED
);
1563 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1566 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1567 struct ssl_async_args args
;
1572 args
.type
= READFUNC
;
1573 args
.f
.func_read
= s
->method
->ssl_peek
;
1575 return ssl_start_async_job(s
, &args
, ssl_io_intern
);
1577 return s
->method
->ssl_peek(s
, buf
, num
);
1581 int SSL_write(SSL
*s
, const void *buf
, int num
)
1583 if (s
->handshake_func
== NULL
) {
1584 SSLerr(SSL_F_SSL_WRITE
, SSL_R_UNINITIALIZED
);
1588 if (s
->shutdown
& SSL_SENT_SHUTDOWN
) {
1589 s
->rwstate
= SSL_NOTHING
;
1590 SSLerr(SSL_F_SSL_WRITE
, SSL_R_PROTOCOL_IS_SHUTDOWN
);
1594 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1595 struct ssl_async_args args
;
1598 args
.buf
= (void *)buf
;
1600 args
.type
= WRITEFUNC
;
1601 args
.f
.func_write
= s
->method
->ssl_write
;
1603 return ssl_start_async_job(s
, &args
, ssl_io_intern
);
1605 return s
->method
->ssl_write(s
, buf
, num
);
1609 int SSL_shutdown(SSL
*s
)
1612 * Note that this function behaves differently from what one might
1613 * expect. Return values are 0 for no success (yet), 1 for success; but
1614 * calling it once is usually not enough, even if blocking I/O is used
1615 * (see ssl3_shutdown).
1618 if (s
->handshake_func
== NULL
) {
1619 SSLerr(SSL_F_SSL_SHUTDOWN
, SSL_R_UNINITIALIZED
);
1623 if (!SSL_in_init(s
)) {
1624 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
1625 struct ssl_async_args args
;
1628 args
.type
= OTHERFUNC
;
1629 args
.f
.func_other
= s
->method
->ssl_shutdown
;
1631 return ssl_start_async_job(s
, &args
, ssl_io_intern
);
1633 return s
->method
->ssl_shutdown(s
);
1636 SSLerr(SSL_F_SSL_SHUTDOWN
, SSL_R_SHUTDOWN_WHILE_IN_INIT
);
1641 int SSL_renegotiate(SSL
*s
)
1643 if (s
->renegotiate
== 0)
1648 return (s
->method
->ssl_renegotiate(s
));
1651 int SSL_renegotiate_abbreviated(SSL
*s
)
1653 if (s
->renegotiate
== 0)
1658 return (s
->method
->ssl_renegotiate(s
));
1661 int SSL_renegotiate_pending(SSL
*s
)
1664 * becomes true when negotiation is requested; false again once a
1665 * handshake has finished
1667 return (s
->renegotiate
!= 0);
1670 long SSL_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
)
1675 case SSL_CTRL_GET_READ_AHEAD
:
1676 return (RECORD_LAYER_get_read_ahead(&s
->rlayer
));
1677 case SSL_CTRL_SET_READ_AHEAD
:
1678 l
= RECORD_LAYER_get_read_ahead(&s
->rlayer
);
1679 RECORD_LAYER_set_read_ahead(&s
->rlayer
, larg
);
1682 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
1683 s
->msg_callback_arg
= parg
;
1687 return (s
->mode
|= larg
);
1688 case SSL_CTRL_CLEAR_MODE
:
1689 return (s
->mode
&= ~larg
);
1690 case SSL_CTRL_GET_MAX_CERT_LIST
:
1691 return (s
->max_cert_list
);
1692 case SSL_CTRL_SET_MAX_CERT_LIST
:
1693 l
= s
->max_cert_list
;
1694 s
->max_cert_list
= larg
;
1696 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
1697 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
1699 s
->max_send_fragment
= larg
;
1700 if (s
->max_send_fragment
< s
->split_send_fragment
)
1701 s
->split_send_fragment
= s
->max_send_fragment
;
1703 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
1704 if ((unsigned int)larg
> s
->max_send_fragment
|| larg
== 0)
1706 s
->split_send_fragment
= larg
;
1708 case SSL_CTRL_SET_MAX_PIPELINES
:
1709 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
1711 s
->max_pipelines
= larg
;
1713 RECORD_LAYER_set_read_ahead(&s
->rlayer
, 1);
1715 case SSL_CTRL_GET_RI_SUPPORT
:
1717 return s
->s3
->send_connection_binding
;
1720 case SSL_CTRL_CERT_FLAGS
:
1721 return (s
->cert
->cert_flags
|= larg
);
1722 case SSL_CTRL_CLEAR_CERT_FLAGS
:
1723 return (s
->cert
->cert_flags
&= ~larg
);
1725 case SSL_CTRL_GET_RAW_CIPHERLIST
:
1727 if (s
->s3
->tmp
.ciphers_raw
== NULL
)
1729 *(unsigned char **)parg
= s
->s3
->tmp
.ciphers_raw
;
1730 return (int)s
->s3
->tmp
.ciphers_rawlen
;
1732 return TLS_CIPHER_LEN
;
1734 case SSL_CTRL_GET_EXTMS_SUPPORT
:
1735 if (!s
->session
|| SSL_in_init(s
) || ossl_statem_get_in_handshake(s
))
1737 if (s
->session
->flags
& SSL_SESS_FLAG_EXTMS
)
1741 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
1742 return ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
1743 &s
->min_proto_version
);
1744 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
1745 return ssl_set_version_bound(s
->ctx
->method
->version
, (int)larg
,
1746 &s
->max_proto_version
);
1748 return (s
->method
->ssl_ctrl(s
, cmd
, larg
, parg
));
1752 long SSL_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void))
1755 case SSL_CTRL_SET_MSG_CALLBACK
:
1756 s
->msg_callback
= (void (*)
1757 (int write_p
, int version
, int content_type
,
1758 const void *buf
, size_t len
, SSL
*ssl
,
1763 return (s
->method
->ssl_callback_ctrl(s
, cmd
, fp
));
1767 LHASH_OF(SSL_SESSION
) *SSL_CTX_sessions(SSL_CTX
*ctx
)
1769 return ctx
->sessions
;
1772 long SSL_CTX_ctrl(SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
)
1775 /* For some cases with ctx == NULL perform syntax checks */
1778 #ifndef OPENSSL_NO_EC
1779 case SSL_CTRL_SET_CURVES_LIST
:
1780 return tls1_set_curves_list(NULL
, NULL
, parg
);
1782 case SSL_CTRL_SET_SIGALGS_LIST
:
1783 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST
:
1784 return tls1_set_sigalgs_list(NULL
, parg
, 0);
1791 case SSL_CTRL_GET_READ_AHEAD
:
1792 return (ctx
->read_ahead
);
1793 case SSL_CTRL_SET_READ_AHEAD
:
1794 l
= ctx
->read_ahead
;
1795 ctx
->read_ahead
= larg
;
1798 case SSL_CTRL_SET_MSG_CALLBACK_ARG
:
1799 ctx
->msg_callback_arg
= parg
;
1802 case SSL_CTRL_GET_MAX_CERT_LIST
:
1803 return (ctx
->max_cert_list
);
1804 case SSL_CTRL_SET_MAX_CERT_LIST
:
1805 l
= ctx
->max_cert_list
;
1806 ctx
->max_cert_list
= larg
;
1809 case SSL_CTRL_SET_SESS_CACHE_SIZE
:
1810 l
= ctx
->session_cache_size
;
1811 ctx
->session_cache_size
= larg
;
1813 case SSL_CTRL_GET_SESS_CACHE_SIZE
:
1814 return (ctx
->session_cache_size
);
1815 case SSL_CTRL_SET_SESS_CACHE_MODE
:
1816 l
= ctx
->session_cache_mode
;
1817 ctx
->session_cache_mode
= larg
;
1819 case SSL_CTRL_GET_SESS_CACHE_MODE
:
1820 return (ctx
->session_cache_mode
);
1822 case SSL_CTRL_SESS_NUMBER
:
1823 return (lh_SSL_SESSION_num_items(ctx
->sessions
));
1824 case SSL_CTRL_SESS_CONNECT
:
1825 return (ctx
->stats
.sess_connect
);
1826 case SSL_CTRL_SESS_CONNECT_GOOD
:
1827 return (ctx
->stats
.sess_connect_good
);
1828 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE
:
1829 return (ctx
->stats
.sess_connect_renegotiate
);
1830 case SSL_CTRL_SESS_ACCEPT
:
1831 return (ctx
->stats
.sess_accept
);
1832 case SSL_CTRL_SESS_ACCEPT_GOOD
:
1833 return (ctx
->stats
.sess_accept_good
);
1834 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE
:
1835 return (ctx
->stats
.sess_accept_renegotiate
);
1836 case SSL_CTRL_SESS_HIT
:
1837 return (ctx
->stats
.sess_hit
);
1838 case SSL_CTRL_SESS_CB_HIT
:
1839 return (ctx
->stats
.sess_cb_hit
);
1840 case SSL_CTRL_SESS_MISSES
:
1841 return (ctx
->stats
.sess_miss
);
1842 case SSL_CTRL_SESS_TIMEOUTS
:
1843 return (ctx
->stats
.sess_timeout
);
1844 case SSL_CTRL_SESS_CACHE_FULL
:
1845 return (ctx
->stats
.sess_cache_full
);
1847 return (ctx
->mode
|= larg
);
1848 case SSL_CTRL_CLEAR_MODE
:
1849 return (ctx
->mode
&= ~larg
);
1850 case SSL_CTRL_SET_MAX_SEND_FRAGMENT
:
1851 if (larg
< 512 || larg
> SSL3_RT_MAX_PLAIN_LENGTH
)
1853 ctx
->max_send_fragment
= larg
;
1854 if (ctx
->max_send_fragment
< ctx
->split_send_fragment
)
1855 ctx
->split_send_fragment
= ctx
->max_send_fragment
;
1857 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT
:
1858 if ((unsigned int)larg
> ctx
->max_send_fragment
|| larg
== 0)
1860 ctx
->split_send_fragment
= larg
;
1862 case SSL_CTRL_SET_MAX_PIPELINES
:
1863 if (larg
< 1 || larg
> SSL_MAX_PIPELINES
)
1865 ctx
->max_pipelines
= larg
;
1867 case SSL_CTRL_CERT_FLAGS
:
1868 return (ctx
->cert
->cert_flags
|= larg
);
1869 case SSL_CTRL_CLEAR_CERT_FLAGS
:
1870 return (ctx
->cert
->cert_flags
&= ~larg
);
1871 case SSL_CTRL_SET_MIN_PROTO_VERSION
:
1872 return ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
1873 &ctx
->min_proto_version
);
1874 case SSL_CTRL_SET_MAX_PROTO_VERSION
:
1875 return ssl_set_version_bound(ctx
->method
->version
, (int)larg
,
1876 &ctx
->max_proto_version
);
1878 return (ctx
->method
->ssl_ctx_ctrl(ctx
, cmd
, larg
, parg
));
1882 long SSL_CTX_callback_ctrl(SSL_CTX
*ctx
, int cmd
, void (*fp
) (void))
1885 case SSL_CTRL_SET_MSG_CALLBACK
:
1886 ctx
->msg_callback
= (void (*)
1887 (int write_p
, int version
, int content_type
,
1888 const void *buf
, size_t len
, SSL
*ssl
,
1893 return (ctx
->method
->ssl_ctx_callback_ctrl(ctx
, cmd
, fp
));
1897 int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
)
1906 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
1907 const SSL_CIPHER
*const *bp
)
1909 if ((*ap
)->id
> (*bp
)->id
)
1911 if ((*ap
)->id
< (*bp
)->id
)
1916 /** return a STACK of the ciphers available for the SSL and in order of
1918 STACK_OF(SSL_CIPHER
) *SSL_get_ciphers(const SSL
*s
)
1921 if (s
->cipher_list
!= NULL
) {
1922 return (s
->cipher_list
);
1923 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list
!= NULL
)) {
1924 return (s
->ctx
->cipher_list
);
1930 STACK_OF(SSL_CIPHER
) *SSL_get_client_ciphers(const SSL
*s
)
1932 if ((s
== NULL
) || (s
->session
== NULL
) || !s
->server
)
1934 return s
->session
->ciphers
;
1937 STACK_OF(SSL_CIPHER
) *SSL_get1_supported_ciphers(SSL
*s
)
1939 STACK_OF(SSL_CIPHER
) *sk
= NULL
, *ciphers
;
1941 ciphers
= SSL_get_ciphers(s
);
1944 ssl_set_client_disabled(s
);
1945 for (i
= 0; i
< sk_SSL_CIPHER_num(ciphers
); i
++) {
1946 const SSL_CIPHER
*c
= sk_SSL_CIPHER_value(ciphers
, i
);
1947 if (!ssl_cipher_disabled(s
, c
, SSL_SECOP_CIPHER_SUPPORTED
)) {
1949 sk
= sk_SSL_CIPHER_new_null();
1952 if (!sk_SSL_CIPHER_push(sk
, c
)) {
1953 sk_SSL_CIPHER_free(sk
);
1961 /** return a STACK of the ciphers available for the SSL and in order of
1963 STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
)
1966 if (s
->cipher_list_by_id
!= NULL
) {
1967 return (s
->cipher_list_by_id
);
1968 } else if ((s
->ctx
!= NULL
) && (s
->ctx
->cipher_list_by_id
!= NULL
)) {
1969 return (s
->ctx
->cipher_list_by_id
);
1975 /** The old interface to get the same thing as SSL_get_ciphers() */
1976 const char *SSL_get_cipher_list(const SSL
*s
, int n
)
1978 const SSL_CIPHER
*c
;
1979 STACK_OF(SSL_CIPHER
) *sk
;
1983 sk
= SSL_get_ciphers(s
);
1984 if ((sk
== NULL
) || (sk_SSL_CIPHER_num(sk
) <= n
))
1986 c
= sk_SSL_CIPHER_value(sk
, n
);
1992 /** return a STACK of the ciphers available for the SSL_CTX and in order of
1994 STACK_OF(SSL_CIPHER
) *SSL_CTX_get_ciphers(const SSL_CTX
*ctx
)
1997 return ctx
->cipher_list
;
2001 /** specify the ciphers to be used by default by the SSL_CTX */
2002 int SSL_CTX_set_cipher_list(SSL_CTX
*ctx
, const char *str
)
2004 STACK_OF(SSL_CIPHER
) *sk
;
2006 sk
= ssl_create_cipher_list(ctx
->method
, &ctx
->cipher_list
,
2007 &ctx
->cipher_list_by_id
, str
, ctx
->cert
);
2009 * ssl_create_cipher_list may return an empty stack if it was unable to
2010 * find a cipher matching the given rule string (for example if the rule
2011 * string specifies a cipher which has been disabled). This is not an
2012 * error as far as ssl_create_cipher_list is concerned, and hence
2013 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2017 else if (sk_SSL_CIPHER_num(sk
) == 0) {
2018 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST
, SSL_R_NO_CIPHER_MATCH
);
2024 /** specify the ciphers to be used by the SSL */
2025 int SSL_set_cipher_list(SSL
*s
, const char *str
)
2027 STACK_OF(SSL_CIPHER
) *sk
;
2029 sk
= ssl_create_cipher_list(s
->ctx
->method
, &s
->cipher_list
,
2030 &s
->cipher_list_by_id
, str
, s
->cert
);
2031 /* see comment in SSL_CTX_set_cipher_list */
2034 else if (sk_SSL_CIPHER_num(sk
) == 0) {
2035 SSLerr(SSL_F_SSL_SET_CIPHER_LIST
, SSL_R_NO_CIPHER_MATCH
);
2041 char *SSL_get_shared_ciphers(const SSL
*s
, char *buf
, int len
)
2044 STACK_OF(SSL_CIPHER
) *sk
;
2045 const SSL_CIPHER
*c
;
2048 if ((s
->session
== NULL
) || (s
->session
->ciphers
== NULL
) || (len
< 2))
2052 sk
= s
->session
->ciphers
;
2054 if (sk_SSL_CIPHER_num(sk
) == 0)
2057 for (i
= 0; i
< sk_SSL_CIPHER_num(sk
); i
++) {
2060 c
= sk_SSL_CIPHER_value(sk
, i
);
2061 n
= strlen(c
->name
);
2068 memcpy(p
, c
->name
, n
+ 1);
2077 /** return a servername extension value if provided in Client Hello, or NULL.
2078 * So far, only host_name types are defined (RFC 3546).
2081 const char *SSL_get_servername(const SSL
*s
, const int type
)
2083 if (type
!= TLSEXT_NAMETYPE_host_name
)
2086 return s
->session
&& !s
->tlsext_hostname
?
2087 s
->session
->tlsext_hostname
: s
->tlsext_hostname
;
2090 int SSL_get_servername_type(const SSL
*s
)
2093 && (!s
->tlsext_hostname
? s
->session
->
2094 tlsext_hostname
: s
->tlsext_hostname
))
2095 return TLSEXT_NAMETYPE_host_name
;
2100 * SSL_select_next_proto implements the standard protocol selection. It is
2101 * expected that this function is called from the callback set by
2102 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2103 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2104 * not included in the length. A byte string of length 0 is invalid. No byte
2105 * string may be truncated. The current, but experimental algorithm for
2106 * selecting the protocol is: 1) If the server doesn't support NPN then this
2107 * is indicated to the callback. In this case, the client application has to
2108 * abort the connection or have a default application level protocol. 2) If
2109 * the server supports NPN, but advertises an empty list then the client
2110 * selects the first protocol in its list, but indicates via the API that this
2111 * fallback case was enacted. 3) Otherwise, the client finds the first
2112 * protocol in the server's list that it supports and selects this protocol.
2113 * This is because it's assumed that the server has better information about
2114 * which protocol a client should use. 4) If the client doesn't support any
2115 * of the server's advertised protocols, then this is treated the same as
2116 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2117 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2119 int SSL_select_next_proto(unsigned char **out
, unsigned char *outlen
,
2120 const unsigned char *server
,
2121 unsigned int server_len
,
2122 const unsigned char *client
, unsigned int client_len
)
2125 const unsigned char *result
;
2126 int status
= OPENSSL_NPN_UNSUPPORTED
;
2129 * For each protocol in server preference order, see if we support it.
2131 for (i
= 0; i
< server_len
;) {
2132 for (j
= 0; j
< client_len
;) {
2133 if (server
[i
] == client
[j
] &&
2134 memcmp(&server
[i
+ 1], &client
[j
+ 1], server
[i
]) == 0) {
2135 /* We found a match */
2136 result
= &server
[i
];
2137 status
= OPENSSL_NPN_NEGOTIATED
;
2147 /* There's no overlap between our protocols and the server's list. */
2149 status
= OPENSSL_NPN_NO_OVERLAP
;
2152 *out
= (unsigned char *)result
+ 1;
2153 *outlen
= result
[0];
2157 #ifndef OPENSSL_NO_NEXTPROTONEG
2159 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2160 * client's requested protocol for this connection and returns 0. If the
2161 * client didn't request any protocol, then *data is set to NULL. Note that
2162 * the client can request any protocol it chooses. The value returned from
2163 * this function need not be a member of the list of supported protocols
2164 * provided by the callback.
2166 void SSL_get0_next_proto_negotiated(const SSL
*s
, const unsigned char **data
,
2169 *data
= s
->next_proto_negotiated
;
2173 *len
= s
->next_proto_negotiated_len
;
2178 * SSL_CTX_set_next_protos_advertised_cb sets a callback that is called when
2179 * a TLS server needs a list of supported protocols for Next Protocol
2180 * Negotiation. The returned list must be in wire format. The list is
2181 * returned by setting |out| to point to it and |outlen| to its length. This
2182 * memory will not be modified, but one should assume that the SSL* keeps a
2183 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2184 * wishes to advertise. Otherwise, no such extension will be included in the
2187 void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX
*ctx
,
2188 int (*cb
) (SSL
*ssl
,
2191 unsigned int *outlen
,
2192 void *arg
), void *arg
)
2194 ctx
->next_protos_advertised_cb
= cb
;
2195 ctx
->next_protos_advertised_cb_arg
= arg
;
2199 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2200 * client needs to select a protocol from the server's provided list. |out|
2201 * must be set to point to the selected protocol (which may be within |in|).
2202 * The length of the protocol name must be written into |outlen|. The
2203 * server's advertised protocols are provided in |in| and |inlen|. The
2204 * callback can assume that |in| is syntactically valid. The client must
2205 * select a protocol. It is fatal to the connection if this callback returns
2206 * a value other than SSL_TLSEXT_ERR_OK.
2208 void SSL_CTX_set_next_proto_select_cb(SSL_CTX
*ctx
,
2209 int (*cb
) (SSL
*s
, unsigned char **out
,
2210 unsigned char *outlen
,
2211 const unsigned char *in
,
2213 void *arg
), void *arg
)
2215 ctx
->next_proto_select_cb
= cb
;
2216 ctx
->next_proto_select_cb_arg
= arg
;
2221 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2222 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2223 * length-prefixed strings). Returns 0 on success.
2225 int SSL_CTX_set_alpn_protos(SSL_CTX
*ctx
, const unsigned char *protos
,
2226 unsigned int protos_len
)
2228 OPENSSL_free(ctx
->alpn_client_proto_list
);
2229 ctx
->alpn_client_proto_list
= OPENSSL_memdup(protos
, protos_len
);
2230 if (ctx
->alpn_client_proto_list
== NULL
) {
2231 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS
, ERR_R_MALLOC_FAILURE
);
2234 ctx
->alpn_client_proto_list_len
= protos_len
;
2240 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2241 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2242 * length-prefixed strings). Returns 0 on success.
2244 int SSL_set_alpn_protos(SSL
*ssl
, const unsigned char *protos
,
2245 unsigned int protos_len
)
2247 OPENSSL_free(ssl
->alpn_client_proto_list
);
2248 ssl
->alpn_client_proto_list
= OPENSSL_memdup(protos
, protos_len
);
2249 if (ssl
->alpn_client_proto_list
== NULL
) {
2250 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS
, ERR_R_MALLOC_FAILURE
);
2253 ssl
->alpn_client_proto_list_len
= protos_len
;
2259 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2260 * called during ClientHello processing in order to select an ALPN protocol
2261 * from the client's list of offered protocols.
2263 void SSL_CTX_set_alpn_select_cb(SSL_CTX
*ctx
,
2264 int (*cb
) (SSL
*ssl
,
2265 const unsigned char **out
,
2266 unsigned char *outlen
,
2267 const unsigned char *in
,
2269 void *arg
), void *arg
)
2271 ctx
->alpn_select_cb
= cb
;
2272 ctx
->alpn_select_cb_arg
= arg
;
2276 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2277 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2278 * (not including the leading length-prefix byte). If the server didn't
2279 * respond with a negotiated protocol then |*len| will be zero.
2281 void SSL_get0_alpn_selected(const SSL
*ssl
, const unsigned char **data
,
2286 *data
= ssl
->s3
->alpn_selected
;
2290 *len
= ssl
->s3
->alpn_selected_len
;
2293 int SSL_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2294 const char *label
, size_t llen
,
2295 const unsigned char *p
, size_t plen
,
2298 if (s
->version
< TLS1_VERSION
&& s
->version
!= DTLS1_BAD_VER
)
2301 return s
->method
->ssl3_enc
->export_keying_material(s
, out
, olen
, label
,
2306 static unsigned long ssl_session_hash(const SSL_SESSION
*a
)
2311 ((unsigned int)a
->session_id
[0]) |
2312 ((unsigned int)a
->session_id
[1] << 8L) |
2313 ((unsigned long)a
->session_id
[2] << 16L) |
2314 ((unsigned long)a
->session_id
[3] << 24L);
2319 * NB: If this function (or indeed the hash function which uses a sort of
2320 * coarser function than this one) is changed, ensure
2321 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2322 * being able to construct an SSL_SESSION that will collide with any existing
2323 * session with a matching session ID.
2325 static int ssl_session_cmp(const SSL_SESSION
*a
, const SSL_SESSION
*b
)
2327 if (a
->ssl_version
!= b
->ssl_version
)
2329 if (a
->session_id_length
!= b
->session_id_length
)
2331 return (memcmp(a
->session_id
, b
->session_id
, a
->session_id_length
));
2335 * These wrapper functions should remain rather than redeclaring
2336 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2337 * variable. The reason is that the functions aren't static, they're exposed
2341 SSL_CTX
*SSL_CTX_new(const SSL_METHOD
*meth
)
2343 SSL_CTX
*ret
= NULL
;
2346 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_NULL_SSL_METHOD_PASSED
);
2350 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS
, NULL
))
2353 if (FIPS_mode() && (meth
->version
< TLS1_VERSION
)) {
2354 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE
);
2358 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2359 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS
);
2362 ret
= OPENSSL_zalloc(sizeof(*ret
));
2367 ret
->min_proto_version
= 0;
2368 ret
->max_proto_version
= 0;
2369 ret
->session_cache_mode
= SSL_SESS_CACHE_SERVER
;
2370 ret
->session_cache_size
= SSL_SESSION_CACHE_MAX_SIZE_DEFAULT
;
2371 /* We take the system default. */
2372 ret
->session_timeout
= meth
->get_timeout();
2373 ret
->references
= 1;
2374 ret
->lock
= CRYPTO_THREAD_lock_new();
2375 if (ret
->lock
== NULL
) {
2376 SSLerr(SSL_F_SSL_CTX_NEW
, ERR_R_MALLOC_FAILURE
);
2380 ret
->max_cert_list
= SSL_MAX_CERT_LIST_DEFAULT
;
2381 ret
->verify_mode
= SSL_VERIFY_NONE
;
2382 if ((ret
->cert
= ssl_cert_new()) == NULL
)
2385 ret
->sessions
= lh_SSL_SESSION_new(ssl_session_hash
, ssl_session_cmp
);
2386 if (ret
->sessions
== NULL
)
2388 ret
->cert_store
= X509_STORE_new();
2389 if (ret
->cert_store
== NULL
)
2391 #ifndef OPENSSL_NO_CT
2392 ret
->ctlog_store
= CTLOG_STORE_new();
2393 if (ret
->ctlog_store
== NULL
)
2396 if (!ssl_create_cipher_list(ret
->method
,
2397 &ret
->cipher_list
, &ret
->cipher_list_by_id
,
2398 SSL_DEFAULT_CIPHER_LIST
, ret
->cert
)
2399 || sk_SSL_CIPHER_num(ret
->cipher_list
) <= 0) {
2400 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_LIBRARY_HAS_NO_CIPHERS
);
2404 ret
->param
= X509_VERIFY_PARAM_new();
2405 if (ret
->param
== NULL
)
2408 if ((ret
->md5
= EVP_get_digestbyname("ssl3-md5")) == NULL
) {
2409 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES
);
2412 if ((ret
->sha1
= EVP_get_digestbyname("ssl3-sha1")) == NULL
) {
2413 SSLerr(SSL_F_SSL_CTX_NEW
, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES
);
2417 if ((ret
->client_CA
= sk_X509_NAME_new_null()) == NULL
)
2420 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, ret
, &ret
->ex_data
))
2423 /* No compression for DTLS */
2424 if (!(meth
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_DTLS
))
2425 ret
->comp_methods
= SSL_COMP_get_compression_methods();
2427 ret
->max_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
2428 ret
->split_send_fragment
= SSL3_RT_MAX_PLAIN_LENGTH
;
2430 /* Setup RFC5077 ticket keys */
2431 if ((RAND_bytes(ret
->tlsext_tick_key_name
,
2432 sizeof(ret
->tlsext_tick_key_name
)) <= 0)
2433 || (RAND_bytes(ret
->tlsext_tick_hmac_key
,
2434 sizeof(ret
->tlsext_tick_hmac_key
)) <= 0)
2435 || (RAND_bytes(ret
->tlsext_tick_aes_key
,
2436 sizeof(ret
->tlsext_tick_aes_key
)) <= 0))
2437 ret
->options
|= SSL_OP_NO_TICKET
;
2439 #ifndef OPENSSL_NO_SRP
2440 if (!SSL_CTX_SRP_CTX_init(ret
))
2443 #ifndef OPENSSL_NO_ENGINE
2444 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2445 # define eng_strx(x) #x
2446 # define eng_str(x) eng_strx(x)
2447 /* Use specific client engine automatically... ignore errors */
2450 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
2453 ENGINE_load_builtin_engines();
2454 eng
= ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO
));
2456 if (!eng
|| !SSL_CTX_set_client_cert_engine(ret
, eng
))
2462 * Default is to connect to non-RI servers. When RI is more widely
2463 * deployed might change this.
2465 ret
->options
|= SSL_OP_LEGACY_SERVER_CONNECT
;
2467 * Disable compression by default to prevent CRIME. Applications can
2468 * re-enable compression by configuring
2469 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2470 * or by using the SSL_CONF library.
2472 ret
->options
|= SSL_OP_NO_COMPRESSION
;
2474 ret
->tlsext_status_type
= -1;
2478 SSLerr(SSL_F_SSL_CTX_NEW
, ERR_R_MALLOC_FAILURE
);
2484 int SSL_CTX_up_ref(SSL_CTX
*ctx
)
2488 if (CRYPTO_atomic_add(&ctx
->references
, 1, &i
, ctx
->lock
) <= 0)
2491 REF_PRINT_COUNT("SSL_CTX", ctx
);
2492 REF_ASSERT_ISNT(i
< 2);
2493 return ((i
> 1) ? 1 : 0);
2496 void SSL_CTX_free(SSL_CTX
*a
)
2503 CRYPTO_atomic_add(&a
->references
, -1, &i
, a
->lock
);
2504 REF_PRINT_COUNT("SSL_CTX", a
);
2507 REF_ASSERT_ISNT(i
< 0);
2509 X509_VERIFY_PARAM_free(a
->param
);
2510 dane_ctx_final(&a
->dane
);
2513 * Free internal session cache. However: the remove_cb() may reference
2514 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2515 * after the sessions were flushed.
2516 * As the ex_data handling routines might also touch the session cache,
2517 * the most secure solution seems to be: empty (flush) the cache, then
2518 * free ex_data, then finally free the cache.
2519 * (See ticket [openssl.org #212].)
2521 if (a
->sessions
!= NULL
)
2522 SSL_CTX_flush_sessions(a
, 0);
2524 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX
, a
, &a
->ex_data
);
2525 lh_SSL_SESSION_free(a
->sessions
);
2526 X509_STORE_free(a
->cert_store
);
2527 #ifndef OPENSSL_NO_CT
2528 CTLOG_STORE_free(a
->ctlog_store
);
2530 sk_SSL_CIPHER_free(a
->cipher_list
);
2531 sk_SSL_CIPHER_free(a
->cipher_list_by_id
);
2532 ssl_cert_free(a
->cert
);
2533 sk_X509_NAME_pop_free(a
->client_CA
, X509_NAME_free
);
2534 sk_X509_pop_free(a
->extra_certs
, X509_free
);
2535 a
->comp_methods
= NULL
;
2536 #ifndef OPENSSL_NO_SRTP
2537 sk_SRTP_PROTECTION_PROFILE_free(a
->srtp_profiles
);
2539 #ifndef OPENSSL_NO_SRP
2540 SSL_CTX_SRP_CTX_free(a
);
2542 #ifndef OPENSSL_NO_ENGINE
2543 ENGINE_finish(a
->client_cert_engine
);
2546 #ifndef OPENSSL_NO_EC
2547 OPENSSL_free(a
->tlsext_ecpointformatlist
);
2548 OPENSSL_free(a
->tlsext_ellipticcurvelist
);
2550 OPENSSL_free(a
->alpn_client_proto_list
);
2552 CRYPTO_THREAD_lock_free(a
->lock
);
2557 void SSL_CTX_set_default_passwd_cb(SSL_CTX
*ctx
, pem_password_cb
*cb
)
2559 ctx
->default_passwd_callback
= cb
;
2562 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX
*ctx
, void *u
)
2564 ctx
->default_passwd_callback_userdata
= u
;
2567 pem_password_cb
*SSL_CTX_get_default_passwd_cb(SSL_CTX
*ctx
)
2569 return ctx
->default_passwd_callback
;
2572 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX
*ctx
)
2574 return ctx
->default_passwd_callback_userdata
;
2577 void SSL_set_default_passwd_cb(SSL
*s
, pem_password_cb
*cb
)
2579 s
->default_passwd_callback
= cb
;
2582 void SSL_set_default_passwd_cb_userdata(SSL
*s
, void *u
)
2584 s
->default_passwd_callback_userdata
= u
;
2587 pem_password_cb
*SSL_get_default_passwd_cb(SSL
*s
)
2589 return s
->default_passwd_callback
;
2592 void *SSL_get_default_passwd_cb_userdata(SSL
*s
)
2594 return s
->default_passwd_callback_userdata
;
2597 void SSL_CTX_set_cert_verify_callback(SSL_CTX
*ctx
,
2598 int (*cb
) (X509_STORE_CTX
*, void *),
2601 ctx
->app_verify_callback
= cb
;
2602 ctx
->app_verify_arg
= arg
;
2605 void SSL_CTX_set_verify(SSL_CTX
*ctx
, int mode
,
2606 int (*cb
) (int, X509_STORE_CTX
*))
2608 ctx
->verify_mode
= mode
;
2609 ctx
->default_verify_callback
= cb
;
2612 void SSL_CTX_set_verify_depth(SSL_CTX
*ctx
, int depth
)
2614 X509_VERIFY_PARAM_set_depth(ctx
->param
, depth
);
2617 void SSL_CTX_set_cert_cb(SSL_CTX
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
2619 ssl_cert_set_cert_cb(c
->cert
, cb
, arg
);
2622 void SSL_set_cert_cb(SSL
*s
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
)
2624 ssl_cert_set_cert_cb(s
->cert
, cb
, arg
);
2627 void ssl_set_masks(SSL
*s
)
2629 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_GOST)
2633 uint32_t *pvalid
= s
->s3
->tmp
.valid_flags
;
2634 int rsa_enc
, rsa_sign
, dh_tmp
, dsa_sign
;
2635 unsigned long mask_k
, mask_a
;
2636 #ifndef OPENSSL_NO_EC
2637 int have_ecc_cert
, ecdsa_ok
;
2643 #ifndef OPENSSL_NO_DH
2644 dh_tmp
= (c
->dh_tmp
!= NULL
|| c
->dh_tmp_cb
!= NULL
|| c
->dh_tmp_auto
);
2649 rsa_enc
= pvalid
[SSL_PKEY_RSA_ENC
] & CERT_PKEY_VALID
;
2650 rsa_sign
= pvalid
[SSL_PKEY_RSA_SIGN
] & CERT_PKEY_SIGN
;
2651 dsa_sign
= pvalid
[SSL_PKEY_DSA_SIGN
] & CERT_PKEY_SIGN
;
2652 #ifndef OPENSSL_NO_EC
2653 have_ecc_cert
= pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_VALID
;
2659 fprintf(stderr
, "dht=%d re=%d rs=%d ds=%d\n",
2660 dh_tmp
, rsa_enc
, rsa_sign
, dsa_sign
);
2663 #ifndef OPENSSL_NO_GOST
2664 cpk
= &(c
->pkeys
[SSL_PKEY_GOST12_512
]);
2665 if (cpk
->x509
!= NULL
&& cpk
->privatekey
!= NULL
) {
2666 mask_k
|= SSL_kGOST
;
2667 mask_a
|= SSL_aGOST12
;
2669 cpk
= &(c
->pkeys
[SSL_PKEY_GOST12_256
]);
2670 if (cpk
->x509
!= NULL
&& cpk
->privatekey
!= NULL
) {
2671 mask_k
|= SSL_kGOST
;
2672 mask_a
|= SSL_aGOST12
;
2674 cpk
= &(c
->pkeys
[SSL_PKEY_GOST01
]);
2675 if (cpk
->x509
!= NULL
&& cpk
->privatekey
!= NULL
) {
2676 mask_k
|= SSL_kGOST
;
2677 mask_a
|= SSL_aGOST01
;
2687 if (rsa_enc
|| rsa_sign
) {
2695 mask_a
|= SSL_aNULL
;
2698 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2699 * depending on the key usage extension.
2701 #ifndef OPENSSL_NO_EC
2702 if (have_ecc_cert
) {
2704 cpk
= &c
->pkeys
[SSL_PKEY_ECC
];
2706 ex_kusage
= X509_get_key_usage(x
);
2707 ecdsa_ok
= ex_kusage
& X509v3_KU_DIGITAL_SIGNATURE
;
2708 if (!(pvalid
[SSL_PKEY_ECC
] & CERT_PKEY_SIGN
))
2711 mask_a
|= SSL_aECDSA
;
2715 #ifndef OPENSSL_NO_EC
2716 mask_k
|= SSL_kECDHE
;
2719 #ifndef OPENSSL_NO_PSK
2722 if (mask_k
& SSL_kRSA
)
2723 mask_k
|= SSL_kRSAPSK
;
2724 if (mask_k
& SSL_kDHE
)
2725 mask_k
|= SSL_kDHEPSK
;
2726 if (mask_k
& SSL_kECDHE
)
2727 mask_k
|= SSL_kECDHEPSK
;
2730 s
->s3
->tmp
.mask_k
= mask_k
;
2731 s
->s3
->tmp
.mask_a
= mask_a
;
2734 #ifndef OPENSSL_NO_EC
2736 int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
)
2738 if (s
->s3
->tmp
.new_cipher
->algorithm_auth
& SSL_aECDSA
) {
2739 /* key usage, if present, must allow signing */
2740 if (!(X509_get_key_usage(x
) & X509v3_KU_DIGITAL_SIGNATURE
)) {
2741 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG
,
2742 SSL_R_ECC_CERT_NOT_FOR_SIGNING
);
2746 return 1; /* all checks are ok */
2751 static int ssl_get_server_cert_index(const SSL
*s
)
2754 idx
= ssl_cipher_get_cert_index(s
->s3
->tmp
.new_cipher
);
2755 if (idx
== SSL_PKEY_RSA_ENC
&& !s
->cert
->pkeys
[SSL_PKEY_RSA_ENC
].x509
)
2756 idx
= SSL_PKEY_RSA_SIGN
;
2757 if (idx
== SSL_PKEY_GOST_EC
) {
2758 if (s
->cert
->pkeys
[SSL_PKEY_GOST12_512
].x509
)
2759 idx
= SSL_PKEY_GOST12_512
;
2760 else if (s
->cert
->pkeys
[SSL_PKEY_GOST12_256
].x509
)
2761 idx
= SSL_PKEY_GOST12_256
;
2762 else if (s
->cert
->pkeys
[SSL_PKEY_GOST01
].x509
)
2763 idx
= SSL_PKEY_GOST01
;
2768 SSLerr(SSL_F_SSL_GET_SERVER_CERT_INDEX
, ERR_R_INTERNAL_ERROR
);
2772 CERT_PKEY
*ssl_get_server_send_pkey(SSL
*s
)
2778 if (!s
->s3
|| !s
->s3
->tmp
.new_cipher
)
2782 i
= ssl_get_server_cert_index(s
);
2784 /* This may or may not be an error. */
2789 return &c
->pkeys
[i
];
2792 EVP_PKEY
*ssl_get_sign_pkey(SSL
*s
, const SSL_CIPHER
*cipher
,
2795 unsigned long alg_a
;
2799 alg_a
= cipher
->algorithm_auth
;
2802 if ((alg_a
& SSL_aDSS
) && (c
->pkeys
[SSL_PKEY_DSA_SIGN
].privatekey
!= NULL
))
2803 idx
= SSL_PKEY_DSA_SIGN
;
2804 else if (alg_a
& SSL_aRSA
) {
2805 if (c
->pkeys
[SSL_PKEY_RSA_SIGN
].privatekey
!= NULL
)
2806 idx
= SSL_PKEY_RSA_SIGN
;
2807 else if (c
->pkeys
[SSL_PKEY_RSA_ENC
].privatekey
!= NULL
)
2808 idx
= SSL_PKEY_RSA_ENC
;
2809 } else if ((alg_a
& SSL_aECDSA
) &&
2810 (c
->pkeys
[SSL_PKEY_ECC
].privatekey
!= NULL
))
2813 SSLerr(SSL_F_SSL_GET_SIGN_PKEY
, ERR_R_INTERNAL_ERROR
);
2817 *pmd
= s
->s3
->tmp
.md
[idx
];
2818 return c
->pkeys
[idx
].privatekey
;
2821 int ssl_get_server_cert_serverinfo(SSL
*s
, const unsigned char **serverinfo
,
2822 size_t *serverinfo_length
)
2826 *serverinfo_length
= 0;
2829 i
= ssl_get_server_cert_index(s
);
2833 if (c
->pkeys
[i
].serverinfo
== NULL
)
2836 *serverinfo
= c
->pkeys
[i
].serverinfo
;
2837 *serverinfo_length
= c
->pkeys
[i
].serverinfo_length
;
2841 void ssl_update_cache(SSL
*s
, int mode
)
2846 * If the session_id_length is 0, we are not supposed to cache it, and it
2847 * would be rather hard to do anyway :-)
2849 if (s
->session
->session_id_length
== 0)
2852 i
= s
->session_ctx
->session_cache_mode
;
2853 if ((i
& mode
) && (!s
->hit
)
2854 && ((i
& SSL_SESS_CACHE_NO_INTERNAL_STORE
)
2855 || SSL_CTX_add_session(s
->session_ctx
, s
->session
))
2856 && (s
->session_ctx
->new_session_cb
!= NULL
)) {
2857 SSL_SESSION_up_ref(s
->session
);
2858 if (!s
->session_ctx
->new_session_cb(s
, s
->session
))
2859 SSL_SESSION_free(s
->session
);
2862 /* auto flush every 255 connections */
2863 if ((!(i
& SSL_SESS_CACHE_NO_AUTO_CLEAR
)) && ((i
& mode
) == mode
)) {
2864 if ((((mode
& SSL_SESS_CACHE_CLIENT
)
2865 ? s
->session_ctx
->stats
.sess_connect_good
2866 : s
->session_ctx
->stats
.sess_accept_good
) & 0xff) == 0xff) {
2867 SSL_CTX_flush_sessions(s
->session_ctx
, (unsigned long)time(NULL
));
2872 const SSL_METHOD
*SSL_CTX_get_ssl_method(SSL_CTX
*ctx
)
2877 const SSL_METHOD
*SSL_get_ssl_method(SSL
*s
)
2882 int SSL_set_ssl_method(SSL
*s
, const SSL_METHOD
*meth
)
2886 if (s
->method
!= meth
) {
2887 const SSL_METHOD
*sm
= s
->method
;
2888 int (*hf
) (SSL
*) = s
->handshake_func
;
2890 if (sm
->version
== meth
->version
)
2895 ret
= s
->method
->ssl_new(s
);
2898 if (hf
== sm
->ssl_connect
)
2899 s
->handshake_func
= meth
->ssl_connect
;
2900 else if (hf
== sm
->ssl_accept
)
2901 s
->handshake_func
= meth
->ssl_accept
;
2906 int SSL_get_error(const SSL
*s
, int i
)
2913 return (SSL_ERROR_NONE
);
2916 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
2917 * where we do encode the error
2919 if ((l
= ERR_peek_error()) != 0) {
2920 if (ERR_GET_LIB(l
) == ERR_LIB_SYS
)
2921 return (SSL_ERROR_SYSCALL
);
2923 return (SSL_ERROR_SSL
);
2927 if (SSL_want_read(s
)) {
2928 bio
= SSL_get_rbio(s
);
2929 if (BIO_should_read(bio
))
2930 return (SSL_ERROR_WANT_READ
);
2931 else if (BIO_should_write(bio
))
2933 * This one doesn't make too much sense ... We never try to write
2934 * to the rbio, and an application program where rbio and wbio
2935 * are separate couldn't even know what it should wait for.
2936 * However if we ever set s->rwstate incorrectly (so that we have
2937 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
2938 * wbio *are* the same, this test works around that bug; so it
2939 * might be safer to keep it.
2941 return (SSL_ERROR_WANT_WRITE
);
2942 else if (BIO_should_io_special(bio
)) {
2943 reason
= BIO_get_retry_reason(bio
);
2944 if (reason
== BIO_RR_CONNECT
)
2945 return (SSL_ERROR_WANT_CONNECT
);
2946 else if (reason
== BIO_RR_ACCEPT
)
2947 return (SSL_ERROR_WANT_ACCEPT
);
2949 return (SSL_ERROR_SYSCALL
); /* unknown */
2953 if (SSL_want_write(s
)) {
2955 * Access wbio directly - in order to use the buffered bio if
2959 if (BIO_should_write(bio
))
2960 return (SSL_ERROR_WANT_WRITE
);
2961 else if (BIO_should_read(bio
))
2963 * See above (SSL_want_read(s) with BIO_should_write(bio))
2965 return (SSL_ERROR_WANT_READ
);
2966 else if (BIO_should_io_special(bio
)) {
2967 reason
= BIO_get_retry_reason(bio
);
2968 if (reason
== BIO_RR_CONNECT
)
2969 return (SSL_ERROR_WANT_CONNECT
);
2970 else if (reason
== BIO_RR_ACCEPT
)
2971 return (SSL_ERROR_WANT_ACCEPT
);
2973 return (SSL_ERROR_SYSCALL
);
2976 if (SSL_want_x509_lookup(s
)) {
2977 return (SSL_ERROR_WANT_X509_LOOKUP
);
2979 if (SSL_want_async(s
)) {
2980 return SSL_ERROR_WANT_ASYNC
;
2982 if (SSL_want_async_job(s
)) {
2983 return SSL_ERROR_WANT_ASYNC_JOB
;
2988 if ((s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) &&
2989 (s
->s3
->warn_alert
== SSL_AD_CLOSE_NOTIFY
))
2990 return (SSL_ERROR_ZERO_RETURN
);
2992 return (SSL_ERROR_SYSCALL
);
2995 static int ssl_do_handshake_intern(void *vargs
)
2997 struct ssl_async_args
*args
;
3000 args
= (struct ssl_async_args
*)vargs
;
3003 return s
->handshake_func(s
);
3006 int SSL_do_handshake(SSL
*s
)
3010 if (s
->handshake_func
== NULL
) {
3011 SSLerr(SSL_F_SSL_DO_HANDSHAKE
, SSL_R_CONNECTION_TYPE_NOT_SET
);
3015 s
->method
->ssl_renegotiate_check(s
);
3017 if (SSL_in_init(s
) || SSL_in_before(s
)) {
3018 if ((s
->mode
& SSL_MODE_ASYNC
) && ASYNC_get_current_job() == NULL
) {
3019 struct ssl_async_args args
;
3023 ret
= ssl_start_async_job(s
, &args
, ssl_do_handshake_intern
);
3025 ret
= s
->handshake_func(s
);
3031 void SSL_set_accept_state(SSL
*s
)
3035 ossl_statem_clear(s
);
3036 s
->handshake_func
= s
->method
->ssl_accept
;
3040 void SSL_set_connect_state(SSL
*s
)
3044 ossl_statem_clear(s
);
3045 s
->handshake_func
= s
->method
->ssl_connect
;
3049 int ssl_undefined_function(SSL
*s
)
3051 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3055 int ssl_undefined_void_function(void)
3057 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION
,
3058 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3062 int ssl_undefined_const_function(const SSL
*s
)
3067 const SSL_METHOD
*ssl_bad_method(int ver
)
3069 SSLerr(SSL_F_SSL_BAD_METHOD
, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED
);
3073 const char *ssl_protocol_to_string(int version
)
3075 if (version
== TLS1_2_VERSION
)
3077 else if (version
== TLS1_1_VERSION
)
3079 else if (version
== TLS1_VERSION
)
3081 else if (version
== SSL3_VERSION
)
3083 else if (version
== DTLS1_BAD_VER
)
3085 else if (version
== DTLS1_VERSION
)
3087 else if (version
== DTLS1_2_VERSION
)
3093 const char *SSL_get_version(const SSL
*s
)
3095 return ssl_protocol_to_string(s
->version
);
3098 SSL
*SSL_dup(SSL
*s
)
3100 STACK_OF(X509_NAME
) *sk
;
3105 /* If we're not quiescent, just up_ref! */
3106 if (!SSL_in_init(s
) || !SSL_in_before(s
)) {
3107 CRYPTO_atomic_add(&s
->references
, 1, &i
, s
->lock
);
3112 * Otherwise, copy configuration state, and session if set.
3114 if ((ret
= SSL_new(SSL_get_SSL_CTX(s
))) == NULL
)
3117 if (s
->session
!= NULL
) {
3119 * Arranges to share the same session via up_ref. This "copies"
3120 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3122 if (!SSL_copy_session_id(ret
, s
))
3126 * No session has been established yet, so we have to expect that
3127 * s->cert or ret->cert will be changed later -- they should not both
3128 * point to the same object, and thus we can't use
3129 * SSL_copy_session_id.
3131 if (!SSL_set_ssl_method(ret
, s
->method
))
3134 if (s
->cert
!= NULL
) {
3135 ssl_cert_free(ret
->cert
);
3136 ret
->cert
= ssl_cert_dup(s
->cert
);
3137 if (ret
->cert
== NULL
)
3141 if (!SSL_set_session_id_context(ret
, s
->sid_ctx
, s
->sid_ctx_length
))
3145 if (!ssl_dane_dup(ret
, s
))
3147 ret
->version
= s
->version
;
3148 ret
->options
= s
->options
;
3149 ret
->mode
= s
->mode
;
3150 SSL_set_max_cert_list(ret
, SSL_get_max_cert_list(s
));
3151 SSL_set_read_ahead(ret
, SSL_get_read_ahead(s
));
3152 ret
->msg_callback
= s
->msg_callback
;
3153 ret
->msg_callback_arg
= s
->msg_callback_arg
;
3154 SSL_set_verify(ret
, SSL_get_verify_mode(s
), SSL_get_verify_callback(s
));
3155 SSL_set_verify_depth(ret
, SSL_get_verify_depth(s
));
3156 ret
->generate_session_id
= s
->generate_session_id
;
3158 SSL_set_info_callback(ret
, SSL_get_info_callback(s
));
3160 /* copy app data, a little dangerous perhaps */
3161 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL
, &ret
->ex_data
, &s
->ex_data
))
3164 /* setup rbio, and wbio */
3165 if (s
->rbio
!= NULL
) {
3166 if (!BIO_dup_state(s
->rbio
, (char *)&ret
->rbio
))
3169 if (s
->wbio
!= NULL
) {
3170 if (s
->wbio
!= s
->rbio
) {
3171 if (!BIO_dup_state(s
->wbio
, (char *)&ret
->wbio
))
3174 BIO_up_ref(ret
->rbio
);
3175 ret
->wbio
= ret
->rbio
;
3179 ret
->server
= s
->server
;
3180 if (s
->handshake_func
) {
3182 SSL_set_accept_state(ret
);
3184 SSL_set_connect_state(ret
);
3186 ret
->shutdown
= s
->shutdown
;
3189 ret
->default_passwd_callback
= s
->default_passwd_callback
;
3190 ret
->default_passwd_callback_userdata
= s
->default_passwd_callback_userdata
;
3192 X509_VERIFY_PARAM_inherit(ret
->param
, s
->param
);
3194 /* dup the cipher_list and cipher_list_by_id stacks */
3195 if (s
->cipher_list
!= NULL
) {
3196 if ((ret
->cipher_list
= sk_SSL_CIPHER_dup(s
->cipher_list
)) == NULL
)
3199 if (s
->cipher_list_by_id
!= NULL
)
3200 if ((ret
->cipher_list_by_id
= sk_SSL_CIPHER_dup(s
->cipher_list_by_id
))
3204 /* Dup the client_CA list */
3205 if (s
->client_CA
!= NULL
) {
3206 if ((sk
= sk_X509_NAME_dup(s
->client_CA
)) == NULL
)
3208 ret
->client_CA
= sk
;
3209 for (i
= 0; i
< sk_X509_NAME_num(sk
); i
++) {
3210 xn
= sk_X509_NAME_value(sk
, i
);
3211 if (sk_X509_NAME_set(sk
, i
, X509_NAME_dup(xn
)) == NULL
) {
3224 void ssl_clear_cipher_ctx(SSL
*s
)
3226 if (s
->enc_read_ctx
!= NULL
) {
3227 EVP_CIPHER_CTX_free(s
->enc_read_ctx
);
3228 s
->enc_read_ctx
= NULL
;
3230 if (s
->enc_write_ctx
!= NULL
) {
3231 EVP_CIPHER_CTX_free(s
->enc_write_ctx
);
3232 s
->enc_write_ctx
= NULL
;
3234 #ifndef OPENSSL_NO_COMP
3235 COMP_CTX_free(s
->expand
);
3237 COMP_CTX_free(s
->compress
);
3242 X509
*SSL_get_certificate(const SSL
*s
)
3244 if (s
->cert
!= NULL
)
3245 return (s
->cert
->key
->x509
);
3250 EVP_PKEY
*SSL_get_privatekey(const SSL
*s
)
3252 if (s
->cert
!= NULL
)
3253 return (s
->cert
->key
->privatekey
);
3258 X509
*SSL_CTX_get0_certificate(const SSL_CTX
*ctx
)
3260 if (ctx
->cert
!= NULL
)
3261 return ctx
->cert
->key
->x509
;
3266 EVP_PKEY
*SSL_CTX_get0_privatekey(const SSL_CTX
*ctx
)
3268 if (ctx
->cert
!= NULL
)
3269 return ctx
->cert
->key
->privatekey
;
3274 const SSL_CIPHER
*SSL_get_current_cipher(const SSL
*s
)
3276 if ((s
->session
!= NULL
) && (s
->session
->cipher
!= NULL
))
3277 return (s
->session
->cipher
);
3281 const COMP_METHOD
*SSL_get_current_compression(SSL
*s
)
3283 #ifndef OPENSSL_NO_COMP
3284 return s
->compress
? COMP_CTX_get_method(s
->compress
) : NULL
;
3290 const COMP_METHOD
*SSL_get_current_expansion(SSL
*s
)
3292 #ifndef OPENSSL_NO_COMP
3293 return s
->expand
? COMP_CTX_get_method(s
->expand
) : NULL
;
3299 int ssl_init_wbio_buffer(SSL
*s
)
3303 if (s
->bbio
!= NULL
) {
3304 /* Already buffered. */
3308 bbio
= BIO_new(BIO_f_buffer());
3309 if (bbio
== NULL
|| !BIO_set_read_buffer_size(bbio
, 1)) {
3311 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER
, ERR_R_BUF_LIB
);
3315 s
->wbio
= BIO_push(bbio
, s
->wbio
);
3320 void ssl_free_wbio_buffer(SSL
*s
)
3322 /* callers ensure s is never null */
3323 if (s
->bbio
== NULL
)
3326 s
->wbio
= BIO_pop(s
->wbio
);
3327 assert(s
->wbio
!= NULL
);
3332 void SSL_CTX_set_quiet_shutdown(SSL_CTX
*ctx
, int mode
)
3334 ctx
->quiet_shutdown
= mode
;
3337 int SSL_CTX_get_quiet_shutdown(const SSL_CTX
*ctx
)
3339 return (ctx
->quiet_shutdown
);
3342 void SSL_set_quiet_shutdown(SSL
*s
, int mode
)
3344 s
->quiet_shutdown
= mode
;
3347 int SSL_get_quiet_shutdown(const SSL
*s
)
3349 return (s
->quiet_shutdown
);
3352 void SSL_set_shutdown(SSL
*s
, int mode
)
3357 int SSL_get_shutdown(const SSL
*s
)
3362 int SSL_version(const SSL
*s
)
3367 int SSL_client_version(const SSL
*s
)
3369 return s
->client_version
;
3372 SSL_CTX
*SSL_get_SSL_CTX(const SSL
*ssl
)
3377 SSL_CTX
*SSL_set_SSL_CTX(SSL
*ssl
, SSL_CTX
*ctx
)
3380 if (ssl
->ctx
== ctx
)
3383 ctx
= ssl
->initial_ctx
;
3384 new_cert
= ssl_cert_dup(ctx
->cert
);
3385 if (new_cert
== NULL
) {
3388 ssl_cert_free(ssl
->cert
);
3389 ssl
->cert
= new_cert
;
3392 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3393 * so setter APIs must prevent invalid lengths from entering the system.
3395 OPENSSL_assert(ssl
->sid_ctx_length
<= sizeof(ssl
->sid_ctx
));
3398 * If the session ID context matches that of the parent SSL_CTX,
3399 * inherit it from the new SSL_CTX as well. If however the context does
3400 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3401 * leave it unchanged.
3403 if ((ssl
->ctx
!= NULL
) &&
3404 (ssl
->sid_ctx_length
== ssl
->ctx
->sid_ctx_length
) &&
3405 (memcmp(ssl
->sid_ctx
, ssl
->ctx
->sid_ctx
, ssl
->sid_ctx_length
) == 0)) {
3406 ssl
->sid_ctx_length
= ctx
->sid_ctx_length
;
3407 memcpy(&ssl
->sid_ctx
, &ctx
->sid_ctx
, sizeof(ssl
->sid_ctx
));
3410 SSL_CTX_up_ref(ctx
);
3411 SSL_CTX_free(ssl
->ctx
); /* decrement reference count */
3417 int SSL_CTX_set_default_verify_paths(SSL_CTX
*ctx
)
3419 return (X509_STORE_set_default_paths(ctx
->cert_store
));
3422 int SSL_CTX_set_default_verify_dir(SSL_CTX
*ctx
)
3424 X509_LOOKUP
*lookup
;
3426 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_hash_dir());
3429 X509_LOOKUP_add_dir(lookup
, NULL
, X509_FILETYPE_DEFAULT
);
3431 /* Clear any errors if the default directory does not exist */
3437 int SSL_CTX_set_default_verify_file(SSL_CTX
*ctx
)
3439 X509_LOOKUP
*lookup
;
3441 lookup
= X509_STORE_add_lookup(ctx
->cert_store
, X509_LOOKUP_file());
3445 X509_LOOKUP_load_file(lookup
, NULL
, X509_FILETYPE_DEFAULT
);
3447 /* Clear any errors if the default file does not exist */
3453 int SSL_CTX_load_verify_locations(SSL_CTX
*ctx
, const char *CAfile
,
3456 return (X509_STORE_load_locations(ctx
->cert_store
, CAfile
, CApath
));
3459 void SSL_set_info_callback(SSL
*ssl
,
3460 void (*cb
) (const SSL
*ssl
, int type
, int val
))
3462 ssl
->info_callback
= cb
;
3466 * One compiler (Diab DCC) doesn't like argument names in returned function
3469 void (*SSL_get_info_callback(const SSL
*ssl
)) (const SSL
* /* ssl */ ,
3472 return ssl
->info_callback
;
3475 void SSL_set_verify_result(SSL
*ssl
, long arg
)
3477 ssl
->verify_result
= arg
;
3480 long SSL_get_verify_result(const SSL
*ssl
)
3482 return (ssl
->verify_result
);
3485 size_t SSL_get_client_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
3488 return sizeof(ssl
->s3
->client_random
);
3489 if (outlen
> sizeof(ssl
->s3
->client_random
))
3490 outlen
= sizeof(ssl
->s3
->client_random
);
3491 memcpy(out
, ssl
->s3
->client_random
, outlen
);
3495 size_t SSL_get_server_random(const SSL
*ssl
, unsigned char *out
, size_t outlen
)
3498 return sizeof(ssl
->s3
->server_random
);
3499 if (outlen
> sizeof(ssl
->s3
->server_random
))
3500 outlen
= sizeof(ssl
->s3
->server_random
);
3501 memcpy(out
, ssl
->s3
->server_random
, outlen
);
3505 size_t SSL_SESSION_get_master_key(const SSL_SESSION
*session
,
3506 unsigned char *out
, size_t outlen
)
3508 if (session
->master_key_length
< 0) {
3509 /* Should never happen */
3513 return session
->master_key_length
;
3514 if (outlen
> (size_t)session
->master_key_length
)
3515 outlen
= session
->master_key_length
;
3516 memcpy(out
, session
->master_key
, outlen
);
3520 int SSL_set_ex_data(SSL
*s
, int idx
, void *arg
)
3522 return (CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
));
3525 void *SSL_get_ex_data(const SSL
*s
, int idx
)
3527 return (CRYPTO_get_ex_data(&s
->ex_data
, idx
));
3530 int SSL_CTX_set_ex_data(SSL_CTX
*s
, int idx
, void *arg
)
3532 return (CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
));
3535 void *SSL_CTX_get_ex_data(const SSL_CTX
*s
, int idx
)
3537 return (CRYPTO_get_ex_data(&s
->ex_data
, idx
));
3545 X509_STORE
*SSL_CTX_get_cert_store(const SSL_CTX
*ctx
)
3547 return (ctx
->cert_store
);
3550 void SSL_CTX_set_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
3552 X509_STORE_free(ctx
->cert_store
);
3553 ctx
->cert_store
= store
;
3556 void SSL_CTX_set1_cert_store(SSL_CTX
*ctx
, X509_STORE
*store
)
3559 X509_STORE_up_ref(store
);
3560 SSL_CTX_set_cert_store(ctx
, store
);
3563 int SSL_want(const SSL
*s
)
3565 return (s
->rwstate
);
3569 * \brief Set the callback for generating temporary DH keys.
3570 * \param ctx the SSL context.
3571 * \param dh the callback
3574 #ifndef OPENSSL_NO_DH
3575 void SSL_CTX_set_tmp_dh_callback(SSL_CTX
*ctx
,
3576 DH
*(*dh
) (SSL
*ssl
, int is_export
,
3579 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_TMP_DH_CB
, (void (*)(void))dh
);
3582 void SSL_set_tmp_dh_callback(SSL
*ssl
, DH
*(*dh
) (SSL
*ssl
, int is_export
,
3585 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_TMP_DH_CB
, (void (*)(void))dh
);
3589 #ifndef OPENSSL_NO_PSK
3590 int SSL_CTX_use_psk_identity_hint(SSL_CTX
*ctx
, const char *identity_hint
)
3592 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
3593 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT
, SSL_R_DATA_LENGTH_TOO_LONG
);
3596 OPENSSL_free(ctx
->cert
->psk_identity_hint
);
3597 if (identity_hint
!= NULL
) {
3598 ctx
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
3599 if (ctx
->cert
->psk_identity_hint
== NULL
)
3602 ctx
->cert
->psk_identity_hint
= NULL
;
3606 int SSL_use_psk_identity_hint(SSL
*s
, const char *identity_hint
)
3611 if (identity_hint
!= NULL
&& strlen(identity_hint
) > PSK_MAX_IDENTITY_LEN
) {
3612 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT
, SSL_R_DATA_LENGTH_TOO_LONG
);
3615 OPENSSL_free(s
->cert
->psk_identity_hint
);
3616 if (identity_hint
!= NULL
) {
3617 s
->cert
->psk_identity_hint
= OPENSSL_strdup(identity_hint
);
3618 if (s
->cert
->psk_identity_hint
== NULL
)
3621 s
->cert
->psk_identity_hint
= NULL
;
3625 const char *SSL_get_psk_identity_hint(const SSL
*s
)
3627 if (s
== NULL
|| s
->session
== NULL
)
3629 return (s
->session
->psk_identity_hint
);
3632 const char *SSL_get_psk_identity(const SSL
*s
)
3634 if (s
== NULL
|| s
->session
== NULL
)
3636 return (s
->session
->psk_identity
);
3639 void SSL_set_psk_client_callback(SSL
*s
,
3640 unsigned int (*cb
) (SSL
*ssl
,
3646 unsigned int max_psk_len
))
3648 s
->psk_client_callback
= cb
;
3651 void SSL_CTX_set_psk_client_callback(SSL_CTX
*ctx
,
3652 unsigned int (*cb
) (SSL
*ssl
,
3661 ctx
->psk_client_callback
= cb
;
3664 void SSL_set_psk_server_callback(SSL
*s
,
3665 unsigned int (*cb
) (SSL
*ssl
,
3666 const char *identity
,
3668 unsigned int max_psk_len
))
3670 s
->psk_server_callback
= cb
;
3673 void SSL_CTX_set_psk_server_callback(SSL_CTX
*ctx
,
3674 unsigned int (*cb
) (SSL
*ssl
,
3675 const char *identity
,
3680 ctx
->psk_server_callback
= cb
;
3684 void SSL_CTX_set_msg_callback(SSL_CTX
*ctx
,
3685 void (*cb
) (int write_p
, int version
,
3686 int content_type
, const void *buf
,
3687 size_t len
, SSL
*ssl
, void *arg
))
3689 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
3692 void SSL_set_msg_callback(SSL
*ssl
,
3693 void (*cb
) (int write_p
, int version
,
3694 int content_type
, const void *buf
,
3695 size_t len
, SSL
*ssl
, void *arg
))
3697 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_MSG_CALLBACK
, (void (*)(void))cb
);
3700 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX
*ctx
,
3701 int (*cb
) (SSL
*ssl
,
3705 SSL_CTX_callback_ctrl(ctx
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
3706 (void (*)(void))cb
);
3709 void SSL_set_not_resumable_session_callback(SSL
*ssl
,
3710 int (*cb
) (SSL
*ssl
,
3711 int is_forward_secure
))
3713 SSL_callback_ctrl(ssl
, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB
,
3714 (void (*)(void))cb
);
3718 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3719 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3720 * If EVP_MD pointer is passed, initializes ctx with this md Returns newly
3724 EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
)
3726 ssl_clear_hash_ctx(hash
);
3727 *hash
= EVP_MD_CTX_new();
3728 if (*hash
== NULL
|| (md
&& EVP_DigestInit_ex(*hash
, md
, NULL
) <= 0)) {
3729 EVP_MD_CTX_free(*hash
);
3736 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
)
3740 EVP_MD_CTX_free(*hash
);
3744 /* Retrieve handshake hashes */
3745 int ssl_handshake_hash(SSL
*s
, unsigned char *out
, int outlen
)
3747 EVP_MD_CTX
*ctx
= NULL
;
3748 EVP_MD_CTX
*hdgst
= s
->s3
->handshake_dgst
;
3749 int ret
= EVP_MD_CTX_size(hdgst
);
3750 if (ret
< 0 || ret
> outlen
) {
3754 ctx
= EVP_MD_CTX_new();
3759 if (!EVP_MD_CTX_copy_ex(ctx
, hdgst
)
3760 || EVP_DigestFinal_ex(ctx
, out
, NULL
) <= 0)
3763 EVP_MD_CTX_free(ctx
);
3767 int SSL_session_reused(SSL
*s
)
3772 int SSL_is_server(SSL
*s
)
3777 #if OPENSSL_API_COMPAT < 0x10100000L
3778 void SSL_set_debug(SSL
*s
, int debug
)
3780 /* Old function was do-nothing anyway... */
3786 void SSL_set_security_level(SSL
*s
, int level
)
3788 s
->cert
->sec_level
= level
;
3791 int SSL_get_security_level(const SSL
*s
)
3793 return s
->cert
->sec_level
;
3796 void SSL_set_security_callback(SSL
*s
,
3797 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
3798 int op
, int bits
, int nid
,
3799 void *other
, void *ex
))
3801 s
->cert
->sec_cb
= cb
;
3804 int (*SSL_get_security_callback(const SSL
*s
)) (const SSL
*s
,
3805 const SSL_CTX
*ctx
, int op
,
3806 int bits
, int nid
, void *other
,
3808 return s
->cert
->sec_cb
;
3811 void SSL_set0_security_ex_data(SSL
*s
, void *ex
)
3813 s
->cert
->sec_ex
= ex
;
3816 void *SSL_get0_security_ex_data(const SSL
*s
)
3818 return s
->cert
->sec_ex
;
3821 void SSL_CTX_set_security_level(SSL_CTX
*ctx
, int level
)
3823 ctx
->cert
->sec_level
= level
;
3826 int SSL_CTX_get_security_level(const SSL_CTX
*ctx
)
3828 return ctx
->cert
->sec_level
;
3831 void SSL_CTX_set_security_callback(SSL_CTX
*ctx
,
3832 int (*cb
) (const SSL
*s
, const SSL_CTX
*ctx
,
3833 int op
, int bits
, int nid
,
3834 void *other
, void *ex
))
3836 ctx
->cert
->sec_cb
= cb
;
3839 int (*SSL_CTX_get_security_callback(const SSL_CTX
*ctx
)) (const SSL
*s
,
3845 return ctx
->cert
->sec_cb
;
3848 void SSL_CTX_set0_security_ex_data(SSL_CTX
*ctx
, void *ex
)
3850 ctx
->cert
->sec_ex
= ex
;
3853 void *SSL_CTX_get0_security_ex_data(const SSL_CTX
*ctx
)
3855 return ctx
->cert
->sec_ex
;
3859 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3860 * can return unsigned long, instead of the generic long return value from the
3861 * control interface.
3863 unsigned long SSL_CTX_get_options(const SSL_CTX
*ctx
)
3865 return ctx
->options
;
3868 unsigned long SSL_get_options(const SSL
*s
)
3873 unsigned long SSL_CTX_set_options(SSL_CTX
*ctx
, unsigned long op
)
3875 return ctx
->options
|= op
;
3878 unsigned long SSL_set_options(SSL
*s
, unsigned long op
)
3880 return s
->options
|= op
;
3883 unsigned long SSL_CTX_clear_options(SSL_CTX
*ctx
, unsigned long op
)
3885 return ctx
->options
&= ~op
;
3888 unsigned long SSL_clear_options(SSL
*s
, unsigned long op
)
3890 return s
->options
&= ~op
;
3893 STACK_OF(X509
) *SSL_get0_verified_chain(const SSL
*s
)
3895 return s
->verified_chain
;
3898 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
3900 #ifndef OPENSSL_NO_CT
3903 * Moves SCTs from the |src| stack to the |dst| stack.
3904 * The source of each SCT will be set to |origin|.
3905 * If |dst| points to a NULL pointer, a new stack will be created and owned by
3907 * Returns the number of SCTs moved, or a negative integer if an error occurs.
3909 static int ct_move_scts(STACK_OF(SCT
) **dst
, STACK_OF(SCT
) *src
,
3910 sct_source_t origin
)
3916 *dst
= sk_SCT_new_null();
3918 SSLerr(SSL_F_CT_MOVE_SCTS
, ERR_R_MALLOC_FAILURE
);
3923 while ((sct
= sk_SCT_pop(src
)) != NULL
) {
3924 if (SCT_set_source(sct
, origin
) != 1)
3927 if (sk_SCT_push(*dst
, sct
) <= 0)
3935 sk_SCT_push(src
, sct
); /* Put the SCT back */
3940 * Look for data collected during ServerHello and parse if found.
3941 * Returns the number of SCTs extracted.
3943 static int ct_extract_tls_extension_scts(SSL
*s
)
3945 int scts_extracted
= 0;
3947 if (s
->tlsext_scts
!= NULL
) {
3948 const unsigned char *p
= s
->tlsext_scts
;
3949 STACK_OF(SCT
) *scts
= o2i_SCT_LIST(NULL
, &p
, s
->tlsext_scts_len
);
3951 scts_extracted
= ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_TLS_EXTENSION
);
3953 SCT_LIST_free(scts
);
3956 return scts_extracted
;
3960 * Checks for an OCSP response and then attempts to extract any SCTs found if it
3961 * contains an SCT X509 extension. They will be stored in |s->scts|.
3963 * - The number of SCTs extracted, assuming an OCSP response exists.
3964 * - 0 if no OCSP response exists or it contains no SCTs.
3965 * - A negative integer if an error occurs.
3967 static int ct_extract_ocsp_response_scts(SSL
*s
)
3969 # ifndef OPENSSL_NO_OCSP
3970 int scts_extracted
= 0;
3971 const unsigned char *p
;
3972 OCSP_BASICRESP
*br
= NULL
;
3973 OCSP_RESPONSE
*rsp
= NULL
;
3974 STACK_OF(SCT
) *scts
= NULL
;
3977 if (s
->tlsext_ocsp_resp
== NULL
|| s
->tlsext_ocsp_resplen
== 0)
3980 p
= s
->tlsext_ocsp_resp
;
3981 rsp
= d2i_OCSP_RESPONSE(NULL
, &p
, s
->tlsext_ocsp_resplen
);
3985 br
= OCSP_response_get1_basic(rsp
);
3989 for (i
= 0; i
< OCSP_resp_count(br
); ++i
) {
3990 OCSP_SINGLERESP
*single
= OCSP_resp_get0(br
, i
);
3996 OCSP_SINGLERESP_get1_ext_d2i(single
, NID_ct_cert_scts
, NULL
, NULL
);
3998 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_OCSP_STAPLED_RESPONSE
);
3999 if (scts_extracted
< 0)
4003 SCT_LIST_free(scts
);
4004 OCSP_BASICRESP_free(br
);
4005 OCSP_RESPONSE_free(rsp
);
4006 return scts_extracted
;
4008 /* Behave as if no OCSP response exists */
4014 * Attempts to extract SCTs from the peer certificate.
4015 * Return the number of SCTs extracted, or a negative integer if an error
4018 static int ct_extract_x509v3_extension_scts(SSL
*s
)
4020 int scts_extracted
= 0;
4021 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
4024 STACK_OF(SCT
) *scts
=
4025 X509_get_ext_d2i(cert
, NID_ct_precert_scts
, NULL
, NULL
);
4028 ct_move_scts(&s
->scts
, scts
, SCT_SOURCE_X509V3_EXTENSION
);
4030 SCT_LIST_free(scts
);
4033 return scts_extracted
;
4037 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4038 * response (if it exists) and X509v3 extensions in the certificate.
4039 * Returns NULL if an error occurs.
4041 const STACK_OF(SCT
) *SSL_get0_peer_scts(SSL
*s
)
4043 if (!s
->scts_parsed
) {
4044 if (ct_extract_tls_extension_scts(s
) < 0 ||
4045 ct_extract_ocsp_response_scts(s
) < 0 ||
4046 ct_extract_x509v3_extension_scts(s
) < 0)
4056 static int ct_permissive(const CT_POLICY_EVAL_CTX
* ctx
,
4057 const STACK_OF(SCT
) *scts
, void *unused_arg
)
4062 static int ct_strict(const CT_POLICY_EVAL_CTX
* ctx
,
4063 const STACK_OF(SCT
) *scts
, void *unused_arg
)
4065 int count
= scts
!= NULL
? sk_SCT_num(scts
) : 0;
4068 for (i
= 0; i
< count
; ++i
) {
4069 SCT
*sct
= sk_SCT_value(scts
, i
);
4070 int status
= SCT_get_validation_status(sct
);
4072 if (status
== SCT_VALIDATION_STATUS_VALID
)
4075 SSLerr(SSL_F_CT_STRICT
, SSL_R_NO_VALID_SCTS
);
4079 int SSL_set_ct_validation_callback(SSL
*s
, ssl_ct_validation_cb callback
,
4083 * Since code exists that uses the custom extension handler for CT, look
4084 * for this and throw an error if they have already registered to use CT.
4086 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(s
->ctx
,
4087 TLSEXT_TYPE_signed_certificate_timestamp
))
4089 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK
,
4090 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
4094 if (callback
!= NULL
) {
4096 * If we are validating CT, then we MUST accept SCTs served via OCSP
4098 if (!SSL_set_tlsext_status_type(s
, TLSEXT_STATUSTYPE_ocsp
))
4102 s
->ct_validation_callback
= callback
;
4103 s
->ct_validation_callback_arg
= arg
;
4108 int SSL_CTX_set_ct_validation_callback(SSL_CTX
*ctx
,
4109 ssl_ct_validation_cb callback
, void *arg
)
4112 * Since code exists that uses the custom extension handler for CT, look for
4113 * this and throw an error if they have already registered to use CT.
4115 if (callback
!= NULL
&& SSL_CTX_has_client_custom_ext(ctx
,
4116 TLSEXT_TYPE_signed_certificate_timestamp
))
4118 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK
,
4119 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED
);
4123 ctx
->ct_validation_callback
= callback
;
4124 ctx
->ct_validation_callback_arg
= arg
;
4128 int SSL_ct_is_enabled(const SSL
*s
)
4130 return s
->ct_validation_callback
!= NULL
;
4133 int SSL_CTX_ct_is_enabled(const SSL_CTX
*ctx
)
4135 return ctx
->ct_validation_callback
!= NULL
;
4138 int ssl_validate_ct(SSL
*s
)
4141 X509
*cert
= s
->session
!= NULL
? s
->session
->peer
: NULL
;
4143 SSL_DANE
*dane
= &s
->dane
;
4144 CT_POLICY_EVAL_CTX
*ctx
= NULL
;
4145 const STACK_OF(SCT
) *scts
;
4148 * If no callback is set, the peer is anonymous, or its chain is invalid,
4149 * skip SCT validation - just return success. Applications that continue
4150 * handshakes without certificates, with unverified chains, or pinned leaf
4151 * certificates are outside the scope of the WebPKI and CT.
4153 * The above exclusions notwithstanding the vast majority of peers will
4154 * have rather ordinary certificate chains validated by typical
4155 * applications that perform certificate verification and therefore will
4156 * process SCTs when enabled.
4158 if (s
->ct_validation_callback
== NULL
|| cert
== NULL
||
4159 s
->verify_result
!= X509_V_OK
||
4160 s
->verified_chain
== NULL
|| sk_X509_num(s
->verified_chain
) <= 1)
4164 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4165 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4167 if (DANETLS_ENABLED(dane
) && dane
->mtlsa
!= NULL
) {
4168 switch (dane
->mtlsa
->usage
) {
4169 case DANETLS_USAGE_DANE_TA
:
4170 case DANETLS_USAGE_DANE_EE
:
4175 ctx
= CT_POLICY_EVAL_CTX_new();
4177 SSLerr(SSL_F_SSL_VALIDATE_CT
, ERR_R_MALLOC_FAILURE
);
4181 issuer
= sk_X509_value(s
->verified_chain
, 1);
4182 CT_POLICY_EVAL_CTX_set1_cert(ctx
, cert
);
4183 CT_POLICY_EVAL_CTX_set1_issuer(ctx
, issuer
);
4184 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx
, s
->ctx
->ctlog_store
);
4186 scts
= SSL_get0_peer_scts(s
);
4189 * This function returns success (> 0) only when all the SCTs are valid, 0
4190 * when some are invalid, and < 0 on various internal errors (out of
4191 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4192 * reason to abort the handshake, that decision is up to the callback.
4193 * Therefore, we error out only in the unexpected case that the return
4194 * value is negative.
4196 * XXX: One might well argue that the return value of this function is an
4197 * unfortunate design choice. Its job is only to determine the validation
4198 * status of each of the provided SCTs. So long as it correctly separates
4199 * the wheat from the chaff it should return success. Failure in this case
4200 * ought to correspond to an inability to carry out its duties.
4202 if (SCT_LIST_validate(scts
, ctx
) < 0) {
4203 SSLerr(SSL_F_SSL_VALIDATE_CT
, SSL_R_SCT_VERIFICATION_FAILED
);
4207 ret
= s
->ct_validation_callback(ctx
, scts
, s
->ct_validation_callback_arg
);
4209 ret
= 0; /* This function returns 0 on failure */
4212 CT_POLICY_EVAL_CTX_free(ctx
);
4214 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4215 * failure return code here. Also the application may wish the complete
4216 * the handshake, and then disconnect cleanly at a higher layer, after
4217 * checking the verification status of the completed connection.
4219 * We therefore force a certificate verification failure which will be
4220 * visible via SSL_get_verify_result() and cached as part of any resumed
4223 * Note: the permissive callback is for information gathering only, always
4224 * returns success, and does not affect verification status. Only the
4225 * strict callback or a custom application-specified callback can trigger
4226 * connection failure or record a verification error.
4229 s
->verify_result
= X509_V_ERR_NO_VALID_SCTS
;
4233 int SSL_CTX_enable_ct(SSL_CTX
*ctx
, int validation_mode
)
4235 switch (validation_mode
) {
4237 SSLerr(SSL_F_SSL_CTX_ENABLE_CT
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
4239 case SSL_CT_VALIDATION_PERMISSIVE
:
4240 return SSL_CTX_set_ct_validation_callback(ctx
, ct_permissive
, NULL
);
4241 case SSL_CT_VALIDATION_STRICT
:
4242 return SSL_CTX_set_ct_validation_callback(ctx
, ct_strict
, NULL
);
4246 int SSL_enable_ct(SSL
*s
, int validation_mode
)
4248 switch (validation_mode
) {
4250 SSLerr(SSL_F_SSL_ENABLE_CT
, SSL_R_INVALID_CT_VALIDATION_TYPE
);
4252 case SSL_CT_VALIDATION_PERMISSIVE
:
4253 return SSL_set_ct_validation_callback(s
, ct_permissive
, NULL
);
4254 case SSL_CT_VALIDATION_STRICT
:
4255 return SSL_set_ct_validation_callback(s
, ct_strict
, NULL
);
4259 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX
*ctx
)
4261 return CTLOG_STORE_load_default_file(ctx
->ctlog_store
);
4264 int SSL_CTX_set_ctlog_list_file(SSL_CTX
*ctx
, const char *path
)
4266 return CTLOG_STORE_load_file(ctx
->ctlog_store
, path
);
4269 void SSL_CTX_set0_ctlog_store(SSL_CTX
*ctx
, CTLOG_STORE
* logs
)
4271 CTLOG_STORE_free(ctx
->ctlog_store
);
4272 ctx
->ctlog_store
= logs
;
4275 const CTLOG_STORE
*SSL_CTX_get0_ctlog_store(const SSL_CTX
*ctx
)
4277 return ctx
->ctlog_store
;