2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 * ECC cipher suite support in OpenSSL originally developed by
13 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
15 /* ====================================================================
16 * Copyright 2005 Nokia. All rights reserved.
18 * The portions of the attached software ("Contribution") is developed by
19 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
22 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24 * support (see RFC 4279) to OpenSSL.
26 * No patent licenses or other rights except those expressly stated in
27 * the OpenSSL open source license shall be deemed granted or received
28 * expressly, by implication, estoppel, or otherwise.
30 * No assurances are provided by Nokia that the Contribution does not
31 * infringe the patent or other intellectual property rights of any third
32 * party or that the license provides you with all the necessary rights
33 * to make use of the Contribution.
35 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
45 #include <openssl/objects.h>
46 #include <openssl/lhash.h>
47 #include <openssl/x509v3.h>
48 #include <openssl/rand.h>
49 #include <openssl/ocsp.h>
50 #include <openssl/dh.h>
51 #include <openssl/engine.h>
52 #include <openssl/async.h>
53 #include <openssl/ct.h>
55 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
57 SSL3_ENC_METHOD ssl3_undef_enc_method = {
59 * evil casts, but these functions are only called if there's a library
62 (int (*)(SSL *, SSL3_RECORD *, size_t, int))ssl_undefined_function,
63 (int (*)(SSL *, SSL3_RECORD *, unsigned char *, int))ssl_undefined_function,
64 ssl_undefined_function,
65 (int (*)(SSL *, unsigned char *, unsigned char *, size_t, size_t *))
66 ssl_undefined_function,
67 (int (*)(SSL *, int))ssl_undefined_function,
68 (size_t (*)(SSL *, const char *, size_t, unsigned char *))
69 ssl_undefined_function,
70 NULL, /* client_finished_label */
71 0, /* client_finished_label_len */
72 NULL, /* server_finished_label */
73 0, /* server_finished_label_len */
74 (int (*)(int))ssl_undefined_function,
75 (int (*)(SSL *, unsigned char *, size_t, const char *,
76 size_t, const unsigned char *, size_t,
77 int use_context))ssl_undefined_function,
80 struct ssl_async_args {
84 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
86 int (*func_read) (SSL *, void *, size_t, size_t *);
87 int (*func_write) (SSL *, const void *, size_t, size_t *);
88 int (*func_other) (SSL *);
98 DANETLS_MATCHING_FULL, 0, NID_undef
101 DANETLS_MATCHING_2256, 1, NID_sha256
104 DANETLS_MATCHING_2512, 2, NID_sha512
108 static int dane_ctx_enable(struct dane_ctx_st *dctx)
110 const EVP_MD **mdevp;
112 uint8_t mdmax = DANETLS_MATCHING_LAST;
113 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
116 if (dctx->mdevp != NULL)
119 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
120 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
122 if (mdord == NULL || mdevp == NULL) {
125 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
129 /* Install default entries */
130 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
133 if (dane_mds[i].nid == NID_undef ||
134 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
136 mdevp[dane_mds[i].mtype] = md;
137 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
147 static void dane_ctx_final(struct dane_ctx_st *dctx)
149 OPENSSL_free(dctx->mdevp);
152 OPENSSL_free(dctx->mdord);
157 static void tlsa_free(danetls_record *t)
161 OPENSSL_free(t->data);
162 EVP_PKEY_free(t->spki);
166 static void dane_final(SSL_DANE *dane)
168 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
171 sk_X509_pop_free(dane->certs, X509_free);
174 X509_free(dane->mcert);
182 * dane_copy - Copy dane configuration, sans verification state.
184 static int ssl_dane_dup(SSL *to, SSL *from)
189 if (!DANETLS_ENABLED(&from->dane))
192 dane_final(&to->dane);
193 to->dane.flags = from->dane.flags;
194 to->dane.dctx = &to->ctx->dane;
195 to->dane.trecs = sk_danetls_record_new_null();
197 if (to->dane.trecs == NULL) {
198 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
202 num = sk_danetls_record_num(from->dane.trecs);
203 for (i = 0; i < num; ++i) {
204 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
206 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
207 t->data, t->dlen) <= 0)
213 static int dane_mtype_set(struct dane_ctx_st *dctx,
214 const EVP_MD *md, uint8_t mtype, uint8_t ord)
218 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
219 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
223 if (mtype > dctx->mdmax) {
224 const EVP_MD **mdevp;
226 int n = ((int)mtype) + 1;
228 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
230 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
235 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
237 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
242 /* Zero-fill any gaps */
243 for (i = dctx->mdmax + 1; i < mtype; ++i) {
251 dctx->mdevp[mtype] = md;
252 /* Coerce ordinal of disabled matching types to 0 */
253 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
258 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
260 if (mtype > dane->dctx->mdmax)
262 return dane->dctx->mdevp[mtype];
265 static int dane_tlsa_add(SSL_DANE *dane,
268 uint8_t mtype, unsigned char *data, size_t dlen)
271 const EVP_MD *md = NULL;
272 int ilen = (int)dlen;
276 if (dane->trecs == NULL) {
277 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
281 if (ilen < 0 || dlen != (size_t)ilen) {
282 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
286 if (usage > DANETLS_USAGE_LAST) {
287 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
291 if (selector > DANETLS_SELECTOR_LAST) {
292 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
296 if (mtype != DANETLS_MATCHING_FULL) {
297 md = tlsa_md_get(dane, mtype);
299 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
304 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
305 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
309 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
313 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
314 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
319 t->selector = selector;
321 t->data = OPENSSL_malloc(dlen);
322 if (t->data == NULL) {
324 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
327 memcpy(t->data, data, dlen);
330 /* Validate and cache full certificate or public key */
331 if (mtype == DANETLS_MATCHING_FULL) {
332 const unsigned char *p = data;
334 EVP_PKEY *pkey = NULL;
337 case DANETLS_SELECTOR_CERT:
338 if (!d2i_X509(&cert, &p, ilen) || p < data ||
339 dlen != (size_t)(p - data)) {
341 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
344 if (X509_get0_pubkey(cert) == NULL) {
346 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
350 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
356 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
357 * records that contain full certificates of trust-anchors that are
358 * not present in the wire chain. For usage PKIX-TA(0), we augment
359 * the chain with untrusted Full(0) certificates from DNS, in case
360 * they are missing from the chain.
362 if ((dane->certs == NULL &&
363 (dane->certs = sk_X509_new_null()) == NULL) ||
364 !sk_X509_push(dane->certs, cert)) {
365 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
372 case DANETLS_SELECTOR_SPKI:
373 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
374 dlen != (size_t)(p - data)) {
376 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
381 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
382 * records that contain full bare keys of trust-anchors that are
383 * not present in the wire chain.
385 if (usage == DANETLS_USAGE_DANE_TA)
394 * Find the right insertion point for the new record.
396 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
397 * they can be processed first, as they require no chain building, and no
398 * expiration or hostname checks. Because DANE-EE(3) is numerically
399 * largest, this is accomplished via descending sort by "usage".
401 * We also sort in descending order by matching ordinal to simplify
402 * the implementation of digest agility in the verification code.
404 * The choice of order for the selector is not significant, so we
405 * use the same descending order for consistency.
407 num = sk_danetls_record_num(dane->trecs);
408 for (i = 0; i < num; ++i) {
409 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
411 if (rec->usage > usage)
413 if (rec->usage < usage)
415 if (rec->selector > selector)
417 if (rec->selector < selector)
419 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
424 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
426 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
429 dane->umask |= DANETLS_USAGE_BIT(usage);
434 static void clear_ciphers(SSL *s)
436 /* clear the current cipher */
437 ssl_clear_cipher_ctx(s);
438 ssl_clear_hash_ctx(&s->read_hash);
439 ssl_clear_hash_ctx(&s->write_hash);
442 int SSL_clear(SSL *s)
444 if (s->method == NULL) {
445 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
449 if (ssl_clear_bad_session(s)) {
450 SSL_SESSION_free(s->session);
458 if (s->renegotiate) {
459 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
463 ossl_statem_clear(s);
465 s->version = s->method->version;
466 s->client_version = s->version;
467 s->rwstate = SSL_NOTHING;
469 BUF_MEM_free(s->init_buf);
474 s->key_update = SSL_KEY_UPDATE_NONE;
476 /* Reset DANE verification result state */
479 X509_free(s->dane.mcert);
480 s->dane.mcert = NULL;
481 s->dane.mtlsa = NULL;
483 /* Clear the verification result peername */
484 X509_VERIFY_PARAM_move_peername(s->param, NULL);
487 * Check to see if we were changed into a different method, if so, revert
488 * back if we are not doing session-id reuse.
490 if (!ossl_statem_get_in_handshake(s) && (s->session == NULL)
491 && (s->method != s->ctx->method)) {
492 s->method->ssl_free(s);
493 s->method = s->ctx->method;
494 if (!s->method->ssl_new(s))
497 s->method->ssl_clear(s);
499 RECORD_LAYER_clear(&s->rlayer);
504 /** Used to change an SSL_CTXs default SSL method type */
505 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
507 STACK_OF(SSL_CIPHER) *sk;
511 sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
512 &(ctx->cipher_list_by_id),
513 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
514 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
515 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
521 SSL *SSL_new(SSL_CTX *ctx)
526 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
529 if (ctx->method == NULL) {
530 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
534 s = OPENSSL_zalloc(sizeof(*s));
538 s->lock = CRYPTO_THREAD_lock_new();
539 if (s->lock == NULL) {
540 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
545 RECORD_LAYER_init(&s->rlayer, s);
547 s->options = ctx->options;
548 s->dane.flags = ctx->dane.flags;
549 s->min_proto_version = ctx->min_proto_version;
550 s->max_proto_version = ctx->max_proto_version;
552 s->max_cert_list = ctx->max_cert_list;
556 * Earlier library versions used to copy the pointer to the CERT, not
557 * its contents; only when setting new parameters for the per-SSL
558 * copy, ssl_cert_new would be called (and the direct reference to
559 * the per-SSL_CTX settings would be lost, but those still were
560 * indirectly accessed for various purposes, and for that reason they
561 * used to be known as s->ctx->default_cert). Now we don't look at the
562 * SSL_CTX's CERT after having duplicated it once.
564 s->cert = ssl_cert_dup(ctx->cert);
568 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
569 s->msg_callback = ctx->msg_callback;
570 s->msg_callback_arg = ctx->msg_callback_arg;
571 s->verify_mode = ctx->verify_mode;
572 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
573 s->sid_ctx_length = ctx->sid_ctx_length;
574 OPENSSL_assert(s->sid_ctx_length <= sizeof s->sid_ctx);
575 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
576 s->verify_callback = ctx->default_verify_callback;
577 s->generate_session_id = ctx->generate_session_id;
579 s->param = X509_VERIFY_PARAM_new();
580 if (s->param == NULL)
582 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
583 s->quiet_shutdown = ctx->quiet_shutdown;
584 s->max_send_fragment = ctx->max_send_fragment;
585 s->split_send_fragment = ctx->split_send_fragment;
586 s->max_pipelines = ctx->max_pipelines;
587 if (s->max_pipelines > 1)
588 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
589 if (ctx->default_read_buf_len > 0)
590 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
595 s->ext.debug_arg = NULL;
596 s->ext.ticket_expected = 0;
597 s->ext.status_type = ctx->ext.status_type;
598 s->ext.status_expected = 0;
599 s->ext.ocsp.ids = NULL;
600 s->ext.ocsp.exts = NULL;
601 s->ext.ocsp.resp = NULL;
602 s->ext.ocsp.resp_len = 0;
604 s->session_ctx = ctx;
605 #ifndef OPENSSL_NO_EC
606 if (ctx->ext.ecpointformats) {
607 s->ext.ecpointformats =
608 OPENSSL_memdup(ctx->ext.ecpointformats,
609 ctx->ext.ecpointformats_len);
610 if (!s->ext.ecpointformats)
612 s->ext.ecpointformats_len =
613 ctx->ext.ecpointformats_len;
615 if (ctx->ext.supportedgroups) {
616 s->ext.supportedgroups =
617 OPENSSL_memdup(ctx->ext.supportedgroups,
618 ctx->ext.supportedgroups_len);
619 if (!s->ext.supportedgroups)
621 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
624 #ifndef OPENSSL_NO_NEXTPROTONEG
628 if (s->ctx->ext.alpn) {
629 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
630 if (s->ext.alpn == NULL)
632 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
633 s->ext.alpn_len = s->ctx->ext.alpn_len;
636 s->verified_chain = NULL;
637 s->verify_result = X509_V_OK;
639 s->default_passwd_callback = ctx->default_passwd_callback;
640 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
642 s->method = ctx->method;
644 s->key_update = SSL_KEY_UPDATE_NONE;
646 if (!s->method->ssl_new(s))
649 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
654 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
657 #ifndef OPENSSL_NO_PSK
658 s->psk_client_callback = ctx->psk_client_callback;
659 s->psk_server_callback = ctx->psk_server_callback;
664 #ifndef OPENSSL_NO_CT
665 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
666 ctx->ct_validation_callback_arg))
673 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
677 int SSL_is_dtls(const SSL *s)
679 return SSL_IS_DTLS(s) ? 1 : 0;
682 int SSL_up_ref(SSL *s)
686 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
689 REF_PRINT_COUNT("SSL", s);
690 REF_ASSERT_ISNT(i < 2);
691 return ((i > 1) ? 1 : 0);
694 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
695 unsigned int sid_ctx_len)
697 if (sid_ctx_len > sizeof ctx->sid_ctx) {
698 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
699 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
702 ctx->sid_ctx_length = sid_ctx_len;
703 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
708 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
709 unsigned int sid_ctx_len)
711 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
712 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
713 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
716 ssl->sid_ctx_length = sid_ctx_len;
717 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
722 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
724 CRYPTO_THREAD_write_lock(ctx->lock);
725 ctx->generate_session_id = cb;
726 CRYPTO_THREAD_unlock(ctx->lock);
730 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
732 CRYPTO_THREAD_write_lock(ssl->lock);
733 ssl->generate_session_id = cb;
734 CRYPTO_THREAD_unlock(ssl->lock);
738 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
742 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
743 * we can "construct" a session to give us the desired check - ie. to
744 * find if there's a session in the hash table that would conflict with
745 * any new session built out of this id/id_len and the ssl_version in use
750 if (id_len > sizeof r.session_id)
753 r.ssl_version = ssl->version;
754 r.session_id_length = id_len;
755 memcpy(r.session_id, id, id_len);
757 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
758 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
759 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
763 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
765 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
768 int SSL_set_purpose(SSL *s, int purpose)
770 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
773 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
775 return X509_VERIFY_PARAM_set_trust(s->param, trust);
778 int SSL_set_trust(SSL *s, int trust)
780 return X509_VERIFY_PARAM_set_trust(s->param, trust);
783 int SSL_set1_host(SSL *s, const char *hostname)
785 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
788 int SSL_add1_host(SSL *s, const char *hostname)
790 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
793 void SSL_set_hostflags(SSL *s, unsigned int flags)
795 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
798 const char *SSL_get0_peername(SSL *s)
800 return X509_VERIFY_PARAM_get0_peername(s->param);
803 int SSL_CTX_dane_enable(SSL_CTX *ctx)
805 return dane_ctx_enable(&ctx->dane);
808 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
810 unsigned long orig = ctx->dane.flags;
812 ctx->dane.flags |= flags;
816 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
818 unsigned long orig = ctx->dane.flags;
820 ctx->dane.flags &= ~flags;
824 int SSL_dane_enable(SSL *s, const char *basedomain)
826 SSL_DANE *dane = &s->dane;
828 if (s->ctx->dane.mdmax == 0) {
829 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
832 if (dane->trecs != NULL) {
833 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
838 * Default SNI name. This rejects empty names, while set1_host below
839 * accepts them and disables host name checks. To avoid side-effects with
840 * invalid input, set the SNI name first.
842 if (s->ext.hostname == NULL) {
843 if (!SSL_set_tlsext_host_name(s, basedomain)) {
844 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
849 /* Primary RFC6125 reference identifier */
850 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
851 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
857 dane->dctx = &s->ctx->dane;
858 dane->trecs = sk_danetls_record_new_null();
860 if (dane->trecs == NULL) {
861 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
867 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
869 unsigned long orig = ssl->dane.flags;
871 ssl->dane.flags |= flags;
875 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
877 unsigned long orig = ssl->dane.flags;
879 ssl->dane.flags &= ~flags;
883 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
885 SSL_DANE *dane = &s->dane;
887 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
891 *mcert = dane->mcert;
893 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
898 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
899 uint8_t *mtype, unsigned const char **data, size_t *dlen)
901 SSL_DANE *dane = &s->dane;
903 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
907 *usage = dane->mtlsa->usage;
909 *selector = dane->mtlsa->selector;
911 *mtype = dane->mtlsa->mtype;
913 *data = dane->mtlsa->data;
915 *dlen = dane->mtlsa->dlen;
920 SSL_DANE *SSL_get0_dane(SSL *s)
925 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
926 uint8_t mtype, unsigned char *data, size_t dlen)
928 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
931 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
934 return dane_mtype_set(&ctx->dane, md, mtype, ord);
937 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
939 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
942 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
944 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
947 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
952 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
957 void SSL_certs_clear(SSL *s)
959 ssl_cert_clear_certs(s->cert);
962 void SSL_free(SSL *s)
969 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
970 REF_PRINT_COUNT("SSL", s);
973 REF_ASSERT_ISNT(i < 0);
975 X509_VERIFY_PARAM_free(s->param);
976 dane_final(&s->dane);
977 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
979 ssl_free_wbio_buffer(s);
981 BIO_free_all(s->wbio);
982 BIO_free_all(s->rbio);
984 BUF_MEM_free(s->init_buf);
986 /* add extra stuff */
987 sk_SSL_CIPHER_free(s->cipher_list);
988 sk_SSL_CIPHER_free(s->cipher_list_by_id);
990 /* Make the next call work :-) */
991 if (s->session != NULL) {
992 ssl_clear_bad_session(s);
993 SSL_SESSION_free(s->session);
998 ssl_cert_free(s->cert);
999 /* Free up if allocated */
1001 OPENSSL_free(s->ext.hostname);
1002 SSL_CTX_free(s->session_ctx);
1003 #ifndef OPENSSL_NO_EC
1004 OPENSSL_free(s->ext.ecpointformats);
1005 OPENSSL_free(s->ext.supportedgroups);
1006 #endif /* OPENSSL_NO_EC */
1007 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1008 #ifndef OPENSSL_NO_OCSP
1009 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1011 #ifndef OPENSSL_NO_CT
1012 SCT_LIST_free(s->scts);
1013 OPENSSL_free(s->ext.scts);
1015 OPENSSL_free(s->ext.ocsp.resp);
1016 OPENSSL_free(s->ext.alpn);
1017 OPENSSL_free(s->clienthello);
1019 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1021 sk_X509_pop_free(s->verified_chain, X509_free);
1023 if (s->method != NULL)
1024 s->method->ssl_free(s);
1026 RECORD_LAYER_release(&s->rlayer);
1028 SSL_CTX_free(s->ctx);
1030 ASYNC_WAIT_CTX_free(s->waitctx);
1032 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1033 OPENSSL_free(s->ext.npn);
1036 #ifndef OPENSSL_NO_SRTP
1037 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1040 CRYPTO_THREAD_lock_free(s->lock);
1045 void SSL_set0_rbio(SSL *s, BIO *rbio)
1047 BIO_free_all(s->rbio);
1051 void SSL_set0_wbio(SSL *s, BIO *wbio)
1054 * If the output buffering BIO is still in place, remove it
1056 if (s->bbio != NULL)
1057 s->wbio = BIO_pop(s->wbio);
1059 BIO_free_all(s->wbio);
1062 /* Re-attach |bbio| to the new |wbio|. */
1063 if (s->bbio != NULL)
1064 s->wbio = BIO_push(s->bbio, s->wbio);
1067 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1070 * For historical reasons, this function has many different cases in
1071 * ownership handling.
1074 /* If nothing has changed, do nothing */
1075 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1079 * If the two arguments are equal then one fewer reference is granted by the
1080 * caller than we want to take
1082 if (rbio != NULL && rbio == wbio)
1086 * If only the wbio is changed only adopt one reference.
1088 if (rbio == SSL_get_rbio(s)) {
1089 SSL_set0_wbio(s, wbio);
1093 * There is an asymmetry here for historical reasons. If only the rbio is
1094 * changed AND the rbio and wbio were originally different, then we only
1095 * adopt one reference.
1097 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1098 SSL_set0_rbio(s, rbio);
1102 /* Otherwise, adopt both references. */
1103 SSL_set0_rbio(s, rbio);
1104 SSL_set0_wbio(s, wbio);
1107 BIO *SSL_get_rbio(const SSL *s)
1112 BIO *SSL_get_wbio(const SSL *s)
1114 if (s->bbio != NULL) {
1116 * If |bbio| is active, the true caller-configured BIO is its
1119 return BIO_next(s->bbio);
1124 int SSL_get_fd(const SSL *s)
1126 return SSL_get_rfd(s);
1129 int SSL_get_rfd(const SSL *s)
1134 b = SSL_get_rbio(s);
1135 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1137 BIO_get_fd(r, &ret);
1141 int SSL_get_wfd(const SSL *s)
1146 b = SSL_get_wbio(s);
1147 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1149 BIO_get_fd(r, &ret);
1153 #ifndef OPENSSL_NO_SOCK
1154 int SSL_set_fd(SSL *s, int fd)
1159 bio = BIO_new(BIO_s_socket());
1162 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1165 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1166 SSL_set_bio(s, bio, bio);
1172 int SSL_set_wfd(SSL *s, int fd)
1174 BIO *rbio = SSL_get_rbio(s);
1176 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1177 || (int)BIO_get_fd(rbio, NULL) != fd) {
1178 BIO *bio = BIO_new(BIO_s_socket());
1181 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1184 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1185 SSL_set0_wbio(s, bio);
1188 SSL_set0_wbio(s, rbio);
1193 int SSL_set_rfd(SSL *s, int fd)
1195 BIO *wbio = SSL_get_wbio(s);
1197 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1198 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1199 BIO *bio = BIO_new(BIO_s_socket());
1202 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1205 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1206 SSL_set0_rbio(s, bio);
1209 SSL_set0_rbio(s, wbio);
1216 /* return length of latest Finished message we sent, copy to 'buf' */
1217 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1221 if (s->s3 != NULL) {
1222 ret = s->s3->tmp.finish_md_len;
1225 memcpy(buf, s->s3->tmp.finish_md, count);
1230 /* return length of latest Finished message we expected, copy to 'buf' */
1231 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1235 if (s->s3 != NULL) {
1236 ret = s->s3->tmp.peer_finish_md_len;
1239 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1244 int SSL_get_verify_mode(const SSL *s)
1246 return (s->verify_mode);
1249 int SSL_get_verify_depth(const SSL *s)
1251 return X509_VERIFY_PARAM_get_depth(s->param);
1254 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1255 return (s->verify_callback);
1258 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1260 return (ctx->verify_mode);
1263 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1265 return X509_VERIFY_PARAM_get_depth(ctx->param);
1268 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1269 return (ctx->default_verify_callback);
1272 void SSL_set_verify(SSL *s, int mode,
1273 int (*callback) (int ok, X509_STORE_CTX *ctx))
1275 s->verify_mode = mode;
1276 if (callback != NULL)
1277 s->verify_callback = callback;
1280 void SSL_set_verify_depth(SSL *s, int depth)
1282 X509_VERIFY_PARAM_set_depth(s->param, depth);
1285 void SSL_set_read_ahead(SSL *s, int yes)
1287 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1290 int SSL_get_read_ahead(const SSL *s)
1292 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1295 int SSL_pending(const SSL *s)
1297 size_t pending = s->method->ssl_pending(s);
1300 * SSL_pending cannot work properly if read-ahead is enabled
1301 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1302 * impossible to fix since SSL_pending cannot report errors that may be
1303 * observed while scanning the new data. (Note that SSL_pending() is
1304 * often used as a boolean value, so we'd better not return -1.)
1306 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1307 * we just return INT_MAX.
1309 return pending < INT_MAX ? (int)pending : INT_MAX;
1312 int SSL_has_pending(const SSL *s)
1315 * Similar to SSL_pending() but returns a 1 to indicate that we have
1316 * unprocessed data available or 0 otherwise (as opposed to the number of
1317 * bytes available). Unlike SSL_pending() this will take into account
1318 * read_ahead data. A 1 return simply indicates that we have unprocessed
1319 * data. That data may not result in any application data, or we may fail
1320 * to parse the records for some reason.
1325 return RECORD_LAYER_read_pending(&s->rlayer);
1328 X509 *SSL_get_peer_certificate(const SSL *s)
1332 if ((s == NULL) || (s->session == NULL))
1335 r = s->session->peer;
1345 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1349 if ((s == NULL) || (s->session == NULL))
1352 r = s->session->peer_chain;
1355 * If we are a client, cert_chain includes the peer's own certificate; if
1356 * we are a server, it does not.
1363 * Now in theory, since the calling process own 't' it should be safe to
1364 * modify. We need to be able to read f without being hassled
1366 int SSL_copy_session_id(SSL *t, const SSL *f)
1369 /* Do we need to to SSL locking? */
1370 if (!SSL_set_session(t, SSL_get_session(f))) {
1375 * what if we are setup for one protocol version but want to talk another
1377 if (t->method != f->method) {
1378 t->method->ssl_free(t);
1379 t->method = f->method;
1380 if (t->method->ssl_new(t) == 0)
1384 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1385 ssl_cert_free(t->cert);
1387 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1394 /* Fix this so it checks all the valid key/cert options */
1395 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1397 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1398 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1401 if (ctx->cert->key->privatekey == NULL) {
1402 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1405 return (X509_check_private_key
1406 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1409 /* Fix this function so that it takes an optional type parameter */
1410 int SSL_check_private_key(const SSL *ssl)
1413 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1416 if (ssl->cert->key->x509 == NULL) {
1417 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1420 if (ssl->cert->key->privatekey == NULL) {
1421 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1424 return (X509_check_private_key(ssl->cert->key->x509,
1425 ssl->cert->key->privatekey));
1428 int SSL_waiting_for_async(SSL *s)
1436 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1438 ASYNC_WAIT_CTX *ctx = s->waitctx;
1442 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1445 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1446 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1448 ASYNC_WAIT_CTX *ctx = s->waitctx;
1452 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1456 int SSL_accept(SSL *s)
1458 if (s->handshake_func == NULL) {
1459 /* Not properly initialized yet */
1460 SSL_set_accept_state(s);
1463 return SSL_do_handshake(s);
1466 int SSL_connect(SSL *s)
1468 if (s->handshake_func == NULL) {
1469 /* Not properly initialized yet */
1470 SSL_set_connect_state(s);
1473 return SSL_do_handshake(s);
1476 long SSL_get_default_timeout(const SSL *s)
1478 return (s->method->get_timeout());
1481 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1482 int (*func) (void *))
1485 if (s->waitctx == NULL) {
1486 s->waitctx = ASYNC_WAIT_CTX_new();
1487 if (s->waitctx == NULL)
1490 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1491 sizeof(struct ssl_async_args))) {
1493 s->rwstate = SSL_NOTHING;
1494 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1497 s->rwstate = SSL_ASYNC_PAUSED;
1500 s->rwstate = SSL_ASYNC_NO_JOBS;
1506 s->rwstate = SSL_NOTHING;
1507 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1508 /* Shouldn't happen */
1513 static int ssl_io_intern(void *vargs)
1515 struct ssl_async_args *args;
1520 args = (struct ssl_async_args *)vargs;
1524 switch (args->type) {
1526 return args->f.func_read(s, buf, num, &s->asyncrw);
1528 return args->f.func_write(s, buf, num, &s->asyncrw);
1530 return args->f.func_other(s);
1535 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1537 if (s->handshake_func == NULL) {
1538 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1542 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1543 s->rwstate = SSL_NOTHING;
1547 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1548 struct ssl_async_args args;
1554 args.type = READFUNC;
1555 args.f.func_read = s->method->ssl_read;
1557 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1558 *readbytes = s->asyncrw;
1561 return s->method->ssl_read(s, buf, num, readbytes);
1565 int SSL_read(SSL *s, void *buf, int num)
1571 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1575 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1578 * The cast is safe here because ret should be <= INT_MAX because num is
1582 ret = (int)readbytes;
1587 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1589 int ret = ssl_read_internal(s, buf, num, readbytes);
1596 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1598 if (s->handshake_func == NULL) {
1599 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1603 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1606 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1607 struct ssl_async_args args;
1613 args.type = READFUNC;
1614 args.f.func_read = s->method->ssl_peek;
1616 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1617 *readbytes = s->asyncrw;
1620 return s->method->ssl_peek(s, buf, num, readbytes);
1624 int SSL_peek(SSL *s, void *buf, int num)
1630 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1634 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1637 * The cast is safe here because ret should be <= INT_MAX because num is
1641 ret = (int)readbytes;
1647 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1649 int ret = ssl_peek_internal(s, buf, num, readbytes);
1656 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1658 if (s->handshake_func == NULL) {
1659 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1663 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1664 s->rwstate = SSL_NOTHING;
1665 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1669 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1671 struct ssl_async_args args;
1674 args.buf = (void *)buf;
1676 args.type = WRITEFUNC;
1677 args.f.func_write = s->method->ssl_write;
1679 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1680 *written = s->asyncrw;
1683 return s->method->ssl_write(s, buf, num, written);
1687 int SSL_write(SSL *s, const void *buf, int num)
1693 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1697 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1700 * The cast is safe here because ret should be <= INT_MAX because num is
1709 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1711 int ret = ssl_write_internal(s, buf, num, written);
1718 int SSL_shutdown(SSL *s)
1721 * Note that this function behaves differently from what one might
1722 * expect. Return values are 0 for no success (yet), 1 for success; but
1723 * calling it once is usually not enough, even if blocking I/O is used
1724 * (see ssl3_shutdown).
1727 if (s->handshake_func == NULL) {
1728 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1732 if (!SSL_in_init(s)) {
1733 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1734 struct ssl_async_args args;
1737 args.type = OTHERFUNC;
1738 args.f.func_other = s->method->ssl_shutdown;
1740 return ssl_start_async_job(s, &args, ssl_io_intern);
1742 return s->method->ssl_shutdown(s);
1745 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1750 int SSL_key_update(SSL *s, int updatetype)
1753 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
1754 * negotiated, and that it is appropriate to call SSL_key_update() instead
1755 * of SSL_renegotiate().
1757 if (!SSL_IS_TLS13(s)) {
1758 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1762 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1763 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1764 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1768 if (!SSL_is_init_finished(s)) {
1769 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1773 ossl_statem_set_in_init(s, 1);
1774 s->key_update = updatetype;
1778 int SSL_get_key_update_type(SSL *s)
1780 return s->key_update;
1783 int SSL_renegotiate(SSL *s)
1785 if (SSL_IS_TLS13(s)) {
1786 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1790 if (s->renegotiate == 0)
1795 return (s->method->ssl_renegotiate(s));
1798 int SSL_renegotiate_abbreviated(SSL *s)
1800 if (SSL_IS_TLS13(s))
1803 if (s->renegotiate == 0)
1808 return (s->method->ssl_renegotiate(s));
1811 int SSL_renegotiate_pending(SSL *s)
1814 * becomes true when negotiation is requested; false again once a
1815 * handshake has finished
1817 return (s->renegotiate != 0);
1820 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1825 case SSL_CTRL_GET_READ_AHEAD:
1826 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1827 case SSL_CTRL_SET_READ_AHEAD:
1828 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1829 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1832 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1833 s->msg_callback_arg = parg;
1837 return (s->mode |= larg);
1838 case SSL_CTRL_CLEAR_MODE:
1839 return (s->mode &= ~larg);
1840 case SSL_CTRL_GET_MAX_CERT_LIST:
1841 return (long)(s->max_cert_list);
1842 case SSL_CTRL_SET_MAX_CERT_LIST:
1845 l = (long)s->max_cert_list;
1846 s->max_cert_list = (size_t)larg;
1848 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1849 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1851 s->max_send_fragment = larg;
1852 if (s->max_send_fragment < s->split_send_fragment)
1853 s->split_send_fragment = s->max_send_fragment;
1855 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1856 if ((size_t)larg > s->max_send_fragment || larg == 0)
1858 s->split_send_fragment = larg;
1860 case SSL_CTRL_SET_MAX_PIPELINES:
1861 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1863 s->max_pipelines = larg;
1865 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1867 case SSL_CTRL_GET_RI_SUPPORT:
1869 return s->s3->send_connection_binding;
1872 case SSL_CTRL_CERT_FLAGS:
1873 return (s->cert->cert_flags |= larg);
1874 case SSL_CTRL_CLEAR_CERT_FLAGS:
1875 return (s->cert->cert_flags &= ~larg);
1877 case SSL_CTRL_GET_RAW_CIPHERLIST:
1879 if (s->s3->tmp.ciphers_raw == NULL)
1881 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
1882 return (int)s->s3->tmp.ciphers_rawlen;
1884 return TLS_CIPHER_LEN;
1886 case SSL_CTRL_GET_EXTMS_SUPPORT:
1887 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
1889 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
1893 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1894 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1895 &s->min_proto_version);
1896 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1897 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1898 &s->max_proto_version);
1900 return (s->method->ssl_ctrl(s, cmd, larg, parg));
1904 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1907 case SSL_CTRL_SET_MSG_CALLBACK:
1908 s->msg_callback = (void (*)
1909 (int write_p, int version, int content_type,
1910 const void *buf, size_t len, SSL *ssl,
1915 return (s->method->ssl_callback_ctrl(s, cmd, fp));
1919 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
1921 return ctx->sessions;
1924 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1927 /* For some cases with ctx == NULL perform syntax checks */
1930 #ifndef OPENSSL_NO_EC
1931 case SSL_CTRL_SET_GROUPS_LIST:
1932 return tls1_set_groups_list(NULL, NULL, parg);
1934 case SSL_CTRL_SET_SIGALGS_LIST:
1935 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
1936 return tls1_set_sigalgs_list(NULL, parg, 0);
1943 case SSL_CTRL_GET_READ_AHEAD:
1944 return (ctx->read_ahead);
1945 case SSL_CTRL_SET_READ_AHEAD:
1946 l = ctx->read_ahead;
1947 ctx->read_ahead = larg;
1950 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1951 ctx->msg_callback_arg = parg;
1954 case SSL_CTRL_GET_MAX_CERT_LIST:
1955 return (long)(ctx->max_cert_list);
1956 case SSL_CTRL_SET_MAX_CERT_LIST:
1959 l = (long)ctx->max_cert_list;
1960 ctx->max_cert_list = (size_t)larg;
1963 case SSL_CTRL_SET_SESS_CACHE_SIZE:
1966 l = (long)ctx->session_cache_size;
1967 ctx->session_cache_size = (size_t)larg;
1969 case SSL_CTRL_GET_SESS_CACHE_SIZE:
1970 return (long)(ctx->session_cache_size);
1971 case SSL_CTRL_SET_SESS_CACHE_MODE:
1972 l = ctx->session_cache_mode;
1973 ctx->session_cache_mode = larg;
1975 case SSL_CTRL_GET_SESS_CACHE_MODE:
1976 return (ctx->session_cache_mode);
1978 case SSL_CTRL_SESS_NUMBER:
1979 return (lh_SSL_SESSION_num_items(ctx->sessions));
1980 case SSL_CTRL_SESS_CONNECT:
1981 return (ctx->stats.sess_connect);
1982 case SSL_CTRL_SESS_CONNECT_GOOD:
1983 return (ctx->stats.sess_connect_good);
1984 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
1985 return (ctx->stats.sess_connect_renegotiate);
1986 case SSL_CTRL_SESS_ACCEPT:
1987 return (ctx->stats.sess_accept);
1988 case SSL_CTRL_SESS_ACCEPT_GOOD:
1989 return (ctx->stats.sess_accept_good);
1990 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
1991 return (ctx->stats.sess_accept_renegotiate);
1992 case SSL_CTRL_SESS_HIT:
1993 return (ctx->stats.sess_hit);
1994 case SSL_CTRL_SESS_CB_HIT:
1995 return (ctx->stats.sess_cb_hit);
1996 case SSL_CTRL_SESS_MISSES:
1997 return (ctx->stats.sess_miss);
1998 case SSL_CTRL_SESS_TIMEOUTS:
1999 return (ctx->stats.sess_timeout);
2000 case SSL_CTRL_SESS_CACHE_FULL:
2001 return (ctx->stats.sess_cache_full);
2003 return (ctx->mode |= larg);
2004 case SSL_CTRL_CLEAR_MODE:
2005 return (ctx->mode &= ~larg);
2006 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2007 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2009 ctx->max_send_fragment = larg;
2010 if (ctx->max_send_fragment < ctx->split_send_fragment)
2011 ctx->split_send_fragment = ctx->max_send_fragment;
2013 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2014 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2016 ctx->split_send_fragment = larg;
2018 case SSL_CTRL_SET_MAX_PIPELINES:
2019 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2021 ctx->max_pipelines = larg;
2023 case SSL_CTRL_CERT_FLAGS:
2024 return (ctx->cert->cert_flags |= larg);
2025 case SSL_CTRL_CLEAR_CERT_FLAGS:
2026 return (ctx->cert->cert_flags &= ~larg);
2027 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2028 return ssl_set_version_bound(ctx->method->version, (int)larg,
2029 &ctx->min_proto_version);
2030 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2031 return ssl_set_version_bound(ctx->method->version, (int)larg,
2032 &ctx->max_proto_version);
2034 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2038 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2041 case SSL_CTRL_SET_MSG_CALLBACK:
2042 ctx->msg_callback = (void (*)
2043 (int write_p, int version, int content_type,
2044 const void *buf, size_t len, SSL *ssl,
2049 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2053 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2062 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2063 const SSL_CIPHER *const *bp)
2065 if ((*ap)->id > (*bp)->id)
2067 if ((*ap)->id < (*bp)->id)
2072 /** return a STACK of the ciphers available for the SSL and in order of
2074 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2077 if (s->cipher_list != NULL) {
2078 return (s->cipher_list);
2079 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2080 return (s->ctx->cipher_list);
2086 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2088 if ((s == NULL) || (s->session == NULL) || !s->server)
2090 return s->session->ciphers;
2093 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2095 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2097 ciphers = SSL_get_ciphers(s);
2100 ssl_set_client_disabled(s);
2101 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2102 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2103 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
2105 sk = sk_SSL_CIPHER_new_null();
2108 if (!sk_SSL_CIPHER_push(sk, c)) {
2109 sk_SSL_CIPHER_free(sk);
2117 /** return a STACK of the ciphers available for the SSL and in order of
2119 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2122 if (s->cipher_list_by_id != NULL) {
2123 return (s->cipher_list_by_id);
2124 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2125 return (s->ctx->cipher_list_by_id);
2131 /** The old interface to get the same thing as SSL_get_ciphers() */
2132 const char *SSL_get_cipher_list(const SSL *s, int n)
2134 const SSL_CIPHER *c;
2135 STACK_OF(SSL_CIPHER) *sk;
2139 sk = SSL_get_ciphers(s);
2140 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2142 c = sk_SSL_CIPHER_value(sk, n);
2148 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2150 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2153 return ctx->cipher_list;
2157 /** specify the ciphers to be used by default by the SSL_CTX */
2158 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2160 STACK_OF(SSL_CIPHER) *sk;
2162 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2163 &ctx->cipher_list_by_id, str, ctx->cert);
2165 * ssl_create_cipher_list may return an empty stack if it was unable to
2166 * find a cipher matching the given rule string (for example if the rule
2167 * string specifies a cipher which has been disabled). This is not an
2168 * error as far as ssl_create_cipher_list is concerned, and hence
2169 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2173 else if (sk_SSL_CIPHER_num(sk) == 0) {
2174 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2180 /** specify the ciphers to be used by the SSL */
2181 int SSL_set_cipher_list(SSL *s, const char *str)
2183 STACK_OF(SSL_CIPHER) *sk;
2185 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2186 &s->cipher_list_by_id, str, s->cert);
2187 /* see comment in SSL_CTX_set_cipher_list */
2190 else if (sk_SSL_CIPHER_num(sk) == 0) {
2191 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2197 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2200 STACK_OF(SSL_CIPHER) *sk;
2201 const SSL_CIPHER *c;
2204 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2208 sk = s->session->ciphers;
2210 if (sk_SSL_CIPHER_num(sk) == 0)
2213 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2216 c = sk_SSL_CIPHER_value(sk, i);
2217 n = strlen(c->name);
2224 memcpy(p, c->name, n + 1);
2233 /** return a servername extension value if provided in Client Hello, or NULL.
2234 * So far, only host_name types are defined (RFC 3546).
2237 const char *SSL_get_servername(const SSL *s, const int type)
2239 if (type != TLSEXT_NAMETYPE_host_name)
2242 return s->session && !s->ext.hostname ?
2243 s->session->ext.hostname : s->ext.hostname;
2246 int SSL_get_servername_type(const SSL *s)
2249 && (!s->ext.hostname ? s->session->
2250 ext.hostname : s->ext.hostname))
2251 return TLSEXT_NAMETYPE_host_name;
2256 * SSL_select_next_proto implements the standard protocol selection. It is
2257 * expected that this function is called from the callback set by
2258 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2259 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2260 * not included in the length. A byte string of length 0 is invalid. No byte
2261 * string may be truncated. The current, but experimental algorithm for
2262 * selecting the protocol is: 1) If the server doesn't support NPN then this
2263 * is indicated to the callback. In this case, the client application has to
2264 * abort the connection or have a default application level protocol. 2) If
2265 * the server supports NPN, but advertises an empty list then the client
2266 * selects the first protocol in its list, but indicates via the API that this
2267 * fallback case was enacted. 3) Otherwise, the client finds the first
2268 * protocol in the server's list that it supports and selects this protocol.
2269 * This is because it's assumed that the server has better information about
2270 * which protocol a client should use. 4) If the client doesn't support any
2271 * of the server's advertised protocols, then this is treated the same as
2272 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2273 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2275 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2276 const unsigned char *server,
2277 unsigned int server_len,
2278 const unsigned char *client, unsigned int client_len)
2281 const unsigned char *result;
2282 int status = OPENSSL_NPN_UNSUPPORTED;
2285 * For each protocol in server preference order, see if we support it.
2287 for (i = 0; i < server_len;) {
2288 for (j = 0; j < client_len;) {
2289 if (server[i] == client[j] &&
2290 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2291 /* We found a match */
2292 result = &server[i];
2293 status = OPENSSL_NPN_NEGOTIATED;
2303 /* There's no overlap between our protocols and the server's list. */
2305 status = OPENSSL_NPN_NO_OVERLAP;
2308 *out = (unsigned char *)result + 1;
2309 *outlen = result[0];
2313 #ifndef OPENSSL_NO_NEXTPROTONEG
2315 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2316 * client's requested protocol for this connection and returns 0. If the
2317 * client didn't request any protocol, then *data is set to NULL. Note that
2318 * the client can request any protocol it chooses. The value returned from
2319 * this function need not be a member of the list of supported protocols
2320 * provided by the callback.
2322 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2329 *len = (unsigned int)s->ext.npn_len;
2334 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2335 * a TLS server needs a list of supported protocols for Next Protocol
2336 * Negotiation. The returned list must be in wire format. The list is
2337 * returned by setting |out| to point to it and |outlen| to its length. This
2338 * memory will not be modified, but one should assume that the SSL* keeps a
2339 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2340 * wishes to advertise. Otherwise, no such extension will be included in the
2343 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2344 SSL_CTX_npn_advertised_cb_func cb,
2347 ctx->ext.npn_advertised_cb = cb;
2348 ctx->ext.npn_advertised_cb_arg = arg;
2352 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2353 * client needs to select a protocol from the server's provided list. |out|
2354 * must be set to point to the selected protocol (which may be within |in|).
2355 * The length of the protocol name must be written into |outlen|. The
2356 * server's advertised protocols are provided in |in| and |inlen|. The
2357 * callback can assume that |in| is syntactically valid. The client must
2358 * select a protocol. It is fatal to the connection if this callback returns
2359 * a value other than SSL_TLSEXT_ERR_OK.
2361 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2362 SSL_CTX_npn_select_cb_func cb,
2365 ctx->ext.npn_select_cb = cb;
2366 ctx->ext.npn_select_cb_arg = arg;
2371 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2372 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2373 * length-prefixed strings). Returns 0 on success.
2375 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2376 unsigned int protos_len)
2378 OPENSSL_free(ctx->ext.alpn);
2379 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2380 if (ctx->ext.alpn == NULL) {
2381 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2384 ctx->ext.alpn_len = protos_len;
2390 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2391 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2392 * length-prefixed strings). Returns 0 on success.
2394 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2395 unsigned int protos_len)
2397 OPENSSL_free(ssl->ext.alpn);
2398 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2399 if (ssl->ext.alpn == NULL) {
2400 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2403 ssl->ext.alpn_len = protos_len;
2409 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2410 * called during ClientHello processing in order to select an ALPN protocol
2411 * from the client's list of offered protocols.
2413 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2414 SSL_CTX_alpn_select_cb_func cb,
2417 ctx->ext.alpn_select_cb = cb;
2418 ctx->ext.alpn_select_cb_arg = arg;
2422 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2423 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2424 * (not including the leading length-prefix byte). If the server didn't
2425 * respond with a negotiated protocol then |*len| will be zero.
2427 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2432 *data = ssl->s3->alpn_selected;
2436 *len = (unsigned int)ssl->s3->alpn_selected_len;
2439 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2440 const char *label, size_t llen,
2441 const unsigned char *p, size_t plen,
2444 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2447 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2452 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2454 const unsigned char *session_id = a->session_id;
2456 unsigned char tmp_storage[4];
2458 if (a->session_id_length < sizeof(tmp_storage)) {
2459 memset(tmp_storage, 0, sizeof(tmp_storage));
2460 memcpy(tmp_storage, a->session_id, a->session_id_length);
2461 session_id = tmp_storage;
2465 ((unsigned long)session_id[0]) |
2466 ((unsigned long)session_id[1] << 8L) |
2467 ((unsigned long)session_id[2] << 16L) |
2468 ((unsigned long)session_id[3] << 24L);
2473 * NB: If this function (or indeed the hash function which uses a sort of
2474 * coarser function than this one) is changed, ensure
2475 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2476 * being able to construct an SSL_SESSION that will collide with any existing
2477 * session with a matching session ID.
2479 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2481 if (a->ssl_version != b->ssl_version)
2483 if (a->session_id_length != b->session_id_length)
2485 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2489 * These wrapper functions should remain rather than redeclaring
2490 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2491 * variable. The reason is that the functions aren't static, they're exposed
2495 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2497 SSL_CTX *ret = NULL;
2500 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2504 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2507 if (FIPS_mode() && (meth->version < TLS1_VERSION)) {
2508 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE);
2512 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2513 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2516 ret = OPENSSL_zalloc(sizeof(*ret));
2521 ret->min_proto_version = 0;
2522 ret->max_proto_version = 0;
2523 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2524 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2525 /* We take the system default. */
2526 ret->session_timeout = meth->get_timeout();
2527 ret->references = 1;
2528 ret->lock = CRYPTO_THREAD_lock_new();
2529 if (ret->lock == NULL) {
2530 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2534 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2535 ret->verify_mode = SSL_VERIFY_NONE;
2536 if ((ret->cert = ssl_cert_new()) == NULL)
2539 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2540 if (ret->sessions == NULL)
2542 ret->cert_store = X509_STORE_new();
2543 if (ret->cert_store == NULL)
2545 #ifndef OPENSSL_NO_CT
2546 ret->ctlog_store = CTLOG_STORE_new();
2547 if (ret->ctlog_store == NULL)
2550 if (!ssl_create_cipher_list(ret->method,
2551 &ret->cipher_list, &ret->cipher_list_by_id,
2552 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2553 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2554 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2558 ret->param = X509_VERIFY_PARAM_new();
2559 if (ret->param == NULL)
2562 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2563 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2566 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2567 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2571 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2574 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2577 /* No compression for DTLS */
2578 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2579 ret->comp_methods = SSL_COMP_get_compression_methods();
2581 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2582 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2584 /* Setup RFC5077 ticket keys */
2585 if ((RAND_bytes(ret->ext.tick_key_name,
2586 sizeof(ret->ext.tick_key_name)) <= 0)
2587 || (RAND_bytes(ret->ext.tick_hmac_key,
2588 sizeof(ret->ext.tick_hmac_key)) <= 0)
2589 || (RAND_bytes(ret->ext.tick_aes_key,
2590 sizeof(ret->ext.tick_aes_key)) <= 0))
2591 ret->options |= SSL_OP_NO_TICKET;
2593 #ifndef OPENSSL_NO_SRP
2594 if (!SSL_CTX_SRP_CTX_init(ret))
2597 #ifndef OPENSSL_NO_ENGINE
2598 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2599 # define eng_strx(x) #x
2600 # define eng_str(x) eng_strx(x)
2601 /* Use specific client engine automatically... ignore errors */
2604 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2607 ENGINE_load_builtin_engines();
2608 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2610 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2616 * Default is to connect to non-RI servers. When RI is more widely
2617 * deployed might change this.
2619 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2621 * Disable compression by default to prevent CRIME. Applications can
2622 * re-enable compression by configuring
2623 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2624 * or by using the SSL_CONF library.
2626 ret->options |= SSL_OP_NO_COMPRESSION;
2628 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2632 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2638 int SSL_CTX_up_ref(SSL_CTX *ctx)
2642 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2645 REF_PRINT_COUNT("SSL_CTX", ctx);
2646 REF_ASSERT_ISNT(i < 2);
2647 return ((i > 1) ? 1 : 0);
2650 void SSL_CTX_free(SSL_CTX *a)
2657 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2658 REF_PRINT_COUNT("SSL_CTX", a);
2661 REF_ASSERT_ISNT(i < 0);
2663 X509_VERIFY_PARAM_free(a->param);
2664 dane_ctx_final(&a->dane);
2667 * Free internal session cache. However: the remove_cb() may reference
2668 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2669 * after the sessions were flushed.
2670 * As the ex_data handling routines might also touch the session cache,
2671 * the most secure solution seems to be: empty (flush) the cache, then
2672 * free ex_data, then finally free the cache.
2673 * (See ticket [openssl.org #212].)
2675 if (a->sessions != NULL)
2676 SSL_CTX_flush_sessions(a, 0);
2678 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2679 lh_SSL_SESSION_free(a->sessions);
2680 X509_STORE_free(a->cert_store);
2681 #ifndef OPENSSL_NO_CT
2682 CTLOG_STORE_free(a->ctlog_store);
2684 sk_SSL_CIPHER_free(a->cipher_list);
2685 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2686 ssl_cert_free(a->cert);
2687 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2688 sk_X509_pop_free(a->extra_certs, X509_free);
2689 a->comp_methods = NULL;
2690 #ifndef OPENSSL_NO_SRTP
2691 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2693 #ifndef OPENSSL_NO_SRP
2694 SSL_CTX_SRP_CTX_free(a);
2696 #ifndef OPENSSL_NO_ENGINE
2697 ENGINE_finish(a->client_cert_engine);
2700 #ifndef OPENSSL_NO_EC
2701 OPENSSL_free(a->ext.ecpointformats);
2702 OPENSSL_free(a->ext.supportedgroups);
2704 OPENSSL_free(a->ext.alpn);
2706 CRYPTO_THREAD_lock_free(a->lock);
2711 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2713 ctx->default_passwd_callback = cb;
2716 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2718 ctx->default_passwd_callback_userdata = u;
2721 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2723 return ctx->default_passwd_callback;
2726 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2728 return ctx->default_passwd_callback_userdata;
2731 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2733 s->default_passwd_callback = cb;
2736 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2738 s->default_passwd_callback_userdata = u;
2741 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2743 return s->default_passwd_callback;
2746 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2748 return s->default_passwd_callback_userdata;
2751 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2752 int (*cb) (X509_STORE_CTX *, void *),
2755 ctx->app_verify_callback = cb;
2756 ctx->app_verify_arg = arg;
2759 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2760 int (*cb) (int, X509_STORE_CTX *))
2762 ctx->verify_mode = mode;
2763 ctx->default_verify_callback = cb;
2766 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2768 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2771 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2773 ssl_cert_set_cert_cb(c->cert, cb, arg);
2776 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2778 ssl_cert_set_cert_cb(s->cert, cb, arg);
2781 void ssl_set_masks(SSL *s)
2784 uint32_t *pvalid = s->s3->tmp.valid_flags;
2785 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2786 unsigned long mask_k, mask_a;
2787 #ifndef OPENSSL_NO_EC
2788 int have_ecc_cert, ecdsa_ok;
2793 #ifndef OPENSSL_NO_DH
2794 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2799 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2800 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2801 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
2802 #ifndef OPENSSL_NO_EC
2803 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2809 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2810 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2813 #ifndef OPENSSL_NO_GOST
2814 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2815 mask_k |= SSL_kGOST;
2816 mask_a |= SSL_aGOST12;
2818 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2819 mask_k |= SSL_kGOST;
2820 mask_a |= SSL_aGOST12;
2822 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2823 mask_k |= SSL_kGOST;
2824 mask_a |= SSL_aGOST01;
2834 if (rsa_enc || rsa_sign) {
2842 mask_a |= SSL_aNULL;
2845 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2846 * depending on the key usage extension.
2848 #ifndef OPENSSL_NO_EC
2849 if (have_ecc_cert) {
2851 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
2852 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2853 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2856 mask_a |= SSL_aECDSA;
2860 #ifndef OPENSSL_NO_EC
2861 mask_k |= SSL_kECDHE;
2864 #ifndef OPENSSL_NO_PSK
2867 if (mask_k & SSL_kRSA)
2868 mask_k |= SSL_kRSAPSK;
2869 if (mask_k & SSL_kDHE)
2870 mask_k |= SSL_kDHEPSK;
2871 if (mask_k & SSL_kECDHE)
2872 mask_k |= SSL_kECDHEPSK;
2875 s->s3->tmp.mask_k = mask_k;
2876 s->s3->tmp.mask_a = mask_a;
2879 #ifndef OPENSSL_NO_EC
2881 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
2883 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
2884 /* key usage, if present, must allow signing */
2885 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
2886 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
2887 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
2891 return 1; /* all checks are ok */
2896 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
2897 size_t *serverinfo_length)
2899 CERT_PKEY *cpk = s->s3->tmp.cert;
2900 *serverinfo_length = 0;
2902 if (cpk == NULL || cpk->serverinfo == NULL)
2905 *serverinfo = cpk->serverinfo;
2906 *serverinfo_length = cpk->serverinfo_length;
2910 void ssl_update_cache(SSL *s, int mode)
2915 * If the session_id_length is 0, we are not supposed to cache it, and it
2916 * would be rather hard to do anyway :-)
2918 if (s->session->session_id_length == 0)
2921 i = s->session_ctx->session_cache_mode;
2922 if ((i & mode) && (!s->hit)
2923 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
2924 || SSL_CTX_add_session(s->session_ctx, s->session))
2925 && (s->session_ctx->new_session_cb != NULL)) {
2926 SSL_SESSION_up_ref(s->session);
2927 if (!s->session_ctx->new_session_cb(s, s->session))
2928 SSL_SESSION_free(s->session);
2931 /* auto flush every 255 connections */
2932 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
2933 if ((((mode & SSL_SESS_CACHE_CLIENT)
2934 ? s->session_ctx->stats.sess_connect_good
2935 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
2936 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
2941 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
2946 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
2951 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
2955 if (s->method != meth) {
2956 const SSL_METHOD *sm = s->method;
2957 int (*hf) (SSL *) = s->handshake_func;
2959 if (sm->version == meth->version)
2964 ret = s->method->ssl_new(s);
2967 if (hf == sm->ssl_connect)
2968 s->handshake_func = meth->ssl_connect;
2969 else if (hf == sm->ssl_accept)
2970 s->handshake_func = meth->ssl_accept;
2975 int SSL_get_error(const SSL *s, int i)
2982 return (SSL_ERROR_NONE);
2985 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
2986 * where we do encode the error
2988 if ((l = ERR_peek_error()) != 0) {
2989 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
2990 return (SSL_ERROR_SYSCALL);
2992 return (SSL_ERROR_SSL);
2995 if (SSL_want_read(s)) {
2996 bio = SSL_get_rbio(s);
2997 if (BIO_should_read(bio))
2998 return (SSL_ERROR_WANT_READ);
2999 else if (BIO_should_write(bio))
3001 * This one doesn't make too much sense ... We never try to write
3002 * to the rbio, and an application program where rbio and wbio
3003 * are separate couldn't even know what it should wait for.
3004 * However if we ever set s->rwstate incorrectly (so that we have
3005 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3006 * wbio *are* the same, this test works around that bug; so it
3007 * might be safer to keep it.
3009 return (SSL_ERROR_WANT_WRITE);
3010 else if (BIO_should_io_special(bio)) {
3011 reason = BIO_get_retry_reason(bio);
3012 if (reason == BIO_RR_CONNECT)
3013 return (SSL_ERROR_WANT_CONNECT);
3014 else if (reason == BIO_RR_ACCEPT)
3015 return (SSL_ERROR_WANT_ACCEPT);
3017 return (SSL_ERROR_SYSCALL); /* unknown */
3021 if (SSL_want_write(s)) {
3023 * Access wbio directly - in order to use the buffered bio if
3027 if (BIO_should_write(bio))
3028 return (SSL_ERROR_WANT_WRITE);
3029 else if (BIO_should_read(bio))
3031 * See above (SSL_want_read(s) with BIO_should_write(bio))
3033 return (SSL_ERROR_WANT_READ);
3034 else if (BIO_should_io_special(bio)) {
3035 reason = BIO_get_retry_reason(bio);
3036 if (reason == BIO_RR_CONNECT)
3037 return (SSL_ERROR_WANT_CONNECT);
3038 else if (reason == BIO_RR_ACCEPT)
3039 return (SSL_ERROR_WANT_ACCEPT);
3041 return (SSL_ERROR_SYSCALL);
3044 if (SSL_want_x509_lookup(s))
3045 return (SSL_ERROR_WANT_X509_LOOKUP);
3046 if (SSL_want_async(s))
3047 return SSL_ERROR_WANT_ASYNC;
3048 if (SSL_want_async_job(s))
3049 return SSL_ERROR_WANT_ASYNC_JOB;
3050 if (SSL_want_early(s))
3051 return SSL_ERROR_WANT_EARLY;
3053 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3054 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3055 return (SSL_ERROR_ZERO_RETURN);
3057 return (SSL_ERROR_SYSCALL);
3060 static int ssl_do_handshake_intern(void *vargs)
3062 struct ssl_async_args *args;
3065 args = (struct ssl_async_args *)vargs;
3068 return s->handshake_func(s);
3071 int SSL_do_handshake(SSL *s)
3075 if (s->handshake_func == NULL) {
3076 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3080 s->method->ssl_renegotiate_check(s, 0);
3082 if (SSL_in_init(s) || SSL_in_before(s)) {
3083 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3084 struct ssl_async_args args;
3088 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3090 ret = s->handshake_func(s);
3096 void SSL_set_accept_state(SSL *s)
3100 ossl_statem_clear(s);
3101 s->handshake_func = s->method->ssl_accept;
3105 void SSL_set_connect_state(SSL *s)
3109 ossl_statem_clear(s);
3110 s->handshake_func = s->method->ssl_connect;
3114 int ssl_undefined_function(SSL *s)
3116 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3120 int ssl_undefined_void_function(void)
3122 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3123 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3127 int ssl_undefined_const_function(const SSL *s)
3132 const SSL_METHOD *ssl_bad_method(int ver)
3134 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3138 const char *ssl_protocol_to_string(int version)
3142 case TLS1_3_VERSION:
3145 case TLS1_2_VERSION:
3148 case TLS1_1_VERSION:
3163 case DTLS1_2_VERSION:
3171 const char *SSL_get_version(const SSL *s)
3173 return ssl_protocol_to_string(s->version);
3176 SSL *SSL_dup(SSL *s)
3178 STACK_OF(X509_NAME) *sk;
3183 /* If we're not quiescent, just up_ref! */
3184 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3185 CRYPTO_UP_REF(&s->references, &i, s->lock);
3190 * Otherwise, copy configuration state, and session if set.
3192 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3195 if (s->session != NULL) {
3197 * Arranges to share the same session via up_ref. This "copies"
3198 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3200 if (!SSL_copy_session_id(ret, s))
3204 * No session has been established yet, so we have to expect that
3205 * s->cert or ret->cert will be changed later -- they should not both
3206 * point to the same object, and thus we can't use
3207 * SSL_copy_session_id.
3209 if (!SSL_set_ssl_method(ret, s->method))
3212 if (s->cert != NULL) {
3213 ssl_cert_free(ret->cert);
3214 ret->cert = ssl_cert_dup(s->cert);
3215 if (ret->cert == NULL)
3219 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3220 (int)s->sid_ctx_length))
3224 if (!ssl_dane_dup(ret, s))
3226 ret->version = s->version;
3227 ret->options = s->options;
3228 ret->mode = s->mode;
3229 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3230 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3231 ret->msg_callback = s->msg_callback;
3232 ret->msg_callback_arg = s->msg_callback_arg;
3233 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3234 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3235 ret->generate_session_id = s->generate_session_id;
3237 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3239 /* copy app data, a little dangerous perhaps */
3240 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3243 /* setup rbio, and wbio */
3244 if (s->rbio != NULL) {
3245 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3248 if (s->wbio != NULL) {
3249 if (s->wbio != s->rbio) {
3250 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3253 BIO_up_ref(ret->rbio);
3254 ret->wbio = ret->rbio;
3258 ret->server = s->server;
3259 if (s->handshake_func) {
3261 SSL_set_accept_state(ret);
3263 SSL_set_connect_state(ret);
3265 ret->shutdown = s->shutdown;
3268 ret->default_passwd_callback = s->default_passwd_callback;
3269 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3271 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3273 /* dup the cipher_list and cipher_list_by_id stacks */
3274 if (s->cipher_list != NULL) {
3275 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3278 if (s->cipher_list_by_id != NULL)
3279 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3283 /* Dup the client_CA list */
3284 if (s->client_CA != NULL) {
3285 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3287 ret->client_CA = sk;
3288 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3289 xn = sk_X509_NAME_value(sk, i);
3290 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3303 void ssl_clear_cipher_ctx(SSL *s)
3305 if (s->enc_read_ctx != NULL) {
3306 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3307 s->enc_read_ctx = NULL;
3309 if (s->enc_write_ctx != NULL) {
3310 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3311 s->enc_write_ctx = NULL;
3313 #ifndef OPENSSL_NO_COMP
3314 COMP_CTX_free(s->expand);
3316 COMP_CTX_free(s->compress);
3321 X509 *SSL_get_certificate(const SSL *s)
3323 if (s->cert != NULL)
3324 return (s->cert->key->x509);
3329 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3331 if (s->cert != NULL)
3332 return (s->cert->key->privatekey);
3337 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3339 if (ctx->cert != NULL)
3340 return ctx->cert->key->x509;
3345 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3347 if (ctx->cert != NULL)
3348 return ctx->cert->key->privatekey;
3353 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3355 if ((s->session != NULL) && (s->session->cipher != NULL))
3356 return (s->session->cipher);
3360 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3362 #ifndef OPENSSL_NO_COMP
3363 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3369 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3371 #ifndef OPENSSL_NO_COMP
3372 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3378 int ssl_init_wbio_buffer(SSL *s)
3382 if (s->bbio != NULL) {
3383 /* Already buffered. */
3387 bbio = BIO_new(BIO_f_buffer());
3388 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3390 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3394 s->wbio = BIO_push(bbio, s->wbio);
3399 void ssl_free_wbio_buffer(SSL *s)
3401 /* callers ensure s is never null */
3402 if (s->bbio == NULL)
3405 s->wbio = BIO_pop(s->wbio);
3406 assert(s->wbio != NULL);
3411 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3413 ctx->quiet_shutdown = mode;
3416 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3418 return (ctx->quiet_shutdown);
3421 void SSL_set_quiet_shutdown(SSL *s, int mode)
3423 s->quiet_shutdown = mode;
3426 int SSL_get_quiet_shutdown(const SSL *s)
3428 return (s->quiet_shutdown);
3431 void SSL_set_shutdown(SSL *s, int mode)
3436 int SSL_get_shutdown(const SSL *s)
3441 int SSL_version(const SSL *s)
3446 int SSL_client_version(const SSL *s)
3448 return s->client_version;
3451 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3456 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3459 if (ssl->ctx == ctx)
3462 ctx = ssl->session_ctx;
3463 new_cert = ssl_cert_dup(ctx->cert);
3464 if (new_cert == NULL) {
3467 ssl_cert_free(ssl->cert);
3468 ssl->cert = new_cert;
3471 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3472 * so setter APIs must prevent invalid lengths from entering the system.
3474 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3477 * If the session ID context matches that of the parent SSL_CTX,
3478 * inherit it from the new SSL_CTX as well. If however the context does
3479 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3480 * leave it unchanged.
3482 if ((ssl->ctx != NULL) &&
3483 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3484 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3485 ssl->sid_ctx_length = ctx->sid_ctx_length;
3486 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3489 SSL_CTX_up_ref(ctx);
3490 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3496 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3498 return (X509_STORE_set_default_paths(ctx->cert_store));
3501 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3503 X509_LOOKUP *lookup;
3505 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3508 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3510 /* Clear any errors if the default directory does not exist */
3516 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3518 X509_LOOKUP *lookup;
3520 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3524 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3526 /* Clear any errors if the default file does not exist */
3532 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3535 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3538 void SSL_set_info_callback(SSL *ssl,
3539 void (*cb) (const SSL *ssl, int type, int val))
3541 ssl->info_callback = cb;
3545 * One compiler (Diab DCC) doesn't like argument names in returned function
3548 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3551 return ssl->info_callback;
3554 void SSL_set_verify_result(SSL *ssl, long arg)
3556 ssl->verify_result = arg;
3559 long SSL_get_verify_result(const SSL *ssl)
3561 return (ssl->verify_result);
3564 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3567 return sizeof(ssl->s3->client_random);
3568 if (outlen > sizeof(ssl->s3->client_random))
3569 outlen = sizeof(ssl->s3->client_random);
3570 memcpy(out, ssl->s3->client_random, outlen);
3574 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3577 return sizeof(ssl->s3->server_random);
3578 if (outlen > sizeof(ssl->s3->server_random))
3579 outlen = sizeof(ssl->s3->server_random);
3580 memcpy(out, ssl->s3->server_random, outlen);
3584 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3585 unsigned char *out, size_t outlen)
3588 return session->master_key_length;
3589 if (outlen > session->master_key_length)
3590 outlen = session->master_key_length;
3591 memcpy(out, session->master_key, outlen);
3595 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3597 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3600 void *SSL_get_ex_data(const SSL *s, int idx)
3602 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3605 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3607 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3610 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3612 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3620 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3622 return (ctx->cert_store);
3625 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3627 X509_STORE_free(ctx->cert_store);
3628 ctx->cert_store = store;
3631 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3634 X509_STORE_up_ref(store);
3635 SSL_CTX_set_cert_store(ctx, store);
3638 int SSL_want(const SSL *s)
3640 return (s->rwstate);
3644 * \brief Set the callback for generating temporary DH keys.
3645 * \param ctx the SSL context.
3646 * \param dh the callback
3649 #ifndef OPENSSL_NO_DH
3650 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3651 DH *(*dh) (SSL *ssl, int is_export,
3654 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3657 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3660 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3664 #ifndef OPENSSL_NO_PSK
3665 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3667 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3668 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3671 OPENSSL_free(ctx->cert->psk_identity_hint);
3672 if (identity_hint != NULL) {
3673 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3674 if (ctx->cert->psk_identity_hint == NULL)
3677 ctx->cert->psk_identity_hint = NULL;
3681 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3686 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3687 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3690 OPENSSL_free(s->cert->psk_identity_hint);
3691 if (identity_hint != NULL) {
3692 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3693 if (s->cert->psk_identity_hint == NULL)
3696 s->cert->psk_identity_hint = NULL;
3700 const char *SSL_get_psk_identity_hint(const SSL *s)
3702 if (s == NULL || s->session == NULL)
3704 return (s->session->psk_identity_hint);
3707 const char *SSL_get_psk_identity(const SSL *s)
3709 if (s == NULL || s->session == NULL)
3711 return (s->session->psk_identity);
3714 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3716 s->psk_client_callback = cb;
3719 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3721 ctx->psk_client_callback = cb;
3724 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3726 s->psk_server_callback = cb;
3729 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3731 ctx->psk_server_callback = cb;
3735 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3736 void (*cb) (int write_p, int version,
3737 int content_type, const void *buf,
3738 size_t len, SSL *ssl, void *arg))
3740 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3743 void SSL_set_msg_callback(SSL *ssl,
3744 void (*cb) (int write_p, int version,
3745 int content_type, const void *buf,
3746 size_t len, SSL *ssl, void *arg))
3748 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3751 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3752 int (*cb) (SSL *ssl,
3756 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3757 (void (*)(void))cb);
3760 void SSL_set_not_resumable_session_callback(SSL *ssl,
3761 int (*cb) (SSL *ssl,
3762 int is_forward_secure))
3764 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3765 (void (*)(void))cb);
3769 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3770 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3771 * If EVP_MD pointer is passed, initializes ctx with this md.
3772 * Returns the newly allocated ctx;
3775 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3777 ssl_clear_hash_ctx(hash);
3778 *hash = EVP_MD_CTX_new();
3779 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3780 EVP_MD_CTX_free(*hash);
3787 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3790 EVP_MD_CTX_free(*hash);
3794 /* Retrieve handshake hashes */
3795 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3798 EVP_MD_CTX *ctx = NULL;
3799 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3800 int hashleni = EVP_MD_CTX_size(hdgst);
3803 if (hashleni < 0 || (size_t)hashleni > outlen)
3806 ctx = EVP_MD_CTX_new();
3810 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3811 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3814 *hashlen = hashleni;
3818 EVP_MD_CTX_free(ctx);
3822 int SSL_session_reused(SSL *s)
3827 int SSL_is_server(SSL *s)
3832 #if OPENSSL_API_COMPAT < 0x10100000L
3833 void SSL_set_debug(SSL *s, int debug)
3835 /* Old function was do-nothing anyway... */
3841 void SSL_set_security_level(SSL *s, int level)
3843 s->cert->sec_level = level;
3846 int SSL_get_security_level(const SSL *s)
3848 return s->cert->sec_level;
3851 void SSL_set_security_callback(SSL *s,
3852 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3853 int op, int bits, int nid,
3854 void *other, void *ex))
3856 s->cert->sec_cb = cb;
3859 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
3860 const SSL_CTX *ctx, int op,
3861 int bits, int nid, void *other,
3863 return s->cert->sec_cb;
3866 void SSL_set0_security_ex_data(SSL *s, void *ex)
3868 s->cert->sec_ex = ex;
3871 void *SSL_get0_security_ex_data(const SSL *s)
3873 return s->cert->sec_ex;
3876 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
3878 ctx->cert->sec_level = level;
3881 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
3883 return ctx->cert->sec_level;
3886 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
3887 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3888 int op, int bits, int nid,
3889 void *other, void *ex))
3891 ctx->cert->sec_cb = cb;
3894 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
3900 return ctx->cert->sec_cb;
3903 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
3905 ctx->cert->sec_ex = ex;
3908 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
3910 return ctx->cert->sec_ex;
3914 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3915 * can return unsigned long, instead of the generic long return value from the
3916 * control interface.
3918 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
3920 return ctx->options;
3923 unsigned long SSL_get_options(const SSL *s)
3928 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
3930 return ctx->options |= op;
3933 unsigned long SSL_set_options(SSL *s, unsigned long op)
3935 return s->options |= op;
3938 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
3940 return ctx->options &= ~op;
3943 unsigned long SSL_clear_options(SSL *s, unsigned long op)
3945 return s->options &= ~op;
3948 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
3950 return s->verified_chain;
3953 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
3955 #ifndef OPENSSL_NO_CT
3958 * Moves SCTs from the |src| stack to the |dst| stack.
3959 * The source of each SCT will be set to |origin|.
3960 * If |dst| points to a NULL pointer, a new stack will be created and owned by
3962 * Returns the number of SCTs moved, or a negative integer if an error occurs.
3964 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
3965 sct_source_t origin)
3971 *dst = sk_SCT_new_null();
3973 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
3978 while ((sct = sk_SCT_pop(src)) != NULL) {
3979 if (SCT_set_source(sct, origin) != 1)
3982 if (sk_SCT_push(*dst, sct) <= 0)
3990 sk_SCT_push(src, sct); /* Put the SCT back */
3995 * Look for data collected during ServerHello and parse if found.
3996 * Returns the number of SCTs extracted.
3998 static int ct_extract_tls_extension_scts(SSL *s)
4000 int scts_extracted = 0;
4002 if (s->ext.scts != NULL) {
4003 const unsigned char *p = s->ext.scts;
4004 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4006 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4008 SCT_LIST_free(scts);
4011 return scts_extracted;
4015 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4016 * contains an SCT X509 extension. They will be stored in |s->scts|.
4018 * - The number of SCTs extracted, assuming an OCSP response exists.
4019 * - 0 if no OCSP response exists or it contains no SCTs.
4020 * - A negative integer if an error occurs.
4022 static int ct_extract_ocsp_response_scts(SSL *s)
4024 # ifndef OPENSSL_NO_OCSP
4025 int scts_extracted = 0;
4026 const unsigned char *p;
4027 OCSP_BASICRESP *br = NULL;
4028 OCSP_RESPONSE *rsp = NULL;
4029 STACK_OF(SCT) *scts = NULL;
4032 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4035 p = s->ext.ocsp.resp;
4036 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4040 br = OCSP_response_get1_basic(rsp);
4044 for (i = 0; i < OCSP_resp_count(br); ++i) {
4045 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4051 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4053 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4054 if (scts_extracted < 0)
4058 SCT_LIST_free(scts);
4059 OCSP_BASICRESP_free(br);
4060 OCSP_RESPONSE_free(rsp);
4061 return scts_extracted;
4063 /* Behave as if no OCSP response exists */
4069 * Attempts to extract SCTs from the peer certificate.
4070 * Return the number of SCTs extracted, or a negative integer if an error
4073 static int ct_extract_x509v3_extension_scts(SSL *s)
4075 int scts_extracted = 0;
4076 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4079 STACK_OF(SCT) *scts =
4080 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4083 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4085 SCT_LIST_free(scts);
4088 return scts_extracted;
4092 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4093 * response (if it exists) and X509v3 extensions in the certificate.
4094 * Returns NULL if an error occurs.
4096 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4098 if (!s->scts_parsed) {
4099 if (ct_extract_tls_extension_scts(s) < 0 ||
4100 ct_extract_ocsp_response_scts(s) < 0 ||
4101 ct_extract_x509v3_extension_scts(s) < 0)
4111 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4112 const STACK_OF(SCT) *scts, void *unused_arg)
4117 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4118 const STACK_OF(SCT) *scts, void *unused_arg)
4120 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4123 for (i = 0; i < count; ++i) {
4124 SCT *sct = sk_SCT_value(scts, i);
4125 int status = SCT_get_validation_status(sct);
4127 if (status == SCT_VALIDATION_STATUS_VALID)
4130 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4134 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4138 * Since code exists that uses the custom extension handler for CT, look
4139 * for this and throw an error if they have already registered to use CT.
4141 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4142 TLSEXT_TYPE_signed_certificate_timestamp))
4144 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4145 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4149 if (callback != NULL) {
4151 * If we are validating CT, then we MUST accept SCTs served via OCSP
4153 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4157 s->ct_validation_callback = callback;
4158 s->ct_validation_callback_arg = arg;
4163 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4164 ssl_ct_validation_cb callback, void *arg)
4167 * Since code exists that uses the custom extension handler for CT, look for
4168 * this and throw an error if they have already registered to use CT.
4170 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4171 TLSEXT_TYPE_signed_certificate_timestamp))
4173 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4174 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4178 ctx->ct_validation_callback = callback;
4179 ctx->ct_validation_callback_arg = arg;
4183 int SSL_ct_is_enabled(const SSL *s)
4185 return s->ct_validation_callback != NULL;
4188 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4190 return ctx->ct_validation_callback != NULL;
4193 int ssl_validate_ct(SSL *s)
4196 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4198 SSL_DANE *dane = &s->dane;
4199 CT_POLICY_EVAL_CTX *ctx = NULL;
4200 const STACK_OF(SCT) *scts;
4203 * If no callback is set, the peer is anonymous, or its chain is invalid,
4204 * skip SCT validation - just return success. Applications that continue
4205 * handshakes without certificates, with unverified chains, or pinned leaf
4206 * certificates are outside the scope of the WebPKI and CT.
4208 * The above exclusions notwithstanding the vast majority of peers will
4209 * have rather ordinary certificate chains validated by typical
4210 * applications that perform certificate verification and therefore will
4211 * process SCTs when enabled.
4213 if (s->ct_validation_callback == NULL || cert == NULL ||
4214 s->verify_result != X509_V_OK ||
4215 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4219 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4220 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4222 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4223 switch (dane->mtlsa->usage) {
4224 case DANETLS_USAGE_DANE_TA:
4225 case DANETLS_USAGE_DANE_EE:
4230 ctx = CT_POLICY_EVAL_CTX_new();
4232 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4236 issuer = sk_X509_value(s->verified_chain, 1);
4237 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4238 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4239 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4240 CT_POLICY_EVAL_CTX_set_time(ctx, SSL_SESSION_get_time(SSL_get0_session(s)));
4242 scts = SSL_get0_peer_scts(s);
4245 * This function returns success (> 0) only when all the SCTs are valid, 0
4246 * when some are invalid, and < 0 on various internal errors (out of
4247 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4248 * reason to abort the handshake, that decision is up to the callback.
4249 * Therefore, we error out only in the unexpected case that the return
4250 * value is negative.
4252 * XXX: One might well argue that the return value of this function is an
4253 * unfortunate design choice. Its job is only to determine the validation
4254 * status of each of the provided SCTs. So long as it correctly separates
4255 * the wheat from the chaff it should return success. Failure in this case
4256 * ought to correspond to an inability to carry out its duties.
4258 if (SCT_LIST_validate(scts, ctx) < 0) {
4259 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4263 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4265 ret = 0; /* This function returns 0 on failure */
4268 CT_POLICY_EVAL_CTX_free(ctx);
4270 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4271 * failure return code here. Also the application may wish the complete
4272 * the handshake, and then disconnect cleanly at a higher layer, after
4273 * checking the verification status of the completed connection.
4275 * We therefore force a certificate verification failure which will be
4276 * visible via SSL_get_verify_result() and cached as part of any resumed
4279 * Note: the permissive callback is for information gathering only, always
4280 * returns success, and does not affect verification status. Only the
4281 * strict callback or a custom application-specified callback can trigger
4282 * connection failure or record a verification error.
4285 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4289 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4291 switch (validation_mode) {
4293 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4295 case SSL_CT_VALIDATION_PERMISSIVE:
4296 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4297 case SSL_CT_VALIDATION_STRICT:
4298 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4302 int SSL_enable_ct(SSL *s, int validation_mode)
4304 switch (validation_mode) {
4306 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4308 case SSL_CT_VALIDATION_PERMISSIVE:
4309 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4310 case SSL_CT_VALIDATION_STRICT:
4311 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4315 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4317 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4320 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4322 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4325 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4327 CTLOG_STORE_free(ctx->ctlog_store);
4328 ctx->ctlog_store = logs;
4331 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4333 return ctx->ctlog_store;
4336 #endif /* OPENSSL_NO_CT */
4338 void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn cb, void *arg)
4341 c->early_cb_arg = arg;
4344 int SSL_early_isv2(SSL *s)
4346 if (s->clienthello == NULL)
4348 return s->clienthello->isv2;
4351 unsigned int SSL_early_get0_legacy_version(SSL *s)
4353 if (s->clienthello == NULL)
4355 return s->clienthello->legacy_version;
4358 size_t SSL_early_get0_random(SSL *s, const unsigned char **out)
4360 if (s->clienthello == NULL)
4363 *out = s->clienthello->random;
4364 return SSL3_RANDOM_SIZE;
4367 size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out)
4369 if (s->clienthello == NULL)
4372 *out = s->clienthello->session_id;
4373 return s->clienthello->session_id_len;
4376 size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out)
4378 if (s->clienthello == NULL)
4381 *out = PACKET_data(&s->clienthello->ciphersuites);
4382 return PACKET_remaining(&s->clienthello->ciphersuites);
4385 size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out)
4387 if (s->clienthello == NULL)
4390 *out = s->clienthello->compressions;
4391 return s->clienthello->compressions_len;
4394 int SSL_early_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4400 if (s->clienthello == NULL)
4402 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4403 r = s->clienthello->pre_proc_exts + i;
4404 if (r->present && r->type == type) {
4406 *out = PACKET_data(&r->data);
4408 *outlen = PACKET_remaining(&r->data);
4415 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4417 ctx->keylog_callback = cb;
4420 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4422 return ctx->keylog_callback;
4425 static int nss_keylog_int(const char *prefix,
4427 const uint8_t *parameter_1,
4428 size_t parameter_1_len,
4429 const uint8_t *parameter_2,
4430 size_t parameter_2_len)
4433 char *cursor = NULL;
4438 if (ssl->ctx->keylog_callback == NULL) return 1;
4441 * Our output buffer will contain the following strings, rendered with
4442 * space characters in between, terminated by a NULL character: first the
4443 * prefix, then the first parameter, then the second parameter. The
4444 * meaning of each parameter depends on the specific key material being
4445 * logged. Note that the first and second parameters are encoded in
4446 * hexadecimal, so we need a buffer that is twice their lengths.
4448 prefix_len = strlen(prefix);
4449 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4450 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4451 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4455 strcpy(cursor, prefix);
4456 cursor += prefix_len;
4459 for (i = 0; i < parameter_1_len; i++) {
4460 sprintf(cursor, "%02x", parameter_1[i]);
4465 for (i = 0; i < parameter_2_len; i++) {
4466 sprintf(cursor, "%02x", parameter_2[i]);
4471 ssl->ctx->keylog_callback(ssl, (const char *)out);
4477 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4478 const uint8_t *encrypted_premaster,
4479 size_t encrypted_premaster_len,
4480 const uint8_t *premaster,
4481 size_t premaster_len)
4483 if (encrypted_premaster_len < 8) {
4484 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4488 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4489 return nss_keylog_int("RSA",
4491 encrypted_premaster,
4497 int ssl_log_secret(SSL *ssl,
4499 const uint8_t *secret,
4502 return nss_keylog_int(label,
4504 ssl->s3->client_random,
4510 #define SSLV2_CIPHER_LEN 3
4512 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format,
4517 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4519 if (PACKET_remaining(cipher_suites) == 0) {
4520 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST, SSL_R_NO_CIPHERS_SPECIFIED);
4521 *al = SSL_AD_ILLEGAL_PARAMETER;
4525 if (PACKET_remaining(cipher_suites) % n != 0) {
4526 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST,
4527 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4528 *al = SSL_AD_DECODE_ERROR;
4532 OPENSSL_free(s->s3->tmp.ciphers_raw);
4533 s->s3->tmp.ciphers_raw = NULL;
4534 s->s3->tmp.ciphers_rawlen = 0;
4537 size_t numciphers = PACKET_remaining(cipher_suites) / n;
4538 PACKET sslv2ciphers = *cipher_suites;
4539 unsigned int leadbyte;
4543 * We store the raw ciphers list in SSLv3+ format so we need to do some
4544 * preprocessing to convert the list first. If there are any SSLv2 only
4545 * ciphersuites with a non-zero leading byte then we are going to
4546 * slightly over allocate because we won't store those. But that isn't a
4549 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
4550 s->s3->tmp.ciphers_raw = raw;
4552 *al = SSL_AD_INTERNAL_ERROR;
4555 for (s->s3->tmp.ciphers_rawlen = 0;
4556 PACKET_remaining(&sslv2ciphers) > 0;
4557 raw += TLS_CIPHER_LEN) {
4558 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
4560 && !PACKET_copy_bytes(&sslv2ciphers, raw,
4563 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
4564 *al = SSL_AD_INTERNAL_ERROR;
4565 OPENSSL_free(s->s3->tmp.ciphers_raw);
4566 s->s3->tmp.ciphers_raw = NULL;
4567 s->s3->tmp.ciphers_rawlen = 0;
4571 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
4573 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
4574 &s->s3->tmp.ciphers_rawlen)) {
4575 *al = SSL_AD_INTERNAL_ERROR;
4583 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
4584 int isv2format, STACK_OF(SSL_CIPHER) **sk,
4585 STACK_OF(SSL_CIPHER) **scsvs)
4590 if (!PACKET_buf_init(&pkt, bytes, len))
4592 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, &alert);
4595 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
4596 STACK_OF(SSL_CIPHER) **skp,
4597 STACK_OF(SSL_CIPHER) **scsvs_out,
4598 int sslv2format, int *al)
4600 const SSL_CIPHER *c;
4601 STACK_OF(SSL_CIPHER) *sk = NULL;
4602 STACK_OF(SSL_CIPHER) *scsvs = NULL;
4604 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
4605 unsigned char cipher[SSLV2_CIPHER_LEN];
4607 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4609 if (PACKET_remaining(cipher_suites) == 0) {
4610 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
4611 *al = SSL_AD_ILLEGAL_PARAMETER;
4615 if (PACKET_remaining(cipher_suites) % n != 0) {
4616 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
4617 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4618 *al = SSL_AD_DECODE_ERROR;
4622 sk = sk_SSL_CIPHER_new_null();
4623 scsvs = sk_SSL_CIPHER_new_null();
4624 if (sk == NULL || scsvs == NULL) {
4625 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4626 *al = SSL_AD_INTERNAL_ERROR;
4630 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
4632 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
4633 * first byte set to zero, while true SSLv2 ciphers have a non-zero
4634 * first byte. We don't support any true SSLv2 ciphers, so skip them.
4636 if (sslv2format && cipher[0] != '\0')
4639 /* For SSLv2-compat, ignore leading 0-byte. */
4640 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
4642 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
4643 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
4644 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4645 *al = SSL_AD_INTERNAL_ERROR;
4650 if (PACKET_remaining(cipher_suites) > 0) {
4651 *al = SSL_AD_INTERNAL_ERROR;
4652 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_INTERNAL_ERROR);
4659 sk_SSL_CIPHER_free(sk);
4660 if (scsvs_out != NULL)
4663 sk_SSL_CIPHER_free(scsvs);
4666 sk_SSL_CIPHER_free(sk);
4667 sk_SSL_CIPHER_free(scsvs);