2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 * ECC cipher suite support in OpenSSL originally developed by
13 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
15 /* ====================================================================
16 * Copyright 2005 Nokia. All rights reserved.
18 * The portions of the attached software ("Contribution") is developed by
19 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
22 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24 * support (see RFC 4279) to OpenSSL.
26 * No patent licenses or other rights except those expressly stated in
27 * the OpenSSL open source license shall be deemed granted or received
28 * expressly, by implication, estoppel, or otherwise.
30 * No assurances are provided by Nokia that the Contribution does not
31 * infringe the patent or other intellectual property rights of any third
32 * party or that the license provides you with all the necessary rights
33 * to make use of the Contribution.
35 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
45 #include <openssl/objects.h>
46 #include <openssl/lhash.h>
47 #include <openssl/x509v3.h>
48 #include <openssl/rand.h>
49 #include <openssl/ocsp.h>
50 #include <openssl/dh.h>
51 #include <openssl/engine.h>
52 #include <openssl/async.h>
53 #include <openssl/ct.h>
55 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
57 SSL3_ENC_METHOD ssl3_undef_enc_method = {
59 * evil casts, but these functions are only called if there's a library
62 (int (*)(SSL *, SSL3_RECORD *, size_t, int))ssl_undefined_function,
63 (int (*)(SSL *, SSL3_RECORD *, unsigned char *, int))ssl_undefined_function,
64 ssl_undefined_function,
65 (int (*)(SSL *, unsigned char *, unsigned char *, size_t, size_t *))
66 ssl_undefined_function,
67 (int (*)(SSL *, int))ssl_undefined_function,
68 (size_t (*)(SSL *, const char *, size_t, unsigned char *))
69 ssl_undefined_function,
70 NULL, /* client_finished_label */
71 0, /* client_finished_label_len */
72 NULL, /* server_finished_label */
73 0, /* server_finished_label_len */
74 (int (*)(int))ssl_undefined_function,
75 (int (*)(SSL *, unsigned char *, size_t, const char *,
76 size_t, const unsigned char *, size_t,
77 int use_context))ssl_undefined_function,
80 struct ssl_async_args {
84 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
86 int (*func_read) (SSL *, void *, size_t, size_t *);
87 int (*func_write) (SSL *, const void *, size_t, size_t *);
88 int (*func_other) (SSL *);
98 DANETLS_MATCHING_FULL, 0, NID_undef
101 DANETLS_MATCHING_2256, 1, NID_sha256
104 DANETLS_MATCHING_2512, 2, NID_sha512
108 static int dane_ctx_enable(struct dane_ctx_st *dctx)
110 const EVP_MD **mdevp;
112 uint8_t mdmax = DANETLS_MATCHING_LAST;
113 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
116 if (dctx->mdevp != NULL)
119 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
120 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
122 if (mdord == NULL || mdevp == NULL) {
125 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
129 /* Install default entries */
130 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
133 if (dane_mds[i].nid == NID_undef ||
134 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
136 mdevp[dane_mds[i].mtype] = md;
137 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
147 static void dane_ctx_final(struct dane_ctx_st *dctx)
149 OPENSSL_free(dctx->mdevp);
152 OPENSSL_free(dctx->mdord);
157 static void tlsa_free(danetls_record *t)
161 OPENSSL_free(t->data);
162 EVP_PKEY_free(t->spki);
166 static void dane_final(SSL_DANE *dane)
168 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
171 sk_X509_pop_free(dane->certs, X509_free);
174 X509_free(dane->mcert);
182 * dane_copy - Copy dane configuration, sans verification state.
184 static int ssl_dane_dup(SSL *to, SSL *from)
189 if (!DANETLS_ENABLED(&from->dane))
192 dane_final(&to->dane);
193 to->dane.flags = from->dane.flags;
194 to->dane.dctx = &to->ctx->dane;
195 to->dane.trecs = sk_danetls_record_new_null();
197 if (to->dane.trecs == NULL) {
198 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
202 num = sk_danetls_record_num(from->dane.trecs);
203 for (i = 0; i < num; ++i) {
204 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
206 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
207 t->data, t->dlen) <= 0)
213 static int dane_mtype_set(struct dane_ctx_st *dctx,
214 const EVP_MD *md, uint8_t mtype, uint8_t ord)
218 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
219 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
223 if (mtype > dctx->mdmax) {
224 const EVP_MD **mdevp;
226 int n = ((int)mtype) + 1;
228 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
230 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
235 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
237 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
242 /* Zero-fill any gaps */
243 for (i = dctx->mdmax + 1; i < mtype; ++i) {
251 dctx->mdevp[mtype] = md;
252 /* Coerce ordinal of disabled matching types to 0 */
253 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
258 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
260 if (mtype > dane->dctx->mdmax)
262 return dane->dctx->mdevp[mtype];
265 static int dane_tlsa_add(SSL_DANE *dane,
268 uint8_t mtype, unsigned char *data, size_t dlen)
271 const EVP_MD *md = NULL;
272 int ilen = (int)dlen;
276 if (dane->trecs == NULL) {
277 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
281 if (ilen < 0 || dlen != (size_t)ilen) {
282 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
286 if (usage > DANETLS_USAGE_LAST) {
287 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
291 if (selector > DANETLS_SELECTOR_LAST) {
292 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
296 if (mtype != DANETLS_MATCHING_FULL) {
297 md = tlsa_md_get(dane, mtype);
299 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
304 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
305 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
309 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
313 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
314 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
319 t->selector = selector;
321 t->data = OPENSSL_malloc(dlen);
322 if (t->data == NULL) {
324 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
327 memcpy(t->data, data, dlen);
330 /* Validate and cache full certificate or public key */
331 if (mtype == DANETLS_MATCHING_FULL) {
332 const unsigned char *p = data;
334 EVP_PKEY *pkey = NULL;
337 case DANETLS_SELECTOR_CERT:
338 if (!d2i_X509(&cert, &p, ilen) || p < data ||
339 dlen != (size_t)(p - data)) {
341 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
344 if (X509_get0_pubkey(cert) == NULL) {
346 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
350 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
356 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
357 * records that contain full certificates of trust-anchors that are
358 * not present in the wire chain. For usage PKIX-TA(0), we augment
359 * the chain with untrusted Full(0) certificates from DNS, in case
360 * they are missing from the chain.
362 if ((dane->certs == NULL &&
363 (dane->certs = sk_X509_new_null()) == NULL) ||
364 !sk_X509_push(dane->certs, cert)) {
365 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
372 case DANETLS_SELECTOR_SPKI:
373 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
374 dlen != (size_t)(p - data)) {
376 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
381 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
382 * records that contain full bare keys of trust-anchors that are
383 * not present in the wire chain.
385 if (usage == DANETLS_USAGE_DANE_TA)
394 * Find the right insertion point for the new record.
396 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
397 * they can be processed first, as they require no chain building, and no
398 * expiration or hostname checks. Because DANE-EE(3) is numerically
399 * largest, this is accomplished via descending sort by "usage".
401 * We also sort in descending order by matching ordinal to simplify
402 * the implementation of digest agility in the verification code.
404 * The choice of order for the selector is not significant, so we
405 * use the same descending order for consistency.
407 num = sk_danetls_record_num(dane->trecs);
408 for (i = 0; i < num; ++i) {
409 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
411 if (rec->usage > usage)
413 if (rec->usage < usage)
415 if (rec->selector > selector)
417 if (rec->selector < selector)
419 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
424 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
426 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
429 dane->umask |= DANETLS_USAGE_BIT(usage);
434 static void clear_ciphers(SSL *s)
436 /* clear the current cipher */
437 ssl_clear_cipher_ctx(s);
438 ssl_clear_hash_ctx(&s->read_hash);
439 ssl_clear_hash_ctx(&s->write_hash);
442 int SSL_clear(SSL *s)
444 if (s->method == NULL) {
445 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
449 if (ssl_clear_bad_session(s)) {
450 SSL_SESSION_free(s->session);
458 if (s->renegotiate) {
459 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
463 ossl_statem_clear(s);
465 s->version = s->method->version;
466 s->client_version = s->version;
467 s->rwstate = SSL_NOTHING;
469 BUF_MEM_free(s->init_buf);
474 s->key_update = SSL_KEY_UPDATE_NONE;
476 /* Reset DANE verification result state */
479 X509_free(s->dane.mcert);
480 s->dane.mcert = NULL;
481 s->dane.mtlsa = NULL;
483 /* Clear the verification result peername */
484 X509_VERIFY_PARAM_move_peername(s->param, NULL);
487 * Check to see if we were changed into a different method, if so, revert
488 * back if we are not doing session-id reuse.
490 if (!ossl_statem_get_in_handshake(s) && (s->session == NULL)
491 && (s->method != s->ctx->method)) {
492 s->method->ssl_free(s);
493 s->method = s->ctx->method;
494 if (!s->method->ssl_new(s))
497 s->method->ssl_clear(s);
499 RECORD_LAYER_clear(&s->rlayer);
504 /** Used to change an SSL_CTXs default SSL method type */
505 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
507 STACK_OF(SSL_CIPHER) *sk;
511 sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
512 &(ctx->cipher_list_by_id),
513 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
514 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
515 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
521 SSL *SSL_new(SSL_CTX *ctx)
526 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
529 if (ctx->method == NULL) {
530 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
534 s = OPENSSL_zalloc(sizeof(*s));
538 s->lock = CRYPTO_THREAD_lock_new();
539 if (s->lock == NULL) {
540 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
545 RECORD_LAYER_init(&s->rlayer, s);
547 s->options = ctx->options;
548 s->dane.flags = ctx->dane.flags;
549 s->min_proto_version = ctx->min_proto_version;
550 s->max_proto_version = ctx->max_proto_version;
552 s->max_cert_list = ctx->max_cert_list;
554 s->max_early_data = ctx->max_early_data;
557 * Earlier library versions used to copy the pointer to the CERT, not
558 * its contents; only when setting new parameters for the per-SSL
559 * copy, ssl_cert_new would be called (and the direct reference to
560 * the per-SSL_CTX settings would be lost, but those still were
561 * indirectly accessed for various purposes, and for that reason they
562 * used to be known as s->ctx->default_cert). Now we don't look at the
563 * SSL_CTX's CERT after having duplicated it once.
565 s->cert = ssl_cert_dup(ctx->cert);
569 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
570 s->msg_callback = ctx->msg_callback;
571 s->msg_callback_arg = ctx->msg_callback_arg;
572 s->verify_mode = ctx->verify_mode;
573 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
574 s->sid_ctx_length = ctx->sid_ctx_length;
575 OPENSSL_assert(s->sid_ctx_length <= sizeof s->sid_ctx);
576 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
577 s->verify_callback = ctx->default_verify_callback;
578 s->generate_session_id = ctx->generate_session_id;
580 s->param = X509_VERIFY_PARAM_new();
581 if (s->param == NULL)
583 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
584 s->quiet_shutdown = ctx->quiet_shutdown;
585 s->max_send_fragment = ctx->max_send_fragment;
586 s->split_send_fragment = ctx->split_send_fragment;
587 s->max_pipelines = ctx->max_pipelines;
588 if (s->max_pipelines > 1)
589 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
590 if (ctx->default_read_buf_len > 0)
591 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
596 s->ext.debug_arg = NULL;
597 s->ext.ticket_expected = 0;
598 s->ext.status_type = ctx->ext.status_type;
599 s->ext.status_expected = 0;
600 s->ext.ocsp.ids = NULL;
601 s->ext.ocsp.exts = NULL;
602 s->ext.ocsp.resp = NULL;
603 s->ext.ocsp.resp_len = 0;
605 s->session_ctx = ctx;
606 #ifndef OPENSSL_NO_EC
607 if (ctx->ext.ecpointformats) {
608 s->ext.ecpointformats =
609 OPENSSL_memdup(ctx->ext.ecpointformats,
610 ctx->ext.ecpointformats_len);
611 if (!s->ext.ecpointformats)
613 s->ext.ecpointformats_len =
614 ctx->ext.ecpointformats_len;
616 if (ctx->ext.supportedgroups) {
617 s->ext.supportedgroups =
618 OPENSSL_memdup(ctx->ext.supportedgroups,
619 ctx->ext.supportedgroups_len);
620 if (!s->ext.supportedgroups)
622 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
625 #ifndef OPENSSL_NO_NEXTPROTONEG
629 if (s->ctx->ext.alpn) {
630 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
631 if (s->ext.alpn == NULL)
633 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
634 s->ext.alpn_len = s->ctx->ext.alpn_len;
637 s->verified_chain = NULL;
638 s->verify_result = X509_V_OK;
640 s->default_passwd_callback = ctx->default_passwd_callback;
641 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
643 s->method = ctx->method;
645 s->key_update = SSL_KEY_UPDATE_NONE;
647 if (!s->method->ssl_new(s))
650 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
655 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
658 #ifndef OPENSSL_NO_PSK
659 s->psk_client_callback = ctx->psk_client_callback;
660 s->psk_server_callback = ctx->psk_server_callback;
665 #ifndef OPENSSL_NO_CT
666 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
667 ctx->ct_validation_callback_arg))
674 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
678 int SSL_is_dtls(const SSL *s)
680 return SSL_IS_DTLS(s) ? 1 : 0;
683 int SSL_up_ref(SSL *s)
687 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
690 REF_PRINT_COUNT("SSL", s);
691 REF_ASSERT_ISNT(i < 2);
692 return ((i > 1) ? 1 : 0);
695 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
696 unsigned int sid_ctx_len)
698 if (sid_ctx_len > sizeof ctx->sid_ctx) {
699 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
700 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
703 ctx->sid_ctx_length = sid_ctx_len;
704 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
709 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
710 unsigned int sid_ctx_len)
712 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
713 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
714 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
717 ssl->sid_ctx_length = sid_ctx_len;
718 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
723 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
725 CRYPTO_THREAD_write_lock(ctx->lock);
726 ctx->generate_session_id = cb;
727 CRYPTO_THREAD_unlock(ctx->lock);
731 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
733 CRYPTO_THREAD_write_lock(ssl->lock);
734 ssl->generate_session_id = cb;
735 CRYPTO_THREAD_unlock(ssl->lock);
739 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
743 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
744 * we can "construct" a session to give us the desired check - i.e. to
745 * find if there's a session in the hash table that would conflict with
746 * any new session built out of this id/id_len and the ssl_version in use
751 if (id_len > sizeof r.session_id)
754 r.ssl_version = ssl->version;
755 r.session_id_length = id_len;
756 memcpy(r.session_id, id, id_len);
758 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
759 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
760 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
764 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
766 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
769 int SSL_set_purpose(SSL *s, int purpose)
771 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
774 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
776 return X509_VERIFY_PARAM_set_trust(s->param, trust);
779 int SSL_set_trust(SSL *s, int trust)
781 return X509_VERIFY_PARAM_set_trust(s->param, trust);
784 int SSL_set1_host(SSL *s, const char *hostname)
786 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
789 int SSL_add1_host(SSL *s, const char *hostname)
791 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
794 void SSL_set_hostflags(SSL *s, unsigned int flags)
796 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
799 const char *SSL_get0_peername(SSL *s)
801 return X509_VERIFY_PARAM_get0_peername(s->param);
804 int SSL_CTX_dane_enable(SSL_CTX *ctx)
806 return dane_ctx_enable(&ctx->dane);
809 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
811 unsigned long orig = ctx->dane.flags;
813 ctx->dane.flags |= flags;
817 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
819 unsigned long orig = ctx->dane.flags;
821 ctx->dane.flags &= ~flags;
825 int SSL_dane_enable(SSL *s, const char *basedomain)
827 SSL_DANE *dane = &s->dane;
829 if (s->ctx->dane.mdmax == 0) {
830 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
833 if (dane->trecs != NULL) {
834 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
839 * Default SNI name. This rejects empty names, while set1_host below
840 * accepts them and disables host name checks. To avoid side-effects with
841 * invalid input, set the SNI name first.
843 if (s->ext.hostname == NULL) {
844 if (!SSL_set_tlsext_host_name(s, basedomain)) {
845 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
850 /* Primary RFC6125 reference identifier */
851 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
852 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
858 dane->dctx = &s->ctx->dane;
859 dane->trecs = sk_danetls_record_new_null();
861 if (dane->trecs == NULL) {
862 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
868 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
870 unsigned long orig = ssl->dane.flags;
872 ssl->dane.flags |= flags;
876 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
878 unsigned long orig = ssl->dane.flags;
880 ssl->dane.flags &= ~flags;
884 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
886 SSL_DANE *dane = &s->dane;
888 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
892 *mcert = dane->mcert;
894 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
899 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
900 uint8_t *mtype, unsigned const char **data, size_t *dlen)
902 SSL_DANE *dane = &s->dane;
904 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
908 *usage = dane->mtlsa->usage;
910 *selector = dane->mtlsa->selector;
912 *mtype = dane->mtlsa->mtype;
914 *data = dane->mtlsa->data;
916 *dlen = dane->mtlsa->dlen;
921 SSL_DANE *SSL_get0_dane(SSL *s)
926 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
927 uint8_t mtype, unsigned char *data, size_t dlen)
929 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
932 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
935 return dane_mtype_set(&ctx->dane, md, mtype, ord);
938 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
940 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
943 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
945 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
948 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
953 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
958 void SSL_certs_clear(SSL *s)
960 ssl_cert_clear_certs(s->cert);
963 void SSL_free(SSL *s)
970 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
971 REF_PRINT_COUNT("SSL", s);
974 REF_ASSERT_ISNT(i < 0);
976 X509_VERIFY_PARAM_free(s->param);
977 dane_final(&s->dane);
978 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
980 ssl_free_wbio_buffer(s);
982 BIO_free_all(s->wbio);
983 BIO_free_all(s->rbio);
985 BUF_MEM_free(s->init_buf);
987 /* add extra stuff */
988 sk_SSL_CIPHER_free(s->cipher_list);
989 sk_SSL_CIPHER_free(s->cipher_list_by_id);
991 /* Make the next call work :-) */
992 if (s->session != NULL) {
993 ssl_clear_bad_session(s);
994 SSL_SESSION_free(s->session);
999 ssl_cert_free(s->cert);
1000 /* Free up if allocated */
1002 OPENSSL_free(s->ext.hostname);
1003 SSL_CTX_free(s->session_ctx);
1004 #ifndef OPENSSL_NO_EC
1005 OPENSSL_free(s->ext.ecpointformats);
1006 OPENSSL_free(s->ext.supportedgroups);
1007 #endif /* OPENSSL_NO_EC */
1008 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1009 #ifndef OPENSSL_NO_OCSP
1010 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1012 #ifndef OPENSSL_NO_CT
1013 SCT_LIST_free(s->scts);
1014 OPENSSL_free(s->ext.scts);
1016 OPENSSL_free(s->ext.ocsp.resp);
1017 OPENSSL_free(s->ext.alpn);
1018 OPENSSL_free(s->ext.tls13_cookie);
1019 OPENSSL_free(s->clienthello);
1021 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1023 sk_X509_pop_free(s->verified_chain, X509_free);
1025 if (s->method != NULL)
1026 s->method->ssl_free(s);
1028 RECORD_LAYER_release(&s->rlayer);
1030 SSL_CTX_free(s->ctx);
1032 ASYNC_WAIT_CTX_free(s->waitctx);
1034 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1035 OPENSSL_free(s->ext.npn);
1038 #ifndef OPENSSL_NO_SRTP
1039 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1042 CRYPTO_THREAD_lock_free(s->lock);
1047 void SSL_set0_rbio(SSL *s, BIO *rbio)
1049 BIO_free_all(s->rbio);
1053 void SSL_set0_wbio(SSL *s, BIO *wbio)
1056 * If the output buffering BIO is still in place, remove it
1058 if (s->bbio != NULL)
1059 s->wbio = BIO_pop(s->wbio);
1061 BIO_free_all(s->wbio);
1064 /* Re-attach |bbio| to the new |wbio|. */
1065 if (s->bbio != NULL)
1066 s->wbio = BIO_push(s->bbio, s->wbio);
1069 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1072 * For historical reasons, this function has many different cases in
1073 * ownership handling.
1076 /* If nothing has changed, do nothing */
1077 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1081 * If the two arguments are equal then one fewer reference is granted by the
1082 * caller than we want to take
1084 if (rbio != NULL && rbio == wbio)
1088 * If only the wbio is changed only adopt one reference.
1090 if (rbio == SSL_get_rbio(s)) {
1091 SSL_set0_wbio(s, wbio);
1095 * There is an asymmetry here for historical reasons. If only the rbio is
1096 * changed AND the rbio and wbio were originally different, then we only
1097 * adopt one reference.
1099 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1100 SSL_set0_rbio(s, rbio);
1104 /* Otherwise, adopt both references. */
1105 SSL_set0_rbio(s, rbio);
1106 SSL_set0_wbio(s, wbio);
1109 BIO *SSL_get_rbio(const SSL *s)
1114 BIO *SSL_get_wbio(const SSL *s)
1116 if (s->bbio != NULL) {
1118 * If |bbio| is active, the true caller-configured BIO is its
1121 return BIO_next(s->bbio);
1126 int SSL_get_fd(const SSL *s)
1128 return SSL_get_rfd(s);
1131 int SSL_get_rfd(const SSL *s)
1136 b = SSL_get_rbio(s);
1137 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1139 BIO_get_fd(r, &ret);
1143 int SSL_get_wfd(const SSL *s)
1148 b = SSL_get_wbio(s);
1149 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1151 BIO_get_fd(r, &ret);
1155 #ifndef OPENSSL_NO_SOCK
1156 int SSL_set_fd(SSL *s, int fd)
1161 bio = BIO_new(BIO_s_socket());
1164 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1167 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1168 SSL_set_bio(s, bio, bio);
1174 int SSL_set_wfd(SSL *s, int fd)
1176 BIO *rbio = SSL_get_rbio(s);
1178 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1179 || (int)BIO_get_fd(rbio, NULL) != fd) {
1180 BIO *bio = BIO_new(BIO_s_socket());
1183 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1186 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1187 SSL_set0_wbio(s, bio);
1190 SSL_set0_wbio(s, rbio);
1195 int SSL_set_rfd(SSL *s, int fd)
1197 BIO *wbio = SSL_get_wbio(s);
1199 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1200 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1201 BIO *bio = BIO_new(BIO_s_socket());
1204 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1207 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1208 SSL_set0_rbio(s, bio);
1211 SSL_set0_rbio(s, wbio);
1218 /* return length of latest Finished message we sent, copy to 'buf' */
1219 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1223 if (s->s3 != NULL) {
1224 ret = s->s3->tmp.finish_md_len;
1227 memcpy(buf, s->s3->tmp.finish_md, count);
1232 /* return length of latest Finished message we expected, copy to 'buf' */
1233 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1237 if (s->s3 != NULL) {
1238 ret = s->s3->tmp.peer_finish_md_len;
1241 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1246 int SSL_get_verify_mode(const SSL *s)
1248 return (s->verify_mode);
1251 int SSL_get_verify_depth(const SSL *s)
1253 return X509_VERIFY_PARAM_get_depth(s->param);
1256 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1257 return (s->verify_callback);
1260 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1262 return (ctx->verify_mode);
1265 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1267 return X509_VERIFY_PARAM_get_depth(ctx->param);
1270 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1271 return (ctx->default_verify_callback);
1274 void SSL_set_verify(SSL *s, int mode,
1275 int (*callback) (int ok, X509_STORE_CTX *ctx))
1277 s->verify_mode = mode;
1278 if (callback != NULL)
1279 s->verify_callback = callback;
1282 void SSL_set_verify_depth(SSL *s, int depth)
1284 X509_VERIFY_PARAM_set_depth(s->param, depth);
1287 void SSL_set_read_ahead(SSL *s, int yes)
1289 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1292 int SSL_get_read_ahead(const SSL *s)
1294 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1297 int SSL_pending(const SSL *s)
1299 size_t pending = s->method->ssl_pending(s);
1302 * SSL_pending cannot work properly if read-ahead is enabled
1303 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1304 * impossible to fix since SSL_pending cannot report errors that may be
1305 * observed while scanning the new data. (Note that SSL_pending() is
1306 * often used as a boolean value, so we'd better not return -1.)
1308 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1309 * we just return INT_MAX.
1311 return pending < INT_MAX ? (int)pending : INT_MAX;
1314 int SSL_has_pending(const SSL *s)
1317 * Similar to SSL_pending() but returns a 1 to indicate that we have
1318 * unprocessed data available or 0 otherwise (as opposed to the number of
1319 * bytes available). Unlike SSL_pending() this will take into account
1320 * read_ahead data. A 1 return simply indicates that we have unprocessed
1321 * data. That data may not result in any application data, or we may fail
1322 * to parse the records for some reason.
1324 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1327 return RECORD_LAYER_read_pending(&s->rlayer);
1330 X509 *SSL_get_peer_certificate(const SSL *s)
1334 if ((s == NULL) || (s->session == NULL))
1337 r = s->session->peer;
1347 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1351 if ((s == NULL) || (s->session == NULL))
1354 r = s->session->peer_chain;
1357 * If we are a client, cert_chain includes the peer's own certificate; if
1358 * we are a server, it does not.
1365 * Now in theory, since the calling process own 't' it should be safe to
1366 * modify. We need to be able to read f without being hassled
1368 int SSL_copy_session_id(SSL *t, const SSL *f)
1371 /* Do we need to to SSL locking? */
1372 if (!SSL_set_session(t, SSL_get_session(f))) {
1377 * what if we are setup for one protocol version but want to talk another
1379 if (t->method != f->method) {
1380 t->method->ssl_free(t);
1381 t->method = f->method;
1382 if (t->method->ssl_new(t) == 0)
1386 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1387 ssl_cert_free(t->cert);
1389 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1396 /* Fix this so it checks all the valid key/cert options */
1397 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1399 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1400 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1403 if (ctx->cert->key->privatekey == NULL) {
1404 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1407 return (X509_check_private_key
1408 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1411 /* Fix this function so that it takes an optional type parameter */
1412 int SSL_check_private_key(const SSL *ssl)
1415 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1418 if (ssl->cert->key->x509 == NULL) {
1419 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1422 if (ssl->cert->key->privatekey == NULL) {
1423 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1426 return (X509_check_private_key(ssl->cert->key->x509,
1427 ssl->cert->key->privatekey));
1430 int SSL_waiting_for_async(SSL *s)
1438 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1440 ASYNC_WAIT_CTX *ctx = s->waitctx;
1444 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1447 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1448 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1450 ASYNC_WAIT_CTX *ctx = s->waitctx;
1454 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1458 int SSL_accept(SSL *s)
1460 if (s->handshake_func == NULL) {
1461 /* Not properly initialized yet */
1462 SSL_set_accept_state(s);
1465 return SSL_do_handshake(s);
1468 int SSL_connect(SSL *s)
1470 if (s->handshake_func == NULL) {
1471 /* Not properly initialized yet */
1472 SSL_set_connect_state(s);
1475 return SSL_do_handshake(s);
1478 long SSL_get_default_timeout(const SSL *s)
1480 return (s->method->get_timeout());
1483 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1484 int (*func) (void *))
1487 if (s->waitctx == NULL) {
1488 s->waitctx = ASYNC_WAIT_CTX_new();
1489 if (s->waitctx == NULL)
1492 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1493 sizeof(struct ssl_async_args))) {
1495 s->rwstate = SSL_NOTHING;
1496 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1499 s->rwstate = SSL_ASYNC_PAUSED;
1502 s->rwstate = SSL_ASYNC_NO_JOBS;
1508 s->rwstate = SSL_NOTHING;
1509 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1510 /* Shouldn't happen */
1515 static int ssl_io_intern(void *vargs)
1517 struct ssl_async_args *args;
1522 args = (struct ssl_async_args *)vargs;
1526 switch (args->type) {
1528 return args->f.func_read(s, buf, num, &s->asyncrw);
1530 return args->f.func_write(s, buf, num, &s->asyncrw);
1532 return args->f.func_other(s);
1537 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1539 if (s->handshake_func == NULL) {
1540 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1544 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1545 s->rwstate = SSL_NOTHING;
1549 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1550 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1551 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1555 * If we are a client and haven't received the ServerHello etc then we
1558 ossl_statem_check_finish_init(s, 0);
1560 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1561 struct ssl_async_args args;
1567 args.type = READFUNC;
1568 args.f.func_read = s->method->ssl_read;
1570 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1571 *readbytes = s->asyncrw;
1574 return s->method->ssl_read(s, buf, num, readbytes);
1578 int SSL_read(SSL *s, void *buf, int num)
1584 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1588 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1591 * The cast is safe here because ret should be <= INT_MAX because num is
1595 ret = (int)readbytes;
1600 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1602 int ret = ssl_read_internal(s, buf, num, readbytes);
1609 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1614 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1615 return SSL_READ_EARLY_DATA_ERROR;
1618 switch (s->early_data_state) {
1619 case SSL_EARLY_DATA_NONE:
1620 if (!SSL_in_before(s)) {
1621 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1622 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1623 return SSL_READ_EARLY_DATA_ERROR;
1627 case SSL_EARLY_DATA_ACCEPT_RETRY:
1628 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1629 ret = SSL_accept(s);
1632 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1633 return SSL_READ_EARLY_DATA_ERROR;
1637 case SSL_EARLY_DATA_READ_RETRY:
1638 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1639 s->early_data_state = SSL_EARLY_DATA_READING;
1640 ret = SSL_read_ex(s, buf, num, readbytes);
1642 * State machine will update early_data_state to
1643 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1646 if (ret > 0 || (ret <= 0 && s->early_data_state
1647 != SSL_EARLY_DATA_FINISHED_READING)) {
1648 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1649 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1650 : SSL_READ_EARLY_DATA_ERROR;
1653 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1656 return SSL_READ_EARLY_DATA_FINISH;
1659 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1660 return SSL_READ_EARLY_DATA_ERROR;
1664 int SSL_get_early_data_status(const SSL *s)
1666 return s->ext.early_data;
1669 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1671 if (s->handshake_func == NULL) {
1672 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1676 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1679 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1680 struct ssl_async_args args;
1686 args.type = READFUNC;
1687 args.f.func_read = s->method->ssl_peek;
1689 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1690 *readbytes = s->asyncrw;
1693 return s->method->ssl_peek(s, buf, num, readbytes);
1697 int SSL_peek(SSL *s, void *buf, int num)
1703 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1707 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1710 * The cast is safe here because ret should be <= INT_MAX because num is
1714 ret = (int)readbytes;
1720 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1722 int ret = ssl_peek_internal(s, buf, num, readbytes);
1729 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1731 if (s->handshake_func == NULL) {
1732 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1736 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1737 s->rwstate = SSL_NOTHING;
1738 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1742 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1743 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1744 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1745 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1748 /* If we are a client and haven't sent the Finished we better do that */
1749 ossl_statem_check_finish_init(s, 1);
1751 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1753 struct ssl_async_args args;
1756 args.buf = (void *)buf;
1758 args.type = WRITEFUNC;
1759 args.f.func_write = s->method->ssl_write;
1761 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1762 *written = s->asyncrw;
1765 return s->method->ssl_write(s, buf, num, written);
1769 int SSL_write(SSL *s, const void *buf, int num)
1775 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1779 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1782 * The cast is safe here because ret should be <= INT_MAX because num is
1791 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1793 int ret = ssl_write_internal(s, buf, num, written);
1800 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1804 switch (s->early_data_state) {
1805 case SSL_EARLY_DATA_NONE:
1807 || !SSL_in_before(s)
1808 || s->session == NULL
1809 || s->session->ext.max_early_data == 0) {
1810 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1811 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1816 case SSL_EARLY_DATA_CONNECT_RETRY:
1817 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1818 ret = SSL_connect(s);
1821 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1826 case SSL_EARLY_DATA_WRITE_RETRY:
1827 s->early_data_state = SSL_EARLY_DATA_WRITING;
1828 ret = SSL_write_ex(s, buf, num, written);
1829 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
1832 case SSL_EARLY_DATA_READ_RETRY:
1833 /* We are a server writing to an unauthenticated client */
1834 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
1835 ret = SSL_write_ex(s, buf, num, written);
1836 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1840 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1845 int SSL_shutdown(SSL *s)
1848 * Note that this function behaves differently from what one might
1849 * expect. Return values are 0 for no success (yet), 1 for success; but
1850 * calling it once is usually not enough, even if blocking I/O is used
1851 * (see ssl3_shutdown).
1854 if (s->handshake_func == NULL) {
1855 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1859 if (!SSL_in_init(s)) {
1860 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1861 struct ssl_async_args args;
1864 args.type = OTHERFUNC;
1865 args.f.func_other = s->method->ssl_shutdown;
1867 return ssl_start_async_job(s, &args, ssl_io_intern);
1869 return s->method->ssl_shutdown(s);
1872 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1877 int SSL_key_update(SSL *s, int updatetype)
1880 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
1881 * negotiated, and that it is appropriate to call SSL_key_update() instead
1882 * of SSL_renegotiate().
1884 if (!SSL_IS_TLS13(s)) {
1885 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1889 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1890 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1891 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1895 if (!SSL_is_init_finished(s)) {
1896 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1900 ossl_statem_set_in_init(s, 1);
1901 s->key_update = updatetype;
1905 int SSL_get_key_update_type(SSL *s)
1907 return s->key_update;
1910 int SSL_renegotiate(SSL *s)
1912 if (SSL_IS_TLS13(s)) {
1913 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1917 if (s->renegotiate == 0)
1922 return (s->method->ssl_renegotiate(s));
1925 int SSL_renegotiate_abbreviated(SSL *s)
1927 if (SSL_IS_TLS13(s))
1930 if (s->renegotiate == 0)
1935 return (s->method->ssl_renegotiate(s));
1938 int SSL_renegotiate_pending(SSL *s)
1941 * becomes true when negotiation is requested; false again once a
1942 * handshake has finished
1944 return (s->renegotiate != 0);
1947 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1952 case SSL_CTRL_GET_READ_AHEAD:
1953 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1954 case SSL_CTRL_SET_READ_AHEAD:
1955 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1956 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1959 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1960 s->msg_callback_arg = parg;
1964 return (s->mode |= larg);
1965 case SSL_CTRL_CLEAR_MODE:
1966 return (s->mode &= ~larg);
1967 case SSL_CTRL_GET_MAX_CERT_LIST:
1968 return (long)(s->max_cert_list);
1969 case SSL_CTRL_SET_MAX_CERT_LIST:
1972 l = (long)s->max_cert_list;
1973 s->max_cert_list = (size_t)larg;
1975 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1976 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1978 s->max_send_fragment = larg;
1979 if (s->max_send_fragment < s->split_send_fragment)
1980 s->split_send_fragment = s->max_send_fragment;
1982 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1983 if ((size_t)larg > s->max_send_fragment || larg == 0)
1985 s->split_send_fragment = larg;
1987 case SSL_CTRL_SET_MAX_PIPELINES:
1988 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1990 s->max_pipelines = larg;
1992 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1994 case SSL_CTRL_GET_RI_SUPPORT:
1996 return s->s3->send_connection_binding;
1999 case SSL_CTRL_CERT_FLAGS:
2000 return (s->cert->cert_flags |= larg);
2001 case SSL_CTRL_CLEAR_CERT_FLAGS:
2002 return (s->cert->cert_flags &= ~larg);
2004 case SSL_CTRL_GET_RAW_CIPHERLIST:
2006 if (s->s3->tmp.ciphers_raw == NULL)
2008 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2009 return (int)s->s3->tmp.ciphers_rawlen;
2011 return TLS_CIPHER_LEN;
2013 case SSL_CTRL_GET_EXTMS_SUPPORT:
2014 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2016 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2020 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2021 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2022 &s->min_proto_version);
2023 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2024 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2025 &s->max_proto_version);
2027 return (s->method->ssl_ctrl(s, cmd, larg, parg));
2031 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2034 case SSL_CTRL_SET_MSG_CALLBACK:
2035 s->msg_callback = (void (*)
2036 (int write_p, int version, int content_type,
2037 const void *buf, size_t len, SSL *ssl,
2042 return (s->method->ssl_callback_ctrl(s, cmd, fp));
2046 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2048 return ctx->sessions;
2051 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2054 /* For some cases with ctx == NULL perform syntax checks */
2057 #ifndef OPENSSL_NO_EC
2058 case SSL_CTRL_SET_GROUPS_LIST:
2059 return tls1_set_groups_list(NULL, NULL, parg);
2061 case SSL_CTRL_SET_SIGALGS_LIST:
2062 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2063 return tls1_set_sigalgs_list(NULL, parg, 0);
2070 case SSL_CTRL_GET_READ_AHEAD:
2071 return (ctx->read_ahead);
2072 case SSL_CTRL_SET_READ_AHEAD:
2073 l = ctx->read_ahead;
2074 ctx->read_ahead = larg;
2077 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2078 ctx->msg_callback_arg = parg;
2081 case SSL_CTRL_GET_MAX_CERT_LIST:
2082 return (long)(ctx->max_cert_list);
2083 case SSL_CTRL_SET_MAX_CERT_LIST:
2086 l = (long)ctx->max_cert_list;
2087 ctx->max_cert_list = (size_t)larg;
2090 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2093 l = (long)ctx->session_cache_size;
2094 ctx->session_cache_size = (size_t)larg;
2096 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2097 return (long)(ctx->session_cache_size);
2098 case SSL_CTRL_SET_SESS_CACHE_MODE:
2099 l = ctx->session_cache_mode;
2100 ctx->session_cache_mode = larg;
2102 case SSL_CTRL_GET_SESS_CACHE_MODE:
2103 return (ctx->session_cache_mode);
2105 case SSL_CTRL_SESS_NUMBER:
2106 return (lh_SSL_SESSION_num_items(ctx->sessions));
2107 case SSL_CTRL_SESS_CONNECT:
2108 return (ctx->stats.sess_connect);
2109 case SSL_CTRL_SESS_CONNECT_GOOD:
2110 return (ctx->stats.sess_connect_good);
2111 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2112 return (ctx->stats.sess_connect_renegotiate);
2113 case SSL_CTRL_SESS_ACCEPT:
2114 return (ctx->stats.sess_accept);
2115 case SSL_CTRL_SESS_ACCEPT_GOOD:
2116 return (ctx->stats.sess_accept_good);
2117 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2118 return (ctx->stats.sess_accept_renegotiate);
2119 case SSL_CTRL_SESS_HIT:
2120 return (ctx->stats.sess_hit);
2121 case SSL_CTRL_SESS_CB_HIT:
2122 return (ctx->stats.sess_cb_hit);
2123 case SSL_CTRL_SESS_MISSES:
2124 return (ctx->stats.sess_miss);
2125 case SSL_CTRL_SESS_TIMEOUTS:
2126 return (ctx->stats.sess_timeout);
2127 case SSL_CTRL_SESS_CACHE_FULL:
2128 return (ctx->stats.sess_cache_full);
2130 return (ctx->mode |= larg);
2131 case SSL_CTRL_CLEAR_MODE:
2132 return (ctx->mode &= ~larg);
2133 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2134 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2136 ctx->max_send_fragment = larg;
2137 if (ctx->max_send_fragment < ctx->split_send_fragment)
2138 ctx->split_send_fragment = ctx->max_send_fragment;
2140 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2141 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2143 ctx->split_send_fragment = larg;
2145 case SSL_CTRL_SET_MAX_PIPELINES:
2146 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2148 ctx->max_pipelines = larg;
2150 case SSL_CTRL_CERT_FLAGS:
2151 return (ctx->cert->cert_flags |= larg);
2152 case SSL_CTRL_CLEAR_CERT_FLAGS:
2153 return (ctx->cert->cert_flags &= ~larg);
2154 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2155 return ssl_set_version_bound(ctx->method->version, (int)larg,
2156 &ctx->min_proto_version);
2157 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2158 return ssl_set_version_bound(ctx->method->version, (int)larg,
2159 &ctx->max_proto_version);
2161 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2165 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2168 case SSL_CTRL_SET_MSG_CALLBACK:
2169 ctx->msg_callback = (void (*)
2170 (int write_p, int version, int content_type,
2171 const void *buf, size_t len, SSL *ssl,
2176 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2180 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2189 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2190 const SSL_CIPHER *const *bp)
2192 if ((*ap)->id > (*bp)->id)
2194 if ((*ap)->id < (*bp)->id)
2199 /** return a STACK of the ciphers available for the SSL and in order of
2201 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2204 if (s->cipher_list != NULL) {
2205 return (s->cipher_list);
2206 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2207 return (s->ctx->cipher_list);
2213 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2215 if ((s == NULL) || (s->session == NULL) || !s->server)
2217 return s->session->ciphers;
2220 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2222 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2224 ciphers = SSL_get_ciphers(s);
2227 ssl_set_client_disabled(s);
2228 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2229 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2230 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
2232 sk = sk_SSL_CIPHER_new_null();
2235 if (!sk_SSL_CIPHER_push(sk, c)) {
2236 sk_SSL_CIPHER_free(sk);
2244 /** return a STACK of the ciphers available for the SSL and in order of
2246 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2249 if (s->cipher_list_by_id != NULL) {
2250 return (s->cipher_list_by_id);
2251 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2252 return (s->ctx->cipher_list_by_id);
2258 /** The old interface to get the same thing as SSL_get_ciphers() */
2259 const char *SSL_get_cipher_list(const SSL *s, int n)
2261 const SSL_CIPHER *c;
2262 STACK_OF(SSL_CIPHER) *sk;
2266 sk = SSL_get_ciphers(s);
2267 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2269 c = sk_SSL_CIPHER_value(sk, n);
2275 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2277 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2280 return ctx->cipher_list;
2284 /** specify the ciphers to be used by default by the SSL_CTX */
2285 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2287 STACK_OF(SSL_CIPHER) *sk;
2289 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2290 &ctx->cipher_list_by_id, str, ctx->cert);
2292 * ssl_create_cipher_list may return an empty stack if it was unable to
2293 * find a cipher matching the given rule string (for example if the rule
2294 * string specifies a cipher which has been disabled). This is not an
2295 * error as far as ssl_create_cipher_list is concerned, and hence
2296 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2300 else if (sk_SSL_CIPHER_num(sk) == 0) {
2301 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2307 /** specify the ciphers to be used by the SSL */
2308 int SSL_set_cipher_list(SSL *s, const char *str)
2310 STACK_OF(SSL_CIPHER) *sk;
2312 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2313 &s->cipher_list_by_id, str, s->cert);
2314 /* see comment in SSL_CTX_set_cipher_list */
2317 else if (sk_SSL_CIPHER_num(sk) == 0) {
2318 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2324 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2327 STACK_OF(SSL_CIPHER) *sk;
2328 const SSL_CIPHER *c;
2331 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2335 sk = s->session->ciphers;
2337 if (sk_SSL_CIPHER_num(sk) == 0)
2340 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2343 c = sk_SSL_CIPHER_value(sk, i);
2344 n = strlen(c->name);
2351 memcpy(p, c->name, n + 1);
2360 /** return a servername extension value if provided in Client Hello, or NULL.
2361 * So far, only host_name types are defined (RFC 3546).
2364 const char *SSL_get_servername(const SSL *s, const int type)
2366 if (type != TLSEXT_NAMETYPE_host_name)
2369 return s->session && !s->ext.hostname ?
2370 s->session->ext.hostname : s->ext.hostname;
2373 int SSL_get_servername_type(const SSL *s)
2376 && (!s->ext.hostname ? s->session->
2377 ext.hostname : s->ext.hostname))
2378 return TLSEXT_NAMETYPE_host_name;
2383 * SSL_select_next_proto implements the standard protocol selection. It is
2384 * expected that this function is called from the callback set by
2385 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2386 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2387 * not included in the length. A byte string of length 0 is invalid. No byte
2388 * string may be truncated. The current, but experimental algorithm for
2389 * selecting the protocol is: 1) If the server doesn't support NPN then this
2390 * is indicated to the callback. In this case, the client application has to
2391 * abort the connection or have a default application level protocol. 2) If
2392 * the server supports NPN, but advertises an empty list then the client
2393 * selects the first protocol in its list, but indicates via the API that this
2394 * fallback case was enacted. 3) Otherwise, the client finds the first
2395 * protocol in the server's list that it supports and selects this protocol.
2396 * This is because it's assumed that the server has better information about
2397 * which protocol a client should use. 4) If the client doesn't support any
2398 * of the server's advertised protocols, then this is treated the same as
2399 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2400 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2402 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2403 const unsigned char *server,
2404 unsigned int server_len,
2405 const unsigned char *client, unsigned int client_len)
2408 const unsigned char *result;
2409 int status = OPENSSL_NPN_UNSUPPORTED;
2412 * For each protocol in server preference order, see if we support it.
2414 for (i = 0; i < server_len;) {
2415 for (j = 0; j < client_len;) {
2416 if (server[i] == client[j] &&
2417 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2418 /* We found a match */
2419 result = &server[i];
2420 status = OPENSSL_NPN_NEGOTIATED;
2430 /* There's no overlap between our protocols and the server's list. */
2432 status = OPENSSL_NPN_NO_OVERLAP;
2435 *out = (unsigned char *)result + 1;
2436 *outlen = result[0];
2440 #ifndef OPENSSL_NO_NEXTPROTONEG
2442 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2443 * client's requested protocol for this connection and returns 0. If the
2444 * client didn't request any protocol, then *data is set to NULL. Note that
2445 * the client can request any protocol it chooses. The value returned from
2446 * this function need not be a member of the list of supported protocols
2447 * provided by the callback.
2449 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2456 *len = (unsigned int)s->ext.npn_len;
2461 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2462 * a TLS server needs a list of supported protocols for Next Protocol
2463 * Negotiation. The returned list must be in wire format. The list is
2464 * returned by setting |out| to point to it and |outlen| to its length. This
2465 * memory will not be modified, but one should assume that the SSL* keeps a
2466 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2467 * wishes to advertise. Otherwise, no such extension will be included in the
2470 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2471 SSL_CTX_npn_advertised_cb_func cb,
2474 ctx->ext.npn_advertised_cb = cb;
2475 ctx->ext.npn_advertised_cb_arg = arg;
2479 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2480 * client needs to select a protocol from the server's provided list. |out|
2481 * must be set to point to the selected protocol (which may be within |in|).
2482 * The length of the protocol name must be written into |outlen|. The
2483 * server's advertised protocols are provided in |in| and |inlen|. The
2484 * callback can assume that |in| is syntactically valid. The client must
2485 * select a protocol. It is fatal to the connection if this callback returns
2486 * a value other than SSL_TLSEXT_ERR_OK.
2488 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2489 SSL_CTX_npn_select_cb_func cb,
2492 ctx->ext.npn_select_cb = cb;
2493 ctx->ext.npn_select_cb_arg = arg;
2498 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2499 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2500 * length-prefixed strings). Returns 0 on success.
2502 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2503 unsigned int protos_len)
2505 OPENSSL_free(ctx->ext.alpn);
2506 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2507 if (ctx->ext.alpn == NULL) {
2508 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2511 ctx->ext.alpn_len = protos_len;
2517 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2518 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2519 * length-prefixed strings). Returns 0 on success.
2521 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2522 unsigned int protos_len)
2524 OPENSSL_free(ssl->ext.alpn);
2525 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2526 if (ssl->ext.alpn == NULL) {
2527 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2530 ssl->ext.alpn_len = protos_len;
2536 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2537 * called during ClientHello processing in order to select an ALPN protocol
2538 * from the client's list of offered protocols.
2540 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2541 SSL_CTX_alpn_select_cb_func cb,
2544 ctx->ext.alpn_select_cb = cb;
2545 ctx->ext.alpn_select_cb_arg = arg;
2549 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2550 * On return it sets |*data| to point to |*len| bytes of protocol name
2551 * (not including the leading length-prefix byte). If the server didn't
2552 * respond with a negotiated protocol then |*len| will be zero.
2554 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2559 *data = ssl->s3->alpn_selected;
2563 *len = (unsigned int)ssl->s3->alpn_selected_len;
2566 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2567 const char *label, size_t llen,
2568 const unsigned char *p, size_t plen,
2571 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2574 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2579 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2581 const unsigned char *session_id = a->session_id;
2583 unsigned char tmp_storage[4];
2585 if (a->session_id_length < sizeof(tmp_storage)) {
2586 memset(tmp_storage, 0, sizeof(tmp_storage));
2587 memcpy(tmp_storage, a->session_id, a->session_id_length);
2588 session_id = tmp_storage;
2592 ((unsigned long)session_id[0]) |
2593 ((unsigned long)session_id[1] << 8L) |
2594 ((unsigned long)session_id[2] << 16L) |
2595 ((unsigned long)session_id[3] << 24L);
2600 * NB: If this function (or indeed the hash function which uses a sort of
2601 * coarser function than this one) is changed, ensure
2602 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2603 * being able to construct an SSL_SESSION that will collide with any existing
2604 * session with a matching session ID.
2606 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2608 if (a->ssl_version != b->ssl_version)
2610 if (a->session_id_length != b->session_id_length)
2612 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2616 * These wrapper functions should remain rather than redeclaring
2617 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2618 * variable. The reason is that the functions aren't static, they're exposed
2622 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2624 SSL_CTX *ret = NULL;
2627 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2631 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2634 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2635 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2638 ret = OPENSSL_zalloc(sizeof(*ret));
2643 ret->min_proto_version = 0;
2644 ret->max_proto_version = 0;
2645 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2646 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2647 /* We take the system default. */
2648 ret->session_timeout = meth->get_timeout();
2649 ret->references = 1;
2650 ret->lock = CRYPTO_THREAD_lock_new();
2651 if (ret->lock == NULL) {
2652 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2656 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2657 ret->verify_mode = SSL_VERIFY_NONE;
2658 if ((ret->cert = ssl_cert_new()) == NULL)
2661 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2662 if (ret->sessions == NULL)
2664 ret->cert_store = X509_STORE_new();
2665 if (ret->cert_store == NULL)
2667 #ifndef OPENSSL_NO_CT
2668 ret->ctlog_store = CTLOG_STORE_new();
2669 if (ret->ctlog_store == NULL)
2672 if (!ssl_create_cipher_list(ret->method,
2673 &ret->cipher_list, &ret->cipher_list_by_id,
2674 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2675 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2676 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2680 ret->param = X509_VERIFY_PARAM_new();
2681 if (ret->param == NULL)
2684 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2685 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2688 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2689 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2693 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2696 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2699 /* No compression for DTLS */
2700 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2701 ret->comp_methods = SSL_COMP_get_compression_methods();
2703 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2704 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2706 /* Setup RFC5077 ticket keys */
2707 if ((RAND_bytes(ret->ext.tick_key_name,
2708 sizeof(ret->ext.tick_key_name)) <= 0)
2709 || (RAND_bytes(ret->ext.tick_hmac_key,
2710 sizeof(ret->ext.tick_hmac_key)) <= 0)
2711 || (RAND_bytes(ret->ext.tick_aes_key,
2712 sizeof(ret->ext.tick_aes_key)) <= 0))
2713 ret->options |= SSL_OP_NO_TICKET;
2715 #ifndef OPENSSL_NO_SRP
2716 if (!SSL_CTX_SRP_CTX_init(ret))
2719 #ifndef OPENSSL_NO_ENGINE
2720 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2721 # define eng_strx(x) #x
2722 # define eng_str(x) eng_strx(x)
2723 /* Use specific client engine automatically... ignore errors */
2726 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2729 ENGINE_load_builtin_engines();
2730 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2732 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2738 * Default is to connect to non-RI servers. When RI is more widely
2739 * deployed might change this.
2741 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2743 * Disable compression by default to prevent CRIME. Applications can
2744 * re-enable compression by configuring
2745 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2746 * or by using the SSL_CONF library.
2748 ret->options |= SSL_OP_NO_COMPRESSION;
2750 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2753 * Default max early data is a fully loaded single record. Could be split
2754 * across multiple records in practice
2756 ret->max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
2760 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2766 int SSL_CTX_up_ref(SSL_CTX *ctx)
2770 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2773 REF_PRINT_COUNT("SSL_CTX", ctx);
2774 REF_ASSERT_ISNT(i < 2);
2775 return ((i > 1) ? 1 : 0);
2778 void SSL_CTX_free(SSL_CTX *a)
2785 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2786 REF_PRINT_COUNT("SSL_CTX", a);
2789 REF_ASSERT_ISNT(i < 0);
2791 X509_VERIFY_PARAM_free(a->param);
2792 dane_ctx_final(&a->dane);
2795 * Free internal session cache. However: the remove_cb() may reference
2796 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2797 * after the sessions were flushed.
2798 * As the ex_data handling routines might also touch the session cache,
2799 * the most secure solution seems to be: empty (flush) the cache, then
2800 * free ex_data, then finally free the cache.
2801 * (See ticket [openssl.org #212].)
2803 if (a->sessions != NULL)
2804 SSL_CTX_flush_sessions(a, 0);
2806 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2807 lh_SSL_SESSION_free(a->sessions);
2808 X509_STORE_free(a->cert_store);
2809 #ifndef OPENSSL_NO_CT
2810 CTLOG_STORE_free(a->ctlog_store);
2812 sk_SSL_CIPHER_free(a->cipher_list);
2813 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2814 ssl_cert_free(a->cert);
2815 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2816 sk_X509_pop_free(a->extra_certs, X509_free);
2817 a->comp_methods = NULL;
2818 #ifndef OPENSSL_NO_SRTP
2819 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2821 #ifndef OPENSSL_NO_SRP
2822 SSL_CTX_SRP_CTX_free(a);
2824 #ifndef OPENSSL_NO_ENGINE
2825 ENGINE_finish(a->client_cert_engine);
2828 #ifndef OPENSSL_NO_EC
2829 OPENSSL_free(a->ext.ecpointformats);
2830 OPENSSL_free(a->ext.supportedgroups);
2832 OPENSSL_free(a->ext.alpn);
2834 CRYPTO_THREAD_lock_free(a->lock);
2839 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2841 ctx->default_passwd_callback = cb;
2844 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2846 ctx->default_passwd_callback_userdata = u;
2849 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2851 return ctx->default_passwd_callback;
2854 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2856 return ctx->default_passwd_callback_userdata;
2859 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2861 s->default_passwd_callback = cb;
2864 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2866 s->default_passwd_callback_userdata = u;
2869 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2871 return s->default_passwd_callback;
2874 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2876 return s->default_passwd_callback_userdata;
2879 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2880 int (*cb) (X509_STORE_CTX *, void *),
2883 ctx->app_verify_callback = cb;
2884 ctx->app_verify_arg = arg;
2887 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2888 int (*cb) (int, X509_STORE_CTX *))
2890 ctx->verify_mode = mode;
2891 ctx->default_verify_callback = cb;
2894 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2896 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2899 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2901 ssl_cert_set_cert_cb(c->cert, cb, arg);
2904 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2906 ssl_cert_set_cert_cb(s->cert, cb, arg);
2909 void ssl_set_masks(SSL *s)
2912 uint32_t *pvalid = s->s3->tmp.valid_flags;
2913 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2914 unsigned long mask_k, mask_a;
2915 #ifndef OPENSSL_NO_EC
2916 int have_ecc_cert, ecdsa_ok;
2921 #ifndef OPENSSL_NO_DH
2922 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2927 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2928 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2929 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
2930 #ifndef OPENSSL_NO_EC
2931 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2937 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2938 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2941 #ifndef OPENSSL_NO_GOST
2942 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2943 mask_k |= SSL_kGOST;
2944 mask_a |= SSL_aGOST12;
2946 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2947 mask_k |= SSL_kGOST;
2948 mask_a |= SSL_aGOST12;
2950 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2951 mask_k |= SSL_kGOST;
2952 mask_a |= SSL_aGOST01;
2962 if (rsa_enc || rsa_sign) {
2970 mask_a |= SSL_aNULL;
2973 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2974 * depending on the key usage extension.
2976 #ifndef OPENSSL_NO_EC
2977 if (have_ecc_cert) {
2979 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
2980 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2981 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2984 mask_a |= SSL_aECDSA;
2988 #ifndef OPENSSL_NO_EC
2989 mask_k |= SSL_kECDHE;
2992 #ifndef OPENSSL_NO_PSK
2995 if (mask_k & SSL_kRSA)
2996 mask_k |= SSL_kRSAPSK;
2997 if (mask_k & SSL_kDHE)
2998 mask_k |= SSL_kDHEPSK;
2999 if (mask_k & SSL_kECDHE)
3000 mask_k |= SSL_kECDHEPSK;
3003 s->s3->tmp.mask_k = mask_k;
3004 s->s3->tmp.mask_a = mask_a;
3007 #ifndef OPENSSL_NO_EC
3009 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3011 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3012 /* key usage, if present, must allow signing */
3013 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3014 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3015 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3019 return 1; /* all checks are ok */
3024 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3025 size_t *serverinfo_length)
3027 CERT_PKEY *cpk = s->s3->tmp.cert;
3028 *serverinfo_length = 0;
3030 if (cpk == NULL || cpk->serverinfo == NULL)
3033 *serverinfo = cpk->serverinfo;
3034 *serverinfo_length = cpk->serverinfo_length;
3038 void ssl_update_cache(SSL *s, int mode)
3043 * If the session_id_length is 0, we are not supposed to cache it, and it
3044 * would be rather hard to do anyway :-)
3046 if (s->session->session_id_length == 0)
3049 i = s->session_ctx->session_cache_mode;
3050 if ((i & mode) && (!s->hit)
3051 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
3052 || SSL_CTX_add_session(s->session_ctx, s->session))
3053 && (s->session_ctx->new_session_cb != NULL)) {
3054 SSL_SESSION_up_ref(s->session);
3055 if (!s->session_ctx->new_session_cb(s, s->session))
3056 SSL_SESSION_free(s->session);
3059 /* auto flush every 255 connections */
3060 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3061 if ((((mode & SSL_SESS_CACHE_CLIENT)
3062 ? s->session_ctx->stats.sess_connect_good
3063 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
3064 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3069 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3074 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3079 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3083 if (s->method != meth) {
3084 const SSL_METHOD *sm = s->method;
3085 int (*hf) (SSL *) = s->handshake_func;
3087 if (sm->version == meth->version)
3092 ret = s->method->ssl_new(s);
3095 if (hf == sm->ssl_connect)
3096 s->handshake_func = meth->ssl_connect;
3097 else if (hf == sm->ssl_accept)
3098 s->handshake_func = meth->ssl_accept;
3103 int SSL_get_error(const SSL *s, int i)
3110 return (SSL_ERROR_NONE);
3113 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3114 * where we do encode the error
3116 if ((l = ERR_peek_error()) != 0) {
3117 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3118 return (SSL_ERROR_SYSCALL);
3120 return (SSL_ERROR_SSL);
3123 if (SSL_want_read(s)) {
3124 bio = SSL_get_rbio(s);
3125 if (BIO_should_read(bio))
3126 return (SSL_ERROR_WANT_READ);
3127 else if (BIO_should_write(bio))
3129 * This one doesn't make too much sense ... We never try to write
3130 * to the rbio, and an application program where rbio and wbio
3131 * are separate couldn't even know what it should wait for.
3132 * However if we ever set s->rwstate incorrectly (so that we have
3133 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3134 * wbio *are* the same, this test works around that bug; so it
3135 * might be safer to keep it.
3137 return (SSL_ERROR_WANT_WRITE);
3138 else if (BIO_should_io_special(bio)) {
3139 reason = BIO_get_retry_reason(bio);
3140 if (reason == BIO_RR_CONNECT)
3141 return (SSL_ERROR_WANT_CONNECT);
3142 else if (reason == BIO_RR_ACCEPT)
3143 return (SSL_ERROR_WANT_ACCEPT);
3145 return (SSL_ERROR_SYSCALL); /* unknown */
3149 if (SSL_want_write(s)) {
3150 /* Access wbio directly - in order to use the buffered bio if present */
3152 if (BIO_should_write(bio))
3153 return (SSL_ERROR_WANT_WRITE);
3154 else if (BIO_should_read(bio))
3156 * See above (SSL_want_read(s) with BIO_should_write(bio))
3158 return (SSL_ERROR_WANT_READ);
3159 else if (BIO_should_io_special(bio)) {
3160 reason = BIO_get_retry_reason(bio);
3161 if (reason == BIO_RR_CONNECT)
3162 return (SSL_ERROR_WANT_CONNECT);
3163 else if (reason == BIO_RR_ACCEPT)
3164 return (SSL_ERROR_WANT_ACCEPT);
3166 return (SSL_ERROR_SYSCALL);
3169 if (SSL_want_x509_lookup(s))
3170 return (SSL_ERROR_WANT_X509_LOOKUP);
3171 if (SSL_want_async(s))
3172 return SSL_ERROR_WANT_ASYNC;
3173 if (SSL_want_async_job(s))
3174 return SSL_ERROR_WANT_ASYNC_JOB;
3175 if (SSL_want_early(s))
3176 return SSL_ERROR_WANT_EARLY;
3178 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3179 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3180 return (SSL_ERROR_ZERO_RETURN);
3182 return (SSL_ERROR_SYSCALL);
3185 static int ssl_do_handshake_intern(void *vargs)
3187 struct ssl_async_args *args;
3190 args = (struct ssl_async_args *)vargs;
3193 return s->handshake_func(s);
3196 int SSL_do_handshake(SSL *s)
3200 if (s->handshake_func == NULL) {
3201 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3205 ossl_statem_check_finish_init(s, -1);
3207 s->method->ssl_renegotiate_check(s, 0);
3209 if (SSL_in_init(s) || SSL_in_before(s)) {
3210 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3211 struct ssl_async_args args;
3215 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3217 ret = s->handshake_func(s);
3223 void SSL_set_accept_state(SSL *s)
3227 ossl_statem_clear(s);
3228 s->handshake_func = s->method->ssl_accept;
3232 void SSL_set_connect_state(SSL *s)
3236 ossl_statem_clear(s);
3237 s->handshake_func = s->method->ssl_connect;
3241 int ssl_undefined_function(SSL *s)
3243 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3247 int ssl_undefined_void_function(void)
3249 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3250 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3254 int ssl_undefined_const_function(const SSL *s)
3259 const SSL_METHOD *ssl_bad_method(int ver)
3261 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3265 const char *ssl_protocol_to_string(int version)
3269 case TLS1_3_VERSION:
3272 case TLS1_2_VERSION:
3275 case TLS1_1_VERSION:
3290 case DTLS1_2_VERSION:
3298 const char *SSL_get_version(const SSL *s)
3300 return ssl_protocol_to_string(s->version);
3303 SSL *SSL_dup(SSL *s)
3305 STACK_OF(X509_NAME) *sk;
3310 /* If we're not quiescent, just up_ref! */
3311 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3312 CRYPTO_UP_REF(&s->references, &i, s->lock);
3317 * Otherwise, copy configuration state, and session if set.
3319 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3322 if (s->session != NULL) {
3324 * Arranges to share the same session via up_ref. This "copies"
3325 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3327 if (!SSL_copy_session_id(ret, s))
3331 * No session has been established yet, so we have to expect that
3332 * s->cert or ret->cert will be changed later -- they should not both
3333 * point to the same object, and thus we can't use
3334 * SSL_copy_session_id.
3336 if (!SSL_set_ssl_method(ret, s->method))
3339 if (s->cert != NULL) {
3340 ssl_cert_free(ret->cert);
3341 ret->cert = ssl_cert_dup(s->cert);
3342 if (ret->cert == NULL)
3346 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3347 (int)s->sid_ctx_length))
3351 if (!ssl_dane_dup(ret, s))
3353 ret->version = s->version;
3354 ret->options = s->options;
3355 ret->mode = s->mode;
3356 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3357 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3358 ret->msg_callback = s->msg_callback;
3359 ret->msg_callback_arg = s->msg_callback_arg;
3360 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3361 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3362 ret->generate_session_id = s->generate_session_id;
3364 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3366 /* copy app data, a little dangerous perhaps */
3367 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3370 /* setup rbio, and wbio */
3371 if (s->rbio != NULL) {
3372 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3375 if (s->wbio != NULL) {
3376 if (s->wbio != s->rbio) {
3377 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3380 BIO_up_ref(ret->rbio);
3381 ret->wbio = ret->rbio;
3385 ret->server = s->server;
3386 if (s->handshake_func) {
3388 SSL_set_accept_state(ret);
3390 SSL_set_connect_state(ret);
3392 ret->shutdown = s->shutdown;
3395 ret->default_passwd_callback = s->default_passwd_callback;
3396 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3398 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3400 /* dup the cipher_list and cipher_list_by_id stacks */
3401 if (s->cipher_list != NULL) {
3402 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3405 if (s->cipher_list_by_id != NULL)
3406 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3410 /* Dup the client_CA list */
3411 if (s->client_CA != NULL) {
3412 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3414 ret->client_CA = sk;
3415 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3416 xn = sk_X509_NAME_value(sk, i);
3417 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3430 void ssl_clear_cipher_ctx(SSL *s)
3432 if (s->enc_read_ctx != NULL) {
3433 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3434 s->enc_read_ctx = NULL;
3436 if (s->enc_write_ctx != NULL) {
3437 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3438 s->enc_write_ctx = NULL;
3440 #ifndef OPENSSL_NO_COMP
3441 COMP_CTX_free(s->expand);
3443 COMP_CTX_free(s->compress);
3448 X509 *SSL_get_certificate(const SSL *s)
3450 if (s->cert != NULL)
3451 return (s->cert->key->x509);
3456 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3458 if (s->cert != NULL)
3459 return (s->cert->key->privatekey);
3464 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3466 if (ctx->cert != NULL)
3467 return ctx->cert->key->x509;
3472 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3474 if (ctx->cert != NULL)
3475 return ctx->cert->key->privatekey;
3480 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3482 if ((s->session != NULL) && (s->session->cipher != NULL))
3483 return (s->session->cipher);
3487 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3489 #ifndef OPENSSL_NO_COMP
3490 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3496 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3498 #ifndef OPENSSL_NO_COMP
3499 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3505 int ssl_init_wbio_buffer(SSL *s)
3509 if (s->bbio != NULL) {
3510 /* Already buffered. */
3514 bbio = BIO_new(BIO_f_buffer());
3515 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3517 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3521 s->wbio = BIO_push(bbio, s->wbio);
3526 void ssl_free_wbio_buffer(SSL *s)
3528 /* callers ensure s is never null */
3529 if (s->bbio == NULL)
3532 s->wbio = BIO_pop(s->wbio);
3533 assert(s->wbio != NULL);
3538 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3540 ctx->quiet_shutdown = mode;
3543 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3545 return (ctx->quiet_shutdown);
3548 void SSL_set_quiet_shutdown(SSL *s, int mode)
3550 s->quiet_shutdown = mode;
3553 int SSL_get_quiet_shutdown(const SSL *s)
3555 return (s->quiet_shutdown);
3558 void SSL_set_shutdown(SSL *s, int mode)
3563 int SSL_get_shutdown(const SSL *s)
3568 int SSL_version(const SSL *s)
3573 int SSL_client_version(const SSL *s)
3575 return s->client_version;
3578 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3583 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3586 if (ssl->ctx == ctx)
3589 ctx = ssl->session_ctx;
3590 new_cert = ssl_cert_dup(ctx->cert);
3591 if (new_cert == NULL) {
3594 ssl_cert_free(ssl->cert);
3595 ssl->cert = new_cert;
3598 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3599 * so setter APIs must prevent invalid lengths from entering the system.
3601 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3604 * If the session ID context matches that of the parent SSL_CTX,
3605 * inherit it from the new SSL_CTX as well. If however the context does
3606 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3607 * leave it unchanged.
3609 if ((ssl->ctx != NULL) &&
3610 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3611 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3612 ssl->sid_ctx_length = ctx->sid_ctx_length;
3613 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3616 SSL_CTX_up_ref(ctx);
3617 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3623 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3625 return (X509_STORE_set_default_paths(ctx->cert_store));
3628 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3630 X509_LOOKUP *lookup;
3632 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3635 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3637 /* Clear any errors if the default directory does not exist */
3643 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3645 X509_LOOKUP *lookup;
3647 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3651 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3653 /* Clear any errors if the default file does not exist */
3659 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3662 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3665 void SSL_set_info_callback(SSL *ssl,
3666 void (*cb) (const SSL *ssl, int type, int val))
3668 ssl->info_callback = cb;
3672 * One compiler (Diab DCC) doesn't like argument names in returned function
3675 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3678 return ssl->info_callback;
3681 void SSL_set_verify_result(SSL *ssl, long arg)
3683 ssl->verify_result = arg;
3686 long SSL_get_verify_result(const SSL *ssl)
3688 return (ssl->verify_result);
3691 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3694 return sizeof(ssl->s3->client_random);
3695 if (outlen > sizeof(ssl->s3->client_random))
3696 outlen = sizeof(ssl->s3->client_random);
3697 memcpy(out, ssl->s3->client_random, outlen);
3701 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3704 return sizeof(ssl->s3->server_random);
3705 if (outlen > sizeof(ssl->s3->server_random))
3706 outlen = sizeof(ssl->s3->server_random);
3707 memcpy(out, ssl->s3->server_random, outlen);
3711 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3712 unsigned char *out, size_t outlen)
3715 return session->master_key_length;
3716 if (outlen > session->master_key_length)
3717 outlen = session->master_key_length;
3718 memcpy(out, session->master_key, outlen);
3722 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3724 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3727 void *SSL_get_ex_data(const SSL *s, int idx)
3729 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3732 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3734 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3737 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3739 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3742 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3744 return (ctx->cert_store);
3747 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3749 X509_STORE_free(ctx->cert_store);
3750 ctx->cert_store = store;
3753 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3756 X509_STORE_up_ref(store);
3757 SSL_CTX_set_cert_store(ctx, store);
3760 int SSL_want(const SSL *s)
3762 return (s->rwstate);
3766 * \brief Set the callback for generating temporary DH keys.
3767 * \param ctx the SSL context.
3768 * \param dh the callback
3771 #ifndef OPENSSL_NO_DH
3772 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3773 DH *(*dh) (SSL *ssl, int is_export,
3776 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3779 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3782 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3786 #ifndef OPENSSL_NO_PSK
3787 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3789 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3790 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3793 OPENSSL_free(ctx->cert->psk_identity_hint);
3794 if (identity_hint != NULL) {
3795 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3796 if (ctx->cert->psk_identity_hint == NULL)
3799 ctx->cert->psk_identity_hint = NULL;
3803 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3808 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3809 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3812 OPENSSL_free(s->cert->psk_identity_hint);
3813 if (identity_hint != NULL) {
3814 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3815 if (s->cert->psk_identity_hint == NULL)
3818 s->cert->psk_identity_hint = NULL;
3822 const char *SSL_get_psk_identity_hint(const SSL *s)
3824 if (s == NULL || s->session == NULL)
3826 return (s->session->psk_identity_hint);
3829 const char *SSL_get_psk_identity(const SSL *s)
3831 if (s == NULL || s->session == NULL)
3833 return (s->session->psk_identity);
3836 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3838 s->psk_client_callback = cb;
3841 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3843 ctx->psk_client_callback = cb;
3846 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3848 s->psk_server_callback = cb;
3851 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3853 ctx->psk_server_callback = cb;
3857 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3858 void (*cb) (int write_p, int version,
3859 int content_type, const void *buf,
3860 size_t len, SSL *ssl, void *arg))
3862 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3865 void SSL_set_msg_callback(SSL *ssl,
3866 void (*cb) (int write_p, int version,
3867 int content_type, const void *buf,
3868 size_t len, SSL *ssl, void *arg))
3870 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3873 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3874 int (*cb) (SSL *ssl,
3878 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3879 (void (*)(void))cb);
3882 void SSL_set_not_resumable_session_callback(SSL *ssl,
3883 int (*cb) (SSL *ssl,
3884 int is_forward_secure))
3886 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3887 (void (*)(void))cb);
3891 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3892 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3893 * If EVP_MD pointer is passed, initializes ctx with this |md|.
3894 * Returns the newly allocated ctx;
3897 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3899 ssl_clear_hash_ctx(hash);
3900 *hash = EVP_MD_CTX_new();
3901 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3902 EVP_MD_CTX_free(*hash);
3909 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3912 EVP_MD_CTX_free(*hash);
3916 /* Retrieve handshake hashes */
3917 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3920 EVP_MD_CTX *ctx = NULL;
3921 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3922 int hashleni = EVP_MD_CTX_size(hdgst);
3925 if (hashleni < 0 || (size_t)hashleni > outlen)
3928 ctx = EVP_MD_CTX_new();
3932 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3933 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3936 *hashlen = hashleni;
3940 EVP_MD_CTX_free(ctx);
3944 int SSL_session_reused(SSL *s)
3949 int SSL_is_server(SSL *s)
3954 #if OPENSSL_API_COMPAT < 0x10100000L
3955 void SSL_set_debug(SSL *s, int debug)
3957 /* Old function was do-nothing anyway... */
3963 void SSL_set_security_level(SSL *s, int level)
3965 s->cert->sec_level = level;
3968 int SSL_get_security_level(const SSL *s)
3970 return s->cert->sec_level;
3973 void SSL_set_security_callback(SSL *s,
3974 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3975 int op, int bits, int nid,
3976 void *other, void *ex))
3978 s->cert->sec_cb = cb;
3981 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
3982 const SSL_CTX *ctx, int op,
3983 int bits, int nid, void *other,
3985 return s->cert->sec_cb;
3988 void SSL_set0_security_ex_data(SSL *s, void *ex)
3990 s->cert->sec_ex = ex;
3993 void *SSL_get0_security_ex_data(const SSL *s)
3995 return s->cert->sec_ex;
3998 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4000 ctx->cert->sec_level = level;
4003 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4005 return ctx->cert->sec_level;
4008 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4009 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4010 int op, int bits, int nid,
4011 void *other, void *ex))
4013 ctx->cert->sec_cb = cb;
4016 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4022 return ctx->cert->sec_cb;
4025 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4027 ctx->cert->sec_ex = ex;
4030 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4032 return ctx->cert->sec_ex;
4036 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4037 * can return unsigned long, instead of the generic long return value from the
4038 * control interface.
4040 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4042 return ctx->options;
4045 unsigned long SSL_get_options(const SSL *s)
4050 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4052 return ctx->options |= op;
4055 unsigned long SSL_set_options(SSL *s, unsigned long op)
4057 return s->options |= op;
4060 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4062 return ctx->options &= ~op;
4065 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4067 return s->options &= ~op;
4070 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4072 return s->verified_chain;
4075 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4077 #ifndef OPENSSL_NO_CT
4080 * Moves SCTs from the |src| stack to the |dst| stack.
4081 * The source of each SCT will be set to |origin|.
4082 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4084 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4086 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4087 sct_source_t origin)
4093 *dst = sk_SCT_new_null();
4095 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4100 while ((sct = sk_SCT_pop(src)) != NULL) {
4101 if (SCT_set_source(sct, origin) != 1)
4104 if (sk_SCT_push(*dst, sct) <= 0)
4112 sk_SCT_push(src, sct); /* Put the SCT back */
4117 * Look for data collected during ServerHello and parse if found.
4118 * Returns the number of SCTs extracted.
4120 static int ct_extract_tls_extension_scts(SSL *s)
4122 int scts_extracted = 0;
4124 if (s->ext.scts != NULL) {
4125 const unsigned char *p = s->ext.scts;
4126 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4128 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4130 SCT_LIST_free(scts);
4133 return scts_extracted;
4137 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4138 * contains an SCT X509 extension. They will be stored in |s->scts|.
4140 * - The number of SCTs extracted, assuming an OCSP response exists.
4141 * - 0 if no OCSP response exists or it contains no SCTs.
4142 * - A negative integer if an error occurs.
4144 static int ct_extract_ocsp_response_scts(SSL *s)
4146 # ifndef OPENSSL_NO_OCSP
4147 int scts_extracted = 0;
4148 const unsigned char *p;
4149 OCSP_BASICRESP *br = NULL;
4150 OCSP_RESPONSE *rsp = NULL;
4151 STACK_OF(SCT) *scts = NULL;
4154 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4157 p = s->ext.ocsp.resp;
4158 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4162 br = OCSP_response_get1_basic(rsp);
4166 for (i = 0; i < OCSP_resp_count(br); ++i) {
4167 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4173 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4175 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4176 if (scts_extracted < 0)
4180 SCT_LIST_free(scts);
4181 OCSP_BASICRESP_free(br);
4182 OCSP_RESPONSE_free(rsp);
4183 return scts_extracted;
4185 /* Behave as if no OCSP response exists */
4191 * Attempts to extract SCTs from the peer certificate.
4192 * Return the number of SCTs extracted, or a negative integer if an error
4195 static int ct_extract_x509v3_extension_scts(SSL *s)
4197 int scts_extracted = 0;
4198 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4201 STACK_OF(SCT) *scts =
4202 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4205 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4207 SCT_LIST_free(scts);
4210 return scts_extracted;
4214 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4215 * response (if it exists) and X509v3 extensions in the certificate.
4216 * Returns NULL if an error occurs.
4218 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4220 if (!s->scts_parsed) {
4221 if (ct_extract_tls_extension_scts(s) < 0 ||
4222 ct_extract_ocsp_response_scts(s) < 0 ||
4223 ct_extract_x509v3_extension_scts(s) < 0)
4233 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4234 const STACK_OF(SCT) *scts, void *unused_arg)
4239 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4240 const STACK_OF(SCT) *scts, void *unused_arg)
4242 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4245 for (i = 0; i < count; ++i) {
4246 SCT *sct = sk_SCT_value(scts, i);
4247 int status = SCT_get_validation_status(sct);
4249 if (status == SCT_VALIDATION_STATUS_VALID)
4252 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4256 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4260 * Since code exists that uses the custom extension handler for CT, look
4261 * for this and throw an error if they have already registered to use CT.
4263 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4264 TLSEXT_TYPE_signed_certificate_timestamp))
4266 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4267 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4271 if (callback != NULL) {
4273 * If we are validating CT, then we MUST accept SCTs served via OCSP
4275 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4279 s->ct_validation_callback = callback;
4280 s->ct_validation_callback_arg = arg;
4285 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4286 ssl_ct_validation_cb callback, void *arg)
4289 * Since code exists that uses the custom extension handler for CT, look for
4290 * this and throw an error if they have already registered to use CT.
4292 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4293 TLSEXT_TYPE_signed_certificate_timestamp))
4295 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4296 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4300 ctx->ct_validation_callback = callback;
4301 ctx->ct_validation_callback_arg = arg;
4305 int SSL_ct_is_enabled(const SSL *s)
4307 return s->ct_validation_callback != NULL;
4310 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4312 return ctx->ct_validation_callback != NULL;
4315 int ssl_validate_ct(SSL *s)
4318 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4320 SSL_DANE *dane = &s->dane;
4321 CT_POLICY_EVAL_CTX *ctx = NULL;
4322 const STACK_OF(SCT) *scts;
4325 * If no callback is set, the peer is anonymous, or its chain is invalid,
4326 * skip SCT validation - just return success. Applications that continue
4327 * handshakes without certificates, with unverified chains, or pinned leaf
4328 * certificates are outside the scope of the WebPKI and CT.
4330 * The above exclusions notwithstanding the vast majority of peers will
4331 * have rather ordinary certificate chains validated by typical
4332 * applications that perform certificate verification and therefore will
4333 * process SCTs when enabled.
4335 if (s->ct_validation_callback == NULL || cert == NULL ||
4336 s->verify_result != X509_V_OK ||
4337 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4341 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4342 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4344 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4345 switch (dane->mtlsa->usage) {
4346 case DANETLS_USAGE_DANE_TA:
4347 case DANETLS_USAGE_DANE_EE:
4352 ctx = CT_POLICY_EVAL_CTX_new();
4354 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4358 issuer = sk_X509_value(s->verified_chain, 1);
4359 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4360 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4361 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4362 CT_POLICY_EVAL_CTX_set_time(ctx, SSL_SESSION_get_time(SSL_get0_session(s)));
4364 scts = SSL_get0_peer_scts(s);
4367 * This function returns success (> 0) only when all the SCTs are valid, 0
4368 * when some are invalid, and < 0 on various internal errors (out of
4369 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4370 * reason to abort the handshake, that decision is up to the callback.
4371 * Therefore, we error out only in the unexpected case that the return
4372 * value is negative.
4374 * XXX: One might well argue that the return value of this function is an
4375 * unfortunate design choice. Its job is only to determine the validation
4376 * status of each of the provided SCTs. So long as it correctly separates
4377 * the wheat from the chaff it should return success. Failure in this case
4378 * ought to correspond to an inability to carry out its duties.
4380 if (SCT_LIST_validate(scts, ctx) < 0) {
4381 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4385 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4387 ret = 0; /* This function returns 0 on failure */
4390 CT_POLICY_EVAL_CTX_free(ctx);
4392 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4393 * failure return code here. Also the application may wish the complete
4394 * the handshake, and then disconnect cleanly at a higher layer, after
4395 * checking the verification status of the completed connection.
4397 * We therefore force a certificate verification failure which will be
4398 * visible via SSL_get_verify_result() and cached as part of any resumed
4401 * Note: the permissive callback is for information gathering only, always
4402 * returns success, and does not affect verification status. Only the
4403 * strict callback or a custom application-specified callback can trigger
4404 * connection failure or record a verification error.
4407 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4411 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4413 switch (validation_mode) {
4415 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4417 case SSL_CT_VALIDATION_PERMISSIVE:
4418 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4419 case SSL_CT_VALIDATION_STRICT:
4420 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4424 int SSL_enable_ct(SSL *s, int validation_mode)
4426 switch (validation_mode) {
4428 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4430 case SSL_CT_VALIDATION_PERMISSIVE:
4431 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4432 case SSL_CT_VALIDATION_STRICT:
4433 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4437 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4439 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4442 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4444 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4447 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4449 CTLOG_STORE_free(ctx->ctlog_store);
4450 ctx->ctlog_store = logs;
4453 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4455 return ctx->ctlog_store;
4458 #endif /* OPENSSL_NO_CT */
4460 void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn cb, void *arg)
4463 c->early_cb_arg = arg;
4466 int SSL_early_isv2(SSL *s)
4468 if (s->clienthello == NULL)
4470 return s->clienthello->isv2;
4473 unsigned int SSL_early_get0_legacy_version(SSL *s)
4475 if (s->clienthello == NULL)
4477 return s->clienthello->legacy_version;
4480 size_t SSL_early_get0_random(SSL *s, const unsigned char **out)
4482 if (s->clienthello == NULL)
4485 *out = s->clienthello->random;
4486 return SSL3_RANDOM_SIZE;
4489 size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out)
4491 if (s->clienthello == NULL)
4494 *out = s->clienthello->session_id;
4495 return s->clienthello->session_id_len;
4498 size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out)
4500 if (s->clienthello == NULL)
4503 *out = PACKET_data(&s->clienthello->ciphersuites);
4504 return PACKET_remaining(&s->clienthello->ciphersuites);
4507 size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out)
4509 if (s->clienthello == NULL)
4512 *out = s->clienthello->compressions;
4513 return s->clienthello->compressions_len;
4516 int SSL_early_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4522 if (s->clienthello == NULL)
4524 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4525 r = s->clienthello->pre_proc_exts + i;
4526 if (r->present && r->type == type) {
4528 *out = PACKET_data(&r->data);
4530 *outlen = PACKET_remaining(&r->data);
4537 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4539 ctx->keylog_callback = cb;
4542 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4544 return ctx->keylog_callback;
4547 static int nss_keylog_int(const char *prefix,
4549 const uint8_t *parameter_1,
4550 size_t parameter_1_len,
4551 const uint8_t *parameter_2,
4552 size_t parameter_2_len)
4555 char *cursor = NULL;
4560 if (ssl->ctx->keylog_callback == NULL) return 1;
4563 * Our output buffer will contain the following strings, rendered with
4564 * space characters in between, terminated by a NULL character: first the
4565 * prefix, then the first parameter, then the second parameter. The
4566 * meaning of each parameter depends on the specific key material being
4567 * logged. Note that the first and second parameters are encoded in
4568 * hexadecimal, so we need a buffer that is twice their lengths.
4570 prefix_len = strlen(prefix);
4571 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4572 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4573 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4577 strcpy(cursor, prefix);
4578 cursor += prefix_len;
4581 for (i = 0; i < parameter_1_len; i++) {
4582 sprintf(cursor, "%02x", parameter_1[i]);
4587 for (i = 0; i < parameter_2_len; i++) {
4588 sprintf(cursor, "%02x", parameter_2[i]);
4593 ssl->ctx->keylog_callback(ssl, (const char *)out);
4599 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4600 const uint8_t *encrypted_premaster,
4601 size_t encrypted_premaster_len,
4602 const uint8_t *premaster,
4603 size_t premaster_len)
4605 if (encrypted_premaster_len < 8) {
4606 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4610 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4611 return nss_keylog_int("RSA",
4613 encrypted_premaster,
4619 int ssl_log_secret(SSL *ssl,
4621 const uint8_t *secret,
4624 return nss_keylog_int(label,
4626 ssl->s3->client_random,
4632 #define SSLV2_CIPHER_LEN 3
4634 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format,
4639 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4641 if (PACKET_remaining(cipher_suites) == 0) {
4642 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST, SSL_R_NO_CIPHERS_SPECIFIED);
4643 *al = SSL_AD_ILLEGAL_PARAMETER;
4647 if (PACKET_remaining(cipher_suites) % n != 0) {
4648 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST,
4649 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4650 *al = SSL_AD_DECODE_ERROR;
4654 OPENSSL_free(s->s3->tmp.ciphers_raw);
4655 s->s3->tmp.ciphers_raw = NULL;
4656 s->s3->tmp.ciphers_rawlen = 0;
4659 size_t numciphers = PACKET_remaining(cipher_suites) / n;
4660 PACKET sslv2ciphers = *cipher_suites;
4661 unsigned int leadbyte;
4665 * We store the raw ciphers list in SSLv3+ format so we need to do some
4666 * preprocessing to convert the list first. If there are any SSLv2 only
4667 * ciphersuites with a non-zero leading byte then we are going to
4668 * slightly over allocate because we won't store those. But that isn't a
4671 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
4672 s->s3->tmp.ciphers_raw = raw;
4674 *al = SSL_AD_INTERNAL_ERROR;
4677 for (s->s3->tmp.ciphers_rawlen = 0;
4678 PACKET_remaining(&sslv2ciphers) > 0;
4679 raw += TLS_CIPHER_LEN) {
4680 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
4682 && !PACKET_copy_bytes(&sslv2ciphers, raw,
4685 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
4686 *al = SSL_AD_INTERNAL_ERROR;
4687 OPENSSL_free(s->s3->tmp.ciphers_raw);
4688 s->s3->tmp.ciphers_raw = NULL;
4689 s->s3->tmp.ciphers_rawlen = 0;
4693 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
4695 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
4696 &s->s3->tmp.ciphers_rawlen)) {
4697 *al = SSL_AD_INTERNAL_ERROR;
4705 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
4706 int isv2format, STACK_OF(SSL_CIPHER) **sk,
4707 STACK_OF(SSL_CIPHER) **scsvs)
4712 if (!PACKET_buf_init(&pkt, bytes, len))
4714 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, &alert);
4717 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
4718 STACK_OF(SSL_CIPHER) **skp,
4719 STACK_OF(SSL_CIPHER) **scsvs_out,
4720 int sslv2format, int *al)
4722 const SSL_CIPHER *c;
4723 STACK_OF(SSL_CIPHER) *sk = NULL;
4724 STACK_OF(SSL_CIPHER) *scsvs = NULL;
4726 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
4727 unsigned char cipher[SSLV2_CIPHER_LEN];
4729 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4731 if (PACKET_remaining(cipher_suites) == 0) {
4732 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
4733 *al = SSL_AD_ILLEGAL_PARAMETER;
4737 if (PACKET_remaining(cipher_suites) % n != 0) {
4738 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
4739 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4740 *al = SSL_AD_DECODE_ERROR;
4744 sk = sk_SSL_CIPHER_new_null();
4745 scsvs = sk_SSL_CIPHER_new_null();
4746 if (sk == NULL || scsvs == NULL) {
4747 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4748 *al = SSL_AD_INTERNAL_ERROR;
4752 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
4754 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
4755 * first byte set to zero, while true SSLv2 ciphers have a non-zero
4756 * first byte. We don't support any true SSLv2 ciphers, so skip them.
4758 if (sslv2format && cipher[0] != '\0')
4761 /* For SSLv2-compat, ignore leading 0-byte. */
4762 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
4764 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
4765 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
4766 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4767 *al = SSL_AD_INTERNAL_ERROR;
4772 if (PACKET_remaining(cipher_suites) > 0) {
4773 *al = SSL_AD_INTERNAL_ERROR;
4774 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_INTERNAL_ERROR);
4781 sk_SSL_CIPHER_free(sk);
4782 if (scsvs_out != NULL)
4785 sk_SSL_CIPHER_free(scsvs);
4788 sk_SSL_CIPHER_free(sk);
4789 sk_SSL_CIPHER_free(scsvs);
4793 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
4795 ctx->max_early_data = max_early_data;
4800 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
4802 return ctx->max_early_data;
4805 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
4807 s->max_early_data = max_early_data;
4812 uint32_t SSL_get_max_early_data(const SSL_CTX *s)
4814 return s->max_early_data;