2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 * ECC cipher suite support in OpenSSL originally developed by
13 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
15 /* ====================================================================
16 * Copyright 2005 Nokia. All rights reserved.
18 * The portions of the attached software ("Contribution") is developed by
19 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
22 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24 * support (see RFC 4279) to OpenSSL.
26 * No patent licenses or other rights except those expressly stated in
27 * the OpenSSL open source license shall be deemed granted or received
28 * expressly, by implication, estoppel, or otherwise.
30 * No assurances are provided by Nokia that the Contribution does not
31 * infringe the patent or other intellectual property rights of any third
32 * party or that the license provides you with all the necessary rights
33 * to make use of the Contribution.
35 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
45 #include <openssl/objects.h>
46 #include <openssl/lhash.h>
47 #include <openssl/x509v3.h>
48 #include <openssl/rand.h>
49 #include <openssl/ocsp.h>
50 #include <openssl/dh.h>
51 #include <openssl/engine.h>
52 #include <openssl/async.h>
53 #include <openssl/ct.h>
55 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
57 static int ssl_undefined_function_1(SSL *ssl, SSL3_RECORD *r, unsigned int s,
63 return ssl_undefined_function(ssl);
66 static int ssl_undefined_function_2(SSL *ssl, SSL3_RECORD *r, unsigned char *s,
72 return ssl_undefined_function(ssl);
75 static int ssl_undefined_function_3(SSL *ssl, unsigned char *r,
76 unsigned char *s, int t)
81 return ssl_undefined_function(ssl);
84 static int ssl_undefined_function_4(SSL *ssl, int r)
87 return ssl_undefined_function(ssl);
90 static int ssl_undefined_function_5(SSL *ssl, const char *r, int s,
96 return ssl_undefined_function(ssl);
99 static int ssl_undefined_function_6(int r)
102 return ssl_undefined_function(NULL);
105 static int ssl_undefined_function_7(SSL *ssl, unsigned char *r, size_t s,
106 const char *t, size_t u,
107 const unsigned char *v, size_t w, int x)
116 return ssl_undefined_function(ssl);
119 SSL3_ENC_METHOD ssl3_undef_enc_method = {
120 ssl_undefined_function_1,
121 ssl_undefined_function_2,
122 ssl_undefined_function,
123 ssl_undefined_function_3,
124 ssl_undefined_function_4,
125 ssl_undefined_function_5,
126 0, /* finish_mac_length */
127 NULL, /* client_finished_label */
128 0, /* client_finished_label_len */
129 NULL, /* server_finished_label */
130 0, /* server_finished_label_len */
131 ssl_undefined_function_6,
132 ssl_undefined_function_7,
135 struct ssl_async_args {
139 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
141 int (*func_read) (SSL *, void *, int);
142 int (*func_write) (SSL *, const void *, int);
143 int (*func_other) (SSL *);
147 static const struct {
153 DANETLS_MATCHING_FULL, 0, NID_undef
156 DANETLS_MATCHING_2256, 1, NID_sha256
159 DANETLS_MATCHING_2512, 2, NID_sha512
163 static int dane_ctx_enable(struct dane_ctx_st *dctx)
165 const EVP_MD **mdevp;
167 uint8_t mdmax = DANETLS_MATCHING_LAST;
168 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
171 if (dctx->mdevp != NULL)
174 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
175 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
177 if (mdord == NULL || mdevp == NULL) {
180 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
184 /* Install default entries */
185 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
188 if (dane_mds[i].nid == NID_undef ||
189 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
191 mdevp[dane_mds[i].mtype] = md;
192 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
202 static void dane_ctx_final(struct dane_ctx_st *dctx)
204 OPENSSL_free(dctx->mdevp);
207 OPENSSL_free(dctx->mdord);
212 static void tlsa_free(danetls_record *t)
216 OPENSSL_free(t->data);
217 EVP_PKEY_free(t->spki);
221 static void dane_final(SSL_DANE *dane)
223 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
226 sk_X509_pop_free(dane->certs, X509_free);
229 X509_free(dane->mcert);
237 * dane_copy - Copy dane configuration, sans verification state.
239 static int ssl_dane_dup(SSL *to, SSL *from)
244 if (!DANETLS_ENABLED(&from->dane))
247 dane_final(&to->dane);
248 to->dane.flags = from->dane.flags;
249 to->dane.dctx = &to->ctx->dane;
250 to->dane.trecs = sk_danetls_record_new_null();
252 if (to->dane.trecs == NULL) {
253 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
257 num = sk_danetls_record_num(from->dane.trecs);
258 for (i = 0; i < num; ++i) {
259 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
261 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
262 t->data, t->dlen) <= 0)
268 static int dane_mtype_set(struct dane_ctx_st *dctx,
269 const EVP_MD *md, uint8_t mtype, uint8_t ord)
273 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
274 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
278 if (mtype > dctx->mdmax) {
279 const EVP_MD **mdevp;
281 int n = ((int)mtype) + 1;
283 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
285 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
290 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
292 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
297 /* Zero-fill any gaps */
298 for (i = dctx->mdmax + 1; i < mtype; ++i) {
306 dctx->mdevp[mtype] = md;
307 /* Coerce ordinal of disabled matching types to 0 */
308 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
313 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
315 if (mtype > dane->dctx->mdmax)
317 return dane->dctx->mdevp[mtype];
320 static int dane_tlsa_add(SSL_DANE *dane,
323 uint8_t mtype, unsigned const char *data, size_t dlen)
326 const EVP_MD *md = NULL;
327 int ilen = (int)dlen;
331 if (dane->trecs == NULL) {
332 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
336 if (ilen < 0 || dlen != (size_t)ilen) {
337 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
341 if (usage > DANETLS_USAGE_LAST) {
342 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
346 if (selector > DANETLS_SELECTOR_LAST) {
347 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
351 if (mtype != DANETLS_MATCHING_FULL) {
352 md = tlsa_md_get(dane, mtype);
354 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
359 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
360 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
364 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
368 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
369 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
374 t->selector = selector;
376 t->data = OPENSSL_malloc(ilen);
377 if (t->data == NULL) {
379 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
382 memcpy(t->data, data, ilen);
385 /* Validate and cache full certificate or public key */
386 if (mtype == DANETLS_MATCHING_FULL) {
387 const unsigned char *p = data;
389 EVP_PKEY *pkey = NULL;
392 case DANETLS_SELECTOR_CERT:
393 if (!d2i_X509(&cert, &p, dlen) || p < data ||
394 dlen != (size_t)(p - data)) {
396 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
399 if (X509_get0_pubkey(cert) == NULL) {
401 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
405 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
411 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
412 * records that contain full certificates of trust-anchors that are
413 * not present in the wire chain. For usage PKIX-TA(0), we augment
414 * the chain with untrusted Full(0) certificates from DNS, in case
415 * they are missing from the chain.
417 if ((dane->certs == NULL &&
418 (dane->certs = sk_X509_new_null()) == NULL) ||
419 !sk_X509_push(dane->certs, cert)) {
420 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
427 case DANETLS_SELECTOR_SPKI:
428 if (!d2i_PUBKEY(&pkey, &p, dlen) || p < data ||
429 dlen != (size_t)(p - data)) {
431 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
436 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
437 * records that contain full bare keys of trust-anchors that are
438 * not present in the wire chain.
440 if (usage == DANETLS_USAGE_DANE_TA)
449 * Find the right insertion point for the new record.
451 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
452 * they can be processed first, as they require no chain building, and no
453 * expiration or hostname checks. Because DANE-EE(3) is numerically
454 * largest, this is accomplished via descending sort by "usage".
456 * We also sort in descending order by matching ordinal to simplify
457 * the implementation of digest agility in the verification code.
459 * The choice of order for the selector is not significant, so we
460 * use the same descending order for consistency.
462 num = sk_danetls_record_num(dane->trecs);
463 for (i = 0; i < num; ++i) {
464 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
466 if (rec->usage > usage)
468 if (rec->usage < usage)
470 if (rec->selector > selector)
472 if (rec->selector < selector)
474 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
479 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
481 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
484 dane->umask |= DANETLS_USAGE_BIT(usage);
490 * Return 0 if there is only one version configured and it was disabled
491 * at configure time. Return 1 otherwise.
493 static int ssl_check_allowed_versions(int min_version, int max_version)
495 int minisdtls = 0, maxisdtls = 0;
497 /* Figure out if we're doing DTLS versions or TLS versions */
498 if (min_version == DTLS1_BAD_VER
499 || min_version >> 8 == DTLS1_VERSION_MAJOR)
501 if (max_version == DTLS1_BAD_VER
502 || max_version >> 8 == DTLS1_VERSION_MAJOR)
504 /* A wildcard version of 0 could be DTLS or TLS. */
505 if ((minisdtls && !maxisdtls && max_version != 0)
506 || (maxisdtls && !minisdtls && min_version != 0)) {
507 /* Mixing DTLS and TLS versions will lead to sadness; deny it. */
511 if (minisdtls || maxisdtls) {
512 /* Do DTLS version checks. */
513 if (min_version == 0)
514 /* Ignore DTLS1_BAD_VER */
515 min_version = DTLS1_VERSION;
516 if (max_version == 0)
517 max_version = DTLS1_2_VERSION;
518 #ifdef OPENSSL_NO_DTLS1_2
519 if (max_version == DTLS1_2_VERSION)
520 max_version = DTLS1_VERSION;
522 #ifdef OPENSSL_NO_DTLS1
523 if (min_version == DTLS1_VERSION)
524 min_version = DTLS1_2_VERSION;
526 /* Done massaging versions; do the check. */
528 #ifdef OPENSSL_NO_DTLS1
529 || (DTLS_VERSION_GE(min_version, DTLS1_VERSION)
530 && DTLS_VERSION_GE(DTLS1_VERSION, max_version))
532 #ifdef OPENSSL_NO_DTLS1_2
533 || (DTLS_VERSION_GE(min_version, DTLS1_2_VERSION)
534 && DTLS_VERSION_GE(DTLS1_2_VERSION, max_version))
539 /* Regular TLS version checks. */
540 if (min_version == 0)
541 min_version = SSL3_VERSION;
542 if (max_version == 0)
543 max_version = TLS1_2_VERSION;
544 #ifdef OPENSSL_NO_TLS1_2
545 if (max_version == TLS1_2_VERSION)
546 max_version = TLS1_1_VERSION;
548 #ifdef OPENSSL_NO_TLS1_1
549 if (max_version == TLS1_1_VERSION)
550 max_version = TLS1_VERSION;
552 #ifdef OPENSSL_NO_TLS1
553 if (max_version == TLS1_VERSION)
554 max_version = SSL3_VERSION;
556 #ifdef OPENSSL_NO_SSL3
557 if (min_version == SSL3_VERSION)
558 min_version = TLS1_VERSION;
560 #ifdef OPENSSL_NO_TLS1
561 if (min_version == TLS1_VERSION)
562 min_version = TLS1_1_VERSION;
564 #ifdef OPENSSL_NO_TLS1_1
565 if (min_version == TLS1_1_VERSION)
566 min_version = TLS1_2_VERSION;
568 /* Done massaging versions; do the check. */
570 #ifdef OPENSSL_NO_SSL3
571 || (min_version <= SSL3_VERSION && SSL3_VERSION <= max_version)
573 #ifdef OPENSSL_NO_TLS1
574 || (min_version <= TLS1_VERSION && TLS1_VERSION <= max_version)
576 #ifdef OPENSSL_NO_TLS1_1
577 || (min_version <= TLS1_1_VERSION && TLS1_1_VERSION <= max_version)
579 #ifdef OPENSSL_NO_TLS1_2
580 || (min_version <= TLS1_2_VERSION && TLS1_2_VERSION <= max_version)
588 static void clear_ciphers(SSL *s)
590 /* clear the current cipher */
591 ssl_clear_cipher_ctx(s);
592 ssl_clear_hash_ctx(&s->read_hash);
593 ssl_clear_hash_ctx(&s->write_hash);
596 int SSL_clear(SSL *s)
598 if (s->method == NULL) {
599 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
603 if (ssl_clear_bad_session(s)) {
604 SSL_SESSION_free(s->session);
612 if (s->renegotiate) {
613 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
617 ossl_statem_clear(s);
619 s->version = s->method->version;
620 s->client_version = s->version;
621 s->rwstate = SSL_NOTHING;
623 BUF_MEM_free(s->init_buf);
628 /* Reset DANE verification result state */
631 X509_free(s->dane.mcert);
632 s->dane.mcert = NULL;
633 s->dane.mtlsa = NULL;
635 /* Clear the verification result peername */
636 X509_VERIFY_PARAM_move_peername(s->param, NULL);
639 * Check to see if we were changed into a different method, if so, revert
640 * back if we are not doing session-id reuse.
642 if (!ossl_statem_get_in_handshake(s) && (s->session == NULL)
643 && (s->method != s->ctx->method)) {
644 s->method->ssl_free(s);
645 s->method = s->ctx->method;
646 if (!s->method->ssl_new(s))
649 s->method->ssl_clear(s);
651 RECORD_LAYER_clear(&s->rlayer);
656 /** Used to change an SSL_CTXs default SSL method type */
657 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
659 STACK_OF(SSL_CIPHER) *sk;
663 sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
664 &(ctx->cipher_list_by_id),
665 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
666 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
667 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
673 SSL *SSL_new(SSL_CTX *ctx)
678 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
681 if (ctx->method == NULL) {
682 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
686 s = OPENSSL_zalloc(sizeof(*s));
690 s->lock = CRYPTO_THREAD_lock_new();
691 if (s->lock == NULL) {
692 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
697 RECORD_LAYER_init(&s->rlayer, s);
699 s->options = ctx->options;
700 s->dane.flags = ctx->dane.flags;
701 s->min_proto_version = ctx->min_proto_version;
702 s->max_proto_version = ctx->max_proto_version;
704 s->max_cert_list = ctx->max_cert_list;
708 * Earlier library versions used to copy the pointer to the CERT, not
709 * its contents; only when setting new parameters for the per-SSL
710 * copy, ssl_cert_new would be called (and the direct reference to
711 * the per-SSL_CTX settings would be lost, but those still were
712 * indirectly accessed for various purposes, and for that reason they
713 * used to be known as s->ctx->default_cert). Now we don't look at the
714 * SSL_CTX's CERT after having duplicated it once.
716 s->cert = ssl_cert_dup(ctx->cert);
720 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
721 s->msg_callback = ctx->msg_callback;
722 s->msg_callback_arg = ctx->msg_callback_arg;
723 s->verify_mode = ctx->verify_mode;
724 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
725 s->sid_ctx_length = ctx->sid_ctx_length;
726 OPENSSL_assert(s->sid_ctx_length <= sizeof(s->sid_ctx));
727 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
728 s->verify_callback = ctx->default_verify_callback;
729 s->generate_session_id = ctx->generate_session_id;
731 s->param = X509_VERIFY_PARAM_new();
732 if (s->param == NULL)
734 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
735 s->quiet_shutdown = ctx->quiet_shutdown;
736 s->max_send_fragment = ctx->max_send_fragment;
737 s->split_send_fragment = ctx->split_send_fragment;
738 s->max_pipelines = ctx->max_pipelines;
739 if (s->max_pipelines > 1)
740 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
741 if (ctx->default_read_buf_len > 0)
742 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
746 s->tlsext_debug_cb = 0;
747 s->tlsext_debug_arg = NULL;
748 s->tlsext_ticket_expected = 0;
749 s->tlsext_status_type = ctx->tlsext_status_type;
750 s->tlsext_status_expected = 0;
751 s->tlsext_ocsp_ids = NULL;
752 s->tlsext_ocsp_exts = NULL;
753 s->tlsext_ocsp_resp = NULL;
754 s->tlsext_ocsp_resplen = -1;
756 s->session_ctx = ctx;
757 #ifndef OPENSSL_NO_EC
758 if (ctx->tlsext_ecpointformatlist) {
759 s->tlsext_ecpointformatlist =
760 OPENSSL_memdup(ctx->tlsext_ecpointformatlist,
761 ctx->tlsext_ecpointformatlist_length);
762 if (!s->tlsext_ecpointformatlist)
764 s->tlsext_ecpointformatlist_length =
765 ctx->tlsext_ecpointformatlist_length;
767 if (ctx->tlsext_ellipticcurvelist) {
768 s->tlsext_ellipticcurvelist =
769 OPENSSL_memdup(ctx->tlsext_ellipticcurvelist,
770 ctx->tlsext_ellipticcurvelist_length);
771 if (!s->tlsext_ellipticcurvelist)
773 s->tlsext_ellipticcurvelist_length =
774 ctx->tlsext_ellipticcurvelist_length;
777 #ifndef OPENSSL_NO_NEXTPROTONEG
778 s->next_proto_negotiated = NULL;
781 if (s->ctx->alpn_client_proto_list) {
782 s->alpn_client_proto_list =
783 OPENSSL_malloc(s->ctx->alpn_client_proto_list_len);
784 if (s->alpn_client_proto_list == NULL)
786 memcpy(s->alpn_client_proto_list, s->ctx->alpn_client_proto_list,
787 s->ctx->alpn_client_proto_list_len);
788 s->alpn_client_proto_list_len = s->ctx->alpn_client_proto_list_len;
791 s->verified_chain = NULL;
792 s->verify_result = X509_V_OK;
794 s->default_passwd_callback = ctx->default_passwd_callback;
795 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
797 s->method = ctx->method;
799 if (!s->method->ssl_new(s))
802 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
807 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
810 #ifndef OPENSSL_NO_PSK
811 s->psk_client_callback = ctx->psk_client_callback;
812 s->psk_server_callback = ctx->psk_server_callback;
817 #ifndef OPENSSL_NO_CT
818 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
819 ctx->ct_validation_callback_arg))
826 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
830 int SSL_is_dtls(const SSL *s)
832 return SSL_IS_DTLS(s) ? 1 : 0;
835 int SSL_up_ref(SSL *s)
839 if (CRYPTO_atomic_add(&s->references, 1, &i, s->lock) <= 0)
842 REF_PRINT_COUNT("SSL", s);
843 REF_ASSERT_ISNT(i < 2);
844 return ((i > 1) ? 1 : 0);
847 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
848 unsigned int sid_ctx_len)
850 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
851 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
852 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
855 ctx->sid_ctx_length = sid_ctx_len;
856 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
861 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
862 unsigned int sid_ctx_len)
864 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
865 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
866 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
869 ssl->sid_ctx_length = sid_ctx_len;
870 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
875 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
877 CRYPTO_THREAD_write_lock(ctx->lock);
878 ctx->generate_session_id = cb;
879 CRYPTO_THREAD_unlock(ctx->lock);
883 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
885 CRYPTO_THREAD_write_lock(ssl->lock);
886 ssl->generate_session_id = cb;
887 CRYPTO_THREAD_unlock(ssl->lock);
891 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
895 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
896 * we can "construct" a session to give us the desired check - i.e. to
897 * find if there's a session in the hash table that would conflict with
898 * any new session built out of this id/id_len and the ssl_version in use
903 if (id_len > sizeof(r.session_id))
906 r.ssl_version = ssl->version;
907 r.session_id_length = id_len;
908 memcpy(r.session_id, id, id_len);
910 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
911 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
912 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
916 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
918 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
921 int SSL_set_purpose(SSL *s, int purpose)
923 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
926 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
928 return X509_VERIFY_PARAM_set_trust(s->param, trust);
931 int SSL_set_trust(SSL *s, int trust)
933 return X509_VERIFY_PARAM_set_trust(s->param, trust);
936 int SSL_set1_host(SSL *s, const char *hostname)
938 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
941 int SSL_add1_host(SSL *s, const char *hostname)
943 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
946 void SSL_set_hostflags(SSL *s, unsigned int flags)
948 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
951 const char *SSL_get0_peername(SSL *s)
953 return X509_VERIFY_PARAM_get0_peername(s->param);
956 int SSL_CTX_dane_enable(SSL_CTX *ctx)
958 return dane_ctx_enable(&ctx->dane);
961 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
963 unsigned long orig = ctx->dane.flags;
965 ctx->dane.flags |= flags;
969 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
971 unsigned long orig = ctx->dane.flags;
973 ctx->dane.flags &= ~flags;
977 int SSL_dane_enable(SSL *s, const char *basedomain)
979 SSL_DANE *dane = &s->dane;
981 if (s->ctx->dane.mdmax == 0) {
982 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
985 if (dane->trecs != NULL) {
986 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
991 * Default SNI name. This rejects empty names, while set1_host below
992 * accepts them and disables host name checks. To avoid side-effects with
993 * invalid input, set the SNI name first.
995 if (s->tlsext_hostname == NULL) {
996 if (!SSL_set_tlsext_host_name(s, basedomain)) {
997 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1002 /* Primary RFC6125 reference identifier */
1003 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1004 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1010 dane->dctx = &s->ctx->dane;
1011 dane->trecs = sk_danetls_record_new_null();
1013 if (dane->trecs == NULL) {
1014 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1020 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1022 unsigned long orig = ssl->dane.flags;
1024 ssl->dane.flags |= flags;
1028 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1030 unsigned long orig = ssl->dane.flags;
1032 ssl->dane.flags &= ~flags;
1036 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1038 SSL_DANE *dane = &s->dane;
1040 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1044 *mcert = dane->mcert;
1046 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1051 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1052 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1054 SSL_DANE *dane = &s->dane;
1056 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1060 *usage = dane->mtlsa->usage;
1062 *selector = dane->mtlsa->selector;
1064 *mtype = dane->mtlsa->mtype;
1066 *data = dane->mtlsa->data;
1068 *dlen = dane->mtlsa->dlen;
1073 SSL_DANE *SSL_get0_dane(SSL *s)
1078 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1079 uint8_t mtype, unsigned const char *data, size_t dlen)
1081 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1084 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1087 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1090 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1092 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1095 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1097 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1100 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1105 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1110 void SSL_certs_clear(SSL *s)
1112 ssl_cert_clear_certs(s->cert);
1115 void SSL_free(SSL *s)
1122 CRYPTO_atomic_add(&s->references, -1, &i, s->lock);
1123 REF_PRINT_COUNT("SSL", s);
1126 REF_ASSERT_ISNT(i < 0);
1128 X509_VERIFY_PARAM_free(s->param);
1129 dane_final(&s->dane);
1130 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1132 ssl_free_wbio_buffer(s);
1134 BIO_free_all(s->wbio);
1135 BIO_free_all(s->rbio);
1137 BUF_MEM_free(s->init_buf);
1139 /* add extra stuff */
1140 sk_SSL_CIPHER_free(s->cipher_list);
1141 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1143 /* Make the next call work :-) */
1144 if (s->session != NULL) {
1145 ssl_clear_bad_session(s);
1146 SSL_SESSION_free(s->session);
1151 ssl_cert_free(s->cert);
1152 /* Free up if allocated */
1154 OPENSSL_free(s->tlsext_hostname);
1155 SSL_CTX_free(s->session_ctx);
1156 #ifndef OPENSSL_NO_EC
1157 OPENSSL_free(s->tlsext_ecpointformatlist);
1158 OPENSSL_free(s->tlsext_ellipticcurvelist);
1159 #endif /* OPENSSL_NO_EC */
1160 sk_X509_EXTENSION_pop_free(s->tlsext_ocsp_exts, X509_EXTENSION_free);
1161 #ifndef OPENSSL_NO_OCSP
1162 sk_OCSP_RESPID_pop_free(s->tlsext_ocsp_ids, OCSP_RESPID_free);
1164 #ifndef OPENSSL_NO_CT
1165 SCT_LIST_free(s->scts);
1166 OPENSSL_free(s->tlsext_scts);
1168 OPENSSL_free(s->tlsext_ocsp_resp);
1169 OPENSSL_free(s->alpn_client_proto_list);
1171 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1173 sk_X509_pop_free(s->verified_chain, X509_free);
1175 if (s->method != NULL)
1176 s->method->ssl_free(s);
1178 RECORD_LAYER_release(&s->rlayer);
1180 SSL_CTX_free(s->ctx);
1182 ASYNC_WAIT_CTX_free(s->waitctx);
1184 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1185 OPENSSL_free(s->next_proto_negotiated);
1188 #ifndef OPENSSL_NO_SRTP
1189 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1192 CRYPTO_THREAD_lock_free(s->lock);
1197 void SSL_set0_rbio(SSL *s, BIO *rbio)
1199 BIO_free_all(s->rbio);
1203 void SSL_set0_wbio(SSL *s, BIO *wbio)
1206 * If the output buffering BIO is still in place, remove it
1208 if (s->bbio != NULL)
1209 s->wbio = BIO_pop(s->wbio);
1211 BIO_free_all(s->wbio);
1214 /* Re-attach |bbio| to the new |wbio|. */
1215 if (s->bbio != NULL)
1216 s->wbio = BIO_push(s->bbio, s->wbio);
1219 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1222 * For historical reasons, this function has many different cases in
1223 * ownership handling.
1226 /* If nothing has changed, do nothing */
1227 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1231 * If the two arguments are equal then one fewer reference is granted by the
1232 * caller than we want to take
1234 if (rbio != NULL && rbio == wbio)
1238 * If only the wbio is changed only adopt one reference.
1240 if (rbio == SSL_get_rbio(s)) {
1241 SSL_set0_wbio(s, wbio);
1245 * There is an asymmetry here for historical reasons. If only the rbio is
1246 * changed AND the rbio and wbio were originally different, then we only
1247 * adopt one reference.
1249 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1250 SSL_set0_rbio(s, rbio);
1254 /* Otherwise, adopt both references. */
1255 SSL_set0_rbio(s, rbio);
1256 SSL_set0_wbio(s, wbio);
1259 BIO *SSL_get_rbio(const SSL *s)
1264 BIO *SSL_get_wbio(const SSL *s)
1266 if (s->bbio != NULL) {
1268 * If |bbio| is active, the true caller-configured BIO is its
1271 return BIO_next(s->bbio);
1276 int SSL_get_fd(const SSL *s)
1278 return SSL_get_rfd(s);
1281 int SSL_get_rfd(const SSL *s)
1286 b = SSL_get_rbio(s);
1287 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1289 BIO_get_fd(r, &ret);
1293 int SSL_get_wfd(const SSL *s)
1298 b = SSL_get_wbio(s);
1299 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1301 BIO_get_fd(r, &ret);
1305 #ifndef OPENSSL_NO_SOCK
1306 int SSL_set_fd(SSL *s, int fd)
1311 bio = BIO_new(BIO_s_socket());
1314 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1317 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1318 SSL_set_bio(s, bio, bio);
1324 int SSL_set_wfd(SSL *s, int fd)
1326 BIO *rbio = SSL_get_rbio(s);
1328 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1329 || (int)BIO_get_fd(rbio, NULL) != fd) {
1330 BIO *bio = BIO_new(BIO_s_socket());
1333 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1336 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1337 SSL_set0_wbio(s, bio);
1340 SSL_set0_wbio(s, rbio);
1345 int SSL_set_rfd(SSL *s, int fd)
1347 BIO *wbio = SSL_get_wbio(s);
1349 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1350 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1351 BIO *bio = BIO_new(BIO_s_socket());
1354 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1357 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1358 SSL_set0_rbio(s, bio);
1361 SSL_set0_rbio(s, wbio);
1368 /* return length of latest Finished message we sent, copy to 'buf' */
1369 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1373 if (s->s3 != NULL) {
1374 ret = s->s3->tmp.finish_md_len;
1377 memcpy(buf, s->s3->tmp.finish_md, count);
1382 /* return length of latest Finished message we expected, copy to 'buf' */
1383 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1387 if (s->s3 != NULL) {
1388 ret = s->s3->tmp.peer_finish_md_len;
1391 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1396 int SSL_get_verify_mode(const SSL *s)
1398 return (s->verify_mode);
1401 int SSL_get_verify_depth(const SSL *s)
1403 return X509_VERIFY_PARAM_get_depth(s->param);
1406 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1407 return (s->verify_callback);
1410 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1412 return (ctx->verify_mode);
1415 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1417 return X509_VERIFY_PARAM_get_depth(ctx->param);
1420 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1421 return (ctx->default_verify_callback);
1424 void SSL_set_verify(SSL *s, int mode,
1425 int (*callback) (int ok, X509_STORE_CTX *ctx))
1427 s->verify_mode = mode;
1428 if (callback != NULL)
1429 s->verify_callback = callback;
1432 void SSL_set_verify_depth(SSL *s, int depth)
1434 X509_VERIFY_PARAM_set_depth(s->param, depth);
1437 void SSL_set_read_ahead(SSL *s, int yes)
1439 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1442 int SSL_get_read_ahead(const SSL *s)
1444 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1447 int SSL_pending(const SSL *s)
1450 * SSL_pending cannot work properly if read-ahead is enabled
1451 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1452 * impossible to fix since SSL_pending cannot report errors that may be
1453 * observed while scanning the new data. (Note that SSL_pending() is
1454 * often used as a boolean value, so we'd better not return -1.)
1456 return (s->method->ssl_pending(s));
1459 int SSL_has_pending(const SSL *s)
1462 * Similar to SSL_pending() but returns a 1 to indicate that we have
1463 * unprocessed data available or 0 otherwise (as opposed to the number of
1464 * bytes available). Unlike SSL_pending() this will take into account
1465 * read_ahead data. A 1 return simply indicates that we have unprocessed
1466 * data. That data may not result in any application data, or we may fail
1467 * to parse the records for some reason.
1469 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1472 return RECORD_LAYER_read_pending(&s->rlayer);
1475 X509 *SSL_get_peer_certificate(const SSL *s)
1479 if ((s == NULL) || (s->session == NULL))
1482 r = s->session->peer;
1492 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1496 if ((s == NULL) || (s->session == NULL))
1499 r = s->session->peer_chain;
1502 * If we are a client, cert_chain includes the peer's own certificate; if
1503 * we are a server, it does not.
1510 * Now in theory, since the calling process own 't' it should be safe to
1511 * modify. We need to be able to read f without being hassled
1513 int SSL_copy_session_id(SSL *t, const SSL *f)
1516 /* Do we need to to SSL locking? */
1517 if (!SSL_set_session(t, SSL_get_session(f))) {
1522 * what if we are setup for one protocol version but want to talk another
1524 if (t->method != f->method) {
1525 t->method->ssl_free(t);
1526 t->method = f->method;
1527 if (t->method->ssl_new(t) == 0)
1531 CRYPTO_atomic_add(&f->cert->references, 1, &i, f->cert->lock);
1532 ssl_cert_free(t->cert);
1534 if (!SSL_set_session_id_context(t, f->sid_ctx, f->sid_ctx_length)) {
1541 /* Fix this so it checks all the valid key/cert options */
1542 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1544 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1545 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1548 if (ctx->cert->key->privatekey == NULL) {
1549 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1552 return (X509_check_private_key
1553 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1556 /* Fix this function so that it takes an optional type parameter */
1557 int SSL_check_private_key(const SSL *ssl)
1560 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1563 if (ssl->cert->key->x509 == NULL) {
1564 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1567 if (ssl->cert->key->privatekey == NULL) {
1568 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1571 return (X509_check_private_key(ssl->cert->key->x509,
1572 ssl->cert->key->privatekey));
1575 int SSL_waiting_for_async(SSL *s)
1583 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1585 ASYNC_WAIT_CTX *ctx = s->waitctx;
1589 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1592 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1593 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1595 ASYNC_WAIT_CTX *ctx = s->waitctx;
1599 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1603 int SSL_accept(SSL *s)
1605 if (s->handshake_func == NULL) {
1606 /* Not properly initialized yet */
1607 SSL_set_accept_state(s);
1610 return SSL_do_handshake(s);
1613 int SSL_connect(SSL *s)
1615 if (s->handshake_func == NULL) {
1616 /* Not properly initialized yet */
1617 SSL_set_connect_state(s);
1620 return SSL_do_handshake(s);
1623 long SSL_get_default_timeout(const SSL *s)
1625 return (s->method->get_timeout());
1628 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1629 int (*func) (void *))
1632 if (s->waitctx == NULL) {
1633 s->waitctx = ASYNC_WAIT_CTX_new();
1634 if (s->waitctx == NULL)
1637 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1638 sizeof(struct ssl_async_args))) {
1640 s->rwstate = SSL_NOTHING;
1641 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1644 s->rwstate = SSL_ASYNC_PAUSED;
1647 s->rwstate = SSL_ASYNC_NO_JOBS;
1653 s->rwstate = SSL_NOTHING;
1654 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1655 /* Shouldn't happen */
1660 static int ssl_io_intern(void *vargs)
1662 struct ssl_async_args *args;
1667 args = (struct ssl_async_args *)vargs;
1671 switch (args->type) {
1673 return args->f.func_read(s, buf, num);
1675 return args->f.func_write(s, buf, num);
1677 return args->f.func_other(s);
1682 int SSL_read(SSL *s, void *buf, int num)
1684 if (s->handshake_func == NULL) {
1685 SSLerr(SSL_F_SSL_READ, SSL_R_UNINITIALIZED);
1689 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1690 s->rwstate = SSL_NOTHING;
1694 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1695 struct ssl_async_args args;
1700 args.type = READFUNC;
1701 args.f.func_read = s->method->ssl_read;
1703 return ssl_start_async_job(s, &args, ssl_io_intern);
1705 return s->method->ssl_read(s, buf, num);
1709 int SSL_peek(SSL *s, void *buf, int num)
1711 if (s->handshake_func == NULL) {
1712 SSLerr(SSL_F_SSL_PEEK, SSL_R_UNINITIALIZED);
1716 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1719 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1720 struct ssl_async_args args;
1725 args.type = READFUNC;
1726 args.f.func_read = s->method->ssl_peek;
1728 return ssl_start_async_job(s, &args, ssl_io_intern);
1730 return s->method->ssl_peek(s, buf, num);
1734 int SSL_write(SSL *s, const void *buf, int num)
1736 if (s->handshake_func == NULL) {
1737 SSLerr(SSL_F_SSL_WRITE, SSL_R_UNINITIALIZED);
1741 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1742 s->rwstate = SSL_NOTHING;
1743 SSLerr(SSL_F_SSL_WRITE, SSL_R_PROTOCOL_IS_SHUTDOWN);
1747 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1748 struct ssl_async_args args;
1751 args.buf = (void *)buf;
1753 args.type = WRITEFUNC;
1754 args.f.func_write = s->method->ssl_write;
1756 return ssl_start_async_job(s, &args, ssl_io_intern);
1758 return s->method->ssl_write(s, buf, num);
1762 int SSL_shutdown(SSL *s)
1765 * Note that this function behaves differently from what one might
1766 * expect. Return values are 0 for no success (yet), 1 for success; but
1767 * calling it once is usually not enough, even if blocking I/O is used
1768 * (see ssl3_shutdown).
1771 if (s->handshake_func == NULL) {
1772 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1776 if (!SSL_in_init(s)) {
1777 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1778 struct ssl_async_args args;
1781 args.type = OTHERFUNC;
1782 args.f.func_other = s->method->ssl_shutdown;
1784 return ssl_start_async_job(s, &args, ssl_io_intern);
1786 return s->method->ssl_shutdown(s);
1789 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1794 int SSL_renegotiate(SSL *s)
1796 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
1797 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
1801 if (s->renegotiate == 0)
1806 return (s->method->ssl_renegotiate(s));
1809 int SSL_renegotiate_abbreviated(SSL *s)
1811 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
1812 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
1816 if (s->renegotiate == 0)
1821 return (s->method->ssl_renegotiate(s));
1824 int SSL_renegotiate_pending(SSL *s)
1827 * becomes true when negotiation is requested; false again once a
1828 * handshake has finished
1830 return (s->renegotiate != 0);
1833 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1838 case SSL_CTRL_GET_READ_AHEAD:
1839 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1840 case SSL_CTRL_SET_READ_AHEAD:
1841 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1842 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1845 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1846 s->msg_callback_arg = parg;
1850 return (s->mode |= larg);
1851 case SSL_CTRL_CLEAR_MODE:
1852 return (s->mode &= ~larg);
1853 case SSL_CTRL_GET_MAX_CERT_LIST:
1854 return (s->max_cert_list);
1855 case SSL_CTRL_SET_MAX_CERT_LIST:
1856 l = s->max_cert_list;
1857 s->max_cert_list = larg;
1859 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1860 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1862 s->max_send_fragment = larg;
1863 if (s->max_send_fragment < s->split_send_fragment)
1864 s->split_send_fragment = s->max_send_fragment;
1866 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1867 if ((unsigned int)larg > s->max_send_fragment || larg == 0)
1869 s->split_send_fragment = larg;
1871 case SSL_CTRL_SET_MAX_PIPELINES:
1872 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1874 s->max_pipelines = larg;
1876 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1878 case SSL_CTRL_GET_RI_SUPPORT:
1880 return s->s3->send_connection_binding;
1883 case SSL_CTRL_CERT_FLAGS:
1884 return (s->cert->cert_flags |= larg);
1885 case SSL_CTRL_CLEAR_CERT_FLAGS:
1886 return (s->cert->cert_flags &= ~larg);
1888 case SSL_CTRL_GET_RAW_CIPHERLIST:
1890 if (s->s3->tmp.ciphers_raw == NULL)
1892 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
1893 return (int)s->s3->tmp.ciphers_rawlen;
1895 return TLS_CIPHER_LEN;
1897 case SSL_CTRL_GET_EXTMS_SUPPORT:
1898 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
1900 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
1904 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1905 return ssl_check_allowed_versions(larg, s->max_proto_version)
1906 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
1907 &s->min_proto_version);
1908 case SSL_CTRL_GET_MIN_PROTO_VERSION:
1909 return s->min_proto_version;
1910 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1911 return ssl_check_allowed_versions(s->min_proto_version, larg)
1912 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
1913 &s->max_proto_version);
1914 case SSL_CTRL_GET_MAX_PROTO_VERSION:
1915 return s->max_proto_version;
1917 return (s->method->ssl_ctrl(s, cmd, larg, parg));
1921 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1924 case SSL_CTRL_SET_MSG_CALLBACK:
1925 s->msg_callback = (void (*)
1926 (int write_p, int version, int content_type,
1927 const void *buf, size_t len, SSL *ssl,
1932 return (s->method->ssl_callback_ctrl(s, cmd, fp));
1936 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
1938 return ctx->sessions;
1941 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1944 /* For some cases with ctx == NULL perform syntax checks */
1947 #ifndef OPENSSL_NO_EC
1948 case SSL_CTRL_SET_CURVES_LIST:
1949 return tls1_set_curves_list(NULL, NULL, parg);
1951 case SSL_CTRL_SET_SIGALGS_LIST:
1952 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
1953 return tls1_set_sigalgs_list(NULL, parg, 0);
1960 case SSL_CTRL_GET_READ_AHEAD:
1961 return (ctx->read_ahead);
1962 case SSL_CTRL_SET_READ_AHEAD:
1963 l = ctx->read_ahead;
1964 ctx->read_ahead = larg;
1967 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1968 ctx->msg_callback_arg = parg;
1971 case SSL_CTRL_GET_MAX_CERT_LIST:
1972 return (ctx->max_cert_list);
1973 case SSL_CTRL_SET_MAX_CERT_LIST:
1974 l = ctx->max_cert_list;
1975 ctx->max_cert_list = larg;
1978 case SSL_CTRL_SET_SESS_CACHE_SIZE:
1979 l = ctx->session_cache_size;
1980 ctx->session_cache_size = larg;
1982 case SSL_CTRL_GET_SESS_CACHE_SIZE:
1983 return (ctx->session_cache_size);
1984 case SSL_CTRL_SET_SESS_CACHE_MODE:
1985 l = ctx->session_cache_mode;
1986 ctx->session_cache_mode = larg;
1988 case SSL_CTRL_GET_SESS_CACHE_MODE:
1989 return (ctx->session_cache_mode);
1991 case SSL_CTRL_SESS_NUMBER:
1992 return (lh_SSL_SESSION_num_items(ctx->sessions));
1993 case SSL_CTRL_SESS_CONNECT:
1994 return (ctx->stats.sess_connect);
1995 case SSL_CTRL_SESS_CONNECT_GOOD:
1996 return (ctx->stats.sess_connect_good);
1997 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
1998 return (ctx->stats.sess_connect_renegotiate);
1999 case SSL_CTRL_SESS_ACCEPT:
2000 return (ctx->stats.sess_accept);
2001 case SSL_CTRL_SESS_ACCEPT_GOOD:
2002 return (ctx->stats.sess_accept_good);
2003 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2004 return (ctx->stats.sess_accept_renegotiate);
2005 case SSL_CTRL_SESS_HIT:
2006 return (ctx->stats.sess_hit);
2007 case SSL_CTRL_SESS_CB_HIT:
2008 return (ctx->stats.sess_cb_hit);
2009 case SSL_CTRL_SESS_MISSES:
2010 return (ctx->stats.sess_miss);
2011 case SSL_CTRL_SESS_TIMEOUTS:
2012 return (ctx->stats.sess_timeout);
2013 case SSL_CTRL_SESS_CACHE_FULL:
2014 return (ctx->stats.sess_cache_full);
2016 return (ctx->mode |= larg);
2017 case SSL_CTRL_CLEAR_MODE:
2018 return (ctx->mode &= ~larg);
2019 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2020 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2022 ctx->max_send_fragment = larg;
2023 if (ctx->max_send_fragment < ctx->split_send_fragment)
2024 ctx->split_send_fragment = ctx->max_send_fragment;
2026 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2027 if ((unsigned int)larg > ctx->max_send_fragment || larg == 0)
2029 ctx->split_send_fragment = larg;
2031 case SSL_CTRL_SET_MAX_PIPELINES:
2032 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2034 ctx->max_pipelines = larg;
2036 case SSL_CTRL_CERT_FLAGS:
2037 return (ctx->cert->cert_flags |= larg);
2038 case SSL_CTRL_CLEAR_CERT_FLAGS:
2039 return (ctx->cert->cert_flags &= ~larg);
2040 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2041 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2042 && ssl_set_version_bound(ctx->method->version, (int)larg,
2043 &ctx->min_proto_version);
2044 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2045 return ctx->min_proto_version;
2046 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2047 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2048 && ssl_set_version_bound(ctx->method->version, (int)larg,
2049 &ctx->max_proto_version);
2050 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2051 return ctx->max_proto_version;
2053 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2057 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2060 case SSL_CTRL_SET_MSG_CALLBACK:
2061 ctx->msg_callback = (void (*)
2062 (int write_p, int version, int content_type,
2063 const void *buf, size_t len, SSL *ssl,
2068 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2072 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2081 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2082 const SSL_CIPHER *const *bp)
2084 if ((*ap)->id > (*bp)->id)
2086 if ((*ap)->id < (*bp)->id)
2091 /** return a STACK of the ciphers available for the SSL and in order of
2093 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2096 if (s->cipher_list != NULL) {
2097 return (s->cipher_list);
2098 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2099 return (s->ctx->cipher_list);
2105 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2107 if ((s == NULL) || (s->session == NULL) || !s->server)
2109 return s->session->ciphers;
2112 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2114 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2116 ciphers = SSL_get_ciphers(s);
2119 ssl_set_client_disabled(s);
2120 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2121 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2122 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2124 sk = sk_SSL_CIPHER_new_null();
2127 if (!sk_SSL_CIPHER_push(sk, c)) {
2128 sk_SSL_CIPHER_free(sk);
2136 /** return a STACK of the ciphers available for the SSL and in order of
2138 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2141 if (s->cipher_list_by_id != NULL) {
2142 return (s->cipher_list_by_id);
2143 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2144 return (s->ctx->cipher_list_by_id);
2150 /** The old interface to get the same thing as SSL_get_ciphers() */
2151 const char *SSL_get_cipher_list(const SSL *s, int n)
2153 const SSL_CIPHER *c;
2154 STACK_OF(SSL_CIPHER) *sk;
2158 sk = SSL_get_ciphers(s);
2159 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2161 c = sk_SSL_CIPHER_value(sk, n);
2167 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2169 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2172 return ctx->cipher_list;
2176 /** specify the ciphers to be used by default by the SSL_CTX */
2177 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2179 STACK_OF(SSL_CIPHER) *sk;
2181 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2182 &ctx->cipher_list_by_id, str, ctx->cert);
2184 * ssl_create_cipher_list may return an empty stack if it was unable to
2185 * find a cipher matching the given rule string (for example if the rule
2186 * string specifies a cipher which has been disabled). This is not an
2187 * error as far as ssl_create_cipher_list is concerned, and hence
2188 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2192 else if (sk_SSL_CIPHER_num(sk) == 0) {
2193 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2199 /** specify the ciphers to be used by the SSL */
2200 int SSL_set_cipher_list(SSL *s, const char *str)
2202 STACK_OF(SSL_CIPHER) *sk;
2204 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2205 &s->cipher_list_by_id, str, s->cert);
2206 /* see comment in SSL_CTX_set_cipher_list */
2209 else if (sk_SSL_CIPHER_num(sk) == 0) {
2210 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2216 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2219 STACK_OF(SSL_CIPHER) *sk;
2220 const SSL_CIPHER *c;
2223 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2227 sk = s->session->ciphers;
2229 if (sk_SSL_CIPHER_num(sk) == 0)
2232 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2235 c = sk_SSL_CIPHER_value(sk, i);
2236 n = strlen(c->name);
2243 memcpy(p, c->name, n + 1);
2252 /** return a servername extension value if provided in Client Hello, or NULL.
2253 * So far, only host_name types are defined (RFC 3546).
2256 const char *SSL_get_servername(const SSL *s, const int type)
2258 if (type != TLSEXT_NAMETYPE_host_name)
2261 return s->session && !s->tlsext_hostname ?
2262 s->session->tlsext_hostname : s->tlsext_hostname;
2265 int SSL_get_servername_type(const SSL *s)
2268 && (!s->tlsext_hostname ? s->session->
2269 tlsext_hostname : s->tlsext_hostname))
2270 return TLSEXT_NAMETYPE_host_name;
2275 * SSL_select_next_proto implements the standard protocol selection. It is
2276 * expected that this function is called from the callback set by
2277 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2278 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2279 * not included in the length. A byte string of length 0 is invalid. No byte
2280 * string may be truncated. The current, but experimental algorithm for
2281 * selecting the protocol is: 1) If the server doesn't support NPN then this
2282 * is indicated to the callback. In this case, the client application has to
2283 * abort the connection or have a default application level protocol. 2) If
2284 * the server supports NPN, but advertises an empty list then the client
2285 * selects the first protocol in its list, but indicates via the API that this
2286 * fallback case was enacted. 3) Otherwise, the client finds the first
2287 * protocol in the server's list that it supports and selects this protocol.
2288 * This is because it's assumed that the server has better information about
2289 * which protocol a client should use. 4) If the client doesn't support any
2290 * of the server's advertised protocols, then this is treated the same as
2291 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2292 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2294 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2295 const unsigned char *server,
2296 unsigned int server_len,
2297 const unsigned char *client, unsigned int client_len)
2300 const unsigned char *result;
2301 int status = OPENSSL_NPN_UNSUPPORTED;
2304 * For each protocol in server preference order, see if we support it.
2306 for (i = 0; i < server_len;) {
2307 for (j = 0; j < client_len;) {
2308 if (server[i] == client[j] &&
2309 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2310 /* We found a match */
2311 result = &server[i];
2312 status = OPENSSL_NPN_NEGOTIATED;
2322 /* There's no overlap between our protocols and the server's list. */
2324 status = OPENSSL_NPN_NO_OVERLAP;
2327 *out = (unsigned char *)result + 1;
2328 *outlen = result[0];
2332 #ifndef OPENSSL_NO_NEXTPROTONEG
2334 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2335 * client's requested protocol for this connection and returns 0. If the
2336 * client didn't request any protocol, then *data is set to NULL. Note that
2337 * the client can request any protocol it chooses. The value returned from
2338 * this function need not be a member of the list of supported protocols
2339 * provided by the callback.
2341 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2344 *data = s->next_proto_negotiated;
2348 *len = s->next_proto_negotiated_len;
2353 * SSL_CTX_set_next_protos_advertised_cb sets a callback that is called when
2354 * a TLS server needs a list of supported protocols for Next Protocol
2355 * Negotiation. The returned list must be in wire format. The list is
2356 * returned by setting |out| to point to it and |outlen| to its length. This
2357 * memory will not be modified, but one should assume that the SSL* keeps a
2358 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2359 * wishes to advertise. Otherwise, no such extension will be included in the
2362 void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX *ctx,
2363 int (*cb) (SSL *ssl,
2366 unsigned int *outlen,
2367 void *arg), void *arg)
2369 ctx->next_protos_advertised_cb = cb;
2370 ctx->next_protos_advertised_cb_arg = arg;
2374 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2375 * client needs to select a protocol from the server's provided list. |out|
2376 * must be set to point to the selected protocol (which may be within |in|).
2377 * The length of the protocol name must be written into |outlen|. The
2378 * server's advertised protocols are provided in |in| and |inlen|. The
2379 * callback can assume that |in| is syntactically valid. The client must
2380 * select a protocol. It is fatal to the connection if this callback returns
2381 * a value other than SSL_TLSEXT_ERR_OK.
2383 void SSL_CTX_set_next_proto_select_cb(SSL_CTX *ctx,
2384 int (*cb) (SSL *s, unsigned char **out,
2385 unsigned char *outlen,
2386 const unsigned char *in,
2388 void *arg), void *arg)
2390 ctx->next_proto_select_cb = cb;
2391 ctx->next_proto_select_cb_arg = arg;
2396 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2397 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2398 * length-prefixed strings). Returns 0 on success.
2400 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2401 unsigned int protos_len)
2403 OPENSSL_free(ctx->alpn_client_proto_list);
2404 ctx->alpn_client_proto_list = OPENSSL_memdup(protos, protos_len);
2405 if (ctx->alpn_client_proto_list == NULL) {
2406 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2409 ctx->alpn_client_proto_list_len = protos_len;
2415 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2416 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2417 * length-prefixed strings). Returns 0 on success.
2419 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2420 unsigned int protos_len)
2422 OPENSSL_free(ssl->alpn_client_proto_list);
2423 ssl->alpn_client_proto_list = OPENSSL_memdup(protos, protos_len);
2424 if (ssl->alpn_client_proto_list == NULL) {
2425 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2428 ssl->alpn_client_proto_list_len = protos_len;
2434 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2435 * called during ClientHello processing in order to select an ALPN protocol
2436 * from the client's list of offered protocols.
2438 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2439 int (*cb) (SSL *ssl,
2440 const unsigned char **out,
2441 unsigned char *outlen,
2442 const unsigned char *in,
2444 void *arg), void *arg)
2446 ctx->alpn_select_cb = cb;
2447 ctx->alpn_select_cb_arg = arg;
2451 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2452 * On return it sets |*data| to point to |*len| bytes of protocol name
2453 * (not including the leading length-prefix byte). If the server didn't
2454 * respond with a negotiated protocol then |*len| will be zero.
2456 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2461 *data = ssl->s3->alpn_selected;
2465 *len = ssl->s3->alpn_selected_len;
2468 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2469 const char *label, size_t llen,
2470 const unsigned char *context, size_t contextlen,
2473 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2476 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2478 contextlen, use_context);
2481 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2483 const unsigned char *session_id = a->session_id;
2485 unsigned char tmp_storage[4];
2487 if (a->session_id_length < sizeof(tmp_storage)) {
2488 memset(tmp_storage, 0, sizeof(tmp_storage));
2489 memcpy(tmp_storage, a->session_id, a->session_id_length);
2490 session_id = tmp_storage;
2494 ((unsigned long)session_id[0]) |
2495 ((unsigned long)session_id[1] << 8L) |
2496 ((unsigned long)session_id[2] << 16L) |
2497 ((unsigned long)session_id[3] << 24L);
2502 * NB: If this function (or indeed the hash function which uses a sort of
2503 * coarser function than this one) is changed, ensure
2504 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2505 * being able to construct an SSL_SESSION that will collide with any existing
2506 * session with a matching session ID.
2508 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2510 if (a->ssl_version != b->ssl_version)
2512 if (a->session_id_length != b->session_id_length)
2514 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2518 * These wrapper functions should remain rather than redeclaring
2519 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2520 * variable. The reason is that the functions aren't static, they're exposed
2524 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2526 SSL_CTX *ret = NULL;
2529 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2533 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2536 if (FIPS_mode() && (meth->version < TLS1_VERSION)) {
2537 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE);
2541 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2542 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2545 ret = OPENSSL_zalloc(sizeof(*ret));
2550 ret->min_proto_version = 0;
2551 ret->max_proto_version = 0;
2552 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2553 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2554 /* We take the system default. */
2555 ret->session_timeout = meth->get_timeout();
2556 ret->references = 1;
2557 ret->lock = CRYPTO_THREAD_lock_new();
2558 if (ret->lock == NULL) {
2559 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2563 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2564 ret->verify_mode = SSL_VERIFY_NONE;
2565 if ((ret->cert = ssl_cert_new()) == NULL)
2568 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2569 if (ret->sessions == NULL)
2571 ret->cert_store = X509_STORE_new();
2572 if (ret->cert_store == NULL)
2574 #ifndef OPENSSL_NO_CT
2575 ret->ctlog_store = CTLOG_STORE_new();
2576 if (ret->ctlog_store == NULL)
2579 if (!ssl_create_cipher_list(ret->method,
2580 &ret->cipher_list, &ret->cipher_list_by_id,
2581 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2582 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2583 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2587 ret->param = X509_VERIFY_PARAM_new();
2588 if (ret->param == NULL)
2591 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2592 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2595 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2596 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2600 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2603 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2606 /* No compression for DTLS */
2607 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2608 ret->comp_methods = SSL_COMP_get_compression_methods();
2610 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2611 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2613 /* Setup RFC5077 ticket keys */
2614 if ((RAND_bytes(ret->tlsext_tick_key_name,
2615 sizeof(ret->tlsext_tick_key_name)) <= 0)
2616 || (RAND_bytes(ret->tlsext_tick_hmac_key,
2617 sizeof(ret->tlsext_tick_hmac_key)) <= 0)
2618 || (RAND_bytes(ret->tlsext_tick_aes_key,
2619 sizeof(ret->tlsext_tick_aes_key)) <= 0))
2620 ret->options |= SSL_OP_NO_TICKET;
2622 #ifndef OPENSSL_NO_SRP
2623 if (!SSL_CTX_SRP_CTX_init(ret))
2626 #ifndef OPENSSL_NO_ENGINE
2627 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2628 # define eng_strx(x) #x
2629 # define eng_str(x) eng_strx(x)
2630 /* Use specific client engine automatically... ignore errors */
2633 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2636 ENGINE_load_builtin_engines();
2637 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2639 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2645 * Default is to connect to non-RI servers. When RI is more widely
2646 * deployed might change this.
2648 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2650 * Disable compression by default to prevent CRIME. Applications can
2651 * re-enable compression by configuring
2652 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2653 * or by using the SSL_CONF library.
2655 ret->options |= SSL_OP_NO_COMPRESSION;
2657 ret->tlsext_status_type = -1;
2661 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2667 int SSL_CTX_up_ref(SSL_CTX *ctx)
2671 if (CRYPTO_atomic_add(&ctx->references, 1, &i, ctx->lock) <= 0)
2674 REF_PRINT_COUNT("SSL_CTX", ctx);
2675 REF_ASSERT_ISNT(i < 2);
2676 return ((i > 1) ? 1 : 0);
2679 void SSL_CTX_free(SSL_CTX *a)
2686 CRYPTO_atomic_add(&a->references, -1, &i, a->lock);
2687 REF_PRINT_COUNT("SSL_CTX", a);
2690 REF_ASSERT_ISNT(i < 0);
2692 X509_VERIFY_PARAM_free(a->param);
2693 dane_ctx_final(&a->dane);
2696 * Free internal session cache. However: the remove_cb() may reference
2697 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2698 * after the sessions were flushed.
2699 * As the ex_data handling routines might also touch the session cache,
2700 * the most secure solution seems to be: empty (flush) the cache, then
2701 * free ex_data, then finally free the cache.
2702 * (See ticket [openssl.org #212].)
2704 if (a->sessions != NULL)
2705 SSL_CTX_flush_sessions(a, 0);
2707 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2708 lh_SSL_SESSION_free(a->sessions);
2709 X509_STORE_free(a->cert_store);
2710 #ifndef OPENSSL_NO_CT
2711 CTLOG_STORE_free(a->ctlog_store);
2713 sk_SSL_CIPHER_free(a->cipher_list);
2714 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2715 ssl_cert_free(a->cert);
2716 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2717 sk_X509_pop_free(a->extra_certs, X509_free);
2718 a->comp_methods = NULL;
2719 #ifndef OPENSSL_NO_SRTP
2720 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2722 #ifndef OPENSSL_NO_SRP
2723 SSL_CTX_SRP_CTX_free(a);
2725 #ifndef OPENSSL_NO_ENGINE
2726 ENGINE_finish(a->client_cert_engine);
2729 #ifndef OPENSSL_NO_EC
2730 OPENSSL_free(a->tlsext_ecpointformatlist);
2731 OPENSSL_free(a->tlsext_ellipticcurvelist);
2733 OPENSSL_free(a->alpn_client_proto_list);
2735 CRYPTO_THREAD_lock_free(a->lock);
2740 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2742 ctx->default_passwd_callback = cb;
2745 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2747 ctx->default_passwd_callback_userdata = u;
2750 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2752 return ctx->default_passwd_callback;
2755 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2757 return ctx->default_passwd_callback_userdata;
2760 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2762 s->default_passwd_callback = cb;
2765 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2767 s->default_passwd_callback_userdata = u;
2770 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2772 return s->default_passwd_callback;
2775 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2777 return s->default_passwd_callback_userdata;
2780 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2781 int (*cb) (X509_STORE_CTX *, void *),
2784 ctx->app_verify_callback = cb;
2785 ctx->app_verify_arg = arg;
2788 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2789 int (*cb) (int, X509_STORE_CTX *))
2791 ctx->verify_mode = mode;
2792 ctx->default_verify_callback = cb;
2795 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2797 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2800 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2802 ssl_cert_set_cert_cb(c->cert, cb, arg);
2805 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2807 ssl_cert_set_cert_cb(s->cert, cb, arg);
2810 void ssl_set_masks(SSL *s)
2812 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_GOST)
2816 uint32_t *pvalid = s->s3->tmp.valid_flags;
2817 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2818 unsigned long mask_k, mask_a;
2819 #ifndef OPENSSL_NO_EC
2820 int have_ecc_cert, ecdsa_ok;
2826 #ifndef OPENSSL_NO_DH
2827 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2832 rsa_enc = pvalid[SSL_PKEY_RSA_ENC] & CERT_PKEY_VALID;
2833 rsa_sign = pvalid[SSL_PKEY_RSA_SIGN] & CERT_PKEY_SIGN;
2834 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_SIGN;
2835 #ifndef OPENSSL_NO_EC
2836 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2842 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2843 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2846 #ifndef OPENSSL_NO_GOST
2847 cpk = &(c->pkeys[SSL_PKEY_GOST12_512]);
2848 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2849 mask_k |= SSL_kGOST;
2850 mask_a |= SSL_aGOST12;
2852 cpk = &(c->pkeys[SSL_PKEY_GOST12_256]);
2853 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2854 mask_k |= SSL_kGOST;
2855 mask_a |= SSL_aGOST12;
2857 cpk = &(c->pkeys[SSL_PKEY_GOST01]);
2858 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2859 mask_k |= SSL_kGOST;
2860 mask_a |= SSL_aGOST01;
2870 if (rsa_enc || rsa_sign) {
2878 mask_a |= SSL_aNULL;
2881 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2882 * depending on the key usage extension.
2884 #ifndef OPENSSL_NO_EC
2885 if (have_ecc_cert) {
2887 cpk = &c->pkeys[SSL_PKEY_ECC];
2889 ex_kusage = X509_get_key_usage(x);
2890 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2891 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2894 mask_a |= SSL_aECDSA;
2898 #ifndef OPENSSL_NO_EC
2899 mask_k |= SSL_kECDHE;
2902 #ifndef OPENSSL_NO_PSK
2905 if (mask_k & SSL_kRSA)
2906 mask_k |= SSL_kRSAPSK;
2907 if (mask_k & SSL_kDHE)
2908 mask_k |= SSL_kDHEPSK;
2909 if (mask_k & SSL_kECDHE)
2910 mask_k |= SSL_kECDHEPSK;
2913 s->s3->tmp.mask_k = mask_k;
2914 s->s3->tmp.mask_a = mask_a;
2917 #ifndef OPENSSL_NO_EC
2919 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
2921 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
2922 /* key usage, if present, must allow signing */
2923 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
2924 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
2925 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
2929 return 1; /* all checks are ok */
2934 static int ssl_get_server_cert_index(const SSL *s)
2937 idx = ssl_cipher_get_cert_index(s->s3->tmp.new_cipher);
2938 if (idx == SSL_PKEY_RSA_ENC && !s->cert->pkeys[SSL_PKEY_RSA_ENC].x509)
2939 idx = SSL_PKEY_RSA_SIGN;
2940 if (idx == SSL_PKEY_GOST_EC) {
2941 if (s->cert->pkeys[SSL_PKEY_GOST12_512].x509)
2942 idx = SSL_PKEY_GOST12_512;
2943 else if (s->cert->pkeys[SSL_PKEY_GOST12_256].x509)
2944 idx = SSL_PKEY_GOST12_256;
2945 else if (s->cert->pkeys[SSL_PKEY_GOST01].x509)
2946 idx = SSL_PKEY_GOST01;
2951 SSLerr(SSL_F_SSL_GET_SERVER_CERT_INDEX, ERR_R_INTERNAL_ERROR);
2955 CERT_PKEY *ssl_get_server_send_pkey(SSL *s)
2961 if (!s->s3 || !s->s3->tmp.new_cipher)
2965 i = ssl_get_server_cert_index(s);
2967 /* This may or may not be an error. */
2972 return &c->pkeys[i];
2975 EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *cipher,
2978 unsigned long alg_a;
2982 alg_a = cipher->algorithm_auth;
2985 if ((alg_a & SSL_aDSS) && (c->pkeys[SSL_PKEY_DSA_SIGN].privatekey != NULL))
2986 idx = SSL_PKEY_DSA_SIGN;
2987 else if (alg_a & SSL_aRSA) {
2988 if (c->pkeys[SSL_PKEY_RSA_SIGN].privatekey != NULL)
2989 idx = SSL_PKEY_RSA_SIGN;
2990 else if (c->pkeys[SSL_PKEY_RSA_ENC].privatekey != NULL)
2991 idx = SSL_PKEY_RSA_ENC;
2992 } else if ((alg_a & SSL_aECDSA) &&
2993 (c->pkeys[SSL_PKEY_ECC].privatekey != NULL))
2996 SSLerr(SSL_F_SSL_GET_SIGN_PKEY, ERR_R_INTERNAL_ERROR);
3000 *pmd = s->s3->tmp.md[idx];
3001 return c->pkeys[idx].privatekey;
3004 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3005 size_t *serverinfo_length)
3009 *serverinfo_length = 0;
3012 i = ssl_get_server_cert_index(s);
3016 if (c->pkeys[i].serverinfo == NULL)
3019 *serverinfo = c->pkeys[i].serverinfo;
3020 *serverinfo_length = c->pkeys[i].serverinfo_length;
3024 void ssl_update_cache(SSL *s, int mode)
3029 * If the session_id_length is 0, we are not supposed to cache it, and it
3030 * would be rather hard to do anyway :-)
3032 if (s->session->session_id_length == 0)
3036 * If sid_ctx_length is 0 there is no specific application context
3037 * associated with this session, so when we try to resume it and
3038 * SSL_VERIFY_PEER is requested, we have no indication that this is
3039 * actually a session for the proper application context, and the
3040 * *handshake* will fail, not just the resumption attempt.
3041 * Do not cache these sessions that are not resumable.
3043 if (s->session->sid_ctx_length == 0
3044 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3047 i = s->session_ctx->session_cache_mode;
3048 if ((i & mode) && (!s->hit)
3049 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
3050 || SSL_CTX_add_session(s->session_ctx, s->session))
3051 && (s->session_ctx->new_session_cb != NULL)) {
3052 SSL_SESSION_up_ref(s->session);
3053 if (!s->session_ctx->new_session_cb(s, s->session))
3054 SSL_SESSION_free(s->session);
3057 /* auto flush every 255 connections */
3058 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3059 if ((((mode & SSL_SESS_CACHE_CLIENT)
3060 ? s->session_ctx->stats.sess_connect_good
3061 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
3062 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3067 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3072 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3077 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3081 if (s->method != meth) {
3082 const SSL_METHOD *sm = s->method;
3083 int (*hf) (SSL *) = s->handshake_func;
3085 if (sm->version == meth->version)
3090 ret = s->method->ssl_new(s);
3093 if (hf == sm->ssl_connect)
3094 s->handshake_func = meth->ssl_connect;
3095 else if (hf == sm->ssl_accept)
3096 s->handshake_func = meth->ssl_accept;
3101 int SSL_get_error(const SSL *s, int i)
3108 return (SSL_ERROR_NONE);
3111 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3112 * where we do encode the error
3114 if ((l = ERR_peek_error()) != 0) {
3115 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3116 return (SSL_ERROR_SYSCALL);
3118 return (SSL_ERROR_SSL);
3122 if (SSL_want_read(s)) {
3123 bio = SSL_get_rbio(s);
3124 if (BIO_should_read(bio))
3125 return (SSL_ERROR_WANT_READ);
3126 else if (BIO_should_write(bio))
3128 * This one doesn't make too much sense ... We never try to write
3129 * to the rbio, and an application program where rbio and wbio
3130 * are separate couldn't even know what it should wait for.
3131 * However if we ever set s->rwstate incorrectly (so that we have
3132 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3133 * wbio *are* the same, this test works around that bug; so it
3134 * might be safer to keep it.
3136 return (SSL_ERROR_WANT_WRITE);
3137 else if (BIO_should_io_special(bio)) {
3138 reason = BIO_get_retry_reason(bio);
3139 if (reason == BIO_RR_CONNECT)
3140 return (SSL_ERROR_WANT_CONNECT);
3141 else if (reason == BIO_RR_ACCEPT)
3142 return (SSL_ERROR_WANT_ACCEPT);
3144 return (SSL_ERROR_SYSCALL); /* unknown */
3148 if (SSL_want_write(s)) {
3150 * Access wbio directly - in order to use the buffered bio if
3154 if (BIO_should_write(bio))
3155 return (SSL_ERROR_WANT_WRITE);
3156 else if (BIO_should_read(bio))
3158 * See above (SSL_want_read(s) with BIO_should_write(bio))
3160 return (SSL_ERROR_WANT_READ);
3161 else if (BIO_should_io_special(bio)) {
3162 reason = BIO_get_retry_reason(bio);
3163 if (reason == BIO_RR_CONNECT)
3164 return (SSL_ERROR_WANT_CONNECT);
3165 else if (reason == BIO_RR_ACCEPT)
3166 return (SSL_ERROR_WANT_ACCEPT);
3168 return (SSL_ERROR_SYSCALL);
3171 if (SSL_want_x509_lookup(s)) {
3172 return (SSL_ERROR_WANT_X509_LOOKUP);
3174 if (SSL_want_async(s)) {
3175 return SSL_ERROR_WANT_ASYNC;
3177 if (SSL_want_async_job(s)) {
3178 return SSL_ERROR_WANT_ASYNC_JOB;
3183 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3184 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3185 return (SSL_ERROR_ZERO_RETURN);
3187 return (SSL_ERROR_SYSCALL);
3190 static int ssl_do_handshake_intern(void *vargs)
3192 struct ssl_async_args *args;
3195 args = (struct ssl_async_args *)vargs;
3198 return s->handshake_func(s);
3201 int SSL_do_handshake(SSL *s)
3205 if (s->handshake_func == NULL) {
3206 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3210 s->method->ssl_renegotiate_check(s);
3212 if (SSL_in_init(s) || SSL_in_before(s)) {
3213 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3214 struct ssl_async_args args;
3218 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3220 ret = s->handshake_func(s);
3226 void SSL_set_accept_state(SSL *s)
3230 ossl_statem_clear(s);
3231 s->handshake_func = s->method->ssl_accept;
3235 void SSL_set_connect_state(SSL *s)
3239 ossl_statem_clear(s);
3240 s->handshake_func = s->method->ssl_connect;
3244 int ssl_undefined_function(SSL *s)
3246 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3250 int ssl_undefined_void_function(void)
3252 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3253 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3257 int ssl_undefined_const_function(const SSL *s)
3262 const SSL_METHOD *ssl_bad_method(int ver)
3264 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3268 const char *ssl_protocol_to_string(int version)
3270 if (version == TLS1_2_VERSION)
3272 else if (version == TLS1_1_VERSION)
3274 else if (version == TLS1_VERSION)
3276 else if (version == SSL3_VERSION)
3278 else if (version == DTLS1_BAD_VER)
3280 else if (version == DTLS1_VERSION)
3282 else if (version == DTLS1_2_VERSION)
3288 const char *SSL_get_version(const SSL *s)
3290 return ssl_protocol_to_string(s->version);
3293 SSL *SSL_dup(SSL *s)
3295 STACK_OF(X509_NAME) *sk;
3300 /* If we're not quiescent, just up_ref! */
3301 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3302 CRYPTO_atomic_add(&s->references, 1, &i, s->lock);
3307 * Otherwise, copy configuration state, and session if set.
3309 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3312 if (s->session != NULL) {
3314 * Arranges to share the same session via up_ref. This "copies"
3315 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3317 if (!SSL_copy_session_id(ret, s))
3321 * No session has been established yet, so we have to expect that
3322 * s->cert or ret->cert will be changed later -- they should not both
3323 * point to the same object, and thus we can't use
3324 * SSL_copy_session_id.
3326 if (!SSL_set_ssl_method(ret, s->method))
3329 if (s->cert != NULL) {
3330 ssl_cert_free(ret->cert);
3331 ret->cert = ssl_cert_dup(s->cert);
3332 if (ret->cert == NULL)
3336 if (!SSL_set_session_id_context(ret, s->sid_ctx, s->sid_ctx_length))
3340 if (!ssl_dane_dup(ret, s))
3342 ret->version = s->version;
3343 ret->options = s->options;
3344 ret->mode = s->mode;
3345 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3346 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3347 ret->msg_callback = s->msg_callback;
3348 ret->msg_callback_arg = s->msg_callback_arg;
3349 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3350 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3351 ret->generate_session_id = s->generate_session_id;
3353 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3355 /* copy app data, a little dangerous perhaps */
3356 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3359 /* setup rbio, and wbio */
3360 if (s->rbio != NULL) {
3361 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3364 if (s->wbio != NULL) {
3365 if (s->wbio != s->rbio) {
3366 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3369 BIO_up_ref(ret->rbio);
3370 ret->wbio = ret->rbio;
3374 ret->server = s->server;
3375 if (s->handshake_func) {
3377 SSL_set_accept_state(ret);
3379 SSL_set_connect_state(ret);
3381 ret->shutdown = s->shutdown;
3384 ret->default_passwd_callback = s->default_passwd_callback;
3385 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3387 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3389 /* dup the cipher_list and cipher_list_by_id stacks */
3390 if (s->cipher_list != NULL) {
3391 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3394 if (s->cipher_list_by_id != NULL)
3395 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3399 /* Dup the client_CA list */
3400 if (s->client_CA != NULL) {
3401 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3403 ret->client_CA = sk;
3404 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3405 xn = sk_X509_NAME_value(sk, i);
3406 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3419 void ssl_clear_cipher_ctx(SSL *s)
3421 if (s->enc_read_ctx != NULL) {
3422 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3423 s->enc_read_ctx = NULL;
3425 if (s->enc_write_ctx != NULL) {
3426 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3427 s->enc_write_ctx = NULL;
3429 #ifndef OPENSSL_NO_COMP
3430 COMP_CTX_free(s->expand);
3432 COMP_CTX_free(s->compress);
3437 X509 *SSL_get_certificate(const SSL *s)
3439 if (s->cert != NULL)
3440 return (s->cert->key->x509);
3445 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3447 if (s->cert != NULL)
3448 return (s->cert->key->privatekey);
3453 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3455 if (ctx->cert != NULL)
3456 return ctx->cert->key->x509;
3461 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3463 if (ctx->cert != NULL)
3464 return ctx->cert->key->privatekey;
3469 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3471 if ((s->session != NULL) && (s->session->cipher != NULL))
3472 return (s->session->cipher);
3476 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3478 #ifndef OPENSSL_NO_COMP
3479 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3485 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3487 #ifndef OPENSSL_NO_COMP
3488 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3494 int ssl_init_wbio_buffer(SSL *s)
3498 if (s->bbio != NULL) {
3499 /* Already buffered. */
3503 bbio = BIO_new(BIO_f_buffer());
3504 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3506 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3510 s->wbio = BIO_push(bbio, s->wbio);
3515 void ssl_free_wbio_buffer(SSL *s)
3517 /* callers ensure s is never null */
3518 if (s->bbio == NULL)
3521 s->wbio = BIO_pop(s->wbio);
3522 assert(s->wbio != NULL);
3527 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3529 ctx->quiet_shutdown = mode;
3532 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3534 return (ctx->quiet_shutdown);
3537 void SSL_set_quiet_shutdown(SSL *s, int mode)
3539 s->quiet_shutdown = mode;
3542 int SSL_get_quiet_shutdown(const SSL *s)
3544 return (s->quiet_shutdown);
3547 void SSL_set_shutdown(SSL *s, int mode)
3552 int SSL_get_shutdown(const SSL *s)
3557 int SSL_version(const SSL *s)
3562 int SSL_client_version(const SSL *s)
3564 return s->client_version;
3567 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3572 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3575 if (ssl->ctx == ctx)
3578 ctx = ssl->session_ctx;
3579 new_cert = ssl_cert_dup(ctx->cert);
3580 if (new_cert == NULL) {
3584 if (!custom_exts_copy_flags(&new_cert->srv_ext, &ssl->cert->srv_ext)) {
3585 ssl_cert_free(new_cert);
3589 ssl_cert_free(ssl->cert);
3590 ssl->cert = new_cert;
3593 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3594 * so setter APIs must prevent invalid lengths from entering the system.
3596 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3599 * If the session ID context matches that of the parent SSL_CTX,
3600 * inherit it from the new SSL_CTX as well. If however the context does
3601 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3602 * leave it unchanged.
3604 if ((ssl->ctx != NULL) &&
3605 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3606 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3607 ssl->sid_ctx_length = ctx->sid_ctx_length;
3608 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3611 SSL_CTX_up_ref(ctx);
3612 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3618 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3620 return (X509_STORE_set_default_paths(ctx->cert_store));
3623 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3625 X509_LOOKUP *lookup;
3627 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3630 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3632 /* Clear any errors if the default directory does not exist */
3638 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3640 X509_LOOKUP *lookup;
3642 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3646 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3648 /* Clear any errors if the default file does not exist */
3654 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3657 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3660 void SSL_set_info_callback(SSL *ssl,
3661 void (*cb) (const SSL *ssl, int type, int val))
3663 ssl->info_callback = cb;
3667 * One compiler (Diab DCC) doesn't like argument names in returned function
3670 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3673 return ssl->info_callback;
3676 void SSL_set_verify_result(SSL *ssl, long arg)
3678 ssl->verify_result = arg;
3681 long SSL_get_verify_result(const SSL *ssl)
3683 return (ssl->verify_result);
3686 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3689 return sizeof(ssl->s3->client_random);
3690 if (outlen > sizeof(ssl->s3->client_random))
3691 outlen = sizeof(ssl->s3->client_random);
3692 memcpy(out, ssl->s3->client_random, outlen);
3696 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3699 return sizeof(ssl->s3->server_random);
3700 if (outlen > sizeof(ssl->s3->server_random))
3701 outlen = sizeof(ssl->s3->server_random);
3702 memcpy(out, ssl->s3->server_random, outlen);
3706 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3707 unsigned char *out, size_t outlen)
3709 if (session->master_key_length < 0) {
3710 /* Should never happen */
3714 return session->master_key_length;
3715 if (outlen > (size_t)session->master_key_length)
3716 outlen = session->master_key_length;
3717 memcpy(out, session->master_key, outlen);
3721 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3723 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3726 void *SSL_get_ex_data(const SSL *s, int idx)
3728 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3731 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3733 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3736 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3738 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3746 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3748 return (ctx->cert_store);
3751 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3753 X509_STORE_free(ctx->cert_store);
3754 ctx->cert_store = store;
3757 int SSL_want(const SSL *s)
3759 return (s->rwstate);
3763 * \brief Set the callback for generating temporary DH keys.
3764 * \param ctx the SSL context.
3765 * \param dh the callback
3768 #ifndef OPENSSL_NO_DH
3769 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3770 DH *(*dh) (SSL *ssl, int is_export,
3773 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3776 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3779 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3783 #ifndef OPENSSL_NO_PSK
3784 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3786 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3787 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3790 OPENSSL_free(ctx->cert->psk_identity_hint);
3791 if (identity_hint != NULL) {
3792 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3793 if (ctx->cert->psk_identity_hint == NULL)
3796 ctx->cert->psk_identity_hint = NULL;
3800 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3805 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3806 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3809 OPENSSL_free(s->cert->psk_identity_hint);
3810 if (identity_hint != NULL) {
3811 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3812 if (s->cert->psk_identity_hint == NULL)
3815 s->cert->psk_identity_hint = NULL;
3819 const char *SSL_get_psk_identity_hint(const SSL *s)
3821 if (s == NULL || s->session == NULL)
3823 return (s->session->psk_identity_hint);
3826 const char *SSL_get_psk_identity(const SSL *s)
3828 if (s == NULL || s->session == NULL)
3830 return (s->session->psk_identity);
3833 void SSL_set_psk_client_callback(SSL *s,
3834 unsigned int (*cb) (SSL *ssl,
3840 unsigned int max_psk_len))
3842 s->psk_client_callback = cb;
3845 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx,
3846 unsigned int (*cb) (SSL *ssl,
3855 ctx->psk_client_callback = cb;
3858 void SSL_set_psk_server_callback(SSL *s,
3859 unsigned int (*cb) (SSL *ssl,
3860 const char *identity,
3862 unsigned int max_psk_len))
3864 s->psk_server_callback = cb;
3867 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx,
3868 unsigned int (*cb) (SSL *ssl,
3869 const char *identity,
3874 ctx->psk_server_callback = cb;
3878 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3879 void (*cb) (int write_p, int version,
3880 int content_type, const void *buf,
3881 size_t len, SSL *ssl, void *arg))
3883 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3886 void SSL_set_msg_callback(SSL *ssl,
3887 void (*cb) (int write_p, int version,
3888 int content_type, const void *buf,
3889 size_t len, SSL *ssl, void *arg))
3891 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3894 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3895 int (*cb) (SSL *ssl,
3899 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3900 (void (*)(void))cb);
3903 void SSL_set_not_resumable_session_callback(SSL *ssl,
3904 int (*cb) (SSL *ssl,
3905 int is_forward_secure))
3907 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3908 (void (*)(void))cb);
3912 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3913 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3914 * If EVP_MD pointer is passed, initializes ctx with this |md|.
3915 * Returns the newly allocated ctx;
3918 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3920 ssl_clear_hash_ctx(hash);
3921 *hash = EVP_MD_CTX_new();
3922 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3923 EVP_MD_CTX_free(*hash);
3930 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3934 EVP_MD_CTX_free(*hash);
3938 /* Retrieve handshake hashes */
3939 int ssl_handshake_hash(SSL *s, unsigned char *out, int outlen)
3941 EVP_MD_CTX *ctx = NULL;
3942 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3943 int ret = EVP_MD_CTX_size(hdgst);
3944 if (ret < 0 || ret > outlen) {
3948 ctx = EVP_MD_CTX_new();
3953 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3954 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3957 EVP_MD_CTX_free(ctx);
3961 int SSL_session_reused(SSL *s)
3966 int SSL_is_server(const SSL *s)
3971 #if OPENSSL_API_COMPAT < 0x10100000L
3972 void SSL_set_debug(SSL *s, int debug)
3974 /* Old function was do-nothing anyway... */
3980 void SSL_set_security_level(SSL *s, int level)
3982 s->cert->sec_level = level;
3985 int SSL_get_security_level(const SSL *s)
3987 return s->cert->sec_level;
3990 void SSL_set_security_callback(SSL *s,
3991 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3992 int op, int bits, int nid,
3993 void *other, void *ex))
3995 s->cert->sec_cb = cb;
3998 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
3999 const SSL_CTX *ctx, int op,
4000 int bits, int nid, void *other,
4002 return s->cert->sec_cb;
4005 void SSL_set0_security_ex_data(SSL *s, void *ex)
4007 s->cert->sec_ex = ex;
4010 void *SSL_get0_security_ex_data(const SSL *s)
4012 return s->cert->sec_ex;
4015 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4017 ctx->cert->sec_level = level;
4020 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4022 return ctx->cert->sec_level;
4025 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4026 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4027 int op, int bits, int nid,
4028 void *other, void *ex))
4030 ctx->cert->sec_cb = cb;
4033 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4039 return ctx->cert->sec_cb;
4042 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4044 ctx->cert->sec_ex = ex;
4047 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4049 return ctx->cert->sec_ex;
4053 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4054 * can return unsigned long, instead of the generic long return value from the
4055 * control interface.
4057 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4059 return ctx->options;
4062 unsigned long SSL_get_options(const SSL *s)
4067 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4069 return ctx->options |= op;
4072 unsigned long SSL_set_options(SSL *s, unsigned long op)
4074 return s->options |= op;
4077 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4079 return ctx->options &= ~op;
4082 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4084 return s->options &= ~op;
4087 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4089 return s->verified_chain;
4092 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4094 #ifndef OPENSSL_NO_CT
4097 * Moves SCTs from the |src| stack to the |dst| stack.
4098 * The source of each SCT will be set to |origin|.
4099 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4101 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4103 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4104 sct_source_t origin)
4110 *dst = sk_SCT_new_null();
4112 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4117 while ((sct = sk_SCT_pop(src)) != NULL) {
4118 if (SCT_set_source(sct, origin) != 1)
4121 if (sk_SCT_push(*dst, sct) <= 0)
4129 sk_SCT_push(src, sct); /* Put the SCT back */
4134 * Look for data collected during ServerHello and parse if found.
4135 * Returns the number of SCTs extracted.
4137 static int ct_extract_tls_extension_scts(SSL *s)
4139 int scts_extracted = 0;
4141 if (s->tlsext_scts != NULL) {
4142 const unsigned char *p = s->tlsext_scts;
4143 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->tlsext_scts_len);
4145 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4147 SCT_LIST_free(scts);
4150 return scts_extracted;
4154 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4155 * contains an SCT X509 extension. They will be stored in |s->scts|.
4157 * - The number of SCTs extracted, assuming an OCSP response exists.
4158 * - 0 if no OCSP response exists or it contains no SCTs.
4159 * - A negative integer if an error occurs.
4161 static int ct_extract_ocsp_response_scts(SSL *s)
4163 # ifndef OPENSSL_NO_OCSP
4164 int scts_extracted = 0;
4165 const unsigned char *p;
4166 OCSP_BASICRESP *br = NULL;
4167 OCSP_RESPONSE *rsp = NULL;
4168 STACK_OF(SCT) *scts = NULL;
4171 if (s->tlsext_ocsp_resp == NULL || s->tlsext_ocsp_resplen == 0)
4174 p = s->tlsext_ocsp_resp;
4175 rsp = d2i_OCSP_RESPONSE(NULL, &p, s->tlsext_ocsp_resplen);
4179 br = OCSP_response_get1_basic(rsp);
4183 for (i = 0; i < OCSP_resp_count(br); ++i) {
4184 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4190 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4192 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4193 if (scts_extracted < 0)
4197 SCT_LIST_free(scts);
4198 OCSP_BASICRESP_free(br);
4199 OCSP_RESPONSE_free(rsp);
4200 return scts_extracted;
4202 /* Behave as if no OCSP response exists */
4208 * Attempts to extract SCTs from the peer certificate.
4209 * Return the number of SCTs extracted, or a negative integer if an error
4212 static int ct_extract_x509v3_extension_scts(SSL *s)
4214 int scts_extracted = 0;
4215 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4218 STACK_OF(SCT) *scts =
4219 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4222 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4224 SCT_LIST_free(scts);
4227 return scts_extracted;
4231 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4232 * response (if it exists) and X509v3 extensions in the certificate.
4233 * Returns NULL if an error occurs.
4235 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4237 if (!s->scts_parsed) {
4238 if (ct_extract_tls_extension_scts(s) < 0 ||
4239 ct_extract_ocsp_response_scts(s) < 0 ||
4240 ct_extract_x509v3_extension_scts(s) < 0)
4250 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4251 const STACK_OF(SCT) *scts, void *unused_arg)
4256 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4257 const STACK_OF(SCT) *scts, void *unused_arg)
4259 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4262 for (i = 0; i < count; ++i) {
4263 SCT *sct = sk_SCT_value(scts, i);
4264 int status = SCT_get_validation_status(sct);
4266 if (status == SCT_VALIDATION_STATUS_VALID)
4269 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4273 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4277 * Since code exists that uses the custom extension handler for CT, look
4278 * for this and throw an error if they have already registered to use CT.
4280 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4281 TLSEXT_TYPE_signed_certificate_timestamp))
4283 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4284 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4288 if (callback != NULL) {
4290 * If we are validating CT, then we MUST accept SCTs served via OCSP
4292 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4296 s->ct_validation_callback = callback;
4297 s->ct_validation_callback_arg = arg;
4302 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4303 ssl_ct_validation_cb callback, void *arg)
4306 * Since code exists that uses the custom extension handler for CT, look for
4307 * this and throw an error if they have already registered to use CT.
4309 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4310 TLSEXT_TYPE_signed_certificate_timestamp))
4312 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4313 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4317 ctx->ct_validation_callback = callback;
4318 ctx->ct_validation_callback_arg = arg;
4322 int SSL_ct_is_enabled(const SSL *s)
4324 return s->ct_validation_callback != NULL;
4327 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4329 return ctx->ct_validation_callback != NULL;
4332 int ssl_validate_ct(SSL *s)
4335 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4337 SSL_DANE *dane = &s->dane;
4338 CT_POLICY_EVAL_CTX *ctx = NULL;
4339 const STACK_OF(SCT) *scts;
4342 * If no callback is set, the peer is anonymous, or its chain is invalid,
4343 * skip SCT validation - just return success. Applications that continue
4344 * handshakes without certificates, with unverified chains, or pinned leaf
4345 * certificates are outside the scope of the WebPKI and CT.
4347 * The above exclusions notwithstanding the vast majority of peers will
4348 * have rather ordinary certificate chains validated by typical
4349 * applications that perform certificate verification and therefore will
4350 * process SCTs when enabled.
4352 if (s->ct_validation_callback == NULL || cert == NULL ||
4353 s->verify_result != X509_V_OK ||
4354 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4358 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4359 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4361 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4362 switch (dane->mtlsa->usage) {
4363 case DANETLS_USAGE_DANE_TA:
4364 case DANETLS_USAGE_DANE_EE:
4369 ctx = CT_POLICY_EVAL_CTX_new();
4371 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4375 issuer = sk_X509_value(s->verified_chain, 1);
4376 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4377 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4378 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4379 CT_POLICY_EVAL_CTX_set_time(
4380 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4382 scts = SSL_get0_peer_scts(s);
4385 * This function returns success (> 0) only when all the SCTs are valid, 0
4386 * when some are invalid, and < 0 on various internal errors (out of
4387 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4388 * reason to abort the handshake, that decision is up to the callback.
4389 * Therefore, we error out only in the unexpected case that the return
4390 * value is negative.
4392 * XXX: One might well argue that the return value of this function is an
4393 * unfortunate design choice. Its job is only to determine the validation
4394 * status of each of the provided SCTs. So long as it correctly separates
4395 * the wheat from the chaff it should return success. Failure in this case
4396 * ought to correspond to an inability to carry out its duties.
4398 if (SCT_LIST_validate(scts, ctx) < 0) {
4399 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4403 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4405 ret = 0; /* This function returns 0 on failure */
4408 CT_POLICY_EVAL_CTX_free(ctx);
4410 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4411 * failure return code here. Also the application may wish the complete
4412 * the handshake, and then disconnect cleanly at a higher layer, after
4413 * checking the verification status of the completed connection.
4415 * We therefore force a certificate verification failure which will be
4416 * visible via SSL_get_verify_result() and cached as part of any resumed
4419 * Note: the permissive callback is for information gathering only, always
4420 * returns success, and does not affect verification status. Only the
4421 * strict callback or a custom application-specified callback can trigger
4422 * connection failure or record a verification error.
4425 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4429 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4431 switch (validation_mode) {
4433 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4435 case SSL_CT_VALIDATION_PERMISSIVE:
4436 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4437 case SSL_CT_VALIDATION_STRICT:
4438 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4442 int SSL_enable_ct(SSL *s, int validation_mode)
4444 switch (validation_mode) {
4446 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4448 case SSL_CT_VALIDATION_PERMISSIVE:
4449 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4450 case SSL_CT_VALIDATION_STRICT:
4451 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4455 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4457 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4460 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4462 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4465 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4467 CTLOG_STORE_free(ctx->ctlog_store);
4468 ctx->ctlog_store = logs;
4471 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4473 return ctx->ctlog_store;