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 /* Reset DANE verification result state */
477 X509_free(s->dane.mcert);
478 s->dane.mcert = NULL;
479 s->dane.mtlsa = NULL;
481 /* Clear the verification result peername */
482 X509_VERIFY_PARAM_move_peername(s->param, NULL);
485 * Check to see if we were changed into a different method, if so, revert
486 * back if we are not doing session-id reuse.
488 if (!ossl_statem_get_in_handshake(s) && (s->session == NULL)
489 && (s->method != s->ctx->method)) {
490 s->method->ssl_free(s);
491 s->method = s->ctx->method;
492 if (!s->method->ssl_new(s))
495 s->method->ssl_clear(s);
497 RECORD_LAYER_clear(&s->rlayer);
502 /** Used to change an SSL_CTXs default SSL method type */
503 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
505 STACK_OF(SSL_CIPHER) *sk;
509 sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
510 &(ctx->cipher_list_by_id),
511 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
512 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
513 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
519 SSL *SSL_new(SSL_CTX *ctx)
524 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
527 if (ctx->method == NULL) {
528 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
532 s = OPENSSL_zalloc(sizeof(*s));
536 s->lock = CRYPTO_THREAD_lock_new();
537 if (s->lock == NULL) {
538 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
543 RECORD_LAYER_init(&s->rlayer, s);
545 s->options = ctx->options;
546 s->dane.flags = ctx->dane.flags;
547 s->min_proto_version = ctx->min_proto_version;
548 s->max_proto_version = ctx->max_proto_version;
550 s->max_cert_list = ctx->max_cert_list;
554 * Earlier library versions used to copy the pointer to the CERT, not
555 * its contents; only when setting new parameters for the per-SSL
556 * copy, ssl_cert_new would be called (and the direct reference to
557 * the per-SSL_CTX settings would be lost, but those still were
558 * indirectly accessed for various purposes, and for that reason they
559 * used to be known as s->ctx->default_cert). Now we don't look at the
560 * SSL_CTX's CERT after having duplicated it once.
562 s->cert = ssl_cert_dup(ctx->cert);
566 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
567 s->msg_callback = ctx->msg_callback;
568 s->msg_callback_arg = ctx->msg_callback_arg;
569 s->verify_mode = ctx->verify_mode;
570 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
571 s->sid_ctx_length = ctx->sid_ctx_length;
572 OPENSSL_assert(s->sid_ctx_length <= sizeof s->sid_ctx);
573 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
574 s->verify_callback = ctx->default_verify_callback;
575 s->generate_session_id = ctx->generate_session_id;
577 s->param = X509_VERIFY_PARAM_new();
578 if (s->param == NULL)
580 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
581 s->quiet_shutdown = ctx->quiet_shutdown;
582 s->max_send_fragment = ctx->max_send_fragment;
583 s->split_send_fragment = ctx->split_send_fragment;
584 s->max_pipelines = ctx->max_pipelines;
585 if (s->max_pipelines > 1)
586 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
587 if (ctx->default_read_buf_len > 0)
588 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
593 s->ext.debug_arg = NULL;
594 s->ext.ticket_expected = 0;
595 s->ext.status_type = ctx->ext.status_type;
596 s->ext.status_expected = 0;
597 s->ext.ocsp.ids = NULL;
598 s->ext.ocsp.exts = NULL;
599 s->ext.ocsp.resp = NULL;
600 s->ext.ocsp.resp_len = 0;
602 s->initial_ctx = ctx;
603 #ifndef OPENSSL_NO_EC
604 if (ctx->ext.ecpointformats) {
605 s->ext.ecpointformats =
606 OPENSSL_memdup(ctx->ext.ecpointformats,
607 ctx->ext.ecpointformats_len);
608 if (!s->ext.ecpointformats)
610 s->ext.ecpointformats_len =
611 ctx->ext.ecpointformats_len;
613 if (ctx->ext.supportedgroups) {
614 s->ext.supportedgroups =
615 OPENSSL_memdup(ctx->ext.supportedgroups,
616 ctx->ext.supportedgroups_len);
617 if (!s->ext.supportedgroups)
619 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
622 #ifndef OPENSSL_NO_NEXTPROTONEG
626 if (s->ctx->ext.alpn) {
627 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
628 if (s->ext.alpn == NULL)
630 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
631 s->ext.alpn_len = s->ctx->ext.alpn_len;
634 s->verified_chain = NULL;
635 s->verify_result = X509_V_OK;
637 s->default_passwd_callback = ctx->default_passwd_callback;
638 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
640 s->method = ctx->method;
642 if (!s->method->ssl_new(s))
645 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
650 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
653 #ifndef OPENSSL_NO_PSK
654 s->psk_client_callback = ctx->psk_client_callback;
655 s->psk_server_callback = ctx->psk_server_callback;
660 #ifndef OPENSSL_NO_CT
661 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
662 ctx->ct_validation_callback_arg))
669 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
673 int SSL_is_dtls(const SSL *s)
675 return SSL_IS_DTLS(s) ? 1 : 0;
678 int SSL_up_ref(SSL *s)
682 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
685 REF_PRINT_COUNT("SSL", s);
686 REF_ASSERT_ISNT(i < 2);
687 return ((i > 1) ? 1 : 0);
690 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
691 unsigned int sid_ctx_len)
693 if (sid_ctx_len > sizeof ctx->sid_ctx) {
694 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
695 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
698 ctx->sid_ctx_length = sid_ctx_len;
699 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
704 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
705 unsigned int sid_ctx_len)
707 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
708 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
709 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
712 ssl->sid_ctx_length = sid_ctx_len;
713 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
718 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
720 CRYPTO_THREAD_write_lock(ctx->lock);
721 ctx->generate_session_id = cb;
722 CRYPTO_THREAD_unlock(ctx->lock);
726 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
728 CRYPTO_THREAD_write_lock(ssl->lock);
729 ssl->generate_session_id = cb;
730 CRYPTO_THREAD_unlock(ssl->lock);
734 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
738 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
739 * we can "construct" a session to give us the desired check - ie. to
740 * find if there's a session in the hash table that would conflict with
741 * any new session built out of this id/id_len and the ssl_version in use
746 if (id_len > sizeof r.session_id)
749 r.ssl_version = ssl->version;
750 r.session_id_length = id_len;
751 memcpy(r.session_id, id, id_len);
753 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
754 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
755 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
759 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
761 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
764 int SSL_set_purpose(SSL *s, int purpose)
766 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
769 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
771 return X509_VERIFY_PARAM_set_trust(s->param, trust);
774 int SSL_set_trust(SSL *s, int trust)
776 return X509_VERIFY_PARAM_set_trust(s->param, trust);
779 int SSL_set1_host(SSL *s, const char *hostname)
781 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
784 int SSL_add1_host(SSL *s, const char *hostname)
786 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
789 void SSL_set_hostflags(SSL *s, unsigned int flags)
791 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
794 const char *SSL_get0_peername(SSL *s)
796 return X509_VERIFY_PARAM_get0_peername(s->param);
799 int SSL_CTX_dane_enable(SSL_CTX *ctx)
801 return dane_ctx_enable(&ctx->dane);
804 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
806 unsigned long orig = ctx->dane.flags;
808 ctx->dane.flags |= flags;
812 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
814 unsigned long orig = ctx->dane.flags;
816 ctx->dane.flags &= ~flags;
820 int SSL_dane_enable(SSL *s, const char *basedomain)
822 SSL_DANE *dane = &s->dane;
824 if (s->ctx->dane.mdmax == 0) {
825 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
828 if (dane->trecs != NULL) {
829 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
834 * Default SNI name. This rejects empty names, while set1_host below
835 * accepts them and disables host name checks. To avoid side-effects with
836 * invalid input, set the SNI name first.
838 if (s->ext.hostname == NULL) {
839 if (!SSL_set_tlsext_host_name(s, basedomain)) {
840 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
845 /* Primary RFC6125 reference identifier */
846 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
847 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
853 dane->dctx = &s->ctx->dane;
854 dane->trecs = sk_danetls_record_new_null();
856 if (dane->trecs == NULL) {
857 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
863 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
865 unsigned long orig = ssl->dane.flags;
867 ssl->dane.flags |= flags;
871 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
873 unsigned long orig = ssl->dane.flags;
875 ssl->dane.flags &= ~flags;
879 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
881 SSL_DANE *dane = &s->dane;
883 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
887 *mcert = dane->mcert;
889 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
894 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
895 uint8_t *mtype, unsigned const char **data, size_t *dlen)
897 SSL_DANE *dane = &s->dane;
899 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
903 *usage = dane->mtlsa->usage;
905 *selector = dane->mtlsa->selector;
907 *mtype = dane->mtlsa->mtype;
909 *data = dane->mtlsa->data;
911 *dlen = dane->mtlsa->dlen;
916 SSL_DANE *SSL_get0_dane(SSL *s)
921 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
922 uint8_t mtype, unsigned char *data, size_t dlen)
924 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
927 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
930 return dane_mtype_set(&ctx->dane, md, mtype, ord);
933 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
935 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
938 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
940 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
943 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
948 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
953 void SSL_certs_clear(SSL *s)
955 ssl_cert_clear_certs(s->cert);
958 void SSL_free(SSL *s)
965 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
966 REF_PRINT_COUNT("SSL", s);
969 REF_ASSERT_ISNT(i < 0);
971 X509_VERIFY_PARAM_free(s->param);
972 dane_final(&s->dane);
973 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
975 ssl_free_wbio_buffer(s);
977 BIO_free_all(s->wbio);
978 BIO_free_all(s->rbio);
980 BUF_MEM_free(s->init_buf);
982 /* add extra stuff */
983 sk_SSL_CIPHER_free(s->cipher_list);
984 sk_SSL_CIPHER_free(s->cipher_list_by_id);
986 /* Make the next call work :-) */
987 if (s->session != NULL) {
988 ssl_clear_bad_session(s);
989 SSL_SESSION_free(s->session);
994 ssl_cert_free(s->cert);
995 /* Free up if allocated */
997 OPENSSL_free(s->ext.hostname);
998 SSL_CTX_free(s->initial_ctx);
999 #ifndef OPENSSL_NO_EC
1000 OPENSSL_free(s->ext.ecpointformats);
1001 OPENSSL_free(s->ext.supportedgroups);
1002 #endif /* OPENSSL_NO_EC */
1003 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1004 #ifndef OPENSSL_NO_OCSP
1005 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1007 #ifndef OPENSSL_NO_CT
1008 SCT_LIST_free(s->scts);
1009 OPENSSL_free(s->ext.scts);
1011 OPENSSL_free(s->ext.ocsp.resp);
1012 OPENSSL_free(s->ext.alpn);
1014 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1016 sk_X509_pop_free(s->verified_chain, X509_free);
1018 if (s->method != NULL)
1019 s->method->ssl_free(s);
1021 RECORD_LAYER_release(&s->rlayer);
1023 SSL_CTX_free(s->ctx);
1025 ASYNC_WAIT_CTX_free(s->waitctx);
1027 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1028 OPENSSL_free(s->ext.npn);
1031 #ifndef OPENSSL_NO_SRTP
1032 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1035 CRYPTO_THREAD_lock_free(s->lock);
1040 void SSL_set0_rbio(SSL *s, BIO *rbio)
1042 BIO_free_all(s->rbio);
1046 void SSL_set0_wbio(SSL *s, BIO *wbio)
1049 * If the output buffering BIO is still in place, remove it
1051 if (s->bbio != NULL)
1052 s->wbio = BIO_pop(s->wbio);
1054 BIO_free_all(s->wbio);
1057 /* Re-attach |bbio| to the new |wbio|. */
1058 if (s->bbio != NULL)
1059 s->wbio = BIO_push(s->bbio, s->wbio);
1062 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1065 * For historical reasons, this function has many different cases in
1066 * ownership handling.
1069 /* If nothing has changed, do nothing */
1070 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1074 * If the two arguments are equal then one fewer reference is granted by the
1075 * caller than we want to take
1077 if (rbio != NULL && rbio == wbio)
1081 * If only the wbio is changed only adopt one reference.
1083 if (rbio == SSL_get_rbio(s)) {
1084 SSL_set0_wbio(s, wbio);
1088 * There is an asymmetry here for historical reasons. If only the rbio is
1089 * changed AND the rbio and wbio were originally different, then we only
1090 * adopt one reference.
1092 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1093 SSL_set0_rbio(s, rbio);
1097 /* Otherwise, adopt both references. */
1098 SSL_set0_rbio(s, rbio);
1099 SSL_set0_wbio(s, wbio);
1102 BIO *SSL_get_rbio(const SSL *s)
1107 BIO *SSL_get_wbio(const SSL *s)
1109 if (s->bbio != NULL) {
1111 * If |bbio| is active, the true caller-configured BIO is its
1114 return BIO_next(s->bbio);
1119 int SSL_get_fd(const SSL *s)
1121 return SSL_get_rfd(s);
1124 int SSL_get_rfd(const SSL *s)
1129 b = SSL_get_rbio(s);
1130 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1132 BIO_get_fd(r, &ret);
1136 int SSL_get_wfd(const SSL *s)
1141 b = SSL_get_wbio(s);
1142 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1144 BIO_get_fd(r, &ret);
1148 #ifndef OPENSSL_NO_SOCK
1149 int SSL_set_fd(SSL *s, int fd)
1154 bio = BIO_new(BIO_s_socket());
1157 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1160 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1161 SSL_set_bio(s, bio, bio);
1167 int SSL_set_wfd(SSL *s, int fd)
1169 BIO *rbio = SSL_get_rbio(s);
1171 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1172 || (int)BIO_get_fd(rbio, NULL) != fd) {
1173 BIO *bio = BIO_new(BIO_s_socket());
1176 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1179 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1180 SSL_set0_wbio(s, bio);
1183 SSL_set0_wbio(s, rbio);
1188 int SSL_set_rfd(SSL *s, int fd)
1190 BIO *wbio = SSL_get_wbio(s);
1192 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1193 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1194 BIO *bio = BIO_new(BIO_s_socket());
1197 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1200 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1201 SSL_set0_rbio(s, bio);
1204 SSL_set0_rbio(s, wbio);
1211 /* return length of latest Finished message we sent, copy to 'buf' */
1212 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1216 if (s->s3 != NULL) {
1217 ret = s->s3->tmp.finish_md_len;
1220 memcpy(buf, s->s3->tmp.finish_md, count);
1225 /* return length of latest Finished message we expected, copy to 'buf' */
1226 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1230 if (s->s3 != NULL) {
1231 ret = s->s3->tmp.peer_finish_md_len;
1234 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1239 int SSL_get_verify_mode(const SSL *s)
1241 return (s->verify_mode);
1244 int SSL_get_verify_depth(const SSL *s)
1246 return X509_VERIFY_PARAM_get_depth(s->param);
1249 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1250 return (s->verify_callback);
1253 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1255 return (ctx->verify_mode);
1258 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1260 return X509_VERIFY_PARAM_get_depth(ctx->param);
1263 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1264 return (ctx->default_verify_callback);
1267 void SSL_set_verify(SSL *s, int mode,
1268 int (*callback) (int ok, X509_STORE_CTX *ctx))
1270 s->verify_mode = mode;
1271 if (callback != NULL)
1272 s->verify_callback = callback;
1275 void SSL_set_verify_depth(SSL *s, int depth)
1277 X509_VERIFY_PARAM_set_depth(s->param, depth);
1280 void SSL_set_read_ahead(SSL *s, int yes)
1282 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1285 int SSL_get_read_ahead(const SSL *s)
1287 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1290 int SSL_pending(const SSL *s)
1292 size_t pending = s->method->ssl_pending(s);
1295 * SSL_pending cannot work properly if read-ahead is enabled
1296 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1297 * impossible to fix since SSL_pending cannot report errors that may be
1298 * observed while scanning the new data. (Note that SSL_pending() is
1299 * often used as a boolean value, so we'd better not return -1.)
1301 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1302 * we just return INT_MAX.
1304 return pending < INT_MAX ? (int)pending : INT_MAX;
1307 int SSL_has_pending(const SSL *s)
1310 * Similar to SSL_pending() but returns a 1 to indicate that we have
1311 * unprocessed data available or 0 otherwise (as opposed to the number of
1312 * bytes available). Unlike SSL_pending() this will take into account
1313 * read_ahead data. A 1 return simply indicates that we have unprocessed
1314 * data. That data may not result in any application data, or we may fail
1315 * to parse the records for some reason.
1320 return RECORD_LAYER_read_pending(&s->rlayer);
1323 X509 *SSL_get_peer_certificate(const SSL *s)
1327 if ((s == NULL) || (s->session == NULL))
1330 r = s->session->peer;
1340 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1344 if ((s == NULL) || (s->session == NULL))
1347 r = s->session->peer_chain;
1350 * If we are a client, cert_chain includes the peer's own certificate; if
1351 * we are a server, it does not.
1358 * Now in theory, since the calling process own 't' it should be safe to
1359 * modify. We need to be able to read f without being hassled
1361 int SSL_copy_session_id(SSL *t, const SSL *f)
1364 /* Do we need to to SSL locking? */
1365 if (!SSL_set_session(t, SSL_get_session(f))) {
1370 * what if we are setup for one protocol version but want to talk another
1372 if (t->method != f->method) {
1373 t->method->ssl_free(t);
1374 t->method = f->method;
1375 if (t->method->ssl_new(t) == 0)
1379 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1380 ssl_cert_free(t->cert);
1382 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1389 /* Fix this so it checks all the valid key/cert options */
1390 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1392 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1393 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1396 if (ctx->cert->key->privatekey == NULL) {
1397 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1400 return (X509_check_private_key
1401 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1404 /* Fix this function so that it takes an optional type parameter */
1405 int SSL_check_private_key(const SSL *ssl)
1408 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1411 if (ssl->cert->key->x509 == NULL) {
1412 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1415 if (ssl->cert->key->privatekey == NULL) {
1416 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1419 return (X509_check_private_key(ssl->cert->key->x509,
1420 ssl->cert->key->privatekey));
1423 int SSL_waiting_for_async(SSL *s)
1431 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1433 ASYNC_WAIT_CTX *ctx = s->waitctx;
1437 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1440 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1441 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1443 ASYNC_WAIT_CTX *ctx = s->waitctx;
1447 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1451 int SSL_accept(SSL *s)
1453 if (s->handshake_func == NULL) {
1454 /* Not properly initialized yet */
1455 SSL_set_accept_state(s);
1458 return SSL_do_handshake(s);
1461 int SSL_connect(SSL *s)
1463 if (s->handshake_func == NULL) {
1464 /* Not properly initialized yet */
1465 SSL_set_connect_state(s);
1468 return SSL_do_handshake(s);
1471 long SSL_get_default_timeout(const SSL *s)
1473 return (s->method->get_timeout());
1476 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1477 int (*func) (void *))
1480 if (s->waitctx == NULL) {
1481 s->waitctx = ASYNC_WAIT_CTX_new();
1482 if (s->waitctx == NULL)
1485 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1486 sizeof(struct ssl_async_args))) {
1488 s->rwstate = SSL_NOTHING;
1489 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1492 s->rwstate = SSL_ASYNC_PAUSED;
1495 s->rwstate = SSL_ASYNC_NO_JOBS;
1501 s->rwstate = SSL_NOTHING;
1502 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1503 /* Shouldn't happen */
1508 static int ssl_io_intern(void *vargs)
1510 struct ssl_async_args *args;
1515 args = (struct ssl_async_args *)vargs;
1519 switch (args->type) {
1521 return args->f.func_read(s, buf, num, &s->asyncrw);
1523 return args->f.func_write(s, buf, num, &s->asyncrw);
1525 return args->f.func_other(s);
1530 int SSL_read(SSL *s, void *buf, int num)
1536 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1540 ret = SSL_read_ex(s, buf, (size_t)num, &readbytes);
1543 * The cast is safe here because ret should be <= INT_MAX because num is
1547 ret = (int)readbytes;
1552 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1554 if (s->handshake_func == NULL) {
1555 SSLerr(SSL_F_SSL_READ_EX, SSL_R_UNINITIALIZED);
1559 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1560 s->rwstate = SSL_NOTHING;
1564 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1565 struct ssl_async_args args;
1571 args.type = READFUNC;
1572 args.f.func_read = s->method->ssl_read;
1574 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1575 *readbytes = s->asyncrw;
1578 return s->method->ssl_read(s, buf, num, readbytes);
1582 int SSL_peek(SSL *s, void *buf, int num)
1588 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1592 ret = SSL_peek_ex(s, buf, (size_t)num, &readbytes);
1595 * The cast is safe here because ret should be <= INT_MAX because num is
1599 ret = (int)readbytes;
1604 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1606 if (s->handshake_func == NULL) {
1607 SSLerr(SSL_F_SSL_PEEK_EX, SSL_R_UNINITIALIZED);
1611 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1614 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1615 struct ssl_async_args args;
1621 args.type = READFUNC;
1622 args.f.func_read = s->method->ssl_peek;
1624 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1625 *readbytes = s->asyncrw;
1628 return s->method->ssl_peek(s, buf, num, readbytes);
1632 int SSL_write(SSL *s, const void *buf, int num)
1638 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1642 ret = SSL_write_ex(s, buf, (size_t)num, &written);
1645 * The cast is safe here because ret should be <= INT_MAX because num is
1654 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1656 if (s->handshake_func == NULL) {
1657 SSLerr(SSL_F_SSL_WRITE_EX, SSL_R_UNINITIALIZED);
1661 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1662 s->rwstate = SSL_NOTHING;
1663 SSLerr(SSL_F_SSL_WRITE_EX, SSL_R_PROTOCOL_IS_SHUTDOWN);
1667 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1669 struct ssl_async_args args;
1672 args.buf = (void *)buf;
1674 args.type = WRITEFUNC;
1675 args.f.func_write = s->method->ssl_write;
1677 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1678 *written = s->asyncrw;
1681 return s->method->ssl_write(s, buf, num, written);
1685 int SSL_shutdown(SSL *s)
1688 * Note that this function behaves differently from what one might
1689 * expect. Return values are 0 for no success (yet), 1 for success; but
1690 * calling it once is usually not enough, even if blocking I/O is used
1691 * (see ssl3_shutdown).
1694 if (s->handshake_func == NULL) {
1695 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1699 if (!SSL_in_init(s)) {
1700 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1701 struct ssl_async_args args;
1704 args.type = OTHERFUNC;
1705 args.f.func_other = s->method->ssl_shutdown;
1707 return ssl_start_async_job(s, &args, ssl_io_intern);
1709 return s->method->ssl_shutdown(s);
1712 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1717 int SSL_renegotiate(SSL *s)
1719 /* Do nothing in TLS1.3 */
1720 if (SSL_IS_TLS13(s))
1723 if (s->renegotiate == 0)
1728 return (s->method->ssl_renegotiate(s));
1731 int SSL_renegotiate_abbreviated(SSL *s)
1733 /* Do nothing in TLS1.3 */
1734 if (SSL_IS_TLS13(s))
1737 if (s->renegotiate == 0)
1742 return (s->method->ssl_renegotiate(s));
1745 int SSL_renegotiate_pending(SSL *s)
1748 * becomes true when negotiation is requested; false again once a
1749 * handshake has finished
1751 return (s->renegotiate != 0);
1754 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1759 case SSL_CTRL_GET_READ_AHEAD:
1760 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1761 case SSL_CTRL_SET_READ_AHEAD:
1762 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1763 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1766 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1767 s->msg_callback_arg = parg;
1771 return (s->mode |= larg);
1772 case SSL_CTRL_CLEAR_MODE:
1773 return (s->mode &= ~larg);
1774 case SSL_CTRL_GET_MAX_CERT_LIST:
1775 return (long)(s->max_cert_list);
1776 case SSL_CTRL_SET_MAX_CERT_LIST:
1779 l = (long)s->max_cert_list;
1780 s->max_cert_list = (size_t)larg;
1782 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1783 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1785 s->max_send_fragment = larg;
1786 if (s->max_send_fragment < s->split_send_fragment)
1787 s->split_send_fragment = s->max_send_fragment;
1789 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1790 if ((size_t)larg > s->max_send_fragment || larg == 0)
1792 s->split_send_fragment = larg;
1794 case SSL_CTRL_SET_MAX_PIPELINES:
1795 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1797 s->max_pipelines = larg;
1799 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1801 case SSL_CTRL_GET_RI_SUPPORT:
1803 return s->s3->send_connection_binding;
1806 case SSL_CTRL_CERT_FLAGS:
1807 return (s->cert->cert_flags |= larg);
1808 case SSL_CTRL_CLEAR_CERT_FLAGS:
1809 return (s->cert->cert_flags &= ~larg);
1811 case SSL_CTRL_GET_RAW_CIPHERLIST:
1813 if (s->s3->tmp.ciphers_raw == NULL)
1815 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
1816 return (int)s->s3->tmp.ciphers_rawlen;
1818 return TLS_CIPHER_LEN;
1820 case SSL_CTRL_GET_EXTMS_SUPPORT:
1821 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
1823 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
1827 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1828 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1829 &s->min_proto_version);
1830 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1831 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1832 &s->max_proto_version);
1834 return (s->method->ssl_ctrl(s, cmd, larg, parg));
1838 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1841 case SSL_CTRL_SET_MSG_CALLBACK:
1842 s->msg_callback = (void (*)
1843 (int write_p, int version, int content_type,
1844 const void *buf, size_t len, SSL *ssl,
1849 return (s->method->ssl_callback_ctrl(s, cmd, fp));
1853 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
1855 return ctx->sessions;
1858 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1861 /* For some cases with ctx == NULL perform syntax checks */
1864 #ifndef OPENSSL_NO_EC
1865 case SSL_CTRL_SET_GROUPS_LIST:
1866 return tls1_set_groups_list(NULL, NULL, parg);
1868 case SSL_CTRL_SET_SIGALGS_LIST:
1869 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
1870 return tls1_set_sigalgs_list(NULL, parg, 0);
1877 case SSL_CTRL_GET_READ_AHEAD:
1878 return (ctx->read_ahead);
1879 case SSL_CTRL_SET_READ_AHEAD:
1880 l = ctx->read_ahead;
1881 ctx->read_ahead = larg;
1884 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1885 ctx->msg_callback_arg = parg;
1888 case SSL_CTRL_GET_MAX_CERT_LIST:
1889 return (long)(ctx->max_cert_list);
1890 case SSL_CTRL_SET_MAX_CERT_LIST:
1893 l = (long)ctx->max_cert_list;
1894 ctx->max_cert_list = (size_t)larg;
1897 case SSL_CTRL_SET_SESS_CACHE_SIZE:
1900 l = (long)ctx->session_cache_size;
1901 ctx->session_cache_size = (size_t)larg;
1903 case SSL_CTRL_GET_SESS_CACHE_SIZE:
1904 return (long)(ctx->session_cache_size);
1905 case SSL_CTRL_SET_SESS_CACHE_MODE:
1906 l = ctx->session_cache_mode;
1907 ctx->session_cache_mode = larg;
1909 case SSL_CTRL_GET_SESS_CACHE_MODE:
1910 return (ctx->session_cache_mode);
1912 case SSL_CTRL_SESS_NUMBER:
1913 return (lh_SSL_SESSION_num_items(ctx->sessions));
1914 case SSL_CTRL_SESS_CONNECT:
1915 return (ctx->stats.sess_connect);
1916 case SSL_CTRL_SESS_CONNECT_GOOD:
1917 return (ctx->stats.sess_connect_good);
1918 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
1919 return (ctx->stats.sess_connect_renegotiate);
1920 case SSL_CTRL_SESS_ACCEPT:
1921 return (ctx->stats.sess_accept);
1922 case SSL_CTRL_SESS_ACCEPT_GOOD:
1923 return (ctx->stats.sess_accept_good);
1924 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
1925 return (ctx->stats.sess_accept_renegotiate);
1926 case SSL_CTRL_SESS_HIT:
1927 return (ctx->stats.sess_hit);
1928 case SSL_CTRL_SESS_CB_HIT:
1929 return (ctx->stats.sess_cb_hit);
1930 case SSL_CTRL_SESS_MISSES:
1931 return (ctx->stats.sess_miss);
1932 case SSL_CTRL_SESS_TIMEOUTS:
1933 return (ctx->stats.sess_timeout);
1934 case SSL_CTRL_SESS_CACHE_FULL:
1935 return (ctx->stats.sess_cache_full);
1937 return (ctx->mode |= larg);
1938 case SSL_CTRL_CLEAR_MODE:
1939 return (ctx->mode &= ~larg);
1940 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1941 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1943 ctx->max_send_fragment = larg;
1944 if (ctx->max_send_fragment < ctx->split_send_fragment)
1945 ctx->split_send_fragment = ctx->max_send_fragment;
1947 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1948 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
1950 ctx->split_send_fragment = larg;
1952 case SSL_CTRL_SET_MAX_PIPELINES:
1953 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1955 ctx->max_pipelines = larg;
1957 case SSL_CTRL_CERT_FLAGS:
1958 return (ctx->cert->cert_flags |= larg);
1959 case SSL_CTRL_CLEAR_CERT_FLAGS:
1960 return (ctx->cert->cert_flags &= ~larg);
1961 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1962 return ssl_set_version_bound(ctx->method->version, (int)larg,
1963 &ctx->min_proto_version);
1964 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1965 return ssl_set_version_bound(ctx->method->version, (int)larg,
1966 &ctx->max_proto_version);
1968 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
1972 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
1975 case SSL_CTRL_SET_MSG_CALLBACK:
1976 ctx->msg_callback = (void (*)
1977 (int write_p, int version, int content_type,
1978 const void *buf, size_t len, SSL *ssl,
1983 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
1987 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
1996 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
1997 const SSL_CIPHER *const *bp)
1999 if ((*ap)->id > (*bp)->id)
2001 if ((*ap)->id < (*bp)->id)
2006 /** return a STACK of the ciphers available for the SSL and in order of
2008 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2011 if (s->cipher_list != NULL) {
2012 return (s->cipher_list);
2013 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2014 return (s->ctx->cipher_list);
2020 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2022 if ((s == NULL) || (s->session == NULL) || !s->server)
2024 return s->session->ciphers;
2027 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2029 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2031 ciphers = SSL_get_ciphers(s);
2034 ssl_set_client_disabled(s);
2035 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2036 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2037 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
2039 sk = sk_SSL_CIPHER_new_null();
2042 if (!sk_SSL_CIPHER_push(sk, c)) {
2043 sk_SSL_CIPHER_free(sk);
2051 /** return a STACK of the ciphers available for the SSL and in order of
2053 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2056 if (s->cipher_list_by_id != NULL) {
2057 return (s->cipher_list_by_id);
2058 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2059 return (s->ctx->cipher_list_by_id);
2065 /** The old interface to get the same thing as SSL_get_ciphers() */
2066 const char *SSL_get_cipher_list(const SSL *s, int n)
2068 const SSL_CIPHER *c;
2069 STACK_OF(SSL_CIPHER) *sk;
2073 sk = SSL_get_ciphers(s);
2074 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2076 c = sk_SSL_CIPHER_value(sk, n);
2082 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2084 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2087 return ctx->cipher_list;
2091 /** specify the ciphers to be used by default by the SSL_CTX */
2092 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2094 STACK_OF(SSL_CIPHER) *sk;
2096 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2097 &ctx->cipher_list_by_id, str, ctx->cert);
2099 * ssl_create_cipher_list may return an empty stack if it was unable to
2100 * find a cipher matching the given rule string (for example if the rule
2101 * string specifies a cipher which has been disabled). This is not an
2102 * error as far as ssl_create_cipher_list is concerned, and hence
2103 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2107 else if (sk_SSL_CIPHER_num(sk) == 0) {
2108 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2114 /** specify the ciphers to be used by the SSL */
2115 int SSL_set_cipher_list(SSL *s, const char *str)
2117 STACK_OF(SSL_CIPHER) *sk;
2119 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2120 &s->cipher_list_by_id, str, s->cert);
2121 /* see comment in SSL_CTX_set_cipher_list */
2124 else if (sk_SSL_CIPHER_num(sk) == 0) {
2125 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2131 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2134 STACK_OF(SSL_CIPHER) *sk;
2135 const SSL_CIPHER *c;
2138 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2142 sk = s->session->ciphers;
2144 if (sk_SSL_CIPHER_num(sk) == 0)
2147 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2150 c = sk_SSL_CIPHER_value(sk, i);
2151 n = strlen(c->name);
2158 memcpy(p, c->name, n + 1);
2167 /** return a servername extension value if provided in Client Hello, or NULL.
2168 * So far, only host_name types are defined (RFC 3546).
2171 const char *SSL_get_servername(const SSL *s, const int type)
2173 if (type != TLSEXT_NAMETYPE_host_name)
2176 return s->session && !s->ext.hostname ?
2177 s->session->ext.hostname : s->ext.hostname;
2180 int SSL_get_servername_type(const SSL *s)
2183 && (!s->ext.hostname ? s->session->
2184 ext.hostname : s->ext.hostname))
2185 return TLSEXT_NAMETYPE_host_name;
2190 * SSL_select_next_proto implements the standard protocol selection. It is
2191 * expected that this function is called from the callback set by
2192 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2193 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2194 * not included in the length. A byte string of length 0 is invalid. No byte
2195 * string may be truncated. The current, but experimental algorithm for
2196 * selecting the protocol is: 1) If the server doesn't support NPN then this
2197 * is indicated to the callback. In this case, the client application has to
2198 * abort the connection or have a default application level protocol. 2) If
2199 * the server supports NPN, but advertises an empty list then the client
2200 * selects the first protocol in its list, but indicates via the API that this
2201 * fallback case was enacted. 3) Otherwise, the client finds the first
2202 * protocol in the server's list that it supports and selects this protocol.
2203 * This is because it's assumed that the server has better information about
2204 * which protocol a client should use. 4) If the client doesn't support any
2205 * of the server's advertised protocols, then this is treated the same as
2206 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2207 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2209 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2210 const unsigned char *server,
2211 unsigned int server_len,
2212 const unsigned char *client, unsigned int client_len)
2215 const unsigned char *result;
2216 int status = OPENSSL_NPN_UNSUPPORTED;
2219 * For each protocol in server preference order, see if we support it.
2221 for (i = 0; i < server_len;) {
2222 for (j = 0; j < client_len;) {
2223 if (server[i] == client[j] &&
2224 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2225 /* We found a match */
2226 result = &server[i];
2227 status = OPENSSL_NPN_NEGOTIATED;
2237 /* There's no overlap between our protocols and the server's list. */
2239 status = OPENSSL_NPN_NO_OVERLAP;
2242 *out = (unsigned char *)result + 1;
2243 *outlen = result[0];
2247 #ifndef OPENSSL_NO_NEXTPROTONEG
2249 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2250 * client's requested protocol for this connection and returns 0. If the
2251 * client didn't request any protocol, then *data is set to NULL. Note that
2252 * the client can request any protocol it chooses. The value returned from
2253 * this function need not be a member of the list of supported protocols
2254 * provided by the callback.
2256 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2263 *len = (unsigned int)s->ext.npn_len;
2268 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2269 * a TLS server needs a list of supported protocols for Next Protocol
2270 * Negotiation. The returned list must be in wire format. The list is
2271 * returned by setting |out| to point to it and |outlen| to its length. This
2272 * memory will not be modified, but one should assume that the SSL* keeps a
2273 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2274 * wishes to advertise. Otherwise, no such extension will be included in the
2277 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2278 SSL_CTX_npn_advertised_cb_func cb,
2281 ctx->ext.npn_advertised_cb = cb;
2282 ctx->ext.npn_advertised_cb_arg = arg;
2286 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2287 * client needs to select a protocol from the server's provided list. |out|
2288 * must be set to point to the selected protocol (which may be within |in|).
2289 * The length of the protocol name must be written into |outlen|. The
2290 * server's advertised protocols are provided in |in| and |inlen|. The
2291 * callback can assume that |in| is syntactically valid. The client must
2292 * select a protocol. It is fatal to the connection if this callback returns
2293 * a value other than SSL_TLSEXT_ERR_OK.
2295 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2296 SSL_CTX_npn_select_cb_func cb,
2299 ctx->ext.npn_select_cb = cb;
2300 ctx->ext.npn_select_cb_arg = arg;
2305 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2306 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2307 * length-prefixed strings). Returns 0 on success.
2309 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2310 unsigned int protos_len)
2312 OPENSSL_free(ctx->ext.alpn);
2313 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2314 if (ctx->ext.alpn == NULL) {
2315 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2318 ctx->ext.alpn_len = protos_len;
2324 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2325 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2326 * length-prefixed strings). Returns 0 on success.
2328 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2329 unsigned int protos_len)
2331 OPENSSL_free(ssl->ext.alpn);
2332 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2333 if (ssl->ext.alpn == NULL) {
2334 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2337 ssl->ext.alpn_len = protos_len;
2343 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2344 * called during ClientHello processing in order to select an ALPN protocol
2345 * from the client's list of offered protocols.
2347 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2348 SSL_CTX_alpn_select_cb_func cb,
2351 ctx->ext.alpn_select_cb = cb;
2352 ctx->ext.alpn_select_cb_arg = arg;
2356 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2357 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2358 * (not including the leading length-prefix byte). If the server didn't
2359 * respond with a negotiated protocol then |*len| will be zero.
2361 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2366 *data = ssl->s3->alpn_selected;
2370 *len = (unsigned int)ssl->s3->alpn_selected_len;
2373 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2374 const char *label, size_t llen,
2375 const unsigned char *p, size_t plen,
2378 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2381 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2386 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2391 ((unsigned int)a->session_id[0]) |
2392 ((unsigned int)a->session_id[1] << 8L) |
2393 ((unsigned long)a->session_id[2] << 16L) |
2394 ((unsigned long)a->session_id[3] << 24L);
2399 * NB: If this function (or indeed the hash function which uses a sort of
2400 * coarser function than this one) is changed, ensure
2401 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2402 * being able to construct an SSL_SESSION that will collide with any existing
2403 * session with a matching session ID.
2405 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2407 if (a->ssl_version != b->ssl_version)
2409 if (a->session_id_length != b->session_id_length)
2411 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2415 * These wrapper functions should remain rather than redeclaring
2416 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2417 * variable. The reason is that the functions aren't static, they're exposed
2421 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2423 SSL_CTX *ret = NULL;
2426 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2430 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2433 if (FIPS_mode() && (meth->version < TLS1_VERSION)) {
2434 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE);
2438 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2439 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2442 ret = OPENSSL_zalloc(sizeof(*ret));
2447 ret->min_proto_version = 0;
2448 ret->max_proto_version = 0;
2449 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2450 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2451 /* We take the system default. */
2452 ret->session_timeout = meth->get_timeout();
2453 ret->references = 1;
2454 ret->lock = CRYPTO_THREAD_lock_new();
2455 if (ret->lock == NULL) {
2456 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2460 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2461 ret->verify_mode = SSL_VERIFY_NONE;
2462 if ((ret->cert = ssl_cert_new()) == NULL)
2465 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2466 if (ret->sessions == NULL)
2468 ret->cert_store = X509_STORE_new();
2469 if (ret->cert_store == NULL)
2471 #ifndef OPENSSL_NO_CT
2472 ret->ctlog_store = CTLOG_STORE_new();
2473 if (ret->ctlog_store == NULL)
2476 if (!ssl_create_cipher_list(ret->method,
2477 &ret->cipher_list, &ret->cipher_list_by_id,
2478 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2479 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2480 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2484 ret->param = X509_VERIFY_PARAM_new();
2485 if (ret->param == NULL)
2488 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2489 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2492 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2493 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2497 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2500 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2503 /* No compression for DTLS */
2504 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2505 ret->comp_methods = SSL_COMP_get_compression_methods();
2507 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2508 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2510 /* Setup RFC5077 ticket keys */
2511 if ((RAND_bytes(ret->ext.tick_key_name,
2512 sizeof(ret->ext.tick_key_name)) <= 0)
2513 || (RAND_bytes(ret->ext.tick_hmac_key,
2514 sizeof(ret->ext.tick_hmac_key)) <= 0)
2515 || (RAND_bytes(ret->ext.tick_aes_key,
2516 sizeof(ret->ext.tick_aes_key)) <= 0))
2517 ret->options |= SSL_OP_NO_TICKET;
2519 #ifndef OPENSSL_NO_SRP
2520 if (!SSL_CTX_SRP_CTX_init(ret))
2523 #ifndef OPENSSL_NO_ENGINE
2524 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2525 # define eng_strx(x) #x
2526 # define eng_str(x) eng_strx(x)
2527 /* Use specific client engine automatically... ignore errors */
2530 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2533 ENGINE_load_builtin_engines();
2534 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2536 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2542 * Default is to connect to non-RI servers. When RI is more widely
2543 * deployed might change this.
2545 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2547 * Disable compression by default to prevent CRIME. Applications can
2548 * re-enable compression by configuring
2549 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2550 * or by using the SSL_CONF library.
2552 ret->options |= SSL_OP_NO_COMPRESSION;
2554 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2558 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2564 int SSL_CTX_up_ref(SSL_CTX *ctx)
2568 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2571 REF_PRINT_COUNT("SSL_CTX", ctx);
2572 REF_ASSERT_ISNT(i < 2);
2573 return ((i > 1) ? 1 : 0);
2576 void SSL_CTX_free(SSL_CTX *a)
2583 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2584 REF_PRINT_COUNT("SSL_CTX", a);
2587 REF_ASSERT_ISNT(i < 0);
2589 X509_VERIFY_PARAM_free(a->param);
2590 dane_ctx_final(&a->dane);
2593 * Free internal session cache. However: the remove_cb() may reference
2594 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2595 * after the sessions were flushed.
2596 * As the ex_data handling routines might also touch the session cache,
2597 * the most secure solution seems to be: empty (flush) the cache, then
2598 * free ex_data, then finally free the cache.
2599 * (See ticket [openssl.org #212].)
2601 if (a->sessions != NULL)
2602 SSL_CTX_flush_sessions(a, 0);
2604 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2605 lh_SSL_SESSION_free(a->sessions);
2606 X509_STORE_free(a->cert_store);
2607 #ifndef OPENSSL_NO_CT
2608 CTLOG_STORE_free(a->ctlog_store);
2610 sk_SSL_CIPHER_free(a->cipher_list);
2611 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2612 ssl_cert_free(a->cert);
2613 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2614 sk_X509_pop_free(a->extra_certs, X509_free);
2615 a->comp_methods = NULL;
2616 #ifndef OPENSSL_NO_SRTP
2617 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2619 #ifndef OPENSSL_NO_SRP
2620 SSL_CTX_SRP_CTX_free(a);
2622 #ifndef OPENSSL_NO_ENGINE
2623 ENGINE_finish(a->client_cert_engine);
2626 #ifndef OPENSSL_NO_EC
2627 OPENSSL_free(a->ext.ecpointformats);
2628 OPENSSL_free(a->ext.supportedgroups);
2630 OPENSSL_free(a->ext.alpn);
2632 CRYPTO_THREAD_lock_free(a->lock);
2637 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2639 ctx->default_passwd_callback = cb;
2642 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2644 ctx->default_passwd_callback_userdata = u;
2647 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2649 return ctx->default_passwd_callback;
2652 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2654 return ctx->default_passwd_callback_userdata;
2657 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2659 s->default_passwd_callback = cb;
2662 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2664 s->default_passwd_callback_userdata = u;
2667 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2669 return s->default_passwd_callback;
2672 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2674 return s->default_passwd_callback_userdata;
2677 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2678 int (*cb) (X509_STORE_CTX *, void *),
2681 ctx->app_verify_callback = cb;
2682 ctx->app_verify_arg = arg;
2685 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2686 int (*cb) (int, X509_STORE_CTX *))
2688 ctx->verify_mode = mode;
2689 ctx->default_verify_callback = cb;
2692 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2694 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2697 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2699 ssl_cert_set_cert_cb(c->cert, cb, arg);
2702 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2704 ssl_cert_set_cert_cb(s->cert, cb, arg);
2707 void ssl_set_masks(SSL *s)
2709 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_GOST)
2713 uint32_t *pvalid = s->s3->tmp.valid_flags;
2714 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2715 unsigned long mask_k, mask_a;
2716 #ifndef OPENSSL_NO_EC
2717 int have_ecc_cert, ecdsa_ok;
2723 #ifndef OPENSSL_NO_DH
2724 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2729 rsa_enc = pvalid[SSL_PKEY_RSA_ENC] & CERT_PKEY_VALID;
2730 rsa_sign = pvalid[SSL_PKEY_RSA_SIGN] & CERT_PKEY_SIGN;
2731 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_SIGN;
2732 #ifndef OPENSSL_NO_EC
2733 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2739 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2740 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2743 #ifndef OPENSSL_NO_GOST
2744 cpk = &(c->pkeys[SSL_PKEY_GOST12_512]);
2745 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2746 mask_k |= SSL_kGOST;
2747 mask_a |= SSL_aGOST12;
2749 cpk = &(c->pkeys[SSL_PKEY_GOST12_256]);
2750 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2751 mask_k |= SSL_kGOST;
2752 mask_a |= SSL_aGOST12;
2754 cpk = &(c->pkeys[SSL_PKEY_GOST01]);
2755 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2756 mask_k |= SSL_kGOST;
2757 mask_a |= SSL_aGOST01;
2767 if (rsa_enc || rsa_sign) {
2775 mask_a |= SSL_aNULL;
2778 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2779 * depending on the key usage extension.
2781 #ifndef OPENSSL_NO_EC
2782 if (have_ecc_cert) {
2784 cpk = &c->pkeys[SSL_PKEY_ECC];
2786 ex_kusage = X509_get_key_usage(x);
2787 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2788 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2791 mask_a |= SSL_aECDSA;
2795 #ifndef OPENSSL_NO_EC
2796 mask_k |= SSL_kECDHE;
2799 #ifndef OPENSSL_NO_PSK
2802 if (mask_k & SSL_kRSA)
2803 mask_k |= SSL_kRSAPSK;
2804 if (mask_k & SSL_kDHE)
2805 mask_k |= SSL_kDHEPSK;
2806 if (mask_k & SSL_kECDHE)
2807 mask_k |= SSL_kECDHEPSK;
2810 s->s3->tmp.mask_k = mask_k;
2811 s->s3->tmp.mask_a = mask_a;
2814 #ifndef OPENSSL_NO_EC
2816 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
2818 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
2819 /* key usage, if present, must allow signing */
2820 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
2821 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
2822 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
2826 return 1; /* all checks are ok */
2831 static int ssl_get_server_cert_index(const SSL *s)
2836 * TODO(TLS1.3): In TLS1.3 the selected certificate is not based on the
2837 * ciphersuite. For now though it still is. Our only TLS1.3 ciphersuite
2838 * forces the use of an RSA cert. This will need to change.
2840 idx = ssl_cipher_get_cert_index(s->s3->tmp.new_cipher);
2841 if (idx == SSL_PKEY_RSA_ENC && !s->cert->pkeys[SSL_PKEY_RSA_ENC].x509)
2842 idx = SSL_PKEY_RSA_SIGN;
2843 if (idx == SSL_PKEY_GOST_EC) {
2844 if (s->cert->pkeys[SSL_PKEY_GOST12_512].x509)
2845 idx = SSL_PKEY_GOST12_512;
2846 else if (s->cert->pkeys[SSL_PKEY_GOST12_256].x509)
2847 idx = SSL_PKEY_GOST12_256;
2848 else if (s->cert->pkeys[SSL_PKEY_GOST01].x509)
2849 idx = SSL_PKEY_GOST01;
2854 SSLerr(SSL_F_SSL_GET_SERVER_CERT_INDEX, ERR_R_INTERNAL_ERROR);
2858 CERT_PKEY *ssl_get_server_send_pkey(SSL *s)
2864 if (!s->s3 || !s->s3->tmp.new_cipher)
2868 i = ssl_get_server_cert_index(s);
2870 /* This may or may not be an error. */
2875 return &c->pkeys[i];
2878 EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *cipher,
2881 unsigned long alg_a;
2885 alg_a = cipher->algorithm_auth;
2888 if ((alg_a & SSL_aDSS) && (c->pkeys[SSL_PKEY_DSA_SIGN].privatekey != NULL))
2889 idx = SSL_PKEY_DSA_SIGN;
2890 else if (alg_a & SSL_aRSA) {
2891 if (c->pkeys[SSL_PKEY_RSA_SIGN].privatekey != NULL)
2892 idx = SSL_PKEY_RSA_SIGN;
2893 else if (c->pkeys[SSL_PKEY_RSA_ENC].privatekey != NULL)
2894 idx = SSL_PKEY_RSA_ENC;
2895 } else if ((alg_a & SSL_aECDSA) &&
2896 (c->pkeys[SSL_PKEY_ECC].privatekey != NULL))
2899 SSLerr(SSL_F_SSL_GET_SIGN_PKEY, ERR_R_INTERNAL_ERROR);
2903 *pmd = s->s3->tmp.md[idx];
2904 return c->pkeys[idx].privatekey;
2907 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
2908 size_t *serverinfo_length)
2912 *serverinfo_length = 0;
2915 i = ssl_get_server_cert_index(s);
2919 if (c->pkeys[i].serverinfo == NULL)
2922 *serverinfo = c->pkeys[i].serverinfo;
2923 *serverinfo_length = c->pkeys[i].serverinfo_length;
2927 void ssl_update_cache(SSL *s, int mode)
2932 * If the session_id_length is 0, we are not supposed to cache it, and it
2933 * would be rather hard to do anyway :-)
2935 if (s->session->session_id_length == 0)
2938 i = s->session_ctx->session_cache_mode;
2939 if ((i & mode) && (!s->hit)
2940 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
2941 || SSL_CTX_add_session(s->session_ctx, s->session))
2942 && (s->session_ctx->new_session_cb != NULL)) {
2943 SSL_SESSION_up_ref(s->session);
2944 if (!s->session_ctx->new_session_cb(s, s->session))
2945 SSL_SESSION_free(s->session);
2948 /* auto flush every 255 connections */
2949 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
2950 if ((((mode & SSL_SESS_CACHE_CLIENT)
2951 ? s->session_ctx->stats.sess_connect_good
2952 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
2953 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
2958 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
2963 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
2968 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
2972 if (s->method != meth) {
2973 const SSL_METHOD *sm = s->method;
2974 int (*hf) (SSL *) = s->handshake_func;
2976 if (sm->version == meth->version)
2981 ret = s->method->ssl_new(s);
2984 if (hf == sm->ssl_connect)
2985 s->handshake_func = meth->ssl_connect;
2986 else if (hf == sm->ssl_accept)
2987 s->handshake_func = meth->ssl_accept;
2992 int SSL_get_error(const SSL *s, int i)
2999 return (SSL_ERROR_NONE);
3002 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3003 * where we do encode the error
3005 if ((l = ERR_peek_error()) != 0) {
3006 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3007 return (SSL_ERROR_SYSCALL);
3009 return (SSL_ERROR_SSL);
3012 if (SSL_want_read(s)) {
3013 bio = SSL_get_rbio(s);
3014 if (BIO_should_read(bio))
3015 return (SSL_ERROR_WANT_READ);
3016 else if (BIO_should_write(bio))
3018 * This one doesn't make too much sense ... We never try to write
3019 * to the rbio, and an application program where rbio and wbio
3020 * are separate couldn't even know what it should wait for.
3021 * However if we ever set s->rwstate incorrectly (so that we have
3022 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3023 * wbio *are* the same, this test works around that bug; so it
3024 * might be safer to keep it.
3026 return (SSL_ERROR_WANT_WRITE);
3027 else if (BIO_should_io_special(bio)) {
3028 reason = BIO_get_retry_reason(bio);
3029 if (reason == BIO_RR_CONNECT)
3030 return (SSL_ERROR_WANT_CONNECT);
3031 else if (reason == BIO_RR_ACCEPT)
3032 return (SSL_ERROR_WANT_ACCEPT);
3034 return (SSL_ERROR_SYSCALL); /* unknown */
3038 if (SSL_want_write(s)) {
3040 * Access wbio directly - in order to use the buffered bio if
3044 if (BIO_should_write(bio))
3045 return (SSL_ERROR_WANT_WRITE);
3046 else if (BIO_should_read(bio))
3048 * See above (SSL_want_read(s) with BIO_should_write(bio))
3050 return (SSL_ERROR_WANT_READ);
3051 else if (BIO_should_io_special(bio)) {
3052 reason = BIO_get_retry_reason(bio);
3053 if (reason == BIO_RR_CONNECT)
3054 return (SSL_ERROR_WANT_CONNECT);
3055 else if (reason == BIO_RR_ACCEPT)
3056 return (SSL_ERROR_WANT_ACCEPT);
3058 return (SSL_ERROR_SYSCALL);
3061 if (SSL_want_x509_lookup(s)) {
3062 return (SSL_ERROR_WANT_X509_LOOKUP);
3064 if (SSL_want_async(s)) {
3065 return SSL_ERROR_WANT_ASYNC;
3067 if (SSL_want_async_job(s)) {
3068 return SSL_ERROR_WANT_ASYNC_JOB;
3071 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3072 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3073 return (SSL_ERROR_ZERO_RETURN);
3075 return (SSL_ERROR_SYSCALL);
3078 static int ssl_do_handshake_intern(void *vargs)
3080 struct ssl_async_args *args;
3083 args = (struct ssl_async_args *)vargs;
3086 return s->handshake_func(s);
3089 int SSL_do_handshake(SSL *s)
3093 if (s->handshake_func == NULL) {
3094 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3098 s->method->ssl_renegotiate_check(s, 0);
3100 if (SSL_in_init(s) || SSL_in_before(s)) {
3101 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3102 struct ssl_async_args args;
3106 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3108 ret = s->handshake_func(s);
3114 void SSL_set_accept_state(SSL *s)
3118 ossl_statem_clear(s);
3119 s->handshake_func = s->method->ssl_accept;
3123 void SSL_set_connect_state(SSL *s)
3127 ossl_statem_clear(s);
3128 s->handshake_func = s->method->ssl_connect;
3132 int ssl_undefined_function(SSL *s)
3134 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3138 int ssl_undefined_void_function(void)
3140 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3141 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3145 int ssl_undefined_const_function(const SSL *s)
3150 const SSL_METHOD *ssl_bad_method(int ver)
3152 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3156 const char *ssl_protocol_to_string(int version)
3160 case TLS1_3_VERSION:
3163 case TLS1_2_VERSION:
3166 case TLS1_1_VERSION:
3181 case DTLS1_2_VERSION:
3189 const char *SSL_get_version(const SSL *s)
3191 return ssl_protocol_to_string(s->version);
3194 SSL *SSL_dup(SSL *s)
3196 STACK_OF(X509_NAME) *sk;
3201 /* If we're not quiescent, just up_ref! */
3202 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3203 CRYPTO_UP_REF(&s->references, &i, s->lock);
3208 * Otherwise, copy configuration state, and session if set.
3210 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3213 if (s->session != NULL) {
3215 * Arranges to share the same session via up_ref. This "copies"
3216 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3218 if (!SSL_copy_session_id(ret, s))
3222 * No session has been established yet, so we have to expect that
3223 * s->cert or ret->cert will be changed later -- they should not both
3224 * point to the same object, and thus we can't use
3225 * SSL_copy_session_id.
3227 if (!SSL_set_ssl_method(ret, s->method))
3230 if (s->cert != NULL) {
3231 ssl_cert_free(ret->cert);
3232 ret->cert = ssl_cert_dup(s->cert);
3233 if (ret->cert == NULL)
3237 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3238 (int)s->sid_ctx_length))
3242 if (!ssl_dane_dup(ret, s))
3244 ret->version = s->version;
3245 ret->options = s->options;
3246 ret->mode = s->mode;
3247 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3248 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3249 ret->msg_callback = s->msg_callback;
3250 ret->msg_callback_arg = s->msg_callback_arg;
3251 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3252 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3253 ret->generate_session_id = s->generate_session_id;
3255 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3257 /* copy app data, a little dangerous perhaps */
3258 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3261 /* setup rbio, and wbio */
3262 if (s->rbio != NULL) {
3263 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3266 if (s->wbio != NULL) {
3267 if (s->wbio != s->rbio) {
3268 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3271 BIO_up_ref(ret->rbio);
3272 ret->wbio = ret->rbio;
3276 ret->server = s->server;
3277 if (s->handshake_func) {
3279 SSL_set_accept_state(ret);
3281 SSL_set_connect_state(ret);
3283 ret->shutdown = s->shutdown;
3286 ret->default_passwd_callback = s->default_passwd_callback;
3287 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3289 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3291 /* dup the cipher_list and cipher_list_by_id stacks */
3292 if (s->cipher_list != NULL) {
3293 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3296 if (s->cipher_list_by_id != NULL)
3297 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3301 /* Dup the client_CA list */
3302 if (s->client_CA != NULL) {
3303 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3305 ret->client_CA = sk;
3306 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3307 xn = sk_X509_NAME_value(sk, i);
3308 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3321 void ssl_clear_cipher_ctx(SSL *s)
3323 if (s->enc_read_ctx != NULL) {
3324 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3325 s->enc_read_ctx = NULL;
3327 if (s->enc_write_ctx != NULL) {
3328 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3329 s->enc_write_ctx = NULL;
3331 #ifndef OPENSSL_NO_COMP
3332 COMP_CTX_free(s->expand);
3334 COMP_CTX_free(s->compress);
3339 X509 *SSL_get_certificate(const SSL *s)
3341 if (s->cert != NULL)
3342 return (s->cert->key->x509);
3347 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3349 if (s->cert != NULL)
3350 return (s->cert->key->privatekey);
3355 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3357 if (ctx->cert != NULL)
3358 return ctx->cert->key->x509;
3363 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3365 if (ctx->cert != NULL)
3366 return ctx->cert->key->privatekey;
3371 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3373 if ((s->session != NULL) && (s->session->cipher != NULL))
3374 return (s->session->cipher);
3378 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3380 #ifndef OPENSSL_NO_COMP
3381 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3387 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3389 #ifndef OPENSSL_NO_COMP
3390 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3396 int ssl_init_wbio_buffer(SSL *s)
3400 if (s->bbio != NULL) {
3401 /* Already buffered. */
3405 bbio = BIO_new(BIO_f_buffer());
3406 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3408 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3412 s->wbio = BIO_push(bbio, s->wbio);
3417 void ssl_free_wbio_buffer(SSL *s)
3419 /* callers ensure s is never null */
3420 if (s->bbio == NULL)
3423 s->wbio = BIO_pop(s->wbio);
3424 assert(s->wbio != NULL);
3429 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3431 ctx->quiet_shutdown = mode;
3434 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3436 return (ctx->quiet_shutdown);
3439 void SSL_set_quiet_shutdown(SSL *s, int mode)
3441 s->quiet_shutdown = mode;
3444 int SSL_get_quiet_shutdown(const SSL *s)
3446 return (s->quiet_shutdown);
3449 void SSL_set_shutdown(SSL *s, int mode)
3454 int SSL_get_shutdown(const SSL *s)
3459 int SSL_version(const SSL *s)
3464 int SSL_client_version(const SSL *s)
3466 return s->client_version;
3469 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3474 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3477 if (ssl->ctx == ctx)
3480 ctx = ssl->initial_ctx;
3481 new_cert = ssl_cert_dup(ctx->cert);
3482 if (new_cert == NULL) {
3485 ssl_cert_free(ssl->cert);
3486 ssl->cert = new_cert;
3489 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3490 * so setter APIs must prevent invalid lengths from entering the system.
3492 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3495 * If the session ID context matches that of the parent SSL_CTX,
3496 * inherit it from the new SSL_CTX as well. If however the context does
3497 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3498 * leave it unchanged.
3500 if ((ssl->ctx != NULL) &&
3501 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3502 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3503 ssl->sid_ctx_length = ctx->sid_ctx_length;
3504 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3507 SSL_CTX_up_ref(ctx);
3508 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3514 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3516 return (X509_STORE_set_default_paths(ctx->cert_store));
3519 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3521 X509_LOOKUP *lookup;
3523 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3526 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3528 /* Clear any errors if the default directory does not exist */
3534 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3536 X509_LOOKUP *lookup;
3538 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3542 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3544 /* Clear any errors if the default file does not exist */
3550 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3553 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3556 void SSL_set_info_callback(SSL *ssl,
3557 void (*cb) (const SSL *ssl, int type, int val))
3559 ssl->info_callback = cb;
3563 * One compiler (Diab DCC) doesn't like argument names in returned function
3566 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3569 return ssl->info_callback;
3572 void SSL_set_verify_result(SSL *ssl, long arg)
3574 ssl->verify_result = arg;
3577 long SSL_get_verify_result(const SSL *ssl)
3579 return (ssl->verify_result);
3582 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3585 return sizeof(ssl->s3->client_random);
3586 if (outlen > sizeof(ssl->s3->client_random))
3587 outlen = sizeof(ssl->s3->client_random);
3588 memcpy(out, ssl->s3->client_random, outlen);
3592 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3595 return sizeof(ssl->s3->server_random);
3596 if (outlen > sizeof(ssl->s3->server_random))
3597 outlen = sizeof(ssl->s3->server_random);
3598 memcpy(out, ssl->s3->server_random, outlen);
3602 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3603 unsigned char *out, size_t outlen)
3606 return session->master_key_length;
3607 if (outlen > session->master_key_length)
3608 outlen = session->master_key_length;
3609 memcpy(out, session->master_key, outlen);
3613 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3615 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3618 void *SSL_get_ex_data(const SSL *s, int idx)
3620 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3623 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3625 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3628 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3630 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3638 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3640 return (ctx->cert_store);
3643 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3645 X509_STORE_free(ctx->cert_store);
3646 ctx->cert_store = store;
3649 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3652 X509_STORE_up_ref(store);
3653 SSL_CTX_set_cert_store(ctx, store);
3656 int SSL_want(const SSL *s)
3658 return (s->rwstate);
3662 * \brief Set the callback for generating temporary DH keys.
3663 * \param ctx the SSL context.
3664 * \param dh the callback
3667 #ifndef OPENSSL_NO_DH
3668 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3669 DH *(*dh) (SSL *ssl, int is_export,
3672 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3675 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3678 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3682 #ifndef OPENSSL_NO_PSK
3683 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3685 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3686 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3689 OPENSSL_free(ctx->cert->psk_identity_hint);
3690 if (identity_hint != NULL) {
3691 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3692 if (ctx->cert->psk_identity_hint == NULL)
3695 ctx->cert->psk_identity_hint = NULL;
3699 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3704 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3705 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3708 OPENSSL_free(s->cert->psk_identity_hint);
3709 if (identity_hint != NULL) {
3710 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3711 if (s->cert->psk_identity_hint == NULL)
3714 s->cert->psk_identity_hint = NULL;
3718 const char *SSL_get_psk_identity_hint(const SSL *s)
3720 if (s == NULL || s->session == NULL)
3722 return (s->session->psk_identity_hint);
3725 const char *SSL_get_psk_identity(const SSL *s)
3727 if (s == NULL || s->session == NULL)
3729 return (s->session->psk_identity);
3732 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3734 s->psk_client_callback = cb;
3737 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3739 ctx->psk_client_callback = cb;
3742 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3744 s->psk_server_callback = cb;
3747 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3749 ctx->psk_server_callback = cb;
3753 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3754 void (*cb) (int write_p, int version,
3755 int content_type, const void *buf,
3756 size_t len, SSL *ssl, void *arg))
3758 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3761 void SSL_set_msg_callback(SSL *ssl,
3762 void (*cb) (int write_p, int version,
3763 int content_type, const void *buf,
3764 size_t len, SSL *ssl, void *arg))
3766 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3769 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3770 int (*cb) (SSL *ssl,
3774 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3775 (void (*)(void))cb);
3778 void SSL_set_not_resumable_session_callback(SSL *ssl,
3779 int (*cb) (SSL *ssl,
3780 int is_forward_secure))
3782 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3783 (void (*)(void))cb);
3787 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3788 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3789 * If EVP_MD pointer is passed, initializes ctx with this md.
3790 * Returns the newly allocated ctx;
3793 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3795 ssl_clear_hash_ctx(hash);
3796 *hash = EVP_MD_CTX_new();
3797 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3798 EVP_MD_CTX_free(*hash);
3805 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3808 EVP_MD_CTX_free(*hash);
3812 /* Retrieve handshake hashes */
3813 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3816 EVP_MD_CTX *ctx = NULL;
3817 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3818 int hashleni = EVP_MD_CTX_size(hdgst);
3821 if (hashleni < 0 || (size_t)hashleni > outlen)
3824 ctx = EVP_MD_CTX_new();
3828 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3829 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3832 *hashlen = hashleni;
3836 EVP_MD_CTX_free(ctx);
3840 int SSL_session_reused(SSL *s)
3845 int SSL_is_server(SSL *s)
3850 #if OPENSSL_API_COMPAT < 0x10100000L
3851 void SSL_set_debug(SSL *s, int debug)
3853 /* Old function was do-nothing anyway... */
3859 void SSL_set_security_level(SSL *s, int level)
3861 s->cert->sec_level = level;
3864 int SSL_get_security_level(const SSL *s)
3866 return s->cert->sec_level;
3869 void SSL_set_security_callback(SSL *s,
3870 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3871 int op, int bits, int nid,
3872 void *other, void *ex))
3874 s->cert->sec_cb = cb;
3877 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
3878 const SSL_CTX *ctx, int op,
3879 int bits, int nid, void *other,
3881 return s->cert->sec_cb;
3884 void SSL_set0_security_ex_data(SSL *s, void *ex)
3886 s->cert->sec_ex = ex;
3889 void *SSL_get0_security_ex_data(const SSL *s)
3891 return s->cert->sec_ex;
3894 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
3896 ctx->cert->sec_level = level;
3899 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
3901 return ctx->cert->sec_level;
3904 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
3905 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3906 int op, int bits, int nid,
3907 void *other, void *ex))
3909 ctx->cert->sec_cb = cb;
3912 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
3918 return ctx->cert->sec_cb;
3921 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
3923 ctx->cert->sec_ex = ex;
3926 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
3928 return ctx->cert->sec_ex;
3932 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3933 * can return unsigned long, instead of the generic long return value from the
3934 * control interface.
3936 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
3938 return ctx->options;
3941 unsigned long SSL_get_options(const SSL *s)
3946 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
3948 return ctx->options |= op;
3951 unsigned long SSL_set_options(SSL *s, unsigned long op)
3953 return s->options |= op;
3956 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
3958 return ctx->options &= ~op;
3961 unsigned long SSL_clear_options(SSL *s, unsigned long op)
3963 return s->options &= ~op;
3966 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
3968 return s->verified_chain;
3971 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
3973 #ifndef OPENSSL_NO_CT
3976 * Moves SCTs from the |src| stack to the |dst| stack.
3977 * The source of each SCT will be set to |origin|.
3978 * If |dst| points to a NULL pointer, a new stack will be created and owned by
3980 * Returns the number of SCTs moved, or a negative integer if an error occurs.
3982 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
3983 sct_source_t origin)
3989 *dst = sk_SCT_new_null();
3991 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
3996 while ((sct = sk_SCT_pop(src)) != NULL) {
3997 if (SCT_set_source(sct, origin) != 1)
4000 if (sk_SCT_push(*dst, sct) <= 0)
4008 sk_SCT_push(src, sct); /* Put the SCT back */
4013 * Look for data collected during ServerHello and parse if found.
4014 * Returns the number of SCTs extracted.
4016 static int ct_extract_tls_extension_scts(SSL *s)
4018 int scts_extracted = 0;
4020 if (s->ext.scts != NULL) {
4021 const unsigned char *p = s->ext.scts;
4022 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4024 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4026 SCT_LIST_free(scts);
4029 return scts_extracted;
4033 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4034 * contains an SCT X509 extension. They will be stored in |s->scts|.
4036 * - The number of SCTs extracted, assuming an OCSP response exists.
4037 * - 0 if no OCSP response exists or it contains no SCTs.
4038 * - A negative integer if an error occurs.
4040 static int ct_extract_ocsp_response_scts(SSL *s)
4042 # ifndef OPENSSL_NO_OCSP
4043 int scts_extracted = 0;
4044 const unsigned char *p;
4045 OCSP_BASICRESP *br = NULL;
4046 OCSP_RESPONSE *rsp = NULL;
4047 STACK_OF(SCT) *scts = NULL;
4050 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4053 p = s->ext.ocsp.resp;
4054 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4058 br = OCSP_response_get1_basic(rsp);
4062 for (i = 0; i < OCSP_resp_count(br); ++i) {
4063 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4069 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4071 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4072 if (scts_extracted < 0)
4076 SCT_LIST_free(scts);
4077 OCSP_BASICRESP_free(br);
4078 OCSP_RESPONSE_free(rsp);
4079 return scts_extracted;
4081 /* Behave as if no OCSP response exists */
4087 * Attempts to extract SCTs from the peer certificate.
4088 * Return the number of SCTs extracted, or a negative integer if an error
4091 static int ct_extract_x509v3_extension_scts(SSL *s)
4093 int scts_extracted = 0;
4094 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4097 STACK_OF(SCT) *scts =
4098 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4101 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4103 SCT_LIST_free(scts);
4106 return scts_extracted;
4110 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4111 * response (if it exists) and X509v3 extensions in the certificate.
4112 * Returns NULL if an error occurs.
4114 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4116 if (!s->scts_parsed) {
4117 if (ct_extract_tls_extension_scts(s) < 0 ||
4118 ct_extract_ocsp_response_scts(s) < 0 ||
4119 ct_extract_x509v3_extension_scts(s) < 0)
4129 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4130 const STACK_OF(SCT) *scts, void *unused_arg)
4135 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4136 const STACK_OF(SCT) *scts, void *unused_arg)
4138 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4141 for (i = 0; i < count; ++i) {
4142 SCT *sct = sk_SCT_value(scts, i);
4143 int status = SCT_get_validation_status(sct);
4145 if (status == SCT_VALIDATION_STATUS_VALID)
4148 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4152 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4156 * Since code exists that uses the custom extension handler for CT, look
4157 * for this and throw an error if they have already registered to use CT.
4159 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4160 TLSEXT_TYPE_signed_certificate_timestamp))
4162 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4163 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4167 if (callback != NULL) {
4169 * If we are validating CT, then we MUST accept SCTs served via OCSP
4171 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4175 s->ct_validation_callback = callback;
4176 s->ct_validation_callback_arg = arg;
4181 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4182 ssl_ct_validation_cb callback, void *arg)
4185 * Since code exists that uses the custom extension handler for CT, look for
4186 * this and throw an error if they have already registered to use CT.
4188 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4189 TLSEXT_TYPE_signed_certificate_timestamp))
4191 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4192 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4196 ctx->ct_validation_callback = callback;
4197 ctx->ct_validation_callback_arg = arg;
4201 int SSL_ct_is_enabled(const SSL *s)
4203 return s->ct_validation_callback != NULL;
4206 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4208 return ctx->ct_validation_callback != NULL;
4211 int ssl_validate_ct(SSL *s)
4214 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4216 SSL_DANE *dane = &s->dane;
4217 CT_POLICY_EVAL_CTX *ctx = NULL;
4218 const STACK_OF(SCT) *scts;
4221 * If no callback is set, the peer is anonymous, or its chain is invalid,
4222 * skip SCT validation - just return success. Applications that continue
4223 * handshakes without certificates, with unverified chains, or pinned leaf
4224 * certificates are outside the scope of the WebPKI and CT.
4226 * The above exclusions notwithstanding the vast majority of peers will
4227 * have rather ordinary certificate chains validated by typical
4228 * applications that perform certificate verification and therefore will
4229 * process SCTs when enabled.
4231 if (s->ct_validation_callback == NULL || cert == NULL ||
4232 s->verify_result != X509_V_OK ||
4233 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4237 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4238 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4240 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4241 switch (dane->mtlsa->usage) {
4242 case DANETLS_USAGE_DANE_TA:
4243 case DANETLS_USAGE_DANE_EE:
4248 ctx = CT_POLICY_EVAL_CTX_new();
4250 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4254 issuer = sk_X509_value(s->verified_chain, 1);
4255 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4256 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4257 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4258 CT_POLICY_EVAL_CTX_set_time(ctx, SSL_SESSION_get_time(SSL_get0_session(s)));
4260 scts = SSL_get0_peer_scts(s);
4263 * This function returns success (> 0) only when all the SCTs are valid, 0
4264 * when some are invalid, and < 0 on various internal errors (out of
4265 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4266 * reason to abort the handshake, that decision is up to the callback.
4267 * Therefore, we error out only in the unexpected case that the return
4268 * value is negative.
4270 * XXX: One might well argue that the return value of this function is an
4271 * unfortunate design choice. Its job is only to determine the validation
4272 * status of each of the provided SCTs. So long as it correctly separates
4273 * the wheat from the chaff it should return success. Failure in this case
4274 * ought to correspond to an inability to carry out its duties.
4276 if (SCT_LIST_validate(scts, ctx) < 0) {
4277 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4281 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4283 ret = 0; /* This function returns 0 on failure */
4286 CT_POLICY_EVAL_CTX_free(ctx);
4288 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4289 * failure return code here. Also the application may wish the complete
4290 * the handshake, and then disconnect cleanly at a higher layer, after
4291 * checking the verification status of the completed connection.
4293 * We therefore force a certificate verification failure which will be
4294 * visible via SSL_get_verify_result() and cached as part of any resumed
4297 * Note: the permissive callback is for information gathering only, always
4298 * returns success, and does not affect verification status. Only the
4299 * strict callback or a custom application-specified callback can trigger
4300 * connection failure or record a verification error.
4303 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4307 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4309 switch (validation_mode) {
4311 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4313 case SSL_CT_VALIDATION_PERMISSIVE:
4314 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4315 case SSL_CT_VALIDATION_STRICT:
4316 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4320 int SSL_enable_ct(SSL *s, int validation_mode)
4322 switch (validation_mode) {
4324 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4326 case SSL_CT_VALIDATION_PERMISSIVE:
4327 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4328 case SSL_CT_VALIDATION_STRICT:
4329 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4333 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4335 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4338 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4340 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4343 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4345 CTLOG_STORE_free(ctx->ctlog_store);
4346 ctx->ctlog_store = logs;
4349 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4351 return ctx->ctlog_store;
4356 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4358 ctx->keylog_callback = cb;
4361 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4363 return ctx->keylog_callback;
4366 static int nss_keylog_int(const char *prefix,
4368 const uint8_t *parameter_1,
4369 size_t parameter_1_len,
4370 const uint8_t *parameter_2,
4371 size_t parameter_2_len)
4374 char *cursor = NULL;
4379 if (ssl->ctx->keylog_callback == NULL) return 1;
4382 * Our output buffer will contain the following strings, rendered with
4383 * space characters in between, terminated by a NULL character: first the
4384 * prefix, then the first parameter, then the second parameter. The
4385 * meaning of each parameter depends on the specific key material being
4386 * logged. Note that the first and second parameters are encoded in
4387 * hexadecimal, so we need a buffer that is twice their lengths.
4389 prefix_len = strlen(prefix);
4390 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4391 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4392 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4396 strcpy(cursor, prefix);
4397 cursor += prefix_len;
4400 for (i = 0; i < parameter_1_len; i++) {
4401 sprintf(cursor, "%02x", parameter_1[i]);
4406 for (i = 0; i < parameter_2_len; i++) {
4407 sprintf(cursor, "%02x", parameter_2[i]);
4412 ssl->ctx->keylog_callback(ssl, (const char *)out);
4418 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4419 const uint8_t *encrypted_premaster,
4420 size_t encrypted_premaster_len,
4421 const uint8_t *premaster,
4422 size_t premaster_len)
4424 if (encrypted_premaster_len < 8) {
4425 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4429 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4430 return nss_keylog_int("RSA",
4432 encrypted_premaster,
4438 int ssl_log_master_secret(SSL *ssl,
4439 const uint8_t *client_random,
4440 size_t client_random_len,
4441 const uint8_t *master,
4445 * TLSv1.3 changes the derivation of the master secret compared to earlier
4446 * TLS versions, meaning that logging it out is less useful. Instead we
4447 * want to log out other secrets: specifically, the handshake and
4448 * application traffic secrets. For this reason, if this function is called
4449 * for TLSv1.3 we don't bother logging, and just return success
4452 if (SSL_IS_TLS13(ssl)) return 1;
4454 if (client_random_len != 32) {
4455 SSLerr(SSL_F_SSL_LOG_MASTER_SECRET, ERR_R_INTERNAL_ERROR);
4459 return nss_keylog_int("CLIENT_RANDOM",