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 OPENSSL_assert(s->sid_ctx_length <= sizeof s->sid_ctx);
579 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
580 s->verify_callback = ctx->default_verify_callback;
581 s->generate_session_id = ctx->generate_session_id;
583 s->param = X509_VERIFY_PARAM_new();
584 if (s->param == NULL)
586 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
587 s->quiet_shutdown = ctx->quiet_shutdown;
588 s->max_send_fragment = ctx->max_send_fragment;
589 s->split_send_fragment = ctx->split_send_fragment;
590 s->max_pipelines = ctx->max_pipelines;
591 if (s->max_pipelines > 1)
592 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
593 if (ctx->default_read_buf_len > 0)
594 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
599 s->ext.debug_arg = NULL;
600 s->ext.ticket_expected = 0;
601 s->ext.status_type = ctx->ext.status_type;
602 s->ext.status_expected = 0;
603 s->ext.ocsp.ids = NULL;
604 s->ext.ocsp.exts = NULL;
605 s->ext.ocsp.resp = NULL;
606 s->ext.ocsp.resp_len = 0;
608 s->session_ctx = ctx;
609 #ifndef OPENSSL_NO_EC
610 if (ctx->ext.ecpointformats) {
611 s->ext.ecpointformats =
612 OPENSSL_memdup(ctx->ext.ecpointformats,
613 ctx->ext.ecpointformats_len);
614 if (!s->ext.ecpointformats)
616 s->ext.ecpointformats_len =
617 ctx->ext.ecpointformats_len;
619 if (ctx->ext.supportedgroups) {
620 s->ext.supportedgroups =
621 OPENSSL_memdup(ctx->ext.supportedgroups,
622 ctx->ext.supportedgroups_len);
623 if (!s->ext.supportedgroups)
625 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
628 #ifndef OPENSSL_NO_NEXTPROTONEG
632 if (s->ctx->ext.alpn) {
633 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
634 if (s->ext.alpn == NULL)
636 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
637 s->ext.alpn_len = s->ctx->ext.alpn_len;
640 s->verified_chain = NULL;
641 s->verify_result = X509_V_OK;
643 s->default_passwd_callback = ctx->default_passwd_callback;
644 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
646 s->method = ctx->method;
648 s->key_update = SSL_KEY_UPDATE_NONE;
650 if (!s->method->ssl_new(s))
653 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
658 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
661 #ifndef OPENSSL_NO_PSK
662 s->psk_client_callback = ctx->psk_client_callback;
663 s->psk_server_callback = ctx->psk_server_callback;
668 #ifndef OPENSSL_NO_CT
669 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
670 ctx->ct_validation_callback_arg))
677 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
681 int SSL_is_dtls(const SSL *s)
683 return SSL_IS_DTLS(s) ? 1 : 0;
686 int SSL_up_ref(SSL *s)
690 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
693 REF_PRINT_COUNT("SSL", s);
694 REF_ASSERT_ISNT(i < 2);
695 return ((i > 1) ? 1 : 0);
698 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
699 unsigned int sid_ctx_len)
701 if (sid_ctx_len > sizeof ctx->sid_ctx) {
702 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
703 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
706 ctx->sid_ctx_length = sid_ctx_len;
707 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
712 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
713 unsigned int sid_ctx_len)
715 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
716 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
717 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
720 ssl->sid_ctx_length = sid_ctx_len;
721 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
726 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
728 CRYPTO_THREAD_write_lock(ctx->lock);
729 ctx->generate_session_id = cb;
730 CRYPTO_THREAD_unlock(ctx->lock);
734 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
736 CRYPTO_THREAD_write_lock(ssl->lock);
737 ssl->generate_session_id = cb;
738 CRYPTO_THREAD_unlock(ssl->lock);
742 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
746 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
747 * we can "construct" a session to give us the desired check - i.e. to
748 * find if there's a session in the hash table that would conflict with
749 * any new session built out of this id/id_len and the ssl_version in use
754 if (id_len > sizeof r.session_id)
757 r.ssl_version = ssl->version;
758 r.session_id_length = id_len;
759 memcpy(r.session_id, id, id_len);
761 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
762 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
763 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
767 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
769 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
772 int SSL_set_purpose(SSL *s, int purpose)
774 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
777 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
779 return X509_VERIFY_PARAM_set_trust(s->param, trust);
782 int SSL_set_trust(SSL *s, int trust)
784 return X509_VERIFY_PARAM_set_trust(s->param, trust);
787 int SSL_set1_host(SSL *s, const char *hostname)
789 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
792 int SSL_add1_host(SSL *s, const char *hostname)
794 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
797 void SSL_set_hostflags(SSL *s, unsigned int flags)
799 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
802 const char *SSL_get0_peername(SSL *s)
804 return X509_VERIFY_PARAM_get0_peername(s->param);
807 int SSL_CTX_dane_enable(SSL_CTX *ctx)
809 return dane_ctx_enable(&ctx->dane);
812 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
814 unsigned long orig = ctx->dane.flags;
816 ctx->dane.flags |= flags;
820 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
822 unsigned long orig = ctx->dane.flags;
824 ctx->dane.flags &= ~flags;
828 int SSL_dane_enable(SSL *s, const char *basedomain)
830 SSL_DANE *dane = &s->dane;
832 if (s->ctx->dane.mdmax == 0) {
833 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
836 if (dane->trecs != NULL) {
837 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
842 * Default SNI name. This rejects empty names, while set1_host below
843 * accepts them and disables host name checks. To avoid side-effects with
844 * invalid input, set the SNI name first.
846 if (s->ext.hostname == NULL) {
847 if (!SSL_set_tlsext_host_name(s, basedomain)) {
848 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
853 /* Primary RFC6125 reference identifier */
854 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
855 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
861 dane->dctx = &s->ctx->dane;
862 dane->trecs = sk_danetls_record_new_null();
864 if (dane->trecs == NULL) {
865 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
871 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
873 unsigned long orig = ssl->dane.flags;
875 ssl->dane.flags |= flags;
879 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
881 unsigned long orig = ssl->dane.flags;
883 ssl->dane.flags &= ~flags;
887 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
889 SSL_DANE *dane = &s->dane;
891 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
895 *mcert = dane->mcert;
897 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
902 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
903 uint8_t *mtype, unsigned const char **data, size_t *dlen)
905 SSL_DANE *dane = &s->dane;
907 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
911 *usage = dane->mtlsa->usage;
913 *selector = dane->mtlsa->selector;
915 *mtype = dane->mtlsa->mtype;
917 *data = dane->mtlsa->data;
919 *dlen = dane->mtlsa->dlen;
924 SSL_DANE *SSL_get0_dane(SSL *s)
929 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
930 uint8_t mtype, unsigned char *data, size_t dlen)
932 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
935 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
938 return dane_mtype_set(&ctx->dane, md, mtype, ord);
941 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
943 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
946 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
948 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
951 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
956 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
961 void SSL_certs_clear(SSL *s)
963 ssl_cert_clear_certs(s->cert);
966 void SSL_free(SSL *s)
973 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
974 REF_PRINT_COUNT("SSL", s);
977 REF_ASSERT_ISNT(i < 0);
979 X509_VERIFY_PARAM_free(s->param);
980 dane_final(&s->dane);
981 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
983 ssl_free_wbio_buffer(s);
985 BIO_free_all(s->wbio);
986 BIO_free_all(s->rbio);
988 BUF_MEM_free(s->init_buf);
990 /* add extra stuff */
991 sk_SSL_CIPHER_free(s->cipher_list);
992 sk_SSL_CIPHER_free(s->cipher_list_by_id);
994 /* Make the next call work :-) */
995 if (s->session != NULL) {
996 ssl_clear_bad_session(s);
997 SSL_SESSION_free(s->session);
1002 ssl_cert_free(s->cert);
1003 /* Free up if allocated */
1005 OPENSSL_free(s->ext.hostname);
1006 SSL_CTX_free(s->session_ctx);
1007 #ifndef OPENSSL_NO_EC
1008 OPENSSL_free(s->ext.ecpointformats);
1009 OPENSSL_free(s->ext.supportedgroups);
1010 #endif /* OPENSSL_NO_EC */
1011 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1012 #ifndef OPENSSL_NO_OCSP
1013 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1015 #ifndef OPENSSL_NO_CT
1016 SCT_LIST_free(s->scts);
1017 OPENSSL_free(s->ext.scts);
1019 OPENSSL_free(s->ext.ocsp.resp);
1020 OPENSSL_free(s->ext.alpn);
1021 OPENSSL_free(s->ext.tls13_cookie);
1022 OPENSSL_free(s->clienthello);
1024 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1026 sk_X509_pop_free(s->verified_chain, X509_free);
1028 if (s->method != NULL)
1029 s->method->ssl_free(s);
1031 RECORD_LAYER_release(&s->rlayer);
1033 SSL_CTX_free(s->ctx);
1035 ASYNC_WAIT_CTX_free(s->waitctx);
1037 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1038 OPENSSL_free(s->ext.npn);
1041 #ifndef OPENSSL_NO_SRTP
1042 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1045 CRYPTO_THREAD_lock_free(s->lock);
1050 void SSL_set0_rbio(SSL *s, BIO *rbio)
1052 BIO_free_all(s->rbio);
1056 void SSL_set0_wbio(SSL *s, BIO *wbio)
1059 * If the output buffering BIO is still in place, remove it
1061 if (s->bbio != NULL)
1062 s->wbio = BIO_pop(s->wbio);
1064 BIO_free_all(s->wbio);
1067 /* Re-attach |bbio| to the new |wbio|. */
1068 if (s->bbio != NULL)
1069 s->wbio = BIO_push(s->bbio, s->wbio);
1072 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1075 * For historical reasons, this function has many different cases in
1076 * ownership handling.
1079 /* If nothing has changed, do nothing */
1080 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1084 * If the two arguments are equal then one fewer reference is granted by the
1085 * caller than we want to take
1087 if (rbio != NULL && rbio == wbio)
1091 * If only the wbio is changed only adopt one reference.
1093 if (rbio == SSL_get_rbio(s)) {
1094 SSL_set0_wbio(s, wbio);
1098 * There is an asymmetry here for historical reasons. If only the rbio is
1099 * changed AND the rbio and wbio were originally different, then we only
1100 * adopt one reference.
1102 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1103 SSL_set0_rbio(s, rbio);
1107 /* Otherwise, adopt both references. */
1108 SSL_set0_rbio(s, rbio);
1109 SSL_set0_wbio(s, wbio);
1112 BIO *SSL_get_rbio(const SSL *s)
1117 BIO *SSL_get_wbio(const SSL *s)
1119 if (s->bbio != NULL) {
1121 * If |bbio| is active, the true caller-configured BIO is its
1124 return BIO_next(s->bbio);
1129 int SSL_get_fd(const SSL *s)
1131 return SSL_get_rfd(s);
1134 int SSL_get_rfd(const SSL *s)
1139 b = SSL_get_rbio(s);
1140 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1142 BIO_get_fd(r, &ret);
1146 int SSL_get_wfd(const SSL *s)
1151 b = SSL_get_wbio(s);
1152 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1154 BIO_get_fd(r, &ret);
1158 #ifndef OPENSSL_NO_SOCK
1159 int SSL_set_fd(SSL *s, int fd)
1164 bio = BIO_new(BIO_s_socket());
1167 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1170 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1171 SSL_set_bio(s, bio, bio);
1177 int SSL_set_wfd(SSL *s, int fd)
1179 BIO *rbio = SSL_get_rbio(s);
1181 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1182 || (int)BIO_get_fd(rbio, NULL) != fd) {
1183 BIO *bio = BIO_new(BIO_s_socket());
1186 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1189 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1190 SSL_set0_wbio(s, bio);
1193 SSL_set0_wbio(s, rbio);
1198 int SSL_set_rfd(SSL *s, int fd)
1200 BIO *wbio = SSL_get_wbio(s);
1202 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1203 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1204 BIO *bio = BIO_new(BIO_s_socket());
1207 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1210 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1211 SSL_set0_rbio(s, bio);
1214 SSL_set0_rbio(s, wbio);
1221 /* return length of latest Finished message we sent, copy to 'buf' */
1222 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1226 if (s->s3 != NULL) {
1227 ret = s->s3->tmp.finish_md_len;
1230 memcpy(buf, s->s3->tmp.finish_md, count);
1235 /* return length of latest Finished message we expected, copy to 'buf' */
1236 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1240 if (s->s3 != NULL) {
1241 ret = s->s3->tmp.peer_finish_md_len;
1244 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1249 int SSL_get_verify_mode(const SSL *s)
1251 return (s->verify_mode);
1254 int SSL_get_verify_depth(const SSL *s)
1256 return X509_VERIFY_PARAM_get_depth(s->param);
1259 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1260 return (s->verify_callback);
1263 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1265 return (ctx->verify_mode);
1268 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1270 return X509_VERIFY_PARAM_get_depth(ctx->param);
1273 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1274 return (ctx->default_verify_callback);
1277 void SSL_set_verify(SSL *s, int mode,
1278 int (*callback) (int ok, X509_STORE_CTX *ctx))
1280 s->verify_mode = mode;
1281 if (callback != NULL)
1282 s->verify_callback = callback;
1285 void SSL_set_verify_depth(SSL *s, int depth)
1287 X509_VERIFY_PARAM_set_depth(s->param, depth);
1290 void SSL_set_read_ahead(SSL *s, int yes)
1292 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1295 int SSL_get_read_ahead(const SSL *s)
1297 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1300 int SSL_pending(const SSL *s)
1302 size_t pending = s->method->ssl_pending(s);
1305 * SSL_pending cannot work properly if read-ahead is enabled
1306 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1307 * impossible to fix since SSL_pending cannot report errors that may be
1308 * observed while scanning the new data. (Note that SSL_pending() is
1309 * often used as a boolean value, so we'd better not return -1.)
1311 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1312 * we just return INT_MAX.
1314 return pending < INT_MAX ? (int)pending : INT_MAX;
1317 int SSL_has_pending(const SSL *s)
1320 * Similar to SSL_pending() but returns a 1 to indicate that we have
1321 * unprocessed data available or 0 otherwise (as opposed to the number of
1322 * bytes available). Unlike SSL_pending() this will take into account
1323 * read_ahead data. A 1 return simply indicates that we have unprocessed
1324 * data. That data may not result in any application data, or we may fail
1325 * to parse the records for some reason.
1327 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1330 return RECORD_LAYER_read_pending(&s->rlayer);
1333 X509 *SSL_get_peer_certificate(const SSL *s)
1337 if ((s == NULL) || (s->session == NULL))
1340 r = s->session->peer;
1350 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1354 if ((s == NULL) || (s->session == NULL))
1357 r = s->session->peer_chain;
1360 * If we are a client, cert_chain includes the peer's own certificate; if
1361 * we are a server, it does not.
1368 * Now in theory, since the calling process own 't' it should be safe to
1369 * modify. We need to be able to read f without being hassled
1371 int SSL_copy_session_id(SSL *t, const SSL *f)
1374 /* Do we need to to SSL locking? */
1375 if (!SSL_set_session(t, SSL_get_session(f))) {
1380 * what if we are setup for one protocol version but want to talk another
1382 if (t->method != f->method) {
1383 t->method->ssl_free(t);
1384 t->method = f->method;
1385 if (t->method->ssl_new(t) == 0)
1389 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1390 ssl_cert_free(t->cert);
1392 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1399 /* Fix this so it checks all the valid key/cert options */
1400 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1402 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1403 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1406 if (ctx->cert->key->privatekey == NULL) {
1407 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1410 return (X509_check_private_key
1411 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1414 /* Fix this function so that it takes an optional type parameter */
1415 int SSL_check_private_key(const SSL *ssl)
1418 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1421 if (ssl->cert->key->x509 == NULL) {
1422 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1425 if (ssl->cert->key->privatekey == NULL) {
1426 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1429 return (X509_check_private_key(ssl->cert->key->x509,
1430 ssl->cert->key->privatekey));
1433 int SSL_waiting_for_async(SSL *s)
1441 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1443 ASYNC_WAIT_CTX *ctx = s->waitctx;
1447 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1450 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1451 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1453 ASYNC_WAIT_CTX *ctx = s->waitctx;
1457 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1461 int SSL_accept(SSL *s)
1463 if (s->handshake_func == NULL) {
1464 /* Not properly initialized yet */
1465 SSL_set_accept_state(s);
1468 return SSL_do_handshake(s);
1471 int SSL_connect(SSL *s)
1473 if (s->handshake_func == NULL) {
1474 /* Not properly initialized yet */
1475 SSL_set_connect_state(s);
1478 return SSL_do_handshake(s);
1481 long SSL_get_default_timeout(const SSL *s)
1483 return (s->method->get_timeout());
1486 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1487 int (*func) (void *))
1490 if (s->waitctx == NULL) {
1491 s->waitctx = ASYNC_WAIT_CTX_new();
1492 if (s->waitctx == NULL)
1495 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1496 sizeof(struct ssl_async_args))) {
1498 s->rwstate = SSL_NOTHING;
1499 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1502 s->rwstate = SSL_ASYNC_PAUSED;
1505 s->rwstate = SSL_ASYNC_NO_JOBS;
1511 s->rwstate = SSL_NOTHING;
1512 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1513 /* Shouldn't happen */
1518 static int ssl_io_intern(void *vargs)
1520 struct ssl_async_args *args;
1525 args = (struct ssl_async_args *)vargs;
1529 switch (args->type) {
1531 return args->f.func_read(s, buf, num, &s->asyncrw);
1533 return args->f.func_write(s, buf, num, &s->asyncrw);
1535 return args->f.func_other(s);
1540 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1542 if (s->handshake_func == NULL) {
1543 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1547 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1548 s->rwstate = SSL_NOTHING;
1552 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1553 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1554 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1558 * If we are a client and haven't received the ServerHello etc then we
1561 ossl_statem_check_finish_init(s, 0);
1563 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1564 struct ssl_async_args args;
1570 args.type = READFUNC;
1571 args.f.func_read = s->method->ssl_read;
1573 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1574 *readbytes = s->asyncrw;
1577 return s->method->ssl_read(s, buf, num, readbytes);
1581 int SSL_read(SSL *s, void *buf, int num)
1587 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1591 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1594 * The cast is safe here because ret should be <= INT_MAX because num is
1598 ret = (int)readbytes;
1603 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1605 int ret = ssl_read_internal(s, buf, num, readbytes);
1612 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1617 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1618 return SSL_READ_EARLY_DATA_ERROR;
1621 switch (s->early_data_state) {
1622 case SSL_EARLY_DATA_NONE:
1623 if (!SSL_in_before(s)) {
1624 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1625 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1626 return SSL_READ_EARLY_DATA_ERROR;
1630 case SSL_EARLY_DATA_ACCEPT_RETRY:
1631 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1632 ret = SSL_accept(s);
1635 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1636 return SSL_READ_EARLY_DATA_ERROR;
1640 case SSL_EARLY_DATA_READ_RETRY:
1641 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1642 s->early_data_state = SSL_EARLY_DATA_READING;
1643 ret = SSL_read_ex(s, buf, num, readbytes);
1645 * State machine will update early_data_state to
1646 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1649 if (ret > 0 || (ret <= 0 && s->early_data_state
1650 != SSL_EARLY_DATA_FINISHED_READING)) {
1651 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1652 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1653 : SSL_READ_EARLY_DATA_ERROR;
1656 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1659 return SSL_READ_EARLY_DATA_FINISH;
1662 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1663 return SSL_READ_EARLY_DATA_ERROR;
1667 int SSL_get_early_data_status(const SSL *s)
1669 return s->ext.early_data;
1672 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1674 if (s->handshake_func == NULL) {
1675 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1679 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1682 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1683 struct ssl_async_args args;
1689 args.type = READFUNC;
1690 args.f.func_read = s->method->ssl_peek;
1692 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1693 *readbytes = s->asyncrw;
1696 return s->method->ssl_peek(s, buf, num, readbytes);
1700 int SSL_peek(SSL *s, void *buf, int num)
1706 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1710 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1713 * The cast is safe here because ret should be <= INT_MAX because num is
1717 ret = (int)readbytes;
1723 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1725 int ret = ssl_peek_internal(s, buf, num, readbytes);
1732 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1734 if (s->handshake_func == NULL) {
1735 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1739 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1740 s->rwstate = SSL_NOTHING;
1741 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1745 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1746 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1747 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1748 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1751 /* If we are a client and haven't sent the Finished we better do that */
1752 ossl_statem_check_finish_init(s, 1);
1754 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1756 struct ssl_async_args args;
1759 args.buf = (void *)buf;
1761 args.type = WRITEFUNC;
1762 args.f.func_write = s->method->ssl_write;
1764 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1765 *written = s->asyncrw;
1768 return s->method->ssl_write(s, buf, num, written);
1772 int SSL_write(SSL *s, const void *buf, int num)
1778 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1782 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1785 * The cast is safe here because ret should be <= INT_MAX because num is
1794 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1796 int ret = ssl_write_internal(s, buf, num, written);
1803 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1805 int ret, early_data_state;
1807 switch (s->early_data_state) {
1808 case SSL_EARLY_DATA_NONE:
1810 || !SSL_in_before(s)
1811 || s->session == NULL
1812 || s->session->ext.max_early_data == 0) {
1813 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1814 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1819 case SSL_EARLY_DATA_CONNECT_RETRY:
1820 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1821 ret = SSL_connect(s);
1824 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1829 case SSL_EARLY_DATA_WRITE_RETRY:
1830 s->early_data_state = SSL_EARLY_DATA_WRITING;
1831 ret = SSL_write_ex(s, buf, num, written);
1832 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
1835 case SSL_EARLY_DATA_FINISHED_READING:
1836 case SSL_EARLY_DATA_READ_RETRY:
1837 early_data_state = s->early_data_state;
1838 /* We are a server writing to an unauthenticated client */
1839 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
1840 ret = SSL_write_ex(s, buf, num, written);
1841 s->early_data_state = early_data_state;
1845 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1850 int SSL_shutdown(SSL *s)
1853 * Note that this function behaves differently from what one might
1854 * expect. Return values are 0 for no success (yet), 1 for success; but
1855 * calling it once is usually not enough, even if blocking I/O is used
1856 * (see ssl3_shutdown).
1859 if (s->handshake_func == NULL) {
1860 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1864 if (!SSL_in_init(s)) {
1865 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1866 struct ssl_async_args args;
1869 args.type = OTHERFUNC;
1870 args.f.func_other = s->method->ssl_shutdown;
1872 return ssl_start_async_job(s, &args, ssl_io_intern);
1874 return s->method->ssl_shutdown(s);
1877 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1882 int SSL_key_update(SSL *s, int updatetype)
1885 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
1886 * negotiated, and that it is appropriate to call SSL_key_update() instead
1887 * of SSL_renegotiate().
1889 if (!SSL_IS_TLS13(s)) {
1890 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1894 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1895 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1896 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1900 if (!SSL_is_init_finished(s)) {
1901 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1905 ossl_statem_set_in_init(s, 1);
1906 s->key_update = updatetype;
1910 int SSL_get_key_update_type(SSL *s)
1912 return s->key_update;
1915 int SSL_renegotiate(SSL *s)
1917 if (SSL_IS_TLS13(s)) {
1918 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1922 if (s->renegotiate == 0)
1927 return (s->method->ssl_renegotiate(s));
1930 int SSL_renegotiate_abbreviated(SSL *s)
1932 if (SSL_IS_TLS13(s))
1935 if (s->renegotiate == 0)
1940 return (s->method->ssl_renegotiate(s));
1943 int SSL_renegotiate_pending(SSL *s)
1946 * becomes true when negotiation is requested; false again once a
1947 * handshake has finished
1949 return (s->renegotiate != 0);
1952 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1957 case SSL_CTRL_GET_READ_AHEAD:
1958 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1959 case SSL_CTRL_SET_READ_AHEAD:
1960 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1961 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1964 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1965 s->msg_callback_arg = parg;
1969 return (s->mode |= larg);
1970 case SSL_CTRL_CLEAR_MODE:
1971 return (s->mode &= ~larg);
1972 case SSL_CTRL_GET_MAX_CERT_LIST:
1973 return (long)(s->max_cert_list);
1974 case SSL_CTRL_SET_MAX_CERT_LIST:
1977 l = (long)s->max_cert_list;
1978 s->max_cert_list = (size_t)larg;
1980 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1981 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1983 s->max_send_fragment = larg;
1984 if (s->max_send_fragment < s->split_send_fragment)
1985 s->split_send_fragment = s->max_send_fragment;
1987 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1988 if ((size_t)larg > s->max_send_fragment || larg == 0)
1990 s->split_send_fragment = larg;
1992 case SSL_CTRL_SET_MAX_PIPELINES:
1993 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1995 s->max_pipelines = larg;
1997 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
1999 case SSL_CTRL_GET_RI_SUPPORT:
2001 return s->s3->send_connection_binding;
2004 case SSL_CTRL_CERT_FLAGS:
2005 return (s->cert->cert_flags |= larg);
2006 case SSL_CTRL_CLEAR_CERT_FLAGS:
2007 return (s->cert->cert_flags &= ~larg);
2009 case SSL_CTRL_GET_RAW_CIPHERLIST:
2011 if (s->s3->tmp.ciphers_raw == NULL)
2013 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2014 return (int)s->s3->tmp.ciphers_rawlen;
2016 return TLS_CIPHER_LEN;
2018 case SSL_CTRL_GET_EXTMS_SUPPORT:
2019 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2021 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2025 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2026 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2027 &s->min_proto_version);
2028 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2029 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2030 &s->max_proto_version);
2032 return (s->method->ssl_ctrl(s, cmd, larg, parg));
2036 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2039 case SSL_CTRL_SET_MSG_CALLBACK:
2040 s->msg_callback = (void (*)
2041 (int write_p, int version, int content_type,
2042 const void *buf, size_t len, SSL *ssl,
2047 return (s->method->ssl_callback_ctrl(s, cmd, fp));
2051 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2053 return ctx->sessions;
2056 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2059 /* For some cases with ctx == NULL perform syntax checks */
2062 #ifndef OPENSSL_NO_EC
2063 case SSL_CTRL_SET_GROUPS_LIST:
2064 return tls1_set_groups_list(NULL, NULL, parg);
2066 case SSL_CTRL_SET_SIGALGS_LIST:
2067 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2068 return tls1_set_sigalgs_list(NULL, parg, 0);
2075 case SSL_CTRL_GET_READ_AHEAD:
2076 return (ctx->read_ahead);
2077 case SSL_CTRL_SET_READ_AHEAD:
2078 l = ctx->read_ahead;
2079 ctx->read_ahead = larg;
2082 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2083 ctx->msg_callback_arg = parg;
2086 case SSL_CTRL_GET_MAX_CERT_LIST:
2087 return (long)(ctx->max_cert_list);
2088 case SSL_CTRL_SET_MAX_CERT_LIST:
2091 l = (long)ctx->max_cert_list;
2092 ctx->max_cert_list = (size_t)larg;
2095 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2098 l = (long)ctx->session_cache_size;
2099 ctx->session_cache_size = (size_t)larg;
2101 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2102 return (long)(ctx->session_cache_size);
2103 case SSL_CTRL_SET_SESS_CACHE_MODE:
2104 l = ctx->session_cache_mode;
2105 ctx->session_cache_mode = larg;
2107 case SSL_CTRL_GET_SESS_CACHE_MODE:
2108 return (ctx->session_cache_mode);
2110 case SSL_CTRL_SESS_NUMBER:
2111 return (lh_SSL_SESSION_num_items(ctx->sessions));
2112 case SSL_CTRL_SESS_CONNECT:
2113 return (ctx->stats.sess_connect);
2114 case SSL_CTRL_SESS_CONNECT_GOOD:
2115 return (ctx->stats.sess_connect_good);
2116 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2117 return (ctx->stats.sess_connect_renegotiate);
2118 case SSL_CTRL_SESS_ACCEPT:
2119 return (ctx->stats.sess_accept);
2120 case SSL_CTRL_SESS_ACCEPT_GOOD:
2121 return (ctx->stats.sess_accept_good);
2122 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2123 return (ctx->stats.sess_accept_renegotiate);
2124 case SSL_CTRL_SESS_HIT:
2125 return (ctx->stats.sess_hit);
2126 case SSL_CTRL_SESS_CB_HIT:
2127 return (ctx->stats.sess_cb_hit);
2128 case SSL_CTRL_SESS_MISSES:
2129 return (ctx->stats.sess_miss);
2130 case SSL_CTRL_SESS_TIMEOUTS:
2131 return (ctx->stats.sess_timeout);
2132 case SSL_CTRL_SESS_CACHE_FULL:
2133 return (ctx->stats.sess_cache_full);
2135 return (ctx->mode |= larg);
2136 case SSL_CTRL_CLEAR_MODE:
2137 return (ctx->mode &= ~larg);
2138 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2139 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2141 ctx->max_send_fragment = larg;
2142 if (ctx->max_send_fragment < ctx->split_send_fragment)
2143 ctx->split_send_fragment = ctx->max_send_fragment;
2145 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2146 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2148 ctx->split_send_fragment = larg;
2150 case SSL_CTRL_SET_MAX_PIPELINES:
2151 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2153 ctx->max_pipelines = larg;
2155 case SSL_CTRL_CERT_FLAGS:
2156 return (ctx->cert->cert_flags |= larg);
2157 case SSL_CTRL_CLEAR_CERT_FLAGS:
2158 return (ctx->cert->cert_flags &= ~larg);
2159 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2160 return ssl_set_version_bound(ctx->method->version, (int)larg,
2161 &ctx->min_proto_version);
2162 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2163 return ssl_set_version_bound(ctx->method->version, (int)larg,
2164 &ctx->max_proto_version);
2166 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2170 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2173 case SSL_CTRL_SET_MSG_CALLBACK:
2174 ctx->msg_callback = (void (*)
2175 (int write_p, int version, int content_type,
2176 const void *buf, size_t len, SSL *ssl,
2181 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2185 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2194 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2195 const SSL_CIPHER *const *bp)
2197 if ((*ap)->id > (*bp)->id)
2199 if ((*ap)->id < (*bp)->id)
2204 /** return a STACK of the ciphers available for the SSL and in order of
2206 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2209 if (s->cipher_list != NULL) {
2210 return (s->cipher_list);
2211 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2212 return (s->ctx->cipher_list);
2218 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2220 if ((s == NULL) || (s->session == NULL) || !s->server)
2222 return s->session->ciphers;
2225 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2227 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2229 ciphers = SSL_get_ciphers(s);
2232 ssl_set_client_disabled(s);
2233 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2234 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2235 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2237 sk = sk_SSL_CIPHER_new_null();
2240 if (!sk_SSL_CIPHER_push(sk, c)) {
2241 sk_SSL_CIPHER_free(sk);
2249 /** return a STACK of the ciphers available for the SSL and in order of
2251 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2254 if (s->cipher_list_by_id != NULL) {
2255 return (s->cipher_list_by_id);
2256 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2257 return (s->ctx->cipher_list_by_id);
2263 /** The old interface to get the same thing as SSL_get_ciphers() */
2264 const char *SSL_get_cipher_list(const SSL *s, int n)
2266 const SSL_CIPHER *c;
2267 STACK_OF(SSL_CIPHER) *sk;
2271 sk = SSL_get_ciphers(s);
2272 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2274 c = sk_SSL_CIPHER_value(sk, n);
2280 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2282 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2285 return ctx->cipher_list;
2289 /** specify the ciphers to be used by default by the SSL_CTX */
2290 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2292 STACK_OF(SSL_CIPHER) *sk;
2294 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2295 &ctx->cipher_list_by_id, str, ctx->cert);
2297 * ssl_create_cipher_list may return an empty stack if it was unable to
2298 * find a cipher matching the given rule string (for example if the rule
2299 * string specifies a cipher which has been disabled). This is not an
2300 * error as far as ssl_create_cipher_list is concerned, and hence
2301 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2305 else if (sk_SSL_CIPHER_num(sk) == 0) {
2306 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2312 /** specify the ciphers to be used by the SSL */
2313 int SSL_set_cipher_list(SSL *s, const char *str)
2315 STACK_OF(SSL_CIPHER) *sk;
2317 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2318 &s->cipher_list_by_id, str, s->cert);
2319 /* see comment in SSL_CTX_set_cipher_list */
2322 else if (sk_SSL_CIPHER_num(sk) == 0) {
2323 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2329 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2332 STACK_OF(SSL_CIPHER) *sk;
2333 const SSL_CIPHER *c;
2336 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2340 sk = s->session->ciphers;
2342 if (sk_SSL_CIPHER_num(sk) == 0)
2345 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2348 c = sk_SSL_CIPHER_value(sk, i);
2349 n = strlen(c->name);
2356 memcpy(p, c->name, n + 1);
2365 /** return a servername extension value if provided in Client Hello, or NULL.
2366 * So far, only host_name types are defined (RFC 3546).
2369 const char *SSL_get_servername(const SSL *s, const int type)
2371 if (type != TLSEXT_NAMETYPE_host_name)
2374 return s->session && !s->ext.hostname ?
2375 s->session->ext.hostname : s->ext.hostname;
2378 int SSL_get_servername_type(const SSL *s)
2381 && (!s->ext.hostname ? s->session->
2382 ext.hostname : s->ext.hostname))
2383 return TLSEXT_NAMETYPE_host_name;
2388 * SSL_select_next_proto implements the standard protocol selection. It is
2389 * expected that this function is called from the callback set by
2390 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2391 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2392 * not included in the length. A byte string of length 0 is invalid. No byte
2393 * string may be truncated. The current, but experimental algorithm for
2394 * selecting the protocol is: 1) If the server doesn't support NPN then this
2395 * is indicated to the callback. In this case, the client application has to
2396 * abort the connection or have a default application level protocol. 2) If
2397 * the server supports NPN, but advertises an empty list then the client
2398 * selects the first protocol in its list, but indicates via the API that this
2399 * fallback case was enacted. 3) Otherwise, the client finds the first
2400 * protocol in the server's list that it supports and selects this protocol.
2401 * This is because it's assumed that the server has better information about
2402 * which protocol a client should use. 4) If the client doesn't support any
2403 * of the server's advertised protocols, then this is treated the same as
2404 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2405 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2407 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2408 const unsigned char *server,
2409 unsigned int server_len,
2410 const unsigned char *client, unsigned int client_len)
2413 const unsigned char *result;
2414 int status = OPENSSL_NPN_UNSUPPORTED;
2417 * For each protocol in server preference order, see if we support it.
2419 for (i = 0; i < server_len;) {
2420 for (j = 0; j < client_len;) {
2421 if (server[i] == client[j] &&
2422 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2423 /* We found a match */
2424 result = &server[i];
2425 status = OPENSSL_NPN_NEGOTIATED;
2435 /* There's no overlap between our protocols and the server's list. */
2437 status = OPENSSL_NPN_NO_OVERLAP;
2440 *out = (unsigned char *)result + 1;
2441 *outlen = result[0];
2445 #ifndef OPENSSL_NO_NEXTPROTONEG
2447 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2448 * client's requested protocol for this connection and returns 0. If the
2449 * client didn't request any protocol, then *data is set to NULL. Note that
2450 * the client can request any protocol it chooses. The value returned from
2451 * this function need not be a member of the list of supported protocols
2452 * provided by the callback.
2454 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2461 *len = (unsigned int)s->ext.npn_len;
2466 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2467 * a TLS server needs a list of supported protocols for Next Protocol
2468 * Negotiation. The returned list must be in wire format. The list is
2469 * returned by setting |out| to point to it and |outlen| to its length. This
2470 * memory will not be modified, but one should assume that the SSL* keeps a
2471 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2472 * wishes to advertise. Otherwise, no such extension will be included in the
2475 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2476 SSL_CTX_npn_advertised_cb_func cb,
2479 ctx->ext.npn_advertised_cb = cb;
2480 ctx->ext.npn_advertised_cb_arg = arg;
2484 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2485 * client needs to select a protocol from the server's provided list. |out|
2486 * must be set to point to the selected protocol (which may be within |in|).
2487 * The length of the protocol name must be written into |outlen|. The
2488 * server's advertised protocols are provided in |in| and |inlen|. The
2489 * callback can assume that |in| is syntactically valid. The client must
2490 * select a protocol. It is fatal to the connection if this callback returns
2491 * a value other than SSL_TLSEXT_ERR_OK.
2493 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2494 SSL_CTX_npn_select_cb_func cb,
2497 ctx->ext.npn_select_cb = cb;
2498 ctx->ext.npn_select_cb_arg = arg;
2503 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2504 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2505 * length-prefixed strings). Returns 0 on success.
2507 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2508 unsigned int protos_len)
2510 OPENSSL_free(ctx->ext.alpn);
2511 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2512 if (ctx->ext.alpn == NULL) {
2513 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2516 ctx->ext.alpn_len = protos_len;
2522 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2523 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2524 * length-prefixed strings). Returns 0 on success.
2526 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2527 unsigned int protos_len)
2529 OPENSSL_free(ssl->ext.alpn);
2530 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2531 if (ssl->ext.alpn == NULL) {
2532 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2535 ssl->ext.alpn_len = protos_len;
2541 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2542 * called during ClientHello processing in order to select an ALPN protocol
2543 * from the client's list of offered protocols.
2545 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2546 SSL_CTX_alpn_select_cb_func cb,
2549 ctx->ext.alpn_select_cb = cb;
2550 ctx->ext.alpn_select_cb_arg = arg;
2554 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2555 * On return it sets |*data| to point to |*len| bytes of protocol name
2556 * (not including the leading length-prefix byte). If the server didn't
2557 * respond with a negotiated protocol then |*len| will be zero.
2559 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2564 *data = ssl->s3->alpn_selected;
2568 *len = (unsigned int)ssl->s3->alpn_selected_len;
2571 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2572 const char *label, size_t llen,
2573 const unsigned char *p, size_t plen,
2576 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2579 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2584 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2586 const unsigned char *session_id = a->session_id;
2588 unsigned char tmp_storage[4];
2590 if (a->session_id_length < sizeof(tmp_storage)) {
2591 memset(tmp_storage, 0, sizeof(tmp_storage));
2592 memcpy(tmp_storage, a->session_id, a->session_id_length);
2593 session_id = tmp_storage;
2597 ((unsigned long)session_id[0]) |
2598 ((unsigned long)session_id[1] << 8L) |
2599 ((unsigned long)session_id[2] << 16L) |
2600 ((unsigned long)session_id[3] << 24L);
2605 * NB: If this function (or indeed the hash function which uses a sort of
2606 * coarser function than this one) is changed, ensure
2607 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2608 * being able to construct an SSL_SESSION that will collide with any existing
2609 * session with a matching session ID.
2611 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2613 if (a->ssl_version != b->ssl_version)
2615 if (a->session_id_length != b->session_id_length)
2617 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2621 * These wrapper functions should remain rather than redeclaring
2622 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2623 * variable. The reason is that the functions aren't static, they're exposed
2627 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2629 SSL_CTX *ret = NULL;
2632 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2636 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2639 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2640 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2643 ret = OPENSSL_zalloc(sizeof(*ret));
2648 ret->min_proto_version = 0;
2649 ret->max_proto_version = 0;
2650 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2651 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2652 /* We take the system default. */
2653 ret->session_timeout = meth->get_timeout();
2654 ret->references = 1;
2655 ret->lock = CRYPTO_THREAD_lock_new();
2656 if (ret->lock == NULL) {
2657 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2661 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2662 ret->verify_mode = SSL_VERIFY_NONE;
2663 if ((ret->cert = ssl_cert_new()) == NULL)
2666 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2667 if (ret->sessions == NULL)
2669 ret->cert_store = X509_STORE_new();
2670 if (ret->cert_store == NULL)
2672 #ifndef OPENSSL_NO_CT
2673 ret->ctlog_store = CTLOG_STORE_new();
2674 if (ret->ctlog_store == NULL)
2677 if (!ssl_create_cipher_list(ret->method,
2678 &ret->cipher_list, &ret->cipher_list_by_id,
2679 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2680 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2681 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2685 ret->param = X509_VERIFY_PARAM_new();
2686 if (ret->param == NULL)
2689 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2690 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2693 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2694 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2698 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2701 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2704 /* No compression for DTLS */
2705 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2706 ret->comp_methods = SSL_COMP_get_compression_methods();
2708 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2709 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2711 /* Setup RFC5077 ticket keys */
2712 if ((RAND_bytes(ret->ext.tick_key_name,
2713 sizeof(ret->ext.tick_key_name)) <= 0)
2714 || (RAND_bytes(ret->ext.tick_hmac_key,
2715 sizeof(ret->ext.tick_hmac_key)) <= 0)
2716 || (RAND_bytes(ret->ext.tick_aes_key,
2717 sizeof(ret->ext.tick_aes_key)) <= 0))
2718 ret->options |= SSL_OP_NO_TICKET;
2720 #ifndef OPENSSL_NO_SRP
2721 if (!SSL_CTX_SRP_CTX_init(ret))
2724 #ifndef OPENSSL_NO_ENGINE
2725 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2726 # define eng_strx(x) #x
2727 # define eng_str(x) eng_strx(x)
2728 /* Use specific client engine automatically... ignore errors */
2731 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2734 ENGINE_load_builtin_engines();
2735 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2737 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2743 * Default is to connect to non-RI servers. When RI is more widely
2744 * deployed might change this.
2746 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2748 * Disable compression by default to prevent CRIME. Applications can
2749 * re-enable compression by configuring
2750 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2751 * or by using the SSL_CONF library.
2753 ret->options |= SSL_OP_NO_COMPRESSION;
2755 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2758 * Default max early data is a fully loaded single record. Could be split
2759 * across multiple records in practice
2761 ret->max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
2765 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2771 int SSL_CTX_up_ref(SSL_CTX *ctx)
2775 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2778 REF_PRINT_COUNT("SSL_CTX", ctx);
2779 REF_ASSERT_ISNT(i < 2);
2780 return ((i > 1) ? 1 : 0);
2783 void SSL_CTX_free(SSL_CTX *a)
2790 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2791 REF_PRINT_COUNT("SSL_CTX", a);
2794 REF_ASSERT_ISNT(i < 0);
2796 X509_VERIFY_PARAM_free(a->param);
2797 dane_ctx_final(&a->dane);
2800 * Free internal session cache. However: the remove_cb() may reference
2801 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2802 * after the sessions were flushed.
2803 * As the ex_data handling routines might also touch the session cache,
2804 * the most secure solution seems to be: empty (flush) the cache, then
2805 * free ex_data, then finally free the cache.
2806 * (See ticket [openssl.org #212].)
2808 if (a->sessions != NULL)
2809 SSL_CTX_flush_sessions(a, 0);
2811 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2812 lh_SSL_SESSION_free(a->sessions);
2813 X509_STORE_free(a->cert_store);
2814 #ifndef OPENSSL_NO_CT
2815 CTLOG_STORE_free(a->ctlog_store);
2817 sk_SSL_CIPHER_free(a->cipher_list);
2818 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2819 ssl_cert_free(a->cert);
2820 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
2821 sk_X509_pop_free(a->extra_certs, X509_free);
2822 a->comp_methods = NULL;
2823 #ifndef OPENSSL_NO_SRTP
2824 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2826 #ifndef OPENSSL_NO_SRP
2827 SSL_CTX_SRP_CTX_free(a);
2829 #ifndef OPENSSL_NO_ENGINE
2830 ENGINE_finish(a->client_cert_engine);
2833 #ifndef OPENSSL_NO_EC
2834 OPENSSL_free(a->ext.ecpointformats);
2835 OPENSSL_free(a->ext.supportedgroups);
2837 OPENSSL_free(a->ext.alpn);
2839 CRYPTO_THREAD_lock_free(a->lock);
2844 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2846 ctx->default_passwd_callback = cb;
2849 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2851 ctx->default_passwd_callback_userdata = u;
2854 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2856 return ctx->default_passwd_callback;
2859 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2861 return ctx->default_passwd_callback_userdata;
2864 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2866 s->default_passwd_callback = cb;
2869 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2871 s->default_passwd_callback_userdata = u;
2874 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2876 return s->default_passwd_callback;
2879 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2881 return s->default_passwd_callback_userdata;
2884 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2885 int (*cb) (X509_STORE_CTX *, void *),
2888 ctx->app_verify_callback = cb;
2889 ctx->app_verify_arg = arg;
2892 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2893 int (*cb) (int, X509_STORE_CTX *))
2895 ctx->verify_mode = mode;
2896 ctx->default_verify_callback = cb;
2899 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2901 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2904 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2906 ssl_cert_set_cert_cb(c->cert, cb, arg);
2909 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2911 ssl_cert_set_cert_cb(s->cert, cb, arg);
2914 void ssl_set_masks(SSL *s)
2917 uint32_t *pvalid = s->s3->tmp.valid_flags;
2918 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2919 unsigned long mask_k, mask_a;
2920 #ifndef OPENSSL_NO_EC
2921 int have_ecc_cert, ecdsa_ok;
2926 #ifndef OPENSSL_NO_DH
2927 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2932 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2933 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2934 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
2935 #ifndef OPENSSL_NO_EC
2936 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2942 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2943 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2946 #ifndef OPENSSL_NO_GOST
2947 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2948 mask_k |= SSL_kGOST;
2949 mask_a |= SSL_aGOST12;
2951 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2952 mask_k |= SSL_kGOST;
2953 mask_a |= SSL_aGOST12;
2955 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2956 mask_k |= SSL_kGOST;
2957 mask_a |= SSL_aGOST01;
2967 if (rsa_enc || rsa_sign) {
2975 mask_a |= SSL_aNULL;
2978 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2979 * depending on the key usage extension.
2981 #ifndef OPENSSL_NO_EC
2982 if (have_ecc_cert) {
2984 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
2985 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2986 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2989 mask_a |= SSL_aECDSA;
2993 #ifndef OPENSSL_NO_EC
2994 mask_k |= SSL_kECDHE;
2997 #ifndef OPENSSL_NO_PSK
3000 if (mask_k & SSL_kRSA)
3001 mask_k |= SSL_kRSAPSK;
3002 if (mask_k & SSL_kDHE)
3003 mask_k |= SSL_kDHEPSK;
3004 if (mask_k & SSL_kECDHE)
3005 mask_k |= SSL_kECDHEPSK;
3008 s->s3->tmp.mask_k = mask_k;
3009 s->s3->tmp.mask_a = mask_a;
3012 #ifndef OPENSSL_NO_EC
3014 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3016 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3017 /* key usage, if present, must allow signing */
3018 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3019 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3020 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3024 return 1; /* all checks are ok */
3029 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3030 size_t *serverinfo_length)
3032 CERT_PKEY *cpk = s->s3->tmp.cert;
3033 *serverinfo_length = 0;
3035 if (cpk == NULL || cpk->serverinfo == NULL)
3038 *serverinfo = cpk->serverinfo;
3039 *serverinfo_length = cpk->serverinfo_length;
3043 void ssl_update_cache(SSL *s, int mode)
3048 * If the session_id_length is 0, we are not supposed to cache it, and it
3049 * would be rather hard to do anyway :-)
3051 if (s->session->session_id_length == 0)
3054 i = s->session_ctx->session_cache_mode;
3055 if ((i & mode) && (!s->hit)
3056 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
3057 || SSL_CTX_add_session(s->session_ctx, s->session))
3058 && (s->session_ctx->new_session_cb != NULL)) {
3059 SSL_SESSION_up_ref(s->session);
3060 if (!s->session_ctx->new_session_cb(s, s->session))
3061 SSL_SESSION_free(s->session);
3064 /* auto flush every 255 connections */
3065 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3066 if ((((mode & SSL_SESS_CACHE_CLIENT)
3067 ? s->session_ctx->stats.sess_connect_good
3068 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
3069 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3074 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3079 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3084 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3088 if (s->method != meth) {
3089 const SSL_METHOD *sm = s->method;
3090 int (*hf) (SSL *) = s->handshake_func;
3092 if (sm->version == meth->version)
3097 ret = s->method->ssl_new(s);
3100 if (hf == sm->ssl_connect)
3101 s->handshake_func = meth->ssl_connect;
3102 else if (hf == sm->ssl_accept)
3103 s->handshake_func = meth->ssl_accept;
3108 int SSL_get_error(const SSL *s, int i)
3115 return (SSL_ERROR_NONE);
3118 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3119 * where we do encode the error
3121 if ((l = ERR_peek_error()) != 0) {
3122 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3123 return (SSL_ERROR_SYSCALL);
3125 return (SSL_ERROR_SSL);
3128 if (SSL_want_read(s)) {
3129 bio = SSL_get_rbio(s);
3130 if (BIO_should_read(bio))
3131 return (SSL_ERROR_WANT_READ);
3132 else if (BIO_should_write(bio))
3134 * This one doesn't make too much sense ... We never try to write
3135 * to the rbio, and an application program where rbio and wbio
3136 * are separate couldn't even know what it should wait for.
3137 * However if we ever set s->rwstate incorrectly (so that we have
3138 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3139 * wbio *are* the same, this test works around that bug; so it
3140 * might be safer to keep it.
3142 return (SSL_ERROR_WANT_WRITE);
3143 else if (BIO_should_io_special(bio)) {
3144 reason = BIO_get_retry_reason(bio);
3145 if (reason == BIO_RR_CONNECT)
3146 return (SSL_ERROR_WANT_CONNECT);
3147 else if (reason == BIO_RR_ACCEPT)
3148 return (SSL_ERROR_WANT_ACCEPT);
3150 return (SSL_ERROR_SYSCALL); /* unknown */
3154 if (SSL_want_write(s)) {
3155 /* Access wbio directly - in order to use the buffered bio if present */
3157 if (BIO_should_write(bio))
3158 return (SSL_ERROR_WANT_WRITE);
3159 else if (BIO_should_read(bio))
3161 * See above (SSL_want_read(s) with BIO_should_write(bio))
3163 return (SSL_ERROR_WANT_READ);
3164 else if (BIO_should_io_special(bio)) {
3165 reason = BIO_get_retry_reason(bio);
3166 if (reason == BIO_RR_CONNECT)
3167 return (SSL_ERROR_WANT_CONNECT);
3168 else if (reason == BIO_RR_ACCEPT)
3169 return (SSL_ERROR_WANT_ACCEPT);
3171 return (SSL_ERROR_SYSCALL);
3174 if (SSL_want_x509_lookup(s))
3175 return (SSL_ERROR_WANT_X509_LOOKUP);
3176 if (SSL_want_async(s))
3177 return SSL_ERROR_WANT_ASYNC;
3178 if (SSL_want_async_job(s))
3179 return SSL_ERROR_WANT_ASYNC_JOB;
3180 if (SSL_want_early(s))
3181 return SSL_ERROR_WANT_EARLY;
3183 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3184 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3185 return (SSL_ERROR_ZERO_RETURN);
3187 return (SSL_ERROR_SYSCALL);
3190 static int ssl_do_handshake_intern(void *vargs)
3192 struct ssl_async_args *args;
3195 args = (struct ssl_async_args *)vargs;
3198 return s->handshake_func(s);
3201 int SSL_do_handshake(SSL *s)
3205 if (s->handshake_func == NULL) {
3206 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3210 ossl_statem_check_finish_init(s, -1);
3212 s->method->ssl_renegotiate_check(s, 0);
3214 if (SSL_in_init(s) || SSL_in_before(s)) {
3215 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3216 struct ssl_async_args args;
3220 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3222 ret = s->handshake_func(s);
3228 void SSL_set_accept_state(SSL *s)
3232 ossl_statem_clear(s);
3233 s->handshake_func = s->method->ssl_accept;
3237 void SSL_set_connect_state(SSL *s)
3241 ossl_statem_clear(s);
3242 s->handshake_func = s->method->ssl_connect;
3246 int ssl_undefined_function(SSL *s)
3248 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3252 int ssl_undefined_void_function(void)
3254 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3255 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3259 int ssl_undefined_const_function(const SSL *s)
3264 const SSL_METHOD *ssl_bad_method(int ver)
3266 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3270 const char *ssl_protocol_to_string(int version)
3274 case TLS1_3_VERSION:
3277 case TLS1_2_VERSION:
3280 case TLS1_1_VERSION:
3295 case DTLS1_2_VERSION:
3303 const char *SSL_get_version(const SSL *s)
3305 return ssl_protocol_to_string(s->version);
3308 SSL *SSL_dup(SSL *s)
3310 STACK_OF(X509_NAME) *sk;
3315 /* If we're not quiescent, just up_ref! */
3316 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3317 CRYPTO_UP_REF(&s->references, &i, s->lock);
3322 * Otherwise, copy configuration state, and session if set.
3324 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3327 if (s->session != NULL) {
3329 * Arranges to share the same session via up_ref. This "copies"
3330 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3332 if (!SSL_copy_session_id(ret, s))
3336 * No session has been established yet, so we have to expect that
3337 * s->cert or ret->cert will be changed later -- they should not both
3338 * point to the same object, and thus we can't use
3339 * SSL_copy_session_id.
3341 if (!SSL_set_ssl_method(ret, s->method))
3344 if (s->cert != NULL) {
3345 ssl_cert_free(ret->cert);
3346 ret->cert = ssl_cert_dup(s->cert);
3347 if (ret->cert == NULL)
3351 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3352 (int)s->sid_ctx_length))
3356 if (!ssl_dane_dup(ret, s))
3358 ret->version = s->version;
3359 ret->options = s->options;
3360 ret->mode = s->mode;
3361 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3362 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3363 ret->msg_callback = s->msg_callback;
3364 ret->msg_callback_arg = s->msg_callback_arg;
3365 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3366 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3367 ret->generate_session_id = s->generate_session_id;
3369 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3371 /* copy app data, a little dangerous perhaps */
3372 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3375 /* setup rbio, and wbio */
3376 if (s->rbio != NULL) {
3377 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3380 if (s->wbio != NULL) {
3381 if (s->wbio != s->rbio) {
3382 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3385 BIO_up_ref(ret->rbio);
3386 ret->wbio = ret->rbio;
3390 ret->server = s->server;
3391 if (s->handshake_func) {
3393 SSL_set_accept_state(ret);
3395 SSL_set_connect_state(ret);
3397 ret->shutdown = s->shutdown;
3400 ret->default_passwd_callback = s->default_passwd_callback;
3401 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3403 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3405 /* dup the cipher_list and cipher_list_by_id stacks */
3406 if (s->cipher_list != NULL) {
3407 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3410 if (s->cipher_list_by_id != NULL)
3411 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3415 /* Dup the client_CA list */
3416 if (s->ca_names != NULL) {
3417 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3420 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3421 xn = sk_X509_NAME_value(sk, i);
3422 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3435 void ssl_clear_cipher_ctx(SSL *s)
3437 if (s->enc_read_ctx != NULL) {
3438 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3439 s->enc_read_ctx = NULL;
3441 if (s->enc_write_ctx != NULL) {
3442 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3443 s->enc_write_ctx = NULL;
3445 #ifndef OPENSSL_NO_COMP
3446 COMP_CTX_free(s->expand);
3448 COMP_CTX_free(s->compress);
3453 X509 *SSL_get_certificate(const SSL *s)
3455 if (s->cert != NULL)
3456 return (s->cert->key->x509);
3461 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3463 if (s->cert != NULL)
3464 return (s->cert->key->privatekey);
3469 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3471 if (ctx->cert != NULL)
3472 return ctx->cert->key->x509;
3477 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3479 if (ctx->cert != NULL)
3480 return ctx->cert->key->privatekey;
3485 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3487 if ((s->session != NULL) && (s->session->cipher != NULL))
3488 return (s->session->cipher);
3492 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3494 #ifndef OPENSSL_NO_COMP
3495 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3501 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3503 #ifndef OPENSSL_NO_COMP
3504 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3510 int ssl_init_wbio_buffer(SSL *s)
3514 if (s->bbio != NULL) {
3515 /* Already buffered. */
3519 bbio = BIO_new(BIO_f_buffer());
3520 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3522 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3526 s->wbio = BIO_push(bbio, s->wbio);
3531 void ssl_free_wbio_buffer(SSL *s)
3533 /* callers ensure s is never null */
3534 if (s->bbio == NULL)
3537 s->wbio = BIO_pop(s->wbio);
3538 assert(s->wbio != NULL);
3543 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3545 ctx->quiet_shutdown = mode;
3548 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3550 return (ctx->quiet_shutdown);
3553 void SSL_set_quiet_shutdown(SSL *s, int mode)
3555 s->quiet_shutdown = mode;
3558 int SSL_get_quiet_shutdown(const SSL *s)
3560 return (s->quiet_shutdown);
3563 void SSL_set_shutdown(SSL *s, int mode)
3568 int SSL_get_shutdown(const SSL *s)
3573 int SSL_version(const SSL *s)
3578 int SSL_client_version(const SSL *s)
3580 return s->client_version;
3583 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3588 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3591 if (ssl->ctx == ctx)
3594 ctx = ssl->session_ctx;
3595 new_cert = ssl_cert_dup(ctx->cert);
3596 if (new_cert == NULL) {
3599 ssl_cert_free(ssl->cert);
3600 ssl->cert = new_cert;
3603 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3604 * so setter APIs must prevent invalid lengths from entering the system.
3606 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3609 * If the session ID context matches that of the parent SSL_CTX,
3610 * inherit it from the new SSL_CTX as well. If however the context does
3611 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3612 * leave it unchanged.
3614 if ((ssl->ctx != NULL) &&
3615 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3616 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3617 ssl->sid_ctx_length = ctx->sid_ctx_length;
3618 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3621 SSL_CTX_up_ref(ctx);
3622 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3628 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3630 return (X509_STORE_set_default_paths(ctx->cert_store));
3633 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3635 X509_LOOKUP *lookup;
3637 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3640 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3642 /* Clear any errors if the default directory does not exist */
3648 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3650 X509_LOOKUP *lookup;
3652 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3656 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3658 /* Clear any errors if the default file does not exist */
3664 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3667 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3670 void SSL_set_info_callback(SSL *ssl,
3671 void (*cb) (const SSL *ssl, int type, int val))
3673 ssl->info_callback = cb;
3677 * One compiler (Diab DCC) doesn't like argument names in returned function
3680 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3683 return ssl->info_callback;
3686 void SSL_set_verify_result(SSL *ssl, long arg)
3688 ssl->verify_result = arg;
3691 long SSL_get_verify_result(const SSL *ssl)
3693 return (ssl->verify_result);
3696 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3699 return sizeof(ssl->s3->client_random);
3700 if (outlen > sizeof(ssl->s3->client_random))
3701 outlen = sizeof(ssl->s3->client_random);
3702 memcpy(out, ssl->s3->client_random, outlen);
3706 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3709 return sizeof(ssl->s3->server_random);
3710 if (outlen > sizeof(ssl->s3->server_random))
3711 outlen = sizeof(ssl->s3->server_random);
3712 memcpy(out, ssl->s3->server_random, outlen);
3716 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3717 unsigned char *out, size_t outlen)
3720 return session->master_key_length;
3721 if (outlen > session->master_key_length)
3722 outlen = session->master_key_length;
3723 memcpy(out, session->master_key, outlen);
3727 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3729 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3732 void *SSL_get_ex_data(const SSL *s, int idx)
3734 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3737 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3739 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3742 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3744 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3747 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3749 return (ctx->cert_store);
3752 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3754 X509_STORE_free(ctx->cert_store);
3755 ctx->cert_store = store;
3758 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3761 X509_STORE_up_ref(store);
3762 SSL_CTX_set_cert_store(ctx, store);
3765 int SSL_want(const SSL *s)
3767 return (s->rwstate);
3771 * \brief Set the callback for generating temporary DH keys.
3772 * \param ctx the SSL context.
3773 * \param dh the callback
3776 #ifndef OPENSSL_NO_DH
3777 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3778 DH *(*dh) (SSL *ssl, int is_export,
3781 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3784 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3787 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3791 #ifndef OPENSSL_NO_PSK
3792 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3794 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3795 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3798 OPENSSL_free(ctx->cert->psk_identity_hint);
3799 if (identity_hint != NULL) {
3800 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3801 if (ctx->cert->psk_identity_hint == NULL)
3804 ctx->cert->psk_identity_hint = NULL;
3808 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3813 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3814 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3817 OPENSSL_free(s->cert->psk_identity_hint);
3818 if (identity_hint != NULL) {
3819 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3820 if (s->cert->psk_identity_hint == NULL)
3823 s->cert->psk_identity_hint = NULL;
3827 const char *SSL_get_psk_identity_hint(const SSL *s)
3829 if (s == NULL || s->session == NULL)
3831 return (s->session->psk_identity_hint);
3834 const char *SSL_get_psk_identity(const SSL *s)
3836 if (s == NULL || s->session == NULL)
3838 return (s->session->psk_identity);
3841 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3843 s->psk_client_callback = cb;
3846 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3848 ctx->psk_client_callback = cb;
3851 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3853 s->psk_server_callback = cb;
3856 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3858 ctx->psk_server_callback = cb;
3862 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3863 void (*cb) (int write_p, int version,
3864 int content_type, const void *buf,
3865 size_t len, SSL *ssl, void *arg))
3867 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3870 void SSL_set_msg_callback(SSL *ssl,
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_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3878 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3879 int (*cb) (SSL *ssl,
3883 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3884 (void (*)(void))cb);
3887 void SSL_set_not_resumable_session_callback(SSL *ssl,
3888 int (*cb) (SSL *ssl,
3889 int is_forward_secure))
3891 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3892 (void (*)(void))cb);
3895 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
3896 size_t (*cb) (SSL *ssl, int type,
3897 size_t len, void *arg))
3899 ctx->record_padding_cb = cb;
3902 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
3904 ctx->record_padding_arg = arg;
3907 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
3909 return ctx->record_padding_arg;
3912 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
3914 /* block size of 0 or 1 is basically no padding */
3915 if (block_size == 1)
3916 ctx->block_padding = 0;
3917 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
3918 ctx->block_padding = block_size;
3924 void SSL_set_record_padding_callback(SSL *ssl,
3925 size_t (*cb) (SSL *ssl, int type,
3926 size_t len, void *arg))
3928 ssl->record_padding_cb = cb;
3931 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
3933 ssl->record_padding_arg = arg;
3936 void *SSL_get_record_padding_callback_arg(SSL *ssl)
3938 return ssl->record_padding_arg;
3941 int SSL_set_block_padding(SSL *ssl, size_t block_size)
3943 /* block size of 0 or 1 is basically no padding */
3944 if (block_size == 1)
3945 ssl->block_padding = 0;
3946 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
3947 ssl->block_padding = block_size;
3954 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3955 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3956 * If EVP_MD pointer is passed, initializes ctx with this |md|.
3957 * Returns the newly allocated ctx;
3960 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3962 ssl_clear_hash_ctx(hash);
3963 *hash = EVP_MD_CTX_new();
3964 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3965 EVP_MD_CTX_free(*hash);
3972 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3975 EVP_MD_CTX_free(*hash);
3979 /* Retrieve handshake hashes */
3980 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3983 EVP_MD_CTX *ctx = NULL;
3984 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3985 int hashleni = EVP_MD_CTX_size(hdgst);
3988 if (hashleni < 0 || (size_t)hashleni > outlen)
3991 ctx = EVP_MD_CTX_new();
3995 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3996 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3999 *hashlen = hashleni;
4003 EVP_MD_CTX_free(ctx);
4007 int SSL_session_reused(SSL *s)
4012 int SSL_is_server(SSL *s)
4017 #if OPENSSL_API_COMPAT < 0x10100000L
4018 void SSL_set_debug(SSL *s, int debug)
4020 /* Old function was do-nothing anyway... */
4026 void SSL_set_security_level(SSL *s, int level)
4028 s->cert->sec_level = level;
4031 int SSL_get_security_level(const SSL *s)
4033 return s->cert->sec_level;
4036 void SSL_set_security_callback(SSL *s,
4037 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4038 int op, int bits, int nid,
4039 void *other, void *ex))
4041 s->cert->sec_cb = cb;
4044 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4045 const SSL_CTX *ctx, int op,
4046 int bits, int nid, void *other,
4048 return s->cert->sec_cb;
4051 void SSL_set0_security_ex_data(SSL *s, void *ex)
4053 s->cert->sec_ex = ex;
4056 void *SSL_get0_security_ex_data(const SSL *s)
4058 return s->cert->sec_ex;
4061 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4063 ctx->cert->sec_level = level;
4066 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4068 return ctx->cert->sec_level;
4071 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4072 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4073 int op, int bits, int nid,
4074 void *other, void *ex))
4076 ctx->cert->sec_cb = cb;
4079 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4085 return ctx->cert->sec_cb;
4088 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4090 ctx->cert->sec_ex = ex;
4093 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4095 return ctx->cert->sec_ex;
4099 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4100 * can return unsigned long, instead of the generic long return value from the
4101 * control interface.
4103 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4105 return ctx->options;
4108 unsigned long SSL_get_options(const SSL *s)
4113 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4115 return ctx->options |= op;
4118 unsigned long SSL_set_options(SSL *s, unsigned long op)
4120 return s->options |= op;
4123 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4125 return ctx->options &= ~op;
4128 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4130 return s->options &= ~op;
4133 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4135 return s->verified_chain;
4138 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4140 #ifndef OPENSSL_NO_CT
4143 * Moves SCTs from the |src| stack to the |dst| stack.
4144 * The source of each SCT will be set to |origin|.
4145 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4147 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4149 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4150 sct_source_t origin)
4156 *dst = sk_SCT_new_null();
4158 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4163 while ((sct = sk_SCT_pop(src)) != NULL) {
4164 if (SCT_set_source(sct, origin) != 1)
4167 if (sk_SCT_push(*dst, sct) <= 0)
4175 sk_SCT_push(src, sct); /* Put the SCT back */
4180 * Look for data collected during ServerHello and parse if found.
4181 * Returns the number of SCTs extracted.
4183 static int ct_extract_tls_extension_scts(SSL *s)
4185 int scts_extracted = 0;
4187 if (s->ext.scts != NULL) {
4188 const unsigned char *p = s->ext.scts;
4189 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4191 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4193 SCT_LIST_free(scts);
4196 return scts_extracted;
4200 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4201 * contains an SCT X509 extension. They will be stored in |s->scts|.
4203 * - The number of SCTs extracted, assuming an OCSP response exists.
4204 * - 0 if no OCSP response exists or it contains no SCTs.
4205 * - A negative integer if an error occurs.
4207 static int ct_extract_ocsp_response_scts(SSL *s)
4209 # ifndef OPENSSL_NO_OCSP
4210 int scts_extracted = 0;
4211 const unsigned char *p;
4212 OCSP_BASICRESP *br = NULL;
4213 OCSP_RESPONSE *rsp = NULL;
4214 STACK_OF(SCT) *scts = NULL;
4217 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4220 p = s->ext.ocsp.resp;
4221 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4225 br = OCSP_response_get1_basic(rsp);
4229 for (i = 0; i < OCSP_resp_count(br); ++i) {
4230 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4236 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4238 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4239 if (scts_extracted < 0)
4243 SCT_LIST_free(scts);
4244 OCSP_BASICRESP_free(br);
4245 OCSP_RESPONSE_free(rsp);
4246 return scts_extracted;
4248 /* Behave as if no OCSP response exists */
4254 * Attempts to extract SCTs from the peer certificate.
4255 * Return the number of SCTs extracted, or a negative integer if an error
4258 static int ct_extract_x509v3_extension_scts(SSL *s)
4260 int scts_extracted = 0;
4261 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4264 STACK_OF(SCT) *scts =
4265 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4268 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4270 SCT_LIST_free(scts);
4273 return scts_extracted;
4277 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4278 * response (if it exists) and X509v3 extensions in the certificate.
4279 * Returns NULL if an error occurs.
4281 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4283 if (!s->scts_parsed) {
4284 if (ct_extract_tls_extension_scts(s) < 0 ||
4285 ct_extract_ocsp_response_scts(s) < 0 ||
4286 ct_extract_x509v3_extension_scts(s) < 0)
4296 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4297 const STACK_OF(SCT) *scts, void *unused_arg)
4302 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4303 const STACK_OF(SCT) *scts, void *unused_arg)
4305 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4308 for (i = 0; i < count; ++i) {
4309 SCT *sct = sk_SCT_value(scts, i);
4310 int status = SCT_get_validation_status(sct);
4312 if (status == SCT_VALIDATION_STATUS_VALID)
4315 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4319 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4323 * Since code exists that uses the custom extension handler for CT, look
4324 * for this and throw an error if they have already registered to use CT.
4326 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4327 TLSEXT_TYPE_signed_certificate_timestamp))
4329 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4330 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4334 if (callback != NULL) {
4336 * If we are validating CT, then we MUST accept SCTs served via OCSP
4338 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4342 s->ct_validation_callback = callback;
4343 s->ct_validation_callback_arg = arg;
4348 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4349 ssl_ct_validation_cb callback, void *arg)
4352 * Since code exists that uses the custom extension handler for CT, look for
4353 * this and throw an error if they have already registered to use CT.
4355 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4356 TLSEXT_TYPE_signed_certificate_timestamp))
4358 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4359 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4363 ctx->ct_validation_callback = callback;
4364 ctx->ct_validation_callback_arg = arg;
4368 int SSL_ct_is_enabled(const SSL *s)
4370 return s->ct_validation_callback != NULL;
4373 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4375 return ctx->ct_validation_callback != NULL;
4378 int ssl_validate_ct(SSL *s)
4381 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4383 SSL_DANE *dane = &s->dane;
4384 CT_POLICY_EVAL_CTX *ctx = NULL;
4385 const STACK_OF(SCT) *scts;
4388 * If no callback is set, the peer is anonymous, or its chain is invalid,
4389 * skip SCT validation - just return success. Applications that continue
4390 * handshakes without certificates, with unverified chains, or pinned leaf
4391 * certificates are outside the scope of the WebPKI and CT.
4393 * The above exclusions notwithstanding the vast majority of peers will
4394 * have rather ordinary certificate chains validated by typical
4395 * applications that perform certificate verification and therefore will
4396 * process SCTs when enabled.
4398 if (s->ct_validation_callback == NULL || cert == NULL ||
4399 s->verify_result != X509_V_OK ||
4400 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4404 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4405 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4407 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4408 switch (dane->mtlsa->usage) {
4409 case DANETLS_USAGE_DANE_TA:
4410 case DANETLS_USAGE_DANE_EE:
4415 ctx = CT_POLICY_EVAL_CTX_new();
4417 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4421 issuer = sk_X509_value(s->verified_chain, 1);
4422 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4423 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4424 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4425 CT_POLICY_EVAL_CTX_set_time(
4426 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4428 scts = SSL_get0_peer_scts(s);
4431 * This function returns success (> 0) only when all the SCTs are valid, 0
4432 * when some are invalid, and < 0 on various internal errors (out of
4433 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4434 * reason to abort the handshake, that decision is up to the callback.
4435 * Therefore, we error out only in the unexpected case that the return
4436 * value is negative.
4438 * XXX: One might well argue that the return value of this function is an
4439 * unfortunate design choice. Its job is only to determine the validation
4440 * status of each of the provided SCTs. So long as it correctly separates
4441 * the wheat from the chaff it should return success. Failure in this case
4442 * ought to correspond to an inability to carry out its duties.
4444 if (SCT_LIST_validate(scts, ctx) < 0) {
4445 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4449 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4451 ret = 0; /* This function returns 0 on failure */
4454 CT_POLICY_EVAL_CTX_free(ctx);
4456 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4457 * failure return code here. Also the application may wish the complete
4458 * the handshake, and then disconnect cleanly at a higher layer, after
4459 * checking the verification status of the completed connection.
4461 * We therefore force a certificate verification failure which will be
4462 * visible via SSL_get_verify_result() and cached as part of any resumed
4465 * Note: the permissive callback is for information gathering only, always
4466 * returns success, and does not affect verification status. Only the
4467 * strict callback or a custom application-specified callback can trigger
4468 * connection failure or record a verification error.
4471 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4475 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4477 switch (validation_mode) {
4479 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4481 case SSL_CT_VALIDATION_PERMISSIVE:
4482 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4483 case SSL_CT_VALIDATION_STRICT:
4484 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4488 int SSL_enable_ct(SSL *s, int validation_mode)
4490 switch (validation_mode) {
4492 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4494 case SSL_CT_VALIDATION_PERMISSIVE:
4495 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4496 case SSL_CT_VALIDATION_STRICT:
4497 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4501 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4503 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4506 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4508 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4511 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4513 CTLOG_STORE_free(ctx->ctlog_store);
4514 ctx->ctlog_store = logs;
4517 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4519 return ctx->ctlog_store;
4522 #endif /* OPENSSL_NO_CT */
4524 void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn cb, void *arg)
4527 c->early_cb_arg = arg;
4530 int SSL_early_isv2(SSL *s)
4532 if (s->clienthello == NULL)
4534 return s->clienthello->isv2;
4537 unsigned int SSL_early_get0_legacy_version(SSL *s)
4539 if (s->clienthello == NULL)
4541 return s->clienthello->legacy_version;
4544 size_t SSL_early_get0_random(SSL *s, const unsigned char **out)
4546 if (s->clienthello == NULL)
4549 *out = s->clienthello->random;
4550 return SSL3_RANDOM_SIZE;
4553 size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out)
4555 if (s->clienthello == NULL)
4558 *out = s->clienthello->session_id;
4559 return s->clienthello->session_id_len;
4562 size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out)
4564 if (s->clienthello == NULL)
4567 *out = PACKET_data(&s->clienthello->ciphersuites);
4568 return PACKET_remaining(&s->clienthello->ciphersuites);
4571 size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out)
4573 if (s->clienthello == NULL)
4576 *out = s->clienthello->compressions;
4577 return s->clienthello->compressions_len;
4580 int SSL_early_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4586 if (s->clienthello == NULL)
4588 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4589 r = s->clienthello->pre_proc_exts + i;
4590 if (r->present && r->type == type) {
4592 *out = PACKET_data(&r->data);
4594 *outlen = PACKET_remaining(&r->data);
4601 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4603 ctx->keylog_callback = cb;
4606 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4608 return ctx->keylog_callback;
4611 static int nss_keylog_int(const char *prefix,
4613 const uint8_t *parameter_1,
4614 size_t parameter_1_len,
4615 const uint8_t *parameter_2,
4616 size_t parameter_2_len)
4619 char *cursor = NULL;
4624 if (ssl->ctx->keylog_callback == NULL) return 1;
4627 * Our output buffer will contain the following strings, rendered with
4628 * space characters in between, terminated by a NULL character: first the
4629 * prefix, then the first parameter, then the second parameter. The
4630 * meaning of each parameter depends on the specific key material being
4631 * logged. Note that the first and second parameters are encoded in
4632 * hexadecimal, so we need a buffer that is twice their lengths.
4634 prefix_len = strlen(prefix);
4635 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4636 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4637 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4641 strcpy(cursor, prefix);
4642 cursor += prefix_len;
4645 for (i = 0; i < parameter_1_len; i++) {
4646 sprintf(cursor, "%02x", parameter_1[i]);
4651 for (i = 0; i < parameter_2_len; i++) {
4652 sprintf(cursor, "%02x", parameter_2[i]);
4657 ssl->ctx->keylog_callback(ssl, (const char *)out);
4663 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4664 const uint8_t *encrypted_premaster,
4665 size_t encrypted_premaster_len,
4666 const uint8_t *premaster,
4667 size_t premaster_len)
4669 if (encrypted_premaster_len < 8) {
4670 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4674 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4675 return nss_keylog_int("RSA",
4677 encrypted_premaster,
4683 int ssl_log_secret(SSL *ssl,
4685 const uint8_t *secret,
4688 return nss_keylog_int(label,
4690 ssl->s3->client_random,
4696 #define SSLV2_CIPHER_LEN 3
4698 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format,
4703 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4705 if (PACKET_remaining(cipher_suites) == 0) {
4706 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST, SSL_R_NO_CIPHERS_SPECIFIED);
4707 *al = SSL_AD_ILLEGAL_PARAMETER;
4711 if (PACKET_remaining(cipher_suites) % n != 0) {
4712 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST,
4713 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4714 *al = SSL_AD_DECODE_ERROR;
4718 OPENSSL_free(s->s3->tmp.ciphers_raw);
4719 s->s3->tmp.ciphers_raw = NULL;
4720 s->s3->tmp.ciphers_rawlen = 0;
4723 size_t numciphers = PACKET_remaining(cipher_suites) / n;
4724 PACKET sslv2ciphers = *cipher_suites;
4725 unsigned int leadbyte;
4729 * We store the raw ciphers list in SSLv3+ format so we need to do some
4730 * preprocessing to convert the list first. If there are any SSLv2 only
4731 * ciphersuites with a non-zero leading byte then we are going to
4732 * slightly over allocate because we won't store those. But that isn't a
4735 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
4736 s->s3->tmp.ciphers_raw = raw;
4738 *al = SSL_AD_INTERNAL_ERROR;
4741 for (s->s3->tmp.ciphers_rawlen = 0;
4742 PACKET_remaining(&sslv2ciphers) > 0;
4743 raw += TLS_CIPHER_LEN) {
4744 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
4746 && !PACKET_copy_bytes(&sslv2ciphers, raw,
4749 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
4750 *al = SSL_AD_INTERNAL_ERROR;
4751 OPENSSL_free(s->s3->tmp.ciphers_raw);
4752 s->s3->tmp.ciphers_raw = NULL;
4753 s->s3->tmp.ciphers_rawlen = 0;
4757 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
4759 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
4760 &s->s3->tmp.ciphers_rawlen)) {
4761 *al = SSL_AD_INTERNAL_ERROR;
4769 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
4770 int isv2format, STACK_OF(SSL_CIPHER) **sk,
4771 STACK_OF(SSL_CIPHER) **scsvs)
4776 if (!PACKET_buf_init(&pkt, bytes, len))
4778 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, &alert);
4781 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
4782 STACK_OF(SSL_CIPHER) **skp,
4783 STACK_OF(SSL_CIPHER) **scsvs_out,
4784 int sslv2format, int *al)
4786 const SSL_CIPHER *c;
4787 STACK_OF(SSL_CIPHER) *sk = NULL;
4788 STACK_OF(SSL_CIPHER) *scsvs = NULL;
4790 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
4791 unsigned char cipher[SSLV2_CIPHER_LEN];
4793 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4795 if (PACKET_remaining(cipher_suites) == 0) {
4796 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
4797 *al = SSL_AD_ILLEGAL_PARAMETER;
4801 if (PACKET_remaining(cipher_suites) % n != 0) {
4802 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
4803 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4804 *al = SSL_AD_DECODE_ERROR;
4808 sk = sk_SSL_CIPHER_new_null();
4809 scsvs = sk_SSL_CIPHER_new_null();
4810 if (sk == NULL || scsvs == NULL) {
4811 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4812 *al = SSL_AD_INTERNAL_ERROR;
4816 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
4818 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
4819 * first byte set to zero, while true SSLv2 ciphers have a non-zero
4820 * first byte. We don't support any true SSLv2 ciphers, so skip them.
4822 if (sslv2format && cipher[0] != '\0')
4825 /* For SSLv2-compat, ignore leading 0-byte. */
4826 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
4828 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
4829 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
4830 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4831 *al = SSL_AD_INTERNAL_ERROR;
4836 if (PACKET_remaining(cipher_suites) > 0) {
4837 *al = SSL_AD_INTERNAL_ERROR;
4838 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_INTERNAL_ERROR);
4845 sk_SSL_CIPHER_free(sk);
4846 if (scsvs_out != NULL)
4849 sk_SSL_CIPHER_free(scsvs);
4852 sk_SSL_CIPHER_free(sk);
4853 sk_SSL_CIPHER_free(scsvs);
4857 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
4859 ctx->max_early_data = max_early_data;
4864 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
4866 return ctx->max_early_data;
4869 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
4871 s->max_early_data = max_early_data;
4876 uint32_t SSL_get_max_early_data(const SSL *s)
4878 return s->max_early_data;