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 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
757 #ifndef OPENSSL_NO_PSK
758 s->psk_client_callback = ctx->psk_client_callback;
759 s->psk_server_callback = ctx->psk_server_callback;
764 #ifndef OPENSSL_NO_CT
765 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
766 ctx->ct_validation_callback_arg))
773 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
777 void SSL_up_ref(SSL *s)
780 CRYPTO_atomic_add(&s->references, 1, &i, s->lock);
783 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
784 unsigned int sid_ctx_len)
786 if (sid_ctx_len > sizeof ctx->sid_ctx) {
787 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
788 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
791 ctx->sid_ctx_length = sid_ctx_len;
792 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
797 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
798 unsigned int sid_ctx_len)
800 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
801 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
802 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
805 ssl->sid_ctx_length = sid_ctx_len;
806 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
811 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
813 CRYPTO_THREAD_write_lock(ctx->lock);
814 ctx->generate_session_id = cb;
815 CRYPTO_THREAD_unlock(ctx->lock);
819 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
821 CRYPTO_THREAD_write_lock(ssl->lock);
822 ssl->generate_session_id = cb;
823 CRYPTO_THREAD_unlock(ssl->lock);
827 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
831 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
832 * we can "construct" a session to give us the desired check - ie. to
833 * find if there's a session in the hash table that would conflict with
834 * any new session built out of this id/id_len and the ssl_version in use
839 if (id_len > sizeof r.session_id)
842 r.ssl_version = ssl->version;
843 r.session_id_length = id_len;
844 memcpy(r.session_id, id, id_len);
846 CRYPTO_THREAD_read_lock(ssl->ctx->lock);
847 p = lh_SSL_SESSION_retrieve(ssl->ctx->sessions, &r);
848 CRYPTO_THREAD_unlock(ssl->ctx->lock);
852 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
854 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
857 int SSL_set_purpose(SSL *s, int purpose)
859 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
862 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
864 return X509_VERIFY_PARAM_set_trust(s->param, trust);
867 int SSL_set_trust(SSL *s, int trust)
869 return X509_VERIFY_PARAM_set_trust(s->param, trust);
872 int SSL_set1_host(SSL *s, const char *hostname)
874 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
877 int SSL_add1_host(SSL *s, const char *hostname)
879 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
882 void SSL_set_hostflags(SSL *s, unsigned int flags)
884 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
887 const char *SSL_get0_peername(SSL *s)
889 return X509_VERIFY_PARAM_get0_peername(s->param);
892 int SSL_CTX_dane_enable(SSL_CTX *ctx)
894 return dane_ctx_enable(&ctx->dane);
897 int SSL_dane_enable(SSL *s, const char *basedomain)
899 SSL_DANE *dane = &s->dane;
901 if (s->ctx->dane.mdmax == 0) {
902 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
905 if (dane->trecs != NULL) {
906 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
911 * Default SNI name. This rejects empty names, while set1_host below
912 * accepts them and disables host name checks. To avoid side-effects with
913 * invalid input, set the SNI name first.
915 if (s->tlsext_hostname == NULL) {
916 if (!SSL_set_tlsext_host_name(s, basedomain)) {
917 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
922 /* Primary RFC6125 reference identifier */
923 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
924 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
930 dane->dctx = &s->ctx->dane;
931 dane->trecs = sk_danetls_record_new_null();
933 if (dane->trecs == NULL) {
934 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
940 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
942 SSL_DANE *dane = &s->dane;
944 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
948 *mcert = dane->mcert;
950 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
955 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
956 uint8_t *mtype, unsigned const char **data, size_t *dlen)
958 SSL_DANE *dane = &s->dane;
960 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
964 *usage = dane->mtlsa->usage;
966 *selector = dane->mtlsa->selector;
968 *mtype = dane->mtlsa->mtype;
970 *data = dane->mtlsa->data;
972 *dlen = dane->mtlsa->dlen;
977 SSL_DANE *SSL_get0_dane(SSL *s)
982 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
983 uint8_t mtype, unsigned char *data, size_t dlen)
985 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
988 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype, uint8_t ord)
990 return dane_mtype_set(&ctx->dane, md, mtype, ord);
993 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
995 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
998 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1000 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1003 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1008 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1013 void SSL_certs_clear(SSL *s)
1015 ssl_cert_clear_certs(s->cert);
1018 void SSL_free(SSL *s)
1025 CRYPTO_atomic_add(&s->references, -1, &i, s->lock);
1026 REF_PRINT_COUNT("SSL", s);
1029 REF_ASSERT_ISNT(i < 0);
1031 X509_VERIFY_PARAM_free(s->param);
1032 dane_final(&s->dane);
1033 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1035 if (s->bbio != NULL) {
1036 /* If the buffering BIO is in place, pop it off */
1037 if (s->bbio == s->wbio) {
1038 s->wbio = BIO_pop(s->wbio);
1043 BIO_free_all(s->rbio);
1044 if (s->wbio != s->rbio)
1045 BIO_free_all(s->wbio);
1047 BUF_MEM_free(s->init_buf);
1049 /* add extra stuff */
1050 sk_SSL_CIPHER_free(s->cipher_list);
1051 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1053 /* Make the next call work :-) */
1054 if (s->session != NULL) {
1055 ssl_clear_bad_session(s);
1056 SSL_SESSION_free(s->session);
1061 ssl_cert_free(s->cert);
1062 /* Free up if allocated */
1064 OPENSSL_free(s->tlsext_hostname);
1065 SSL_CTX_free(s->initial_ctx);
1066 #ifndef OPENSSL_NO_EC
1067 OPENSSL_free(s->tlsext_ecpointformatlist);
1068 OPENSSL_free(s->tlsext_ellipticcurvelist);
1069 #endif /* OPENSSL_NO_EC */
1070 sk_X509_EXTENSION_pop_free(s->tlsext_ocsp_exts, X509_EXTENSION_free);
1071 #ifndef OPENSSL_NO_OCSP
1072 sk_OCSP_RESPID_pop_free(s->tlsext_ocsp_ids, OCSP_RESPID_free);
1074 #ifndef OPENSSL_NO_CT
1075 SCT_LIST_free(s->scts);
1076 OPENSSL_free(s->tlsext_scts);
1078 OPENSSL_free(s->tlsext_ocsp_resp);
1079 OPENSSL_free(s->alpn_client_proto_list);
1081 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1083 sk_X509_pop_free(s->verified_chain, X509_free);
1085 if (s->method != NULL)
1086 s->method->ssl_free(s);
1088 RECORD_LAYER_release(&s->rlayer);
1090 SSL_CTX_free(s->ctx);
1092 ASYNC_WAIT_CTX_free(s->waitctx);
1094 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1095 OPENSSL_free(s->next_proto_negotiated);
1098 #ifndef OPENSSL_NO_SRTP
1099 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1102 CRYPTO_THREAD_lock_free(s->lock);
1107 void SSL_set_rbio(SSL *s, BIO *rbio)
1109 if (s->rbio != rbio)
1110 BIO_free_all(s->rbio);
1114 void SSL_set_wbio(SSL *s, BIO *wbio)
1117 * If the output buffering BIO is still in place, remove it
1119 if (s->bbio != NULL) {
1120 if (s->wbio == s->bbio) {
1121 s->wbio = BIO_next(s->wbio);
1122 BIO_set_next(s->bbio, NULL);
1125 if (s->wbio != wbio && s->rbio != s->wbio)
1126 BIO_free_all(s->wbio);
1130 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1132 SSL_set_wbio(s, wbio);
1133 SSL_set_rbio(s, rbio);
1136 BIO *SSL_get_rbio(const SSL *s)
1141 BIO *SSL_get_wbio(const SSL *s)
1146 int SSL_get_fd(const SSL *s)
1148 return (SSL_get_rfd(s));
1151 int SSL_get_rfd(const SSL *s)
1156 b = SSL_get_rbio(s);
1157 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1159 BIO_get_fd(r, &ret);
1163 int SSL_get_wfd(const SSL *s)
1168 b = SSL_get_wbio(s);
1169 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1171 BIO_get_fd(r, &ret);
1175 #ifndef OPENSSL_NO_SOCK
1176 int SSL_set_fd(SSL *s, int fd)
1181 bio = BIO_new(BIO_s_socket());
1184 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1187 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1188 SSL_set_bio(s, bio, bio);
1194 int SSL_set_wfd(SSL *s, int fd)
1199 if ((s->rbio == NULL) || (BIO_method_type(s->rbio) != BIO_TYPE_SOCKET)
1200 || ((int)BIO_get_fd(s->rbio, NULL) != fd)) {
1201 bio = BIO_new(BIO_s_socket());
1204 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1207 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1208 SSL_set_bio(s, SSL_get_rbio(s), bio);
1210 SSL_set_bio(s, SSL_get_rbio(s), SSL_get_rbio(s));
1216 int SSL_set_rfd(SSL *s, int fd)
1221 if ((s->wbio == NULL) || (BIO_method_type(s->wbio) != BIO_TYPE_SOCKET)
1222 || ((int)BIO_get_fd(s->wbio, NULL) != fd)) {
1223 bio = BIO_new(BIO_s_socket());
1226 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1229 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1230 SSL_set_bio(s, bio, SSL_get_wbio(s));
1232 SSL_set_bio(s, SSL_get_wbio(s), SSL_get_wbio(s));
1239 /* return length of latest Finished message we sent, copy to 'buf' */
1240 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1244 if (s->s3 != NULL) {
1245 ret = s->s3->tmp.finish_md_len;
1248 memcpy(buf, s->s3->tmp.finish_md, count);
1253 /* return length of latest Finished message we expected, copy to 'buf' */
1254 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1258 if (s->s3 != NULL) {
1259 ret = s->s3->tmp.peer_finish_md_len;
1262 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1267 int SSL_get_verify_mode(const SSL *s)
1269 return (s->verify_mode);
1272 int SSL_get_verify_depth(const SSL *s)
1274 return X509_VERIFY_PARAM_get_depth(s->param);
1277 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1278 return (s->verify_callback);
1281 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1283 return (ctx->verify_mode);
1286 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1288 return X509_VERIFY_PARAM_get_depth(ctx->param);
1291 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1292 return (ctx->default_verify_callback);
1295 void SSL_set_verify(SSL *s, int mode,
1296 int (*callback) (int ok, X509_STORE_CTX *ctx))
1298 s->verify_mode = mode;
1299 if (callback != NULL)
1300 s->verify_callback = callback;
1303 void SSL_set_verify_depth(SSL *s, int depth)
1305 X509_VERIFY_PARAM_set_depth(s->param, depth);
1308 void SSL_set_read_ahead(SSL *s, int yes)
1310 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1313 int SSL_get_read_ahead(const SSL *s)
1315 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1318 int SSL_pending(const SSL *s)
1321 * SSL_pending cannot work properly if read-ahead is enabled
1322 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1323 * impossible to fix since SSL_pending cannot report errors that may be
1324 * observed while scanning the new data. (Note that SSL_pending() is
1325 * often used as a boolean value, so we'd better not return -1.)
1327 return (s->method->ssl_pending(s));
1330 int SSL_has_pending(const SSL *s)
1333 * Similar to SSL_pending() but returns a 1 to indicate that we have
1334 * unprocessed data available or 0 otherwise (as opposed to the number of
1335 * bytes available). Unlike SSL_pending() this will take into account
1336 * read_ahead data. A 1 return simply indicates that we have unprocessed
1337 * data. That data may not result in any application data, or we may fail
1338 * to parse the records for some reason.
1343 return RECORD_LAYER_read_pending(&s->rlayer);
1346 X509 *SSL_get_peer_certificate(const SSL *s)
1350 if ((s == NULL) || (s->session == NULL))
1353 r = s->session->peer;
1363 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1367 if ((s == NULL) || (s->session == NULL))
1370 r = s->session->peer_chain;
1373 * If we are a client, cert_chain includes the peer's own certificate; if
1374 * we are a server, it does not.
1381 * Now in theory, since the calling process own 't' it should be safe to
1382 * modify. We need to be able to read f without being hassled
1384 int SSL_copy_session_id(SSL *t, const SSL *f)
1387 /* Do we need to to SSL locking? */
1388 if (!SSL_set_session(t, SSL_get_session(f))) {
1393 * what if we are setup for one protocol version but want to talk another
1395 if (t->method != f->method) {
1396 t->method->ssl_free(t);
1397 t->method = f->method;
1398 if (t->method->ssl_new(t) == 0)
1402 CRYPTO_atomic_add(&f->cert->references, 1, &i, f->cert->lock);
1403 ssl_cert_free(t->cert);
1405 if (!SSL_set_session_id_context(t, f->sid_ctx, f->sid_ctx_length)) {
1412 /* Fix this so it checks all the valid key/cert options */
1413 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1415 if ((ctx == NULL) ||
1416 (ctx->cert->key->x509 == NULL)) {
1417 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY,
1418 SSL_R_NO_CERTIFICATE_ASSIGNED);
1421 if (ctx->cert->key->privatekey == NULL) {
1422 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY,
1423 SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1426 return (X509_check_private_key
1427 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1430 /* Fix this function so that it takes an optional type parameter */
1431 int SSL_check_private_key(const SSL *ssl)
1434 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1437 if (ssl->cert->key->x509 == NULL) {
1438 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1441 if (ssl->cert->key->privatekey == NULL) {
1442 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1445 return (X509_check_private_key(ssl->cert->key->x509,
1446 ssl->cert->key->privatekey));
1449 int SSL_waiting_for_async(SSL *s)
1457 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1459 ASYNC_WAIT_CTX *ctx = s->waitctx;
1463 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1466 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1467 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1469 ASYNC_WAIT_CTX *ctx = s->waitctx;
1473 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1477 int SSL_accept(SSL *s)
1479 if (s->handshake_func == NULL) {
1480 /* Not properly initialized yet */
1481 SSL_set_accept_state(s);
1484 return SSL_do_handshake(s);
1487 int SSL_connect(SSL *s)
1489 if (s->handshake_func == NULL) {
1490 /* Not properly initialized yet */
1491 SSL_set_connect_state(s);
1494 return SSL_do_handshake(s);
1497 long SSL_get_default_timeout(const SSL *s)
1499 return (s->method->get_timeout());
1502 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1503 int (*func)(void *)) {
1505 if (s->waitctx == NULL) {
1506 s->waitctx = ASYNC_WAIT_CTX_new();
1507 if (s->waitctx == NULL)
1510 switch(ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1511 sizeof(struct ssl_async_args))) {
1513 s->rwstate = SSL_NOTHING;
1514 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1517 s->rwstate = SSL_ASYNC_PAUSED;
1520 s->rwstate = SSL_ASYNC_NO_JOBS;
1526 s->rwstate = SSL_NOTHING;
1527 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1528 /* Shouldn't happen */
1533 static int ssl_io_intern(void *vargs)
1535 struct ssl_async_args *args;
1540 args = (struct ssl_async_args *)vargs;
1544 switch (args->type) {
1546 return args->f.func_read(s, buf, num);
1548 return args->f.func_write(s, buf, num);
1550 return args->f.func_other(s);
1555 int SSL_read(SSL *s, void *buf, int num)
1557 if (s->handshake_func == NULL) {
1558 SSLerr(SSL_F_SSL_READ, SSL_R_UNINITIALIZED);
1562 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1563 s->rwstate = SSL_NOTHING;
1567 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1568 struct ssl_async_args args;
1573 args.type = READFUNC;
1574 args.f.func_read = s->method->ssl_read;
1576 return ssl_start_async_job(s, &args, ssl_io_intern);
1578 return s->method->ssl_read(s, buf, num);
1582 int SSL_peek(SSL *s, void *buf, int num)
1584 if (s->handshake_func == NULL) {
1585 SSLerr(SSL_F_SSL_PEEK, SSL_R_UNINITIALIZED);
1589 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1592 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1593 struct ssl_async_args args;
1598 args.type = READFUNC;
1599 args.f.func_read = s->method->ssl_peek;
1601 return ssl_start_async_job(s, &args, ssl_io_intern);
1603 return s->method->ssl_peek(s, buf, num);
1607 int SSL_write(SSL *s, const void *buf, int num)
1609 if (s->handshake_func == NULL) {
1610 SSLerr(SSL_F_SSL_WRITE, SSL_R_UNINITIALIZED);
1614 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1615 s->rwstate = SSL_NOTHING;
1616 SSLerr(SSL_F_SSL_WRITE, SSL_R_PROTOCOL_IS_SHUTDOWN);
1620 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1621 struct ssl_async_args args;
1624 args.buf = (void *)buf;
1626 args.type = WRITEFUNC;
1627 args.f.func_write = s->method->ssl_write;
1629 return ssl_start_async_job(s, &args, ssl_io_intern);
1631 return s->method->ssl_write(s, buf, num);
1635 int SSL_shutdown(SSL *s)
1638 * Note that this function behaves differently from what one might
1639 * expect. Return values are 0 for no success (yet), 1 for success; but
1640 * calling it once is usually not enough, even if blocking I/O is used
1641 * (see ssl3_shutdown).
1644 if (s->handshake_func == NULL) {
1645 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1649 if (!SSL_in_init(s)) {
1650 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1651 struct ssl_async_args args;
1654 args.type = OTHERFUNC;
1655 args.f.func_other = s->method->ssl_shutdown;
1657 return ssl_start_async_job(s, &args, ssl_io_intern);
1659 return s->method->ssl_shutdown(s);
1662 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1667 int SSL_renegotiate(SSL *s)
1669 if (s->renegotiate == 0)
1674 return (s->method->ssl_renegotiate(s));
1677 int SSL_renegotiate_abbreviated(SSL *s)
1679 if (s->renegotiate == 0)
1684 return (s->method->ssl_renegotiate(s));
1687 int SSL_renegotiate_pending(SSL *s)
1690 * becomes true when negotiation is requested; false again once a
1691 * handshake has finished
1693 return (s->renegotiate != 0);
1696 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1701 case SSL_CTRL_GET_READ_AHEAD:
1702 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1703 case SSL_CTRL_SET_READ_AHEAD:
1704 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1705 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1708 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1709 s->msg_callback_arg = parg;
1713 return (s->mode |= larg);
1714 case SSL_CTRL_CLEAR_MODE:
1715 return (s->mode &= ~larg);
1716 case SSL_CTRL_GET_MAX_CERT_LIST:
1717 return (s->max_cert_list);
1718 case SSL_CTRL_SET_MAX_CERT_LIST:
1719 l = s->max_cert_list;
1720 s->max_cert_list = larg;
1722 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1723 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1725 s->max_send_fragment = larg;
1726 if (s->max_send_fragment < s->split_send_fragment)
1727 s->split_send_fragment = s->max_send_fragment;
1729 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1730 if ((unsigned int)larg > s->max_send_fragment || larg == 0)
1732 s->split_send_fragment = larg;
1734 case SSL_CTRL_SET_MAX_PIPELINES:
1735 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1737 s->max_pipelines = larg;
1739 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1741 case SSL_CTRL_GET_RI_SUPPORT:
1743 return s->s3->send_connection_binding;
1746 case SSL_CTRL_CERT_FLAGS:
1747 return (s->cert->cert_flags |= larg);
1748 case SSL_CTRL_CLEAR_CERT_FLAGS:
1749 return (s->cert->cert_flags &= ~larg);
1751 case SSL_CTRL_GET_RAW_CIPHERLIST:
1753 if (s->s3->tmp.ciphers_raw == NULL)
1755 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
1756 return (int)s->s3->tmp.ciphers_rawlen;
1758 return TLS_CIPHER_LEN;
1760 case SSL_CTRL_GET_EXTMS_SUPPORT:
1761 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
1763 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
1767 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1768 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1769 &s->min_proto_version);
1770 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1771 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1772 &s->max_proto_version);
1774 return (s->method->ssl_ctrl(s, cmd, larg, parg));
1778 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1781 case SSL_CTRL_SET_MSG_CALLBACK:
1782 s->msg_callback = (void (*)
1783 (int write_p, int version, int content_type,
1784 const void *buf, size_t len, SSL *ssl,
1789 return (s->method->ssl_callback_ctrl(s, cmd, fp));
1793 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
1795 return ctx->sessions;
1798 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1801 /* For some cases with ctx == NULL perform syntax checks */
1804 #ifndef OPENSSL_NO_EC
1805 case SSL_CTRL_SET_CURVES_LIST:
1806 return tls1_set_curves_list(NULL, NULL, parg);
1808 case SSL_CTRL_SET_SIGALGS_LIST:
1809 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
1810 return tls1_set_sigalgs_list(NULL, parg, 0);
1817 case SSL_CTRL_GET_READ_AHEAD:
1818 return (ctx->read_ahead);
1819 case SSL_CTRL_SET_READ_AHEAD:
1820 l = ctx->read_ahead;
1821 ctx->read_ahead = larg;
1824 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1825 ctx->msg_callback_arg = parg;
1828 case SSL_CTRL_GET_MAX_CERT_LIST:
1829 return (ctx->max_cert_list);
1830 case SSL_CTRL_SET_MAX_CERT_LIST:
1831 l = ctx->max_cert_list;
1832 ctx->max_cert_list = larg;
1835 case SSL_CTRL_SET_SESS_CACHE_SIZE:
1836 l = ctx->session_cache_size;
1837 ctx->session_cache_size = larg;
1839 case SSL_CTRL_GET_SESS_CACHE_SIZE:
1840 return (ctx->session_cache_size);
1841 case SSL_CTRL_SET_SESS_CACHE_MODE:
1842 l = ctx->session_cache_mode;
1843 ctx->session_cache_mode = larg;
1845 case SSL_CTRL_GET_SESS_CACHE_MODE:
1846 return (ctx->session_cache_mode);
1848 case SSL_CTRL_SESS_NUMBER:
1849 return (lh_SSL_SESSION_num_items(ctx->sessions));
1850 case SSL_CTRL_SESS_CONNECT:
1851 return (ctx->stats.sess_connect);
1852 case SSL_CTRL_SESS_CONNECT_GOOD:
1853 return (ctx->stats.sess_connect_good);
1854 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
1855 return (ctx->stats.sess_connect_renegotiate);
1856 case SSL_CTRL_SESS_ACCEPT:
1857 return (ctx->stats.sess_accept);
1858 case SSL_CTRL_SESS_ACCEPT_GOOD:
1859 return (ctx->stats.sess_accept_good);
1860 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
1861 return (ctx->stats.sess_accept_renegotiate);
1862 case SSL_CTRL_SESS_HIT:
1863 return (ctx->stats.sess_hit);
1864 case SSL_CTRL_SESS_CB_HIT:
1865 return (ctx->stats.sess_cb_hit);
1866 case SSL_CTRL_SESS_MISSES:
1867 return (ctx->stats.sess_miss);
1868 case SSL_CTRL_SESS_TIMEOUTS:
1869 return (ctx->stats.sess_timeout);
1870 case SSL_CTRL_SESS_CACHE_FULL:
1871 return (ctx->stats.sess_cache_full);
1873 return (ctx->mode |= larg);
1874 case SSL_CTRL_CLEAR_MODE:
1875 return (ctx->mode &= ~larg);
1876 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1877 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1879 ctx->max_send_fragment = larg;
1880 if (ctx->max_send_fragment < ctx->split_send_fragment)
1881 ctx->split_send_fragment = ctx->max_send_fragment;
1883 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1884 if ((unsigned int)larg > ctx->max_send_fragment || larg == 0)
1886 ctx->split_send_fragment = larg;
1888 case SSL_CTRL_SET_MAX_PIPELINES:
1889 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1891 ctx->max_pipelines = larg;
1893 case SSL_CTRL_CERT_FLAGS:
1894 return (ctx->cert->cert_flags |= larg);
1895 case SSL_CTRL_CLEAR_CERT_FLAGS:
1896 return (ctx->cert->cert_flags &= ~larg);
1897 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1898 return ssl_set_version_bound(ctx->method->version, (int)larg,
1899 &ctx->min_proto_version);
1900 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1901 return ssl_set_version_bound(ctx->method->version, (int)larg,
1902 &ctx->max_proto_version);
1904 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
1908 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
1911 case SSL_CTRL_SET_MSG_CALLBACK:
1912 ctx->msg_callback = (void (*)
1913 (int write_p, int version, int content_type,
1914 const void *buf, size_t len, SSL *ssl,
1919 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
1923 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
1932 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
1933 const SSL_CIPHER *const *bp)
1935 if ((*ap)->id > (*bp)->id)
1937 if ((*ap)->id < (*bp)->id)
1942 /** return a STACK of the ciphers available for the SSL and in order of
1944 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
1947 if (s->cipher_list != NULL) {
1948 return (s->cipher_list);
1949 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
1950 return (s->ctx->cipher_list);
1956 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
1958 if ((s == NULL) || (s->session == NULL) || !s->server)
1960 return s->session->ciphers;
1963 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
1965 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
1967 ciphers = SSL_get_ciphers(s);
1970 ssl_set_client_disabled(s);
1971 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
1972 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
1973 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
1975 sk = sk_SSL_CIPHER_new_null();
1978 if (!sk_SSL_CIPHER_push(sk, c)) {
1979 sk_SSL_CIPHER_free(sk);
1987 /** return a STACK of the ciphers available for the SSL and in order of
1989 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
1992 if (s->cipher_list_by_id != NULL) {
1993 return (s->cipher_list_by_id);
1994 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
1995 return (s->ctx->cipher_list_by_id);
2001 /** The old interface to get the same thing as SSL_get_ciphers() */
2002 const char *SSL_get_cipher_list(const SSL *s, int n)
2004 const SSL_CIPHER *c;
2005 STACK_OF(SSL_CIPHER) *sk;
2009 sk = SSL_get_ciphers(s);
2010 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2012 c = sk_SSL_CIPHER_value(sk, n);
2018 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2020 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2023 return ctx->cipher_list;
2027 /** specify the ciphers to be used by default by the SSL_CTX */
2028 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2030 STACK_OF(SSL_CIPHER) *sk;
2032 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2033 &ctx->cipher_list_by_id, str, ctx->cert);
2035 * ssl_create_cipher_list may return an empty stack if it was unable to
2036 * find a cipher matching the given rule string (for example if the rule
2037 * string specifies a cipher which has been disabled). This is not an
2038 * error as far as ssl_create_cipher_list is concerned, and hence
2039 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2043 else if (sk_SSL_CIPHER_num(sk) == 0) {
2044 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2050 /** specify the ciphers to be used by the SSL */
2051 int SSL_set_cipher_list(SSL *s, const char *str)
2053 STACK_OF(SSL_CIPHER) *sk;
2055 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2056 &s->cipher_list_by_id, str, s->cert);
2057 /* see comment in SSL_CTX_set_cipher_list */
2060 else if (sk_SSL_CIPHER_num(sk) == 0) {
2061 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2067 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2070 STACK_OF(SSL_CIPHER) *sk;
2071 const SSL_CIPHER *c;
2074 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2078 sk = s->session->ciphers;
2080 if (sk_SSL_CIPHER_num(sk) == 0)
2083 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2086 c = sk_SSL_CIPHER_value(sk, i);
2087 n = strlen(c->name);
2094 memcpy(p, c->name, n + 1);
2103 /** return a servername extension value if provided in Client Hello, or NULL.
2104 * So far, only host_name types are defined (RFC 3546).
2107 const char *SSL_get_servername(const SSL *s, const int type)
2109 if (type != TLSEXT_NAMETYPE_host_name)
2112 return s->session && !s->tlsext_hostname ?
2113 s->session->tlsext_hostname : s->tlsext_hostname;
2116 int SSL_get_servername_type(const SSL *s)
2119 && (!s->tlsext_hostname ? s->session->
2120 tlsext_hostname : s->tlsext_hostname))
2121 return TLSEXT_NAMETYPE_host_name;
2126 * SSL_select_next_proto implements the standard protocol selection. It is
2127 * expected that this function is called from the callback set by
2128 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2129 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2130 * not included in the length. A byte string of length 0 is invalid. No byte
2131 * string may be truncated. The current, but experimental algorithm for
2132 * selecting the protocol is: 1) If the server doesn't support NPN then this
2133 * is indicated to the callback. In this case, the client application has to
2134 * abort the connection or have a default application level protocol. 2) If
2135 * the server supports NPN, but advertises an empty list then the client
2136 * selects the first protcol in its list, but indicates via the API that this
2137 * fallback case was enacted. 3) Otherwise, the client finds the first
2138 * protocol in the server's list that it supports and selects this protocol.
2139 * This is because it's assumed that the server has better information about
2140 * which protocol a client should use. 4) If the client doesn't support any
2141 * of the server's advertised protocols, then this is treated the same as
2142 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2143 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2145 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2146 const unsigned char *server,
2147 unsigned int server_len,
2148 const unsigned char *client,
2149 unsigned int client_len)
2152 const unsigned char *result;
2153 int status = OPENSSL_NPN_UNSUPPORTED;
2156 * For each protocol in server preference order, see if we support it.
2158 for (i = 0; i < server_len;) {
2159 for (j = 0; j < client_len;) {
2160 if (server[i] == client[j] &&
2161 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2162 /* We found a match */
2163 result = &server[i];
2164 status = OPENSSL_NPN_NEGOTIATED;
2174 /* There's no overlap between our protocols and the server's list. */
2176 status = OPENSSL_NPN_NO_OVERLAP;
2179 *out = (unsigned char *)result + 1;
2180 *outlen = result[0];
2184 #ifndef OPENSSL_NO_NEXTPROTONEG
2186 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2187 * client's requested protocol for this connection and returns 0. If the
2188 * client didn't request any protocol, then *data is set to NULL. Note that
2189 * the client can request any protocol it chooses. The value returned from
2190 * this function need not be a member of the list of supported protocols
2191 * provided by the callback.
2193 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2196 *data = s->next_proto_negotiated;
2200 *len = s->next_proto_negotiated_len;
2205 * SSL_CTX_set_next_protos_advertised_cb sets a callback that is called when
2206 * a TLS server needs a list of supported protocols for Next Protocol
2207 * Negotiation. The returned list must be in wire format. The list is
2208 * returned by setting |out| to point to it and |outlen| to its length. This
2209 * memory will not be modified, but one should assume that the SSL* keeps a
2210 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2211 * wishes to advertise. Otherwise, no such extension will be included in the
2214 void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX *ctx,
2215 int (*cb) (SSL *ssl,
2218 unsigned int *outlen,
2219 void *arg), void *arg)
2221 ctx->next_protos_advertised_cb = cb;
2222 ctx->next_protos_advertised_cb_arg = arg;
2226 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2227 * client needs to select a protocol from the server's provided list. |out|
2228 * must be set to point to the selected protocol (which may be within |in|).
2229 * The length of the protocol name must be written into |outlen|. The
2230 * server's advertised protocols are provided in |in| and |inlen|. The
2231 * callback can assume that |in| is syntactically valid. The client must
2232 * select a protocol. It is fatal to the connection if this callback returns
2233 * a value other than SSL_TLSEXT_ERR_OK.
2235 void SSL_CTX_set_next_proto_select_cb(SSL_CTX *ctx,
2236 int (*cb) (SSL *s, unsigned char **out,
2237 unsigned char *outlen,
2238 const unsigned char *in,
2240 void *arg), void *arg)
2242 ctx->next_proto_select_cb = cb;
2243 ctx->next_proto_select_cb_arg = arg;
2248 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2249 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2250 * length-prefixed strings). Returns 0 on success.
2252 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2253 unsigned int protos_len)
2255 OPENSSL_free(ctx->alpn_client_proto_list);
2256 ctx->alpn_client_proto_list = OPENSSL_memdup(protos, protos_len);
2257 if (ctx->alpn_client_proto_list == NULL) {
2258 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2261 ctx->alpn_client_proto_list_len = protos_len;
2267 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2268 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2269 * length-prefixed strings). Returns 0 on success.
2271 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2272 unsigned int protos_len)
2274 OPENSSL_free(ssl->alpn_client_proto_list);
2275 ssl->alpn_client_proto_list = OPENSSL_memdup(protos, protos_len);
2276 if (ssl->alpn_client_proto_list == NULL) {
2277 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2280 ssl->alpn_client_proto_list_len = protos_len;
2286 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2287 * called during ClientHello processing in order to select an ALPN protocol
2288 * from the client's list of offered protocols.
2290 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2291 int (*cb) (SSL *ssl,
2292 const unsigned char **out,
2293 unsigned char *outlen,
2294 const unsigned char *in,
2296 void *arg), void *arg)
2298 ctx->alpn_select_cb = cb;
2299 ctx->alpn_select_cb_arg = arg;
2303 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2304 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2305 * (not including the leading length-prefix byte). If the server didn't
2306 * respond with a negotiated protocol then |*len| will be zero.
2308 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2313 *data = ssl->s3->alpn_selected;
2317 *len = ssl->s3->alpn_selected_len;
2321 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2322 const char *label, size_t llen,
2323 const unsigned char *p, size_t plen,
2326 if (s->version < TLS1_VERSION)
2329 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2334 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2339 ((unsigned int)a->session_id[0]) |
2340 ((unsigned int)a->session_id[1] << 8L) |
2341 ((unsigned long)a->session_id[2] << 16L) |
2342 ((unsigned long)a->session_id[3] << 24L);
2347 * NB: If this function (or indeed the hash function which uses a sort of
2348 * coarser function than this one) is changed, ensure
2349 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2350 * being able to construct an SSL_SESSION that will collide with any existing
2351 * session with a matching session ID.
2353 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2355 if (a->ssl_version != b->ssl_version)
2357 if (a->session_id_length != b->session_id_length)
2359 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2363 * These wrapper functions should remain rather than redeclaring
2364 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2365 * variable. The reason is that the functions aren't static, they're exposed
2369 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2371 SSL_CTX *ret = NULL;
2374 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2378 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2381 if (FIPS_mode() && (meth->version < TLS1_VERSION)) {
2382 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE);
2386 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2387 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2390 ret = OPENSSL_zalloc(sizeof(*ret));
2395 ret->min_proto_version = 0;
2396 ret->max_proto_version = 0;
2397 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2398 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2399 /* We take the system default. */
2400 ret->session_timeout = meth->get_timeout();
2401 ret->references = 1;
2402 ret->lock = CRYPTO_THREAD_lock_new();
2403 if (ret->lock == NULL) {
2404 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2408 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2409 ret->verify_mode = SSL_VERIFY_NONE;
2410 if ((ret->cert = ssl_cert_new()) == NULL)
2413 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2414 if (ret->sessions == NULL)
2416 ret->cert_store = X509_STORE_new();
2417 if (ret->cert_store == NULL)
2419 #ifndef OPENSSL_NO_CT
2420 ret->ctlog_store = CTLOG_STORE_new();
2421 if (ret->ctlog_store == NULL)
2424 if (!ssl_create_cipher_list(ret->method,
2425 &ret->cipher_list, &ret->cipher_list_by_id,
2426 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2427 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2428 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2432 ret->param = X509_VERIFY_PARAM_new();
2433 if (ret->param == NULL)
2436 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2437 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2440 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2441 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2445 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2448 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2451 /* No compression for DTLS */
2452 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2453 ret->comp_methods = SSL_COMP_get_compression_methods();
2455 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2456 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2458 /* Setup RFC4507 ticket keys */
2459 if ((RAND_bytes(ret->tlsext_tick_key_name, 16) <= 0)
2460 || (RAND_bytes(ret->tlsext_tick_hmac_key, 16) <= 0)
2461 || (RAND_bytes(ret->tlsext_tick_aes_key, 16) <= 0))
2462 ret->options |= SSL_OP_NO_TICKET;
2464 #ifndef OPENSSL_NO_SRP
2465 if (!SSL_CTX_SRP_CTX_init(ret))
2468 #ifndef OPENSSL_NO_ENGINE
2469 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2470 # define eng_strx(x) #x
2471 # define eng_str(x) eng_strx(x)
2472 /* Use specific client engine automatically... ignore errors */
2475 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2478 ENGINE_load_builtin_engines();
2479 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2481 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2487 * Default is to connect to non-RI servers. When RI is more widely
2488 * deployed might change this.
2490 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2492 * Disable compression by default to prevent CRIME. Applications can
2493 * re-enable compression by configuring
2494 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2495 * or by using the SSL_CONF library.
2497 ret->options |= SSL_OP_NO_COMPRESSION;
2501 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2507 void SSL_CTX_up_ref(SSL_CTX *ctx)
2510 CRYPTO_atomic_add(&ctx->references, 1, &i, ctx->lock);
2513 void SSL_CTX_free(SSL_CTX *a)
2520 CRYPTO_atomic_add(&a->references, -1, &i, a->lock);
2521 REF_PRINT_COUNT("SSL_CTX", a);
2524 REF_ASSERT_ISNT(i < 0);
2526 X509_VERIFY_PARAM_free(a->param);
2527 dane_ctx_final(&a->dane);
2530 * Free internal session cache. However: the remove_cb() may reference
2531 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2532 * after the sessions were flushed.
2533 * As the ex_data handling routines might also touch the session cache,
2534 * the most secure solution seems to be: empty (flush) the cache, then
2535 * free ex_data, then finally free the cache.
2536 * (See ticket [openssl.org #212].)
2538 if (a->sessions != NULL)
2539 SSL_CTX_flush_sessions(a, 0);
2541 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2542 lh_SSL_SESSION_free(a->sessions);
2543 X509_STORE_free(a->cert_store);
2544 #ifndef OPENSSL_NO_CT
2545 CTLOG_STORE_free(a->ctlog_store);
2547 sk_SSL_CIPHER_free(a->cipher_list);
2548 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2549 ssl_cert_free(a->cert);
2550 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2551 sk_X509_pop_free(a->extra_certs, X509_free);
2552 a->comp_methods = NULL;
2553 #ifndef OPENSSL_NO_SRTP
2554 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2556 #ifndef OPENSSL_NO_SRP
2557 SSL_CTX_SRP_CTX_free(a);
2559 #ifndef OPENSSL_NO_ENGINE
2560 ENGINE_finish(a->client_cert_engine);
2563 #ifndef OPENSSL_NO_EC
2564 OPENSSL_free(a->tlsext_ecpointformatlist);
2565 OPENSSL_free(a->tlsext_ellipticcurvelist);
2567 OPENSSL_free(a->alpn_client_proto_list);
2569 CRYPTO_THREAD_lock_free(a->lock);
2574 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2576 ctx->default_passwd_callback = cb;
2579 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2581 ctx->default_passwd_callback_userdata = u;
2584 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2586 return ctx->default_passwd_callback;
2589 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2591 return ctx->default_passwd_callback_userdata;
2594 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2596 s->default_passwd_callback = cb;
2599 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2601 s->default_passwd_callback_userdata = u;
2604 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2606 return s->default_passwd_callback;
2609 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2611 return s->default_passwd_callback_userdata;
2614 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2615 int (*cb) (X509_STORE_CTX *, void *),
2618 ctx->app_verify_callback = cb;
2619 ctx->app_verify_arg = arg;
2622 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2623 int (*cb) (int, X509_STORE_CTX *))
2625 ctx->verify_mode = mode;
2626 ctx->default_verify_callback = cb;
2629 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2631 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2634 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg),
2637 ssl_cert_set_cert_cb(c->cert, cb, arg);
2640 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2642 ssl_cert_set_cert_cb(s->cert, cb, arg);
2645 void ssl_set_masks(SSL *s)
2647 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_GOST)
2651 uint32_t *pvalid = s->s3->tmp.valid_flags;
2652 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2653 unsigned long mask_k, mask_a;
2654 #ifndef OPENSSL_NO_EC
2655 int have_ecc_cert, ecdsa_ok;
2661 #ifndef OPENSSL_NO_DH
2662 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2667 rsa_enc = pvalid[SSL_PKEY_RSA_ENC] & CERT_PKEY_VALID;
2668 rsa_sign = pvalid[SSL_PKEY_RSA_SIGN] & CERT_PKEY_SIGN;
2669 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_SIGN;
2670 #ifndef OPENSSL_NO_EC
2671 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2677 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2678 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2681 #ifndef OPENSSL_NO_GOST
2682 cpk = &(c->pkeys[SSL_PKEY_GOST12_512]);
2683 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2684 mask_k |= SSL_kGOST;
2685 mask_a |= SSL_aGOST12;
2687 cpk = &(c->pkeys[SSL_PKEY_GOST12_256]);
2688 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2689 mask_k |= SSL_kGOST;
2690 mask_a |= SSL_aGOST12;
2692 cpk = &(c->pkeys[SSL_PKEY_GOST01]);
2693 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2694 mask_k |= SSL_kGOST;
2695 mask_a |= SSL_aGOST01;
2705 if (rsa_enc || rsa_sign) {
2713 mask_a |= SSL_aNULL;
2716 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2717 * depending on the key usage extension.
2719 #ifndef OPENSSL_NO_EC
2720 if (have_ecc_cert) {
2722 cpk = &c->pkeys[SSL_PKEY_ECC];
2724 ex_kusage = X509_get_key_usage(x);
2725 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2726 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2729 mask_a |= SSL_aECDSA;
2733 #ifndef OPENSSL_NO_EC
2734 mask_k |= SSL_kECDHE;
2737 #ifndef OPENSSL_NO_PSK
2740 if (mask_k & SSL_kRSA)
2741 mask_k |= SSL_kRSAPSK;
2742 if (mask_k & SSL_kDHE)
2743 mask_k |= SSL_kDHEPSK;
2744 if (mask_k & SSL_kECDHE)
2745 mask_k |= SSL_kECDHEPSK;
2748 s->s3->tmp.mask_k = mask_k;
2749 s->s3->tmp.mask_a = mask_a;
2752 #ifndef OPENSSL_NO_EC
2754 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
2756 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
2757 /* key usage, if present, must allow signing */
2758 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
2759 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
2760 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
2764 return 1; /* all checks are ok */
2769 static int ssl_get_server_cert_index(const SSL *s)
2772 idx = ssl_cipher_get_cert_index(s->s3->tmp.new_cipher);
2773 if (idx == SSL_PKEY_RSA_ENC && !s->cert->pkeys[SSL_PKEY_RSA_ENC].x509)
2774 idx = SSL_PKEY_RSA_SIGN;
2775 if (idx == SSL_PKEY_GOST_EC) {
2776 if (s->cert->pkeys[SSL_PKEY_GOST12_512].x509)
2777 idx = SSL_PKEY_GOST12_512;
2778 else if (s->cert->pkeys[SSL_PKEY_GOST12_256].x509)
2779 idx = SSL_PKEY_GOST12_256;
2780 else if (s->cert->pkeys[SSL_PKEY_GOST01].x509)
2781 idx = SSL_PKEY_GOST01;
2786 SSLerr(SSL_F_SSL_GET_SERVER_CERT_INDEX, ERR_R_INTERNAL_ERROR);
2790 CERT_PKEY *ssl_get_server_send_pkey(SSL *s)
2796 if (!s->s3 || !s->s3->tmp.new_cipher)
2800 i = ssl_get_server_cert_index(s);
2802 /* This may or may not be an error. */
2807 return &c->pkeys[i];
2810 EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *cipher,
2813 unsigned long alg_a;
2817 alg_a = cipher->algorithm_auth;
2820 if ((alg_a & SSL_aDSS) &&
2821 (c->pkeys[SSL_PKEY_DSA_SIGN].privatekey != NULL))
2822 idx = SSL_PKEY_DSA_SIGN;
2823 else if (alg_a & SSL_aRSA) {
2824 if (c->pkeys[SSL_PKEY_RSA_SIGN].privatekey != NULL)
2825 idx = SSL_PKEY_RSA_SIGN;
2826 else if (c->pkeys[SSL_PKEY_RSA_ENC].privatekey != NULL)
2827 idx = SSL_PKEY_RSA_ENC;
2828 } else if ((alg_a & SSL_aECDSA) &&
2829 (c->pkeys[SSL_PKEY_ECC].privatekey != NULL))
2832 SSLerr(SSL_F_SSL_GET_SIGN_PKEY, ERR_R_INTERNAL_ERROR);
2836 *pmd = s->s3->tmp.md[idx];
2837 return c->pkeys[idx].privatekey;
2840 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
2841 size_t *serverinfo_length)
2845 *serverinfo_length = 0;
2848 i = ssl_get_server_cert_index(s);
2852 if (c->pkeys[i].serverinfo == NULL)
2855 *serverinfo = c->pkeys[i].serverinfo;
2856 *serverinfo_length = c->pkeys[i].serverinfo_length;
2860 void ssl_update_cache(SSL *s, int mode)
2865 * If the session_id_length is 0, we are not supposed to cache it, and it
2866 * would be rather hard to do anyway :-)
2868 if (s->session->session_id_length == 0)
2871 i = s->session_ctx->session_cache_mode;
2872 if ((i & mode) && (!s->hit)
2873 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
2874 || SSL_CTX_add_session(s->session_ctx, s->session))
2875 && (s->session_ctx->new_session_cb != NULL)) {
2876 SSL_SESSION_up_ref(s->session);
2877 if (!s->session_ctx->new_session_cb(s, s->session))
2878 SSL_SESSION_free(s->session);
2881 /* auto flush every 255 connections */
2882 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
2883 if ((((mode & SSL_SESS_CACHE_CLIENT)
2884 ? s->session_ctx->stats.sess_connect_good
2885 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
2886 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
2891 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
2896 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
2901 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
2905 if (s->method != meth) {
2906 const SSL_METHOD *sm = s->method;
2907 int (*hf)(SSL *) = s->handshake_func;
2909 if (sm->version == meth->version)
2914 ret = s->method->ssl_new(s);
2917 if (hf == sm->ssl_connect)
2918 s->handshake_func = meth->ssl_connect;
2919 else if (hf == sm->ssl_accept)
2920 s->handshake_func = meth->ssl_accept;
2925 int SSL_get_error(const SSL *s, int i)
2932 return (SSL_ERROR_NONE);
2935 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
2936 * where we do encode the error
2938 if ((l = ERR_peek_error()) != 0) {
2939 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
2940 return (SSL_ERROR_SYSCALL);
2942 return (SSL_ERROR_SSL);
2946 if (SSL_want_read(s)) {
2947 bio = SSL_get_rbio(s);
2948 if (BIO_should_read(bio))
2949 return (SSL_ERROR_WANT_READ);
2950 else if (BIO_should_write(bio))
2952 * This one doesn't make too much sense ... We never try to write
2953 * to the rbio, and an application program where rbio and wbio
2954 * are separate couldn't even know what it should wait for.
2955 * However if we ever set s->rwstate incorrectly (so that we have
2956 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
2957 * wbio *are* the same, this test works around that bug; so it
2958 * might be safer to keep it.
2960 return (SSL_ERROR_WANT_WRITE);
2961 else if (BIO_should_io_special(bio)) {
2962 reason = BIO_get_retry_reason(bio);
2963 if (reason == BIO_RR_CONNECT)
2964 return (SSL_ERROR_WANT_CONNECT);
2965 else if (reason == BIO_RR_ACCEPT)
2966 return (SSL_ERROR_WANT_ACCEPT);
2968 return (SSL_ERROR_SYSCALL); /* unknown */
2972 if (SSL_want_write(s)) {
2973 bio = SSL_get_wbio(s);
2974 if (BIO_should_write(bio))
2975 return (SSL_ERROR_WANT_WRITE);
2976 else if (BIO_should_read(bio))
2978 * See above (SSL_want_read(s) with BIO_should_write(bio))
2980 return (SSL_ERROR_WANT_READ);
2981 else if (BIO_should_io_special(bio)) {
2982 reason = BIO_get_retry_reason(bio);
2983 if (reason == BIO_RR_CONNECT)
2984 return (SSL_ERROR_WANT_CONNECT);
2985 else if (reason == BIO_RR_ACCEPT)
2986 return (SSL_ERROR_WANT_ACCEPT);
2988 return (SSL_ERROR_SYSCALL);
2991 if (SSL_want_x509_lookup(s)) {
2992 return (SSL_ERROR_WANT_X509_LOOKUP);
2994 if (SSL_want_async(s)) {
2995 return SSL_ERROR_WANT_ASYNC;
2997 if (SSL_want_async_job(s)) {
2998 return SSL_ERROR_WANT_ASYNC_JOB;
3003 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3004 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3005 return (SSL_ERROR_ZERO_RETURN);
3007 return (SSL_ERROR_SYSCALL);
3010 static int ssl_do_handshake_intern(void *vargs)
3012 struct ssl_async_args *args;
3015 args = (struct ssl_async_args *)vargs;
3018 return s->handshake_func(s);
3021 int SSL_do_handshake(SSL *s)
3025 if (s->handshake_func == NULL) {
3026 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3030 s->method->ssl_renegotiate_check(s);
3032 if (SSL_in_init(s) || SSL_in_before(s)) {
3033 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3034 struct ssl_async_args args;
3038 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3040 ret = s->handshake_func(s);
3046 void SSL_set_accept_state(SSL *s)
3050 ossl_statem_clear(s);
3051 s->handshake_func = s->method->ssl_accept;
3055 void SSL_set_connect_state(SSL *s)
3059 ossl_statem_clear(s);
3060 s->handshake_func = s->method->ssl_connect;
3064 int ssl_undefined_function(SSL *s)
3066 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3070 int ssl_undefined_void_function(void)
3072 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3073 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3077 int ssl_undefined_const_function(const SSL *s)
3082 const SSL_METHOD *ssl_bad_method(int ver)
3084 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3088 const char *ssl_protocol_to_string(int version)
3090 if (version == TLS1_2_VERSION)
3092 else if (version == TLS1_1_VERSION)
3094 else if (version == TLS1_VERSION)
3096 else if (version == SSL3_VERSION)
3098 else if (version == DTLS1_BAD_VER)
3100 else if (version == DTLS1_VERSION)
3102 else if (version == DTLS1_2_VERSION)
3108 const char *SSL_get_version(const SSL *s)
3110 return ssl_protocol_to_string(s->version);
3113 SSL *SSL_dup(SSL *s)
3115 STACK_OF(X509_NAME) *sk;
3120 /* If we're not quiescent, just up_ref! */
3121 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3122 CRYPTO_atomic_add(&s->references, 1, &i, s->lock);
3127 * Otherwise, copy configuration state, and session if set.
3129 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3132 if (s->session != NULL) {
3134 * Arranges to share the same session via up_ref. This "copies"
3135 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3137 if (!SSL_copy_session_id(ret, s))
3141 * No session has been established yet, so we have to expect that
3142 * s->cert or ret->cert will be changed later -- they should not both
3143 * point to the same object, and thus we can't use
3144 * SSL_copy_session_id.
3146 if (!SSL_set_ssl_method(ret, s->method))
3149 if (s->cert != NULL) {
3150 ssl_cert_free(ret->cert);
3151 ret->cert = ssl_cert_dup(s->cert);
3152 if (ret->cert == NULL)
3156 if (!SSL_set_session_id_context(ret, s->sid_ctx, s->sid_ctx_length))
3160 if (!ssl_dane_dup(ret, s))
3162 ret->version = s->version;
3163 ret->options = s->options;
3164 ret->mode = s->mode;
3165 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3166 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3167 ret->msg_callback = s->msg_callback;
3168 ret->msg_callback_arg = s->msg_callback_arg;
3169 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3170 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3171 ret->generate_session_id = s->generate_session_id;
3173 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3175 /* copy app data, a little dangerous perhaps */
3176 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3179 /* setup rbio, and wbio */
3180 if (s->rbio != NULL) {
3181 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3184 if (s->wbio != NULL) {
3185 if (s->wbio != s->rbio) {
3186 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3189 ret->wbio = ret->rbio;
3192 ret->server = s->server;
3193 if (s->handshake_func) {
3195 SSL_set_accept_state(ret);
3197 SSL_set_connect_state(ret);
3199 ret->shutdown = s->shutdown;
3202 ret->default_passwd_callback = s->default_passwd_callback;
3203 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3205 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3207 /* dup the cipher_list and cipher_list_by_id stacks */
3208 if (s->cipher_list != NULL) {
3209 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3212 if (s->cipher_list_by_id != NULL)
3213 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3217 /* Dup the client_CA list */
3218 if (s->client_CA != NULL) {
3219 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3221 ret->client_CA = sk;
3222 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3223 xn = sk_X509_NAME_value(sk, i);
3224 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3237 void ssl_clear_cipher_ctx(SSL *s)
3239 if (s->enc_read_ctx != NULL) {
3240 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3241 s->enc_read_ctx = NULL;
3243 if (s->enc_write_ctx != NULL) {
3244 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3245 s->enc_write_ctx = NULL;
3247 #ifndef OPENSSL_NO_COMP
3248 COMP_CTX_free(s->expand);
3250 COMP_CTX_free(s->compress);
3255 X509 *SSL_get_certificate(const SSL *s)
3257 if (s->cert != NULL)
3258 return (s->cert->key->x509);
3263 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3265 if (s->cert != NULL)
3266 return (s->cert->key->privatekey);
3271 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3273 if (ctx->cert != NULL)
3274 return ctx->cert->key->x509;
3279 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3281 if (ctx->cert != NULL)
3282 return ctx->cert->key->privatekey;
3287 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3289 if ((s->session != NULL) && (s->session->cipher != NULL))
3290 return (s->session->cipher);
3294 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3296 #ifndef OPENSSL_NO_COMP
3297 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3303 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3305 #ifndef OPENSSL_NO_COMP
3306 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3312 int ssl_init_wbio_buffer(SSL *s, int push)
3316 if (s->bbio == NULL) {
3317 bbio = BIO_new(BIO_f_buffer());
3323 if (s->bbio == s->wbio)
3324 s->wbio = BIO_pop(s->wbio);
3326 (void)BIO_reset(bbio);
3327 /* if (!BIO_set_write_buffer_size(bbio,16*1024)) */
3328 if (!BIO_set_read_buffer_size(bbio, 1)) {
3329 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3333 if (s->wbio != bbio)
3334 s->wbio = BIO_push(bbio, s->wbio);
3336 if (s->wbio == bbio)
3337 s->wbio = BIO_pop(bbio);
3342 void ssl_free_wbio_buffer(SSL *s)
3344 /* callers ensure s is never null */
3345 if (s->bbio == NULL)
3348 if (s->bbio == s->wbio) {
3349 /* remove buffering */
3350 s->wbio = BIO_pop(s->wbio);
3351 assert(s->wbio != NULL);
3357 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3359 ctx->quiet_shutdown = mode;
3362 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3364 return (ctx->quiet_shutdown);
3367 void SSL_set_quiet_shutdown(SSL *s, int mode)
3369 s->quiet_shutdown = mode;
3372 int SSL_get_quiet_shutdown(const SSL *s)
3374 return (s->quiet_shutdown);
3377 void SSL_set_shutdown(SSL *s, int mode)
3382 int SSL_get_shutdown(const SSL *s)
3384 return (s->shutdown);
3387 int SSL_version(const SSL *s)
3389 return (s->version);
3392 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3397 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3400 if (ssl->ctx == ctx)
3403 ctx = ssl->initial_ctx;
3404 new_cert = ssl_cert_dup(ctx->cert);
3405 if (new_cert == NULL) {
3408 ssl_cert_free(ssl->cert);
3409 ssl->cert = new_cert;
3412 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3413 * so setter APIs must prevent invalid lengths from entering the system.
3415 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3418 * If the session ID context matches that of the parent SSL_CTX,
3419 * inherit it from the new SSL_CTX as well. If however the context does
3420 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3421 * leave it unchanged.
3423 if ((ssl->ctx != NULL) &&
3424 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3425 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3426 ssl->sid_ctx_length = ctx->sid_ctx_length;
3427 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3430 SSL_CTX_up_ref(ctx);
3431 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3437 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3439 return (X509_STORE_set_default_paths(ctx->cert_store));
3442 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3444 X509_LOOKUP *lookup;
3446 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3449 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3451 /* Clear any errors if the default directory does not exist */
3457 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3459 X509_LOOKUP *lookup;
3461 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3465 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3467 /* Clear any errors if the default file does not exist */
3473 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3476 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3479 void SSL_set_info_callback(SSL *ssl,
3480 void (*cb) (const SSL *ssl, int type, int val))
3482 ssl->info_callback = cb;
3486 * One compiler (Diab DCC) doesn't like argument names in returned function
3489 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3492 return ssl->info_callback;
3495 void SSL_set_verify_result(SSL *ssl, long arg)
3497 ssl->verify_result = arg;
3500 long SSL_get_verify_result(const SSL *ssl)
3502 return (ssl->verify_result);
3505 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3508 return sizeof(ssl->s3->client_random);
3509 if (outlen > sizeof(ssl->s3->client_random))
3510 outlen = sizeof(ssl->s3->client_random);
3511 memcpy(out, ssl->s3->client_random, outlen);
3515 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3518 return sizeof(ssl->s3->server_random);
3519 if (outlen > sizeof(ssl->s3->server_random))
3520 outlen = sizeof(ssl->s3->server_random);
3521 memcpy(out, ssl->s3->server_random, outlen);
3525 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3526 unsigned char *out, size_t outlen)
3528 if (session->master_key_length < 0) {
3529 /* Should never happen */
3533 return session->master_key_length;
3534 if (outlen > (size_t)session->master_key_length)
3535 outlen = session->master_key_length;
3536 memcpy(out, session->master_key, outlen);
3540 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3542 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3545 void *SSL_get_ex_data(const SSL *s, int idx)
3547 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3550 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3552 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3555 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3557 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3565 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3567 return (ctx->cert_store);
3570 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3572 X509_STORE_free(ctx->cert_store);
3573 ctx->cert_store = store;
3576 int SSL_want(const SSL *s)
3578 return (s->rwstate);
3582 * \brief Set the callback for generating temporary DH keys.
3583 * \param ctx the SSL context.
3584 * \param dh the callback
3587 #ifndef OPENSSL_NO_DH
3588 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3589 DH *(*dh) (SSL *ssl, int is_export,
3592 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3595 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3598 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3602 #ifndef OPENSSL_NO_PSK
3603 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3605 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3606 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT,
3607 SSL_R_DATA_LENGTH_TOO_LONG);
3610 OPENSSL_free(ctx->cert->psk_identity_hint);
3611 if (identity_hint != NULL) {
3612 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3613 if (ctx->cert->psk_identity_hint == NULL)
3616 ctx->cert->psk_identity_hint = NULL;
3620 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3625 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3626 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3629 OPENSSL_free(s->cert->psk_identity_hint);
3630 if (identity_hint != NULL) {
3631 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3632 if (s->cert->psk_identity_hint == NULL)
3635 s->cert->psk_identity_hint = NULL;
3639 const char *SSL_get_psk_identity_hint(const SSL *s)
3641 if (s == NULL || s->session == NULL)
3643 return (s->session->psk_identity_hint);
3646 const char *SSL_get_psk_identity(const SSL *s)
3648 if (s == NULL || s->session == NULL)
3650 return (s->session->psk_identity);
3653 void SSL_set_psk_client_callback(SSL *s,
3654 unsigned int (*cb) (SSL *ssl,
3663 s->psk_client_callback = cb;
3666 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx,
3667 unsigned int (*cb) (SSL *ssl,
3676 ctx->psk_client_callback = cb;
3679 void SSL_set_psk_server_callback(SSL *s,
3680 unsigned int (*cb) (SSL *ssl,
3681 const char *identity,
3686 s->psk_server_callback = cb;
3689 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx,
3690 unsigned int (*cb) (SSL *ssl,
3691 const char *identity,
3696 ctx->psk_server_callback = cb;
3700 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3701 void (*cb) (int write_p, int version,
3702 int content_type, const void *buf,
3703 size_t len, SSL *ssl, void *arg))
3705 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3708 void SSL_set_msg_callback(SSL *ssl,
3709 void (*cb) (int write_p, int version,
3710 int content_type, const void *buf,
3711 size_t len, SSL *ssl, void *arg))
3713 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3716 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3717 int (*cb) (SSL *ssl,
3721 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3722 (void (*)(void))cb);
3725 void SSL_set_not_resumable_session_callback(SSL *ssl,
3726 int (*cb) (SSL *ssl,
3727 int is_forward_secure))
3729 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3730 (void (*)(void))cb);
3734 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3735 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3736 * If EVP_MD pointer is passed, initializes ctx with this md Returns newly
3740 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3742 ssl_clear_hash_ctx(hash);
3743 *hash = EVP_MD_CTX_new();
3744 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3745 EVP_MD_CTX_free(*hash);
3752 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3756 EVP_MD_CTX_free(*hash);
3760 /* Retrieve handshake hashes */
3761 int ssl_handshake_hash(SSL *s, unsigned char *out, int outlen)
3763 EVP_MD_CTX *ctx = NULL;
3764 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3765 int ret = EVP_MD_CTX_size(hdgst);
3766 if (ret < 0 || ret > outlen) {
3770 ctx = EVP_MD_CTX_new();
3775 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3776 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3779 EVP_MD_CTX_free(ctx);
3783 int SSL_session_reused(SSL *s)
3788 int SSL_is_server(SSL *s)
3793 #if OPENSSL_API_COMPAT < 0x10100000L
3794 void SSL_set_debug(SSL *s, int debug)
3796 /* Old function was do-nothing anyway... */
3803 void SSL_set_security_level(SSL *s, int level)
3805 s->cert->sec_level = level;
3808 int SSL_get_security_level(const SSL *s)
3810 return s->cert->sec_level;
3813 void SSL_set_security_callback(SSL *s,
3814 int (*cb) (const SSL *s, const SSL_CTX *ctx, int op,
3815 int bits, int nid, void *other,
3818 s->cert->sec_cb = cb;
3821 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s, const SSL_CTX *ctx, int op,
3823 void *other, void *ex) {
3824 return s->cert->sec_cb;
3827 void SSL_set0_security_ex_data(SSL *s, void *ex)
3829 s->cert->sec_ex = ex;
3832 void *SSL_get0_security_ex_data(const SSL *s)
3834 return s->cert->sec_ex;
3837 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
3839 ctx->cert->sec_level = level;
3842 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
3844 return ctx->cert->sec_level;
3847 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
3848 int (*cb) (const SSL *s, const SSL_CTX *ctx, int op,
3849 int bits, int nid, void *other,
3852 ctx->cert->sec_cb = cb;
3855 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
3861 return ctx->cert->sec_cb;
3864 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
3866 ctx->cert->sec_ex = ex;
3869 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
3871 return ctx->cert->sec_ex;
3876 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3877 * can return unsigned long, instead of the generic long return value from the
3878 * control interface.
3880 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
3882 return ctx->options;
3884 unsigned long SSL_get_options(const SSL* s)
3888 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
3890 return ctx->options |= op;
3892 unsigned long SSL_set_options(SSL *s, unsigned long op)
3894 return s->options |= op;
3896 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
3898 return ctx->options &= ~op;
3900 unsigned long SSL_clear_options(SSL *s, unsigned long op)
3902 return s->options &= ~op;
3905 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
3907 return s->verified_chain;
3910 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
3912 #ifndef OPENSSL_NO_CT
3915 * Moves SCTs from the |src| stack to the |dst| stack.
3916 * The source of each SCT will be set to |origin|.
3917 * If |dst| points to a NULL pointer, a new stack will be created and owned by
3919 * Returns the number of SCTs moved, or a negative integer if an error occurs.
3921 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src, sct_source_t origin)
3927 *dst = sk_SCT_new_null();
3929 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
3934 while ((sct = sk_SCT_pop(src)) != NULL) {
3935 if (SCT_set_source(sct, origin) != 1)
3938 if (sk_SCT_push(*dst, sct) <= 0)
3946 sk_SCT_push(src, sct); /* Put the SCT back */
3951 * Look for data collected during ServerHello and parse if found.
3952 * Return 1 on success, 0 on failure.
3954 static int ct_extract_tls_extension_scts(SSL *s)
3956 int scts_extracted = 0;
3958 if (s->tlsext_scts != NULL) {
3959 const unsigned char *p = s->tlsext_scts;
3960 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->tlsext_scts_len);
3962 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
3964 SCT_LIST_free(scts);
3967 return scts_extracted;
3971 * Checks for an OCSP response and then attempts to extract any SCTs found if it
3972 * contains an SCT X509 extension. They will be stored in |s->scts|.
3974 * - The number of SCTs extracted, assuming an OCSP response exists.
3975 * - 0 if no OCSP response exists or it contains no SCTs.
3976 * - A negative integer if an error occurs.
3978 static int ct_extract_ocsp_response_scts(SSL *s)
3980 #ifndef OPENSSL_NO_OCSP
3981 int scts_extracted = 0;
3982 const unsigned char *p;
3983 OCSP_BASICRESP *br = NULL;
3984 OCSP_RESPONSE *rsp = NULL;
3985 STACK_OF(SCT) *scts = NULL;
3988 if (s->tlsext_ocsp_resp == NULL || s->tlsext_ocsp_resplen == 0)
3991 p = s->tlsext_ocsp_resp;
3992 rsp = d2i_OCSP_RESPONSE(NULL, &p, s->tlsext_ocsp_resplen);
3996 br = OCSP_response_get1_basic(rsp);
4000 for (i = 0; i < OCSP_resp_count(br); ++i) {
4001 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4006 scts = OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4007 scts_extracted = ct_move_scts(&s->scts, scts,
4008 SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4009 if (scts_extracted < 0)
4013 SCT_LIST_free(scts);
4014 OCSP_BASICRESP_free(br);
4015 OCSP_RESPONSE_free(rsp);
4016 return scts_extracted;
4018 /* Behave as if no OCSP response exists */
4024 * Attempts to extract SCTs from the peer certificate.
4025 * Return the number of SCTs extracted, or a negative integer if an error
4028 static int ct_extract_x509v3_extension_scts(SSL *s)
4030 int scts_extracted = 0;
4031 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4034 STACK_OF(SCT) *scts =
4035 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4038 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4040 SCT_LIST_free(scts);
4043 return scts_extracted;
4047 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4048 * response (if it exists) and X509v3 extensions in the certificate.
4049 * Returns NULL if an error occurs.
4051 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4053 if (!s->scts_parsed) {
4054 if (ct_extract_tls_extension_scts(s) < 0 ||
4055 ct_extract_ocsp_response_scts(s) < 0 ||
4056 ct_extract_x509v3_extension_scts(s) < 0)
4066 static int ct_permissive(const CT_POLICY_EVAL_CTX *ctx,
4067 const STACK_OF(SCT) *scts, void *unused_arg)
4072 static int ct_strict(const CT_POLICY_EVAL_CTX *ctx,
4073 const STACK_OF(SCT) *scts, void *unused_arg)
4075 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4078 for (i = 0; i < count; ++i) {
4079 SCT *sct = sk_SCT_value(scts, i);
4080 int status = SCT_get_validation_status(sct);
4082 if (status == SCT_VALIDATION_STATUS_VALID)
4085 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4089 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4093 * Since code exists that uses the custom extension handler for CT, look
4094 * for this and throw an error if they have already registered to use CT.
4096 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4097 TLSEXT_TYPE_signed_certificate_timestamp)) {
4098 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4099 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4103 if (callback != NULL) {
4104 /* If we are validating CT, then we MUST accept SCTs served via OCSP */
4105 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4109 s->ct_validation_callback = callback;
4110 s->ct_validation_callback_arg = arg;
4115 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4116 ssl_ct_validation_cb callback,
4120 * Since code exists that uses the custom extension handler for CT, look for
4121 * this and throw an error if they have already registered to use CT.
4123 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4124 TLSEXT_TYPE_signed_certificate_timestamp)) {
4125 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4126 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4130 ctx->ct_validation_callback = callback;
4131 ctx->ct_validation_callback_arg = arg;
4135 int SSL_ct_is_enabled(const SSL *s)
4137 return s->ct_validation_callback != NULL;
4140 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4142 return ctx->ct_validation_callback != NULL;
4145 int ssl_validate_ct(SSL *s)
4148 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4150 SSL_DANE *dane = &s->dane;
4151 CT_POLICY_EVAL_CTX *ctx = NULL;
4152 const STACK_OF(SCT) *scts;
4155 * If no callback is set, the peer is anonymous, or its chain is invalid,
4156 * skip SCT validation - just return success. Applications that continue
4157 * handshakes without certificates, with unverified chains, or pinned leaf
4158 * certificates are outside the scope of the WebPKI and CT.
4160 * The above exclusions notwithstanding the vast majority of peers will
4161 * have rather ordinary certificate chains validated by typical
4162 * applications that perform certificate verification and therefore will
4163 * process SCTs when enabled.
4165 if (s->ct_validation_callback == NULL || cert == NULL ||
4166 s->verify_result != X509_V_OK ||
4167 s->verified_chain == NULL ||
4168 sk_X509_num(s->verified_chain) <= 1)
4172 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4173 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4175 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4176 switch (dane->mtlsa->usage) {
4177 case DANETLS_USAGE_DANE_TA:
4178 case DANETLS_USAGE_DANE_EE:
4183 ctx = CT_POLICY_EVAL_CTX_new();
4185 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4189 issuer = sk_X509_value(s->verified_chain, 1);
4190 CT_POLICY_EVAL_CTX_set0_cert(ctx, cert);
4191 CT_POLICY_EVAL_CTX_set0_issuer(ctx, issuer);
4192 CT_POLICY_EVAL_CTX_set0_log_store(ctx, s->ctx->ctlog_store);
4194 scts = SSL_get0_peer_scts(s);
4197 * This function returns success (> 0) only when all the SCTs are valid, 0
4198 * when some are invalid, and < 0 on various internal errors (out of
4199 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4200 * reason to abort the handshake, that decision is up to the callback.
4201 * Therefore, we error out only in the unexpected case that the return
4202 * value is negative.
4204 * XXX: One might well argue that the return value of this function is an
4205 * unforunate design choice. Its job is only to determine the validation
4206 * status of each of the provided SCTs. So long as it correctly separates
4207 * the wheat from the chaff it should return success. Failure in this case
4208 * ought to correspond to an inability to carry out its duties.
4210 if (SCT_LIST_validate(scts, ctx) < 0) {
4211 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4215 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4217 ret = 0; /* This function returns 0 on failure */
4220 CT_POLICY_EVAL_CTX_free(ctx);
4224 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4226 switch (validation_mode) {
4228 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4230 case SSL_CT_VALIDATION_PERMISSIVE:
4231 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4232 case SSL_CT_VALIDATION_STRICT:
4233 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4237 int SSL_enable_ct(SSL *s, int validation_mode)
4239 switch (validation_mode) {
4241 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4243 case SSL_CT_VALIDATION_PERMISSIVE:
4244 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4245 case SSL_CT_VALIDATION_STRICT:
4246 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4250 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4252 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4255 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4257 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4260 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE *logs)
4262 CTLOG_STORE_free(ctx->ctlog_store);
4263 ctx->ctlog_store = logs;
4266 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4268 return ctx->ctlog_store;