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/ocsp.h>
18 #include <openssl/dh.h>
19 #include <openssl/engine.h>
20 #include <openssl/async.h>
21 #include <openssl/ct.h>
22 #include "internal/cryptlib.h"
23 #include "internal/rand.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, &(ctx->cipher_list),
657 &(ctx->cipher_list_by_id),
658 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
659 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
660 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
666 SSL *SSL_new(SSL_CTX *ctx)
671 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
674 if (ctx->method == NULL) {
675 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
679 s = OPENSSL_zalloc(sizeof(*s));
684 s->lock = CRYPTO_THREAD_lock_new();
685 if (s->lock == NULL) {
692 * If not using the standard RAND (say for fuzzing), then don't use a
695 if (RAND_get_rand_method() == RAND_OpenSSL()) {
697 RAND_DRBG_new(RAND_DRBG_NID, RAND_DRBG_FLAG_CTR_USE_DF,
698 RAND_DRBG_get0_public());
700 || RAND_DRBG_instantiate(s->drbg,
701 (const unsigned char *) SSL_version_str,
702 sizeof(SSL_version_str) - 1) == 0)
706 RECORD_LAYER_init(&s->rlayer, s);
708 s->options = ctx->options;
709 s->dane.flags = ctx->dane.flags;
710 s->min_proto_version = ctx->min_proto_version;
711 s->max_proto_version = ctx->max_proto_version;
713 s->max_cert_list = ctx->max_cert_list;
714 s->max_early_data = ctx->max_early_data;
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 if (!s->method->ssl_new(s))
817 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
822 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
825 #ifndef OPENSSL_NO_PSK
826 s->psk_client_callback = ctx->psk_client_callback;
827 s->psk_server_callback = ctx->psk_server_callback;
829 s->psk_find_session_cb = ctx->psk_find_session_cb;
830 s->psk_use_session_cb = ctx->psk_use_session_cb;
834 #ifndef OPENSSL_NO_CT
835 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
836 ctx->ct_validation_callback_arg))
843 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
847 int SSL_is_dtls(const SSL *s)
849 return SSL_IS_DTLS(s) ? 1 : 0;
852 int SSL_up_ref(SSL *s)
856 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
859 REF_PRINT_COUNT("SSL", s);
860 REF_ASSERT_ISNT(i < 2);
861 return ((i > 1) ? 1 : 0);
864 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
865 unsigned int sid_ctx_len)
867 if (sid_ctx_len > sizeof(ctx->sid_ctx)) {
868 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
869 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
872 ctx->sid_ctx_length = sid_ctx_len;
873 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
878 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
879 unsigned int sid_ctx_len)
881 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
882 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
883 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
886 ssl->sid_ctx_length = sid_ctx_len;
887 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
892 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
894 CRYPTO_THREAD_write_lock(ctx->lock);
895 ctx->generate_session_id = cb;
896 CRYPTO_THREAD_unlock(ctx->lock);
900 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
902 CRYPTO_THREAD_write_lock(ssl->lock);
903 ssl->generate_session_id = cb;
904 CRYPTO_THREAD_unlock(ssl->lock);
908 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
912 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
913 * we can "construct" a session to give us the desired check - i.e. to
914 * find if there's a session in the hash table that would conflict with
915 * any new session built out of this id/id_len and the ssl_version in use
920 if (id_len > sizeof(r.session_id))
923 r.ssl_version = ssl->version;
924 r.session_id_length = id_len;
925 memcpy(r.session_id, id, id_len);
927 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
928 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
929 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
933 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
935 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
938 int SSL_set_purpose(SSL *s, int purpose)
940 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
943 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
945 return X509_VERIFY_PARAM_set_trust(s->param, trust);
948 int SSL_set_trust(SSL *s, int trust)
950 return X509_VERIFY_PARAM_set_trust(s->param, trust);
953 int SSL_set1_host(SSL *s, const char *hostname)
955 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
958 int SSL_add1_host(SSL *s, const char *hostname)
960 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
963 void SSL_set_hostflags(SSL *s, unsigned int flags)
965 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
968 const char *SSL_get0_peername(SSL *s)
970 return X509_VERIFY_PARAM_get0_peername(s->param);
973 int SSL_CTX_dane_enable(SSL_CTX *ctx)
975 return dane_ctx_enable(&ctx->dane);
978 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
980 unsigned long orig = ctx->dane.flags;
982 ctx->dane.flags |= flags;
986 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
988 unsigned long orig = ctx->dane.flags;
990 ctx->dane.flags &= ~flags;
994 int SSL_dane_enable(SSL *s, const char *basedomain)
996 SSL_DANE *dane = &s->dane;
998 if (s->ctx->dane.mdmax == 0) {
999 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
1002 if (dane->trecs != NULL) {
1003 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
1008 * Default SNI name. This rejects empty names, while set1_host below
1009 * accepts them and disables host name checks. To avoid side-effects with
1010 * invalid input, set the SNI name first.
1012 if (s->ext.hostname == NULL) {
1013 if (!SSL_set_tlsext_host_name(s, basedomain)) {
1014 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1019 /* Primary RFC6125 reference identifier */
1020 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
1021 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
1027 dane->dctx = &s->ctx->dane;
1028 dane->trecs = sk_danetls_record_new_null();
1030 if (dane->trecs == NULL) {
1031 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
1037 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
1039 unsigned long orig = ssl->dane.flags;
1041 ssl->dane.flags |= flags;
1045 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
1047 unsigned long orig = ssl->dane.flags;
1049 ssl->dane.flags &= ~flags;
1053 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
1055 SSL_DANE *dane = &s->dane;
1057 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1061 *mcert = dane->mcert;
1063 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
1068 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1069 uint8_t *mtype, unsigned const char **data, size_t *dlen)
1071 SSL_DANE *dane = &s->dane;
1073 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
1077 *usage = dane->mtlsa->usage;
1079 *selector = dane->mtlsa->selector;
1081 *mtype = dane->mtlsa->mtype;
1083 *data = dane->mtlsa->data;
1085 *dlen = dane->mtlsa->dlen;
1090 SSL_DANE *SSL_get0_dane(SSL *s)
1095 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1096 uint8_t mtype, unsigned const char *data, size_t dlen)
1098 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
1101 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
1104 return dane_mtype_set(&ctx->dane, md, mtype, ord);
1107 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
1109 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
1112 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
1114 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
1117 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
1122 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
1127 void SSL_certs_clear(SSL *s)
1129 ssl_cert_clear_certs(s->cert);
1132 void SSL_free(SSL *s)
1139 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
1140 REF_PRINT_COUNT("SSL", s);
1143 REF_ASSERT_ISNT(i < 0);
1145 X509_VERIFY_PARAM_free(s->param);
1146 dane_final(&s->dane);
1147 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
1149 /* Ignore return value */
1150 ssl_free_wbio_buffer(s);
1152 BIO_free_all(s->wbio);
1153 BIO_free_all(s->rbio);
1155 BUF_MEM_free(s->init_buf);
1157 /* add extra stuff */
1158 sk_SSL_CIPHER_free(s->cipher_list);
1159 sk_SSL_CIPHER_free(s->cipher_list_by_id);
1161 /* Make the next call work :-) */
1162 if (s->session != NULL) {
1163 ssl_clear_bad_session(s);
1164 SSL_SESSION_free(s->session);
1166 SSL_SESSION_free(s->psksession);
1167 OPENSSL_free(s->psksession_id);
1171 ssl_cert_free(s->cert);
1172 /* Free up if allocated */
1174 OPENSSL_free(s->ext.hostname);
1175 SSL_CTX_free(s->session_ctx);
1176 #ifndef OPENSSL_NO_EC
1177 OPENSSL_free(s->ext.ecpointformats);
1178 OPENSSL_free(s->ext.supportedgroups);
1179 #endif /* OPENSSL_NO_EC */
1180 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1181 #ifndef OPENSSL_NO_OCSP
1182 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1184 #ifndef OPENSSL_NO_CT
1185 SCT_LIST_free(s->scts);
1186 OPENSSL_free(s->ext.scts);
1188 OPENSSL_free(s->ext.ocsp.resp);
1189 OPENSSL_free(s->ext.alpn);
1190 OPENSSL_free(s->ext.tls13_cookie);
1191 OPENSSL_free(s->clienthello);
1192 OPENSSL_free(s->pha_context);
1193 EVP_MD_CTX_free(s->pha_dgst);
1195 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1197 sk_X509_pop_free(s->verified_chain, X509_free);
1199 if (s->method != NULL)
1200 s->method->ssl_free(s);
1202 RECORD_LAYER_release(&s->rlayer);
1204 SSL_CTX_free(s->ctx);
1206 ASYNC_WAIT_CTX_free(s->waitctx);
1208 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1209 OPENSSL_free(s->ext.npn);
1212 #ifndef OPENSSL_NO_SRTP
1213 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1216 RAND_DRBG_free(s->drbg);
1217 CRYPTO_THREAD_lock_free(s->lock);
1222 void SSL_set0_rbio(SSL *s, BIO *rbio)
1224 BIO_free_all(s->rbio);
1228 void SSL_set0_wbio(SSL *s, BIO *wbio)
1231 * If the output buffering BIO is still in place, remove it
1233 if (s->bbio != NULL)
1234 s->wbio = BIO_pop(s->wbio);
1236 BIO_free_all(s->wbio);
1239 /* Re-attach |bbio| to the new |wbio|. */
1240 if (s->bbio != NULL)
1241 s->wbio = BIO_push(s->bbio, s->wbio);
1244 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1247 * For historical reasons, this function has many different cases in
1248 * ownership handling.
1251 /* If nothing has changed, do nothing */
1252 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1256 * If the two arguments are equal then one fewer reference is granted by the
1257 * caller than we want to take
1259 if (rbio != NULL && rbio == wbio)
1263 * If only the wbio is changed only adopt one reference.
1265 if (rbio == SSL_get_rbio(s)) {
1266 SSL_set0_wbio(s, wbio);
1270 * There is an asymmetry here for historical reasons. If only the rbio is
1271 * changed AND the rbio and wbio were originally different, then we only
1272 * adopt one reference.
1274 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1275 SSL_set0_rbio(s, rbio);
1279 /* Otherwise, adopt both references. */
1280 SSL_set0_rbio(s, rbio);
1281 SSL_set0_wbio(s, wbio);
1284 BIO *SSL_get_rbio(const SSL *s)
1289 BIO *SSL_get_wbio(const SSL *s)
1291 if (s->bbio != NULL) {
1293 * If |bbio| is active, the true caller-configured BIO is its
1296 return BIO_next(s->bbio);
1301 int SSL_get_fd(const SSL *s)
1303 return SSL_get_rfd(s);
1306 int SSL_get_rfd(const SSL *s)
1311 b = SSL_get_rbio(s);
1312 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1314 BIO_get_fd(r, &ret);
1318 int SSL_get_wfd(const SSL *s)
1323 b = SSL_get_wbio(s);
1324 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1326 BIO_get_fd(r, &ret);
1330 #ifndef OPENSSL_NO_SOCK
1331 int SSL_set_fd(SSL *s, int fd)
1336 bio = BIO_new(BIO_s_socket());
1339 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1342 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1343 SSL_set_bio(s, bio, bio);
1349 int SSL_set_wfd(SSL *s, int fd)
1351 BIO *rbio = SSL_get_rbio(s);
1353 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1354 || (int)BIO_get_fd(rbio, NULL) != fd) {
1355 BIO *bio = BIO_new(BIO_s_socket());
1358 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1361 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1362 SSL_set0_wbio(s, bio);
1365 SSL_set0_wbio(s, rbio);
1370 int SSL_set_rfd(SSL *s, int fd)
1372 BIO *wbio = SSL_get_wbio(s);
1374 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1375 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1376 BIO *bio = BIO_new(BIO_s_socket());
1379 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1382 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1383 SSL_set0_rbio(s, bio);
1386 SSL_set0_rbio(s, wbio);
1393 /* return length of latest Finished message we sent, copy to 'buf' */
1394 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1398 if (s->s3 != NULL) {
1399 ret = s->s3->tmp.finish_md_len;
1402 memcpy(buf, s->s3->tmp.finish_md, count);
1407 /* return length of latest Finished message we expected, copy to 'buf' */
1408 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1412 if (s->s3 != NULL) {
1413 ret = s->s3->tmp.peer_finish_md_len;
1416 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1421 int SSL_get_verify_mode(const SSL *s)
1423 return s->verify_mode;
1426 int SSL_get_verify_depth(const SSL *s)
1428 return X509_VERIFY_PARAM_get_depth(s->param);
1431 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1432 return s->verify_callback;
1435 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1437 return ctx->verify_mode;
1440 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1442 return X509_VERIFY_PARAM_get_depth(ctx->param);
1445 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1446 return ctx->default_verify_callback;
1449 void SSL_set_verify(SSL *s, int mode,
1450 int (*callback) (int ok, X509_STORE_CTX *ctx))
1452 s->verify_mode = mode;
1453 if (callback != NULL)
1454 s->verify_callback = callback;
1457 void SSL_set_verify_depth(SSL *s, int depth)
1459 X509_VERIFY_PARAM_set_depth(s->param, depth);
1462 void SSL_set_read_ahead(SSL *s, int yes)
1464 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1467 int SSL_get_read_ahead(const SSL *s)
1469 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1472 int SSL_pending(const SSL *s)
1474 size_t pending = s->method->ssl_pending(s);
1477 * SSL_pending cannot work properly if read-ahead is enabled
1478 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1479 * impossible to fix since SSL_pending cannot report errors that may be
1480 * observed while scanning the new data. (Note that SSL_pending() is
1481 * often used as a boolean value, so we'd better not return -1.)
1483 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1484 * we just return INT_MAX.
1486 return pending < INT_MAX ? (int)pending : INT_MAX;
1489 int SSL_has_pending(const SSL *s)
1492 * Similar to SSL_pending() but returns a 1 to indicate that we have
1493 * unprocessed data available or 0 otherwise (as opposed to the number of
1494 * bytes available). Unlike SSL_pending() this will take into account
1495 * read_ahead data. A 1 return simply indicates that we have unprocessed
1496 * data. That data may not result in any application data, or we may fail
1497 * to parse the records for some reason.
1499 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1502 return RECORD_LAYER_read_pending(&s->rlayer);
1505 X509 *SSL_get_peer_certificate(const SSL *s)
1509 if ((s == NULL) || (s->session == NULL))
1512 r = s->session->peer;
1522 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1526 if ((s == NULL) || (s->session == NULL))
1529 r = s->session->peer_chain;
1532 * If we are a client, cert_chain includes the peer's own certificate; if
1533 * we are a server, it does not.
1540 * Now in theory, since the calling process own 't' it should be safe to
1541 * modify. We need to be able to read f without being hassled
1543 int SSL_copy_session_id(SSL *t, const SSL *f)
1546 /* Do we need to to SSL locking? */
1547 if (!SSL_set_session(t, SSL_get_session(f))) {
1552 * what if we are setup for one protocol version but want to talk another
1554 if (t->method != f->method) {
1555 t->method->ssl_free(t);
1556 t->method = f->method;
1557 if (t->method->ssl_new(t) == 0)
1561 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1562 ssl_cert_free(t->cert);
1564 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1571 /* Fix this so it checks all the valid key/cert options */
1572 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1574 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1575 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1578 if (ctx->cert->key->privatekey == NULL) {
1579 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1582 return X509_check_private_key
1583 (ctx->cert->key->x509, ctx->cert->key->privatekey);
1586 /* Fix this function so that it takes an optional type parameter */
1587 int SSL_check_private_key(const SSL *ssl)
1590 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1593 if (ssl->cert->key->x509 == NULL) {
1594 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1597 if (ssl->cert->key->privatekey == NULL) {
1598 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1601 return X509_check_private_key(ssl->cert->key->x509,
1602 ssl->cert->key->privatekey);
1605 int SSL_waiting_for_async(SSL *s)
1613 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1615 ASYNC_WAIT_CTX *ctx = s->waitctx;
1619 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1622 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1623 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1625 ASYNC_WAIT_CTX *ctx = s->waitctx;
1629 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1633 int SSL_accept(SSL *s)
1635 if (s->handshake_func == NULL) {
1636 /* Not properly initialized yet */
1637 SSL_set_accept_state(s);
1640 return SSL_do_handshake(s);
1643 int SSL_connect(SSL *s)
1645 if (s->handshake_func == NULL) {
1646 /* Not properly initialized yet */
1647 SSL_set_connect_state(s);
1650 return SSL_do_handshake(s);
1653 long SSL_get_default_timeout(const SSL *s)
1655 return s->method->get_timeout();
1658 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1659 int (*func) (void *))
1662 if (s->waitctx == NULL) {
1663 s->waitctx = ASYNC_WAIT_CTX_new();
1664 if (s->waitctx == NULL)
1667 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1668 sizeof(struct ssl_async_args))) {
1670 s->rwstate = SSL_NOTHING;
1671 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1674 s->rwstate = SSL_ASYNC_PAUSED;
1677 s->rwstate = SSL_ASYNC_NO_JOBS;
1683 s->rwstate = SSL_NOTHING;
1684 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1685 /* Shouldn't happen */
1690 static int ssl_io_intern(void *vargs)
1692 struct ssl_async_args *args;
1697 args = (struct ssl_async_args *)vargs;
1701 switch (args->type) {
1703 return args->f.func_read(s, buf, num, &s->asyncrw);
1705 return args->f.func_write(s, buf, num, &s->asyncrw);
1707 return args->f.func_other(s);
1712 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1714 if (s->handshake_func == NULL) {
1715 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1719 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1720 s->rwstate = SSL_NOTHING;
1724 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1725 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1726 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1730 * If we are a client and haven't received the ServerHello etc then we
1733 ossl_statem_check_finish_init(s, 0);
1735 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1736 struct ssl_async_args args;
1742 args.type = READFUNC;
1743 args.f.func_read = s->method->ssl_read;
1745 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1746 *readbytes = s->asyncrw;
1749 return s->method->ssl_read(s, buf, num, readbytes);
1753 int SSL_read(SSL *s, void *buf, int num)
1759 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1763 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1766 * The cast is safe here because ret should be <= INT_MAX because num is
1770 ret = (int)readbytes;
1775 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1777 int ret = ssl_read_internal(s, buf, num, readbytes);
1784 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1789 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1790 return SSL_READ_EARLY_DATA_ERROR;
1793 switch (s->early_data_state) {
1794 case SSL_EARLY_DATA_NONE:
1795 if (!SSL_in_before(s)) {
1796 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1797 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1798 return SSL_READ_EARLY_DATA_ERROR;
1802 case SSL_EARLY_DATA_ACCEPT_RETRY:
1803 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1804 ret = SSL_accept(s);
1807 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1808 return SSL_READ_EARLY_DATA_ERROR;
1812 case SSL_EARLY_DATA_READ_RETRY:
1813 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1814 s->early_data_state = SSL_EARLY_DATA_READING;
1815 ret = SSL_read_ex(s, buf, num, readbytes);
1817 * State machine will update early_data_state to
1818 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1821 if (ret > 0 || (ret <= 0 && s->early_data_state
1822 != SSL_EARLY_DATA_FINISHED_READING)) {
1823 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1824 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1825 : SSL_READ_EARLY_DATA_ERROR;
1828 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1831 return SSL_READ_EARLY_DATA_FINISH;
1834 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1835 return SSL_READ_EARLY_DATA_ERROR;
1839 int SSL_get_early_data_status(const SSL *s)
1841 return s->ext.early_data;
1844 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1846 if (s->handshake_func == NULL) {
1847 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1851 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1854 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1855 struct ssl_async_args args;
1861 args.type = READFUNC;
1862 args.f.func_read = s->method->ssl_peek;
1864 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1865 *readbytes = s->asyncrw;
1868 return s->method->ssl_peek(s, buf, num, readbytes);
1872 int SSL_peek(SSL *s, void *buf, int num)
1878 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1882 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1885 * The cast is safe here because ret should be <= INT_MAX because num is
1889 ret = (int)readbytes;
1895 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1897 int ret = ssl_peek_internal(s, buf, num, readbytes);
1904 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1906 if (s->handshake_func == NULL) {
1907 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1911 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1912 s->rwstate = SSL_NOTHING;
1913 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1917 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1918 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1919 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1920 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1923 /* If we are a client and haven't sent the Finished we better do that */
1924 ossl_statem_check_finish_init(s, 1);
1926 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1928 struct ssl_async_args args;
1931 args.buf = (void *)buf;
1933 args.type = WRITEFUNC;
1934 args.f.func_write = s->method->ssl_write;
1936 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1937 *written = s->asyncrw;
1940 return s->method->ssl_write(s, buf, num, written);
1944 int SSL_write(SSL *s, const void *buf, int num)
1950 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1954 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1957 * The cast is safe here because ret should be <= INT_MAX because num is
1966 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1968 int ret = ssl_write_internal(s, buf, num, written);
1975 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1977 int ret, early_data_state;
1979 uint32_t partialwrite;
1981 switch (s->early_data_state) {
1982 case SSL_EARLY_DATA_NONE:
1984 || !SSL_in_before(s)
1985 || ((s->session == NULL || s->session->ext.max_early_data == 0)
1986 && (s->psk_use_session_cb == NULL))) {
1987 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1988 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1993 case SSL_EARLY_DATA_CONNECT_RETRY:
1994 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1995 ret = SSL_connect(s);
1998 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
2003 case SSL_EARLY_DATA_WRITE_RETRY:
2004 s->early_data_state = SSL_EARLY_DATA_WRITING;
2006 * We disable partial write for early data because we don't keep track
2007 * of how many bytes we've written between the SSL_write_ex() call and
2008 * the flush if the flush needs to be retried)
2010 partialwrite = s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE;
2011 s->mode &= ~SSL_MODE_ENABLE_PARTIAL_WRITE;
2012 ret = SSL_write_ex(s, buf, num, &writtmp);
2013 s->mode |= partialwrite;
2015 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2018 s->early_data_state = SSL_EARLY_DATA_WRITE_FLUSH;
2021 case SSL_EARLY_DATA_WRITE_FLUSH:
2022 /* The buffering BIO is still in place so we need to flush it */
2023 if (statem_flush(s) != 1)
2026 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
2029 case SSL_EARLY_DATA_FINISHED_READING:
2030 case SSL_EARLY_DATA_READ_RETRY:
2031 early_data_state = s->early_data_state;
2032 /* We are a server writing to an unauthenticated client */
2033 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
2034 ret = SSL_write_ex(s, buf, num, written);
2035 s->early_data_state = early_data_state;
2039 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
2044 int SSL_shutdown(SSL *s)
2047 * Note that this function behaves differently from what one might
2048 * expect. Return values are 0 for no success (yet), 1 for success; but
2049 * calling it once is usually not enough, even if blocking I/O is used
2050 * (see ssl3_shutdown).
2053 if (s->handshake_func == NULL) {
2054 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
2058 if (!SSL_in_init(s)) {
2059 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
2060 struct ssl_async_args args;
2063 args.type = OTHERFUNC;
2064 args.f.func_other = s->method->ssl_shutdown;
2066 return ssl_start_async_job(s, &args, ssl_io_intern);
2068 return s->method->ssl_shutdown(s);
2071 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
2076 int SSL_key_update(SSL *s, int updatetype)
2079 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
2080 * negotiated, and that it is appropriate to call SSL_key_update() instead
2081 * of SSL_renegotiate().
2083 if (!SSL_IS_TLS13(s)) {
2084 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
2088 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
2089 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
2090 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
2094 if (!SSL_is_init_finished(s)) {
2095 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
2099 ossl_statem_set_in_init(s, 1);
2100 s->key_update = updatetype;
2104 int SSL_get_key_update_type(SSL *s)
2106 return s->key_update;
2109 int SSL_renegotiate(SSL *s)
2111 if (SSL_IS_TLS13(s)) {
2112 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
2116 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2117 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
2124 return s->method->ssl_renegotiate(s);
2127 int SSL_renegotiate_abbreviated(SSL *s)
2129 if (SSL_IS_TLS13(s)) {
2130 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
2134 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
2135 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
2142 return s->method->ssl_renegotiate(s);
2145 int SSL_renegotiate_pending(SSL *s)
2148 * becomes true when negotiation is requested; false again once a
2149 * handshake has finished
2151 return (s->renegotiate != 0);
2154 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
2159 case SSL_CTRL_GET_READ_AHEAD:
2160 return RECORD_LAYER_get_read_ahead(&s->rlayer);
2161 case SSL_CTRL_SET_READ_AHEAD:
2162 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2163 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2166 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2167 s->msg_callback_arg = parg;
2171 return (s->mode |= larg);
2172 case SSL_CTRL_CLEAR_MODE:
2173 return (s->mode &= ~larg);
2174 case SSL_CTRL_GET_MAX_CERT_LIST:
2175 return (long)s->max_cert_list;
2176 case SSL_CTRL_SET_MAX_CERT_LIST:
2179 l = (long)s->max_cert_list;
2180 s->max_cert_list = (size_t)larg;
2182 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2183 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2185 s->max_send_fragment = larg;
2186 if (s->max_send_fragment < s->split_send_fragment)
2187 s->split_send_fragment = s->max_send_fragment;
2189 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2190 if ((size_t)larg > s->max_send_fragment || larg == 0)
2192 s->split_send_fragment = larg;
2194 case SSL_CTRL_SET_MAX_PIPELINES:
2195 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2197 s->max_pipelines = larg;
2199 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2201 case SSL_CTRL_GET_RI_SUPPORT:
2203 return s->s3->send_connection_binding;
2206 case SSL_CTRL_CERT_FLAGS:
2207 return (s->cert->cert_flags |= larg);
2208 case SSL_CTRL_CLEAR_CERT_FLAGS:
2209 return (s->cert->cert_flags &= ~larg);
2211 case SSL_CTRL_GET_RAW_CIPHERLIST:
2213 if (s->s3->tmp.ciphers_raw == NULL)
2215 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2216 return (int)s->s3->tmp.ciphers_rawlen;
2218 return TLS_CIPHER_LEN;
2220 case SSL_CTRL_GET_EXTMS_SUPPORT:
2221 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2223 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2227 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2228 return ssl_check_allowed_versions(larg, s->max_proto_version)
2229 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2230 &s->min_proto_version);
2231 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2232 return s->min_proto_version;
2233 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2234 return ssl_check_allowed_versions(s->min_proto_version, larg)
2235 && ssl_set_version_bound(s->ctx->method->version, (int)larg,
2236 &s->max_proto_version);
2237 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2238 return s->max_proto_version;
2240 return s->method->ssl_ctrl(s, cmd, larg, parg);
2244 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2247 case SSL_CTRL_SET_MSG_CALLBACK:
2248 s->msg_callback = (void (*)
2249 (int write_p, int version, int content_type,
2250 const void *buf, size_t len, SSL *ssl,
2255 return s->method->ssl_callback_ctrl(s, cmd, fp);
2259 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2261 return ctx->sessions;
2264 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2268 /* For some cases with ctx == NULL perform syntax checks */
2271 #ifndef OPENSSL_NO_EC
2272 case SSL_CTRL_SET_GROUPS_LIST:
2273 return tls1_set_groups_list(NULL, NULL, parg);
2275 case SSL_CTRL_SET_SIGALGS_LIST:
2276 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2277 return tls1_set_sigalgs_list(NULL, parg, 0);
2284 case SSL_CTRL_GET_READ_AHEAD:
2285 return ctx->read_ahead;
2286 case SSL_CTRL_SET_READ_AHEAD:
2287 l = ctx->read_ahead;
2288 ctx->read_ahead = larg;
2291 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2292 ctx->msg_callback_arg = parg;
2295 case SSL_CTRL_GET_MAX_CERT_LIST:
2296 return (long)ctx->max_cert_list;
2297 case SSL_CTRL_SET_MAX_CERT_LIST:
2300 l = (long)ctx->max_cert_list;
2301 ctx->max_cert_list = (size_t)larg;
2304 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2307 l = (long)ctx->session_cache_size;
2308 ctx->session_cache_size = (size_t)larg;
2310 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2311 return (long)ctx->session_cache_size;
2312 case SSL_CTRL_SET_SESS_CACHE_MODE:
2313 l = ctx->session_cache_mode;
2314 ctx->session_cache_mode = larg;
2316 case SSL_CTRL_GET_SESS_CACHE_MODE:
2317 return ctx->session_cache_mode;
2319 case SSL_CTRL_SESS_NUMBER:
2320 return lh_SSL_SESSION_num_items(ctx->sessions);
2321 case SSL_CTRL_SESS_CONNECT:
2322 return CRYPTO_atomic_read(&ctx->stats.sess_connect, &i, ctx->lock)
2324 case SSL_CTRL_SESS_CONNECT_GOOD:
2325 return CRYPTO_atomic_read(&ctx->stats.sess_connect_good, &i, ctx->lock)
2327 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2328 return CRYPTO_atomic_read(&ctx->stats.sess_connect_renegotiate, &i,
2331 case SSL_CTRL_SESS_ACCEPT:
2332 return CRYPTO_atomic_read(&ctx->stats.sess_accept, &i, ctx->lock)
2334 case SSL_CTRL_SESS_ACCEPT_GOOD:
2335 return CRYPTO_atomic_read(&ctx->stats.sess_accept_good, &i, ctx->lock)
2337 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2338 return CRYPTO_atomic_read(&ctx->stats.sess_accept_renegotiate, &i,
2341 case SSL_CTRL_SESS_HIT:
2342 return CRYPTO_atomic_read(&ctx->stats.sess_hit, &i, ctx->lock)
2344 case SSL_CTRL_SESS_CB_HIT:
2345 return CRYPTO_atomic_read(&ctx->stats.sess_cb_hit, &i, ctx->lock)
2347 case SSL_CTRL_SESS_MISSES:
2348 return CRYPTO_atomic_read(&ctx->stats.sess_miss, &i, ctx->lock)
2350 case SSL_CTRL_SESS_TIMEOUTS:
2351 return CRYPTO_atomic_read(&ctx->stats.sess_timeout, &i, ctx->lock)
2353 case SSL_CTRL_SESS_CACHE_FULL:
2354 return CRYPTO_atomic_read(&ctx->stats.sess_cache_full, &i, ctx->lock)
2357 return (ctx->mode |= larg);
2358 case SSL_CTRL_CLEAR_MODE:
2359 return (ctx->mode &= ~larg);
2360 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2361 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2363 ctx->max_send_fragment = larg;
2364 if (ctx->max_send_fragment < ctx->split_send_fragment)
2365 ctx->split_send_fragment = ctx->max_send_fragment;
2367 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2368 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2370 ctx->split_send_fragment = larg;
2372 case SSL_CTRL_SET_MAX_PIPELINES:
2373 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2375 ctx->max_pipelines = larg;
2377 case SSL_CTRL_CERT_FLAGS:
2378 return (ctx->cert->cert_flags |= larg);
2379 case SSL_CTRL_CLEAR_CERT_FLAGS:
2380 return (ctx->cert->cert_flags &= ~larg);
2381 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2382 return ssl_check_allowed_versions(larg, ctx->max_proto_version)
2383 && ssl_set_version_bound(ctx->method->version, (int)larg,
2384 &ctx->min_proto_version);
2385 case SSL_CTRL_GET_MIN_PROTO_VERSION:
2386 return ctx->min_proto_version;
2387 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2388 return ssl_check_allowed_versions(ctx->min_proto_version, larg)
2389 && ssl_set_version_bound(ctx->method->version, (int)larg,
2390 &ctx->max_proto_version);
2391 case SSL_CTRL_GET_MAX_PROTO_VERSION:
2392 return ctx->max_proto_version;
2394 return ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg);
2398 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2401 case SSL_CTRL_SET_MSG_CALLBACK:
2402 ctx->msg_callback = (void (*)
2403 (int write_p, int version, int content_type,
2404 const void *buf, size_t len, SSL *ssl,
2409 return ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp);
2413 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2422 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2423 const SSL_CIPHER *const *bp)
2425 if ((*ap)->id > (*bp)->id)
2427 if ((*ap)->id < (*bp)->id)
2432 /** return a STACK of the ciphers available for the SSL and in order of
2434 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2437 if (s->cipher_list != NULL) {
2438 return s->cipher_list;
2439 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2440 return s->ctx->cipher_list;
2446 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2448 if ((s == NULL) || (s->session == NULL) || !s->server)
2450 return s->session->ciphers;
2453 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2455 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2458 ciphers = SSL_get_ciphers(s);
2461 if (!ssl_set_client_disabled(s))
2463 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2464 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2465 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2467 sk = sk_SSL_CIPHER_new_null();
2470 if (!sk_SSL_CIPHER_push(sk, c)) {
2471 sk_SSL_CIPHER_free(sk);
2479 /** return a STACK of the ciphers available for the SSL and in order of
2481 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2484 if (s->cipher_list_by_id != NULL) {
2485 return s->cipher_list_by_id;
2486 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2487 return s->ctx->cipher_list_by_id;
2493 /** The old interface to get the same thing as SSL_get_ciphers() */
2494 const char *SSL_get_cipher_list(const SSL *s, int n)
2496 const SSL_CIPHER *c;
2497 STACK_OF(SSL_CIPHER) *sk;
2501 sk = SSL_get_ciphers(s);
2502 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2504 c = sk_SSL_CIPHER_value(sk, n);
2510 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2512 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2515 return ctx->cipher_list;
2519 /** specify the ciphers to be used by default by the SSL_CTX */
2520 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2522 STACK_OF(SSL_CIPHER) *sk;
2524 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2525 &ctx->cipher_list_by_id, str, ctx->cert);
2527 * ssl_create_cipher_list may return an empty stack if it was unable to
2528 * find a cipher matching the given rule string (for example if the rule
2529 * string specifies a cipher which has been disabled). This is not an
2530 * error as far as ssl_create_cipher_list is concerned, and hence
2531 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2535 else if (sk_SSL_CIPHER_num(sk) == 0) {
2536 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2542 /** specify the ciphers to be used by the SSL */
2543 int SSL_set_cipher_list(SSL *s, const char *str)
2545 STACK_OF(SSL_CIPHER) *sk;
2547 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2548 &s->cipher_list_by_id, str, s->cert);
2549 /* see comment in SSL_CTX_set_cipher_list */
2552 else if (sk_SSL_CIPHER_num(sk) == 0) {
2553 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2559 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2562 STACK_OF(SSL_CIPHER) *sk;
2563 const SSL_CIPHER *c;
2566 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2570 sk = s->session->ciphers;
2572 if (sk_SSL_CIPHER_num(sk) == 0)
2575 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2578 c = sk_SSL_CIPHER_value(sk, i);
2579 n = strlen(c->name);
2595 /** return a servername extension value if provided in Client Hello, or NULL.
2596 * So far, only host_name types are defined (RFC 3546).
2599 const char *SSL_get_servername(const SSL *s, const int type)
2601 if (type != TLSEXT_NAMETYPE_host_name)
2604 return s->session && !s->ext.hostname ?
2605 s->session->ext.hostname : s->ext.hostname;
2608 int SSL_get_servername_type(const SSL *s)
2611 && (!s->ext.hostname ? s->session->
2612 ext.hostname : s->ext.hostname))
2613 return TLSEXT_NAMETYPE_host_name;
2618 * SSL_select_next_proto implements the standard protocol selection. It is
2619 * expected that this function is called from the callback set by
2620 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2621 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2622 * not included in the length. A byte string of length 0 is invalid. No byte
2623 * string may be truncated. The current, but experimental algorithm for
2624 * selecting the protocol is: 1) If the server doesn't support NPN then this
2625 * is indicated to the callback. In this case, the client application has to
2626 * abort the connection or have a default application level protocol. 2) If
2627 * the server supports NPN, but advertises an empty list then the client
2628 * selects the first protocol in its list, but indicates via the API that this
2629 * fallback case was enacted. 3) Otherwise, the client finds the first
2630 * protocol in the server's list that it supports and selects this protocol.
2631 * This is because it's assumed that the server has better information about
2632 * which protocol a client should use. 4) If the client doesn't support any
2633 * of the server's advertised protocols, then this is treated the same as
2634 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2635 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2637 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2638 const unsigned char *server,
2639 unsigned int server_len,
2640 const unsigned char *client, unsigned int client_len)
2643 const unsigned char *result;
2644 int status = OPENSSL_NPN_UNSUPPORTED;
2647 * For each protocol in server preference order, see if we support it.
2649 for (i = 0; i < server_len;) {
2650 for (j = 0; j < client_len;) {
2651 if (server[i] == client[j] &&
2652 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2653 /* We found a match */
2654 result = &server[i];
2655 status = OPENSSL_NPN_NEGOTIATED;
2665 /* There's no overlap between our protocols and the server's list. */
2667 status = OPENSSL_NPN_NO_OVERLAP;
2670 *out = (unsigned char *)result + 1;
2671 *outlen = result[0];
2675 #ifndef OPENSSL_NO_NEXTPROTONEG
2677 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2678 * client's requested protocol for this connection and returns 0. If the
2679 * client didn't request any protocol, then *data is set to NULL. Note that
2680 * the client can request any protocol it chooses. The value returned from
2681 * this function need not be a member of the list of supported protocols
2682 * provided by the callback.
2684 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2691 *len = (unsigned int)s->ext.npn_len;
2696 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2697 * a TLS server needs a list of supported protocols for Next Protocol
2698 * Negotiation. The returned list must be in wire format. The list is
2699 * returned by setting |out| to point to it and |outlen| to its length. This
2700 * memory will not be modified, but one should assume that the SSL* keeps a
2701 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2702 * wishes to advertise. Otherwise, no such extension will be included in the
2705 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2706 SSL_CTX_npn_advertised_cb_func cb,
2709 ctx->ext.npn_advertised_cb = cb;
2710 ctx->ext.npn_advertised_cb_arg = arg;
2714 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2715 * client needs to select a protocol from the server's provided list. |out|
2716 * must be set to point to the selected protocol (which may be within |in|).
2717 * The length of the protocol name must be written into |outlen|. The
2718 * server's advertised protocols are provided in |in| and |inlen|. The
2719 * callback can assume that |in| is syntactically valid. The client must
2720 * select a protocol. It is fatal to the connection if this callback returns
2721 * a value other than SSL_TLSEXT_ERR_OK.
2723 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2724 SSL_CTX_npn_select_cb_func cb,
2727 ctx->ext.npn_select_cb = cb;
2728 ctx->ext.npn_select_cb_arg = arg;
2733 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2734 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2735 * length-prefixed strings). Returns 0 on success.
2737 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2738 unsigned int protos_len)
2740 OPENSSL_free(ctx->ext.alpn);
2741 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2742 if (ctx->ext.alpn == NULL) {
2743 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2746 ctx->ext.alpn_len = protos_len;
2752 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2753 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2754 * length-prefixed strings). Returns 0 on success.
2756 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2757 unsigned int protos_len)
2759 OPENSSL_free(ssl->ext.alpn);
2760 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2761 if (ssl->ext.alpn == NULL) {
2762 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2765 ssl->ext.alpn_len = protos_len;
2771 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2772 * called during ClientHello processing in order to select an ALPN protocol
2773 * from the client's list of offered protocols.
2775 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2776 SSL_CTX_alpn_select_cb_func cb,
2779 ctx->ext.alpn_select_cb = cb;
2780 ctx->ext.alpn_select_cb_arg = arg;
2784 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2785 * On return it sets |*data| to point to |*len| bytes of protocol name
2786 * (not including the leading length-prefix byte). If the server didn't
2787 * respond with a negotiated protocol then |*len| will be zero.
2789 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2794 *data = ssl->s3->alpn_selected;
2798 *len = (unsigned int)ssl->s3->alpn_selected_len;
2801 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2802 const char *label, size_t llen,
2803 const unsigned char *context, size_t contextlen,
2806 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2809 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2811 contextlen, use_context);
2814 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2816 const unsigned char *session_id = a->session_id;
2818 unsigned char tmp_storage[4];
2820 if (a->session_id_length < sizeof(tmp_storage)) {
2821 memset(tmp_storage, 0, sizeof(tmp_storage));
2822 memcpy(tmp_storage, a->session_id, a->session_id_length);
2823 session_id = tmp_storage;
2827 ((unsigned long)session_id[0]) |
2828 ((unsigned long)session_id[1] << 8L) |
2829 ((unsigned long)session_id[2] << 16L) |
2830 ((unsigned long)session_id[3] << 24L);
2835 * NB: If this function (or indeed the hash function which uses a sort of
2836 * coarser function than this one) is changed, ensure
2837 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2838 * being able to construct an SSL_SESSION that will collide with any existing
2839 * session with a matching session ID.
2841 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2843 if (a->ssl_version != b->ssl_version)
2845 if (a->session_id_length != b->session_id_length)
2847 return memcmp(a->session_id, b->session_id, a->session_id_length);
2851 * These wrapper functions should remain rather than redeclaring
2852 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2853 * variable. The reason is that the functions aren't static, they're exposed
2857 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2859 SSL_CTX *ret = NULL;
2862 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2866 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2869 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2870 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2873 ret = OPENSSL_zalloc(sizeof(*ret));
2878 ret->min_proto_version = 0;
2879 ret->max_proto_version = 0;
2880 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2881 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2882 /* We take the system default. */
2883 ret->session_timeout = meth->get_timeout();
2884 ret->references = 1;
2885 ret->lock = CRYPTO_THREAD_lock_new();
2886 if (ret->lock == NULL) {
2887 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2891 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2892 ret->verify_mode = SSL_VERIFY_NONE;
2893 if ((ret->cert = ssl_cert_new()) == NULL)
2896 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2897 if (ret->sessions == NULL)
2899 ret->cert_store = X509_STORE_new();
2900 if (ret->cert_store == NULL)
2902 #ifndef OPENSSL_NO_CT
2903 ret->ctlog_store = CTLOG_STORE_new();
2904 if (ret->ctlog_store == NULL)
2907 if (!ssl_create_cipher_list(ret->method,
2908 &ret->cipher_list, &ret->cipher_list_by_id,
2909 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2910 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2911 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2915 ret->param = X509_VERIFY_PARAM_new();
2916 if (ret->param == NULL)
2919 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2920 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2923 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2924 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2928 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2931 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2934 /* No compression for DTLS */
2935 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2936 ret->comp_methods = SSL_COMP_get_compression_methods();
2938 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2939 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2941 /* Setup RFC5077 ticket keys */
2942 if ((RAND_bytes(ret->ext.tick_key_name,
2943 sizeof(ret->ext.tick_key_name)) <= 0)
2944 || (RAND_bytes(ret->ext.tick_hmac_key,
2945 sizeof(ret->ext.tick_hmac_key)) <= 0)
2946 || (RAND_bytes(ret->ext.tick_aes_key,
2947 sizeof(ret->ext.tick_aes_key)) <= 0))
2948 ret->options |= SSL_OP_NO_TICKET;
2950 if (RAND_bytes(ret->ext.cookie_hmac_key,
2951 sizeof(ret->ext.cookie_hmac_key)) <= 0)
2954 #ifndef OPENSSL_NO_SRP
2955 if (!SSL_CTX_SRP_CTX_init(ret))
2958 #ifndef OPENSSL_NO_ENGINE
2959 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2960 # define eng_strx(x) #x
2961 # define eng_str(x) eng_strx(x)
2962 /* Use specific client engine automatically... ignore errors */
2965 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2968 ENGINE_load_builtin_engines();
2969 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2971 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2977 * Default is to connect to non-RI servers. When RI is more widely
2978 * deployed might change this.
2980 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2982 * Disable compression by default to prevent CRIME. Applications can
2983 * re-enable compression by configuring
2984 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2985 * or by using the SSL_CONF library. Similarly we also enable TLSv1.3
2986 * middlebox compatibility by default. This may be disabled by default in
2987 * a later OpenSSL version.
2989 ret->options |= SSL_OP_NO_COMPRESSION | SSL_OP_ENABLE_MIDDLEBOX_COMPAT;
2991 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2994 * Default max early data is a fully loaded single record. Could be split
2995 * across multiple records in practice
2997 ret->max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
3001 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
3007 int SSL_CTX_up_ref(SSL_CTX *ctx)
3011 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
3014 REF_PRINT_COUNT("SSL_CTX", ctx);
3015 REF_ASSERT_ISNT(i < 2);
3016 return ((i > 1) ? 1 : 0);
3019 void SSL_CTX_free(SSL_CTX *a)
3026 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
3027 REF_PRINT_COUNT("SSL_CTX", a);
3030 REF_ASSERT_ISNT(i < 0);
3032 X509_VERIFY_PARAM_free(a->param);
3033 dane_ctx_final(&a->dane);
3036 * Free internal session cache. However: the remove_cb() may reference
3037 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
3038 * after the sessions were flushed.
3039 * As the ex_data handling routines might also touch the session cache,
3040 * the most secure solution seems to be: empty (flush) the cache, then
3041 * free ex_data, then finally free the cache.
3042 * (See ticket [openssl.org #212].)
3044 if (a->sessions != NULL)
3045 SSL_CTX_flush_sessions(a, 0);
3047 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
3048 lh_SSL_SESSION_free(a->sessions);
3049 X509_STORE_free(a->cert_store);
3050 #ifndef OPENSSL_NO_CT
3051 CTLOG_STORE_free(a->ctlog_store);
3053 sk_SSL_CIPHER_free(a->cipher_list);
3054 sk_SSL_CIPHER_free(a->cipher_list_by_id);
3055 ssl_cert_free(a->cert);
3056 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
3057 sk_X509_pop_free(a->extra_certs, X509_free);
3058 a->comp_methods = NULL;
3059 #ifndef OPENSSL_NO_SRTP
3060 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
3062 #ifndef OPENSSL_NO_SRP
3063 SSL_CTX_SRP_CTX_free(a);
3065 #ifndef OPENSSL_NO_ENGINE
3066 ENGINE_finish(a->client_cert_engine);
3069 #ifndef OPENSSL_NO_EC
3070 OPENSSL_free(a->ext.ecpointformats);
3071 OPENSSL_free(a->ext.supportedgroups);
3073 OPENSSL_free(a->ext.alpn);
3075 CRYPTO_THREAD_lock_free(a->lock);
3080 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
3082 ctx->default_passwd_callback = cb;
3085 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
3087 ctx->default_passwd_callback_userdata = u;
3090 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
3092 return ctx->default_passwd_callback;
3095 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
3097 return ctx->default_passwd_callback_userdata;
3100 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
3102 s->default_passwd_callback = cb;
3105 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
3107 s->default_passwd_callback_userdata = u;
3110 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
3112 return s->default_passwd_callback;
3115 void *SSL_get_default_passwd_cb_userdata(SSL *s)
3117 return s->default_passwd_callback_userdata;
3120 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
3121 int (*cb) (X509_STORE_CTX *, void *),
3124 ctx->app_verify_callback = cb;
3125 ctx->app_verify_arg = arg;
3128 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
3129 int (*cb) (int, X509_STORE_CTX *))
3131 ctx->verify_mode = mode;
3132 ctx->default_verify_callback = cb;
3135 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
3137 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
3140 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
3142 ssl_cert_set_cert_cb(c->cert, cb, arg);
3145 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
3147 ssl_cert_set_cert_cb(s->cert, cb, arg);
3150 void ssl_set_masks(SSL *s)
3153 uint32_t *pvalid = s->s3->tmp.valid_flags;
3154 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
3155 unsigned long mask_k, mask_a;
3156 #ifndef OPENSSL_NO_EC
3157 int have_ecc_cert, ecdsa_ok;
3162 #ifndef OPENSSL_NO_DH
3163 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
3168 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3169 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
3170 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
3171 #ifndef OPENSSL_NO_EC
3172 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
3178 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
3179 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
3182 #ifndef OPENSSL_NO_GOST
3183 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
3184 mask_k |= SSL_kGOST;
3185 mask_a |= SSL_aGOST12;
3187 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
3188 mask_k |= SSL_kGOST;
3189 mask_a |= SSL_aGOST12;
3191 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
3192 mask_k |= SSL_kGOST;
3193 mask_a |= SSL_aGOST01;
3204 * If we only have an RSA-PSS certificate allow RSA authentication
3205 * if TLS 1.2 and peer supports it.
3208 if (rsa_enc || rsa_sign || (ssl_has_cert(s, SSL_PKEY_RSA_PSS_SIGN)
3209 && pvalid[SSL_PKEY_RSA_PSS_SIGN] & CERT_PKEY_EXPLICIT_SIGN
3210 && TLS1_get_version(s) == TLS1_2_VERSION))
3217 mask_a |= SSL_aNULL;
3220 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3221 * depending on the key usage extension.
3223 #ifndef OPENSSL_NO_EC
3224 if (have_ecc_cert) {
3226 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3227 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3228 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3231 mask_a |= SSL_aECDSA;
3233 /* Allow Ed25519 for TLS 1.2 if peer supports it */
3234 if (!(mask_a & SSL_aECDSA) && ssl_has_cert(s, SSL_PKEY_ED25519)
3235 && pvalid[SSL_PKEY_ED25519] & CERT_PKEY_EXPLICIT_SIGN
3236 && TLS1_get_version(s) == TLS1_2_VERSION)
3237 mask_a |= SSL_aECDSA;
3240 #ifndef OPENSSL_NO_EC
3241 mask_k |= SSL_kECDHE;
3244 #ifndef OPENSSL_NO_PSK
3247 if (mask_k & SSL_kRSA)
3248 mask_k |= SSL_kRSAPSK;
3249 if (mask_k & SSL_kDHE)
3250 mask_k |= SSL_kDHEPSK;
3251 if (mask_k & SSL_kECDHE)
3252 mask_k |= SSL_kECDHEPSK;
3255 s->s3->tmp.mask_k = mask_k;
3256 s->s3->tmp.mask_a = mask_a;
3259 #ifndef OPENSSL_NO_EC
3261 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3263 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3264 /* key usage, if present, must allow signing */
3265 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3266 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3267 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3271 return 1; /* all checks are ok */
3276 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3277 size_t *serverinfo_length)
3279 CERT_PKEY *cpk = s->s3->tmp.cert;
3280 *serverinfo_length = 0;
3282 if (cpk == NULL || cpk->serverinfo == NULL)
3285 *serverinfo = cpk->serverinfo;
3286 *serverinfo_length = cpk->serverinfo_length;
3290 void ssl_update_cache(SSL *s, int mode)
3295 * If the session_id_length is 0, we are not supposed to cache it, and it
3296 * would be rather hard to do anyway :-)
3298 if (s->session->session_id_length == 0)
3301 i = s->session_ctx->session_cache_mode;
3303 && (!s->hit || SSL_IS_TLS13(s))
3304 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE) != 0
3305 || SSL_CTX_add_session(s->session_ctx, s->session))
3306 && s->session_ctx->new_session_cb != NULL) {
3307 SSL_SESSION_up_ref(s->session);
3308 if (!s->session_ctx->new_session_cb(s, s->session))
3309 SSL_SESSION_free(s->session);
3312 /* auto flush every 255 connections */
3313 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3315 if (mode & SSL_SESS_CACHE_CLIENT)
3316 stat = &s->session_ctx->stats.sess_connect_good;
3318 stat = &s->session_ctx->stats.sess_accept_good;
3319 if (CRYPTO_atomic_read(stat, &val, s->session_ctx->lock)
3320 && (val & 0xff) == 0xff)
3321 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3325 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3330 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3335 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3339 if (s->method != meth) {
3340 const SSL_METHOD *sm = s->method;
3341 int (*hf) (SSL *) = s->handshake_func;
3343 if (sm->version == meth->version)
3348 ret = s->method->ssl_new(s);
3351 if (hf == sm->ssl_connect)
3352 s->handshake_func = meth->ssl_connect;
3353 else if (hf == sm->ssl_accept)
3354 s->handshake_func = meth->ssl_accept;
3359 int SSL_get_error(const SSL *s, int i)
3366 return SSL_ERROR_NONE;
3369 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3370 * where we do encode the error
3372 if ((l = ERR_peek_error()) != 0) {
3373 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3374 return SSL_ERROR_SYSCALL;
3376 return SSL_ERROR_SSL;
3379 if (SSL_want_read(s)) {
3380 bio = SSL_get_rbio(s);
3381 if (BIO_should_read(bio))
3382 return SSL_ERROR_WANT_READ;
3383 else if (BIO_should_write(bio))
3385 * This one doesn't make too much sense ... We never try to write
3386 * to the rbio, and an application program where rbio and wbio
3387 * are separate couldn't even know what it should wait for.
3388 * However if we ever set s->rwstate incorrectly (so that we have
3389 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3390 * wbio *are* the same, this test works around that bug; so it
3391 * might be safer to keep it.
3393 return SSL_ERROR_WANT_WRITE;
3394 else if (BIO_should_io_special(bio)) {
3395 reason = BIO_get_retry_reason(bio);
3396 if (reason == BIO_RR_CONNECT)
3397 return SSL_ERROR_WANT_CONNECT;
3398 else if (reason == BIO_RR_ACCEPT)
3399 return SSL_ERROR_WANT_ACCEPT;
3401 return SSL_ERROR_SYSCALL; /* unknown */
3405 if (SSL_want_write(s)) {
3406 /* Access wbio directly - in order to use the buffered bio if present */
3408 if (BIO_should_write(bio))
3409 return SSL_ERROR_WANT_WRITE;
3410 else if (BIO_should_read(bio))
3412 * See above (SSL_want_read(s) with BIO_should_write(bio))
3414 return SSL_ERROR_WANT_READ;
3415 else if (BIO_should_io_special(bio)) {
3416 reason = BIO_get_retry_reason(bio);
3417 if (reason == BIO_RR_CONNECT)
3418 return SSL_ERROR_WANT_CONNECT;
3419 else if (reason == BIO_RR_ACCEPT)
3420 return SSL_ERROR_WANT_ACCEPT;
3422 return SSL_ERROR_SYSCALL;
3425 if (SSL_want_x509_lookup(s))
3426 return SSL_ERROR_WANT_X509_LOOKUP;
3427 if (SSL_want_async(s))
3428 return SSL_ERROR_WANT_ASYNC;
3429 if (SSL_want_async_job(s))
3430 return SSL_ERROR_WANT_ASYNC_JOB;
3431 if (SSL_want_client_hello_cb(s))
3432 return SSL_ERROR_WANT_CLIENT_HELLO_CB;
3434 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3435 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3436 return SSL_ERROR_ZERO_RETURN;
3438 return SSL_ERROR_SYSCALL;
3441 static int ssl_do_handshake_intern(void *vargs)
3443 struct ssl_async_args *args;
3446 args = (struct ssl_async_args *)vargs;
3449 return s->handshake_func(s);
3452 int SSL_do_handshake(SSL *s)
3456 if (s->handshake_func == NULL) {
3457 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3461 ossl_statem_check_finish_init(s, -1);
3463 s->method->ssl_renegotiate_check(s, 0);
3465 if (SSL_is_server(s)) {
3466 /* clear SNI settings at server-side */
3467 OPENSSL_free(s->ext.hostname);
3468 s->ext.hostname = NULL;
3471 if (SSL_in_init(s) || SSL_in_before(s)) {
3472 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3473 struct ssl_async_args args;
3477 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3479 ret = s->handshake_func(s);
3485 void SSL_set_accept_state(SSL *s)
3489 ossl_statem_clear(s);
3490 s->handshake_func = s->method->ssl_accept;
3494 void SSL_set_connect_state(SSL *s)
3498 ossl_statem_clear(s);
3499 s->handshake_func = s->method->ssl_connect;
3503 int ssl_undefined_function(SSL *s)
3505 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3509 int ssl_undefined_void_function(void)
3511 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3512 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3516 int ssl_undefined_const_function(const SSL *s)
3521 const SSL_METHOD *ssl_bad_method(int ver)
3523 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3527 const char *ssl_protocol_to_string(int version)
3531 case TLS1_3_VERSION:
3534 case TLS1_2_VERSION:
3537 case TLS1_1_VERSION:
3552 case DTLS1_2_VERSION:
3560 const char *SSL_get_version(const SSL *s)
3562 return ssl_protocol_to_string(s->version);
3565 SSL *SSL_dup(SSL *s)
3567 STACK_OF(X509_NAME) *sk;
3572 /* If we're not quiescent, just up_ref! */
3573 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3574 CRYPTO_UP_REF(&s->references, &i, s->lock);
3579 * Otherwise, copy configuration state, and session if set.
3581 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3584 if (s->session != NULL) {
3586 * Arranges to share the same session via up_ref. This "copies"
3587 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3589 if (!SSL_copy_session_id(ret, s))
3593 * No session has been established yet, so we have to expect that
3594 * s->cert or ret->cert will be changed later -- they should not both
3595 * point to the same object, and thus we can't use
3596 * SSL_copy_session_id.
3598 if (!SSL_set_ssl_method(ret, s->method))
3601 if (s->cert != NULL) {
3602 ssl_cert_free(ret->cert);
3603 ret->cert = ssl_cert_dup(s->cert);
3604 if (ret->cert == NULL)
3608 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3609 (int)s->sid_ctx_length))
3613 if (!ssl_dane_dup(ret, s))
3615 ret->version = s->version;
3616 ret->options = s->options;
3617 ret->mode = s->mode;
3618 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3619 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3620 ret->msg_callback = s->msg_callback;
3621 ret->msg_callback_arg = s->msg_callback_arg;
3622 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3623 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3624 ret->generate_session_id = s->generate_session_id;
3626 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3628 /* copy app data, a little dangerous perhaps */
3629 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3632 /* setup rbio, and wbio */
3633 if (s->rbio != NULL) {
3634 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3637 if (s->wbio != NULL) {
3638 if (s->wbio != s->rbio) {
3639 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3642 BIO_up_ref(ret->rbio);
3643 ret->wbio = ret->rbio;
3647 ret->server = s->server;
3648 if (s->handshake_func) {
3650 SSL_set_accept_state(ret);
3652 SSL_set_connect_state(ret);
3654 ret->shutdown = s->shutdown;
3657 ret->default_passwd_callback = s->default_passwd_callback;
3658 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3660 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3662 /* dup the cipher_list and cipher_list_by_id stacks */
3663 if (s->cipher_list != NULL) {
3664 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3667 if (s->cipher_list_by_id != NULL)
3668 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3672 /* Dup the client_CA list */
3673 if (s->ca_names != NULL) {
3674 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3677 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3678 xn = sk_X509_NAME_value(sk, i);
3679 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3692 void ssl_clear_cipher_ctx(SSL *s)
3694 if (s->enc_read_ctx != NULL) {
3695 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3696 s->enc_read_ctx = NULL;
3698 if (s->enc_write_ctx != NULL) {
3699 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3700 s->enc_write_ctx = NULL;
3702 #ifndef OPENSSL_NO_COMP
3703 COMP_CTX_free(s->expand);
3705 COMP_CTX_free(s->compress);
3710 X509 *SSL_get_certificate(const SSL *s)
3712 if (s->cert != NULL)
3713 return s->cert->key->x509;
3718 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3720 if (s->cert != NULL)
3721 return s->cert->key->privatekey;
3726 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3728 if (ctx->cert != NULL)
3729 return ctx->cert->key->x509;
3734 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3736 if (ctx->cert != NULL)
3737 return ctx->cert->key->privatekey;
3742 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3744 if ((s->session != NULL) && (s->session->cipher != NULL))
3745 return s->session->cipher;
3749 const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s)
3751 return s->s3->tmp.new_cipher;
3754 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3756 #ifndef OPENSSL_NO_COMP
3757 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3763 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3765 #ifndef OPENSSL_NO_COMP
3766 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3772 int ssl_init_wbio_buffer(SSL *s)
3776 if (s->bbio != NULL) {
3777 /* Already buffered. */
3781 bbio = BIO_new(BIO_f_buffer());
3782 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3784 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3788 s->wbio = BIO_push(bbio, s->wbio);
3793 int ssl_free_wbio_buffer(SSL *s)
3795 /* callers ensure s is never null */
3796 if (s->bbio == NULL)
3799 s->wbio = BIO_pop(s->wbio);
3800 if (!ossl_assert(s->wbio != NULL))
3808 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3810 ctx->quiet_shutdown = mode;
3813 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3815 return ctx->quiet_shutdown;
3818 void SSL_set_quiet_shutdown(SSL *s, int mode)
3820 s->quiet_shutdown = mode;
3823 int SSL_get_quiet_shutdown(const SSL *s)
3825 return s->quiet_shutdown;
3828 void SSL_set_shutdown(SSL *s, int mode)
3833 int SSL_get_shutdown(const SSL *s)
3838 int SSL_version(const SSL *s)
3843 int SSL_client_version(const SSL *s)
3845 return s->client_version;
3848 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3853 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3856 if (ssl->ctx == ctx)
3859 ctx = ssl->session_ctx;
3860 new_cert = ssl_cert_dup(ctx->cert);
3861 if (new_cert == NULL) {
3865 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3866 ssl_cert_free(new_cert);
3870 ssl_cert_free(ssl->cert);
3871 ssl->cert = new_cert;
3874 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3875 * so setter APIs must prevent invalid lengths from entering the system.
3877 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3881 * If the session ID context matches that of the parent SSL_CTX,
3882 * inherit it from the new SSL_CTX as well. If however the context does
3883 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3884 * leave it unchanged.
3886 if ((ssl->ctx != NULL) &&
3887 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3888 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3889 ssl->sid_ctx_length = ctx->sid_ctx_length;
3890 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3893 SSL_CTX_up_ref(ctx);
3894 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3900 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3902 return X509_STORE_set_default_paths(ctx->cert_store);
3905 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3907 X509_LOOKUP *lookup;
3909 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3912 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3914 /* Clear any errors if the default directory does not exist */
3920 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3922 X509_LOOKUP *lookup;
3924 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3928 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3930 /* Clear any errors if the default file does not exist */
3936 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3939 return X509_STORE_load_locations(ctx->cert_store, CAfile, CApath);
3942 void SSL_set_info_callback(SSL *ssl,
3943 void (*cb) (const SSL *ssl, int type, int val))
3945 ssl->info_callback = cb;
3949 * One compiler (Diab DCC) doesn't like argument names in returned function
3952 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3955 return ssl->info_callback;
3958 void SSL_set_verify_result(SSL *ssl, long arg)
3960 ssl->verify_result = arg;
3963 long SSL_get_verify_result(const SSL *ssl)
3965 return ssl->verify_result;
3968 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3971 return sizeof(ssl->s3->client_random);
3972 if (outlen > sizeof(ssl->s3->client_random))
3973 outlen = sizeof(ssl->s3->client_random);
3974 memcpy(out, ssl->s3->client_random, outlen);
3978 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3981 return sizeof(ssl->s3->server_random);
3982 if (outlen > sizeof(ssl->s3->server_random))
3983 outlen = sizeof(ssl->s3->server_random);
3984 memcpy(out, ssl->s3->server_random, outlen);
3988 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3989 unsigned char *out, size_t outlen)
3992 return session->master_key_length;
3993 if (outlen > session->master_key_length)
3994 outlen = session->master_key_length;
3995 memcpy(out, session->master_key, outlen);
3999 int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
4002 if (len > sizeof(sess->master_key))
4005 memcpy(sess->master_key, in, len);
4006 sess->master_key_length = len;
4011 int SSL_set_ex_data(SSL *s, int idx, void *arg)
4013 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4016 void *SSL_get_ex_data(const SSL *s, int idx)
4018 return CRYPTO_get_ex_data(&s->ex_data, idx);
4021 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
4023 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
4026 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
4028 return CRYPTO_get_ex_data(&s->ex_data, idx);
4031 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
4033 return ctx->cert_store;
4036 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
4038 X509_STORE_free(ctx->cert_store);
4039 ctx->cert_store = store;
4042 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
4045 X509_STORE_up_ref(store);
4046 SSL_CTX_set_cert_store(ctx, store);
4049 int SSL_want(const SSL *s)
4055 * \brief Set the callback for generating temporary DH keys.
4056 * \param ctx the SSL context.
4057 * \param dh the callback
4060 #ifndef OPENSSL_NO_DH
4061 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
4062 DH *(*dh) (SSL *ssl, int is_export,
4065 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4068 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
4071 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
4075 #ifndef OPENSSL_NO_PSK
4076 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
4078 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4079 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4082 OPENSSL_free(ctx->cert->psk_identity_hint);
4083 if (identity_hint != NULL) {
4084 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4085 if (ctx->cert->psk_identity_hint == NULL)
4088 ctx->cert->psk_identity_hint = NULL;
4092 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
4097 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
4098 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
4101 OPENSSL_free(s->cert->psk_identity_hint);
4102 if (identity_hint != NULL) {
4103 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
4104 if (s->cert->psk_identity_hint == NULL)
4107 s->cert->psk_identity_hint = NULL;
4111 const char *SSL_get_psk_identity_hint(const SSL *s)
4113 if (s == NULL || s->session == NULL)
4115 return s->session->psk_identity_hint;
4118 const char *SSL_get_psk_identity(const SSL *s)
4120 if (s == NULL || s->session == NULL)
4122 return s->session->psk_identity;
4125 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
4127 s->psk_client_callback = cb;
4130 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
4132 ctx->psk_client_callback = cb;
4135 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
4137 s->psk_server_callback = cb;
4140 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
4142 ctx->psk_server_callback = cb;
4146 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb)
4148 s->psk_find_session_cb = cb;
4151 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
4152 SSL_psk_find_session_cb_func cb)
4154 ctx->psk_find_session_cb = cb;
4157 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb)
4159 s->psk_use_session_cb = cb;
4162 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
4163 SSL_psk_use_session_cb_func cb)
4165 ctx->psk_use_session_cb = cb;
4168 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
4169 void (*cb) (int write_p, int version,
4170 int content_type, const void *buf,
4171 size_t len, SSL *ssl, void *arg))
4173 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4176 void SSL_set_msg_callback(SSL *ssl,
4177 void (*cb) (int write_p, int version,
4178 int content_type, const void *buf,
4179 size_t len, SSL *ssl, void *arg))
4181 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
4184 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
4185 int (*cb) (SSL *ssl,
4189 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4190 (void (*)(void))cb);
4193 void SSL_set_not_resumable_session_callback(SSL *ssl,
4194 int (*cb) (SSL *ssl,
4195 int is_forward_secure))
4197 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
4198 (void (*)(void))cb);
4201 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
4202 size_t (*cb) (SSL *ssl, int type,
4203 size_t len, void *arg))
4205 ctx->record_padding_cb = cb;
4208 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
4210 ctx->record_padding_arg = arg;
4213 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
4215 return ctx->record_padding_arg;
4218 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
4220 /* block size of 0 or 1 is basically no padding */
4221 if (block_size == 1)
4222 ctx->block_padding = 0;
4223 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4224 ctx->block_padding = block_size;
4230 void SSL_set_record_padding_callback(SSL *ssl,
4231 size_t (*cb) (SSL *ssl, int type,
4232 size_t len, void *arg))
4234 ssl->record_padding_cb = cb;
4237 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
4239 ssl->record_padding_arg = arg;
4242 void *SSL_get_record_padding_callback_arg(SSL *ssl)
4244 return ssl->record_padding_arg;
4247 int SSL_set_block_padding(SSL *ssl, size_t block_size)
4249 /* block size of 0 or 1 is basically no padding */
4250 if (block_size == 1)
4251 ssl->block_padding = 0;
4252 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
4253 ssl->block_padding = block_size;
4260 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
4261 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
4262 * If EVP_MD pointer is passed, initializes ctx with this |md|.
4263 * Returns the newly allocated ctx;
4266 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
4268 ssl_clear_hash_ctx(hash);
4269 *hash = EVP_MD_CTX_new();
4270 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
4271 EVP_MD_CTX_free(*hash);
4278 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
4281 EVP_MD_CTX_free(*hash);
4285 /* Retrieve handshake hashes */
4286 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4289 EVP_MD_CTX *ctx = NULL;
4290 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4291 int hashleni = EVP_MD_CTX_size(hdgst);
4294 if (hashleni < 0 || (size_t)hashleni > outlen) {
4295 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4296 ERR_R_INTERNAL_ERROR);
4300 ctx = EVP_MD_CTX_new();
4304 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4305 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0) {
4306 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_HANDSHAKE_HASH,
4307 ERR_R_INTERNAL_ERROR);
4311 *hashlen = hashleni;
4315 EVP_MD_CTX_free(ctx);
4319 int SSL_session_reused(SSL *s)
4324 int SSL_is_server(const SSL *s)
4329 #if OPENSSL_API_COMPAT < 0x10100000L
4330 void SSL_set_debug(SSL *s, int debug)
4332 /* Old function was do-nothing anyway... */
4338 void SSL_set_security_level(SSL *s, int level)
4340 s->cert->sec_level = level;
4343 int SSL_get_security_level(const SSL *s)
4345 return s->cert->sec_level;
4348 void SSL_set_security_callback(SSL *s,
4349 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4350 int op, int bits, int nid,
4351 void *other, void *ex))
4353 s->cert->sec_cb = cb;
4356 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4357 const SSL_CTX *ctx, int op,
4358 int bits, int nid, void *other,
4360 return s->cert->sec_cb;
4363 void SSL_set0_security_ex_data(SSL *s, void *ex)
4365 s->cert->sec_ex = ex;
4368 void *SSL_get0_security_ex_data(const SSL *s)
4370 return s->cert->sec_ex;
4373 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4375 ctx->cert->sec_level = level;
4378 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4380 return ctx->cert->sec_level;
4383 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4384 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4385 int op, int bits, int nid,
4386 void *other, void *ex))
4388 ctx->cert->sec_cb = cb;
4391 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4397 return ctx->cert->sec_cb;
4400 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4402 ctx->cert->sec_ex = ex;
4405 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4407 return ctx->cert->sec_ex;
4411 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4412 * can return unsigned long, instead of the generic long return value from the
4413 * control interface.
4415 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4417 return ctx->options;
4420 unsigned long SSL_get_options(const SSL *s)
4425 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4427 return ctx->options |= op;
4430 unsigned long SSL_set_options(SSL *s, unsigned long op)
4432 return s->options |= op;
4435 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4437 return ctx->options &= ~op;
4440 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4442 return s->options &= ~op;
4445 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4447 return s->verified_chain;
4450 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4452 #ifndef OPENSSL_NO_CT
4455 * Moves SCTs from the |src| stack to the |dst| stack.
4456 * The source of each SCT will be set to |origin|.
4457 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4459 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4461 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4462 sct_source_t origin)
4468 *dst = sk_SCT_new_null();
4470 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4475 while ((sct = sk_SCT_pop(src)) != NULL) {
4476 if (SCT_set_source(sct, origin) != 1)
4479 if (sk_SCT_push(*dst, sct) <= 0)
4487 sk_SCT_push(src, sct); /* Put the SCT back */
4492 * Look for data collected during ServerHello and parse if found.
4493 * Returns the number of SCTs extracted.
4495 static int ct_extract_tls_extension_scts(SSL *s)
4497 int scts_extracted = 0;
4499 if (s->ext.scts != NULL) {
4500 const unsigned char *p = s->ext.scts;
4501 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4503 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4505 SCT_LIST_free(scts);
4508 return scts_extracted;
4512 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4513 * contains an SCT X509 extension. They will be stored in |s->scts|.
4515 * - The number of SCTs extracted, assuming an OCSP response exists.
4516 * - 0 if no OCSP response exists or it contains no SCTs.
4517 * - A negative integer if an error occurs.
4519 static int ct_extract_ocsp_response_scts(SSL *s)
4521 # ifndef OPENSSL_NO_OCSP
4522 int scts_extracted = 0;
4523 const unsigned char *p;
4524 OCSP_BASICRESP *br = NULL;
4525 OCSP_RESPONSE *rsp = NULL;
4526 STACK_OF(SCT) *scts = NULL;
4529 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4532 p = s->ext.ocsp.resp;
4533 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4537 br = OCSP_response_get1_basic(rsp);
4541 for (i = 0; i < OCSP_resp_count(br); ++i) {
4542 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4548 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4550 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4551 if (scts_extracted < 0)
4555 SCT_LIST_free(scts);
4556 OCSP_BASICRESP_free(br);
4557 OCSP_RESPONSE_free(rsp);
4558 return scts_extracted;
4560 /* Behave as if no OCSP response exists */
4566 * Attempts to extract SCTs from the peer certificate.
4567 * Return the number of SCTs extracted, or a negative integer if an error
4570 static int ct_extract_x509v3_extension_scts(SSL *s)
4572 int scts_extracted = 0;
4573 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4576 STACK_OF(SCT) *scts =
4577 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4580 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4582 SCT_LIST_free(scts);
4585 return scts_extracted;
4589 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4590 * response (if it exists) and X509v3 extensions in the certificate.
4591 * Returns NULL if an error occurs.
4593 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4595 if (!s->scts_parsed) {
4596 if (ct_extract_tls_extension_scts(s) < 0 ||
4597 ct_extract_ocsp_response_scts(s) < 0 ||
4598 ct_extract_x509v3_extension_scts(s) < 0)
4608 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4609 const STACK_OF(SCT) *scts, void *unused_arg)
4614 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4615 const STACK_OF(SCT) *scts, void *unused_arg)
4617 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4620 for (i = 0; i < count; ++i) {
4621 SCT *sct = sk_SCT_value(scts, i);
4622 int status = SCT_get_validation_status(sct);
4624 if (status == SCT_VALIDATION_STATUS_VALID)
4627 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4631 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4635 * Since code exists that uses the custom extension handler for CT, look
4636 * for this and throw an error if they have already registered to use CT.
4638 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4639 TLSEXT_TYPE_signed_certificate_timestamp))
4641 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4642 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4646 if (callback != NULL) {
4648 * If we are validating CT, then we MUST accept SCTs served via OCSP
4650 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4654 s->ct_validation_callback = callback;
4655 s->ct_validation_callback_arg = arg;
4660 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4661 ssl_ct_validation_cb callback, void *arg)
4664 * Since code exists that uses the custom extension handler for CT, look for
4665 * this and throw an error if they have already registered to use CT.
4667 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4668 TLSEXT_TYPE_signed_certificate_timestamp))
4670 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4671 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4675 ctx->ct_validation_callback = callback;
4676 ctx->ct_validation_callback_arg = arg;
4680 int SSL_ct_is_enabled(const SSL *s)
4682 return s->ct_validation_callback != NULL;
4685 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4687 return ctx->ct_validation_callback != NULL;
4690 int ssl_validate_ct(SSL *s)
4693 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4695 SSL_DANE *dane = &s->dane;
4696 CT_POLICY_EVAL_CTX *ctx = NULL;
4697 const STACK_OF(SCT) *scts;
4700 * If no callback is set, the peer is anonymous, or its chain is invalid,
4701 * skip SCT validation - just return success. Applications that continue
4702 * handshakes without certificates, with unverified chains, or pinned leaf
4703 * certificates are outside the scope of the WebPKI and CT.
4705 * The above exclusions notwithstanding the vast majority of peers will
4706 * have rather ordinary certificate chains validated by typical
4707 * applications that perform certificate verification and therefore will
4708 * process SCTs when enabled.
4710 if (s->ct_validation_callback == NULL || cert == NULL ||
4711 s->verify_result != X509_V_OK ||
4712 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4716 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4717 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4719 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4720 switch (dane->mtlsa->usage) {
4721 case DANETLS_USAGE_DANE_TA:
4722 case DANETLS_USAGE_DANE_EE:
4727 ctx = CT_POLICY_EVAL_CTX_new();
4729 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_VALIDATE_CT,
4730 ERR_R_MALLOC_FAILURE);
4734 issuer = sk_X509_value(s->verified_chain, 1);
4735 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4736 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4737 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4738 CT_POLICY_EVAL_CTX_set_time(
4739 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4741 scts = SSL_get0_peer_scts(s);
4744 * This function returns success (> 0) only when all the SCTs are valid, 0
4745 * when some are invalid, and < 0 on various internal errors (out of
4746 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4747 * reason to abort the handshake, that decision is up to the callback.
4748 * Therefore, we error out only in the unexpected case that the return
4749 * value is negative.
4751 * XXX: One might well argue that the return value of this function is an
4752 * unfortunate design choice. Its job is only to determine the validation
4753 * status of each of the provided SCTs. So long as it correctly separates
4754 * the wheat from the chaff it should return success. Failure in this case
4755 * ought to correspond to an inability to carry out its duties.
4757 if (SCT_LIST_validate(scts, ctx) < 0) {
4758 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4759 SSL_R_SCT_VERIFICATION_FAILED);
4763 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4765 ret = 0; /* This function returns 0 on failure */
4767 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL_VALIDATE_CT,
4768 SSL_R_CALLBACK_FAILED);
4771 CT_POLICY_EVAL_CTX_free(ctx);
4773 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4774 * failure return code here. Also the application may wish the complete
4775 * the handshake, and then disconnect cleanly at a higher layer, after
4776 * checking the verification status of the completed connection.
4778 * We therefore force a certificate verification failure which will be
4779 * visible via SSL_get_verify_result() and cached as part of any resumed
4782 * Note: the permissive callback is for information gathering only, always
4783 * returns success, and does not affect verification status. Only the
4784 * strict callback or a custom application-specified callback can trigger
4785 * connection failure or record a verification error.
4788 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4792 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4794 switch (validation_mode) {
4796 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4798 case SSL_CT_VALIDATION_PERMISSIVE:
4799 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4800 case SSL_CT_VALIDATION_STRICT:
4801 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4805 int SSL_enable_ct(SSL *s, int validation_mode)
4807 switch (validation_mode) {
4809 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4811 case SSL_CT_VALIDATION_PERMISSIVE:
4812 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4813 case SSL_CT_VALIDATION_STRICT:
4814 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4818 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4820 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4823 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4825 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4828 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4830 CTLOG_STORE_free(ctx->ctlog_store);
4831 ctx->ctlog_store = logs;
4834 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4836 return ctx->ctlog_store;
4839 #endif /* OPENSSL_NO_CT */
4841 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
4844 c->client_hello_cb = cb;
4845 c->client_hello_cb_arg = arg;
4848 int SSL_client_hello_isv2(SSL *s)
4850 if (s->clienthello == NULL)
4852 return s->clienthello->isv2;
4855 unsigned int SSL_client_hello_get0_legacy_version(SSL *s)
4857 if (s->clienthello == NULL)
4859 return s->clienthello->legacy_version;
4862 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out)
4864 if (s->clienthello == NULL)
4867 *out = s->clienthello->random;
4868 return SSL3_RANDOM_SIZE;
4871 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out)
4873 if (s->clienthello == NULL)
4876 *out = s->clienthello->session_id;
4877 return s->clienthello->session_id_len;
4880 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out)
4882 if (s->clienthello == NULL)
4885 *out = PACKET_data(&s->clienthello->ciphersuites);
4886 return PACKET_remaining(&s->clienthello->ciphersuites);
4889 size_t SSL_client_hello_get0_compression_methods(SSL *s, const unsigned char **out)
4891 if (s->clienthello == NULL)
4894 *out = s->clienthello->compressions;
4895 return s->clienthello->compressions_len;
4898 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen)
4904 if (s->clienthello == NULL || out == NULL || outlen == NULL)
4906 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
4907 ext = s->clienthello->pre_proc_exts + i;
4911 present = OPENSSL_malloc(sizeof(*present) * num);
4912 if (present == NULL)
4914 for (i = 0; i < s->clienthello->pre_proc_exts_len; i++) {
4915 ext = s->clienthello->pre_proc_exts + i;
4917 if (ext->received_order >= num)
4919 present[ext->received_order] = ext->type;
4926 OPENSSL_free(present);
4930 int SSL_client_hello_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4936 if (s->clienthello == NULL)
4938 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4939 r = s->clienthello->pre_proc_exts + i;
4940 if (r->present && r->type == type) {
4942 *out = PACKET_data(&r->data);
4944 *outlen = PACKET_remaining(&r->data);
4951 int SSL_free_buffers(SSL *ssl)
4953 RECORD_LAYER *rl = &ssl->rlayer;
4955 if (RECORD_LAYER_read_pending(rl) || RECORD_LAYER_write_pending(rl))
4958 RECORD_LAYER_release(rl);
4962 int SSL_alloc_buffers(SSL *ssl)
4964 return ssl3_setup_buffers(ssl);
4967 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4969 ctx->keylog_callback = cb;
4972 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4974 return ctx->keylog_callback;
4977 static int nss_keylog_int(const char *prefix,
4979 const uint8_t *parameter_1,
4980 size_t parameter_1_len,
4981 const uint8_t *parameter_2,
4982 size_t parameter_2_len)
4985 char *cursor = NULL;
4990 if (ssl->ctx->keylog_callback == NULL) return 1;
4993 * Our output buffer will contain the following strings, rendered with
4994 * space characters in between, terminated by a NULL character: first the
4995 * prefix, then the first parameter, then the second parameter. The
4996 * meaning of each parameter depends on the specific key material being
4997 * logged. Note that the first and second parameters are encoded in
4998 * hexadecimal, so we need a buffer that is twice their lengths.
5000 prefix_len = strlen(prefix);
5001 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
5002 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
5003 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR, SSL_F_NSS_KEYLOG_INT,
5004 ERR_R_MALLOC_FAILURE);
5008 strcpy(cursor, prefix);
5009 cursor += prefix_len;
5012 for (i = 0; i < parameter_1_len; i++) {
5013 sprintf(cursor, "%02x", parameter_1[i]);
5018 for (i = 0; i < parameter_2_len; i++) {
5019 sprintf(cursor, "%02x", parameter_2[i]);
5024 ssl->ctx->keylog_callback(ssl, (const char *)out);
5030 int ssl_log_rsa_client_key_exchange(SSL *ssl,
5031 const uint8_t *encrypted_premaster,
5032 size_t encrypted_premaster_len,
5033 const uint8_t *premaster,
5034 size_t premaster_len)
5036 if (encrypted_premaster_len < 8) {
5037 SSLfatal(ssl, SSL_AD_INTERNAL_ERROR,
5038 SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
5042 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
5043 return nss_keylog_int("RSA",
5045 encrypted_premaster,
5051 int ssl_log_secret(SSL *ssl,
5053 const uint8_t *secret,
5056 return nss_keylog_int(label,
5058 ssl->s3->client_random,
5064 #define SSLV2_CIPHER_LEN 3
5066 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format)
5070 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5072 if (PACKET_remaining(cipher_suites) == 0) {
5073 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_CACHE_CIPHERLIST,
5074 SSL_R_NO_CIPHERS_SPECIFIED);
5078 if (PACKET_remaining(cipher_suites) % n != 0) {
5079 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5080 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5084 OPENSSL_free(s->s3->tmp.ciphers_raw);
5085 s->s3->tmp.ciphers_raw = NULL;
5086 s->s3->tmp.ciphers_rawlen = 0;
5089 size_t numciphers = PACKET_remaining(cipher_suites) / n;
5090 PACKET sslv2ciphers = *cipher_suites;
5091 unsigned int leadbyte;
5095 * We store the raw ciphers list in SSLv3+ format so we need to do some
5096 * preprocessing to convert the list first. If there are any SSLv2 only
5097 * ciphersuites with a non-zero leading byte then we are going to
5098 * slightly over allocate because we won't store those. But that isn't a
5101 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
5102 s->s3->tmp.ciphers_raw = raw;
5104 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5105 ERR_R_MALLOC_FAILURE);
5108 for (s->s3->tmp.ciphers_rawlen = 0;
5109 PACKET_remaining(&sslv2ciphers) > 0;
5110 raw += TLS_CIPHER_LEN) {
5111 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
5113 && !PACKET_copy_bytes(&sslv2ciphers, raw,
5116 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
5117 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5119 OPENSSL_free(s->s3->tmp.ciphers_raw);
5120 s->s3->tmp.ciphers_raw = NULL;
5121 s->s3->tmp.ciphers_rawlen = 0;
5125 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
5127 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
5128 &s->s3->tmp.ciphers_rawlen)) {
5129 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_CACHE_CIPHERLIST,
5130 ERR_R_INTERNAL_ERROR);
5136 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
5137 int isv2format, STACK_OF(SSL_CIPHER) **sk,
5138 STACK_OF(SSL_CIPHER) **scsvs)
5142 if (!PACKET_buf_init(&pkt, bytes, len))
5144 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, 0);
5147 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
5148 STACK_OF(SSL_CIPHER) **skp,
5149 STACK_OF(SSL_CIPHER) **scsvs_out,
5150 int sslv2format, int fatal)
5152 const SSL_CIPHER *c;
5153 STACK_OF(SSL_CIPHER) *sk = NULL;
5154 STACK_OF(SSL_CIPHER) *scsvs = NULL;
5156 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
5157 unsigned char cipher[SSLV2_CIPHER_LEN];
5159 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
5161 if (PACKET_remaining(cipher_suites) == 0) {
5163 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_BYTES_TO_CIPHER_LIST,
5164 SSL_R_NO_CIPHERS_SPECIFIED);
5166 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
5170 if (PACKET_remaining(cipher_suites) % n != 0) {
5172 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5173 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5175 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
5176 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
5180 sk = sk_SSL_CIPHER_new_null();
5181 scsvs = sk_SSL_CIPHER_new_null();
5182 if (sk == NULL || scsvs == NULL) {
5184 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5185 ERR_R_MALLOC_FAILURE);
5187 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5191 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
5193 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
5194 * first byte set to zero, while true SSLv2 ciphers have a non-zero
5195 * first byte. We don't support any true SSLv2 ciphers, so skip them.
5197 if (sslv2format && cipher[0] != '\0')
5200 /* For SSLv2-compat, ignore leading 0-byte. */
5201 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
5203 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
5204 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
5206 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
5207 SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5209 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
5214 if (PACKET_remaining(cipher_suites) > 0) {
5216 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_BYTES_TO_CIPHER_LIST,
5219 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
5226 sk_SSL_CIPHER_free(sk);
5227 if (scsvs_out != NULL)
5230 sk_SSL_CIPHER_free(scsvs);
5233 sk_SSL_CIPHER_free(sk);
5234 sk_SSL_CIPHER_free(scsvs);
5238 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
5240 ctx->max_early_data = max_early_data;
5245 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
5247 return ctx->max_early_data;
5250 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
5252 s->max_early_data = max_early_data;
5257 uint32_t SSL_get_max_early_data(const SSL *s)
5259 return s->max_early_data;
5262 int ssl_randbytes(SSL *s, unsigned char *rnd, size_t size)
5264 if (s->drbg != NULL) {
5266 * Currently, it's the duty of the caller to serialize the generate
5267 * requests to the DRBG. So formally we have to check whether
5268 * s->drbg->lock != NULL and take the lock if this is the case.
5269 * However, this DRBG is unique to a given SSL object, and we already
5270 * require that SSL objects are only accessed by a single thread at
5271 * a given time. Also, SSL DRBGs have no child DRBG, so there is
5272 * no risk that this DRBG is accessed by a child DRBG in parallel
5273 * for reseeding. As such, we can rely on the application's
5274 * serialization of SSL accesses for the needed concurrency protection
5277 return RAND_DRBG_bytes(s->drbg, rnd, size);
5281 return RAND_bytes(rnd, size);
5284 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl)
5286 /* Return any active Max Fragment Len extension */
5287 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session))
5288 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5290 /* return current SSL connection setting */
5291 return ssl->max_send_fragment;
5294 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl)
5296 /* Return a value regarding an active Max Fragment Len extension */
5297 if (ssl->session != NULL && USE_MAX_FRAGMENT_LENGTH_EXT(ssl->session)
5298 && ssl->split_send_fragment > GET_MAX_FRAGMENT_LENGTH(ssl->session))
5299 return GET_MAX_FRAGMENT_LENGTH(ssl->session);
5301 /* else limit |split_send_fragment| to current |max_send_fragment| */
5302 if (ssl->split_send_fragment > ssl->max_send_fragment)
5303 return ssl->max_send_fragment;
5305 /* return current SSL connection setting */
5306 return ssl->split_send_fragment;
5309 int SSL_stateless(SSL *s)
5313 /* Ensure there is no state left over from a previous invocation */
5319 s->s3->flags |= TLS1_FLAGS_STATELESS;
5320 ret = SSL_accept(s);
5321 s->s3->flags &= ~TLS1_FLAGS_STATELESS;
5323 if (ret > 0 && s->ext.cookieok)
5329 void SSL_force_post_handshake_auth(SSL *ssl)
5331 ssl->pha_forced = 1;
5334 int SSL_verify_client_post_handshake(SSL *ssl)
5336 if (!SSL_IS_TLS13(ssl)) {
5337 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_WRONG_SSL_VERSION);
5341 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_NOT_SERVER);
5345 if (!SSL_is_init_finished(ssl)) {
5346 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_STILL_IN_INIT);
5350 switch (ssl->post_handshake_auth) {
5352 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_EXTENSION_NOT_RECEIVED);
5355 case SSL_PHA_EXT_SENT:
5356 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, ERR_R_INTERNAL_ERROR);
5358 case SSL_PHA_EXT_RECEIVED:
5360 case SSL_PHA_REQUEST_PENDING:
5361 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_PENDING);
5363 case SSL_PHA_REQUESTED:
5364 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_REQUEST_SENT);
5368 ssl->post_handshake_auth = SSL_PHA_REQUEST_PENDING;
5370 /* checks verify_mode and algorithm_auth */
5371 if (!send_certificate_request(ssl)) {
5372 ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED; /* restore on error */
5373 SSLerr(SSL_F_SSL_VERIFY_CLIENT_POST_HANDSHAKE, SSL_R_INVALID_CONFIG);
5377 ossl_statem_set_in_init(ssl, 1);