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 - ie. 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->clienthello);
1020 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1022 sk_X509_pop_free(s->verified_chain, X509_free);
1024 if (s->method != NULL)
1025 s->method->ssl_free(s);
1027 RECORD_LAYER_release(&s->rlayer);
1029 SSL_CTX_free(s->ctx);
1031 ASYNC_WAIT_CTX_free(s->waitctx);
1033 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1034 OPENSSL_free(s->ext.npn);
1037 #ifndef OPENSSL_NO_SRTP
1038 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1041 CRYPTO_THREAD_lock_free(s->lock);
1046 void SSL_set0_rbio(SSL *s, BIO *rbio)
1048 BIO_free_all(s->rbio);
1052 void SSL_set0_wbio(SSL *s, BIO *wbio)
1055 * If the output buffering BIO is still in place, remove it
1057 if (s->bbio != NULL)
1058 s->wbio = BIO_pop(s->wbio);
1060 BIO_free_all(s->wbio);
1063 /* Re-attach |bbio| to the new |wbio|. */
1064 if (s->bbio != NULL)
1065 s->wbio = BIO_push(s->bbio, s->wbio);
1068 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1071 * For historical reasons, this function has many different cases in
1072 * ownership handling.
1075 /* If nothing has changed, do nothing */
1076 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1080 * If the two arguments are equal then one fewer reference is granted by the
1081 * caller than we want to take
1083 if (rbio != NULL && rbio == wbio)
1087 * If only the wbio is changed only adopt one reference.
1089 if (rbio == SSL_get_rbio(s)) {
1090 SSL_set0_wbio(s, wbio);
1094 * There is an asymmetry here for historical reasons. If only the rbio is
1095 * changed AND the rbio and wbio were originally different, then we only
1096 * adopt one reference.
1098 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1099 SSL_set0_rbio(s, rbio);
1103 /* Otherwise, adopt both references. */
1104 SSL_set0_rbio(s, rbio);
1105 SSL_set0_wbio(s, wbio);
1108 BIO *SSL_get_rbio(const SSL *s)
1113 BIO *SSL_get_wbio(const SSL *s)
1115 if (s->bbio != NULL) {
1117 * If |bbio| is active, the true caller-configured BIO is its
1120 return BIO_next(s->bbio);
1125 int SSL_get_fd(const SSL *s)
1127 return SSL_get_rfd(s);
1130 int SSL_get_rfd(const SSL *s)
1135 b = SSL_get_rbio(s);
1136 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1138 BIO_get_fd(r, &ret);
1142 int SSL_get_wfd(const SSL *s)
1147 b = SSL_get_wbio(s);
1148 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1150 BIO_get_fd(r, &ret);
1154 #ifndef OPENSSL_NO_SOCK
1155 int SSL_set_fd(SSL *s, int fd)
1160 bio = BIO_new(BIO_s_socket());
1163 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1166 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1167 SSL_set_bio(s, bio, bio);
1173 int SSL_set_wfd(SSL *s, int fd)
1175 BIO *rbio = SSL_get_rbio(s);
1177 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1178 || (int)BIO_get_fd(rbio, NULL) != fd) {
1179 BIO *bio = BIO_new(BIO_s_socket());
1182 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1185 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1186 SSL_set0_wbio(s, bio);
1189 SSL_set0_wbio(s, rbio);
1194 int SSL_set_rfd(SSL *s, int fd)
1196 BIO *wbio = SSL_get_wbio(s);
1198 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1199 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1200 BIO *bio = BIO_new(BIO_s_socket());
1203 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1206 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1207 SSL_set0_rbio(s, bio);
1210 SSL_set0_rbio(s, wbio);
1217 /* return length of latest Finished message we sent, copy to 'buf' */
1218 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1222 if (s->s3 != NULL) {
1223 ret = s->s3->tmp.finish_md_len;
1226 memcpy(buf, s->s3->tmp.finish_md, count);
1231 /* return length of latest Finished message we expected, copy to 'buf' */
1232 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1236 if (s->s3 != NULL) {
1237 ret = s->s3->tmp.peer_finish_md_len;
1240 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1245 int SSL_get_verify_mode(const SSL *s)
1247 return (s->verify_mode);
1250 int SSL_get_verify_depth(const SSL *s)
1252 return X509_VERIFY_PARAM_get_depth(s->param);
1255 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1256 return (s->verify_callback);
1259 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1261 return (ctx->verify_mode);
1264 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1266 return X509_VERIFY_PARAM_get_depth(ctx->param);
1269 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1270 return (ctx->default_verify_callback);
1273 void SSL_set_verify(SSL *s, int mode,
1274 int (*callback) (int ok, X509_STORE_CTX *ctx))
1276 s->verify_mode = mode;
1277 if (callback != NULL)
1278 s->verify_callback = callback;
1281 void SSL_set_verify_depth(SSL *s, int depth)
1283 X509_VERIFY_PARAM_set_depth(s->param, depth);
1286 void SSL_set_read_ahead(SSL *s, int yes)
1288 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1291 int SSL_get_read_ahead(const SSL *s)
1293 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1296 int SSL_pending(const SSL *s)
1298 size_t pending = s->method->ssl_pending(s);
1301 * SSL_pending cannot work properly if read-ahead is enabled
1302 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1303 * impossible to fix since SSL_pending cannot report errors that may be
1304 * observed while scanning the new data. (Note that SSL_pending() is
1305 * often used as a boolean value, so we'd better not return -1.)
1307 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1308 * we just return INT_MAX.
1310 return pending < INT_MAX ? (int)pending : INT_MAX;
1313 int SSL_has_pending(const SSL *s)
1316 * Similar to SSL_pending() but returns a 1 to indicate that we have
1317 * unprocessed data available or 0 otherwise (as opposed to the number of
1318 * bytes available). Unlike SSL_pending() this will take into account
1319 * read_ahead data. A 1 return simply indicates that we have unprocessed
1320 * data. That data may not result in any application data, or we may fail
1321 * to parse the records for some reason.
1326 return RECORD_LAYER_read_pending(&s->rlayer);
1329 X509 *SSL_get_peer_certificate(const SSL *s)
1333 if ((s == NULL) || (s->session == NULL))
1336 r = s->session->peer;
1346 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1350 if ((s == NULL) || (s->session == NULL))
1353 r = s->session->peer_chain;
1356 * If we are a client, cert_chain includes the peer's own certificate; if
1357 * we are a server, it does not.
1364 * Now in theory, since the calling process own 't' it should be safe to
1365 * modify. We need to be able to read f without being hassled
1367 int SSL_copy_session_id(SSL *t, const SSL *f)
1370 /* Do we need to to SSL locking? */
1371 if (!SSL_set_session(t, SSL_get_session(f))) {
1376 * what if we are setup for one protocol version but want to talk another
1378 if (t->method != f->method) {
1379 t->method->ssl_free(t);
1380 t->method = f->method;
1381 if (t->method->ssl_new(t) == 0)
1385 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1386 ssl_cert_free(t->cert);
1388 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1395 /* Fix this so it checks all the valid key/cert options */
1396 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1398 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1399 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1402 if (ctx->cert->key->privatekey == NULL) {
1403 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1406 return (X509_check_private_key
1407 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1410 /* Fix this function so that it takes an optional type parameter */
1411 int SSL_check_private_key(const SSL *ssl)
1414 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1417 if (ssl->cert->key->x509 == NULL) {
1418 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1421 if (ssl->cert->key->privatekey == NULL) {
1422 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1425 return (X509_check_private_key(ssl->cert->key->x509,
1426 ssl->cert->key->privatekey));
1429 int SSL_waiting_for_async(SSL *s)
1437 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1439 ASYNC_WAIT_CTX *ctx = s->waitctx;
1443 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1446 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1447 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1449 ASYNC_WAIT_CTX *ctx = s->waitctx;
1453 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1457 int SSL_accept(SSL *s)
1459 if (s->handshake_func == NULL) {
1460 /* Not properly initialized yet */
1461 SSL_set_accept_state(s);
1464 return SSL_do_handshake(s);
1467 int SSL_connect(SSL *s)
1469 if (s->handshake_func == NULL) {
1470 /* Not properly initialized yet */
1471 SSL_set_connect_state(s);
1474 return SSL_do_handshake(s);
1477 long SSL_get_default_timeout(const SSL *s)
1479 return (s->method->get_timeout());
1482 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1483 int (*func) (void *))
1486 if (s->waitctx == NULL) {
1487 s->waitctx = ASYNC_WAIT_CTX_new();
1488 if (s->waitctx == NULL)
1491 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1492 sizeof(struct ssl_async_args))) {
1494 s->rwstate = SSL_NOTHING;
1495 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1498 s->rwstate = SSL_ASYNC_PAUSED;
1501 s->rwstate = SSL_ASYNC_NO_JOBS;
1507 s->rwstate = SSL_NOTHING;
1508 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1509 /* Shouldn't happen */
1514 static int ssl_io_intern(void *vargs)
1516 struct ssl_async_args *args;
1521 args = (struct ssl_async_args *)vargs;
1525 switch (args->type) {
1527 return args->f.func_read(s, buf, num, &s->asyncrw);
1529 return args->f.func_write(s, buf, num, &s->asyncrw);
1531 return args->f.func_other(s);
1536 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1538 if (s->handshake_func == NULL) {
1539 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1543 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1544 s->rwstate = SSL_NOTHING;
1548 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1549 struct ssl_async_args args;
1555 args.type = READFUNC;
1556 args.f.func_read = s->method->ssl_read;
1558 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1559 *readbytes = s->asyncrw;
1562 return s->method->ssl_read(s, buf, num, readbytes);
1566 int SSL_read(SSL *s, void *buf, int num)
1572 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1576 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1579 * The cast is safe here because ret should be <= INT_MAX because num is
1583 ret = (int)readbytes;
1588 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1590 int ret = ssl_read_internal(s, buf, num, readbytes);
1597 int SSL_read_early(SSL *s, void *buf, size_t num, size_t *readbytes)
1602 SSLerr(SSL_F_SSL_READ_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1603 return SSL_READ_EARLY_ERROR;
1607 * TODO(TLS1.3): Somehow we need to check that we're not receiving too much
1611 switch (s->early_data_state) {
1612 case SSL_EARLY_DATA_NONE:
1613 if (!SSL_in_before(s)) {
1614 SSLerr(SSL_F_SSL_READ_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1615 return SSL_READ_EARLY_ERROR;
1619 case SSL_EARLY_DATA_ACCEPT_RETRY:
1620 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1621 ret = SSL_accept(s);
1624 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1625 return SSL_READ_EARLY_ERROR;
1629 case SSL_EARLY_DATA_READ_RETRY:
1630 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1631 s->early_data_state = SSL_EARLY_DATA_READING;
1632 ret = SSL_read_ex(s, buf, num, readbytes);
1634 * Record layer will call ssl_end_of_early_data_seen() if we see
1635 * that alert - which updates the early_data_state to
1636 * SSL_EARLY_DATA_FINISHED_READING
1638 if (ret > 0 || (ret <= 0 && s->early_data_state
1639 != SSL_EARLY_DATA_FINISHED_READING)) {
1640 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1641 return ret > 0 ? SSL_READ_EARLY_SUCCESS : SSL_READ_EARLY_ERROR;
1644 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1647 ossl_statem_set_in_init(s, 1);
1648 return SSL_READ_EARLY_FINISH;
1651 SSLerr(SSL_F_SSL_READ_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1652 return SSL_READ_EARLY_ERROR;
1656 int ssl_end_of_early_data_seen(SSL *s)
1658 if (s->early_data_state == SSL_EARLY_DATA_READING) {
1659 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1666 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1668 if (s->handshake_func == NULL) {
1669 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1673 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1676 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1677 struct ssl_async_args args;
1683 args.type = READFUNC;
1684 args.f.func_read = s->method->ssl_peek;
1686 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1687 *readbytes = s->asyncrw;
1690 return s->method->ssl_peek(s, buf, num, readbytes);
1694 int SSL_peek(SSL *s, void *buf, int num)
1700 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1704 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1707 * The cast is safe here because ret should be <= INT_MAX because num is
1711 ret = (int)readbytes;
1717 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1719 int ret = ssl_peek_internal(s, buf, num, readbytes);
1726 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1728 if (s->handshake_func == NULL) {
1729 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1733 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1734 s->rwstate = SSL_NOTHING;
1735 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1739 if (s->early_data_state == SSL_EARLY_DATA_WRITE_RETRY
1740 || s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY)
1743 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1745 struct ssl_async_args args;
1748 args.buf = (void *)buf;
1750 args.type = WRITEFUNC;
1751 args.f.func_write = s->method->ssl_write;
1753 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1754 *written = s->asyncrw;
1757 return s->method->ssl_write(s, buf, num, written);
1761 int SSL_write(SSL *s, const void *buf, int num)
1767 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1771 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1774 * The cast is safe here because ret should be <= INT_MAX because num is
1783 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1785 int ret = ssl_write_internal(s, buf, num, written);
1792 int SSL_write_early(SSL *s, const void *buf, size_t num, size_t *written)
1797 SSLerr(SSL_F_SSL_WRITE_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1802 * TODO(TLS1.3): Somehow we need to check that we're not sending too much
1806 switch (s->early_data_state) {
1807 case SSL_EARLY_DATA_NONE:
1808 if (!SSL_in_before(s)) {
1809 SSLerr(SSL_F_SSL_WRITE_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1814 case SSL_EARLY_DATA_CONNECT_RETRY:
1815 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1816 ret = SSL_connect(s);
1819 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1824 case SSL_EARLY_DATA_WRITE_RETRY:
1825 s->early_data_state = SSL_EARLY_DATA_WRITING;
1826 ret = SSL_write_ex(s, buf, num, written);
1827 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
1831 SSLerr(SSL_F_SSL_WRITE_EARLY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1836 int SSL_write_early_finish(SSL *s)
1840 if (s->early_data_state != SSL_EARLY_DATA_WRITE_RETRY) {
1841 SSLerr(SSL_F_SSL_WRITE_EARLY_FINISH, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1845 s->early_data_state = SSL_EARLY_DATA_WRITING;
1846 ret = ssl3_send_alert(s, SSL3_AL_WARNING, SSL_AD_END_OF_EARLY_DATA);
1848 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
1851 s->early_data_state = SSL_EARLY_DATA_FINISHED_WRITING;
1853 * We set the enc_write_ctx back to NULL because we may end up writing
1854 * in cleartext again if we get a HelloRetryRequest from the server.
1856 EVP_CIPHER_CTX_free(s->enc_write_ctx);
1857 s->enc_write_ctx = NULL;
1858 ossl_statem_set_in_init(s, 1);
1862 int SSL_shutdown(SSL *s)
1865 * Note that this function behaves differently from what one might
1866 * expect. Return values are 0 for no success (yet), 1 for success; but
1867 * calling it once is usually not enough, even if blocking I/O is used
1868 * (see ssl3_shutdown).
1871 if (s->handshake_func == NULL) {
1872 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1876 if (!SSL_in_init(s)) {
1877 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1878 struct ssl_async_args args;
1881 args.type = OTHERFUNC;
1882 args.f.func_other = s->method->ssl_shutdown;
1884 return ssl_start_async_job(s, &args, ssl_io_intern);
1886 return s->method->ssl_shutdown(s);
1889 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1894 int SSL_key_update(SSL *s, int updatetype)
1897 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
1898 * negotiated, and that it is appropriate to call SSL_key_update() instead
1899 * of SSL_renegotiate().
1901 if (!SSL_IS_TLS13(s)) {
1902 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1906 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1907 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1908 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1912 if (!SSL_is_init_finished(s)) {
1913 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1917 ossl_statem_set_in_init(s, 1);
1918 s->key_update = updatetype;
1922 int SSL_get_key_update_type(SSL *s)
1924 return s->key_update;
1927 int SSL_renegotiate(SSL *s)
1929 if (SSL_IS_TLS13(s)) {
1930 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1934 if (s->renegotiate == 0)
1939 return (s->method->ssl_renegotiate(s));
1942 int SSL_renegotiate_abbreviated(SSL *s)
1944 if (SSL_IS_TLS13(s))
1947 if (s->renegotiate == 0)
1952 return (s->method->ssl_renegotiate(s));
1955 int SSL_renegotiate_pending(SSL *s)
1958 * becomes true when negotiation is requested; false again once a
1959 * handshake has finished
1961 return (s->renegotiate != 0);
1964 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1969 case SSL_CTRL_GET_READ_AHEAD:
1970 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1971 case SSL_CTRL_SET_READ_AHEAD:
1972 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1973 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1976 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1977 s->msg_callback_arg = parg;
1981 return (s->mode |= larg);
1982 case SSL_CTRL_CLEAR_MODE:
1983 return (s->mode &= ~larg);
1984 case SSL_CTRL_GET_MAX_CERT_LIST:
1985 return (long)(s->max_cert_list);
1986 case SSL_CTRL_SET_MAX_CERT_LIST:
1989 l = (long)s->max_cert_list;
1990 s->max_cert_list = (size_t)larg;
1992 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1993 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1995 s->max_send_fragment = larg;
1996 if (s->max_send_fragment < s->split_send_fragment)
1997 s->split_send_fragment = s->max_send_fragment;
1999 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2000 if ((size_t)larg > s->max_send_fragment || larg == 0)
2002 s->split_send_fragment = larg;
2004 case SSL_CTRL_SET_MAX_PIPELINES:
2005 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2007 s->max_pipelines = larg;
2009 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2011 case SSL_CTRL_GET_RI_SUPPORT:
2013 return s->s3->send_connection_binding;
2016 case SSL_CTRL_CERT_FLAGS:
2017 return (s->cert->cert_flags |= larg);
2018 case SSL_CTRL_CLEAR_CERT_FLAGS:
2019 return (s->cert->cert_flags &= ~larg);
2021 case SSL_CTRL_GET_RAW_CIPHERLIST:
2023 if (s->s3->tmp.ciphers_raw == NULL)
2025 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2026 return (int)s->s3->tmp.ciphers_rawlen;
2028 return TLS_CIPHER_LEN;
2030 case SSL_CTRL_GET_EXTMS_SUPPORT:
2031 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2033 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2037 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2038 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2039 &s->min_proto_version);
2040 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2041 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2042 &s->max_proto_version);
2044 return (s->method->ssl_ctrl(s, cmd, larg, parg));
2048 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2051 case SSL_CTRL_SET_MSG_CALLBACK:
2052 s->msg_callback = (void (*)
2053 (int write_p, int version, int content_type,
2054 const void *buf, size_t len, SSL *ssl,
2059 return (s->method->ssl_callback_ctrl(s, cmd, fp));
2063 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2065 return ctx->sessions;
2068 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2071 /* For some cases with ctx == NULL perform syntax checks */
2074 #ifndef OPENSSL_NO_EC
2075 case SSL_CTRL_SET_GROUPS_LIST:
2076 return tls1_set_groups_list(NULL, NULL, parg);
2078 case SSL_CTRL_SET_SIGALGS_LIST:
2079 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2080 return tls1_set_sigalgs_list(NULL, parg, 0);
2087 case SSL_CTRL_GET_READ_AHEAD:
2088 return (ctx->read_ahead);
2089 case SSL_CTRL_SET_READ_AHEAD:
2090 l = ctx->read_ahead;
2091 ctx->read_ahead = larg;
2094 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2095 ctx->msg_callback_arg = parg;
2098 case SSL_CTRL_GET_MAX_CERT_LIST:
2099 return (long)(ctx->max_cert_list);
2100 case SSL_CTRL_SET_MAX_CERT_LIST:
2103 l = (long)ctx->max_cert_list;
2104 ctx->max_cert_list = (size_t)larg;
2107 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2110 l = (long)ctx->session_cache_size;
2111 ctx->session_cache_size = (size_t)larg;
2113 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2114 return (long)(ctx->session_cache_size);
2115 case SSL_CTRL_SET_SESS_CACHE_MODE:
2116 l = ctx->session_cache_mode;
2117 ctx->session_cache_mode = larg;
2119 case SSL_CTRL_GET_SESS_CACHE_MODE:
2120 return (ctx->session_cache_mode);
2122 case SSL_CTRL_SESS_NUMBER:
2123 return (lh_SSL_SESSION_num_items(ctx->sessions));
2124 case SSL_CTRL_SESS_CONNECT:
2125 return (ctx->stats.sess_connect);
2126 case SSL_CTRL_SESS_CONNECT_GOOD:
2127 return (ctx->stats.sess_connect_good);
2128 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2129 return (ctx->stats.sess_connect_renegotiate);
2130 case SSL_CTRL_SESS_ACCEPT:
2131 return (ctx->stats.sess_accept);
2132 case SSL_CTRL_SESS_ACCEPT_GOOD:
2133 return (ctx->stats.sess_accept_good);
2134 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2135 return (ctx->stats.sess_accept_renegotiate);
2136 case SSL_CTRL_SESS_HIT:
2137 return (ctx->stats.sess_hit);
2138 case SSL_CTRL_SESS_CB_HIT:
2139 return (ctx->stats.sess_cb_hit);
2140 case SSL_CTRL_SESS_MISSES:
2141 return (ctx->stats.sess_miss);
2142 case SSL_CTRL_SESS_TIMEOUTS:
2143 return (ctx->stats.sess_timeout);
2144 case SSL_CTRL_SESS_CACHE_FULL:
2145 return (ctx->stats.sess_cache_full);
2147 return (ctx->mode |= larg);
2148 case SSL_CTRL_CLEAR_MODE:
2149 return (ctx->mode &= ~larg);
2150 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2151 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2153 ctx->max_send_fragment = larg;
2154 if (ctx->max_send_fragment < ctx->split_send_fragment)
2155 ctx->split_send_fragment = ctx->max_send_fragment;
2157 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2158 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2160 ctx->split_send_fragment = larg;
2162 case SSL_CTRL_SET_MAX_PIPELINES:
2163 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2165 ctx->max_pipelines = larg;
2167 case SSL_CTRL_CERT_FLAGS:
2168 return (ctx->cert->cert_flags |= larg);
2169 case SSL_CTRL_CLEAR_CERT_FLAGS:
2170 return (ctx->cert->cert_flags &= ~larg);
2171 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2172 return ssl_set_version_bound(ctx->method->version, (int)larg,
2173 &ctx->min_proto_version);
2174 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2175 return ssl_set_version_bound(ctx->method->version, (int)larg,
2176 &ctx->max_proto_version);
2178 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2182 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2185 case SSL_CTRL_SET_MSG_CALLBACK:
2186 ctx->msg_callback = (void (*)
2187 (int write_p, int version, int content_type,
2188 const void *buf, size_t len, SSL *ssl,
2193 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2197 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2206 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2207 const SSL_CIPHER *const *bp)
2209 if ((*ap)->id > (*bp)->id)
2211 if ((*ap)->id < (*bp)->id)
2216 /** return a STACK of the ciphers available for the SSL and in order of
2218 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2221 if (s->cipher_list != NULL) {
2222 return (s->cipher_list);
2223 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2224 return (s->ctx->cipher_list);
2230 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2232 if ((s == NULL) || (s->session == NULL) || !s->server)
2234 return s->session->ciphers;
2237 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2239 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2241 ciphers = SSL_get_ciphers(s);
2244 ssl_set_client_disabled(s);
2245 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2246 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2247 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
2249 sk = sk_SSL_CIPHER_new_null();
2252 if (!sk_SSL_CIPHER_push(sk, c)) {
2253 sk_SSL_CIPHER_free(sk);
2261 /** return a STACK of the ciphers available for the SSL and in order of
2263 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2266 if (s->cipher_list_by_id != NULL) {
2267 return (s->cipher_list_by_id);
2268 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2269 return (s->ctx->cipher_list_by_id);
2275 /** The old interface to get the same thing as SSL_get_ciphers() */
2276 const char *SSL_get_cipher_list(const SSL *s, int n)
2278 const SSL_CIPHER *c;
2279 STACK_OF(SSL_CIPHER) *sk;
2283 sk = SSL_get_ciphers(s);
2284 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2286 c = sk_SSL_CIPHER_value(sk, n);
2292 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2294 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2297 return ctx->cipher_list;
2301 /** specify the ciphers to be used by default by the SSL_CTX */
2302 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2304 STACK_OF(SSL_CIPHER) *sk;
2306 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2307 &ctx->cipher_list_by_id, str, ctx->cert);
2309 * ssl_create_cipher_list may return an empty stack if it was unable to
2310 * find a cipher matching the given rule string (for example if the rule
2311 * string specifies a cipher which has been disabled). This is not an
2312 * error as far as ssl_create_cipher_list is concerned, and hence
2313 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2317 else if (sk_SSL_CIPHER_num(sk) == 0) {
2318 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2324 /** specify the ciphers to be used by the SSL */
2325 int SSL_set_cipher_list(SSL *s, const char *str)
2327 STACK_OF(SSL_CIPHER) *sk;
2329 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2330 &s->cipher_list_by_id, str, s->cert);
2331 /* see comment in SSL_CTX_set_cipher_list */
2334 else if (sk_SSL_CIPHER_num(sk) == 0) {
2335 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2341 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2344 STACK_OF(SSL_CIPHER) *sk;
2345 const SSL_CIPHER *c;
2348 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2352 sk = s->session->ciphers;
2354 if (sk_SSL_CIPHER_num(sk) == 0)
2357 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2360 c = sk_SSL_CIPHER_value(sk, i);
2361 n = strlen(c->name);
2368 memcpy(p, c->name, n + 1);
2377 /** return a servername extension value if provided in Client Hello, or NULL.
2378 * So far, only host_name types are defined (RFC 3546).
2381 const char *SSL_get_servername(const SSL *s, const int type)
2383 if (type != TLSEXT_NAMETYPE_host_name)
2386 return s->session && !s->ext.hostname ?
2387 s->session->ext.hostname : s->ext.hostname;
2390 int SSL_get_servername_type(const SSL *s)
2393 && (!s->ext.hostname ? s->session->
2394 ext.hostname : s->ext.hostname))
2395 return TLSEXT_NAMETYPE_host_name;
2400 * SSL_select_next_proto implements the standard protocol selection. It is
2401 * expected that this function is called from the callback set by
2402 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2403 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2404 * not included in the length. A byte string of length 0 is invalid. No byte
2405 * string may be truncated. The current, but experimental algorithm for
2406 * selecting the protocol is: 1) If the server doesn't support NPN then this
2407 * is indicated to the callback. In this case, the client application has to
2408 * abort the connection or have a default application level protocol. 2) If
2409 * the server supports NPN, but advertises an empty list then the client
2410 * selects the first protocol in its list, but indicates via the API that this
2411 * fallback case was enacted. 3) Otherwise, the client finds the first
2412 * protocol in the server's list that it supports and selects this protocol.
2413 * This is because it's assumed that the server has better information about
2414 * which protocol a client should use. 4) If the client doesn't support any
2415 * of the server's advertised protocols, then this is treated the same as
2416 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2417 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2419 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2420 const unsigned char *server,
2421 unsigned int server_len,
2422 const unsigned char *client, unsigned int client_len)
2425 const unsigned char *result;
2426 int status = OPENSSL_NPN_UNSUPPORTED;
2429 * For each protocol in server preference order, see if we support it.
2431 for (i = 0; i < server_len;) {
2432 for (j = 0; j < client_len;) {
2433 if (server[i] == client[j] &&
2434 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2435 /* We found a match */
2436 result = &server[i];
2437 status = OPENSSL_NPN_NEGOTIATED;
2447 /* There's no overlap between our protocols and the server's list. */
2449 status = OPENSSL_NPN_NO_OVERLAP;
2452 *out = (unsigned char *)result + 1;
2453 *outlen = result[0];
2457 #ifndef OPENSSL_NO_NEXTPROTONEG
2459 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2460 * client's requested protocol for this connection and returns 0. If the
2461 * client didn't request any protocol, then *data is set to NULL. Note that
2462 * the client can request any protocol it chooses. The value returned from
2463 * this function need not be a member of the list of supported protocols
2464 * provided by the callback.
2466 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2473 *len = (unsigned int)s->ext.npn_len;
2478 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2479 * a TLS server needs a list of supported protocols for Next Protocol
2480 * Negotiation. The returned list must be in wire format. The list is
2481 * returned by setting |out| to point to it and |outlen| to its length. This
2482 * memory will not be modified, but one should assume that the SSL* keeps a
2483 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2484 * wishes to advertise. Otherwise, no such extension will be included in the
2487 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2488 SSL_CTX_npn_advertised_cb_func cb,
2491 ctx->ext.npn_advertised_cb = cb;
2492 ctx->ext.npn_advertised_cb_arg = arg;
2496 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2497 * client needs to select a protocol from the server's provided list. |out|
2498 * must be set to point to the selected protocol (which may be within |in|).
2499 * The length of the protocol name must be written into |outlen|. The
2500 * server's advertised protocols are provided in |in| and |inlen|. The
2501 * callback can assume that |in| is syntactically valid. The client must
2502 * select a protocol. It is fatal to the connection if this callback returns
2503 * a value other than SSL_TLSEXT_ERR_OK.
2505 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2506 SSL_CTX_npn_select_cb_func cb,
2509 ctx->ext.npn_select_cb = cb;
2510 ctx->ext.npn_select_cb_arg = arg;
2515 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2516 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2517 * length-prefixed strings). Returns 0 on success.
2519 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2520 unsigned int protos_len)
2522 OPENSSL_free(ctx->ext.alpn);
2523 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2524 if (ctx->ext.alpn == NULL) {
2525 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2528 ctx->ext.alpn_len = protos_len;
2534 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2535 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2536 * length-prefixed strings). Returns 0 on success.
2538 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2539 unsigned int protos_len)
2541 OPENSSL_free(ssl->ext.alpn);
2542 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2543 if (ssl->ext.alpn == NULL) {
2544 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2547 ssl->ext.alpn_len = protos_len;
2553 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2554 * called during ClientHello processing in order to select an ALPN protocol
2555 * from the client's list of offered protocols.
2557 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2558 SSL_CTX_alpn_select_cb_func cb,
2561 ctx->ext.alpn_select_cb = cb;
2562 ctx->ext.alpn_select_cb_arg = arg;
2566 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2567 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2568 * (not including the leading length-prefix byte). If the server didn't
2569 * respond with a negotiated protocol then |*len| will be zero.
2571 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2576 *data = ssl->s3->alpn_selected;
2580 *len = (unsigned int)ssl->s3->alpn_selected_len;
2583 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2584 const char *label, size_t llen,
2585 const unsigned char *p, size_t plen,
2588 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2591 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2596 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2598 const unsigned char *session_id = a->session_id;
2600 unsigned char tmp_storage[4];
2602 if (a->session_id_length < sizeof(tmp_storage)) {
2603 memset(tmp_storage, 0, sizeof(tmp_storage));
2604 memcpy(tmp_storage, a->session_id, a->session_id_length);
2605 session_id = tmp_storage;
2609 ((unsigned long)session_id[0]) |
2610 ((unsigned long)session_id[1] << 8L) |
2611 ((unsigned long)session_id[2] << 16L) |
2612 ((unsigned long)session_id[3] << 24L);
2617 * NB: If this function (or indeed the hash function which uses a sort of
2618 * coarser function than this one) is changed, ensure
2619 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2620 * being able to construct an SSL_SESSION that will collide with any existing
2621 * session with a matching session ID.
2623 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2625 if (a->ssl_version != b->ssl_version)
2627 if (a->session_id_length != b->session_id_length)
2629 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2633 * These wrapper functions should remain rather than redeclaring
2634 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2635 * variable. The reason is that the functions aren't static, they're exposed
2639 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2641 SSL_CTX *ret = NULL;
2644 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2648 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2651 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2652 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2655 ret = OPENSSL_zalloc(sizeof(*ret));
2660 ret->min_proto_version = 0;
2661 ret->max_proto_version = 0;
2662 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2663 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2664 /* We take the system default. */
2665 ret->session_timeout = meth->get_timeout();
2666 ret->references = 1;
2667 ret->lock = CRYPTO_THREAD_lock_new();
2668 if (ret->lock == NULL) {
2669 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2673 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2674 ret->verify_mode = SSL_VERIFY_NONE;
2675 if ((ret->cert = ssl_cert_new()) == NULL)
2678 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2679 if (ret->sessions == NULL)
2681 ret->cert_store = X509_STORE_new();
2682 if (ret->cert_store == NULL)
2684 #ifndef OPENSSL_NO_CT
2685 ret->ctlog_store = CTLOG_STORE_new();
2686 if (ret->ctlog_store == NULL)
2689 if (!ssl_create_cipher_list(ret->method,
2690 &ret->cipher_list, &ret->cipher_list_by_id,
2691 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2692 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2693 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2697 ret->param = X509_VERIFY_PARAM_new();
2698 if (ret->param == NULL)
2701 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2702 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2705 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2706 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2710 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2713 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2716 /* No compression for DTLS */
2717 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2718 ret->comp_methods = SSL_COMP_get_compression_methods();
2720 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2721 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2723 /* Setup RFC5077 ticket keys */
2724 if ((RAND_bytes(ret->ext.tick_key_name,
2725 sizeof(ret->ext.tick_key_name)) <= 0)
2726 || (RAND_bytes(ret->ext.tick_hmac_key,
2727 sizeof(ret->ext.tick_hmac_key)) <= 0)
2728 || (RAND_bytes(ret->ext.tick_aes_key,
2729 sizeof(ret->ext.tick_aes_key)) <= 0))
2730 ret->options |= SSL_OP_NO_TICKET;
2732 #ifndef OPENSSL_NO_SRP
2733 if (!SSL_CTX_SRP_CTX_init(ret))
2736 #ifndef OPENSSL_NO_ENGINE
2737 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2738 # define eng_strx(x) #x
2739 # define eng_str(x) eng_strx(x)
2740 /* Use specific client engine automatically... ignore errors */
2743 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2746 ENGINE_load_builtin_engines();
2747 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2749 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2755 * Default is to connect to non-RI servers. When RI is more widely
2756 * deployed might change this.
2758 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2760 * Disable compression by default to prevent CRIME. Applications can
2761 * re-enable compression by configuring
2762 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2763 * or by using the SSL_CONF library.
2765 ret->options |= SSL_OP_NO_COMPRESSION;
2767 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2771 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2777 int SSL_CTX_up_ref(SSL_CTX *ctx)
2781 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2784 REF_PRINT_COUNT("SSL_CTX", ctx);
2785 REF_ASSERT_ISNT(i < 2);
2786 return ((i > 1) ? 1 : 0);
2789 void SSL_CTX_free(SSL_CTX *a)
2796 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2797 REF_PRINT_COUNT("SSL_CTX", a);
2800 REF_ASSERT_ISNT(i < 0);
2802 X509_VERIFY_PARAM_free(a->param);
2803 dane_ctx_final(&a->dane);
2806 * Free internal session cache. However: the remove_cb() may reference
2807 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2808 * after the sessions were flushed.
2809 * As the ex_data handling routines might also touch the session cache,
2810 * the most secure solution seems to be: empty (flush) the cache, then
2811 * free ex_data, then finally free the cache.
2812 * (See ticket [openssl.org #212].)
2814 if (a->sessions != NULL)
2815 SSL_CTX_flush_sessions(a, 0);
2817 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2818 lh_SSL_SESSION_free(a->sessions);
2819 X509_STORE_free(a->cert_store);
2820 #ifndef OPENSSL_NO_CT
2821 CTLOG_STORE_free(a->ctlog_store);
2823 sk_SSL_CIPHER_free(a->cipher_list);
2824 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2825 ssl_cert_free(a->cert);
2826 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2827 sk_X509_pop_free(a->extra_certs, X509_free);
2828 a->comp_methods = NULL;
2829 #ifndef OPENSSL_NO_SRTP
2830 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2832 #ifndef OPENSSL_NO_SRP
2833 SSL_CTX_SRP_CTX_free(a);
2835 #ifndef OPENSSL_NO_ENGINE
2836 ENGINE_finish(a->client_cert_engine);
2839 #ifndef OPENSSL_NO_EC
2840 OPENSSL_free(a->ext.ecpointformats);
2841 OPENSSL_free(a->ext.supportedgroups);
2843 OPENSSL_free(a->ext.alpn);
2845 CRYPTO_THREAD_lock_free(a->lock);
2850 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2852 ctx->default_passwd_callback = cb;
2855 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2857 ctx->default_passwd_callback_userdata = u;
2860 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2862 return ctx->default_passwd_callback;
2865 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2867 return ctx->default_passwd_callback_userdata;
2870 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2872 s->default_passwd_callback = cb;
2875 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2877 s->default_passwd_callback_userdata = u;
2880 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2882 return s->default_passwd_callback;
2885 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2887 return s->default_passwd_callback_userdata;
2890 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2891 int (*cb) (X509_STORE_CTX *, void *),
2894 ctx->app_verify_callback = cb;
2895 ctx->app_verify_arg = arg;
2898 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2899 int (*cb) (int, X509_STORE_CTX *))
2901 ctx->verify_mode = mode;
2902 ctx->default_verify_callback = cb;
2905 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2907 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2910 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2912 ssl_cert_set_cert_cb(c->cert, cb, arg);
2915 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2917 ssl_cert_set_cert_cb(s->cert, cb, arg);
2920 void ssl_set_masks(SSL *s)
2923 uint32_t *pvalid = s->s3->tmp.valid_flags;
2924 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2925 unsigned long mask_k, mask_a;
2926 #ifndef OPENSSL_NO_EC
2927 int have_ecc_cert, ecdsa_ok;
2932 #ifndef OPENSSL_NO_DH
2933 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2938 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2939 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2940 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
2941 #ifndef OPENSSL_NO_EC
2942 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2948 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2949 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2952 #ifndef OPENSSL_NO_GOST
2953 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2954 mask_k |= SSL_kGOST;
2955 mask_a |= SSL_aGOST12;
2957 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2958 mask_k |= SSL_kGOST;
2959 mask_a |= SSL_aGOST12;
2961 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2962 mask_k |= SSL_kGOST;
2963 mask_a |= SSL_aGOST01;
2973 if (rsa_enc || rsa_sign) {
2981 mask_a |= SSL_aNULL;
2984 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2985 * depending on the key usage extension.
2987 #ifndef OPENSSL_NO_EC
2988 if (have_ecc_cert) {
2990 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
2991 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2992 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2995 mask_a |= SSL_aECDSA;
2999 #ifndef OPENSSL_NO_EC
3000 mask_k |= SSL_kECDHE;
3003 #ifndef OPENSSL_NO_PSK
3006 if (mask_k & SSL_kRSA)
3007 mask_k |= SSL_kRSAPSK;
3008 if (mask_k & SSL_kDHE)
3009 mask_k |= SSL_kDHEPSK;
3010 if (mask_k & SSL_kECDHE)
3011 mask_k |= SSL_kECDHEPSK;
3014 s->s3->tmp.mask_k = mask_k;
3015 s->s3->tmp.mask_a = mask_a;
3018 #ifndef OPENSSL_NO_EC
3020 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3022 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3023 /* key usage, if present, must allow signing */
3024 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3025 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3026 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3030 return 1; /* all checks are ok */
3035 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3036 size_t *serverinfo_length)
3038 CERT_PKEY *cpk = s->s3->tmp.cert;
3039 *serverinfo_length = 0;
3041 if (cpk == NULL || cpk->serverinfo == NULL)
3044 *serverinfo = cpk->serverinfo;
3045 *serverinfo_length = cpk->serverinfo_length;
3049 void ssl_update_cache(SSL *s, int mode)
3054 * If the session_id_length is 0, we are not supposed to cache it, and it
3055 * would be rather hard to do anyway :-)
3057 if (s->session->session_id_length == 0)
3060 i = s->session_ctx->session_cache_mode;
3061 if ((i & mode) && (!s->hit)
3062 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
3063 || SSL_CTX_add_session(s->session_ctx, s->session))
3064 && (s->session_ctx->new_session_cb != NULL)) {
3065 SSL_SESSION_up_ref(s->session);
3066 if (!s->session_ctx->new_session_cb(s, s->session))
3067 SSL_SESSION_free(s->session);
3070 /* auto flush every 255 connections */
3071 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3072 if ((((mode & SSL_SESS_CACHE_CLIENT)
3073 ? s->session_ctx->stats.sess_connect_good
3074 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
3075 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3080 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3085 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3090 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3094 if (s->method != meth) {
3095 const SSL_METHOD *sm = s->method;
3096 int (*hf) (SSL *) = s->handshake_func;
3098 if (sm->version == meth->version)
3103 ret = s->method->ssl_new(s);
3106 if (hf == sm->ssl_connect)
3107 s->handshake_func = meth->ssl_connect;
3108 else if (hf == sm->ssl_accept)
3109 s->handshake_func = meth->ssl_accept;
3114 int SSL_get_error(const SSL *s, int i)
3121 return (SSL_ERROR_NONE);
3124 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3125 * where we do encode the error
3127 if ((l = ERR_peek_error()) != 0) {
3128 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3129 return (SSL_ERROR_SYSCALL);
3131 return (SSL_ERROR_SSL);
3134 if (SSL_want_read(s)) {
3135 bio = SSL_get_rbio(s);
3136 if (BIO_should_read(bio))
3137 return (SSL_ERROR_WANT_READ);
3138 else if (BIO_should_write(bio))
3140 * This one doesn't make too much sense ... We never try to write
3141 * to the rbio, and an application program where rbio and wbio
3142 * are separate couldn't even know what it should wait for.
3143 * However if we ever set s->rwstate incorrectly (so that we have
3144 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3145 * wbio *are* the same, this test works around that bug; so it
3146 * might be safer to keep it.
3148 return (SSL_ERROR_WANT_WRITE);
3149 else if (BIO_should_io_special(bio)) {
3150 reason = BIO_get_retry_reason(bio);
3151 if (reason == BIO_RR_CONNECT)
3152 return (SSL_ERROR_WANT_CONNECT);
3153 else if (reason == BIO_RR_ACCEPT)
3154 return (SSL_ERROR_WANT_ACCEPT);
3156 return (SSL_ERROR_SYSCALL); /* unknown */
3160 if (SSL_want_write(s)) {
3162 * Access wbio directly - in order to use the buffered bio if
3166 if (BIO_should_write(bio))
3167 return (SSL_ERROR_WANT_WRITE);
3168 else if (BIO_should_read(bio))
3170 * See above (SSL_want_read(s) with BIO_should_write(bio))
3172 return (SSL_ERROR_WANT_READ);
3173 else if (BIO_should_io_special(bio)) {
3174 reason = BIO_get_retry_reason(bio);
3175 if (reason == BIO_RR_CONNECT)
3176 return (SSL_ERROR_WANT_CONNECT);
3177 else if (reason == BIO_RR_ACCEPT)
3178 return (SSL_ERROR_WANT_ACCEPT);
3180 return (SSL_ERROR_SYSCALL);
3183 if (SSL_want_x509_lookup(s))
3184 return (SSL_ERROR_WANT_X509_LOOKUP);
3185 if (SSL_want_async(s))
3186 return SSL_ERROR_WANT_ASYNC;
3187 if (SSL_want_async_job(s))
3188 return SSL_ERROR_WANT_ASYNC_JOB;
3189 if (SSL_want_early(s))
3190 return SSL_ERROR_WANT_EARLY;
3192 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3193 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3194 return (SSL_ERROR_ZERO_RETURN);
3196 return (SSL_ERROR_SYSCALL);
3199 static int ssl_do_handshake_intern(void *vargs)
3201 struct ssl_async_args *args;
3204 args = (struct ssl_async_args *)vargs;
3207 return s->handshake_func(s);
3210 int SSL_do_handshake(SSL *s)
3214 if (s->handshake_func == NULL) {
3215 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3219 if (s->early_data_state == SSL_EARLY_DATA_WRITE_RETRY
3220 || s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY)
3223 s->method->ssl_renegotiate_check(s, 0);
3225 if (SSL_in_init(s) || SSL_in_before(s)) {
3226 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3227 struct ssl_async_args args;
3231 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3233 ret = s->handshake_func(s);
3239 void SSL_set_accept_state(SSL *s)
3243 ossl_statem_clear(s);
3244 s->handshake_func = s->method->ssl_accept;
3248 void SSL_set_connect_state(SSL *s)
3252 ossl_statem_clear(s);
3253 s->handshake_func = s->method->ssl_connect;
3257 int ssl_undefined_function(SSL *s)
3259 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3263 int ssl_undefined_void_function(void)
3265 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3266 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3270 int ssl_undefined_const_function(const SSL *s)
3275 const SSL_METHOD *ssl_bad_method(int ver)
3277 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3281 const char *ssl_protocol_to_string(int version)
3285 case TLS1_3_VERSION:
3288 case TLS1_2_VERSION:
3291 case TLS1_1_VERSION:
3306 case DTLS1_2_VERSION:
3314 const char *SSL_get_version(const SSL *s)
3316 return ssl_protocol_to_string(s->version);
3319 SSL *SSL_dup(SSL *s)
3321 STACK_OF(X509_NAME) *sk;
3326 /* If we're not quiescent, just up_ref! */
3327 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3328 CRYPTO_UP_REF(&s->references, &i, s->lock);
3333 * Otherwise, copy configuration state, and session if set.
3335 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3338 if (s->session != NULL) {
3340 * Arranges to share the same session via up_ref. This "copies"
3341 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3343 if (!SSL_copy_session_id(ret, s))
3347 * No session has been established yet, so we have to expect that
3348 * s->cert or ret->cert will be changed later -- they should not both
3349 * point to the same object, and thus we can't use
3350 * SSL_copy_session_id.
3352 if (!SSL_set_ssl_method(ret, s->method))
3355 if (s->cert != NULL) {
3356 ssl_cert_free(ret->cert);
3357 ret->cert = ssl_cert_dup(s->cert);
3358 if (ret->cert == NULL)
3362 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3363 (int)s->sid_ctx_length))
3367 if (!ssl_dane_dup(ret, s))
3369 ret->version = s->version;
3370 ret->options = s->options;
3371 ret->mode = s->mode;
3372 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3373 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3374 ret->msg_callback = s->msg_callback;
3375 ret->msg_callback_arg = s->msg_callback_arg;
3376 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3377 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3378 ret->generate_session_id = s->generate_session_id;
3380 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3382 /* copy app data, a little dangerous perhaps */
3383 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3386 /* setup rbio, and wbio */
3387 if (s->rbio != NULL) {
3388 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3391 if (s->wbio != NULL) {
3392 if (s->wbio != s->rbio) {
3393 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3396 BIO_up_ref(ret->rbio);
3397 ret->wbio = ret->rbio;
3401 ret->server = s->server;
3402 if (s->handshake_func) {
3404 SSL_set_accept_state(ret);
3406 SSL_set_connect_state(ret);
3408 ret->shutdown = s->shutdown;
3411 ret->default_passwd_callback = s->default_passwd_callback;
3412 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3414 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3416 /* dup the cipher_list and cipher_list_by_id stacks */
3417 if (s->cipher_list != NULL) {
3418 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3421 if (s->cipher_list_by_id != NULL)
3422 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3426 /* Dup the client_CA list */
3427 if (s->client_CA != NULL) {
3428 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3430 ret->client_CA = sk;
3431 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3432 xn = sk_X509_NAME_value(sk, i);
3433 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3446 void ssl_clear_cipher_ctx(SSL *s)
3448 if (s->enc_read_ctx != NULL) {
3449 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3450 s->enc_read_ctx = NULL;
3452 if (s->enc_write_ctx != NULL) {
3453 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3454 s->enc_write_ctx = NULL;
3456 #ifndef OPENSSL_NO_COMP
3457 COMP_CTX_free(s->expand);
3459 COMP_CTX_free(s->compress);
3464 X509 *SSL_get_certificate(const SSL *s)
3466 if (s->cert != NULL)
3467 return (s->cert->key->x509);
3472 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3474 if (s->cert != NULL)
3475 return (s->cert->key->privatekey);
3480 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3482 if (ctx->cert != NULL)
3483 return ctx->cert->key->x509;
3488 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3490 if (ctx->cert != NULL)
3491 return ctx->cert->key->privatekey;
3496 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3498 if ((s->session != NULL) && (s->session->cipher != NULL))
3499 return (s->session->cipher);
3503 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3505 #ifndef OPENSSL_NO_COMP
3506 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3512 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3514 #ifndef OPENSSL_NO_COMP
3515 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3521 int ssl_init_wbio_buffer(SSL *s)
3525 if (s->bbio != NULL) {
3526 /* Already buffered. */
3530 bbio = BIO_new(BIO_f_buffer());
3531 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3533 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3537 s->wbio = BIO_push(bbio, s->wbio);
3542 void ssl_free_wbio_buffer(SSL *s)
3544 /* callers ensure s is never null */
3545 if (s->bbio == NULL)
3548 s->wbio = BIO_pop(s->wbio);
3549 assert(s->wbio != NULL);
3554 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3556 ctx->quiet_shutdown = mode;
3559 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3561 return (ctx->quiet_shutdown);
3564 void SSL_set_quiet_shutdown(SSL *s, int mode)
3566 s->quiet_shutdown = mode;
3569 int SSL_get_quiet_shutdown(const SSL *s)
3571 return (s->quiet_shutdown);
3574 void SSL_set_shutdown(SSL *s, int mode)
3579 int SSL_get_shutdown(const SSL *s)
3584 int SSL_version(const SSL *s)
3589 int SSL_client_version(const SSL *s)
3591 return s->client_version;
3594 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3599 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3602 if (ssl->ctx == ctx)
3605 ctx = ssl->session_ctx;
3606 new_cert = ssl_cert_dup(ctx->cert);
3607 if (new_cert == NULL) {
3610 ssl_cert_free(ssl->cert);
3611 ssl->cert = new_cert;
3614 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3615 * so setter APIs must prevent invalid lengths from entering the system.
3617 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3620 * If the session ID context matches that of the parent SSL_CTX,
3621 * inherit it from the new SSL_CTX as well. If however the context does
3622 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3623 * leave it unchanged.
3625 if ((ssl->ctx != NULL) &&
3626 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3627 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3628 ssl->sid_ctx_length = ctx->sid_ctx_length;
3629 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3632 SSL_CTX_up_ref(ctx);
3633 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3639 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3641 return (X509_STORE_set_default_paths(ctx->cert_store));
3644 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3646 X509_LOOKUP *lookup;
3648 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3651 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3653 /* Clear any errors if the default directory does not exist */
3659 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3661 X509_LOOKUP *lookup;
3663 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3667 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3669 /* Clear any errors if the default file does not exist */
3675 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3678 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3681 void SSL_set_info_callback(SSL *ssl,
3682 void (*cb) (const SSL *ssl, int type, int val))
3684 ssl->info_callback = cb;
3688 * One compiler (Diab DCC) doesn't like argument names in returned function
3691 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3694 return ssl->info_callback;
3697 void SSL_set_verify_result(SSL *ssl, long arg)
3699 ssl->verify_result = arg;
3702 long SSL_get_verify_result(const SSL *ssl)
3704 return (ssl->verify_result);
3707 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3710 return sizeof(ssl->s3->client_random);
3711 if (outlen > sizeof(ssl->s3->client_random))
3712 outlen = sizeof(ssl->s3->client_random);
3713 memcpy(out, ssl->s3->client_random, outlen);
3717 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3720 return sizeof(ssl->s3->server_random);
3721 if (outlen > sizeof(ssl->s3->server_random))
3722 outlen = sizeof(ssl->s3->server_random);
3723 memcpy(out, ssl->s3->server_random, outlen);
3727 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3728 unsigned char *out, size_t outlen)
3731 return session->master_key_length;
3732 if (outlen > session->master_key_length)
3733 outlen = session->master_key_length;
3734 memcpy(out, session->master_key, outlen);
3738 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3740 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3743 void *SSL_get_ex_data(const SSL *s, int idx)
3745 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3748 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3750 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3753 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3755 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3758 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3760 return (ctx->cert_store);
3763 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3765 X509_STORE_free(ctx->cert_store);
3766 ctx->cert_store = store;
3769 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3772 X509_STORE_up_ref(store);
3773 SSL_CTX_set_cert_store(ctx, store);
3776 int SSL_want(const SSL *s)
3778 return (s->rwstate);
3782 * \brief Set the callback for generating temporary DH keys.
3783 * \param ctx the SSL context.
3784 * \param dh the callback
3787 #ifndef OPENSSL_NO_DH
3788 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3789 DH *(*dh) (SSL *ssl, int is_export,
3792 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3795 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3798 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3802 #ifndef OPENSSL_NO_PSK
3803 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3805 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3806 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3809 OPENSSL_free(ctx->cert->psk_identity_hint);
3810 if (identity_hint != NULL) {
3811 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3812 if (ctx->cert->psk_identity_hint == NULL)
3815 ctx->cert->psk_identity_hint = NULL;
3819 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3824 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3825 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3828 OPENSSL_free(s->cert->psk_identity_hint);
3829 if (identity_hint != NULL) {
3830 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3831 if (s->cert->psk_identity_hint == NULL)
3834 s->cert->psk_identity_hint = NULL;
3838 const char *SSL_get_psk_identity_hint(const SSL *s)
3840 if (s == NULL || s->session == NULL)
3842 return (s->session->psk_identity_hint);
3845 const char *SSL_get_psk_identity(const SSL *s)
3847 if (s == NULL || s->session == NULL)
3849 return (s->session->psk_identity);
3852 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3854 s->psk_client_callback = cb;
3857 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3859 ctx->psk_client_callback = cb;
3862 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3864 s->psk_server_callback = cb;
3867 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3869 ctx->psk_server_callback = cb;
3873 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3874 void (*cb) (int write_p, int version,
3875 int content_type, const void *buf,
3876 size_t len, SSL *ssl, void *arg))
3878 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3881 void SSL_set_msg_callback(SSL *ssl,
3882 void (*cb) (int write_p, int version,
3883 int content_type, const void *buf,
3884 size_t len, SSL *ssl, void *arg))
3886 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3889 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3890 int (*cb) (SSL *ssl,
3894 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3895 (void (*)(void))cb);
3898 void SSL_set_not_resumable_session_callback(SSL *ssl,
3899 int (*cb) (SSL *ssl,
3900 int is_forward_secure))
3902 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3903 (void (*)(void))cb);
3907 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3908 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3909 * If EVP_MD pointer is passed, initializes ctx with this md.
3910 * Returns the newly allocated ctx;
3913 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3915 ssl_clear_hash_ctx(hash);
3916 *hash = EVP_MD_CTX_new();
3917 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3918 EVP_MD_CTX_free(*hash);
3925 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3928 EVP_MD_CTX_free(*hash);
3932 /* Retrieve handshake hashes */
3933 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3936 EVP_MD_CTX *ctx = NULL;
3937 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3938 int hashleni = EVP_MD_CTX_size(hdgst);
3941 if (hashleni < 0 || (size_t)hashleni > outlen)
3944 ctx = EVP_MD_CTX_new();
3948 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3949 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3952 *hashlen = hashleni;
3956 EVP_MD_CTX_free(ctx);
3960 int SSL_session_reused(SSL *s)
3965 int SSL_is_server(SSL *s)
3970 #if OPENSSL_API_COMPAT < 0x10100000L
3971 void SSL_set_debug(SSL *s, int debug)
3973 /* Old function was do-nothing anyway... */
3979 void SSL_set_security_level(SSL *s, int level)
3981 s->cert->sec_level = level;
3984 int SSL_get_security_level(const SSL *s)
3986 return s->cert->sec_level;
3989 void SSL_set_security_callback(SSL *s,
3990 int (*cb) (const SSL *s, const SSL_CTX *ctx,
3991 int op, int bits, int nid,
3992 void *other, void *ex))
3994 s->cert->sec_cb = cb;
3997 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
3998 const SSL_CTX *ctx, int op,
3999 int bits, int nid, void *other,
4001 return s->cert->sec_cb;
4004 void SSL_set0_security_ex_data(SSL *s, void *ex)
4006 s->cert->sec_ex = ex;
4009 void *SSL_get0_security_ex_data(const SSL *s)
4011 return s->cert->sec_ex;
4014 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4016 ctx->cert->sec_level = level;
4019 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4021 return ctx->cert->sec_level;
4024 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4025 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4026 int op, int bits, int nid,
4027 void *other, void *ex))
4029 ctx->cert->sec_cb = cb;
4032 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4038 return ctx->cert->sec_cb;
4041 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4043 ctx->cert->sec_ex = ex;
4046 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4048 return ctx->cert->sec_ex;
4052 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4053 * can return unsigned long, instead of the generic long return value from the
4054 * control interface.
4056 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4058 return ctx->options;
4061 unsigned long SSL_get_options(const SSL *s)
4066 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4068 return ctx->options |= op;
4071 unsigned long SSL_set_options(SSL *s, unsigned long op)
4073 return s->options |= op;
4076 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4078 return ctx->options &= ~op;
4081 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4083 return s->options &= ~op;
4086 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4088 return s->verified_chain;
4091 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4093 #ifndef OPENSSL_NO_CT
4096 * Moves SCTs from the |src| stack to the |dst| stack.
4097 * The source of each SCT will be set to |origin|.
4098 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4100 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4102 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4103 sct_source_t origin)
4109 *dst = sk_SCT_new_null();
4111 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4116 while ((sct = sk_SCT_pop(src)) != NULL) {
4117 if (SCT_set_source(sct, origin) != 1)
4120 if (sk_SCT_push(*dst, sct) <= 0)
4128 sk_SCT_push(src, sct); /* Put the SCT back */
4133 * Look for data collected during ServerHello and parse if found.
4134 * Returns the number of SCTs extracted.
4136 static int ct_extract_tls_extension_scts(SSL *s)
4138 int scts_extracted = 0;
4140 if (s->ext.scts != NULL) {
4141 const unsigned char *p = s->ext.scts;
4142 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4144 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4146 SCT_LIST_free(scts);
4149 return scts_extracted;
4153 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4154 * contains an SCT X509 extension. They will be stored in |s->scts|.
4156 * - The number of SCTs extracted, assuming an OCSP response exists.
4157 * - 0 if no OCSP response exists or it contains no SCTs.
4158 * - A negative integer if an error occurs.
4160 static int ct_extract_ocsp_response_scts(SSL *s)
4162 # ifndef OPENSSL_NO_OCSP
4163 int scts_extracted = 0;
4164 const unsigned char *p;
4165 OCSP_BASICRESP *br = NULL;
4166 OCSP_RESPONSE *rsp = NULL;
4167 STACK_OF(SCT) *scts = NULL;
4170 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4173 p = s->ext.ocsp.resp;
4174 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4178 br = OCSP_response_get1_basic(rsp);
4182 for (i = 0; i < OCSP_resp_count(br); ++i) {
4183 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4189 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4191 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4192 if (scts_extracted < 0)
4196 SCT_LIST_free(scts);
4197 OCSP_BASICRESP_free(br);
4198 OCSP_RESPONSE_free(rsp);
4199 return scts_extracted;
4201 /* Behave as if no OCSP response exists */
4207 * Attempts to extract SCTs from the peer certificate.
4208 * Return the number of SCTs extracted, or a negative integer if an error
4211 static int ct_extract_x509v3_extension_scts(SSL *s)
4213 int scts_extracted = 0;
4214 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4217 STACK_OF(SCT) *scts =
4218 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4221 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4223 SCT_LIST_free(scts);
4226 return scts_extracted;
4230 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4231 * response (if it exists) and X509v3 extensions in the certificate.
4232 * Returns NULL if an error occurs.
4234 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4236 if (!s->scts_parsed) {
4237 if (ct_extract_tls_extension_scts(s) < 0 ||
4238 ct_extract_ocsp_response_scts(s) < 0 ||
4239 ct_extract_x509v3_extension_scts(s) < 0)
4249 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4250 const STACK_OF(SCT) *scts, void *unused_arg)
4255 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4256 const STACK_OF(SCT) *scts, void *unused_arg)
4258 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4261 for (i = 0; i < count; ++i) {
4262 SCT *sct = sk_SCT_value(scts, i);
4263 int status = SCT_get_validation_status(sct);
4265 if (status == SCT_VALIDATION_STATUS_VALID)
4268 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4272 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4276 * Since code exists that uses the custom extension handler for CT, look
4277 * for this and throw an error if they have already registered to use CT.
4279 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4280 TLSEXT_TYPE_signed_certificate_timestamp))
4282 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4283 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4287 if (callback != NULL) {
4289 * If we are validating CT, then we MUST accept SCTs served via OCSP
4291 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4295 s->ct_validation_callback = callback;
4296 s->ct_validation_callback_arg = arg;
4301 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4302 ssl_ct_validation_cb callback, void *arg)
4305 * Since code exists that uses the custom extension handler for CT, look for
4306 * this and throw an error if they have already registered to use CT.
4308 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4309 TLSEXT_TYPE_signed_certificate_timestamp))
4311 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4312 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4316 ctx->ct_validation_callback = callback;
4317 ctx->ct_validation_callback_arg = arg;
4321 int SSL_ct_is_enabled(const SSL *s)
4323 return s->ct_validation_callback != NULL;
4326 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4328 return ctx->ct_validation_callback != NULL;
4331 int ssl_validate_ct(SSL *s)
4334 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4336 SSL_DANE *dane = &s->dane;
4337 CT_POLICY_EVAL_CTX *ctx = NULL;
4338 const STACK_OF(SCT) *scts;
4341 * If no callback is set, the peer is anonymous, or its chain is invalid,
4342 * skip SCT validation - just return success. Applications that continue
4343 * handshakes without certificates, with unverified chains, or pinned leaf
4344 * certificates are outside the scope of the WebPKI and CT.
4346 * The above exclusions notwithstanding the vast majority of peers will
4347 * have rather ordinary certificate chains validated by typical
4348 * applications that perform certificate verification and therefore will
4349 * process SCTs when enabled.
4351 if (s->ct_validation_callback == NULL || cert == NULL ||
4352 s->verify_result != X509_V_OK ||
4353 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4357 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4358 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4360 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4361 switch (dane->mtlsa->usage) {
4362 case DANETLS_USAGE_DANE_TA:
4363 case DANETLS_USAGE_DANE_EE:
4368 ctx = CT_POLICY_EVAL_CTX_new();
4370 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4374 issuer = sk_X509_value(s->verified_chain, 1);
4375 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4376 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4377 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4378 CT_POLICY_EVAL_CTX_set_time(ctx, SSL_SESSION_get_time(SSL_get0_session(s)));
4380 scts = SSL_get0_peer_scts(s);
4383 * This function returns success (> 0) only when all the SCTs are valid, 0
4384 * when some are invalid, and < 0 on various internal errors (out of
4385 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4386 * reason to abort the handshake, that decision is up to the callback.
4387 * Therefore, we error out only in the unexpected case that the return
4388 * value is negative.
4390 * XXX: One might well argue that the return value of this function is an
4391 * unfortunate design choice. Its job is only to determine the validation
4392 * status of each of the provided SCTs. So long as it correctly separates
4393 * the wheat from the chaff it should return success. Failure in this case
4394 * ought to correspond to an inability to carry out its duties.
4396 if (SCT_LIST_validate(scts, ctx) < 0) {
4397 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4401 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4403 ret = 0; /* This function returns 0 on failure */
4406 CT_POLICY_EVAL_CTX_free(ctx);
4408 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4409 * failure return code here. Also the application may wish the complete
4410 * the handshake, and then disconnect cleanly at a higher layer, after
4411 * checking the verification status of the completed connection.
4413 * We therefore force a certificate verification failure which will be
4414 * visible via SSL_get_verify_result() and cached as part of any resumed
4417 * Note: the permissive callback is for information gathering only, always
4418 * returns success, and does not affect verification status. Only the
4419 * strict callback or a custom application-specified callback can trigger
4420 * connection failure or record a verification error.
4423 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4427 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4429 switch (validation_mode) {
4431 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4433 case SSL_CT_VALIDATION_PERMISSIVE:
4434 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4435 case SSL_CT_VALIDATION_STRICT:
4436 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4440 int SSL_enable_ct(SSL *s, int validation_mode)
4442 switch (validation_mode) {
4444 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4446 case SSL_CT_VALIDATION_PERMISSIVE:
4447 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4448 case SSL_CT_VALIDATION_STRICT:
4449 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4453 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4455 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4458 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4460 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4463 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4465 CTLOG_STORE_free(ctx->ctlog_store);
4466 ctx->ctlog_store = logs;
4469 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4471 return ctx->ctlog_store;
4474 #endif /* OPENSSL_NO_CT */
4476 void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn cb, void *arg)
4479 c->early_cb_arg = arg;
4482 int SSL_early_isv2(SSL *s)
4484 if (s->clienthello == NULL)
4486 return s->clienthello->isv2;
4489 unsigned int SSL_early_get0_legacy_version(SSL *s)
4491 if (s->clienthello == NULL)
4493 return s->clienthello->legacy_version;
4496 size_t SSL_early_get0_random(SSL *s, const unsigned char **out)
4498 if (s->clienthello == NULL)
4501 *out = s->clienthello->random;
4502 return SSL3_RANDOM_SIZE;
4505 size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out)
4507 if (s->clienthello == NULL)
4510 *out = s->clienthello->session_id;
4511 return s->clienthello->session_id_len;
4514 size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out)
4516 if (s->clienthello == NULL)
4519 *out = PACKET_data(&s->clienthello->ciphersuites);
4520 return PACKET_remaining(&s->clienthello->ciphersuites);
4523 size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out)
4525 if (s->clienthello == NULL)
4528 *out = s->clienthello->compressions;
4529 return s->clienthello->compressions_len;
4532 int SSL_early_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4538 if (s->clienthello == NULL)
4540 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4541 r = s->clienthello->pre_proc_exts + i;
4542 if (r->present && r->type == type) {
4544 *out = PACKET_data(&r->data);
4546 *outlen = PACKET_remaining(&r->data);
4553 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4555 ctx->keylog_callback = cb;
4558 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4560 return ctx->keylog_callback;
4563 static int nss_keylog_int(const char *prefix,
4565 const uint8_t *parameter_1,
4566 size_t parameter_1_len,
4567 const uint8_t *parameter_2,
4568 size_t parameter_2_len)
4571 char *cursor = NULL;
4576 if (ssl->ctx->keylog_callback == NULL) return 1;
4579 * Our output buffer will contain the following strings, rendered with
4580 * space characters in between, terminated by a NULL character: first the
4581 * prefix, then the first parameter, then the second parameter. The
4582 * meaning of each parameter depends on the specific key material being
4583 * logged. Note that the first and second parameters are encoded in
4584 * hexadecimal, so we need a buffer that is twice their lengths.
4586 prefix_len = strlen(prefix);
4587 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4588 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4589 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4593 strcpy(cursor, prefix);
4594 cursor += prefix_len;
4597 for (i = 0; i < parameter_1_len; i++) {
4598 sprintf(cursor, "%02x", parameter_1[i]);
4603 for (i = 0; i < parameter_2_len; i++) {
4604 sprintf(cursor, "%02x", parameter_2[i]);
4609 ssl->ctx->keylog_callback(ssl, (const char *)out);
4615 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4616 const uint8_t *encrypted_premaster,
4617 size_t encrypted_premaster_len,
4618 const uint8_t *premaster,
4619 size_t premaster_len)
4621 if (encrypted_premaster_len < 8) {
4622 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4626 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4627 return nss_keylog_int("RSA",
4629 encrypted_premaster,
4635 int ssl_log_secret(SSL *ssl,
4637 const uint8_t *secret,
4640 return nss_keylog_int(label,
4642 ssl->s3->client_random,
4648 #define SSLV2_CIPHER_LEN 3
4650 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format,
4655 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4657 if (PACKET_remaining(cipher_suites) == 0) {
4658 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST, SSL_R_NO_CIPHERS_SPECIFIED);
4659 *al = SSL_AD_ILLEGAL_PARAMETER;
4663 if (PACKET_remaining(cipher_suites) % n != 0) {
4664 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST,
4665 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4666 *al = SSL_AD_DECODE_ERROR;
4670 OPENSSL_free(s->s3->tmp.ciphers_raw);
4671 s->s3->tmp.ciphers_raw = NULL;
4672 s->s3->tmp.ciphers_rawlen = 0;
4675 size_t numciphers = PACKET_remaining(cipher_suites) / n;
4676 PACKET sslv2ciphers = *cipher_suites;
4677 unsigned int leadbyte;
4681 * We store the raw ciphers list in SSLv3+ format so we need to do some
4682 * preprocessing to convert the list first. If there are any SSLv2 only
4683 * ciphersuites with a non-zero leading byte then we are going to
4684 * slightly over allocate because we won't store those. But that isn't a
4687 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
4688 s->s3->tmp.ciphers_raw = raw;
4690 *al = SSL_AD_INTERNAL_ERROR;
4693 for (s->s3->tmp.ciphers_rawlen = 0;
4694 PACKET_remaining(&sslv2ciphers) > 0;
4695 raw += TLS_CIPHER_LEN) {
4696 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
4698 && !PACKET_copy_bytes(&sslv2ciphers, raw,
4701 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
4702 *al = SSL_AD_INTERNAL_ERROR;
4703 OPENSSL_free(s->s3->tmp.ciphers_raw);
4704 s->s3->tmp.ciphers_raw = NULL;
4705 s->s3->tmp.ciphers_rawlen = 0;
4709 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
4711 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
4712 &s->s3->tmp.ciphers_rawlen)) {
4713 *al = SSL_AD_INTERNAL_ERROR;
4721 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
4722 int isv2format, STACK_OF(SSL_CIPHER) **sk,
4723 STACK_OF(SSL_CIPHER) **scsvs)
4728 if (!PACKET_buf_init(&pkt, bytes, len))
4730 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, &alert);
4733 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
4734 STACK_OF(SSL_CIPHER) **skp,
4735 STACK_OF(SSL_CIPHER) **scsvs_out,
4736 int sslv2format, int *al)
4738 const SSL_CIPHER *c;
4739 STACK_OF(SSL_CIPHER) *sk = NULL;
4740 STACK_OF(SSL_CIPHER) *scsvs = NULL;
4742 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
4743 unsigned char cipher[SSLV2_CIPHER_LEN];
4745 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4747 if (PACKET_remaining(cipher_suites) == 0) {
4748 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
4749 *al = SSL_AD_ILLEGAL_PARAMETER;
4753 if (PACKET_remaining(cipher_suites) % n != 0) {
4754 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
4755 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4756 *al = SSL_AD_DECODE_ERROR;
4760 sk = sk_SSL_CIPHER_new_null();
4761 scsvs = sk_SSL_CIPHER_new_null();
4762 if (sk == NULL || scsvs == NULL) {
4763 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4764 *al = SSL_AD_INTERNAL_ERROR;
4768 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
4770 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
4771 * first byte set to zero, while true SSLv2 ciphers have a non-zero
4772 * first byte. We don't support any true SSLv2 ciphers, so skip them.
4774 if (sslv2format && cipher[0] != '\0')
4777 /* For SSLv2-compat, ignore leading 0-byte. */
4778 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
4780 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
4781 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
4782 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4783 *al = SSL_AD_INTERNAL_ERROR;
4788 if (PACKET_remaining(cipher_suites) > 0) {
4789 *al = SSL_AD_INTERNAL_ERROR;
4790 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_INTERNAL_ERROR);
4797 sk_SSL_CIPHER_free(sk);
4798 if (scsvs_out != NULL)
4801 sk_SSL_CIPHER_free(scsvs);
4804 sk_SSL_CIPHER_free(sk);
4805 sk_SSL_CIPHER_free(scsvs);
4809 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
4811 ctx->max_early_data = max_early_data;
4816 uint32_t SSL_CTX_get_max_early_data(SSL_CTX *ctx)
4818 return ctx->max_early_data;
4821 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
4823 s->max_early_data = max_early_data;
4828 uint32_t SSL_get_max_early_data(SSL_CTX *s)
4830 return s->max_early_data;