2 * ! \file ssl/ssl_lib.c \brief Version independent SSL functions.
4 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
7 * This package is an SSL implementation written
8 * by Eric Young (eay@cryptsoft.com).
9 * The implementation was written so as to conform with Netscapes SSL.
11 * This library is free for commercial and non-commercial use as long as
12 * the following conditions are aheared to. The following conditions
13 * apply to all code found in this distribution, be it the RC4, RSA,
14 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
15 * included with this distribution is covered by the same copyright terms
16 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
18 * Copyright remains Eric Young's, and as such any Copyright notices in
19 * the code are not to be removed.
20 * If this package is used in a product, Eric Young should be given attribution
21 * as the author of the parts of the library used.
22 * This can be in the form of a textual message at program startup or
23 * in documentation (online or textual) provided with the package.
25 * Redistribution and use in source and binary forms, with or without
26 * modification, are permitted provided that the following conditions
28 * 1. Redistributions of source code must retain the copyright
29 * notice, this list of conditions and the following disclaimer.
30 * 2. Redistributions in binary form must reproduce the above copyright
31 * notice, this list of conditions and the following disclaimer in the
32 * documentation and/or other materials provided with the distribution.
33 * 3. All advertising materials mentioning features or use of this software
34 * must display the following acknowledgement:
35 * "This product includes cryptographic software written by
36 * Eric Young (eay@cryptsoft.com)"
37 * The word 'cryptographic' can be left out if the rouines from the library
38 * being used are not cryptographic related :-).
39 * 4. If you include any Windows specific code (or a derivative thereof) from
40 * the apps directory (application code) you must include an acknowledgement:
41 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
43 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55 * The licence and distribution terms for any publically available version or
56 * derivative of this code cannot be changed. i.e. this code cannot simply be
57 * copied and put under another distribution licence
58 * [including the GNU Public Licence.]
60 /* ====================================================================
61 * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
63 * Redistribution and use in source and binary forms, with or without
64 * modification, are permitted provided that the following conditions
67 * 1. Redistributions of source code must retain the above copyright
68 * notice, this list of conditions and the following disclaimer.
70 * 2. Redistributions in binary form must reproduce the above copyright
71 * notice, this list of conditions and the following disclaimer in
72 * the documentation and/or other materials provided with the
75 * 3. All advertising materials mentioning features or use of this
76 * software must display the following acknowledgment:
77 * "This product includes software developed by the OpenSSL Project
78 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
80 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
81 * endorse or promote products derived from this software without
82 * prior written permission. For written permission, please contact
83 * openssl-core@openssl.org.
85 * 5. Products derived from this software may not be called "OpenSSL"
86 * nor may "OpenSSL" appear in their names without prior written
87 * permission of the OpenSSL Project.
89 * 6. Redistributions of any form whatsoever must retain the following
91 * "This product includes software developed by the OpenSSL Project
92 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
94 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
95 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
96 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
97 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
98 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
99 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
100 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
101 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
102 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
103 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
104 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
105 * OF THE POSSIBILITY OF SUCH DAMAGE.
106 * ====================================================================
108 * This product includes cryptographic software written by Eric Young
109 * (eay@cryptsoft.com). This product includes software written by Tim
110 * Hudson (tjh@cryptsoft.com).
113 /* ====================================================================
114 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
115 * ECC cipher suite support in OpenSSL originally developed by
116 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
118 /* ====================================================================
119 * Copyright 2005 Nokia. All rights reserved.
121 * The portions of the attached software ("Contribution") is developed by
122 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
125 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
126 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
127 * support (see RFC 4279) to OpenSSL.
129 * No patent licenses or other rights except those expressly stated in
130 * the OpenSSL open source license shall be deemed granted or received
131 * expressly, by implication, estoppel, or otherwise.
133 * No assurances are provided by Nokia that the Contribution does not
134 * infringe the patent or other intellectual property rights of any third
135 * party or that the license provides you with all the necessary rights
136 * to make use of the Contribution.
138 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
139 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
140 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
141 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
147 #include "ssl_locl.h"
148 #include <openssl/objects.h>
149 #include <openssl/lhash.h>
150 #include <openssl/x509v3.h>
151 #include <openssl/rand.h>
152 #include <openssl/ocsp.h>
153 #include <openssl/dh.h>
154 #include <openssl/engine.h>
155 #include <openssl/async.h>
156 #include <openssl/ct.h>
158 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
160 SSL3_ENC_METHOD ssl3_undef_enc_method = {
162 * evil casts, but these functions are only called if there's a library
165 (int (*)(SSL *, SSL3_RECORD *, unsigned int, int))ssl_undefined_function,
166 (int (*)(SSL *, SSL3_RECORD *, unsigned char *, int))ssl_undefined_function,
167 ssl_undefined_function,
168 (int (*)(SSL *, unsigned char *, unsigned char *, int))
169 ssl_undefined_function,
170 (int (*)(SSL *, int))ssl_undefined_function,
171 (int (*)(SSL *, const char *, int, unsigned char *))
172 ssl_undefined_function,
173 0, /* finish_mac_length */
174 NULL, /* client_finished_label */
175 0, /* client_finished_label_len */
176 NULL, /* server_finished_label */
177 0, /* server_finished_label_len */
178 (int (*)(int))ssl_undefined_function,
179 (int (*)(SSL *, unsigned char *, size_t, const char *,
180 size_t, const unsigned char *, size_t,
181 int use_context))ssl_undefined_function,
184 struct ssl_async_args {
188 enum { READFUNC, WRITEFUNC, OTHERFUNC} type;
190 int (*func_read)(SSL *, void *, int);
191 int (*func_write)(SSL *, const void *, int);
192 int (*func_other)(SSL *);
196 static const struct {
201 { DANETLS_MATCHING_FULL, 0, NID_undef },
202 { DANETLS_MATCHING_2256, 1, NID_sha256 },
203 { DANETLS_MATCHING_2512, 2, NID_sha512 },
206 static int dane_ctx_enable(struct dane_ctx_st *dctx)
208 const EVP_MD **mdevp;
210 uint8_t mdmax = DANETLS_MATCHING_LAST;
211 int n = ((int) mdmax) + 1; /* int to handle PrivMatch(255) */
214 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
215 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
217 if (mdord == NULL || mdevp == NULL) {
220 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
224 /* Install default entries */
225 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
228 if (dane_mds[i].nid == NID_undef ||
229 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
231 mdevp[dane_mds[i].mtype] = md;
232 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
242 static void dane_ctx_final(struct dane_ctx_st *dctx)
244 OPENSSL_free(dctx->mdevp);
247 OPENSSL_free(dctx->mdord);
252 static void tlsa_free(danetls_record *t)
256 OPENSSL_free(t->data);
257 EVP_PKEY_free(t->spki);
261 static void dane_final(SSL_DANE *dane)
263 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
266 sk_X509_pop_free(dane->certs, X509_free);
269 X509_free(dane->mcert);
277 * dane_copy - Copy dane configuration, sans verification state.
279 static int ssl_dane_dup(SSL *to, SSL *from)
284 if (!DANETLS_ENABLED(&from->dane))
287 dane_final(&to->dane);
288 to->dane.dctx = &to->ctx->dane;
289 to->dane.trecs = sk_danetls_record_new_null();
291 if (to->dane.trecs == NULL) {
292 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
296 num = sk_danetls_record_num(from->dane.trecs);
297 for (i = 0; i < num; ++i) {
298 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
300 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
301 t->data, t->dlen) <= 0)
307 static int dane_mtype_set(
308 struct dane_ctx_st *dctx,
315 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
316 SSLerr(SSL_F_DANE_MTYPE_SET,
317 SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
321 if (mtype > dctx->mdmax) {
322 const EVP_MD **mdevp;
324 int n = ((int) mtype) + 1;
326 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
328 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
333 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
335 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
340 /* Zero-fill any gaps */
341 for (i = dctx->mdmax+1; i < mtype; ++i) {
349 dctx->mdevp[mtype] = md;
350 /* Coerce ordinal of disabled matching types to 0 */
351 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
356 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
358 if (mtype > dane->dctx->mdmax)
360 return dane->dctx->mdevp[mtype];
363 static int dane_tlsa_add(
372 const EVP_MD *md = NULL;
373 int ilen = (int)dlen;
377 if (dane->trecs == NULL) {
378 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
382 if (ilen < 0 || dlen != (size_t)ilen) {
383 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
387 if (usage > DANETLS_USAGE_LAST) {
388 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
392 if (selector > DANETLS_SELECTOR_LAST) {
393 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
397 if (mtype != DANETLS_MATCHING_FULL) {
398 md = tlsa_md_get(dane, mtype);
400 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
405 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
406 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
410 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
414 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
415 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
420 t->selector = selector;
422 t->data = OPENSSL_malloc(ilen);
423 if (t->data == NULL) {
425 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
428 memcpy(t->data, data, ilen);
431 /* Validate and cache full certificate or public key */
432 if (mtype == DANETLS_MATCHING_FULL) {
433 const unsigned char *p = data;
435 EVP_PKEY *pkey = NULL;
438 case DANETLS_SELECTOR_CERT:
439 if (!d2i_X509(&cert, &p, dlen) || p < data ||
440 dlen != (size_t)(p - data)) {
442 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
445 if (X509_get0_pubkey(cert) == NULL) {
447 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
451 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
457 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
458 * records that contain full certificates of trust-anchors that are
459 * not present in the wire chain. For usage PKIX-TA(0), we augment
460 * the chain with untrusted Full(0) certificates from DNS, in case
461 * they are missing from the chain.
463 if ((dane->certs == NULL &&
464 (dane->certs = sk_X509_new_null()) == NULL) ||
465 !sk_X509_push(dane->certs, cert)) {
466 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
473 case DANETLS_SELECTOR_SPKI:
474 if (!d2i_PUBKEY(&pkey, &p, dlen) || p < data ||
475 dlen != (size_t)(p - data)) {
477 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
482 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
483 * records that contain full bare keys of trust-anchors that are
484 * not present in the wire chain.
486 if (usage == DANETLS_USAGE_DANE_TA)
495 * Find the right insertion point for the new record.
497 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
498 * they can be processed first, as they require no chain building, and no
499 * expiration or hostname checks. Because DANE-EE(3) is numerically
500 * largest, this is accomplished via descending sort by "usage".
502 * We also sort in descending order by matching ordinal to simplify
503 * the implementation of digest agility in the verification code.
505 * The choice of order for the selector is not significant, so we
506 * use the same descending order for consistency.
508 num = sk_danetls_record_num(dane->trecs);
509 for (i = 0; i < num; ++i) {
510 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
512 if (rec->usage > usage)
514 if (rec->usage < usage)
516 if (rec->selector > selector)
518 if (rec->selector < selector)
520 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
525 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
527 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
530 dane->umask |= DANETLS_USAGE_BIT(usage);
535 static void clear_ciphers(SSL *s)
537 /* clear the current cipher */
538 ssl_clear_cipher_ctx(s);
539 ssl_clear_hash_ctx(&s->read_hash);
540 ssl_clear_hash_ctx(&s->write_hash);
543 int SSL_clear(SSL *s)
545 if (s->method == NULL) {
546 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
550 if (ssl_clear_bad_session(s)) {
551 SSL_SESSION_free(s->session);
559 if (s->renegotiate) {
560 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
564 ossl_statem_clear(s);
566 s->version = s->method->version;
567 s->client_version = s->version;
568 s->rwstate = SSL_NOTHING;
570 BUF_MEM_free(s->init_buf);
575 /* Reset DANE verification result state */
578 X509_free(s->dane.mcert);
579 s->dane.mcert = NULL;
580 s->dane.mtlsa = NULL;
582 /* Clear the verification result peername */
583 X509_VERIFY_PARAM_move_peername(s->param, NULL);
586 * Check to see if we were changed into a different method, if so, revert
587 * back if we are not doing session-id reuse.
589 if (!ossl_statem_get_in_handshake(s) && (s->session == NULL)
590 && (s->method != s->ctx->method)) {
591 s->method->ssl_free(s);
592 s->method = s->ctx->method;
593 if (!s->method->ssl_new(s))
596 s->method->ssl_clear(s);
598 RECORD_LAYER_clear(&s->rlayer);
603 /** Used to change an SSL_CTXs default SSL method type */
604 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
606 STACK_OF(SSL_CIPHER) *sk;
610 sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
611 &(ctx->cipher_list_by_id),
612 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
613 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
614 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION,
615 SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
621 SSL *SSL_new(SSL_CTX *ctx)
626 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
629 if (ctx->method == NULL) {
630 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
634 s = OPENSSL_zalloc(sizeof(*s));
638 s->lock = CRYPTO_THREAD_lock_new();
639 if (s->lock == NULL) {
640 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
645 RECORD_LAYER_init(&s->rlayer, s);
647 s->options = ctx->options;
648 s->min_proto_version = ctx->min_proto_version;
649 s->max_proto_version = ctx->max_proto_version;
651 s->max_cert_list = ctx->max_cert_list;
655 * Earlier library versions used to copy the pointer to the CERT, not
656 * its contents; only when setting new parameters for the per-SSL
657 * copy, ssl_cert_new would be called (and the direct reference to
658 * the per-SSL_CTX settings would be lost, but those still were
659 * indirectly accessed for various purposes, and for that reason they
660 * used to be known as s->ctx->default_cert). Now we don't look at the
661 * SSL_CTX's CERT after having duplicated it once.
663 s->cert = ssl_cert_dup(ctx->cert);
667 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
668 s->msg_callback = ctx->msg_callback;
669 s->msg_callback_arg = ctx->msg_callback_arg;
670 s->verify_mode = ctx->verify_mode;
671 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
672 s->sid_ctx_length = ctx->sid_ctx_length;
673 OPENSSL_assert(s->sid_ctx_length <= sizeof s->sid_ctx);
674 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
675 s->verify_callback = ctx->default_verify_callback;
676 s->generate_session_id = ctx->generate_session_id;
678 s->param = X509_VERIFY_PARAM_new();
679 if (s->param == NULL)
681 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
682 s->quiet_shutdown = ctx->quiet_shutdown;
683 s->max_send_fragment = ctx->max_send_fragment;
684 s->split_send_fragment = ctx->split_send_fragment;
685 s->max_pipelines = ctx->max_pipelines;
686 if (s->max_pipelines > 1)
687 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
688 if (ctx->default_read_buf_len > 0)
689 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
693 s->tlsext_debug_cb = 0;
694 s->tlsext_debug_arg = NULL;
695 s->tlsext_ticket_expected = 0;
696 s->tlsext_status_type = -1;
697 s->tlsext_status_expected = 0;
698 s->tlsext_ocsp_ids = NULL;
699 s->tlsext_ocsp_exts = NULL;
700 s->tlsext_ocsp_resp = NULL;
701 s->tlsext_ocsp_resplen = -1;
703 s->initial_ctx = ctx;
704 # ifndef OPENSSL_NO_EC
705 if (ctx->tlsext_ecpointformatlist) {
706 s->tlsext_ecpointformatlist =
707 OPENSSL_memdup(ctx->tlsext_ecpointformatlist,
708 ctx->tlsext_ecpointformatlist_length);
709 if (!s->tlsext_ecpointformatlist)
711 s->tlsext_ecpointformatlist_length =
712 ctx->tlsext_ecpointformatlist_length;
714 if (ctx->tlsext_ellipticcurvelist) {
715 s->tlsext_ellipticcurvelist =
716 OPENSSL_memdup(ctx->tlsext_ellipticcurvelist,
717 ctx->tlsext_ellipticcurvelist_length);
718 if (!s->tlsext_ellipticcurvelist)
720 s->tlsext_ellipticcurvelist_length =
721 ctx->tlsext_ellipticcurvelist_length;
724 # ifndef OPENSSL_NO_NEXTPROTONEG
725 s->next_proto_negotiated = NULL;
728 if (s->ctx->alpn_client_proto_list) {
729 s->alpn_client_proto_list =
730 OPENSSL_malloc(s->ctx->alpn_client_proto_list_len);
731 if (s->alpn_client_proto_list == NULL)
733 memcpy(s->alpn_client_proto_list, s->ctx->alpn_client_proto_list,
734 s->ctx->alpn_client_proto_list_len);
735 s->alpn_client_proto_list_len = s->ctx->alpn_client_proto_list_len;
738 s->verified_chain = NULL;
739 s->verify_result = X509_V_OK;
741 s->default_passwd_callback = ctx->default_passwd_callback;
742 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
744 s->method = ctx->method;
746 if (!s->method->ssl_new(s))
749 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
754 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
756 #ifndef OPENSSL_NO_PSK
757 s->psk_client_callback = ctx->psk_client_callback;
758 s->psk_server_callback = ctx->psk_server_callback;
763 #ifndef OPENSSL_NO_CT
764 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
765 ctx->ct_validation_callback_arg))
772 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
776 void SSL_up_ref(SSL *s)
779 CRYPTO_atomic_add(&s->references, 1, &i, s->lock);
782 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
783 unsigned int sid_ctx_len)
785 if (sid_ctx_len > sizeof ctx->sid_ctx) {
786 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
787 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
790 ctx->sid_ctx_length = sid_ctx_len;
791 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
796 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
797 unsigned int sid_ctx_len)
799 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
800 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
801 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
804 ssl->sid_ctx_length = sid_ctx_len;
805 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
810 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
812 CRYPTO_THREAD_write_lock(ctx->lock);
813 ctx->generate_session_id = cb;
814 CRYPTO_THREAD_unlock(ctx->lock);
818 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
820 CRYPTO_THREAD_write_lock(ssl->lock);
821 ssl->generate_session_id = cb;
822 CRYPTO_THREAD_unlock(ssl->lock);
826 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
830 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
831 * we can "construct" a session to give us the desired check - ie. to
832 * find if there's a session in the hash table that would conflict with
833 * any new session built out of this id/id_len and the ssl_version in use
838 if (id_len > sizeof r.session_id)
841 r.ssl_version = ssl->version;
842 r.session_id_length = id_len;
843 memcpy(r.session_id, id, id_len);
845 CRYPTO_THREAD_read_lock(ssl->ctx->lock);
846 p = lh_SSL_SESSION_retrieve(ssl->ctx->sessions, &r);
847 CRYPTO_THREAD_unlock(ssl->ctx->lock);
851 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
853 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
856 int SSL_set_purpose(SSL *s, int purpose)
858 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
861 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
863 return X509_VERIFY_PARAM_set_trust(s->param, trust);
866 int SSL_set_trust(SSL *s, int trust)
868 return X509_VERIFY_PARAM_set_trust(s->param, trust);
871 int SSL_set1_host(SSL *s, const char *hostname)
873 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
876 int SSL_add1_host(SSL *s, const char *hostname)
878 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
881 void SSL_set_hostflags(SSL *s, unsigned int flags)
883 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
886 const char *SSL_get0_peername(SSL *s)
888 return X509_VERIFY_PARAM_get0_peername(s->param);
891 int SSL_CTX_dane_enable(SSL_CTX *ctx)
893 return dane_ctx_enable(&ctx->dane);
896 int SSL_dane_enable(SSL *s, const char *basedomain)
898 SSL_DANE *dane = &s->dane;
900 if (s->ctx->dane.mdmax == 0) {
901 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
904 if (dane->trecs != NULL) {
905 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
910 * Default SNI name. This rejects empty names, while set1_host below
911 * accepts them and disables host name checks. To avoid side-effects with
912 * invalid input, set the SNI name first.
914 if (s->tlsext_hostname == NULL) {
915 if (!SSL_set_tlsext_host_name(s, basedomain)) {
916 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
921 /* Primary RFC6125 reference identifier */
922 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
923 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
929 dane->dctx = &s->ctx->dane;
930 dane->trecs = sk_danetls_record_new_null();
932 if (dane->trecs == NULL) {
933 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
939 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
941 SSL_DANE *dane = &s->dane;
943 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
947 *mcert = dane->mcert;
949 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
954 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
955 uint8_t *mtype, unsigned const char **data, size_t *dlen)
957 SSL_DANE *dane = &s->dane;
959 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
963 *usage = dane->mtlsa->usage;
965 *selector = dane->mtlsa->selector;
967 *mtype = dane->mtlsa->mtype;
969 *data = dane->mtlsa->data;
971 *dlen = dane->mtlsa->dlen;
976 SSL_DANE *SSL_get0_dane(SSL *s)
981 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
982 uint8_t mtype, unsigned char *data, size_t dlen)
984 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
987 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype, uint8_t ord)
989 return dane_mtype_set(&ctx->dane, md, mtype, ord);
992 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
994 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
997 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
999 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1002 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1007 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1012 void SSL_certs_clear(SSL *s)
1014 ssl_cert_clear_certs(s->cert);
1017 void SSL_free(SSL *s)
1024 CRYPTO_atomic_add(&s->references, -1, &i, s->lock);
1025 REF_PRINT_COUNT("SSL", s);
1028 REF_ASSERT_ISNT(i < 0);
1030 X509_VERIFY_PARAM_free(s->param);
1031 dane_final(&s->dane);
1032 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1034 if (s->bbio != NULL) {
1035 /* If the buffering BIO is in place, pop it off */
1036 if (s->bbio == s->wbio) {
1037 s->wbio = BIO_pop(s->wbio);
1042 BIO_free_all(s->rbio);
1043 if (s->wbio != s->rbio)
1044 BIO_free_all(s->wbio);
1046 BUF_MEM_free(s->init_buf);
1048 /* add extra stuff */
1049 sk_SSL_CIPHER_free(s->cipher_list);
1050 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1052 /* Make the next call work :-) */
1053 if (s->session != NULL) {
1054 ssl_clear_bad_session(s);
1055 SSL_SESSION_free(s->session);
1060 ssl_cert_free(s->cert);
1061 /* Free up if allocated */
1063 OPENSSL_free(s->tlsext_hostname);
1064 SSL_CTX_free(s->initial_ctx);
1065 #ifndef OPENSSL_NO_EC
1066 OPENSSL_free(s->tlsext_ecpointformatlist);
1067 OPENSSL_free(s->tlsext_ellipticcurvelist);
1068 #endif /* OPENSSL_NO_EC */
1069 sk_X509_EXTENSION_pop_free(s->tlsext_ocsp_exts, X509_EXTENSION_free);
1070 #ifndef OPENSSL_NO_OCSP
1071 sk_OCSP_RESPID_pop_free(s->tlsext_ocsp_ids, OCSP_RESPID_free);
1073 #ifndef OPENSSL_NO_CT
1074 SCT_LIST_free(s->scts);
1075 OPENSSL_free(s->tlsext_scts);
1077 OPENSSL_free(s->tlsext_ocsp_resp);
1078 OPENSSL_free(s->alpn_client_proto_list);
1080 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1082 sk_X509_pop_free(s->verified_chain, X509_free);
1084 if (s->method != NULL)
1085 s->method->ssl_free(s);
1087 RECORD_LAYER_release(&s->rlayer);
1089 SSL_CTX_free(s->ctx);
1091 ASYNC_WAIT_CTX_free(s->waitctx);
1093 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1094 OPENSSL_free(s->next_proto_negotiated);
1097 #ifndef OPENSSL_NO_SRTP
1098 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1101 CRYPTO_THREAD_lock_free(s->lock);
1106 void SSL_set_rbio(SSL *s, BIO *rbio)
1108 if (s->rbio != rbio)
1109 BIO_free_all(s->rbio);
1113 void SSL_set_wbio(SSL *s, BIO *wbio)
1116 * If the output buffering BIO is still in place, remove it
1118 if (s->bbio != NULL) {
1119 if (s->wbio == s->bbio) {
1120 s->wbio = BIO_next(s->wbio);
1121 BIO_set_next(s->bbio, NULL);
1124 if (s->wbio != wbio && s->rbio != s->wbio)
1125 BIO_free_all(s->wbio);
1129 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1131 SSL_set_wbio(s, wbio);
1132 SSL_set_rbio(s, rbio);
1135 BIO *SSL_get_rbio(const SSL *s)
1140 BIO *SSL_get_wbio(const SSL *s)
1145 int SSL_get_fd(const SSL *s)
1147 return (SSL_get_rfd(s));
1150 int SSL_get_rfd(const SSL *s)
1155 b = SSL_get_rbio(s);
1156 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1158 BIO_get_fd(r, &ret);
1162 int SSL_get_wfd(const SSL *s)
1167 b = SSL_get_wbio(s);
1168 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1170 BIO_get_fd(r, &ret);
1174 #ifndef OPENSSL_NO_SOCK
1175 int SSL_set_fd(SSL *s, int fd)
1180 bio = BIO_new(BIO_s_socket());
1183 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1186 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1187 SSL_set_bio(s, bio, bio);
1193 int SSL_set_wfd(SSL *s, int fd)
1198 if ((s->rbio == NULL) || (BIO_method_type(s->rbio) != BIO_TYPE_SOCKET)
1199 || ((int)BIO_get_fd(s->rbio, NULL) != fd)) {
1200 bio = BIO_new(BIO_s_socket());
1203 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1206 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1207 SSL_set_bio(s, SSL_get_rbio(s), bio);
1209 SSL_set_bio(s, SSL_get_rbio(s), SSL_get_rbio(s));
1215 int SSL_set_rfd(SSL *s, int fd)
1220 if ((s->wbio == NULL) || (BIO_method_type(s->wbio) != BIO_TYPE_SOCKET)
1221 || ((int)BIO_get_fd(s->wbio, NULL) != fd)) {
1222 bio = BIO_new(BIO_s_socket());
1225 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1228 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1229 SSL_set_bio(s, bio, SSL_get_wbio(s));
1231 SSL_set_bio(s, SSL_get_wbio(s), SSL_get_wbio(s));
1238 /* return length of latest Finished message we sent, copy to 'buf' */
1239 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1243 if (s->s3 != NULL) {
1244 ret = s->s3->tmp.finish_md_len;
1247 memcpy(buf, s->s3->tmp.finish_md, count);
1252 /* return length of latest Finished message we expected, copy to 'buf' */
1253 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1257 if (s->s3 != NULL) {
1258 ret = s->s3->tmp.peer_finish_md_len;
1261 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1266 int SSL_get_verify_mode(const SSL *s)
1268 return (s->verify_mode);
1271 int SSL_get_verify_depth(const SSL *s)
1273 return X509_VERIFY_PARAM_get_depth(s->param);
1276 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1277 return (s->verify_callback);
1280 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1282 return (ctx->verify_mode);
1285 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1287 return X509_VERIFY_PARAM_get_depth(ctx->param);
1290 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1291 return (ctx->default_verify_callback);
1294 void SSL_set_verify(SSL *s, int mode,
1295 int (*callback) (int ok, X509_STORE_CTX *ctx))
1297 s->verify_mode = mode;
1298 if (callback != NULL)
1299 s->verify_callback = callback;
1302 void SSL_set_verify_depth(SSL *s, int depth)
1304 X509_VERIFY_PARAM_set_depth(s->param, depth);
1307 void SSL_set_read_ahead(SSL *s, int yes)
1309 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1312 int SSL_get_read_ahead(const SSL *s)
1314 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1317 int SSL_pending(const SSL *s)
1320 * SSL_pending cannot work properly if read-ahead is enabled
1321 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1322 * impossible to fix since SSL_pending cannot report errors that may be
1323 * observed while scanning the new data. (Note that SSL_pending() is
1324 * often used as a boolean value, so we'd better not return -1.)
1326 return (s->method->ssl_pending(s));
1329 int SSL_has_pending(const SSL *s)
1332 * Similar to SSL_pending() but returns a 1 to indicate that we have
1333 * unprocessed data available or 0 otherwise (as opposed to the number of
1334 * bytes available). Unlike SSL_pending() this will take into account
1335 * read_ahead data. A 1 return simply indicates that we have unprocessed
1336 * data. That data may not result in any application data, or we may fail
1337 * to parse the records for some reason.
1342 return RECORD_LAYER_read_pending(&s->rlayer);
1345 X509 *SSL_get_peer_certificate(const SSL *s)
1349 if ((s == NULL) || (s->session == NULL))
1352 r = s->session->peer;
1362 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1366 if ((s == NULL) || (s->session == NULL))
1369 r = s->session->peer_chain;
1372 * If we are a client, cert_chain includes the peer's own certificate; if
1373 * we are a server, it does not.
1380 * Now in theory, since the calling process own 't' it should be safe to
1381 * modify. We need to be able to read f without being hassled
1383 int SSL_copy_session_id(SSL *t, const SSL *f)
1386 /* Do we need to to SSL locking? */
1387 if (!SSL_set_session(t, SSL_get_session(f))) {
1392 * what if we are setup for one protocol version but want to talk another
1394 if (t->method != f->method) {
1395 t->method->ssl_free(t);
1396 t->method = f->method;
1397 if (t->method->ssl_new(t) == 0)
1401 CRYPTO_atomic_add(&f->cert->references, 1, &i, f->cert->lock);
1402 ssl_cert_free(t->cert);
1404 if (!SSL_set_session_id_context(t, f->sid_ctx, f->sid_ctx_length)) {
1411 /* Fix this so it checks all the valid key/cert options */
1412 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1414 if ((ctx == NULL) ||
1415 (ctx->cert->key->x509 == NULL)) {
1416 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY,
1417 SSL_R_NO_CERTIFICATE_ASSIGNED);
1420 if (ctx->cert->key->privatekey == NULL) {
1421 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY,
1422 SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1425 return (X509_check_private_key
1426 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1429 /* Fix this function so that it takes an optional type parameter */
1430 int SSL_check_private_key(const SSL *ssl)
1433 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1436 if (ssl->cert->key->x509 == NULL) {
1437 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1440 if (ssl->cert->key->privatekey == NULL) {
1441 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1444 return (X509_check_private_key(ssl->cert->key->x509,
1445 ssl->cert->key->privatekey));
1448 int SSL_waiting_for_async(SSL *s)
1456 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1458 ASYNC_WAIT_CTX *ctx = s->waitctx;
1462 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1465 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1466 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1468 ASYNC_WAIT_CTX *ctx = s->waitctx;
1472 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1476 int SSL_accept(SSL *s)
1478 if (s->handshake_func == NULL) {
1479 /* Not properly initialized yet */
1480 SSL_set_accept_state(s);
1483 return SSL_do_handshake(s);
1486 int SSL_connect(SSL *s)
1488 if (s->handshake_func == NULL) {
1489 /* Not properly initialized yet */
1490 SSL_set_connect_state(s);
1493 return SSL_do_handshake(s);
1496 long SSL_get_default_timeout(const SSL *s)
1498 return (s->method->get_timeout());
1501 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1502 int (*func)(void *)) {
1504 if (s->waitctx == NULL) {
1505 s->waitctx = ASYNC_WAIT_CTX_new();
1506 if (s->waitctx == NULL)
1509 switch(ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1510 sizeof(struct ssl_async_args))) {
1512 s->rwstate = SSL_NOTHING;
1513 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1516 s->rwstate = SSL_ASYNC_PAUSED;
1522 s->rwstate = SSL_NOTHING;
1523 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1524 /* Shouldn't happen */
1529 static int ssl_io_intern(void *vargs)
1531 struct ssl_async_args *args;
1536 args = (struct ssl_async_args *)vargs;
1540 switch (args->type) {
1542 return args->f.func_read(s, buf, num);
1544 return args->f.func_write(s, buf, num);
1546 return args->f.func_other(s);
1551 int SSL_read(SSL *s, void *buf, int num)
1553 if (s->handshake_func == NULL) {
1554 SSLerr(SSL_F_SSL_READ, SSL_R_UNINITIALIZED);
1558 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1559 s->rwstate = SSL_NOTHING;
1563 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1564 struct ssl_async_args args;
1569 args.type = READFUNC;
1570 args.f.func_read = s->method->ssl_read;
1572 return ssl_start_async_job(s, &args, ssl_io_intern);
1574 return s->method->ssl_read(s, buf, num);
1578 int SSL_peek(SSL *s, void *buf, int num)
1580 if (s->handshake_func == NULL) {
1581 SSLerr(SSL_F_SSL_PEEK, SSL_R_UNINITIALIZED);
1585 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1588 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1589 struct ssl_async_args args;
1594 args.type = READFUNC;
1595 args.f.func_read = s->method->ssl_peek;
1597 return ssl_start_async_job(s, &args, ssl_io_intern);
1599 return s->method->ssl_peek(s, buf, num);
1603 int SSL_write(SSL *s, const void *buf, int num)
1605 if (s->handshake_func == NULL) {
1606 SSLerr(SSL_F_SSL_WRITE, SSL_R_UNINITIALIZED);
1610 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1611 s->rwstate = SSL_NOTHING;
1612 SSLerr(SSL_F_SSL_WRITE, SSL_R_PROTOCOL_IS_SHUTDOWN);
1616 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1617 struct ssl_async_args args;
1620 args.buf = (void *)buf;
1622 args.type = WRITEFUNC;
1623 args.f.func_write = s->method->ssl_write;
1625 return ssl_start_async_job(s, &args, ssl_io_intern);
1627 return s->method->ssl_write(s, buf, num);
1631 int SSL_shutdown(SSL *s)
1634 * Note that this function behaves differently from what one might
1635 * expect. Return values are 0 for no success (yet), 1 for success; but
1636 * calling it once is usually not enough, even if blocking I/O is used
1637 * (see ssl3_shutdown).
1640 if (s->handshake_func == NULL) {
1641 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1645 if (!SSL_in_init(s)) {
1646 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1647 struct ssl_async_args args;
1650 args.type = OTHERFUNC;
1651 args.f.func_other = s->method->ssl_shutdown;
1653 return ssl_start_async_job(s, &args, ssl_io_intern);
1655 return s->method->ssl_shutdown(s);
1658 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1663 int SSL_renegotiate(SSL *s)
1665 if (s->renegotiate == 0)
1670 return (s->method->ssl_renegotiate(s));
1673 int SSL_renegotiate_abbreviated(SSL *s)
1675 if (s->renegotiate == 0)
1680 return (s->method->ssl_renegotiate(s));
1683 int SSL_renegotiate_pending(SSL *s)
1686 * becomes true when negotiation is requested; false again once a
1687 * handshake has finished
1689 return (s->renegotiate != 0);
1692 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1697 case SSL_CTRL_GET_READ_AHEAD:
1698 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1699 case SSL_CTRL_SET_READ_AHEAD:
1700 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1701 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1704 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1705 s->msg_callback_arg = parg;
1709 return (s->mode |= larg);
1710 case SSL_CTRL_CLEAR_MODE:
1711 return (s->mode &= ~larg);
1712 case SSL_CTRL_GET_MAX_CERT_LIST:
1713 return (s->max_cert_list);
1714 case SSL_CTRL_SET_MAX_CERT_LIST:
1715 l = s->max_cert_list;
1716 s->max_cert_list = larg;
1718 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1719 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1721 s->max_send_fragment = larg;
1722 if (s->max_send_fragment < s->split_send_fragment)
1723 s->split_send_fragment = s->max_send_fragment;
1725 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1726 if ((unsigned int)larg > s->max_send_fragment || larg == 0)
1728 s->split_send_fragment = larg;
1730 case SSL_CTRL_SET_MAX_PIPELINES:
1731 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1733 s->max_pipelines = larg;
1735 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1737 case SSL_CTRL_GET_RI_SUPPORT:
1739 return s->s3->send_connection_binding;
1742 case SSL_CTRL_CERT_FLAGS:
1743 return (s->cert->cert_flags |= larg);
1744 case SSL_CTRL_CLEAR_CERT_FLAGS:
1745 return (s->cert->cert_flags &= ~larg);
1747 case SSL_CTRL_GET_RAW_CIPHERLIST:
1749 if (s->s3->tmp.ciphers_raw == NULL)
1751 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
1752 return (int)s->s3->tmp.ciphers_rawlen;
1754 return TLS_CIPHER_LEN;
1756 case SSL_CTRL_GET_EXTMS_SUPPORT:
1757 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
1759 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
1763 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1764 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1765 &s->min_proto_version);
1766 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1767 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1768 &s->max_proto_version);
1770 return (s->method->ssl_ctrl(s, cmd, larg, parg));
1774 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1777 case SSL_CTRL_SET_MSG_CALLBACK:
1778 s->msg_callback = (void (*)
1779 (int write_p, int version, int content_type,
1780 const void *buf, size_t len, SSL *ssl,
1785 return (s->method->ssl_callback_ctrl(s, cmd, fp));
1789 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
1791 return ctx->sessions;
1794 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1797 /* For some cases with ctx == NULL perform syntax checks */
1800 #ifndef OPENSSL_NO_EC
1801 case SSL_CTRL_SET_CURVES_LIST:
1802 return tls1_set_curves_list(NULL, NULL, parg);
1804 case SSL_CTRL_SET_SIGALGS_LIST:
1805 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
1806 return tls1_set_sigalgs_list(NULL, parg, 0);
1813 case SSL_CTRL_GET_READ_AHEAD:
1814 return (ctx->read_ahead);
1815 case SSL_CTRL_SET_READ_AHEAD:
1816 l = ctx->read_ahead;
1817 ctx->read_ahead = larg;
1820 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1821 ctx->msg_callback_arg = parg;
1824 case SSL_CTRL_GET_MAX_CERT_LIST:
1825 return (ctx->max_cert_list);
1826 case SSL_CTRL_SET_MAX_CERT_LIST:
1827 l = ctx->max_cert_list;
1828 ctx->max_cert_list = larg;
1831 case SSL_CTRL_SET_SESS_CACHE_SIZE:
1832 l = ctx->session_cache_size;
1833 ctx->session_cache_size = larg;
1835 case SSL_CTRL_GET_SESS_CACHE_SIZE:
1836 return (ctx->session_cache_size);
1837 case SSL_CTRL_SET_SESS_CACHE_MODE:
1838 l = ctx->session_cache_mode;
1839 ctx->session_cache_mode = larg;
1841 case SSL_CTRL_GET_SESS_CACHE_MODE:
1842 return (ctx->session_cache_mode);
1844 case SSL_CTRL_SESS_NUMBER:
1845 return (lh_SSL_SESSION_num_items(ctx->sessions));
1846 case SSL_CTRL_SESS_CONNECT:
1847 return (ctx->stats.sess_connect);
1848 case SSL_CTRL_SESS_CONNECT_GOOD:
1849 return (ctx->stats.sess_connect_good);
1850 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
1851 return (ctx->stats.sess_connect_renegotiate);
1852 case SSL_CTRL_SESS_ACCEPT:
1853 return (ctx->stats.sess_accept);
1854 case SSL_CTRL_SESS_ACCEPT_GOOD:
1855 return (ctx->stats.sess_accept_good);
1856 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
1857 return (ctx->stats.sess_accept_renegotiate);
1858 case SSL_CTRL_SESS_HIT:
1859 return (ctx->stats.sess_hit);
1860 case SSL_CTRL_SESS_CB_HIT:
1861 return (ctx->stats.sess_cb_hit);
1862 case SSL_CTRL_SESS_MISSES:
1863 return (ctx->stats.sess_miss);
1864 case SSL_CTRL_SESS_TIMEOUTS:
1865 return (ctx->stats.sess_timeout);
1866 case SSL_CTRL_SESS_CACHE_FULL:
1867 return (ctx->stats.sess_cache_full);
1869 return (ctx->mode |= larg);
1870 case SSL_CTRL_CLEAR_MODE:
1871 return (ctx->mode &= ~larg);
1872 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1873 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1875 ctx->max_send_fragment = larg;
1876 if (ctx->max_send_fragment < ctx->split_send_fragment)
1877 ctx->split_send_fragment = ctx->max_send_fragment;
1879 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1880 if ((unsigned int)larg > ctx->max_send_fragment || larg == 0)
1882 ctx->split_send_fragment = larg;
1884 case SSL_CTRL_SET_MAX_PIPELINES:
1885 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1887 ctx->max_pipelines = larg;
1889 case SSL_CTRL_CERT_FLAGS:
1890 return (ctx->cert->cert_flags |= larg);
1891 case SSL_CTRL_CLEAR_CERT_FLAGS:
1892 return (ctx->cert->cert_flags &= ~larg);
1893 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1894 return ssl_set_version_bound(ctx->method->version, (int)larg,
1895 &ctx->min_proto_version);
1896 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1897 return ssl_set_version_bound(ctx->method->version, (int)larg,
1898 &ctx->max_proto_version);
1900 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
1904 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
1907 case SSL_CTRL_SET_MSG_CALLBACK:
1908 ctx->msg_callback = (void (*)
1909 (int write_p, int version, int content_type,
1910 const void *buf, size_t len, SSL *ssl,
1915 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
1919 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
1928 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
1929 const SSL_CIPHER *const *bp)
1931 if ((*ap)->id > (*bp)->id)
1933 if ((*ap)->id < (*bp)->id)
1938 /** return a STACK of the ciphers available for the SSL and in order of
1940 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
1943 if (s->cipher_list != NULL) {
1944 return (s->cipher_list);
1945 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
1946 return (s->ctx->cipher_list);
1952 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
1954 if ((s == NULL) || (s->session == NULL) || !s->server)
1956 return s->session->ciphers;
1959 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
1961 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
1963 ciphers = SSL_get_ciphers(s);
1966 ssl_set_client_disabled(s);
1967 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
1968 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
1969 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
1971 sk = sk_SSL_CIPHER_new_null();
1974 if (!sk_SSL_CIPHER_push(sk, c)) {
1975 sk_SSL_CIPHER_free(sk);
1983 /** return a STACK of the ciphers available for the SSL and in order of
1985 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
1988 if (s->cipher_list_by_id != NULL) {
1989 return (s->cipher_list_by_id);
1990 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
1991 return (s->ctx->cipher_list_by_id);
1997 /** The old interface to get the same thing as SSL_get_ciphers() */
1998 const char *SSL_get_cipher_list(const SSL *s, int n)
2000 const SSL_CIPHER *c;
2001 STACK_OF(SSL_CIPHER) *sk;
2005 sk = SSL_get_ciphers(s);
2006 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2008 c = sk_SSL_CIPHER_value(sk, n);
2014 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2016 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2019 return ctx->cipher_list;
2023 /** specify the ciphers to be used by default by the SSL_CTX */
2024 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2026 STACK_OF(SSL_CIPHER) *sk;
2028 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2029 &ctx->cipher_list_by_id, str, ctx->cert);
2031 * ssl_create_cipher_list may return an empty stack if it was unable to
2032 * find a cipher matching the given rule string (for example if the rule
2033 * string specifies a cipher which has been disabled). This is not an
2034 * error as far as ssl_create_cipher_list is concerned, and hence
2035 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2039 else if (sk_SSL_CIPHER_num(sk) == 0) {
2040 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2046 /** specify the ciphers to be used by the SSL */
2047 int SSL_set_cipher_list(SSL *s, const char *str)
2049 STACK_OF(SSL_CIPHER) *sk;
2051 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2052 &s->cipher_list_by_id, str, s->cert);
2053 /* see comment in SSL_CTX_set_cipher_list */
2056 else if (sk_SSL_CIPHER_num(sk) == 0) {
2057 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2063 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2066 STACK_OF(SSL_CIPHER) *sk;
2067 const SSL_CIPHER *c;
2070 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2074 sk = s->session->ciphers;
2076 if (sk_SSL_CIPHER_num(sk) == 0)
2079 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2082 c = sk_SSL_CIPHER_value(sk, i);
2083 n = strlen(c->name);
2090 memcpy(p, c->name, n + 1);
2099 /** return a servername extension value if provided in Client Hello, or NULL.
2100 * So far, only host_name types are defined (RFC 3546).
2103 const char *SSL_get_servername(const SSL *s, const int type)
2105 if (type != TLSEXT_NAMETYPE_host_name)
2108 return s->session && !s->tlsext_hostname ?
2109 s->session->tlsext_hostname : s->tlsext_hostname;
2112 int SSL_get_servername_type(const SSL *s)
2115 && (!s->tlsext_hostname ? s->session->
2116 tlsext_hostname : s->tlsext_hostname))
2117 return TLSEXT_NAMETYPE_host_name;
2122 * SSL_select_next_proto implements the standard protocol selection. It is
2123 * expected that this function is called from the callback set by
2124 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2125 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2126 * not included in the length. A byte string of length 0 is invalid. No byte
2127 * string may be truncated. The current, but experimental algorithm for
2128 * selecting the protocol is: 1) If the server doesn't support NPN then this
2129 * is indicated to the callback. In this case, the client application has to
2130 * abort the connection or have a default application level protocol. 2) If
2131 * the server supports NPN, but advertises an empty list then the client
2132 * selects the first protcol in its list, but indicates via the API that this
2133 * fallback case was enacted. 3) Otherwise, the client finds the first
2134 * protocol in the server's list that it supports and selects this protocol.
2135 * This is because it's assumed that the server has better information about
2136 * which protocol a client should use. 4) If the client doesn't support any
2137 * of the server's advertised protocols, then this is treated the same as
2138 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2139 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2141 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2142 const unsigned char *server,
2143 unsigned int server_len,
2144 const unsigned char *client,
2145 unsigned int client_len)
2148 const unsigned char *result;
2149 int status = OPENSSL_NPN_UNSUPPORTED;
2152 * For each protocol in server preference order, see if we support it.
2154 for (i = 0; i < server_len;) {
2155 for (j = 0; j < client_len;) {
2156 if (server[i] == client[j] &&
2157 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2158 /* We found a match */
2159 result = &server[i];
2160 status = OPENSSL_NPN_NEGOTIATED;
2170 /* There's no overlap between our protocols and the server's list. */
2172 status = OPENSSL_NPN_NO_OVERLAP;
2175 *out = (unsigned char *)result + 1;
2176 *outlen = result[0];
2180 #ifndef OPENSSL_NO_NEXTPROTONEG
2182 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2183 * client's requested protocol for this connection and returns 0. If the
2184 * client didn't request any protocol, then *data is set to NULL. Note that
2185 * the client can request any protocol it chooses. The value returned from
2186 * this function need not be a member of the list of supported protocols
2187 * provided by the callback.
2189 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2192 *data = s->next_proto_negotiated;
2196 *len = s->next_proto_negotiated_len;
2201 * SSL_CTX_set_next_protos_advertised_cb sets a callback that is called when
2202 * a TLS server needs a list of supported protocols for Next Protocol
2203 * Negotiation. The returned list must be in wire format. The list is
2204 * returned by setting |out| to point to it and |outlen| to its length. This
2205 * memory will not be modified, but one should assume that the SSL* keeps a
2206 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2207 * wishes to advertise. Otherwise, no such extension will be included in the
2210 void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX *ctx,
2211 int (*cb) (SSL *ssl,
2214 unsigned int *outlen,
2215 void *arg), void *arg)
2217 ctx->next_protos_advertised_cb = cb;
2218 ctx->next_protos_advertised_cb_arg = arg;
2222 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2223 * client needs to select a protocol from the server's provided list. |out|
2224 * must be set to point to the selected protocol (which may be within |in|).
2225 * The length of the protocol name must be written into |outlen|. The
2226 * server's advertised protocols are provided in |in| and |inlen|. The
2227 * callback can assume that |in| is syntactically valid. The client must
2228 * select a protocol. It is fatal to the connection if this callback returns
2229 * a value other than SSL_TLSEXT_ERR_OK.
2231 void SSL_CTX_set_next_proto_select_cb(SSL_CTX *ctx,
2232 int (*cb) (SSL *s, unsigned char **out,
2233 unsigned char *outlen,
2234 const unsigned char *in,
2236 void *arg), void *arg)
2238 ctx->next_proto_select_cb = cb;
2239 ctx->next_proto_select_cb_arg = arg;
2244 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2245 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2246 * length-prefixed strings). Returns 0 on success.
2248 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2249 unsigned int protos_len)
2251 OPENSSL_free(ctx->alpn_client_proto_list);
2252 ctx->alpn_client_proto_list = OPENSSL_memdup(protos, protos_len);
2253 if (ctx->alpn_client_proto_list == NULL) {
2254 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2257 ctx->alpn_client_proto_list_len = protos_len;
2263 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2264 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2265 * length-prefixed strings). Returns 0 on success.
2267 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2268 unsigned int protos_len)
2270 OPENSSL_free(ssl->alpn_client_proto_list);
2271 ssl->alpn_client_proto_list = OPENSSL_memdup(protos, protos_len);
2272 if (ssl->alpn_client_proto_list == NULL) {
2273 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2276 ssl->alpn_client_proto_list_len = protos_len;
2282 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2283 * called during ClientHello processing in order to select an ALPN protocol
2284 * from the client's list of offered protocols.
2286 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2287 int (*cb) (SSL *ssl,
2288 const unsigned char **out,
2289 unsigned char *outlen,
2290 const unsigned char *in,
2292 void *arg), void *arg)
2294 ctx->alpn_select_cb = cb;
2295 ctx->alpn_select_cb_arg = arg;
2299 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2300 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2301 * (not including the leading length-prefix byte). If the server didn't
2302 * respond with a negotiated protocol then |*len| will be zero.
2304 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2309 *data = ssl->s3->alpn_selected;
2313 *len = ssl->s3->alpn_selected_len;
2317 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2318 const char *label, size_t llen,
2319 const unsigned char *p, size_t plen,
2322 if (s->version < TLS1_VERSION)
2325 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2330 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2335 ((unsigned int)a->session_id[0]) |
2336 ((unsigned int)a->session_id[1] << 8L) |
2337 ((unsigned long)a->session_id[2] << 16L) |
2338 ((unsigned long)a->session_id[3] << 24L);
2343 * NB: If this function (or indeed the hash function which uses a sort of
2344 * coarser function than this one) is changed, ensure
2345 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2346 * being able to construct an SSL_SESSION that will collide with any existing
2347 * session with a matching session ID.
2349 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2351 if (a->ssl_version != b->ssl_version)
2353 if (a->session_id_length != b->session_id_length)
2355 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2359 * These wrapper functions should remain rather than redeclaring
2360 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2361 * variable. The reason is that the functions aren't static, they're exposed
2365 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2367 SSL_CTX *ret = NULL;
2370 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2374 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2377 if (FIPS_mode() && (meth->version < TLS1_VERSION)) {
2378 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE);
2382 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2383 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2386 ret = OPENSSL_zalloc(sizeof(*ret));
2391 ret->min_proto_version = 0;
2392 ret->max_proto_version = 0;
2393 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2394 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2395 /* We take the system default. */
2396 ret->session_timeout = meth->get_timeout();
2397 ret->references = 1;
2398 ret->lock = CRYPTO_THREAD_lock_new();
2399 if (ret->lock == NULL) {
2400 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2404 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2405 ret->verify_mode = SSL_VERIFY_NONE;
2406 if ((ret->cert = ssl_cert_new()) == NULL)
2409 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2410 if (ret->sessions == NULL)
2412 ret->cert_store = X509_STORE_new();
2413 if (ret->cert_store == NULL)
2415 #ifndef OPENSSL_NO_CT
2416 ret->ctlog_store = CTLOG_STORE_new();
2417 if (ret->ctlog_store == NULL)
2420 if (!ssl_create_cipher_list(ret->method,
2421 &ret->cipher_list, &ret->cipher_list_by_id,
2422 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2423 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2424 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2428 ret->param = X509_VERIFY_PARAM_new();
2429 if (ret->param == NULL)
2432 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2433 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2436 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2437 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2441 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2444 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data);
2446 /* No compression for DTLS */
2447 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2448 ret->comp_methods = SSL_COMP_get_compression_methods();
2450 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2451 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2453 /* Setup RFC4507 ticket keys */
2454 if ((RAND_bytes(ret->tlsext_tick_key_name, 16) <= 0)
2455 || (RAND_bytes(ret->tlsext_tick_hmac_key, 16) <= 0)
2456 || (RAND_bytes(ret->tlsext_tick_aes_key, 16) <= 0))
2457 ret->options |= SSL_OP_NO_TICKET;
2459 #ifndef OPENSSL_NO_SRP
2460 if (!SSL_CTX_SRP_CTX_init(ret))
2463 #ifndef OPENSSL_NO_ENGINE
2464 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2465 # define eng_strx(x) #x
2466 # define eng_str(x) eng_strx(x)
2467 /* Use specific client engine automatically... ignore errors */
2470 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2473 ENGINE_load_builtin_engines();
2474 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2476 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2482 * Default is to connect to non-RI servers. When RI is more widely
2483 * deployed might change this.
2485 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2487 * Disable compression by default to prevent CRIME. Applications can
2488 * re-enable compression by configuring
2489 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2490 * or by using the SSL_CONF library.
2492 ret->options |= SSL_OP_NO_COMPRESSION;
2496 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2502 void SSL_CTX_up_ref(SSL_CTX *ctx)
2505 CRYPTO_atomic_add(&ctx->references, 1, &i, ctx->lock);
2508 void SSL_CTX_free(SSL_CTX *a)
2515 CRYPTO_atomic_add(&a->references, -1, &i, a->lock);
2516 REF_PRINT_COUNT("SSL_CTX", a);
2519 REF_ASSERT_ISNT(i < 0);
2521 X509_VERIFY_PARAM_free(a->param);
2522 dane_ctx_final(&a->dane);
2525 * Free internal session cache. However: the remove_cb() may reference
2526 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2527 * after the sessions were flushed.
2528 * As the ex_data handling routines might also touch the session cache,
2529 * the most secure solution seems to be: empty (flush) the cache, then
2530 * free ex_data, then finally free the cache.
2531 * (See ticket [openssl.org #212].)
2533 if (a->sessions != NULL)
2534 SSL_CTX_flush_sessions(a, 0);
2536 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2537 lh_SSL_SESSION_free(a->sessions);
2538 X509_STORE_free(a->cert_store);
2539 #ifndef OPENSSL_NO_CT
2540 CTLOG_STORE_free(a->ctlog_store);
2542 sk_SSL_CIPHER_free(a->cipher_list);
2543 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2544 ssl_cert_free(a->cert);
2545 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2546 sk_X509_pop_free(a->extra_certs, X509_free);
2547 a->comp_methods = NULL;
2548 #ifndef OPENSSL_NO_SRTP
2549 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2551 #ifndef OPENSSL_NO_SRP
2552 SSL_CTX_SRP_CTX_free(a);
2554 #ifndef OPENSSL_NO_ENGINE
2555 ENGINE_finish(a->client_cert_engine);
2558 #ifndef OPENSSL_NO_EC
2559 OPENSSL_free(a->tlsext_ecpointformatlist);
2560 OPENSSL_free(a->tlsext_ellipticcurvelist);
2562 OPENSSL_free(a->alpn_client_proto_list);
2564 CRYPTO_THREAD_lock_free(a->lock);
2569 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2571 ctx->default_passwd_callback = cb;
2574 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2576 ctx->default_passwd_callback_userdata = u;
2579 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2581 return ctx->default_passwd_callback;
2584 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2586 return ctx->default_passwd_callback_userdata;
2589 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2591 s->default_passwd_callback = cb;
2594 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2596 s->default_passwd_callback_userdata = u;
2599 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2601 return s->default_passwd_callback;
2604 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2606 return s->default_passwd_callback_userdata;
2609 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2610 int (*cb) (X509_STORE_CTX *, void *),
2613 ctx->app_verify_callback = cb;
2614 ctx->app_verify_arg = arg;
2617 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2618 int (*cb) (int, X509_STORE_CTX *))
2620 ctx->verify_mode = mode;
2621 ctx->default_verify_callback = cb;
2624 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2626 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2629 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg),
2632 ssl_cert_set_cert_cb(c->cert, cb, arg);
2635 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2637 ssl_cert_set_cert_cb(s->cert, cb, arg);
2640 void ssl_set_masks(SSL *s)
2642 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_GOST)
2646 uint32_t *pvalid = s->s3->tmp.valid_flags;
2647 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2648 unsigned long mask_k, mask_a;
2649 #ifndef OPENSSL_NO_EC
2650 int have_ecc_cert, ecdsa_ok;
2656 #ifndef OPENSSL_NO_DH
2657 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2662 rsa_enc = pvalid[SSL_PKEY_RSA_ENC] & CERT_PKEY_VALID;
2663 rsa_sign = pvalid[SSL_PKEY_RSA_SIGN] & CERT_PKEY_SIGN;
2664 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_SIGN;
2665 #ifndef OPENSSL_NO_EC
2666 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2672 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2673 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2676 #ifndef OPENSSL_NO_GOST
2677 cpk = &(c->pkeys[SSL_PKEY_GOST12_512]);
2678 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2679 mask_k |= SSL_kGOST;
2680 mask_a |= SSL_aGOST12;
2682 cpk = &(c->pkeys[SSL_PKEY_GOST12_256]);
2683 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2684 mask_k |= SSL_kGOST;
2685 mask_a |= SSL_aGOST12;
2687 cpk = &(c->pkeys[SSL_PKEY_GOST01]);
2688 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2689 mask_k |= SSL_kGOST;
2690 mask_a |= SSL_aGOST01;
2700 if (rsa_enc || rsa_sign) {
2708 mask_a |= SSL_aNULL;
2711 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2712 * depending on the key usage extension.
2714 #ifndef OPENSSL_NO_EC
2715 if (have_ecc_cert) {
2717 cpk = &c->pkeys[SSL_PKEY_ECC];
2719 ex_kusage = X509_get_key_usage(x);
2720 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2721 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2724 mask_a |= SSL_aECDSA;
2728 #ifndef OPENSSL_NO_EC
2729 mask_k |= SSL_kECDHE;
2732 #ifndef OPENSSL_NO_PSK
2735 if (mask_k & SSL_kRSA)
2736 mask_k |= SSL_kRSAPSK;
2737 if (mask_k & SSL_kDHE)
2738 mask_k |= SSL_kDHEPSK;
2739 if (mask_k & SSL_kECDHE)
2740 mask_k |= SSL_kECDHEPSK;
2743 s->s3->tmp.mask_k = mask_k;
2744 s->s3->tmp.mask_a = mask_a;
2747 #ifndef OPENSSL_NO_EC
2749 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
2751 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
2752 /* key usage, if present, must allow signing */
2753 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
2754 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
2755 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
2759 return 1; /* all checks are ok */
2764 static int ssl_get_server_cert_index(const SSL *s)
2767 idx = ssl_cipher_get_cert_index(s->s3->tmp.new_cipher);
2768 if (idx == SSL_PKEY_RSA_ENC && !s->cert->pkeys[SSL_PKEY_RSA_ENC].x509)
2769 idx = SSL_PKEY_RSA_SIGN;
2770 if (idx == SSL_PKEY_GOST_EC) {
2771 if (s->cert->pkeys[SSL_PKEY_GOST12_512].x509)
2772 idx = SSL_PKEY_GOST12_512;
2773 else if (s->cert->pkeys[SSL_PKEY_GOST12_256].x509)
2774 idx = SSL_PKEY_GOST12_256;
2775 else if (s->cert->pkeys[SSL_PKEY_GOST01].x509)
2776 idx = SSL_PKEY_GOST01;
2781 SSLerr(SSL_F_SSL_GET_SERVER_CERT_INDEX, ERR_R_INTERNAL_ERROR);
2785 CERT_PKEY *ssl_get_server_send_pkey(SSL *s)
2791 if (!s->s3 || !s->s3->tmp.new_cipher)
2795 i = ssl_get_server_cert_index(s);
2797 /* This may or may not be an error. */
2802 return &c->pkeys[i];
2805 EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *cipher,
2808 unsigned long alg_a;
2812 alg_a = cipher->algorithm_auth;
2815 if ((alg_a & SSL_aDSS) &&
2816 (c->pkeys[SSL_PKEY_DSA_SIGN].privatekey != NULL))
2817 idx = SSL_PKEY_DSA_SIGN;
2818 else if (alg_a & SSL_aRSA) {
2819 if (c->pkeys[SSL_PKEY_RSA_SIGN].privatekey != NULL)
2820 idx = SSL_PKEY_RSA_SIGN;
2821 else if (c->pkeys[SSL_PKEY_RSA_ENC].privatekey != NULL)
2822 idx = SSL_PKEY_RSA_ENC;
2823 } else if ((alg_a & SSL_aECDSA) &&
2824 (c->pkeys[SSL_PKEY_ECC].privatekey != NULL))
2827 SSLerr(SSL_F_SSL_GET_SIGN_PKEY, ERR_R_INTERNAL_ERROR);
2831 *pmd = s->s3->tmp.md[idx];
2832 return c->pkeys[idx].privatekey;
2835 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
2836 size_t *serverinfo_length)
2840 *serverinfo_length = 0;
2843 i = ssl_get_server_cert_index(s);
2847 if (c->pkeys[i].serverinfo == NULL)
2850 *serverinfo = c->pkeys[i].serverinfo;
2851 *serverinfo_length = c->pkeys[i].serverinfo_length;
2855 void ssl_update_cache(SSL *s, int mode)
2860 * If the session_id_length is 0, we are not supposed to cache it, and it
2861 * would be rather hard to do anyway :-)
2863 if (s->session->session_id_length == 0)
2866 i = s->session_ctx->session_cache_mode;
2867 if ((i & mode) && (!s->hit)
2868 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
2869 || SSL_CTX_add_session(s->session_ctx, s->session))
2870 && (s->session_ctx->new_session_cb != NULL)) {
2871 SSL_SESSION_up_ref(s->session);
2872 if (!s->session_ctx->new_session_cb(s, s->session))
2873 SSL_SESSION_free(s->session);
2876 /* auto flush every 255 connections */
2877 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
2878 if ((((mode & SSL_SESS_CACHE_CLIENT)
2879 ? s->session_ctx->stats.sess_connect_good
2880 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
2881 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
2886 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
2891 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
2896 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
2900 if (s->method != meth) {
2901 const SSL_METHOD *sm = s->method;
2902 int (*hf)(SSL *) = s->handshake_func;
2904 if (sm->version == meth->version)
2909 ret = s->method->ssl_new(s);
2912 if (hf == sm->ssl_connect)
2913 s->handshake_func = meth->ssl_connect;
2914 else if (hf == sm->ssl_accept)
2915 s->handshake_func = meth->ssl_accept;
2920 int SSL_get_error(const SSL *s, int i)
2927 return (SSL_ERROR_NONE);
2930 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
2931 * where we do encode the error
2933 if ((l = ERR_peek_error()) != 0) {
2934 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
2935 return (SSL_ERROR_SYSCALL);
2937 return (SSL_ERROR_SSL);
2940 if ((i < 0) && SSL_want_read(s)) {
2941 bio = SSL_get_rbio(s);
2942 if (BIO_should_read(bio))
2943 return (SSL_ERROR_WANT_READ);
2944 else if (BIO_should_write(bio))
2946 * This one doesn't make too much sense ... We never try to write
2947 * to the rbio, and an application program where rbio and wbio
2948 * are separate couldn't even know what it should wait for.
2949 * However if we ever set s->rwstate incorrectly (so that we have
2950 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
2951 * wbio *are* the same, this test works around that bug; so it
2952 * might be safer to keep it.
2954 return (SSL_ERROR_WANT_WRITE);
2955 else if (BIO_should_io_special(bio)) {
2956 reason = BIO_get_retry_reason(bio);
2957 if (reason == BIO_RR_CONNECT)
2958 return (SSL_ERROR_WANT_CONNECT);
2959 else if (reason == BIO_RR_ACCEPT)
2960 return (SSL_ERROR_WANT_ACCEPT);
2962 return (SSL_ERROR_SYSCALL); /* unknown */
2966 if ((i < 0) && SSL_want_write(s)) {
2967 bio = SSL_get_wbio(s);
2968 if (BIO_should_write(bio))
2969 return (SSL_ERROR_WANT_WRITE);
2970 else if (BIO_should_read(bio))
2972 * See above (SSL_want_read(s) with BIO_should_write(bio))
2974 return (SSL_ERROR_WANT_READ);
2975 else if (BIO_should_io_special(bio)) {
2976 reason = BIO_get_retry_reason(bio);
2977 if (reason == BIO_RR_CONNECT)
2978 return (SSL_ERROR_WANT_CONNECT);
2979 else if (reason == BIO_RR_ACCEPT)
2980 return (SSL_ERROR_WANT_ACCEPT);
2982 return (SSL_ERROR_SYSCALL);
2985 if ((i < 0) && SSL_want_x509_lookup(s)) {
2986 return (SSL_ERROR_WANT_X509_LOOKUP);
2988 if ((i < 0) && SSL_want_async(s)) {
2989 return SSL_ERROR_WANT_ASYNC;
2993 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
2994 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
2995 return (SSL_ERROR_ZERO_RETURN);
2997 return (SSL_ERROR_SYSCALL);
3000 static int ssl_do_handshake_intern(void *vargs)
3002 struct ssl_async_args *args;
3005 args = (struct ssl_async_args *)vargs;
3008 return s->handshake_func(s);
3011 int SSL_do_handshake(SSL *s)
3015 if (s->handshake_func == NULL) {
3016 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3020 s->method->ssl_renegotiate_check(s);
3022 if (SSL_in_init(s) || SSL_in_before(s)) {
3023 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3024 struct ssl_async_args args;
3028 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3030 ret = s->handshake_func(s);
3036 void SSL_set_accept_state(SSL *s)
3040 ossl_statem_clear(s);
3041 s->handshake_func = s->method->ssl_accept;
3045 void SSL_set_connect_state(SSL *s)
3049 ossl_statem_clear(s);
3050 s->handshake_func = s->method->ssl_connect;
3054 int ssl_undefined_function(SSL *s)
3056 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3060 int ssl_undefined_void_function(void)
3062 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3063 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3067 int ssl_undefined_const_function(const SSL *s)
3072 const SSL_METHOD *ssl_bad_method(int ver)
3074 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3078 const char *ssl_protocol_to_string(int version)
3080 if (version == TLS1_2_VERSION)
3082 else if (version == TLS1_1_VERSION)
3084 else if (version == TLS1_VERSION)
3086 else if (version == SSL3_VERSION)
3088 else if (version == DTLS1_BAD_VER)
3090 else if (version == DTLS1_VERSION)
3092 else if (version == DTLS1_2_VERSION)
3098 const char *SSL_get_version(const SSL *s)
3100 return ssl_protocol_to_string(s->version);
3103 SSL *SSL_dup(SSL *s)
3105 STACK_OF(X509_NAME) *sk;
3110 /* If we're not quiescent, just up_ref! */
3111 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3112 CRYPTO_atomic_add(&s->references, 1, &i, s->lock);
3117 * Otherwise, copy configuration state, and session if set.
3119 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3122 if (s->session != NULL) {
3124 * Arranges to share the same session via up_ref. This "copies"
3125 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3127 if (!SSL_copy_session_id(ret, s))
3131 * No session has been established yet, so we have to expect that
3132 * s->cert or ret->cert will be changed later -- they should not both
3133 * point to the same object, and thus we can't use
3134 * SSL_copy_session_id.
3136 if (!SSL_set_ssl_method(ret, s->method))
3139 if (s->cert != NULL) {
3140 ssl_cert_free(ret->cert);
3141 ret->cert = ssl_cert_dup(s->cert);
3142 if (ret->cert == NULL)
3146 if (!SSL_set_session_id_context(ret, s->sid_ctx, s->sid_ctx_length))
3150 if (!ssl_dane_dup(ret, s))
3152 ret->version = s->version;
3153 ret->options = s->options;
3154 ret->mode = s->mode;
3155 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3156 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3157 ret->msg_callback = s->msg_callback;
3158 ret->msg_callback_arg = s->msg_callback_arg;
3159 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3160 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3161 ret->generate_session_id = s->generate_session_id;
3163 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3165 /* copy app data, a little dangerous perhaps */
3166 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3169 /* setup rbio, and wbio */
3170 if (s->rbio != NULL) {
3171 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3174 if (s->wbio != NULL) {
3175 if (s->wbio != s->rbio) {
3176 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3179 ret->wbio = ret->rbio;
3182 ret->server = s->server;
3183 if (s->handshake_func) {
3185 SSL_set_accept_state(ret);
3187 SSL_set_connect_state(ret);
3189 ret->shutdown = s->shutdown;
3192 ret->default_passwd_callback = s->default_passwd_callback;
3193 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3195 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3197 /* dup the cipher_list and cipher_list_by_id stacks */
3198 if (s->cipher_list != NULL) {
3199 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3202 if (s->cipher_list_by_id != NULL)
3203 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3207 /* Dup the client_CA list */
3208 if (s->client_CA != NULL) {
3209 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3211 ret->client_CA = sk;
3212 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3213 xn = sk_X509_NAME_value(sk, i);
3214 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3227 void ssl_clear_cipher_ctx(SSL *s)
3229 if (s->enc_read_ctx != NULL) {
3230 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3231 s->enc_read_ctx = NULL;
3233 if (s->enc_write_ctx != NULL) {
3234 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3235 s->enc_write_ctx = NULL;
3237 #ifndef OPENSSL_NO_COMP
3238 COMP_CTX_free(s->expand);
3240 COMP_CTX_free(s->compress);
3245 X509 *SSL_get_certificate(const SSL *s)
3247 if (s->cert != NULL)
3248 return (s->cert->key->x509);
3253 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3255 if (s->cert != NULL)
3256 return (s->cert->key->privatekey);
3261 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3263 if (ctx->cert != NULL)
3264 return ctx->cert->key->x509;
3269 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3271 if (ctx->cert != NULL)
3272 return ctx->cert->key->privatekey;
3277 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3279 if ((s->session != NULL) && (s->session->cipher != NULL))
3280 return (s->session->cipher);
3284 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3286 #ifndef OPENSSL_NO_COMP
3287 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3293 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3295 #ifndef OPENSSL_NO_COMP
3296 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3302 int ssl_init_wbio_buffer(SSL *s, int push)
3306 if (s->bbio == NULL) {
3307 bbio = BIO_new(BIO_f_buffer());
3313 if (s->bbio == s->wbio)
3314 s->wbio = BIO_pop(s->wbio);
3316 (void)BIO_reset(bbio);
3317 /* if (!BIO_set_write_buffer_size(bbio,16*1024)) */
3318 if (!BIO_set_read_buffer_size(bbio, 1)) {
3319 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3323 if (s->wbio != bbio)
3324 s->wbio = BIO_push(bbio, s->wbio);
3326 if (s->wbio == bbio)
3327 s->wbio = BIO_pop(bbio);
3332 void ssl_free_wbio_buffer(SSL *s)
3334 /* callers ensure s is never null */
3335 if (s->bbio == NULL)
3338 if (s->bbio == s->wbio) {
3339 /* remove buffering */
3340 s->wbio = BIO_pop(s->wbio);
3341 assert(s->wbio != NULL);
3347 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3349 ctx->quiet_shutdown = mode;
3352 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3354 return (ctx->quiet_shutdown);
3357 void SSL_set_quiet_shutdown(SSL *s, int mode)
3359 s->quiet_shutdown = mode;
3362 int SSL_get_quiet_shutdown(const SSL *s)
3364 return (s->quiet_shutdown);
3367 void SSL_set_shutdown(SSL *s, int mode)
3372 int SSL_get_shutdown(const SSL *s)
3374 return (s->shutdown);
3377 int SSL_version(const SSL *s)
3379 return (s->version);
3382 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3387 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3390 if (ssl->ctx == ctx)
3393 ctx = ssl->initial_ctx;
3394 new_cert = ssl_cert_dup(ctx->cert);
3395 if (new_cert == NULL) {
3398 ssl_cert_free(ssl->cert);
3399 ssl->cert = new_cert;
3402 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3403 * so setter APIs must prevent invalid lengths from entering the system.
3405 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3408 * If the session ID context matches that of the parent SSL_CTX,
3409 * inherit it from the new SSL_CTX as well. If however the context does
3410 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3411 * leave it unchanged.
3413 if ((ssl->ctx != NULL) &&
3414 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3415 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3416 ssl->sid_ctx_length = ctx->sid_ctx_length;
3417 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3420 SSL_CTX_up_ref(ctx);
3421 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3427 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3429 return (X509_STORE_set_default_paths(ctx->cert_store));
3432 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3434 X509_LOOKUP *lookup;
3436 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3439 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3441 /* Clear any errors if the default directory does not exist */
3447 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3449 X509_LOOKUP *lookup;
3451 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3455 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3457 /* Clear any errors if the default file does not exist */
3463 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3466 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3469 void SSL_set_info_callback(SSL *ssl,
3470 void (*cb) (const SSL *ssl, int type, int val))
3472 ssl->info_callback = cb;
3476 * One compiler (Diab DCC) doesn't like argument names in returned function
3479 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3482 return ssl->info_callback;
3485 void SSL_set_verify_result(SSL *ssl, long arg)
3487 ssl->verify_result = arg;
3490 long SSL_get_verify_result(const SSL *ssl)
3492 return (ssl->verify_result);
3495 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3498 return sizeof(ssl->s3->client_random);
3499 if (outlen > sizeof(ssl->s3->client_random))
3500 outlen = sizeof(ssl->s3->client_random);
3501 memcpy(out, ssl->s3->client_random, outlen);
3505 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3508 return sizeof(ssl->s3->server_random);
3509 if (outlen > sizeof(ssl->s3->server_random))
3510 outlen = sizeof(ssl->s3->server_random);
3511 memcpy(out, ssl->s3->server_random, outlen);
3515 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3516 unsigned char *out, size_t outlen)
3518 if (session->master_key_length < 0) {
3519 /* Should never happen */
3523 return session->master_key_length;
3524 if (outlen > (size_t)session->master_key_length)
3525 outlen = session->master_key_length;
3526 memcpy(out, session->master_key, outlen);
3530 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3532 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3535 void *SSL_get_ex_data(const SSL *s, int idx)
3537 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3540 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3542 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3545 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3547 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3555 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3557 return (ctx->cert_store);
3560 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3562 X509_STORE_free(ctx->cert_store);
3563 ctx->cert_store = store;
3566 int SSL_want(const SSL *s)
3568 return (s->rwstate);
3572 * \brief Set the callback for generating temporary DH keys.
3573 * \param ctx the SSL context.
3574 * \param dh the callback
3577 #ifndef OPENSSL_NO_DH
3578 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3579 DH *(*dh) (SSL *ssl, int is_export,
3582 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3585 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3588 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3592 #ifndef OPENSSL_NO_PSK
3593 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3595 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3596 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT,
3597 SSL_R_DATA_LENGTH_TOO_LONG);
3600 OPENSSL_free(ctx->cert->psk_identity_hint);
3601 if (identity_hint != NULL) {
3602 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3603 if (ctx->cert->psk_identity_hint == NULL)
3606 ctx->cert->psk_identity_hint = NULL;
3610 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3615 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3616 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3619 OPENSSL_free(s->cert->psk_identity_hint);
3620 if (identity_hint != NULL) {
3621 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3622 if (s->cert->psk_identity_hint == NULL)
3625 s->cert->psk_identity_hint = NULL;
3629 const char *SSL_get_psk_identity_hint(const SSL *s)
3631 if (s == NULL || s->session == NULL)
3633 return (s->session->psk_identity_hint);
3636 const char *SSL_get_psk_identity(const SSL *s)
3638 if (s == NULL || s->session == NULL)
3640 return (s->session->psk_identity);
3643 void SSL_set_psk_client_callback(SSL *s,
3644 unsigned int (*cb) (SSL *ssl,
3653 s->psk_client_callback = cb;
3656 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx,
3657 unsigned int (*cb) (SSL *ssl,
3666 ctx->psk_client_callback = cb;
3669 void SSL_set_psk_server_callback(SSL *s,
3670 unsigned int (*cb) (SSL *ssl,
3671 const char *identity,
3676 s->psk_server_callback = cb;
3679 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx,
3680 unsigned int (*cb) (SSL *ssl,
3681 const char *identity,
3686 ctx->psk_server_callback = cb;
3690 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3691 void (*cb) (int write_p, int version,
3692 int content_type, const void *buf,
3693 size_t len, SSL *ssl, void *arg))
3695 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3698 void SSL_set_msg_callback(SSL *ssl,
3699 void (*cb) (int write_p, int version,
3700 int content_type, const void *buf,
3701 size_t len, SSL *ssl, void *arg))
3703 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3706 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3707 int (*cb) (SSL *ssl,
3711 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3712 (void (*)(void))cb);
3715 void SSL_set_not_resumable_session_callback(SSL *ssl,
3716 int (*cb) (SSL *ssl,
3717 int is_forward_secure))
3719 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3720 (void (*)(void))cb);
3724 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3725 * vairable, freeing EVP_MD_CTX previously stored in that variable, if any.
3726 * If EVP_MD pointer is passed, initializes ctx with this md Returns newly
3730 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3732 ssl_clear_hash_ctx(hash);
3733 *hash = EVP_MD_CTX_new();
3734 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3735 EVP_MD_CTX_free(*hash);
3742 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3746 EVP_MD_CTX_free(*hash);
3750 /* Retrieve handshake hashes */
3751 int ssl_handshake_hash(SSL *s, unsigned char *out, int outlen)
3753 EVP_MD_CTX *ctx = NULL;
3754 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3755 int ret = EVP_MD_CTX_size(hdgst);
3756 if (ret < 0 || ret > outlen) {
3760 ctx = EVP_MD_CTX_new();
3765 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3766 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3769 EVP_MD_CTX_free(ctx);
3773 int SSL_session_reused(SSL *s)
3778 int SSL_is_server(SSL *s)
3783 #if OPENSSL_API_COMPAT < 0x10100000L
3784 void SSL_set_debug(SSL *s, int debug)
3786 /* Old function was do-nothing anyway... */
3793 void SSL_set_security_level(SSL *s, int level)
3795 s->cert->sec_level = level;
3798 int SSL_get_security_level(const SSL *s)
3800 return s->cert->sec_level;
3803 void SSL_set_security_callback(SSL *s,
3804 int (*cb) (const SSL *s, const SSL_CTX *ctx, int op,
3805 int bits, int nid, void *other,
3808 s->cert->sec_cb = cb;
3811 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s, const SSL_CTX *ctx, int op,
3813 void *other, void *ex) {
3814 return s->cert->sec_cb;
3817 void SSL_set0_security_ex_data(SSL *s, void *ex)
3819 s->cert->sec_ex = ex;
3822 void *SSL_get0_security_ex_data(const SSL *s)
3824 return s->cert->sec_ex;
3827 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
3829 ctx->cert->sec_level = level;
3832 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
3834 return ctx->cert->sec_level;
3837 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
3838 int (*cb) (const SSL *s, const SSL_CTX *ctx, int op,
3839 int bits, int nid, void *other,
3842 ctx->cert->sec_cb = cb;
3845 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
3851 return ctx->cert->sec_cb;
3854 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
3856 ctx->cert->sec_ex = ex;
3859 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
3861 return ctx->cert->sec_ex;
3866 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3867 * can return unsigned long, instead of the generic long return value from the
3868 * control interface.
3870 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
3872 return ctx->options;
3874 unsigned long SSL_get_options(const SSL* s)
3878 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
3880 return ctx->options |= op;
3882 unsigned long SSL_set_options(SSL *s, unsigned long op)
3884 return s->options |= op;
3886 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
3888 return ctx->options &= ~op;
3890 unsigned long SSL_clear_options(SSL *s, unsigned long op)
3892 return s->options &= ~op;
3895 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
3897 return s->verified_chain;
3900 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
3902 #ifndef OPENSSL_NO_CT
3905 * Moves SCTs from the |src| stack to the |dst| stack.
3906 * The source of each SCT will be set to |origin|.
3907 * If |dst| points to a NULL pointer, a new stack will be created and owned by
3909 * Returns the number of SCTs moved, or a negative integer if an error occurs.
3911 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src, sct_source_t origin)
3917 *dst = sk_SCT_new_null();
3919 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
3924 while ((sct = sk_SCT_pop(src)) != NULL) {
3925 if (SCT_set_source(sct, origin) != 1)
3928 if (sk_SCT_push(*dst, sct) <= 0)
3936 sk_SCT_push(src, sct); /* Put the SCT back */
3941 * Look for data collected during ServerHello and parse if found.
3942 * Return 1 on success, 0 on failure.
3944 static int ct_extract_tls_extension_scts(SSL *s)
3946 int scts_extracted = 0;
3948 if (s->tlsext_scts != NULL) {
3949 const unsigned char *p = s->tlsext_scts;
3950 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->tlsext_scts_len);
3952 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
3954 SCT_LIST_free(scts);
3957 return scts_extracted;
3961 * Checks for an OCSP response and then attempts to extract any SCTs found if it
3962 * contains an SCT X509 extension. They will be stored in |s->scts|.
3964 * - The number of SCTs extracted, assuming an OCSP response exists.
3965 * - 0 if no OCSP response exists or it contains no SCTs.
3966 * - A negative integer if an error occurs.
3968 static int ct_extract_ocsp_response_scts(SSL *s)
3970 #ifndef OPENSSL_NO_OCSP
3971 int scts_extracted = 0;
3972 const unsigned char *p;
3973 OCSP_BASICRESP *br = NULL;
3974 OCSP_RESPONSE *rsp = NULL;
3975 STACK_OF(SCT) *scts = NULL;
3978 if (s->tlsext_ocsp_resp == NULL || s->tlsext_ocsp_resplen == 0)
3981 p = s->tlsext_ocsp_resp;
3982 rsp = d2i_OCSP_RESPONSE(NULL, &p, s->tlsext_ocsp_resplen);
3986 br = OCSP_response_get1_basic(rsp);
3990 for (i = 0; i < OCSP_resp_count(br); ++i) {
3991 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
3996 scts = OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
3997 scts_extracted = ct_move_scts(&s->scts, scts,
3998 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)) {
4088 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4089 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4093 if (callback != NULL) {
4094 /* If we are validating CT, then we MUST accept SCTs served via OCSP */
4095 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4099 s->ct_validation_callback = callback;
4100 s->ct_validation_callback_arg = arg;
4105 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4106 ssl_ct_validation_cb callback,
4110 * Since code exists that uses the custom extension handler for CT, look for
4111 * this and throw an error if they have already registered to use CT.
4113 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4114 TLSEXT_TYPE_signed_certificate_timestamp)) {
4115 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4116 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4120 ctx->ct_validation_callback = callback;
4121 ctx->ct_validation_callback_arg = arg;
4125 int SSL_ct_is_enabled(const SSL *s)
4127 return s->ct_validation_callback != NULL;
4130 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4132 return ctx->ct_validation_callback != NULL;
4135 int ssl_validate_ct(SSL *s)
4138 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4140 SSL_DANE *dane = &s->dane;
4141 CT_POLICY_EVAL_CTX *ctx = NULL;
4142 const STACK_OF(SCT) *scts;
4145 * If no callback is set, the peer is anonymous, or its chain is invalid,
4146 * skip SCT validation - just return success. Applications that continue
4147 * handshakes without certificates, with unverified chains, or pinned leaf
4148 * certificates are outside the scope of the WebPKI and CT.
4150 * The above exclusions notwithstanding the vast majority of peers will
4151 * have rather ordinary certificate chains validated by typical
4152 * applications that perform certificate verification and therefore will
4153 * process SCTs when enabled.
4155 if (s->ct_validation_callback == NULL || cert == NULL ||
4156 s->verify_result != X509_V_OK ||
4157 s->verified_chain == NULL ||
4158 sk_X509_num(s->verified_chain) <= 1)
4162 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4163 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4165 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4166 switch (dane->mtlsa->usage) {
4167 case DANETLS_USAGE_DANE_TA:
4168 case DANETLS_USAGE_DANE_EE:
4173 ctx = CT_POLICY_EVAL_CTX_new();
4175 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4179 issuer = sk_X509_value(s->verified_chain, 1);
4180 CT_POLICY_EVAL_CTX_set0_cert(ctx, cert);
4181 CT_POLICY_EVAL_CTX_set0_issuer(ctx, issuer);
4182 CT_POLICY_EVAL_CTX_set0_log_store(ctx, s->ctx->ctlog_store);
4184 scts = SSL_get0_peer_scts(s);
4187 * This function returns success (> 0) only when all the SCTs are valid, 0
4188 * when some are invalid, and < 0 on various internal errors (out of
4189 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4190 * reason to abort the handshake, that decision is up to the callback.
4191 * Therefore, we error out only in the unexpected case that the return
4192 * value is negative.
4194 * XXX: One might well argue that the return value of this function is an
4195 * unforunate design choice. Its job is only to determine the validation
4196 * status of each of the provided SCTs. So long as it correctly separates
4197 * the wheat from the chaff it should return success. Failure in this case
4198 * ought to correspond to an inability to carry out its duties.
4200 if (SCT_LIST_validate(scts, ctx) < 0) {
4201 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4205 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4207 ret = 0; /* This function returns 0 on failure */
4210 CT_POLICY_EVAL_CTX_free(ctx);
4214 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4216 switch (validation_mode) {
4218 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4220 case SSL_CT_VALIDATION_PERMISSIVE:
4221 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4222 case SSL_CT_VALIDATION_STRICT:
4223 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4227 int SSL_enable_ct(SSL *s, int validation_mode)
4229 switch (validation_mode) {
4231 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4233 case SSL_CT_VALIDATION_PERMISSIVE:
4234 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4235 case SSL_CT_VALIDATION_STRICT:
4236 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4240 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4242 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4245 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4247 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4250 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE *logs)
4252 CTLOG_STORE_free(ctx->ctlog_store);
4253 ctx->ctlog_store = logs;
4256 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4258 return ctx->ctlog_store;