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 = ctx->tlsext_status_type;
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 int SSL_up_ref(SSL *s)
781 if (CRYPTO_atomic_add(&s->references, 1, &i, s->lock) <= 0)
784 REF_PRINT_COUNT("SSL", s);
785 REF_ASSERT_ISNT(i < 2);
786 return ((i > 1) ? 1 : 0);
789 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
790 unsigned int sid_ctx_len)
792 if (sid_ctx_len > sizeof ctx->sid_ctx) {
793 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
794 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
797 ctx->sid_ctx_length = sid_ctx_len;
798 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
803 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
804 unsigned int sid_ctx_len)
806 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
807 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
808 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
811 ssl->sid_ctx_length = sid_ctx_len;
812 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
817 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
819 CRYPTO_THREAD_write_lock(ctx->lock);
820 ctx->generate_session_id = cb;
821 CRYPTO_THREAD_unlock(ctx->lock);
825 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
827 CRYPTO_THREAD_write_lock(ssl->lock);
828 ssl->generate_session_id = cb;
829 CRYPTO_THREAD_unlock(ssl->lock);
833 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
837 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
838 * we can "construct" a session to give us the desired check - ie. to
839 * find if there's a session in the hash table that would conflict with
840 * any new session built out of this id/id_len and the ssl_version in use
845 if (id_len > sizeof r.session_id)
848 r.ssl_version = ssl->version;
849 r.session_id_length = id_len;
850 memcpy(r.session_id, id, id_len);
852 CRYPTO_THREAD_read_lock(ssl->ctx->lock);
853 p = lh_SSL_SESSION_retrieve(ssl->ctx->sessions, &r);
854 CRYPTO_THREAD_unlock(ssl->ctx->lock);
858 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
860 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
863 int SSL_set_purpose(SSL *s, int purpose)
865 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
868 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
870 return X509_VERIFY_PARAM_set_trust(s->param, trust);
873 int SSL_set_trust(SSL *s, int trust)
875 return X509_VERIFY_PARAM_set_trust(s->param, trust);
878 int SSL_set1_host(SSL *s, const char *hostname)
880 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
883 int SSL_add1_host(SSL *s, const char *hostname)
885 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
888 void SSL_set_hostflags(SSL *s, unsigned int flags)
890 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
893 const char *SSL_get0_peername(SSL *s)
895 return X509_VERIFY_PARAM_get0_peername(s->param);
898 int SSL_CTX_dane_enable(SSL_CTX *ctx)
900 return dane_ctx_enable(&ctx->dane);
903 int SSL_dane_enable(SSL *s, const char *basedomain)
905 SSL_DANE *dane = &s->dane;
907 if (s->ctx->dane.mdmax == 0) {
908 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
911 if (dane->trecs != NULL) {
912 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
917 * Default SNI name. This rejects empty names, while set1_host below
918 * accepts them and disables host name checks. To avoid side-effects with
919 * invalid input, set the SNI name first.
921 if (s->tlsext_hostname == NULL) {
922 if (!SSL_set_tlsext_host_name(s, basedomain)) {
923 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
928 /* Primary RFC6125 reference identifier */
929 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
930 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
936 dane->dctx = &s->ctx->dane;
937 dane->trecs = sk_danetls_record_new_null();
939 if (dane->trecs == NULL) {
940 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
946 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
948 SSL_DANE *dane = &s->dane;
950 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
954 *mcert = dane->mcert;
956 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
961 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
962 uint8_t *mtype, unsigned const char **data, size_t *dlen)
964 SSL_DANE *dane = &s->dane;
966 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
970 *usage = dane->mtlsa->usage;
972 *selector = dane->mtlsa->selector;
974 *mtype = dane->mtlsa->mtype;
976 *data = dane->mtlsa->data;
978 *dlen = dane->mtlsa->dlen;
983 SSL_DANE *SSL_get0_dane(SSL *s)
988 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
989 uint8_t mtype, unsigned char *data, size_t dlen)
991 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
994 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype, uint8_t ord)
996 return dane_mtype_set(&ctx->dane, md, mtype, ord);
999 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1001 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1004 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1006 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1009 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1014 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1019 void SSL_certs_clear(SSL *s)
1021 ssl_cert_clear_certs(s->cert);
1024 void SSL_free(SSL *s)
1031 CRYPTO_atomic_add(&s->references, -1, &i, s->lock);
1032 REF_PRINT_COUNT("SSL", s);
1035 REF_ASSERT_ISNT(i < 0);
1037 X509_VERIFY_PARAM_free(s->param);
1038 dane_final(&s->dane);
1039 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1041 if (s->bbio != NULL) {
1042 /* If the buffering BIO is in place, pop it off */
1043 if (s->bbio == s->wbio) {
1044 s->wbio = BIO_pop(s->wbio);
1049 BIO_free_all(s->rbio);
1050 if (s->wbio != s->rbio)
1051 BIO_free_all(s->wbio);
1053 BUF_MEM_free(s->init_buf);
1055 /* add extra stuff */
1056 sk_SSL_CIPHER_free(s->cipher_list);
1057 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1059 /* Make the next call work :-) */
1060 if (s->session != NULL) {
1061 ssl_clear_bad_session(s);
1062 SSL_SESSION_free(s->session);
1067 ssl_cert_free(s->cert);
1068 /* Free up if allocated */
1070 OPENSSL_free(s->tlsext_hostname);
1071 SSL_CTX_free(s->initial_ctx);
1072 #ifndef OPENSSL_NO_EC
1073 OPENSSL_free(s->tlsext_ecpointformatlist);
1074 OPENSSL_free(s->tlsext_ellipticcurvelist);
1075 #endif /* OPENSSL_NO_EC */
1076 sk_X509_EXTENSION_pop_free(s->tlsext_ocsp_exts, X509_EXTENSION_free);
1077 #ifndef OPENSSL_NO_OCSP
1078 sk_OCSP_RESPID_pop_free(s->tlsext_ocsp_ids, OCSP_RESPID_free);
1080 #ifndef OPENSSL_NO_CT
1081 SCT_LIST_free(s->scts);
1082 OPENSSL_free(s->tlsext_scts);
1084 OPENSSL_free(s->tlsext_ocsp_resp);
1085 OPENSSL_free(s->alpn_client_proto_list);
1087 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1089 sk_X509_pop_free(s->verified_chain, X509_free);
1091 if (s->method != NULL)
1092 s->method->ssl_free(s);
1094 RECORD_LAYER_release(&s->rlayer);
1096 SSL_CTX_free(s->ctx);
1098 ASYNC_WAIT_CTX_free(s->waitctx);
1100 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1101 OPENSSL_free(s->next_proto_negotiated);
1104 #ifndef OPENSSL_NO_SRTP
1105 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1108 CRYPTO_THREAD_lock_free(s->lock);
1113 void SSL_set_rbio(SSL *s, BIO *rbio)
1115 if (s->rbio != rbio)
1116 BIO_free_all(s->rbio);
1120 void SSL_set_wbio(SSL *s, BIO *wbio)
1123 * If the output buffering BIO is still in place, remove it
1125 if (s->bbio != NULL) {
1126 if (s->wbio == s->bbio) {
1127 s->wbio = BIO_next(s->wbio);
1128 BIO_set_next(s->bbio, NULL);
1131 if (s->wbio != wbio && s->rbio != s->wbio)
1132 BIO_free_all(s->wbio);
1136 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1138 SSL_set_wbio(s, wbio);
1139 SSL_set_rbio(s, rbio);
1142 BIO *SSL_get_rbio(const SSL *s)
1147 BIO *SSL_get_wbio(const SSL *s)
1152 int SSL_get_fd(const SSL *s)
1154 return (SSL_get_rfd(s));
1157 int SSL_get_rfd(const SSL *s)
1162 b = SSL_get_rbio(s);
1163 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1165 BIO_get_fd(r, &ret);
1169 int SSL_get_wfd(const SSL *s)
1174 b = SSL_get_wbio(s);
1175 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1177 BIO_get_fd(r, &ret);
1181 #ifndef OPENSSL_NO_SOCK
1182 int SSL_set_fd(SSL *s, int fd)
1187 bio = BIO_new(BIO_s_socket());
1190 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1193 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1194 SSL_set_bio(s, bio, bio);
1200 int SSL_set_wfd(SSL *s, int fd)
1205 if ((s->rbio == NULL) || (BIO_method_type(s->rbio) != BIO_TYPE_SOCKET)
1206 || ((int)BIO_get_fd(s->rbio, NULL) != fd)) {
1207 bio = BIO_new(BIO_s_socket());
1210 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1213 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1214 SSL_set_bio(s, SSL_get_rbio(s), bio);
1216 SSL_set_bio(s, SSL_get_rbio(s), SSL_get_rbio(s));
1222 int SSL_set_rfd(SSL *s, int fd)
1227 if ((s->wbio == NULL) || (BIO_method_type(s->wbio) != BIO_TYPE_SOCKET)
1228 || ((int)BIO_get_fd(s->wbio, NULL) != fd)) {
1229 bio = BIO_new(BIO_s_socket());
1232 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1235 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1236 SSL_set_bio(s, bio, SSL_get_wbio(s));
1238 SSL_set_bio(s, SSL_get_wbio(s), SSL_get_wbio(s));
1245 /* return length of latest Finished message we sent, copy to 'buf' */
1246 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1250 if (s->s3 != NULL) {
1251 ret = s->s3->tmp.finish_md_len;
1254 memcpy(buf, s->s3->tmp.finish_md, count);
1259 /* return length of latest Finished message we expected, copy to 'buf' */
1260 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1264 if (s->s3 != NULL) {
1265 ret = s->s3->tmp.peer_finish_md_len;
1268 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1273 int SSL_get_verify_mode(const SSL *s)
1275 return (s->verify_mode);
1278 int SSL_get_verify_depth(const SSL *s)
1280 return X509_VERIFY_PARAM_get_depth(s->param);
1283 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1284 return (s->verify_callback);
1287 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1289 return (ctx->verify_mode);
1292 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1294 return X509_VERIFY_PARAM_get_depth(ctx->param);
1297 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1298 return (ctx->default_verify_callback);
1301 void SSL_set_verify(SSL *s, int mode,
1302 int (*callback) (int ok, X509_STORE_CTX *ctx))
1304 s->verify_mode = mode;
1305 if (callback != NULL)
1306 s->verify_callback = callback;
1309 void SSL_set_verify_depth(SSL *s, int depth)
1311 X509_VERIFY_PARAM_set_depth(s->param, depth);
1314 void SSL_set_read_ahead(SSL *s, int yes)
1316 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1319 int SSL_get_read_ahead(const SSL *s)
1321 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1324 int SSL_pending(const SSL *s)
1327 * SSL_pending cannot work properly if read-ahead is enabled
1328 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1329 * impossible to fix since SSL_pending cannot report errors that may be
1330 * observed while scanning the new data. (Note that SSL_pending() is
1331 * often used as a boolean value, so we'd better not return -1.)
1333 return (s->method->ssl_pending(s));
1336 int SSL_has_pending(const SSL *s)
1339 * Similar to SSL_pending() but returns a 1 to indicate that we have
1340 * unprocessed data available or 0 otherwise (as opposed to the number of
1341 * bytes available). Unlike SSL_pending() this will take into account
1342 * read_ahead data. A 1 return simply indicates that we have unprocessed
1343 * data. That data may not result in any application data, or we may fail
1344 * to parse the records for some reason.
1349 return RECORD_LAYER_read_pending(&s->rlayer);
1352 X509 *SSL_get_peer_certificate(const SSL *s)
1356 if ((s == NULL) || (s->session == NULL))
1359 r = s->session->peer;
1369 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1373 if ((s == NULL) || (s->session == NULL))
1376 r = s->session->peer_chain;
1379 * If we are a client, cert_chain includes the peer's own certificate; if
1380 * we are a server, it does not.
1387 * Now in theory, since the calling process own 't' it should be safe to
1388 * modify. We need to be able to read f without being hassled
1390 int SSL_copy_session_id(SSL *t, const SSL *f)
1393 /* Do we need to to SSL locking? */
1394 if (!SSL_set_session(t, SSL_get_session(f))) {
1399 * what if we are setup for one protocol version but want to talk another
1401 if (t->method != f->method) {
1402 t->method->ssl_free(t);
1403 t->method = f->method;
1404 if (t->method->ssl_new(t) == 0)
1408 CRYPTO_atomic_add(&f->cert->references, 1, &i, f->cert->lock);
1409 ssl_cert_free(t->cert);
1411 if (!SSL_set_session_id_context(t, f->sid_ctx, f->sid_ctx_length)) {
1418 /* Fix this so it checks all the valid key/cert options */
1419 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1421 if ((ctx == NULL) ||
1422 (ctx->cert->key->x509 == NULL)) {
1423 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY,
1424 SSL_R_NO_CERTIFICATE_ASSIGNED);
1427 if (ctx->cert->key->privatekey == NULL) {
1428 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY,
1429 SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1432 return (X509_check_private_key
1433 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1436 /* Fix this function so that it takes an optional type parameter */
1437 int SSL_check_private_key(const SSL *ssl)
1440 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1443 if (ssl->cert->key->x509 == NULL) {
1444 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1447 if (ssl->cert->key->privatekey == NULL) {
1448 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1451 return (X509_check_private_key(ssl->cert->key->x509,
1452 ssl->cert->key->privatekey));
1455 int SSL_waiting_for_async(SSL *s)
1463 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1465 ASYNC_WAIT_CTX *ctx = s->waitctx;
1469 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1472 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1473 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1475 ASYNC_WAIT_CTX *ctx = s->waitctx;
1479 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1483 int SSL_accept(SSL *s)
1485 if (s->handshake_func == NULL) {
1486 /* Not properly initialized yet */
1487 SSL_set_accept_state(s);
1490 return SSL_do_handshake(s);
1493 int SSL_connect(SSL *s)
1495 if (s->handshake_func == NULL) {
1496 /* Not properly initialized yet */
1497 SSL_set_connect_state(s);
1500 return SSL_do_handshake(s);
1503 long SSL_get_default_timeout(const SSL *s)
1505 return (s->method->get_timeout());
1508 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1509 int (*func)(void *)) {
1511 if (s->waitctx == NULL) {
1512 s->waitctx = ASYNC_WAIT_CTX_new();
1513 if (s->waitctx == NULL)
1516 switch(ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1517 sizeof(struct ssl_async_args))) {
1519 s->rwstate = SSL_NOTHING;
1520 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1523 s->rwstate = SSL_ASYNC_PAUSED;
1526 s->rwstate = SSL_ASYNC_NO_JOBS;
1532 s->rwstate = SSL_NOTHING;
1533 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1534 /* Shouldn't happen */
1539 static int ssl_io_intern(void *vargs)
1541 struct ssl_async_args *args;
1546 args = (struct ssl_async_args *)vargs;
1550 switch (args->type) {
1552 return args->f.func_read(s, buf, num);
1554 return args->f.func_write(s, buf, num);
1556 return args->f.func_other(s);
1561 int SSL_read(SSL *s, void *buf, int num)
1563 if (s->handshake_func == NULL) {
1564 SSLerr(SSL_F_SSL_READ, SSL_R_UNINITIALIZED);
1568 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1569 s->rwstate = SSL_NOTHING;
1573 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1574 struct ssl_async_args args;
1579 args.type = READFUNC;
1580 args.f.func_read = s->method->ssl_read;
1582 return ssl_start_async_job(s, &args, ssl_io_intern);
1584 return s->method->ssl_read(s, buf, num);
1588 int SSL_peek(SSL *s, void *buf, int num)
1590 if (s->handshake_func == NULL) {
1591 SSLerr(SSL_F_SSL_PEEK, SSL_R_UNINITIALIZED);
1595 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1598 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1599 struct ssl_async_args args;
1604 args.type = READFUNC;
1605 args.f.func_read = s->method->ssl_peek;
1607 return ssl_start_async_job(s, &args, ssl_io_intern);
1609 return s->method->ssl_peek(s, buf, num);
1613 int SSL_write(SSL *s, const void *buf, int num)
1615 if (s->handshake_func == NULL) {
1616 SSLerr(SSL_F_SSL_WRITE, SSL_R_UNINITIALIZED);
1620 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1621 s->rwstate = SSL_NOTHING;
1622 SSLerr(SSL_F_SSL_WRITE, SSL_R_PROTOCOL_IS_SHUTDOWN);
1626 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1627 struct ssl_async_args args;
1630 args.buf = (void *)buf;
1632 args.type = WRITEFUNC;
1633 args.f.func_write = s->method->ssl_write;
1635 return ssl_start_async_job(s, &args, ssl_io_intern);
1637 return s->method->ssl_write(s, buf, num);
1641 int SSL_shutdown(SSL *s)
1644 * Note that this function behaves differently from what one might
1645 * expect. Return values are 0 for no success (yet), 1 for success; but
1646 * calling it once is usually not enough, even if blocking I/O is used
1647 * (see ssl3_shutdown).
1650 if (s->handshake_func == NULL) {
1651 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1655 if (!SSL_in_init(s)) {
1656 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1657 struct ssl_async_args args;
1660 args.type = OTHERFUNC;
1661 args.f.func_other = s->method->ssl_shutdown;
1663 return ssl_start_async_job(s, &args, ssl_io_intern);
1665 return s->method->ssl_shutdown(s);
1668 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1673 int SSL_renegotiate(SSL *s)
1675 if (s->renegotiate == 0)
1680 return (s->method->ssl_renegotiate(s));
1683 int SSL_renegotiate_abbreviated(SSL *s)
1685 if (s->renegotiate == 0)
1690 return (s->method->ssl_renegotiate(s));
1693 int SSL_renegotiate_pending(SSL *s)
1696 * becomes true when negotiation is requested; false again once a
1697 * handshake has finished
1699 return (s->renegotiate != 0);
1702 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1707 case SSL_CTRL_GET_READ_AHEAD:
1708 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1709 case SSL_CTRL_SET_READ_AHEAD:
1710 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1711 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1714 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1715 s->msg_callback_arg = parg;
1719 return (s->mode |= larg);
1720 case SSL_CTRL_CLEAR_MODE:
1721 return (s->mode &= ~larg);
1722 case SSL_CTRL_GET_MAX_CERT_LIST:
1723 return (s->max_cert_list);
1724 case SSL_CTRL_SET_MAX_CERT_LIST:
1725 l = s->max_cert_list;
1726 s->max_cert_list = larg;
1728 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1729 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1731 s->max_send_fragment = larg;
1732 if (s->max_send_fragment < s->split_send_fragment)
1733 s->split_send_fragment = s->max_send_fragment;
1735 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1736 if ((unsigned int)larg > s->max_send_fragment || larg == 0)
1738 s->split_send_fragment = larg;
1740 case SSL_CTRL_SET_MAX_PIPELINES:
1741 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1743 s->max_pipelines = larg;
1745 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1747 case SSL_CTRL_GET_RI_SUPPORT:
1749 return s->s3->send_connection_binding;
1752 case SSL_CTRL_CERT_FLAGS:
1753 return (s->cert->cert_flags |= larg);
1754 case SSL_CTRL_CLEAR_CERT_FLAGS:
1755 return (s->cert->cert_flags &= ~larg);
1757 case SSL_CTRL_GET_RAW_CIPHERLIST:
1759 if (s->s3->tmp.ciphers_raw == NULL)
1761 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
1762 return (int)s->s3->tmp.ciphers_rawlen;
1764 return TLS_CIPHER_LEN;
1766 case SSL_CTRL_GET_EXTMS_SUPPORT:
1767 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
1769 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
1773 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1774 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1775 &s->min_proto_version);
1776 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1777 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1778 &s->max_proto_version);
1780 return (s->method->ssl_ctrl(s, cmd, larg, parg));
1784 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1787 case SSL_CTRL_SET_MSG_CALLBACK:
1788 s->msg_callback = (void (*)
1789 (int write_p, int version, int content_type,
1790 const void *buf, size_t len, SSL *ssl,
1795 return (s->method->ssl_callback_ctrl(s, cmd, fp));
1799 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
1801 return ctx->sessions;
1804 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1807 /* For some cases with ctx == NULL perform syntax checks */
1810 #ifndef OPENSSL_NO_EC
1811 case SSL_CTRL_SET_CURVES_LIST:
1812 return tls1_set_curves_list(NULL, NULL, parg);
1814 case SSL_CTRL_SET_SIGALGS_LIST:
1815 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
1816 return tls1_set_sigalgs_list(NULL, parg, 0);
1823 case SSL_CTRL_GET_READ_AHEAD:
1824 return (ctx->read_ahead);
1825 case SSL_CTRL_SET_READ_AHEAD:
1826 l = ctx->read_ahead;
1827 ctx->read_ahead = larg;
1830 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1831 ctx->msg_callback_arg = parg;
1834 case SSL_CTRL_GET_MAX_CERT_LIST:
1835 return (ctx->max_cert_list);
1836 case SSL_CTRL_SET_MAX_CERT_LIST:
1837 l = ctx->max_cert_list;
1838 ctx->max_cert_list = larg;
1841 case SSL_CTRL_SET_SESS_CACHE_SIZE:
1842 l = ctx->session_cache_size;
1843 ctx->session_cache_size = larg;
1845 case SSL_CTRL_GET_SESS_CACHE_SIZE:
1846 return (ctx->session_cache_size);
1847 case SSL_CTRL_SET_SESS_CACHE_MODE:
1848 l = ctx->session_cache_mode;
1849 ctx->session_cache_mode = larg;
1851 case SSL_CTRL_GET_SESS_CACHE_MODE:
1852 return (ctx->session_cache_mode);
1854 case SSL_CTRL_SESS_NUMBER:
1855 return (lh_SSL_SESSION_num_items(ctx->sessions));
1856 case SSL_CTRL_SESS_CONNECT:
1857 return (ctx->stats.sess_connect);
1858 case SSL_CTRL_SESS_CONNECT_GOOD:
1859 return (ctx->stats.sess_connect_good);
1860 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
1861 return (ctx->stats.sess_connect_renegotiate);
1862 case SSL_CTRL_SESS_ACCEPT:
1863 return (ctx->stats.sess_accept);
1864 case SSL_CTRL_SESS_ACCEPT_GOOD:
1865 return (ctx->stats.sess_accept_good);
1866 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
1867 return (ctx->stats.sess_accept_renegotiate);
1868 case SSL_CTRL_SESS_HIT:
1869 return (ctx->stats.sess_hit);
1870 case SSL_CTRL_SESS_CB_HIT:
1871 return (ctx->stats.sess_cb_hit);
1872 case SSL_CTRL_SESS_MISSES:
1873 return (ctx->stats.sess_miss);
1874 case SSL_CTRL_SESS_TIMEOUTS:
1875 return (ctx->stats.sess_timeout);
1876 case SSL_CTRL_SESS_CACHE_FULL:
1877 return (ctx->stats.sess_cache_full);
1879 return (ctx->mode |= larg);
1880 case SSL_CTRL_CLEAR_MODE:
1881 return (ctx->mode &= ~larg);
1882 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1883 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1885 ctx->max_send_fragment = larg;
1886 if (ctx->max_send_fragment < ctx->split_send_fragment)
1887 ctx->split_send_fragment = ctx->max_send_fragment;
1889 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1890 if ((unsigned int)larg > ctx->max_send_fragment || larg == 0)
1892 ctx->split_send_fragment = larg;
1894 case SSL_CTRL_SET_MAX_PIPELINES:
1895 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1897 ctx->max_pipelines = larg;
1899 case SSL_CTRL_CERT_FLAGS:
1900 return (ctx->cert->cert_flags |= larg);
1901 case SSL_CTRL_CLEAR_CERT_FLAGS:
1902 return (ctx->cert->cert_flags &= ~larg);
1903 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1904 return ssl_set_version_bound(ctx->method->version, (int)larg,
1905 &ctx->min_proto_version);
1906 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1907 return ssl_set_version_bound(ctx->method->version, (int)larg,
1908 &ctx->max_proto_version);
1910 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
1914 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
1917 case SSL_CTRL_SET_MSG_CALLBACK:
1918 ctx->msg_callback = (void (*)
1919 (int write_p, int version, int content_type,
1920 const void *buf, size_t len, SSL *ssl,
1925 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
1929 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
1938 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
1939 const SSL_CIPHER *const *bp)
1941 if ((*ap)->id > (*bp)->id)
1943 if ((*ap)->id < (*bp)->id)
1948 /** return a STACK of the ciphers available for the SSL and in order of
1950 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
1953 if (s->cipher_list != NULL) {
1954 return (s->cipher_list);
1955 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
1956 return (s->ctx->cipher_list);
1962 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
1964 if ((s == NULL) || (s->session == NULL) || !s->server)
1966 return s->session->ciphers;
1969 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
1971 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
1973 ciphers = SSL_get_ciphers(s);
1976 ssl_set_client_disabled(s);
1977 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
1978 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
1979 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
1981 sk = sk_SSL_CIPHER_new_null();
1984 if (!sk_SSL_CIPHER_push(sk, c)) {
1985 sk_SSL_CIPHER_free(sk);
1993 /** return a STACK of the ciphers available for the SSL and in order of
1995 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
1998 if (s->cipher_list_by_id != NULL) {
1999 return (s->cipher_list_by_id);
2000 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2001 return (s->ctx->cipher_list_by_id);
2007 /** The old interface to get the same thing as SSL_get_ciphers() */
2008 const char *SSL_get_cipher_list(const SSL *s, int n)
2010 const SSL_CIPHER *c;
2011 STACK_OF(SSL_CIPHER) *sk;
2015 sk = SSL_get_ciphers(s);
2016 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2018 c = sk_SSL_CIPHER_value(sk, n);
2024 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2026 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2029 return ctx->cipher_list;
2033 /** specify the ciphers to be used by default by the SSL_CTX */
2034 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2036 STACK_OF(SSL_CIPHER) *sk;
2038 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2039 &ctx->cipher_list_by_id, str, ctx->cert);
2041 * ssl_create_cipher_list may return an empty stack if it was unable to
2042 * find a cipher matching the given rule string (for example if the rule
2043 * string specifies a cipher which has been disabled). This is not an
2044 * error as far as ssl_create_cipher_list is concerned, and hence
2045 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2049 else if (sk_SSL_CIPHER_num(sk) == 0) {
2050 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2056 /** specify the ciphers to be used by the SSL */
2057 int SSL_set_cipher_list(SSL *s, const char *str)
2059 STACK_OF(SSL_CIPHER) *sk;
2061 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2062 &s->cipher_list_by_id, str, s->cert);
2063 /* see comment in SSL_CTX_set_cipher_list */
2066 else if (sk_SSL_CIPHER_num(sk) == 0) {
2067 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2073 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2076 STACK_OF(SSL_CIPHER) *sk;
2077 const SSL_CIPHER *c;
2080 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2084 sk = s->session->ciphers;
2086 if (sk_SSL_CIPHER_num(sk) == 0)
2089 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2092 c = sk_SSL_CIPHER_value(sk, i);
2093 n = strlen(c->name);
2100 memcpy(p, c->name, n + 1);
2109 /** return a servername extension value if provided in Client Hello, or NULL.
2110 * So far, only host_name types are defined (RFC 3546).
2113 const char *SSL_get_servername(const SSL *s, const int type)
2115 if (type != TLSEXT_NAMETYPE_host_name)
2118 return s->session && !s->tlsext_hostname ?
2119 s->session->tlsext_hostname : s->tlsext_hostname;
2122 int SSL_get_servername_type(const SSL *s)
2125 && (!s->tlsext_hostname ? s->session->
2126 tlsext_hostname : s->tlsext_hostname))
2127 return TLSEXT_NAMETYPE_host_name;
2132 * SSL_select_next_proto implements the standard protocol selection. It is
2133 * expected that this function is called from the callback set by
2134 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2135 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2136 * not included in the length. A byte string of length 0 is invalid. No byte
2137 * string may be truncated. The current, but experimental algorithm for
2138 * selecting the protocol is: 1) If the server doesn't support NPN then this
2139 * is indicated to the callback. In this case, the client application has to
2140 * abort the connection or have a default application level protocol. 2) If
2141 * the server supports NPN, but advertises an empty list then the client
2142 * selects the first protcol in its list, but indicates via the API that this
2143 * fallback case was enacted. 3) Otherwise, the client finds the first
2144 * protocol in the server's list that it supports and selects this protocol.
2145 * This is because it's assumed that the server has better information about
2146 * which protocol a client should use. 4) If the client doesn't support any
2147 * of the server's advertised protocols, then this is treated the same as
2148 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2149 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2151 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2152 const unsigned char *server,
2153 unsigned int server_len,
2154 const unsigned char *client,
2155 unsigned int client_len)
2158 const unsigned char *result;
2159 int status = OPENSSL_NPN_UNSUPPORTED;
2162 * For each protocol in server preference order, see if we support it.
2164 for (i = 0; i < server_len;) {
2165 for (j = 0; j < client_len;) {
2166 if (server[i] == client[j] &&
2167 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2168 /* We found a match */
2169 result = &server[i];
2170 status = OPENSSL_NPN_NEGOTIATED;
2180 /* There's no overlap between our protocols and the server's list. */
2182 status = OPENSSL_NPN_NO_OVERLAP;
2185 *out = (unsigned char *)result + 1;
2186 *outlen = result[0];
2190 #ifndef OPENSSL_NO_NEXTPROTONEG
2192 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2193 * client's requested protocol for this connection and returns 0. If the
2194 * client didn't request any protocol, then *data is set to NULL. Note that
2195 * the client can request any protocol it chooses. The value returned from
2196 * this function need not be a member of the list of supported protocols
2197 * provided by the callback.
2199 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2202 *data = s->next_proto_negotiated;
2206 *len = s->next_proto_negotiated_len;
2211 * SSL_CTX_set_next_protos_advertised_cb sets a callback that is called when
2212 * a TLS server needs a list of supported protocols for Next Protocol
2213 * Negotiation. The returned list must be in wire format. The list is
2214 * returned by setting |out| to point to it and |outlen| to its length. This
2215 * memory will not be modified, but one should assume that the SSL* keeps a
2216 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2217 * wishes to advertise. Otherwise, no such extension will be included in the
2220 void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX *ctx,
2221 int (*cb) (SSL *ssl,
2224 unsigned int *outlen,
2225 void *arg), void *arg)
2227 ctx->next_protos_advertised_cb = cb;
2228 ctx->next_protos_advertised_cb_arg = arg;
2232 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2233 * client needs to select a protocol from the server's provided list. |out|
2234 * must be set to point to the selected protocol (which may be within |in|).
2235 * The length of the protocol name must be written into |outlen|. The
2236 * server's advertised protocols are provided in |in| and |inlen|. The
2237 * callback can assume that |in| is syntactically valid. The client must
2238 * select a protocol. It is fatal to the connection if this callback returns
2239 * a value other than SSL_TLSEXT_ERR_OK.
2241 void SSL_CTX_set_next_proto_select_cb(SSL_CTX *ctx,
2242 int (*cb) (SSL *s, unsigned char **out,
2243 unsigned char *outlen,
2244 const unsigned char *in,
2246 void *arg), void *arg)
2248 ctx->next_proto_select_cb = cb;
2249 ctx->next_proto_select_cb_arg = arg;
2254 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2255 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2256 * length-prefixed strings). Returns 0 on success.
2258 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2259 unsigned int protos_len)
2261 OPENSSL_free(ctx->alpn_client_proto_list);
2262 ctx->alpn_client_proto_list = OPENSSL_memdup(protos, protos_len);
2263 if (ctx->alpn_client_proto_list == NULL) {
2264 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2267 ctx->alpn_client_proto_list_len = protos_len;
2273 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2274 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2275 * length-prefixed strings). Returns 0 on success.
2277 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2278 unsigned int protos_len)
2280 OPENSSL_free(ssl->alpn_client_proto_list);
2281 ssl->alpn_client_proto_list = OPENSSL_memdup(protos, protos_len);
2282 if (ssl->alpn_client_proto_list == NULL) {
2283 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2286 ssl->alpn_client_proto_list_len = protos_len;
2292 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2293 * called during ClientHello processing in order to select an ALPN protocol
2294 * from the client's list of offered protocols.
2296 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2297 int (*cb) (SSL *ssl,
2298 const unsigned char **out,
2299 unsigned char *outlen,
2300 const unsigned char *in,
2302 void *arg), void *arg)
2304 ctx->alpn_select_cb = cb;
2305 ctx->alpn_select_cb_arg = arg;
2309 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2310 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2311 * (not including the leading length-prefix byte). If the server didn't
2312 * respond with a negotiated protocol then |*len| will be zero.
2314 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2319 *data = ssl->s3->alpn_selected;
2323 *len = ssl->s3->alpn_selected_len;
2327 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2328 const char *label, size_t llen,
2329 const unsigned char *p, size_t plen,
2332 if (s->version < TLS1_VERSION)
2335 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2340 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2345 ((unsigned int)a->session_id[0]) |
2346 ((unsigned int)a->session_id[1] << 8L) |
2347 ((unsigned long)a->session_id[2] << 16L) |
2348 ((unsigned long)a->session_id[3] << 24L);
2353 * NB: If this function (or indeed the hash function which uses a sort of
2354 * coarser function than this one) is changed, ensure
2355 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2356 * being able to construct an SSL_SESSION that will collide with any existing
2357 * session with a matching session ID.
2359 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2361 if (a->ssl_version != b->ssl_version)
2363 if (a->session_id_length != b->session_id_length)
2365 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2369 * These wrapper functions should remain rather than redeclaring
2370 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2371 * variable. The reason is that the functions aren't static, they're exposed
2375 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2377 SSL_CTX *ret = NULL;
2380 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2384 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2387 if (FIPS_mode() && (meth->version < TLS1_VERSION)) {
2388 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE);
2392 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2393 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2396 ret = OPENSSL_zalloc(sizeof(*ret));
2401 ret->min_proto_version = 0;
2402 ret->max_proto_version = 0;
2403 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2404 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2405 /* We take the system default. */
2406 ret->session_timeout = meth->get_timeout();
2407 ret->references = 1;
2408 ret->lock = CRYPTO_THREAD_lock_new();
2409 if (ret->lock == NULL) {
2410 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2414 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2415 ret->verify_mode = SSL_VERIFY_NONE;
2416 if ((ret->cert = ssl_cert_new()) == NULL)
2419 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2420 if (ret->sessions == NULL)
2422 ret->cert_store = X509_STORE_new();
2423 if (ret->cert_store == NULL)
2425 #ifndef OPENSSL_NO_CT
2426 ret->ctlog_store = CTLOG_STORE_new();
2427 if (ret->ctlog_store == NULL)
2430 if (!ssl_create_cipher_list(ret->method,
2431 &ret->cipher_list, &ret->cipher_list_by_id,
2432 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2433 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2434 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2438 ret->param = X509_VERIFY_PARAM_new();
2439 if (ret->param == NULL)
2442 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2443 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2446 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2447 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2451 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2454 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2457 /* No compression for DTLS */
2458 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2459 ret->comp_methods = SSL_COMP_get_compression_methods();
2461 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2462 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2464 /* Setup RFC4507 ticket keys */
2465 if ((RAND_bytes(ret->tlsext_tick_key_name, 16) <= 0)
2466 || (RAND_bytes(ret->tlsext_tick_hmac_key, 16) <= 0)
2467 || (RAND_bytes(ret->tlsext_tick_aes_key, 16) <= 0))
2468 ret->options |= SSL_OP_NO_TICKET;
2470 #ifndef OPENSSL_NO_SRP
2471 if (!SSL_CTX_SRP_CTX_init(ret))
2474 #ifndef OPENSSL_NO_ENGINE
2475 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2476 # define eng_strx(x) #x
2477 # define eng_str(x) eng_strx(x)
2478 /* Use specific client engine automatically... ignore errors */
2481 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2484 ENGINE_load_builtin_engines();
2485 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2487 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2493 * Default is to connect to non-RI servers. When RI is more widely
2494 * deployed might change this.
2496 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2498 * Disable compression by default to prevent CRIME. Applications can
2499 * re-enable compression by configuring
2500 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2501 * or by using the SSL_CONF library.
2503 ret->options |= SSL_OP_NO_COMPRESSION;
2505 ret->tlsext_status_type = -1;
2509 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2515 int SSL_CTX_up_ref(SSL_CTX *ctx)
2519 if (CRYPTO_atomic_add(&ctx->references, 1, &i, ctx->lock) <= 0)
2522 REF_PRINT_COUNT("SSL_CTX", ctx);
2523 REF_ASSERT_ISNT(i < 2);
2524 return ((i > 1) ? 1 : 0);
2527 void SSL_CTX_free(SSL_CTX *a)
2534 CRYPTO_atomic_add(&a->references, -1, &i, a->lock);
2535 REF_PRINT_COUNT("SSL_CTX", a);
2538 REF_ASSERT_ISNT(i < 0);
2540 X509_VERIFY_PARAM_free(a->param);
2541 dane_ctx_final(&a->dane);
2544 * Free internal session cache. However: the remove_cb() may reference
2545 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2546 * after the sessions were flushed.
2547 * As the ex_data handling routines might also touch the session cache,
2548 * the most secure solution seems to be: empty (flush) the cache, then
2549 * free ex_data, then finally free the cache.
2550 * (See ticket [openssl.org #212].)
2552 if (a->sessions != NULL)
2553 SSL_CTX_flush_sessions(a, 0);
2555 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2556 lh_SSL_SESSION_free(a->sessions);
2557 X509_STORE_free(a->cert_store);
2558 #ifndef OPENSSL_NO_CT
2559 CTLOG_STORE_free(a->ctlog_store);
2561 sk_SSL_CIPHER_free(a->cipher_list);
2562 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2563 ssl_cert_free(a->cert);
2564 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2565 sk_X509_pop_free(a->extra_certs, X509_free);
2566 a->comp_methods = NULL;
2567 #ifndef OPENSSL_NO_SRTP
2568 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2570 #ifndef OPENSSL_NO_SRP
2571 SSL_CTX_SRP_CTX_free(a);
2573 #ifndef OPENSSL_NO_ENGINE
2574 ENGINE_finish(a->client_cert_engine);
2577 #ifndef OPENSSL_NO_EC
2578 OPENSSL_free(a->tlsext_ecpointformatlist);
2579 OPENSSL_free(a->tlsext_ellipticcurvelist);
2581 OPENSSL_free(a->alpn_client_proto_list);
2583 CRYPTO_THREAD_lock_free(a->lock);
2588 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2590 ctx->default_passwd_callback = cb;
2593 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2595 ctx->default_passwd_callback_userdata = u;
2598 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2600 return ctx->default_passwd_callback;
2603 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2605 return ctx->default_passwd_callback_userdata;
2608 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2610 s->default_passwd_callback = cb;
2613 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2615 s->default_passwd_callback_userdata = u;
2618 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2620 return s->default_passwd_callback;
2623 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2625 return s->default_passwd_callback_userdata;
2628 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2629 int (*cb) (X509_STORE_CTX *, void *),
2632 ctx->app_verify_callback = cb;
2633 ctx->app_verify_arg = arg;
2636 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2637 int (*cb) (int, X509_STORE_CTX *))
2639 ctx->verify_mode = mode;
2640 ctx->default_verify_callback = cb;
2643 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2645 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2648 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg),
2651 ssl_cert_set_cert_cb(c->cert, cb, arg);
2654 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2656 ssl_cert_set_cert_cb(s->cert, cb, arg);
2659 void ssl_set_masks(SSL *s)
2661 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_GOST)
2665 uint32_t *pvalid = s->s3->tmp.valid_flags;
2666 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2667 unsigned long mask_k, mask_a;
2668 #ifndef OPENSSL_NO_EC
2669 int have_ecc_cert, ecdsa_ok;
2675 #ifndef OPENSSL_NO_DH
2676 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2681 rsa_enc = pvalid[SSL_PKEY_RSA_ENC] & CERT_PKEY_VALID;
2682 rsa_sign = pvalid[SSL_PKEY_RSA_SIGN] & CERT_PKEY_SIGN;
2683 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_SIGN;
2684 #ifndef OPENSSL_NO_EC
2685 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2691 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2692 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2695 #ifndef OPENSSL_NO_GOST
2696 cpk = &(c->pkeys[SSL_PKEY_GOST12_512]);
2697 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2698 mask_k |= SSL_kGOST;
2699 mask_a |= SSL_aGOST12;
2701 cpk = &(c->pkeys[SSL_PKEY_GOST12_256]);
2702 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2703 mask_k |= SSL_kGOST;
2704 mask_a |= SSL_aGOST12;
2706 cpk = &(c->pkeys[SSL_PKEY_GOST01]);
2707 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2708 mask_k |= SSL_kGOST;
2709 mask_a |= SSL_aGOST01;
2719 if (rsa_enc || rsa_sign) {
2727 mask_a |= SSL_aNULL;
2730 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2731 * depending on the key usage extension.
2733 #ifndef OPENSSL_NO_EC
2734 if (have_ecc_cert) {
2736 cpk = &c->pkeys[SSL_PKEY_ECC];
2738 ex_kusage = X509_get_key_usage(x);
2739 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2740 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2743 mask_a |= SSL_aECDSA;
2747 #ifndef OPENSSL_NO_EC
2748 mask_k |= SSL_kECDHE;
2751 #ifndef OPENSSL_NO_PSK
2754 if (mask_k & SSL_kRSA)
2755 mask_k |= SSL_kRSAPSK;
2756 if (mask_k & SSL_kDHE)
2757 mask_k |= SSL_kDHEPSK;
2758 if (mask_k & SSL_kECDHE)
2759 mask_k |= SSL_kECDHEPSK;
2762 s->s3->tmp.mask_k = mask_k;
2763 s->s3->tmp.mask_a = mask_a;
2766 #ifndef OPENSSL_NO_EC
2768 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
2770 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
2771 /* key usage, if present, must allow signing */
2772 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
2773 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
2774 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
2778 return 1; /* all checks are ok */
2783 static int ssl_get_server_cert_index(const SSL *s)
2786 idx = ssl_cipher_get_cert_index(s->s3->tmp.new_cipher);
2787 if (idx == SSL_PKEY_RSA_ENC && !s->cert->pkeys[SSL_PKEY_RSA_ENC].x509)
2788 idx = SSL_PKEY_RSA_SIGN;
2789 if (idx == SSL_PKEY_GOST_EC) {
2790 if (s->cert->pkeys[SSL_PKEY_GOST12_512].x509)
2791 idx = SSL_PKEY_GOST12_512;
2792 else if (s->cert->pkeys[SSL_PKEY_GOST12_256].x509)
2793 idx = SSL_PKEY_GOST12_256;
2794 else if (s->cert->pkeys[SSL_PKEY_GOST01].x509)
2795 idx = SSL_PKEY_GOST01;
2800 SSLerr(SSL_F_SSL_GET_SERVER_CERT_INDEX, ERR_R_INTERNAL_ERROR);
2804 CERT_PKEY *ssl_get_server_send_pkey(SSL *s)
2810 if (!s->s3 || !s->s3->tmp.new_cipher)
2814 i = ssl_get_server_cert_index(s);
2816 /* This may or may not be an error. */
2821 return &c->pkeys[i];
2824 EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *cipher,
2827 unsigned long alg_a;
2831 alg_a = cipher->algorithm_auth;
2834 if ((alg_a & SSL_aDSS) &&
2835 (c->pkeys[SSL_PKEY_DSA_SIGN].privatekey != NULL))
2836 idx = SSL_PKEY_DSA_SIGN;
2837 else if (alg_a & SSL_aRSA) {
2838 if (c->pkeys[SSL_PKEY_RSA_SIGN].privatekey != NULL)
2839 idx = SSL_PKEY_RSA_SIGN;
2840 else if (c->pkeys[SSL_PKEY_RSA_ENC].privatekey != NULL)
2841 idx = SSL_PKEY_RSA_ENC;
2842 } else if ((alg_a & SSL_aECDSA) &&
2843 (c->pkeys[SSL_PKEY_ECC].privatekey != NULL))
2846 SSLerr(SSL_F_SSL_GET_SIGN_PKEY, ERR_R_INTERNAL_ERROR);
2850 *pmd = s->s3->tmp.md[idx];
2851 return c->pkeys[idx].privatekey;
2854 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
2855 size_t *serverinfo_length)
2859 *serverinfo_length = 0;
2862 i = ssl_get_server_cert_index(s);
2866 if (c->pkeys[i].serverinfo == NULL)
2869 *serverinfo = c->pkeys[i].serverinfo;
2870 *serverinfo_length = c->pkeys[i].serverinfo_length;
2874 void ssl_update_cache(SSL *s, int mode)
2879 * If the session_id_length is 0, we are not supposed to cache it, and it
2880 * would be rather hard to do anyway :-)
2882 if (s->session->session_id_length == 0)
2885 i = s->session_ctx->session_cache_mode;
2886 if ((i & mode) && (!s->hit)
2887 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
2888 || SSL_CTX_add_session(s->session_ctx, s->session))
2889 && (s->session_ctx->new_session_cb != NULL)) {
2890 SSL_SESSION_up_ref(s->session);
2891 if (!s->session_ctx->new_session_cb(s, s->session))
2892 SSL_SESSION_free(s->session);
2895 /* auto flush every 255 connections */
2896 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
2897 if ((((mode & SSL_SESS_CACHE_CLIENT)
2898 ? s->session_ctx->stats.sess_connect_good
2899 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
2900 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
2905 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
2910 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
2915 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
2919 if (s->method != meth) {
2920 const SSL_METHOD *sm = s->method;
2921 int (*hf)(SSL *) = s->handshake_func;
2923 if (sm->version == meth->version)
2928 ret = s->method->ssl_new(s);
2931 if (hf == sm->ssl_connect)
2932 s->handshake_func = meth->ssl_connect;
2933 else if (hf == sm->ssl_accept)
2934 s->handshake_func = meth->ssl_accept;
2939 int SSL_get_error(const SSL *s, int i)
2946 return (SSL_ERROR_NONE);
2949 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
2950 * where we do encode the error
2952 if ((l = ERR_peek_error()) != 0) {
2953 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
2954 return (SSL_ERROR_SYSCALL);
2956 return (SSL_ERROR_SSL);
2960 if (SSL_want_read(s)) {
2961 bio = SSL_get_rbio(s);
2962 if (BIO_should_read(bio))
2963 return (SSL_ERROR_WANT_READ);
2964 else if (BIO_should_write(bio))
2966 * This one doesn't make too much sense ... We never try to write
2967 * to the rbio, and an application program where rbio and wbio
2968 * are separate couldn't even know what it should wait for.
2969 * However if we ever set s->rwstate incorrectly (so that we have
2970 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
2971 * wbio *are* the same, this test works around that bug; so it
2972 * might be safer to keep it.
2974 return (SSL_ERROR_WANT_WRITE);
2975 else if (BIO_should_io_special(bio)) {
2976 reason = BIO_get_retry_reason(bio);
2977 if (reason == BIO_RR_CONNECT)
2978 return (SSL_ERROR_WANT_CONNECT);
2979 else if (reason == BIO_RR_ACCEPT)
2980 return (SSL_ERROR_WANT_ACCEPT);
2982 return (SSL_ERROR_SYSCALL); /* unknown */
2986 if (SSL_want_write(s)) {
2987 bio = SSL_get_wbio(s);
2988 if (BIO_should_write(bio))
2989 return (SSL_ERROR_WANT_WRITE);
2990 else if (BIO_should_read(bio))
2992 * See above (SSL_want_read(s) with BIO_should_write(bio))
2994 return (SSL_ERROR_WANT_READ);
2995 else if (BIO_should_io_special(bio)) {
2996 reason = BIO_get_retry_reason(bio);
2997 if (reason == BIO_RR_CONNECT)
2998 return (SSL_ERROR_WANT_CONNECT);
2999 else if (reason == BIO_RR_ACCEPT)
3000 return (SSL_ERROR_WANT_ACCEPT);
3002 return (SSL_ERROR_SYSCALL);
3005 if (SSL_want_x509_lookup(s)) {
3006 return (SSL_ERROR_WANT_X509_LOOKUP);
3008 if (SSL_want_async(s)) {
3009 return SSL_ERROR_WANT_ASYNC;
3011 if (SSL_want_async_job(s)) {
3012 return SSL_ERROR_WANT_ASYNC_JOB;
3017 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3018 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3019 return (SSL_ERROR_ZERO_RETURN);
3021 return (SSL_ERROR_SYSCALL);
3024 static int ssl_do_handshake_intern(void *vargs)
3026 struct ssl_async_args *args;
3029 args = (struct ssl_async_args *)vargs;
3032 return s->handshake_func(s);
3035 int SSL_do_handshake(SSL *s)
3039 if (s->handshake_func == NULL) {
3040 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3044 s->method->ssl_renegotiate_check(s);
3046 if (SSL_in_init(s) || SSL_in_before(s)) {
3047 if((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3048 struct ssl_async_args args;
3052 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3054 ret = s->handshake_func(s);
3060 void SSL_set_accept_state(SSL *s)
3064 ossl_statem_clear(s);
3065 s->handshake_func = s->method->ssl_accept;
3069 void SSL_set_connect_state(SSL *s)
3073 ossl_statem_clear(s);
3074 s->handshake_func = s->method->ssl_connect;
3078 int ssl_undefined_function(SSL *s)
3080 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3084 int ssl_undefined_void_function(void)
3086 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3087 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3091 int ssl_undefined_const_function(const SSL *s)
3096 const SSL_METHOD *ssl_bad_method(int ver)
3098 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3102 const char *ssl_protocol_to_string(int version)
3104 if (version == TLS1_2_VERSION)
3106 else if (version == TLS1_1_VERSION)
3108 else if (version == TLS1_VERSION)
3110 else if (version == SSL3_VERSION)
3112 else if (version == DTLS1_BAD_VER)
3114 else if (version == DTLS1_VERSION)
3116 else if (version == DTLS1_2_VERSION)
3122 const char *SSL_get_version(const SSL *s)
3124 return ssl_protocol_to_string(s->version);
3127 SSL *SSL_dup(SSL *s)
3129 STACK_OF(X509_NAME) *sk;
3134 /* If we're not quiescent, just up_ref! */
3135 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3136 CRYPTO_atomic_add(&s->references, 1, &i, s->lock);
3141 * Otherwise, copy configuration state, and session if set.
3143 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3146 if (s->session != NULL) {
3148 * Arranges to share the same session via up_ref. This "copies"
3149 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3151 if (!SSL_copy_session_id(ret, s))
3155 * No session has been established yet, so we have to expect that
3156 * s->cert or ret->cert will be changed later -- they should not both
3157 * point to the same object, and thus we can't use
3158 * SSL_copy_session_id.
3160 if (!SSL_set_ssl_method(ret, s->method))
3163 if (s->cert != NULL) {
3164 ssl_cert_free(ret->cert);
3165 ret->cert = ssl_cert_dup(s->cert);
3166 if (ret->cert == NULL)
3170 if (!SSL_set_session_id_context(ret, s->sid_ctx, s->sid_ctx_length))
3174 if (!ssl_dane_dup(ret, s))
3176 ret->version = s->version;
3177 ret->options = s->options;
3178 ret->mode = s->mode;
3179 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3180 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3181 ret->msg_callback = s->msg_callback;
3182 ret->msg_callback_arg = s->msg_callback_arg;
3183 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3184 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3185 ret->generate_session_id = s->generate_session_id;
3187 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3189 /* copy app data, a little dangerous perhaps */
3190 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3193 /* setup rbio, and wbio */
3194 if (s->rbio != NULL) {
3195 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3198 if (s->wbio != NULL) {
3199 if (s->wbio != s->rbio) {
3200 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3203 ret->wbio = ret->rbio;
3206 ret->server = s->server;
3207 if (s->handshake_func) {
3209 SSL_set_accept_state(ret);
3211 SSL_set_connect_state(ret);
3213 ret->shutdown = s->shutdown;
3216 ret->default_passwd_callback = s->default_passwd_callback;
3217 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3219 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3221 /* dup the cipher_list and cipher_list_by_id stacks */
3222 if (s->cipher_list != NULL) {
3223 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3226 if (s->cipher_list_by_id != NULL)
3227 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3231 /* Dup the client_CA list */
3232 if (s->client_CA != NULL) {
3233 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3235 ret->client_CA = sk;
3236 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3237 xn = sk_X509_NAME_value(sk, i);
3238 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3251 void ssl_clear_cipher_ctx(SSL *s)
3253 if (s->enc_read_ctx != NULL) {
3254 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3255 s->enc_read_ctx = NULL;
3257 if (s->enc_write_ctx != NULL) {
3258 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3259 s->enc_write_ctx = NULL;
3261 #ifndef OPENSSL_NO_COMP
3262 COMP_CTX_free(s->expand);
3264 COMP_CTX_free(s->compress);
3269 X509 *SSL_get_certificate(const SSL *s)
3271 if (s->cert != NULL)
3272 return (s->cert->key->x509);
3277 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3279 if (s->cert != NULL)
3280 return (s->cert->key->privatekey);
3285 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3287 if (ctx->cert != NULL)
3288 return ctx->cert->key->x509;
3293 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3295 if (ctx->cert != NULL)
3296 return ctx->cert->key->privatekey;
3301 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3303 if ((s->session != NULL) && (s->session->cipher != NULL))
3304 return (s->session->cipher);
3308 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3310 #ifndef OPENSSL_NO_COMP
3311 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3317 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3319 #ifndef OPENSSL_NO_COMP
3320 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3326 int ssl_init_wbio_buffer(SSL *s, int push)
3330 if (s->bbio == NULL) {
3331 bbio = BIO_new(BIO_f_buffer());
3337 if (s->bbio == s->wbio)
3338 s->wbio = BIO_pop(s->wbio);
3340 (void)BIO_reset(bbio);
3341 /* if (!BIO_set_write_buffer_size(bbio,16*1024)) */
3342 if (!BIO_set_read_buffer_size(bbio, 1)) {
3343 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3347 if (s->wbio != bbio)
3348 s->wbio = BIO_push(bbio, s->wbio);
3350 if (s->wbio == bbio)
3351 s->wbio = BIO_pop(bbio);
3356 void ssl_free_wbio_buffer(SSL *s)
3358 /* callers ensure s is never null */
3359 if (s->bbio == NULL)
3362 if (s->bbio == s->wbio) {
3363 /* remove buffering */
3364 s->wbio = BIO_pop(s->wbio);
3365 assert(s->wbio != NULL);
3371 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3373 ctx->quiet_shutdown = mode;
3376 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3378 return (ctx->quiet_shutdown);
3381 void SSL_set_quiet_shutdown(SSL *s, int mode)
3383 s->quiet_shutdown = mode;
3386 int SSL_get_quiet_shutdown(const SSL *s)
3388 return (s->quiet_shutdown);
3391 void SSL_set_shutdown(SSL *s, int mode)
3396 int SSL_get_shutdown(const SSL *s)
3398 return (s->shutdown);
3401 int SSL_version(const SSL *s)
3403 return (s->version);
3406 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3411 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3414 if (ssl->ctx == ctx)
3417 ctx = ssl->initial_ctx;
3418 new_cert = ssl_cert_dup(ctx->cert);
3419 if (new_cert == NULL) {
3422 ssl_cert_free(ssl->cert);
3423 ssl->cert = new_cert;
3426 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3427 * so setter APIs must prevent invalid lengths from entering the system.
3429 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3432 * If the session ID context matches that of the parent SSL_CTX,
3433 * inherit it from the new SSL_CTX as well. If however the context does
3434 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3435 * leave it unchanged.
3437 if ((ssl->ctx != NULL) &&
3438 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3439 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3440 ssl->sid_ctx_length = ctx->sid_ctx_length;
3441 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3444 SSL_CTX_up_ref(ctx);
3445 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3451 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3453 return (X509_STORE_set_default_paths(ctx->cert_store));
3456 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3458 X509_LOOKUP *lookup;
3460 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3463 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3465 /* Clear any errors if the default directory does not exist */
3471 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3473 X509_LOOKUP *lookup;
3475 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3479 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3481 /* Clear any errors if the default file does not exist */
3487 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3490 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3493 void SSL_set_info_callback(SSL *ssl,
3494 void (*cb) (const SSL *ssl, int type, int val))
3496 ssl->info_callback = cb;
3500 * One compiler (Diab DCC) doesn't like argument names in returned function
3503 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3506 return ssl->info_callback;
3509 void SSL_set_verify_result(SSL *ssl, long arg)
3511 ssl->verify_result = arg;
3514 long SSL_get_verify_result(const SSL *ssl)
3516 return (ssl->verify_result);
3519 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3522 return sizeof(ssl->s3->client_random);
3523 if (outlen > sizeof(ssl->s3->client_random))
3524 outlen = sizeof(ssl->s3->client_random);
3525 memcpy(out, ssl->s3->client_random, outlen);
3529 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3532 return sizeof(ssl->s3->server_random);
3533 if (outlen > sizeof(ssl->s3->server_random))
3534 outlen = sizeof(ssl->s3->server_random);
3535 memcpy(out, ssl->s3->server_random, outlen);
3539 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3540 unsigned char *out, size_t outlen)
3542 if (session->master_key_length < 0) {
3543 /* Should never happen */
3547 return session->master_key_length;
3548 if (outlen > (size_t)session->master_key_length)
3549 outlen = session->master_key_length;
3550 memcpy(out, session->master_key, outlen);
3554 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3556 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3559 void *SSL_get_ex_data(const SSL *s, int idx)
3561 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3564 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3566 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3569 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3571 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3579 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3581 return (ctx->cert_store);
3584 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3586 X509_STORE_free(ctx->cert_store);
3587 ctx->cert_store = store;
3590 int SSL_want(const SSL *s)
3592 return (s->rwstate);
3596 * \brief Set the callback for generating temporary DH keys.
3597 * \param ctx the SSL context.
3598 * \param dh the callback
3601 #ifndef OPENSSL_NO_DH
3602 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3603 DH *(*dh) (SSL *ssl, int is_export,
3606 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3609 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3612 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3616 #ifndef OPENSSL_NO_PSK
3617 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3619 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3620 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT,
3621 SSL_R_DATA_LENGTH_TOO_LONG);
3624 OPENSSL_free(ctx->cert->psk_identity_hint);
3625 if (identity_hint != NULL) {
3626 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3627 if (ctx->cert->psk_identity_hint == NULL)
3630 ctx->cert->psk_identity_hint = NULL;
3634 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3639 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3640 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3643 OPENSSL_free(s->cert->psk_identity_hint);
3644 if (identity_hint != NULL) {
3645 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3646 if (s->cert->psk_identity_hint == NULL)
3649 s->cert->psk_identity_hint = NULL;
3653 const char *SSL_get_psk_identity_hint(const SSL *s)
3655 if (s == NULL || s->session == NULL)
3657 return (s->session->psk_identity_hint);
3660 const char *SSL_get_psk_identity(const SSL *s)
3662 if (s == NULL || s->session == NULL)
3664 return (s->session->psk_identity);
3667 void SSL_set_psk_client_callback(SSL *s,
3668 unsigned int (*cb) (SSL *ssl,
3677 s->psk_client_callback = cb;
3680 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx,
3681 unsigned int (*cb) (SSL *ssl,
3690 ctx->psk_client_callback = cb;
3693 void SSL_set_psk_server_callback(SSL *s,
3694 unsigned int (*cb) (SSL *ssl,
3695 const char *identity,
3700 s->psk_server_callback = cb;
3703 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx,
3704 unsigned int (*cb) (SSL *ssl,
3705 const char *identity,
3710 ctx->psk_server_callback = cb;
3714 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3715 void (*cb) (int write_p, int version,
3716 int content_type, const void *buf,
3717 size_t len, SSL *ssl, void *arg))
3719 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3722 void SSL_set_msg_callback(SSL *ssl,
3723 void (*cb) (int write_p, int version,
3724 int content_type, const void *buf,
3725 size_t len, SSL *ssl, void *arg))
3727 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3730 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3731 int (*cb) (SSL *ssl,
3735 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3736 (void (*)(void))cb);
3739 void SSL_set_not_resumable_session_callback(SSL *ssl,
3740 int (*cb) (SSL *ssl,
3741 int is_forward_secure))
3743 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3744 (void (*)(void))cb);
3748 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3749 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3750 * If EVP_MD pointer is passed, initializes ctx with this md Returns newly
3754 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3756 ssl_clear_hash_ctx(hash);
3757 *hash = EVP_MD_CTX_new();
3758 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3759 EVP_MD_CTX_free(*hash);
3766 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3770 EVP_MD_CTX_free(*hash);
3774 /* Retrieve handshake hashes */
3775 int ssl_handshake_hash(SSL *s, unsigned char *out, int outlen)
3777 EVP_MD_CTX *ctx = NULL;
3778 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3779 int ret = EVP_MD_CTX_size(hdgst);
3780 if (ret < 0 || ret > outlen) {
3784 ctx = EVP_MD_CTX_new();
3789 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3790 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3793 EVP_MD_CTX_free(ctx);
3797 int SSL_session_reused(SSL *s)
3802 int SSL_is_server(SSL *s)
3807 #if OPENSSL_API_COMPAT < 0x10100000L
3808 void SSL_set_debug(SSL *s, int debug)
3810 /* Old function was do-nothing anyway... */
3817 void SSL_set_security_level(SSL *s, int level)
3819 s->cert->sec_level = level;
3822 int SSL_get_security_level(const SSL *s)
3824 return s->cert->sec_level;
3827 void SSL_set_security_callback(SSL *s,
3828 int (*cb) (const SSL *s, const SSL_CTX *ctx, int op,
3829 int bits, int nid, void *other,
3832 s->cert->sec_cb = cb;
3835 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s, const SSL_CTX *ctx, int op,
3837 void *other, void *ex) {
3838 return s->cert->sec_cb;
3841 void SSL_set0_security_ex_data(SSL *s, void *ex)
3843 s->cert->sec_ex = ex;
3846 void *SSL_get0_security_ex_data(const SSL *s)
3848 return s->cert->sec_ex;
3851 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
3853 ctx->cert->sec_level = level;
3856 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
3858 return ctx->cert->sec_level;
3861 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
3862 int (*cb) (const SSL *s, const SSL_CTX *ctx, int op,
3863 int bits, int nid, void *other,
3866 ctx->cert->sec_cb = cb;
3869 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
3875 return ctx->cert->sec_cb;
3878 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
3880 ctx->cert->sec_ex = ex;
3883 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
3885 return ctx->cert->sec_ex;
3890 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3891 * can return unsigned long, instead of the generic long return value from the
3892 * control interface.
3894 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
3896 return ctx->options;
3898 unsigned long SSL_get_options(const SSL* s)
3902 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
3904 return ctx->options |= op;
3906 unsigned long SSL_set_options(SSL *s, unsigned long op)
3908 return s->options |= op;
3910 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
3912 return ctx->options &= ~op;
3914 unsigned long SSL_clear_options(SSL *s, unsigned long op)
3916 return s->options &= ~op;
3919 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
3921 return s->verified_chain;
3924 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
3926 #ifndef OPENSSL_NO_CT
3929 * Moves SCTs from the |src| stack to the |dst| stack.
3930 * The source of each SCT will be set to |origin|.
3931 * If |dst| points to a NULL pointer, a new stack will be created and owned by
3933 * Returns the number of SCTs moved, or a negative integer if an error occurs.
3935 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src, sct_source_t origin)
3941 *dst = sk_SCT_new_null();
3943 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
3948 while ((sct = sk_SCT_pop(src)) != NULL) {
3949 if (SCT_set_source(sct, origin) != 1)
3952 if (sk_SCT_push(*dst, sct) <= 0)
3960 sk_SCT_push(src, sct); /* Put the SCT back */
3965 * Look for data collected during ServerHello and parse if found.
3966 * Return 1 on success, 0 on failure.
3968 static int ct_extract_tls_extension_scts(SSL *s)
3970 int scts_extracted = 0;
3972 if (s->tlsext_scts != NULL) {
3973 const unsigned char *p = s->tlsext_scts;
3974 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->tlsext_scts_len);
3976 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
3978 SCT_LIST_free(scts);
3981 return scts_extracted;
3985 * Checks for an OCSP response and then attempts to extract any SCTs found if it
3986 * contains an SCT X509 extension. They will be stored in |s->scts|.
3988 * - The number of SCTs extracted, assuming an OCSP response exists.
3989 * - 0 if no OCSP response exists or it contains no SCTs.
3990 * - A negative integer if an error occurs.
3992 static int ct_extract_ocsp_response_scts(SSL *s)
3994 #ifndef OPENSSL_NO_OCSP
3995 int scts_extracted = 0;
3996 const unsigned char *p;
3997 OCSP_BASICRESP *br = NULL;
3998 OCSP_RESPONSE *rsp = NULL;
3999 STACK_OF(SCT) *scts = NULL;
4002 if (s->tlsext_ocsp_resp == NULL || s->tlsext_ocsp_resplen == 0)
4005 p = s->tlsext_ocsp_resp;
4006 rsp = d2i_OCSP_RESPONSE(NULL, &p, s->tlsext_ocsp_resplen);
4010 br = OCSP_response_get1_basic(rsp);
4014 for (i = 0; i < OCSP_resp_count(br); ++i) {
4015 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4020 scts = OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4021 scts_extracted = ct_move_scts(&s->scts, scts,
4022 SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4023 if (scts_extracted < 0)
4027 SCT_LIST_free(scts);
4028 OCSP_BASICRESP_free(br);
4029 OCSP_RESPONSE_free(rsp);
4030 return scts_extracted;
4032 /* Behave as if no OCSP response exists */
4038 * Attempts to extract SCTs from the peer certificate.
4039 * Return the number of SCTs extracted, or a negative integer if an error
4042 static int ct_extract_x509v3_extension_scts(SSL *s)
4044 int scts_extracted = 0;
4045 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4048 STACK_OF(SCT) *scts =
4049 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4052 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4054 SCT_LIST_free(scts);
4057 return scts_extracted;
4061 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4062 * response (if it exists) and X509v3 extensions in the certificate.
4063 * Returns NULL if an error occurs.
4065 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4067 if (!s->scts_parsed) {
4068 if (ct_extract_tls_extension_scts(s) < 0 ||
4069 ct_extract_ocsp_response_scts(s) < 0 ||
4070 ct_extract_x509v3_extension_scts(s) < 0)
4080 static int ct_permissive(const CT_POLICY_EVAL_CTX *ctx,
4081 const STACK_OF(SCT) *scts, void *unused_arg)
4086 static int ct_strict(const CT_POLICY_EVAL_CTX *ctx,
4087 const STACK_OF(SCT) *scts, void *unused_arg)
4089 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4092 for (i = 0; i < count; ++i) {
4093 SCT *sct = sk_SCT_value(scts, i);
4094 int status = SCT_get_validation_status(sct);
4096 if (status == SCT_VALIDATION_STATUS_VALID)
4099 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4103 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4107 * Since code exists that uses the custom extension handler for CT, look
4108 * for this and throw an error if they have already registered to use CT.
4110 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4111 TLSEXT_TYPE_signed_certificate_timestamp)) {
4112 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4113 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4117 if (callback != NULL) {
4118 /* If we are validating CT, then we MUST accept SCTs served via OCSP */
4119 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4123 s->ct_validation_callback = callback;
4124 s->ct_validation_callback_arg = arg;
4129 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4130 ssl_ct_validation_cb callback,
4134 * Since code exists that uses the custom extension handler for CT, look for
4135 * this and throw an error if they have already registered to use CT.
4137 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4138 TLSEXT_TYPE_signed_certificate_timestamp)) {
4139 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4140 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4144 ctx->ct_validation_callback = callback;
4145 ctx->ct_validation_callback_arg = arg;
4149 int SSL_ct_is_enabled(const SSL *s)
4151 return s->ct_validation_callback != NULL;
4154 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4156 return ctx->ct_validation_callback != NULL;
4159 int ssl_validate_ct(SSL *s)
4162 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4164 SSL_DANE *dane = &s->dane;
4165 CT_POLICY_EVAL_CTX *ctx = NULL;
4166 const STACK_OF(SCT) *scts;
4169 * If no callback is set, the peer is anonymous, or its chain is invalid,
4170 * skip SCT validation - just return success. Applications that continue
4171 * handshakes without certificates, with unverified chains, or pinned leaf
4172 * certificates are outside the scope of the WebPKI and CT.
4174 * The above exclusions notwithstanding the vast majority of peers will
4175 * have rather ordinary certificate chains validated by typical
4176 * applications that perform certificate verification and therefore will
4177 * process SCTs when enabled.
4179 if (s->ct_validation_callback == NULL || cert == NULL ||
4180 s->verify_result != X509_V_OK ||
4181 s->verified_chain == NULL ||
4182 sk_X509_num(s->verified_chain) <= 1)
4186 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4187 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4189 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4190 switch (dane->mtlsa->usage) {
4191 case DANETLS_USAGE_DANE_TA:
4192 case DANETLS_USAGE_DANE_EE:
4197 ctx = CT_POLICY_EVAL_CTX_new();
4199 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4203 issuer = sk_X509_value(s->verified_chain, 1);
4204 CT_POLICY_EVAL_CTX_set0_cert(ctx, cert);
4205 CT_POLICY_EVAL_CTX_set0_issuer(ctx, issuer);
4206 CT_POLICY_EVAL_CTX_set0_log_store(ctx, s->ctx->ctlog_store);
4208 scts = SSL_get0_peer_scts(s);
4211 * This function returns success (> 0) only when all the SCTs are valid, 0
4212 * when some are invalid, and < 0 on various internal errors (out of
4213 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4214 * reason to abort the handshake, that decision is up to the callback.
4215 * Therefore, we error out only in the unexpected case that the return
4216 * value is negative.
4218 * XXX: One might well argue that the return value of this function is an
4219 * unforunate design choice. Its job is only to determine the validation
4220 * status of each of the provided SCTs. So long as it correctly separates
4221 * the wheat from the chaff it should return success. Failure in this case
4222 * ought to correspond to an inability to carry out its duties.
4224 if (SCT_LIST_validate(scts, ctx) < 0) {
4225 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4229 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4231 ret = 0; /* This function returns 0 on failure */
4234 CT_POLICY_EVAL_CTX_free(ctx);
4238 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4240 switch (validation_mode) {
4242 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4244 case SSL_CT_VALIDATION_PERMISSIVE:
4245 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4246 case SSL_CT_VALIDATION_STRICT:
4247 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4251 int SSL_enable_ct(SSL *s, int validation_mode)
4253 switch (validation_mode) {
4255 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4257 case SSL_CT_VALIDATION_PERMISSIVE:
4258 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4259 case SSL_CT_VALIDATION_STRICT:
4260 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4264 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4266 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4269 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4271 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4274 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE *logs)
4276 CTLOG_STORE_free(ctx->ctlog_store);
4277 ctx->ctlog_store = logs;
4280 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4282 return ctx->ctlog_store;