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->session_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->session_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)
1720 * TODO(TLS1.3): Return an error for now. Perhaps we should do a KeyUpdate
1721 * instead when we support that?
1723 if (SSL_IS_TLS13(s))
1726 if (s->renegotiate == 0)
1731 return (s->method->ssl_renegotiate(s));
1734 int SSL_renegotiate_abbreviated(SSL *s)
1737 * TODO(TLS1.3): Return an error for now. Perhaps we should do a KeyUpdate
1738 * instead when we support that?
1740 if (SSL_IS_TLS13(s))
1743 if (s->renegotiate == 0)
1748 return (s->method->ssl_renegotiate(s));
1751 int SSL_renegotiate_pending(SSL *s)
1754 * becomes true when negotiation is requested; false again once a
1755 * handshake has finished
1757 return (s->renegotiate != 0);
1760 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1765 case SSL_CTRL_GET_READ_AHEAD:
1766 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1767 case SSL_CTRL_SET_READ_AHEAD:
1768 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1769 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1772 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1773 s->msg_callback_arg = parg;
1777 return (s->mode |= larg);
1778 case SSL_CTRL_CLEAR_MODE:
1779 return (s->mode &= ~larg);
1780 case SSL_CTRL_GET_MAX_CERT_LIST:
1781 return (long)(s->max_cert_list);
1782 case SSL_CTRL_SET_MAX_CERT_LIST:
1785 l = (long)s->max_cert_list;
1786 s->max_cert_list = (size_t)larg;
1788 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1789 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1791 s->max_send_fragment = larg;
1792 if (s->max_send_fragment < s->split_send_fragment)
1793 s->split_send_fragment = s->max_send_fragment;
1795 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1796 if ((size_t)larg > s->max_send_fragment || larg == 0)
1798 s->split_send_fragment = larg;
1800 case SSL_CTRL_SET_MAX_PIPELINES:
1801 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1803 s->max_pipelines = larg;
1805 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1807 case SSL_CTRL_GET_RI_SUPPORT:
1809 return s->s3->send_connection_binding;
1812 case SSL_CTRL_CERT_FLAGS:
1813 return (s->cert->cert_flags |= larg);
1814 case SSL_CTRL_CLEAR_CERT_FLAGS:
1815 return (s->cert->cert_flags &= ~larg);
1817 case SSL_CTRL_GET_RAW_CIPHERLIST:
1819 if (s->s3->tmp.ciphers_raw == NULL)
1821 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
1822 return (int)s->s3->tmp.ciphers_rawlen;
1824 return TLS_CIPHER_LEN;
1826 case SSL_CTRL_GET_EXTMS_SUPPORT:
1827 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
1829 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
1833 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1834 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1835 &s->min_proto_version);
1836 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1837 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1838 &s->max_proto_version);
1840 return (s->method->ssl_ctrl(s, cmd, larg, parg));
1844 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1847 case SSL_CTRL_SET_MSG_CALLBACK:
1848 s->msg_callback = (void (*)
1849 (int write_p, int version, int content_type,
1850 const void *buf, size_t len, SSL *ssl,
1855 return (s->method->ssl_callback_ctrl(s, cmd, fp));
1859 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
1861 return ctx->sessions;
1864 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1867 /* For some cases with ctx == NULL perform syntax checks */
1870 #ifndef OPENSSL_NO_EC
1871 case SSL_CTRL_SET_GROUPS_LIST:
1872 return tls1_set_groups_list(NULL, NULL, parg);
1874 case SSL_CTRL_SET_SIGALGS_LIST:
1875 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
1876 return tls1_set_sigalgs_list(NULL, parg, 0);
1883 case SSL_CTRL_GET_READ_AHEAD:
1884 return (ctx->read_ahead);
1885 case SSL_CTRL_SET_READ_AHEAD:
1886 l = ctx->read_ahead;
1887 ctx->read_ahead = larg;
1890 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1891 ctx->msg_callback_arg = parg;
1894 case SSL_CTRL_GET_MAX_CERT_LIST:
1895 return (long)(ctx->max_cert_list);
1896 case SSL_CTRL_SET_MAX_CERT_LIST:
1899 l = (long)ctx->max_cert_list;
1900 ctx->max_cert_list = (size_t)larg;
1903 case SSL_CTRL_SET_SESS_CACHE_SIZE:
1906 l = (long)ctx->session_cache_size;
1907 ctx->session_cache_size = (size_t)larg;
1909 case SSL_CTRL_GET_SESS_CACHE_SIZE:
1910 return (long)(ctx->session_cache_size);
1911 case SSL_CTRL_SET_SESS_CACHE_MODE:
1912 l = ctx->session_cache_mode;
1913 ctx->session_cache_mode = larg;
1915 case SSL_CTRL_GET_SESS_CACHE_MODE:
1916 return (ctx->session_cache_mode);
1918 case SSL_CTRL_SESS_NUMBER:
1919 return (lh_SSL_SESSION_num_items(ctx->sessions));
1920 case SSL_CTRL_SESS_CONNECT:
1921 return (ctx->stats.sess_connect);
1922 case SSL_CTRL_SESS_CONNECT_GOOD:
1923 return (ctx->stats.sess_connect_good);
1924 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
1925 return (ctx->stats.sess_connect_renegotiate);
1926 case SSL_CTRL_SESS_ACCEPT:
1927 return (ctx->stats.sess_accept);
1928 case SSL_CTRL_SESS_ACCEPT_GOOD:
1929 return (ctx->stats.sess_accept_good);
1930 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
1931 return (ctx->stats.sess_accept_renegotiate);
1932 case SSL_CTRL_SESS_HIT:
1933 return (ctx->stats.sess_hit);
1934 case SSL_CTRL_SESS_CB_HIT:
1935 return (ctx->stats.sess_cb_hit);
1936 case SSL_CTRL_SESS_MISSES:
1937 return (ctx->stats.sess_miss);
1938 case SSL_CTRL_SESS_TIMEOUTS:
1939 return (ctx->stats.sess_timeout);
1940 case SSL_CTRL_SESS_CACHE_FULL:
1941 return (ctx->stats.sess_cache_full);
1943 return (ctx->mode |= larg);
1944 case SSL_CTRL_CLEAR_MODE:
1945 return (ctx->mode &= ~larg);
1946 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1947 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1949 ctx->max_send_fragment = larg;
1950 if (ctx->max_send_fragment < ctx->split_send_fragment)
1951 ctx->split_send_fragment = ctx->max_send_fragment;
1953 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1954 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
1956 ctx->split_send_fragment = larg;
1958 case SSL_CTRL_SET_MAX_PIPELINES:
1959 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1961 ctx->max_pipelines = larg;
1963 case SSL_CTRL_CERT_FLAGS:
1964 return (ctx->cert->cert_flags |= larg);
1965 case SSL_CTRL_CLEAR_CERT_FLAGS:
1966 return (ctx->cert->cert_flags &= ~larg);
1967 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1968 return ssl_set_version_bound(ctx->method->version, (int)larg,
1969 &ctx->min_proto_version);
1970 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1971 return ssl_set_version_bound(ctx->method->version, (int)larg,
1972 &ctx->max_proto_version);
1974 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
1978 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
1981 case SSL_CTRL_SET_MSG_CALLBACK:
1982 ctx->msg_callback = (void (*)
1983 (int write_p, int version, int content_type,
1984 const void *buf, size_t len, SSL *ssl,
1989 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
1993 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2002 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2003 const SSL_CIPHER *const *bp)
2005 if ((*ap)->id > (*bp)->id)
2007 if ((*ap)->id < (*bp)->id)
2012 /** return a STACK of the ciphers available for the SSL and in order of
2014 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2017 if (s->cipher_list != NULL) {
2018 return (s->cipher_list);
2019 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2020 return (s->ctx->cipher_list);
2026 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2028 if ((s == NULL) || (s->session == NULL) || !s->server)
2030 return s->session->ciphers;
2033 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2035 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2037 ciphers = SSL_get_ciphers(s);
2040 ssl_set_client_disabled(s);
2041 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2042 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2043 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
2045 sk = sk_SSL_CIPHER_new_null();
2048 if (!sk_SSL_CIPHER_push(sk, c)) {
2049 sk_SSL_CIPHER_free(sk);
2057 /** return a STACK of the ciphers available for the SSL and in order of
2059 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2062 if (s->cipher_list_by_id != NULL) {
2063 return (s->cipher_list_by_id);
2064 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2065 return (s->ctx->cipher_list_by_id);
2071 /** The old interface to get the same thing as SSL_get_ciphers() */
2072 const char *SSL_get_cipher_list(const SSL *s, int n)
2074 const SSL_CIPHER *c;
2075 STACK_OF(SSL_CIPHER) *sk;
2079 sk = SSL_get_ciphers(s);
2080 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2082 c = sk_SSL_CIPHER_value(sk, n);
2088 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2090 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2093 return ctx->cipher_list;
2097 /** specify the ciphers to be used by default by the SSL_CTX */
2098 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2100 STACK_OF(SSL_CIPHER) *sk;
2102 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2103 &ctx->cipher_list_by_id, str, ctx->cert);
2105 * ssl_create_cipher_list may return an empty stack if it was unable to
2106 * find a cipher matching the given rule string (for example if the rule
2107 * string specifies a cipher which has been disabled). This is not an
2108 * error as far as ssl_create_cipher_list is concerned, and hence
2109 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2113 else if (sk_SSL_CIPHER_num(sk) == 0) {
2114 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2120 /** specify the ciphers to be used by the SSL */
2121 int SSL_set_cipher_list(SSL *s, const char *str)
2123 STACK_OF(SSL_CIPHER) *sk;
2125 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2126 &s->cipher_list_by_id, str, s->cert);
2127 /* see comment in SSL_CTX_set_cipher_list */
2130 else if (sk_SSL_CIPHER_num(sk) == 0) {
2131 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2137 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2140 STACK_OF(SSL_CIPHER) *sk;
2141 const SSL_CIPHER *c;
2144 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2148 sk = s->session->ciphers;
2150 if (sk_SSL_CIPHER_num(sk) == 0)
2153 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2156 c = sk_SSL_CIPHER_value(sk, i);
2157 n = strlen(c->name);
2164 memcpy(p, c->name, n + 1);
2173 /** return a servername extension value if provided in Client Hello, or NULL.
2174 * So far, only host_name types are defined (RFC 3546).
2177 const char *SSL_get_servername(const SSL *s, const int type)
2179 if (type != TLSEXT_NAMETYPE_host_name)
2182 return s->session && !s->ext.hostname ?
2183 s->session->ext.hostname : s->ext.hostname;
2186 int SSL_get_servername_type(const SSL *s)
2189 && (!s->ext.hostname ? s->session->
2190 ext.hostname : s->ext.hostname))
2191 return TLSEXT_NAMETYPE_host_name;
2196 * SSL_select_next_proto implements the standard protocol selection. It is
2197 * expected that this function is called from the callback set by
2198 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2199 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2200 * not included in the length. A byte string of length 0 is invalid. No byte
2201 * string may be truncated. The current, but experimental algorithm for
2202 * selecting the protocol is: 1) If the server doesn't support NPN then this
2203 * is indicated to the callback. In this case, the client application has to
2204 * abort the connection or have a default application level protocol. 2) If
2205 * the server supports NPN, but advertises an empty list then the client
2206 * selects the first protocol in its list, but indicates via the API that this
2207 * fallback case was enacted. 3) Otherwise, the client finds the first
2208 * protocol in the server's list that it supports and selects this protocol.
2209 * This is because it's assumed that the server has better information about
2210 * which protocol a client should use. 4) If the client doesn't support any
2211 * of the server's advertised protocols, then this is treated the same as
2212 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2213 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2215 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2216 const unsigned char *server,
2217 unsigned int server_len,
2218 const unsigned char *client, unsigned int client_len)
2221 const unsigned char *result;
2222 int status = OPENSSL_NPN_UNSUPPORTED;
2225 * For each protocol in server preference order, see if we support it.
2227 for (i = 0; i < server_len;) {
2228 for (j = 0; j < client_len;) {
2229 if (server[i] == client[j] &&
2230 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2231 /* We found a match */
2232 result = &server[i];
2233 status = OPENSSL_NPN_NEGOTIATED;
2243 /* There's no overlap between our protocols and the server's list. */
2245 status = OPENSSL_NPN_NO_OVERLAP;
2248 *out = (unsigned char *)result + 1;
2249 *outlen = result[0];
2253 #ifndef OPENSSL_NO_NEXTPROTONEG
2255 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2256 * client's requested protocol for this connection and returns 0. If the
2257 * client didn't request any protocol, then *data is set to NULL. Note that
2258 * the client can request any protocol it chooses. The value returned from
2259 * this function need not be a member of the list of supported protocols
2260 * provided by the callback.
2262 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2269 *len = (unsigned int)s->ext.npn_len;
2274 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2275 * a TLS server needs a list of supported protocols for Next Protocol
2276 * Negotiation. The returned list must be in wire format. The list is
2277 * returned by setting |out| to point to it and |outlen| to its length. This
2278 * memory will not be modified, but one should assume that the SSL* keeps a
2279 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2280 * wishes to advertise. Otherwise, no such extension will be included in the
2283 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2284 SSL_CTX_npn_advertised_cb_func cb,
2287 ctx->ext.npn_advertised_cb = cb;
2288 ctx->ext.npn_advertised_cb_arg = arg;
2292 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2293 * client needs to select a protocol from the server's provided list. |out|
2294 * must be set to point to the selected protocol (which may be within |in|).
2295 * The length of the protocol name must be written into |outlen|. The
2296 * server's advertised protocols are provided in |in| and |inlen|. The
2297 * callback can assume that |in| is syntactically valid. The client must
2298 * select a protocol. It is fatal to the connection if this callback returns
2299 * a value other than SSL_TLSEXT_ERR_OK.
2301 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2302 SSL_CTX_npn_select_cb_func cb,
2305 ctx->ext.npn_select_cb = cb;
2306 ctx->ext.npn_select_cb_arg = arg;
2311 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2312 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2313 * length-prefixed strings). Returns 0 on success.
2315 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2316 unsigned int protos_len)
2318 OPENSSL_free(ctx->ext.alpn);
2319 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2320 if (ctx->ext.alpn == NULL) {
2321 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2324 ctx->ext.alpn_len = protos_len;
2330 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2331 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2332 * length-prefixed strings). Returns 0 on success.
2334 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2335 unsigned int protos_len)
2337 OPENSSL_free(ssl->ext.alpn);
2338 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2339 if (ssl->ext.alpn == NULL) {
2340 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2343 ssl->ext.alpn_len = protos_len;
2349 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2350 * called during ClientHello processing in order to select an ALPN protocol
2351 * from the client's list of offered protocols.
2353 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2354 SSL_CTX_alpn_select_cb_func cb,
2357 ctx->ext.alpn_select_cb = cb;
2358 ctx->ext.alpn_select_cb_arg = arg;
2362 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2363 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2364 * (not including the leading length-prefix byte). If the server didn't
2365 * respond with a negotiated protocol then |*len| will be zero.
2367 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2372 *data = ssl->s3->alpn_selected;
2376 *len = (unsigned int)ssl->s3->alpn_selected_len;
2379 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2380 const char *label, size_t llen,
2381 const unsigned char *p, size_t plen,
2384 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2387 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2392 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2397 ((unsigned int)a->session_id[0]) |
2398 ((unsigned int)a->session_id[1] << 8L) |
2399 ((unsigned long)a->session_id[2] << 16L) |
2400 ((unsigned long)a->session_id[3] << 24L);
2405 * NB: If this function (or indeed the hash function which uses a sort of
2406 * coarser function than this one) is changed, ensure
2407 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2408 * being able to construct an SSL_SESSION that will collide with any existing
2409 * session with a matching session ID.
2411 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2413 if (a->ssl_version != b->ssl_version)
2415 if (a->session_id_length != b->session_id_length)
2417 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2421 * These wrapper functions should remain rather than redeclaring
2422 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2423 * variable. The reason is that the functions aren't static, they're exposed
2427 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2429 SSL_CTX *ret = NULL;
2432 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2436 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2439 if (FIPS_mode() && (meth->version < TLS1_VERSION)) {
2440 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE);
2444 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2445 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2448 ret = OPENSSL_zalloc(sizeof(*ret));
2453 ret->min_proto_version = 0;
2454 ret->max_proto_version = 0;
2455 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2456 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2457 /* We take the system default. */
2458 ret->session_timeout = meth->get_timeout();
2459 ret->references = 1;
2460 ret->lock = CRYPTO_THREAD_lock_new();
2461 if (ret->lock == NULL) {
2462 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2466 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2467 ret->verify_mode = SSL_VERIFY_NONE;
2468 if ((ret->cert = ssl_cert_new()) == NULL)
2471 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2472 if (ret->sessions == NULL)
2474 ret->cert_store = X509_STORE_new();
2475 if (ret->cert_store == NULL)
2477 #ifndef OPENSSL_NO_CT
2478 ret->ctlog_store = CTLOG_STORE_new();
2479 if (ret->ctlog_store == NULL)
2482 if (!ssl_create_cipher_list(ret->method,
2483 &ret->cipher_list, &ret->cipher_list_by_id,
2484 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2485 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2486 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2490 ret->param = X509_VERIFY_PARAM_new();
2491 if (ret->param == NULL)
2494 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2495 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2498 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2499 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2503 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2506 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2509 /* No compression for DTLS */
2510 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2511 ret->comp_methods = SSL_COMP_get_compression_methods();
2513 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2514 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2516 /* Setup RFC5077 ticket keys */
2517 if ((RAND_bytes(ret->ext.tick_key_name,
2518 sizeof(ret->ext.tick_key_name)) <= 0)
2519 || (RAND_bytes(ret->ext.tick_hmac_key,
2520 sizeof(ret->ext.tick_hmac_key)) <= 0)
2521 || (RAND_bytes(ret->ext.tick_aes_key,
2522 sizeof(ret->ext.tick_aes_key)) <= 0))
2523 ret->options |= SSL_OP_NO_TICKET;
2525 #ifndef OPENSSL_NO_SRP
2526 if (!SSL_CTX_SRP_CTX_init(ret))
2529 #ifndef OPENSSL_NO_ENGINE
2530 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2531 # define eng_strx(x) #x
2532 # define eng_str(x) eng_strx(x)
2533 /* Use specific client engine automatically... ignore errors */
2536 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2539 ENGINE_load_builtin_engines();
2540 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2542 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2548 * Default is to connect to non-RI servers. When RI is more widely
2549 * deployed might change this.
2551 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2553 * Disable compression by default to prevent CRIME. Applications can
2554 * re-enable compression by configuring
2555 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2556 * or by using the SSL_CONF library.
2558 ret->options |= SSL_OP_NO_COMPRESSION;
2560 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2564 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2570 int SSL_CTX_up_ref(SSL_CTX *ctx)
2574 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2577 REF_PRINT_COUNT("SSL_CTX", ctx);
2578 REF_ASSERT_ISNT(i < 2);
2579 return ((i > 1) ? 1 : 0);
2582 void SSL_CTX_free(SSL_CTX *a)
2589 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2590 REF_PRINT_COUNT("SSL_CTX", a);
2593 REF_ASSERT_ISNT(i < 0);
2595 X509_VERIFY_PARAM_free(a->param);
2596 dane_ctx_final(&a->dane);
2599 * Free internal session cache. However: the remove_cb() may reference
2600 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2601 * after the sessions were flushed.
2602 * As the ex_data handling routines might also touch the session cache,
2603 * the most secure solution seems to be: empty (flush) the cache, then
2604 * free ex_data, then finally free the cache.
2605 * (See ticket [openssl.org #212].)
2607 if (a->sessions != NULL)
2608 SSL_CTX_flush_sessions(a, 0);
2610 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2611 lh_SSL_SESSION_free(a->sessions);
2612 X509_STORE_free(a->cert_store);
2613 #ifndef OPENSSL_NO_CT
2614 CTLOG_STORE_free(a->ctlog_store);
2616 sk_SSL_CIPHER_free(a->cipher_list);
2617 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2618 ssl_cert_free(a->cert);
2619 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2620 sk_X509_pop_free(a->extra_certs, X509_free);
2621 a->comp_methods = NULL;
2622 #ifndef OPENSSL_NO_SRTP
2623 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2625 #ifndef OPENSSL_NO_SRP
2626 SSL_CTX_SRP_CTX_free(a);
2628 #ifndef OPENSSL_NO_ENGINE
2629 ENGINE_finish(a->client_cert_engine);
2632 #ifndef OPENSSL_NO_EC
2633 OPENSSL_free(a->ext.ecpointformats);
2634 OPENSSL_free(a->ext.supportedgroups);
2636 OPENSSL_free(a->ext.alpn);
2638 CRYPTO_THREAD_lock_free(a->lock);
2643 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2645 ctx->default_passwd_callback = cb;
2648 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2650 ctx->default_passwd_callback_userdata = u;
2653 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2655 return ctx->default_passwd_callback;
2658 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2660 return ctx->default_passwd_callback_userdata;
2663 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2665 s->default_passwd_callback = cb;
2668 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2670 s->default_passwd_callback_userdata = u;
2673 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2675 return s->default_passwd_callback;
2678 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2680 return s->default_passwd_callback_userdata;
2683 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2684 int (*cb) (X509_STORE_CTX *, void *),
2687 ctx->app_verify_callback = cb;
2688 ctx->app_verify_arg = arg;
2691 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2692 int (*cb) (int, X509_STORE_CTX *))
2694 ctx->verify_mode = mode;
2695 ctx->default_verify_callback = cb;
2698 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2700 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2703 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2705 ssl_cert_set_cert_cb(c->cert, cb, arg);
2708 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2710 ssl_cert_set_cert_cb(s->cert, cb, arg);
2713 void ssl_set_masks(SSL *s)
2715 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_GOST)
2719 uint32_t *pvalid = s->s3->tmp.valid_flags;
2720 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2721 unsigned long mask_k, mask_a;
2722 #ifndef OPENSSL_NO_EC
2723 int have_ecc_cert, ecdsa_ok;
2729 #ifndef OPENSSL_NO_DH
2730 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2735 rsa_enc = pvalid[SSL_PKEY_RSA_ENC] & CERT_PKEY_VALID;
2736 rsa_sign = pvalid[SSL_PKEY_RSA_SIGN] & CERT_PKEY_SIGN;
2737 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_SIGN;
2738 #ifndef OPENSSL_NO_EC
2739 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2745 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2746 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2749 #ifndef OPENSSL_NO_GOST
2750 cpk = &(c->pkeys[SSL_PKEY_GOST12_512]);
2751 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2752 mask_k |= SSL_kGOST;
2753 mask_a |= SSL_aGOST12;
2755 cpk = &(c->pkeys[SSL_PKEY_GOST12_256]);
2756 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2757 mask_k |= SSL_kGOST;
2758 mask_a |= SSL_aGOST12;
2760 cpk = &(c->pkeys[SSL_PKEY_GOST01]);
2761 if (cpk->x509 != NULL && cpk->privatekey != NULL) {
2762 mask_k |= SSL_kGOST;
2763 mask_a |= SSL_aGOST01;
2773 if (rsa_enc || rsa_sign) {
2781 mask_a |= SSL_aNULL;
2784 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2785 * depending on the key usage extension.
2787 #ifndef OPENSSL_NO_EC
2788 if (have_ecc_cert) {
2790 cpk = &c->pkeys[SSL_PKEY_ECC];
2792 ex_kusage = X509_get_key_usage(x);
2793 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2794 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2797 mask_a |= SSL_aECDSA;
2801 #ifndef OPENSSL_NO_EC
2802 mask_k |= SSL_kECDHE;
2805 #ifndef OPENSSL_NO_PSK
2808 if (mask_k & SSL_kRSA)
2809 mask_k |= SSL_kRSAPSK;
2810 if (mask_k & SSL_kDHE)
2811 mask_k |= SSL_kDHEPSK;
2812 if (mask_k & SSL_kECDHE)
2813 mask_k |= SSL_kECDHEPSK;
2816 s->s3->tmp.mask_k = mask_k;
2817 s->s3->tmp.mask_a = mask_a;
2820 #ifndef OPENSSL_NO_EC
2822 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
2824 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
2825 /* key usage, if present, must allow signing */
2826 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
2827 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
2828 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
2832 return 1; /* all checks are ok */
2837 static int ssl_get_server_cert_index(const SSL *s)
2841 if (SSL_IS_TLS13(s)) {
2842 if (s->s3->tmp.sigalg == NULL) {
2843 SSLerr(SSL_F_SSL_GET_SERVER_CERT_INDEX, ERR_R_INTERNAL_ERROR);
2846 return s->s3->tmp.cert_idx;
2849 idx = ssl_cipher_get_cert_index(s->s3->tmp.new_cipher);
2850 if (idx == SSL_PKEY_RSA_ENC && !s->cert->pkeys[SSL_PKEY_RSA_ENC].x509)
2851 idx = SSL_PKEY_RSA_SIGN;
2852 if (idx == SSL_PKEY_GOST_EC) {
2853 if (s->cert->pkeys[SSL_PKEY_GOST12_512].x509)
2854 idx = SSL_PKEY_GOST12_512;
2855 else if (s->cert->pkeys[SSL_PKEY_GOST12_256].x509)
2856 idx = SSL_PKEY_GOST12_256;
2857 else if (s->cert->pkeys[SSL_PKEY_GOST01].x509)
2858 idx = SSL_PKEY_GOST01;
2863 SSLerr(SSL_F_SSL_GET_SERVER_CERT_INDEX, ERR_R_INTERNAL_ERROR);
2867 CERT_PKEY *ssl_get_server_send_pkey(SSL *s)
2873 if (!s->s3 || !s->s3->tmp.new_cipher)
2877 i = ssl_get_server_cert_index(s);
2879 /* This may or may not be an error. */
2884 return &c->pkeys[i];
2887 EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *cipher,
2890 unsigned long alg_a;
2894 alg_a = cipher->algorithm_auth;
2897 if ((alg_a & SSL_aDSS) && (c->pkeys[SSL_PKEY_DSA_SIGN].privatekey != NULL))
2898 idx = SSL_PKEY_DSA_SIGN;
2899 else if (alg_a & SSL_aRSA) {
2900 if (c->pkeys[SSL_PKEY_RSA_SIGN].privatekey != NULL)
2901 idx = SSL_PKEY_RSA_SIGN;
2902 else if (c->pkeys[SSL_PKEY_RSA_ENC].privatekey != NULL)
2903 idx = SSL_PKEY_RSA_ENC;
2904 } else if ((alg_a & SSL_aECDSA) &&
2905 (c->pkeys[SSL_PKEY_ECC].privatekey != NULL))
2908 SSLerr(SSL_F_SSL_GET_SIGN_PKEY, ERR_R_INTERNAL_ERROR);
2912 *pmd = s->s3->tmp.md[idx];
2913 return c->pkeys[idx].privatekey;
2916 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
2917 size_t *serverinfo_length)
2921 *serverinfo_length = 0;
2924 i = ssl_get_server_cert_index(s);
2928 if (c->pkeys[i].serverinfo == NULL)
2931 *serverinfo = c->pkeys[i].serverinfo;
2932 *serverinfo_length = c->pkeys[i].serverinfo_length;
2936 void ssl_update_cache(SSL *s, int mode)
2941 * If the session_id_length is 0, we are not supposed to cache it, and it
2942 * would be rather hard to do anyway :-)
2944 if (s->session->session_id_length == 0)
2947 i = s->session_ctx->session_cache_mode;
2948 if ((i & mode) && (!s->hit)
2949 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
2950 || SSL_CTX_add_session(s->session_ctx, s->session))
2951 && (s->session_ctx->new_session_cb != NULL)) {
2952 SSL_SESSION_up_ref(s->session);
2953 if (!s->session_ctx->new_session_cb(s, s->session))
2954 SSL_SESSION_free(s->session);
2957 /* auto flush every 255 connections */
2958 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
2959 if ((((mode & SSL_SESS_CACHE_CLIENT)
2960 ? s->session_ctx->stats.sess_connect_good
2961 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
2962 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
2967 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
2972 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
2977 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
2981 if (s->method != meth) {
2982 const SSL_METHOD *sm = s->method;
2983 int (*hf) (SSL *) = s->handshake_func;
2985 if (sm->version == meth->version)
2990 ret = s->method->ssl_new(s);
2993 if (hf == sm->ssl_connect)
2994 s->handshake_func = meth->ssl_connect;
2995 else if (hf == sm->ssl_accept)
2996 s->handshake_func = meth->ssl_accept;
3001 int SSL_get_error(const SSL *s, int i)
3008 return (SSL_ERROR_NONE);
3011 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3012 * where we do encode the error
3014 if ((l = ERR_peek_error()) != 0) {
3015 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3016 return (SSL_ERROR_SYSCALL);
3018 return (SSL_ERROR_SSL);
3021 if (SSL_want_read(s)) {
3022 bio = SSL_get_rbio(s);
3023 if (BIO_should_read(bio))
3024 return (SSL_ERROR_WANT_READ);
3025 else if (BIO_should_write(bio))
3027 * This one doesn't make too much sense ... We never try to write
3028 * to the rbio, and an application program where rbio and wbio
3029 * are separate couldn't even know what it should wait for.
3030 * However if we ever set s->rwstate incorrectly (so that we have
3031 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3032 * wbio *are* the same, this test works around that bug; so it
3033 * might be safer to keep it.
3035 return (SSL_ERROR_WANT_WRITE);
3036 else if (BIO_should_io_special(bio)) {
3037 reason = BIO_get_retry_reason(bio);
3038 if (reason == BIO_RR_CONNECT)
3039 return (SSL_ERROR_WANT_CONNECT);
3040 else if (reason == BIO_RR_ACCEPT)
3041 return (SSL_ERROR_WANT_ACCEPT);
3043 return (SSL_ERROR_SYSCALL); /* unknown */
3047 if (SSL_want_write(s)) {
3049 * Access wbio directly - in order to use the buffered bio if
3053 if (BIO_should_write(bio))
3054 return (SSL_ERROR_WANT_WRITE);
3055 else if (BIO_should_read(bio))
3057 * See above (SSL_want_read(s) with BIO_should_write(bio))
3059 return (SSL_ERROR_WANT_READ);
3060 else if (BIO_should_io_special(bio)) {
3061 reason = BIO_get_retry_reason(bio);
3062 if (reason == BIO_RR_CONNECT)
3063 return (SSL_ERROR_WANT_CONNECT);
3064 else if (reason == BIO_RR_ACCEPT)
3065 return (SSL_ERROR_WANT_ACCEPT);
3067 return (SSL_ERROR_SYSCALL);
3070 if (SSL_want_x509_lookup(s)) {
3071 return (SSL_ERROR_WANT_X509_LOOKUP);
3073 if (SSL_want_async(s)) {
3074 return SSL_ERROR_WANT_ASYNC;
3076 if (SSL_want_async_job(s)) {
3077 return SSL_ERROR_WANT_ASYNC_JOB;
3080 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3081 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3082 return (SSL_ERROR_ZERO_RETURN);
3084 return (SSL_ERROR_SYSCALL);
3087 static int ssl_do_handshake_intern(void *vargs)
3089 struct ssl_async_args *args;
3092 args = (struct ssl_async_args *)vargs;
3095 return s->handshake_func(s);
3098 int SSL_do_handshake(SSL *s)
3102 if (s->handshake_func == NULL) {
3103 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3107 s->method->ssl_renegotiate_check(s, 0);
3109 if (SSL_in_init(s) || SSL_in_before(s)) {
3110 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3111 struct ssl_async_args args;
3115 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3117 ret = s->handshake_func(s);
3123 void SSL_set_accept_state(SSL *s)
3127 ossl_statem_clear(s);
3128 s->handshake_func = s->method->ssl_accept;
3132 void SSL_set_connect_state(SSL *s)
3136 ossl_statem_clear(s);
3137 s->handshake_func = s->method->ssl_connect;
3141 int ssl_undefined_function(SSL *s)
3143 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3147 int ssl_undefined_void_function(void)
3149 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3150 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3154 int ssl_undefined_const_function(const SSL *s)
3159 const SSL_METHOD *ssl_bad_method(int ver)
3161 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3165 const char *ssl_protocol_to_string(int version)
3169 case TLS1_3_VERSION:
3172 case TLS1_2_VERSION:
3175 case TLS1_1_VERSION:
3190 case DTLS1_2_VERSION:
3198 const char *SSL_get_version(const SSL *s)
3200 return ssl_protocol_to_string(s->version);
3203 SSL *SSL_dup(SSL *s)
3205 STACK_OF(X509_NAME) *sk;
3210 /* If we're not quiescent, just up_ref! */
3211 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3212 CRYPTO_UP_REF(&s->references, &i, s->lock);
3217 * Otherwise, copy configuration state, and session if set.
3219 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3222 if (s->session != NULL) {
3224 * Arranges to share the same session via up_ref. This "copies"
3225 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3227 if (!SSL_copy_session_id(ret, s))
3231 * No session has been established yet, so we have to expect that
3232 * s->cert or ret->cert will be changed later -- they should not both
3233 * point to the same object, and thus we can't use
3234 * SSL_copy_session_id.
3236 if (!SSL_set_ssl_method(ret, s->method))
3239 if (s->cert != NULL) {
3240 ssl_cert_free(ret->cert);
3241 ret->cert = ssl_cert_dup(s->cert);
3242 if (ret->cert == NULL)
3246 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3247 (int)s->sid_ctx_length))
3251 if (!ssl_dane_dup(ret, s))
3253 ret->version = s->version;
3254 ret->options = s->options;
3255 ret->mode = s->mode;
3256 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3257 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3258 ret->msg_callback = s->msg_callback;
3259 ret->msg_callback_arg = s->msg_callback_arg;
3260 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3261 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3262 ret->generate_session_id = s->generate_session_id;
3264 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3266 /* copy app data, a little dangerous perhaps */
3267 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3270 /* setup rbio, and wbio */
3271 if (s->rbio != NULL) {
3272 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3275 if (s->wbio != NULL) {
3276 if (s->wbio != s->rbio) {
3277 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3280 BIO_up_ref(ret->rbio);
3281 ret->wbio = ret->rbio;
3285 ret->server = s->server;
3286 if (s->handshake_func) {
3288 SSL_set_accept_state(ret);
3290 SSL_set_connect_state(ret);
3292 ret->shutdown = s->shutdown;
3295 ret->default_passwd_callback = s->default_passwd_callback;
3296 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3298 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3300 /* dup the cipher_list and cipher_list_by_id stacks */
3301 if (s->cipher_list != NULL) {
3302 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3305 if (s->cipher_list_by_id != NULL)
3306 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3310 /* Dup the client_CA list */
3311 if (s->client_CA != NULL) {
3312 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3314 ret->client_CA = sk;
3315 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3316 xn = sk_X509_NAME_value(sk, i);
3317 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3330 void ssl_clear_cipher_ctx(SSL *s)
3332 if (s->enc_read_ctx != NULL) {
3333 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3334 s->enc_read_ctx = NULL;
3336 if (s->enc_write_ctx != NULL) {
3337 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3338 s->enc_write_ctx = NULL;
3340 #ifndef OPENSSL_NO_COMP
3341 COMP_CTX_free(s->expand);
3343 COMP_CTX_free(s->compress);
3348 X509 *SSL_get_certificate(const SSL *s)
3350 if (s->cert != NULL)
3351 return (s->cert->key->x509);
3356 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3358 if (s->cert != NULL)
3359 return (s->cert->key->privatekey);
3364 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3366 if (ctx->cert != NULL)
3367 return ctx->cert->key->x509;
3372 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3374 if (ctx->cert != NULL)
3375 return ctx->cert->key->privatekey;
3380 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3382 if ((s->session != NULL) && (s->session->cipher != NULL))
3383 return (s->session->cipher);
3387 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3389 #ifndef OPENSSL_NO_COMP
3390 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3396 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3398 #ifndef OPENSSL_NO_COMP
3399 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3405 int ssl_init_wbio_buffer(SSL *s)
3409 if (s->bbio != NULL) {
3410 /* Already buffered. */
3414 bbio = BIO_new(BIO_f_buffer());
3415 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3417 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3421 s->wbio = BIO_push(bbio, s->wbio);
3426 void ssl_free_wbio_buffer(SSL *s)
3428 /* callers ensure s is never null */
3429 if (s->bbio == NULL)
3432 s->wbio = BIO_pop(s->wbio);
3433 assert(s->wbio != NULL);
3438 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3440 ctx->quiet_shutdown = mode;
3443 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3445 return (ctx->quiet_shutdown);
3448 void SSL_set_quiet_shutdown(SSL *s, int mode)
3450 s->quiet_shutdown = mode;
3453 int SSL_get_quiet_shutdown(const SSL *s)
3455 return (s->quiet_shutdown);
3458 void SSL_set_shutdown(SSL *s, int mode)
3463 int SSL_get_shutdown(const SSL *s)
3468 int SSL_version(const SSL *s)
3473 int SSL_client_version(const SSL *s)
3475 return s->client_version;
3478 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3483 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3486 if (ssl->ctx == ctx)
3489 ctx = ssl->session_ctx;
3490 new_cert = ssl_cert_dup(ctx->cert);
3491 if (new_cert == NULL) {
3494 ssl_cert_free(ssl->cert);
3495 ssl->cert = new_cert;
3498 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3499 * so setter APIs must prevent invalid lengths from entering the system.
3501 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3504 * If the session ID context matches that of the parent SSL_CTX,
3505 * inherit it from the new SSL_CTX as well. If however the context does
3506 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3507 * leave it unchanged.
3509 if ((ssl->ctx != NULL) &&
3510 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3511 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3512 ssl->sid_ctx_length = ctx->sid_ctx_length;
3513 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3516 SSL_CTX_up_ref(ctx);
3517 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3523 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3525 return (X509_STORE_set_default_paths(ctx->cert_store));
3528 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3530 X509_LOOKUP *lookup;
3532 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3535 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3537 /* Clear any errors if the default directory does not exist */
3543 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3545 X509_LOOKUP *lookup;
3547 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3551 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3553 /* Clear any errors if the default file does not exist */
3559 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3562 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3565 void SSL_set_info_callback(SSL *ssl,
3566 void (*cb) (const SSL *ssl, int type, int val))
3568 ssl->info_callback = cb;
3572 * One compiler (Diab DCC) doesn't like argument names in returned function
3575 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3578 return ssl->info_callback;
3581 void SSL_set_verify_result(SSL *ssl, long arg)
3583 ssl->verify_result = arg;
3586 long SSL_get_verify_result(const SSL *ssl)
3588 return (ssl->verify_result);
3591 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3594 return sizeof(ssl->s3->client_random);
3595 if (outlen > sizeof(ssl->s3->client_random))
3596 outlen = sizeof(ssl->s3->client_random);
3597 memcpy(out, ssl->s3->client_random, outlen);
3601 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3604 return sizeof(ssl->s3->server_random);
3605 if (outlen > sizeof(ssl->s3->server_random))
3606 outlen = sizeof(ssl->s3->server_random);
3607 memcpy(out, ssl->s3->server_random, outlen);
3611 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3612 unsigned char *out, size_t outlen)
3615 return session->master_key_length;
3616 if (outlen > session->master_key_length)
3617 outlen = session->master_key_length;
3618 memcpy(out, session->master_key, outlen);
3622 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3624 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3627 void *SSL_get_ex_data(const SSL *s, int idx)
3629 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3632 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3634 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3637 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3639 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3647 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3649 return (ctx->cert_store);
3652 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3654 X509_STORE_free(ctx->cert_store);
3655 ctx->cert_store = store;
3658 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3661 X509_STORE_up_ref(store);
3662 SSL_CTX_set_cert_store(ctx, store);
3665 int SSL_want(const SSL *s)
3667 return (s->rwstate);
3671 * \brief Set the callback for generating temporary DH keys.
3672 * \param ctx the SSL context.
3673 * \param dh the callback
3676 #ifndef OPENSSL_NO_DH
3677 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3678 DH *(*dh) (SSL *ssl, int is_export,
3681 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3684 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3687 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3691 #ifndef OPENSSL_NO_PSK
3692 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3694 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3695 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3698 OPENSSL_free(ctx->cert->psk_identity_hint);
3699 if (identity_hint != NULL) {
3700 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3701 if (ctx->cert->psk_identity_hint == NULL)
3704 ctx->cert->psk_identity_hint = NULL;
3708 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3713 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3714 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3717 OPENSSL_free(s->cert->psk_identity_hint);
3718 if (identity_hint != NULL) {
3719 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3720 if (s->cert->psk_identity_hint == NULL)
3723 s->cert->psk_identity_hint = NULL;
3727 const char *SSL_get_psk_identity_hint(const SSL *s)
3729 if (s == NULL || s->session == NULL)
3731 return (s->session->psk_identity_hint);
3734 const char *SSL_get_psk_identity(const SSL *s)
3736 if (s == NULL || s->session == NULL)
3738 return (s->session->psk_identity);
3741 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3743 s->psk_client_callback = cb;
3746 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3748 ctx->psk_client_callback = cb;
3751 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3753 s->psk_server_callback = cb;
3756 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3758 ctx->psk_server_callback = cb;
3762 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3763 void (*cb) (int write_p, int version,
3764 int content_type, const void *buf,
3765 size_t len, SSL *ssl, void *arg))
3767 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3770 void SSL_set_msg_callback(SSL *ssl,
3771 void (*cb) (int write_p, int version,
3772 int content_type, const void *buf,
3773 size_t len, SSL *ssl, void *arg))
3775 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3778 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3779 int (*cb) (SSL *ssl,
3783 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3784 (void (*)(void))cb);
3787 void SSL_set_not_resumable_session_callback(SSL *ssl,
3788 int (*cb) (SSL *ssl,
3789 int is_forward_secure))
3791 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3792 (void (*)(void))cb);
3796 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3797 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3798 * If EVP_MD pointer is passed, initializes ctx with this md.
3799 * Returns the newly allocated ctx;
3802 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3804 ssl_clear_hash_ctx(hash);
3805 *hash = EVP_MD_CTX_new();
3806 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3807 EVP_MD_CTX_free(*hash);
3814 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3817 EVP_MD_CTX_free(*hash);
3821 /* Retrieve handshake hashes */
3822 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3825 EVP_MD_CTX *ctx = NULL;
3826 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3827 int hashleni = EVP_MD_CTX_size(hdgst);
3830 if (hashleni < 0 || (size_t)hashleni > outlen)
3833 ctx = EVP_MD_CTX_new();
3837 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3838 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3841 *hashlen = hashleni;
3845 EVP_MD_CTX_free(ctx);
3849 int SSL_session_reused(SSL *s)
3854 int SSL_is_server(SSL *s)
3859 #if OPENSSL_API_COMPAT < 0x10100000L
3860 void SSL_set_debug(SSL *s, int debug)
3862 /* Old function was do-nothing anyway... */
3868 void SSL_set_security_level(SSL *s, int level)
3870 s->cert->sec_level = level;
3873 int SSL_get_security_level(const SSL *s)
3875 return s->cert->sec_level;
3878 void SSL_set_security_callback(SSL *s,
3879 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3880 int op, int bits, int nid,
3881 void *other, void *ex))
3883 s->cert->sec_cb = cb;
3886 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
3887 const SSL_CTX *ctx, int op,
3888 int bits, int nid, void *other,
3890 return s->cert->sec_cb;
3893 void SSL_set0_security_ex_data(SSL *s, void *ex)
3895 s->cert->sec_ex = ex;
3898 void *SSL_get0_security_ex_data(const SSL *s)
3900 return s->cert->sec_ex;
3903 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
3905 ctx->cert->sec_level = level;
3908 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
3910 return ctx->cert->sec_level;
3913 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
3914 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3915 int op, int bits, int nid,
3916 void *other, void *ex))
3918 ctx->cert->sec_cb = cb;
3921 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
3927 return ctx->cert->sec_cb;
3930 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
3932 ctx->cert->sec_ex = ex;
3935 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
3937 return ctx->cert->sec_ex;
3941 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3942 * can return unsigned long, instead of the generic long return value from the
3943 * control interface.
3945 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
3947 return ctx->options;
3950 unsigned long SSL_get_options(const SSL *s)
3955 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
3957 return ctx->options |= op;
3960 unsigned long SSL_set_options(SSL *s, unsigned long op)
3962 return s->options |= op;
3965 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
3967 return ctx->options &= ~op;
3970 unsigned long SSL_clear_options(SSL *s, unsigned long op)
3972 return s->options &= ~op;
3975 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
3977 return s->verified_chain;
3980 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
3982 #ifndef OPENSSL_NO_CT
3985 * Moves SCTs from the |src| stack to the |dst| stack.
3986 * The source of each SCT will be set to |origin|.
3987 * If |dst| points to a NULL pointer, a new stack will be created and owned by
3989 * Returns the number of SCTs moved, or a negative integer if an error occurs.
3991 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
3992 sct_source_t origin)
3998 *dst = sk_SCT_new_null();
4000 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4005 while ((sct = sk_SCT_pop(src)) != NULL) {
4006 if (SCT_set_source(sct, origin) != 1)
4009 if (sk_SCT_push(*dst, sct) <= 0)
4017 sk_SCT_push(src, sct); /* Put the SCT back */
4022 * Look for data collected during ServerHello and parse if found.
4023 * Returns the number of SCTs extracted.
4025 static int ct_extract_tls_extension_scts(SSL *s)
4027 int scts_extracted = 0;
4029 if (s->ext.scts != NULL) {
4030 const unsigned char *p = s->ext.scts;
4031 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4033 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4035 SCT_LIST_free(scts);
4038 return scts_extracted;
4042 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4043 * contains an SCT X509 extension. They will be stored in |s->scts|.
4045 * - The number of SCTs extracted, assuming an OCSP response exists.
4046 * - 0 if no OCSP response exists or it contains no SCTs.
4047 * - A negative integer if an error occurs.
4049 static int ct_extract_ocsp_response_scts(SSL *s)
4051 # ifndef OPENSSL_NO_OCSP
4052 int scts_extracted = 0;
4053 const unsigned char *p;
4054 OCSP_BASICRESP *br = NULL;
4055 OCSP_RESPONSE *rsp = NULL;
4056 STACK_OF(SCT) *scts = NULL;
4059 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4062 p = s->ext.ocsp.resp;
4063 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4067 br = OCSP_response_get1_basic(rsp);
4071 for (i = 0; i < OCSP_resp_count(br); ++i) {
4072 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4078 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4080 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4081 if (scts_extracted < 0)
4085 SCT_LIST_free(scts);
4086 OCSP_BASICRESP_free(br);
4087 OCSP_RESPONSE_free(rsp);
4088 return scts_extracted;
4090 /* Behave as if no OCSP response exists */
4096 * Attempts to extract SCTs from the peer certificate.
4097 * Return the number of SCTs extracted, or a negative integer if an error
4100 static int ct_extract_x509v3_extension_scts(SSL *s)
4102 int scts_extracted = 0;
4103 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4106 STACK_OF(SCT) *scts =
4107 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4110 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4112 SCT_LIST_free(scts);
4115 return scts_extracted;
4119 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4120 * response (if it exists) and X509v3 extensions in the certificate.
4121 * Returns NULL if an error occurs.
4123 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4125 if (!s->scts_parsed) {
4126 if (ct_extract_tls_extension_scts(s) < 0 ||
4127 ct_extract_ocsp_response_scts(s) < 0 ||
4128 ct_extract_x509v3_extension_scts(s) < 0)
4138 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4139 const STACK_OF(SCT) *scts, void *unused_arg)
4144 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4145 const STACK_OF(SCT) *scts, void *unused_arg)
4147 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4150 for (i = 0; i < count; ++i) {
4151 SCT *sct = sk_SCT_value(scts, i);
4152 int status = SCT_get_validation_status(sct);
4154 if (status == SCT_VALIDATION_STATUS_VALID)
4157 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4161 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4165 * Since code exists that uses the custom extension handler for CT, look
4166 * for this and throw an error if they have already registered to use CT.
4168 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4169 TLSEXT_TYPE_signed_certificate_timestamp))
4171 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4172 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4176 if (callback != NULL) {
4178 * If we are validating CT, then we MUST accept SCTs served via OCSP
4180 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4184 s->ct_validation_callback = callback;
4185 s->ct_validation_callback_arg = arg;
4190 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4191 ssl_ct_validation_cb callback, void *arg)
4194 * Since code exists that uses the custom extension handler for CT, look for
4195 * this and throw an error if they have already registered to use CT.
4197 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4198 TLSEXT_TYPE_signed_certificate_timestamp))
4200 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4201 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4205 ctx->ct_validation_callback = callback;
4206 ctx->ct_validation_callback_arg = arg;
4210 int SSL_ct_is_enabled(const SSL *s)
4212 return s->ct_validation_callback != NULL;
4215 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4217 return ctx->ct_validation_callback != NULL;
4220 int ssl_validate_ct(SSL *s)
4223 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4225 SSL_DANE *dane = &s->dane;
4226 CT_POLICY_EVAL_CTX *ctx = NULL;
4227 const STACK_OF(SCT) *scts;
4230 * If no callback is set, the peer is anonymous, or its chain is invalid,
4231 * skip SCT validation - just return success. Applications that continue
4232 * handshakes without certificates, with unverified chains, or pinned leaf
4233 * certificates are outside the scope of the WebPKI and CT.
4235 * The above exclusions notwithstanding the vast majority of peers will
4236 * have rather ordinary certificate chains validated by typical
4237 * applications that perform certificate verification and therefore will
4238 * process SCTs when enabled.
4240 if (s->ct_validation_callback == NULL || cert == NULL ||
4241 s->verify_result != X509_V_OK ||
4242 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4246 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4247 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4249 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4250 switch (dane->mtlsa->usage) {
4251 case DANETLS_USAGE_DANE_TA:
4252 case DANETLS_USAGE_DANE_EE:
4257 ctx = CT_POLICY_EVAL_CTX_new();
4259 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4263 issuer = sk_X509_value(s->verified_chain, 1);
4264 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4265 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4266 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4267 CT_POLICY_EVAL_CTX_set_time(ctx, SSL_SESSION_get_time(SSL_get0_session(s)));
4269 scts = SSL_get0_peer_scts(s);
4272 * This function returns success (> 0) only when all the SCTs are valid, 0
4273 * when some are invalid, and < 0 on various internal errors (out of
4274 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4275 * reason to abort the handshake, that decision is up to the callback.
4276 * Therefore, we error out only in the unexpected case that the return
4277 * value is negative.
4279 * XXX: One might well argue that the return value of this function is an
4280 * unfortunate design choice. Its job is only to determine the validation
4281 * status of each of the provided SCTs. So long as it correctly separates
4282 * the wheat from the chaff it should return success. Failure in this case
4283 * ought to correspond to an inability to carry out its duties.
4285 if (SCT_LIST_validate(scts, ctx) < 0) {
4286 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4290 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4292 ret = 0; /* This function returns 0 on failure */
4295 CT_POLICY_EVAL_CTX_free(ctx);
4297 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4298 * failure return code here. Also the application may wish the complete
4299 * the handshake, and then disconnect cleanly at a higher layer, after
4300 * checking the verification status of the completed connection.
4302 * We therefore force a certificate verification failure which will be
4303 * visible via SSL_get_verify_result() and cached as part of any resumed
4306 * Note: the permissive callback is for information gathering only, always
4307 * returns success, and does not affect verification status. Only the
4308 * strict callback or a custom application-specified callback can trigger
4309 * connection failure or record a verification error.
4312 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4316 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4318 switch (validation_mode) {
4320 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4322 case SSL_CT_VALIDATION_PERMISSIVE:
4323 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4324 case SSL_CT_VALIDATION_STRICT:
4325 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4329 int SSL_enable_ct(SSL *s, int validation_mode)
4331 switch (validation_mode) {
4333 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4335 case SSL_CT_VALIDATION_PERMISSIVE:
4336 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4337 case SSL_CT_VALIDATION_STRICT:
4338 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4342 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4344 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4347 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4349 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4352 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4354 CTLOG_STORE_free(ctx->ctlog_store);
4355 ctx->ctlog_store = logs;
4358 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4360 return ctx->ctlog_store;
4365 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4367 ctx->keylog_callback = cb;
4370 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4372 return ctx->keylog_callback;
4375 static int nss_keylog_int(const char *prefix,
4377 const uint8_t *parameter_1,
4378 size_t parameter_1_len,
4379 const uint8_t *parameter_2,
4380 size_t parameter_2_len)
4383 char *cursor = NULL;
4388 if (ssl->ctx->keylog_callback == NULL) return 1;
4391 * Our output buffer will contain the following strings, rendered with
4392 * space characters in between, terminated by a NULL character: first the
4393 * prefix, then the first parameter, then the second parameter. The
4394 * meaning of each parameter depends on the specific key material being
4395 * logged. Note that the first and second parameters are encoded in
4396 * hexadecimal, so we need a buffer that is twice their lengths.
4398 prefix_len = strlen(prefix);
4399 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4400 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4401 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4405 strcpy(cursor, prefix);
4406 cursor += prefix_len;
4409 for (i = 0; i < parameter_1_len; i++) {
4410 sprintf(cursor, "%02x", parameter_1[i]);
4415 for (i = 0; i < parameter_2_len; i++) {
4416 sprintf(cursor, "%02x", parameter_2[i]);
4421 ssl->ctx->keylog_callback(ssl, (const char *)out);
4427 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4428 const uint8_t *encrypted_premaster,
4429 size_t encrypted_premaster_len,
4430 const uint8_t *premaster,
4431 size_t premaster_len)
4433 if (encrypted_premaster_len < 8) {
4434 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4438 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4439 return nss_keylog_int("RSA",
4441 encrypted_premaster,
4447 int ssl_log_secret(SSL *ssl,
4449 const uint8_t *secret,
4452 return nss_keylog_int(label,
4454 ssl->s3->client_random,