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 if (!SSL_CTX_set_ciphersuites(ctx, TLS_DEFAULT_CIPHERSUITES)) {
658 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
661 sk = ssl_create_cipher_list(ctx->method,
662 ctx->tls13_ciphersuites,
664 &(ctx->cipher_list_by_id),
665 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
666 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
667 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
673 SSL *SSL_new(SSL_CTX *ctx)
678 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
681 if (ctx->method == NULL) {
682 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
686 s = OPENSSL_zalloc(sizeof(*s));
691 s->lock = CRYPTO_THREAD_lock_new();
692 if (s->lock == NULL) {
698 RECORD_LAYER_init(&s->rlayer, s);
700 s->options = ctx->options;
701 s->dane.flags = ctx->dane.flags;
702 s->min_proto_version = ctx->min_proto_version;
703 s->max_proto_version = ctx->max_proto_version;
705 s->max_cert_list = ctx->max_cert_list;
706 s->max_early_data = ctx->max_early_data;
707 s->recv_max_early_data = ctx->recv_max_early_data;
708 s->num_tickets = ctx->num_tickets;
709 s->pha_enabled = ctx->pha_enabled;
711 /* Shallow copy of the ciphersuites stack */
712 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
713 if (s->tls13_ciphersuites == NULL)
717 * Earlier library versions used to copy the pointer to the CERT, not
718 * its contents; only when setting new parameters for the per-SSL
719 * copy, ssl_cert_new would be called (and the direct reference to
720 * the per-SSL_CTX settings would be lost, but those still were
721 * indirectly accessed for various purposes, and for that reason they
722 * used to be known as s->ctx->default_cert). Now we don't look at the
723 * SSL_CTX's CERT after having duplicated it once.
725 s->cert = ssl_cert_dup(ctx->cert);
729 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
730 s->msg_callback = ctx->msg_callback;
731 s->msg_callback_arg = ctx->msg_callback_arg;
732 s->verify_mode = ctx->verify_mode;
733 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
734 s->record_padding_cb = ctx->record_padding_cb;
735 s->record_padding_arg = ctx->record_padding_arg;
736 s->block_padding = ctx->block_padding;
737 s->sid_ctx_length = ctx->sid_ctx_length;
738 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
740 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
741 s->verify_callback = ctx->default_verify_callback;
742 s->generate_session_id = ctx->generate_session_id;
744 s->param = X509_VERIFY_PARAM_new();
745 if (s->param == NULL)
747 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
748 s->quiet_shutdown = ctx->quiet_shutdown;
750 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
751 s->max_send_fragment = ctx->max_send_fragment;
752 s->split_send_fragment = ctx->split_send_fragment;
753 s->max_pipelines = ctx->max_pipelines;
754 if (s->max_pipelines > 1)
755 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
756 if (ctx->default_read_buf_len > 0)
757 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
762 s->ext.debug_arg = NULL;
763 s->ext.ticket_expected = 0;
764 s->ext.status_type = ctx->ext.status_type;
765 s->ext.status_expected = 0;
766 s->ext.ocsp.ids = NULL;
767 s->ext.ocsp.exts = NULL;
768 s->ext.ocsp.resp = NULL;
769 s->ext.ocsp.resp_len = 0;
771 s->session_ctx = ctx;
772 #ifndef OPENSSL_NO_EC
773 if (ctx->ext.ecpointformats) {
774 s->ext.ecpointformats =
775 OPENSSL_memdup(ctx->ext.ecpointformats,
776 ctx->ext.ecpointformats_len);
777 if (!s->ext.ecpointformats)
779 s->ext.ecpointformats_len =
780 ctx->ext.ecpointformats_len;
782 if (ctx->ext.supportedgroups) {
783 s->ext.supportedgroups =
784 OPENSSL_memdup(ctx->ext.supportedgroups,
785 ctx->ext.supportedgroups_len
786 * sizeof(*ctx->ext.supportedgroups));
787 if (!s->ext.supportedgroups)
789 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
792 #ifndef OPENSSL_NO_NEXTPROTONEG
796 if (s->ctx->ext.alpn) {
797 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
798 if (s->ext.alpn == NULL)
800 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
801 s->ext.alpn_len = s->ctx->ext.alpn_len;
804 s->verified_chain = NULL;
805 s->verify_result = X509_V_OK;
807 s->default_passwd_callback = ctx->default_passwd_callback;
808 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
810 s->method = ctx->method;
812 s->key_update = SSL_KEY_UPDATE_NONE;
814 s->allow_early_data_cb = ctx->allow_early_data_cb;
815 s->allow_early_data_cb_data = ctx->allow_early_data_cb_data;
817 if (!s->method->ssl_new(s))
820 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
825 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
828 #ifndef OPENSSL_NO_PSK
829 s->psk_client_callback = ctx->psk_client_callback;
830 s->psk_server_callback = ctx->psk_server_callback;
832 s->psk_find_session_cb = ctx->psk_find_session_cb;
833 s->psk_use_session_cb = ctx->psk_use_session_cb;
837 #ifndef OPENSSL_NO_CT
838 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
839 ctx->ct_validation_callback_arg))
846 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
850 int SSL_is_dtls(const SSL *s)
852 return SSL_IS_DTLS(s) ? 1 : 0;
855 int SSL_up_ref(SSL *s)
859 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
862 REF_PRINT_COUNT("SSL", s);
863 REF_ASSERT_ISNT(i < 2);
864 return ((i > 1) ? 1 : 0);
867 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
868 unsigned int sid_ctx_len)
870 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
871 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
872 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
875 ctx->sid_ctx_length = sid_ctx_len;
876 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
881 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
882 unsigned int sid_ctx_len)
884 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
885 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
886 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
889 ssl->sid_ctx_length = sid_ctx_len;
890 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
895 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
897 CRYPTO_THREAD_write_lock(ctx->lock);
898 ctx->generate_session_id = cb;
899 CRYPTO_THREAD_unlock(ctx->lock);
903 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
905 CRYPTO_THREAD_write_lock(ssl->lock);
906 ssl->generate_session_id = cb;
907 CRYPTO_THREAD_unlock(ssl->lock);
911 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
915 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
916 * we can "construct" a session to give us the desired check - i.e. to
917 * find if there's a session in the hash table that would conflict with
918 * any new session built out of this id/id_len and the ssl_version in use
923 if (id_len > sizeof(r.session_id))
926 r.ssl_version = ssl->version;
927 r.session_id_length = id_len;
928 memcpy(r.session_id, id, id_len);
930 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
931 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
932 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
936 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
938 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
941 int SSL_set_purpose(SSL *s, int purpose)
943 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
946 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
948 return X509_VERIFY_PARAM_set_trust(s->param, trust);
951 int SSL_set_trust(SSL *s, int trust)
953 return X509_VERIFY_PARAM_set_trust(s->param, trust);
956 int SSL_set1_host(SSL *s, const char *hostname)
958 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
961 int SSL_add1_host(SSL *s, const char *hostname)
963 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
966 void SSL_set_hostflags(SSL *s, unsigned int flags)
968 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
971 const char *SSL_get0_peername(SSL *s)
973 return X509_VERIFY_PARAM_get0_peername(s->param);
976 int SSL_CTX_dane_enable(SSL_CTX *ctx)
978 return dane_ctx_enable(&ctx->dane);
981 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
983 unsigned long orig = ctx->dane.flags;
985 ctx->dane.flags |= flags;
989 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
991 unsigned long orig = ctx->dane.flags;
993 ctx->dane.flags &= ~flags;
997 int SSL_dane_enable(SSL *s, const char *basedomain)
999 SSL_DANE *dane = &s->dane;
1001 if (s->ctx->dane.mdmax == 0) {
1002 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
1005 if (dane->trecs != NULL) {
1006 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1011 * Default SNI name. This rejects empty names, while set1_host below
1012 * accepts them and disables host name checks. To avoid side-effects with
1013 * invalid input, set the SNI name first.
1015 if (s->ext.hostname == NULL) {
1016 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1017 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1022 /* Primary RFC6125 reference identifier */
1023 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1024 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1030 dane->dctx = &s->ctx->dane;
1031 dane->trecs = sk_danetls_record_new_null();
1033 if (dane->trecs == NULL) {
1034 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1040 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1042 unsigned long orig = ssl->dane.flags;
1044 ssl->dane.flags |= flags;
1048 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1050 unsigned long orig = ssl->dane.flags;
1052 ssl->dane.flags &= ~flags;
1056 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1058 SSL_DANE *dane = &s->dane;
1060 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1064 *mcert = dane->mcert;
1066 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1071 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1072 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1074 SSL_DANE *dane = &s->dane;
1076 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1080 *usage = dane->mtlsa->usage;
1082 *selector = dane->mtlsa->selector;
1084 *mtype = dane->mtlsa->mtype;
1086 *data = dane->mtlsa->data;
1088 *dlen = dane->mtlsa->dlen;
1093 SSL_DANE *SSL_get0_dane(SSL *s)
1098 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1099 uint8_t mtype, unsigned const char *data, size_t dlen)
1101 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1104 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1107 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1110 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1112 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1115 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1117 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1120 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1125 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1130 void SSL_certs_clear(SSL *s)
1132 ssl_cert_clear_certs(s->cert);
1135 void SSL_free(SSL *s)
1141 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1142 REF_PRINT_COUNT("SSL", s);
1145 REF_ASSERT_ISNT(i < 0);
1147 X509_VERIFY_PARAM_free(s->param);
1148 dane_final(&s->dane);
1149 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1151 /* Ignore return value */
1152 ssl_free_wbio_buffer(s);
1154 BIO_free_all(s->wbio);
1155 BIO_free_all(s->rbio);
1157 BUF_MEM_free(s->init_buf);
1159 /* add extra stuff */
1160 sk_SSL_CIPHER_free(s->cipher_list);
1161 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1162 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1164 /* Make the next call work :-) */
1165 if (s->session != NULL) {
1166 ssl_clear_bad_session(s);
1167 SSL_SESSION_free(s->session);
1169 SSL_SESSION_free(s->psksession);
1170 OPENSSL_free(s->psksession_id);
1174 ssl_cert_free(s->cert);
1175 /* Free up if allocated */
1177 OPENSSL_free(s->ext.hostname);
1178 SSL_CTX_free(s->session_ctx);
1179 #ifndef OPENSSL_NO_EC
1180 OPENSSL_free(s->ext.ecpointformats);
1181 OPENSSL_free(s->ext.supportedgroups);
1182 #endif /* OPENSSL_NO_EC */
1183 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1184 #ifndef OPENSSL_NO_OCSP
1185 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1187 #ifndef OPENSSL_NO_CT
1188 SCT_LIST_free(s->scts);
1189 OPENSSL_free(s->ext.scts);
1191 OPENSSL_free(s->ext.ocsp.resp);
1192 OPENSSL_free(s->ext.alpn);
1193 OPENSSL_free(s->ext.tls13_cookie);
1194 OPENSSL_free(s->clienthello);
1195 OPENSSL_free(s->pha_context);
1196 EVP_MD_CTX_free(s->pha_dgst);
1198 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1200 sk_X509_pop_free(s->verified_chain, X509_free);
1202 if (s->method != NULL)
1203 s->method->ssl_free(s);
1205 RECORD_LAYER_release(&s->rlayer);
1207 SSL_CTX_free(s->ctx);
1209 ASYNC_WAIT_CTX_free(s->waitctx);
1211 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1212 OPENSSL_free(s->ext.npn);
1215 #ifndef OPENSSL_NO_SRTP
1216 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1219 CRYPTO_THREAD_lock_free(s->lock);
1224 void SSL_set0_rbio(SSL *s, BIO *rbio)
1226 BIO_free_all(s->rbio);
1230 void SSL_set0_wbio(SSL *s, BIO *wbio)
1233 * If the output buffering BIO is still in place, remove it
1235 if (s->bbio != NULL)
1236 s->wbio = BIO_pop(s->wbio);
1238 BIO_free_all(s->wbio);
1241 /* Re-attach |bbio| to the new |wbio|. */
1242 if (s->bbio != NULL)
1243 s->wbio = BIO_push(s->bbio, s->wbio);
1246 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1249 * For historical reasons, this function has many different cases in
1250 * ownership handling.
1253 /* If nothing has changed, do nothing */
1254 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1258 * If the two arguments are equal then one fewer reference is granted by the
1259 * caller than we want to take
1261 if (rbio != NULL && rbio == wbio)
1265 * If only the wbio is changed only adopt one reference.
1267 if (rbio == SSL_get_rbio(s)) {
1268 SSL_set0_wbio(s, wbio);
1272 * There is an asymmetry here for historical reasons. If only the rbio is
1273 * changed AND the rbio and wbio were originally different, then we only
1274 * adopt one reference.
1276 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1277 SSL_set0_rbio(s, rbio);
1281 /* Otherwise, adopt both references. */
1282 SSL_set0_rbio(s, rbio);
1283 SSL_set0_wbio(s, wbio);
1286 BIO *SSL_get_rbio(const SSL *s)
1291 BIO *SSL_get_wbio(const SSL *s)
1293 if (s->bbio != NULL) {
1295 * If |bbio| is active, the true caller-configured BIO is its
1298 return BIO_next(s->bbio);
1303 int SSL_get_fd(const SSL *s)
1305 return SSL_get_rfd(s);
1308 int SSL_get_rfd(const SSL *s)
1313 b = SSL_get_rbio(s);
1314 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1316 BIO_get_fd(r, &ret);
1320 int SSL_get_wfd(const SSL *s)
1325 b = SSL_get_wbio(s);
1326 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1328 BIO_get_fd(r, &ret);
1332 #ifndef OPENSSL_NO_SOCK
1333 int SSL_set_fd(SSL *s, int fd)
1338 bio = BIO_new(BIO_s_socket());
1341 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1344 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1345 SSL_set_bio(s, bio, bio);
1351 int SSL_set_wfd(SSL *s, int fd)
1353 BIO *rbio = SSL_get_rbio(s);
1355 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1356 || (int)BIO_get_fd(rbio, NULL) != fd) {
1357 BIO *bio = BIO_new(BIO_s_socket());
1360 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1363 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1364 SSL_set0_wbio(s, bio);
1367 SSL_set0_wbio(s, rbio);
1372 int SSL_set_rfd(SSL *s, int fd)
1374 BIO *wbio = SSL_get_wbio(s);
1376 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1377 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1378 BIO *bio = BIO_new(BIO_s_socket());
1381 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1384 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1385 SSL_set0_rbio(s, bio);
1388 SSL_set0_rbio(s, wbio);
1395 /* return length of latest Finished message we sent, copy to 'buf' */
1396 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1400 if (s->s3 != NULL) {
1401 ret = s->s3->tmp.finish_md_len;
1404 memcpy(buf, s->s3->tmp.finish_md, count);
1409 /* return length of latest Finished message we expected, copy to 'buf' */
1410 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1414 if (s->s3 != NULL) {
1415 ret = s->s3->tmp.peer_finish_md_len;
1418 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1423 int SSL_get_verify_mode(const SSL *s)
1425 return s->verify_mode;
1428 int SSL_get_verify_depth(const SSL *s)
1430 return X509_VERIFY_PARAM_get_depth(s->param);
1433 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1434 return s->verify_callback;
1437 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1439 return ctx->verify_mode;
1442 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1444 return X509_VERIFY_PARAM_get_depth(ctx->param);
1447 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1448 return ctx->default_verify_callback;
1451 void SSL_set_verify(SSL *s, int mode,
1452 int (*callback) (int ok, X509_STORE_CTX *ctx))
1454 s->verify_mode = mode;
1455 if (callback != NULL)
1456 s->verify_callback = callback;
1459 void SSL_set_verify_depth(SSL *s, int depth)
1461 X509_VERIFY_PARAM_set_depth(s->param, depth);
1464 void SSL_set_read_ahead(SSL *s, int yes)
1466 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1469 int SSL_get_read_ahead(const SSL *s)
1471 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1474 int SSL_pending(const SSL *s)
1476 size_t pending = s->method->ssl_pending(s);
1479 * SSL_pending cannot work properly if read-ahead is enabled
1480 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1481 * impossible to fix since SSL_pending cannot report errors that may be
1482 * observed while scanning the new data. (Note that SSL_pending() is
1483 * often used as a boolean value, so we'd better not return -1.)
1485 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1486 * we just return INT_MAX.
1488 return pending < INT_MAX ? (int)pending : INT_MAX;
1491 int SSL_has_pending(const SSL *s)
1494 * Similar to SSL_pending() but returns a 1 to indicate that we have
1495 * unprocessed data available or 0 otherwise (as opposed to the number of
1496 * bytes available). Unlike SSL_pending() this will take into account
1497 * read_ahead data. A 1 return simply indicates that we have unprocessed
1498 * data. That data may not result in any application data, or we may fail
1499 * to parse the records for some reason.
1501 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1504 return RECORD_LAYER_read_pending(&s->rlayer);
1507 X509 *SSL_get_peer_certificate(const SSL *s)
1511 if ((s == NULL) || (s->session == NULL))
1514 r = s->session->peer;
1524 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1528 if ((s == NULL) || (s->session == NULL))
1531 r = s->session->peer_chain;
1534 * If we are a client, cert_chain includes the peer's own certificate; if
1535 * we are a server, it does not.
1542 * Now in theory, since the calling process own 't' it should be safe to
1543 * modify. We need to be able to read f without being hassled
1545 int SSL_copy_session_id(SSL *t, const SSL *f)
1548 /* Do we need to to SSL locking? */
1549 if (!SSL_set_session(t, SSL_get_session(f))) {
1554 * what if we are setup for one protocol version but want to talk another
1556 if (t->method != f->method) {
1557 t->method->ssl_free(t);
1558 t->method = f->method;
1559 if (t->method->ssl_new(t) == 0)
1563 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1564 ssl_cert_free(t->cert);
1566 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1573 /* Fix this so it checks all the valid key/cert options */
1574 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1576 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1577 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1580 if (ctx->cert->key->privatekey == NULL) {
1581 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1584 return X509_check_private_key
1585 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1588 /* Fix this function so that it takes an optional type parameter */
1589 int SSL_check_private_key(const SSL *ssl)
1592 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1595 if (ssl->cert->key->x509 == NULL) {
1596 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1599 if (ssl->cert->key->privatekey == NULL) {
1600 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1603 return X509_check_private_key(ssl->cert->key->x509,
1604 ssl->cert->key->privatekey);
1607 int SSL_waiting_for_async(SSL *s)
1615 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1617 ASYNC_WAIT_CTX *ctx = s->waitctx;
1621 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1624 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1625 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1627 ASYNC_WAIT_CTX *ctx = s->waitctx;
1631 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1635 int SSL_accept(SSL *s)
1637 if (s->handshake_func == NULL) {
1638 /* Not properly initialized yet */
1639 SSL_set_accept_state(s);
1642 return SSL_do_handshake(s);
1645 int SSL_connect(SSL *s)
1647 if (s->handshake_func == NULL) {
1648 /* Not properly initialized yet */
1649 SSL_set_connect_state(s);
1652 return SSL_do_handshake(s);
1655 long SSL_get_default_timeout(const SSL *s)
1657 return s->method->get_timeout();
1660 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1661 int (*func) (void *))
1664 if (s->waitctx == NULL) {
1665 s->waitctx = ASYNC_WAIT_CTX_new();
1666 if (s->waitctx == NULL)
1669 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1670 sizeof(struct ssl_async_args))) {
1672 s->rwstate = SSL_NOTHING;
1673 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1676 s->rwstate = SSL_ASYNC_PAUSED;
1679 s->rwstate = SSL_ASYNC_NO_JOBS;
1685 s->rwstate = SSL_NOTHING;
1686 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1687 /* Shouldn't happen */
1692 static int ssl_io_intern(void *vargs)
1694 struct ssl_async_args *args;
1699 args = (struct ssl_async_args *)vargs;
1703 switch (args->type) {
1705 return args->f.func_read(s, buf, num, &s->asyncrw);
1707 return args->f.func_write(s, buf, num, &s->asyncrw);
1709 return args->f.func_other(s);
1714 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1716 if (s->handshake_func == NULL) {
1717 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1721 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1722 s->rwstate = SSL_NOTHING;
1726 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1727 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1728 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1732 * If we are a client and haven't received the ServerHello etc then we
1735 ossl_statem_check_finish_init(s, 0);
1737 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1738 struct ssl_async_args args;
1744 args.type = READFUNC;
1745 args.f.func_read = s->method->ssl_read;
1747 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1748 *readbytes = s->asyncrw;
1751 return s->method->ssl_read(s, buf, num, readbytes);
1755 int SSL_read(SSL *s, void *buf, int num)
1761 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1765 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1768 * The cast is safe here because ret should be <= INT_MAX because num is
1772 ret = (int)readbytes;
1777 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1779 int ret = ssl_read_internal(s, buf, num, readbytes);
1786 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1791 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1792 return SSL_READ_EARLY_DATA_ERROR;
1795 switch (s->early_data_state) {
1796 case SSL_EARLY_DATA_NONE:
1797 if (!SSL_in_before(s)) {
1798 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1799 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1800 return SSL_READ_EARLY_DATA_ERROR;
1804 case SSL_EARLY_DATA_ACCEPT_RETRY:
1805 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1806 ret = SSL_accept(s);
1809 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1810 return SSL_READ_EARLY_DATA_ERROR;
1814 case SSL_EARLY_DATA_READ_RETRY:
1815 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1816 s->early_data_state = SSL_EARLY_DATA_READING;
1817 ret = SSL_read_ex(s, buf, num, readbytes);
1819 * State machine will update early_data_state to
1820 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1823 if (ret > 0 || (ret <= 0 && s->early_data_state
1824 != SSL_EARLY_DATA_FINISHED_READING)) {
1825 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1826 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1827 : SSL_READ_EARLY_DATA_ERROR;
1830 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1833 return SSL_READ_EARLY_DATA_FINISH;
1836 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1837 return SSL_READ_EARLY_DATA_ERROR;
1841 int SSL_get_early_data_status(const SSL *s)
1843 return s->ext.early_data;
1846 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1848 if (s->handshake_func == NULL) {
1849 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1853 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1856 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1857 struct ssl_async_args args;
1863 args.type = READFUNC;
1864 args.f.func_read = s->method->ssl_peek;
1866 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1867 *readbytes = s->asyncrw;
1870 return s->method->ssl_peek(s, buf, num, readbytes);
1874 int SSL_peek(SSL *s, void *buf, int num)
1880 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1884 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1887 * The cast is safe here because ret should be <= INT_MAX because num is
1891 ret = (int)readbytes;
1897 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1899 int ret = ssl_peek_internal(s, buf, num, readbytes);
1906 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1908 if (s->handshake_func == NULL) {
1909 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1913 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1914 s->rwstate = SSL_NOTHING;
1915 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1919 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1920 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1921 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1922 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1925 /* If we are a client and haven't sent the Finished we better do that */
1926 ossl_statem_check_finish_init(s, 1);
1928 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1930 struct ssl_async_args args;
1933 args.buf = (void *)buf;
1935 args.type = WRITEFUNC;
1936 args.f.func_write = s->method->ssl_write;
1938 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1939 *written = s->asyncrw;
1942 return s->method->ssl_write(s, buf, num, written);
1946 int SSL_write(SSL *s, const void *buf, int num)
1952 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1956 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1959 * The cast is safe here because ret should be <= INT_MAX because num is
1968 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1970 int ret = ssl_write_internal(s, buf, num, written);
1977 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1979 int ret, early_data_state;
1981 uint32_t partialwrite;
1983 switch (s->early_data_state) {
1984 case SSL_EARLY_DATA_NONE:
1986 || !SSL_in_before(s)
1987 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1988 && (s->psk_use_session_cb == NULL))) {
1989 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1990 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1995 case SSL_EARLY_DATA_CONNECT_RETRY:
1996 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1997 ret = SSL_connect(s);
2000 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2005 case SSL_EARLY_DATA_WRITE_RETRY:
2006 s->early_data_state = SSL_EARLY_DATA_WRITING;
2008 * We disable partial write for early data because we don't keep track
2009 * of how many bytes we've written between the SSL_write_ex() call and
2010 * the flush if the flush needs to be retried)
2012 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2013 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2014 ret = SSL_write_ex(s, buf, num, &writtmp);
2015 s->mode |= partialwrite;
2017 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2020 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2023 case SSL_EARLY_DATA_WRITE_FLUSH:
2024 /* The buffering BIO is still in place so we need to flush it */
2025 if (statem_flush(s) != 1)
2028 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2031 case SSL_EARLY_DATA_FINISHED_READING:
2032 case SSL_EARLY_DATA_READ_RETRY:
2033 early_data_state = s->early_data_state;
2034 /* We are a server writing to an unauthenticated client */
2035 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2036 ret = SSL_write_ex(s, buf, num, written);
2037 /* The buffering BIO is still in place */
2039 (void)BIO_flush(s->wbio);
2040 s->early_data_state = early_data_state;
2044 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2049 int SSL_shutdown(SSL *s)
2052 * Note that this function behaves differently from what one might
2053 * expect. Return values are 0 for no success (yet), 1 for success; but
2054 * calling it once is usually not enough, even if blocking I/O is used
2055 * (see ssl3_shutdown).
2058 if (s->handshake_func == NULL) {
2059 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2063 if (!SSL_in_init(s)) {
2064 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2065 struct ssl_async_args args;
2068 args.type = OTHERFUNC;
2069 args.f.func_other = s->method->ssl_shutdown;
2071 return ssl_start_async_job(s, &args, ssl_io_intern);
2073 return s->method->ssl_shutdown(s);
2076 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2081 int SSL_key_update(SSL *s, int updatetype)
2084 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2085 * negotiated, and that it is appropriate to call SSL_key_update() instead
2086 * of SSL_renegotiate().
2088 if (!SSL_IS_TLS13(s)) {
2089 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2093 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2094 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2095 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2099 if (!SSL_is_init_finished(s)) {
2100 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2104 ossl_statem_set_in_init(s, 1);
2105 s->key_update = updatetype;
2109 int SSL_get_key_update_type(SSL *s)
2111 return s->key_update;
2114 int SSL_renegotiate(SSL *s)
2116 if (SSL_IS_TLS13(s)) {
2117 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2121 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2122 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2129 return s->method->ssl_renegotiate(s);
2132 int SSL_renegotiate_abbreviated(SSL *s)
2134 if (SSL_IS_TLS13(s)) {
2135 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2139 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2140 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2147 return s->method->ssl_renegotiate(s);
2150 int SSL_renegotiate_pending(SSL *s)
2153 * becomes true when negotiation is requested; false again once a
2154 * handshake has finished
2156 return (s->renegotiate != 0);
2159 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2164 case SSL_CTRL_GET_READ_AHEAD:
2165 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2166 case SSL_CTRL_SET_READ_AHEAD:
2167 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2168 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2171 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2172 s->msg_callback_arg = parg;
2176 return (s->mode |= larg);
2177 case SSL_CTRL_CLEAR_MODE:
2178 return (s->mode &= ~larg);
2179 case SSL_CTRL_GET_MAX_CERT_LIST:
2180 return (long)s->max_cert_list;
2181 case SSL_CTRL_SET_MAX_CERT_LIST:
2184 l = (long)s->max_cert_list;
2185 s->max_cert_list = (size_t)larg;
2187 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2188 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2190 s->max_send_fragment = larg;
2191 if (s->max_send_fragment < s->split_send_fragment)
2192 s->split_send_fragment = s->max_send_fragment;
2194 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2195 if ((size_t)larg > s->max_send_fragment || larg == 0)
2197 s->split_send_fragment = larg;
2199 case SSL_CTRL_SET_MAX_PIPELINES:
2200 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2202 s->max_pipelines = larg;
2204 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2206 case SSL_CTRL_GET_RI_SUPPORT:
2208 return s->s3->send_connection_binding;
2211 case SSL_CTRL_CERT_FLAGS:
2212 return (s->cert->cert_flags |= larg);
2213 case SSL_CTRL_CLEAR_CERT_FLAGS:
2214 return (s->cert->cert_flags &= ~larg);
2216 case SSL_CTRL_GET_RAW_CIPHERLIST:
2218 if (s->s3->tmp.ciphers_raw == NULL)
2220 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2221 return (int)s->s3->tmp.ciphers_rawlen;
2223 return TLS_CIPHER_LEN;
2225 case SSL_CTRL_GET_EXTMS_SUPPORT:
2226 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2228 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2232 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2233 return ssl_check_allowed_versions(larg, s->max_proto_version)
2234 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2235 &s->min_proto_version);
2236 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2237 return s->min_proto_version;
2238 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2239 return ssl_check_allowed_versions(s->min_proto_version, larg)
2240 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2241 &s->max_proto_version);
2242 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2243 return s->max_proto_version;
2245 return s->method->ssl_ctrl(s, cmd, larg, parg);
2249 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2252 case SSL_CTRL_SET_MSG_CALLBACK:
2253 s->msg_callback = (void (*)
2254 (int write_p, int version, int content_type,
2255 const void *buf, size_t len, SSL *ssl,
2260 return s->method->ssl_callback_ctrl(s, cmd, fp);
2264 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2266 return ctx->sessions;
2269 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2272 /* For some cases with ctx == NULL perform syntax checks */
2275 #ifndef OPENSSL_NO_EC
2276 case SSL_CTRL_SET_GROUPS_LIST:
2277 return tls1_set_groups_list(NULL, NULL, parg);
2279 case SSL_CTRL_SET_SIGALGS_LIST:
2280 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2281 return tls1_set_sigalgs_list(NULL, parg, 0);
2288 case SSL_CTRL_GET_READ_AHEAD:
2289 return ctx->read_ahead;
2290 case SSL_CTRL_SET_READ_AHEAD:
2291 l = ctx->read_ahead;
2292 ctx->read_ahead = larg;
2295 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2296 ctx->msg_callback_arg = parg;
2299 case SSL_CTRL_GET_MAX_CERT_LIST:
2300 return (long)ctx->max_cert_list;
2301 case SSL_CTRL_SET_MAX_CERT_LIST:
2304 l = (long)ctx->max_cert_list;
2305 ctx->max_cert_list = (size_t)larg;
2308 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2311 l = (long)ctx->session_cache_size;
2312 ctx->session_cache_size = (size_t)larg;
2314 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2315 return (long)ctx->session_cache_size;
2316 case SSL_CTRL_SET_SESS_CACHE_MODE:
2317 l = ctx->session_cache_mode;
2318 ctx->session_cache_mode = larg;
2320 case SSL_CTRL_GET_SESS_CACHE_MODE:
2321 return ctx->session_cache_mode;
2323 case SSL_CTRL_SESS_NUMBER:
2324 return lh_SSL_SESSION_num_items(ctx->sessions);
2325 case SSL_CTRL_SESS_CONNECT:
2326 return tsan_load(&ctx->stats.sess_connect);
2327 case SSL_CTRL_SESS_CONNECT_GOOD:
2328 return tsan_load(&ctx->stats.sess_connect_good);
2329 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2330 return tsan_load(&ctx->stats.sess_connect_renegotiate);
2331 case SSL_CTRL_SESS_ACCEPT:
2332 return tsan_load(&ctx->stats.sess_accept);
2333 case SSL_CTRL_SESS_ACCEPT_GOOD:
2334 return tsan_load(&ctx->stats.sess_accept_good);
2335 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2336 return tsan_load(&ctx->stats.sess_accept_renegotiate);
2337 case SSL_CTRL_SESS_HIT:
2338 return tsan_load(&ctx->stats.sess_hit);
2339 case SSL_CTRL_SESS_CB_HIT:
2340 return tsan_load(&ctx->stats.sess_cb_hit);
2341 case SSL_CTRL_SESS_MISSES:
2342 return tsan_load(&ctx->stats.sess_miss);
2343 case SSL_CTRL_SESS_TIMEOUTS:
2344 return tsan_load(&ctx->stats.sess_timeout);
2345 case SSL_CTRL_SESS_CACHE_FULL:
2346 return tsan_load(&ctx->stats.sess_cache_full);
2348 return (ctx->mode |= larg);
2349 case SSL_CTRL_CLEAR_MODE:
2350 return (ctx->mode &= ~larg);
2351 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2352 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2354 ctx->max_send_fragment = larg;
2355 if (ctx->max_send_fragment < ctx->split_send_fragment)
2356 ctx->split_send_fragment = ctx->max_send_fragment;
2358 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2359 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2361 ctx->split_send_fragment = larg;
2363 case SSL_CTRL_SET_MAX_PIPELINES:
2364 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2366 ctx->max_pipelines = larg;
2368 case SSL_CTRL_CERT_FLAGS:
2369 return (ctx->cert->cert_flags |= larg);
2370 case SSL_CTRL_CLEAR_CERT_FLAGS:
2371 return (ctx->cert->cert_flags &= ~larg);
2372 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2373 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2374 && ssl_set_version_bound(ctx->method->version, (int)larg,
2375 &ctx->min_proto_version);
2376 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2377 return ctx->min_proto_version;
2378 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2379 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2380 && ssl_set_version_bound(ctx->method->version, (int)larg,
2381 &ctx->max_proto_version);
2382 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2383 return ctx->max_proto_version;
2385 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2389 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2392 case SSL_CTRL_SET_MSG_CALLBACK:
2393 ctx->msg_callback = (void (*)
2394 (int write_p, int version, int content_type,
2395 const void *buf, size_t len, SSL *ssl,
2400 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2404 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2413 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2414 const SSL_CIPHER *const *bp)
2416 if ((*ap)->id > (*bp)->id)
2418 if ((*ap)->id < (*bp)->id)
2423 /** return a STACK of the ciphers available for the SSL and in order of
2425 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2428 if (s->cipher_list != NULL) {
2429 return s->cipher_list;
2430 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2431 return s->ctx->cipher_list;
2437 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2439 if ((s == NULL) || (s->session == NULL) || !s->server)
2441 return s->session->ciphers;
2444 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2446 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2449 ciphers = SSL_get_ciphers(s);
2452 if (!ssl_set_client_disabled(s))
2454 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2455 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2456 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2458 sk = sk_SSL_CIPHER_new_null();
2461 if (!sk_SSL_CIPHER_push(sk, c)) {
2462 sk_SSL_CIPHER_free(sk);
2470 /** return a STACK of the ciphers available for the SSL and in order of
2472 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2475 if (s->cipher_list_by_id != NULL) {
2476 return s->cipher_list_by_id;
2477 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2478 return s->ctx->cipher_list_by_id;
2484 /** The old interface to get the same thing as SSL_get_ciphers() */
2485 const char *SSL_get_cipher_list(const SSL *s, int n)
2487 const SSL_CIPHER *c;
2488 STACK_OF(SSL_CIPHER) *sk;
2492 sk = SSL_get_ciphers(s);
2493 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2495 c = sk_SSL_CIPHER_value(sk, n);
2501 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2503 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2506 return ctx->cipher_list;
2510 /** specify the ciphers to be used by default by the SSL_CTX */
2511 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2513 STACK_OF(SSL_CIPHER) *sk;
2515 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2516 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2519 * ssl_create_cipher_list may return an empty stack if it was unable to
2520 * find a cipher matching the given rule string (for example if the rule
2521 * string specifies a cipher which has been disabled). This is not an
2522 * error as far as ssl_create_cipher_list is concerned, and hence
2523 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2527 else if (sk_SSL_CIPHER_num(sk) == 0) {
2528 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2534 /** specify the ciphers to be used by the SSL */
2535 int SSL_set_cipher_list(SSL *s, const char *str)
2537 STACK_OF(SSL_CIPHER) *sk;
2539 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2540 &s->cipher_list, &s->cipher_list_by_id, str,
2542 /* see comment in SSL_CTX_set_cipher_list */
2545 else if (sk_SSL_CIPHER_num(sk) == 0) {
2546 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2552 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2555 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2556 const SSL_CIPHER *c;
2560 || s->session == NULL
2561 || s->session->ciphers == NULL
2566 clntsk = s->session->ciphers;
2567 srvrsk = SSL_get_ciphers(s);
2568 if (clntsk == NULL || srvrsk == NULL)
2571 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2574 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2577 c = sk_SSL_CIPHER_value(clntsk, i);
2578 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2581 n = strlen(c->name);
2597 /** return a servername extension value if provided in Client Hello, or NULL.
2598 * So far, only host_name types are defined (RFC 3546).
2601 const char *SSL_get_servername(const SSL *s, const int type)
2603 if (type != TLSEXT_NAMETYPE_host_name)
2607 * SNI is not negotiated in pre-TLS-1.3 resumption flows, so fake up an
2608 * SNI value to return if we are resuming/resumed. N.B. that we still
2609 * call the relevant callbacks for such resumption flows, and callbacks
2610 * might error out if there is not a SNI value available.
2613 return s->session->ext.hostname;
2614 return s->ext.hostname;
2617 int SSL_get_servername_type(const SSL *s)
2620 && (!s->ext.hostname ? s->session->
2621 ext.hostname : s->ext.hostname))
2622 return TLSEXT_NAMETYPE_host_name;
2627 * SSL_select_next_proto implements the standard protocol selection. It is
2628 * expected that this function is called from the callback set by
2629 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2630 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2631 * not included in the length. A byte string of length 0 is invalid. No byte
2632 * string may be truncated. The current, but experimental algorithm for
2633 * selecting the protocol is: 1) If the server doesn't support NPN then this
2634 * is indicated to the callback. In this case, the client application has to
2635 * abort the connection or have a default application level protocol. 2) If
2636 * the server supports NPN, but advertises an empty list then the client
2637 * selects the first protocol in its list, but indicates via the API that this
2638 * fallback case was enacted. 3) Otherwise, the client finds the first
2639 * protocol in the server's list that it supports and selects this protocol.
2640 * This is because it's assumed that the server has better information about
2641 * which protocol a client should use. 4) If the client doesn't support any
2642 * of the server's advertised protocols, then this is treated the same as
2643 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2644 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2646 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2647 const unsigned char *server,
2648 unsigned int server_len,
2649 const unsigned char *client, unsigned int client_len)
2652 const unsigned char *result;
2653 int status = OPENSSL_NPN_UNSUPPORTED;
2656 * For each protocol in server preference order, see if we support it.
2658 for (i = 0; i < server_len;) {
2659 for (j = 0; j < client_len;) {
2660 if (server[i] == client[j] &&
2661 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2662 /* We found a match */
2663 result = &server[i];
2664 status = OPENSSL_NPN_NEGOTIATED;
2674 /* There's no overlap between our protocols and the server's list. */
2676 status = OPENSSL_NPN_NO_OVERLAP;
2679 *out = (unsigned char *)result + 1;
2680 *outlen = result[0];
2684 #ifndef OPENSSL_NO_NEXTPROTONEG
2686 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2687 * client's requested protocol for this connection and returns 0. If the
2688 * client didn't request any protocol, then *data is set to NULL. Note that
2689 * the client can request any protocol it chooses. The value returned from
2690 * this function need not be a member of the list of supported protocols
2691 * provided by the callback.
2693 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2700 *len = (unsigned int)s->ext.npn_len;
2705 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2706 * a TLS server needs a list of supported protocols for Next Protocol
2707 * Negotiation. The returned list must be in wire format. The list is
2708 * returned by setting |out| to point to it and |outlen| to its length. This
2709 * memory will not be modified, but one should assume that the SSL* keeps a
2710 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2711 * wishes to advertise. Otherwise, no such extension will be included in the
2714 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2715 SSL_CTX_npn_advertised_cb_func cb,
2718 ctx->ext.npn_advertised_cb = cb;
2719 ctx->ext.npn_advertised_cb_arg = arg;
2723 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2724 * client needs to select a protocol from the server's provided list. |out|
2725 * must be set to point to the selected protocol (which may be within |in|).
2726 * The length of the protocol name must be written into |outlen|. The
2727 * server's advertised protocols are provided in |in| and |inlen|. The
2728 * callback can assume that |in| is syntactically valid. The client must
2729 * select a protocol. It is fatal to the connection if this callback returns
2730 * a value other than SSL_TLSEXT_ERR_OK.
2732 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2733 SSL_CTX_npn_select_cb_func cb,
2736 ctx->ext.npn_select_cb = cb;
2737 ctx->ext.npn_select_cb_arg = arg;
2742 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2743 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2744 * length-prefixed strings). Returns 0 on success.
2746 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2747 unsigned int protos_len)
2749 OPENSSL_free(ctx->ext.alpn);
2750 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2751 if (ctx->ext.alpn == NULL) {
2752 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2755 ctx->ext.alpn_len = protos_len;
2761 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2762 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2763 * length-prefixed strings). Returns 0 on success.
2765 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2766 unsigned int protos_len)
2768 OPENSSL_free(ssl->ext.alpn);
2769 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2770 if (ssl->ext.alpn == NULL) {
2771 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2774 ssl->ext.alpn_len = protos_len;
2780 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2781 * called during ClientHello processing in order to select an ALPN protocol
2782 * from the client's list of offered protocols.
2784 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2785 SSL_CTX_alpn_select_cb_func cb,
2788 ctx->ext.alpn_select_cb = cb;
2789 ctx->ext.alpn_select_cb_arg = arg;
2793 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2794 * On return it sets |*data| to point to |*len| bytes of protocol name
2795 * (not including the leading length-prefix byte). If the server didn't
2796 * respond with a negotiated protocol then |*len| will be zero.
2798 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2803 *data = ssl->s3->alpn_selected;
2807 *len = (unsigned int)ssl->s3->alpn_selected_len;
2810 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2811 const char *label, size_t llen,
2812 const unsigned char *context, size_t contextlen,
2815 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2818 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2820 contextlen, use_context);
2823 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2824 const char *label, size_t llen,
2825 const unsigned char *context,
2828 if (s->version != TLS1_3_VERSION)
2831 return tls13_export_keying_material_early(s, out, olen, label, llen,
2832 context, contextlen);
2835 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2837 const unsigned char *session_id = a->session_id;
2839 unsigned char tmp_storage[4];
2841 if (a->session_id_length < sizeof(tmp_storage)) {
2842 memset(tmp_storage, 0, sizeof(tmp_storage));
2843 memcpy(tmp_storage, a->session_id, a->session_id_length);
2844 session_id = tmp_storage;
2848 ((unsigned long)session_id[0]) |
2849 ((unsigned long)session_id[1] << 8L) |
2850 ((unsigned long)session_id[2] << 16L) |
2851 ((unsigned long)session_id[3] << 24L);
2856 * NB: If this function (or indeed the hash function which uses a sort of
2857 * coarser function than this one) is changed, ensure
2858 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2859 * being able to construct an SSL_SESSION that will collide with any existing
2860 * session with a matching session ID.
2862 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2864 if (a->ssl_version != b->ssl_version)
2866 if (a->session_id_length != b->session_id_length)
2868 return memcmp(a->session_id, b->session_id, a->session_id_length);
2872 * These wrapper functions should remain rather than redeclaring
2873 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2874 * variable. The reason is that the functions aren't static, they're exposed
2878 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2880 SSL_CTX *ret = NULL;
2883 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2887 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2890 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2891 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2894 ret = OPENSSL_zalloc(sizeof(*ret));
2899 ret->min_proto_version = 0;
2900 ret->max_proto_version = 0;
2901 ret->mode = SSL_MODE_AUTO_RETRY;
2902 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2903 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2904 /* We take the system default. */
2905 ret->session_timeout = meth->get_timeout();
2906 ret->references = 1;
2907 ret->lock = CRYPTO_THREAD_lock_new();
2908 if (ret->lock == NULL) {
2909 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2913 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2914 ret->verify_mode = SSL_VERIFY_NONE;
2915 if ((ret->cert = ssl_cert_new()) == NULL)
2918 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2919 if (ret->sessions == NULL)
2921 ret->cert_store = X509_STORE_new();
2922 if (ret->cert_store == NULL)
2924 #ifndef OPENSSL_NO_CT
2925 ret->ctlog_store = CTLOG_STORE_new();
2926 if (ret->ctlog_store == NULL)
2930 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
2933 if (!ssl_create_cipher_list(ret->method,
2934 ret->tls13_ciphersuites,
2935 &ret->cipher_list, &ret->cipher_list_by_id,
2936 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2937 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2938 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2942 ret->param = X509_VERIFY_PARAM_new();
2943 if (ret->param == NULL)
2946 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2947 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2950 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2951 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2955 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2958 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2961 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
2964 /* No compression for DTLS */
2965 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2966 ret->comp_methods = SSL_COMP_get_compression_methods();
2968 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2969 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2971 /* Setup RFC5077 ticket keys */
2972 if ((RAND_bytes(ret->ext.tick_key_name,
2973 sizeof(ret->ext.tick_key_name)) <= 0)
2974 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
2975 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
2976 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
2977 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
2978 ret->options |= SSL_OP_NO_TICKET;
2980 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
2981 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2984 #ifndef OPENSSL_NO_SRP
2985 if (!SSL_CTX_SRP_CTX_init(ret))
2988 #ifndef OPENSSL_NO_ENGINE
2989 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2990 # define eng_strx(x) #x
2991 # define eng_str(x) eng_strx(x)
2992 /* Use specific client engine automatically... ignore errors */
2995 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2998 ENGINE_load_builtin_engines();
2999 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
3001 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3007 * Default is to connect to non-RI servers. When RI is more widely
3008 * deployed might change this.
3010 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3012 * Disable compression by default to prevent CRIME. Applications can
3013 * re-enable compression by configuring
3014 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3015 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3016 * middlebox compatibility by default. This may be disabled by default in
3017 * a later OpenSSL version.
3019 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3021 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3024 * We cannot usefully set a default max_early_data here (which gets
3025 * propagated in SSL_new(), for the following reason: setting the
3026 * SSL field causes tls_construct_stoc_early_data() to tell the
3027 * client that early data will be accepted when constructing a TLS 1.3
3028 * session ticket, and the client will accordingly send us early data
3029 * when using that ticket (if the client has early data to send).
3030 * However, in order for the early data to actually be consumed by
3031 * the application, the application must also have calls to
3032 * SSL_read_early_data(); otherwise we'll just skip past the early data
3033 * and ignore it. So, since the application must add calls to
3034 * SSL_read_early_data(), we also require them to add
3035 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3036 * eliminating the bandwidth-wasting early data in the case described
3039 ret->max_early_data = 0;
3042 * Default recv_max_early_data is a fully loaded single record. Could be
3043 * split across multiple records in practice. We set this differently to
3044 * max_early_data so that, in the default case, we do not advertise any
3045 * support for early_data, but if a client were to send us some (e.g.
3046 * because of an old, stale ticket) then we will tolerate it and skip over
3049 ret->recv_max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
3051 /* By default we send two session tickets automatically in TLSv1.3 */
3052 ret->num_tickets = 2;
3054 ssl_ctx_system_config(ret);
3058 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3064 int SSL_CTX_up_ref(SSL_CTX *ctx)
3068 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3071 REF_PRINT_COUNT("SSL_CTX", ctx);
3072 REF_ASSERT_ISNT(i < 2);
3073 return ((i > 1) ? 1 : 0);
3076 void SSL_CTX_free(SSL_CTX *a)
3083 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3084 REF_PRINT_COUNT("SSL_CTX", a);
3087 REF_ASSERT_ISNT(i < 0);
3089 X509_VERIFY_PARAM_free(a->param);
3090 dane_ctx_final(&a->dane);
3093 * Free internal session cache. However: the remove_cb() may reference
3094 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3095 * after the sessions were flushed.
3096 * As the ex_data handling routines might also touch the session cache,
3097 * the most secure solution seems to be: empty (flush) the cache, then
3098 * free ex_data, then finally free the cache.
3099 * (See ticket [openssl.org #212].)
3101 if (a->sessions != NULL)
3102 SSL_CTX_flush_sessions(a, 0);
3104 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3105 lh_SSL_SESSION_free(a->sessions);
3106 X509_STORE_free(a->cert_store);
3107 #ifndef OPENSSL_NO_CT
3108 CTLOG_STORE_free(a->ctlog_store);
3110 sk_SSL_CIPHER_free(a->cipher_list);
3111 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3112 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3113 ssl_cert_free(a->cert);
3114 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3115 sk_X509_pop_free(a->extra_certs, X509_free);
3116 a->comp_methods = NULL;
3117 #ifndef OPENSSL_NO_SRTP
3118 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3120 #ifndef OPENSSL_NO_SRP
3121 SSL_CTX_SRP_CTX_free(a);
3123 #ifndef OPENSSL_NO_ENGINE
3124 ENGINE_finish(a->client_cert_engine);
3127 #ifndef OPENSSL_NO_EC
3128 OPENSSL_free(a->ext.ecpointformats);
3129 OPENSSL_free(a->ext.supportedgroups);
3131 OPENSSL_free(a->ext.alpn);
3132 OPENSSL_secure_free(a->ext.secure);
3134 CRYPTO_THREAD_lock_free(a->lock);
3139 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3141 ctx->default_passwd_callback = cb;
3144 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3146 ctx->default_passwd_callback_userdata = u;
3149 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3151 return ctx->default_passwd_callback;
3154 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3156 return ctx->default_passwd_callback_userdata;
3159 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3161 s->default_passwd_callback = cb;
3164 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3166 s->default_passwd_callback_userdata = u;
3169 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3171 return s->default_passwd_callback;
3174 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3176 return s->default_passwd_callback_userdata;
3179 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3180 int (*cb) (X509_STORE_CTX *, void *),
3183 ctx->app_verify_callback = cb;
3184 ctx->app_verify_arg = arg;
3187 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3188 int (*cb) (int, X509_STORE_CTX *))
3190 ctx->verify_mode = mode;
3191 ctx->default_verify_callback = cb;
3194 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3196 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3199 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3201 ssl_cert_set_cert_cb(c->cert, cb, arg);
3204 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3206 ssl_cert_set_cert_cb(s->cert, cb, arg);
3209 void ssl_set_masks(SSL *s)
3212 uint32_t *pvalid = s->s3->tmp.valid_flags;
3213 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3214 unsigned long mask_k, mask_a;
3215 #ifndef OPENSSL_NO_EC
3216 int have_ecc_cert, ecdsa_ok;
3221 #ifndef OPENSSL_NO_DH
3222 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3227 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3228 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3229 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3230 #ifndef OPENSSL_NO_EC
3231 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3237 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3238 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3241 #ifndef OPENSSL_NO_GOST
3242 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3243 mask_k |= SSL_kGOST;
3244 mask_a |= SSL_aGOST12;
3246 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3247 mask_k |= SSL_kGOST;
3248 mask_a |= SSL_aGOST12;
3250 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3251 mask_k |= SSL_kGOST;
3252 mask_a |= SSL_aGOST01;
3263 * If we only have an RSA-PSS certificate allow RSA authentication
3264 * if TLS 1.2 and peer supports it.
3267 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3268 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3269 && TLS1_get_version(s) == TLS1_2_VERSION))
3276 mask_a |= SSL_aNULL;
3279 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3280 * depending on the key usage extension.
3282 #ifndef OPENSSL_NO_EC
3283 if (have_ecc_cert) {
3285 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3286 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3287 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3290 mask_a |= SSL_aECDSA;
3292 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3293 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3294 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3295 && TLS1_get_version(s) == TLS1_2_VERSION)
3296 mask_a |= SSL_aECDSA;
3298 /* Allow Ed448 for TLS 1.2 if peer supports it */
3299 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3300 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3301 && TLS1_get_version(s) == TLS1_2_VERSION)
3302 mask_a |= SSL_aECDSA;
3305 #ifndef OPENSSL_NO_EC
3306 mask_k |= SSL_kECDHE;
3309 #ifndef OPENSSL_NO_PSK
3312 if (mask_k & SSL_kRSA)
3313 mask_k |= SSL_kRSAPSK;
3314 if (mask_k & SSL_kDHE)
3315 mask_k |= SSL_kDHEPSK;
3316 if (mask_k & SSL_kECDHE)
3317 mask_k |= SSL_kECDHEPSK;
3320 s->s3->tmp.mask_k = mask_k;
3321 s->s3->tmp.mask_a = mask_a;
3324 #ifndef OPENSSL_NO_EC
3326 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3328 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3329 /* key usage, if present, must allow signing */
3330 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3331 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3332 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3336 return 1; /* all checks are ok */
3341 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3342 size_t *serverinfo_length)
3344 CERT_PKEY *cpk = s->s3->tmp.cert;
3345 *serverinfo_length = 0;
3347 if (cpk == NULL || cpk->serverinfo == NULL)
3350 *serverinfo = cpk->serverinfo;
3351 *serverinfo_length = cpk->serverinfo_length;
3355 void ssl_update_cache(SSL *s, int mode)
3360 * If the session_id_length is 0, we are not supposed to cache it, and it
3361 * would be rather hard to do anyway :-)
3363 if (s->session->session_id_length == 0)
3367 * If sid_ctx_length is 0 there is no specific application context
3368 * associated with this session, so when we try to resume it and
3369 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3370 * indication that this is actually a session for the proper application
3371 * context, and the *handshake* will fail, not just the resumption attempt.
3372 * Do not cache (on the server) these sessions that are not resumable
3373 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3375 if (s->server && s->session->sid_ctx_length == 0
3376 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3379 i = s->session_ctx->session_cache_mode;
3381 && (!s->hit || SSL_IS_TLS13(s))) {
3383 * Add the session to the internal cache. In server side TLSv1.3 we
3384 * normally don't do this because by default it's a full stateless ticket
3385 * with only a dummy session id so there is no reason to cache it,
3387 * - we are doing early_data, in which case we cache so that we can
3389 * - the application has set a remove_session_cb so needs to know about
3390 * session timeout events
3391 * - SSL_OP_NO_TICKET is set in which case it is a stateful ticket
3393 if ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0
3394 && (!SSL_IS_TLS13(s)
3396 || (s->max_early_data > 0
3397 && (s->options & SSL_OP_NO_ANTI_REPLAY) == 0)
3398 || s->session_ctx->remove_session_cb != NULL
3399 || (s->options & SSL_OP_NO_TICKET) != 0))
3400 SSL_CTX_add_session(s->session_ctx, s->session);
3403 * Add the session to the external cache. We do this even in server side
3404 * TLSv1.3 without early data because some applications just want to
3405 * know about the creation of a session and aren't doing a full cache.
3407 if (s->session_ctx->new_session_cb != NULL) {
3408 SSL_SESSION_up_ref(s->session);
3409 if (!s->session_ctx->new_session_cb(s, s->session))
3410 SSL_SESSION_free(s->session);
3414 /* auto flush every 255 connections */
3415 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3416 TSAN_QUALIFIER int *stat;
3417 if (mode & SSL_SESS_CACHE_CLIENT)
3418 stat = &s->session_ctx->stats.sess_connect_good;
3420 stat = &s->session_ctx->stats.sess_accept_good;
3421 if ((tsan_load(stat) & 0xff) == 0xff)
3422 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3426 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3431 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3436 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3440 if (s->method != meth) {
3441 const SSL_METHOD *sm = s->method;
3442 int (*hf) (SSL *) = s->handshake_func;
3444 if (sm->version == meth->version)
3449 ret = s->method->ssl_new(s);
3452 if (hf == sm->ssl_connect)
3453 s->handshake_func = meth->ssl_connect;
3454 else if (hf == sm->ssl_accept)
3455 s->handshake_func = meth->ssl_accept;
3460 int SSL_get_error(const SSL *s, int i)
3467 return SSL_ERROR_NONE;
3470 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3471 * where we do encode the error
3473 if ((l = ERR_peek_error()) != 0) {
3474 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3475 return SSL_ERROR_SYSCALL;
3477 return SSL_ERROR_SSL;
3480 if (SSL_want_read(s)) {
3481 bio = SSL_get_rbio(s);
3482 if (BIO_should_read(bio))
3483 return SSL_ERROR_WANT_READ;
3484 else if (BIO_should_write(bio))
3486 * This one doesn't make too much sense ... We never try to write
3487 * to the rbio, and an application program where rbio and wbio
3488 * are separate couldn't even know what it should wait for.
3489 * However if we ever set s->rwstate incorrectly (so that we have
3490 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3491 * wbio *are* the same, this test works around that bug; so it
3492 * might be safer to keep it.
3494 return SSL_ERROR_WANT_WRITE;
3495 else if (BIO_should_io_special(bio)) {
3496 reason = BIO_get_retry_reason(bio);
3497 if (reason == BIO_RR_CONNECT)
3498 return SSL_ERROR_WANT_CONNECT;
3499 else if (reason == BIO_RR_ACCEPT)
3500 return SSL_ERROR_WANT_ACCEPT;
3502 return SSL_ERROR_SYSCALL; /* unknown */
3506 if (SSL_want_write(s)) {
3507 /* Access wbio directly - in order to use the buffered bio if present */
3509 if (BIO_should_write(bio))
3510 return SSL_ERROR_WANT_WRITE;
3511 else if (BIO_should_read(bio))
3513 * See above (SSL_want_read(s) with BIO_should_write(bio))
3515 return SSL_ERROR_WANT_READ;
3516 else if (BIO_should_io_special(bio)) {
3517 reason = BIO_get_retry_reason(bio);
3518 if (reason == BIO_RR_CONNECT)
3519 return SSL_ERROR_WANT_CONNECT;
3520 else if (reason == BIO_RR_ACCEPT)
3521 return SSL_ERROR_WANT_ACCEPT;
3523 return SSL_ERROR_SYSCALL;
3526 if (SSL_want_x509_lookup(s))
3527 return SSL_ERROR_WANT_X509_LOOKUP;
3528 if (SSL_want_async(s))
3529 return SSL_ERROR_WANT_ASYNC;
3530 if (SSL_want_async_job(s))
3531 return SSL_ERROR_WANT_ASYNC_JOB;
3532 if (SSL_want_client_hello_cb(s))
3533 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3535 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3536 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3537 return SSL_ERROR_ZERO_RETURN;
3539 return SSL_ERROR_SYSCALL;
3542 static int ssl_do_handshake_intern(void *vargs)
3544 struct ssl_async_args *args;
3547 args = (struct ssl_async_args *)vargs;
3550 return s->handshake_func(s);
3553 int SSL_do_handshake(SSL *s)
3557 if (s->handshake_func == NULL) {
3558 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3562 ossl_statem_check_finish_init(s, -1);
3564 s->method->ssl_renegotiate_check(s, 0);
3566 if (SSL_in_init(s) || SSL_in_before(s)) {
3567 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3568 struct ssl_async_args args;
3572 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3574 ret = s->handshake_func(s);
3580 void SSL_set_accept_state(SSL *s)
3584 ossl_statem_clear(s);
3585 s->handshake_func = s->method->ssl_accept;
3589 void SSL_set_connect_state(SSL *s)
3593 ossl_statem_clear(s);
3594 s->handshake_func = s->method->ssl_connect;
3598 int ssl_undefined_function(SSL *s)
3600 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3604 int ssl_undefined_void_function(void)
3606 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3607 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3611 int ssl_undefined_const_function(const SSL *s)
3616 const SSL_METHOD *ssl_bad_method(int ver)
3618 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3622 const char *ssl_protocol_to_string(int version)
3626 case TLS1_3_VERSION:
3629 case TLS1_2_VERSION:
3632 case TLS1_1_VERSION:
3647 case DTLS1_2_VERSION:
3655 const char *SSL_get_version(const SSL *s)
3657 return ssl_protocol_to_string(s->version);
3660 SSL *SSL_dup(SSL *s)
3662 STACK_OF(X509_NAME) *sk;
3667 /* If we're not quiescent, just up_ref! */
3668 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3669 CRYPTO_UP_REF(&s->references, &i, s->lock);
3674 * Otherwise, copy configuration state, and session if set.
3676 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3679 if (s->session != NULL) {
3681 * Arranges to share the same session via up_ref. This "copies"
3682 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3684 if (!SSL_copy_session_id(ret, s))
3688 * No session has been established yet, so we have to expect that
3689 * s->cert or ret->cert will be changed later -- they should not both
3690 * point to the same object, and thus we can't use
3691 * SSL_copy_session_id.
3693 if (!SSL_set_ssl_method(ret, s->method))
3696 if (s->cert != NULL) {
3697 ssl_cert_free(ret->cert);
3698 ret->cert = ssl_cert_dup(s->cert);
3699 if (ret->cert == NULL)
3703 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3704 (int)s->sid_ctx_length))
3708 if (!ssl_dane_dup(ret, s))
3710 ret->version = s->version;
3711 ret->options = s->options;
3712 ret->mode = s->mode;
3713 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3714 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3715 ret->msg_callback = s->msg_callback;
3716 ret->msg_callback_arg = s->msg_callback_arg;
3717 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3718 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3719 ret->generate_session_id = s->generate_session_id;
3721 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3723 /* copy app data, a little dangerous perhaps */
3724 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3727 /* setup rbio, and wbio */
3728 if (s->rbio != NULL) {
3729 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3732 if (s->wbio != NULL) {
3733 if (s->wbio != s->rbio) {
3734 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3737 BIO_up_ref(ret->rbio);
3738 ret->wbio = ret->rbio;
3742 ret->server = s->server;
3743 if (s->handshake_func) {
3745 SSL_set_accept_state(ret);
3747 SSL_set_connect_state(ret);
3749 ret->shutdown = s->shutdown;
3752 ret->default_passwd_callback = s->default_passwd_callback;
3753 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3755 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3757 /* dup the cipher_list and cipher_list_by_id stacks */
3758 if (s->cipher_list != NULL) {
3759 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3762 if (s->cipher_list_by_id != NULL)
3763 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3767 /* Dup the client_CA list */
3768 if (s->ca_names != NULL) {
3769 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3772 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3773 xn = sk_X509_NAME_value(sk, i);
3774 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3787 void ssl_clear_cipher_ctx(SSL *s)
3789 if (s->enc_read_ctx != NULL) {
3790 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3791 s->enc_read_ctx = NULL;
3793 if (s->enc_write_ctx != NULL) {
3794 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3795 s->enc_write_ctx = NULL;
3797 #ifndef OPENSSL_NO_COMP
3798 COMP_CTX_free(s->expand);
3800 COMP_CTX_free(s->compress);
3805 X509 *SSL_get_certificate(const SSL *s)
3807 if (s->cert != NULL)
3808 return s->cert->key->x509;
3813 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3815 if (s->cert != NULL)
3816 return s->cert->key->privatekey;
3821 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3823 if (ctx->cert != NULL)
3824 return ctx->cert->key->x509;
3829 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3831 if (ctx->cert != NULL)
3832 return ctx->cert->key->privatekey;
3837 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3839 if ((s->session != NULL) && (s->session->cipher != NULL))
3840 return s->session->cipher;
3844 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3846 return s->s3->tmp.new_cipher;
3849 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3851 #ifndef OPENSSL_NO_COMP
3852 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3858 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3860 #ifndef OPENSSL_NO_COMP
3861 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3867 int ssl_init_wbio_buffer(SSL *s)
3871 if (s->bbio != NULL) {
3872 /* Already buffered. */
3876 bbio = BIO_new(BIO_f_buffer());
3877 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3879 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3883 s->wbio = BIO_push(bbio, s->wbio);
3888 int ssl_free_wbio_buffer(SSL *s)
3890 /* callers ensure s is never null */
3891 if (s->bbio == NULL)
3894 s->wbio = BIO_pop(s->wbio);
3901 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3903 ctx->quiet_shutdown = mode;
3906 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3908 return ctx->quiet_shutdown;
3911 void SSL_set_quiet_shutdown(SSL *s, int mode)
3913 s->quiet_shutdown = mode;
3916 int SSL_get_quiet_shutdown(const SSL *s)
3918 return s->quiet_shutdown;
3921 void SSL_set_shutdown(SSL *s, int mode)
3926 int SSL_get_shutdown(const SSL *s)
3931 int SSL_version(const SSL *s)
3936 int SSL_client_version(const SSL *s)
3938 return s->client_version;
3941 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3946 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3949 if (ssl->ctx == ctx)
3952 ctx = ssl->session_ctx;
3953 new_cert = ssl_cert_dup(ctx->cert);
3954 if (new_cert == NULL) {
3958 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3959 ssl_cert_free(new_cert);
3963 ssl_cert_free(ssl->cert);
3964 ssl->cert = new_cert;
3967 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3968 * so setter APIs must prevent invalid lengths from entering the system.
3970 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3974 * If the session ID context matches that of the parent SSL_CTX,
3975 * inherit it from the new SSL_CTX as well. If however the context does
3976 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3977 * leave it unchanged.
3979 if ((ssl->ctx != NULL) &&
3980 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3981 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3982 ssl->sid_ctx_length = ctx->sid_ctx_length;
3983 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3986 SSL_CTX_up_ref(ctx);
3987 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3993 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3995 return X509_STORE_set_default_paths(ctx->cert_store);
3998 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
4000 X509_LOOKUP *lookup;
4002 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
4005 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
4007 /* Clear any errors if the default directory does not exist */
4013 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
4015 X509_LOOKUP *lookup;
4017 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
4021 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
4023 /* Clear any errors if the default file does not exist */
4029 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
4032 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
4035 void SSL_set_info_callback(SSL *ssl,
4036 void (*cb) (const SSL *ssl, int type, int val))
4038 ssl->info_callback = cb;
4042 * One compiler (Diab DCC) doesn't like argument names in returned function
4045 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
4048 return ssl->info_callback;
4051 void SSL_set_verify_result(SSL *ssl, long arg)
4053 ssl->verify_result = arg;
4056 long SSL_get_verify_result(const SSL *ssl)
4058 return ssl->verify_result;
4061 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
4064 return sizeof(ssl->s3->client_random);
4065 if (outlen > sizeof(ssl->s3->client_random))
4066 outlen = sizeof(ssl->s3->client_random);
4067 memcpy(out, ssl->s3->client_random, outlen);
4071 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
4074 return sizeof(ssl->s3->server_random);
4075 if (outlen > sizeof(ssl->s3->server_random))
4076 outlen = sizeof(ssl->s3->server_random);
4077 memcpy(out, ssl->s3->server_random, outlen);
4081 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
4082 unsigned char *out, size_t outlen)
4085 return session->master_key_length;
4086 if (outlen > session->master_key_length)
4087 outlen = session->master_key_length;
4088 memcpy(out, session->master_key, outlen);
4092 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4095 if (len > sizeof(sess->master_key))
4098 memcpy(sess->master_key, in, len);
4099 sess->master_key_length = len;
4104 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4106 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4109 void *SSL_get_ex_data(const SSL *s, int idx)
4111 return CRYPTO_get_ex_data(&s->ex_data, idx);
4114 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4116 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4119 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4121 return CRYPTO_get_ex_data(&s->ex_data, idx);
4124 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4126 return ctx->cert_store;
4129 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4131 X509_STORE_free(ctx->cert_store);
4132 ctx->cert_store = store;
4135 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4138 X509_STORE_up_ref(store);
4139 SSL_CTX_set_cert_store(ctx, store);
4142 int SSL_want(const SSL *s)
4148 * \brief Set the callback for generating temporary DH keys.
4149 * \param ctx the SSL context.
4150 * \param dh the callback
4153 #ifndef OPENSSL_NO_DH
4154 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4155 DH *(*dh) (SSL *ssl, int is_export,
4158 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4161 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4164 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4168 #ifndef OPENSSL_NO_PSK
4169 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4171 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4172 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4175 OPENSSL_free(ctx->cert->psk_identity_hint);
4176 if (identity_hint != NULL) {
4177 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4178 if (ctx->cert->psk_identity_hint == NULL)
4181 ctx->cert->psk_identity_hint = NULL;
4185 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4190 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4191 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4194 OPENSSL_free(s->cert->psk_identity_hint);
4195 if (identity_hint != NULL) {
4196 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4197 if (s->cert->psk_identity_hint == NULL)
4200 s->cert->psk_identity_hint = NULL;
4204 const char *SSL_get_psk_identity_hint(const SSL *s)
4206 if (s == NULL || s->session == NULL)
4208 return s->session->psk_identity_hint;
4211 const char *SSL_get_psk_identity(const SSL *s)
4213 if (s == NULL || s->session == NULL)
4215 return s->session->psk_identity;
4218 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4220 s->psk_client_callback = cb;
4223 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4225 ctx->psk_client_callback = cb;
4228 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4230 s->psk_server_callback = cb;
4233 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4235 ctx->psk_server_callback = cb;
4239 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4241 s->psk_find_session_cb = cb;
4244 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4245 SSL_psk_find_session_cb_func cb)
4247 ctx->psk_find_session_cb = cb;
4250 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4252 s->psk_use_session_cb = cb;
4255 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4256 SSL_psk_use_session_cb_func cb)
4258 ctx->psk_use_session_cb = cb;
4261 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4262 void (*cb) (int write_p, int version,
4263 int content_type, const void *buf,
4264 size_t len, SSL *ssl, void *arg))
4266 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4269 void SSL_set_msg_callback(SSL *ssl,
4270 void (*cb) (int write_p, int version,
4271 int content_type, const void *buf,
4272 size_t len, SSL *ssl, void *arg))
4274 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4277 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4278 int (*cb) (SSL *ssl,
4282 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4283 (void (*)(void))cb);
4286 void SSL_set_not_resumable_session_callback(SSL *ssl,
4287 int (*cb) (SSL *ssl,
4288 int is_forward_secure))
4290 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4291 (void (*)(void))cb);
4294 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4295 size_t (*cb) (SSL *ssl, int type,
4296 size_t len, void *arg))
4298 ctx->record_padding_cb = cb;
4301 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4303 ctx->record_padding_arg = arg;
4306 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4308 return ctx->record_padding_arg;
4311 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4313 /* block size of 0 or 1 is basically no padding */
4314 if (block_size == 1)
4315 ctx->block_padding = 0;
4316 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4317 ctx->block_padding = block_size;
4323 void SSL_set_record_padding_callback(SSL *ssl,
4324 size_t (*cb) (SSL *ssl, int type,
4325 size_t len, void *arg))
4327 ssl->record_padding_cb = cb;
4330 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4332 ssl->record_padding_arg = arg;
4335 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4337 return ssl->record_padding_arg;
4340 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4342 /* block size of 0 or 1 is basically no padding */
4343 if (block_size == 1)
4344 ssl->block_padding = 0;
4345 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4346 ssl->block_padding = block_size;
4352 int SSL_set_num_tickets(SSL *s, size_t num_tickets)
4354 s->num_tickets = num_tickets;
4359 size_t SSL_get_num_tickets(SSL *s)
4361 return s->num_tickets;
4364 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets)
4366 ctx->num_tickets = num_tickets;
4371 size_t SSL_CTX_get_num_tickets(SSL_CTX *ctx)
4373 return ctx->num_tickets;
4377 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4378 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4379 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4380 * Returns the newly allocated ctx;
4383 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4385 ssl_clear_hash_ctx(hash);
4386 *hash = EVP_MD_CTX_new();
4387 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4388 EVP_MD_CTX_free(*hash);
4395 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4398 EVP_MD_CTX_free(*hash);
4402 /* Retrieve handshake hashes */
4403 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4406 EVP_MD_CTX *ctx = NULL;
4407 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4408 int hashleni = EVP_MD_CTX_size(hdgst);
4411 if (hashleni < 0 || (size_t)hashleni > outlen) {
4412 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4413 ERR_R_INTERNAL_ERROR);
4417 ctx = EVP_MD_CTX_new();
4421 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4422 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4423 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4424 ERR_R_INTERNAL_ERROR);
4428 *hashlen = hashleni;
4432 EVP_MD_CTX_free(ctx);
4436 int SSL_session_reused(SSL *s)
4441 int SSL_is_server(const SSL *s)
4446 #if OPENSSL_API_COMPAT < 0x10100000L
4447 void SSL_set_debug(SSL *s, int debug)
4449 /* Old function was do-nothing anyway... */
4455 void SSL_set_security_level(SSL *s, int level)
4457 s->cert->sec_level = level;
4460 int SSL_get_security_level(const SSL *s)
4462 return s->cert->sec_level;
4465 void SSL_set_security_callback(SSL *s,
4466 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4467 int op, int bits, int nid,
4468 void *other, void *ex))
4470 s->cert->sec_cb = cb;
4473 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4474 const SSL_CTX *ctx, int op,
4475 int bits, int nid, void *other,
4477 return s->cert->sec_cb;
4480 void SSL_set0_security_ex_data(SSL *s, void *ex)
4482 s->cert->sec_ex = ex;
4485 void *SSL_get0_security_ex_data(const SSL *s)
4487 return s->cert->sec_ex;
4490 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4492 ctx->cert->sec_level = level;
4495 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4497 return ctx->cert->sec_level;
4500 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4501 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4502 int op, int bits, int nid,
4503 void *other, void *ex))
4505 ctx->cert->sec_cb = cb;
4508 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4514 return ctx->cert->sec_cb;
4517 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4519 ctx->cert->sec_ex = ex;
4522 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4524 return ctx->cert->sec_ex;
4528 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4529 * can return unsigned long, instead of the generic long return value from the
4530 * control interface.
4532 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4534 return ctx->options;
4537 unsigned long SSL_get_options(const SSL *s)
4542 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4544 return ctx->options |= op;
4547 unsigned long SSL_set_options(SSL *s, unsigned long op)
4549 return s->options |= op;
4552 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4554 return ctx->options &= ~op;
4557 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4559 return s->options &= ~op;
4562 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4564 return s->verified_chain;
4567 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4569 #ifndef OPENSSL_NO_CT
4572 * Moves SCTs from the |src| stack to the |dst| stack.
4573 * The source of each SCT will be set to |origin|.
4574 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4576 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4578 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4579 sct_source_t origin)
4585 *dst = sk_SCT_new_null();
4587 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4592 while ((sct = sk_SCT_pop(src)) != NULL) {
4593 if (SCT_set_source(sct, origin) != 1)
4596 if (sk_SCT_push(*dst, sct) <= 0)
4604 sk_SCT_push(src, sct); /* Put the SCT back */
4609 * Look for data collected during ServerHello and parse if found.
4610 * Returns the number of SCTs extracted.
4612 static int ct_extract_tls_extension_scts(SSL *s)
4614 int scts_extracted = 0;
4616 if (s->ext.scts != NULL) {
4617 const unsigned char *p = s->ext.scts;
4618 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4620 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4622 SCT_LIST_free(scts);
4625 return scts_extracted;
4629 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4630 * contains an SCT X509 extension. They will be stored in |s->scts|.
4632 * - The number of SCTs extracted, assuming an OCSP response exists.
4633 * - 0 if no OCSP response exists or it contains no SCTs.
4634 * - A negative integer if an error occurs.
4636 static int ct_extract_ocsp_response_scts(SSL *s)
4638 # ifndef OPENSSL_NO_OCSP
4639 int scts_extracted = 0;
4640 const unsigned char *p;
4641 OCSP_BASICRESP *br = NULL;
4642 OCSP_RESPONSE *rsp = NULL;
4643 STACK_OF(SCT) *scts = NULL;
4646 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4649 p = s->ext.ocsp.resp;
4650 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4654 br = OCSP_response_get1_basic(rsp);
4658 for (i = 0; i < OCSP_resp_count(br); ++i) {
4659 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4665 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4667 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4668 if (scts_extracted < 0)
4672 SCT_LIST_free(scts);
4673 OCSP_BASICRESP_free(br);
4674 OCSP_RESPONSE_free(rsp);
4675 return scts_extracted;
4677 /* Behave as if no OCSP response exists */
4683 * Attempts to extract SCTs from the peer certificate.
4684 * Return the number of SCTs extracted, or a negative integer if an error
4687 static int ct_extract_x509v3_extension_scts(SSL *s)
4689 int scts_extracted = 0;
4690 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4693 STACK_OF(SCT) *scts =
4694 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4697 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4699 SCT_LIST_free(scts);
4702 return scts_extracted;
4706 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4707 * response (if it exists) and X509v3 extensions in the certificate.
4708 * Returns NULL if an error occurs.
4710 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4712 if (!s->scts_parsed) {
4713 if (ct_extract_tls_extension_scts(s) < 0 ||
4714 ct_extract_ocsp_response_scts(s) < 0 ||
4715 ct_extract_x509v3_extension_scts(s) < 0)
4725 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4726 const STACK_OF(SCT) *scts, void *unused_arg)
4731 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4732 const STACK_OF(SCT) *scts, void *unused_arg)
4734 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4737 for (i = 0; i < count; ++i) {
4738 SCT *sct = sk_SCT_value(scts, i);
4739 int status = SCT_get_validation_status(sct);
4741 if (status == SCT_VALIDATION_STATUS_VALID)
4744 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4748 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4752 * Since code exists that uses the custom extension handler for CT, look
4753 * for this and throw an error if they have already registered to use CT.
4755 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4756 TLSEXT_TYPE_signed_certificate_timestamp))
4758 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4759 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4763 if (callback != NULL) {
4765 * If we are validating CT, then we MUST accept SCTs served via OCSP
4767 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4771 s->ct_validation_callback = callback;
4772 s->ct_validation_callback_arg = arg;
4777 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4778 ssl_ct_validation_cb callback, void *arg)
4781 * Since code exists that uses the custom extension handler for CT, look for
4782 * this and throw an error if they have already registered to use CT.
4784 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4785 TLSEXT_TYPE_signed_certificate_timestamp))
4787 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4788 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4792 ctx->ct_validation_callback = callback;
4793 ctx->ct_validation_callback_arg = arg;
4797 int SSL_ct_is_enabled(const SSL *s)
4799 return s->ct_validation_callback != NULL;
4802 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4804 return ctx->ct_validation_callback != NULL;
4807 int ssl_validate_ct(SSL *s)
4810 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4812 SSL_DANE *dane = &s->dane;
4813 CT_POLICY_EVAL_CTX *ctx = NULL;
4814 const STACK_OF(SCT) *scts;
4817 * If no callback is set, the peer is anonymous, or its chain is invalid,
4818 * skip SCT validation - just return success. Applications that continue
4819 * handshakes without certificates, with unverified chains, or pinned leaf
4820 * certificates are outside the scope of the WebPKI and CT.
4822 * The above exclusions notwithstanding the vast majority of peers will
4823 * have rather ordinary certificate chains validated by typical
4824 * applications that perform certificate verification and therefore will
4825 * process SCTs when enabled.
4827 if (s->ct_validation_callback == NULL || cert == NULL ||
4828 s->verify_result != X509_V_OK ||
4829 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4833 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4834 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4836 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4837 switch (dane->mtlsa->usage) {
4838 case DANETLS_USAGE_DANE_TA:
4839 case DANETLS_USAGE_DANE_EE:
4844 ctx = CT_POLICY_EVAL_CTX_new();
4846 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4847 ERR_R_MALLOC_FAILURE);
4851 issuer = sk_X509_value(s->verified_chain, 1);
4852 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4853 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4854 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4855 CT_POLICY_EVAL_CTX_set_time(
4856 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4858 scts = SSL_get0_peer_scts(s);
4861 * This function returns success (> 0) only when all the SCTs are valid, 0
4862 * when some are invalid, and < 0 on various internal errors (out of
4863 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4864 * reason to abort the handshake, that decision is up to the callback.
4865 * Therefore, we error out only in the unexpected case that the return
4866 * value is negative.
4868 * XXX: One might well argue that the return value of this function is an
4869 * unfortunate design choice. Its job is only to determine the validation
4870 * status of each of the provided SCTs. So long as it correctly separates
4871 * the wheat from the chaff it should return success. Failure in this case
4872 * ought to correspond to an inability to carry out its duties.
4874 if (SCT_LIST_validate(scts, ctx) < 0) {
4875 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4876 SSL_R_SCT_VERIFICATION_FAILED);
4880 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4882 ret = 0; /* This function returns 0 on failure */
4884 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4885 SSL_R_CALLBACK_FAILED);
4888 CT_POLICY_EVAL_CTX_free(ctx);
4890 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4891 * failure return code here. Also the application may wish the complete
4892 * the handshake, and then disconnect cleanly at a higher layer, after
4893 * checking the verification status of the completed connection.
4895 * We therefore force a certificate verification failure which will be
4896 * visible via SSL_get_verify_result() and cached as part of any resumed
4899 * Note: the permissive callback is for information gathering only, always
4900 * returns success, and does not affect verification status. Only the
4901 * strict callback or a custom application-specified callback can trigger
4902 * connection failure or record a verification error.
4905 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4909 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4911 switch (validation_mode) {
4913 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4915 case SSL_CT_VALIDATION_PERMISSIVE:
4916 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4917 case SSL_CT_VALIDATION_STRICT:
4918 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4922 int SSL_enable_ct(SSL *s, int validation_mode)
4924 switch (validation_mode) {
4926 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4928 case SSL_CT_VALIDATION_PERMISSIVE:
4929 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4930 case SSL_CT_VALIDATION_STRICT:
4931 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4935 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4937 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4940 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4942 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4945 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4947 CTLOG_STORE_free(ctx->ctlog_store);
4948 ctx->ctlog_store = logs;
4951 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4953 return ctx->ctlog_store;
4956 #endif /* OPENSSL_NO_CT */
4958 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4961 c->client_hello_cb = cb;
4962 c->client_hello_cb_arg = arg;
4965 int SSL_client_hello_isv2(SSL *s)
4967 if (s->clienthello == NULL)
4969 return s->clienthello->isv2;
4972 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4974 if (s->clienthello == NULL)
4976 return s->clienthello->legacy_version;
4979 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
4981 if (s->clienthello == NULL)
4984 *out = s->clienthello->random;
4985 return SSL3_RANDOM_SIZE;
4988 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
4990 if (s->clienthello == NULL)
4993 *out = s->clienthello->session_id;
4994 return s->clienthello->session_id_len;
4997 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
4999 if (s->clienthello == NULL)
5002 *out = PACKET_data(&s->clienthello->ciphersuites);
5003 return PACKET_remaining(&s->clienthello->ciphersuites);
5006 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
5008 if (s->clienthello == NULL)
5011 *out = s->clienthello->compressions;
5012 return s->clienthello->compressions_len;
5015 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
5021 if (s->clienthello == NULL || out == NULL || outlen == NULL)
5023 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5024 ext = s->clienthello->pre_proc_exts + i;
5028 if ((present = OPENSSL_malloc(sizeof(*present) * num)) == NULL) {
5029 SSLerr(SSL_F_SSL_CLIENT_HELLO_GET1_EXTENSIONS_PRESENT,
5030 ERR_R_MALLOC_FAILURE);
5033 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
5034 ext = s->clienthello->pre_proc_exts + i;
5036 if (ext->received_order >= num)
5038 present[ext->received_order] = ext->type;
5045 OPENSSL_free(present);
5049 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
5055 if (s->clienthello == NULL)
5057 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
5058 r = s->clienthello->pre_proc_exts + i;
5059 if (r->present && r->type == type) {
5061 *out = PACKET_data(&r->data);
5063 *outlen = PACKET_remaining(&r->data);
5070 int SSL_free_buffers(SSL *ssl)
5072 RECORD_LAYER *rl = &ssl->rlayer;
5074 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
5077 RECORD_LAYER_release(rl);
5081 int SSL_alloc_buffers(SSL *ssl)
5083 return ssl3_setup_buffers(ssl);
5086 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
5088 ctx->keylog_callback = cb;
5091 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
5093 return ctx->keylog_callback;
5096 static int nss_keylog_int(const char *prefix,
5098 const uint8_t *parameter_1,
5099 size_t parameter_1_len,
5100 const uint8_t *parameter_2,
5101 size_t parameter_2_len)
5104 char *cursor = NULL;
5109 if (ssl->ctx->keylog_callback == NULL) return 1;
5112 * Our output buffer will contain the following strings, rendered with
5113 * space characters in between, terminated by a NULL character: first the
5114 * prefix, then the first parameter, then the second parameter. The
5115 * meaning of each parameter depends on the specific key material being
5116 * logged. Note that the first and second parameters are encoded in
5117 * hexadecimal, so we need a buffer that is twice their lengths.
5119 prefix_len = strlen(prefix);
5120 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
5121 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5122 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5123 ERR_R_MALLOC_FAILURE);
5127 strcpy(cursor, prefix);
5128 cursor += prefix_len;
5131 for (i = 0; i < parameter_1_len; i++) {
5132 sprintf(cursor, "%02x", parameter_1[i]);
5137 for (i = 0; i < parameter_2_len; i++) {
5138 sprintf(cursor, "%02x", parameter_2[i]);
5143 ssl->ctx->keylog_callback(ssl, (const char *)out);
5149 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5150 const uint8_t *encrypted_premaster,
5151 size_t encrypted_premaster_len,
5152 const uint8_t *premaster,
5153 size_t premaster_len)
5155 if (encrypted_premaster_len < 8) {
5156 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5157 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5161 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5162 return nss_keylog_int("RSA",
5164 encrypted_premaster,
5170 int ssl_log_secret(SSL *ssl,
5172 const uint8_t *secret,
5175 return nss_keylog_int(label,
5177 ssl->s3->client_random,
5183 #define SSLV2_CIPHER_LEN 3
5185 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5189 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5191 if (PACKET_remaining(cipher_suites) == 0) {
5192 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5193 SSL_R_NO_CIPHERS_SPECIFIED);
5197 if (PACKET_remaining(cipher_suites) % n != 0) {
5198 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5199 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5203 OPENSSL_free(s->s3->tmp.ciphers_raw);
5204 s->s3->tmp.ciphers_raw = NULL;
5205 s->s3->tmp.ciphers_rawlen = 0;
5208 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5209 PACKET sslv2ciphers = *cipher_suites;
5210 unsigned int leadbyte;
5214 * We store the raw ciphers list in SSLv3+ format so we need to do some
5215 * preprocessing to convert the list first. If there are any SSLv2 only
5216 * ciphersuites with a non-zero leading byte then we are going to
5217 * slightly over allocate because we won't store those. But that isn't a
5220 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5221 s->s3->tmp.ciphers_raw = raw;
5223 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5224 ERR_R_MALLOC_FAILURE);
5227 for (s->s3->tmp.ciphers_rawlen = 0;
5228 PACKET_remaining(&sslv2ciphers) > 0;
5229 raw += TLS_CIPHER_LEN) {
5230 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5232 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5235 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5236 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5238 OPENSSL_free(s->s3->tmp.ciphers_raw);
5239 s->s3->tmp.ciphers_raw = NULL;
5240 s->s3->tmp.ciphers_rawlen = 0;
5244 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5246 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5247 &s->s3->tmp.ciphers_rawlen)) {
5248 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5249 ERR_R_INTERNAL_ERROR);
5255 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5256 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5257 STACK_OF(SSL_CIPHER) **scsvs)
5261 if (!PACKET_buf_init(&pkt, bytes, len))
5263 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5266 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5267 STACK_OF(SSL_CIPHER) **skp,
5268 STACK_OF(SSL_CIPHER) **scsvs_out,
5269 int sslv2format, int fatal)
5271 const SSL_CIPHER *c;
5272 STACK_OF(SSL_CIPHER) *sk = NULL;
5273 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5275 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5276 unsigned char cipher[SSLV2_CIPHER_LEN];
5278 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5280 if (PACKET_remaining(cipher_suites) == 0) {
5282 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5283 SSL_R_NO_CIPHERS_SPECIFIED);
5285 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5289 if (PACKET_remaining(cipher_suites) % n != 0) {
5291 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5292 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5294 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5295 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5299 sk = sk_SSL_CIPHER_new_null();
5300 scsvs = sk_SSL_CIPHER_new_null();
5301 if (sk == NULL || scsvs == NULL) {
5303 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5304 ERR_R_MALLOC_FAILURE);
5306 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5310 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5312 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5313 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5314 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5316 if (sslv2format && cipher[0] != '\0')
5319 /* For SSLv2-compat, ignore leading 0-byte. */
5320 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5322 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5323 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5325 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5326 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5328 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5333 if (PACKET_remaining(cipher_suites) > 0) {
5335 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5338 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5345 sk_SSL_CIPHER_free(sk);
5346 if (scsvs_out != NULL)
5349 sk_SSL_CIPHER_free(scsvs);
5352 sk_SSL_CIPHER_free(sk);
5353 sk_SSL_CIPHER_free(scsvs);
5357 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5359 ctx->max_early_data = max_early_data;
5364 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5366 return ctx->max_early_data;
5369 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5371 s->max_early_data = max_early_data;
5376 uint32_t SSL_get_max_early_data(const SSL *s)
5378 return s->max_early_data;
5381 int SSL_CTX_set_recv_max_early_data(SSL_CTX *ctx, uint32_t recv_max_early_data)
5383 ctx->recv_max_early_data = recv_max_early_data;
5388 uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX *ctx)
5390 return ctx->recv_max_early_data;
5393 int SSL_set_recv_max_early_data(SSL *s, uint32_t recv_max_early_data)
5395 s->recv_max_early_data = recv_max_early_data;
5400 uint32_t SSL_get_recv_max_early_data(const SSL *s)
5402 return s->recv_max_early_data;
5405 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5407 /* Return any active Max Fragment Len extension */
5408 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5409 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5411 /* return current SSL connection setting */
5412 return ssl->max_send_fragment;
5415 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5417 /* Return a value regarding an active Max Fragment Len extension */
5418 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5419 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5420 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5422 /* else limit |split_send_fragment| to current |max_send_fragment| */
5423 if (ssl->split_send_fragment > ssl->max_send_fragment)
5424 return ssl->max_send_fragment;
5426 /* return current SSL connection setting */
5427 return ssl->split_send_fragment;
5430 int SSL_stateless(SSL *s)
5434 /* Ensure there is no state left over from a previous invocation */
5440 s->s3->flags |= TLS1_FLAGS_STATELESS;
5441 ret = SSL_accept(s);
5442 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5444 if (ret > 0 && s->ext.cookieok)
5447 if (s->hello_retry_request == SSL_HRR_PENDING && !ossl_statem_in_error(s))
5453 void SSL_CTX_set_post_handshake_auth(SSL_CTX *ctx, int val)
5455 ctx->pha_enabled = val;
5458 void SSL_set_post_handshake_auth(SSL *ssl, int val)
5460 ssl->pha_enabled = val;
5463 int SSL_verify_client_post_handshake(SSL *ssl)
5465 if (!SSL_IS_TLS13(ssl)) {
5466 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5470 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5474 if (!SSL_is_init_finished(ssl)) {
5475 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5479 switch (ssl->post_handshake_auth) {
5481 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5484 case SSL_PHA_EXT_SENT:
5485 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5487 case SSL_PHA_EXT_RECEIVED:
5489 case SSL_PHA_REQUEST_PENDING:
5490 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5492 case SSL_PHA_REQUESTED:
5493 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5497 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5499 /* checks verify_mode and algorithm_auth */
5500 if (!send_certificate_request(ssl)) {
5501 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5502 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5506 ossl_statem_set_in_init(ssl, 1);
5510 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
5511 SSL_CTX_generate_session_ticket_fn gen_cb,
5512 SSL_CTX_decrypt_session_ticket_fn dec_cb,
5515 ctx->generate_ticket_cb = gen_cb;
5516 ctx->decrypt_ticket_cb = dec_cb;
5517 ctx->ticket_cb_data = arg;
5521 void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
5522 SSL_allow_early_data_cb_fn cb,
5525 ctx->allow_early_data_cb = cb;
5526 ctx->allow_early_data_cb_data = arg;
5529 void SSL_set_allow_early_data_cb(SSL *s,
5530 SSL_allow_early_data_cb_fn cb,
5533 s->allow_early_data_cb = cb;
5534 s->allow_early_data_cb_data = arg;