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;
599 if (s->renegotiate) {
600 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
604 ossl_statem_clear(s);
606 s->version = s->method->version;
607 s->client_version = s->version;
608 s->rwstate = SSL_NOTHING;
610 BUF_MEM_free(s->init_buf);
615 s->key_update = SSL_KEY_UPDATE_NONE;
617 EVP_MD_CTX_free(s->pha_dgst);
620 /* Reset DANE verification result state */
623 X509_free(s->dane.mcert);
624 s->dane.mcert = NULL;
625 s->dane.mtlsa = NULL;
627 /* Clear the verification result peername */
628 X509_VERIFY_PARAM_move_peername(s->param, NULL);
631 * Check to see if we were changed into a different method, if so, revert
634 if (s->method != s->ctx->method) {
635 s->method->ssl_free(s);
636 s->method = s->ctx->method;
637 if (!s->method->ssl_new(s))
640 if (!s->method->ssl_clear(s))
644 RECORD_LAYER_clear(&s->rlayer);
649 /** Used to change an SSL_CTXs default SSL method type */
650 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
652 STACK_OF(SSL_CIPHER) *sk;
656 sk = ssl_create_cipher_list(ctx->method,
657 ctx->tls13_ciphersuites,
659 &(ctx->cipher_list_by_id),
660 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
661 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
662 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
668 SSL *SSL_new(SSL_CTX *ctx)
673 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
676 if (ctx->method == NULL) {
677 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
681 s = OPENSSL_zalloc(sizeof(*s));
686 s->lock = CRYPTO_THREAD_lock_new();
687 if (s->lock == NULL) {
693 RECORD_LAYER_init(&s->rlayer, s);
695 s->options = ctx->options;
696 s->dane.flags = ctx->dane.flags;
697 s->min_proto_version = ctx->min_proto_version;
698 s->max_proto_version = ctx->max_proto_version;
700 s->max_cert_list = ctx->max_cert_list;
701 s->max_early_data = ctx->max_early_data;
702 s->num_tickets = ctx->num_tickets;
704 /* Shallow copy of the ciphersuites stack */
705 s->tls13_ciphersuites = sk_SSL_CIPHER_dup(ctx->tls13_ciphersuites);
706 if (s->tls13_ciphersuites == NULL)
710 * Earlier library versions used to copy the pointer to the CERT, not
711 * its contents; only when setting new parameters for the per-SSL
712 * copy, ssl_cert_new would be called (and the direct reference to
713 * the per-SSL_CTX settings would be lost, but those still were
714 * indirectly accessed for various purposes, and for that reason they
715 * used to be known as s->ctx->default_cert). Now we don't look at the
716 * SSL_CTX's CERT after having duplicated it once.
718 s->cert = ssl_cert_dup(ctx->cert);
722 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
723 s->msg_callback = ctx->msg_callback;
724 s->msg_callback_arg = ctx->msg_callback_arg;
725 s->verify_mode = ctx->verify_mode;
726 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
727 s->record_padding_cb = ctx->record_padding_cb;
728 s->record_padding_arg = ctx->record_padding_arg;
729 s->block_padding = ctx->block_padding;
730 s->sid_ctx_length = ctx->sid_ctx_length;
731 if (!ossl_assert(s->sid_ctx_length <= sizeof(s->sid_ctx)))
733 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
734 s->verify_callback = ctx->default_verify_callback;
735 s->generate_session_id = ctx->generate_session_id;
737 s->param = X509_VERIFY_PARAM_new();
738 if (s->param == NULL)
740 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
741 s->quiet_shutdown = ctx->quiet_shutdown;
743 s->ext.max_fragment_len_mode = ctx->ext.max_fragment_len_mode;
744 s->max_send_fragment = ctx->max_send_fragment;
745 s->split_send_fragment = ctx->split_send_fragment;
746 s->max_pipelines = ctx->max_pipelines;
747 if (s->max_pipelines > 1)
748 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
749 if (ctx->default_read_buf_len > 0)
750 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
755 s->ext.debug_arg = NULL;
756 s->ext.ticket_expected = 0;
757 s->ext.status_type = ctx->ext.status_type;
758 s->ext.status_expected = 0;
759 s->ext.ocsp.ids = NULL;
760 s->ext.ocsp.exts = NULL;
761 s->ext.ocsp.resp = NULL;
762 s->ext.ocsp.resp_len = 0;
764 s->session_ctx = ctx;
765 #ifndef OPENSSL_NO_EC
766 if (ctx->ext.ecpointformats) {
767 s->ext.ecpointformats =
768 OPENSSL_memdup(ctx->ext.ecpointformats,
769 ctx->ext.ecpointformats_len);
770 if (!s->ext.ecpointformats)
772 s->ext.ecpointformats_len =
773 ctx->ext.ecpointformats_len;
775 if (ctx->ext.supportedgroups) {
776 s->ext.supportedgroups =
777 OPENSSL_memdup(ctx->ext.supportedgroups,
778 ctx->ext.supportedgroups_len
779 * sizeof(*ctx->ext.supportedgroups));
780 if (!s->ext.supportedgroups)
782 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
785 #ifndef OPENSSL_NO_NEXTPROTONEG
789 if (s->ctx->ext.alpn) {
790 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
791 if (s->ext.alpn == NULL)
793 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
794 s->ext.alpn_len = s->ctx->ext.alpn_len;
797 s->verified_chain = NULL;
798 s->verify_result = X509_V_OK;
800 s->default_passwd_callback = ctx->default_passwd_callback;
801 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
803 s->method = ctx->method;
805 s->key_update = SSL_KEY_UPDATE_NONE;
807 if (!s->method->ssl_new(s))
810 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
815 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
818 #ifndef OPENSSL_NO_PSK
819 s->psk_client_callback = ctx->psk_client_callback;
820 s->psk_server_callback = ctx->psk_server_callback;
822 s->psk_find_session_cb = ctx->psk_find_session_cb;
823 s->psk_use_session_cb = ctx->psk_use_session_cb;
827 #ifndef OPENSSL_NO_CT
828 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
829 ctx->ct_validation_callback_arg))
836 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
840 int SSL_is_dtls(const SSL *s)
842 return SSL_IS_DTLS(s) ? 1 : 0;
845 int SSL_up_ref(SSL *s)
849 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
852 REF_PRINT_COUNT("SSL", s);
853 REF_ASSERT_ISNT(i < 2);
854 return ((i > 1) ? 1 : 0);
857 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
858 unsigned int sid_ctx_len)
860 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
861 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
862 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
865 ctx->sid_ctx_length = sid_ctx_len;
866 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
871 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
872 unsigned int sid_ctx_len)
874 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
875 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
876 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
879 ssl->sid_ctx_length = sid_ctx_len;
880 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
885 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
887 CRYPTO_THREAD_write_lock(ctx->lock);
888 ctx->generate_session_id = cb;
889 CRYPTO_THREAD_unlock(ctx->lock);
893 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
895 CRYPTO_THREAD_write_lock(ssl->lock);
896 ssl->generate_session_id = cb;
897 CRYPTO_THREAD_unlock(ssl->lock);
901 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
905 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
906 * we can "construct" a session to give us the desired check - i.e. to
907 * find if there's a session in the hash table that would conflict with
908 * any new session built out of this id/id_len and the ssl_version in use
913 if (id_len > sizeof(r.session_id))
916 r.ssl_version = ssl->version;
917 r.session_id_length = id_len;
918 memcpy(r.session_id, id, id_len);
920 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
921 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
922 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
926 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
928 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
931 int SSL_set_purpose(SSL *s, int purpose)
933 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
936 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
938 return X509_VERIFY_PARAM_set_trust(s->param, trust);
941 int SSL_set_trust(SSL *s, int trust)
943 return X509_VERIFY_PARAM_set_trust(s->param, trust);
946 int SSL_set1_host(SSL *s, const char *hostname)
948 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
951 int SSL_add1_host(SSL *s, const char *hostname)
953 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
956 void SSL_set_hostflags(SSL *s, unsigned int flags)
958 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
961 const char *SSL_get0_peername(SSL *s)
963 return X509_VERIFY_PARAM_get0_peername(s->param);
966 int SSL_CTX_dane_enable(SSL_CTX *ctx)
968 return dane_ctx_enable(&ctx->dane);
971 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
973 unsigned long orig = ctx->dane.flags;
975 ctx->dane.flags |= flags;
979 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
981 unsigned long orig = ctx->dane.flags;
983 ctx->dane.flags &= ~flags;
987 int SSL_dane_enable(SSL *s, const char *basedomain)
989 SSL_DANE *dane = &s->dane;
991 if (s->ctx->dane.mdmax == 0) {
992 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
995 if (dane->trecs != NULL) {
996 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1001 * Default SNI name. This rejects empty names, while set1_host below
1002 * accepts them and disables host name checks. To avoid side-effects with
1003 * invalid input, set the SNI name first.
1005 if (s->ext.hostname == NULL) {
1006 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1007 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1012 /* Primary RFC6125 reference identifier */
1013 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1014 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1020 dane->dctx = &s->ctx->dane;
1021 dane->trecs = sk_danetls_record_new_null();
1023 if (dane->trecs == NULL) {
1024 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1030 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1032 unsigned long orig = ssl->dane.flags;
1034 ssl->dane.flags |= flags;
1038 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1040 unsigned long orig = ssl->dane.flags;
1042 ssl->dane.flags &= ~flags;
1046 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1048 SSL_DANE *dane = &s->dane;
1050 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1054 *mcert = dane->mcert;
1056 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1061 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1062 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1064 SSL_DANE *dane = &s->dane;
1066 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1070 *usage = dane->mtlsa->usage;
1072 *selector = dane->mtlsa->selector;
1074 *mtype = dane->mtlsa->mtype;
1076 *data = dane->mtlsa->data;
1078 *dlen = dane->mtlsa->dlen;
1083 SSL_DANE *SSL_get0_dane(SSL *s)
1088 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1089 uint8_t mtype, unsigned const char *data, size_t dlen)
1091 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1094 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1097 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1100 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1102 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1105 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1107 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1110 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1115 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1120 void SSL_certs_clear(SSL *s)
1122 ssl_cert_clear_certs(s->cert);
1125 void SSL_free(SSL *s)
1131 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1132 REF_PRINT_COUNT("SSL", s);
1135 REF_ASSERT_ISNT(i < 0);
1137 X509_VERIFY_PARAM_free(s->param);
1138 dane_final(&s->dane);
1139 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1141 /* Ignore return value */
1142 ssl_free_wbio_buffer(s);
1144 BIO_free_all(s->wbio);
1145 BIO_free_all(s->rbio);
1147 BUF_MEM_free(s->init_buf);
1149 /* add extra stuff */
1150 sk_SSL_CIPHER_free(s->cipher_list);
1151 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1152 sk_SSL_CIPHER_free(s->tls13_ciphersuites);
1154 /* Make the next call work :-) */
1155 if (s->session != NULL) {
1156 ssl_clear_bad_session(s);
1157 SSL_SESSION_free(s->session);
1159 SSL_SESSION_free(s->psksession);
1160 OPENSSL_free(s->psksession_id);
1164 ssl_cert_free(s->cert);
1165 /* Free up if allocated */
1167 OPENSSL_free(s->ext.hostname);
1168 SSL_CTX_free(s->session_ctx);
1169 #ifndef OPENSSL_NO_EC
1170 OPENSSL_free(s->ext.ecpointformats);
1171 OPENSSL_free(s->ext.supportedgroups);
1172 #endif /* OPENSSL_NO_EC */
1173 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1174 #ifndef OPENSSL_NO_OCSP
1175 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1177 #ifndef OPENSSL_NO_CT
1178 SCT_LIST_free(s->scts);
1179 OPENSSL_free(s->ext.scts);
1181 OPENSSL_free(s->ext.ocsp.resp);
1182 OPENSSL_free(s->ext.alpn);
1183 OPENSSL_free(s->ext.tls13_cookie);
1184 OPENSSL_free(s->clienthello);
1185 OPENSSL_free(s->pha_context);
1186 EVP_MD_CTX_free(s->pha_dgst);
1188 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1190 sk_X509_pop_free(s->verified_chain, X509_free);
1192 if (s->method != NULL)
1193 s->method->ssl_free(s);
1195 RECORD_LAYER_release(&s->rlayer);
1197 SSL_CTX_free(s->ctx);
1199 ASYNC_WAIT_CTX_free(s->waitctx);
1201 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1202 OPENSSL_free(s->ext.npn);
1205 #ifndef OPENSSL_NO_SRTP
1206 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1209 CRYPTO_THREAD_lock_free(s->lock);
1214 void SSL_set0_rbio(SSL *s, BIO *rbio)
1216 BIO_free_all(s->rbio);
1220 void SSL_set0_wbio(SSL *s, BIO *wbio)
1223 * If the output buffering BIO is still in place, remove it
1225 if (s->bbio != NULL)
1226 s->wbio = BIO_pop(s->wbio);
1228 BIO_free_all(s->wbio);
1231 /* Re-attach |bbio| to the new |wbio|. */
1232 if (s->bbio != NULL)
1233 s->wbio = BIO_push(s->bbio, s->wbio);
1236 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1239 * For historical reasons, this function has many different cases in
1240 * ownership handling.
1243 /* If nothing has changed, do nothing */
1244 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1248 * If the two arguments are equal then one fewer reference is granted by the
1249 * caller than we want to take
1251 if (rbio != NULL && rbio == wbio)
1255 * If only the wbio is changed only adopt one reference.
1257 if (rbio == SSL_get_rbio(s)) {
1258 SSL_set0_wbio(s, wbio);
1262 * There is an asymmetry here for historical reasons. If only the rbio is
1263 * changed AND the rbio and wbio were originally different, then we only
1264 * adopt one reference.
1266 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1267 SSL_set0_rbio(s, rbio);
1271 /* Otherwise, adopt both references. */
1272 SSL_set0_rbio(s, rbio);
1273 SSL_set0_wbio(s, wbio);
1276 BIO *SSL_get_rbio(const SSL *s)
1281 BIO *SSL_get_wbio(const SSL *s)
1283 if (s->bbio != NULL) {
1285 * If |bbio| is active, the true caller-configured BIO is its
1288 return BIO_next(s->bbio);
1293 int SSL_get_fd(const SSL *s)
1295 return SSL_get_rfd(s);
1298 int SSL_get_rfd(const SSL *s)
1303 b = SSL_get_rbio(s);
1304 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1306 BIO_get_fd(r, &ret);
1310 int SSL_get_wfd(const SSL *s)
1315 b = SSL_get_wbio(s);
1316 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1318 BIO_get_fd(r, &ret);
1322 #ifndef OPENSSL_NO_SOCK
1323 int SSL_set_fd(SSL *s, int fd)
1328 bio = BIO_new(BIO_s_socket());
1331 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1334 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1335 SSL_set_bio(s, bio, bio);
1341 int SSL_set_wfd(SSL *s, int fd)
1343 BIO *rbio = SSL_get_rbio(s);
1345 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1346 || (int)BIO_get_fd(rbio, NULL) != fd) {
1347 BIO *bio = BIO_new(BIO_s_socket());
1350 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1353 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1354 SSL_set0_wbio(s, bio);
1357 SSL_set0_wbio(s, rbio);
1362 int SSL_set_rfd(SSL *s, int fd)
1364 BIO *wbio = SSL_get_wbio(s);
1366 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1367 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1368 BIO *bio = BIO_new(BIO_s_socket());
1371 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1374 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1375 SSL_set0_rbio(s, bio);
1378 SSL_set0_rbio(s, wbio);
1385 /* return length of latest Finished message we sent, copy to 'buf' */
1386 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1390 if (s->s3 != NULL) {
1391 ret = s->s3->tmp.finish_md_len;
1394 memcpy(buf, s->s3->tmp.finish_md, count);
1399 /* return length of latest Finished message we expected, copy to 'buf' */
1400 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1404 if (s->s3 != NULL) {
1405 ret = s->s3->tmp.peer_finish_md_len;
1408 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1413 int SSL_get_verify_mode(const SSL *s)
1415 return s->verify_mode;
1418 int SSL_get_verify_depth(const SSL *s)
1420 return X509_VERIFY_PARAM_get_depth(s->param);
1423 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1424 return s->verify_callback;
1427 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1429 return ctx->verify_mode;
1432 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1434 return X509_VERIFY_PARAM_get_depth(ctx->param);
1437 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1438 return ctx->default_verify_callback;
1441 void SSL_set_verify(SSL *s, int mode,
1442 int (*callback) (int ok, X509_STORE_CTX *ctx))
1444 s->verify_mode = mode;
1445 if (callback != NULL)
1446 s->verify_callback = callback;
1449 void SSL_set_verify_depth(SSL *s, int depth)
1451 X509_VERIFY_PARAM_set_depth(s->param, depth);
1454 void SSL_set_read_ahead(SSL *s, int yes)
1456 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1459 int SSL_get_read_ahead(const SSL *s)
1461 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1464 int SSL_pending(const SSL *s)
1466 size_t pending = s->method->ssl_pending(s);
1469 * SSL_pending cannot work properly if read-ahead is enabled
1470 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1471 * impossible to fix since SSL_pending cannot report errors that may be
1472 * observed while scanning the new data. (Note that SSL_pending() is
1473 * often used as a boolean value, so we'd better not return -1.)
1475 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1476 * we just return INT_MAX.
1478 return pending < INT_MAX ? (int)pending : INT_MAX;
1481 int SSL_has_pending(const SSL *s)
1484 * Similar to SSL_pending() but returns a 1 to indicate that we have
1485 * unprocessed data available or 0 otherwise (as opposed to the number of
1486 * bytes available). Unlike SSL_pending() this will take into account
1487 * read_ahead data. A 1 return simply indicates that we have unprocessed
1488 * data. That data may not result in any application data, or we may fail
1489 * to parse the records for some reason.
1491 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1494 return RECORD_LAYER_read_pending(&s->rlayer);
1497 X509 *SSL_get_peer_certificate(const SSL *s)
1501 if ((s == NULL) || (s->session == NULL))
1504 r = s->session->peer;
1514 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1518 if ((s == NULL) || (s->session == NULL))
1521 r = s->session->peer_chain;
1524 * If we are a client, cert_chain includes the peer's own certificate; if
1525 * we are a server, it does not.
1532 * Now in theory, since the calling process own 't' it should be safe to
1533 * modify. We need to be able to read f without being hassled
1535 int SSL_copy_session_id(SSL *t, const SSL *f)
1538 /* Do we need to to SSL locking? */
1539 if (!SSL_set_session(t, SSL_get_session(f))) {
1544 * what if we are setup for one protocol version but want to talk another
1546 if (t->method != f->method) {
1547 t->method->ssl_free(t);
1548 t->method = f->method;
1549 if (t->method->ssl_new(t) == 0)
1553 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1554 ssl_cert_free(t->cert);
1556 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1563 /* Fix this so it checks all the valid key/cert options */
1564 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1566 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1567 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1570 if (ctx->cert->key->privatekey == NULL) {
1571 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1574 return X509_check_private_key
1575 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1578 /* Fix this function so that it takes an optional type parameter */
1579 int SSL_check_private_key(const SSL *ssl)
1582 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1585 if (ssl->cert->key->x509 == NULL) {
1586 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1589 if (ssl->cert->key->privatekey == NULL) {
1590 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1593 return X509_check_private_key(ssl->cert->key->x509,
1594 ssl->cert->key->privatekey);
1597 int SSL_waiting_for_async(SSL *s)
1605 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1607 ASYNC_WAIT_CTX *ctx = s->waitctx;
1611 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1614 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1615 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1617 ASYNC_WAIT_CTX *ctx = s->waitctx;
1621 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1625 int SSL_accept(SSL *s)
1627 if (s->handshake_func == NULL) {
1628 /* Not properly initialized yet */
1629 SSL_set_accept_state(s);
1632 return SSL_do_handshake(s);
1635 int SSL_connect(SSL *s)
1637 if (s->handshake_func == NULL) {
1638 /* Not properly initialized yet */
1639 SSL_set_connect_state(s);
1642 return SSL_do_handshake(s);
1645 long SSL_get_default_timeout(const SSL *s)
1647 return s->method->get_timeout();
1650 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1651 int (*func) (void *))
1654 if (s->waitctx == NULL) {
1655 s->waitctx = ASYNC_WAIT_CTX_new();
1656 if (s->waitctx == NULL)
1659 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1660 sizeof(struct ssl_async_args))) {
1662 s->rwstate = SSL_NOTHING;
1663 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1666 s->rwstate = SSL_ASYNC_PAUSED;
1669 s->rwstate = SSL_ASYNC_NO_JOBS;
1675 s->rwstate = SSL_NOTHING;
1676 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1677 /* Shouldn't happen */
1682 static int ssl_io_intern(void *vargs)
1684 struct ssl_async_args *args;
1689 args = (struct ssl_async_args *)vargs;
1693 switch (args->type) {
1695 return args->f.func_read(s, buf, num, &s->asyncrw);
1697 return args->f.func_write(s, buf, num, &s->asyncrw);
1699 return args->f.func_other(s);
1704 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1706 if (s->handshake_func == NULL) {
1707 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1711 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1712 s->rwstate = SSL_NOTHING;
1716 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1717 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1718 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1722 * If we are a client and haven't received the ServerHello etc then we
1725 ossl_statem_check_finish_init(s, 0);
1727 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1728 struct ssl_async_args args;
1734 args.type = READFUNC;
1735 args.f.func_read = s->method->ssl_read;
1737 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1738 *readbytes = s->asyncrw;
1741 return s->method->ssl_read(s, buf, num, readbytes);
1745 int SSL_read(SSL *s, void *buf, int num)
1751 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1755 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1758 * The cast is safe here because ret should be <= INT_MAX because num is
1762 ret = (int)readbytes;
1767 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1769 int ret = ssl_read_internal(s, buf, num, readbytes);
1776 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1781 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1782 return SSL_READ_EARLY_DATA_ERROR;
1785 switch (s->early_data_state) {
1786 case SSL_EARLY_DATA_NONE:
1787 if (!SSL_in_before(s)) {
1788 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1789 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1790 return SSL_READ_EARLY_DATA_ERROR;
1794 case SSL_EARLY_DATA_ACCEPT_RETRY:
1795 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1796 ret = SSL_accept(s);
1799 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1800 return SSL_READ_EARLY_DATA_ERROR;
1804 case SSL_EARLY_DATA_READ_RETRY:
1805 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1806 s->early_data_state = SSL_EARLY_DATA_READING;
1807 ret = SSL_read_ex(s, buf, num, readbytes);
1809 * State machine will update early_data_state to
1810 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1813 if (ret > 0 || (ret <= 0 && s->early_data_state
1814 != SSL_EARLY_DATA_FINISHED_READING)) {
1815 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1816 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1817 : SSL_READ_EARLY_DATA_ERROR;
1820 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1823 return SSL_READ_EARLY_DATA_FINISH;
1826 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1827 return SSL_READ_EARLY_DATA_ERROR;
1831 int SSL_get_early_data_status(const SSL *s)
1833 return s->ext.early_data;
1836 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1838 if (s->handshake_func == NULL) {
1839 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1843 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1846 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1847 struct ssl_async_args args;
1853 args.type = READFUNC;
1854 args.f.func_read = s->method->ssl_peek;
1856 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1857 *readbytes = s->asyncrw;
1860 return s->method->ssl_peek(s, buf, num, readbytes);
1864 int SSL_peek(SSL *s, void *buf, int num)
1870 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1874 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1877 * The cast is safe here because ret should be <= INT_MAX because num is
1881 ret = (int)readbytes;
1887 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1889 int ret = ssl_peek_internal(s, buf, num, readbytes);
1896 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1898 if (s->handshake_func == NULL) {
1899 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1903 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1904 s->rwstate = SSL_NOTHING;
1905 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1909 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1910 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1911 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1912 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1915 /* If we are a client and haven't sent the Finished we better do that */
1916 ossl_statem_check_finish_init(s, 1);
1918 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1920 struct ssl_async_args args;
1923 args.buf = (void *)buf;
1925 args.type = WRITEFUNC;
1926 args.f.func_write = s->method->ssl_write;
1928 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1929 *written = s->asyncrw;
1932 return s->method->ssl_write(s, buf, num, written);
1936 int SSL_write(SSL *s, const void *buf, int num)
1942 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1946 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1949 * The cast is safe here because ret should be <= INT_MAX because num is
1958 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1960 int ret = ssl_write_internal(s, buf, num, written);
1967 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1969 int ret, early_data_state;
1971 uint32_t partialwrite;
1973 switch (s->early_data_state) {
1974 case SSL_EARLY_DATA_NONE:
1976 || !SSL_in_before(s)
1977 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1978 && (s->psk_use_session_cb == NULL))) {
1979 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1980 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1985 case SSL_EARLY_DATA_CONNECT_RETRY:
1986 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1987 ret = SSL_connect(s);
1990 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1995 case SSL_EARLY_DATA_WRITE_RETRY:
1996 s->early_data_state = SSL_EARLY_DATA_WRITING;
1998 * We disable partial write for early data because we don't keep track
1999 * of how many bytes we've written between the SSL_write_ex() call and
2000 * the flush if the flush needs to be retried)
2002 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2003 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2004 ret = SSL_write_ex(s, buf, num, &writtmp);
2005 s->mode |= partialwrite;
2007 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2010 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2013 case SSL_EARLY_DATA_WRITE_FLUSH:
2014 /* The buffering BIO is still in place so we need to flush it */
2015 if (statem_flush(s) != 1)
2018 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2021 case SSL_EARLY_DATA_FINISHED_READING:
2022 case SSL_EARLY_DATA_READ_RETRY:
2023 early_data_state = s->early_data_state;
2024 /* We are a server writing to an unauthenticated client */
2025 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2026 ret = SSL_write_ex(s, buf, num, written);
2027 /* The buffering BIO is still in place */
2029 (void)BIO_flush(s->wbio);
2030 s->early_data_state = early_data_state;
2034 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2039 int SSL_shutdown(SSL *s)
2042 * Note that this function behaves differently from what one might
2043 * expect. Return values are 0 for no success (yet), 1 for success; but
2044 * calling it once is usually not enough, even if blocking I/O is used
2045 * (see ssl3_shutdown).
2048 if (s->handshake_func == NULL) {
2049 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2053 if (!SSL_in_init(s)) {
2054 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2055 struct ssl_async_args args;
2058 args.type = OTHERFUNC;
2059 args.f.func_other = s->method->ssl_shutdown;
2061 return ssl_start_async_job(s, &args, ssl_io_intern);
2063 return s->method->ssl_shutdown(s);
2066 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2071 int SSL_key_update(SSL *s, int updatetype)
2074 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2075 * negotiated, and that it is appropriate to call SSL_key_update() instead
2076 * of SSL_renegotiate().
2078 if (!SSL_IS_TLS13(s)) {
2079 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2083 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2084 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2085 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2089 if (!SSL_is_init_finished(s)) {
2090 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2094 ossl_statem_set_in_init(s, 1);
2095 s->key_update = updatetype;
2099 int SSL_get_key_update_type(SSL *s)
2101 return s->key_update;
2104 int SSL_renegotiate(SSL *s)
2106 if (SSL_IS_TLS13(s)) {
2107 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2111 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2112 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2119 return s->method->ssl_renegotiate(s);
2122 int SSL_renegotiate_abbreviated(SSL *s)
2124 if (SSL_IS_TLS13(s)) {
2125 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2129 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2130 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2137 return s->method->ssl_renegotiate(s);
2140 int SSL_renegotiate_pending(SSL *s)
2143 * becomes true when negotiation is requested; false again once a
2144 * handshake has finished
2146 return (s->renegotiate != 0);
2149 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2154 case SSL_CTRL_GET_READ_AHEAD:
2155 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2156 case SSL_CTRL_SET_READ_AHEAD:
2157 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2158 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2161 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2162 s->msg_callback_arg = parg;
2166 return (s->mode |= larg);
2167 case SSL_CTRL_CLEAR_MODE:
2168 return (s->mode &= ~larg);
2169 case SSL_CTRL_GET_MAX_CERT_LIST:
2170 return (long)s->max_cert_list;
2171 case SSL_CTRL_SET_MAX_CERT_LIST:
2174 l = (long)s->max_cert_list;
2175 s->max_cert_list = (size_t)larg;
2177 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2178 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2180 s->max_send_fragment = larg;
2181 if (s->max_send_fragment < s->split_send_fragment)
2182 s->split_send_fragment = s->max_send_fragment;
2184 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2185 if ((size_t)larg > s->max_send_fragment || larg == 0)
2187 s->split_send_fragment = larg;
2189 case SSL_CTRL_SET_MAX_PIPELINES:
2190 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2192 s->max_pipelines = larg;
2194 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2196 case SSL_CTRL_GET_RI_SUPPORT:
2198 return s->s3->send_connection_binding;
2201 case SSL_CTRL_CERT_FLAGS:
2202 return (s->cert->cert_flags |= larg);
2203 case SSL_CTRL_CLEAR_CERT_FLAGS:
2204 return (s->cert->cert_flags &= ~larg);
2206 case SSL_CTRL_GET_RAW_CIPHERLIST:
2208 if (s->s3->tmp.ciphers_raw == NULL)
2210 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2211 return (int)s->s3->tmp.ciphers_rawlen;
2213 return TLS_CIPHER_LEN;
2215 case SSL_CTRL_GET_EXTMS_SUPPORT:
2216 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2218 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2222 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2223 return ssl_check_allowed_versions(larg, s->max_proto_version)
2224 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2225 &s->min_proto_version);
2226 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2227 return s->min_proto_version;
2228 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2229 return ssl_check_allowed_versions(s->min_proto_version, larg)
2230 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2231 &s->max_proto_version);
2232 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2233 return s->max_proto_version;
2235 return s->method->ssl_ctrl(s, cmd, larg, parg);
2239 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2242 case SSL_CTRL_SET_MSG_CALLBACK:
2243 s->msg_callback = (void (*)
2244 (int write_p, int version, int content_type,
2245 const void *buf, size_t len, SSL *ssl,
2250 return s->method->ssl_callback_ctrl(s, cmd, fp);
2254 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2256 return ctx->sessions;
2259 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2263 /* For some cases with ctx == NULL perform syntax checks */
2266 #ifndef OPENSSL_NO_EC
2267 case SSL_CTRL_SET_GROUPS_LIST:
2268 return tls1_set_groups_list(NULL, NULL, parg);
2270 case SSL_CTRL_SET_SIGALGS_LIST:
2271 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2272 return tls1_set_sigalgs_list(NULL, parg, 0);
2279 case SSL_CTRL_GET_READ_AHEAD:
2280 return ctx->read_ahead;
2281 case SSL_CTRL_SET_READ_AHEAD:
2282 l = ctx->read_ahead;
2283 ctx->read_ahead = larg;
2286 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2287 ctx->msg_callback_arg = parg;
2290 case SSL_CTRL_GET_MAX_CERT_LIST:
2291 return (long)ctx->max_cert_list;
2292 case SSL_CTRL_SET_MAX_CERT_LIST:
2295 l = (long)ctx->max_cert_list;
2296 ctx->max_cert_list = (size_t)larg;
2299 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2302 l = (long)ctx->session_cache_size;
2303 ctx->session_cache_size = (size_t)larg;
2305 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2306 return (long)ctx->session_cache_size;
2307 case SSL_CTRL_SET_SESS_CACHE_MODE:
2308 l = ctx->session_cache_mode;
2309 ctx->session_cache_mode = larg;
2311 case SSL_CTRL_GET_SESS_CACHE_MODE:
2312 return ctx->session_cache_mode;
2314 case SSL_CTRL_SESS_NUMBER:
2315 return lh_SSL_SESSION_num_items(ctx->sessions);
2316 case SSL_CTRL_SESS_CONNECT:
2317 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2319 case SSL_CTRL_SESS_CONNECT_GOOD:
2320 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2322 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2323 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2326 case SSL_CTRL_SESS_ACCEPT:
2327 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2329 case SSL_CTRL_SESS_ACCEPT_GOOD:
2330 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2332 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2333 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2336 case SSL_CTRL_SESS_HIT:
2337 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2339 case SSL_CTRL_SESS_CB_HIT:
2340 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2342 case SSL_CTRL_SESS_MISSES:
2343 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2345 case SSL_CTRL_SESS_TIMEOUTS:
2346 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2348 case SSL_CTRL_SESS_CACHE_FULL:
2349 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2352 return (ctx->mode |= larg);
2353 case SSL_CTRL_CLEAR_MODE:
2354 return (ctx->mode &= ~larg);
2355 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2356 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2358 ctx->max_send_fragment = larg;
2359 if (ctx->max_send_fragment < ctx->split_send_fragment)
2360 ctx->split_send_fragment = ctx->max_send_fragment;
2362 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2363 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2365 ctx->split_send_fragment = larg;
2367 case SSL_CTRL_SET_MAX_PIPELINES:
2368 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2370 ctx->max_pipelines = larg;
2372 case SSL_CTRL_CERT_FLAGS:
2373 return (ctx->cert->cert_flags |= larg);
2374 case SSL_CTRL_CLEAR_CERT_FLAGS:
2375 return (ctx->cert->cert_flags &= ~larg);
2376 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2377 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2378 && ssl_set_version_bound(ctx->method->version, (int)larg,
2379 &ctx->min_proto_version);
2380 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2381 return ctx->min_proto_version;
2382 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2383 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2384 && ssl_set_version_bound(ctx->method->version, (int)larg,
2385 &ctx->max_proto_version);
2386 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2387 return ctx->max_proto_version;
2389 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2393 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2396 case SSL_CTRL_SET_MSG_CALLBACK:
2397 ctx->msg_callback = (void (*)
2398 (int write_p, int version, int content_type,
2399 const void *buf, size_t len, SSL *ssl,
2404 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2408 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2417 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2418 const SSL_CIPHER *const *bp)
2420 if ((*ap)->id > (*bp)->id)
2422 if ((*ap)->id < (*bp)->id)
2427 /** return a STACK of the ciphers available for the SSL and in order of
2429 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2432 if (s->cipher_list != NULL) {
2433 return s->cipher_list;
2434 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2435 return s->ctx->cipher_list;
2441 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2443 if ((s == NULL) || (s->session == NULL) || !s->server)
2445 return s->session->ciphers;
2448 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2450 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2453 ciphers = SSL_get_ciphers(s);
2456 if (!ssl_set_client_disabled(s))
2458 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2459 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2460 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2462 sk = sk_SSL_CIPHER_new_null();
2465 if (!sk_SSL_CIPHER_push(sk, c)) {
2466 sk_SSL_CIPHER_free(sk);
2474 /** return a STACK of the ciphers available for the SSL and in order of
2476 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2479 if (s->cipher_list_by_id != NULL) {
2480 return s->cipher_list_by_id;
2481 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2482 return s->ctx->cipher_list_by_id;
2488 /** The old interface to get the same thing as SSL_get_ciphers() */
2489 const char *SSL_get_cipher_list(const SSL *s, int n)
2491 const SSL_CIPHER *c;
2492 STACK_OF(SSL_CIPHER) *sk;
2496 sk = SSL_get_ciphers(s);
2497 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2499 c = sk_SSL_CIPHER_value(sk, n);
2505 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2507 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2510 return ctx->cipher_list;
2514 /** specify the ciphers to be used by default by the SSL_CTX */
2515 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2517 STACK_OF(SSL_CIPHER) *sk;
2519 sk = ssl_create_cipher_list(ctx->method, ctx->tls13_ciphersuites,
2520 &ctx->cipher_list, &ctx->cipher_list_by_id, str,
2523 * ssl_create_cipher_list may return an empty stack if it was unable to
2524 * find a cipher matching the given rule string (for example if the rule
2525 * string specifies a cipher which has been disabled). This is not an
2526 * error as far as ssl_create_cipher_list is concerned, and hence
2527 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2531 else if (sk_SSL_CIPHER_num(sk) == 0) {
2532 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2538 /** specify the ciphers to be used by the SSL */
2539 int SSL_set_cipher_list(SSL *s, const char *str)
2541 STACK_OF(SSL_CIPHER) *sk;
2543 sk = ssl_create_cipher_list(s->ctx->method, s->tls13_ciphersuites,
2544 &s->cipher_list, &s->cipher_list_by_id, str,
2546 /* see comment in SSL_CTX_set_cipher_list */
2549 else if (sk_SSL_CIPHER_num(sk) == 0) {
2550 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2556 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size)
2559 STACK_OF(SSL_CIPHER) *clntsk, *srvrsk;
2560 const SSL_CIPHER *c;
2564 || s->session == NULL
2565 || s->session->ciphers == NULL
2570 clntsk = s->session->ciphers;
2571 srvrsk = SSL_get_ciphers(s);
2572 if (clntsk == NULL || srvrsk == NULL)
2575 if (sk_SSL_CIPHER_num(clntsk) == 0 || sk_SSL_CIPHER_num(srvrsk) == 0)
2578 for (i = 0; i < sk_SSL_CIPHER_num(clntsk); i++) {
2581 c = sk_SSL_CIPHER_value(clntsk, i);
2582 if (sk_SSL_CIPHER_find(srvrsk, c) < 0)
2585 n = strlen(c->name);
2601 /** return a servername extension value if provided in Client Hello, or NULL.
2602 * So far, only host_name types are defined (RFC 3546).
2605 const char *SSL_get_servername(const SSL *s, const int type)
2607 if (type != TLSEXT_NAMETYPE_host_name)
2610 return s->session && !s->ext.hostname ?
2611 s->session->ext.hostname : s->ext.hostname;
2614 int SSL_get_servername_type(const SSL *s)
2617 && (!s->ext.hostname ? s->session->
2618 ext.hostname : s->ext.hostname))
2619 return TLSEXT_NAMETYPE_host_name;
2624 * SSL_select_next_proto implements the standard protocol selection. It is
2625 * expected that this function is called from the callback set by
2626 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2627 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2628 * not included in the length. A byte string of length 0 is invalid. No byte
2629 * string may be truncated. The current, but experimental algorithm for
2630 * selecting the protocol is: 1) If the server doesn't support NPN then this
2631 * is indicated to the callback. In this case, the client application has to
2632 * abort the connection or have a default application level protocol. 2) If
2633 * the server supports NPN, but advertises an empty list then the client
2634 * selects the first protocol in its list, but indicates via the API that this
2635 * fallback case was enacted. 3) Otherwise, the client finds the first
2636 * protocol in the server's list that it supports and selects this protocol.
2637 * This is because it's assumed that the server has better information about
2638 * which protocol a client should use. 4) If the client doesn't support any
2639 * of the server's advertised protocols, then this is treated the same as
2640 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2641 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2643 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2644 const unsigned char *server,
2645 unsigned int server_len,
2646 const unsigned char *client, unsigned int client_len)
2649 const unsigned char *result;
2650 int status = OPENSSL_NPN_UNSUPPORTED;
2653 * For each protocol in server preference order, see if we support it.
2655 for (i = 0; i < server_len;) {
2656 for (j = 0; j < client_len;) {
2657 if (server[i] == client[j] &&
2658 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2659 /* We found a match */
2660 result = &server[i];
2661 status = OPENSSL_NPN_NEGOTIATED;
2671 /* There's no overlap between our protocols and the server's list. */
2673 status = OPENSSL_NPN_NO_OVERLAP;
2676 *out = (unsigned char *)result + 1;
2677 *outlen = result[0];
2681 #ifndef OPENSSL_NO_NEXTPROTONEG
2683 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2684 * client's requested protocol for this connection and returns 0. If the
2685 * client didn't request any protocol, then *data is set to NULL. Note that
2686 * the client can request any protocol it chooses. The value returned from
2687 * this function need not be a member of the list of supported protocols
2688 * provided by the callback.
2690 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2697 *len = (unsigned int)s->ext.npn_len;
2702 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2703 * a TLS server needs a list of supported protocols for Next Protocol
2704 * Negotiation. The returned list must be in wire format. The list is
2705 * returned by setting |out| to point to it and |outlen| to its length. This
2706 * memory will not be modified, but one should assume that the SSL* keeps a
2707 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2708 * wishes to advertise. Otherwise, no such extension will be included in the
2711 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2712 SSL_CTX_npn_advertised_cb_func cb,
2715 ctx->ext.npn_advertised_cb = cb;
2716 ctx->ext.npn_advertised_cb_arg = arg;
2720 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2721 * client needs to select a protocol from the server's provided list. |out|
2722 * must be set to point to the selected protocol (which may be within |in|).
2723 * The length of the protocol name must be written into |outlen|. The
2724 * server's advertised protocols are provided in |in| and |inlen|. The
2725 * callback can assume that |in| is syntactically valid. The client must
2726 * select a protocol. It is fatal to the connection if this callback returns
2727 * a value other than SSL_TLSEXT_ERR_OK.
2729 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2730 SSL_CTX_npn_select_cb_func cb,
2733 ctx->ext.npn_select_cb = cb;
2734 ctx->ext.npn_select_cb_arg = arg;
2739 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2740 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2741 * length-prefixed strings). Returns 0 on success.
2743 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2744 unsigned int protos_len)
2746 OPENSSL_free(ctx->ext.alpn);
2747 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2748 if (ctx->ext.alpn == NULL) {
2749 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2752 ctx->ext.alpn_len = protos_len;
2758 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2759 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2760 * length-prefixed strings). Returns 0 on success.
2762 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2763 unsigned int protos_len)
2765 OPENSSL_free(ssl->ext.alpn);
2766 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2767 if (ssl->ext.alpn == NULL) {
2768 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2771 ssl->ext.alpn_len = protos_len;
2777 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2778 * called during ClientHello processing in order to select an ALPN protocol
2779 * from the client's list of offered protocols.
2781 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2782 SSL_CTX_alpn_select_cb_func cb,
2785 ctx->ext.alpn_select_cb = cb;
2786 ctx->ext.alpn_select_cb_arg = arg;
2790 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2791 * On return it sets |*data| to point to |*len| bytes of protocol name
2792 * (not including the leading length-prefix byte). If the server didn't
2793 * respond with a negotiated protocol then |*len| will be zero.
2795 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2800 *data = ssl->s3->alpn_selected;
2804 *len = (unsigned int)ssl->s3->alpn_selected_len;
2807 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2808 const char *label, size_t llen,
2809 const unsigned char *context, size_t contextlen,
2812 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2815 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2817 contextlen, use_context);
2820 int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
2821 const char *label, size_t llen,
2822 const unsigned char *context,
2825 if (s->version != TLS1_3_VERSION)
2828 return tls13_export_keying_material_early(s, out, olen, label, llen,
2829 context, contextlen);
2832 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2834 const unsigned char *session_id = a->session_id;
2836 unsigned char tmp_storage[4];
2838 if (a->session_id_length < sizeof(tmp_storage)) {
2839 memset(tmp_storage, 0, sizeof(tmp_storage));
2840 memcpy(tmp_storage, a->session_id, a->session_id_length);
2841 session_id = tmp_storage;
2845 ((unsigned long)session_id[0]) |
2846 ((unsigned long)session_id[1] << 8L) |
2847 ((unsigned long)session_id[2] << 16L) |
2848 ((unsigned long)session_id[3] << 24L);
2853 * NB: If this function (or indeed the hash function which uses a sort of
2854 * coarser function than this one) is changed, ensure
2855 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2856 * being able to construct an SSL_SESSION that will collide with any existing
2857 * session with a matching session ID.
2859 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2861 if (a->ssl_version != b->ssl_version)
2863 if (a->session_id_length != b->session_id_length)
2865 return memcmp(a->session_id, b->session_id, a->session_id_length);
2869 * These wrapper functions should remain rather than redeclaring
2870 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2871 * variable. The reason is that the functions aren't static, they're exposed
2875 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2877 SSL_CTX *ret = NULL;
2880 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2884 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2887 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2888 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2891 ret = OPENSSL_zalloc(sizeof(*ret));
2896 ret->min_proto_version = 0;
2897 ret->max_proto_version = 0;
2898 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2899 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2900 /* We take the system default. */
2901 ret->session_timeout = meth->get_timeout();
2902 ret->references = 1;
2903 ret->lock = CRYPTO_THREAD_lock_new();
2904 if (ret->lock == NULL) {
2905 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2909 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2910 ret->verify_mode = SSL_VERIFY_NONE;
2911 if ((ret->cert = ssl_cert_new()) == NULL)
2914 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2915 if (ret->sessions == NULL)
2917 ret->cert_store = X509_STORE_new();
2918 if (ret->cert_store == NULL)
2920 #ifndef OPENSSL_NO_CT
2921 ret->ctlog_store = CTLOG_STORE_new();
2922 if (ret->ctlog_store == NULL)
2926 if (!SSL_CTX_set_ciphersuites(ret, TLS_DEFAULT_CIPHERSUITES))
2929 if (!ssl_create_cipher_list(ret->method,
2930 ret->tls13_ciphersuites,
2931 &ret->cipher_list, &ret->cipher_list_by_id,
2932 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2933 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2934 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2938 ret->param = X509_VERIFY_PARAM_new();
2939 if (ret->param == NULL)
2942 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2943 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2946 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2947 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2951 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2954 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2957 if ((ret->ext.secure = OPENSSL_secure_zalloc(sizeof(*ret->ext.secure))) == NULL)
2960 /* No compression for DTLS */
2961 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2962 ret->comp_methods = SSL_COMP_get_compression_methods();
2964 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2965 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2967 /* Setup RFC5077 ticket keys */
2968 if ((RAND_bytes(ret->ext.tick_key_name,
2969 sizeof(ret->ext.tick_key_name)) <= 0)
2970 || (RAND_priv_bytes(ret->ext.secure->tick_hmac_key,
2971 sizeof(ret->ext.secure->tick_hmac_key)) <= 0)
2972 || (RAND_priv_bytes(ret->ext.secure->tick_aes_key,
2973 sizeof(ret->ext.secure->tick_aes_key)) <= 0))
2974 ret->options |= SSL_OP_NO_TICKET;
2976 if (RAND_priv_bytes(ret->ext.cookie_hmac_key,
2977 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2980 #ifndef OPENSSL_NO_SRP
2981 if (!SSL_CTX_SRP_CTX_init(ret))
2984 #ifndef OPENSSL_NO_ENGINE
2985 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2986 # define eng_strx(x) #x
2987 # define eng_str(x) eng_strx(x)
2988 /* Use specific client engine automatically... ignore errors */
2991 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2994 ENGINE_load_builtin_engines();
2995 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2997 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
3003 * Default is to connect to non-RI servers. When RI is more widely
3004 * deployed might change this.
3006 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
3008 * Disable compression by default to prevent CRIME. Applications can
3009 * re-enable compression by configuring
3010 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
3011 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
3012 * middlebox compatibility by default. This may be disabled by default in
3013 * a later OpenSSL version.
3015 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
3017 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
3020 * We cannot usefully set a default max_early_data here (which gets
3021 * propagated in SSL_new(), for the following reason: setting the
3022 * SSL field causes tls_construct_stoc_early_data() to tell the
3023 * client that early data will be accepted when constructing a TLS 1.3
3024 * session ticket, and the client will accordingly send us early data
3025 * when using that ticket (if the client has early data to send).
3026 * However, in order for the early data to actually be consumed by
3027 * the application, the application must also have calls to
3028 * SSL_read_early_data(); otherwise we'll just skip past the early data
3029 * and ignore it. So, since the application must add calls to
3030 * SSL_read_early_data(), we also require them to add
3031 * calls to SSL_CTX_set_max_early_data() in order to use early data,
3032 * eliminating the bandwidth-wasting early data in the case described
3035 ret->max_early_data = 0;
3037 /* By default we send one session ticket automatically in TLSv1.3 */
3038 ret->num_tickets = 1;
3040 ssl_ctx_system_config(ret);
3044 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3050 int SSL_CTX_up_ref(SSL_CTX *ctx)
3054 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3057 REF_PRINT_COUNT("SSL_CTX", ctx);
3058 REF_ASSERT_ISNT(i < 2);
3059 return ((i > 1) ? 1 : 0);
3062 void SSL_CTX_free(SSL_CTX *a)
3069 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3070 REF_PRINT_COUNT("SSL_CTX", a);
3073 REF_ASSERT_ISNT(i < 0);
3075 X509_VERIFY_PARAM_free(a->param);
3076 dane_ctx_final(&a->dane);
3079 * Free internal session cache. However: the remove_cb() may reference
3080 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3081 * after the sessions were flushed.
3082 * As the ex_data handling routines might also touch the session cache,
3083 * the most secure solution seems to be: empty (flush) the cache, then
3084 * free ex_data, then finally free the cache.
3085 * (See ticket [openssl.org #212].)
3087 if (a->sessions != NULL)
3088 SSL_CTX_flush_sessions(a, 0);
3090 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3091 lh_SSL_SESSION_free(a->sessions);
3092 X509_STORE_free(a->cert_store);
3093 #ifndef OPENSSL_NO_CT
3094 CTLOG_STORE_free(a->ctlog_store);
3096 sk_SSL_CIPHER_free(a->cipher_list);
3097 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3098 sk_SSL_CIPHER_free(a->tls13_ciphersuites);
3099 ssl_cert_free(a->cert);
3100 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3101 sk_X509_pop_free(a->extra_certs, X509_free);
3102 a->comp_methods = NULL;
3103 #ifndef OPENSSL_NO_SRTP
3104 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3106 #ifndef OPENSSL_NO_SRP
3107 SSL_CTX_SRP_CTX_free(a);
3109 #ifndef OPENSSL_NO_ENGINE
3110 ENGINE_finish(a->client_cert_engine);
3113 #ifndef OPENSSL_NO_EC
3114 OPENSSL_free(a->ext.ecpointformats);
3115 OPENSSL_free(a->ext.supportedgroups);
3117 OPENSSL_free(a->ext.alpn);
3118 OPENSSL_secure_free(a->ext.secure);
3120 CRYPTO_THREAD_lock_free(a->lock);
3125 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3127 ctx->default_passwd_callback = cb;
3130 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3132 ctx->default_passwd_callback_userdata = u;
3135 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3137 return ctx->default_passwd_callback;
3140 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3142 return ctx->default_passwd_callback_userdata;
3145 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3147 s->default_passwd_callback = cb;
3150 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3152 s->default_passwd_callback_userdata = u;
3155 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3157 return s->default_passwd_callback;
3160 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3162 return s->default_passwd_callback_userdata;
3165 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3166 int (*cb) (X509_STORE_CTX *, void *),
3169 ctx->app_verify_callback = cb;
3170 ctx->app_verify_arg = arg;
3173 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3174 int (*cb) (int, X509_STORE_CTX *))
3176 ctx->verify_mode = mode;
3177 ctx->default_verify_callback = cb;
3180 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3182 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3185 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3187 ssl_cert_set_cert_cb(c->cert, cb, arg);
3190 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3192 ssl_cert_set_cert_cb(s->cert, cb, arg);
3195 void ssl_set_masks(SSL *s)
3198 uint32_t *pvalid = s->s3->tmp.valid_flags;
3199 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3200 unsigned long mask_k, mask_a;
3201 #ifndef OPENSSL_NO_EC
3202 int have_ecc_cert, ecdsa_ok;
3207 #ifndef OPENSSL_NO_DH
3208 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3213 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3214 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3215 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3216 #ifndef OPENSSL_NO_EC
3217 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3223 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3224 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3227 #ifndef OPENSSL_NO_GOST
3228 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3229 mask_k |= SSL_kGOST;
3230 mask_a |= SSL_aGOST12;
3232 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3233 mask_k |= SSL_kGOST;
3234 mask_a |= SSL_aGOST12;
3236 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3237 mask_k |= SSL_kGOST;
3238 mask_a |= SSL_aGOST01;
3249 * If we only have an RSA-PSS certificate allow RSA authentication
3250 * if TLS 1.2 and peer supports it.
3253 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3254 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3255 && TLS1_get_version(s) == TLS1_2_VERSION))
3262 mask_a |= SSL_aNULL;
3265 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3266 * depending on the key usage extension.
3268 #ifndef OPENSSL_NO_EC
3269 if (have_ecc_cert) {
3271 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3272 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3273 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3276 mask_a |= SSL_aECDSA;
3278 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3279 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3280 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3281 && TLS1_get_version(s) == TLS1_2_VERSION)
3282 mask_a |= SSL_aECDSA;
3284 /* Allow Ed448 for TLS 1.2 if peer supports it */
3285 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED448)
3286 && pvalid[SSL_PKEY_ED448] & CERT_PKEY_EXPLICIT_SIGN
3287 && TLS1_get_version(s) == TLS1_2_VERSION)
3288 mask_a |= SSL_aECDSA;
3291 #ifndef OPENSSL_NO_EC
3292 mask_k |= SSL_kECDHE;
3295 #ifndef OPENSSL_NO_PSK
3298 if (mask_k & SSL_kRSA)
3299 mask_k |= SSL_kRSAPSK;
3300 if (mask_k & SSL_kDHE)
3301 mask_k |= SSL_kDHEPSK;
3302 if (mask_k & SSL_kECDHE)
3303 mask_k |= SSL_kECDHEPSK;
3306 s->s3->tmp.mask_k = mask_k;
3307 s->s3->tmp.mask_a = mask_a;
3310 #ifndef OPENSSL_NO_EC
3312 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3314 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3315 /* key usage, if present, must allow signing */
3316 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3317 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3318 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3322 return 1; /* all checks are ok */
3327 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3328 size_t *serverinfo_length)
3330 CERT_PKEY *cpk = s->s3->tmp.cert;
3331 *serverinfo_length = 0;
3333 if (cpk == NULL || cpk->serverinfo == NULL)
3336 *serverinfo = cpk->serverinfo;
3337 *serverinfo_length = cpk->serverinfo_length;
3341 void ssl_update_cache(SSL *s, int mode)
3346 * If the session_id_length is 0, we are not supposed to cache it, and it
3347 * would be rather hard to do anyway :-)
3349 if (s->session->session_id_length == 0)
3353 * If sid_ctx_length is 0 there is no specific application context
3354 * associated with this session, so when we try to resume it and
3355 * SSL_VERIFY_PEER is requested to verify the client identity, we have no
3356 * indication that this is actually a session for the proper application
3357 * context, and the *handshake* will fail, not just the resumption attempt.
3358 * Do not cache (on the server) these sessions that are not resumable
3359 * (clients can set SSL_VERIFY_PEER without needing a sid_ctx set).
3361 if (s->server && s->session->sid_ctx_length == 0
3362 && (s->verify_mode & SSL_VERIFY_PEER) != 0)
3365 i = s->session_ctx->session_cache_mode;
3367 && (!s->hit || SSL_IS_TLS13(s))
3368 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) != 0
3369 || SSL_CTX_add_session(s->session_ctx, s->session))
3370 && s->session_ctx->new_session_cb != NULL) {
3371 SSL_SESSION_up_ref(s->session);
3372 if (!s->session_ctx->new_session_cb(s, s->session))
3373 SSL_SESSION_free(s->session);
3376 /* auto flush every 255 connections */
3377 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3379 if (mode & SSL_SESS_CACHE_CLIENT)
3380 stat = &s->session_ctx->stats.sess_connect_good;
3382 stat = &s->session_ctx->stats.sess_accept_good;
3383 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3384 && (val & 0xff) == 0xff)
3385 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3389 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3394 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3399 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3403 if (s->method != meth) {
3404 const SSL_METHOD *sm = s->method;
3405 int (*hf) (SSL *) = s->handshake_func;
3407 if (sm->version == meth->version)
3412 ret = s->method->ssl_new(s);
3415 if (hf == sm->ssl_connect)
3416 s->handshake_func = meth->ssl_connect;
3417 else if (hf == sm->ssl_accept)
3418 s->handshake_func = meth->ssl_accept;
3423 int SSL_get_error(const SSL *s, int i)
3430 return SSL_ERROR_NONE;
3433 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3434 * where we do encode the error
3436 if ((l = ERR_peek_error()) != 0) {
3437 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3438 return SSL_ERROR_SYSCALL;
3440 return SSL_ERROR_SSL;
3443 if (SSL_want_read(s)) {
3444 bio = SSL_get_rbio(s);
3445 if (BIO_should_read(bio))
3446 return SSL_ERROR_WANT_READ;
3447 else if (BIO_should_write(bio))
3449 * This one doesn't make too much sense ... We never try to write
3450 * to the rbio, and an application program where rbio and wbio
3451 * are separate couldn't even know what it should wait for.
3452 * However if we ever set s->rwstate incorrectly (so that we have
3453 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3454 * wbio *are* the same, this test works around that bug; so it
3455 * might be safer to keep it.
3457 return SSL_ERROR_WANT_WRITE;
3458 else if (BIO_should_io_special(bio)) {
3459 reason = BIO_get_retry_reason(bio);
3460 if (reason == BIO_RR_CONNECT)
3461 return SSL_ERROR_WANT_CONNECT;
3462 else if (reason == BIO_RR_ACCEPT)
3463 return SSL_ERROR_WANT_ACCEPT;
3465 return SSL_ERROR_SYSCALL; /* unknown */
3469 if (SSL_want_write(s)) {
3470 /* Access wbio directly - in order to use the buffered bio if present */
3472 if (BIO_should_write(bio))
3473 return SSL_ERROR_WANT_WRITE;
3474 else if (BIO_should_read(bio))
3476 * See above (SSL_want_read(s) with BIO_should_write(bio))
3478 return SSL_ERROR_WANT_READ;
3479 else if (BIO_should_io_special(bio)) {
3480 reason = BIO_get_retry_reason(bio);
3481 if (reason == BIO_RR_CONNECT)
3482 return SSL_ERROR_WANT_CONNECT;
3483 else if (reason == BIO_RR_ACCEPT)
3484 return SSL_ERROR_WANT_ACCEPT;
3486 return SSL_ERROR_SYSCALL;
3489 if (SSL_want_x509_lookup(s))
3490 return SSL_ERROR_WANT_X509_LOOKUP;
3491 if (SSL_want_async(s))
3492 return SSL_ERROR_WANT_ASYNC;
3493 if (SSL_want_async_job(s))
3494 return SSL_ERROR_WANT_ASYNC_JOB;
3495 if (SSL_want_client_hello_cb(s))
3496 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3498 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3499 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3500 return SSL_ERROR_ZERO_RETURN;
3502 return SSL_ERROR_SYSCALL;
3505 static int ssl_do_handshake_intern(void *vargs)
3507 struct ssl_async_args *args;
3510 args = (struct ssl_async_args *)vargs;
3513 return s->handshake_func(s);
3516 int SSL_do_handshake(SSL *s)
3520 if (s->handshake_func == NULL) {
3521 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3525 ossl_statem_check_finish_init(s, -1);
3527 s->method->ssl_renegotiate_check(s, 0);
3529 if (SSL_is_server(s)) {
3530 /* clear SNI settings at server-side */
3531 OPENSSL_free(s->ext.hostname);
3532 s->ext.hostname = NULL;
3535 if (SSL_in_init(s) || SSL_in_before(s)) {
3536 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3537 struct ssl_async_args args;
3541 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3543 ret = s->handshake_func(s);
3549 void SSL_set_accept_state(SSL *s)
3553 ossl_statem_clear(s);
3554 s->handshake_func = s->method->ssl_accept;
3558 void SSL_set_connect_state(SSL *s)
3562 ossl_statem_clear(s);
3563 s->handshake_func = s->method->ssl_connect;
3567 int ssl_undefined_function(SSL *s)
3569 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3573 int ssl_undefined_void_function(void)
3575 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3576 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3580 int ssl_undefined_const_function(const SSL *s)
3585 const SSL_METHOD *ssl_bad_method(int ver)
3587 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3591 const char *ssl_protocol_to_string(int version)
3595 case TLS1_3_VERSION:
3598 case TLS1_2_VERSION:
3601 case TLS1_1_VERSION:
3616 case DTLS1_2_VERSION:
3624 const char *SSL_get_version(const SSL *s)
3626 return ssl_protocol_to_string(s->version);
3629 SSL *SSL_dup(SSL *s)
3631 STACK_OF(X509_NAME) *sk;
3636 /* If we're not quiescent, just up_ref! */
3637 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3638 CRYPTO_UP_REF(&s->references, &i, s->lock);
3643 * Otherwise, copy configuration state, and session if set.
3645 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3648 if (s->session != NULL) {
3650 * Arranges to share the same session via up_ref. This "copies"
3651 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3653 if (!SSL_copy_session_id(ret, s))
3657 * No session has been established yet, so we have to expect that
3658 * s->cert or ret->cert will be changed later -- they should not both
3659 * point to the same object, and thus we can't use
3660 * SSL_copy_session_id.
3662 if (!SSL_set_ssl_method(ret, s->method))
3665 if (s->cert != NULL) {
3666 ssl_cert_free(ret->cert);
3667 ret->cert = ssl_cert_dup(s->cert);
3668 if (ret->cert == NULL)
3672 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3673 (int)s->sid_ctx_length))
3677 if (!ssl_dane_dup(ret, s))
3679 ret->version = s->version;
3680 ret->options = s->options;
3681 ret->mode = s->mode;
3682 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3683 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3684 ret->msg_callback = s->msg_callback;
3685 ret->msg_callback_arg = s->msg_callback_arg;
3686 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3687 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3688 ret->generate_session_id = s->generate_session_id;
3690 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3692 /* copy app data, a little dangerous perhaps */
3693 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3696 /* setup rbio, and wbio */
3697 if (s->rbio != NULL) {
3698 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3701 if (s->wbio != NULL) {
3702 if (s->wbio != s->rbio) {
3703 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3706 BIO_up_ref(ret->rbio);
3707 ret->wbio = ret->rbio;
3711 ret->server = s->server;
3712 if (s->handshake_func) {
3714 SSL_set_accept_state(ret);
3716 SSL_set_connect_state(ret);
3718 ret->shutdown = s->shutdown;
3721 ret->default_passwd_callback = s->default_passwd_callback;
3722 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3724 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3726 /* dup the cipher_list and cipher_list_by_id stacks */
3727 if (s->cipher_list != NULL) {
3728 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3731 if (s->cipher_list_by_id != NULL)
3732 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3736 /* Dup the client_CA list */
3737 if (s->ca_names != NULL) {
3738 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3741 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3742 xn = sk_X509_NAME_value(sk, i);
3743 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3756 void ssl_clear_cipher_ctx(SSL *s)
3758 if (s->enc_read_ctx != NULL) {
3759 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3760 s->enc_read_ctx = NULL;
3762 if (s->enc_write_ctx != NULL) {
3763 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3764 s->enc_write_ctx = NULL;
3766 #ifndef OPENSSL_NO_COMP
3767 COMP_CTX_free(s->expand);
3769 COMP_CTX_free(s->compress);
3774 X509 *SSL_get_certificate(const SSL *s)
3776 if (s->cert != NULL)
3777 return s->cert->key->x509;
3782 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3784 if (s->cert != NULL)
3785 return s->cert->key->privatekey;
3790 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3792 if (ctx->cert != NULL)
3793 return ctx->cert->key->x509;
3798 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3800 if (ctx->cert != NULL)
3801 return ctx->cert->key->privatekey;
3806 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3808 if ((s->session != NULL) && (s->session->cipher != NULL))
3809 return s->session->cipher;
3813 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3815 return s->s3->tmp.new_cipher;
3818 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3820 #ifndef OPENSSL_NO_COMP
3821 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3827 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3829 #ifndef OPENSSL_NO_COMP
3830 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3836 int ssl_init_wbio_buffer(SSL *s)
3840 if (s->bbio != NULL) {
3841 /* Already buffered. */
3845 bbio = BIO_new(BIO_f_buffer());
3846 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3848 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3852 s->wbio = BIO_push(bbio, s->wbio);
3857 int ssl_free_wbio_buffer(SSL *s)
3859 /* callers ensure s is never null */
3860 if (s->bbio == NULL)
3863 s->wbio = BIO_pop(s->wbio);