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->early_data_state != SSL_EARLY_DATA_NONE
1549 && s->early_data_state != SSL_EARLY_DATA_FINISHED_WRITING
1550 && s->early_data_state != SSL_EARLY_DATA_FINISHED_READING
1551 && s->early_data_state != SSL_EARLY_DATA_READING) {
1552 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1556 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1557 struct ssl_async_args args;
1563 args.type = READFUNC;
1564 args.f.func_read = s->method->ssl_read;
1566 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1567 *readbytes = s->asyncrw;
1570 return s->method->ssl_read(s, buf, num, readbytes);
1574 int SSL_read(SSL *s, void *buf, int num)
1580 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1584 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1587 * The cast is safe here because ret should be <= INT_MAX because num is
1591 ret = (int)readbytes;
1596 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1598 int ret = ssl_read_internal(s, buf, num, readbytes);
1605 int SSL_read_early(SSL *s, void *buf, size_t num, size_t *readbytes)
1610 SSLerr(SSL_F_SSL_READ_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1611 return SSL_READ_EARLY_ERROR;
1614 switch (s->early_data_state) {
1615 case SSL_EARLY_DATA_NONE:
1616 if (!SSL_in_before(s)) {
1617 SSLerr(SSL_F_SSL_READ_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1618 return SSL_READ_EARLY_ERROR;
1622 case SSL_EARLY_DATA_ACCEPT_RETRY:
1623 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1624 ret = SSL_accept(s);
1627 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1628 return SSL_READ_EARLY_ERROR;
1632 case SSL_EARLY_DATA_READ_RETRY:
1633 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1634 s->early_data_state = SSL_EARLY_DATA_READING;
1635 ret = SSL_read_ex(s, buf, num, readbytes);
1637 * Record layer will call ssl_end_of_early_data_seen() if we see
1638 * that alert - which updates the early_data_state to
1639 * SSL_EARLY_DATA_FINISHED_READING
1641 if (ret > 0 || (ret <= 0 && s->early_data_state
1642 != SSL_EARLY_DATA_FINISHED_READING)) {
1643 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1644 return ret > 0 ? SSL_READ_EARLY_SUCCESS : SSL_READ_EARLY_ERROR;
1647 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1650 ossl_statem_set_in_init(s, 1);
1651 return SSL_READ_EARLY_FINISH;
1654 SSLerr(SSL_F_SSL_READ_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1655 return SSL_READ_EARLY_ERROR;
1659 int ssl_end_of_early_data_seen(SSL *s)
1661 if (s->early_data_state == SSL_EARLY_DATA_READING) {
1662 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1663 ossl_statem_finish_early_data(s);
1670 int SSL_get_early_data_status(const SSL *s)
1672 return s->ext.early_data;
1675 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1677 if (s->handshake_func == NULL) {
1678 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1682 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1685 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1686 struct ssl_async_args args;
1692 args.type = READFUNC;
1693 args.f.func_read = s->method->ssl_peek;
1695 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1696 *readbytes = s->asyncrw;
1699 return s->method->ssl_peek(s, buf, num, readbytes);
1703 int SSL_peek(SSL *s, void *buf, int num)
1709 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1713 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1716 * The cast is safe here because ret should be <= INT_MAX because num is
1720 ret = (int)readbytes;
1726 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1728 int ret = ssl_peek_internal(s, buf, num, readbytes);
1735 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1737 if (s->handshake_func == NULL) {
1738 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1742 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1743 s->rwstate = SSL_NOTHING;
1744 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1748 if (s->early_data_state != SSL_EARLY_DATA_NONE
1749 && s->early_data_state != SSL_EARLY_DATA_FINISHED_WRITING
1750 && s->early_data_state != SSL_EARLY_DATA_FINISHED_READING
1751 && s->early_data_state != SSL_EARLY_DATA_WRITING) {
1752 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1756 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1758 struct ssl_async_args args;
1761 args.buf = (void *)buf;
1763 args.type = WRITEFUNC;
1764 args.f.func_write = s->method->ssl_write;
1766 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1767 *written = s->asyncrw;
1770 return s->method->ssl_write(s, buf, num, written);
1774 int SSL_write(SSL *s, const void *buf, int num)
1780 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1784 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1787 * The cast is safe here because ret should be <= INT_MAX because num is
1796 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1798 int ret = ssl_write_internal(s, buf, num, written);
1805 int SSL_write_early(SSL *s, const void *buf, size_t num, size_t *written)
1810 SSLerr(SSL_F_SSL_WRITE_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1814 switch (s->early_data_state) {
1815 case SSL_EARLY_DATA_NONE:
1816 if (!SSL_in_before(s)
1817 || s->session == NULL
1818 || s->session->ext.max_early_data == 0) {
1819 SSLerr(SSL_F_SSL_WRITE_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1824 case SSL_EARLY_DATA_CONNECT_RETRY:
1825 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1826 ret = SSL_connect(s);
1829 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1834 case SSL_EARLY_DATA_WRITE_RETRY:
1835 s->early_data_state = SSL_EARLY_DATA_WRITING;
1836 ret = SSL_write_ex(s, buf, num, written);
1837 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
1841 SSLerr(SSL_F_SSL_WRITE_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1846 int SSL_write_early_finish(SSL *s)
1850 if (s->early_data_state != SSL_EARLY_DATA_WRITE_RETRY) {
1851 SSLerr(SSL_F_SSL_WRITE_EARLY_FINISH, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1855 s->early_data_state = SSL_EARLY_DATA_WRITING;
1856 ret = ssl3_send_alert(s, SSL3_AL_WARNING, SSL_AD_END_OF_EARLY_DATA);
1858 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
1861 s->early_data_state = SSL_EARLY_DATA_FINISHED_WRITING;
1863 * We set the enc_write_ctx back to NULL because we may end up writing
1864 * in cleartext again if we get a HelloRetryRequest from the server.
1866 EVP_CIPHER_CTX_free(s->enc_write_ctx);
1867 s->enc_write_ctx = NULL;
1868 ossl_statem_set_in_init(s, 1);
1872 int SSL_shutdown(SSL *s)
1875 * Note that this function behaves differently from what one might
1876 * expect. Return values are 0 for no success (yet), 1 for success; but
1877 * calling it once is usually not enough, even if blocking I/O is used
1878 * (see ssl3_shutdown).
1881 if (s->handshake_func == NULL) {
1882 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1886 if (!SSL_in_init(s)) {
1887 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1888 struct ssl_async_args args;
1891 args.type = OTHERFUNC;
1892 args.f.func_other = s->method->ssl_shutdown;
1894 return ssl_start_async_job(s, &args, ssl_io_intern);
1896 return s->method->ssl_shutdown(s);
1899 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1904 int SSL_key_update(SSL *s, int updatetype)
1907 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
1908 * negotiated, and that it is appropriate to call SSL_key_update() instead
1909 * of SSL_renegotiate().
1911 if (!SSL_IS_TLS13(s)) {
1912 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1916 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1917 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1918 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1922 if (!SSL_is_init_finished(s)) {
1923 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1927 ossl_statem_set_in_init(s, 1);
1928 s->key_update = updatetype;
1932 int SSL_get_key_update_type(SSL *s)
1934 return s->key_update;
1937 int SSL_renegotiate(SSL *s)
1939 if (SSL_IS_TLS13(s)) {
1940 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1944 if (s->renegotiate == 0)
1949 return (s->method->ssl_renegotiate(s));
1952 int SSL_renegotiate_abbreviated(SSL *s)
1954 if (SSL_IS_TLS13(s))
1957 if (s->renegotiate == 0)
1962 return (s->method->ssl_renegotiate(s));
1965 int SSL_renegotiate_pending(SSL *s)
1968 * becomes true when negotiation is requested; false again once a
1969 * handshake has finished
1971 return (s->renegotiate != 0);
1974 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1979 case SSL_CTRL_GET_READ_AHEAD:
1980 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1981 case SSL_CTRL_SET_READ_AHEAD:
1982 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1983 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1986 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1987 s->msg_callback_arg = parg;
1991 return (s->mode |= larg);
1992 case SSL_CTRL_CLEAR_MODE:
1993 return (s->mode &= ~larg);
1994 case SSL_CTRL_GET_MAX_CERT_LIST:
1995 return (long)(s->max_cert_list);
1996 case SSL_CTRL_SET_MAX_CERT_LIST:
1999 l = (long)s->max_cert_list;
2000 s->max_cert_list = (size_t)larg;
2002 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2003 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2005 s->max_send_fragment = larg;
2006 if (s->max_send_fragment < s->split_send_fragment)
2007 s->split_send_fragment = s->max_send_fragment;
2009 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2010 if ((size_t)larg > s->max_send_fragment || larg == 0)
2012 s->split_send_fragment = larg;
2014 case SSL_CTRL_SET_MAX_PIPELINES:
2015 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2017 s->max_pipelines = larg;
2019 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2021 case SSL_CTRL_GET_RI_SUPPORT:
2023 return s->s3->send_connection_binding;
2026 case SSL_CTRL_CERT_FLAGS:
2027 return (s->cert->cert_flags |= larg);
2028 case SSL_CTRL_CLEAR_CERT_FLAGS:
2029 return (s->cert->cert_flags &= ~larg);
2031 case SSL_CTRL_GET_RAW_CIPHERLIST:
2033 if (s->s3->tmp.ciphers_raw == NULL)
2035 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2036 return (int)s->s3->tmp.ciphers_rawlen;
2038 return TLS_CIPHER_LEN;
2040 case SSL_CTRL_GET_EXTMS_SUPPORT:
2041 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2043 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2047 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2048 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2049 &s->min_proto_version);
2050 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2051 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2052 &s->max_proto_version);
2054 return (s->method->ssl_ctrl(s, cmd, larg, parg));
2058 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2061 case SSL_CTRL_SET_MSG_CALLBACK:
2062 s->msg_callback = (void (*)
2063 (int write_p, int version, int content_type,
2064 const void *buf, size_t len, SSL *ssl,
2069 return (s->method->ssl_callback_ctrl(s, cmd, fp));
2073 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2075 return ctx->sessions;
2078 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2081 /* For some cases with ctx == NULL perform syntax checks */
2084 #ifndef OPENSSL_NO_EC
2085 case SSL_CTRL_SET_GROUPS_LIST:
2086 return tls1_set_groups_list(NULL, NULL, parg);
2088 case SSL_CTRL_SET_SIGALGS_LIST:
2089 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2090 return tls1_set_sigalgs_list(NULL, parg, 0);
2097 case SSL_CTRL_GET_READ_AHEAD:
2098 return (ctx->read_ahead);
2099 case SSL_CTRL_SET_READ_AHEAD:
2100 l = ctx->read_ahead;
2101 ctx->read_ahead = larg;
2104 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2105 ctx->msg_callback_arg = parg;
2108 case SSL_CTRL_GET_MAX_CERT_LIST:
2109 return (long)(ctx->max_cert_list);
2110 case SSL_CTRL_SET_MAX_CERT_LIST:
2113 l = (long)ctx->max_cert_list;
2114 ctx->max_cert_list = (size_t)larg;
2117 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2120 l = (long)ctx->session_cache_size;
2121 ctx->session_cache_size = (size_t)larg;
2123 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2124 return (long)(ctx->session_cache_size);
2125 case SSL_CTRL_SET_SESS_CACHE_MODE:
2126 l = ctx->session_cache_mode;
2127 ctx->session_cache_mode = larg;
2129 case SSL_CTRL_GET_SESS_CACHE_MODE:
2130 return (ctx->session_cache_mode);
2132 case SSL_CTRL_SESS_NUMBER:
2133 return (lh_SSL_SESSION_num_items(ctx->sessions));
2134 case SSL_CTRL_SESS_CONNECT:
2135 return (ctx->stats.sess_connect);
2136 case SSL_CTRL_SESS_CONNECT_GOOD:
2137 return (ctx->stats.sess_connect_good);
2138 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2139 return (ctx->stats.sess_connect_renegotiate);
2140 case SSL_CTRL_SESS_ACCEPT:
2141 return (ctx->stats.sess_accept);
2142 case SSL_CTRL_SESS_ACCEPT_GOOD:
2143 return (ctx->stats.sess_accept_good);
2144 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2145 return (ctx->stats.sess_accept_renegotiate);
2146 case SSL_CTRL_SESS_HIT:
2147 return (ctx->stats.sess_hit);
2148 case SSL_CTRL_SESS_CB_HIT:
2149 return (ctx->stats.sess_cb_hit);
2150 case SSL_CTRL_SESS_MISSES:
2151 return (ctx->stats.sess_miss);
2152 case SSL_CTRL_SESS_TIMEOUTS:
2153 return (ctx->stats.sess_timeout);
2154 case SSL_CTRL_SESS_CACHE_FULL:
2155 return (ctx->stats.sess_cache_full);
2157 return (ctx->mode |= larg);
2158 case SSL_CTRL_CLEAR_MODE:
2159 return (ctx->mode &= ~larg);
2160 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2161 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2163 ctx->max_send_fragment = larg;
2164 if (ctx->max_send_fragment < ctx->split_send_fragment)
2165 ctx->split_send_fragment = ctx->max_send_fragment;
2167 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2168 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2170 ctx->split_send_fragment = larg;
2172 case SSL_CTRL_SET_MAX_PIPELINES:
2173 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2175 ctx->max_pipelines = larg;
2177 case SSL_CTRL_CERT_FLAGS:
2178 return (ctx->cert->cert_flags |= larg);
2179 case SSL_CTRL_CLEAR_CERT_FLAGS:
2180 return (ctx->cert->cert_flags &= ~larg);
2181 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2182 return ssl_set_version_bound(ctx->method->version, (int)larg,
2183 &ctx->min_proto_version);
2184 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2185 return ssl_set_version_bound(ctx->method->version, (int)larg,
2186 &ctx->max_proto_version);
2188 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2192 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2195 case SSL_CTRL_SET_MSG_CALLBACK:
2196 ctx->msg_callback = (void (*)
2197 (int write_p, int version, int content_type,
2198 const void *buf, size_t len, SSL *ssl,
2203 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2207 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2216 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2217 const SSL_CIPHER *const *bp)
2219 if ((*ap)->id > (*bp)->id)
2221 if ((*ap)->id < (*bp)->id)
2226 /** return a STACK of the ciphers available for the SSL and in order of
2228 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2231 if (s->cipher_list != NULL) {
2232 return (s->cipher_list);
2233 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2234 return (s->ctx->cipher_list);
2240 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2242 if ((s == NULL) || (s->session == NULL) || !s->server)
2244 return s->session->ciphers;
2247 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2249 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2251 ciphers = SSL_get_ciphers(s);
2254 ssl_set_client_disabled(s);
2255 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2256 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2257 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
2259 sk = sk_SSL_CIPHER_new_null();
2262 if (!sk_SSL_CIPHER_push(sk, c)) {
2263 sk_SSL_CIPHER_free(sk);
2271 /** return a STACK of the ciphers available for the SSL and in order of
2273 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2276 if (s->cipher_list_by_id != NULL) {
2277 return (s->cipher_list_by_id);
2278 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2279 return (s->ctx->cipher_list_by_id);
2285 /** The old interface to get the same thing as SSL_get_ciphers() */
2286 const char *SSL_get_cipher_list(const SSL *s, int n)
2288 const SSL_CIPHER *c;
2289 STACK_OF(SSL_CIPHER) *sk;
2293 sk = SSL_get_ciphers(s);
2294 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2296 c = sk_SSL_CIPHER_value(sk, n);
2302 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2304 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2307 return ctx->cipher_list;
2311 /** specify the ciphers to be used by default by the SSL_CTX */
2312 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2314 STACK_OF(SSL_CIPHER) *sk;
2316 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2317 &ctx->cipher_list_by_id, str, ctx->cert);
2319 * ssl_create_cipher_list may return an empty stack if it was unable to
2320 * find a cipher matching the given rule string (for example if the rule
2321 * string specifies a cipher which has been disabled). This is not an
2322 * error as far as ssl_create_cipher_list is concerned, and hence
2323 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2327 else if (sk_SSL_CIPHER_num(sk) == 0) {
2328 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2334 /** specify the ciphers to be used by the SSL */
2335 int SSL_set_cipher_list(SSL *s, const char *str)
2337 STACK_OF(SSL_CIPHER) *sk;
2339 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2340 &s->cipher_list_by_id, str, s->cert);
2341 /* see comment in SSL_CTX_set_cipher_list */
2344 else if (sk_SSL_CIPHER_num(sk) == 0) {
2345 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2351 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2354 STACK_OF(SSL_CIPHER) *sk;
2355 const SSL_CIPHER *c;
2358 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2362 sk = s->session->ciphers;
2364 if (sk_SSL_CIPHER_num(sk) == 0)
2367 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2370 c = sk_SSL_CIPHER_value(sk, i);
2371 n = strlen(c->name);
2378 memcpy(p, c->name, n + 1);
2387 /** return a servername extension value if provided in Client Hello, or NULL.
2388 * So far, only host_name types are defined (RFC 3546).
2391 const char *SSL_get_servername(const SSL *s, const int type)
2393 if (type != TLSEXT_NAMETYPE_host_name)
2396 return s->session && !s->ext.hostname ?
2397 s->session->ext.hostname : s->ext.hostname;
2400 int SSL_get_servername_type(const SSL *s)
2403 && (!s->ext.hostname ? s->session->
2404 ext.hostname : s->ext.hostname))
2405 return TLSEXT_NAMETYPE_host_name;
2410 * SSL_select_next_proto implements the standard protocol selection. It is
2411 * expected that this function is called from the callback set by
2412 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2413 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2414 * not included in the length. A byte string of length 0 is invalid. No byte
2415 * string may be truncated. The current, but experimental algorithm for
2416 * selecting the protocol is: 1) If the server doesn't support NPN then this
2417 * is indicated to the callback. In this case, the client application has to
2418 * abort the connection or have a default application level protocol. 2) If
2419 * the server supports NPN, but advertises an empty list then the client
2420 * selects the first protocol in its list, but indicates via the API that this
2421 * fallback case was enacted. 3) Otherwise, the client finds the first
2422 * protocol in the server's list that it supports and selects this protocol.
2423 * This is because it's assumed that the server has better information about
2424 * which protocol a client should use. 4) If the client doesn't support any
2425 * of the server's advertised protocols, then this is treated the same as
2426 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2427 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2429 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2430 const unsigned char *server,
2431 unsigned int server_len,
2432 const unsigned char *client, unsigned int client_len)
2435 const unsigned char *result;
2436 int status = OPENSSL_NPN_UNSUPPORTED;
2439 * For each protocol in server preference order, see if we support it.
2441 for (i = 0; i < server_len;) {
2442 for (j = 0; j < client_len;) {
2443 if (server[i] == client[j] &&
2444 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2445 /* We found a match */
2446 result = &server[i];
2447 status = OPENSSL_NPN_NEGOTIATED;
2457 /* There's no overlap between our protocols and the server's list. */
2459 status = OPENSSL_NPN_NO_OVERLAP;
2462 *out = (unsigned char *)result + 1;
2463 *outlen = result[0];
2467 #ifndef OPENSSL_NO_NEXTPROTONEG
2469 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2470 * client's requested protocol for this connection and returns 0. If the
2471 * client didn't request any protocol, then *data is set to NULL. Note that
2472 * the client can request any protocol it chooses. The value returned from
2473 * this function need not be a member of the list of supported protocols
2474 * provided by the callback.
2476 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2483 *len = (unsigned int)s->ext.npn_len;
2488 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2489 * a TLS server needs a list of supported protocols for Next Protocol
2490 * Negotiation. The returned list must be in wire format. The list is
2491 * returned by setting |out| to point to it and |outlen| to its length. This
2492 * memory will not be modified, but one should assume that the SSL* keeps a
2493 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2494 * wishes to advertise. Otherwise, no such extension will be included in the
2497 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2498 SSL_CTX_npn_advertised_cb_func cb,
2501 ctx->ext.npn_advertised_cb = cb;
2502 ctx->ext.npn_advertised_cb_arg = arg;
2506 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2507 * client needs to select a protocol from the server's provided list. |out|
2508 * must be set to point to the selected protocol (which may be within |in|).
2509 * The length of the protocol name must be written into |outlen|. The
2510 * server's advertised protocols are provided in |in| and |inlen|. The
2511 * callback can assume that |in| is syntactically valid. The client must
2512 * select a protocol. It is fatal to the connection if this callback returns
2513 * a value other than SSL_TLSEXT_ERR_OK.
2515 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2516 SSL_CTX_npn_select_cb_func cb,
2519 ctx->ext.npn_select_cb = cb;
2520 ctx->ext.npn_select_cb_arg = arg;
2525 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2526 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2527 * length-prefixed strings). Returns 0 on success.
2529 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2530 unsigned int protos_len)
2532 OPENSSL_free(ctx->ext.alpn);
2533 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2534 if (ctx->ext.alpn == NULL) {
2535 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2538 ctx->ext.alpn_len = protos_len;
2544 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2545 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2546 * length-prefixed strings). Returns 0 on success.
2548 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2549 unsigned int protos_len)
2551 OPENSSL_free(ssl->ext.alpn);
2552 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2553 if (ssl->ext.alpn == NULL) {
2554 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2557 ssl->ext.alpn_len = protos_len;
2563 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2564 * called during ClientHello processing in order to select an ALPN protocol
2565 * from the client's list of offered protocols.
2567 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2568 SSL_CTX_alpn_select_cb_func cb,
2571 ctx->ext.alpn_select_cb = cb;
2572 ctx->ext.alpn_select_cb_arg = arg;
2576 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2577 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2578 * (not including the leading length-prefix byte). If the server didn't
2579 * respond with a negotiated protocol then |*len| will be zero.
2581 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2586 *data = ssl->s3->alpn_selected;
2590 *len = (unsigned int)ssl->s3->alpn_selected_len;
2593 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2594 const char *label, size_t llen,
2595 const unsigned char *p, size_t plen,
2598 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2601 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2606 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2608 const unsigned char *session_id = a->session_id;
2610 unsigned char tmp_storage[4];
2612 if (a->session_id_length < sizeof(tmp_storage)) {
2613 memset(tmp_storage, 0, sizeof(tmp_storage));
2614 memcpy(tmp_storage, a->session_id, a->session_id_length);
2615 session_id = tmp_storage;
2619 ((unsigned long)session_id[0]) |
2620 ((unsigned long)session_id[1] << 8L) |
2621 ((unsigned long)session_id[2] << 16L) |
2622 ((unsigned long)session_id[3] << 24L);
2627 * NB: If this function (or indeed the hash function which uses a sort of
2628 * coarser function than this one) is changed, ensure
2629 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2630 * being able to construct an SSL_SESSION that will collide with any existing
2631 * session with a matching session ID.
2633 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2635 if (a->ssl_version != b->ssl_version)
2637 if (a->session_id_length != b->session_id_length)
2639 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2643 * These wrapper functions should remain rather than redeclaring
2644 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2645 * variable. The reason is that the functions aren't static, they're exposed
2649 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2651 SSL_CTX *ret = NULL;
2654 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2658 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2661 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2662 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2665 ret = OPENSSL_zalloc(sizeof(*ret));
2670 ret->min_proto_version = 0;
2671 ret->max_proto_version = 0;
2672 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2673 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2674 /* We take the system default. */
2675 ret->session_timeout = meth->get_timeout();
2676 ret->references = 1;
2677 ret->lock = CRYPTO_THREAD_lock_new();
2678 if (ret->lock == NULL) {
2679 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2683 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2684 ret->verify_mode = SSL_VERIFY_NONE;
2685 if ((ret->cert = ssl_cert_new()) == NULL)
2688 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2689 if (ret->sessions == NULL)
2691 ret->cert_store = X509_STORE_new();
2692 if (ret->cert_store == NULL)
2694 #ifndef OPENSSL_NO_CT
2695 ret->ctlog_store = CTLOG_STORE_new();
2696 if (ret->ctlog_store == NULL)
2699 if (!ssl_create_cipher_list(ret->method,
2700 &ret->cipher_list, &ret->cipher_list_by_id,
2701 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2702 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2703 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2707 ret->param = X509_VERIFY_PARAM_new();
2708 if (ret->param == NULL)
2711 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2712 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2715 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2716 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2720 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2723 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2726 /* No compression for DTLS */
2727 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2728 ret->comp_methods = SSL_COMP_get_compression_methods();
2730 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2731 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2733 /* Setup RFC5077 ticket keys */
2734 if ((RAND_bytes(ret->ext.tick_key_name,
2735 sizeof(ret->ext.tick_key_name)) <= 0)
2736 || (RAND_bytes(ret->ext.tick_hmac_key,
2737 sizeof(ret->ext.tick_hmac_key)) <= 0)
2738 || (RAND_bytes(ret->ext.tick_aes_key,
2739 sizeof(ret->ext.tick_aes_key)) <= 0))
2740 ret->options |= SSL_OP_NO_TICKET;
2742 #ifndef OPENSSL_NO_SRP
2743 if (!SSL_CTX_SRP_CTX_init(ret))
2746 #ifndef OPENSSL_NO_ENGINE
2747 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2748 # define eng_strx(x) #x
2749 # define eng_str(x) eng_strx(x)
2750 /* Use specific client engine automatically... ignore errors */
2753 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2756 ENGINE_load_builtin_engines();
2757 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2759 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2765 * Default is to connect to non-RI servers. When RI is more widely
2766 * deployed might change this.
2768 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2770 * Disable compression by default to prevent CRIME. Applications can
2771 * re-enable compression by configuring
2772 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2773 * or by using the SSL_CONF library.
2775 ret->options |= SSL_OP_NO_COMPRESSION;
2777 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2780 * Default max early data is a fully loaded single record. Could be split
2781 * across multiple records in practice
2783 ret->max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
2787 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2793 int SSL_CTX_up_ref(SSL_CTX *ctx)
2797 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2800 REF_PRINT_COUNT("SSL_CTX", ctx);
2801 REF_ASSERT_ISNT(i < 2);
2802 return ((i > 1) ? 1 : 0);
2805 void SSL_CTX_free(SSL_CTX *a)
2812 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2813 REF_PRINT_COUNT("SSL_CTX", a);
2816 REF_ASSERT_ISNT(i < 0);
2818 X509_VERIFY_PARAM_free(a->param);
2819 dane_ctx_final(&a->dane);
2822 * Free internal session cache. However: the remove_cb() may reference
2823 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2824 * after the sessions were flushed.
2825 * As the ex_data handling routines might also touch the session cache,
2826 * the most secure solution seems to be: empty (flush) the cache, then
2827 * free ex_data, then finally free the cache.
2828 * (See ticket [openssl.org #212].)
2830 if (a->sessions != NULL)
2831 SSL_CTX_flush_sessions(a, 0);
2833 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2834 lh_SSL_SESSION_free(a->sessions);
2835 X509_STORE_free(a->cert_store);
2836 #ifndef OPENSSL_NO_CT
2837 CTLOG_STORE_free(a->ctlog_store);
2839 sk_SSL_CIPHER_free(a->cipher_list);
2840 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2841 ssl_cert_free(a->cert);
2842 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2843 sk_X509_pop_free(a->extra_certs, X509_free);
2844 a->comp_methods = NULL;
2845 #ifndef OPENSSL_NO_SRTP
2846 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2848 #ifndef OPENSSL_NO_SRP
2849 SSL_CTX_SRP_CTX_free(a);
2851 #ifndef OPENSSL_NO_ENGINE
2852 ENGINE_finish(a->client_cert_engine);
2855 #ifndef OPENSSL_NO_EC
2856 OPENSSL_free(a->ext.ecpointformats);
2857 OPENSSL_free(a->ext.supportedgroups);
2859 OPENSSL_free(a->ext.alpn);
2861 CRYPTO_THREAD_lock_free(a->lock);
2866 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2868 ctx->default_passwd_callback = cb;
2871 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2873 ctx->default_passwd_callback_userdata = u;
2876 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2878 return ctx->default_passwd_callback;
2881 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2883 return ctx->default_passwd_callback_userdata;
2886 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2888 s->default_passwd_callback = cb;
2891 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2893 s->default_passwd_callback_userdata = u;
2896 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2898 return s->default_passwd_callback;
2901 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2903 return s->default_passwd_callback_userdata;
2906 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2907 int (*cb) (X509_STORE_CTX *, void *),
2910 ctx->app_verify_callback = cb;
2911 ctx->app_verify_arg = arg;
2914 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2915 int (*cb) (int, X509_STORE_CTX *))
2917 ctx->verify_mode = mode;
2918 ctx->default_verify_callback = cb;
2921 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2923 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2926 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2928 ssl_cert_set_cert_cb(c->cert, cb, arg);
2931 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2933 ssl_cert_set_cert_cb(s->cert, cb, arg);
2936 void ssl_set_masks(SSL *s)
2939 uint32_t *pvalid = s->s3->tmp.valid_flags;
2940 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2941 unsigned long mask_k, mask_a;
2942 #ifndef OPENSSL_NO_EC
2943 int have_ecc_cert, ecdsa_ok;
2948 #ifndef OPENSSL_NO_DH
2949 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2954 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2955 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2956 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
2957 #ifndef OPENSSL_NO_EC
2958 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2964 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2965 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2968 #ifndef OPENSSL_NO_GOST
2969 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2970 mask_k |= SSL_kGOST;
2971 mask_a |= SSL_aGOST12;
2973 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2974 mask_k |= SSL_kGOST;
2975 mask_a |= SSL_aGOST12;
2977 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2978 mask_k |= SSL_kGOST;
2979 mask_a |= SSL_aGOST01;
2989 if (rsa_enc || rsa_sign) {
2997 mask_a |= SSL_aNULL;
3000 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3001 * depending on the key usage extension.
3003 #ifndef OPENSSL_NO_EC
3004 if (have_ecc_cert) {
3006 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3007 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3008 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3011 mask_a |= SSL_aECDSA;
3015 #ifndef OPENSSL_NO_EC
3016 mask_k |= SSL_kECDHE;
3019 #ifndef OPENSSL_NO_PSK
3022 if (mask_k & SSL_kRSA)
3023 mask_k |= SSL_kRSAPSK;
3024 if (mask_k & SSL_kDHE)
3025 mask_k |= SSL_kDHEPSK;
3026 if (mask_k & SSL_kECDHE)
3027 mask_k |= SSL_kECDHEPSK;
3030 s->s3->tmp.mask_k = mask_k;
3031 s->s3->tmp.mask_a = mask_a;
3034 #ifndef OPENSSL_NO_EC
3036 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3038 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3039 /* key usage, if present, must allow signing */
3040 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3041 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3042 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3046 return 1; /* all checks are ok */
3051 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3052 size_t *serverinfo_length)
3054 CERT_PKEY *cpk = s->s3->tmp.cert;
3055 *serverinfo_length = 0;
3057 if (cpk == NULL || cpk->serverinfo == NULL)
3060 *serverinfo = cpk->serverinfo;
3061 *serverinfo_length = cpk->serverinfo_length;
3065 void ssl_update_cache(SSL *s, int mode)
3070 * If the session_id_length is 0, we are not supposed to cache it, and it
3071 * would be rather hard to do anyway :-)
3073 if (s->session->session_id_length == 0)
3076 i = s->session_ctx->session_cache_mode;
3077 if ((i & mode) && (!s->hit)
3078 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
3079 || SSL_CTX_add_session(s->session_ctx, s->session))
3080 && (s->session_ctx->new_session_cb != NULL)) {
3081 SSL_SESSION_up_ref(s->session);
3082 if (!s->session_ctx->new_session_cb(s, s->session))
3083 SSL_SESSION_free(s->session);
3086 /* auto flush every 255 connections */
3087 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3088 if ((((mode & SSL_SESS_CACHE_CLIENT)
3089 ? s->session_ctx->stats.sess_connect_good
3090 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
3091 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3096 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3101 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3106 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3110 if (s->method != meth) {
3111 const SSL_METHOD *sm = s->method;
3112 int (*hf) (SSL *) = s->handshake_func;
3114 if (sm->version == meth->version)
3119 ret = s->method->ssl_new(s);
3122 if (hf == sm->ssl_connect)
3123 s->handshake_func = meth->ssl_connect;
3124 else if (hf == sm->ssl_accept)
3125 s->handshake_func = meth->ssl_accept;
3130 int SSL_get_error(const SSL *s, int i)
3137 return (SSL_ERROR_NONE);
3140 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3141 * where we do encode the error
3143 if ((l = ERR_peek_error()) != 0) {
3144 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3145 return (SSL_ERROR_SYSCALL);
3147 return (SSL_ERROR_SSL);
3150 if (SSL_want_read(s)) {
3151 bio = SSL_get_rbio(s);
3152 if (BIO_should_read(bio))
3153 return (SSL_ERROR_WANT_READ);
3154 else if (BIO_should_write(bio))
3156 * This one doesn't make too much sense ... We never try to write
3157 * to the rbio, and an application program where rbio and wbio
3158 * are separate couldn't even know what it should wait for.
3159 * However if we ever set s->rwstate incorrectly (so that we have
3160 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3161 * wbio *are* the same, this test works around that bug; so it
3162 * might be safer to keep it.
3164 return (SSL_ERROR_WANT_WRITE);
3165 else if (BIO_should_io_special(bio)) {
3166 reason = BIO_get_retry_reason(bio);
3167 if (reason == BIO_RR_CONNECT)
3168 return (SSL_ERROR_WANT_CONNECT);
3169 else if (reason == BIO_RR_ACCEPT)
3170 return (SSL_ERROR_WANT_ACCEPT);
3172 return (SSL_ERROR_SYSCALL); /* unknown */
3176 if (SSL_want_write(s)) {
3178 * Access wbio directly - in order to use the buffered bio if
3182 if (BIO_should_write(bio))
3183 return (SSL_ERROR_WANT_WRITE);
3184 else if (BIO_should_read(bio))
3186 * See above (SSL_want_read(s) with BIO_should_write(bio))
3188 return (SSL_ERROR_WANT_READ);
3189 else if (BIO_should_io_special(bio)) {
3190 reason = BIO_get_retry_reason(bio);
3191 if (reason == BIO_RR_CONNECT)
3192 return (SSL_ERROR_WANT_CONNECT);
3193 else if (reason == BIO_RR_ACCEPT)
3194 return (SSL_ERROR_WANT_ACCEPT);
3196 return (SSL_ERROR_SYSCALL);
3199 if (SSL_want_x509_lookup(s))
3200 return (SSL_ERROR_WANT_X509_LOOKUP);
3201 if (SSL_want_async(s))
3202 return SSL_ERROR_WANT_ASYNC;
3203 if (SSL_want_async_job(s))
3204 return SSL_ERROR_WANT_ASYNC_JOB;
3205 if (SSL_want_early(s))
3206 return SSL_ERROR_WANT_EARLY;
3208 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3209 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3210 return (SSL_ERROR_ZERO_RETURN);
3212 return (SSL_ERROR_SYSCALL);
3215 static int ssl_do_handshake_intern(void *vargs)
3217 struct ssl_async_args *args;
3220 args = (struct ssl_async_args *)vargs;
3223 return s->handshake_func(s);
3226 int SSL_do_handshake(SSL *s)
3230 if (s->handshake_func == NULL) {
3231 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3235 if (s->early_data_state == SSL_EARLY_DATA_WRITE_RETRY
3236 || s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY)
3239 s->method->ssl_renegotiate_check(s, 0);
3241 if (SSL_in_init(s) || SSL_in_before(s)) {
3242 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3243 struct ssl_async_args args;
3247 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3249 ret = s->handshake_func(s);
3255 void SSL_set_accept_state(SSL *s)
3259 ossl_statem_clear(s);
3260 s->handshake_func = s->method->ssl_accept;
3264 void SSL_set_connect_state(SSL *s)
3268 ossl_statem_clear(s);
3269 s->handshake_func = s->method->ssl_connect;
3273 int ssl_undefined_function(SSL *s)
3275 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3279 int ssl_undefined_void_function(void)
3281 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3282 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3286 int ssl_undefined_const_function(const SSL *s)
3291 const SSL_METHOD *ssl_bad_method(int ver)
3293 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3297 const char *ssl_protocol_to_string(int version)
3301 case TLS1_3_VERSION:
3304 case TLS1_2_VERSION:
3307 case TLS1_1_VERSION:
3322 case DTLS1_2_VERSION:
3330 const char *SSL_get_version(const SSL *s)
3332 return ssl_protocol_to_string(s->version);
3335 SSL *SSL_dup(SSL *s)
3337 STACK_OF(X509_NAME) *sk;
3342 /* If we're not quiescent, just up_ref! */
3343 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3344 CRYPTO_UP_REF(&s->references, &i, s->lock);
3349 * Otherwise, copy configuration state, and session if set.
3351 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3354 if (s->session != NULL) {
3356 * Arranges to share the same session via up_ref. This "copies"
3357 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3359 if (!SSL_copy_session_id(ret, s))
3363 * No session has been established yet, so we have to expect that
3364 * s->cert or ret->cert will be changed later -- they should not both
3365 * point to the same object, and thus we can't use
3366 * SSL_copy_session_id.
3368 if (!SSL_set_ssl_method(ret, s->method))
3371 if (s->cert != NULL) {
3372 ssl_cert_free(ret->cert);
3373 ret->cert = ssl_cert_dup(s->cert);
3374 if (ret->cert == NULL)
3378 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3379 (int)s->sid_ctx_length))
3383 if (!ssl_dane_dup(ret, s))
3385 ret->version = s->version;
3386 ret->options = s->options;
3387 ret->mode = s->mode;
3388 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3389 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3390 ret->msg_callback = s->msg_callback;
3391 ret->msg_callback_arg = s->msg_callback_arg;
3392 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3393 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3394 ret->generate_session_id = s->generate_session_id;
3396 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3398 /* copy app data, a little dangerous perhaps */
3399 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3402 /* setup rbio, and wbio */
3403 if (s->rbio != NULL) {
3404 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3407 if (s->wbio != NULL) {
3408 if (s->wbio != s->rbio) {
3409 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3412 BIO_up_ref(ret->rbio);
3413 ret->wbio = ret->rbio;
3417 ret->server = s->server;
3418 if (s->handshake_func) {
3420 SSL_set_accept_state(ret);
3422 SSL_set_connect_state(ret);
3424 ret->shutdown = s->shutdown;
3427 ret->default_passwd_callback = s->default_passwd_callback;
3428 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3430 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3432 /* dup the cipher_list and cipher_list_by_id stacks */
3433 if (s->cipher_list != NULL) {
3434 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3437 if (s->cipher_list_by_id != NULL)
3438 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3442 /* Dup the client_CA list */
3443 if (s->client_CA != NULL) {
3444 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3446 ret->client_CA = sk;
3447 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3448 xn = sk_X509_NAME_value(sk, i);
3449 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3462 void ssl_clear_cipher_ctx(SSL *s)
3464 if (s->enc_read_ctx != NULL) {
3465 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3466 s->enc_read_ctx = NULL;
3468 if (s->enc_write_ctx != NULL) {
3469 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3470 s->enc_write_ctx = NULL;
3472 #ifndef OPENSSL_NO_COMP
3473 COMP_CTX_free(s->expand);
3475 COMP_CTX_free(s->compress);
3480 X509 *SSL_get_certificate(const SSL *s)
3482 if (s->cert != NULL)
3483 return (s->cert->key->x509);
3488 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3490 if (s->cert != NULL)
3491 return (s->cert->key->privatekey);
3496 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3498 if (ctx->cert != NULL)
3499 return ctx->cert->key->x509;
3504 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3506 if (ctx->cert != NULL)
3507 return ctx->cert->key->privatekey;
3512 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3514 if ((s->session != NULL) && (s->session->cipher != NULL))
3515 return (s->session->cipher);
3519 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3521 #ifndef OPENSSL_NO_COMP
3522 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3528 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3530 #ifndef OPENSSL_NO_COMP
3531 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3537 int ssl_init_wbio_buffer(SSL *s)
3541 if (s->bbio != NULL) {
3542 /* Already buffered. */
3546 bbio = BIO_new(BIO_f_buffer());
3547 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3549 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3553 s->wbio = BIO_push(bbio, s->wbio);
3558 void ssl_free_wbio_buffer(SSL *s)
3560 /* callers ensure s is never null */
3561 if (s->bbio == NULL)
3564 s->wbio = BIO_pop(s->wbio);
3565 assert(s->wbio != NULL);
3570 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3572 ctx->quiet_shutdown = mode;
3575 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3577 return (ctx->quiet_shutdown);
3580 void SSL_set_quiet_shutdown(SSL *s, int mode)
3582 s->quiet_shutdown = mode;
3585 int SSL_get_quiet_shutdown(const SSL *s)
3587 return (s->quiet_shutdown);
3590 void SSL_set_shutdown(SSL *s, int mode)
3595 int SSL_get_shutdown(const SSL *s)
3600 int SSL_version(const SSL *s)
3605 int SSL_client_version(const SSL *s)
3607 return s->client_version;
3610 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3615 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3618 if (ssl->ctx == ctx)
3621 ctx = ssl->session_ctx;
3622 new_cert = ssl_cert_dup(ctx->cert);
3623 if (new_cert == NULL) {
3626 ssl_cert_free(ssl->cert);
3627 ssl->cert = new_cert;
3630 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3631 * so setter APIs must prevent invalid lengths from entering the system.
3633 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3636 * If the session ID context matches that of the parent SSL_CTX,
3637 * inherit it from the new SSL_CTX as well. If however the context does
3638 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3639 * leave it unchanged.
3641 if ((ssl->ctx != NULL) &&
3642 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3643 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3644 ssl->sid_ctx_length = ctx->sid_ctx_length;
3645 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3648 SSL_CTX_up_ref(ctx);
3649 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3655 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3657 return (X509_STORE_set_default_paths(ctx->cert_store));
3660 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3662 X509_LOOKUP *lookup;
3664 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3667 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3669 /* Clear any errors if the default directory does not exist */
3675 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3677 X509_LOOKUP *lookup;
3679 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3683 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3685 /* Clear any errors if the default file does not exist */
3691 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3694 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3697 void SSL_set_info_callback(SSL *ssl,
3698 void (*cb) (const SSL *ssl, int type, int val))
3700 ssl->info_callback = cb;
3704 * One compiler (Diab DCC) doesn't like argument names in returned function
3707 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3710 return ssl->info_callback;
3713 void SSL_set_verify_result(SSL *ssl, long arg)
3715 ssl->verify_result = arg;
3718 long SSL_get_verify_result(const SSL *ssl)
3720 return (ssl->verify_result);
3723 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3726 return sizeof(ssl->s3->client_random);
3727 if (outlen > sizeof(ssl->s3->client_random))
3728 outlen = sizeof(ssl->s3->client_random);
3729 memcpy(out, ssl->s3->client_random, outlen);
3733 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3736 return sizeof(ssl->s3->server_random);
3737 if (outlen > sizeof(ssl->s3->server_random))
3738 outlen = sizeof(ssl->s3->server_random);
3739 memcpy(out, ssl->s3->server_random, outlen);
3743 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3744 unsigned char *out, size_t outlen)
3747 return session->master_key_length;
3748 if (outlen > session->master_key_length)
3749 outlen = session->master_key_length;
3750 memcpy(out, session->master_key, outlen);
3754 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3756 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3759 void *SSL_get_ex_data(const SSL *s, int idx)
3761 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3764 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3766 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3769 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3771 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3774 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3776 return (ctx->cert_store);
3779 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3781 X509_STORE_free(ctx->cert_store);
3782 ctx->cert_store = store;
3785 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3788 X509_STORE_up_ref(store);
3789 SSL_CTX_set_cert_store(ctx, store);
3792 int SSL_want(const SSL *s)
3794 return (s->rwstate);
3798 * \brief Set the callback for generating temporary DH keys.
3799 * \param ctx the SSL context.
3800 * \param dh the callback
3803 #ifndef OPENSSL_NO_DH
3804 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3805 DH *(*dh) (SSL *ssl, int is_export,
3808 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3811 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3814 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3818 #ifndef OPENSSL_NO_PSK
3819 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3821 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3822 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3825 OPENSSL_free(ctx->cert->psk_identity_hint);
3826 if (identity_hint != NULL) {
3827 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3828 if (ctx->cert->psk_identity_hint == NULL)
3831 ctx->cert->psk_identity_hint = NULL;
3835 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3840 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3841 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3844 OPENSSL_free(s->cert->psk_identity_hint);
3845 if (identity_hint != NULL) {
3846 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3847 if (s->cert->psk_identity_hint == NULL)
3850 s->cert->psk_identity_hint = NULL;
3854 const char *SSL_get_psk_identity_hint(const SSL *s)
3856 if (s == NULL || s->session == NULL)
3858 return (s->session->psk_identity_hint);
3861 const char *SSL_get_psk_identity(const SSL *s)
3863 if (s == NULL || s->session == NULL)
3865 return (s->session->psk_identity);
3868 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3870 s->psk_client_callback = cb;
3873 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3875 ctx->psk_client_callback = cb;
3878 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3880 s->psk_server_callback = cb;
3883 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3885 ctx->psk_server_callback = cb;
3889 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3890 void (*cb) (int write_p, int version,
3891 int content_type, const void *buf,
3892 size_t len, SSL *ssl, void *arg))
3894 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3897 void SSL_set_msg_callback(SSL *ssl,
3898 void (*cb) (int write_p, int version,
3899 int content_type, const void *buf,
3900 size_t len, SSL *ssl, void *arg))
3902 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3905 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3906 int (*cb) (SSL *ssl,
3910 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3911 (void (*)(void))cb);
3914 void SSL_set_not_resumable_session_callback(SSL *ssl,
3915 int (*cb) (SSL *ssl,
3916 int is_forward_secure))
3918 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3919 (void (*)(void))cb);
3923 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3924 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3925 * If EVP_MD pointer is passed, initializes ctx with this md.
3926 * Returns the newly allocated ctx;
3929 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3931 ssl_clear_hash_ctx(hash);
3932 *hash = EVP_MD_CTX_new();
3933 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3934 EVP_MD_CTX_free(*hash);
3941 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3944 EVP_MD_CTX_free(*hash);
3948 /* Retrieve handshake hashes */
3949 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3952 EVP_MD_CTX *ctx = NULL;
3953 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3954 int hashleni = EVP_MD_CTX_size(hdgst);
3957 if (hashleni < 0 || (size_t)hashleni > outlen)
3960 ctx = EVP_MD_CTX_new();
3964 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3965 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3968 *hashlen = hashleni;
3972 EVP_MD_CTX_free(ctx);
3976 int SSL_session_reused(SSL *s)
3981 int SSL_is_server(SSL *s)
3986 #if OPENSSL_API_COMPAT < 0x10100000L
3987 void SSL_set_debug(SSL *s, int debug)
3989 /* Old function was do-nothing anyway... */
3995 void SSL_set_security_level(SSL *s, int level)
3997 s->cert->sec_level = level;
4000 int SSL_get_security_level(const SSL *s)
4002 return s->cert->sec_level;
4005 void SSL_set_security_callback(SSL *s,
4006 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4007 int op, int bits, int nid,
4008 void *other, void *ex))
4010 s->cert->sec_cb = cb;
4013 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4014 const SSL_CTX *ctx, int op,
4015 int bits, int nid, void *other,
4017 return s->cert->sec_cb;
4020 void SSL_set0_security_ex_data(SSL *s, void *ex)
4022 s->cert->sec_ex = ex;
4025 void *SSL_get0_security_ex_data(const SSL *s)
4027 return s->cert->sec_ex;
4030 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4032 ctx->cert->sec_level = level;
4035 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4037 return ctx->cert->sec_level;
4040 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4041 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4042 int op, int bits, int nid,
4043 void *other, void *ex))
4045 ctx->cert->sec_cb = cb;
4048 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4054 return ctx->cert->sec_cb;
4057 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4059 ctx->cert->sec_ex = ex;
4062 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4064 return ctx->cert->sec_ex;
4068 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4069 * can return unsigned long, instead of the generic long return value from the
4070 * control interface.
4072 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4074 return ctx->options;
4077 unsigned long SSL_get_options(const SSL *s)
4082 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4084 return ctx->options |= op;
4087 unsigned long SSL_set_options(SSL *s, unsigned long op)
4089 return s->options |= op;
4092 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4094 return ctx->options &= ~op;
4097 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4099 return s->options &= ~op;
4102 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4104 return s->verified_chain;
4107 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4109 #ifndef OPENSSL_NO_CT
4112 * Moves SCTs from the |src| stack to the |dst| stack.
4113 * The source of each SCT will be set to |origin|.
4114 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4116 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4118 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4119 sct_source_t origin)
4125 *dst = sk_SCT_new_null();
4127 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4132 while ((sct = sk_SCT_pop(src)) != NULL) {
4133 if (SCT_set_source(sct, origin) != 1)
4136 if (sk_SCT_push(*dst, sct) <= 0)
4144 sk_SCT_push(src, sct); /* Put the SCT back */
4149 * Look for data collected during ServerHello and parse if found.
4150 * Returns the number of SCTs extracted.
4152 static int ct_extract_tls_extension_scts(SSL *s)
4154 int scts_extracted = 0;
4156 if (s->ext.scts != NULL) {
4157 const unsigned char *p = s->ext.scts;
4158 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4160 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4162 SCT_LIST_free(scts);
4165 return scts_extracted;
4169 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4170 * contains an SCT X509 extension. They will be stored in |s->scts|.
4172 * - The number of SCTs extracted, assuming an OCSP response exists.
4173 * - 0 if no OCSP response exists or it contains no SCTs.
4174 * - A negative integer if an error occurs.
4176 static int ct_extract_ocsp_response_scts(SSL *s)
4178 # ifndef OPENSSL_NO_OCSP
4179 int scts_extracted = 0;
4180 const unsigned char *p;
4181 OCSP_BASICRESP *br = NULL;
4182 OCSP_RESPONSE *rsp = NULL;
4183 STACK_OF(SCT) *scts = NULL;
4186 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4189 p = s->ext.ocsp.resp;
4190 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4194 br = OCSP_response_get1_basic(rsp);
4198 for (i = 0; i < OCSP_resp_count(br); ++i) {
4199 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4205 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4207 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4208 if (scts_extracted < 0)
4212 SCT_LIST_free(scts);
4213 OCSP_BASICRESP_free(br);
4214 OCSP_RESPONSE_free(rsp);
4215 return scts_extracted;
4217 /* Behave as if no OCSP response exists */
4223 * Attempts to extract SCTs from the peer certificate.
4224 * Return the number of SCTs extracted, or a negative integer if an error
4227 static int ct_extract_x509v3_extension_scts(SSL *s)
4229 int scts_extracted = 0;
4230 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4233 STACK_OF(SCT) *scts =
4234 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4237 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4239 SCT_LIST_free(scts);
4242 return scts_extracted;
4246 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4247 * response (if it exists) and X509v3 extensions in the certificate.
4248 * Returns NULL if an error occurs.
4250 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4252 if (!s->scts_parsed) {
4253 if (ct_extract_tls_extension_scts(s) < 0 ||
4254 ct_extract_ocsp_response_scts(s) < 0 ||
4255 ct_extract_x509v3_extension_scts(s) < 0)
4265 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4266 const STACK_OF(SCT) *scts, void *unused_arg)
4271 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4272 const STACK_OF(SCT) *scts, void *unused_arg)
4274 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4277 for (i = 0; i < count; ++i) {
4278 SCT *sct = sk_SCT_value(scts, i);
4279 int status = SCT_get_validation_status(sct);
4281 if (status == SCT_VALIDATION_STATUS_VALID)
4284 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4288 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4292 * Since code exists that uses the custom extension handler for CT, look
4293 * for this and throw an error if they have already registered to use CT.
4295 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4296 TLSEXT_TYPE_signed_certificate_timestamp))
4298 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4299 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4303 if (callback != NULL) {
4305 * If we are validating CT, then we MUST accept SCTs served via OCSP
4307 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4311 s->ct_validation_callback = callback;
4312 s->ct_validation_callback_arg = arg;
4317 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4318 ssl_ct_validation_cb callback, void *arg)
4321 * Since code exists that uses the custom extension handler for CT, look for
4322 * this and throw an error if they have already registered to use CT.
4324 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4325 TLSEXT_TYPE_signed_certificate_timestamp))
4327 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4328 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4332 ctx->ct_validation_callback = callback;
4333 ctx->ct_validation_callback_arg = arg;
4337 int SSL_ct_is_enabled(const SSL *s)
4339 return s->ct_validation_callback != NULL;
4342 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4344 return ctx->ct_validation_callback != NULL;
4347 int ssl_validate_ct(SSL *s)
4350 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4352 SSL_DANE *dane = &s->dane;
4353 CT_POLICY_EVAL_CTX *ctx = NULL;
4354 const STACK_OF(SCT) *scts;
4357 * If no callback is set, the peer is anonymous, or its chain is invalid,
4358 * skip SCT validation - just return success. Applications that continue
4359 * handshakes without certificates, with unverified chains, or pinned leaf
4360 * certificates are outside the scope of the WebPKI and CT.
4362 * The above exclusions notwithstanding the vast majority of peers will
4363 * have rather ordinary certificate chains validated by typical
4364 * applications that perform certificate verification and therefore will
4365 * process SCTs when enabled.
4367 if (s->ct_validation_callback == NULL || cert == NULL ||
4368 s->verify_result != X509_V_OK ||
4369 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4373 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4374 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4376 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4377 switch (dane->mtlsa->usage) {
4378 case DANETLS_USAGE_DANE_TA:
4379 case DANETLS_USAGE_DANE_EE:
4384 ctx = CT_POLICY_EVAL_CTX_new();
4386 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4390 issuer = sk_X509_value(s->verified_chain, 1);
4391 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4392 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4393 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4394 CT_POLICY_EVAL_CTX_set_time(ctx, SSL_SESSION_get_time(SSL_get0_session(s)));
4396 scts = SSL_get0_peer_scts(s);
4399 * This function returns success (> 0) only when all the SCTs are valid, 0
4400 * when some are invalid, and < 0 on various internal errors (out of
4401 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4402 * reason to abort the handshake, that decision is up to the callback.
4403 * Therefore, we error out only in the unexpected case that the return
4404 * value is negative.
4406 * XXX: One might well argue that the return value of this function is an
4407 * unfortunate design choice. Its job is only to determine the validation
4408 * status of each of the provided SCTs. So long as it correctly separates
4409 * the wheat from the chaff it should return success. Failure in this case
4410 * ought to correspond to an inability to carry out its duties.
4412 if (SCT_LIST_validate(scts, ctx) < 0) {
4413 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4417 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4419 ret = 0; /* This function returns 0 on failure */
4422 CT_POLICY_EVAL_CTX_free(ctx);
4424 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4425 * failure return code here. Also the application may wish the complete
4426 * the handshake, and then disconnect cleanly at a higher layer, after
4427 * checking the verification status of the completed connection.
4429 * We therefore force a certificate verification failure which will be
4430 * visible via SSL_get_verify_result() and cached as part of any resumed
4433 * Note: the permissive callback is for information gathering only, always
4434 * returns success, and does not affect verification status. Only the
4435 * strict callback or a custom application-specified callback can trigger
4436 * connection failure or record a verification error.
4439 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4443 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4445 switch (validation_mode) {
4447 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4449 case SSL_CT_VALIDATION_PERMISSIVE:
4450 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4451 case SSL_CT_VALIDATION_STRICT:
4452 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4456 int SSL_enable_ct(SSL *s, int validation_mode)
4458 switch (validation_mode) {
4460 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4462 case SSL_CT_VALIDATION_PERMISSIVE:
4463 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4464 case SSL_CT_VALIDATION_STRICT:
4465 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4469 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4471 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4474 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4476 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4479 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4481 CTLOG_STORE_free(ctx->ctlog_store);
4482 ctx->ctlog_store = logs;
4485 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4487 return ctx->ctlog_store;
4490 #endif /* OPENSSL_NO_CT */
4492 void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn cb, void *arg)
4495 c->early_cb_arg = arg;
4498 int SSL_early_isv2(SSL *s)
4500 if (s->clienthello == NULL)
4502 return s->clienthello->isv2;
4505 unsigned int SSL_early_get0_legacy_version(SSL *s)
4507 if (s->clienthello == NULL)
4509 return s->clienthello->legacy_version;
4512 size_t SSL_early_get0_random(SSL *s, const unsigned char **out)
4514 if (s->clienthello == NULL)
4517 *out = s->clienthello->random;
4518 return SSL3_RANDOM_SIZE;
4521 size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out)
4523 if (s->clienthello == NULL)
4526 *out = s->clienthello->session_id;
4527 return s->clienthello->session_id_len;
4530 size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out)
4532 if (s->clienthello == NULL)
4535 *out = PACKET_data(&s->clienthello->ciphersuites);
4536 return PACKET_remaining(&s->clienthello->ciphersuites);
4539 size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out)
4541 if (s->clienthello == NULL)
4544 *out = s->clienthello->compressions;
4545 return s->clienthello->compressions_len;
4548 int SSL_early_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4554 if (s->clienthello == NULL)
4556 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4557 r = s->clienthello->pre_proc_exts + i;
4558 if (r->present && r->type == type) {
4560 *out = PACKET_data(&r->data);
4562 *outlen = PACKET_remaining(&r->data);
4569 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4571 ctx->keylog_callback = cb;
4574 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4576 return ctx->keylog_callback;
4579 static int nss_keylog_int(const char *prefix,
4581 const uint8_t *parameter_1,
4582 size_t parameter_1_len,
4583 const uint8_t *parameter_2,
4584 size_t parameter_2_len)
4587 char *cursor = NULL;
4592 if (ssl->ctx->keylog_callback == NULL) return 1;
4595 * Our output buffer will contain the following strings, rendered with
4596 * space characters in between, terminated by a NULL character: first the
4597 * prefix, then the first parameter, then the second parameter. The
4598 * meaning of each parameter depends on the specific key material being
4599 * logged. Note that the first and second parameters are encoded in
4600 * hexadecimal, so we need a buffer that is twice their lengths.
4602 prefix_len = strlen(prefix);
4603 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4604 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4605 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4609 strcpy(cursor, prefix);
4610 cursor += prefix_len;
4613 for (i = 0; i < parameter_1_len; i++) {
4614 sprintf(cursor, "%02x", parameter_1[i]);
4619 for (i = 0; i < parameter_2_len; i++) {
4620 sprintf(cursor, "%02x", parameter_2[i]);
4625 ssl->ctx->keylog_callback(ssl, (const char *)out);
4631 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4632 const uint8_t *encrypted_premaster,
4633 size_t encrypted_premaster_len,
4634 const uint8_t *premaster,
4635 size_t premaster_len)
4637 if (encrypted_premaster_len < 8) {
4638 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4642 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4643 return nss_keylog_int("RSA",
4645 encrypted_premaster,
4651 int ssl_log_secret(SSL *ssl,
4653 const uint8_t *secret,
4656 return nss_keylog_int(label,
4658 ssl->s3->client_random,
4664 #define SSLV2_CIPHER_LEN 3
4666 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format,
4671 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4673 if (PACKET_remaining(cipher_suites) == 0) {
4674 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST, SSL_R_NO_CIPHERS_SPECIFIED);
4675 *al = SSL_AD_ILLEGAL_PARAMETER;
4679 if (PACKET_remaining(cipher_suites) % n != 0) {
4680 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST,
4681 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4682 *al = SSL_AD_DECODE_ERROR;
4686 OPENSSL_free(s->s3->tmp.ciphers_raw);
4687 s->s3->tmp.ciphers_raw = NULL;
4688 s->s3->tmp.ciphers_rawlen = 0;
4691 size_t numciphers = PACKET_remaining(cipher_suites) / n;
4692 PACKET sslv2ciphers = *cipher_suites;
4693 unsigned int leadbyte;
4697 * We store the raw ciphers list in SSLv3+ format so we need to do some
4698 * preprocessing to convert the list first. If there are any SSLv2 only
4699 * ciphersuites with a non-zero leading byte then we are going to
4700 * slightly over allocate because we won't store those. But that isn't a
4703 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
4704 s->s3->tmp.ciphers_raw = raw;
4706 *al = SSL_AD_INTERNAL_ERROR;
4709 for (s->s3->tmp.ciphers_rawlen = 0;
4710 PACKET_remaining(&sslv2ciphers) > 0;
4711 raw += TLS_CIPHER_LEN) {
4712 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
4714 && !PACKET_copy_bytes(&sslv2ciphers, raw,
4717 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
4718 *al = SSL_AD_INTERNAL_ERROR;
4719 OPENSSL_free(s->s3->tmp.ciphers_raw);
4720 s->s3->tmp.ciphers_raw = NULL;
4721 s->s3->tmp.ciphers_rawlen = 0;
4725 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
4727 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
4728 &s->s3->tmp.ciphers_rawlen)) {
4729 *al = SSL_AD_INTERNAL_ERROR;
4737 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
4738 int isv2format, STACK_OF(SSL_CIPHER) **sk,
4739 STACK_OF(SSL_CIPHER) **scsvs)
4744 if (!PACKET_buf_init(&pkt, bytes, len))
4746 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, &alert);
4749 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
4750 STACK_OF(SSL_CIPHER) **skp,
4751 STACK_OF(SSL_CIPHER) **scsvs_out,
4752 int sslv2format, int *al)
4754 const SSL_CIPHER *c;
4755 STACK_OF(SSL_CIPHER) *sk = NULL;
4756 STACK_OF(SSL_CIPHER) *scsvs = NULL;
4758 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
4759 unsigned char cipher[SSLV2_CIPHER_LEN];
4761 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4763 if (PACKET_remaining(cipher_suites) == 0) {
4764 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
4765 *al = SSL_AD_ILLEGAL_PARAMETER;
4769 if (PACKET_remaining(cipher_suites) % n != 0) {
4770 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
4771 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4772 *al = SSL_AD_DECODE_ERROR;
4776 sk = sk_SSL_CIPHER_new_null();
4777 scsvs = sk_SSL_CIPHER_new_null();
4778 if (sk == NULL || scsvs == NULL) {
4779 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4780 *al = SSL_AD_INTERNAL_ERROR;
4784 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
4786 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
4787 * first byte set to zero, while true SSLv2 ciphers have a non-zero
4788 * first byte. We don't support any true SSLv2 ciphers, so skip them.
4790 if (sslv2format && cipher[0] != '\0')
4793 /* For SSLv2-compat, ignore leading 0-byte. */
4794 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
4796 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
4797 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
4798 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4799 *al = SSL_AD_INTERNAL_ERROR;
4804 if (PACKET_remaining(cipher_suites) > 0) {
4805 *al = SSL_AD_INTERNAL_ERROR;
4806 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_INTERNAL_ERROR);
4813 sk_SSL_CIPHER_free(sk);
4814 if (scsvs_out != NULL)
4817 sk_SSL_CIPHER_free(scsvs);
4820 sk_SSL_CIPHER_free(sk);
4821 sk_SSL_CIPHER_free(scsvs);
4825 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
4827 ctx->max_early_data = max_early_data;
4832 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
4834 return ctx->max_early_data;
4837 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
4839 s->max_early_data = max_early_data;
4844 uint32_t SSL_get_max_early_data(const SSL_CTX *s)
4846 return s->max_early_data;