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->record_padding_cb = ctx->record_padding_cb;
575 s->record_padding_arg = ctx->record_padding_arg;
576 s->block_padding = ctx->block_padding;
577 s->sid_ctx_length = ctx->sid_ctx_length;
578 if (!ossl_assert(s->sid_ctx_length <= sizeof s->sid_ctx))
580 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
581 s->verify_callback = ctx->default_verify_callback;
582 s->generate_session_id = ctx->generate_session_id;
584 s->param = X509_VERIFY_PARAM_new();
585 if (s->param == NULL)
587 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
588 s->quiet_shutdown = ctx->quiet_shutdown;
589 s->max_send_fragment = ctx->max_send_fragment;
590 s->split_send_fragment = ctx->split_send_fragment;
591 s->max_pipelines = ctx->max_pipelines;
592 if (s->max_pipelines > 1)
593 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
594 if (ctx->default_read_buf_len > 0)
595 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
600 s->ext.debug_arg = NULL;
601 s->ext.ticket_expected = 0;
602 s->ext.status_type = ctx->ext.status_type;
603 s->ext.status_expected = 0;
604 s->ext.ocsp.ids = NULL;
605 s->ext.ocsp.exts = NULL;
606 s->ext.ocsp.resp = NULL;
607 s->ext.ocsp.resp_len = 0;
609 s->session_ctx = ctx;
610 #ifndef OPENSSL_NO_EC
611 if (ctx->ext.ecpointformats) {
612 s->ext.ecpointformats =
613 OPENSSL_memdup(ctx->ext.ecpointformats,
614 ctx->ext.ecpointformats_len);
615 if (!s->ext.ecpointformats)
617 s->ext.ecpointformats_len =
618 ctx->ext.ecpointformats_len;
620 if (ctx->ext.supportedgroups) {
621 s->ext.supportedgroups =
622 OPENSSL_memdup(ctx->ext.supportedgroups,
623 ctx->ext.supportedgroups_len);
624 if (!s->ext.supportedgroups)
626 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
629 #ifndef OPENSSL_NO_NEXTPROTONEG
633 if (s->ctx->ext.alpn) {
634 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
635 if (s->ext.alpn == NULL)
637 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
638 s->ext.alpn_len = s->ctx->ext.alpn_len;
641 s->verified_chain = NULL;
642 s->verify_result = X509_V_OK;
644 s->default_passwd_callback = ctx->default_passwd_callback;
645 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
647 s->method = ctx->method;
649 s->key_update = SSL_KEY_UPDATE_NONE;
651 if (!s->method->ssl_new(s))
654 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
659 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
662 #ifndef OPENSSL_NO_PSK
663 s->psk_client_callback = ctx->psk_client_callback;
664 s->psk_server_callback = ctx->psk_server_callback;
669 #ifndef OPENSSL_NO_CT
670 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
671 ctx->ct_validation_callback_arg))
678 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
682 int SSL_is_dtls(const SSL *s)
684 return SSL_IS_DTLS(s) ? 1 : 0;
687 int SSL_up_ref(SSL *s)
691 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
694 REF_PRINT_COUNT("SSL", s);
695 REF_ASSERT_ISNT(i < 2);
696 return ((i > 1) ? 1 : 0);
699 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
700 unsigned int sid_ctx_len)
702 if (sid_ctx_len > sizeof ctx->sid_ctx) {
703 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
704 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
707 ctx->sid_ctx_length = sid_ctx_len;
708 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
713 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
714 unsigned int sid_ctx_len)
716 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
717 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
718 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
721 ssl->sid_ctx_length = sid_ctx_len;
722 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
727 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
729 CRYPTO_THREAD_write_lock(ctx->lock);
730 ctx->generate_session_id = cb;
731 CRYPTO_THREAD_unlock(ctx->lock);
735 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
737 CRYPTO_THREAD_write_lock(ssl->lock);
738 ssl->generate_session_id = cb;
739 CRYPTO_THREAD_unlock(ssl->lock);
743 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
747 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
748 * we can "construct" a session to give us the desired check - i.e. to
749 * find if there's a session in the hash table that would conflict with
750 * any new session built out of this id/id_len and the ssl_version in use
755 if (id_len > sizeof r.session_id)
758 r.ssl_version = ssl->version;
759 r.session_id_length = id_len;
760 memcpy(r.session_id, id, id_len);
762 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
763 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
764 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
768 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
770 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
773 int SSL_set_purpose(SSL *s, int purpose)
775 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
778 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
780 return X509_VERIFY_PARAM_set_trust(s->param, trust);
783 int SSL_set_trust(SSL *s, int trust)
785 return X509_VERIFY_PARAM_set_trust(s->param, trust);
788 int SSL_set1_host(SSL *s, const char *hostname)
790 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
793 int SSL_add1_host(SSL *s, const char *hostname)
795 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
798 void SSL_set_hostflags(SSL *s, unsigned int flags)
800 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
803 const char *SSL_get0_peername(SSL *s)
805 return X509_VERIFY_PARAM_get0_peername(s->param);
808 int SSL_CTX_dane_enable(SSL_CTX *ctx)
810 return dane_ctx_enable(&ctx->dane);
813 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
815 unsigned long orig = ctx->dane.flags;
817 ctx->dane.flags |= flags;
821 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
823 unsigned long orig = ctx->dane.flags;
825 ctx->dane.flags &= ~flags;
829 int SSL_dane_enable(SSL *s, const char *basedomain)
831 SSL_DANE *dane = &s->dane;
833 if (s->ctx->dane.mdmax == 0) {
834 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
837 if (dane->trecs != NULL) {
838 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
843 * Default SNI name. This rejects empty names, while set1_host below
844 * accepts them and disables host name checks. To avoid side-effects with
845 * invalid input, set the SNI name first.
847 if (s->ext.hostname == NULL) {
848 if (!SSL_set_tlsext_host_name(s, basedomain)) {
849 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
854 /* Primary RFC6125 reference identifier */
855 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
856 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
862 dane->dctx = &s->ctx->dane;
863 dane->trecs = sk_danetls_record_new_null();
865 if (dane->trecs == NULL) {
866 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
872 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
874 unsigned long orig = ssl->dane.flags;
876 ssl->dane.flags |= flags;
880 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
882 unsigned long orig = ssl->dane.flags;
884 ssl->dane.flags &= ~flags;
888 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
890 SSL_DANE *dane = &s->dane;
892 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
896 *mcert = dane->mcert;
898 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
903 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
904 uint8_t *mtype, unsigned const char **data, size_t *dlen)
906 SSL_DANE *dane = &s->dane;
908 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
912 *usage = dane->mtlsa->usage;
914 *selector = dane->mtlsa->selector;
916 *mtype = dane->mtlsa->mtype;
918 *data = dane->mtlsa->data;
920 *dlen = dane->mtlsa->dlen;
925 SSL_DANE *SSL_get0_dane(SSL *s)
930 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
931 uint8_t mtype, unsigned char *data, size_t dlen)
933 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
936 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
939 return dane_mtype_set(&ctx->dane, md, mtype, ord);
942 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
944 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
947 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
949 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
952 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
957 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
962 void SSL_certs_clear(SSL *s)
964 ssl_cert_clear_certs(s->cert);
967 void SSL_free(SSL *s)
974 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
975 REF_PRINT_COUNT("SSL", s);
978 REF_ASSERT_ISNT(i < 0);
980 X509_VERIFY_PARAM_free(s->param);
981 dane_final(&s->dane);
982 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
984 ssl_free_wbio_buffer(s);
986 BIO_free_all(s->wbio);
987 BIO_free_all(s->rbio);
989 BUF_MEM_free(s->init_buf);
991 /* add extra stuff */
992 sk_SSL_CIPHER_free(s->cipher_list);
993 sk_SSL_CIPHER_free(s->cipher_list_by_id);
995 /* Make the next call work :-) */
996 if (s->session != NULL) {
997 ssl_clear_bad_session(s);
998 SSL_SESSION_free(s->session);
1003 ssl_cert_free(s->cert);
1004 /* Free up if allocated */
1006 OPENSSL_free(s->ext.hostname);
1007 SSL_CTX_free(s->session_ctx);
1008 #ifndef OPENSSL_NO_EC
1009 OPENSSL_free(s->ext.ecpointformats);
1010 OPENSSL_free(s->ext.supportedgroups);
1011 #endif /* OPENSSL_NO_EC */
1012 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1013 #ifndef OPENSSL_NO_OCSP
1014 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1016 #ifndef OPENSSL_NO_CT
1017 SCT_LIST_free(s->scts);
1018 OPENSSL_free(s->ext.scts);
1020 OPENSSL_free(s->ext.ocsp.resp);
1021 OPENSSL_free(s->ext.alpn);
1022 OPENSSL_free(s->ext.tls13_cookie);
1023 OPENSSL_free(s->clienthello);
1025 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1027 sk_X509_pop_free(s->verified_chain, X509_free);
1029 if (s->method != NULL)
1030 s->method->ssl_free(s);
1032 RECORD_LAYER_release(&s->rlayer);
1034 SSL_CTX_free(s->ctx);
1036 ASYNC_WAIT_CTX_free(s->waitctx);
1038 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1039 OPENSSL_free(s->ext.npn);
1042 #ifndef OPENSSL_NO_SRTP
1043 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1046 CRYPTO_THREAD_lock_free(s->lock);
1051 void SSL_set0_rbio(SSL *s, BIO *rbio)
1053 BIO_free_all(s->rbio);
1057 void SSL_set0_wbio(SSL *s, BIO *wbio)
1060 * If the output buffering BIO is still in place, remove it
1062 if (s->bbio != NULL)
1063 s->wbio = BIO_pop(s->wbio);
1065 BIO_free_all(s->wbio);
1068 /* Re-attach |bbio| to the new |wbio|. */
1069 if (s->bbio != NULL)
1070 s->wbio = BIO_push(s->bbio, s->wbio);
1073 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1076 * For historical reasons, this function has many different cases in
1077 * ownership handling.
1080 /* If nothing has changed, do nothing */
1081 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1085 * If the two arguments are equal then one fewer reference is granted by the
1086 * caller than we want to take
1088 if (rbio != NULL && rbio == wbio)
1092 * If only the wbio is changed only adopt one reference.
1094 if (rbio == SSL_get_rbio(s)) {
1095 SSL_set0_wbio(s, wbio);
1099 * There is an asymmetry here for historical reasons. If only the rbio is
1100 * changed AND the rbio and wbio were originally different, then we only
1101 * adopt one reference.
1103 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1104 SSL_set0_rbio(s, rbio);
1108 /* Otherwise, adopt both references. */
1109 SSL_set0_rbio(s, rbio);
1110 SSL_set0_wbio(s, wbio);
1113 BIO *SSL_get_rbio(const SSL *s)
1118 BIO *SSL_get_wbio(const SSL *s)
1120 if (s->bbio != NULL) {
1122 * If |bbio| is active, the true caller-configured BIO is its
1125 return BIO_next(s->bbio);
1130 int SSL_get_fd(const SSL *s)
1132 return SSL_get_rfd(s);
1135 int SSL_get_rfd(const SSL *s)
1140 b = SSL_get_rbio(s);
1141 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1143 BIO_get_fd(r, &ret);
1147 int SSL_get_wfd(const SSL *s)
1152 b = SSL_get_wbio(s);
1153 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1155 BIO_get_fd(r, &ret);
1159 #ifndef OPENSSL_NO_SOCK
1160 int SSL_set_fd(SSL *s, int fd)
1165 bio = BIO_new(BIO_s_socket());
1168 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1171 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1172 SSL_set_bio(s, bio, bio);
1178 int SSL_set_wfd(SSL *s, int fd)
1180 BIO *rbio = SSL_get_rbio(s);
1182 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1183 || (int)BIO_get_fd(rbio, NULL) != fd) {
1184 BIO *bio = BIO_new(BIO_s_socket());
1187 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1190 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1191 SSL_set0_wbio(s, bio);
1194 SSL_set0_wbio(s, rbio);
1199 int SSL_set_rfd(SSL *s, int fd)
1201 BIO *wbio = SSL_get_wbio(s);
1203 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1204 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1205 BIO *bio = BIO_new(BIO_s_socket());
1208 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1211 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1212 SSL_set0_rbio(s, bio);
1215 SSL_set0_rbio(s, wbio);
1222 /* return length of latest Finished message we sent, copy to 'buf' */
1223 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1227 if (s->s3 != NULL) {
1228 ret = s->s3->tmp.finish_md_len;
1231 memcpy(buf, s->s3->tmp.finish_md, count);
1236 /* return length of latest Finished message we expected, copy to 'buf' */
1237 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1241 if (s->s3 != NULL) {
1242 ret = s->s3->tmp.peer_finish_md_len;
1245 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1250 int SSL_get_verify_mode(const SSL *s)
1252 return (s->verify_mode);
1255 int SSL_get_verify_depth(const SSL *s)
1257 return X509_VERIFY_PARAM_get_depth(s->param);
1260 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1261 return (s->verify_callback);
1264 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1266 return (ctx->verify_mode);
1269 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1271 return X509_VERIFY_PARAM_get_depth(ctx->param);
1274 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1275 return (ctx->default_verify_callback);
1278 void SSL_set_verify(SSL *s, int mode,
1279 int (*callback) (int ok, X509_STORE_CTX *ctx))
1281 s->verify_mode = mode;
1282 if (callback != NULL)
1283 s->verify_callback = callback;
1286 void SSL_set_verify_depth(SSL *s, int depth)
1288 X509_VERIFY_PARAM_set_depth(s->param, depth);
1291 void SSL_set_read_ahead(SSL *s, int yes)
1293 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1296 int SSL_get_read_ahead(const SSL *s)
1298 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1301 int SSL_pending(const SSL *s)
1303 size_t pending = s->method->ssl_pending(s);
1306 * SSL_pending cannot work properly if read-ahead is enabled
1307 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1308 * impossible to fix since SSL_pending cannot report errors that may be
1309 * observed while scanning the new data. (Note that SSL_pending() is
1310 * often used as a boolean value, so we'd better not return -1.)
1312 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1313 * we just return INT_MAX.
1315 return pending < INT_MAX ? (int)pending : INT_MAX;
1318 int SSL_has_pending(const SSL *s)
1321 * Similar to SSL_pending() but returns a 1 to indicate that we have
1322 * unprocessed data available or 0 otherwise (as opposed to the number of
1323 * bytes available). Unlike SSL_pending() this will take into account
1324 * read_ahead data. A 1 return simply indicates that we have unprocessed
1325 * data. That data may not result in any application data, or we may fail
1326 * to parse the records for some reason.
1328 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1331 return RECORD_LAYER_read_pending(&s->rlayer);
1334 X509 *SSL_get_peer_certificate(const SSL *s)
1338 if ((s == NULL) || (s->session == NULL))
1341 r = s->session->peer;
1351 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1355 if ((s == NULL) || (s->session == NULL))
1358 r = s->session->peer_chain;
1361 * If we are a client, cert_chain includes the peer's own certificate; if
1362 * we are a server, it does not.
1369 * Now in theory, since the calling process own 't' it should be safe to
1370 * modify. We need to be able to read f without being hassled
1372 int SSL_copy_session_id(SSL *t, const SSL *f)
1375 /* Do we need to to SSL locking? */
1376 if (!SSL_set_session(t, SSL_get_session(f))) {
1381 * what if we are setup for one protocol version but want to talk another
1383 if (t->method != f->method) {
1384 t->method->ssl_free(t);
1385 t->method = f->method;
1386 if (t->method->ssl_new(t) == 0)
1390 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1391 ssl_cert_free(t->cert);
1393 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1400 /* Fix this so it checks all the valid key/cert options */
1401 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1403 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1404 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1407 if (ctx->cert->key->privatekey == NULL) {
1408 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1411 return (X509_check_private_key
1412 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1415 /* Fix this function so that it takes an optional type parameter */
1416 int SSL_check_private_key(const SSL *ssl)
1419 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1422 if (ssl->cert->key->x509 == NULL) {
1423 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1426 if (ssl->cert->key->privatekey == NULL) {
1427 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1430 return (X509_check_private_key(ssl->cert->key->x509,
1431 ssl->cert->key->privatekey));
1434 int SSL_waiting_for_async(SSL *s)
1442 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1444 ASYNC_WAIT_CTX *ctx = s->waitctx;
1448 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1451 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1452 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1454 ASYNC_WAIT_CTX *ctx = s->waitctx;
1458 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1462 int SSL_accept(SSL *s)
1464 if (s->handshake_func == NULL) {
1465 /* Not properly initialized yet */
1466 SSL_set_accept_state(s);
1469 return SSL_do_handshake(s);
1472 int SSL_connect(SSL *s)
1474 if (s->handshake_func == NULL) {
1475 /* Not properly initialized yet */
1476 SSL_set_connect_state(s);
1479 return SSL_do_handshake(s);
1482 long SSL_get_default_timeout(const SSL *s)
1484 return (s->method->get_timeout());
1487 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1488 int (*func) (void *))
1491 if (s->waitctx == NULL) {
1492 s->waitctx = ASYNC_WAIT_CTX_new();
1493 if (s->waitctx == NULL)
1496 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1497 sizeof(struct ssl_async_args))) {
1499 s->rwstate = SSL_NOTHING;
1500 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1503 s->rwstate = SSL_ASYNC_PAUSED;
1506 s->rwstate = SSL_ASYNC_NO_JOBS;
1512 s->rwstate = SSL_NOTHING;
1513 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1514 /* Shouldn't happen */
1519 static int ssl_io_intern(void *vargs)
1521 struct ssl_async_args *args;
1526 args = (struct ssl_async_args *)vargs;
1530 switch (args->type) {
1532 return args->f.func_read(s, buf, num, &s->asyncrw);
1534 return args->f.func_write(s, buf, num, &s->asyncrw);
1536 return args->f.func_other(s);
1541 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1543 if (s->handshake_func == NULL) {
1544 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1548 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1549 s->rwstate = SSL_NOTHING;
1553 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1554 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1555 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1559 * If we are a client and haven't received the ServerHello etc then we
1562 ossl_statem_check_finish_init(s, 0);
1564 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1565 struct ssl_async_args args;
1571 args.type = READFUNC;
1572 args.f.func_read = s->method->ssl_read;
1574 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1575 *readbytes = s->asyncrw;
1578 return s->method->ssl_read(s, buf, num, readbytes);
1582 int SSL_read(SSL *s, void *buf, int num)
1588 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1592 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1595 * The cast is safe here because ret should be <= INT_MAX because num is
1599 ret = (int)readbytes;
1604 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1606 int ret = ssl_read_internal(s, buf, num, readbytes);
1613 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1618 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1619 return SSL_READ_EARLY_DATA_ERROR;
1622 switch (s->early_data_state) {
1623 case SSL_EARLY_DATA_NONE:
1624 if (!SSL_in_before(s)) {
1625 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1626 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1627 return SSL_READ_EARLY_DATA_ERROR;
1631 case SSL_EARLY_DATA_ACCEPT_RETRY:
1632 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1633 ret = SSL_accept(s);
1636 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1637 return SSL_READ_EARLY_DATA_ERROR;
1641 case SSL_EARLY_DATA_READ_RETRY:
1642 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1643 s->early_data_state = SSL_EARLY_DATA_READING;
1644 ret = SSL_read_ex(s, buf, num, readbytes);
1646 * State machine will update early_data_state to
1647 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1650 if (ret > 0 || (ret <= 0 && s->early_data_state
1651 != SSL_EARLY_DATA_FINISHED_READING)) {
1652 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1653 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1654 : SSL_READ_EARLY_DATA_ERROR;
1657 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1660 return SSL_READ_EARLY_DATA_FINISH;
1663 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1664 return SSL_READ_EARLY_DATA_ERROR;
1668 int SSL_get_early_data_status(const SSL *s)
1670 return s->ext.early_data;
1673 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1675 if (s->handshake_func == NULL) {
1676 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1680 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1683 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1684 struct ssl_async_args args;
1690 args.type = READFUNC;
1691 args.f.func_read = s->method->ssl_peek;
1693 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1694 *readbytes = s->asyncrw;
1697 return s->method->ssl_peek(s, buf, num, readbytes);
1701 int SSL_peek(SSL *s, void *buf, int num)
1707 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1711 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1714 * The cast is safe here because ret should be <= INT_MAX because num is
1718 ret = (int)readbytes;
1724 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1726 int ret = ssl_peek_internal(s, buf, num, readbytes);
1733 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1735 if (s->handshake_func == NULL) {
1736 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1740 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1741 s->rwstate = SSL_NOTHING;
1742 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1746 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1747 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1748 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1749 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1752 /* If we are a client and haven't sent the Finished we better do that */
1753 ossl_statem_check_finish_init(s, 1);
1755 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1757 struct ssl_async_args args;
1760 args.buf = (void *)buf;
1762 args.type = WRITEFUNC;
1763 args.f.func_write = s->method->ssl_write;
1765 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1766 *written = s->asyncrw;
1769 return s->method->ssl_write(s, buf, num, written);
1773 int SSL_write(SSL *s, const void *buf, int num)
1779 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1783 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1786 * The cast is safe here because ret should be <= INT_MAX because num is
1795 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1797 int ret = ssl_write_internal(s, buf, num, written);
1804 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1806 int ret, early_data_state;
1808 switch (s->early_data_state) {
1809 case SSL_EARLY_DATA_NONE:
1811 || !SSL_in_before(s)
1812 || s->session == NULL
1813 || s->session->ext.max_early_data == 0) {
1814 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1815 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1820 case SSL_EARLY_DATA_CONNECT_RETRY:
1821 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1822 ret = SSL_connect(s);
1825 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1830 case SSL_EARLY_DATA_WRITE_RETRY:
1831 s->early_data_state = SSL_EARLY_DATA_WRITING;
1832 ret = SSL_write_ex(s, buf, num, written);
1833 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
1836 case SSL_EARLY_DATA_FINISHED_READING:
1837 case SSL_EARLY_DATA_READ_RETRY:
1838 early_data_state = s->early_data_state;
1839 /* We are a server writing to an unauthenticated client */
1840 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
1841 ret = SSL_write_ex(s, buf, num, written);
1842 s->early_data_state = early_data_state;
1846 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1851 int SSL_shutdown(SSL *s)
1854 * Note that this function behaves differently from what one might
1855 * expect. Return values are 0 for no success (yet), 1 for success; but
1856 * calling it once is usually not enough, even if blocking I/O is used
1857 * (see ssl3_shutdown).
1860 if (s->handshake_func == NULL) {
1861 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1865 if (!SSL_in_init(s)) {
1866 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1867 struct ssl_async_args args;
1870 args.type = OTHERFUNC;
1871 args.f.func_other = s->method->ssl_shutdown;
1873 return ssl_start_async_job(s, &args, ssl_io_intern);
1875 return s->method->ssl_shutdown(s);
1878 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1883 int SSL_key_update(SSL *s, int updatetype)
1886 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
1887 * negotiated, and that it is appropriate to call SSL_key_update() instead
1888 * of SSL_renegotiate().
1890 if (!SSL_IS_TLS13(s)) {
1891 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1895 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1896 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1897 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1901 if (!SSL_is_init_finished(s)) {
1902 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1906 ossl_statem_set_in_init(s, 1);
1907 s->key_update = updatetype;
1911 int SSL_get_key_update_type(SSL *s)
1913 return s->key_update;
1916 int SSL_renegotiate(SSL *s)
1918 if (SSL_IS_TLS13(s)) {
1919 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1923 if (s->renegotiate == 0)
1928 return (s->method->ssl_renegotiate(s));
1931 int SSL_renegotiate_abbreviated(SSL *s)
1933 if (SSL_IS_TLS13(s))
1936 if (s->renegotiate == 0)
1941 return (s->method->ssl_renegotiate(s));
1944 int SSL_renegotiate_pending(SSL *s)
1947 * becomes true when negotiation is requested; false again once a
1948 * handshake has finished
1950 return (s->renegotiate != 0);
1953 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1958 case SSL_CTRL_GET_READ_AHEAD:
1959 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1960 case SSL_CTRL_SET_READ_AHEAD:
1961 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1962 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1965 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1966 s->msg_callback_arg = parg;
1970 return (s->mode |= larg);
1971 case SSL_CTRL_CLEAR_MODE:
1972 return (s->mode &= ~larg);
1973 case SSL_CTRL_GET_MAX_CERT_LIST:
1974 return (long)(s->max_cert_list);
1975 case SSL_CTRL_SET_MAX_CERT_LIST:
1978 l = (long)s->max_cert_list;
1979 s->max_cert_list = (size_t)larg;
1981 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1982 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1984 s->max_send_fragment = larg;
1985 if (s->max_send_fragment < s->split_send_fragment)
1986 s->split_send_fragment = s->max_send_fragment;
1988 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1989 if ((size_t)larg > s->max_send_fragment || larg == 0)
1991 s->split_send_fragment = larg;
1993 case SSL_CTRL_SET_MAX_PIPELINES:
1994 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1996 s->max_pipelines = larg;
1998 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2000 case SSL_CTRL_GET_RI_SUPPORT:
2002 return s->s3->send_connection_binding;
2005 case SSL_CTRL_CERT_FLAGS:
2006 return (s->cert->cert_flags |= larg);
2007 case SSL_CTRL_CLEAR_CERT_FLAGS:
2008 return (s->cert->cert_flags &= ~larg);
2010 case SSL_CTRL_GET_RAW_CIPHERLIST:
2012 if (s->s3->tmp.ciphers_raw == NULL)
2014 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2015 return (int)s->s3->tmp.ciphers_rawlen;
2017 return TLS_CIPHER_LEN;
2019 case SSL_CTRL_GET_EXTMS_SUPPORT:
2020 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2022 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2026 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2027 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2028 &s->min_proto_version);
2029 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2030 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2031 &s->max_proto_version);
2033 return (s->method->ssl_ctrl(s, cmd, larg, parg));
2037 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2040 case SSL_CTRL_SET_MSG_CALLBACK:
2041 s->msg_callback = (void (*)
2042 (int write_p, int version, int content_type,
2043 const void *buf, size_t len, SSL *ssl,
2048 return (s->method->ssl_callback_ctrl(s, cmd, fp));
2052 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2054 return ctx->sessions;
2057 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2060 /* For some cases with ctx == NULL perform syntax checks */
2063 #ifndef OPENSSL_NO_EC
2064 case SSL_CTRL_SET_GROUPS_LIST:
2065 return tls1_set_groups_list(NULL, NULL, parg);
2067 case SSL_CTRL_SET_SIGALGS_LIST:
2068 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2069 return tls1_set_sigalgs_list(NULL, parg, 0);
2076 case SSL_CTRL_GET_READ_AHEAD:
2077 return (ctx->read_ahead);
2078 case SSL_CTRL_SET_READ_AHEAD:
2079 l = ctx->read_ahead;
2080 ctx->read_ahead = larg;
2083 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2084 ctx->msg_callback_arg = parg;
2087 case SSL_CTRL_GET_MAX_CERT_LIST:
2088 return (long)(ctx->max_cert_list);
2089 case SSL_CTRL_SET_MAX_CERT_LIST:
2092 l = (long)ctx->max_cert_list;
2093 ctx->max_cert_list = (size_t)larg;
2096 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2099 l = (long)ctx->session_cache_size;
2100 ctx->session_cache_size = (size_t)larg;
2102 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2103 return (long)(ctx->session_cache_size);
2104 case SSL_CTRL_SET_SESS_CACHE_MODE:
2105 l = ctx->session_cache_mode;
2106 ctx->session_cache_mode = larg;
2108 case SSL_CTRL_GET_SESS_CACHE_MODE:
2109 return (ctx->session_cache_mode);
2111 case SSL_CTRL_SESS_NUMBER:
2112 return (lh_SSL_SESSION_num_items(ctx->sessions));
2113 case SSL_CTRL_SESS_CONNECT:
2114 return (ctx->stats.sess_connect);
2115 case SSL_CTRL_SESS_CONNECT_GOOD:
2116 return (ctx->stats.sess_connect_good);
2117 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2118 return (ctx->stats.sess_connect_renegotiate);
2119 case SSL_CTRL_SESS_ACCEPT:
2120 return (ctx->stats.sess_accept);
2121 case SSL_CTRL_SESS_ACCEPT_GOOD:
2122 return (ctx->stats.sess_accept_good);
2123 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2124 return (ctx->stats.sess_accept_renegotiate);
2125 case SSL_CTRL_SESS_HIT:
2126 return (ctx->stats.sess_hit);
2127 case SSL_CTRL_SESS_CB_HIT:
2128 return (ctx->stats.sess_cb_hit);
2129 case SSL_CTRL_SESS_MISSES:
2130 return (ctx->stats.sess_miss);
2131 case SSL_CTRL_SESS_TIMEOUTS:
2132 return (ctx->stats.sess_timeout);
2133 case SSL_CTRL_SESS_CACHE_FULL:
2134 return (ctx->stats.sess_cache_full);
2136 return (ctx->mode |= larg);
2137 case SSL_CTRL_CLEAR_MODE:
2138 return (ctx->mode &= ~larg);
2139 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2140 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2142 ctx->max_send_fragment = larg;
2143 if (ctx->max_send_fragment < ctx->split_send_fragment)
2144 ctx->split_send_fragment = ctx->max_send_fragment;
2146 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2147 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2149 ctx->split_send_fragment = larg;
2151 case SSL_CTRL_SET_MAX_PIPELINES:
2152 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2154 ctx->max_pipelines = larg;
2156 case SSL_CTRL_CERT_FLAGS:
2157 return (ctx->cert->cert_flags |= larg);
2158 case SSL_CTRL_CLEAR_CERT_FLAGS:
2159 return (ctx->cert->cert_flags &= ~larg);
2160 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2161 return ssl_set_version_bound(ctx->method->version, (int)larg,
2162 &ctx->min_proto_version);
2163 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2164 return ssl_set_version_bound(ctx->method->version, (int)larg,
2165 &ctx->max_proto_version);
2167 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2171 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2174 case SSL_CTRL_SET_MSG_CALLBACK:
2175 ctx->msg_callback = (void (*)
2176 (int write_p, int version, int content_type,
2177 const void *buf, size_t len, SSL *ssl,
2182 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2186 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2195 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2196 const SSL_CIPHER *const *bp)
2198 if ((*ap)->id > (*bp)->id)
2200 if ((*ap)->id < (*bp)->id)
2205 /** return a STACK of the ciphers available for the SSL and in order of
2207 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2210 if (s->cipher_list != NULL) {
2211 return (s->cipher_list);
2212 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2213 return (s->ctx->cipher_list);
2219 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2221 if ((s == NULL) || (s->session == NULL) || !s->server)
2223 return s->session->ciphers;
2226 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2228 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2230 ciphers = SSL_get_ciphers(s);
2233 ssl_set_client_disabled(s);
2234 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2235 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2236 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2238 sk = sk_SSL_CIPHER_new_null();
2241 if (!sk_SSL_CIPHER_push(sk, c)) {
2242 sk_SSL_CIPHER_free(sk);
2250 /** return a STACK of the ciphers available for the SSL and in order of
2252 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2255 if (s->cipher_list_by_id != NULL) {
2256 return (s->cipher_list_by_id);
2257 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2258 return (s->ctx->cipher_list_by_id);
2264 /** The old interface to get the same thing as SSL_get_ciphers() */
2265 const char *SSL_get_cipher_list(const SSL *s, int n)
2267 const SSL_CIPHER *c;
2268 STACK_OF(SSL_CIPHER) *sk;
2272 sk = SSL_get_ciphers(s);
2273 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2275 c = sk_SSL_CIPHER_value(sk, n);
2281 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2283 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2286 return ctx->cipher_list;
2290 /** specify the ciphers to be used by default by the SSL_CTX */
2291 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2293 STACK_OF(SSL_CIPHER) *sk;
2295 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2296 &ctx->cipher_list_by_id, str, ctx->cert);
2298 * ssl_create_cipher_list may return an empty stack if it was unable to
2299 * find a cipher matching the given rule string (for example if the rule
2300 * string specifies a cipher which has been disabled). This is not an
2301 * error as far as ssl_create_cipher_list is concerned, and hence
2302 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2306 else if (sk_SSL_CIPHER_num(sk) == 0) {
2307 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2313 /** specify the ciphers to be used by the SSL */
2314 int SSL_set_cipher_list(SSL *s, const char *str)
2316 STACK_OF(SSL_CIPHER) *sk;
2318 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2319 &s->cipher_list_by_id, str, s->cert);
2320 /* see comment in SSL_CTX_set_cipher_list */
2323 else if (sk_SSL_CIPHER_num(sk) == 0) {
2324 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2330 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2333 STACK_OF(SSL_CIPHER) *sk;
2334 const SSL_CIPHER *c;
2337 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2341 sk = s->session->ciphers;
2343 if (sk_SSL_CIPHER_num(sk) == 0)
2346 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2349 c = sk_SSL_CIPHER_value(sk, i);
2350 n = strlen(c->name);
2357 memcpy(p, c->name, n + 1);
2366 /** return a servername extension value if provided in Client Hello, or NULL.
2367 * So far, only host_name types are defined (RFC 3546).
2370 const char *SSL_get_servername(const SSL *s, const int type)
2372 if (type != TLSEXT_NAMETYPE_host_name)
2375 return s->session && !s->ext.hostname ?
2376 s->session->ext.hostname : s->ext.hostname;
2379 int SSL_get_servername_type(const SSL *s)
2382 && (!s->ext.hostname ? s->session->
2383 ext.hostname : s->ext.hostname))
2384 return TLSEXT_NAMETYPE_host_name;
2389 * SSL_select_next_proto implements the standard protocol selection. It is
2390 * expected that this function is called from the callback set by
2391 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2392 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2393 * not included in the length. A byte string of length 0 is invalid. No byte
2394 * string may be truncated. The current, but experimental algorithm for
2395 * selecting the protocol is: 1) If the server doesn't support NPN then this
2396 * is indicated to the callback. In this case, the client application has to
2397 * abort the connection or have a default application level protocol. 2) If
2398 * the server supports NPN, but advertises an empty list then the client
2399 * selects the first protocol in its list, but indicates via the API that this
2400 * fallback case was enacted. 3) Otherwise, the client finds the first
2401 * protocol in the server's list that it supports and selects this protocol.
2402 * This is because it's assumed that the server has better information about
2403 * which protocol a client should use. 4) If the client doesn't support any
2404 * of the server's advertised protocols, then this is treated the same as
2405 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2406 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2408 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2409 const unsigned char *server,
2410 unsigned int server_len,
2411 const unsigned char *client, unsigned int client_len)
2414 const unsigned char *result;
2415 int status = OPENSSL_NPN_UNSUPPORTED;
2418 * For each protocol in server preference order, see if we support it.
2420 for (i = 0; i < server_len;) {
2421 for (j = 0; j < client_len;) {
2422 if (server[i] == client[j] &&
2423 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2424 /* We found a match */
2425 result = &server[i];
2426 status = OPENSSL_NPN_NEGOTIATED;
2436 /* There's no overlap between our protocols and the server's list. */
2438 status = OPENSSL_NPN_NO_OVERLAP;
2441 *out = (unsigned char *)result + 1;
2442 *outlen = result[0];
2446 #ifndef OPENSSL_NO_NEXTPROTONEG
2448 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2449 * client's requested protocol for this connection and returns 0. If the
2450 * client didn't request any protocol, then *data is set to NULL. Note that
2451 * the client can request any protocol it chooses. The value returned from
2452 * this function need not be a member of the list of supported protocols
2453 * provided by the callback.
2455 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2462 *len = (unsigned int)s->ext.npn_len;
2467 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2468 * a TLS server needs a list of supported protocols for Next Protocol
2469 * Negotiation. The returned list must be in wire format. The list is
2470 * returned by setting |out| to point to it and |outlen| to its length. This
2471 * memory will not be modified, but one should assume that the SSL* keeps a
2472 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2473 * wishes to advertise. Otherwise, no such extension will be included in the
2476 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2477 SSL_CTX_npn_advertised_cb_func cb,
2480 ctx->ext.npn_advertised_cb = cb;
2481 ctx->ext.npn_advertised_cb_arg = arg;
2485 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2486 * client needs to select a protocol from the server's provided list. |out|
2487 * must be set to point to the selected protocol (which may be within |in|).
2488 * The length of the protocol name must be written into |outlen|. The
2489 * server's advertised protocols are provided in |in| and |inlen|. The
2490 * callback can assume that |in| is syntactically valid. The client must
2491 * select a protocol. It is fatal to the connection if this callback returns
2492 * a value other than SSL_TLSEXT_ERR_OK.
2494 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2495 SSL_CTX_npn_select_cb_func cb,
2498 ctx->ext.npn_select_cb = cb;
2499 ctx->ext.npn_select_cb_arg = arg;
2504 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2505 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2506 * length-prefixed strings). Returns 0 on success.
2508 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2509 unsigned int protos_len)
2511 OPENSSL_free(ctx->ext.alpn);
2512 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2513 if (ctx->ext.alpn == NULL) {
2514 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2517 ctx->ext.alpn_len = protos_len;
2523 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2524 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2525 * length-prefixed strings). Returns 0 on success.
2527 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2528 unsigned int protos_len)
2530 OPENSSL_free(ssl->ext.alpn);
2531 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2532 if (ssl->ext.alpn == NULL) {
2533 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2536 ssl->ext.alpn_len = protos_len;
2542 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2543 * called during ClientHello processing in order to select an ALPN protocol
2544 * from the client's list of offered protocols.
2546 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2547 SSL_CTX_alpn_select_cb_func cb,
2550 ctx->ext.alpn_select_cb = cb;
2551 ctx->ext.alpn_select_cb_arg = arg;
2555 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2556 * On return it sets |*data| to point to |*len| bytes of protocol name
2557 * (not including the leading length-prefix byte). If the server didn't
2558 * respond with a negotiated protocol then |*len| will be zero.
2560 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2565 *data = ssl->s3->alpn_selected;
2569 *len = (unsigned int)ssl->s3->alpn_selected_len;
2572 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2573 const char *label, size_t llen,
2574 const unsigned char *p, size_t plen,
2577 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2580 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2585 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2587 const unsigned char *session_id = a->session_id;
2589 unsigned char tmp_storage[4];
2591 if (a->session_id_length < sizeof(tmp_storage)) {
2592 memset(tmp_storage, 0, sizeof(tmp_storage));
2593 memcpy(tmp_storage, a->session_id, a->session_id_length);
2594 session_id = tmp_storage;
2598 ((unsigned long)session_id[0]) |
2599 ((unsigned long)session_id[1] << 8L) |
2600 ((unsigned long)session_id[2] << 16L) |
2601 ((unsigned long)session_id[3] << 24L);
2606 * NB: If this function (or indeed the hash function which uses a sort of
2607 * coarser function than this one) is changed, ensure
2608 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2609 * being able to construct an SSL_SESSION that will collide with any existing
2610 * session with a matching session ID.
2612 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2614 if (a->ssl_version != b->ssl_version)
2616 if (a->session_id_length != b->session_id_length)
2618 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2622 * These wrapper functions should remain rather than redeclaring
2623 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2624 * variable. The reason is that the functions aren't static, they're exposed
2628 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2630 SSL_CTX *ret = NULL;
2633 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2637 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2640 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2641 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2644 ret = OPENSSL_zalloc(sizeof(*ret));
2649 ret->min_proto_version = 0;
2650 ret->max_proto_version = 0;
2651 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2652 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2653 /* We take the system default. */
2654 ret->session_timeout = meth->get_timeout();
2655 ret->references = 1;
2656 ret->lock = CRYPTO_THREAD_lock_new();
2657 if (ret->lock == NULL) {
2658 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2662 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2663 ret->verify_mode = SSL_VERIFY_NONE;
2664 if ((ret->cert = ssl_cert_new()) == NULL)
2667 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2668 if (ret->sessions == NULL)
2670 ret->cert_store = X509_STORE_new();
2671 if (ret->cert_store == NULL)
2673 #ifndef OPENSSL_NO_CT
2674 ret->ctlog_store = CTLOG_STORE_new();
2675 if (ret->ctlog_store == NULL)
2678 if (!ssl_create_cipher_list(ret->method,
2679 &ret->cipher_list, &ret->cipher_list_by_id,
2680 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2681 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2682 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2686 ret->param = X509_VERIFY_PARAM_new();
2687 if (ret->param == NULL)
2690 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2691 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2694 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2695 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2699 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2702 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2705 /* No compression for DTLS */
2706 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2707 ret->comp_methods = SSL_COMP_get_compression_methods();
2709 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2710 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2712 /* Setup RFC5077 ticket keys */
2713 if ((RAND_bytes(ret->ext.tick_key_name,
2714 sizeof(ret->ext.tick_key_name)) <= 0)
2715 || (RAND_bytes(ret->ext.tick_hmac_key,
2716 sizeof(ret->ext.tick_hmac_key)) <= 0)
2717 || (RAND_bytes(ret->ext.tick_aes_key,
2718 sizeof(ret->ext.tick_aes_key)) <= 0))
2719 ret->options |= SSL_OP_NO_TICKET;
2721 #ifndef OPENSSL_NO_SRP
2722 if (!SSL_CTX_SRP_CTX_init(ret))
2725 #ifndef OPENSSL_NO_ENGINE
2726 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2727 # define eng_strx(x) #x
2728 # define eng_str(x) eng_strx(x)
2729 /* Use specific client engine automatically... ignore errors */
2732 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2735 ENGINE_load_builtin_engines();
2736 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2738 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2744 * Default is to connect to non-RI servers. When RI is more widely
2745 * deployed might change this.
2747 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2749 * Disable compression by default to prevent CRIME. Applications can
2750 * re-enable compression by configuring
2751 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2752 * or by using the SSL_CONF library.
2754 ret->options |= SSL_OP_NO_COMPRESSION;
2756 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2759 * Default max early data is a fully loaded single record. Could be split
2760 * across multiple records in practice
2762 ret->max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
2766 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2772 int SSL_CTX_up_ref(SSL_CTX *ctx)
2776 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2779 REF_PRINT_COUNT("SSL_CTX", ctx);
2780 REF_ASSERT_ISNT(i < 2);
2781 return ((i > 1) ? 1 : 0);
2784 void SSL_CTX_free(SSL_CTX *a)
2791 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2792 REF_PRINT_COUNT("SSL_CTX", a);
2795 REF_ASSERT_ISNT(i < 0);
2797 X509_VERIFY_PARAM_free(a->param);
2798 dane_ctx_final(&a->dane);
2801 * Free internal session cache. However: the remove_cb() may reference
2802 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2803 * after the sessions were flushed.
2804 * As the ex_data handling routines might also touch the session cache,
2805 * the most secure solution seems to be: empty (flush) the cache, then
2806 * free ex_data, then finally free the cache.
2807 * (See ticket [openssl.org #212].)
2809 if (a->sessions != NULL)
2810 SSL_CTX_flush_sessions(a, 0);
2812 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2813 lh_SSL_SESSION_free(a->sessions);
2814 X509_STORE_free(a->cert_store);
2815 #ifndef OPENSSL_NO_CT
2816 CTLOG_STORE_free(a->ctlog_store);
2818 sk_SSL_CIPHER_free(a->cipher_list);
2819 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2820 ssl_cert_free(a->cert);
2821 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
2822 sk_X509_pop_free(a->extra_certs, X509_free);
2823 a->comp_methods = NULL;
2824 #ifndef OPENSSL_NO_SRTP
2825 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2827 #ifndef OPENSSL_NO_SRP
2828 SSL_CTX_SRP_CTX_free(a);
2830 #ifndef OPENSSL_NO_ENGINE
2831 ENGINE_finish(a->client_cert_engine);
2834 #ifndef OPENSSL_NO_EC
2835 OPENSSL_free(a->ext.ecpointformats);
2836 OPENSSL_free(a->ext.supportedgroups);
2838 OPENSSL_free(a->ext.alpn);
2840 CRYPTO_THREAD_lock_free(a->lock);
2845 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2847 ctx->default_passwd_callback = cb;
2850 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2852 ctx->default_passwd_callback_userdata = u;
2855 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2857 return ctx->default_passwd_callback;
2860 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2862 return ctx->default_passwd_callback_userdata;
2865 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2867 s->default_passwd_callback = cb;
2870 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2872 s->default_passwd_callback_userdata = u;
2875 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2877 return s->default_passwd_callback;
2880 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2882 return s->default_passwd_callback_userdata;
2885 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2886 int (*cb) (X509_STORE_CTX *, void *),
2889 ctx->app_verify_callback = cb;
2890 ctx->app_verify_arg = arg;
2893 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2894 int (*cb) (int, X509_STORE_CTX *))
2896 ctx->verify_mode = mode;
2897 ctx->default_verify_callback = cb;
2900 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2902 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2905 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2907 ssl_cert_set_cert_cb(c->cert, cb, arg);
2910 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2912 ssl_cert_set_cert_cb(s->cert, cb, arg);
2915 void ssl_set_masks(SSL *s)
2918 uint32_t *pvalid = s->s3->tmp.valid_flags;
2919 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2920 unsigned long mask_k, mask_a;
2921 #ifndef OPENSSL_NO_EC
2922 int have_ecc_cert, ecdsa_ok;
2927 #ifndef OPENSSL_NO_DH
2928 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2933 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2934 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2935 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
2936 #ifndef OPENSSL_NO_EC
2937 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2943 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2944 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2947 #ifndef OPENSSL_NO_GOST
2948 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2949 mask_k |= SSL_kGOST;
2950 mask_a |= SSL_aGOST12;
2952 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2953 mask_k |= SSL_kGOST;
2954 mask_a |= SSL_aGOST12;
2956 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2957 mask_k |= SSL_kGOST;
2958 mask_a |= SSL_aGOST01;
2968 if (rsa_enc || rsa_sign) {
2976 mask_a |= SSL_aNULL;
2979 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2980 * depending on the key usage extension.
2982 #ifndef OPENSSL_NO_EC
2983 if (have_ecc_cert) {
2985 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
2986 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2987 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2990 mask_a |= SSL_aECDSA;
2994 #ifndef OPENSSL_NO_EC
2995 mask_k |= SSL_kECDHE;
2998 #ifndef OPENSSL_NO_PSK
3001 if (mask_k & SSL_kRSA)
3002 mask_k |= SSL_kRSAPSK;
3003 if (mask_k & SSL_kDHE)
3004 mask_k |= SSL_kDHEPSK;
3005 if (mask_k & SSL_kECDHE)
3006 mask_k |= SSL_kECDHEPSK;
3009 s->s3->tmp.mask_k = mask_k;
3010 s->s3->tmp.mask_a = mask_a;
3013 #ifndef OPENSSL_NO_EC
3015 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3017 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3018 /* key usage, if present, must allow signing */
3019 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3020 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3021 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3025 return 1; /* all checks are ok */
3030 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3031 size_t *serverinfo_length)
3033 CERT_PKEY *cpk = s->s3->tmp.cert;
3034 *serverinfo_length = 0;
3036 if (cpk == NULL || cpk->serverinfo == NULL)
3039 *serverinfo = cpk->serverinfo;
3040 *serverinfo_length = cpk->serverinfo_length;
3044 void ssl_update_cache(SSL *s, int mode)
3049 * If the session_id_length is 0, we are not supposed to cache it, and it
3050 * would be rather hard to do anyway :-)
3052 if (s->session->session_id_length == 0)
3055 i = s->session_ctx->session_cache_mode;
3056 if ((i & mode) && (!s->hit)
3057 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
3058 || SSL_CTX_add_session(s->session_ctx, s->session))
3059 && (s->session_ctx->new_session_cb != NULL)) {
3060 SSL_SESSION_up_ref(s->session);
3061 if (!s->session_ctx->new_session_cb(s, s->session))
3062 SSL_SESSION_free(s->session);
3065 /* auto flush every 255 connections */
3066 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3067 if ((((mode & SSL_SESS_CACHE_CLIENT)
3068 ? s->session_ctx->stats.sess_connect_good
3069 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
3070 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3075 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3080 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3085 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3089 if (s->method != meth) {
3090 const SSL_METHOD *sm = s->method;
3091 int (*hf) (SSL *) = s->handshake_func;
3093 if (sm->version == meth->version)
3098 ret = s->method->ssl_new(s);
3101 if (hf == sm->ssl_connect)
3102 s->handshake_func = meth->ssl_connect;
3103 else if (hf == sm->ssl_accept)
3104 s->handshake_func = meth->ssl_accept;
3109 int SSL_get_error(const SSL *s, int i)
3116 return (SSL_ERROR_NONE);
3119 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3120 * where we do encode the error
3122 if ((l = ERR_peek_error()) != 0) {
3123 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3124 return (SSL_ERROR_SYSCALL);
3126 return (SSL_ERROR_SSL);
3129 if (SSL_want_read(s)) {
3130 bio = SSL_get_rbio(s);
3131 if (BIO_should_read(bio))
3132 return (SSL_ERROR_WANT_READ);
3133 else if (BIO_should_write(bio))
3135 * This one doesn't make too much sense ... We never try to write
3136 * to the rbio, and an application program where rbio and wbio
3137 * are separate couldn't even know what it should wait for.
3138 * However if we ever set s->rwstate incorrectly (so that we have
3139 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3140 * wbio *are* the same, this test works around that bug; so it
3141 * might be safer to keep it.
3143 return (SSL_ERROR_WANT_WRITE);
3144 else if (BIO_should_io_special(bio)) {
3145 reason = BIO_get_retry_reason(bio);
3146 if (reason == BIO_RR_CONNECT)
3147 return (SSL_ERROR_WANT_CONNECT);
3148 else if (reason == BIO_RR_ACCEPT)
3149 return (SSL_ERROR_WANT_ACCEPT);
3151 return (SSL_ERROR_SYSCALL); /* unknown */
3155 if (SSL_want_write(s)) {
3156 /* Access wbio directly - in order to use the buffered bio if present */
3158 if (BIO_should_write(bio))
3159 return (SSL_ERROR_WANT_WRITE);
3160 else if (BIO_should_read(bio))
3162 * See above (SSL_want_read(s) with BIO_should_write(bio))
3164 return (SSL_ERROR_WANT_READ);
3165 else if (BIO_should_io_special(bio)) {
3166 reason = BIO_get_retry_reason(bio);
3167 if (reason == BIO_RR_CONNECT)
3168 return (SSL_ERROR_WANT_CONNECT);
3169 else if (reason == BIO_RR_ACCEPT)
3170 return (SSL_ERROR_WANT_ACCEPT);
3172 return (SSL_ERROR_SYSCALL);
3175 if (SSL_want_x509_lookup(s))
3176 return (SSL_ERROR_WANT_X509_LOOKUP);
3177 if (SSL_want_async(s))
3178 return SSL_ERROR_WANT_ASYNC;
3179 if (SSL_want_async_job(s))
3180 return SSL_ERROR_WANT_ASYNC_JOB;
3181 if (SSL_want_early(s))
3182 return SSL_ERROR_WANT_EARLY;
3184 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3185 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3186 return (SSL_ERROR_ZERO_RETURN);
3188 return (SSL_ERROR_SYSCALL);
3191 static int ssl_do_handshake_intern(void *vargs)
3193 struct ssl_async_args *args;
3196 args = (struct ssl_async_args *)vargs;
3199 return s->handshake_func(s);
3202 int SSL_do_handshake(SSL *s)
3206 if (s->handshake_func == NULL) {
3207 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3211 ossl_statem_check_finish_init(s, -1);
3213 s->method->ssl_renegotiate_check(s, 0);
3215 if (SSL_in_init(s) || SSL_in_before(s)) {
3216 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3217 struct ssl_async_args args;
3221 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3223 ret = s->handshake_func(s);
3229 void SSL_set_accept_state(SSL *s)
3233 ossl_statem_clear(s);
3234 s->handshake_func = s->method->ssl_accept;
3238 void SSL_set_connect_state(SSL *s)
3242 ossl_statem_clear(s);
3243 s->handshake_func = s->method->ssl_connect;
3247 int ssl_undefined_function(SSL *s)
3249 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3253 int ssl_undefined_void_function(void)
3255 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3256 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3260 int ssl_undefined_const_function(const SSL *s)
3265 const SSL_METHOD *ssl_bad_method(int ver)
3267 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3271 const char *ssl_protocol_to_string(int version)
3275 case TLS1_3_VERSION:
3278 case TLS1_2_VERSION:
3281 case TLS1_1_VERSION:
3296 case DTLS1_2_VERSION:
3304 const char *SSL_get_version(const SSL *s)
3306 return ssl_protocol_to_string(s->version);
3309 SSL *SSL_dup(SSL *s)
3311 STACK_OF(X509_NAME) *sk;
3316 /* If we're not quiescent, just up_ref! */
3317 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3318 CRYPTO_UP_REF(&s->references, &i, s->lock);
3323 * Otherwise, copy configuration state, and session if set.
3325 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3328 if (s->session != NULL) {
3330 * Arranges to share the same session via up_ref. This "copies"
3331 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3333 if (!SSL_copy_session_id(ret, s))
3337 * No session has been established yet, so we have to expect that
3338 * s->cert or ret->cert will be changed later -- they should not both
3339 * point to the same object, and thus we can't use
3340 * SSL_copy_session_id.
3342 if (!SSL_set_ssl_method(ret, s->method))
3345 if (s->cert != NULL) {
3346 ssl_cert_free(ret->cert);
3347 ret->cert = ssl_cert_dup(s->cert);
3348 if (ret->cert == NULL)
3352 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3353 (int)s->sid_ctx_length))
3357 if (!ssl_dane_dup(ret, s))
3359 ret->version = s->version;
3360 ret->options = s->options;
3361 ret->mode = s->mode;
3362 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3363 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3364 ret->msg_callback = s->msg_callback;
3365 ret->msg_callback_arg = s->msg_callback_arg;
3366 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3367 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3368 ret->generate_session_id = s->generate_session_id;
3370 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3372 /* copy app data, a little dangerous perhaps */
3373 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3376 /* setup rbio, and wbio */
3377 if (s->rbio != NULL) {
3378 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3381 if (s->wbio != NULL) {
3382 if (s->wbio != s->rbio) {
3383 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3386 BIO_up_ref(ret->rbio);
3387 ret->wbio = ret->rbio;
3391 ret->server = s->server;
3392 if (s->handshake_func) {
3394 SSL_set_accept_state(ret);
3396 SSL_set_connect_state(ret);
3398 ret->shutdown = s->shutdown;
3401 ret->default_passwd_callback = s->default_passwd_callback;
3402 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3404 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3406 /* dup the cipher_list and cipher_list_by_id stacks */
3407 if (s->cipher_list != NULL) {
3408 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3411 if (s->cipher_list_by_id != NULL)
3412 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3416 /* Dup the client_CA list */
3417 if (s->ca_names != NULL) {
3418 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3421 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3422 xn = sk_X509_NAME_value(sk, i);
3423 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3436 void ssl_clear_cipher_ctx(SSL *s)
3438 if (s->enc_read_ctx != NULL) {
3439 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3440 s->enc_read_ctx = NULL;
3442 if (s->enc_write_ctx != NULL) {
3443 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3444 s->enc_write_ctx = NULL;
3446 #ifndef OPENSSL_NO_COMP
3447 COMP_CTX_free(s->expand);
3449 COMP_CTX_free(s->compress);
3454 X509 *SSL_get_certificate(const SSL *s)
3456 if (s->cert != NULL)
3457 return (s->cert->key->x509);
3462 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3464 if (s->cert != NULL)
3465 return (s->cert->key->privatekey);
3470 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3472 if (ctx->cert != NULL)
3473 return ctx->cert->key->x509;
3478 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3480 if (ctx->cert != NULL)
3481 return ctx->cert->key->privatekey;
3486 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3488 if ((s->session != NULL) && (s->session->cipher != NULL))
3489 return (s->session->cipher);
3493 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3495 #ifndef OPENSSL_NO_COMP
3496 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3502 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3504 #ifndef OPENSSL_NO_COMP
3505 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3511 int ssl_init_wbio_buffer(SSL *s)
3515 if (s->bbio != NULL) {
3516 /* Already buffered. */
3520 bbio = BIO_new(BIO_f_buffer());
3521 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3523 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3527 s->wbio = BIO_push(bbio, s->wbio);
3532 void ssl_free_wbio_buffer(SSL *s)
3534 /* callers ensure s is never null */
3535 if (s->bbio == NULL)
3538 s->wbio = BIO_pop(s->wbio);
3539 assert(s->wbio != NULL);
3544 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3546 ctx->quiet_shutdown = mode;
3549 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3551 return (ctx->quiet_shutdown);
3554 void SSL_set_quiet_shutdown(SSL *s, int mode)
3556 s->quiet_shutdown = mode;
3559 int SSL_get_quiet_shutdown(const SSL *s)
3561 return (s->quiet_shutdown);
3564 void SSL_set_shutdown(SSL *s, int mode)
3569 int SSL_get_shutdown(const SSL *s)
3574 int SSL_version(const SSL *s)
3579 int SSL_client_version(const SSL *s)
3581 return s->client_version;
3584 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3589 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3592 if (ssl->ctx == ctx)
3595 ctx = ssl->session_ctx;
3596 new_cert = ssl_cert_dup(ctx->cert);
3597 if (new_cert == NULL) {
3601 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3602 ssl_cert_free(new_cert);
3606 ssl_cert_free(ssl->cert);
3607 ssl->cert = new_cert;
3610 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3611 * so setter APIs must prevent invalid lengths from entering the system.
3613 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3617 * If the session ID context matches that of the parent SSL_CTX,
3618 * inherit it from the new SSL_CTX as well. If however the context does
3619 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3620 * leave it unchanged.
3622 if ((ssl->ctx != NULL) &&
3623 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3624 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3625 ssl->sid_ctx_length = ctx->sid_ctx_length;
3626 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3629 SSL_CTX_up_ref(ctx);
3630 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3636 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3638 return (X509_STORE_set_default_paths(ctx->cert_store));
3641 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3643 X509_LOOKUP *lookup;
3645 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3648 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3650 /* Clear any errors if the default directory does not exist */
3656 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3658 X509_LOOKUP *lookup;
3660 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3664 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3666 /* Clear any errors if the default file does not exist */
3672 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3675 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3678 void SSL_set_info_callback(SSL *ssl,
3679 void (*cb) (const SSL *ssl, int type, int val))
3681 ssl->info_callback = cb;
3685 * One compiler (Diab DCC) doesn't like argument names in returned function
3688 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3691 return ssl->info_callback;
3694 void SSL_set_verify_result(SSL *ssl, long arg)
3696 ssl->verify_result = arg;
3699 long SSL_get_verify_result(const SSL *ssl)
3701 return (ssl->verify_result);
3704 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3707 return sizeof(ssl->s3->client_random);
3708 if (outlen > sizeof(ssl->s3->client_random))
3709 outlen = sizeof(ssl->s3->client_random);
3710 memcpy(out, ssl->s3->client_random, outlen);
3714 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3717 return sizeof(ssl->s3->server_random);
3718 if (outlen > sizeof(ssl->s3->server_random))
3719 outlen = sizeof(ssl->s3->server_random);
3720 memcpy(out, ssl->s3->server_random, outlen);
3724 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3725 unsigned char *out, size_t outlen)
3728 return session->master_key_length;
3729 if (outlen > session->master_key_length)
3730 outlen = session->master_key_length;
3731 memcpy(out, session->master_key, outlen);
3735 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3737 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3740 void *SSL_get_ex_data(const SSL *s, int idx)
3742 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3745 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3747 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3750 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3752 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3755 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3757 return (ctx->cert_store);
3760 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3762 X509_STORE_free(ctx->cert_store);
3763 ctx->cert_store = store;
3766 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3769 X509_STORE_up_ref(store);
3770 SSL_CTX_set_cert_store(ctx, store);
3773 int SSL_want(const SSL *s)
3775 return (s->rwstate);
3779 * \brief Set the callback for generating temporary DH keys.
3780 * \param ctx the SSL context.
3781 * \param dh the callback
3784 #ifndef OPENSSL_NO_DH
3785 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3786 DH *(*dh) (SSL *ssl, int is_export,
3789 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3792 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3795 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3799 #ifndef OPENSSL_NO_PSK
3800 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3802 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3803 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3806 OPENSSL_free(ctx->cert->psk_identity_hint);
3807 if (identity_hint != NULL) {
3808 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3809 if (ctx->cert->psk_identity_hint == NULL)
3812 ctx->cert->psk_identity_hint = NULL;
3816 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3821 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3822 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3825 OPENSSL_free(s->cert->psk_identity_hint);
3826 if (identity_hint != NULL) {
3827 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3828 if (s->cert->psk_identity_hint == NULL)
3831 s->cert->psk_identity_hint = NULL;
3835 const char *SSL_get_psk_identity_hint(const SSL *s)
3837 if (s == NULL || s->session == NULL)
3839 return (s->session->psk_identity_hint);
3842 const char *SSL_get_psk_identity(const SSL *s)
3844 if (s == NULL || s->session == NULL)
3846 return (s->session->psk_identity);
3849 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3851 s->psk_client_callback = cb;
3854 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3856 ctx->psk_client_callback = cb;
3859 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3861 s->psk_server_callback = cb;
3864 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3866 ctx->psk_server_callback = cb;
3870 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3871 void (*cb) (int write_p, int version,
3872 int content_type, const void *buf,
3873 size_t len, SSL *ssl, void *arg))
3875 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3878 void SSL_set_msg_callback(SSL *ssl,
3879 void (*cb) (int write_p, int version,
3880 int content_type, const void *buf,
3881 size_t len, SSL *ssl, void *arg))
3883 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3886 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3887 int (*cb) (SSL *ssl,
3891 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3892 (void (*)(void))cb);
3895 void SSL_set_not_resumable_session_callback(SSL *ssl,
3896 int (*cb) (SSL *ssl,
3897 int is_forward_secure))
3899 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3900 (void (*)(void))cb);
3903 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
3904 size_t (*cb) (SSL *ssl, int type,
3905 size_t len, void *arg))
3907 ctx->record_padding_cb = cb;
3910 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
3912 ctx->record_padding_arg = arg;
3915 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
3917 return ctx->record_padding_arg;
3920 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
3922 /* block size of 0 or 1 is basically no padding */
3923 if (block_size == 1)
3924 ctx->block_padding = 0;
3925 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
3926 ctx->block_padding = block_size;
3932 void SSL_set_record_padding_callback(SSL *ssl,
3933 size_t (*cb) (SSL *ssl, int type,
3934 size_t len, void *arg))
3936 ssl->record_padding_cb = cb;
3939 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
3941 ssl->record_padding_arg = arg;
3944 void *SSL_get_record_padding_callback_arg(SSL *ssl)
3946 return ssl->record_padding_arg;
3949 int SSL_set_block_padding(SSL *ssl, size_t block_size)
3951 /* block size of 0 or 1 is basically no padding */
3952 if (block_size == 1)
3953 ssl->block_padding = 0;
3954 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
3955 ssl->block_padding = block_size;
3962 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3963 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3964 * If EVP_MD pointer is passed, initializes ctx with this |md|.
3965 * Returns the newly allocated ctx;
3968 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3970 ssl_clear_hash_ctx(hash);
3971 *hash = EVP_MD_CTX_new();
3972 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3973 EVP_MD_CTX_free(*hash);
3980 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3983 EVP_MD_CTX_free(*hash);
3987 /* Retrieve handshake hashes */
3988 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3991 EVP_MD_CTX *ctx = NULL;
3992 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3993 int hashleni = EVP_MD_CTX_size(hdgst);
3996 if (hashleni < 0 || (size_t)hashleni > outlen)
3999 ctx = EVP_MD_CTX_new();
4003 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4004 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
4007 *hashlen = hashleni;
4011 EVP_MD_CTX_free(ctx);
4015 int SSL_session_reused(SSL *s)
4020 int SSL_is_server(const SSL *s)
4025 #if OPENSSL_API_COMPAT < 0x10100000L
4026 void SSL_set_debug(SSL *s, int debug)
4028 /* Old function was do-nothing anyway... */
4034 void SSL_set_security_level(SSL *s, int level)
4036 s->cert->sec_level = level;
4039 int SSL_get_security_level(const SSL *s)
4041 return s->cert->sec_level;
4044 void SSL_set_security_callback(SSL *s,
4045 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4046 int op, int bits, int nid,
4047 void *other, void *ex))
4049 s->cert->sec_cb = cb;
4052 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4053 const SSL_CTX *ctx, int op,
4054 int bits, int nid, void *other,
4056 return s->cert->sec_cb;
4059 void SSL_set0_security_ex_data(SSL *s, void *ex)
4061 s->cert->sec_ex = ex;
4064 void *SSL_get0_security_ex_data(const SSL *s)
4066 return s->cert->sec_ex;
4069 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4071 ctx->cert->sec_level = level;
4074 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4076 return ctx->cert->sec_level;
4079 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4080 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4081 int op, int bits, int nid,
4082 void *other, void *ex))
4084 ctx->cert->sec_cb = cb;
4087 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4093 return ctx->cert->sec_cb;
4096 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4098 ctx->cert->sec_ex = ex;
4101 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4103 return ctx->cert->sec_ex;
4107 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4108 * can return unsigned long, instead of the generic long return value from the
4109 * control interface.
4111 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4113 return ctx->options;
4116 unsigned long SSL_get_options(const SSL *s)
4121 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4123 return ctx->options |= op;
4126 unsigned long SSL_set_options(SSL *s, unsigned long op)
4128 return s->options |= op;
4131 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4133 return ctx->options &= ~op;
4136 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4138 return s->options &= ~op;
4141 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4143 return s->verified_chain;
4146 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4148 #ifndef OPENSSL_NO_CT
4151 * Moves SCTs from the |src| stack to the |dst| stack.
4152 * The source of each SCT will be set to |origin|.
4153 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4155 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4157 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4158 sct_source_t origin)
4164 *dst = sk_SCT_new_null();
4166 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4171 while ((sct = sk_SCT_pop(src)) != NULL) {
4172 if (SCT_set_source(sct, origin) != 1)
4175 if (sk_SCT_push(*dst, sct) <= 0)
4183 sk_SCT_push(src, sct); /* Put the SCT back */
4188 * Look for data collected during ServerHello and parse if found.
4189 * Returns the number of SCTs extracted.
4191 static int ct_extract_tls_extension_scts(SSL *s)
4193 int scts_extracted = 0;
4195 if (s->ext.scts != NULL) {
4196 const unsigned char *p = s->ext.scts;
4197 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4199 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4201 SCT_LIST_free(scts);
4204 return scts_extracted;
4208 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4209 * contains an SCT X509 extension. They will be stored in |s->scts|.
4211 * - The number of SCTs extracted, assuming an OCSP response exists.
4212 * - 0 if no OCSP response exists or it contains no SCTs.
4213 * - A negative integer if an error occurs.
4215 static int ct_extract_ocsp_response_scts(SSL *s)
4217 # ifndef OPENSSL_NO_OCSP
4218 int scts_extracted = 0;
4219 const unsigned char *p;
4220 OCSP_BASICRESP *br = NULL;
4221 OCSP_RESPONSE *rsp = NULL;
4222 STACK_OF(SCT) *scts = NULL;
4225 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4228 p = s->ext.ocsp.resp;
4229 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4233 br = OCSP_response_get1_basic(rsp);
4237 for (i = 0; i < OCSP_resp_count(br); ++i) {
4238 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4244 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4246 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4247 if (scts_extracted < 0)
4251 SCT_LIST_free(scts);
4252 OCSP_BASICRESP_free(br);
4253 OCSP_RESPONSE_free(rsp);
4254 return scts_extracted;
4256 /* Behave as if no OCSP response exists */
4262 * Attempts to extract SCTs from the peer certificate.
4263 * Return the number of SCTs extracted, or a negative integer if an error
4266 static int ct_extract_x509v3_extension_scts(SSL *s)
4268 int scts_extracted = 0;
4269 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4272 STACK_OF(SCT) *scts =
4273 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4276 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4278 SCT_LIST_free(scts);
4281 return scts_extracted;
4285 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4286 * response (if it exists) and X509v3 extensions in the certificate.
4287 * Returns NULL if an error occurs.
4289 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4291 if (!s->scts_parsed) {
4292 if (ct_extract_tls_extension_scts(s) < 0 ||
4293 ct_extract_ocsp_response_scts(s) < 0 ||
4294 ct_extract_x509v3_extension_scts(s) < 0)
4304 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4305 const STACK_OF(SCT) *scts, void *unused_arg)
4310 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4311 const STACK_OF(SCT) *scts, void *unused_arg)
4313 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4316 for (i = 0; i < count; ++i) {
4317 SCT *sct = sk_SCT_value(scts, i);
4318 int status = SCT_get_validation_status(sct);
4320 if (status == SCT_VALIDATION_STATUS_VALID)
4323 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4327 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4331 * Since code exists that uses the custom extension handler for CT, look
4332 * for this and throw an error if they have already registered to use CT.
4334 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4335 TLSEXT_TYPE_signed_certificate_timestamp))
4337 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4338 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4342 if (callback != NULL) {
4344 * If we are validating CT, then we MUST accept SCTs served via OCSP
4346 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4350 s->ct_validation_callback = callback;
4351 s->ct_validation_callback_arg = arg;
4356 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4357 ssl_ct_validation_cb callback, void *arg)
4360 * Since code exists that uses the custom extension handler for CT, look for
4361 * this and throw an error if they have already registered to use CT.
4363 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4364 TLSEXT_TYPE_signed_certificate_timestamp))
4366 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4367 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4371 ctx->ct_validation_callback = callback;
4372 ctx->ct_validation_callback_arg = arg;
4376 int SSL_ct_is_enabled(const SSL *s)
4378 return s->ct_validation_callback != NULL;
4381 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4383 return ctx->ct_validation_callback != NULL;
4386 int ssl_validate_ct(SSL *s)
4389 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4391 SSL_DANE *dane = &s->dane;
4392 CT_POLICY_EVAL_CTX *ctx = NULL;
4393 const STACK_OF(SCT) *scts;
4396 * If no callback is set, the peer is anonymous, or its chain is invalid,
4397 * skip SCT validation - just return success. Applications that continue
4398 * handshakes without certificates, with unverified chains, or pinned leaf
4399 * certificates are outside the scope of the WebPKI and CT.
4401 * The above exclusions notwithstanding the vast majority of peers will
4402 * have rather ordinary certificate chains validated by typical
4403 * applications that perform certificate verification and therefore will
4404 * process SCTs when enabled.
4406 if (s->ct_validation_callback == NULL || cert == NULL ||
4407 s->verify_result != X509_V_OK ||
4408 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4412 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4413 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4415 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4416 switch (dane->mtlsa->usage) {
4417 case DANETLS_USAGE_DANE_TA:
4418 case DANETLS_USAGE_DANE_EE:
4423 ctx = CT_POLICY_EVAL_CTX_new();
4425 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4429 issuer = sk_X509_value(s->verified_chain, 1);
4430 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4431 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4432 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4433 CT_POLICY_EVAL_CTX_set_time(
4434 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4436 scts = SSL_get0_peer_scts(s);
4439 * This function returns success (> 0) only when all the SCTs are valid, 0
4440 * when some are invalid, and < 0 on various internal errors (out of
4441 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4442 * reason to abort the handshake, that decision is up to the callback.
4443 * Therefore, we error out only in the unexpected case that the return
4444 * value is negative.
4446 * XXX: One might well argue that the return value of this function is an
4447 * unfortunate design choice. Its job is only to determine the validation
4448 * status of each of the provided SCTs. So long as it correctly separates
4449 * the wheat from the chaff it should return success. Failure in this case
4450 * ought to correspond to an inability to carry out its duties.
4452 if (SCT_LIST_validate(scts, ctx) < 0) {
4453 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4457 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4459 ret = 0; /* This function returns 0 on failure */
4462 CT_POLICY_EVAL_CTX_free(ctx);
4464 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4465 * failure return code here. Also the application may wish the complete
4466 * the handshake, and then disconnect cleanly at a higher layer, after
4467 * checking the verification status of the completed connection.
4469 * We therefore force a certificate verification failure which will be
4470 * visible via SSL_get_verify_result() and cached as part of any resumed
4473 * Note: the permissive callback is for information gathering only, always
4474 * returns success, and does not affect verification status. Only the
4475 * strict callback or a custom application-specified callback can trigger
4476 * connection failure or record a verification error.
4479 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4483 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4485 switch (validation_mode) {
4487 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4489 case SSL_CT_VALIDATION_PERMISSIVE:
4490 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4491 case SSL_CT_VALIDATION_STRICT:
4492 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4496 int SSL_enable_ct(SSL *s, int validation_mode)
4498 switch (validation_mode) {
4500 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4502 case SSL_CT_VALIDATION_PERMISSIVE:
4503 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4504 case SSL_CT_VALIDATION_STRICT:
4505 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4509 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4511 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4514 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4516 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4519 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4521 CTLOG_STORE_free(ctx->ctlog_store);
4522 ctx->ctlog_store = logs;
4525 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4527 return ctx->ctlog_store;
4530 #endif /* OPENSSL_NO_CT */
4532 void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn cb, void *arg)
4535 c->early_cb_arg = arg;
4538 int SSL_early_isv2(SSL *s)
4540 if (s->clienthello == NULL)
4542 return s->clienthello->isv2;
4545 unsigned int SSL_early_get0_legacy_version(SSL *s)
4547 if (s->clienthello == NULL)
4549 return s->clienthello->legacy_version;
4552 size_t SSL_early_get0_random(SSL *s, const unsigned char **out)
4554 if (s->clienthello == NULL)
4557 *out = s->clienthello->random;
4558 return SSL3_RANDOM_SIZE;
4561 size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out)
4563 if (s->clienthello == NULL)
4566 *out = s->clienthello->session_id;
4567 return s->clienthello->session_id_len;
4570 size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out)
4572 if (s->clienthello == NULL)
4575 *out = PACKET_data(&s->clienthello->ciphersuites);
4576 return PACKET_remaining(&s->clienthello->ciphersuites);
4579 size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out)
4581 if (s->clienthello == NULL)
4584 *out = s->clienthello->compressions;
4585 return s->clienthello->compressions_len;
4588 int SSL_early_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4594 if (s->clienthello == NULL)
4596 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4597 r = s->clienthello->pre_proc_exts + i;
4598 if (r->present && r->type == type) {
4600 *out = PACKET_data(&r->data);
4602 *outlen = PACKET_remaining(&r->data);
4609 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4611 ctx->keylog_callback = cb;
4614 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4616 return ctx->keylog_callback;
4619 static int nss_keylog_int(const char *prefix,
4621 const uint8_t *parameter_1,
4622 size_t parameter_1_len,
4623 const uint8_t *parameter_2,
4624 size_t parameter_2_len)
4627 char *cursor = NULL;
4632 if (ssl->ctx->keylog_callback == NULL) return 1;
4635 * Our output buffer will contain the following strings, rendered with
4636 * space characters in between, terminated by a NULL character: first the
4637 * prefix, then the first parameter, then the second parameter. The
4638 * meaning of each parameter depends on the specific key material being
4639 * logged. Note that the first and second parameters are encoded in
4640 * hexadecimal, so we need a buffer that is twice their lengths.
4642 prefix_len = strlen(prefix);
4643 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4644 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4645 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4649 strcpy(cursor, prefix);
4650 cursor += prefix_len;
4653 for (i = 0; i < parameter_1_len; i++) {
4654 sprintf(cursor, "%02x", parameter_1[i]);
4659 for (i = 0; i < parameter_2_len; i++) {
4660 sprintf(cursor, "%02x", parameter_2[i]);
4665 ssl->ctx->keylog_callback(ssl, (const char *)out);
4671 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4672 const uint8_t *encrypted_premaster,
4673 size_t encrypted_premaster_len,
4674 const uint8_t *premaster,
4675 size_t premaster_len)
4677 if (encrypted_premaster_len < 8) {
4678 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4682 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4683 return nss_keylog_int("RSA",
4685 encrypted_premaster,
4691 int ssl_log_secret(SSL *ssl,
4693 const uint8_t *secret,
4696 return nss_keylog_int(label,
4698 ssl->s3->client_random,
4704 #define SSLV2_CIPHER_LEN 3
4706 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format,
4711 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4713 if (PACKET_remaining(cipher_suites) == 0) {
4714 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST, SSL_R_NO_CIPHERS_SPECIFIED);
4715 *al = SSL_AD_ILLEGAL_PARAMETER;
4719 if (PACKET_remaining(cipher_suites) % n != 0) {
4720 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST,
4721 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4722 *al = SSL_AD_DECODE_ERROR;
4726 OPENSSL_free(s->s3->tmp.ciphers_raw);
4727 s->s3->tmp.ciphers_raw = NULL;
4728 s->s3->tmp.ciphers_rawlen = 0;
4731 size_t numciphers = PACKET_remaining(cipher_suites) / n;
4732 PACKET sslv2ciphers = *cipher_suites;
4733 unsigned int leadbyte;
4737 * We store the raw ciphers list in SSLv3+ format so we need to do some
4738 * preprocessing to convert the list first. If there are any SSLv2 only
4739 * ciphersuites with a non-zero leading byte then we are going to
4740 * slightly over allocate because we won't store those. But that isn't a
4743 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
4744 s->s3->tmp.ciphers_raw = raw;
4746 *al = SSL_AD_INTERNAL_ERROR;
4749 for (s->s3->tmp.ciphers_rawlen = 0;
4750 PACKET_remaining(&sslv2ciphers) > 0;
4751 raw += TLS_CIPHER_LEN) {
4752 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
4754 && !PACKET_copy_bytes(&sslv2ciphers, raw,
4757 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
4758 *al = SSL_AD_DECODE_ERROR;
4759 OPENSSL_free(s->s3->tmp.ciphers_raw);
4760 s->s3->tmp.ciphers_raw = NULL;
4761 s->s3->tmp.ciphers_rawlen = 0;
4765 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
4767 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
4768 &s->s3->tmp.ciphers_rawlen)) {
4769 *al = SSL_AD_INTERNAL_ERROR;
4777 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
4778 int isv2format, STACK_OF(SSL_CIPHER) **sk,
4779 STACK_OF(SSL_CIPHER) **scsvs)
4784 if (!PACKET_buf_init(&pkt, bytes, len))
4786 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, &alert);
4789 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
4790 STACK_OF(SSL_CIPHER) **skp,
4791 STACK_OF(SSL_CIPHER) **scsvs_out,
4792 int sslv2format, int *al)
4794 const SSL_CIPHER *c;
4795 STACK_OF(SSL_CIPHER) *sk = NULL;
4796 STACK_OF(SSL_CIPHER) *scsvs = NULL;
4798 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
4799 unsigned char cipher[SSLV2_CIPHER_LEN];
4801 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4803 if (PACKET_remaining(cipher_suites) == 0) {
4804 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
4805 *al = SSL_AD_ILLEGAL_PARAMETER;
4809 if (PACKET_remaining(cipher_suites) % n != 0) {
4810 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
4811 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4812 *al = SSL_AD_DECODE_ERROR;
4816 sk = sk_SSL_CIPHER_new_null();
4817 scsvs = sk_SSL_CIPHER_new_null();
4818 if (sk == NULL || scsvs == NULL) {
4819 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4820 *al = SSL_AD_INTERNAL_ERROR;
4824 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
4826 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
4827 * first byte set to zero, while true SSLv2 ciphers have a non-zero
4828 * first byte. We don't support any true SSLv2 ciphers, so skip them.
4830 if (sslv2format && cipher[0] != '\0')
4833 /* For SSLv2-compat, ignore leading 0-byte. */
4834 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
4836 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
4837 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
4838 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4839 *al = SSL_AD_INTERNAL_ERROR;
4844 if (PACKET_remaining(cipher_suites) > 0) {
4845 *al = SSL_AD_DECODE_ERROR;
4846 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
4853 sk_SSL_CIPHER_free(sk);
4854 if (scsvs_out != NULL)
4857 sk_SSL_CIPHER_free(scsvs);
4860 sk_SSL_CIPHER_free(sk);
4861 sk_SSL_CIPHER_free(scsvs);
4865 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
4867 ctx->max_early_data = max_early_data;
4872 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
4874 return ctx->max_early_data;
4877 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
4879 s->max_early_data = max_early_data;
4884 uint32_t SSL_get_max_early_data(const SSL *s)
4886 return s->max_early_data;