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;
554 s->max_early_data = ctx->max_early_data;
557 * Earlier library versions used to copy the pointer to the CERT, not
558 * its contents; only when setting new parameters for the per-SSL
559 * copy, ssl_cert_new would be called (and the direct reference to
560 * the per-SSL_CTX settings would be lost, but those still were
561 * indirectly accessed for various purposes, and for that reason they
562 * used to be known as s->ctx->default_cert). Now we don't look at the
563 * SSL_CTX's CERT after having duplicated it once.
565 s->cert = ssl_cert_dup(ctx->cert);
569 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
570 s->msg_callback = ctx->msg_callback;
571 s->msg_callback_arg = ctx->msg_callback_arg;
572 s->verify_mode = ctx->verify_mode;
573 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
574 s->sid_ctx_length = ctx->sid_ctx_length;
575 OPENSSL_assert(s->sid_ctx_length <= sizeof s->sid_ctx);
576 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
577 s->verify_callback = ctx->default_verify_callback;
578 s->generate_session_id = ctx->generate_session_id;
580 s->param = X509_VERIFY_PARAM_new();
581 if (s->param == NULL)
583 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
584 s->quiet_shutdown = ctx->quiet_shutdown;
585 s->max_send_fragment = ctx->max_send_fragment;
586 s->split_send_fragment = ctx->split_send_fragment;
587 s->max_pipelines = ctx->max_pipelines;
588 if (s->max_pipelines > 1)
589 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
590 if (ctx->default_read_buf_len > 0)
591 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
596 s->ext.debug_arg = NULL;
597 s->ext.ticket_expected = 0;
598 s->ext.status_type = ctx->ext.status_type;
599 s->ext.status_expected = 0;
600 s->ext.ocsp.ids = NULL;
601 s->ext.ocsp.exts = NULL;
602 s->ext.ocsp.resp = NULL;
603 s->ext.ocsp.resp_len = 0;
605 s->session_ctx = ctx;
606 #ifndef OPENSSL_NO_EC
607 if (ctx->ext.ecpointformats) {
608 s->ext.ecpointformats =
609 OPENSSL_memdup(ctx->ext.ecpointformats,
610 ctx->ext.ecpointformats_len);
611 if (!s->ext.ecpointformats)
613 s->ext.ecpointformats_len =
614 ctx->ext.ecpointformats_len;
616 if (ctx->ext.supportedgroups) {
617 s->ext.supportedgroups =
618 OPENSSL_memdup(ctx->ext.supportedgroups,
619 ctx->ext.supportedgroups_len);
620 if (!s->ext.supportedgroups)
622 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
625 #ifndef OPENSSL_NO_NEXTPROTONEG
629 if (s->ctx->ext.alpn) {
630 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
631 if (s->ext.alpn == NULL)
633 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
634 s->ext.alpn_len = s->ctx->ext.alpn_len;
637 s->verified_chain = NULL;
638 s->verify_result = X509_V_OK;
640 s->default_passwd_callback = ctx->default_passwd_callback;
641 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
643 s->method = ctx->method;
645 s->key_update = SSL_KEY_UPDATE_NONE;
647 if (!s->method->ssl_new(s))
650 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
655 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
658 #ifndef OPENSSL_NO_PSK
659 s->psk_client_callback = ctx->psk_client_callback;
660 s->psk_server_callback = ctx->psk_server_callback;
665 #ifndef OPENSSL_NO_CT
666 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
667 ctx->ct_validation_callback_arg))
674 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
678 int SSL_is_dtls(const SSL *s)
680 return SSL_IS_DTLS(s) ? 1 : 0;
683 int SSL_up_ref(SSL *s)
687 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
690 REF_PRINT_COUNT("SSL", s);
691 REF_ASSERT_ISNT(i < 2);
692 return ((i > 1) ? 1 : 0);
695 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
696 unsigned int sid_ctx_len)
698 if (sid_ctx_len > sizeof ctx->sid_ctx) {
699 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
700 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
703 ctx->sid_ctx_length = sid_ctx_len;
704 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
709 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
710 unsigned int sid_ctx_len)
712 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
713 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
714 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
717 ssl->sid_ctx_length = sid_ctx_len;
718 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
723 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
725 CRYPTO_THREAD_write_lock(ctx->lock);
726 ctx->generate_session_id = cb;
727 CRYPTO_THREAD_unlock(ctx->lock);
731 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
733 CRYPTO_THREAD_write_lock(ssl->lock);
734 ssl->generate_session_id = cb;
735 CRYPTO_THREAD_unlock(ssl->lock);
739 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
743 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
744 * we can "construct" a session to give us the desired check - ie. to
745 * find if there's a session in the hash table that would conflict with
746 * any new session built out of this id/id_len and the ssl_version in use
751 if (id_len > sizeof r.session_id)
754 r.ssl_version = ssl->version;
755 r.session_id_length = id_len;
756 memcpy(r.session_id, id, id_len);
758 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
759 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
760 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
764 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
766 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
769 int SSL_set_purpose(SSL *s, int purpose)
771 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
774 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
776 return X509_VERIFY_PARAM_set_trust(s->param, trust);
779 int SSL_set_trust(SSL *s, int trust)
781 return X509_VERIFY_PARAM_set_trust(s->param, trust);
784 int SSL_set1_host(SSL *s, const char *hostname)
786 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
789 int SSL_add1_host(SSL *s, const char *hostname)
791 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
794 void SSL_set_hostflags(SSL *s, unsigned int flags)
796 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
799 const char *SSL_get0_peername(SSL *s)
801 return X509_VERIFY_PARAM_get0_peername(s->param);
804 int SSL_CTX_dane_enable(SSL_CTX *ctx)
806 return dane_ctx_enable(&ctx->dane);
809 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
811 unsigned long orig = ctx->dane.flags;
813 ctx->dane.flags |= flags;
817 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
819 unsigned long orig = ctx->dane.flags;
821 ctx->dane.flags &= ~flags;
825 int SSL_dane_enable(SSL *s, const char *basedomain)
827 SSL_DANE *dane = &s->dane;
829 if (s->ctx->dane.mdmax == 0) {
830 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
833 if (dane->trecs != NULL) {
834 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
839 * Default SNI name. This rejects empty names, while set1_host below
840 * accepts them and disables host name checks. To avoid side-effects with
841 * invalid input, set the SNI name first.
843 if (s->ext.hostname == NULL) {
844 if (!SSL_set_tlsext_host_name(s, basedomain)) {
845 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
850 /* Primary RFC6125 reference identifier */
851 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
852 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
858 dane->dctx = &s->ctx->dane;
859 dane->trecs = sk_danetls_record_new_null();
861 if (dane->trecs == NULL) {
862 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
868 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
870 unsigned long orig = ssl->dane.flags;
872 ssl->dane.flags |= flags;
876 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
878 unsigned long orig = ssl->dane.flags;
880 ssl->dane.flags &= ~flags;
884 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
886 SSL_DANE *dane = &s->dane;
888 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
892 *mcert = dane->mcert;
894 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
899 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
900 uint8_t *mtype, unsigned const char **data, size_t *dlen)
902 SSL_DANE *dane = &s->dane;
904 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
908 *usage = dane->mtlsa->usage;
910 *selector = dane->mtlsa->selector;
912 *mtype = dane->mtlsa->mtype;
914 *data = dane->mtlsa->data;
916 *dlen = dane->mtlsa->dlen;
921 SSL_DANE *SSL_get0_dane(SSL *s)
926 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
927 uint8_t mtype, unsigned char *data, size_t dlen)
929 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
932 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
935 return dane_mtype_set(&ctx->dane, md, mtype, ord);
938 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
940 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
943 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
945 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
948 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
953 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
958 void SSL_certs_clear(SSL *s)
960 ssl_cert_clear_certs(s->cert);
963 void SSL_free(SSL *s)
970 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
971 REF_PRINT_COUNT("SSL", s);
974 REF_ASSERT_ISNT(i < 0);
976 X509_VERIFY_PARAM_free(s->param);
977 dane_final(&s->dane);
978 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
980 ssl_free_wbio_buffer(s);
982 BIO_free_all(s->wbio);
983 BIO_free_all(s->rbio);
985 BUF_MEM_free(s->init_buf);
987 /* add extra stuff */
988 sk_SSL_CIPHER_free(s->cipher_list);
989 sk_SSL_CIPHER_free(s->cipher_list_by_id);
991 /* Make the next call work :-) */
992 if (s->session != NULL) {
993 ssl_clear_bad_session(s);
994 SSL_SESSION_free(s->session);
999 ssl_cert_free(s->cert);
1000 /* Free up if allocated */
1002 OPENSSL_free(s->ext.hostname);
1003 SSL_CTX_free(s->session_ctx);
1004 #ifndef OPENSSL_NO_EC
1005 OPENSSL_free(s->ext.ecpointformats);
1006 OPENSSL_free(s->ext.supportedgroups);
1007 #endif /* OPENSSL_NO_EC */
1008 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1009 #ifndef OPENSSL_NO_OCSP
1010 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1012 #ifndef OPENSSL_NO_CT
1013 SCT_LIST_free(s->scts);
1014 OPENSSL_free(s->ext.scts);
1016 OPENSSL_free(s->ext.ocsp.resp);
1017 OPENSSL_free(s->ext.alpn);
1018 OPENSSL_free(s->clienthello);
1020 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1022 sk_X509_pop_free(s->verified_chain, X509_free);
1024 if (s->method != NULL)
1025 s->method->ssl_free(s);
1027 RECORD_LAYER_release(&s->rlayer);
1029 SSL_CTX_free(s->ctx);
1031 ASYNC_WAIT_CTX_free(s->waitctx);
1033 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1034 OPENSSL_free(s->ext.npn);
1037 #ifndef OPENSSL_NO_SRTP
1038 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1041 CRYPTO_THREAD_lock_free(s->lock);
1046 void SSL_set0_rbio(SSL *s, BIO *rbio)
1048 BIO_free_all(s->rbio);
1052 void SSL_set0_wbio(SSL *s, BIO *wbio)
1055 * If the output buffering BIO is still in place, remove it
1057 if (s->bbio != NULL)
1058 s->wbio = BIO_pop(s->wbio);
1060 BIO_free_all(s->wbio);
1063 /* Re-attach |bbio| to the new |wbio|. */
1064 if (s->bbio != NULL)
1065 s->wbio = BIO_push(s->bbio, s->wbio);
1068 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1071 * For historical reasons, this function has many different cases in
1072 * ownership handling.
1075 /* If nothing has changed, do nothing */
1076 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1080 * If the two arguments are equal then one fewer reference is granted by the
1081 * caller than we want to take
1083 if (rbio != NULL && rbio == wbio)
1087 * If only the wbio is changed only adopt one reference.
1089 if (rbio == SSL_get_rbio(s)) {
1090 SSL_set0_wbio(s, wbio);
1094 * There is an asymmetry here for historical reasons. If only the rbio is
1095 * changed AND the rbio and wbio were originally different, then we only
1096 * adopt one reference.
1098 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1099 SSL_set0_rbio(s, rbio);
1103 /* Otherwise, adopt both references. */
1104 SSL_set0_rbio(s, rbio);
1105 SSL_set0_wbio(s, wbio);
1108 BIO *SSL_get_rbio(const SSL *s)
1113 BIO *SSL_get_wbio(const SSL *s)
1115 if (s->bbio != NULL) {
1117 * If |bbio| is active, the true caller-configured BIO is its
1120 return BIO_next(s->bbio);
1125 int SSL_get_fd(const SSL *s)
1127 return SSL_get_rfd(s);
1130 int SSL_get_rfd(const SSL *s)
1135 b = SSL_get_rbio(s);
1136 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1138 BIO_get_fd(r, &ret);
1142 int SSL_get_wfd(const SSL *s)
1147 b = SSL_get_wbio(s);
1148 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1150 BIO_get_fd(r, &ret);
1154 #ifndef OPENSSL_NO_SOCK
1155 int SSL_set_fd(SSL *s, int fd)
1160 bio = BIO_new(BIO_s_socket());
1163 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1166 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1167 SSL_set_bio(s, bio, bio);
1173 int SSL_set_wfd(SSL *s, int fd)
1175 BIO *rbio = SSL_get_rbio(s);
1177 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1178 || (int)BIO_get_fd(rbio, NULL) != fd) {
1179 BIO *bio = BIO_new(BIO_s_socket());
1182 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1185 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1186 SSL_set0_wbio(s, bio);
1189 SSL_set0_wbio(s, rbio);
1194 int SSL_set_rfd(SSL *s, int fd)
1196 BIO *wbio = SSL_get_wbio(s);
1198 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1199 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1200 BIO *bio = BIO_new(BIO_s_socket());
1203 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1206 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1207 SSL_set0_rbio(s, bio);
1210 SSL_set0_rbio(s, wbio);
1217 /* return length of latest Finished message we sent, copy to 'buf' */
1218 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1222 if (s->s3 != NULL) {
1223 ret = s->s3->tmp.finish_md_len;
1226 memcpy(buf, s->s3->tmp.finish_md, count);
1231 /* return length of latest Finished message we expected, copy to 'buf' */
1232 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1236 if (s->s3 != NULL) {
1237 ret = s->s3->tmp.peer_finish_md_len;
1240 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1245 int SSL_get_verify_mode(const SSL *s)
1247 return (s->verify_mode);
1250 int SSL_get_verify_depth(const SSL *s)
1252 return X509_VERIFY_PARAM_get_depth(s->param);
1255 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1256 return (s->verify_callback);
1259 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1261 return (ctx->verify_mode);
1264 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1266 return X509_VERIFY_PARAM_get_depth(ctx->param);
1269 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1270 return (ctx->default_verify_callback);
1273 void SSL_set_verify(SSL *s, int mode,
1274 int (*callback) (int ok, X509_STORE_CTX *ctx))
1276 s->verify_mode = mode;
1277 if (callback != NULL)
1278 s->verify_callback = callback;
1281 void SSL_set_verify_depth(SSL *s, int depth)
1283 X509_VERIFY_PARAM_set_depth(s->param, depth);
1286 void SSL_set_read_ahead(SSL *s, int yes)
1288 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1291 int SSL_get_read_ahead(const SSL *s)
1293 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1296 int SSL_pending(const SSL *s)
1298 size_t pending = s->method->ssl_pending(s);
1301 * SSL_pending cannot work properly if read-ahead is enabled
1302 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1303 * impossible to fix since SSL_pending cannot report errors that may be
1304 * observed while scanning the new data. (Note that SSL_pending() is
1305 * often used as a boolean value, so we'd better not return -1.)
1307 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1308 * we just return INT_MAX.
1310 return pending < INT_MAX ? (int)pending : INT_MAX;
1313 int SSL_has_pending(const SSL *s)
1316 * Similar to SSL_pending() but returns a 1 to indicate that we have
1317 * unprocessed data available or 0 otherwise (as opposed to the number of
1318 * bytes available). Unlike SSL_pending() this will take into account
1319 * read_ahead data. A 1 return simply indicates that we have unprocessed
1320 * data. That data may not result in any application data, or we may fail
1321 * to parse the records for some reason.
1326 return RECORD_LAYER_read_pending(&s->rlayer);
1329 X509 *SSL_get_peer_certificate(const SSL *s)
1333 if ((s == NULL) || (s->session == NULL))
1336 r = s->session->peer;
1346 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1350 if ((s == NULL) || (s->session == NULL))
1353 r = s->session->peer_chain;
1356 * If we are a client, cert_chain includes the peer's own certificate; if
1357 * we are a server, it does not.
1364 * Now in theory, since the calling process own 't' it should be safe to
1365 * modify. We need to be able to read f without being hassled
1367 int SSL_copy_session_id(SSL *t, const SSL *f)
1370 /* Do we need to to SSL locking? */
1371 if (!SSL_set_session(t, SSL_get_session(f))) {
1376 * what if we are setup for one protocol version but want to talk another
1378 if (t->method != f->method) {
1379 t->method->ssl_free(t);
1380 t->method = f->method;
1381 if (t->method->ssl_new(t) == 0)
1385 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1386 ssl_cert_free(t->cert);
1388 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1395 /* Fix this so it checks all the valid key/cert options */
1396 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1398 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1399 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1402 if (ctx->cert->key->privatekey == NULL) {
1403 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1406 return (X509_check_private_key
1407 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1410 /* Fix this function so that it takes an optional type parameter */
1411 int SSL_check_private_key(const SSL *ssl)
1414 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1417 if (ssl->cert->key->x509 == NULL) {
1418 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1421 if (ssl->cert->key->privatekey == NULL) {
1422 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1425 return (X509_check_private_key(ssl->cert->key->x509,
1426 ssl->cert->key->privatekey));
1429 int SSL_waiting_for_async(SSL *s)
1437 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1439 ASYNC_WAIT_CTX *ctx = s->waitctx;
1443 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1446 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1447 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1449 ASYNC_WAIT_CTX *ctx = s->waitctx;
1453 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1457 int SSL_accept(SSL *s)
1459 if (s->handshake_func == NULL) {
1460 /* Not properly initialized yet */
1461 SSL_set_accept_state(s);
1464 return SSL_do_handshake(s);
1467 int SSL_connect(SSL *s)
1469 if (s->handshake_func == NULL) {
1470 /* Not properly initialized yet */
1471 SSL_set_connect_state(s);
1474 return SSL_do_handshake(s);
1477 long SSL_get_default_timeout(const SSL *s)
1479 return (s->method->get_timeout());
1482 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1483 int (*func) (void *))
1486 if (s->waitctx == NULL) {
1487 s->waitctx = ASYNC_WAIT_CTX_new();
1488 if (s->waitctx == NULL)
1491 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1492 sizeof(struct ssl_async_args))) {
1494 s->rwstate = SSL_NOTHING;
1495 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1498 s->rwstate = SSL_ASYNC_PAUSED;
1501 s->rwstate = SSL_ASYNC_NO_JOBS;
1507 s->rwstate = SSL_NOTHING;
1508 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1509 /* Shouldn't happen */
1514 static int ssl_io_intern(void *vargs)
1516 struct ssl_async_args *args;
1521 args = (struct ssl_async_args *)vargs;
1525 switch (args->type) {
1527 return args->f.func_read(s, buf, num, &s->asyncrw);
1529 return args->f.func_write(s, buf, num, &s->asyncrw);
1531 return args->f.func_other(s);
1536 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1538 if (s->handshake_func == NULL) {
1539 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1543 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1544 s->rwstate = SSL_NOTHING;
1548 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1549 struct ssl_async_args args;
1555 args.type = READFUNC;
1556 args.f.func_read = s->method->ssl_read;
1558 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1559 *readbytes = s->asyncrw;
1562 return s->method->ssl_read(s, buf, num, readbytes);
1566 int SSL_read(SSL *s, void *buf, int num)
1572 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1576 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1579 * The cast is safe here because ret should be <= INT_MAX because num is
1583 ret = (int)readbytes;
1588 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1590 int ret = ssl_read_internal(s, buf, num, readbytes);
1597 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1599 if (s->handshake_func == NULL) {
1600 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1604 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1607 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1608 struct ssl_async_args args;
1614 args.type = READFUNC;
1615 args.f.func_read = s->method->ssl_peek;
1617 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1618 *readbytes = s->asyncrw;
1621 return s->method->ssl_peek(s, buf, num, readbytes);
1625 int SSL_peek(SSL *s, void *buf, int num)
1631 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1635 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1638 * The cast is safe here because ret should be <= INT_MAX because num is
1642 ret = (int)readbytes;
1648 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1650 int ret = ssl_peek_internal(s, buf, num, readbytes);
1657 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1659 if (s->handshake_func == NULL) {
1660 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1664 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1665 s->rwstate = SSL_NOTHING;
1666 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1670 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1672 struct ssl_async_args args;
1675 args.buf = (void *)buf;
1677 args.type = WRITEFUNC;
1678 args.f.func_write = s->method->ssl_write;
1680 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1681 *written = s->asyncrw;
1684 return s->method->ssl_write(s, buf, num, written);
1688 int SSL_write(SSL *s, const void *buf, int num)
1694 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1698 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1701 * The cast is safe here because ret should be <= INT_MAX because num is
1710 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1712 int ret = ssl_write_internal(s, buf, num, written);
1719 int SSL_shutdown(SSL *s)
1722 * Note that this function behaves differently from what one might
1723 * expect. Return values are 0 for no success (yet), 1 for success; but
1724 * calling it once is usually not enough, even if blocking I/O is used
1725 * (see ssl3_shutdown).
1728 if (s->handshake_func == NULL) {
1729 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1733 if (!SSL_in_init(s)) {
1734 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1735 struct ssl_async_args args;
1738 args.type = OTHERFUNC;
1739 args.f.func_other = s->method->ssl_shutdown;
1741 return ssl_start_async_job(s, &args, ssl_io_intern);
1743 return s->method->ssl_shutdown(s);
1746 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1751 int SSL_key_update(SSL *s, int updatetype)
1754 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
1755 * negotiated, and that it is appropriate to call SSL_key_update() instead
1756 * of SSL_renegotiate().
1758 if (!SSL_IS_TLS13(s)) {
1759 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1763 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1764 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1765 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1769 if (!SSL_is_init_finished(s)) {
1770 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1774 ossl_statem_set_in_init(s, 1);
1775 s->key_update = updatetype;
1779 int SSL_get_key_update_type(SSL *s)
1781 return s->key_update;
1784 int SSL_renegotiate(SSL *s)
1786 if (SSL_IS_TLS13(s)) {
1787 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1791 if (s->renegotiate == 0)
1796 return (s->method->ssl_renegotiate(s));
1799 int SSL_renegotiate_abbreviated(SSL *s)
1801 if (SSL_IS_TLS13(s))
1804 if (s->renegotiate == 0)
1809 return (s->method->ssl_renegotiate(s));
1812 int SSL_renegotiate_pending(SSL *s)
1815 * becomes true when negotiation is requested; false again once a
1816 * handshake has finished
1818 return (s->renegotiate != 0);
1821 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1826 case SSL_CTRL_GET_READ_AHEAD:
1827 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1828 case SSL_CTRL_SET_READ_AHEAD:
1829 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1830 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1833 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1834 s->msg_callback_arg = parg;
1838 return (s->mode |= larg);
1839 case SSL_CTRL_CLEAR_MODE:
1840 return (s->mode &= ~larg);
1841 case SSL_CTRL_GET_MAX_CERT_LIST:
1842 return (long)(s->max_cert_list);
1843 case SSL_CTRL_SET_MAX_CERT_LIST:
1846 l = (long)s->max_cert_list;
1847 s->max_cert_list = (size_t)larg;
1849 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1850 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1852 s->max_send_fragment = larg;
1853 if (s->max_send_fragment < s->split_send_fragment)
1854 s->split_send_fragment = s->max_send_fragment;
1856 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1857 if ((size_t)larg > s->max_send_fragment || larg == 0)
1859 s->split_send_fragment = larg;
1861 case SSL_CTRL_SET_MAX_PIPELINES:
1862 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1864 s->max_pipelines = larg;
1866 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1868 case SSL_CTRL_GET_RI_SUPPORT:
1870 return s->s3->send_connection_binding;
1873 case SSL_CTRL_CERT_FLAGS:
1874 return (s->cert->cert_flags |= larg);
1875 case SSL_CTRL_CLEAR_CERT_FLAGS:
1876 return (s->cert->cert_flags &= ~larg);
1878 case SSL_CTRL_GET_RAW_CIPHERLIST:
1880 if (s->s3->tmp.ciphers_raw == NULL)
1882 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
1883 return (int)s->s3->tmp.ciphers_rawlen;
1885 return TLS_CIPHER_LEN;
1887 case SSL_CTRL_GET_EXTMS_SUPPORT:
1888 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
1890 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
1894 case SSL_CTRL_SET_MIN_PROTO_VERSION:
1895 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1896 &s->min_proto_version);
1897 case SSL_CTRL_SET_MAX_PROTO_VERSION:
1898 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
1899 &s->max_proto_version);
1901 return (s->method->ssl_ctrl(s, cmd, larg, parg));
1905 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1908 case SSL_CTRL_SET_MSG_CALLBACK:
1909 s->msg_callback = (void (*)
1910 (int write_p, int version, int content_type,
1911 const void *buf, size_t len, SSL *ssl,
1916 return (s->method->ssl_callback_ctrl(s, cmd, fp));
1920 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
1922 return ctx->sessions;
1925 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1928 /* For some cases with ctx == NULL perform syntax checks */
1931 #ifndef OPENSSL_NO_EC
1932 case SSL_CTRL_SET_GROUPS_LIST:
1933 return tls1_set_groups_list(NULL, NULL, parg);
1935 case SSL_CTRL_SET_SIGALGS_LIST:
1936 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
1937 return tls1_set_sigalgs_list(NULL, parg, 0);
1944 case SSL_CTRL_GET_READ_AHEAD:
1945 return (ctx->read_ahead);
1946 case SSL_CTRL_SET_READ_AHEAD:
1947 l = ctx->read_ahead;
1948 ctx->read_ahead = larg;
1951 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1952 ctx->msg_callback_arg = parg;
1955 case SSL_CTRL_GET_MAX_CERT_LIST:
1956 return (long)(ctx->max_cert_list);
1957 case SSL_CTRL_SET_MAX_CERT_LIST:
1960 l = (long)ctx->max_cert_list;
1961 ctx->max_cert_list = (size_t)larg;
1964 case SSL_CTRL_SET_SESS_CACHE_SIZE:
1967 l = (long)ctx->session_cache_size;
1968 ctx->session_cache_size = (size_t)larg;
1970 case SSL_CTRL_GET_SESS_CACHE_SIZE:
1971 return (long)(ctx->session_cache_size);
1972 case SSL_CTRL_SET_SESS_CACHE_MODE:
1973 l = ctx->session_cache_mode;
1974 ctx->session_cache_mode = larg;
1976 case SSL_CTRL_GET_SESS_CACHE_MODE:
1977 return (ctx->session_cache_mode);
1979 case SSL_CTRL_SESS_NUMBER:
1980 return (lh_SSL_SESSION_num_items(ctx->sessions));
1981 case SSL_CTRL_SESS_CONNECT:
1982 return (ctx->stats.sess_connect);
1983 case SSL_CTRL_SESS_CONNECT_GOOD:
1984 return (ctx->stats.sess_connect_good);
1985 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
1986 return (ctx->stats.sess_connect_renegotiate);
1987 case SSL_CTRL_SESS_ACCEPT:
1988 return (ctx->stats.sess_accept);
1989 case SSL_CTRL_SESS_ACCEPT_GOOD:
1990 return (ctx->stats.sess_accept_good);
1991 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
1992 return (ctx->stats.sess_accept_renegotiate);
1993 case SSL_CTRL_SESS_HIT:
1994 return (ctx->stats.sess_hit);
1995 case SSL_CTRL_SESS_CB_HIT:
1996 return (ctx->stats.sess_cb_hit);
1997 case SSL_CTRL_SESS_MISSES:
1998 return (ctx->stats.sess_miss);
1999 case SSL_CTRL_SESS_TIMEOUTS:
2000 return (ctx->stats.sess_timeout);
2001 case SSL_CTRL_SESS_CACHE_FULL:
2002 return (ctx->stats.sess_cache_full);
2004 return (ctx->mode |= larg);
2005 case SSL_CTRL_CLEAR_MODE:
2006 return (ctx->mode &= ~larg);
2007 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2008 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2010 ctx->max_send_fragment = larg;
2011 if (ctx->max_send_fragment < ctx->split_send_fragment)
2012 ctx->split_send_fragment = ctx->max_send_fragment;
2014 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2015 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2017 ctx->split_send_fragment = larg;
2019 case SSL_CTRL_SET_MAX_PIPELINES:
2020 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2022 ctx->max_pipelines = larg;
2024 case SSL_CTRL_CERT_FLAGS:
2025 return (ctx->cert->cert_flags |= larg);
2026 case SSL_CTRL_CLEAR_CERT_FLAGS:
2027 return (ctx->cert->cert_flags &= ~larg);
2028 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2029 return ssl_set_version_bound(ctx->method->version, (int)larg,
2030 &ctx->min_proto_version);
2031 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2032 return ssl_set_version_bound(ctx->method->version, (int)larg,
2033 &ctx->max_proto_version);
2035 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2039 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2042 case SSL_CTRL_SET_MSG_CALLBACK:
2043 ctx->msg_callback = (void (*)
2044 (int write_p, int version, int content_type,
2045 const void *buf, size_t len, SSL *ssl,
2050 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2054 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2063 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2064 const SSL_CIPHER *const *bp)
2066 if ((*ap)->id > (*bp)->id)
2068 if ((*ap)->id < (*bp)->id)
2073 /** return a STACK of the ciphers available for the SSL and in order of
2075 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2078 if (s->cipher_list != NULL) {
2079 return (s->cipher_list);
2080 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2081 return (s->ctx->cipher_list);
2087 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2089 if ((s == NULL) || (s->session == NULL) || !s->server)
2091 return s->session->ciphers;
2094 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2096 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2098 ciphers = SSL_get_ciphers(s);
2101 ssl_set_client_disabled(s);
2102 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2103 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2104 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
2106 sk = sk_SSL_CIPHER_new_null();
2109 if (!sk_SSL_CIPHER_push(sk, c)) {
2110 sk_SSL_CIPHER_free(sk);
2118 /** return a STACK of the ciphers available for the SSL and in order of
2120 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2123 if (s->cipher_list_by_id != NULL) {
2124 return (s->cipher_list_by_id);
2125 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2126 return (s->ctx->cipher_list_by_id);
2132 /** The old interface to get the same thing as SSL_get_ciphers() */
2133 const char *SSL_get_cipher_list(const SSL *s, int n)
2135 const SSL_CIPHER *c;
2136 STACK_OF(SSL_CIPHER) *sk;
2140 sk = SSL_get_ciphers(s);
2141 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2143 c = sk_SSL_CIPHER_value(sk, n);
2149 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2151 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2154 return ctx->cipher_list;
2158 /** specify the ciphers to be used by default by the SSL_CTX */
2159 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2161 STACK_OF(SSL_CIPHER) *sk;
2163 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2164 &ctx->cipher_list_by_id, str, ctx->cert);
2166 * ssl_create_cipher_list may return an empty stack if it was unable to
2167 * find a cipher matching the given rule string (for example if the rule
2168 * string specifies a cipher which has been disabled). This is not an
2169 * error as far as ssl_create_cipher_list is concerned, and hence
2170 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2174 else if (sk_SSL_CIPHER_num(sk) == 0) {
2175 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2181 /** specify the ciphers to be used by the SSL */
2182 int SSL_set_cipher_list(SSL *s, const char *str)
2184 STACK_OF(SSL_CIPHER) *sk;
2186 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2187 &s->cipher_list_by_id, str, s->cert);
2188 /* see comment in SSL_CTX_set_cipher_list */
2191 else if (sk_SSL_CIPHER_num(sk) == 0) {
2192 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2198 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2201 STACK_OF(SSL_CIPHER) *sk;
2202 const SSL_CIPHER *c;
2205 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2209 sk = s->session->ciphers;
2211 if (sk_SSL_CIPHER_num(sk) == 0)
2214 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2217 c = sk_SSL_CIPHER_value(sk, i);
2218 n = strlen(c->name);
2225 memcpy(p, c->name, n + 1);
2234 /** return a servername extension value if provided in Client Hello, or NULL.
2235 * So far, only host_name types are defined (RFC 3546).
2238 const char *SSL_get_servername(const SSL *s, const int type)
2240 if (type != TLSEXT_NAMETYPE_host_name)
2243 return s->session && !s->ext.hostname ?
2244 s->session->ext.hostname : s->ext.hostname;
2247 int SSL_get_servername_type(const SSL *s)
2250 && (!s->ext.hostname ? s->session->
2251 ext.hostname : s->ext.hostname))
2252 return TLSEXT_NAMETYPE_host_name;
2257 * SSL_select_next_proto implements the standard protocol selection. It is
2258 * expected that this function is called from the callback set by
2259 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2260 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2261 * not included in the length. A byte string of length 0 is invalid. No byte
2262 * string may be truncated. The current, but experimental algorithm for
2263 * selecting the protocol is: 1) If the server doesn't support NPN then this
2264 * is indicated to the callback. In this case, the client application has to
2265 * abort the connection or have a default application level protocol. 2) If
2266 * the server supports NPN, but advertises an empty list then the client
2267 * selects the first protocol in its list, but indicates via the API that this
2268 * fallback case was enacted. 3) Otherwise, the client finds the first
2269 * protocol in the server's list that it supports and selects this protocol.
2270 * This is because it's assumed that the server has better information about
2271 * which protocol a client should use. 4) If the client doesn't support any
2272 * of the server's advertised protocols, then this is treated the same as
2273 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2274 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2276 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2277 const unsigned char *server,
2278 unsigned int server_len,
2279 const unsigned char *client, unsigned int client_len)
2282 const unsigned char *result;
2283 int status = OPENSSL_NPN_UNSUPPORTED;
2286 * For each protocol in server preference order, see if we support it.
2288 for (i = 0; i < server_len;) {
2289 for (j = 0; j < client_len;) {
2290 if (server[i] == client[j] &&
2291 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2292 /* We found a match */
2293 result = &server[i];
2294 status = OPENSSL_NPN_NEGOTIATED;
2304 /* There's no overlap between our protocols and the server's list. */
2306 status = OPENSSL_NPN_NO_OVERLAP;
2309 *out = (unsigned char *)result + 1;
2310 *outlen = result[0];
2314 #ifndef OPENSSL_NO_NEXTPROTONEG
2316 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2317 * client's requested protocol for this connection and returns 0. If the
2318 * client didn't request any protocol, then *data is set to NULL. Note that
2319 * the client can request any protocol it chooses. The value returned from
2320 * this function need not be a member of the list of supported protocols
2321 * provided by the callback.
2323 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2330 *len = (unsigned int)s->ext.npn_len;
2335 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2336 * a TLS server needs a list of supported protocols for Next Protocol
2337 * Negotiation. The returned list must be in wire format. The list is
2338 * returned by setting |out| to point to it and |outlen| to its length. This
2339 * memory will not be modified, but one should assume that the SSL* keeps a
2340 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2341 * wishes to advertise. Otherwise, no such extension will be included in the
2344 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2345 SSL_CTX_npn_advertised_cb_func cb,
2348 ctx->ext.npn_advertised_cb = cb;
2349 ctx->ext.npn_advertised_cb_arg = arg;
2353 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2354 * client needs to select a protocol from the server's provided list. |out|
2355 * must be set to point to the selected protocol (which may be within |in|).
2356 * The length of the protocol name must be written into |outlen|. The
2357 * server's advertised protocols are provided in |in| and |inlen|. The
2358 * callback can assume that |in| is syntactically valid. The client must
2359 * select a protocol. It is fatal to the connection if this callback returns
2360 * a value other than SSL_TLSEXT_ERR_OK.
2362 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2363 SSL_CTX_npn_select_cb_func cb,
2366 ctx->ext.npn_select_cb = cb;
2367 ctx->ext.npn_select_cb_arg = arg;
2372 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2373 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2374 * length-prefixed strings). Returns 0 on success.
2376 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2377 unsigned int protos_len)
2379 OPENSSL_free(ctx->ext.alpn);
2380 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2381 if (ctx->ext.alpn == NULL) {
2382 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2385 ctx->ext.alpn_len = protos_len;
2391 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2392 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2393 * length-prefixed strings). Returns 0 on success.
2395 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2396 unsigned int protos_len)
2398 OPENSSL_free(ssl->ext.alpn);
2399 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2400 if (ssl->ext.alpn == NULL) {
2401 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2404 ssl->ext.alpn_len = protos_len;
2410 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2411 * called during ClientHello processing in order to select an ALPN protocol
2412 * from the client's list of offered protocols.
2414 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2415 SSL_CTX_alpn_select_cb_func cb,
2418 ctx->ext.alpn_select_cb = cb;
2419 ctx->ext.alpn_select_cb_arg = arg;
2423 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2424 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2425 * (not including the leading length-prefix byte). If the server didn't
2426 * respond with a negotiated protocol then |*len| will be zero.
2428 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2433 *data = ssl->s3->alpn_selected;
2437 *len = (unsigned int)ssl->s3->alpn_selected_len;
2440 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2441 const char *label, size_t llen,
2442 const unsigned char *p, size_t plen,
2445 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2448 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2453 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2455 const unsigned char *session_id = a->session_id;
2457 unsigned char tmp_storage[4];
2459 if (a->session_id_length < sizeof(tmp_storage)) {
2460 memset(tmp_storage, 0, sizeof(tmp_storage));
2461 memcpy(tmp_storage, a->session_id, a->session_id_length);
2462 session_id = tmp_storage;
2466 ((unsigned long)session_id[0]) |
2467 ((unsigned long)session_id[1] << 8L) |
2468 ((unsigned long)session_id[2] << 16L) |
2469 ((unsigned long)session_id[3] << 24L);
2474 * NB: If this function (or indeed the hash function which uses a sort of
2475 * coarser function than this one) is changed, ensure
2476 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2477 * being able to construct an SSL_SESSION that will collide with any existing
2478 * session with a matching session ID.
2480 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2482 if (a->ssl_version != b->ssl_version)
2484 if (a->session_id_length != b->session_id_length)
2486 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2490 * These wrapper functions should remain rather than redeclaring
2491 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2492 * variable. The reason is that the functions aren't static, they're exposed
2496 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2498 SSL_CTX *ret = NULL;
2501 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2505 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2508 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2509 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2512 ret = OPENSSL_zalloc(sizeof(*ret));
2517 ret->min_proto_version = 0;
2518 ret->max_proto_version = 0;
2519 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2520 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2521 /* We take the system default. */
2522 ret->session_timeout = meth->get_timeout();
2523 ret->references = 1;
2524 ret->lock = CRYPTO_THREAD_lock_new();
2525 if (ret->lock == NULL) {
2526 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2530 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2531 ret->verify_mode = SSL_VERIFY_NONE;
2532 if ((ret->cert = ssl_cert_new()) == NULL)
2535 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2536 if (ret->sessions == NULL)
2538 ret->cert_store = X509_STORE_new();
2539 if (ret->cert_store == NULL)
2541 #ifndef OPENSSL_NO_CT
2542 ret->ctlog_store = CTLOG_STORE_new();
2543 if (ret->ctlog_store == NULL)
2546 if (!ssl_create_cipher_list(ret->method,
2547 &ret->cipher_list, &ret->cipher_list_by_id,
2548 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2549 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2550 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2554 ret->param = X509_VERIFY_PARAM_new();
2555 if (ret->param == NULL)
2558 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2559 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2562 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2563 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2567 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2570 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2573 /* No compression for DTLS */
2574 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2575 ret->comp_methods = SSL_COMP_get_compression_methods();
2577 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2578 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2580 /* Setup RFC5077 ticket keys */
2581 if ((RAND_bytes(ret->ext.tick_key_name,
2582 sizeof(ret->ext.tick_key_name)) <= 0)
2583 || (RAND_bytes(ret->ext.tick_hmac_key,
2584 sizeof(ret->ext.tick_hmac_key)) <= 0)
2585 || (RAND_bytes(ret->ext.tick_aes_key,
2586 sizeof(ret->ext.tick_aes_key)) <= 0))
2587 ret->options |= SSL_OP_NO_TICKET;
2589 #ifndef OPENSSL_NO_SRP
2590 if (!SSL_CTX_SRP_CTX_init(ret))
2593 #ifndef OPENSSL_NO_ENGINE
2594 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2595 # define eng_strx(x) #x
2596 # define eng_str(x) eng_strx(x)
2597 /* Use specific client engine automatically... ignore errors */
2600 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2603 ENGINE_load_builtin_engines();
2604 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2606 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2612 * Default is to connect to non-RI servers. When RI is more widely
2613 * deployed might change this.
2615 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2617 * Disable compression by default to prevent CRIME. Applications can
2618 * re-enable compression by configuring
2619 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2620 * or by using the SSL_CONF library.
2622 ret->options |= SSL_OP_NO_COMPRESSION;
2624 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2628 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2634 int SSL_CTX_up_ref(SSL_CTX *ctx)
2638 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2641 REF_PRINT_COUNT("SSL_CTX", ctx);
2642 REF_ASSERT_ISNT(i < 2);
2643 return ((i > 1) ? 1 : 0);
2646 void SSL_CTX_free(SSL_CTX *a)
2653 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2654 REF_PRINT_COUNT("SSL_CTX", a);
2657 REF_ASSERT_ISNT(i < 0);
2659 X509_VERIFY_PARAM_free(a->param);
2660 dane_ctx_final(&a->dane);
2663 * Free internal session cache. However: the remove_cb() may reference
2664 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2665 * after the sessions were flushed.
2666 * As the ex_data handling routines might also touch the session cache,
2667 * the most secure solution seems to be: empty (flush) the cache, then
2668 * free ex_data, then finally free the cache.
2669 * (See ticket [openssl.org #212].)
2671 if (a->sessions != NULL)
2672 SSL_CTX_flush_sessions(a, 0);
2674 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2675 lh_SSL_SESSION_free(a->sessions);
2676 X509_STORE_free(a->cert_store);
2677 #ifndef OPENSSL_NO_CT
2678 CTLOG_STORE_free(a->ctlog_store);
2680 sk_SSL_CIPHER_free(a->cipher_list);
2681 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2682 ssl_cert_free(a->cert);
2683 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2684 sk_X509_pop_free(a->extra_certs, X509_free);
2685 a->comp_methods = NULL;
2686 #ifndef OPENSSL_NO_SRTP
2687 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2689 #ifndef OPENSSL_NO_SRP
2690 SSL_CTX_SRP_CTX_free(a);
2692 #ifndef OPENSSL_NO_ENGINE
2693 ENGINE_finish(a->client_cert_engine);
2696 #ifndef OPENSSL_NO_EC
2697 OPENSSL_free(a->ext.ecpointformats);
2698 OPENSSL_free(a->ext.supportedgroups);
2700 OPENSSL_free(a->ext.alpn);
2702 CRYPTO_THREAD_lock_free(a->lock);
2707 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2709 ctx->default_passwd_callback = cb;
2712 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2714 ctx->default_passwd_callback_userdata = u;
2717 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2719 return ctx->default_passwd_callback;
2722 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2724 return ctx->default_passwd_callback_userdata;
2727 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2729 s->default_passwd_callback = cb;
2732 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2734 s->default_passwd_callback_userdata = u;
2737 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2739 return s->default_passwd_callback;
2742 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2744 return s->default_passwd_callback_userdata;
2747 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2748 int (*cb) (X509_STORE_CTX *, void *),
2751 ctx->app_verify_callback = cb;
2752 ctx->app_verify_arg = arg;
2755 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2756 int (*cb) (int, X509_STORE_CTX *))
2758 ctx->verify_mode = mode;
2759 ctx->default_verify_callback = cb;
2762 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2764 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2767 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2769 ssl_cert_set_cert_cb(c->cert, cb, arg);
2772 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2774 ssl_cert_set_cert_cb(s->cert, cb, arg);
2777 void ssl_set_masks(SSL *s)
2780 uint32_t *pvalid = s->s3->tmp.valid_flags;
2781 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2782 unsigned long mask_k, mask_a;
2783 #ifndef OPENSSL_NO_EC
2784 int have_ecc_cert, ecdsa_ok;
2789 #ifndef OPENSSL_NO_DH
2790 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2795 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2796 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2797 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
2798 #ifndef OPENSSL_NO_EC
2799 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2805 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2806 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2809 #ifndef OPENSSL_NO_GOST
2810 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2811 mask_k |= SSL_kGOST;
2812 mask_a |= SSL_aGOST12;
2814 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2815 mask_k |= SSL_kGOST;
2816 mask_a |= SSL_aGOST12;
2818 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2819 mask_k |= SSL_kGOST;
2820 mask_a |= SSL_aGOST01;
2830 if (rsa_enc || rsa_sign) {
2838 mask_a |= SSL_aNULL;
2841 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2842 * depending on the key usage extension.
2844 #ifndef OPENSSL_NO_EC
2845 if (have_ecc_cert) {
2847 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
2848 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2849 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2852 mask_a |= SSL_aECDSA;
2856 #ifndef OPENSSL_NO_EC
2857 mask_k |= SSL_kECDHE;
2860 #ifndef OPENSSL_NO_PSK
2863 if (mask_k & SSL_kRSA)
2864 mask_k |= SSL_kRSAPSK;
2865 if (mask_k & SSL_kDHE)
2866 mask_k |= SSL_kDHEPSK;
2867 if (mask_k & SSL_kECDHE)
2868 mask_k |= SSL_kECDHEPSK;
2871 s->s3->tmp.mask_k = mask_k;
2872 s->s3->tmp.mask_a = mask_a;
2875 #ifndef OPENSSL_NO_EC
2877 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
2879 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
2880 /* key usage, if present, must allow signing */
2881 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
2882 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
2883 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
2887 return 1; /* all checks are ok */
2892 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
2893 size_t *serverinfo_length)
2895 CERT_PKEY *cpk = s->s3->tmp.cert;
2896 *serverinfo_length = 0;
2898 if (cpk == NULL || cpk->serverinfo == NULL)
2901 *serverinfo = cpk->serverinfo;
2902 *serverinfo_length = cpk->serverinfo_length;
2906 void ssl_update_cache(SSL *s, int mode)
2911 * If the session_id_length is 0, we are not supposed to cache it, and it
2912 * would be rather hard to do anyway :-)
2914 if (s->session->session_id_length == 0)
2917 i = s->session_ctx->session_cache_mode;
2918 if ((i & mode) && (!s->hit)
2919 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
2920 || SSL_CTX_add_session(s->session_ctx, s->session))
2921 && (s->session_ctx->new_session_cb != NULL)) {
2922 SSL_SESSION_up_ref(s->session);
2923 if (!s->session_ctx->new_session_cb(s, s->session))
2924 SSL_SESSION_free(s->session);
2927 /* auto flush every 255 connections */
2928 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
2929 if ((((mode & SSL_SESS_CACHE_CLIENT)
2930 ? s->session_ctx->stats.sess_connect_good
2931 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
2932 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
2937 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
2942 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
2947 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
2951 if (s->method != meth) {
2952 const SSL_METHOD *sm = s->method;
2953 int (*hf) (SSL *) = s->handshake_func;
2955 if (sm->version == meth->version)
2960 ret = s->method->ssl_new(s);
2963 if (hf == sm->ssl_connect)
2964 s->handshake_func = meth->ssl_connect;
2965 else if (hf == sm->ssl_accept)
2966 s->handshake_func = meth->ssl_accept;
2971 int SSL_get_error(const SSL *s, int i)
2978 return (SSL_ERROR_NONE);
2981 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
2982 * where we do encode the error
2984 if ((l = ERR_peek_error()) != 0) {
2985 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
2986 return (SSL_ERROR_SYSCALL);
2988 return (SSL_ERROR_SSL);
2991 if (SSL_want_read(s)) {
2992 bio = SSL_get_rbio(s);
2993 if (BIO_should_read(bio))
2994 return (SSL_ERROR_WANT_READ);
2995 else if (BIO_should_write(bio))
2997 * This one doesn't make too much sense ... We never try to write
2998 * to the rbio, and an application program where rbio and wbio
2999 * are separate couldn't even know what it should wait for.
3000 * However if we ever set s->rwstate incorrectly (so that we have
3001 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3002 * wbio *are* the same, this test works around that bug; so it
3003 * might be safer to keep it.
3005 return (SSL_ERROR_WANT_WRITE);
3006 else if (BIO_should_io_special(bio)) {
3007 reason = BIO_get_retry_reason(bio);
3008 if (reason == BIO_RR_CONNECT)
3009 return (SSL_ERROR_WANT_CONNECT);
3010 else if (reason == BIO_RR_ACCEPT)
3011 return (SSL_ERROR_WANT_ACCEPT);
3013 return (SSL_ERROR_SYSCALL); /* unknown */
3017 if (SSL_want_write(s)) {
3019 * Access wbio directly - in order to use the buffered bio if
3023 if (BIO_should_write(bio))
3024 return (SSL_ERROR_WANT_WRITE);
3025 else if (BIO_should_read(bio))
3027 * See above (SSL_want_read(s) with BIO_should_write(bio))
3029 return (SSL_ERROR_WANT_READ);
3030 else if (BIO_should_io_special(bio)) {
3031 reason = BIO_get_retry_reason(bio);
3032 if (reason == BIO_RR_CONNECT)
3033 return (SSL_ERROR_WANT_CONNECT);
3034 else if (reason == BIO_RR_ACCEPT)
3035 return (SSL_ERROR_WANT_ACCEPT);
3037 return (SSL_ERROR_SYSCALL);
3040 if (SSL_want_x509_lookup(s))
3041 return (SSL_ERROR_WANT_X509_LOOKUP);
3042 if (SSL_want_async(s))
3043 return SSL_ERROR_WANT_ASYNC;
3044 if (SSL_want_async_job(s))
3045 return SSL_ERROR_WANT_ASYNC_JOB;
3046 if (SSL_want_early(s))
3047 return SSL_ERROR_WANT_EARLY;
3049 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3050 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3051 return (SSL_ERROR_ZERO_RETURN);
3053 return (SSL_ERROR_SYSCALL);
3056 static int ssl_do_handshake_intern(void *vargs)
3058 struct ssl_async_args *args;
3061 args = (struct ssl_async_args *)vargs;
3064 return s->handshake_func(s);
3067 int SSL_do_handshake(SSL *s)
3071 if (s->handshake_func == NULL) {
3072 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3076 s->method->ssl_renegotiate_check(s, 0);
3078 if (SSL_in_init(s) || SSL_in_before(s)) {
3079 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3080 struct ssl_async_args args;
3084 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3086 ret = s->handshake_func(s);
3092 void SSL_set_accept_state(SSL *s)
3096 ossl_statem_clear(s);
3097 s->handshake_func = s->method->ssl_accept;
3101 void SSL_set_connect_state(SSL *s)
3105 ossl_statem_clear(s);
3106 s->handshake_func = s->method->ssl_connect;
3110 int ssl_undefined_function(SSL *s)
3112 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3116 int ssl_undefined_void_function(void)
3118 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3119 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3123 int ssl_undefined_const_function(const SSL *s)
3128 const SSL_METHOD *ssl_bad_method(int ver)
3130 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3134 const char *ssl_protocol_to_string(int version)
3138 case TLS1_3_VERSION:
3141 case TLS1_2_VERSION:
3144 case TLS1_1_VERSION:
3159 case DTLS1_2_VERSION:
3167 const char *SSL_get_version(const SSL *s)
3169 return ssl_protocol_to_string(s->version);
3172 SSL *SSL_dup(SSL *s)
3174 STACK_OF(X509_NAME) *sk;
3179 /* If we're not quiescent, just up_ref! */
3180 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3181 CRYPTO_UP_REF(&s->references, &i, s->lock);
3186 * Otherwise, copy configuration state, and session if set.
3188 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3191 if (s->session != NULL) {
3193 * Arranges to share the same session via up_ref. This "copies"
3194 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3196 if (!SSL_copy_session_id(ret, s))
3200 * No session has been established yet, so we have to expect that
3201 * s->cert or ret->cert will be changed later -- they should not both
3202 * point to the same object, and thus we can't use
3203 * SSL_copy_session_id.
3205 if (!SSL_set_ssl_method(ret, s->method))
3208 if (s->cert != NULL) {
3209 ssl_cert_free(ret->cert);
3210 ret->cert = ssl_cert_dup(s->cert);
3211 if (ret->cert == NULL)
3215 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3216 (int)s->sid_ctx_length))
3220 if (!ssl_dane_dup(ret, s))
3222 ret->version = s->version;
3223 ret->options = s->options;
3224 ret->mode = s->mode;
3225 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3226 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3227 ret->msg_callback = s->msg_callback;
3228 ret->msg_callback_arg = s->msg_callback_arg;
3229 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3230 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3231 ret->generate_session_id = s->generate_session_id;
3233 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3235 /* copy app data, a little dangerous perhaps */
3236 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3239 /* setup rbio, and wbio */
3240 if (s->rbio != NULL) {
3241 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3244 if (s->wbio != NULL) {
3245 if (s->wbio != s->rbio) {
3246 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3249 BIO_up_ref(ret->rbio);
3250 ret->wbio = ret->rbio;
3254 ret->server = s->server;
3255 if (s->handshake_func) {
3257 SSL_set_accept_state(ret);
3259 SSL_set_connect_state(ret);
3261 ret->shutdown = s->shutdown;
3264 ret->default_passwd_callback = s->default_passwd_callback;
3265 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3267 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3269 /* dup the cipher_list and cipher_list_by_id stacks */
3270 if (s->cipher_list != NULL) {
3271 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3274 if (s->cipher_list_by_id != NULL)
3275 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3279 /* Dup the client_CA list */
3280 if (s->client_CA != NULL) {
3281 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3283 ret->client_CA = sk;
3284 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3285 xn = sk_X509_NAME_value(sk, i);
3286 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3299 void ssl_clear_cipher_ctx(SSL *s)
3301 if (s->enc_read_ctx != NULL) {
3302 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3303 s->enc_read_ctx = NULL;
3305 if (s->enc_write_ctx != NULL) {
3306 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3307 s->enc_write_ctx = NULL;
3309 #ifndef OPENSSL_NO_COMP
3310 COMP_CTX_free(s->expand);
3312 COMP_CTX_free(s->compress);
3317 X509 *SSL_get_certificate(const SSL *s)
3319 if (s->cert != NULL)
3320 return (s->cert->key->x509);
3325 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3327 if (s->cert != NULL)
3328 return (s->cert->key->privatekey);
3333 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3335 if (ctx->cert != NULL)
3336 return ctx->cert->key->x509;
3341 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3343 if (ctx->cert != NULL)
3344 return ctx->cert->key->privatekey;
3349 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3351 if ((s->session != NULL) && (s->session->cipher != NULL))
3352 return (s->session->cipher);
3356 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3358 #ifndef OPENSSL_NO_COMP
3359 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3365 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3367 #ifndef OPENSSL_NO_COMP
3368 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3374 int ssl_init_wbio_buffer(SSL *s)
3378 if (s->bbio != NULL) {
3379 /* Already buffered. */
3383 bbio = BIO_new(BIO_f_buffer());
3384 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3386 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3390 s->wbio = BIO_push(bbio, s->wbio);
3395 void ssl_free_wbio_buffer(SSL *s)
3397 /* callers ensure s is never null */
3398 if (s->bbio == NULL)
3401 s->wbio = BIO_pop(s->wbio);
3402 assert(s->wbio != NULL);
3407 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3409 ctx->quiet_shutdown = mode;
3412 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3414 return (ctx->quiet_shutdown);
3417 void SSL_set_quiet_shutdown(SSL *s, int mode)
3419 s->quiet_shutdown = mode;
3422 int SSL_get_quiet_shutdown(const SSL *s)
3424 return (s->quiet_shutdown);
3427 void SSL_set_shutdown(SSL *s, int mode)
3432 int SSL_get_shutdown(const SSL *s)
3437 int SSL_version(const SSL *s)
3442 int SSL_client_version(const SSL *s)
3444 return s->client_version;
3447 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3452 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3455 if (ssl->ctx == ctx)
3458 ctx = ssl->session_ctx;
3459 new_cert = ssl_cert_dup(ctx->cert);
3460 if (new_cert == NULL) {
3463 ssl_cert_free(ssl->cert);
3464 ssl->cert = new_cert;
3467 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3468 * so setter APIs must prevent invalid lengths from entering the system.
3470 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3473 * If the session ID context matches that of the parent SSL_CTX,
3474 * inherit it from the new SSL_CTX as well. If however the context does
3475 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3476 * leave it unchanged.
3478 if ((ssl->ctx != NULL) &&
3479 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3480 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3481 ssl->sid_ctx_length = ctx->sid_ctx_length;
3482 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3485 SSL_CTX_up_ref(ctx);
3486 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3492 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3494 return (X509_STORE_set_default_paths(ctx->cert_store));
3497 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3499 X509_LOOKUP *lookup;
3501 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3504 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3506 /* Clear any errors if the default directory does not exist */
3512 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3514 X509_LOOKUP *lookup;
3516 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3520 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3522 /* Clear any errors if the default file does not exist */
3528 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3531 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3534 void SSL_set_info_callback(SSL *ssl,
3535 void (*cb) (const SSL *ssl, int type, int val))
3537 ssl->info_callback = cb;
3541 * One compiler (Diab DCC) doesn't like argument names in returned function
3544 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3547 return ssl->info_callback;
3550 void SSL_set_verify_result(SSL *ssl, long arg)
3552 ssl->verify_result = arg;
3555 long SSL_get_verify_result(const SSL *ssl)
3557 return (ssl->verify_result);
3560 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3563 return sizeof(ssl->s3->client_random);
3564 if (outlen > sizeof(ssl->s3->client_random))
3565 outlen = sizeof(ssl->s3->client_random);
3566 memcpy(out, ssl->s3->client_random, outlen);
3570 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3573 return sizeof(ssl->s3->server_random);
3574 if (outlen > sizeof(ssl->s3->server_random))
3575 outlen = sizeof(ssl->s3->server_random);
3576 memcpy(out, ssl->s3->server_random, outlen);
3580 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3581 unsigned char *out, size_t outlen)
3584 return session->master_key_length;
3585 if (outlen > session->master_key_length)
3586 outlen = session->master_key_length;
3587 memcpy(out, session->master_key, outlen);
3591 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3593 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3596 void *SSL_get_ex_data(const SSL *s, int idx)
3598 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3601 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3603 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3606 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3608 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3611 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3613 return (ctx->cert_store);
3616 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3618 X509_STORE_free(ctx->cert_store);
3619 ctx->cert_store = store;
3622 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3625 X509_STORE_up_ref(store);
3626 SSL_CTX_set_cert_store(ctx, store);
3629 int SSL_want(const SSL *s)
3631 return (s->rwstate);
3635 * \brief Set the callback for generating temporary DH keys.
3636 * \param ctx the SSL context.
3637 * \param dh the callback
3640 #ifndef OPENSSL_NO_DH
3641 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3642 DH *(*dh) (SSL *ssl, int is_export,
3645 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3648 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3651 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3655 #ifndef OPENSSL_NO_PSK
3656 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3658 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3659 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3662 OPENSSL_free(ctx->cert->psk_identity_hint);
3663 if (identity_hint != NULL) {
3664 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3665 if (ctx->cert->psk_identity_hint == NULL)
3668 ctx->cert->psk_identity_hint = NULL;
3672 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3677 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3678 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3681 OPENSSL_free(s->cert->psk_identity_hint);
3682 if (identity_hint != NULL) {
3683 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3684 if (s->cert->psk_identity_hint == NULL)
3687 s->cert->psk_identity_hint = NULL;
3691 const char *SSL_get_psk_identity_hint(const SSL *s)
3693 if (s == NULL || s->session == NULL)
3695 return (s->session->psk_identity_hint);
3698 const char *SSL_get_psk_identity(const SSL *s)
3700 if (s == NULL || s->session == NULL)
3702 return (s->session->psk_identity);
3705 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3707 s->psk_client_callback = cb;
3710 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3712 ctx->psk_client_callback = cb;
3715 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3717 s->psk_server_callback = cb;
3720 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3722 ctx->psk_server_callback = cb;
3726 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3727 void (*cb) (int write_p, int version,
3728 int content_type, const void *buf,
3729 size_t len, SSL *ssl, void *arg))
3731 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3734 void SSL_set_msg_callback(SSL *ssl,
3735 void (*cb) (int write_p, int version,
3736 int content_type, const void *buf,
3737 size_t len, SSL *ssl, void *arg))
3739 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3742 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3743 int (*cb) (SSL *ssl,
3747 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3748 (void (*)(void))cb);
3751 void SSL_set_not_resumable_session_callback(SSL *ssl,
3752 int (*cb) (SSL *ssl,
3753 int is_forward_secure))
3755 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3756 (void (*)(void))cb);
3760 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3761 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3762 * If EVP_MD pointer is passed, initializes ctx with this md.
3763 * Returns the newly allocated ctx;
3766 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3768 ssl_clear_hash_ctx(hash);
3769 *hash = EVP_MD_CTX_new();
3770 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3771 EVP_MD_CTX_free(*hash);
3778 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3781 EVP_MD_CTX_free(*hash);
3785 /* Retrieve handshake hashes */
3786 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3789 EVP_MD_CTX *ctx = NULL;
3790 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3791 int hashleni = EVP_MD_CTX_size(hdgst);
3794 if (hashleni < 0 || (size_t)hashleni > outlen)
3797 ctx = EVP_MD_CTX_new();
3801 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3802 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3805 *hashlen = hashleni;
3809 EVP_MD_CTX_free(ctx);
3813 int SSL_session_reused(SSL *s)
3818 int SSL_is_server(SSL *s)
3823 #if OPENSSL_API_COMPAT < 0x10100000L
3824 void SSL_set_debug(SSL *s, int debug)
3826 /* Old function was do-nothing anyway... */
3832 void SSL_set_security_level(SSL *s, int level)
3834 s->cert->sec_level = level;
3837 int SSL_get_security_level(const SSL *s)
3839 return s->cert->sec_level;
3842 void SSL_set_security_callback(SSL *s,
3843 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3844 int op, int bits, int nid,
3845 void *other, void *ex))
3847 s->cert->sec_cb = cb;
3850 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
3851 const SSL_CTX *ctx, int op,
3852 int bits, int nid, void *other,
3854 return s->cert->sec_cb;
3857 void SSL_set0_security_ex_data(SSL *s, void *ex)
3859 s->cert->sec_ex = ex;
3862 void *SSL_get0_security_ex_data(const SSL *s)
3864 return s->cert->sec_ex;
3867 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
3869 ctx->cert->sec_level = level;
3872 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
3874 return ctx->cert->sec_level;
3877 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
3878 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3879 int op, int bits, int nid,
3880 void *other, void *ex))
3882 ctx->cert->sec_cb = cb;
3885 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
3891 return ctx->cert->sec_cb;
3894 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
3896 ctx->cert->sec_ex = ex;
3899 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
3901 return ctx->cert->sec_ex;
3905 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
3906 * can return unsigned long, instead of the generic long return value from the
3907 * control interface.
3909 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
3911 return ctx->options;
3914 unsigned long SSL_get_options(const SSL *s)
3919 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
3921 return ctx->options |= op;
3924 unsigned long SSL_set_options(SSL *s, unsigned long op)
3926 return s->options |= op;
3929 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
3931 return ctx->options &= ~op;
3934 unsigned long SSL_clear_options(SSL *s, unsigned long op)
3936 return s->options &= ~op;
3939 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
3941 return s->verified_chain;
3944 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
3946 #ifndef OPENSSL_NO_CT
3949 * Moves SCTs from the |src| stack to the |dst| stack.
3950 * The source of each SCT will be set to |origin|.
3951 * If |dst| points to a NULL pointer, a new stack will be created and owned by
3953 * Returns the number of SCTs moved, or a negative integer if an error occurs.
3955 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
3956 sct_source_t origin)
3962 *dst = sk_SCT_new_null();
3964 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
3969 while ((sct = sk_SCT_pop(src)) != NULL) {
3970 if (SCT_set_source(sct, origin) != 1)
3973 if (sk_SCT_push(*dst, sct) <= 0)
3981 sk_SCT_push(src, sct); /* Put the SCT back */
3986 * Look for data collected during ServerHello and parse if found.
3987 * Returns the number of SCTs extracted.
3989 static int ct_extract_tls_extension_scts(SSL *s)
3991 int scts_extracted = 0;
3993 if (s->ext.scts != NULL) {
3994 const unsigned char *p = s->ext.scts;
3995 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
3997 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
3999 SCT_LIST_free(scts);
4002 return scts_extracted;
4006 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4007 * contains an SCT X509 extension. They will be stored in |s->scts|.
4009 * - The number of SCTs extracted, assuming an OCSP response exists.
4010 * - 0 if no OCSP response exists or it contains no SCTs.
4011 * - A negative integer if an error occurs.
4013 static int ct_extract_ocsp_response_scts(SSL *s)
4015 # ifndef OPENSSL_NO_OCSP
4016 int scts_extracted = 0;
4017 const unsigned char *p;
4018 OCSP_BASICRESP *br = NULL;
4019 OCSP_RESPONSE *rsp = NULL;
4020 STACK_OF(SCT) *scts = NULL;
4023 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4026 p = s->ext.ocsp.resp;
4027 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4031 br = OCSP_response_get1_basic(rsp);
4035 for (i = 0; i < OCSP_resp_count(br); ++i) {
4036 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4042 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4044 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4045 if (scts_extracted < 0)
4049 SCT_LIST_free(scts);
4050 OCSP_BASICRESP_free(br);
4051 OCSP_RESPONSE_free(rsp);
4052 return scts_extracted;
4054 /* Behave as if no OCSP response exists */
4060 * Attempts to extract SCTs from the peer certificate.
4061 * Return the number of SCTs extracted, or a negative integer if an error
4064 static int ct_extract_x509v3_extension_scts(SSL *s)
4066 int scts_extracted = 0;
4067 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4070 STACK_OF(SCT) *scts =
4071 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4074 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4076 SCT_LIST_free(scts);
4079 return scts_extracted;
4083 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4084 * response (if it exists) and X509v3 extensions in the certificate.
4085 * Returns NULL if an error occurs.
4087 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4089 if (!s->scts_parsed) {
4090 if (ct_extract_tls_extension_scts(s) < 0 ||
4091 ct_extract_ocsp_response_scts(s) < 0 ||
4092 ct_extract_x509v3_extension_scts(s) < 0)
4102 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4103 const STACK_OF(SCT) *scts, void *unused_arg)
4108 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4109 const STACK_OF(SCT) *scts, void *unused_arg)
4111 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4114 for (i = 0; i < count; ++i) {
4115 SCT *sct = sk_SCT_value(scts, i);
4116 int status = SCT_get_validation_status(sct);
4118 if (status == SCT_VALIDATION_STATUS_VALID)
4121 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4125 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4129 * Since code exists that uses the custom extension handler for CT, look
4130 * for this and throw an error if they have already registered to use CT.
4132 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4133 TLSEXT_TYPE_signed_certificate_timestamp))
4135 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4136 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4140 if (callback != NULL) {
4142 * If we are validating CT, then we MUST accept SCTs served via OCSP
4144 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4148 s->ct_validation_callback = callback;
4149 s->ct_validation_callback_arg = arg;
4154 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4155 ssl_ct_validation_cb callback, void *arg)
4158 * Since code exists that uses the custom extension handler for CT, look for
4159 * this and throw an error if they have already registered to use CT.
4161 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4162 TLSEXT_TYPE_signed_certificate_timestamp))
4164 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4165 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4169 ctx->ct_validation_callback = callback;
4170 ctx->ct_validation_callback_arg = arg;
4174 int SSL_ct_is_enabled(const SSL *s)
4176 return s->ct_validation_callback != NULL;
4179 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4181 return ctx->ct_validation_callback != NULL;
4184 int ssl_validate_ct(SSL *s)
4187 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4189 SSL_DANE *dane = &s->dane;
4190 CT_POLICY_EVAL_CTX *ctx = NULL;
4191 const STACK_OF(SCT) *scts;
4194 * If no callback is set, the peer is anonymous, or its chain is invalid,
4195 * skip SCT validation - just return success. Applications that continue
4196 * handshakes without certificates, with unverified chains, or pinned leaf
4197 * certificates are outside the scope of the WebPKI and CT.
4199 * The above exclusions notwithstanding the vast majority of peers will
4200 * have rather ordinary certificate chains validated by typical
4201 * applications that perform certificate verification and therefore will
4202 * process SCTs when enabled.
4204 if (s->ct_validation_callback == NULL || cert == NULL ||
4205 s->verify_result != X509_V_OK ||
4206 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4210 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4211 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4213 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4214 switch (dane->mtlsa->usage) {
4215 case DANETLS_USAGE_DANE_TA:
4216 case DANETLS_USAGE_DANE_EE:
4221 ctx = CT_POLICY_EVAL_CTX_new();
4223 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4227 issuer = sk_X509_value(s->verified_chain, 1);
4228 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4229 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4230 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4231 CT_POLICY_EVAL_CTX_set_time(ctx, SSL_SESSION_get_time(SSL_get0_session(s)));
4233 scts = SSL_get0_peer_scts(s);
4236 * This function returns success (> 0) only when all the SCTs are valid, 0
4237 * when some are invalid, and < 0 on various internal errors (out of
4238 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4239 * reason to abort the handshake, that decision is up to the callback.
4240 * Therefore, we error out only in the unexpected case that the return
4241 * value is negative.
4243 * XXX: One might well argue that the return value of this function is an
4244 * unfortunate design choice. Its job is only to determine the validation
4245 * status of each of the provided SCTs. So long as it correctly separates
4246 * the wheat from the chaff it should return success. Failure in this case
4247 * ought to correspond to an inability to carry out its duties.
4249 if (SCT_LIST_validate(scts, ctx) < 0) {
4250 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4254 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4256 ret = 0; /* This function returns 0 on failure */
4259 CT_POLICY_EVAL_CTX_free(ctx);
4261 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4262 * failure return code here. Also the application may wish the complete
4263 * the handshake, and then disconnect cleanly at a higher layer, after
4264 * checking the verification status of the completed connection.
4266 * We therefore force a certificate verification failure which will be
4267 * visible via SSL_get_verify_result() and cached as part of any resumed
4270 * Note: the permissive callback is for information gathering only, always
4271 * returns success, and does not affect verification status. Only the
4272 * strict callback or a custom application-specified callback can trigger
4273 * connection failure or record a verification error.
4276 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4280 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4282 switch (validation_mode) {
4284 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4286 case SSL_CT_VALIDATION_PERMISSIVE:
4287 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4288 case SSL_CT_VALIDATION_STRICT:
4289 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4293 int SSL_enable_ct(SSL *s, int validation_mode)
4295 switch (validation_mode) {
4297 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4299 case SSL_CT_VALIDATION_PERMISSIVE:
4300 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4301 case SSL_CT_VALIDATION_STRICT:
4302 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4306 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4308 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4311 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4313 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4316 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4318 CTLOG_STORE_free(ctx->ctlog_store);
4319 ctx->ctlog_store = logs;
4322 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4324 return ctx->ctlog_store;
4327 #endif /* OPENSSL_NO_CT */
4329 void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn cb, void *arg)
4332 c->early_cb_arg = arg;
4335 int SSL_early_isv2(SSL *s)
4337 if (s->clienthello == NULL)
4339 return s->clienthello->isv2;
4342 unsigned int SSL_early_get0_legacy_version(SSL *s)
4344 if (s->clienthello == NULL)
4346 return s->clienthello->legacy_version;
4349 size_t SSL_early_get0_random(SSL *s, const unsigned char **out)
4351 if (s->clienthello == NULL)
4354 *out = s->clienthello->random;
4355 return SSL3_RANDOM_SIZE;
4358 size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out)
4360 if (s->clienthello == NULL)
4363 *out = s->clienthello->session_id;
4364 return s->clienthello->session_id_len;
4367 size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out)
4369 if (s->clienthello == NULL)
4372 *out = PACKET_data(&s->clienthello->ciphersuites);
4373 return PACKET_remaining(&s->clienthello->ciphersuites);
4376 size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out)
4378 if (s->clienthello == NULL)
4381 *out = s->clienthello->compressions;
4382 return s->clienthello->compressions_len;
4385 int SSL_early_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4391 if (s->clienthello == NULL)
4393 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4394 r = s->clienthello->pre_proc_exts + i;
4395 if (r->present && r->type == type) {
4397 *out = PACKET_data(&r->data);
4399 *outlen = PACKET_remaining(&r->data);
4406 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4408 ctx->keylog_callback = cb;
4411 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4413 return ctx->keylog_callback;
4416 static int nss_keylog_int(const char *prefix,
4418 const uint8_t *parameter_1,
4419 size_t parameter_1_len,
4420 const uint8_t *parameter_2,
4421 size_t parameter_2_len)
4424 char *cursor = NULL;
4429 if (ssl->ctx->keylog_callback == NULL) return 1;
4432 * Our output buffer will contain the following strings, rendered with
4433 * space characters in between, terminated by a NULL character: first the
4434 * prefix, then the first parameter, then the second parameter. The
4435 * meaning of each parameter depends on the specific key material being
4436 * logged. Note that the first and second parameters are encoded in
4437 * hexadecimal, so we need a buffer that is twice their lengths.
4439 prefix_len = strlen(prefix);
4440 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4441 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4442 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4446 strcpy(cursor, prefix);
4447 cursor += prefix_len;
4450 for (i = 0; i < parameter_1_len; i++) {
4451 sprintf(cursor, "%02x", parameter_1[i]);
4456 for (i = 0; i < parameter_2_len; i++) {
4457 sprintf(cursor, "%02x", parameter_2[i]);
4462 ssl->ctx->keylog_callback(ssl, (const char *)out);
4468 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4469 const uint8_t *encrypted_premaster,
4470 size_t encrypted_premaster_len,
4471 const uint8_t *premaster,
4472 size_t premaster_len)
4474 if (encrypted_premaster_len < 8) {
4475 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4479 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4480 return nss_keylog_int("RSA",
4482 encrypted_premaster,
4488 int ssl_log_secret(SSL *ssl,
4490 const uint8_t *secret,
4493 return nss_keylog_int(label,
4495 ssl->s3->client_random,
4501 #define SSLV2_CIPHER_LEN 3
4503 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format,
4508 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4510 if (PACKET_remaining(cipher_suites) == 0) {
4511 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST, SSL_R_NO_CIPHERS_SPECIFIED);
4512 *al = SSL_AD_ILLEGAL_PARAMETER;
4516 if (PACKET_remaining(cipher_suites) % n != 0) {
4517 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST,
4518 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4519 *al = SSL_AD_DECODE_ERROR;
4523 OPENSSL_free(s->s3->tmp.ciphers_raw);
4524 s->s3->tmp.ciphers_raw = NULL;
4525 s->s3->tmp.ciphers_rawlen = 0;
4528 size_t numciphers = PACKET_remaining(cipher_suites) / n;
4529 PACKET sslv2ciphers = *cipher_suites;
4530 unsigned int leadbyte;
4534 * We store the raw ciphers list in SSLv3+ format so we need to do some
4535 * preprocessing to convert the list first. If there are any SSLv2 only
4536 * ciphersuites with a non-zero leading byte then we are going to
4537 * slightly over allocate because we won't store those. But that isn't a
4540 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
4541 s->s3->tmp.ciphers_raw = raw;
4543 *al = SSL_AD_INTERNAL_ERROR;
4546 for (s->s3->tmp.ciphers_rawlen = 0;
4547 PACKET_remaining(&sslv2ciphers) > 0;
4548 raw += TLS_CIPHER_LEN) {
4549 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
4551 && !PACKET_copy_bytes(&sslv2ciphers, raw,
4554 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
4555 *al = SSL_AD_INTERNAL_ERROR;
4556 OPENSSL_free(s->s3->tmp.ciphers_raw);
4557 s->s3->tmp.ciphers_raw = NULL;
4558 s->s3->tmp.ciphers_rawlen = 0;
4562 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
4564 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
4565 &s->s3->tmp.ciphers_rawlen)) {
4566 *al = SSL_AD_INTERNAL_ERROR;
4574 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
4575 int isv2format, STACK_OF(SSL_CIPHER) **sk,
4576 STACK_OF(SSL_CIPHER) **scsvs)
4581 if (!PACKET_buf_init(&pkt, bytes, len))
4583 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, &alert);
4586 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
4587 STACK_OF(SSL_CIPHER) **skp,
4588 STACK_OF(SSL_CIPHER) **scsvs_out,
4589 int sslv2format, int *al)
4591 const SSL_CIPHER *c;
4592 STACK_OF(SSL_CIPHER) *sk = NULL;
4593 STACK_OF(SSL_CIPHER) *scsvs = NULL;
4595 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
4596 unsigned char cipher[SSLV2_CIPHER_LEN];
4598 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4600 if (PACKET_remaining(cipher_suites) == 0) {
4601 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
4602 *al = SSL_AD_ILLEGAL_PARAMETER;
4606 if (PACKET_remaining(cipher_suites) % n != 0) {
4607 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
4608 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4609 *al = SSL_AD_DECODE_ERROR;
4613 sk = sk_SSL_CIPHER_new_null();
4614 scsvs = sk_SSL_CIPHER_new_null();
4615 if (sk == NULL || scsvs == NULL) {
4616 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4617 *al = SSL_AD_INTERNAL_ERROR;
4621 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
4623 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
4624 * first byte set to zero, while true SSLv2 ciphers have a non-zero
4625 * first byte. We don't support any true SSLv2 ciphers, so skip them.
4627 if (sslv2format && cipher[0] != '\0')
4630 /* For SSLv2-compat, ignore leading 0-byte. */
4631 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
4633 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
4634 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
4635 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4636 *al = SSL_AD_INTERNAL_ERROR;
4641 if (PACKET_remaining(cipher_suites) > 0) {
4642 *al = SSL_AD_INTERNAL_ERROR;
4643 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_INTERNAL_ERROR);
4650 sk_SSL_CIPHER_free(sk);
4651 if (scsvs_out != NULL)
4654 sk_SSL_CIPHER_free(scsvs);
4657 sk_SSL_CIPHER_free(sk);
4658 sk_SSL_CIPHER_free(scsvs);
4662 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
4664 ctx->max_early_data = max_early_data;
4669 uint32_t SSL_CTX_get_max_early_data(SSL_CTX *ctx)
4671 return ctx->max_early_data;
4674 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
4676 s->max_early_data = max_early_data;
4681 uint32_t SSL_get_max_early_data(SSL_CTX *s)
4683 return s->max_early_data;