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
44 #include <openssl/objects.h>
45 #include <openssl/lhash.h>
46 #include <openssl/x509v3.h>
47 #include <openssl/rand.h>
48 #include <openssl/ocsp.h>
49 #include <openssl/dh.h>
50 #include <openssl/engine.h>
51 #include <openssl/async.h>
52 #include <openssl/ct.h>
54 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
56 SSL3_ENC_METHOD ssl3_undef_enc_method = {
58 * evil casts, but these functions are only called if there's a library
61 (int (*)(SSL *, SSL3_RECORD *, size_t, int))ssl_undefined_function,
62 (int (*)(SSL *, SSL3_RECORD *, unsigned char *, int))ssl_undefined_function,
63 ssl_undefined_function,
64 (int (*)(SSL *, unsigned char *, unsigned char *, size_t, size_t *))
65 ssl_undefined_function,
66 (int (*)(SSL *, int))ssl_undefined_function,
67 (size_t (*)(SSL *, const char *, size_t, unsigned char *))
68 ssl_undefined_function,
69 NULL, /* client_finished_label */
70 0, /* client_finished_label_len */
71 NULL, /* server_finished_label */
72 0, /* server_finished_label_len */
73 (int (*)(int))ssl_undefined_function,
74 (int (*)(SSL *, unsigned char *, size_t, const char *,
75 size_t, const unsigned char *, size_t,
76 int use_context))ssl_undefined_function,
79 struct ssl_async_args {
83 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
85 int (*func_read) (SSL *, void *, size_t, size_t *);
86 int (*func_write) (SSL *, const void *, size_t, size_t *);
87 int (*func_other) (SSL *);
97 DANETLS_MATCHING_FULL, 0, NID_undef
100 DANETLS_MATCHING_2256, 1, NID_sha256
103 DANETLS_MATCHING_2512, 2, NID_sha512
107 static int dane_ctx_enable(struct dane_ctx_st *dctx)
109 const EVP_MD **mdevp;
111 uint8_t mdmax = DANETLS_MATCHING_LAST;
112 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
115 if (dctx->mdevp != NULL)
118 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
119 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
121 if (mdord == NULL || mdevp == NULL) {
124 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
128 /* Install default entries */
129 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
132 if (dane_mds[i].nid == NID_undef ||
133 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
135 mdevp[dane_mds[i].mtype] = md;
136 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
146 static void dane_ctx_final(struct dane_ctx_st *dctx)
148 OPENSSL_free(dctx->mdevp);
151 OPENSSL_free(dctx->mdord);
156 static void tlsa_free(danetls_record *t)
160 OPENSSL_free(t->data);
161 EVP_PKEY_free(t->spki);
165 static void dane_final(SSL_DANE *dane)
167 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
170 sk_X509_pop_free(dane->certs, X509_free);
173 X509_free(dane->mcert);
181 * dane_copy - Copy dane configuration, sans verification state.
183 static int ssl_dane_dup(SSL *to, SSL *from)
188 if (!DANETLS_ENABLED(&from->dane))
191 dane_final(&to->dane);
192 to->dane.flags = from->dane.flags;
193 to->dane.dctx = &to->ctx->dane;
194 to->dane.trecs = sk_danetls_record_new_null();
196 if (to->dane.trecs == NULL) {
197 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
201 num = sk_danetls_record_num(from->dane.trecs);
202 for (i = 0; i < num; ++i) {
203 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
205 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
206 t->data, t->dlen) <= 0)
212 static int dane_mtype_set(struct dane_ctx_st *dctx,
213 const EVP_MD *md, uint8_t mtype, uint8_t ord)
217 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
218 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
222 if (mtype > dctx->mdmax) {
223 const EVP_MD **mdevp;
225 int n = ((int)mtype) + 1;
227 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
229 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
234 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
236 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
241 /* Zero-fill any gaps */
242 for (i = dctx->mdmax + 1; i < mtype; ++i) {
250 dctx->mdevp[mtype] = md;
251 /* Coerce ordinal of disabled matching types to 0 */
252 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
257 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
259 if (mtype > dane->dctx->mdmax)
261 return dane->dctx->mdevp[mtype];
264 static int dane_tlsa_add(SSL_DANE *dane,
267 uint8_t mtype, unsigned char *data, size_t dlen)
270 const EVP_MD *md = NULL;
271 int ilen = (int)dlen;
275 if (dane->trecs == NULL) {
276 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
280 if (ilen < 0 || dlen != (size_t)ilen) {
281 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
285 if (usage > DANETLS_USAGE_LAST) {
286 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
290 if (selector > DANETLS_SELECTOR_LAST) {
291 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
295 if (mtype != DANETLS_MATCHING_FULL) {
296 md = tlsa_md_get(dane, mtype);
298 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
303 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
304 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
308 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
312 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
313 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
318 t->selector = selector;
320 t->data = OPENSSL_malloc(dlen);
321 if (t->data == NULL) {
323 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
326 memcpy(t->data, data, dlen);
329 /* Validate and cache full certificate or public key */
330 if (mtype == DANETLS_MATCHING_FULL) {
331 const unsigned char *p = data;
333 EVP_PKEY *pkey = NULL;
336 case DANETLS_SELECTOR_CERT:
337 if (!d2i_X509(&cert, &p, ilen) || p < data ||
338 dlen != (size_t)(p - data)) {
340 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
343 if (X509_get0_pubkey(cert) == NULL) {
345 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
349 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
355 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
356 * records that contain full certificates of trust-anchors that are
357 * not present in the wire chain. For usage PKIX-TA(0), we augment
358 * the chain with untrusted Full(0) certificates from DNS, in case
359 * they are missing from the chain.
361 if ((dane->certs == NULL &&
362 (dane->certs = sk_X509_new_null()) == NULL) ||
363 !sk_X509_push(dane->certs, cert)) {
364 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
371 case DANETLS_SELECTOR_SPKI:
372 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
373 dlen != (size_t)(p - data)) {
375 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
380 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
381 * records that contain full bare keys of trust-anchors that are
382 * not present in the wire chain.
384 if (usage == DANETLS_USAGE_DANE_TA)
393 * Find the right insertion point for the new record.
395 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
396 * they can be processed first, as they require no chain building, and no
397 * expiration or hostname checks. Because DANE-EE(3) is numerically
398 * largest, this is accomplished via descending sort by "usage".
400 * We also sort in descending order by matching ordinal to simplify
401 * the implementation of digest agility in the verification code.
403 * The choice of order for the selector is not significant, so we
404 * use the same descending order for consistency.
406 num = sk_danetls_record_num(dane->trecs);
407 for (i = 0; i < num; ++i) {
408 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
410 if (rec->usage > usage)
412 if (rec->usage < usage)
414 if (rec->selector > selector)
416 if (rec->selector < selector)
418 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
423 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
425 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
428 dane->umask |= DANETLS_USAGE_BIT(usage);
433 static void clear_ciphers(SSL *s)
435 /* clear the current cipher */
436 ssl_clear_cipher_ctx(s);
437 ssl_clear_hash_ctx(&s->read_hash);
438 ssl_clear_hash_ctx(&s->write_hash);
441 int SSL_clear(SSL *s)
443 if (s->method == NULL) {
444 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
448 if (ssl_clear_bad_session(s)) {
449 SSL_SESSION_free(s->session);
457 if (s->renegotiate) {
458 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
462 ossl_statem_clear(s);
464 s->version = s->method->version;
465 s->client_version = s->version;
466 s->rwstate = SSL_NOTHING;
468 BUF_MEM_free(s->init_buf);
473 s->key_update = SSL_KEY_UPDATE_NONE;
475 /* Reset DANE verification result state */
478 X509_free(s->dane.mcert);
479 s->dane.mcert = NULL;
480 s->dane.mtlsa = NULL;
482 /* Clear the verification result peername */
483 X509_VERIFY_PARAM_move_peername(s->param, NULL);
486 * Check to see if we were changed into a different method, if so, revert
487 * back if we are not doing session-id reuse.
489 if (!ossl_statem_get_in_handshake(s) && (s->session == NULL)
490 && (s->method != s->ctx->method)) {
491 s->method->ssl_free(s);
492 s->method = s->ctx->method;
493 if (!s->method->ssl_new(s))
496 if (!s->method->ssl_clear(s))
500 RECORD_LAYER_clear(&s->rlayer);
505 /** Used to change an SSL_CTXs default SSL method type */
506 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
508 STACK_OF(SSL_CIPHER) *sk;
512 sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
513 &(ctx->cipher_list_by_id),
514 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
515 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
516 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
522 SSL *SSL_new(SSL_CTX *ctx)
527 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
530 if (ctx->method == NULL) {
531 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
535 s = OPENSSL_zalloc(sizeof(*s));
539 s->lock = CRYPTO_THREAD_lock_new();
540 if (s->lock == NULL) {
541 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
546 RECORD_LAYER_init(&s->rlayer, s);
548 s->options = ctx->options;
549 s->dane.flags = ctx->dane.flags;
550 s->min_proto_version = ctx->min_proto_version;
551 s->max_proto_version = ctx->max_proto_version;
553 s->max_cert_list = ctx->max_cert_list;
555 s->max_early_data = ctx->max_early_data;
558 * Earlier library versions used to copy the pointer to the CERT, not
559 * its contents; only when setting new parameters for the per-SSL
560 * copy, ssl_cert_new would be called (and the direct reference to
561 * the per-SSL_CTX settings would be lost, but those still were
562 * indirectly accessed for various purposes, and for that reason they
563 * used to be known as s->ctx->default_cert). Now we don't look at the
564 * SSL_CTX's CERT after having duplicated it once.
566 s->cert = ssl_cert_dup(ctx->cert);
570 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
571 s->msg_callback = ctx->msg_callback;
572 s->msg_callback_arg = ctx->msg_callback_arg;
573 s->verify_mode = ctx->verify_mode;
574 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
575 s->record_padding_cb = ctx->record_padding_cb;
576 s->record_padding_arg = ctx->record_padding_arg;
577 s->block_padding = ctx->block_padding;
578 s->sid_ctx_length = ctx->sid_ctx_length;
579 if (!ossl_assert(s->sid_ctx_length <= sizeof s->sid_ctx))
581 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
582 s->verify_callback = ctx->default_verify_callback;
583 s->generate_session_id = ctx->generate_session_id;
585 s->param = X509_VERIFY_PARAM_new();
586 if (s->param == NULL)
588 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
589 s->quiet_shutdown = ctx->quiet_shutdown;
590 s->max_send_fragment = ctx->max_send_fragment;
591 s->split_send_fragment = ctx->split_send_fragment;
592 s->max_pipelines = ctx->max_pipelines;
593 if (s->max_pipelines > 1)
594 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
595 if (ctx->default_read_buf_len > 0)
596 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
601 s->ext.debug_arg = NULL;
602 s->ext.ticket_expected = 0;
603 s->ext.status_type = ctx->ext.status_type;
604 s->ext.status_expected = 0;
605 s->ext.ocsp.ids = NULL;
606 s->ext.ocsp.exts = NULL;
607 s->ext.ocsp.resp = NULL;
608 s->ext.ocsp.resp_len = 0;
610 s->session_ctx = ctx;
611 #ifndef OPENSSL_NO_EC
612 if (ctx->ext.ecpointformats) {
613 s->ext.ecpointformats =
614 OPENSSL_memdup(ctx->ext.ecpointformats,
615 ctx->ext.ecpointformats_len);
616 if (!s->ext.ecpointformats)
618 s->ext.ecpointformats_len =
619 ctx->ext.ecpointformats_len;
621 if (ctx->ext.supportedgroups) {
622 s->ext.supportedgroups =
623 OPENSSL_memdup(ctx->ext.supportedgroups,
624 ctx->ext.supportedgroups_len);
625 if (!s->ext.supportedgroups)
627 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
630 #ifndef OPENSSL_NO_NEXTPROTONEG
634 if (s->ctx->ext.alpn) {
635 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
636 if (s->ext.alpn == NULL)
638 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
639 s->ext.alpn_len = s->ctx->ext.alpn_len;
642 s->verified_chain = NULL;
643 s->verify_result = X509_V_OK;
645 s->default_passwd_callback = ctx->default_passwd_callback;
646 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
648 s->method = ctx->method;
650 s->key_update = SSL_KEY_UPDATE_NONE;
652 if (!s->method->ssl_new(s))
655 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
660 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
663 #ifndef OPENSSL_NO_PSK
664 s->psk_client_callback = ctx->psk_client_callback;
665 s->psk_server_callback = ctx->psk_server_callback;
670 #ifndef OPENSSL_NO_CT
671 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
672 ctx->ct_validation_callback_arg))
679 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
683 int SSL_is_dtls(const SSL *s)
685 return SSL_IS_DTLS(s) ? 1 : 0;
688 int SSL_up_ref(SSL *s)
692 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
695 REF_PRINT_COUNT("SSL", s);
696 REF_ASSERT_ISNT(i < 2);
697 return ((i > 1) ? 1 : 0);
700 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
701 unsigned int sid_ctx_len)
703 if (sid_ctx_len > sizeof ctx->sid_ctx) {
704 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
705 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
708 ctx->sid_ctx_length = sid_ctx_len;
709 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
714 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
715 unsigned int sid_ctx_len)
717 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
718 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
719 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
722 ssl->sid_ctx_length = sid_ctx_len;
723 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
728 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
730 CRYPTO_THREAD_write_lock(ctx->lock);
731 ctx->generate_session_id = cb;
732 CRYPTO_THREAD_unlock(ctx->lock);
736 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
738 CRYPTO_THREAD_write_lock(ssl->lock);
739 ssl->generate_session_id = cb;
740 CRYPTO_THREAD_unlock(ssl->lock);
744 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
748 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
749 * we can "construct" a session to give us the desired check - i.e. to
750 * find if there's a session in the hash table that would conflict with
751 * any new session built out of this id/id_len and the ssl_version in use
756 if (id_len > sizeof r.session_id)
759 r.ssl_version = ssl->version;
760 r.session_id_length = id_len;
761 memcpy(r.session_id, id, id_len);
763 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
764 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
765 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
769 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
771 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
774 int SSL_set_purpose(SSL *s, int purpose)
776 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
779 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
781 return X509_VERIFY_PARAM_set_trust(s->param, trust);
784 int SSL_set_trust(SSL *s, int trust)
786 return X509_VERIFY_PARAM_set_trust(s->param, trust);
789 int SSL_set1_host(SSL *s, const char *hostname)
791 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
794 int SSL_add1_host(SSL *s, const char *hostname)
796 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
799 void SSL_set_hostflags(SSL *s, unsigned int flags)
801 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
804 const char *SSL_get0_peername(SSL *s)
806 return X509_VERIFY_PARAM_get0_peername(s->param);
809 int SSL_CTX_dane_enable(SSL_CTX *ctx)
811 return dane_ctx_enable(&ctx->dane);
814 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
816 unsigned long orig = ctx->dane.flags;
818 ctx->dane.flags |= flags;
822 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
824 unsigned long orig = ctx->dane.flags;
826 ctx->dane.flags &= ~flags;
830 int SSL_dane_enable(SSL *s, const char *basedomain)
832 SSL_DANE *dane = &s->dane;
834 if (s->ctx->dane.mdmax == 0) {
835 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
838 if (dane->trecs != NULL) {
839 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
844 * Default SNI name. This rejects empty names, while set1_host below
845 * accepts them and disables host name checks. To avoid side-effects with
846 * invalid input, set the SNI name first.
848 if (s->ext.hostname == NULL) {
849 if (!SSL_set_tlsext_host_name(s, basedomain)) {
850 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
855 /* Primary RFC6125 reference identifier */
856 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
857 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
863 dane->dctx = &s->ctx->dane;
864 dane->trecs = sk_danetls_record_new_null();
866 if (dane->trecs == NULL) {
867 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
873 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
875 unsigned long orig = ssl->dane.flags;
877 ssl->dane.flags |= flags;
881 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
883 unsigned long orig = ssl->dane.flags;
885 ssl->dane.flags &= ~flags;
889 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
891 SSL_DANE *dane = &s->dane;
893 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
897 *mcert = dane->mcert;
899 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
904 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
905 uint8_t *mtype, unsigned const char **data, size_t *dlen)
907 SSL_DANE *dane = &s->dane;
909 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
913 *usage = dane->mtlsa->usage;
915 *selector = dane->mtlsa->selector;
917 *mtype = dane->mtlsa->mtype;
919 *data = dane->mtlsa->data;
921 *dlen = dane->mtlsa->dlen;
926 SSL_DANE *SSL_get0_dane(SSL *s)
931 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
932 uint8_t mtype, unsigned char *data, size_t dlen)
934 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
937 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
940 return dane_mtype_set(&ctx->dane, md, mtype, ord);
943 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
945 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
948 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
950 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
953 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
958 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
963 void SSL_certs_clear(SSL *s)
965 ssl_cert_clear_certs(s->cert);
968 void SSL_free(SSL *s)
975 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
976 REF_PRINT_COUNT("SSL", s);
979 REF_ASSERT_ISNT(i < 0);
981 X509_VERIFY_PARAM_free(s->param);
982 dane_final(&s->dane);
983 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
985 /* Ignore return value */
986 ssl_free_wbio_buffer(s);
988 BIO_free_all(s->wbio);
989 BIO_free_all(s->rbio);
991 BUF_MEM_free(s->init_buf);
993 /* add extra stuff */
994 sk_SSL_CIPHER_free(s->cipher_list);
995 sk_SSL_CIPHER_free(s->cipher_list_by_id);
997 /* Make the next call work :-) */
998 if (s->session != NULL) {
999 ssl_clear_bad_session(s);
1000 SSL_SESSION_free(s->session);
1005 ssl_cert_free(s->cert);
1006 /* Free up if allocated */
1008 OPENSSL_free(s->ext.hostname);
1009 SSL_CTX_free(s->session_ctx);
1010 #ifndef OPENSSL_NO_EC
1011 OPENSSL_free(s->ext.ecpointformats);
1012 OPENSSL_free(s->ext.supportedgroups);
1013 #endif /* OPENSSL_NO_EC */
1014 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1015 #ifndef OPENSSL_NO_OCSP
1016 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1018 #ifndef OPENSSL_NO_CT
1019 SCT_LIST_free(s->scts);
1020 OPENSSL_free(s->ext.scts);
1022 OPENSSL_free(s->ext.ocsp.resp);
1023 OPENSSL_free(s->ext.alpn);
1024 OPENSSL_free(s->ext.tls13_cookie);
1025 OPENSSL_free(s->clienthello);
1027 sk_X509_NAME_pop_free(s->ca_names, X509_NAME_free);
1029 sk_X509_pop_free(s->verified_chain, X509_free);
1031 if (s->method != NULL)
1032 s->method->ssl_free(s);
1034 RECORD_LAYER_release(&s->rlayer);
1036 SSL_CTX_free(s->ctx);
1038 ASYNC_WAIT_CTX_free(s->waitctx);
1040 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1041 OPENSSL_free(s->ext.npn);
1044 #ifndef OPENSSL_NO_SRTP
1045 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1048 CRYPTO_THREAD_lock_free(s->lock);
1053 void SSL_set0_rbio(SSL *s, BIO *rbio)
1055 BIO_free_all(s->rbio);
1059 void SSL_set0_wbio(SSL *s, BIO *wbio)
1062 * If the output buffering BIO is still in place, remove it
1064 if (s->bbio != NULL)
1065 s->wbio = BIO_pop(s->wbio);
1067 BIO_free_all(s->wbio);
1070 /* Re-attach |bbio| to the new |wbio|. */
1071 if (s->bbio != NULL)
1072 s->wbio = BIO_push(s->bbio, s->wbio);
1075 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1078 * For historical reasons, this function has many different cases in
1079 * ownership handling.
1082 /* If nothing has changed, do nothing */
1083 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1087 * If the two arguments are equal then one fewer reference is granted by the
1088 * caller than we want to take
1090 if (rbio != NULL && rbio == wbio)
1094 * If only the wbio is changed only adopt one reference.
1096 if (rbio == SSL_get_rbio(s)) {
1097 SSL_set0_wbio(s, wbio);
1101 * There is an asymmetry here for historical reasons. If only the rbio is
1102 * changed AND the rbio and wbio were originally different, then we only
1103 * adopt one reference.
1105 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1106 SSL_set0_rbio(s, rbio);
1110 /* Otherwise, adopt both references. */
1111 SSL_set0_rbio(s, rbio);
1112 SSL_set0_wbio(s, wbio);
1115 BIO *SSL_get_rbio(const SSL *s)
1120 BIO *SSL_get_wbio(const SSL *s)
1122 if (s->bbio != NULL) {
1124 * If |bbio| is active, the true caller-configured BIO is its
1127 return BIO_next(s->bbio);
1132 int SSL_get_fd(const SSL *s)
1134 return SSL_get_rfd(s);
1137 int SSL_get_rfd(const SSL *s)
1142 b = SSL_get_rbio(s);
1143 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1145 BIO_get_fd(r, &ret);
1149 int SSL_get_wfd(const SSL *s)
1154 b = SSL_get_wbio(s);
1155 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1157 BIO_get_fd(r, &ret);
1161 #ifndef OPENSSL_NO_SOCK
1162 int SSL_set_fd(SSL *s, int fd)
1167 bio = BIO_new(BIO_s_socket());
1170 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1173 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1174 SSL_set_bio(s, bio, bio);
1180 int SSL_set_wfd(SSL *s, int fd)
1182 BIO *rbio = SSL_get_rbio(s);
1184 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1185 || (int)BIO_get_fd(rbio, NULL) != fd) {
1186 BIO *bio = BIO_new(BIO_s_socket());
1189 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1192 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1193 SSL_set0_wbio(s, bio);
1196 SSL_set0_wbio(s, rbio);
1201 int SSL_set_rfd(SSL *s, int fd)
1203 BIO *wbio = SSL_get_wbio(s);
1205 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1206 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1207 BIO *bio = BIO_new(BIO_s_socket());
1210 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1213 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1214 SSL_set0_rbio(s, bio);
1217 SSL_set0_rbio(s, wbio);
1224 /* return length of latest Finished message we sent, copy to 'buf' */
1225 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1229 if (s->s3 != NULL) {
1230 ret = s->s3->tmp.finish_md_len;
1233 memcpy(buf, s->s3->tmp.finish_md, count);
1238 /* return length of latest Finished message we expected, copy to 'buf' */
1239 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1243 if (s->s3 != NULL) {
1244 ret = s->s3->tmp.peer_finish_md_len;
1247 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1252 int SSL_get_verify_mode(const SSL *s)
1254 return (s->verify_mode);
1257 int SSL_get_verify_depth(const SSL *s)
1259 return X509_VERIFY_PARAM_get_depth(s->param);
1262 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1263 return (s->verify_callback);
1266 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1268 return (ctx->verify_mode);
1271 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1273 return X509_VERIFY_PARAM_get_depth(ctx->param);
1276 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1277 return (ctx->default_verify_callback);
1280 void SSL_set_verify(SSL *s, int mode,
1281 int (*callback) (int ok, X509_STORE_CTX *ctx))
1283 s->verify_mode = mode;
1284 if (callback != NULL)
1285 s->verify_callback = callback;
1288 void SSL_set_verify_depth(SSL *s, int depth)
1290 X509_VERIFY_PARAM_set_depth(s->param, depth);
1293 void SSL_set_read_ahead(SSL *s, int yes)
1295 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1298 int SSL_get_read_ahead(const SSL *s)
1300 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1303 int SSL_pending(const SSL *s)
1305 size_t pending = s->method->ssl_pending(s);
1308 * SSL_pending cannot work properly if read-ahead is enabled
1309 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1310 * impossible to fix since SSL_pending cannot report errors that may be
1311 * observed while scanning the new data. (Note that SSL_pending() is
1312 * often used as a boolean value, so we'd better not return -1.)
1314 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1315 * we just return INT_MAX.
1317 return pending < INT_MAX ? (int)pending : INT_MAX;
1320 int SSL_has_pending(const SSL *s)
1323 * Similar to SSL_pending() but returns a 1 to indicate that we have
1324 * unprocessed data available or 0 otherwise (as opposed to the number of
1325 * bytes available). Unlike SSL_pending() this will take into account
1326 * read_ahead data. A 1 return simply indicates that we have unprocessed
1327 * data. That data may not result in any application data, or we may fail
1328 * to parse the records for some reason.
1330 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1333 return RECORD_LAYER_read_pending(&s->rlayer);
1336 X509 *SSL_get_peer_certificate(const SSL *s)
1340 if ((s == NULL) || (s->session == NULL))
1343 r = s->session->peer;
1353 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1357 if ((s == NULL) || (s->session == NULL))
1360 r = s->session->peer_chain;
1363 * If we are a client, cert_chain includes the peer's own certificate; if
1364 * we are a server, it does not.
1371 * Now in theory, since the calling process own 't' it should be safe to
1372 * modify. We need to be able to read f without being hassled
1374 int SSL_copy_session_id(SSL *t, const SSL *f)
1377 /* Do we need to to SSL locking? */
1378 if (!SSL_set_session(t, SSL_get_session(f))) {
1383 * what if we are setup for one protocol version but want to talk another
1385 if (t->method != f->method) {
1386 t->method->ssl_free(t);
1387 t->method = f->method;
1388 if (t->method->ssl_new(t) == 0)
1392 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1393 ssl_cert_free(t->cert);
1395 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1402 /* Fix this so it checks all the valid key/cert options */
1403 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1405 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1406 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1409 if (ctx->cert->key->privatekey == NULL) {
1410 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1413 return (X509_check_private_key
1414 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1417 /* Fix this function so that it takes an optional type parameter */
1418 int SSL_check_private_key(const SSL *ssl)
1421 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1424 if (ssl->cert->key->x509 == NULL) {
1425 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1428 if (ssl->cert->key->privatekey == NULL) {
1429 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1432 return (X509_check_private_key(ssl->cert->key->x509,
1433 ssl->cert->key->privatekey));
1436 int SSL_waiting_for_async(SSL *s)
1444 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1446 ASYNC_WAIT_CTX *ctx = s->waitctx;
1450 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1453 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1454 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1456 ASYNC_WAIT_CTX *ctx = s->waitctx;
1460 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1464 int SSL_accept(SSL *s)
1466 if (s->handshake_func == NULL) {
1467 /* Not properly initialized yet */
1468 SSL_set_accept_state(s);
1471 return SSL_do_handshake(s);
1474 int SSL_connect(SSL *s)
1476 if (s->handshake_func == NULL) {
1477 /* Not properly initialized yet */
1478 SSL_set_connect_state(s);
1481 return SSL_do_handshake(s);
1484 long SSL_get_default_timeout(const SSL *s)
1486 return (s->method->get_timeout());
1489 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1490 int (*func) (void *))
1493 if (s->waitctx == NULL) {
1494 s->waitctx = ASYNC_WAIT_CTX_new();
1495 if (s->waitctx == NULL)
1498 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1499 sizeof(struct ssl_async_args))) {
1501 s->rwstate = SSL_NOTHING;
1502 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1505 s->rwstate = SSL_ASYNC_PAUSED;
1508 s->rwstate = SSL_ASYNC_NO_JOBS;
1514 s->rwstate = SSL_NOTHING;
1515 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1516 /* Shouldn't happen */
1521 static int ssl_io_intern(void *vargs)
1523 struct ssl_async_args *args;
1528 args = (struct ssl_async_args *)vargs;
1532 switch (args->type) {
1534 return args->f.func_read(s, buf, num, &s->asyncrw);
1536 return args->f.func_write(s, buf, num, &s->asyncrw);
1538 return args->f.func_other(s);
1543 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1545 if (s->handshake_func == NULL) {
1546 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1550 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1551 s->rwstate = SSL_NOTHING;
1555 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1556 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1557 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1561 * If we are a client and haven't received the ServerHello etc then we
1564 ossl_statem_check_finish_init(s, 0);
1566 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1567 struct ssl_async_args args;
1573 args.type = READFUNC;
1574 args.f.func_read = s->method->ssl_read;
1576 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1577 *readbytes = s->asyncrw;
1580 return s->method->ssl_read(s, buf, num, readbytes);
1584 int SSL_read(SSL *s, void *buf, int num)
1590 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1594 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1597 * The cast is safe here because ret should be <= INT_MAX because num is
1601 ret = (int)readbytes;
1606 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1608 int ret = ssl_read_internal(s, buf, num, readbytes);
1615 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1620 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1621 return SSL_READ_EARLY_DATA_ERROR;
1624 switch (s->early_data_state) {
1625 case SSL_EARLY_DATA_NONE:
1626 if (!SSL_in_before(s)) {
1627 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1628 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1629 return SSL_READ_EARLY_DATA_ERROR;
1633 case SSL_EARLY_DATA_ACCEPT_RETRY:
1634 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1635 ret = SSL_accept(s);
1638 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1639 return SSL_READ_EARLY_DATA_ERROR;
1643 case SSL_EARLY_DATA_READ_RETRY:
1644 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1645 s->early_data_state = SSL_EARLY_DATA_READING;
1646 ret = SSL_read_ex(s, buf, num, readbytes);
1648 * State machine will update early_data_state to
1649 * SSL_EARLY_DATA_FINISHED_READING if we get an EndOfEarlyData
1652 if (ret > 0 || (ret <= 0 && s->early_data_state
1653 != SSL_EARLY_DATA_FINISHED_READING)) {
1654 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1655 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1656 : SSL_READ_EARLY_DATA_ERROR;
1659 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1662 return SSL_READ_EARLY_DATA_FINISH;
1665 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1666 return SSL_READ_EARLY_DATA_ERROR;
1670 int SSL_get_early_data_status(const SSL *s)
1672 return s->ext.early_data;
1675 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1677 if (s->handshake_func == NULL) {
1678 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1682 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1685 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1686 struct ssl_async_args args;
1692 args.type = READFUNC;
1693 args.f.func_read = s->method->ssl_peek;
1695 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1696 *readbytes = s->asyncrw;
1699 return s->method->ssl_peek(s, buf, num, readbytes);
1703 int SSL_peek(SSL *s, void *buf, int num)
1709 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1713 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1716 * The cast is safe here because ret should be <= INT_MAX because num is
1720 ret = (int)readbytes;
1726 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1728 int ret = ssl_peek_internal(s, buf, num, readbytes);
1735 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1737 if (s->handshake_func == NULL) {
1738 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1742 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1743 s->rwstate = SSL_NOTHING;
1744 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1748 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1749 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1750 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1751 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1754 /* If we are a client and haven't sent the Finished we better do that */
1755 ossl_statem_check_finish_init(s, 1);
1757 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1759 struct ssl_async_args args;
1762 args.buf = (void *)buf;
1764 args.type = WRITEFUNC;
1765 args.f.func_write = s->method->ssl_write;
1767 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1768 *written = s->asyncrw;
1771 return s->method->ssl_write(s, buf, num, written);
1775 int SSL_write(SSL *s, const void *buf, int num)
1781 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1785 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1788 * The cast is safe here because ret should be <= INT_MAX because num is
1797 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1799 int ret = ssl_write_internal(s, buf, num, written);
1806 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1808 int ret, early_data_state;
1810 switch (s->early_data_state) {
1811 case SSL_EARLY_DATA_NONE:
1813 || !SSL_in_before(s)
1814 || s->session == NULL
1815 || s->session->ext.max_early_data == 0) {
1816 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1817 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1822 case SSL_EARLY_DATA_CONNECT_RETRY:
1823 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1824 ret = SSL_connect(s);
1827 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1832 case SSL_EARLY_DATA_WRITE_RETRY:
1833 s->early_data_state = SSL_EARLY_DATA_WRITING;
1834 ret = SSL_write_ex(s, buf, num, written);
1835 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
1838 case SSL_EARLY_DATA_FINISHED_READING:
1839 case SSL_EARLY_DATA_READ_RETRY:
1840 early_data_state = s->early_data_state;
1841 /* We are a server writing to an unauthenticated client */
1842 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
1843 ret = SSL_write_ex(s, buf, num, written);
1844 s->early_data_state = early_data_state;
1848 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1853 int SSL_shutdown(SSL *s)
1856 * Note that this function behaves differently from what one might
1857 * expect. Return values are 0 for no success (yet), 1 for success; but
1858 * calling it once is usually not enough, even if blocking I/O is used
1859 * (see ssl3_shutdown).
1862 if (s->handshake_func == NULL) {
1863 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1867 if (!SSL_in_init(s)) {
1868 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1869 struct ssl_async_args args;
1872 args.type = OTHERFUNC;
1873 args.f.func_other = s->method->ssl_shutdown;
1875 return ssl_start_async_job(s, &args, ssl_io_intern);
1877 return s->method->ssl_shutdown(s);
1880 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1885 int SSL_key_update(SSL *s, int updatetype)
1888 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
1889 * negotiated, and that it is appropriate to call SSL_key_update() instead
1890 * of SSL_renegotiate().
1892 if (!SSL_IS_TLS13(s)) {
1893 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1897 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1898 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1899 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1903 if (!SSL_is_init_finished(s)) {
1904 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1908 ossl_statem_set_in_init(s, 1);
1909 s->key_update = updatetype;
1913 int SSL_get_key_update_type(SSL *s)
1915 return s->key_update;
1918 int SSL_renegotiate(SSL *s)
1920 if (SSL_IS_TLS13(s)) {
1921 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1925 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
1926 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_NO_RENEGOTIATION);
1933 return (s->method->ssl_renegotiate(s));
1936 int SSL_renegotiate_abbreviated(SSL *s)
1938 if (SSL_IS_TLS13(s)) {
1939 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_WRONG_SSL_VERSION);
1943 if ((s->options & SSL_OP_NO_RENEGOTIATION)) {
1944 SSLerr(SSL_F_SSL_RENEGOTIATE_ABBREVIATED, SSL_R_NO_RENEGOTIATION);
1951 return (s->method->ssl_renegotiate(s));
1954 int SSL_renegotiate_pending(SSL *s)
1957 * becomes true when negotiation is requested; false again once a
1958 * handshake has finished
1960 return (s->renegotiate != 0);
1963 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1968 case SSL_CTRL_GET_READ_AHEAD:
1969 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1970 case SSL_CTRL_SET_READ_AHEAD:
1971 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1972 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1975 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1976 s->msg_callback_arg = parg;
1980 return (s->mode |= larg);
1981 case SSL_CTRL_CLEAR_MODE:
1982 return (s->mode &= ~larg);
1983 case SSL_CTRL_GET_MAX_CERT_LIST:
1984 return (long)(s->max_cert_list);
1985 case SSL_CTRL_SET_MAX_CERT_LIST:
1988 l = (long)s->max_cert_list;
1989 s->max_cert_list = (size_t)larg;
1991 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1992 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1994 s->max_send_fragment = larg;
1995 if (s->max_send_fragment < s->split_send_fragment)
1996 s->split_send_fragment = s->max_send_fragment;
1998 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1999 if ((size_t)larg > s->max_send_fragment || larg == 0)
2001 s->split_send_fragment = larg;
2003 case SSL_CTRL_SET_MAX_PIPELINES:
2004 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2006 s->max_pipelines = larg;
2008 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2010 case SSL_CTRL_GET_RI_SUPPORT:
2012 return s->s3->send_connection_binding;
2015 case SSL_CTRL_CERT_FLAGS:
2016 return (s->cert->cert_flags |= larg);
2017 case SSL_CTRL_CLEAR_CERT_FLAGS:
2018 return (s->cert->cert_flags &= ~larg);
2020 case SSL_CTRL_GET_RAW_CIPHERLIST:
2022 if (s->s3->tmp.ciphers_raw == NULL)
2024 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2025 return (int)s->s3->tmp.ciphers_rawlen;
2027 return TLS_CIPHER_LEN;
2029 case SSL_CTRL_GET_EXTMS_SUPPORT:
2030 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2032 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2036 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2037 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2038 &s->min_proto_version);
2039 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2040 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2041 &s->max_proto_version);
2043 return (s->method->ssl_ctrl(s, cmd, larg, parg));
2047 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2050 case SSL_CTRL_SET_MSG_CALLBACK:
2051 s->msg_callback = (void (*)
2052 (int write_p, int version, int content_type,
2053 const void *buf, size_t len, SSL *ssl,
2058 return (s->method->ssl_callback_ctrl(s, cmd, fp));
2062 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2064 return ctx->sessions;
2067 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2070 /* For some cases with ctx == NULL perform syntax checks */
2073 #ifndef OPENSSL_NO_EC
2074 case SSL_CTRL_SET_GROUPS_LIST:
2075 return tls1_set_groups_list(NULL, NULL, parg);
2077 case SSL_CTRL_SET_SIGALGS_LIST:
2078 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2079 return tls1_set_sigalgs_list(NULL, parg, 0);
2086 case SSL_CTRL_GET_READ_AHEAD:
2087 return (ctx->read_ahead);
2088 case SSL_CTRL_SET_READ_AHEAD:
2089 l = ctx->read_ahead;
2090 ctx->read_ahead = larg;
2093 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2094 ctx->msg_callback_arg = parg;
2097 case SSL_CTRL_GET_MAX_CERT_LIST:
2098 return (long)(ctx->max_cert_list);
2099 case SSL_CTRL_SET_MAX_CERT_LIST:
2102 l = (long)ctx->max_cert_list;
2103 ctx->max_cert_list = (size_t)larg;
2106 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2109 l = (long)ctx->session_cache_size;
2110 ctx->session_cache_size = (size_t)larg;
2112 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2113 return (long)(ctx->session_cache_size);
2114 case SSL_CTRL_SET_SESS_CACHE_MODE:
2115 l = ctx->session_cache_mode;
2116 ctx->session_cache_mode = larg;
2118 case SSL_CTRL_GET_SESS_CACHE_MODE:
2119 return (ctx->session_cache_mode);
2121 case SSL_CTRL_SESS_NUMBER:
2122 return (lh_SSL_SESSION_num_items(ctx->sessions));
2123 case SSL_CTRL_SESS_CONNECT:
2124 return (ctx->stats.sess_connect);
2125 case SSL_CTRL_SESS_CONNECT_GOOD:
2126 return (ctx->stats.sess_connect_good);
2127 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2128 return (ctx->stats.sess_connect_renegotiate);
2129 case SSL_CTRL_SESS_ACCEPT:
2130 return (ctx->stats.sess_accept);
2131 case SSL_CTRL_SESS_ACCEPT_GOOD:
2132 return (ctx->stats.sess_accept_good);
2133 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2134 return (ctx->stats.sess_accept_renegotiate);
2135 case SSL_CTRL_SESS_HIT:
2136 return (ctx->stats.sess_hit);
2137 case SSL_CTRL_SESS_CB_HIT:
2138 return (ctx->stats.sess_cb_hit);
2139 case SSL_CTRL_SESS_MISSES:
2140 return (ctx->stats.sess_miss);
2141 case SSL_CTRL_SESS_TIMEOUTS:
2142 return (ctx->stats.sess_timeout);
2143 case SSL_CTRL_SESS_CACHE_FULL:
2144 return (ctx->stats.sess_cache_full);
2146 return (ctx->mode |= larg);
2147 case SSL_CTRL_CLEAR_MODE:
2148 return (ctx->mode &= ~larg);
2149 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2150 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2152 ctx->max_send_fragment = larg;
2153 if (ctx->max_send_fragment < ctx->split_send_fragment)
2154 ctx->split_send_fragment = ctx->max_send_fragment;
2156 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2157 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2159 ctx->split_send_fragment = larg;
2161 case SSL_CTRL_SET_MAX_PIPELINES:
2162 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2164 ctx->max_pipelines = larg;
2166 case SSL_CTRL_CERT_FLAGS:
2167 return (ctx->cert->cert_flags |= larg);
2168 case SSL_CTRL_CLEAR_CERT_FLAGS:
2169 return (ctx->cert->cert_flags &= ~larg);
2170 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2171 return ssl_set_version_bound(ctx->method->version, (int)larg,
2172 &ctx->min_proto_version);
2173 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2174 return ssl_set_version_bound(ctx->method->version, (int)larg,
2175 &ctx->max_proto_version);
2177 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2181 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2184 case SSL_CTRL_SET_MSG_CALLBACK:
2185 ctx->msg_callback = (void (*)
2186 (int write_p, int version, int content_type,
2187 const void *buf, size_t len, SSL *ssl,
2192 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2196 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2205 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2206 const SSL_CIPHER *const *bp)
2208 if ((*ap)->id > (*bp)->id)
2210 if ((*ap)->id < (*bp)->id)
2215 /** return a STACK of the ciphers available for the SSL and in order of
2217 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2220 if (s->cipher_list != NULL) {
2221 return (s->cipher_list);
2222 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2223 return (s->ctx->cipher_list);
2229 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2231 if ((s == NULL) || (s->session == NULL) || !s->server)
2233 return s->session->ciphers;
2236 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2238 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2240 ciphers = SSL_get_ciphers(s);
2243 ssl_set_client_disabled(s);
2244 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2245 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2246 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2248 sk = sk_SSL_CIPHER_new_null();
2251 if (!sk_SSL_CIPHER_push(sk, c)) {
2252 sk_SSL_CIPHER_free(sk);
2260 /** return a STACK of the ciphers available for the SSL and in order of
2262 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2265 if (s->cipher_list_by_id != NULL) {
2266 return (s->cipher_list_by_id);
2267 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2268 return (s->ctx->cipher_list_by_id);
2274 /** The old interface to get the same thing as SSL_get_ciphers() */
2275 const char *SSL_get_cipher_list(const SSL *s, int n)
2277 const SSL_CIPHER *c;
2278 STACK_OF(SSL_CIPHER) *sk;
2282 sk = SSL_get_ciphers(s);
2283 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2285 c = sk_SSL_CIPHER_value(sk, n);
2291 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2293 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2296 return ctx->cipher_list;
2300 /** specify the ciphers to be used by default by the SSL_CTX */
2301 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2303 STACK_OF(SSL_CIPHER) *sk;
2305 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2306 &ctx->cipher_list_by_id, str, ctx->cert);
2308 * ssl_create_cipher_list may return an empty stack if it was unable to
2309 * find a cipher matching the given rule string (for example if the rule
2310 * string specifies a cipher which has been disabled). This is not an
2311 * error as far as ssl_create_cipher_list is concerned, and hence
2312 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2316 else if (sk_SSL_CIPHER_num(sk) == 0) {
2317 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2323 /** specify the ciphers to be used by the SSL */
2324 int SSL_set_cipher_list(SSL *s, const char *str)
2326 STACK_OF(SSL_CIPHER) *sk;
2328 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2329 &s->cipher_list_by_id, str, s->cert);
2330 /* see comment in SSL_CTX_set_cipher_list */
2333 else if (sk_SSL_CIPHER_num(sk) == 0) {
2334 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2340 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2343 STACK_OF(SSL_CIPHER) *sk;
2344 const SSL_CIPHER *c;
2347 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2351 sk = s->session->ciphers;
2353 if (sk_SSL_CIPHER_num(sk) == 0)
2356 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2359 c = sk_SSL_CIPHER_value(sk, i);
2360 n = strlen(c->name);
2367 memcpy(p, c->name, n + 1);
2376 /** return a servername extension value if provided in Client Hello, or NULL.
2377 * So far, only host_name types are defined (RFC 3546).
2380 const char *SSL_get_servername(const SSL *s, const int type)
2382 if (type != TLSEXT_NAMETYPE_host_name)
2385 return s->session && !s->ext.hostname ?
2386 s->session->ext.hostname : s->ext.hostname;
2389 int SSL_get_servername_type(const SSL *s)
2392 && (!s->ext.hostname ? s->session->
2393 ext.hostname : s->ext.hostname))
2394 return TLSEXT_NAMETYPE_host_name;
2399 * SSL_select_next_proto implements the standard protocol selection. It is
2400 * expected that this function is called from the callback set by
2401 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2402 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2403 * not included in the length. A byte string of length 0 is invalid. No byte
2404 * string may be truncated. The current, but experimental algorithm for
2405 * selecting the protocol is: 1) If the server doesn't support NPN then this
2406 * is indicated to the callback. In this case, the client application has to
2407 * abort the connection or have a default application level protocol. 2) If
2408 * the server supports NPN, but advertises an empty list then the client
2409 * selects the first protocol in its list, but indicates via the API that this
2410 * fallback case was enacted. 3) Otherwise, the client finds the first
2411 * protocol in the server's list that it supports and selects this protocol.
2412 * This is because it's assumed that the server has better information about
2413 * which protocol a client should use. 4) If the client doesn't support any
2414 * of the server's advertised protocols, then this is treated the same as
2415 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2416 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2418 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2419 const unsigned char *server,
2420 unsigned int server_len,
2421 const unsigned char *client, unsigned int client_len)
2424 const unsigned char *result;
2425 int status = OPENSSL_NPN_UNSUPPORTED;
2428 * For each protocol in server preference order, see if we support it.
2430 for (i = 0; i < server_len;) {
2431 for (j = 0; j < client_len;) {
2432 if (server[i] == client[j] &&
2433 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2434 /* We found a match */
2435 result = &server[i];
2436 status = OPENSSL_NPN_NEGOTIATED;
2446 /* There's no overlap between our protocols and the server's list. */
2448 status = OPENSSL_NPN_NO_OVERLAP;
2451 *out = (unsigned char *)result + 1;
2452 *outlen = result[0];
2456 #ifndef OPENSSL_NO_NEXTPROTONEG
2458 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2459 * client's requested protocol for this connection and returns 0. If the
2460 * client didn't request any protocol, then *data is set to NULL. Note that
2461 * the client can request any protocol it chooses. The value returned from
2462 * this function need not be a member of the list of supported protocols
2463 * provided by the callback.
2465 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2472 *len = (unsigned int)s->ext.npn_len;
2477 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2478 * a TLS server needs a list of supported protocols for Next Protocol
2479 * Negotiation. The returned list must be in wire format. The list is
2480 * returned by setting |out| to point to it and |outlen| to its length. This
2481 * memory will not be modified, but one should assume that the SSL* keeps a
2482 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2483 * wishes to advertise. Otherwise, no such extension will be included in the
2486 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2487 SSL_CTX_npn_advertised_cb_func cb,
2490 ctx->ext.npn_advertised_cb = cb;
2491 ctx->ext.npn_advertised_cb_arg = arg;
2495 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2496 * client needs to select a protocol from the server's provided list. |out|
2497 * must be set to point to the selected protocol (which may be within |in|).
2498 * The length of the protocol name must be written into |outlen|. The
2499 * server's advertised protocols are provided in |in| and |inlen|. The
2500 * callback can assume that |in| is syntactically valid. The client must
2501 * select a protocol. It is fatal to the connection if this callback returns
2502 * a value other than SSL_TLSEXT_ERR_OK.
2504 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2505 SSL_CTX_npn_select_cb_func cb,
2508 ctx->ext.npn_select_cb = cb;
2509 ctx->ext.npn_select_cb_arg = arg;
2514 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2515 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2516 * length-prefixed strings). Returns 0 on success.
2518 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2519 unsigned int protos_len)
2521 OPENSSL_free(ctx->ext.alpn);
2522 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2523 if (ctx->ext.alpn == NULL) {
2524 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2527 ctx->ext.alpn_len = protos_len;
2533 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2534 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2535 * length-prefixed strings). Returns 0 on success.
2537 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2538 unsigned int protos_len)
2540 OPENSSL_free(ssl->ext.alpn);
2541 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2542 if (ssl->ext.alpn == NULL) {
2543 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2546 ssl->ext.alpn_len = protos_len;
2552 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2553 * called during ClientHello processing in order to select an ALPN protocol
2554 * from the client's list of offered protocols.
2556 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2557 SSL_CTX_alpn_select_cb_func cb,
2560 ctx->ext.alpn_select_cb = cb;
2561 ctx->ext.alpn_select_cb_arg = arg;
2565 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2566 * On return it sets |*data| to point to |*len| bytes of protocol name
2567 * (not including the leading length-prefix byte). If the server didn't
2568 * respond with a negotiated protocol then |*len| will be zero.
2570 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2575 *data = ssl->s3->alpn_selected;
2579 *len = (unsigned int)ssl->s3->alpn_selected_len;
2582 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2583 const char *label, size_t llen,
2584 const unsigned char *p, size_t plen,
2587 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2590 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2595 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2597 const unsigned char *session_id = a->session_id;
2599 unsigned char tmp_storage[4];
2601 if (a->session_id_length < sizeof(tmp_storage)) {
2602 memset(tmp_storage, 0, sizeof(tmp_storage));
2603 memcpy(tmp_storage, a->session_id, a->session_id_length);
2604 session_id = tmp_storage;
2608 ((unsigned long)session_id[0]) |
2609 ((unsigned long)session_id[1] << 8L) |
2610 ((unsigned long)session_id[2] << 16L) |
2611 ((unsigned long)session_id[3] << 24L);
2616 * NB: If this function (or indeed the hash function which uses a sort of
2617 * coarser function than this one) is changed, ensure
2618 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2619 * being able to construct an SSL_SESSION that will collide with any existing
2620 * session with a matching session ID.
2622 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2624 if (a->ssl_version != b->ssl_version)
2626 if (a->session_id_length != b->session_id_length)
2628 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2632 * These wrapper functions should remain rather than redeclaring
2633 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2634 * variable. The reason is that the functions aren't static, they're exposed
2638 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2640 SSL_CTX *ret = NULL;
2643 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2647 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2650 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2651 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2654 ret = OPENSSL_zalloc(sizeof(*ret));
2659 ret->min_proto_version = 0;
2660 ret->max_proto_version = 0;
2661 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2662 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2663 /* We take the system default. */
2664 ret->session_timeout = meth->get_timeout();
2665 ret->references = 1;
2666 ret->lock = CRYPTO_THREAD_lock_new();
2667 if (ret->lock == NULL) {
2668 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2672 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2673 ret->verify_mode = SSL_VERIFY_NONE;
2674 if ((ret->cert = ssl_cert_new()) == NULL)
2677 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2678 if (ret->sessions == NULL)
2680 ret->cert_store = X509_STORE_new();
2681 if (ret->cert_store == NULL)
2683 #ifndef OPENSSL_NO_CT
2684 ret->ctlog_store = CTLOG_STORE_new();
2685 if (ret->ctlog_store == NULL)
2688 if (!ssl_create_cipher_list(ret->method,
2689 &ret->cipher_list, &ret->cipher_list_by_id,
2690 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2691 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2692 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2696 ret->param = X509_VERIFY_PARAM_new();
2697 if (ret->param == NULL)
2700 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2701 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2704 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2705 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2709 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2712 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2715 /* No compression for DTLS */
2716 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2717 ret->comp_methods = SSL_COMP_get_compression_methods();
2719 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2720 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2722 /* Setup RFC5077 ticket keys */
2723 if ((RAND_bytes(ret->ext.tick_key_name,
2724 sizeof(ret->ext.tick_key_name)) <= 0)
2725 || (RAND_bytes(ret->ext.tick_hmac_key,
2726 sizeof(ret->ext.tick_hmac_key)) <= 0)
2727 || (RAND_bytes(ret->ext.tick_aes_key,
2728 sizeof(ret->ext.tick_aes_key)) <= 0))
2729 ret->options |= SSL_OP_NO_TICKET;
2731 #ifndef OPENSSL_NO_SRP
2732 if (!SSL_CTX_SRP_CTX_init(ret))
2735 #ifndef OPENSSL_NO_ENGINE
2736 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2737 # define eng_strx(x) #x
2738 # define eng_str(x) eng_strx(x)
2739 /* Use specific client engine automatically... ignore errors */
2742 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2745 ENGINE_load_builtin_engines();
2746 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2748 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2754 * Default is to connect to non-RI servers. When RI is more widely
2755 * deployed might change this.
2757 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2759 * Disable compression by default to prevent CRIME. Applications can
2760 * re-enable compression by configuring
2761 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2762 * or by using the SSL_CONF library.
2764 ret->options |= SSL_OP_NO_COMPRESSION;
2766 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2769 * Default max early data is a fully loaded single record. Could be split
2770 * across multiple records in practice
2772 ret->max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
2776 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2782 int SSL_CTX_up_ref(SSL_CTX *ctx)
2786 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2789 REF_PRINT_COUNT("SSL_CTX", ctx);
2790 REF_ASSERT_ISNT(i < 2);
2791 return ((i > 1) ? 1 : 0);
2794 void SSL_CTX_free(SSL_CTX *a)
2801 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2802 REF_PRINT_COUNT("SSL_CTX", a);
2805 REF_ASSERT_ISNT(i < 0);
2807 X509_VERIFY_PARAM_free(a->param);
2808 dane_ctx_final(&a->dane);
2811 * Free internal session cache. However: the remove_cb() may reference
2812 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2813 * after the sessions were flushed.
2814 * As the ex_data handling routines might also touch the session cache,
2815 * the most secure solution seems to be: empty (flush) the cache, then
2816 * free ex_data, then finally free the cache.
2817 * (See ticket [openssl.org #212].)
2819 if (a->sessions != NULL)
2820 SSL_CTX_flush_sessions(a, 0);
2822 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2823 lh_SSL_SESSION_free(a->sessions);
2824 X509_STORE_free(a->cert_store);
2825 #ifndef OPENSSL_NO_CT
2826 CTLOG_STORE_free(a->ctlog_store);
2828 sk_SSL_CIPHER_free(a->cipher_list);
2829 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2830 ssl_cert_free(a->cert);
2831 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
2832 sk_X509_pop_free(a->extra_certs, X509_free);
2833 a->comp_methods = NULL;
2834 #ifndef OPENSSL_NO_SRTP
2835 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2837 #ifndef OPENSSL_NO_SRP
2838 SSL_CTX_SRP_CTX_free(a);
2840 #ifndef OPENSSL_NO_ENGINE
2841 ENGINE_finish(a->client_cert_engine);
2844 #ifndef OPENSSL_NO_EC
2845 OPENSSL_free(a->ext.ecpointformats);
2846 OPENSSL_free(a->ext.supportedgroups);
2848 OPENSSL_free(a->ext.alpn);
2850 CRYPTO_THREAD_lock_free(a->lock);
2855 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2857 ctx->default_passwd_callback = cb;
2860 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2862 ctx->default_passwd_callback_userdata = u;
2865 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2867 return ctx->default_passwd_callback;
2870 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2872 return ctx->default_passwd_callback_userdata;
2875 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2877 s->default_passwd_callback = cb;
2880 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2882 s->default_passwd_callback_userdata = u;
2885 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2887 return s->default_passwd_callback;
2890 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2892 return s->default_passwd_callback_userdata;
2895 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2896 int (*cb) (X509_STORE_CTX *, void *),
2899 ctx->app_verify_callback = cb;
2900 ctx->app_verify_arg = arg;
2903 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2904 int (*cb) (int, X509_STORE_CTX *))
2906 ctx->verify_mode = mode;
2907 ctx->default_verify_callback = cb;
2910 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2912 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2915 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2917 ssl_cert_set_cert_cb(c->cert, cb, arg);
2920 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2922 ssl_cert_set_cert_cb(s->cert, cb, arg);
2925 void ssl_set_masks(SSL *s)
2928 uint32_t *pvalid = s->s3->tmp.valid_flags;
2929 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2930 unsigned long mask_k, mask_a;
2931 #ifndef OPENSSL_NO_EC
2932 int have_ecc_cert, ecdsa_ok;
2937 #ifndef OPENSSL_NO_DH
2938 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2943 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2944 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2945 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
2946 #ifndef OPENSSL_NO_EC
2947 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2953 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2954 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2957 #ifndef OPENSSL_NO_GOST
2958 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2959 mask_k |= SSL_kGOST;
2960 mask_a |= SSL_aGOST12;
2962 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2963 mask_k |= SSL_kGOST;
2964 mask_a |= SSL_aGOST12;
2966 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2967 mask_k |= SSL_kGOST;
2968 mask_a |= SSL_aGOST01;
2978 if (rsa_enc || rsa_sign) {
2986 mask_a |= SSL_aNULL;
2989 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2990 * depending on the key usage extension.
2992 #ifndef OPENSSL_NO_EC
2993 if (have_ecc_cert) {
2995 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
2996 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2997 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3000 mask_a |= SSL_aECDSA;
3004 #ifndef OPENSSL_NO_EC
3005 mask_k |= SSL_kECDHE;
3008 #ifndef OPENSSL_NO_PSK
3011 if (mask_k & SSL_kRSA)
3012 mask_k |= SSL_kRSAPSK;
3013 if (mask_k & SSL_kDHE)
3014 mask_k |= SSL_kDHEPSK;
3015 if (mask_k & SSL_kECDHE)
3016 mask_k |= SSL_kECDHEPSK;
3019 s->s3->tmp.mask_k = mask_k;
3020 s->s3->tmp.mask_a = mask_a;
3023 #ifndef OPENSSL_NO_EC
3025 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3027 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3028 /* key usage, if present, must allow signing */
3029 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3030 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3031 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3035 return 1; /* all checks are ok */
3040 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3041 size_t *serverinfo_length)
3043 CERT_PKEY *cpk = s->s3->tmp.cert;
3044 *serverinfo_length = 0;
3046 if (cpk == NULL || cpk->serverinfo == NULL)
3049 *serverinfo = cpk->serverinfo;
3050 *serverinfo_length = cpk->serverinfo_length;
3054 void ssl_update_cache(SSL *s, int mode)
3059 * If the session_id_length is 0, we are not supposed to cache it, and it
3060 * would be rather hard to do anyway :-)
3062 if (s->session->session_id_length == 0)
3065 i = s->session_ctx->session_cache_mode;
3066 if ((i & mode) && (!s->hit)
3067 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
3068 || SSL_CTX_add_session(s->session_ctx, s->session))
3069 && (s->session_ctx->new_session_cb != NULL)) {
3070 SSL_SESSION_up_ref(s->session);
3071 if (!s->session_ctx->new_session_cb(s, s->session))
3072 SSL_SESSION_free(s->session);
3075 /* auto flush every 255 connections */
3076 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3077 if ((((mode & SSL_SESS_CACHE_CLIENT)
3078 ? s->session_ctx->stats.sess_connect_good
3079 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
3080 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3085 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3090 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3095 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3099 if (s->method != meth) {
3100 const SSL_METHOD *sm = s->method;
3101 int (*hf) (SSL *) = s->handshake_func;
3103 if (sm->version == meth->version)
3108 ret = s->method->ssl_new(s);
3111 if (hf == sm->ssl_connect)
3112 s->handshake_func = meth->ssl_connect;
3113 else if (hf == sm->ssl_accept)
3114 s->handshake_func = meth->ssl_accept;
3119 int SSL_get_error(const SSL *s, int i)
3126 return (SSL_ERROR_NONE);
3129 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3130 * where we do encode the error
3132 if ((l = ERR_peek_error()) != 0) {
3133 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3134 return (SSL_ERROR_SYSCALL);
3136 return (SSL_ERROR_SSL);
3139 if (SSL_want_read(s)) {
3140 bio = SSL_get_rbio(s);
3141 if (BIO_should_read(bio))
3142 return (SSL_ERROR_WANT_READ);
3143 else if (BIO_should_write(bio))
3145 * This one doesn't make too much sense ... We never try to write
3146 * to the rbio, and an application program where rbio and wbio
3147 * are separate couldn't even know what it should wait for.
3148 * However if we ever set s->rwstate incorrectly (so that we have
3149 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3150 * wbio *are* the same, this test works around that bug; so it
3151 * might be safer to keep it.
3153 return (SSL_ERROR_WANT_WRITE);
3154 else if (BIO_should_io_special(bio)) {
3155 reason = BIO_get_retry_reason(bio);
3156 if (reason == BIO_RR_CONNECT)
3157 return (SSL_ERROR_WANT_CONNECT);
3158 else if (reason == BIO_RR_ACCEPT)
3159 return (SSL_ERROR_WANT_ACCEPT);
3161 return (SSL_ERROR_SYSCALL); /* unknown */
3165 if (SSL_want_write(s)) {
3166 /* Access wbio directly - in order to use the buffered bio if present */
3168 if (BIO_should_write(bio))
3169 return (SSL_ERROR_WANT_WRITE);
3170 else if (BIO_should_read(bio))
3172 * See above (SSL_want_read(s) with BIO_should_write(bio))
3174 return (SSL_ERROR_WANT_READ);
3175 else if (BIO_should_io_special(bio)) {
3176 reason = BIO_get_retry_reason(bio);
3177 if (reason == BIO_RR_CONNECT)
3178 return (SSL_ERROR_WANT_CONNECT);
3179 else if (reason == BIO_RR_ACCEPT)
3180 return (SSL_ERROR_WANT_ACCEPT);
3182 return (SSL_ERROR_SYSCALL);
3185 if (SSL_want_x509_lookup(s))
3186 return (SSL_ERROR_WANT_X509_LOOKUP);
3187 if (SSL_want_async(s))
3188 return SSL_ERROR_WANT_ASYNC;
3189 if (SSL_want_async_job(s))
3190 return SSL_ERROR_WANT_ASYNC_JOB;
3191 if (SSL_want_early(s))
3192 return SSL_ERROR_WANT_EARLY;
3194 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3195 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3196 return (SSL_ERROR_ZERO_RETURN);
3198 return (SSL_ERROR_SYSCALL);
3201 static int ssl_do_handshake_intern(void *vargs)
3203 struct ssl_async_args *args;
3206 args = (struct ssl_async_args *)vargs;
3209 return s->handshake_func(s);
3212 int SSL_do_handshake(SSL *s)
3216 if (s->handshake_func == NULL) {
3217 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3221 ossl_statem_check_finish_init(s, -1);
3223 s->method->ssl_renegotiate_check(s, 0);
3225 if (SSL_in_init(s) || SSL_in_before(s)) {
3226 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3227 struct ssl_async_args args;
3231 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3233 ret = s->handshake_func(s);
3239 void SSL_set_accept_state(SSL *s)
3243 ossl_statem_clear(s);
3244 s->handshake_func = s->method->ssl_accept;
3248 void SSL_set_connect_state(SSL *s)
3252 ossl_statem_clear(s);
3253 s->handshake_func = s->method->ssl_connect;
3257 int ssl_undefined_function(SSL *s)
3259 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3263 int ssl_undefined_void_function(void)
3265 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3266 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3270 int ssl_undefined_const_function(const SSL *s)
3275 const SSL_METHOD *ssl_bad_method(int ver)
3277 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3281 const char *ssl_protocol_to_string(int version)
3285 case TLS1_3_VERSION:
3288 case TLS1_2_VERSION:
3291 case TLS1_1_VERSION:
3306 case DTLS1_2_VERSION:
3314 const char *SSL_get_version(const SSL *s)
3316 return ssl_protocol_to_string(s->version);
3319 SSL *SSL_dup(SSL *s)
3321 STACK_OF(X509_NAME) *sk;
3326 /* If we're not quiescent, just up_ref! */
3327 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3328 CRYPTO_UP_REF(&s->references, &i, s->lock);
3333 * Otherwise, copy configuration state, and session if set.
3335 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3338 if (s->session != NULL) {
3340 * Arranges to share the same session via up_ref. This "copies"
3341 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3343 if (!SSL_copy_session_id(ret, s))
3347 * No session has been established yet, so we have to expect that
3348 * s->cert or ret->cert will be changed later -- they should not both
3349 * point to the same object, and thus we can't use
3350 * SSL_copy_session_id.
3352 if (!SSL_set_ssl_method(ret, s->method))
3355 if (s->cert != NULL) {
3356 ssl_cert_free(ret->cert);
3357 ret->cert = ssl_cert_dup(s->cert);
3358 if (ret->cert == NULL)
3362 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3363 (int)s->sid_ctx_length))
3367 if (!ssl_dane_dup(ret, s))
3369 ret->version = s->version;
3370 ret->options = s->options;
3371 ret->mode = s->mode;
3372 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3373 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3374 ret->msg_callback = s->msg_callback;
3375 ret->msg_callback_arg = s->msg_callback_arg;
3376 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3377 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3378 ret->generate_session_id = s->generate_session_id;
3380 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3382 /* copy app data, a little dangerous perhaps */
3383 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3386 /* setup rbio, and wbio */
3387 if (s->rbio != NULL) {
3388 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3391 if (s->wbio != NULL) {
3392 if (s->wbio != s->rbio) {
3393 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3396 BIO_up_ref(ret->rbio);
3397 ret->wbio = ret->rbio;
3401 ret->server = s->server;
3402 if (s->handshake_func) {
3404 SSL_set_accept_state(ret);
3406 SSL_set_connect_state(ret);
3408 ret->shutdown = s->shutdown;
3411 ret->default_passwd_callback = s->default_passwd_callback;
3412 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3414 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3416 /* dup the cipher_list and cipher_list_by_id stacks */
3417 if (s->cipher_list != NULL) {
3418 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3421 if (s->cipher_list_by_id != NULL)
3422 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3426 /* Dup the client_CA list */
3427 if (s->ca_names != NULL) {
3428 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3431 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3432 xn = sk_X509_NAME_value(sk, i);
3433 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3446 void ssl_clear_cipher_ctx(SSL *s)
3448 if (s->enc_read_ctx != NULL) {
3449 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3450 s->enc_read_ctx = NULL;
3452 if (s->enc_write_ctx != NULL) {
3453 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3454 s->enc_write_ctx = NULL;
3456 #ifndef OPENSSL_NO_COMP
3457 COMP_CTX_free(s->expand);
3459 COMP_CTX_free(s->compress);
3464 X509 *SSL_get_certificate(const SSL *s)
3466 if (s->cert != NULL)
3467 return (s->cert->key->x509);
3472 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3474 if (s->cert != NULL)
3475 return (s->cert->key->privatekey);
3480 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3482 if (ctx->cert != NULL)
3483 return ctx->cert->key->x509;
3488 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3490 if (ctx->cert != NULL)
3491 return ctx->cert->key->privatekey;
3496 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3498 if ((s->session != NULL) && (s->session->cipher != NULL))
3499 return (s->session->cipher);
3503 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3505 #ifndef OPENSSL_NO_COMP
3506 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3512 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3514 #ifndef OPENSSL_NO_COMP
3515 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3521 int ssl_init_wbio_buffer(SSL *s)
3525 if (s->bbio != NULL) {
3526 /* Already buffered. */
3530 bbio = BIO_new(BIO_f_buffer());
3531 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3533 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3537 s->wbio = BIO_push(bbio, s->wbio);
3542 int ssl_free_wbio_buffer(SSL *s)
3544 /* callers ensure s is never null */
3545 if (s->bbio == NULL)
3548 s->wbio = BIO_pop(s->wbio);
3549 if (!ossl_assert(s->wbio != NULL))
3557 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3559 ctx->quiet_shutdown = mode;
3562 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3564 return (ctx->quiet_shutdown);
3567 void SSL_set_quiet_shutdown(SSL *s, int mode)
3569 s->quiet_shutdown = mode;
3572 int SSL_get_quiet_shutdown(const SSL *s)
3574 return (s->quiet_shutdown);
3577 void SSL_set_shutdown(SSL *s, int mode)
3582 int SSL_get_shutdown(const SSL *s)
3587 int SSL_version(const SSL *s)
3592 int SSL_client_version(const SSL *s)
3594 return s->client_version;
3597 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3602 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3605 if (ssl->ctx == ctx)
3608 ctx = ssl->session_ctx;
3609 new_cert = ssl_cert_dup(ctx->cert);
3610 if (new_cert == NULL) {
3614 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3615 ssl_cert_free(new_cert);
3619 ssl_cert_free(ssl->cert);
3620 ssl->cert = new_cert;
3623 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3624 * so setter APIs must prevent invalid lengths from entering the system.
3626 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3630 * If the session ID context matches that of the parent SSL_CTX,
3631 * inherit it from the new SSL_CTX as well. If however the context does
3632 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3633 * leave it unchanged.
3635 if ((ssl->ctx != NULL) &&
3636 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3637 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3638 ssl->sid_ctx_length = ctx->sid_ctx_length;
3639 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3642 SSL_CTX_up_ref(ctx);
3643 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3649 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3651 return (X509_STORE_set_default_paths(ctx->cert_store));
3654 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3656 X509_LOOKUP *lookup;
3658 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3661 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3663 /* Clear any errors if the default directory does not exist */
3669 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3671 X509_LOOKUP *lookup;
3673 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3677 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3679 /* Clear any errors if the default file does not exist */
3685 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3688 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3691 void SSL_set_info_callback(SSL *ssl,
3692 void (*cb) (const SSL *ssl, int type, int val))
3694 ssl->info_callback = cb;
3698 * One compiler (Diab DCC) doesn't like argument names in returned function
3701 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3704 return ssl->info_callback;
3707 void SSL_set_verify_result(SSL *ssl, long arg)
3709 ssl->verify_result = arg;
3712 long SSL_get_verify_result(const SSL *ssl)
3714 return (ssl->verify_result);
3717 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3720 return sizeof(ssl->s3->client_random);
3721 if (outlen > sizeof(ssl->s3->client_random))
3722 outlen = sizeof(ssl->s3->client_random);
3723 memcpy(out, ssl->s3->client_random, outlen);
3727 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3730 return sizeof(ssl->s3->server_random);
3731 if (outlen > sizeof(ssl->s3->server_random))
3732 outlen = sizeof(ssl->s3->server_random);
3733 memcpy(out, ssl->s3->server_random, outlen);
3737 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3738 unsigned char *out, size_t outlen)
3741 return session->master_key_length;
3742 if (outlen > session->master_key_length)
3743 outlen = session->master_key_length;
3744 memcpy(out, session->master_key, outlen);
3748 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3750 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3753 void *SSL_get_ex_data(const SSL *s, int idx)
3755 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3758 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3760 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3763 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3765 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3768 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3770 return (ctx->cert_store);
3773 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3775 X509_STORE_free(ctx->cert_store);
3776 ctx->cert_store = store;
3779 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3782 X509_STORE_up_ref(store);
3783 SSL_CTX_set_cert_store(ctx, store);
3786 int SSL_want(const SSL *s)
3788 return (s->rwstate);
3792 * \brief Set the callback for generating temporary DH keys.
3793 * \param ctx the SSL context.
3794 * \param dh the callback
3797 #ifndef OPENSSL_NO_DH
3798 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3799 DH *(*dh) (SSL *ssl, int is_export,
3802 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3805 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3808 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3812 #ifndef OPENSSL_NO_PSK
3813 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3815 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3816 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3819 OPENSSL_free(ctx->cert->psk_identity_hint);
3820 if (identity_hint != NULL) {
3821 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3822 if (ctx->cert->psk_identity_hint == NULL)
3825 ctx->cert->psk_identity_hint = NULL;
3829 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3834 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3835 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3838 OPENSSL_free(s->cert->psk_identity_hint);
3839 if (identity_hint != NULL) {
3840 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3841 if (s->cert->psk_identity_hint == NULL)
3844 s->cert->psk_identity_hint = NULL;
3848 const char *SSL_get_psk_identity_hint(const SSL *s)
3850 if (s == NULL || s->session == NULL)
3852 return (s->session->psk_identity_hint);
3855 const char *SSL_get_psk_identity(const SSL *s)
3857 if (s == NULL || s->session == NULL)
3859 return (s->session->psk_identity);
3862 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3864 s->psk_client_callback = cb;
3867 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3869 ctx->psk_client_callback = cb;
3872 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3874 s->psk_server_callback = cb;
3877 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3879 ctx->psk_server_callback = cb;
3883 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3884 void (*cb) (int write_p, int version,
3885 int content_type, const void *buf,
3886 size_t len, SSL *ssl, void *arg))
3888 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3891 void SSL_set_msg_callback(SSL *ssl,
3892 void (*cb) (int write_p, int version,
3893 int content_type, const void *buf,
3894 size_t len, SSL *ssl, void *arg))
3896 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3899 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3900 int (*cb) (SSL *ssl,
3904 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3905 (void (*)(void))cb);
3908 void SSL_set_not_resumable_session_callback(SSL *ssl,
3909 int (*cb) (SSL *ssl,
3910 int is_forward_secure))
3912 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3913 (void (*)(void))cb);
3916 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
3917 size_t (*cb) (SSL *ssl, int type,
3918 size_t len, void *arg))
3920 ctx->record_padding_cb = cb;
3923 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
3925 ctx->record_padding_arg = arg;
3928 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
3930 return ctx->record_padding_arg;
3933 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
3935 /* block size of 0 or 1 is basically no padding */
3936 if (block_size == 1)
3937 ctx->block_padding = 0;
3938 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
3939 ctx->block_padding = block_size;
3945 void SSL_set_record_padding_callback(SSL *ssl,
3946 size_t (*cb) (SSL *ssl, int type,
3947 size_t len, void *arg))
3949 ssl->record_padding_cb = cb;
3952 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
3954 ssl->record_padding_arg = arg;
3957 void *SSL_get_record_padding_callback_arg(SSL *ssl)
3959 return ssl->record_padding_arg;
3962 int SSL_set_block_padding(SSL *ssl, size_t block_size)
3964 /* block size of 0 or 1 is basically no padding */
3965 if (block_size == 1)
3966 ssl->block_padding = 0;
3967 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
3968 ssl->block_padding = block_size;
3975 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3976 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3977 * If EVP_MD pointer is passed, initializes ctx with this |md|.
3978 * Returns the newly allocated ctx;
3981 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3983 ssl_clear_hash_ctx(hash);
3984 *hash = EVP_MD_CTX_new();
3985 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3986 EVP_MD_CTX_free(*hash);
3993 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3996 EVP_MD_CTX_free(*hash);
4000 /* Retrieve handshake hashes */
4001 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
4004 EVP_MD_CTX *ctx = NULL;
4005 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
4006 int hashleni = EVP_MD_CTX_size(hdgst);
4009 if (hashleni < 0 || (size_t)hashleni > outlen)
4012 ctx = EVP_MD_CTX_new();
4016 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4017 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
4020 *hashlen = hashleni;
4024 EVP_MD_CTX_free(ctx);
4028 int SSL_session_reused(SSL *s)
4033 int SSL_is_server(const SSL *s)
4038 #if OPENSSL_API_COMPAT < 0x10100000L
4039 void SSL_set_debug(SSL *s, int debug)
4041 /* Old function was do-nothing anyway... */
4047 void SSL_set_security_level(SSL *s, int level)
4049 s->cert->sec_level = level;
4052 int SSL_get_security_level(const SSL *s)
4054 return s->cert->sec_level;
4057 void SSL_set_security_callback(SSL *s,
4058 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4059 int op, int bits, int nid,
4060 void *other, void *ex))
4062 s->cert->sec_cb = cb;
4065 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4066 const SSL_CTX *ctx, int op,
4067 int bits, int nid, void *other,
4069 return s->cert->sec_cb;
4072 void SSL_set0_security_ex_data(SSL *s, void *ex)
4074 s->cert->sec_ex = ex;
4077 void *SSL_get0_security_ex_data(const SSL *s)
4079 return s->cert->sec_ex;
4082 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4084 ctx->cert->sec_level = level;
4087 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4089 return ctx->cert->sec_level;
4092 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4093 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4094 int op, int bits, int nid,
4095 void *other, void *ex))
4097 ctx->cert->sec_cb = cb;
4100 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4106 return ctx->cert->sec_cb;
4109 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4111 ctx->cert->sec_ex = ex;
4114 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4116 return ctx->cert->sec_ex;
4120 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4121 * can return unsigned long, instead of the generic long return value from the
4122 * control interface.
4124 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4126 return ctx->options;
4129 unsigned long SSL_get_options(const SSL *s)
4134 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4136 return ctx->options |= op;
4139 unsigned long SSL_set_options(SSL *s, unsigned long op)
4141 return s->options |= op;
4144 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4146 return ctx->options &= ~op;
4149 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4151 return s->options &= ~op;
4154 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4156 return s->verified_chain;
4159 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4161 #ifndef OPENSSL_NO_CT
4164 * Moves SCTs from the |src| stack to the |dst| stack.
4165 * The source of each SCT will be set to |origin|.
4166 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4168 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4170 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4171 sct_source_t origin)
4177 *dst = sk_SCT_new_null();
4179 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4184 while ((sct = sk_SCT_pop(src)) != NULL) {
4185 if (SCT_set_source(sct, origin) != 1)
4188 if (sk_SCT_push(*dst, sct) <= 0)
4196 sk_SCT_push(src, sct); /* Put the SCT back */
4201 * Look for data collected during ServerHello and parse if found.
4202 * Returns the number of SCTs extracted.
4204 static int ct_extract_tls_extension_scts(SSL *s)
4206 int scts_extracted = 0;
4208 if (s->ext.scts != NULL) {
4209 const unsigned char *p = s->ext.scts;
4210 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4212 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4214 SCT_LIST_free(scts);
4217 return scts_extracted;
4221 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4222 * contains an SCT X509 extension. They will be stored in |s->scts|.
4224 * - The number of SCTs extracted, assuming an OCSP response exists.
4225 * - 0 if no OCSP response exists or it contains no SCTs.
4226 * - A negative integer if an error occurs.
4228 static int ct_extract_ocsp_response_scts(SSL *s)
4230 # ifndef OPENSSL_NO_OCSP
4231 int scts_extracted = 0;
4232 const unsigned char *p;
4233 OCSP_BASICRESP *br = NULL;
4234 OCSP_RESPONSE *rsp = NULL;
4235 STACK_OF(SCT) *scts = NULL;
4238 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4241 p = s->ext.ocsp.resp;
4242 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4246 br = OCSP_response_get1_basic(rsp);
4250 for (i = 0; i < OCSP_resp_count(br); ++i) {
4251 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4257 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4259 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4260 if (scts_extracted < 0)
4264 SCT_LIST_free(scts);
4265 OCSP_BASICRESP_free(br);
4266 OCSP_RESPONSE_free(rsp);
4267 return scts_extracted;
4269 /* Behave as if no OCSP response exists */
4275 * Attempts to extract SCTs from the peer certificate.
4276 * Return the number of SCTs extracted, or a negative integer if an error
4279 static int ct_extract_x509v3_extension_scts(SSL *s)
4281 int scts_extracted = 0;
4282 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4285 STACK_OF(SCT) *scts =
4286 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4289 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4291 SCT_LIST_free(scts);
4294 return scts_extracted;
4298 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4299 * response (if it exists) and X509v3 extensions in the certificate.
4300 * Returns NULL if an error occurs.
4302 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4304 if (!s->scts_parsed) {
4305 if (ct_extract_tls_extension_scts(s) < 0 ||
4306 ct_extract_ocsp_response_scts(s) < 0 ||
4307 ct_extract_x509v3_extension_scts(s) < 0)
4317 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4318 const STACK_OF(SCT) *scts, void *unused_arg)
4323 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4324 const STACK_OF(SCT) *scts, void *unused_arg)
4326 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4329 for (i = 0; i < count; ++i) {
4330 SCT *sct = sk_SCT_value(scts, i);
4331 int status = SCT_get_validation_status(sct);
4333 if (status == SCT_VALIDATION_STATUS_VALID)
4336 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4340 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4344 * Since code exists that uses the custom extension handler for CT, look
4345 * for this and throw an error if they have already registered to use CT.
4347 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4348 TLSEXT_TYPE_signed_certificate_timestamp))
4350 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4351 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4355 if (callback != NULL) {
4357 * If we are validating CT, then we MUST accept SCTs served via OCSP
4359 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4363 s->ct_validation_callback = callback;
4364 s->ct_validation_callback_arg = arg;
4369 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4370 ssl_ct_validation_cb callback, void *arg)
4373 * Since code exists that uses the custom extension handler for CT, look for
4374 * this and throw an error if they have already registered to use CT.
4376 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4377 TLSEXT_TYPE_signed_certificate_timestamp))
4379 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4380 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4384 ctx->ct_validation_callback = callback;
4385 ctx->ct_validation_callback_arg = arg;
4389 int SSL_ct_is_enabled(const SSL *s)
4391 return s->ct_validation_callback != NULL;
4394 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4396 return ctx->ct_validation_callback != NULL;
4399 int ssl_validate_ct(SSL *s)
4402 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4404 SSL_DANE *dane = &s->dane;
4405 CT_POLICY_EVAL_CTX *ctx = NULL;
4406 const STACK_OF(SCT) *scts;
4409 * If no callback is set, the peer is anonymous, or its chain is invalid,
4410 * skip SCT validation - just return success. Applications that continue
4411 * handshakes without certificates, with unverified chains, or pinned leaf
4412 * certificates are outside the scope of the WebPKI and CT.
4414 * The above exclusions notwithstanding the vast majority of peers will
4415 * have rather ordinary certificate chains validated by typical
4416 * applications that perform certificate verification and therefore will
4417 * process SCTs when enabled.
4419 if (s->ct_validation_callback == NULL || cert == NULL ||
4420 s->verify_result != X509_V_OK ||
4421 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4425 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4426 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4428 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4429 switch (dane->mtlsa->usage) {
4430 case DANETLS_USAGE_DANE_TA:
4431 case DANETLS_USAGE_DANE_EE:
4436 ctx = CT_POLICY_EVAL_CTX_new();
4438 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4442 issuer = sk_X509_value(s->verified_chain, 1);
4443 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4444 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4445 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4446 CT_POLICY_EVAL_CTX_set_time(
4447 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4449 scts = SSL_get0_peer_scts(s);
4452 * This function returns success (> 0) only when all the SCTs are valid, 0
4453 * when some are invalid, and < 0 on various internal errors (out of
4454 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4455 * reason to abort the handshake, that decision is up to the callback.
4456 * Therefore, we error out only in the unexpected case that the return
4457 * value is negative.
4459 * XXX: One might well argue that the return value of this function is an
4460 * unfortunate design choice. Its job is only to determine the validation
4461 * status of each of the provided SCTs. So long as it correctly separates
4462 * the wheat from the chaff it should return success. Failure in this case
4463 * ought to correspond to an inability to carry out its duties.
4465 if (SCT_LIST_validate(scts, ctx) < 0) {
4466 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4470 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4472 ret = 0; /* This function returns 0 on failure */
4475 CT_POLICY_EVAL_CTX_free(ctx);
4477 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4478 * failure return code here. Also the application may wish the complete
4479 * the handshake, and then disconnect cleanly at a higher layer, after
4480 * checking the verification status of the completed connection.
4482 * We therefore force a certificate verification failure which will be
4483 * visible via SSL_get_verify_result() and cached as part of any resumed
4486 * Note: the permissive callback is for information gathering only, always
4487 * returns success, and does not affect verification status. Only the
4488 * strict callback or a custom application-specified callback can trigger
4489 * connection failure or record a verification error.
4492 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4496 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4498 switch (validation_mode) {
4500 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4502 case SSL_CT_VALIDATION_PERMISSIVE:
4503 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4504 case SSL_CT_VALIDATION_STRICT:
4505 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4509 int SSL_enable_ct(SSL *s, int validation_mode)
4511 switch (validation_mode) {
4513 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4515 case SSL_CT_VALIDATION_PERMISSIVE:
4516 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4517 case SSL_CT_VALIDATION_STRICT:
4518 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4522 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4524 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4527 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4529 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4532 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4534 CTLOG_STORE_free(ctx->ctlog_store);
4535 ctx->ctlog_store = logs;
4538 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4540 return ctx->ctlog_store;
4543 #endif /* OPENSSL_NO_CT */
4545 void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn cb, void *arg)
4548 c->early_cb_arg = arg;
4551 int SSL_early_isv2(SSL *s)
4553 if (s->clienthello == NULL)
4555 return s->clienthello->isv2;
4558 unsigned int SSL_early_get0_legacy_version(SSL *s)
4560 if (s->clienthello == NULL)
4562 return s->clienthello->legacy_version;
4565 size_t SSL_early_get0_random(SSL *s, const unsigned char **out)
4567 if (s->clienthello == NULL)
4570 *out = s->clienthello->random;
4571 return SSL3_RANDOM_SIZE;
4574 size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out)
4576 if (s->clienthello == NULL)
4579 *out = s->clienthello->session_id;
4580 return s->clienthello->session_id_len;
4583 size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out)
4585 if (s->clienthello == NULL)
4588 *out = PACKET_data(&s->clienthello->ciphersuites);
4589 return PACKET_remaining(&s->clienthello->ciphersuites);
4592 size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out)
4594 if (s->clienthello == NULL)
4597 *out = s->clienthello->compressions;
4598 return s->clienthello->compressions_len;
4601 int SSL_early_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4607 if (s->clienthello == NULL)
4609 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4610 r = s->clienthello->pre_proc_exts + i;
4611 if (r->present && r->type == type) {
4613 *out = PACKET_data(&r->data);
4615 *outlen = PACKET_remaining(&r->data);
4622 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4624 ctx->keylog_callback = cb;
4627 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4629 return ctx->keylog_callback;
4632 static int nss_keylog_int(const char *prefix,
4634 const uint8_t *parameter_1,
4635 size_t parameter_1_len,
4636 const uint8_t *parameter_2,
4637 size_t parameter_2_len)
4640 char *cursor = NULL;
4645 if (ssl->ctx->keylog_callback == NULL) return 1;
4648 * Our output buffer will contain the following strings, rendered with
4649 * space characters in between, terminated by a NULL character: first the
4650 * prefix, then the first parameter, then the second parameter. The
4651 * meaning of each parameter depends on the specific key material being
4652 * logged. Note that the first and second parameters are encoded in
4653 * hexadecimal, so we need a buffer that is twice their lengths.
4655 prefix_len = strlen(prefix);
4656 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4657 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4658 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4662 strcpy(cursor, prefix);
4663 cursor += prefix_len;
4666 for (i = 0; i < parameter_1_len; i++) {
4667 sprintf(cursor, "%02x", parameter_1[i]);
4672 for (i = 0; i < parameter_2_len; i++) {
4673 sprintf(cursor, "%02x", parameter_2[i]);
4678 ssl->ctx->keylog_callback(ssl, (const char *)out);
4684 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4685 const uint8_t *encrypted_premaster,
4686 size_t encrypted_premaster_len,
4687 const uint8_t *premaster,
4688 size_t premaster_len)
4690 if (encrypted_premaster_len < 8) {
4691 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4695 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4696 return nss_keylog_int("RSA",
4698 encrypted_premaster,
4704 int ssl_log_secret(SSL *ssl,
4706 const uint8_t *secret,
4709 return nss_keylog_int(label,
4711 ssl->s3->client_random,
4717 #define SSLV2_CIPHER_LEN 3
4719 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format,
4724 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4726 if (PACKET_remaining(cipher_suites) == 0) {
4727 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST, SSL_R_NO_CIPHERS_SPECIFIED);
4728 *al = SSL_AD_ILLEGAL_PARAMETER;
4732 if (PACKET_remaining(cipher_suites) % n != 0) {
4733 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST,
4734 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4735 *al = SSL_AD_DECODE_ERROR;
4739 OPENSSL_free(s->s3->tmp.ciphers_raw);
4740 s->s3->tmp.ciphers_raw = NULL;
4741 s->s3->tmp.ciphers_rawlen = 0;
4744 size_t numciphers = PACKET_remaining(cipher_suites) / n;
4745 PACKET sslv2ciphers = *cipher_suites;
4746 unsigned int leadbyte;
4750 * We store the raw ciphers list in SSLv3+ format so we need to do some
4751 * preprocessing to convert the list first. If there are any SSLv2 only
4752 * ciphersuites with a non-zero leading byte then we are going to
4753 * slightly over allocate because we won't store those. But that isn't a
4756 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
4757 s->s3->tmp.ciphers_raw = raw;
4759 *al = SSL_AD_INTERNAL_ERROR;
4762 for (s->s3->tmp.ciphers_rawlen = 0;
4763 PACKET_remaining(&sslv2ciphers) > 0;
4764 raw += TLS_CIPHER_LEN) {
4765 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
4767 && !PACKET_copy_bytes(&sslv2ciphers, raw,
4770 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
4771 *al = SSL_AD_DECODE_ERROR;
4772 OPENSSL_free(s->s3->tmp.ciphers_raw);
4773 s->s3->tmp.ciphers_raw = NULL;
4774 s->s3->tmp.ciphers_rawlen = 0;
4778 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
4780 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
4781 &s->s3->tmp.ciphers_rawlen)) {
4782 *al = SSL_AD_INTERNAL_ERROR;
4790 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
4791 int isv2format, STACK_OF(SSL_CIPHER) **sk,
4792 STACK_OF(SSL_CIPHER) **scsvs)
4797 if (!PACKET_buf_init(&pkt, bytes, len))
4799 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, &alert);
4802 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
4803 STACK_OF(SSL_CIPHER) **skp,
4804 STACK_OF(SSL_CIPHER) **scsvs_out,
4805 int sslv2format, int *al)
4807 const SSL_CIPHER *c;
4808 STACK_OF(SSL_CIPHER) *sk = NULL;
4809 STACK_OF(SSL_CIPHER) *scsvs = NULL;
4811 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
4812 unsigned char cipher[SSLV2_CIPHER_LEN];
4814 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4816 if (PACKET_remaining(cipher_suites) == 0) {
4817 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
4818 *al = SSL_AD_ILLEGAL_PARAMETER;
4822 if (PACKET_remaining(cipher_suites) % n != 0) {
4823 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
4824 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4825 *al = SSL_AD_DECODE_ERROR;
4829 sk = sk_SSL_CIPHER_new_null();
4830 scsvs = sk_SSL_CIPHER_new_null();
4831 if (sk == NULL || scsvs == NULL) {
4832 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4833 *al = SSL_AD_INTERNAL_ERROR;
4837 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
4839 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
4840 * first byte set to zero, while true SSLv2 ciphers have a non-zero
4841 * first byte. We don't support any true SSLv2 ciphers, so skip them.
4843 if (sslv2format && cipher[0] != '\0')
4846 /* For SSLv2-compat, ignore leading 0-byte. */
4847 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
4849 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
4850 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
4851 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4852 *al = SSL_AD_INTERNAL_ERROR;
4857 if (PACKET_remaining(cipher_suites) > 0) {
4858 *al = SSL_AD_DECODE_ERROR;
4859 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
4866 sk_SSL_CIPHER_free(sk);
4867 if (scsvs_out != NULL)
4870 sk_SSL_CIPHER_free(scsvs);
4873 sk_SSL_CIPHER_free(sk);
4874 sk_SSL_CIPHER_free(scsvs);
4878 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
4880 ctx->max_early_data = max_early_data;
4885 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
4887 return ctx->max_early_data;
4890 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
4892 s->max_early_data = max_early_data;
4897 uint32_t SSL_get_max_early_data(const SSL *s)
4899 return s->max_early_data;