2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 * ECC cipher suite support in OpenSSL originally developed by
13 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
15 /* ====================================================================
16 * Copyright 2005 Nokia. All rights reserved.
18 * The portions of the attached software ("Contribution") is developed by
19 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
22 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24 * support (see RFC 4279) to OpenSSL.
26 * No patent licenses or other rights except those expressly stated in
27 * the OpenSSL open source license shall be deemed granted or received
28 * expressly, by implication, estoppel, or otherwise.
30 * No assurances are provided by Nokia that the Contribution does not
31 * infringe the patent or other intellectual property rights of any third
32 * party or that the license provides you with all the necessary rights
33 * to make use of the Contribution.
35 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
45 #include <openssl/objects.h>
46 #include <openssl/lhash.h>
47 #include <openssl/x509v3.h>
48 #include <openssl/rand.h>
49 #include <openssl/ocsp.h>
50 #include <openssl/dh.h>
51 #include <openssl/engine.h>
52 #include <openssl/async.h>
53 #include <openssl/ct.h>
55 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
57 SSL3_ENC_METHOD ssl3_undef_enc_method = {
59 * evil casts, but these functions are only called if there's a library
62 (int (*)(SSL *, SSL3_RECORD *, size_t, int))ssl_undefined_function,
63 (int (*)(SSL *, SSL3_RECORD *, unsigned char *, int))ssl_undefined_function,
64 ssl_undefined_function,
65 (int (*)(SSL *, unsigned char *, unsigned char *, size_t, size_t *))
66 ssl_undefined_function,
67 (int (*)(SSL *, int))ssl_undefined_function,
68 (size_t (*)(SSL *, const char *, size_t, unsigned char *))
69 ssl_undefined_function,
70 NULL, /* client_finished_label */
71 0, /* client_finished_label_len */
72 NULL, /* server_finished_label */
73 0, /* server_finished_label_len */
74 (int (*)(int))ssl_undefined_function,
75 (int (*)(SSL *, unsigned char *, size_t, const char *,
76 size_t, const unsigned char *, size_t,
77 int use_context))ssl_undefined_function,
80 struct ssl_async_args {
84 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
86 int (*func_read) (SSL *, void *, size_t, size_t *);
87 int (*func_write) (SSL *, const void *, size_t, size_t *);
88 int (*func_other) (SSL *);
98 DANETLS_MATCHING_FULL, 0, NID_undef
101 DANETLS_MATCHING_2256, 1, NID_sha256
104 DANETLS_MATCHING_2512, 2, NID_sha512
108 static int dane_ctx_enable(struct dane_ctx_st *dctx)
110 const EVP_MD **mdevp;
112 uint8_t mdmax = DANETLS_MATCHING_LAST;
113 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
116 if (dctx->mdevp != NULL)
119 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
120 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
122 if (mdord == NULL || mdevp == NULL) {
125 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
129 /* Install default entries */
130 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
133 if (dane_mds[i].nid == NID_undef ||
134 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
136 mdevp[dane_mds[i].mtype] = md;
137 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
147 static void dane_ctx_final(struct dane_ctx_st *dctx)
149 OPENSSL_free(dctx->mdevp);
152 OPENSSL_free(dctx->mdord);
157 static void tlsa_free(danetls_record *t)
161 OPENSSL_free(t->data);
162 EVP_PKEY_free(t->spki);
166 static void dane_final(SSL_DANE *dane)
168 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
171 sk_X509_pop_free(dane->certs, X509_free);
174 X509_free(dane->mcert);
182 * dane_copy - Copy dane configuration, sans verification state.
184 static int ssl_dane_dup(SSL *to, SSL *from)
189 if (!DANETLS_ENABLED(&from->dane))
192 dane_final(&to->dane);
193 to->dane.flags = from->dane.flags;
194 to->dane.dctx = &to->ctx->dane;
195 to->dane.trecs = sk_danetls_record_new_null();
197 if (to->dane.trecs == NULL) {
198 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
202 num = sk_danetls_record_num(from->dane.trecs);
203 for (i = 0; i < num; ++i) {
204 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
206 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
207 t->data, t->dlen) <= 0)
213 static int dane_mtype_set(struct dane_ctx_st *dctx,
214 const EVP_MD *md, uint8_t mtype, uint8_t ord)
218 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
219 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
223 if (mtype > dctx->mdmax) {
224 const EVP_MD **mdevp;
226 int n = ((int)mtype) + 1;
228 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
230 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
235 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
237 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
242 /* Zero-fill any gaps */
243 for (i = dctx->mdmax + 1; i < mtype; ++i) {
251 dctx->mdevp[mtype] = md;
252 /* Coerce ordinal of disabled matching types to 0 */
253 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
258 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
260 if (mtype > dane->dctx->mdmax)
262 return dane->dctx->mdevp[mtype];
265 static int dane_tlsa_add(SSL_DANE *dane,
268 uint8_t mtype, unsigned char *data, size_t dlen)
271 const EVP_MD *md = NULL;
272 int ilen = (int)dlen;
276 if (dane->trecs == NULL) {
277 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
281 if (ilen < 0 || dlen != (size_t)ilen) {
282 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
286 if (usage > DANETLS_USAGE_LAST) {
287 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
291 if (selector > DANETLS_SELECTOR_LAST) {
292 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
296 if (mtype != DANETLS_MATCHING_FULL) {
297 md = tlsa_md_get(dane, mtype);
299 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
304 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
305 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
309 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
313 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
314 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
319 t->selector = selector;
321 t->data = OPENSSL_malloc(dlen);
322 if (t->data == NULL) {
324 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
327 memcpy(t->data, data, dlen);
330 /* Validate and cache full certificate or public key */
331 if (mtype == DANETLS_MATCHING_FULL) {
332 const unsigned char *p = data;
334 EVP_PKEY *pkey = NULL;
337 case DANETLS_SELECTOR_CERT:
338 if (!d2i_X509(&cert, &p, ilen) || p < data ||
339 dlen != (size_t)(p - data)) {
341 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
344 if (X509_get0_pubkey(cert) == NULL) {
346 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
350 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
356 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
357 * records that contain full certificates of trust-anchors that are
358 * not present in the wire chain. For usage PKIX-TA(0), we augment
359 * the chain with untrusted Full(0) certificates from DNS, in case
360 * they are missing from the chain.
362 if ((dane->certs == NULL &&
363 (dane->certs = sk_X509_new_null()) == NULL) ||
364 !sk_X509_push(dane->certs, cert)) {
365 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
372 case DANETLS_SELECTOR_SPKI:
373 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
374 dlen != (size_t)(p - data)) {
376 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
381 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
382 * records that contain full bare keys of trust-anchors that are
383 * not present in the wire chain.
385 if (usage == DANETLS_USAGE_DANE_TA)
394 * Find the right insertion point for the new record.
396 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
397 * they can be processed first, as they require no chain building, and no
398 * expiration or hostname checks. Because DANE-EE(3) is numerically
399 * largest, this is accomplished via descending sort by "usage".
401 * We also sort in descending order by matching ordinal to simplify
402 * the implementation of digest agility in the verification code.
404 * The choice of order for the selector is not significant, so we
405 * use the same descending order for consistency.
407 num = sk_danetls_record_num(dane->trecs);
408 for (i = 0; i < num; ++i) {
409 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
411 if (rec->usage > usage)
413 if (rec->usage < usage)
415 if (rec->selector > selector)
417 if (rec->selector < selector)
419 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
424 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
426 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
429 dane->umask |= DANETLS_USAGE_BIT(usage);
434 static void clear_ciphers(SSL *s)
436 /* clear the current cipher */
437 ssl_clear_cipher_ctx(s);
438 ssl_clear_hash_ctx(&s->read_hash);
439 ssl_clear_hash_ctx(&s->write_hash);
442 int SSL_clear(SSL *s)
444 if (s->method == NULL) {
445 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
449 if (ssl_clear_bad_session(s)) {
450 SSL_SESSION_free(s->session);
458 if (s->renegotiate) {
459 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
463 ossl_statem_clear(s);
465 s->version = s->method->version;
466 s->client_version = s->version;
467 s->rwstate = SSL_NOTHING;
469 BUF_MEM_free(s->init_buf);
474 s->key_update = SSL_KEY_UPDATE_NONE;
476 /* Reset DANE verification result state */
479 X509_free(s->dane.mcert);
480 s->dane.mcert = NULL;
481 s->dane.mtlsa = NULL;
483 /* Clear the verification result peername */
484 X509_VERIFY_PARAM_move_peername(s->param, NULL);
487 * Check to see if we were changed into a different method, if so, revert
488 * back if we are not doing session-id reuse.
490 if (!ossl_statem_get_in_handshake(s) && (s->session == NULL)
491 && (s->method != s->ctx->method)) {
492 s->method->ssl_free(s);
493 s->method = s->ctx->method;
494 if (!s->method->ssl_new(s))
497 s->method->ssl_clear(s);
499 RECORD_LAYER_clear(&s->rlayer);
504 /** Used to change an SSL_CTXs default SSL method type */
505 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
507 STACK_OF(SSL_CIPHER) *sk;
511 sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
512 &(ctx->cipher_list_by_id),
513 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
514 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
515 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
521 SSL *SSL_new(SSL_CTX *ctx)
526 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
529 if (ctx->method == NULL) {
530 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
534 s = OPENSSL_zalloc(sizeof(*s));
538 s->lock = CRYPTO_THREAD_lock_new();
539 if (s->lock == NULL) {
540 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
545 RECORD_LAYER_init(&s->rlayer, s);
547 s->options = ctx->options;
548 s->dane.flags = ctx->dane.flags;
549 s->min_proto_version = ctx->min_proto_version;
550 s->max_proto_version = ctx->max_proto_version;
552 s->max_cert_list = ctx->max_cert_list;
556 * Earlier library versions used to copy the pointer to the CERT, not
557 * its contents; only when setting new parameters for the per-SSL
558 * copy, ssl_cert_new would be called (and the direct reference to
559 * the per-SSL_CTX settings would be lost, but those still were
560 * indirectly accessed for various purposes, and for that reason they
561 * used to be known as s->ctx->default_cert). Now we don't look at the
562 * SSL_CTX's CERT after having duplicated it once.
564 s->cert = ssl_cert_dup(ctx->cert);
568 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
569 s->msg_callback = ctx->msg_callback;
570 s->msg_callback_arg = ctx->msg_callback_arg;
571 s->verify_mode = ctx->verify_mode;
572 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
573 s->sid_ctx_length = ctx->sid_ctx_length;
574 OPENSSL_assert(s->sid_ctx_length <= sizeof s->sid_ctx);
575 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
576 s->verify_callback = ctx->default_verify_callback;
577 s->generate_session_id = ctx->generate_session_id;
579 s->param = X509_VERIFY_PARAM_new();
580 if (s->param == NULL)
582 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
583 s->quiet_shutdown = ctx->quiet_shutdown;
584 s->max_send_fragment = ctx->max_send_fragment;
585 s->split_send_fragment = ctx->split_send_fragment;
586 s->max_pipelines = ctx->max_pipelines;
587 if (s->max_pipelines > 1)
588 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
589 if (ctx->default_read_buf_len > 0)
590 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
595 s->ext.debug_arg = NULL;
596 s->ext.ticket_expected = 0;
597 s->ext.status_type = ctx->ext.status_type;
598 s->ext.status_expected = 0;
599 s->ext.ocsp.ids = NULL;
600 s->ext.ocsp.exts = NULL;
601 s->ext.ocsp.resp = NULL;
602 s->ext.ocsp.resp_len = 0;
604 s->session_ctx = ctx;
605 #ifndef OPENSSL_NO_EC
606 if (ctx->ext.ecpointformats) {
607 s->ext.ecpointformats =
608 OPENSSL_memdup(ctx->ext.ecpointformats,
609 ctx->ext.ecpointformats_len);
610 if (!s->ext.ecpointformats)
612 s->ext.ecpointformats_len =
613 ctx->ext.ecpointformats_len;
615 if (ctx->ext.supportedgroups) {
616 s->ext.supportedgroups =
617 OPENSSL_memdup(ctx->ext.supportedgroups,
618 ctx->ext.supportedgroups_len);
619 if (!s->ext.supportedgroups)
621 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
624 #ifndef OPENSSL_NO_NEXTPROTONEG
628 if (s->ctx->ext.alpn) {
629 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
630 if (s->ext.alpn == NULL)
632 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
633 s->ext.alpn_len = s->ctx->ext.alpn_len;
636 s->verified_chain = NULL;
637 s->verify_result = X509_V_OK;
639 s->default_passwd_callback = ctx->default_passwd_callback;
640 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
642 s->method = ctx->method;
644 s->key_update = SSL_KEY_UPDATE_NONE;
646 if (!s->method->ssl_new(s))
649 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
654 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
657 #ifndef OPENSSL_NO_PSK
658 s->psk_client_callback = ctx->psk_client_callback;
659 s->psk_server_callback = ctx->psk_server_callback;
664 #ifndef OPENSSL_NO_CT
665 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
666 ctx->ct_validation_callback_arg))
673 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
677 int SSL_is_dtls(const SSL *s)
679 return SSL_IS_DTLS(s) ? 1 : 0;
682 int SSL_up_ref(SSL *s)
686 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
689 REF_PRINT_COUNT("SSL", s);
690 REF_ASSERT_ISNT(i < 2);
691 return ((i > 1) ? 1 : 0);
694 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
695 unsigned int sid_ctx_len)
697 if (sid_ctx_len > sizeof ctx->sid_ctx) {
698 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
699 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
702 ctx->sid_ctx_length = sid_ctx_len;
703 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
708 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
709 unsigned int sid_ctx_len)
711 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
712 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
713 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
716 ssl->sid_ctx_length = sid_ctx_len;
717 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
722 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
724 CRYPTO_THREAD_write_lock(ctx->lock);
725 ctx->generate_session_id = cb;
726 CRYPTO_THREAD_unlock(ctx->lock);
730 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
732 CRYPTO_THREAD_write_lock(ssl->lock);
733 ssl->generate_session_id = cb;
734 CRYPTO_THREAD_unlock(ssl->lock);
738 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
742 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
743 * we can "construct" a session to give us the desired check - ie. to
744 * find if there's a session in the hash table that would conflict with
745 * any new session built out of this id/id_len and the ssl_version in use
750 if (id_len > sizeof r.session_id)
753 r.ssl_version = ssl->version;
754 r.session_id_length = id_len;
755 memcpy(r.session_id, id, id_len);
757 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
758 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
759 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
763 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
765 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
768 int SSL_set_purpose(SSL *s, int purpose)
770 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
773 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
775 return X509_VERIFY_PARAM_set_trust(s->param, trust);
778 int SSL_set_trust(SSL *s, int trust)
780 return X509_VERIFY_PARAM_set_trust(s->param, trust);
783 int SSL_set1_host(SSL *s, const char *hostname)
785 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
788 int SSL_add1_host(SSL *s, const char *hostname)
790 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
793 void SSL_set_hostflags(SSL *s, unsigned int flags)
795 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
798 const char *SSL_get0_peername(SSL *s)
800 return X509_VERIFY_PARAM_get0_peername(s->param);
803 int SSL_CTX_dane_enable(SSL_CTX *ctx)
805 return dane_ctx_enable(&ctx->dane);
808 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
810 unsigned long orig = ctx->dane.flags;
812 ctx->dane.flags |= flags;
816 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
818 unsigned long orig = ctx->dane.flags;
820 ctx->dane.flags &= ~flags;
824 int SSL_dane_enable(SSL *s, const char *basedomain)
826 SSL_DANE *dane = &s->dane;
828 if (s->ctx->dane.mdmax == 0) {
829 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
832 if (dane->trecs != NULL) {
833 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
838 * Default SNI name. This rejects empty names, while set1_host below
839 * accepts them and disables host name checks. To avoid side-effects with
840 * invalid input, set the SNI name first.
842 if (s->ext.hostname == NULL) {
843 if (!SSL_set_tlsext_host_name(s, basedomain)) {
844 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
849 /* Primary RFC6125 reference identifier */
850 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
851 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
857 dane->dctx = &s->ctx->dane;
858 dane->trecs = sk_danetls_record_new_null();
860 if (dane->trecs == NULL) {
861 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
867 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
869 unsigned long orig = ssl->dane.flags;
871 ssl->dane.flags |= flags;
875 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
877 unsigned long orig = ssl->dane.flags;
879 ssl->dane.flags &= ~flags;
883 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
885 SSL_DANE *dane = &s->dane;
887 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
891 *mcert = dane->mcert;
893 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
898 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
899 uint8_t *mtype, unsigned const char **data, size_t *dlen)
901 SSL_DANE *dane = &s->dane;
903 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
907 *usage = dane->mtlsa->usage;
909 *selector = dane->mtlsa->selector;
911 *mtype = dane->mtlsa->mtype;
913 *data = dane->mtlsa->data;
915 *dlen = dane->mtlsa->dlen;
920 SSL_DANE *SSL_get0_dane(SSL *s)
925 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
926 uint8_t mtype, unsigned char *data, size_t dlen)
928 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
931 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
934 return dane_mtype_set(&ctx->dane, md, mtype, ord);
937 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
939 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
942 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
944 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
947 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
952 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
957 void SSL_certs_clear(SSL *s)
959 ssl_cert_clear_certs(s->cert);
962 void SSL_free(SSL *s)
969 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
970 REF_PRINT_COUNT("SSL", s);
973 REF_ASSERT_ISNT(i < 0);
975 X509_VERIFY_PARAM_free(s->param);
976 dane_final(&s->dane);
977 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
979 ssl_free_wbio_buffer(s);
981 BIO_free_all(s->wbio);
982 BIO_free_all(s->rbio);
984 BUF_MEM_free(s->init_buf);
986 /* add extra stuff */
987 sk_SSL_CIPHER_free(s->cipher_list);
988 sk_SSL_CIPHER_free(s->cipher_list_by_id);
990 /* Make the next call work :-) */
991 if (s->session != NULL) {
992 ssl_clear_bad_session(s);
993 SSL_SESSION_free(s->session);
998 ssl_cert_free(s->cert);
999 /* Free up if allocated */
1001 OPENSSL_free(s->ext.hostname);
1002 SSL_CTX_free(s->session_ctx);
1003 #ifndef OPENSSL_NO_EC
1004 OPENSSL_free(s->ext.ecpointformats);
1005 OPENSSL_free(s->ext.supportedgroups);
1006 #endif /* OPENSSL_NO_EC */
1007 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1008 #ifndef OPENSSL_NO_OCSP
1009 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1011 #ifndef OPENSSL_NO_CT
1012 SCT_LIST_free(s->scts);
1013 OPENSSL_free(s->ext.scts);
1015 OPENSSL_free(s->ext.ocsp.resp);
1016 OPENSSL_free(s->ext.alpn);
1018 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1020 sk_X509_pop_free(s->verified_chain, X509_free);
1022 if (s->method != NULL)
1023 s->method->ssl_free(s);
1025 RECORD_LAYER_release(&s->rlayer);
1027 SSL_CTX_free(s->ctx);
1029 ASYNC_WAIT_CTX_free(s->waitctx);
1031 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1032 OPENSSL_free(s->ext.npn);
1035 #ifndef OPENSSL_NO_SRTP
1036 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1039 CRYPTO_THREAD_lock_free(s->lock);
1044 void SSL_set0_rbio(SSL *s, BIO *rbio)
1046 BIO_free_all(s->rbio);
1050 void SSL_set0_wbio(SSL *s, BIO *wbio)
1053 * If the output buffering BIO is still in place, remove it
1055 if (s->bbio != NULL)
1056 s->wbio = BIO_pop(s->wbio);
1058 BIO_free_all(s->wbio);
1061 /* Re-attach |bbio| to the new |wbio|. */
1062 if (s->bbio != NULL)
1063 s->wbio = BIO_push(s->bbio, s->wbio);
1066 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1069 * For historical reasons, this function has many different cases in
1070 * ownership handling.
1073 /* If nothing has changed, do nothing */
1074 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1078 * If the two arguments are equal then one fewer reference is granted by the
1079 * caller than we want to take
1081 if (rbio != NULL && rbio == wbio)
1085 * If only the wbio is changed only adopt one reference.
1087 if (rbio == SSL_get_rbio(s)) {
1088 SSL_set0_wbio(s, wbio);
1092 * There is an asymmetry here for historical reasons. If only the rbio is
1093 * changed AND the rbio and wbio were originally different, then we only
1094 * adopt one reference.
1096 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1097 SSL_set0_rbio(s, rbio);
1101 /* Otherwise, adopt both references. */
1102 SSL_set0_rbio(s, rbio);
1103 SSL_set0_wbio(s, wbio);
1106 BIO *SSL_get_rbio(const SSL *s)
1111 BIO *SSL_get_wbio(const SSL *s)
1113 if (s->bbio != NULL) {
1115 * If |bbio| is active, the true caller-configured BIO is its
1118 return BIO_next(s->bbio);
1123 int SSL_get_fd(const SSL *s)
1125 return SSL_get_rfd(s);
1128 int SSL_get_rfd(const SSL *s)
1133 b = SSL_get_rbio(s);
1134 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1136 BIO_get_fd(r, &ret);
1140 int SSL_get_wfd(const SSL *s)
1145 b = SSL_get_wbio(s);
1146 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1148 BIO_get_fd(r, &ret);
1152 #ifndef OPENSSL_NO_SOCK
1153 int SSL_set_fd(SSL *s, int fd)
1158 bio = BIO_new(BIO_s_socket());
1161 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1164 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1165 SSL_set_bio(s, bio, bio);
1171 int SSL_set_wfd(SSL *s, int fd)
1173 BIO *rbio = SSL_get_rbio(s);
1175 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1176 || (int)BIO_get_fd(rbio, NULL) != fd) {
1177 BIO *bio = BIO_new(BIO_s_socket());
1180 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1183 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1184 SSL_set0_wbio(s, bio);
1187 SSL_set0_wbio(s, rbio);
1192 int SSL_set_rfd(SSL *s, int fd)
1194 BIO *wbio = SSL_get_wbio(s);
1196 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1197 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1198 BIO *bio = BIO_new(BIO_s_socket());
1201 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1204 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1205 SSL_set0_rbio(s, bio);
1208 SSL_set0_rbio(s, wbio);
1215 /* return length of latest Finished message we sent, copy to 'buf' */
1216 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1220 if (s->s3 != NULL) {
1221 ret = s->s3->tmp.finish_md_len;
1224 memcpy(buf, s->s3->tmp.finish_md, count);
1229 /* return length of latest Finished message we expected, copy to 'buf' */
1230 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1234 if (s->s3 != NULL) {
1235 ret = s->s3->tmp.peer_finish_md_len;
1238 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1243 int SSL_get_verify_mode(const SSL *s)
1245 return (s->verify_mode);
1248 int SSL_get_verify_depth(const SSL *s)
1250 return X509_VERIFY_PARAM_get_depth(s->param);
1253 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1254 return (s->verify_callback);
1257 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1259 return (ctx->verify_mode);
1262 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1264 return X509_VERIFY_PARAM_get_depth(ctx->param);
1267 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1268 return (ctx->default_verify_callback);
1271 void SSL_set_verify(SSL *s, int mode,
1272 int (*callback) (int ok, X509_STORE_CTX *ctx))
1274 s->verify_mode = mode;
1275 if (callback != NULL)
1276 s->verify_callback = callback;
1279 void SSL_set_verify_depth(SSL *s, int depth)
1281 X509_VERIFY_PARAM_set_depth(s->param, depth);
1284 void SSL_set_read_ahead(SSL *s, int yes)
1286 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1289 int SSL_get_read_ahead(const SSL *s)
1291 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1294 int SSL_pending(const SSL *s)
1296 size_t pending = s->method->ssl_pending(s);
1299 * SSL_pending cannot work properly if read-ahead is enabled
1300 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1301 * impossible to fix since SSL_pending cannot report errors that may be
1302 * observed while scanning the new data. (Note that SSL_pending() is
1303 * often used as a boolean value, so we'd better not return -1.)
1305 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1306 * we just return INT_MAX.
1308 return pending < INT_MAX ? (int)pending : INT_MAX;
1311 int SSL_has_pending(const SSL *s)
1314 * Similar to SSL_pending() but returns a 1 to indicate that we have
1315 * unprocessed data available or 0 otherwise (as opposed to the number of
1316 * bytes available). Unlike SSL_pending() this will take into account
1317 * read_ahead data. A 1 return simply indicates that we have unprocessed
1318 * data. That data may not result in any application data, or we may fail
1319 * to parse the records for some reason.
1324 return RECORD_LAYER_read_pending(&s->rlayer);
1327 X509 *SSL_get_peer_certificate(const SSL *s)
1331 if ((s == NULL) || (s->session == NULL))
1334 r = s->session->peer;
1344 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1348 if ((s == NULL) || (s->session == NULL))
1351 r = s->session->peer_chain;
1354 * If we are a client, cert_chain includes the peer's own certificate; if
1355 * we are a server, it does not.
1362 * Now in theory, since the calling process own 't' it should be safe to
1363 * modify. We need to be able to read f without being hassled
1365 int SSL_copy_session_id(SSL *t, const SSL *f)
1368 /* Do we need to to SSL locking? */
1369 if (!SSL_set_session(t, SSL_get_session(f))) {
1374 * what if we are setup for one protocol version but want to talk another
1376 if (t->method != f->method) {
1377 t->method->ssl_free(t);
1378 t->method = f->method;
1379 if (t->method->ssl_new(t) == 0)
1383 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1384 ssl_cert_free(t->cert);
1386 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1393 /* Fix this so it checks all the valid key/cert options */
1394 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1396 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1397 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1400 if (ctx->cert->key->privatekey == NULL) {
1401 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1404 return (X509_check_private_key
1405 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1408 /* Fix this function so that it takes an optional type parameter */
1409 int SSL_check_private_key(const SSL *ssl)
1412 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1415 if (ssl->cert->key->x509 == NULL) {
1416 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1419 if (ssl->cert->key->privatekey == NULL) {
1420 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1423 return (X509_check_private_key(ssl->cert->key->x509,
1424 ssl->cert->key->privatekey));
1427 int SSL_waiting_for_async(SSL *s)
1435 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1437 ASYNC_WAIT_CTX *ctx = s->waitctx;
1441 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1444 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1445 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1447 ASYNC_WAIT_CTX *ctx = s->waitctx;
1451 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1455 int SSL_accept(SSL *s)
1457 if (s->handshake_func == NULL) {
1458 /* Not properly initialized yet */
1459 SSL_set_accept_state(s);
1462 return SSL_do_handshake(s);
1465 int SSL_connect(SSL *s)
1467 if (s->handshake_func == NULL) {
1468 /* Not properly initialized yet */
1469 SSL_set_connect_state(s);
1472 return SSL_do_handshake(s);
1475 long SSL_get_default_timeout(const SSL *s)
1477 return (s->method->get_timeout());
1480 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1481 int (*func) (void *))
1484 if (s->waitctx == NULL) {
1485 s->waitctx = ASYNC_WAIT_CTX_new();
1486 if (s->waitctx == NULL)
1489 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1490 sizeof(struct ssl_async_args))) {
1492 s->rwstate = SSL_NOTHING;
1493 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1496 s->rwstate = SSL_ASYNC_PAUSED;
1499 s->rwstate = SSL_ASYNC_NO_JOBS;
1505 s->rwstate = SSL_NOTHING;
1506 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1507 /* Shouldn't happen */
1512 static int ssl_io_intern(void *vargs)
1514 struct ssl_async_args *args;
1519 args = (struct ssl_async_args *)vargs;
1523 switch (args->type) {
1525 return args->f.func_read(s, buf, num, &s->asyncrw);
1527 return args->f.func_write(s, buf, num, &s->asyncrw);
1529 return args->f.func_other(s);
1534 int SSL_read(SSL *s, void *buf, int num)
1540 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1544 ret = SSL_read_ex(s, buf, (size_t)num, &readbytes);
1547 * The cast is safe here because ret should be <= INT_MAX because num is
1551 ret = (int)readbytes;
1556 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1558 if (s->handshake_func == NULL) {
1559 SSLerr(SSL_F_SSL_READ_EX, SSL_R_UNINITIALIZED);
1563 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1564 s->rwstate = SSL_NOTHING;
1568 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1569 struct ssl_async_args args;
1575 args.type = READFUNC;
1576 args.f.func_read = s->method->ssl_read;
1578 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1579 *readbytes = s->asyncrw;
1582 return s->method->ssl_read(s, buf, num, readbytes);
1586 int SSL_peek(SSL *s, void *buf, int num)
1592 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1596 ret = SSL_peek_ex(s, buf, (size_t)num, &readbytes);
1599 * The cast is safe here because ret should be <= INT_MAX because num is
1603 ret = (int)readbytes;
1608 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1610 if (s->handshake_func == NULL) {
1611 SSLerr(SSL_F_SSL_PEEK_EX, SSL_R_UNINITIALIZED);
1615 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1618 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1619 struct ssl_async_args args;
1625 args.type = READFUNC;
1626 args.f.func_read = s->method->ssl_peek;
1628 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1629 *readbytes = s->asyncrw;
1632 return s->method->ssl_peek(s, buf, num, readbytes);
1636 int SSL_write(SSL *s, const void *buf, int num)
1642 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1646 ret = SSL_write_ex(s, buf, (size_t)num, &written);
1649 * The cast is safe here because ret should be <= INT_MAX because num is
1658 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1660 if (s->handshake_func == NULL) {
1661 SSLerr(SSL_F_SSL_WRITE_EX, SSL_R_UNINITIALIZED);
1665 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1666 s->rwstate = SSL_NOTHING;
1667 SSLerr(SSL_F_SSL_WRITE_EX, SSL_R_PROTOCOL_IS_SHUTDOWN);
1671 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1673 struct ssl_async_args args;
1676 args.buf = (void *)buf;
1678 args.type = WRITEFUNC;
1679 args.f.func_write = s->method->ssl_write;
1681 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1682 *written = s->asyncrw;
1685 return s->method->ssl_write(s, buf, num, written);
1689 int SSL_shutdown(SSL *s)
1692 * Note that this function behaves differently from what one might
1693 * expect. Return values are 0 for no success (yet), 1 for success; but
1694 * calling it once is usually not enough, even if blocking I/O is used
1695 * (see ssl3_shutdown).
1698 if (s->handshake_func == NULL) {
1699 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1703 if (!SSL_in_init(s)) {
1704 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1705 struct ssl_async_args args;
1708 args.type = OTHERFUNC;
1709 args.f.func_other = s->method->ssl_shutdown;
1711 return ssl_start_async_job(s, &args, ssl_io_intern);
1713 return s->method->ssl_shutdown(s);
1716 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1721 int SSL_key_update(SSL *s, SSL_KEY_UPDATE updatetype)
1723 if (!SSL_IS_TLS13(s)) {
1724 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1728 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1729 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1730 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1734 if (!SSL_is_init_finished(s)) {
1735 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1739 ossl_statem_set_in_init(s, 1);
1741 s->key_update = updatetype;
1746 SSL_KEY_UPDATE SSL_get_key_update_type(SSL *s)
1748 return s->key_update;
1751 int SSL_renegotiate(SSL *s)
1753 if (SSL_IS_TLS13(s)) {
1754 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1758 if (s->renegotiate == 0)
1763 return (s->method->ssl_renegotiate(s));
1766 int SSL_renegotiate_abbreviated(SSL *s)
1768 if (SSL_IS_TLS13(s))
1771 if (s->renegotiate == 0)
1776 return (s->method->ssl_renegotiate(s));
1779 int SSL_renegotiate_pending(SSL *s)
1782 * becomes true when negotiation is requested; false again once a
1783 * handshake has finished
1785 return (s->renegotiate != 0);
1788 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1793 case SSL_CTRL_GET_READ_AHEAD:
1794 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1795 case SSL_CTRL_SET_READ_AHEAD:
1796 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1797 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1800 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1801 s->msg_callback_arg = parg;
1805 return (s->mode |= larg);
1806 case SSL_CTRL_CLEAR_MODE:
1807 return (s->mode &= ~larg);
1808 case SSL_CTRL_GET_MAX_CERT_LIST:
1809 return (long)(s->max_cert_list);
1810 case SSL_CTRL_SET_MAX_CERT_LIST:
1813 l = (long)s->max_cert_list;
1814 s->max_cert_list = (size_t)larg;
1816 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1817 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1819 s->max_send_fragment = larg;
1820 if (s->max_send_fragment < s->split_send_fragment)
1821 s->split_send_fragment = s->max_send_fragment;
1823 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1824 if ((size_t)larg > s->max_send_fragment || larg == 0)
1826 s->split_send_fragment = larg;
1828 case SSL_CTRL_SET_MAX_PIPELINES:
1829 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1831 s->max_pipelines = larg;
1833 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1835 case SSL_CTRL_GET_RI_SUPPORT:
1837 return s->s3->send_connection_binding;
1840 case SSL_CTRL_CERT_FLAGS:
1841 return (s->cert->cert_flags |= larg);
1842 case SSL_CTRL_CLEAR_CERT_FLAGS:
1843 return (s->cert->cert_flags &= ~larg);
1845 case SSL_CTRL_GET_RAW_CIPHERLIST:
1847 if (s->s3->tmp.ciphers_raw == NULL)
1849 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
1850 return (int)s->s3->tmp.ciphers_rawlen;
1852 return TLS_CIPHER_LEN;
1854 case SSL_CTRL_GET_EXTMS_SUPPORT:
1855 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
1857 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
1861 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1862 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1863 &s->min_proto_version);
1864 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1865 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1866 &s->max_proto_version);
1868 return (s->method->ssl_ctrl(s, cmd, larg, parg));
1872 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1875 case SSL_CTRL_SET_MSG_CALLBACK:
1876 s->msg_callback = (void (*)
1877 (int write_p, int version, int content_type,
1878 const void *buf, size_t len, SSL *ssl,
1883 return (s->method->ssl_callback_ctrl(s, cmd, fp));
1887 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
1889 return ctx->sessions;
1892 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1895 /* For some cases with ctx == NULL perform syntax checks */
1898 #ifndef OPENSSL_NO_EC
1899 case SSL_CTRL_SET_GROUPS_LIST:
1900 return tls1_set_groups_list(NULL, NULL, parg);
1902 case SSL_CTRL_SET_SIGALGS_LIST:
1903 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
1904 return tls1_set_sigalgs_list(NULL, parg, 0);
1911 case SSL_CTRL_GET_READ_AHEAD:
1912 return (ctx->read_ahead);
1913 case SSL_CTRL_SET_READ_AHEAD:
1914 l = ctx->read_ahead;
1915 ctx->read_ahead = larg;
1918 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1919 ctx->msg_callback_arg = parg;
1922 case SSL_CTRL_GET_MAX_CERT_LIST:
1923 return (long)(ctx->max_cert_list);
1924 case SSL_CTRL_SET_MAX_CERT_LIST:
1927 l = (long)ctx->max_cert_list;
1928 ctx->max_cert_list = (size_t)larg;
1931 case SSL_CTRL_SET_SESS_CACHE_SIZE:
1934 l = (long)ctx->session_cache_size;
1935 ctx->session_cache_size = (size_t)larg;
1937 case SSL_CTRL_GET_SESS_CACHE_SIZE:
1938 return (long)(ctx->session_cache_size);
1939 case SSL_CTRL_SET_SESS_CACHE_MODE:
1940 l = ctx->session_cache_mode;
1941 ctx->session_cache_mode = larg;
1943 case SSL_CTRL_GET_SESS_CACHE_MODE:
1944 return (ctx->session_cache_mode);
1946 case SSL_CTRL_SESS_NUMBER:
1947 return (lh_SSL_SESSION_num_items(ctx->sessions));
1948 case SSL_CTRL_SESS_CONNECT:
1949 return (ctx->stats.sess_connect);
1950 case SSL_CTRL_SESS_CONNECT_GOOD:
1951 return (ctx->stats.sess_connect_good);
1952 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
1953 return (ctx->stats.sess_connect_renegotiate);
1954 case SSL_CTRL_SESS_ACCEPT:
1955 return (ctx->stats.sess_accept);
1956 case SSL_CTRL_SESS_ACCEPT_GOOD:
1957 return (ctx->stats.sess_accept_good);
1958 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
1959 return (ctx->stats.sess_accept_renegotiate);
1960 case SSL_CTRL_SESS_HIT:
1961 return (ctx->stats.sess_hit);
1962 case SSL_CTRL_SESS_CB_HIT:
1963 return (ctx->stats.sess_cb_hit);
1964 case SSL_CTRL_SESS_MISSES:
1965 return (ctx->stats.sess_miss);
1966 case SSL_CTRL_SESS_TIMEOUTS:
1967 return (ctx->stats.sess_timeout);
1968 case SSL_CTRL_SESS_CACHE_FULL:
1969 return (ctx->stats.sess_cache_full);
1971 return (ctx->mode |= larg);
1972 case SSL_CTRL_CLEAR_MODE:
1973 return (ctx->mode &= ~larg);
1974 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1975 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1977 ctx->max_send_fragment = larg;
1978 if (ctx->max_send_fragment < ctx->split_send_fragment)
1979 ctx->split_send_fragment = ctx->max_send_fragment;
1981 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1982 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
1984 ctx->split_send_fragment = larg;
1986 case SSL_CTRL_SET_MAX_PIPELINES:
1987 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1989 ctx->max_pipelines = larg;
1991 case SSL_CTRL_CERT_FLAGS:
1992 return (ctx->cert->cert_flags |= larg);
1993 case SSL_CTRL_CLEAR_CERT_FLAGS:
1994 return (ctx->cert->cert_flags &= ~larg);
1995 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1996 return ssl_set_version_bound(ctx->method->version, (int)larg,
1997 &ctx->min_proto_version);
1998 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1999 return ssl_set_version_bound(ctx->method->version, (int)larg,
2000 &ctx->max_proto_version);
2002 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2006 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2009 case SSL_CTRL_SET_MSG_CALLBACK:
2010 ctx->msg_callback = (void (*)
2011 (int write_p, int version, int content_type,
2012 const void *buf, size_t len, SSL *ssl,
2017 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2021 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2030 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2031 const SSL_CIPHER *const *bp)
2033 if ((*ap)->id > (*bp)->id)
2035 if ((*ap)->id < (*bp)->id)
2040 /** return a STACK of the ciphers available for the SSL and in order of
2042 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2045 if (s->cipher_list != NULL) {
2046 return (s->cipher_list);
2047 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2048 return (s->ctx->cipher_list);
2054 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2056 if ((s == NULL) || (s->session == NULL) || !s->server)
2058 return s->session->ciphers;
2061 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2063 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2065 ciphers = SSL_get_ciphers(s);
2068 ssl_set_client_disabled(s);
2069 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2070 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2071 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
2073 sk = sk_SSL_CIPHER_new_null();
2076 if (!sk_SSL_CIPHER_push(sk, c)) {
2077 sk_SSL_CIPHER_free(sk);
2085 /** return a STACK of the ciphers available for the SSL and in order of
2087 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2090 if (s->cipher_list_by_id != NULL) {
2091 return (s->cipher_list_by_id);
2092 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2093 return (s->ctx->cipher_list_by_id);
2099 /** The old interface to get the same thing as SSL_get_ciphers() */
2100 const char *SSL_get_cipher_list(const SSL *s, int n)
2102 const SSL_CIPHER *c;
2103 STACK_OF(SSL_CIPHER) *sk;
2107 sk = SSL_get_ciphers(s);
2108 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2110 c = sk_SSL_CIPHER_value(sk, n);
2116 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2118 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2121 return ctx->cipher_list;
2125 /** specify the ciphers to be used by default by the SSL_CTX */
2126 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2128 STACK_OF(SSL_CIPHER) *sk;
2130 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2131 &ctx->cipher_list_by_id, str, ctx->cert);
2133 * ssl_create_cipher_list may return an empty stack if it was unable to
2134 * find a cipher matching the given rule string (for example if the rule
2135 * string specifies a cipher which has been disabled). This is not an
2136 * error as far as ssl_create_cipher_list is concerned, and hence
2137 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2141 else if (sk_SSL_CIPHER_num(sk) == 0) {
2142 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2148 /** specify the ciphers to be used by the SSL */
2149 int SSL_set_cipher_list(SSL *s, const char *str)
2151 STACK_OF(SSL_CIPHER) *sk;
2153 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2154 &s->cipher_list_by_id, str, s->cert);
2155 /* see comment in SSL_CTX_set_cipher_list */
2158 else if (sk_SSL_CIPHER_num(sk) == 0) {
2159 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2165 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2168 STACK_OF(SSL_CIPHER) *sk;
2169 const SSL_CIPHER *c;
2172 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2176 sk = s->session->ciphers;
2178 if (sk_SSL_CIPHER_num(sk) == 0)
2181 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2184 c = sk_SSL_CIPHER_value(sk, i);
2185 n = strlen(c->name);
2192 memcpy(p, c->name, n + 1);
2201 /** return a servername extension value if provided in Client Hello, or NULL.
2202 * So far, only host_name types are defined (RFC 3546).
2205 const char *SSL_get_servername(const SSL *s, const int type)
2207 if (type != TLSEXT_NAMETYPE_host_name)
2210 return s->session && !s->ext.hostname ?
2211 s->session->ext.hostname : s->ext.hostname;
2214 int SSL_get_servername_type(const SSL *s)
2217 && (!s->ext.hostname ? s->session->
2218 ext.hostname : s->ext.hostname))
2219 return TLSEXT_NAMETYPE_host_name;
2224 * SSL_select_next_proto implements the standard protocol selection. It is
2225 * expected that this function is called from the callback set by
2226 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2227 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2228 * not included in the length. A byte string of length 0 is invalid. No byte
2229 * string may be truncated. The current, but experimental algorithm for
2230 * selecting the protocol is: 1) If the server doesn't support NPN then this
2231 * is indicated to the callback. In this case, the client application has to
2232 * abort the connection or have a default application level protocol. 2) If
2233 * the server supports NPN, but advertises an empty list then the client
2234 * selects the first protocol in its list, but indicates via the API that this
2235 * fallback case was enacted. 3) Otherwise, the client finds the first
2236 * protocol in the server's list that it supports and selects this protocol.
2237 * This is because it's assumed that the server has better information about
2238 * which protocol a client should use. 4) If the client doesn't support any
2239 * of the server's advertised protocols, then this is treated the same as
2240 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2241 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2243 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2244 const unsigned char *server,
2245 unsigned int server_len,
2246 const unsigned char *client, unsigned int client_len)
2249 const unsigned char *result;
2250 int status = OPENSSL_NPN_UNSUPPORTED;
2253 * For each protocol in server preference order, see if we support it.
2255 for (i = 0; i < server_len;) {
2256 for (j = 0; j < client_len;) {
2257 if (server[i] == client[j] &&
2258 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2259 /* We found a match */
2260 result = &server[i];
2261 status = OPENSSL_NPN_NEGOTIATED;
2271 /* There's no overlap between our protocols and the server's list. */
2273 status = OPENSSL_NPN_NO_OVERLAP;
2276 *out = (unsigned char *)result + 1;
2277 *outlen = result[0];
2281 #ifndef OPENSSL_NO_NEXTPROTONEG
2283 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2284 * client's requested protocol for this connection and returns 0. If the
2285 * client didn't request any protocol, then *data is set to NULL. Note that
2286 * the client can request any protocol it chooses. The value returned from
2287 * this function need not be a member of the list of supported protocols
2288 * provided by the callback.
2290 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2297 *len = (unsigned int)s->ext.npn_len;
2302 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2303 * a TLS server needs a list of supported protocols for Next Protocol
2304 * Negotiation. The returned list must be in wire format. The list is
2305 * returned by setting |out| to point to it and |outlen| to its length. This
2306 * memory will not be modified, but one should assume that the SSL* keeps a
2307 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2308 * wishes to advertise. Otherwise, no such extension will be included in the
2311 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2312 SSL_CTX_npn_advertised_cb_func cb,
2315 ctx->ext.npn_advertised_cb = cb;
2316 ctx->ext.npn_advertised_cb_arg = arg;
2320 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2321 * client needs to select a protocol from the server's provided list. |out|
2322 * must be set to point to the selected protocol (which may be within |in|).
2323 * The length of the protocol name must be written into |outlen|. The
2324 * server's advertised protocols are provided in |in| and |inlen|. The
2325 * callback can assume that |in| is syntactically valid. The client must
2326 * select a protocol. It is fatal to the connection if this callback returns
2327 * a value other than SSL_TLSEXT_ERR_OK.
2329 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2330 SSL_CTX_npn_select_cb_func cb,
2333 ctx->ext.npn_select_cb = cb;
2334 ctx->ext.npn_select_cb_arg = arg;
2339 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2340 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2341 * length-prefixed strings). Returns 0 on success.
2343 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2344 unsigned int protos_len)
2346 OPENSSL_free(ctx->ext.alpn);
2347 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2348 if (ctx->ext.alpn == NULL) {
2349 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2352 ctx->ext.alpn_len = protos_len;
2358 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2359 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2360 * length-prefixed strings). Returns 0 on success.
2362 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2363 unsigned int protos_len)
2365 OPENSSL_free(ssl->ext.alpn);
2366 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2367 if (ssl->ext.alpn == NULL) {
2368 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2371 ssl->ext.alpn_len = protos_len;
2377 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2378 * called during ClientHello processing in order to select an ALPN protocol
2379 * from the client's list of offered protocols.
2381 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2382 SSL_CTX_alpn_select_cb_func cb,
2385 ctx->ext.alpn_select_cb = cb;
2386 ctx->ext.alpn_select_cb_arg = arg;
2390 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2391 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2392 * (not including the leading length-prefix byte). If the server didn't
2393 * respond with a negotiated protocol then |*len| will be zero.
2395 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2400 *data = ssl->s3->alpn_selected;
2404 *len = (unsigned int)ssl->s3->alpn_selected_len;
2407 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2408 const char *label, size_t llen,
2409 const unsigned char *p, size_t plen,
2412 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2415 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2420 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2422 const unsigned char *session_id = a->session_id;
2424 unsigned char tmp_storage[4];
2426 if (a->session_id_length < sizeof(tmp_storage)) {
2427 memset(tmp_storage, 0, sizeof(tmp_storage));
2428 memcpy(tmp_storage, a->session_id, a->session_id_length);
2429 session_id = tmp_storage;
2433 ((unsigned long)session_id[0]) |
2434 ((unsigned long)session_id[1] << 8L) |
2435 ((unsigned long)session_id[2] << 16L) |
2436 ((unsigned long)session_id[3] << 24L);
2441 * NB: If this function (or indeed the hash function which uses a sort of
2442 * coarser function than this one) is changed, ensure
2443 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2444 * being able to construct an SSL_SESSION that will collide with any existing
2445 * session with a matching session ID.
2447 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2449 if (a->ssl_version != b->ssl_version)
2451 if (a->session_id_length != b->session_id_length)
2453 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2457 * These wrapper functions should remain rather than redeclaring
2458 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2459 * variable. The reason is that the functions aren't static, they're exposed
2463 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2465 SSL_CTX *ret = NULL;
2468 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2472 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2475 if (FIPS_mode() && (meth->version < TLS1_VERSION)) {
2476 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE);
2480 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2481 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2484 ret = OPENSSL_zalloc(sizeof(*ret));
2489 ret->min_proto_version = 0;
2490 ret->max_proto_version = 0;
2491 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2492 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2493 /* We take the system default. */
2494 ret->session_timeout = meth->get_timeout();
2495 ret->references = 1;
2496 ret->lock = CRYPTO_THREAD_lock_new();
2497 if (ret->lock == NULL) {
2498 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2502 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2503 ret->verify_mode = SSL_VERIFY_NONE;
2504 if ((ret->cert = ssl_cert_new()) == NULL)
2507 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2508 if (ret->sessions == NULL)
2510 ret->cert_store = X509_STORE_new();
2511 if (ret->cert_store == NULL)
2513 #ifndef OPENSSL_NO_CT
2514 ret->ctlog_store = CTLOG_STORE_new();
2515 if (ret->ctlog_store == NULL)
2518 if (!ssl_create_cipher_list(ret->method,
2519 &ret->cipher_list, &ret->cipher_list_by_id,
2520 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2521 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2522 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2526 ret->param = X509_VERIFY_PARAM_new();
2527 if (ret->param == NULL)
2530 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2531 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2534 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2535 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2539 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2542 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2545 /* No compression for DTLS */
2546 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2547 ret->comp_methods = SSL_COMP_get_compression_methods();
2549 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2550 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2552 /* Setup RFC5077 ticket keys */
2553 if ((RAND_bytes(ret->ext.tick_key_name,
2554 sizeof(ret->ext.tick_key_name)) <= 0)
2555 || (RAND_bytes(ret->ext.tick_hmac_key,
2556 sizeof(ret->ext.tick_hmac_key)) <= 0)
2557 || (RAND_bytes(ret->ext.tick_aes_key,
2558 sizeof(ret->ext.tick_aes_key)) <= 0))
2559 ret->options |= SSL_OP_NO_TICKET;
2561 #ifndef OPENSSL_NO_SRP
2562 if (!SSL_CTX_SRP_CTX_init(ret))
2565 #ifndef OPENSSL_NO_ENGINE
2566 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2567 # define eng_strx(x) #x
2568 # define eng_str(x) eng_strx(x)
2569 /* Use specific client engine automatically... ignore errors */
2572 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2575 ENGINE_load_builtin_engines();
2576 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2578 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2584 * Default is to connect to non-RI servers. When RI is more widely
2585 * deployed might change this.
2587 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2589 * Disable compression by default to prevent CRIME. Applications can
2590 * re-enable compression by configuring
2591 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2592 * or by using the SSL_CONF library.
2594 ret->options |= SSL_OP_NO_COMPRESSION;
2596 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2600 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2606 int SSL_CTX_up_ref(SSL_CTX *ctx)
2610 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2613 REF_PRINT_COUNT("SSL_CTX", ctx);
2614 REF_ASSERT_ISNT(i < 2);
2615 return ((i > 1) ? 1 : 0);
2618 void SSL_CTX_free(SSL_CTX *a)
2625 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2626 REF_PRINT_COUNT("SSL_CTX", a);
2629 REF_ASSERT_ISNT(i < 0);
2631 X509_VERIFY_PARAM_free(a->param);
2632 dane_ctx_final(&a->dane);
2635 * Free internal session cache. However: the remove_cb() may reference
2636 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2637 * after the sessions were flushed.
2638 * As the ex_data handling routines might also touch the session cache,
2639 * the most secure solution seems to be: empty (flush) the cache, then
2640 * free ex_data, then finally free the cache.
2641 * (See ticket [openssl.org #212].)
2643 if (a->sessions != NULL)
2644 SSL_CTX_flush_sessions(a, 0);
2646 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2647 lh_SSL_SESSION_free(a->sessions);
2648 X509_STORE_free(a->cert_store);
2649 #ifndef OPENSSL_NO_CT
2650 CTLOG_STORE_free(a->ctlog_store);
2652 sk_SSL_CIPHER_free(a->cipher_list);
2653 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2654 ssl_cert_free(a->cert);
2655 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2656 sk_X509_pop_free(a->extra_certs, X509_free);
2657 a->comp_methods = NULL;
2658 #ifndef OPENSSL_NO_SRTP
2659 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2661 #ifndef OPENSSL_NO_SRP
2662 SSL_CTX_SRP_CTX_free(a);
2664 #ifndef OPENSSL_NO_ENGINE
2665 ENGINE_finish(a->client_cert_engine);
2668 #ifndef OPENSSL_NO_EC
2669 OPENSSL_free(a->ext.ecpointformats);
2670 OPENSSL_free(a->ext.supportedgroups);
2672 OPENSSL_free(a->ext.alpn);
2674 CRYPTO_THREAD_lock_free(a->lock);
2679 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2681 ctx->default_passwd_callback = cb;
2684 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2686 ctx->default_passwd_callback_userdata = u;
2689 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2691 return ctx->default_passwd_callback;
2694 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2696 return ctx->default_passwd_callback_userdata;
2699 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2701 s->default_passwd_callback = cb;
2704 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2706 s->default_passwd_callback_userdata = u;
2709 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2711 return s->default_passwd_callback;
2714 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2716 return s->default_passwd_callback_userdata;
2719 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2720 int (*cb) (X509_STORE_CTX *, void *),
2723 ctx->app_verify_callback = cb;
2724 ctx->app_verify_arg = arg;
2727 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2728 int (*cb) (int, X509_STORE_CTX *))
2730 ctx->verify_mode = mode;
2731 ctx->default_verify_callback = cb;
2734 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2736 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2739 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2741 ssl_cert_set_cert_cb(c->cert, cb, arg);
2744 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2746 ssl_cert_set_cert_cb(s->cert, cb, arg);
2749 void ssl_set_masks(SSL *s)
2752 uint32_t *pvalid = s->s3->tmp.valid_flags;
2753 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2754 unsigned long mask_k, mask_a;
2755 #ifndef OPENSSL_NO_EC
2756 int have_ecc_cert, ecdsa_ok;
2761 #ifndef OPENSSL_NO_DH
2762 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2767 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2768 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_SIGN;
2769 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_SIGN;
2770 #ifndef OPENSSL_NO_EC
2771 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2777 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2778 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2781 #ifndef OPENSSL_NO_GOST
2782 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2783 mask_k |= SSL_kGOST;
2784 mask_a |= SSL_aGOST12;
2786 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2787 mask_k |= SSL_kGOST;
2788 mask_a |= SSL_aGOST12;
2790 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2791 mask_k |= SSL_kGOST;
2792 mask_a |= SSL_aGOST01;
2802 if (rsa_enc || rsa_sign) {
2810 mask_a |= SSL_aNULL;
2813 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2814 * depending on the key usage extension.
2816 #ifndef OPENSSL_NO_EC
2817 if (have_ecc_cert) {
2819 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
2820 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2821 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2824 mask_a |= SSL_aECDSA;
2828 #ifndef OPENSSL_NO_EC
2829 mask_k |= SSL_kECDHE;
2832 #ifndef OPENSSL_NO_PSK
2835 if (mask_k & SSL_kRSA)
2836 mask_k |= SSL_kRSAPSK;
2837 if (mask_k & SSL_kDHE)
2838 mask_k |= SSL_kDHEPSK;
2839 if (mask_k & SSL_kECDHE)
2840 mask_k |= SSL_kECDHEPSK;
2843 s->s3->tmp.mask_k = mask_k;
2844 s->s3->tmp.mask_a = mask_a;
2847 #ifndef OPENSSL_NO_EC
2849 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
2851 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
2852 /* key usage, if present, must allow signing */
2853 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
2854 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
2855 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
2859 return 1; /* all checks are ok */
2864 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
2865 size_t *serverinfo_length)
2867 CERT_PKEY *cpk = s->s3->tmp.cert;
2868 *serverinfo_length = 0;
2870 if (cpk == NULL || cpk->serverinfo == NULL)
2873 *serverinfo = cpk->serverinfo;
2874 *serverinfo_length = cpk->serverinfo_length;
2878 void ssl_update_cache(SSL *s, int mode)
2883 * If the session_id_length is 0, we are not supposed to cache it, and it
2884 * would be rather hard to do anyway :-)
2886 if (s->session->session_id_length == 0)
2889 i = s->session_ctx->session_cache_mode;
2890 if ((i & mode) && (!s->hit)
2891 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
2892 || SSL_CTX_add_session(s->session_ctx, s->session))
2893 && (s->session_ctx->new_session_cb != NULL)) {
2894 SSL_SESSION_up_ref(s->session);
2895 if (!s->session_ctx->new_session_cb(s, s->session))
2896 SSL_SESSION_free(s->session);
2899 /* auto flush every 255 connections */
2900 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
2901 if ((((mode & SSL_SESS_CACHE_CLIENT)
2902 ? s->session_ctx->stats.sess_connect_good
2903 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
2904 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
2909 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
2914 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
2919 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
2923 if (s->method != meth) {
2924 const SSL_METHOD *sm = s->method;
2925 int (*hf) (SSL *) = s->handshake_func;
2927 if (sm->version == meth->version)
2932 ret = s->method->ssl_new(s);
2935 if (hf == sm->ssl_connect)
2936 s->handshake_func = meth->ssl_connect;
2937 else if (hf == sm->ssl_accept)
2938 s->handshake_func = meth->ssl_accept;
2943 int SSL_get_error(const SSL *s, int i)
2950 return (SSL_ERROR_NONE);
2953 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
2954 * where we do encode the error
2956 if ((l = ERR_peek_error()) != 0) {
2957 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
2958 return (SSL_ERROR_SYSCALL);
2960 return (SSL_ERROR_SSL);
2963 if (SSL_want_read(s)) {
2964 bio = SSL_get_rbio(s);
2965 if (BIO_should_read(bio))
2966 return (SSL_ERROR_WANT_READ);
2967 else if (BIO_should_write(bio))
2969 * This one doesn't make too much sense ... We never try to write
2970 * to the rbio, and an application program where rbio and wbio
2971 * are separate couldn't even know what it should wait for.
2972 * However if we ever set s->rwstate incorrectly (so that we have
2973 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
2974 * wbio *are* the same, this test works around that bug; so it
2975 * might be safer to keep it.
2977 return (SSL_ERROR_WANT_WRITE);
2978 else if (BIO_should_io_special(bio)) {
2979 reason = BIO_get_retry_reason(bio);
2980 if (reason == BIO_RR_CONNECT)
2981 return (SSL_ERROR_WANT_CONNECT);
2982 else if (reason == BIO_RR_ACCEPT)
2983 return (SSL_ERROR_WANT_ACCEPT);
2985 return (SSL_ERROR_SYSCALL); /* unknown */
2989 if (SSL_want_write(s)) {
2991 * Access wbio directly - in order to use the buffered bio if
2995 if (BIO_should_write(bio))
2996 return (SSL_ERROR_WANT_WRITE);
2997 else if (BIO_should_read(bio))
2999 * See above (SSL_want_read(s) with BIO_should_write(bio))
3001 return (SSL_ERROR_WANT_READ);
3002 else if (BIO_should_io_special(bio)) {
3003 reason = BIO_get_retry_reason(bio);
3004 if (reason == BIO_RR_CONNECT)
3005 return (SSL_ERROR_WANT_CONNECT);
3006 else if (reason == BIO_RR_ACCEPT)
3007 return (SSL_ERROR_WANT_ACCEPT);
3009 return (SSL_ERROR_SYSCALL);
3012 if (SSL_want_x509_lookup(s)) {
3013 return (SSL_ERROR_WANT_X509_LOOKUP);
3015 if (SSL_want_async(s)) {
3016 return SSL_ERROR_WANT_ASYNC;
3018 if (SSL_want_async_job(s)) {
3019 return SSL_ERROR_WANT_ASYNC_JOB;
3022 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3023 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3024 return (SSL_ERROR_ZERO_RETURN);
3026 return (SSL_ERROR_SYSCALL);
3029 static int ssl_do_handshake_intern(void *vargs)
3031 struct ssl_async_args *args;
3034 args = (struct ssl_async_args *)vargs;
3037 return s->handshake_func(s);
3040 int SSL_do_handshake(SSL *s)
3044 if (s->handshake_func == NULL) {
3045 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3049 s->method->ssl_renegotiate_check(s, 0);
3051 if (SSL_in_init(s) || SSL_in_before(s)) {
3052 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3053 struct ssl_async_args args;
3057 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3059 ret = s->handshake_func(s);
3065 void SSL_set_accept_state(SSL *s)
3069 ossl_statem_clear(s);
3070 s->handshake_func = s->method->ssl_accept;
3074 void SSL_set_connect_state(SSL *s)
3078 ossl_statem_clear(s);
3079 s->handshake_func = s->method->ssl_connect;
3083 int ssl_undefined_function(SSL *s)
3085 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3089 int ssl_undefined_void_function(void)
3091 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3092 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3096 int ssl_undefined_const_function(const SSL *s)
3101 const SSL_METHOD *ssl_bad_method(int ver)
3103 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3107 const char *ssl_protocol_to_string(int version)
3111 case TLS1_3_VERSION:
3114 case TLS1_2_VERSION:
3117 case TLS1_1_VERSION:
3132 case DTLS1_2_VERSION:
3140 const char *SSL_get_version(const SSL *s)
3142 return ssl_protocol_to_string(s->version);
3145 SSL *SSL_dup(SSL *s)
3147 STACK_OF(X509_NAME) *sk;
3152 /* If we're not quiescent, just up_ref! */
3153 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3154 CRYPTO_UP_REF(&s->references, &i, s->lock);
3159 * Otherwise, copy configuration state, and session if set.
3161 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3164 if (s->session != NULL) {
3166 * Arranges to share the same session via up_ref. This "copies"
3167 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3169 if (!SSL_copy_session_id(ret, s))
3173 * No session has been established yet, so we have to expect that
3174 * s->cert or ret->cert will be changed later -- they should not both
3175 * point to the same object, and thus we can't use
3176 * SSL_copy_session_id.
3178 if (!SSL_set_ssl_method(ret, s->method))
3181 if (s->cert != NULL) {
3182 ssl_cert_free(ret->cert);
3183 ret->cert = ssl_cert_dup(s->cert);
3184 if (ret->cert == NULL)
3188 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3189 (int)s->sid_ctx_length))
3193 if (!ssl_dane_dup(ret, s))
3195 ret->version = s->version;
3196 ret->options = s->options;
3197 ret->mode = s->mode;
3198 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3199 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3200 ret->msg_callback = s->msg_callback;
3201 ret->msg_callback_arg = s->msg_callback_arg;
3202 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3203 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3204 ret->generate_session_id = s->generate_session_id;
3206 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3208 /* copy app data, a little dangerous perhaps */
3209 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3212 /* setup rbio, and wbio */
3213 if (s->rbio != NULL) {
3214 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3217 if (s->wbio != NULL) {
3218 if (s->wbio != s->rbio) {
3219 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3222 BIO_up_ref(ret->rbio);
3223 ret->wbio = ret->rbio;
3227 ret->server = s->server;
3228 if (s->handshake_func) {
3230 SSL_set_accept_state(ret);
3232 SSL_set_connect_state(ret);
3234 ret->shutdown = s->shutdown;
3237 ret->default_passwd_callback = s->default_passwd_callback;
3238 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3240 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3242 /* dup the cipher_list and cipher_list_by_id stacks */
3243 if (s->cipher_list != NULL) {
3244 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3247 if (s->cipher_list_by_id != NULL)
3248 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3252 /* Dup the client_CA list */
3253 if (s->client_CA != NULL) {
3254 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3256 ret->client_CA = sk;
3257 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3258 xn = sk_X509_NAME_value(sk, i);
3259 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3272 void ssl_clear_cipher_ctx(SSL *s)
3274 if (s->enc_read_ctx != NULL) {
3275 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3276 s->enc_read_ctx = NULL;
3278 if (s->enc_write_ctx != NULL) {
3279 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3280 s->enc_write_ctx = NULL;
3282 #ifndef OPENSSL_NO_COMP
3283 COMP_CTX_free(s->expand);
3285 COMP_CTX_free(s->compress);
3290 X509 *SSL_get_certificate(const SSL *s)
3292 if (s->cert != NULL)
3293 return (s->cert->key->x509);
3298 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3300 if (s->cert != NULL)
3301 return (s->cert->key->privatekey);
3306 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3308 if (ctx->cert != NULL)
3309 return ctx->cert->key->x509;
3314 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3316 if (ctx->cert != NULL)
3317 return ctx->cert->key->privatekey;
3322 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3324 if ((s->session != NULL) && (s->session->cipher != NULL))
3325 return (s->session->cipher);
3329 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3331 #ifndef OPENSSL_NO_COMP
3332 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3338 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3340 #ifndef OPENSSL_NO_COMP
3341 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3347 int ssl_init_wbio_buffer(SSL *s)
3351 if (s->bbio != NULL) {
3352 /* Already buffered. */
3356 bbio = BIO_new(BIO_f_buffer());
3357 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3359 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3363 s->wbio = BIO_push(bbio, s->wbio);
3368 void ssl_free_wbio_buffer(SSL *s)
3370 /* callers ensure s is never null */
3371 if (s->bbio == NULL)
3374 s->wbio = BIO_pop(s->wbio);
3375 assert(s->wbio != NULL);
3380 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3382 ctx->quiet_shutdown = mode;
3385 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3387 return (ctx->quiet_shutdown);
3390 void SSL_set_quiet_shutdown(SSL *s, int mode)
3392 s->quiet_shutdown = mode;
3395 int SSL_get_quiet_shutdown(const SSL *s)
3397 return (s->quiet_shutdown);
3400 void SSL_set_shutdown(SSL *s, int mode)
3405 int SSL_get_shutdown(const SSL *s)
3410 int SSL_version(const SSL *s)
3415 int SSL_client_version(const SSL *s)
3417 return s->client_version;
3420 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3425 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3428 if (ssl->ctx == ctx)
3431 ctx = ssl->session_ctx;
3432 new_cert = ssl_cert_dup(ctx->cert);
3433 if (new_cert == NULL) {
3436 ssl_cert_free(ssl->cert);
3437 ssl->cert = new_cert;
3440 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3441 * so setter APIs must prevent invalid lengths from entering the system.
3443 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3446 * If the session ID context matches that of the parent SSL_CTX,
3447 * inherit it from the new SSL_CTX as well. If however the context does
3448 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3449 * leave it unchanged.
3451 if ((ssl->ctx != NULL) &&
3452 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3453 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3454 ssl->sid_ctx_length = ctx->sid_ctx_length;
3455 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3458 SSL_CTX_up_ref(ctx);
3459 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3465 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3467 return (X509_STORE_set_default_paths(ctx->cert_store));
3470 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3472 X509_LOOKUP *lookup;
3474 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3477 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3479 /* Clear any errors if the default directory does not exist */
3485 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3487 X509_LOOKUP *lookup;
3489 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3493 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3495 /* Clear any errors if the default file does not exist */
3501 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3504 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3507 void SSL_set_info_callback(SSL *ssl,
3508 void (*cb) (const SSL *ssl, int type, int val))
3510 ssl->info_callback = cb;
3514 * One compiler (Diab DCC) doesn't like argument names in returned function
3517 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3520 return ssl->info_callback;
3523 void SSL_set_verify_result(SSL *ssl, long arg)
3525 ssl->verify_result = arg;
3528 long SSL_get_verify_result(const SSL *ssl)
3530 return (ssl->verify_result);
3533 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3536 return sizeof(ssl->s3->client_random);
3537 if (outlen > sizeof(ssl->s3->client_random))
3538 outlen = sizeof(ssl->s3->client_random);
3539 memcpy(out, ssl->s3->client_random, outlen);
3543 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3546 return sizeof(ssl->s3->server_random);
3547 if (outlen > sizeof(ssl->s3->server_random))
3548 outlen = sizeof(ssl->s3->server_random);
3549 memcpy(out, ssl->s3->server_random, outlen);
3553 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3554 unsigned char *out, size_t outlen)
3557 return session->master_key_length;
3558 if (outlen > session->master_key_length)
3559 outlen = session->master_key_length;
3560 memcpy(out, session->master_key, outlen);
3564 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3566 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3569 void *SSL_get_ex_data(const SSL *s, int idx)
3571 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3574 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3576 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3579 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3581 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3589 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3591 return (ctx->cert_store);
3594 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3596 X509_STORE_free(ctx->cert_store);
3597 ctx->cert_store = store;
3600 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3603 X509_STORE_up_ref(store);
3604 SSL_CTX_set_cert_store(ctx, store);
3607 int SSL_want(const SSL *s)
3609 return (s->rwstate);
3613 * \brief Set the callback for generating temporary DH keys.
3614 * \param ctx the SSL context.
3615 * \param dh the callback
3618 #ifndef OPENSSL_NO_DH
3619 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3620 DH *(*dh) (SSL *ssl, int is_export,
3623 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3626 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3629 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3633 #ifndef OPENSSL_NO_PSK
3634 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3636 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3637 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3640 OPENSSL_free(ctx->cert->psk_identity_hint);
3641 if (identity_hint != NULL) {
3642 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3643 if (ctx->cert->psk_identity_hint == NULL)
3646 ctx->cert->psk_identity_hint = NULL;
3650 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3655 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3656 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3659 OPENSSL_free(s->cert->psk_identity_hint);
3660 if (identity_hint != NULL) {
3661 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3662 if (s->cert->psk_identity_hint == NULL)
3665 s->cert->psk_identity_hint = NULL;
3669 const char *SSL_get_psk_identity_hint(const SSL *s)
3671 if (s == NULL || s->session == NULL)
3673 return (s->session->psk_identity_hint);
3676 const char *SSL_get_psk_identity(const SSL *s)
3678 if (s == NULL || s->session == NULL)
3680 return (s->session->psk_identity);
3683 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3685 s->psk_client_callback = cb;
3688 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3690 ctx->psk_client_callback = cb;
3693 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3695 s->psk_server_callback = cb;
3698 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3700 ctx->psk_server_callback = cb;
3704 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3705 void (*cb) (int write_p, int version,
3706 int content_type, const void *buf,
3707 size_t len, SSL *ssl, void *arg))
3709 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3712 void SSL_set_msg_callback(SSL *ssl,
3713 void (*cb) (int write_p, int version,
3714 int content_type, const void *buf,
3715 size_t len, SSL *ssl, void *arg))
3717 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3720 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3721 int (*cb) (SSL *ssl,
3725 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3726 (void (*)(void))cb);
3729 void SSL_set_not_resumable_session_callback(SSL *ssl,
3730 int (*cb) (SSL *ssl,
3731 int is_forward_secure))
3733 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3734 (void (*)(void))cb);
3738 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3739 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3740 * If EVP_MD pointer is passed, initializes ctx with this md.
3741 * Returns the newly allocated ctx;
3744 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3746 ssl_clear_hash_ctx(hash);
3747 *hash = EVP_MD_CTX_new();
3748 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3749 EVP_MD_CTX_free(*hash);
3756 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3759 EVP_MD_CTX_free(*hash);
3763 /* Retrieve handshake hashes */
3764 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3767 EVP_MD_CTX *ctx = NULL;
3768 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3769 int hashleni = EVP_MD_CTX_size(hdgst);
3772 if (hashleni < 0 || (size_t)hashleni > outlen)
3775 ctx = EVP_MD_CTX_new();
3779 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3780 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3783 *hashlen = hashleni;
3787 EVP_MD_CTX_free(ctx);
3791 int SSL_session_reused(SSL *s)
3796 int SSL_is_server(SSL *s)
3801 #if OPENSSL_API_COMPAT < 0x10100000L
3802 void SSL_set_debug(SSL *s, int debug)
3804 /* Old function was do-nothing anyway... */
3810 void SSL_set_security_level(SSL *s, int level)
3812 s->cert->sec_level = level;
3815 int SSL_get_security_level(const SSL *s)
3817 return s->cert->sec_level;
3820 void SSL_set_security_callback(SSL *s,
3821 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3822 int op, int bits, int nid,
3823 void *other, void *ex))
3825 s->cert->sec_cb = cb;
3828 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
3829 const SSL_CTX *ctx, int op,
3830 int bits, int nid, void *other,
3832 return s->cert->sec_cb;
3835 void SSL_set0_security_ex_data(SSL *s, void *ex)
3837 s->cert->sec_ex = ex;
3840 void *SSL_get0_security_ex_data(const SSL *s)
3842 return s->cert->sec_ex;
3845 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
3847 ctx->cert->sec_level = level;
3850 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
3852 return ctx->cert->sec_level;
3855 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
3856 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3857 int op, int bits, int nid,
3858 void *other, void *ex))
3860 ctx->cert->sec_cb = cb;
3863 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
3869 return ctx->cert->sec_cb;
3872 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
3874 ctx->cert->sec_ex = ex;
3877 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
3879 return ctx->cert->sec_ex;
3883 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3884 * can return unsigned long, instead of the generic long return value from the
3885 * control interface.
3887 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
3889 return ctx->options;
3892 unsigned long SSL_get_options(const SSL *s)
3897 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
3899 return ctx->options |= op;
3902 unsigned long SSL_set_options(SSL *s, unsigned long op)
3904 return s->options |= op;
3907 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
3909 return ctx->options &= ~op;
3912 unsigned long SSL_clear_options(SSL *s, unsigned long op)
3914 return s->options &= ~op;
3917 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
3919 return s->verified_chain;
3922 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
3924 #ifndef OPENSSL_NO_CT
3927 * Moves SCTs from the |src| stack to the |dst| stack.
3928 * The source of each SCT will be set to |origin|.
3929 * If |dst| points to a NULL pointer, a new stack will be created and owned by
3931 * Returns the number of SCTs moved, or a negative integer if an error occurs.
3933 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
3934 sct_source_t origin)
3940 *dst = sk_SCT_new_null();
3942 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
3947 while ((sct = sk_SCT_pop(src)) != NULL) {
3948 if (SCT_set_source(sct, origin) != 1)
3951 if (sk_SCT_push(*dst, sct) <= 0)
3959 sk_SCT_push(src, sct); /* Put the SCT back */
3964 * Look for data collected during ServerHello and parse if found.
3965 * Returns the number of SCTs extracted.
3967 static int ct_extract_tls_extension_scts(SSL *s)
3969 int scts_extracted = 0;
3971 if (s->ext.scts != NULL) {
3972 const unsigned char *p = s->ext.scts;
3973 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
3975 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
3977 SCT_LIST_free(scts);
3980 return scts_extracted;
3984 * Checks for an OCSP response and then attempts to extract any SCTs found if it
3985 * contains an SCT X509 extension. They will be stored in |s->scts|.
3987 * - The number of SCTs extracted, assuming an OCSP response exists.
3988 * - 0 if no OCSP response exists or it contains no SCTs.
3989 * - A negative integer if an error occurs.
3991 static int ct_extract_ocsp_response_scts(SSL *s)
3993 # ifndef OPENSSL_NO_OCSP
3994 int scts_extracted = 0;
3995 const unsigned char *p;
3996 OCSP_BASICRESP *br = NULL;
3997 OCSP_RESPONSE *rsp = NULL;
3998 STACK_OF(SCT) *scts = NULL;
4001 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4004 p = s->ext.ocsp.resp;
4005 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4009 br = OCSP_response_get1_basic(rsp);
4013 for (i = 0; i < OCSP_resp_count(br); ++i) {
4014 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4020 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4022 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4023 if (scts_extracted < 0)
4027 SCT_LIST_free(scts);
4028 OCSP_BASICRESP_free(br);
4029 OCSP_RESPONSE_free(rsp);
4030 return scts_extracted;
4032 /* Behave as if no OCSP response exists */
4038 * Attempts to extract SCTs from the peer certificate.
4039 * Return the number of SCTs extracted, or a negative integer if an error
4042 static int ct_extract_x509v3_extension_scts(SSL *s)
4044 int scts_extracted = 0;
4045 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4048 STACK_OF(SCT) *scts =
4049 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4052 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4054 SCT_LIST_free(scts);
4057 return scts_extracted;
4061 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4062 * response (if it exists) and X509v3 extensions in the certificate.
4063 * Returns NULL if an error occurs.
4065 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4067 if (!s->scts_parsed) {
4068 if (ct_extract_tls_extension_scts(s) < 0 ||
4069 ct_extract_ocsp_response_scts(s) < 0 ||
4070 ct_extract_x509v3_extension_scts(s) < 0)
4080 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4081 const STACK_OF(SCT) *scts, void *unused_arg)
4086 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4087 const STACK_OF(SCT) *scts, void *unused_arg)
4089 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4092 for (i = 0; i < count; ++i) {
4093 SCT *sct = sk_SCT_value(scts, i);
4094 int status = SCT_get_validation_status(sct);
4096 if (status == SCT_VALIDATION_STATUS_VALID)
4099 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4103 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4107 * Since code exists that uses the custom extension handler for CT, look
4108 * for this and throw an error if they have already registered to use CT.
4110 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4111 TLSEXT_TYPE_signed_certificate_timestamp))
4113 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4114 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4118 if (callback != NULL) {
4120 * If we are validating CT, then we MUST accept SCTs served via OCSP
4122 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4126 s->ct_validation_callback = callback;
4127 s->ct_validation_callback_arg = arg;
4132 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4133 ssl_ct_validation_cb callback, void *arg)
4136 * Since code exists that uses the custom extension handler for CT, look for
4137 * this and throw an error if they have already registered to use CT.
4139 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4140 TLSEXT_TYPE_signed_certificate_timestamp))
4142 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4143 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4147 ctx->ct_validation_callback = callback;
4148 ctx->ct_validation_callback_arg = arg;
4152 int SSL_ct_is_enabled(const SSL *s)
4154 return s->ct_validation_callback != NULL;
4157 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4159 return ctx->ct_validation_callback != NULL;
4162 int ssl_validate_ct(SSL *s)
4165 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4167 SSL_DANE *dane = &s->dane;
4168 CT_POLICY_EVAL_CTX *ctx = NULL;
4169 const STACK_OF(SCT) *scts;
4172 * If no callback is set, the peer is anonymous, or its chain is invalid,
4173 * skip SCT validation - just return success. Applications that continue
4174 * handshakes without certificates, with unverified chains, or pinned leaf
4175 * certificates are outside the scope of the WebPKI and CT.
4177 * The above exclusions notwithstanding the vast majority of peers will
4178 * have rather ordinary certificate chains validated by typical
4179 * applications that perform certificate verification and therefore will
4180 * process SCTs when enabled.
4182 if (s->ct_validation_callback == NULL || cert == NULL ||
4183 s->verify_result != X509_V_OK ||
4184 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4188 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4189 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4191 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4192 switch (dane->mtlsa->usage) {
4193 case DANETLS_USAGE_DANE_TA:
4194 case DANETLS_USAGE_DANE_EE:
4199 ctx = CT_POLICY_EVAL_CTX_new();
4201 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4205 issuer = sk_X509_value(s->verified_chain, 1);
4206 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4207 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4208 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4209 CT_POLICY_EVAL_CTX_set_time(ctx, SSL_SESSION_get_time(SSL_get0_session(s)));
4211 scts = SSL_get0_peer_scts(s);
4214 * This function returns success (> 0) only when all the SCTs are valid, 0
4215 * when some are invalid, and < 0 on various internal errors (out of
4216 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4217 * reason to abort the handshake, that decision is up to the callback.
4218 * Therefore, we error out only in the unexpected case that the return
4219 * value is negative.
4221 * XXX: One might well argue that the return value of this function is an
4222 * unfortunate design choice. Its job is only to determine the validation
4223 * status of each of the provided SCTs. So long as it correctly separates
4224 * the wheat from the chaff it should return success. Failure in this case
4225 * ought to correspond to an inability to carry out its duties.
4227 if (SCT_LIST_validate(scts, ctx) < 0) {
4228 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4232 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4234 ret = 0; /* This function returns 0 on failure */
4237 CT_POLICY_EVAL_CTX_free(ctx);
4239 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4240 * failure return code here. Also the application may wish the complete
4241 * the handshake, and then disconnect cleanly at a higher layer, after
4242 * checking the verification status of the completed connection.
4244 * We therefore force a certificate verification failure which will be
4245 * visible via SSL_get_verify_result() and cached as part of any resumed
4248 * Note: the permissive callback is for information gathering only, always
4249 * returns success, and does not affect verification status. Only the
4250 * strict callback or a custom application-specified callback can trigger
4251 * connection failure or record a verification error.
4254 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4258 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4260 switch (validation_mode) {
4262 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4264 case SSL_CT_VALIDATION_PERMISSIVE:
4265 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4266 case SSL_CT_VALIDATION_STRICT:
4267 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4271 int SSL_enable_ct(SSL *s, int validation_mode)
4273 switch (validation_mode) {
4275 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4277 case SSL_CT_VALIDATION_PERMISSIVE:
4278 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4279 case SSL_CT_VALIDATION_STRICT:
4280 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4284 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4286 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4289 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4291 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4294 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4296 CTLOG_STORE_free(ctx->ctlog_store);
4297 ctx->ctlog_store = logs;
4300 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4302 return ctx->ctlog_store;
4307 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4309 ctx->keylog_callback = cb;
4312 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4314 return ctx->keylog_callback;
4317 static int nss_keylog_int(const char *prefix,
4319 const uint8_t *parameter_1,
4320 size_t parameter_1_len,
4321 const uint8_t *parameter_2,
4322 size_t parameter_2_len)
4325 char *cursor = NULL;
4330 if (ssl->ctx->keylog_callback == NULL) return 1;
4333 * Our output buffer will contain the following strings, rendered with
4334 * space characters in between, terminated by a NULL character: first the
4335 * prefix, then the first parameter, then the second parameter. The
4336 * meaning of each parameter depends on the specific key material being
4337 * logged. Note that the first and second parameters are encoded in
4338 * hexadecimal, so we need a buffer that is twice their lengths.
4340 prefix_len = strlen(prefix);
4341 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4342 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4343 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4347 strcpy(cursor, prefix);
4348 cursor += prefix_len;
4351 for (i = 0; i < parameter_1_len; i++) {
4352 sprintf(cursor, "%02x", parameter_1[i]);
4357 for (i = 0; i < parameter_2_len; i++) {
4358 sprintf(cursor, "%02x", parameter_2[i]);
4363 ssl->ctx->keylog_callback(ssl, (const char *)out);
4369 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4370 const uint8_t *encrypted_premaster,
4371 size_t encrypted_premaster_len,
4372 const uint8_t *premaster,
4373 size_t premaster_len)
4375 if (encrypted_premaster_len < 8) {
4376 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4380 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4381 return nss_keylog_int("RSA",
4383 encrypted_premaster,
4389 int ssl_log_secret(SSL *ssl,
4391 const uint8_t *secret,
4394 return nss_keylog_int(label,
4396 ssl->s3->client_random,