2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4 * Copyright 2005 Nokia. All rights reserved.
6 * Licensed under the OpenSSL license (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
14 #include <openssl/objects.h>
15 #include <openssl/x509v3.h>
16 #include <openssl/rand.h>
17 #include <openssl/rand_drbg.h>
18 #include <openssl/ocsp.h>
19 #include <openssl/dh.h>
20 #include <openssl/engine.h>
21 #include <openssl/async.h>
22 #include <openssl/ct.h>
23 #include "internal/cryptlib.h"
24 #include "internal/refcount.h"
26 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
28 static int ssl_undefined_function_1(SSL *ssl, SSL3_RECORD *r, size_t s, int t)
33 return ssl_undefined_function(ssl);
36 static int ssl_undefined_function_2(SSL *ssl, SSL3_RECORD *r, unsigned char *s,
42 return ssl_undefined_function(ssl);
45 static int ssl_undefined_function_3(SSL *ssl, unsigned char *r,
46 unsigned char *s, size_t t, size_t *u)
52 return ssl_undefined_function(ssl);
55 static int ssl_undefined_function_4(SSL *ssl, int r)
58 return ssl_undefined_function(ssl);
61 static size_t ssl_undefined_function_5(SSL *ssl, const char *r, size_t s,
67 return ssl_undefined_function(ssl);
70 static int ssl_undefined_function_6(int r)
73 return ssl_undefined_function(NULL);
76 static int ssl_undefined_function_7(SSL *ssl, unsigned char *r, size_t s,
77 const char *t, size_t u,
78 const unsigned char *v, size_t w, int x)
87 return ssl_undefined_function(ssl);
90 SSL3_ENC_METHOD ssl3_undef_enc_method = {
91 ssl_undefined_function_1,
92 ssl_undefined_function_2,
93 ssl_undefined_function,
94 ssl_undefined_function_3,
95 ssl_undefined_function_4,
96 ssl_undefined_function_5,
97 NULL, /* client_finished_label */
98 0, /* client_finished_label_len */
99 NULL, /* server_finished_label */
100 0, /* server_finished_label_len */
101 ssl_undefined_function_6,
102 ssl_undefined_function_7,
105 struct ssl_async_args {
109 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
111 int (*func_read) (SSL *, void *, size_t, size_t *);
112 int (*func_write) (SSL *, const void *, size_t, size_t *);
113 int (*func_other) (SSL *);
117 static const struct {
123 DANETLS_MATCHING_FULL, 0, NID_undef
126 DANETLS_MATCHING_2256, 1, NID_sha256
129 DANETLS_MATCHING_2512, 2, NID_sha512
133 static int dane_ctx_enable(struct dane_ctx_st *dctx)
135 const EVP_MD **mdevp;
137 uint8_t mdmax = DANETLS_MATCHING_LAST;
138 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
141 if (dctx->mdevp != NULL)
144 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
145 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
147 if (mdord == NULL || mdevp == NULL) {
150 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
154 /* Install default entries */
155 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
158 if (dane_mds[i].nid == NID_undef ||
159 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
161 mdevp[dane_mds[i].mtype] = md;
162 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
172 static void dane_ctx_final(struct dane_ctx_st *dctx)
174 OPENSSL_free(dctx->mdevp);
177 OPENSSL_free(dctx->mdord);
182 static void tlsa_free(danetls_record *t)
186 OPENSSL_free(t->data);
187 EVP_PKEY_free(t->spki);
191 static void dane_final(SSL_DANE *dane)
193 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
196 sk_X509_pop_free(dane->certs, X509_free);
199 X509_free(dane->mcert);
207 * dane_copy - Copy dane configuration, sans verification state.
209 static int ssl_dane_dup(SSL *to, SSL *from)
214 if (!DANETLS_ENABLED(&from->dane))
217 num = sk_danetls_record_num(from->dane.trecs);
218 dane_final(&to->dane);
219 to->dane.flags = from->dane.flags;
220 to->dane.dctx = &to->ctx->dane;
221 to->dane.trecs = sk_danetls_record_new_reserve(NULL, num);
223 if (to->dane.trecs == NULL) {
224 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
228 for (i = 0; i < num; ++i) {
229 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
231 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
232 t->data, t->dlen) <= 0)
238 static int dane_mtype_set(struct dane_ctx_st *dctx,
239 const EVP_MD *md, uint8_t mtype, uint8_t ord)
243 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
244 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
248 if (mtype > dctx->mdmax) {
249 const EVP_MD **mdevp;
251 int n = ((int)mtype) + 1;
253 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
255 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
260 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
262 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
267 /* Zero-fill any gaps */
268 for (i = dctx->mdmax + 1; i < mtype; ++i) {
276 dctx->mdevp[mtype] = md;
277 /* Coerce ordinal of disabled matching types to 0 */
278 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
283 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
285 if (mtype > dane->dctx->mdmax)
287 return dane->dctx->mdevp[mtype];
290 static int dane_tlsa_add(SSL_DANE *dane,
293 uint8_t mtype, unsigned const char *data, size_t dlen)
296 const EVP_MD *md = NULL;
297 int ilen = (int)dlen;
301 if (dane->trecs == NULL) {
302 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
306 if (ilen < 0 || dlen != (size_t)ilen) {
307 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
311 if (usage > DANETLS_USAGE_LAST) {
312 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
316 if (selector > DANETLS_SELECTOR_LAST) {
317 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
321 if (mtype != DANETLS_MATCHING_FULL) {
322 md = tlsa_md_get(dane, mtype);
324 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
329 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
330 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
334 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
338 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
339 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
344 t->selector = selector;
346 t->data = OPENSSL_malloc(dlen);
347 if (t->data == NULL) {
349 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
352 memcpy(t->data, data, dlen);
355 /* Validate and cache full certificate or public key */
356 if (mtype == DANETLS_MATCHING_FULL) {
357 const unsigned char *p = data;
359 EVP_PKEY *pkey = NULL;
362 case DANETLS_SELECTOR_CERT:
363 if (!d2i_X509(&cert, &p, ilen) || p < data ||
364 dlen != (size_t)(p - data)) {
366 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
369 if (X509_get0_pubkey(cert) == NULL) {
371 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
375 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
381 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
382 * records that contain full certificates of trust-anchors that are
383 * not present in the wire chain. For usage PKIX-TA(0), we augment
384 * the chain with untrusted Full(0) certificates from DNS, in case
385 * they are missing from the chain.
387 if ((dane->certs == NULL &&
388 (dane->certs = sk_X509_new_null()) == NULL) ||
389 !sk_X509_push(dane->certs, cert)) {
390 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
397 case DANETLS_SELECTOR_SPKI:
398 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
399 dlen != (size_t)(p - data)) {
401 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
406 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
407 * records that contain full bare keys of trust-anchors that are
408 * not present in the wire chain.
410 if (usage == DANETLS_USAGE_DANE_TA)
419 * Find the right insertion point for the new record.
421 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
422 * they can be processed first, as they require no chain building, and no
423 * expiration or hostname checks. Because DANE-EE(3) is numerically
424 * largest, this is accomplished via descending sort by "usage".
426 * We also sort in descending order by matching ordinal to simplify
427 * the implementation of digest agility in the verification code.
429 * The choice of order for the selector is not significant, so we
430 * use the same descending order for consistency.
432 num = sk_danetls_record_num(dane->trecs);
433 for (i = 0; i < num; ++i) {
434 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
436 if (rec->usage > usage)
438 if (rec->usage < usage)
440 if (rec->selector > selector)
442 if (rec->selector < selector)
444 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
449 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
451 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
454 dane->umask |= DANETLS_USAGE_BIT(usage);
460 * Return 0 if there is only one version configured and it was disabled
461 * at configure time. Return 1 otherwise.
463 static int ssl_check_allowed_versions(int min_version, int max_version)
465 int minisdtls = 0, maxisdtls = 0;
467 /* Figure out if we're doing DTLS versions or TLS versions */
468 if (min_version == DTLS1_BAD_VER
469 || min_version >> 8 == DTLS1_VERSION_MAJOR)
471 if (max_version == DTLS1_BAD_VER
472 || max_version >> 8 == DTLS1_VERSION_MAJOR)
474 /* A wildcard version of 0 could be DTLS or TLS. */
475 if ((minisdtls && !maxisdtls && max_version != 0)
476 || (maxisdtls && !minisdtls && min_version != 0)) {
477 /* Mixing DTLS and TLS versions will lead to sadness; deny it. */
481 if (minisdtls || maxisdtls) {
482 /* Do DTLS version checks. */
483 if (min_version == 0)
484 /* Ignore DTLS1_BAD_VER */
485 min_version = DTLS1_VERSION;
486 if (max_version == 0)
487 max_version = DTLS1_2_VERSION;
488 #ifdef OPENSSL_NO_DTLS1_2
489 if (max_version == DTLS1_2_VERSION)
490 max_version = DTLS1_VERSION;
492 #ifdef OPENSSL_NO_DTLS1
493 if (min_version == DTLS1_VERSION)
494 min_version = DTLS1_2_VERSION;
496 /* Done massaging versions; do the check. */
498 #ifdef OPENSSL_NO_DTLS1
499 || (DTLS_VERSION_GE(min_version, DTLS1_VERSION)
500 && DTLS_VERSION_GE(DTLS1_VERSION, max_version))
502 #ifdef OPENSSL_NO_DTLS1_2
503 || (DTLS_VERSION_GE(min_version, DTLS1_2_VERSION)
504 && DTLS_VERSION_GE(DTLS1_2_VERSION, max_version))
509 /* Regular TLS version checks. */
510 if (min_version == 0)
511 min_version = SSL3_VERSION;
512 if (max_version == 0)
513 max_version = TLS1_3_VERSION;
514 #ifdef OPENSSL_NO_TLS1_3
515 if (max_version == TLS1_3_VERSION)
516 max_version = TLS1_2_VERSION;
518 #ifdef OPENSSL_NO_TLS1_2
519 if (max_version == TLS1_2_VERSION)
520 max_version = TLS1_1_VERSION;
522 #ifdef OPENSSL_NO_TLS1_1
523 if (max_version == TLS1_1_VERSION)
524 max_version = TLS1_VERSION;
526 #ifdef OPENSSL_NO_TLS1
527 if (max_version == TLS1_VERSION)
528 max_version = SSL3_VERSION;
530 #ifdef OPENSSL_NO_SSL3
531 if (min_version == SSL3_VERSION)
532 min_version = TLS1_VERSION;
534 #ifdef OPENSSL_NO_TLS1
535 if (min_version == TLS1_VERSION)
536 min_version = TLS1_1_VERSION;
538 #ifdef OPENSSL_NO_TLS1_1
539 if (min_version == TLS1_1_VERSION)
540 min_version = TLS1_2_VERSION;
542 #ifdef OPENSSL_NO_TLS1_2
543 if (min_version == TLS1_2_VERSION)
544 min_version = TLS1_3_VERSION;
546 /* Done massaging versions; do the check. */
548 #ifdef OPENSSL_NO_SSL3
549 || (min_version <= SSL3_VERSION && SSL3_VERSION <= max_version)
551 #ifdef OPENSSL_NO_TLS1
552 || (min_version <= TLS1_VERSION && TLS1_VERSION <= max_version)
554 #ifdef OPENSSL_NO_TLS1_1
555 || (min_version <= TLS1_1_VERSION && TLS1_1_VERSION <= max_version)
557 #ifdef OPENSSL_NO_TLS1_2
558 || (min_version <= TLS1_2_VERSION && TLS1_2_VERSION <= max_version)
560 #ifdef OPENSSL_NO_TLS1_3
561 || (min_version <= TLS1_3_VERSION && TLS1_3_VERSION <= max_version)
569 static void clear_ciphers(SSL *s)
571 /* clear the current cipher */
572 ssl_clear_cipher_ctx(s);
573 ssl_clear_hash_ctx(&s->read_hash);
574 ssl_clear_hash_ctx(&s->write_hash);
577 int SSL_clear(SSL *s)
579 if (s->method == NULL) {
580 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
584 if (ssl_clear_bad_session(s)) {
585 SSL_SESSION_free(s->session);
588 SSL_SESSION_free(s->psksession);
589 s->psksession = NULL;
590 OPENSSL_free(s->psksession_id);
591 s->psksession_id = NULL;
592 s->psksession_id_len = 0;
593 s->hello_retry_request = 0;
600 if (s->renegotiate) {
601 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
605 ossl_statem_clear(s);
607 s->version = s->method->version;
608 s->client_version = s->version;
609 s->rwstate = SSL_NOTHING;
611 BUF_MEM_free(s->init_buf);
616 s->key_update = SSL_KEY_UPDATE_NONE;
618 EVP_MD_CTX_free(s->pha_dgst);
621 /* Reset DANE verification result state */
624 X509_free(s->dane.mcert);
625 s->dane.mcert = NULL;
626 s->dane.mtlsa = NULL;
628 /* Clear the verification result peername */
629 X509_VERIFY_PARAM_move_peername(s->param, NULL);
632 * Check to see if we were changed into a different method, if so, revert
635 if (s->method != s->ctx->method) {
636 s->method->ssl_free(s);
637 s->method = s->ctx->method;
638 if (!s->method->ssl_new(s))
641 if (!s->method->ssl_clear(s))
645 RECORD_LAYER_clear(&s->rlayer);
650 /** Used to change an SSL_CTXs default SSL method type */
651 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
653 STACK_OF(SSL_CIPHER) *sk;
657 sk = ssl_create_cipher_list(ctx->method,
658 ctx->tls13_ciphersuites,
660 &(ctx->cipher_list_by_id),
661 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
662 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
663 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
669 SSL *SSL_new(SSL_CTX *ctx)
674 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
677 if (ctx->method == NULL) {
678 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
682 s = OPENSSL_zalloc(sizeof(*s));
687 s->lock = CRYPTO_THREAD_lock_new();
688 if (s->lock == NULL) {
694 RECORD_LAYER_init(&s->rlayer, s);
696 s->options = ctx->options;
697 s->dane.flags = ctx->dane.flags;
698 s->min_proto_version = ctx->min_proto_version;
699 s->max_proto_version = ctx->max_proto_version;
701 s->max_cert_list = ctx->max_cert_list;
702 s->max_early_data = ctx->max_early_data;
703 s->num_tickets = ctx->num_tickets;
705 /* Shallow copy of the ciphersuites stack */
706 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
707 if (s->tls13_ciphersuites == NULL)
711 * Earlier library versions used to copy the pointer to the CERT, not
712 * its contents; only when setting new parameters for the per-SSL
713 * copy, ssl_cert_new would be called (and the direct reference to
714 * the per-SSL_CTX settings would be lost, but those still were
715 * indirectly accessed for various purposes, and for that reason they
716 * used to be known as s->ctx->default_cert). Now we don't look at the
717 * SSL_CTX's CERT after having duplicated it once.
719 s->cert = ssl_cert_dup(ctx->cert);
723 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
724 s->msg_callback = ctx->msg_callback;
725 s->msg_callback_arg = ctx->msg_callback_arg;
726 s->verify_mode = ctx->verify_mode;
727 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
728 s->record_padding_cb = ctx->record_padding_cb;
729 s->record_padding_arg = ctx->record_padding_arg;
730 s->block_padding = ctx->block_padding;
731 s->sid_ctx_length = ctx->sid_ctx_length;
732 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
734 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
735 s->verify_callback = ctx->default_verify_callback;
736 s->generate_session_id = ctx->generate_session_id;
738 s->param = X509_VERIFY_PARAM_new();
739 if (s->param == NULL)
741 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
742 s->quiet_shutdown = ctx->quiet_shutdown;
744 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
745 s->max_send_fragment = ctx->max_send_fragment;
746 s->split_send_fragment = ctx->split_send_fragment;
747 s->max_pipelines = ctx->max_pipelines;
748 if (s->max_pipelines > 1)
749 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
750 if (ctx->default_read_buf_len > 0)
751 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
756 s->ext.debug_arg = NULL;
757 s->ext.ticket_expected = 0;
758 s->ext.status_type = ctx->ext.status_type;
759 s->ext.status_expected = 0;
760 s->ext.ocsp.ids = NULL;
761 s->ext.ocsp.exts = NULL;
762 s->ext.ocsp.resp = NULL;
763 s->ext.ocsp.resp_len = 0;
765 s->session_ctx = ctx;
766 #ifndef OPENSSL_NO_EC
767 if (ctx->ext.ecpointformats) {
768 s->ext.ecpointformats =
769 OPENSSL_memdup(ctx->ext.ecpointformats,
770 ctx->ext.ecpointformats_len);
771 if (!s->ext.ecpointformats)
773 s->ext.ecpointformats_len =
774 ctx->ext.ecpointformats_len;
776 if (ctx->ext.supportedgroups) {
777 s->ext.supportedgroups =
778 OPENSSL_memdup(ctx->ext.supportedgroups,
779 ctx->ext.supportedgroups_len
780 * sizeof(*ctx->ext.supportedgroups));
781 if (!s->ext.supportedgroups)
783 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
786 #ifndef OPENSSL_NO_NEXTPROTONEG
790 if (s->ctx->ext.alpn) {
791 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
792 if (s->ext.alpn == NULL)
794 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
795 s->ext.alpn_len = s->ctx->ext.alpn_len;
798 s->verified_chain = NULL;
799 s->verify_result = X509_V_OK;
801 s->default_passwd_callback = ctx->default_passwd_callback;
802 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
804 s->method = ctx->method;
806 s->key_update = SSL_KEY_UPDATE_NONE;
808 s->allow_early_data_cb = ctx->allow_early_data_cb;
809 s->allow_early_data_cb_data = ctx->allow_early_data_cb_data;
811 if (!s->method->ssl_new(s))
814 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
819 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
822 #ifndef OPENSSL_NO_PSK
823 s->psk_client_callback = ctx->psk_client_callback;
824 s->psk_server_callback = ctx->psk_server_callback;
826 s->psk_find_session_cb = ctx->psk_find_session_cb;
827 s->psk_use_session_cb = ctx->psk_use_session_cb;
831 #ifndef OPENSSL_NO_CT
832 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
833 ctx->ct_validation_callback_arg))
840 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
844 int SSL_is_dtls(const SSL *s)
846 return SSL_IS_DTLS(s) ? 1 : 0;
849 int SSL_up_ref(SSL *s)
853 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
856 REF_PRINT_COUNT("SSL", s);
857 REF_ASSERT_ISNT(i < 2);
858 return ((i > 1) ? 1 : 0);
861 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
862 unsigned int sid_ctx_len)
864 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
865 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
866 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
869 ctx->sid_ctx_length = sid_ctx_len;
870 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
875 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
876 unsigned int sid_ctx_len)
878 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
879 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
880 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
883 ssl->sid_ctx_length = sid_ctx_len;
884 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
889 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
891 CRYPTO_THREAD_write_lock(ctx->lock);
892 ctx->generate_session_id = cb;
893 CRYPTO_THREAD_unlock(ctx->lock);
897 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
899 CRYPTO_THREAD_write_lock(ssl->lock);
900 ssl->generate_session_id = cb;
901 CRYPTO_THREAD_unlock(ssl->lock);
905 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
909 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
910 * we can "construct" a session to give us the desired check - i.e. to
911 * find if there's a session in the hash table that would conflict with
912 * any new session built out of this id/id_len and the ssl_version in use
917 if (id_len > sizeof(r.session_id))
920 r.ssl_version = ssl->version;
921 r.session_id_length = id_len;
922 memcpy(r.session_id, id, id_len);
924 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
925 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
926 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
930 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
932 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
935 int SSL_set_purpose(SSL *s, int purpose)
937 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
940 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
942 return X509_VERIFY_PARAM_set_trust(s->param, trust);
945 int SSL_set_trust(SSL *s, int trust)
947 return X509_VERIFY_PARAM_set_trust(s->param, trust);
950 int SSL_set1_host(SSL *s, const char *hostname)
952 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
955 int SSL_add1_host(SSL *s, const char *hostname)
957 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
960 void SSL_set_hostflags(SSL *s, unsigned int flags)
962 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
965 const char *SSL_get0_peername(SSL *s)
967 return X509_VERIFY_PARAM_get0_peername(s->param);
970 int SSL_CTX_dane_enable(SSL_CTX *ctx)
972 return dane_ctx_enable(&ctx->dane);
975 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
977 unsigned long orig = ctx->dane.flags;
979 ctx->dane.flags |= flags;
983 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
985 unsigned long orig = ctx->dane.flags;
987 ctx->dane.flags &= ~flags;
991 int SSL_dane_enable(SSL *s, const char *basedomain)
993 SSL_DANE *dane = &s->dane;
995 if (s->ctx->dane.mdmax == 0) {
996 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
999 if (dane->trecs != NULL) {
1000 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1005 * Default SNI name. This rejects empty names, while set1_host below
1006 * accepts them and disables host name checks. To avoid side-effects with
1007 * invalid input, set the SNI name first.
1009 if (s->ext.hostname == NULL) {
1010 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1011 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1016 /* Primary RFC6125 reference identifier */
1017 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1018 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1024 dane->dctx = &s->ctx->dane;
1025 dane->trecs = sk_danetls_record_new_null();
1027 if (dane->trecs == NULL) {
1028 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1034 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1036 unsigned long orig = ssl->dane.flags;
1038 ssl->dane.flags |= flags;
1042 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1044 unsigned long orig = ssl->dane.flags;
1046 ssl->dane.flags &= ~flags;
1050 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1052 SSL_DANE *dane = &s->dane;
1054 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1058 *mcert = dane->mcert;
1060 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1065 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1066 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1068 SSL_DANE *dane = &s->dane;
1070 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1074 *usage = dane->mtlsa->usage;
1076 *selector = dane->mtlsa->selector;
1078 *mtype = dane->mtlsa->mtype;
1080 *data = dane->mtlsa->data;
1082 *dlen = dane->mtlsa->dlen;
1087 SSL_DANE *SSL_get0_dane(SSL *s)
1092 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1093 uint8_t mtype, unsigned const char *data, size_t dlen)
1095 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1098 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1101 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1104 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1106 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1109 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1111 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1114 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1119 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1124 void SSL_certs_clear(SSL *s)
1126 ssl_cert_clear_certs(s->cert);
1129 void SSL_free(SSL *s)
1135 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1136 REF_PRINT_COUNT("SSL", s);
1139 REF_ASSERT_ISNT(i < 0);
1141 X509_VERIFY_PARAM_free(s->param);
1142 dane_final(&s->dane);
1143 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1145 /* Ignore return value */
1146 ssl_free_wbio_buffer(s);
1148 BIO_free_all(s->wbio);
1149 BIO_free_all(s->rbio);
1151 BUF_MEM_free(s->init_buf);
1153 /* add extra stuff */
1154 sk_SSL_CIPHER_free(s->cipher_list);
1155 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1156 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1158 /* Make the next call work :-) */
1159 if (s->session != NULL) {
1160 ssl_clear_bad_session(s);
1161 SSL_SESSION_free(s->session);
1163 SSL_SESSION_free(s->psksession);
1164 OPENSSL_free(s->psksession_id);
1168 ssl_cert_free(s->cert);
1169 /* Free up if allocated */
1171 OPENSSL_free(s->ext.hostname);
1172 SSL_CTX_free(s->session_ctx);
1173 #ifndef OPENSSL_NO_EC
1174 OPENSSL_free(s->ext.ecpointformats);
1175 OPENSSL_free(s->ext.supportedgroups);
1176 #endif /* OPENSSL_NO_EC */
1177 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1178 #ifndef OPENSSL_NO_OCSP
1179 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1181 #ifndef OPENSSL_NO_CT
1182 SCT_LIST_free(s->scts);
1183 OPENSSL_free(s->ext.scts);
1185 OPENSSL_free(s->ext.ocsp.resp);
1186 OPENSSL_free(s->ext.alpn);
1187 OPENSSL_free(s->ext.tls13_cookie);
1188 OPENSSL_free(s->clienthello);
1189 OPENSSL_free(s->pha_context);
1190 EVP_MD_CTX_free(s->pha_dgst);
1192 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1194 sk_X509_pop_free(s->verified_chain, X509_free);
1196 if (s->method != NULL)
1197 s->method->ssl_free(s);
1199 RECORD_LAYER_release(&s->rlayer);
1201 SSL_CTX_free(s->ctx);
1203 ASYNC_WAIT_CTX_free(s->waitctx);
1205 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1206 OPENSSL_free(s->ext.npn);
1209 #ifndef OPENSSL_NO_SRTP
1210 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1213 CRYPTO_THREAD_lock_free(s->lock);
1218 void SSL_set0_rbio(SSL *s, BIO *rbio)
1220 BIO_free_all(s->rbio);
1224 void SSL_set0_wbio(SSL *s, BIO *wbio)
1227 * If the output buffering BIO is still in place, remove it
1229 if (s->bbio != NULL)
1230 s->wbio = BIO_pop(s->wbio);
1232 BIO_free_all(s->wbio);
1235 /* Re-attach |bbio| to the new |wbio|. */
1236 if (s->bbio != NULL)
1237 s->wbio = BIO_push(s->bbio, s->wbio);
1240 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1243 * For historical reasons, this function has many different cases in
1244 * ownership handling.
1247 /* If nothing has changed, do nothing */
1248 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1252 * If the two arguments are equal then one fewer reference is granted by the
1253 * caller than we want to take
1255 if (rbio != NULL && rbio == wbio)
1259 * If only the wbio is changed only adopt one reference.
1261 if (rbio == SSL_get_rbio(s)) {
1262 SSL_set0_wbio(s, wbio);
1266 * There is an asymmetry here for historical reasons. If only the rbio is
1267 * changed AND the rbio and wbio were originally different, then we only
1268 * adopt one reference.
1270 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1271 SSL_set0_rbio(s, rbio);
1275 /* Otherwise, adopt both references. */
1276 SSL_set0_rbio(s, rbio);
1277 SSL_set0_wbio(s, wbio);
1280 BIO *SSL_get_rbio(const SSL *s)
1285 BIO *SSL_get_wbio(const SSL *s)
1287 if (s->bbio != NULL) {
1289 * If |bbio| is active, the true caller-configured BIO is its
1292 return BIO_next(s->bbio);
1297 int SSL_get_fd(const SSL *s)
1299 return SSL_get_rfd(s);
1302 int SSL_get_rfd(const SSL *s)
1307 b = SSL_get_rbio(s);
1308 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1310 BIO_get_fd(r, &ret);
1314 int SSL_get_wfd(const SSL *s)
1319 b = SSL_get_wbio(s);
1320 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1322 BIO_get_fd(r, &ret);
1326 #ifndef OPENSSL_NO_SOCK
1327 int SSL_set_fd(SSL *s, int fd)
1332 bio = BIO_new(BIO_s_socket());
1335 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1338 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1339 SSL_set_bio(s, bio, bio);
1345 int SSL_set_wfd(SSL *s, int fd)
1347 BIO *rbio = SSL_get_rbio(s);
1349 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1350 || (int)BIO_get_fd(rbio, NULL) != fd) {
1351 BIO *bio = BIO_new(BIO_s_socket());
1354 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1357 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1358 SSL_set0_wbio(s, bio);
1361 SSL_set0_wbio(s, rbio);
1366 int SSL_set_rfd(SSL *s, int fd)
1368 BIO *wbio = SSL_get_wbio(s);
1370 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1371 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1372 BIO *bio = BIO_new(BIO_s_socket());
1375 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1378 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1379 SSL_set0_rbio(s, bio);
1382 SSL_set0_rbio(s, wbio);
1389 /* return length of latest Finished message we sent, copy to 'buf' */
1390 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1394 if (s->s3 != NULL) {
1395 ret = s->s3->tmp.finish_md_len;
1398 memcpy(buf, s->s3->tmp.finish_md, count);
1403 /* return length of latest Finished message we expected, copy to 'buf' */
1404 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1408 if (s->s3 != NULL) {
1409 ret = s->s3->tmp.peer_finish_md_len;
1412 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1417 int SSL_get_verify_mode(const SSL *s)
1419 return s->verify_mode;
1422 int SSL_get_verify_depth(const SSL *s)
1424 return X509_VERIFY_PARAM_get_depth(s->param);
1427 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1428 return s->verify_callback;
1431 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1433 return ctx->verify_mode;
1436 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1438 return X509_VERIFY_PARAM_get_depth(ctx->param);
1441 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1442 return ctx->default_verify_callback;
1445 void SSL_set_verify(SSL *s, int mode,
1446 int (*callback) (int ok, X509_STORE_CTX *ctx))
1448 s->verify_mode = mode;
1449 if (callback != NULL)
1450 s->verify_callback = callback;
1453 void SSL_set_verify_depth(SSL *s, int depth)
1455 X509_VERIFY_PARAM_set_depth(s->param, depth);
1458 void SSL_set_read_ahead(SSL *s, int yes)
1460 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1463 int SSL_get_read_ahead(const SSL *s)
1465 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1468 int SSL_pending(const SSL *s)
1470 size_t pending = s->method->ssl_pending(s);
1473 * SSL_pending cannot work properly if read-ahead is enabled
1474 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1475 * impossible to fix since SSL_pending cannot report errors that may be
1476 * observed while scanning the new data. (Note that SSL_pending() is
1477 * often used as a boolean value, so we'd better not return -1.)
1479 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1480 * we just return INT_MAX.
1482 return pending < INT_MAX ? (int)pending : INT_MAX;
1485 int SSL_has_pending(const SSL *s)
1488 * Similar to SSL_pending() but returns a 1 to indicate that we have
1489 * unprocessed data available or 0 otherwise (as opposed to the number of
1490 * bytes available). Unlike SSL_pending() this will take into account
1491 * read_ahead data. A 1 return simply indicates that we have unprocessed
1492 * data. That data may not result in any application data, or we may fail
1493 * to parse the records for some reason.
1495 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1498 return RECORD_LAYER_read_pending(&s->rlayer);
1501 X509 *SSL_get_peer_certificate(const SSL *s)
1505 if ((s == NULL) || (s->session == NULL))
1508 r = s->session->peer;
1518 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1522 if ((s == NULL) || (s->session == NULL))
1525 r = s->session->peer_chain;
1528 * If we are a client, cert_chain includes the peer's own certificate; if
1529 * we are a server, it does not.
1536 * Now in theory, since the calling process own 't' it should be safe to
1537 * modify. We need to be able to read f without being hassled
1539 int SSL_copy_session_id(SSL *t, const SSL *f)
1542 /* Do we need to to SSL locking? */
1543 if (!SSL_set_session(t, SSL_get_session(f))) {
1548 * what if we are setup for one protocol version but want to talk another
1550 if (t->method != f->method) {
1551 t->method->ssl_free(t);
1552 t->method = f->method;
1553 if (t->method->ssl_new(t) == 0)
1557 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1558 ssl_cert_free(t->cert);
1560 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1567 /* Fix this so it checks all the valid key/cert options */
1568 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1570 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1571 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1574 if (ctx->cert->key->privatekey == NULL) {
1575 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1578 return X509_check_private_key
1579 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1582 /* Fix this function so that it takes an optional type parameter */
1583 int SSL_check_private_key(const SSL *ssl)
1586 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1589 if (ssl->cert->key->x509 == NULL) {
1590 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1593 if (ssl->cert->key->privatekey == NULL) {
1594 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1597 return X509_check_private_key(ssl->cert->key->x509,
1598 ssl->cert->key->privatekey);
1601 int SSL_waiting_for_async(SSL *s)
1609 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1611 ASYNC_WAIT_CTX *ctx = s->waitctx;
1615 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1618 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1619 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1621 ASYNC_WAIT_CTX *ctx = s->waitctx;
1625 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1629 int SSL_accept(SSL *s)
1631 if (s->handshake_func == NULL) {
1632 /* Not properly initialized yet */
1633 SSL_set_accept_state(s);
1636 return SSL_do_handshake(s);
1639 int SSL_connect(SSL *s)
1641 if (s->handshake_func == NULL) {
1642 /* Not properly initialized yet */
1643 SSL_set_connect_state(s);
1646 return SSL_do_handshake(s);
1649 long SSL_get_default_timeout(const SSL *s)
1651 return s->method->get_timeout();
1654 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1655 int (*func) (void *))
1658 if (s->waitctx == NULL) {
1659 s->waitctx = ASYNC_WAIT_CTX_new();
1660 if (s->waitctx == NULL)
1663 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1664 sizeof(struct ssl_async_args))) {
1666 s->rwstate = SSL_NOTHING;
1667 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1670 s->rwstate = SSL_ASYNC_PAUSED;
1673 s->rwstate = SSL_ASYNC_NO_JOBS;
1679 s->rwstate = SSL_NOTHING;
1680 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1681 /* Shouldn't happen */
1686 static int ssl_io_intern(void *vargs)
1688 struct ssl_async_args *args;
1693 args = (struct ssl_async_args *)vargs;
1697 switch (args->type) {
1699 return args->f.func_read(s, buf, num, &s->asyncrw);
1701 return args->f.func_write(s, buf, num, &s->asyncrw);
1703 return args->f.func_other(s);
1708 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1710 if (s->handshake_func == NULL) {
1711 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1715 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1716 s->rwstate = SSL_NOTHING;
1720 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1721 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1722 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1726 * If we are a client and haven't received the ServerHello etc then we
1729 ossl_statem_check_finish_init(s, 0);
1731 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1732 struct ssl_async_args args;
1738 args.type = READFUNC;
1739 args.f.func_read = s->method->ssl_read;
1741 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1742 *readbytes = s->asyncrw;
1745 return s->method->ssl_read(s, buf, num, readbytes);
1749 int SSL_read(SSL *s, void *buf, int num)
1755 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1759 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1762 * The cast is safe here because ret should be <= INT_MAX because num is
1766 ret = (int)readbytes;
1771 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1773 int ret = ssl_read_internal(s, buf, num, readbytes);
1780 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1785 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1786 return SSL_READ_EARLY_DATA_ERROR;
1789 switch (s->early_data_state) {
1790 case SSL_EARLY_DATA_NONE:
1791 if (!SSL_in_before(s)) {
1792 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1793 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1794 return SSL_READ_EARLY_DATA_ERROR;
1798 case SSL_EARLY_DATA_ACCEPT_RETRY:
1799 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1800 ret = SSL_accept(s);
1803 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1804 return SSL_READ_EARLY_DATA_ERROR;
1808 case SSL_EARLY_DATA_READ_RETRY:
1809 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1810 s->early_data_state = SSL_EARLY_DATA_READING;
1811 ret = SSL_read_ex(s, buf, num, readbytes);
1813 * State machine will update early_data_state to
1814 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1817 if (ret > 0 || (ret <= 0 && s->early_data_state
1818 != SSL_EARLY_DATA_FINISHED_READING)) {
1819 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1820 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1821 : SSL_READ_EARLY_DATA_ERROR;
1824 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1827 return SSL_READ_EARLY_DATA_FINISH;
1830 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1831 return SSL_READ_EARLY_DATA_ERROR;
1835 int SSL_get_early_data_status(const SSL *s)
1837 return s->ext.early_data;
1840 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1842 if (s->handshake_func == NULL) {
1843 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1847 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1850 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1851 struct ssl_async_args args;
1857 args.type = READFUNC;
1858 args.f.func_read = s->method->ssl_peek;
1860 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1861 *readbytes = s->asyncrw;
1864 return s->method->ssl_peek(s, buf, num, readbytes);
1868 int SSL_peek(SSL *s, void *buf, int num)
1874 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1878 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1881 * The cast is safe here because ret should be <= INT_MAX because num is
1885 ret = (int)readbytes;
1891 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1893 int ret = ssl_peek_internal(s, buf, num, readbytes);
1900 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1902 if (s->handshake_func == NULL) {
1903 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1907 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1908 s->rwstate = SSL_NOTHING;
1909 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1913 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1914 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1915 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1916 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1919 /* If we are a client and haven't sent the Finished we better do that */
1920 ossl_statem_check_finish_init(s, 1);
1922 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1924 struct ssl_async_args args;
1927 args.buf = (void *)buf;
1929 args.type = WRITEFUNC;
1930 args.f.func_write = s->method->ssl_write;
1932 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1933 *written = s->asyncrw;
1936 return s->method->ssl_write(s, buf, num, written);
1940 int SSL_write(SSL *s, const void *buf, int num)
1946 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1950 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1953 * The cast is safe here because ret should be <= INT_MAX because num is
1962 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1964 int ret = ssl_write_internal(s, buf, num, written);
1971 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1973 int ret, early_data_state;
1975 uint32_t partialwrite;
1977 switch (s->early_data_state) {
1978 case SSL_EARLY_DATA_NONE:
1980 || !SSL_in_before(s)
1981 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1982 && (s->psk_use_session_cb == NULL))) {
1983 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1984 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1989 case SSL_EARLY_DATA_CONNECT_RETRY:
1990 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1991 ret = SSL_connect(s);
1994 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1999 case SSL_EARLY_DATA_WRITE_RETRY:
2000 s->early_data_state = SSL_EARLY_DATA_WRITING;
2002 * We disable partial write for early data because we don't keep track
2003 * of how many bytes we've written between the SSL_write_ex() call and
2004 * the flush if the flush needs to be retried)
2006 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2007 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2008 ret = SSL_write_ex(s, buf, num, &writtmp);
2009 s->mode |= partialwrite;
2011 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2014 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2017 case SSL_EARLY_DATA_WRITE_FLUSH:
2018 /* The buffering BIO is still in place so we need to flush it */
2019 if (statem_flush(s) != 1)
2022 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2025 case SSL_EARLY_DATA_FINISHED_READING:
2026 case SSL_EARLY_DATA_READ_RETRY:
2027 early_data_state = s->early_data_state;
2028 /* We are a server writing to an unauthenticated client */
2029 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2030 ret = SSL_write_ex(s, buf, num, written);
2031 /* The buffering BIO is still in place */
2033 (void)BIO_flush(s->wbio);
2034 s->early_data_state = early_data_state;
2038 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2043 int SSL_shutdown(SSL *s)
2046 * Note that this function behaves differently from what one might
2047 * expect. Return values are 0 for no success (yet), 1 for success; but
2048 * calling it once is usually not enough, even if blocking I/O is used
2049 * (see ssl3_shutdown).
2052 if (s->handshake_func == NULL) {
2053 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2057 if (!SSL_in_init(s)) {
2058 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2059 struct ssl_async_args args;
2062 args.type = OTHERFUNC;
2063 args.f.func_other = s->method->ssl_shutdown;
2065 return ssl_start_async_job(s, &args, ssl_io_intern);
2067 return s->method->ssl_shutdown(s);
2070 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2075 int SSL_key_update(SSL *s, int updatetype)
2078 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2079 * negotiated, and that it is appropriate to call SSL_key_update() instead
2080 * of SSL_renegotiate().
2082 if (!SSL_IS_TLS13(s)) {
2083 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2087 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2088 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2089 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2093 if (!SSL_is_init_finished(s)) {
2094 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2098 ossl_statem_set_in_init(s, 1);
2099 s->key_update = updatetype;
2103 int SSL_get_key_update_type(SSL *s)
2105 return s->key_update;
2108 int SSL_renegotiate(SSL *s)
2110 if (SSL_IS_TLS13(s)) {
2111 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2115 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2116 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2123 return s->method->ssl_renegotiate(s);
2126 int SSL_renegotiate_abbreviated(SSL *s)
2128 if (SSL_IS_TLS13(s)) {
2129 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2133 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2134 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2141 return s->method->ssl_renegotiate(s);
2144 int SSL_renegotiate_pending(SSL *s)
2147 * becomes true when negotiation is requested; false again once a
2148 * handshake has finished
2150 return (s->renegotiate != 0);
2153 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2158 case SSL_CTRL_GET_READ_AHEAD:
2159 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2160 case SSL_CTRL_SET_READ_AHEAD:
2161 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2162 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2165 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2166 s->msg_callback_arg = parg;
2170 return (s->mode |= larg);
2171 case SSL_CTRL_CLEAR_MODE:
2172 return (s->mode &= ~larg);
2173 case SSL_CTRL_GET_MAX_CERT_LIST:
2174 return (long)s->max_cert_list;
2175 case SSL_CTRL_SET_MAX_CERT_LIST:
2178 l = (long)s->max_cert_list;
2179 s->max_cert_list = (size_t)larg;
2181 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2182 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2184 s->max_send_fragment = larg;
2185 if (s->max_send_fragment < s->split_send_fragment)
2186 s->split_send_fragment = s->max_send_fragment;
2188 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2189 if ((size_t)larg > s->max_send_fragment || larg == 0)
2191 s->split_send_fragment = larg;
2193 case SSL_CTRL_SET_MAX_PIPELINES:
2194 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2196 s->max_pipelines = larg;
2198 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2200 case SSL_CTRL_GET_RI_SUPPORT:
2202 return s->s3->send_connection_binding;
2205 case SSL_CTRL_CERT_FLAGS:
2206 return (s->cert->cert_flags |= larg);
2207 case SSL_CTRL_CLEAR_CERT_FLAGS:
2208 return (s->cert->cert_flags &= ~larg);
2210 case SSL_CTRL_GET_RAW_CIPHERLIST:
2212 if (s->s3->tmp.ciphers_raw == NULL)
2214 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2215 return (int)s->s3->tmp.ciphers_rawlen;
2217 return TLS_CIPHER_LEN;
2219 case SSL_CTRL_GET_EXTMS_SUPPORT:
2220 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2222 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2226 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2227 return ssl_check_allowed_versions(larg, s->max_proto_version)
2228 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2229 &s->min_proto_version);
2230 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2231 return s->min_proto_version;
2232 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2233 return ssl_check_allowed_versions(s->min_proto_version, larg)
2234 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2235 &s->max_proto_version);
2236 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2237 return s->max_proto_version;
2239 return s->method->ssl_ctrl(s, cmd, larg, parg);
2243 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2246 case SSL_CTRL_SET_MSG_CALLBACK:
2247 s->msg_callback = (void (*)
2248 (int write_p, int version, int content_type,
2249 const void *buf, size_t len, SSL *ssl,
2254 return s->method->ssl_callback_ctrl(s, cmd, fp);
2258 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2260 return ctx->sessions;
2263 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2267 /* For some cases with ctx == NULL perform syntax checks */
2270 #ifndef OPENSSL_NO_EC
2271 case SSL_CTRL_SET_GROUPS_LIST:
2272 return tls1_set_groups_list(NULL, NULL, parg);
2274 case SSL_CTRL_SET_SIGALGS_LIST:
2275 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2276 return tls1_set_sigalgs_list(NULL, parg, 0);
2283 case SSL_CTRL_GET_READ_AHEAD:
2284 return ctx->read_ahead;
2285 case SSL_CTRL_SET_READ_AHEAD:
2286 l = ctx->read_ahead;
2287 ctx->read_ahead = larg;
2290 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2291 ctx->msg_callback_arg = parg;
2294 case SSL_CTRL_GET_MAX_CERT_LIST:
2295 return (long)ctx->max_cert_list;
2296 case SSL_CTRL_SET_MAX_CERT_LIST:
2299 l = (long)ctx->max_cert_list;
2300 ctx->max_cert_list = (size_t)larg;
2303 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2306 l = (long)ctx->session_cache_size;
2307 ctx->session_cache_size = (size_t)larg;
2309 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2310 return (long)ctx->session_cache_size;
2311 case SSL_CTRL_SET_SESS_CACHE_MODE:
2312 l = ctx->session_cache_mode;
2313 ctx->session_cache_mode = larg;
2315 case SSL_CTRL_GET_SESS_CACHE_MODE:
2316 return ctx->session_cache_mode;
2318 case SSL_CTRL_SESS_NUMBER:
2319 return lh_SSL_SESSION_num_items(ctx->sessions);
2320 case SSL_CTRL_SESS_CONNECT:
2321 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2323 case SSL_CTRL_SESS_CONNECT_GOOD:
2324 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2326 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2327 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2330 case SSL_CTRL_SESS_ACCEPT:
2331 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2333 case SSL_CTRL_SESS_ACCEPT_GOOD:
2334 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2336 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2337 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2340 case SSL_CTRL_SESS_HIT:
2341 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2343 case SSL_CTRL_SESS_CB_HIT:
2344 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2346 case SSL_CTRL_SESS_MISSES:
2347 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2349 case SSL_CTRL_SESS_TIMEOUTS:
2350 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2352 case SSL_CTRL_SESS_CACHE_FULL:
2353 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2356 return (ctx->mode |= larg);
2357 case SSL_CTRL_CLEAR_MODE:
2358 return (ctx->mode &= ~larg);
2359 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2360 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2362 ctx->max_send_fragment = larg;
2363 if (ctx->max_send_fragment < ctx->split_send_fragment)
2364 ctx->split_send_fragment = ctx->max_send_fragment;
2366 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2367 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2369 ctx->split_send_fragment = larg;
2371 case SSL_CTRL_SET_MAX_PIPELINES:
2372 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2374 ctx->max_pipelines = larg;
2376 case SSL_CTRL_CERT_FLAGS:
2377 return (ctx->cert->cert_flags |= larg);
2378 case SSL_CTRL_CLEAR_CERT_FLAGS:
2379 return (ctx->cert->cert_flags &= ~larg);
2380 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2381 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2382 && ssl_set_version_bound(ctx->method->version, (int)larg,
2383 &ctx->min_proto_version);
2384 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2385 return ctx->min_proto_version;
2386 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2387 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2388 && ssl_set_version_bound(ctx->method->version, (int)larg,
2389 &ctx->max_proto_version);
2390 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2391 return ctx->max_proto_version;
2393 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2397 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2400 case SSL_CTRL_SET_MSG_CALLBACK:
2401 ctx->msg_callback = (void (*)
2402 (int write_p, int version, int content_type,
2403 const void *buf, size_t len, SSL *ssl,
2408 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2412 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2421 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2422 const SSL_CIPHER *const *bp)
2424 if ((*ap)->id > (*bp)->id)
2426 if ((*ap)->id < (*bp)->id)
2431 /** return a STACK of the ciphers available for the SSL and in order of
2433 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2436 if (s->cipher_list != NULL) {
2437 return s->cipher_list;
2438 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2439 return s->ctx->cipher_list;
2445 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2447 if ((s == NULL) || (s->session == NULL) || !s->server)
2449 return s->session->ciphers;
2452 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2454 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2457 ciphers = SSL_get_ciphers(s);
2460 if (!ssl_set_client_disabled(s))
2462 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2463 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2464 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2466 sk = sk_SSL_CIPHER_new_null();
2469 if (!sk_SSL_CIPHER_push(sk, c)) {
2470 sk_SSL_CIPHER_free(sk);
2478 /** return a STACK of the ciphers available for the SSL and in order of
2480 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2483 if (s->cipher_list_by_id != NULL) {
2484 return s->cipher_list_by_id;
2485 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2486 return s->ctx->cipher_list_by_id;
2492 /** The old interface to get the same thing as SSL_get_ciphers() */
2493 const char *SSL_get_cipher_list(const SSL *s, int n)
2495 const SSL_CIPHER *c;
2496 STACK_OF(SSL_CIPHER) *sk;
2500 sk = SSL_get_ciphers(s);
2501 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2503 c = sk_SSL_CIPHER_value(sk, n);
2509 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2511 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2514 return ctx->cipher_list;
2518 /** specify the ciphers to be used by default by the SSL_CTX */
2519 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2521 STACK_OF(SSL_CIPHER) *sk;
2523 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2524 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2527 * ssl_create_cipher_list may return an empty stack if it was unable to
2528 * find a cipher matching the given rule string (for example if the rule
2529 * string specifies a cipher which has been disabled). This is not an
2530 * error as far as ssl_create_cipher_list is concerned, and hence
2531 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2535 else if (sk_SSL_CIPHER_num(sk) == 0) {
2536 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2542 /** specify the ciphers to be used by the SSL */
2543 int SSL_set_cipher_list(SSL *s, const char *str)
2545 STACK_OF(SSL_CIPHER) *sk;
2547 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2548 &s->cipher_list, &s->cipher_list_by_id, str,
2550 /* see comment in SSL_CTX_set_cipher_list */
2553 else if (sk_SSL_CIPHER_num(sk) == 0) {
2554 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2560 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2563 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2564 const SSL_CIPHER *c;
2568 || s->session == NULL
2569 || s->session->ciphers == NULL
2574 clntsk = s->session->ciphers;
2575 srvrsk = SSL_get_ciphers(s);
2576 if (clntsk == NULL || srvrsk == NULL)
2579 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2582 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2585 c = sk_SSL_CIPHER_value(clntsk, i);
2586 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2589 n = strlen(c->name);
2605 /** return a servername extension value if provided in Client Hello, or NULL.
2606 * So far, only host_name types are defined (RFC 3546).
2609 const char *SSL_get_servername(const SSL *s, const int type)
2611 if (type != TLSEXT_NAMETYPE_host_name)
2614 return s->session && !s->ext.hostname ?
2615 s->session->ext.hostname : s->ext.hostname;
2618 int SSL_get_servername_type(const SSL *s)
2621 && (!s->ext.hostname ? s->session->
2622 ext.hostname : s->ext.hostname))
2623 return TLSEXT_NAMETYPE_host_name;
2628 * SSL_select_next_proto implements the standard protocol selection. It is
2629 * expected that this function is called from the callback set by
2630 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2631 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2632 * not included in the length. A byte string of length 0 is invalid. No byte
2633 * string may be truncated. The current, but experimental algorithm for
2634 * selecting the protocol is: 1) If the server doesn't support NPN then this
2635 * is indicated to the callback. In this case, the client application has to
2636 * abort the connection or have a default application level protocol. 2) If
2637 * the server supports NPN, but advertises an empty list then the client
2638 * selects the first protocol in its list, but indicates via the API that this
2639 * fallback case was enacted. 3) Otherwise, the client finds the first
2640 * protocol in the server's list that it supports and selects this protocol.
2641 * This is because it's assumed that the server has better information about
2642 * which protocol a client should use. 4) If the client doesn't support any
2643 * of the server's advertised protocols, then this is treated the same as
2644 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2645 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2647 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2648 const unsigned char *server,
2649 unsigned int server_len,
2650 const unsigned char *client, unsigned int client_len)
2653 const unsigned char *result;
2654 int status = OPENSSL_NPN_UNSUPPORTED;
2657 * For each protocol in server preference order, see if we support it.
2659 for (i = 0; i < server_len;) {
2660 for (j = 0; j < client_len;) {
2661 if (server[i] == client[j] &&
2662 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2663 /* We found a match */
2664 result = &server[i];
2665 status = OPENSSL_NPN_NEGOTIATED;
2675 /* There's no overlap between our protocols and the server's list. */
2677 status = OPENSSL_NPN_NO_OVERLAP;
2680 *out = (unsigned char *)result + 1;
2681 *outlen = result[0];
2685 #ifndef OPENSSL_NO_NEXTPROTONEG
2687 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2688 * client's requested protocol for this connection and returns 0. If the
2689 * client didn't request any protocol, then *data is set to NULL. Note that
2690 * the client can request any protocol it chooses. The value returned from
2691 * this function need not be a member of the list of supported protocols
2692 * provided by the callback.
2694 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2701 *len = (unsigned int)s->ext.npn_len;
2706 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2707 * a TLS server needs a list of supported protocols for Next Protocol
2708 * Negotiation. The returned list must be in wire format. The list is
2709 * returned by setting |out| to point to it and |outlen| to its length. This
2710 * memory will not be modified, but one should assume that the SSL* keeps a
2711 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2712 * wishes to advertise. Otherwise, no such extension will be included in the
2715 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2716 SSL_CTX_npn_advertised_cb_func cb,
2719 ctx->ext.npn_advertised_cb = cb;
2720 ctx->ext.npn_advertised_cb_arg = arg;
2724 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2725 * client needs to select a protocol from the server's provided list. |out|
2726 * must be set to point to the selected protocol (which may be within |in|).
2727 * The length of the protocol name must be written into |outlen|. The
2728 * server's advertised protocols are provided in |in| and |inlen|. The
2729 * callback can assume that |in| is syntactically valid. The client must
2730 * select a protocol. It is fatal to the connection if this callback returns
2731 * a value other than SSL_TLSEXT_ERR_OK.
2733 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2734 SSL_CTX_npn_select_cb_func cb,
2737 ctx->ext.npn_select_cb = cb;
2738 ctx->ext.npn_select_cb_arg = arg;
2743 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2744 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2745 * length-prefixed strings). Returns 0 on success.
2747 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2748 unsigned int protos_len)
2750 OPENSSL_free(ctx->ext.alpn);
2751 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2752 if (ctx->ext.alpn == NULL) {
2753 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2756 ctx->ext.alpn_len = protos_len;
2762 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2763 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2764 * length-prefixed strings). Returns 0 on success.
2766 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2767 unsigned int protos_len)
2769 OPENSSL_free(ssl->ext.alpn);
2770 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2771 if (ssl->ext.alpn == NULL) {
2772 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2775 ssl->ext.alpn_len = protos_len;
2781 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2782 * called during ClientHello processing in order to select an ALPN protocol
2783 * from the client's list of offered protocols.
2785 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2786 SSL_CTX_alpn_select_cb_func cb,
2789 ctx->ext.alpn_select_cb = cb;
2790 ctx->ext.alpn_select_cb_arg = arg;
2794 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2795 * On return it sets |*data| to point to |*len| bytes of protocol name
2796 * (not including the leading length-prefix byte). If the server didn't
2797 * respond with a negotiated protocol then |*len| will be zero.
2799 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2804 *data = ssl->s3->alpn_selected;
2808 *len = (unsigned int)ssl->s3->alpn_selected_len;
2811 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2812 const char *label, size_t llen,
2813 const unsigned char *context, size_t contextlen,
2816 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2819 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2821 contextlen, use_context);
2824 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2825 const char *label, size_t llen,
2826 const unsigned char *context,
2829 if (s->version != TLS1_3_VERSION)
2832 return tls13_export_keying_material_early(s, out, olen, label, llen,
2833 context, contextlen);
2836 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2838 const unsigned char *session_id = a->session_id;
2840 unsigned char tmp_storage[4];
2842 if (a->session_id_length < sizeof(tmp_storage)) {
2843 memset(tmp_storage, 0, sizeof(tmp_storage));
2844 memcpy(tmp_storage, a->session_id, a->session_id_length);
2845 session_id = tmp_storage;
2849 ((unsigned long)session_id[0]) |
2850 ((unsigned long)session_id[1] << 8L) |
2851 ((unsigned long)session_id[2] << 16L) |
2852 ((unsigned long)session_id[3] << 24L);
2857 * NB: If this function (or indeed the hash function which uses a sort of
2858 * coarser function than this one) is changed, ensure
2859 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2860 * being able to construct an SSL_SESSION that will collide with any existing
2861 * session with a matching session ID.
2863 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2865 if (a->ssl_version != b->ssl_version)
2867 if (a->session_id_length != b->session_id_length)
2869 return memcmp(a->session_id, b->session_id, a->session_id_length);
2873 * These wrapper functions should remain rather than redeclaring
2874 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2875 * variable. The reason is that the functions aren't static, they're exposed
2879 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2881 SSL_CTX *ret = NULL;
2884 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2888 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2891 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2892 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2895 ret = OPENSSL_zalloc(sizeof(*ret));
2900 ret->min_proto_version = 0;
2901 ret->max_proto_version = 0;
2902 ret->mode = SSL_MODE_AUTO_RETRY;
2903 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2904 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2905 /* We take the system default. */
2906 ret->session_timeout = meth->get_timeout();
2907 ret->references = 1;
2908 ret->lock = CRYPTO_THREAD_lock_new();
2909 if (ret->lock == NULL) {
2910 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2914 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2915 ret->verify_mode = SSL_VERIFY_NONE;
2916 if ((ret->cert = ssl_cert_new()) == NULL)
2919 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2920 if (ret->sessions == NULL)
2922 ret->cert_store = X509_STORE_new();
2923 if (ret->cert_store == NULL)
2925 #ifndef OPENSSL_NO_CT
2926 ret->ctlog_store = CTLOG_STORE_new();
2927 if (ret->ctlog_store == NULL)
2931 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
2934 if (!ssl_create_cipher_list(ret->method,
2935 ret->tls13_ciphersuites,
2936 &ret->cipher_list, &ret->cipher_list_by_id,
2937 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2938 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2939 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2943 ret->param = X509_VERIFY_PARAM_new();
2944 if (ret->param == NULL)
2947 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2948 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2951 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2952 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2956 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2959 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2962 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
2965 /* No compression for DTLS */
2966 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2967 ret->comp_methods = SSL_COMP_get_compression_methods();
2969 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2970 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2972 /* Setup RFC5077 ticket keys */
2973 if ((RAND_bytes(ret->ext.tick_key_name,
2974 sizeof(ret->ext.tick_key_name)) <= 0)
2975 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
2976 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
2977 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
2978 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
2979 ret->options |= SSL_OP_NO_TICKET;
2981 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
2982 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2985 #ifndef OPENSSL_NO_SRP
2986 if (!SSL_CTX_SRP_CTX_init(ret))
2989 #ifndef OPENSSL_NO_ENGINE
2990 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2991 # define eng_strx(x) #x
2992 # define eng_str(x) eng_strx(x)
2993 /* Use specific client engine automatically... ignore errors */
2996 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2999 ENGINE_load_builtin_engines();
3000 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3002 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3008 * Default is to connect to non-RI servers. When RI is more widely
3009 * deployed might change this.
3011 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3013 * Disable compression by default to prevent CRIME. Applications can
3014 * re-enable compression by configuring
3015 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3016 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3017 * middlebox compatibility by default. This may be disabled by default in
3018 * a later OpenSSL version.
3020 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3022 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3025 * We cannot usefully set a default max_early_data here (which gets
3026 * propagated in SSL_new(), for the following reason: setting the
3027 * SSL field causes tls_construct_stoc_early_data() to tell the
3028 * client that early data will be accepted when constructing a TLS 1.3
3029 * session ticket, and the client will accordingly send us early data
3030 * when using that ticket (if the client has early data to send).
3031 * However, in order for the early data to actually be consumed by
3032 * the application, the application must also have calls to
3033 * SSL_read_early_data(); otherwise we'll just skip past the early data
3034 * and ignore it. So, since the application must add calls to
3035 * SSL_read_early_data(), we also require them to add
3036 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3037 * eliminating the bandwidth-wasting early data in the case described
3040 ret->max_early_data = 0;
3042 /* By default we send two session tickets automatically in TLSv1.3 */
3043 ret->num_tickets = 2;
3045 ssl_ctx_system_config(ret);
3049 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3055 int SSL_CTX_up_ref(SSL_CTX *ctx)
3059 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3062 REF_PRINT_COUNT("SSL_CTX", ctx);
3063 REF_ASSERT_ISNT(i < 2);
3064 return ((i > 1) ? 1 : 0);
3067 void SSL_CTX_free(SSL_CTX *a)
3074 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3075 REF_PRINT_COUNT("SSL_CTX", a);
3078 REF_ASSERT_ISNT(i < 0);
3080 X509_VERIFY_PARAM_free(a->param);
3081 dane_ctx_final(&a->dane);
3084 * Free internal session cache. However: the remove_cb() may reference
3085 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3086 * after the sessions were flushed.
3087 * As the ex_data handling routines might also touch the session cache,
3088 * the most secure solution seems to be: empty (flush) the cache, then
3089 * free ex_data, then finally free the cache.
3090 * (See ticket [openssl.org #212].)
3092 if (a->sessions != NULL)
3093 SSL_CTX_flush_sessions(a, 0);
3095 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3096 lh_SSL_SESSION_free(a->sessions);
3097 X509_STORE_free(a->cert_store);
3098 #ifndef OPENSSL_NO_CT
3099 CTLOG_STORE_free(a->ctlog_store);
3101 sk_SSL_CIPHER_free(a->cipher_list);
3102 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3103 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3104 ssl_cert_free(a->cert);
3105 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3106 sk_X509_pop_free(a->extra_certs, X509_free);
3107 a->comp_methods = NULL;
3108 #ifndef OPENSSL_NO_SRTP
3109 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3111 #ifndef OPENSSL_NO_SRP
3112 SSL_CTX_SRP_CTX_free(a);
3114 #ifndef OPENSSL_NO_ENGINE
3115 ENGINE_finish(a->client_cert_engine);
3118 #ifndef OPENSSL_NO_EC
3119 OPENSSL_free(a->ext.ecpointformats);
3120 OPENSSL_free(a->ext.supportedgroups);
3122 OPENSSL_free(a->ext.alpn);
3123 OPENSSL_secure_free(a->ext.secure);
3125 CRYPTO_THREAD_lock_free(a->lock);
3130 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3132 ctx->default_passwd_callback = cb;
3135 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3137 ctx->default_passwd_callback_userdata = u;
3140 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3142 return ctx->default_passwd_callback;
3145 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3147 return ctx->default_passwd_callback_userdata;
3150 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3152 s->default_passwd_callback = cb;
3155 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3157 s->default_passwd_callback_userdata = u;
3160 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3162 return s->default_passwd_callback;
3165 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3167 return s->default_passwd_callback_userdata;
3170 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3171 int (*cb) (X509_STORE_CTX *, void *),
3174 ctx->app_verify_callback = cb;
3175 ctx->app_verify_arg = arg;
3178 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3179 int (*cb) (int, X509_STORE_CTX *))
3181 ctx->verify_mode = mode;
3182 ctx->default_verify_callback = cb;
3185 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3187 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3190 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3192 ssl_cert_set_cert_cb(c->cert, cb, arg);
3195 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3197 ssl_cert_set_cert_cb(s->cert, cb, arg);
3200 void ssl_set_masks(SSL *s)
3203 uint32_t *pvalid = s->s3->tmp.valid_flags;
3204 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3205 unsigned long mask_k, mask_a;
3206 #ifndef OPENSSL_NO_EC
3207 int have_ecc_cert, ecdsa_ok;
3212 #ifndef OPENSSL_NO_DH
3213 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3218 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3219 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3220 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3221 #ifndef OPENSSL_NO_EC
3222 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3228 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3229 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3232 #ifndef OPENSSL_NO_GOST
3233 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3234 mask_k |= SSL_kGOST;
3235 mask_a |= SSL_aGOST12;
3237 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3238 mask_k |= SSL_kGOST;
3239 mask_a |= SSL_aGOST12;
3241 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3242 mask_k |= SSL_kGOST;
3243 mask_a |= SSL_aGOST01;
3254 * If we only have an RSA-PSS certificate allow RSA authentication
3255 * if TLS 1.2 and peer supports it.
3258 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3259 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3260 && TLS1_get_version(s) == TLS1_2_VERSION))
3267 mask_a |= SSL_aNULL;
3270 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3271 * depending on the key usage extension.
3273 #ifndef OPENSSL_NO_EC
3274 if (have_ecc_cert) {
3276 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3277 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3278 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3281 mask_a |= SSL_aECDSA;
3283 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3284 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3285 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3286 && TLS1_get_version(s) == TLS1_2_VERSION)
3287 mask_a |= SSL_aECDSA;
3289 /* Allow Ed448 for TLS 1.2 if peer supports it */
3290 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3291 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3292 && TLS1_get_version(s) == TLS1_2_VERSION)
3293 mask_a |= SSL_aECDSA;
3296 #ifndef OPENSSL_NO_EC
3297 mask_k |= SSL_kECDHE;
3300 #ifndef OPENSSL_NO_PSK
3303 if (mask_k & SSL_kRSA)
3304 mask_k |= SSL_kRSAPSK;
3305 if (mask_k & SSL_kDHE)
3306 mask_k |= SSL_kDHEPSK;
3307 if (mask_k & SSL_kECDHE)
3308 mask_k |= SSL_kECDHEPSK;
3311 s->s3->tmp.mask_k = mask_k;
3312 s->s3->tmp.mask_a = mask_a;
3315 #ifndef OPENSSL_NO_EC
3317 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3319 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3320 /* key usage, if present, must allow signing */
3321 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3322 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3323 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3327 return 1; /* all checks are ok */
3332 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3333 size_t *serverinfo_length)
3335 CERT_PKEY *cpk = s->s3->tmp.cert;
3336 *serverinfo_length = 0;
3338 if (cpk == NULL || cpk->serverinfo == NULL)
3341 *serverinfo = cpk->serverinfo;
3342 *serverinfo_length = cpk->serverinfo_length;
3346 void ssl_update_cache(SSL *s, int mode)
3351 * If the session_id_length is 0, we are not supposed to cache it, and it
3352 * would be rather hard to do anyway :-)
3354 if (s->session->session_id_length == 0)
3358 * If sid_ctx_length is 0 there is no specific application context
3359 * associated with this session, so when we try to resume it and
3360 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3361 * indication that this is actually a session for the proper application
3362 * context, and the *handshake* will fail, not just the resumption attempt.
3363 * Do not cache (on the server) these sessions that are not resumable
3364 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3366 if (s->server && s->session->sid_ctx_length == 0
3367 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3370 i = s->session_ctx->session_cache_mode;
3372 && (!s->hit || SSL_IS_TLS13(s))) {
3374 * Add the session to the internal cache. In server side TLSv1.3 we
3375 * normally don't do this because by default it's a full stateless ticket
3376 * with only a dummy session id so there is no reason to cache it,
3378 * - we are doing early_data, in which case we cache so that we can
3380 * - the application has set a remove_session_cb so needs to know about
3381 * session timeout events
3382 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3384 if ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0
3385 && (!SSL_IS_TLS13(s)
3387 || (s->max_early_data > 0
3388 && (s->options & SSL_OP_NO_ANTI_REPLAY) == 0)
3389 || s->session_ctx->remove_session_cb != NULL
3390 || (s->options & SSL_OP_NO_TICKET) != 0))
3391 SSL_CTX_add_session(s->session_ctx, s->session);
3394 * Add the session to the external cache. We do this even in server side
3395 * TLSv1.3 without early data because some applications just want to
3396 * know about the creation of a session and aren't doing a full cache.
3398 if (s->session_ctx->new_session_cb != NULL) {
3399 SSL_SESSION_up_ref(s->session);
3400 if (!s->session_ctx->new_session_cb(s, s->session))
3401 SSL_SESSION_free(s->session);
3405 /* auto flush every 255 connections */
3406 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3408 if (mode & SSL_SESS_CACHE_CLIENT)
3409 stat = &s->session_ctx->stats.sess_connect_good;
3411 stat = &s->session_ctx->stats.sess_accept_good;
3412 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3413 && (val & 0xff) == 0xff)
3414 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3418 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3423 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3428 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3432 if (s->method != meth) {
3433 const SSL_METHOD *sm = s->method;
3434 int (*hf) (SSL *) = s->handshake_func;
3436 if (sm->version == meth->version)
3441 ret = s->method->ssl_new(s);
3444 if (hf == sm->ssl_connect)
3445 s->handshake_func = meth->ssl_connect;
3446 else if (hf == sm->ssl_accept)
3447 s->handshake_func = meth->ssl_accept;
3452 int SSL_get_error(const SSL *s, int i)
3459 return SSL_ERROR_NONE;
3462 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3463 * where we do encode the error
3465 if ((l = ERR_peek_error()) != 0) {
3466 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3467 return SSL_ERROR_SYSCALL;
3469 return SSL_ERROR_SSL;
3472 if (SSL_want_read(s)) {
3473 bio = SSL_get_rbio(s);
3474 if (BIO_should_read(bio))
3475 return SSL_ERROR_WANT_READ;
3476 else if (BIO_should_write(bio))
3478 * This one doesn't make too much sense ... We never try to write
3479 * to the rbio, and an application program where rbio and wbio
3480 * are separate couldn't even know what it should wait for.
3481 * However if we ever set s->rwstate incorrectly (so that we have
3482 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3483 * wbio *are* the same, this test works around that bug; so it
3484 * might be safer to keep it.
3486 return SSL_ERROR_WANT_WRITE;
3487 else if (BIO_should_io_special(bio)) {
3488 reason = BIO_get_retry_reason(bio);
3489 if (reason == BIO_RR_CONNECT)
3490 return SSL_ERROR_WANT_CONNECT;
3491 else if (reason == BIO_RR_ACCEPT)
3492 return SSL_ERROR_WANT_ACCEPT;
3494 return SSL_ERROR_SYSCALL; /* unknown */
3498 if (SSL_want_write(s)) {
3499 /* Access wbio directly - in order to use the buffered bio if present */
3501 if (BIO_should_write(bio))
3502 return SSL_ERROR_WANT_WRITE;
3503 else if (BIO_should_read(bio))
3505 * See above (SSL_want_read(s) with BIO_should_write(bio))
3507 return SSL_ERROR_WANT_READ;
3508 else if (BIO_should_io_special(bio)) {
3509 reason = BIO_get_retry_reason(bio);
3510 if (reason == BIO_RR_CONNECT)
3511 return SSL_ERROR_WANT_CONNECT;
3512 else if (reason == BIO_RR_ACCEPT)
3513 return SSL_ERROR_WANT_ACCEPT;
3515 return SSL_ERROR_SYSCALL;
3518 if (SSL_want_x509_lookup(s))
3519 return SSL_ERROR_WANT_X509_LOOKUP;
3520 if (SSL_want_async(s))
3521 return SSL_ERROR_WANT_ASYNC;
3522 if (SSL_want_async_job(s))
3523 return SSL_ERROR_WANT_ASYNC_JOB;
3524 if (SSL_want_client_hello_cb(s))
3525 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3527 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3528 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3529 return SSL_ERROR_ZERO_RETURN;
3531 return SSL_ERROR_SYSCALL;
3534 static int ssl_do_handshake_intern(void *vargs)
3536 struct ssl_async_args *args;
3539 args = (struct ssl_async_args *)vargs;
3542 return s->handshake_func(s);
3545 int SSL_do_handshake(SSL *s)
3549 if (s->handshake_func == NULL) {
3550 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3554 ossl_statem_check_finish_init(s, -1);
3556 s->method->ssl_renegotiate_check(s, 0);
3558 if (SSL_is_server(s)) {
3559 /* clear SNI settings at server-side */
3560 OPENSSL_free(s->ext.hostname);
3561 s->ext.hostname = NULL;
3564 if (SSL_in_init(s) || SSL_in_before(s)) {
3565 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3566 struct ssl_async_args args;
3570 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3572 ret = s->handshake_func(s);
3578 void SSL_set_accept_state(SSL *s)
3582 ossl_statem_clear(s);
3583 s->handshake_func = s->method->ssl_accept;
3587 void SSL_set_connect_state(SSL *s)
3591 ossl_statem_clear(s);
3592 s->handshake_func = s->method->ssl_connect;
3596 int ssl_undefined_function(SSL *s)
3598 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3602 int ssl_undefined_void_function(void)
3604 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3605 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3609 int ssl_undefined_const_function(const SSL *s)
3614 const SSL_METHOD *ssl_bad_method(int ver)
3616 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3620 const char *ssl_protocol_to_string(int version)
3624 case TLS1_3_VERSION:
3627 case TLS1_2_VERSION:
3630 case TLS1_1_VERSION:
3645 case DTLS1_2_VERSION:
3653 const char *SSL_get_version(const SSL *s)
3655 return ssl_protocol_to_string(s->version);
3658 SSL *SSL_dup(SSL *s)
3660 STACK_OF(X509_NAME) *sk;
3665 /* If we're not quiescent, just up_ref! */
3666 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3667 CRYPTO_UP_REF(&s->references, &i, s->lock);
3672 * Otherwise, copy configuration state, and session if set.
3674 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3677 if (s->session != NULL) {
3679 * Arranges to share the same session via up_ref. This "copies"
3680 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3682 if (!SSL_copy_session_id(ret, s))
3686 * No session has been established yet, so we have to expect that
3687 * s->cert or ret->cert will be changed later -- they should not both
3688 * point to the same object, and thus we can't use
3689 * SSL_copy_session_id.
3691 if (!SSL_set_ssl_method(ret, s->method))
3694 if (s->cert != NULL) {
3695 ssl_cert_free(ret->cert);
3696 ret->cert = ssl_cert_dup(s->cert);
3697 if (ret->cert == NULL)
3701 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3702 (int)s->sid_ctx_length))
3706 if (!ssl_dane_dup(ret, s))
3708 ret->version = s->version;
3709 ret->options = s->options;
3710 ret->mode = s->mode;
3711 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3712 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3713 ret->msg_callback = s->msg_callback;
3714 ret->msg_callback_arg = s->msg_callback_arg;
3715 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3716 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3717 ret->generate_session_id = s->generate_session_id;
3719 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3721 /* copy app data, a little dangerous perhaps */
3722 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3725 /* setup rbio, and wbio */
3726 if (s->rbio != NULL) {
3727 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3730 if (s->wbio != NULL) {
3731 if (s->wbio != s->rbio) {
3732 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3735 BIO_up_ref(ret->rbio);
3736 ret->wbio = ret->rbio;
3740 ret->server = s->server;
3741 if (s->handshake_func) {
3743 SSL_set_accept_state(ret);
3745 SSL_set_connect_state(ret);
3747 ret->shutdown = s->shutdown;
3750 ret->default_passwd_callback = s->default_passwd_callback;
3751 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3753 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3755 /* dup the cipher_list and cipher_list_by_id stacks */
3756 if (s->cipher_list != NULL) {
3757 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3760 if (s->cipher_list_by_id != NULL)
3761 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3765 /* Dup the client_CA list */
3766 if (s->ca_names != NULL) {
3767 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3770 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3771 xn = sk_X509_NAME_value(sk, i);
3772 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3785 void ssl_clear_cipher_ctx(SSL *s)
3787 if (s->enc_read_ctx != NULL) {
3788 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3789 s->enc_read_ctx = NULL;
3791 if (s->enc_write_ctx != NULL) {
3792 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3793 s->enc_write_ctx = NULL;
3795 #ifndef OPENSSL_NO_COMP
3796 COMP_CTX_free(s->expand);
3798 COMP_CTX_free(s->compress);
3803 X509 *SSL_get_certificate(const SSL *s)
3805 if (s->cert != NULL)
3806 return s->cert->key->x509;
3811 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3813 if (s->cert != NULL)
3814 return s->cert->key->privatekey;
3819 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3821 if (ctx->cert != NULL)
3822 return ctx->cert->key->x509;
3827 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3829 if (ctx->cert != NULL)
3830 return ctx->cert->key->privatekey;
3835 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3837 if ((s->session != NULL) && (s->session->cipher != NULL))
3838 return s->session->cipher;
3842 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3844 return s->s3->tmp.new_cipher;
3847 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3849 #ifndef OPENSSL_NO_COMP
3850 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3856 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3858 #ifndef OPENSSL_NO_COMP
3859 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3865 int ssl_init_wbio_buffer(SSL *s)
3869 if (s->bbio != NULL) {
3870 /* Already buffered. */
3874 bbio = BIO_new(BIO_f_buffer());
3875 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3877 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3881 s->wbio = BIO_push(bbio, s->wbio);
3886 int ssl_free_wbio_buffer(SSL *s)
3888 /* callers ensure s is never null */
3889 if (s->bbio == NULL)
3892 s->wbio = BIO_pop(s->wbio);
3899 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3901 ctx->quiet_shutdown = mode;
3904 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3906 return ctx->quiet_shutdown;
3909 void SSL_set_quiet_shutdown(SSL *s, int mode)
3911 s->quiet_shutdown = mode;
3914 int SSL_get_quiet_shutdown(const SSL *s)
3916 return s->quiet_shutdown;
3919 void SSL_set_shutdown(SSL *s, int mode)
3924 int SSL_get_shutdown(const SSL *s)
3929 int SSL_version(const SSL *s)
3934 int SSL_client_version(const SSL *s)
3936 return s->client_version;
3939 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3944 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3947 if (ssl->ctx == ctx)
3950 ctx = ssl->session_ctx;
3951 new_cert = ssl_cert_dup(ctx->cert);
3952 if (new_cert == NULL) {
3956 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3957 ssl_cert_free(new_cert);
3961 ssl_cert_free(ssl->cert);
3962 ssl->cert = new_cert;
3965 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3966 * so setter APIs must prevent invalid lengths from entering the system.
3968 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3972 * If the session ID context matches that of the parent SSL_CTX,
3973 * inherit it from the new SSL_CTX as well. If however the context does
3974 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3975 * leave it unchanged.
3977 if ((ssl->ctx != NULL) &&
3978 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3979 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3980 ssl->sid_ctx_length = ctx->sid_ctx_length;
3981 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3984 SSL_CTX_up_ref(ctx);
3985 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3991 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3993 return X509_STORE_set_default_paths(ctx->cert_store);
3996 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3998 X509_LOOKUP *lookup;
4000 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
4003 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
4005 /* Clear any errors if the default directory does not exist */
4011 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4013 X509_LOOKUP *lookup;
4015 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4019 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4021 /* Clear any errors if the default file does not exist */
4027 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4030 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4033 void SSL_set_info_callback(SSL *ssl,
4034 void (*cb) (const SSL *ssl, int type, int val))
4036 ssl->info_callback = cb;
4040 * One compiler (Diab DCC) doesn't like argument names in returned function
4043 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4046 return ssl->info_callback;
4049 void SSL_set_verify_result(SSL *ssl, long arg)
4051 ssl->verify_result = arg;
4054 long SSL_get_verify_result(const SSL *ssl)
4056 return ssl->verify_result;
4059 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4062 return sizeof(ssl->s3->client_random);
4063 if (outlen > sizeof(ssl->s3->client_random))
4064 outlen = sizeof(ssl->s3->client_random);
4065 memcpy(out, ssl->s3->client_random, outlen);
4069 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4072 return sizeof(ssl->s3->server_random);
4073 if (outlen > sizeof(ssl->s3->server_random))
4074 outlen = sizeof(ssl->s3->server_random);
4075 memcpy(out, ssl->s3->server_random, outlen);
4079 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4080 unsigned char *out, size_t outlen)
4083 return session->master_key_length;
4084 if (outlen > session->master_key_length)
4085 outlen = session->master_key_length;
4086 memcpy(out, session->master_key, outlen);
4090 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4093 if (len > sizeof(sess->master_key))
4096 memcpy(sess->master_key, in, len);
4097 sess->master_key_length = len;
4102 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4104 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4107 void *SSL_get_ex_data(const SSL *s, int idx)
4109 return CRYPTO_get_ex_data(&s->ex_data, idx);
4112 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4114 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4117 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4119 return CRYPTO_get_ex_data(&s->ex_data, idx);
4122 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4124 return ctx->cert_store;
4127 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4129 X509_STORE_free(ctx->cert_store);
4130 ctx->cert_store = store;
4133 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4136 X509_STORE_up_ref(store);
4137 SSL_CTX_set_cert_store(ctx, store);
4140 int SSL_want(const SSL *s)
4146 * \brief Set the callback for generating temporary DH keys.
4147 * \param ctx the SSL context.
4148 * \param dh the callback
4151 #ifndef OPENSSL_NO_DH
4152 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4153 DH *(*dh) (SSL *ssl, int is_export,
4156 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4159 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4162 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4166 #ifndef OPENSSL_NO_PSK
4167 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4169 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4170 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4173 OPENSSL_free(ctx->cert->psk_identity_hint);
4174 if (identity_hint != NULL) {
4175 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4176 if (ctx->cert->psk_identity_hint == NULL)
4179 ctx->cert->psk_identity_hint = NULL;
4183 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4188 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4189 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4192 OPENSSL_free(s->cert->psk_identity_hint);
4193 if (identity_hint != NULL) {
4194 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4195 if (s->cert->psk_identity_hint == NULL)
4198 s->cert->psk_identity_hint = NULL;
4202 const char *SSL_get_psk_identity_hint(const SSL *s)
4204 if (s == NULL || s->session == NULL)
4206 return s->session->psk_identity_hint;
4209 const char *SSL_get_psk_identity(const SSL *s)
4211 if (s == NULL || s->session == NULL)
4213 return s->session->psk_identity;
4216 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4218 s->psk_client_callback = cb;
4221 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4223 ctx->psk_client_callback = cb;
4226 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4228 s->psk_server_callback = cb;
4231 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4233 ctx->psk_server_callback = cb;
4237 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4239 s->psk_find_session_cb = cb;
4242 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4243 SSL_psk_find_session_cb_func cb)
4245 ctx->psk_find_session_cb = cb;
4248 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4250 s->psk_use_session_cb = cb;
4253 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4254 SSL_psk_use_session_cb_func cb)
4256 ctx->psk_use_session_cb = cb;
4259 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4260 void (*cb) (int write_p, int version,
4261 int content_type, const void *buf,
4262 size_t len, SSL *ssl, void *arg))
4264 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4267 void SSL_set_msg_callback(SSL *ssl,
4268 void (*cb) (int write_p, int version,
4269 int content_type, const void *buf,
4270 size_t len, SSL *ssl, void *arg))
4272 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4275 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4276 int (*cb) (SSL *ssl,
4280 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4281 (void (*)(void))cb);
4284 void SSL_set_not_resumable_session_callback(SSL *ssl,
4285 int (*cb) (SSL *ssl,
4286 int is_forward_secure))
4288 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4289 (void (*)(void))cb);
4292 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4293 size_t (*cb) (SSL *ssl, int type,
4294 size_t len, void *arg))
4296 ctx->record_padding_cb = cb;
4299 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4301 ctx->record_padding_arg = arg;
4304 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4306 return ctx->record_padding_arg;
4309 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4311 /* block size of 0 or 1 is basically no padding */
4312 if (block_size == 1)
4313 ctx->block_padding = 0;
4314 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4315 ctx->block_padding = block_size;
4321 void SSL_set_record_padding_callback(SSL *ssl,
4322 size_t (*cb) (SSL *ssl, int type,
4323 size_t len, void *arg))
4325 ssl->record_padding_cb = cb;
4328 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4330 ssl->record_padding_arg = arg;
4333 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4335 return ssl->record_padding_arg;
4338 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4340 /* block size of 0 or 1 is basically no padding */
4341 if (block_size == 1)
4342 ssl->block_padding = 0;
4343 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4344 ssl->block_padding = block_size;
4350 int SSL_set_num_tickets(SSL *s, size_t num_tickets)
4352 s->num_tickets = num_tickets;
4357 size_t SSL_get_num_tickets(SSL *s)
4359 return s->num_tickets;
4362 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets)
4364 ctx->num_tickets = num_tickets;
4369 size_t SSL_CTX_get_num_tickets(SSL_CTX *ctx)
4371 return ctx->num_tickets;
4375 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4376 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4377 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4378 * Returns the newly allocated ctx;
4381 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4383 ssl_clear_hash_ctx(hash);
4384 *hash = EVP_MD_CTX_new();
4385 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4386 EVP_MD_CTX_free(*hash);
4393 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4396 EVP_MD_CTX_free(*hash);
4400 /* Retrieve handshake hashes */
4401 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4404 EVP_MD_CTX *ctx = NULL;
4405 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4406 int hashleni = EVP_MD_CTX_size(hdgst);
4409 if (hashleni < 0 || (size_t)hashleni > outlen) {
4410 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4411 ERR_R_INTERNAL_ERROR);
4415 ctx = EVP_MD_CTX_new();
4419 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4420 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4421 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4422 ERR_R_INTERNAL_ERROR);
4426 *hashlen = hashleni;
4430 EVP_MD_CTX_free(ctx);
4434 int SSL_session_reused(SSL *s)
4439 int SSL_is_server(const SSL *s)
4444 #if OPENSSL_API_COMPAT < 0x10100000L
4445 void SSL_set_debug(SSL *s, int debug)
4447 /* Old function was do-nothing anyway... */
4453 void SSL_set_security_level(SSL *s, int level)
4455 s->cert->sec_level = level;
4458 int SSL_get_security_level(const SSL *s)
4460 return s->cert->sec_level;
4463 void SSL_set_security_callback(SSL *s,
4464 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4465 int op, int bits, int nid,
4466 void *other, void *ex))
4468 s->cert->sec_cb = cb;
4471 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4472 const SSL_CTX *ctx, int op,
4473 int bits, int nid, void *other,
4475 return s->cert->sec_cb;
4478 void SSL_set0_security_ex_data(SSL *s, void *ex)
4480 s->cert->sec_ex = ex;
4483 void *SSL_get0_security_ex_data(const SSL *s)
4485 return s->cert->sec_ex;
4488 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4490 ctx->cert->sec_level = level;
4493 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4495 return ctx->cert->sec_level;
4498 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4499 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4500 int op, int bits, int nid,
4501 void *other, void *ex))
4503 ctx->cert->sec_cb = cb;
4506 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4512 return ctx->cert->sec_cb;
4515 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4517 ctx->cert->sec_ex = ex;
4520 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4522 return ctx->cert->sec_ex;
4526 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4527 * can return unsigned long, instead of the generic long return value from the
4528 * control interface.
4530 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4532 return ctx->options;
4535 unsigned long SSL_get_options(const SSL *s)
4540 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4542 return ctx->options |= op;
4545 unsigned long SSL_set_options(SSL *s, unsigned long op)
4547 return s->options |= op;
4550 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4552 return ctx->options &= ~op;
4555 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4557 return s->options &= ~op;
4560 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4562 return s->verified_chain;
4565 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4567 #ifndef OPENSSL_NO_CT
4570 * Moves SCTs from the |src| stack to the |dst| stack.
4571 * The source of each SCT will be set to |origin|.
4572 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4574 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4576 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4577 sct_source_t origin)
4583 *dst = sk_SCT_new_null();
4585 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4590 while ((sct = sk_SCT_pop(src)) != NULL) {
4591 if (SCT_set_source(sct, origin) != 1)
4594 if (sk_SCT_push(*dst, sct) <= 0)
4602 sk_SCT_push(src, sct); /* Put the SCT back */
4607 * Look for data collected during ServerHello and parse if found.
4608 * Returns the number of SCTs extracted.
4610 static int ct_extract_tls_extension_scts(SSL *s)
4612 int scts_extracted = 0;
4614 if (s->ext.scts != NULL) {
4615 const unsigned char *p = s->ext.scts;
4616 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4618 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4620 SCT_LIST_free(scts);
4623 return scts_extracted;
4627 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4628 * contains an SCT X509 extension. They will be stored in |s->scts|.
4630 * - The number of SCTs extracted, assuming an OCSP response exists.
4631 * - 0 if no OCSP response exists or it contains no SCTs.
4632 * - A negative integer if an error occurs.
4634 static int ct_extract_ocsp_response_scts(SSL *s)
4636 # ifndef OPENSSL_NO_OCSP
4637 int scts_extracted = 0;
4638 const unsigned char *p;
4639 OCSP_BASICRESP *br = NULL;
4640 OCSP_RESPONSE *rsp = NULL;
4641 STACK_OF(SCT) *scts = NULL;
4644 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4647 p = s->ext.ocsp.resp;
4648 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4652 br = OCSP_response_get1_basic(rsp);
4656 for (i = 0; i < OCSP_resp_count(br); ++i) {
4657 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4663 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4665 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4666 if (scts_extracted < 0)
4670 SCT_LIST_free(scts);
4671 OCSP_BASICRESP_free(br);
4672 OCSP_RESPONSE_free(rsp);
4673 return scts_extracted;
4675 /* Behave as if no OCSP response exists */
4681 * Attempts to extract SCTs from the peer certificate.
4682 * Return the number of SCTs extracted, or a negative integer if an error
4685 static int ct_extract_x509v3_extension_scts(SSL *s)
4687 int scts_extracted = 0;
4688 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4691 STACK_OF(SCT) *scts =
4692 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4695 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4697 SCT_LIST_free(scts);
4700 return scts_extracted;
4704 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4705 * response (if it exists) and X509v3 extensions in the certificate.
4706 * Returns NULL if an error occurs.
4708 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4710 if (!s->scts_parsed) {
4711 if (ct_extract_tls_extension_scts(s) < 0 ||
4712 ct_extract_ocsp_response_scts(s) < 0 ||
4713 ct_extract_x509v3_extension_scts(s) < 0)
4723 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4724 const STACK_OF(SCT) *scts, void *unused_arg)
4729 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4730 const STACK_OF(SCT) *scts, void *unused_arg)
4732 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4735 for (i = 0; i < count; ++i) {
4736 SCT *sct = sk_SCT_value(scts, i);
4737 int status = SCT_get_validation_status(sct);
4739 if (status == SCT_VALIDATION_STATUS_VALID)
4742 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4746 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4750 * Since code exists that uses the custom extension handler for CT, look
4751 * for this and throw an error if they have already registered to use CT.
4753 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4754 TLSEXT_TYPE_signed_certificate_timestamp))
4756 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4757 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4761 if (callback != NULL) {
4763 * If we are validating CT, then we MUST accept SCTs served via OCSP
4765 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4769 s->ct_validation_callback = callback;
4770 s->ct_validation_callback_arg = arg;
4775 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4776 ssl_ct_validation_cb callback, void *arg)
4779 * Since code exists that uses the custom extension handler for CT, look for
4780 * this and throw an error if they have already registered to use CT.
4782 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4783 TLSEXT_TYPE_signed_certificate_timestamp))
4785 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4786 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4790 ctx->ct_validation_callback = callback;
4791 ctx->ct_validation_callback_arg = arg;
4795 int SSL_ct_is_enabled(const SSL *s)
4797 return s->ct_validation_callback != NULL;
4800 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4802 return ctx->ct_validation_callback != NULL;
4805 int ssl_validate_ct(SSL *s)
4808 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4810 SSL_DANE *dane = &s->dane;
4811 CT_POLICY_EVAL_CTX *ctx = NULL;
4812 const STACK_OF(SCT) *scts;
4815 * If no callback is set, the peer is anonymous, or its chain is invalid,
4816 * skip SCT validation - just return success. Applications that continue
4817 * handshakes without certificates, with unverified chains, or pinned leaf
4818 * certificates are outside the scope of the WebPKI and CT.
4820 * The above exclusions notwithstanding the vast majority of peers will
4821 * have rather ordinary certificate chains validated by typical
4822 * applications that perform certificate verification and therefore will
4823 * process SCTs when enabled.
4825 if (s->ct_validation_callback == NULL || cert == NULL ||
4826 s->verify_result != X509_V_OK ||
4827 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4831 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4832 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4834 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4835 switch (dane->mtlsa->usage) {
4836 case DANETLS_USAGE_DANE_TA:
4837 case DANETLS_USAGE_DANE_EE:
4842 ctx = CT_POLICY_EVAL_CTX_new();
4844 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4845 ERR_R_MALLOC_FAILURE);
4849 issuer = sk_X509_value(s->verified_chain, 1);
4850 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4851 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4852 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4853 CT_POLICY_EVAL_CTX_set_time(
4854 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4856 scts = SSL_get0_peer_scts(s);
4859 * This function returns success (> 0) only when all the SCTs are valid, 0
4860 * when some are invalid, and < 0 on various internal errors (out of
4861 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4862 * reason to abort the handshake, that decision is up to the callback.
4863 * Therefore, we error out only in the unexpected case that the return
4864 * value is negative.
4866 * XXX: One might well argue that the return value of this function is an
4867 * unfortunate design choice. Its job is only to determine the validation
4868 * status of each of the provided SCTs. So long as it correctly separates
4869 * the wheat from the chaff it should return success. Failure in this case
4870 * ought to correspond to an inability to carry out its duties.
4872 if (SCT_LIST_validate(scts, ctx) < 0) {
4873 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4874 SSL_R_SCT_VERIFICATION_FAILED);
4878 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4880 ret = 0; /* This function returns 0 on failure */
4882 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4883 SSL_R_CALLBACK_FAILED);
4886 CT_POLICY_EVAL_CTX_free(ctx);
4888 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4889 * failure return code here. Also the application may wish the complete
4890 * the handshake, and then disconnect cleanly at a higher layer, after
4891 * checking the verification status of the completed connection.
4893 * We therefore force a certificate verification failure which will be
4894 * visible via SSL_get_verify_result() and cached as part of any resumed
4897 * Note: the permissive callback is for information gathering only, always
4898 * returns success, and does not affect verification status. Only the
4899 * strict callback or a custom application-specified callback can trigger
4900 * connection failure or record a verification error.
4903 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4907 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4909 switch (validation_mode) {
4911 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4913 case SSL_CT_VALIDATION_PERMISSIVE:
4914 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4915 case SSL_CT_VALIDATION_STRICT:
4916 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4920 int SSL_enable_ct(SSL *s, int validation_mode)
4922 switch (validation_mode) {
4924 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4926 case SSL_CT_VALIDATION_PERMISSIVE:
4927 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4928 case SSL_CT_VALIDATION_STRICT:
4929 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4933 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4935 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4938 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4940 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4943 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4945 CTLOG_STORE_free(ctx->ctlog_store);
4946 ctx->ctlog_store = logs;
4949 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4951 return ctx->ctlog_store;
4954 #endif /* OPENSSL_NO_CT */
4956 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4959 c->client_hello_cb = cb;
4960 c->client_hello_cb_arg = arg;
4963 int SSL_client_hello_isv2(SSL *s)
4965 if (s->clienthello == NULL)
4967 return s->clienthello->isv2;
4970 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4972 if (s->clienthello == NULL)
4974 return s->clienthello->legacy_version;
4977 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
4979 if (s->clienthello == NULL)
4982 *out = s->clienthello->random;
4983 return SSL3_RANDOM_SIZE;
4986 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
4988 if (s->clienthello == NULL)
4991 *out = s->clienthello->session_id;
4992 return s->clienthello->session_id_len;
4995 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
4997 if (s->clienthello == NULL)
5000 *out = PACKET_data(&s->clienthello->ciphersuites);
5001 return PACKET_remaining(&s->clienthello->ciphersuites);
5004 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
5006 if (s->clienthello == NULL)
5009 *out = s->clienthello->compressions;
5010 return s->clienthello->compressions_len;
5013 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5019 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5021 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5022 ext = s->clienthello->pre_proc_exts + i;
5026 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
5027 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
5028 ERR_R_MALLOC_FAILURE);
5031 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5032 ext = s->clienthello->pre_proc_exts + i;
5034 if (ext->received_order >= num)
5036 present[ext->received_order] = ext->type;
5043 OPENSSL_free(present);
5047 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5053 if (s->clienthello == NULL)
5055 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5056 r = s->clienthello->pre_proc_exts + i;
5057 if (r->present && r->type == type) {
5059 *out = PACKET_data(&r->data);
5061 *outlen = PACKET_remaining(&r->data);
5068 int SSL_free_buffers(SSL *ssl)
5070 RECORD_LAYER *rl = &ssl->rlayer;
5072 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5075 RECORD_LAYER_release(rl);
5079 int SSL_alloc_buffers(SSL *ssl)
5081 return ssl3_setup_buffers(ssl);
5084 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5086 ctx->keylog_callback = cb;
5089 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5091 return ctx->keylog_callback;
5094 static int nss_keylog_int(const char *prefix,
5096 const uint8_t *parameter_1,
5097 size_t parameter_1_len,
5098 const uint8_t *parameter_2,
5099 size_t parameter_2_len)
5102 char *cursor = NULL;
5107 if (ssl->ctx->keylog_callback == NULL) return 1;
5110 * Our output buffer will contain the following strings, rendered with
5111 * space characters in between, terminated by a NULL character: first the
5112 * prefix, then the first parameter, then the second parameter. The
5113 * meaning of each parameter depends on the specific key material being
5114 * logged. Note that the first and second parameters are encoded in
5115 * hexadecimal, so we need a buffer that is twice their lengths.
5117 prefix_len = strlen(prefix);
5118 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
5119 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5120 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5121 ERR_R_MALLOC_FAILURE);
5125 strcpy(cursor, prefix);
5126 cursor += prefix_len;
5129 for (i = 0; i < parameter_1_len; i++) {
5130 sprintf(cursor, "%02x", parameter_1[i]);
5135 for (i = 0; i < parameter_2_len; i++) {
5136 sprintf(cursor, "%02x", parameter_2[i]);
5141 ssl->ctx->keylog_callback(ssl, (const char *)out);
5147 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5148 const uint8_t *encrypted_premaster,
5149 size_t encrypted_premaster_len,
5150 const uint8_t *premaster,
5151 size_t premaster_len)
5153 if (encrypted_premaster_len < 8) {
5154 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5155 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5159 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5160 return nss_keylog_int("RSA",
5162 encrypted_premaster,
5168 int ssl_log_secret(SSL *ssl,
5170 const uint8_t *secret,
5173 return nss_keylog_int(label,
5175 ssl->s3->client_random,
5181 #define SSLV2_CIPHER_LEN 3
5183 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5187 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5189 if (PACKET_remaining(cipher_suites) == 0) {
5190 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5191 SSL_R_NO_CIPHERS_SPECIFIED);
5195 if (PACKET_remaining(cipher_suites) % n != 0) {
5196 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5197 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5201 OPENSSL_free(s->s3->tmp.ciphers_raw);
5202 s->s3->tmp.ciphers_raw = NULL;
5203 s->s3->tmp.ciphers_rawlen = 0;
5206 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5207 PACKET sslv2ciphers = *cipher_suites;
5208 unsigned int leadbyte;
5212 * We store the raw ciphers list in SSLv3+ format so we need to do some
5213 * preprocessing to convert the list first. If there are any SSLv2 only
5214 * ciphersuites with a non-zero leading byte then we are going to
5215 * slightly over allocate because we won't store those. But that isn't a
5218 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5219 s->s3->tmp.ciphers_raw = raw;
5221 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5222 ERR_R_MALLOC_FAILURE);
5225 for (s->s3->tmp.ciphers_rawlen = 0;
5226 PACKET_remaining(&sslv2ciphers) > 0;
5227 raw += TLS_CIPHER_LEN) {
5228 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5230 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5233 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5234 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5236 OPENSSL_free(s->s3->tmp.ciphers_raw);
5237 s->s3->tmp.ciphers_raw = NULL;
5238 s->s3->tmp.ciphers_rawlen = 0;
5242 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5244 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5245 &s->s3->tmp.ciphers_rawlen)) {
5246 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5247 ERR_R_INTERNAL_ERROR);
5253 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5254 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5255 STACK_OF(SSL_CIPHER) **scsvs)
5259 if (!PACKET_buf_init(&pkt, bytes, len))
5261 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5264 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5265 STACK_OF(SSL_CIPHER) **skp,
5266 STACK_OF(SSL_CIPHER) **scsvs_out,
5267 int sslv2format, int fatal)
5269 const SSL_CIPHER *c;
5270 STACK_OF(SSL_CIPHER) *sk = NULL;
5271 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5273 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5274 unsigned char cipher[SSLV2_CIPHER_LEN];
5276 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5278 if (PACKET_remaining(cipher_suites) == 0) {
5280 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5281 SSL_R_NO_CIPHERS_SPECIFIED);
5283 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5287 if (PACKET_remaining(cipher_suites) % n != 0) {
5289 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5290 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5292 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5293 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5297 sk = sk_SSL_CIPHER_new_null();
5298 scsvs = sk_SSL_CIPHER_new_null();
5299 if (sk == NULL || scsvs == NULL) {
5301 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5302 ERR_R_MALLOC_FAILURE);
5304 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5308 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5310 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5311 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5312 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5314 if (sslv2format && cipher[0] != '\0')
5317 /* For SSLv2-compat, ignore leading 0-byte. */
5318 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5320 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5321 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5323 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5324 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5326 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5331 if (PACKET_remaining(cipher_suites) > 0) {
5333 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5336 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5343 sk_SSL_CIPHER_free(sk);
5344 if (scsvs_out != NULL)
5347 sk_SSL_CIPHER_free(scsvs);
5350 sk_SSL_CIPHER_free(sk);
5351 sk_SSL_CIPHER_free(scsvs);
5355 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5357 ctx->max_early_data = max_early_data;
5362 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5364 return ctx->max_early_data;
5367 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5369 s->max_early_data = max_early_data;
5374 uint32_t SSL_get_max_early_data(const SSL *s)
5376 return s->max_early_data;
5379 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5381 /* Return any active Max Fragment Len extension */
5382 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5383 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5385 /* return current SSL connection setting */
5386 return ssl->max_send_fragment;
5389 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5391 /* Return a value regarding an active Max Fragment Len extension */
5392 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5393 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5394 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5396 /* else limit |split_send_fragment| to current |max_send_fragment| */
5397 if (ssl->split_send_fragment > ssl->max_send_fragment)
5398 return ssl->max_send_fragment;
5400 /* return current SSL connection setting */
5401 return ssl->split_send_fragment;
5404 int SSL_stateless(SSL *s)
5408 /* Ensure there is no state left over from a previous invocation */
5414 s->s3->flags |= TLS1_FLAGS_STATELESS;
5415 ret = SSL_accept(s);
5416 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5418 if (ret > 0 && s->ext.cookieok)
5421 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5427 void SSL_force_post_handshake_auth(SSL *ssl)
5429 ssl->pha_forced = 1;
5432 int SSL_verify_client_post_handshake(SSL *ssl)
5434 if (!SSL_IS_TLS13(ssl)) {
5435 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5439 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5443 if (!SSL_is_init_finished(ssl)) {
5444 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5448 switch (ssl->post_handshake_auth) {
5450 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5453 case SSL_PHA_EXT_SENT:
5454 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5456 case SSL_PHA_EXT_RECEIVED:
5458 case SSL_PHA_REQUEST_PENDING:
5459 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5461 case SSL_PHA_REQUESTED:
5462 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5466 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5468 /* checks verify_mode and algorithm_auth */
5469 if (!send_certificate_request(ssl)) {
5470 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5471 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5475 ossl_statem_set_in_init(ssl, 1);
5479 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5480 SSL_CTX_generate_session_ticket_fn gen_cb,
5481 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5484 ctx->generate_ticket_cb = gen_cb;
5485 ctx->decrypt_ticket_cb = dec_cb;
5486 ctx->ticket_cb_data = arg;
5490 void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
5491 SSL_allow_early_data_cb_fn cb,
5494 ctx->allow_early_data_cb = cb;
5495 ctx->allow_early_data_cb_data = arg;
5498 void SSL_set_allow_early_data_cb(SSL *s,
5499 SSL_allow_early_data_cb_fn cb,
5502 s->allow_early_data_cb = cb;
5503 s->allow_early_data_cb_data = arg;