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->renegotiate == 0)
1930 return (s->method->ssl_renegotiate(s));
1933 int SSL_renegotiate_abbreviated(SSL *s)
1935 if (SSL_IS_TLS13(s))
1938 if (s->renegotiate == 0)
1943 return (s->method->ssl_renegotiate(s));
1946 int SSL_renegotiate_pending(SSL *s)
1949 * becomes true when negotiation is requested; false again once a
1950 * handshake has finished
1952 return (s->renegotiate != 0);
1955 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1960 case SSL_CTRL_GET_READ_AHEAD:
1961 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
1962 case SSL_CTRL_SET_READ_AHEAD:
1963 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
1964 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
1967 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
1968 s->msg_callback_arg = parg;
1972 return (s->mode |= larg);
1973 case SSL_CTRL_CLEAR_MODE:
1974 return (s->mode &= ~larg);
1975 case SSL_CTRL_GET_MAX_CERT_LIST:
1976 return (long)(s->max_cert_list);
1977 case SSL_CTRL_SET_MAX_CERT_LIST:
1980 l = (long)s->max_cert_list;
1981 s->max_cert_list = (size_t)larg;
1983 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
1984 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
1986 s->max_send_fragment = larg;
1987 if (s->max_send_fragment < s->split_send_fragment)
1988 s->split_send_fragment = s->max_send_fragment;
1990 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
1991 if ((size_t)larg > s->max_send_fragment || larg == 0)
1993 s->split_send_fragment = larg;
1995 case SSL_CTRL_SET_MAX_PIPELINES:
1996 if (larg < 1 || larg > SSL_MAX_PIPELINES)
1998 s->max_pipelines = larg;
2000 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2002 case SSL_CTRL_GET_RI_SUPPORT:
2004 return s->s3->send_connection_binding;
2007 case SSL_CTRL_CERT_FLAGS:
2008 return (s->cert->cert_flags |= larg);
2009 case SSL_CTRL_CLEAR_CERT_FLAGS:
2010 return (s->cert->cert_flags &= ~larg);
2012 case SSL_CTRL_GET_RAW_CIPHERLIST:
2014 if (s->s3->tmp.ciphers_raw == NULL)
2016 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2017 return (int)s->s3->tmp.ciphers_rawlen;
2019 return TLS_CIPHER_LEN;
2021 case SSL_CTRL_GET_EXTMS_SUPPORT:
2022 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2024 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2028 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2029 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2030 &s->min_proto_version);
2031 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2032 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2033 &s->max_proto_version);
2035 return (s->method->ssl_ctrl(s, cmd, larg, parg));
2039 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2042 case SSL_CTRL_SET_MSG_CALLBACK:
2043 s->msg_callback = (void (*)
2044 (int write_p, int version, int content_type,
2045 const void *buf, size_t len, SSL *ssl,
2050 return (s->method->ssl_callback_ctrl(s, cmd, fp));
2054 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2056 return ctx->sessions;
2059 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2062 /* For some cases with ctx == NULL perform syntax checks */
2065 #ifndef OPENSSL_NO_EC
2066 case SSL_CTRL_SET_GROUPS_LIST:
2067 return tls1_set_groups_list(NULL, NULL, parg);
2069 case SSL_CTRL_SET_SIGALGS_LIST:
2070 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2071 return tls1_set_sigalgs_list(NULL, parg, 0);
2078 case SSL_CTRL_GET_READ_AHEAD:
2079 return (ctx->read_ahead);
2080 case SSL_CTRL_SET_READ_AHEAD:
2081 l = ctx->read_ahead;
2082 ctx->read_ahead = larg;
2085 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2086 ctx->msg_callback_arg = parg;
2089 case SSL_CTRL_GET_MAX_CERT_LIST:
2090 return (long)(ctx->max_cert_list);
2091 case SSL_CTRL_SET_MAX_CERT_LIST:
2094 l = (long)ctx->max_cert_list;
2095 ctx->max_cert_list = (size_t)larg;
2098 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2101 l = (long)ctx->session_cache_size;
2102 ctx->session_cache_size = (size_t)larg;
2104 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2105 return (long)(ctx->session_cache_size);
2106 case SSL_CTRL_SET_SESS_CACHE_MODE:
2107 l = ctx->session_cache_mode;
2108 ctx->session_cache_mode = larg;
2110 case SSL_CTRL_GET_SESS_CACHE_MODE:
2111 return (ctx->session_cache_mode);
2113 case SSL_CTRL_SESS_NUMBER:
2114 return (lh_SSL_SESSION_num_items(ctx->sessions));
2115 case SSL_CTRL_SESS_CONNECT:
2116 return (ctx->stats.sess_connect);
2117 case SSL_CTRL_SESS_CONNECT_GOOD:
2118 return (ctx->stats.sess_connect_good);
2119 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2120 return (ctx->stats.sess_connect_renegotiate);
2121 case SSL_CTRL_SESS_ACCEPT:
2122 return (ctx->stats.sess_accept);
2123 case SSL_CTRL_SESS_ACCEPT_GOOD:
2124 return (ctx->stats.sess_accept_good);
2125 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2126 return (ctx->stats.sess_accept_renegotiate);
2127 case SSL_CTRL_SESS_HIT:
2128 return (ctx->stats.sess_hit);
2129 case SSL_CTRL_SESS_CB_HIT:
2130 return (ctx->stats.sess_cb_hit);
2131 case SSL_CTRL_SESS_MISSES:
2132 return (ctx->stats.sess_miss);
2133 case SSL_CTRL_SESS_TIMEOUTS:
2134 return (ctx->stats.sess_timeout);
2135 case SSL_CTRL_SESS_CACHE_FULL:
2136 return (ctx->stats.sess_cache_full);
2138 return (ctx->mode |= larg);
2139 case SSL_CTRL_CLEAR_MODE:
2140 return (ctx->mode &= ~larg);
2141 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2142 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2144 ctx->max_send_fragment = larg;
2145 if (ctx->max_send_fragment < ctx->split_send_fragment)
2146 ctx->split_send_fragment = ctx->max_send_fragment;
2148 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2149 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2151 ctx->split_send_fragment = larg;
2153 case SSL_CTRL_SET_MAX_PIPELINES:
2154 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2156 ctx->max_pipelines = larg;
2158 case SSL_CTRL_CERT_FLAGS:
2159 return (ctx->cert->cert_flags |= larg);
2160 case SSL_CTRL_CLEAR_CERT_FLAGS:
2161 return (ctx->cert->cert_flags &= ~larg);
2162 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2163 return ssl_set_version_bound(ctx->method->version, (int)larg,
2164 &ctx->min_proto_version);
2165 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2166 return ssl_set_version_bound(ctx->method->version, (int)larg,
2167 &ctx->max_proto_version);
2169 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2173 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2176 case SSL_CTRL_SET_MSG_CALLBACK:
2177 ctx->msg_callback = (void (*)
2178 (int write_p, int version, int content_type,
2179 const void *buf, size_t len, SSL *ssl,
2184 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2188 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2197 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2198 const SSL_CIPHER *const *bp)
2200 if ((*ap)->id > (*bp)->id)
2202 if ((*ap)->id < (*bp)->id)
2207 /** return a STACK of the ciphers available for the SSL and in order of
2209 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2212 if (s->cipher_list != NULL) {
2213 return (s->cipher_list);
2214 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2215 return (s->ctx->cipher_list);
2221 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2223 if ((s == NULL) || (s->session == NULL) || !s->server)
2225 return s->session->ciphers;
2228 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2230 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2232 ciphers = SSL_get_ciphers(s);
2235 ssl_set_client_disabled(s);
2236 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2237 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2238 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED, 0)) {
2240 sk = sk_SSL_CIPHER_new_null();
2243 if (!sk_SSL_CIPHER_push(sk, c)) {
2244 sk_SSL_CIPHER_free(sk);
2252 /** return a STACK of the ciphers available for the SSL and in order of
2254 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2257 if (s->cipher_list_by_id != NULL) {
2258 return (s->cipher_list_by_id);
2259 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2260 return (s->ctx->cipher_list_by_id);
2266 /** The old interface to get the same thing as SSL_get_ciphers() */
2267 const char *SSL_get_cipher_list(const SSL *s, int n)
2269 const SSL_CIPHER *c;
2270 STACK_OF(SSL_CIPHER) *sk;
2274 sk = SSL_get_ciphers(s);
2275 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2277 c = sk_SSL_CIPHER_value(sk, n);
2283 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2285 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2288 return ctx->cipher_list;
2292 /** specify the ciphers to be used by default by the SSL_CTX */
2293 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2295 STACK_OF(SSL_CIPHER) *sk;
2297 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2298 &ctx->cipher_list_by_id, str, ctx->cert);
2300 * ssl_create_cipher_list may return an empty stack if it was unable to
2301 * find a cipher matching the given rule string (for example if the rule
2302 * string specifies a cipher which has been disabled). This is not an
2303 * error as far as ssl_create_cipher_list is concerned, and hence
2304 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2308 else if (sk_SSL_CIPHER_num(sk) == 0) {
2309 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2315 /** specify the ciphers to be used by the SSL */
2316 int SSL_set_cipher_list(SSL *s, const char *str)
2318 STACK_OF(SSL_CIPHER) *sk;
2320 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2321 &s->cipher_list_by_id, str, s->cert);
2322 /* see comment in SSL_CTX_set_cipher_list */
2325 else if (sk_SSL_CIPHER_num(sk) == 0) {
2326 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2332 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2335 STACK_OF(SSL_CIPHER) *sk;
2336 const SSL_CIPHER *c;
2339 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2343 sk = s->session->ciphers;
2345 if (sk_SSL_CIPHER_num(sk) == 0)
2348 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2351 c = sk_SSL_CIPHER_value(sk, i);
2352 n = strlen(c->name);
2359 memcpy(p, c->name, n + 1);
2368 /** return a servername extension value if provided in Client Hello, or NULL.
2369 * So far, only host_name types are defined (RFC 3546).
2372 const char *SSL_get_servername(const SSL *s, const int type)
2374 if (type != TLSEXT_NAMETYPE_host_name)
2377 return s->session && !s->ext.hostname ?
2378 s->session->ext.hostname : s->ext.hostname;
2381 int SSL_get_servername_type(const SSL *s)
2384 && (!s->ext.hostname ? s->session->
2385 ext.hostname : s->ext.hostname))
2386 return TLSEXT_NAMETYPE_host_name;
2391 * SSL_select_next_proto implements the standard protocol selection. It is
2392 * expected that this function is called from the callback set by
2393 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2394 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2395 * not included in the length. A byte string of length 0 is invalid. No byte
2396 * string may be truncated. The current, but experimental algorithm for
2397 * selecting the protocol is: 1) If the server doesn't support NPN then this
2398 * is indicated to the callback. In this case, the client application has to
2399 * abort the connection or have a default application level protocol. 2) If
2400 * the server supports NPN, but advertises an empty list then the client
2401 * selects the first protocol in its list, but indicates via the API that this
2402 * fallback case was enacted. 3) Otherwise, the client finds the first
2403 * protocol in the server's list that it supports and selects this protocol.
2404 * This is because it's assumed that the server has better information about
2405 * which protocol a client should use. 4) If the client doesn't support any
2406 * of the server's advertised protocols, then this is treated the same as
2407 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2408 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2410 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2411 const unsigned char *server,
2412 unsigned int server_len,
2413 const unsigned char *client, unsigned int client_len)
2416 const unsigned char *result;
2417 int status = OPENSSL_NPN_UNSUPPORTED;
2420 * For each protocol in server preference order, see if we support it.
2422 for (i = 0; i < server_len;) {
2423 for (j = 0; j < client_len;) {
2424 if (server[i] == client[j] &&
2425 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2426 /* We found a match */
2427 result = &server[i];
2428 status = OPENSSL_NPN_NEGOTIATED;
2438 /* There's no overlap between our protocols and the server's list. */
2440 status = OPENSSL_NPN_NO_OVERLAP;
2443 *out = (unsigned char *)result + 1;
2444 *outlen = result[0];
2448 #ifndef OPENSSL_NO_NEXTPROTONEG
2450 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2451 * client's requested protocol for this connection and returns 0. If the
2452 * client didn't request any protocol, then *data is set to NULL. Note that
2453 * the client can request any protocol it chooses. The value returned from
2454 * this function need not be a member of the list of supported protocols
2455 * provided by the callback.
2457 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2464 *len = (unsigned int)s->ext.npn_len;
2469 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2470 * a TLS server needs a list of supported protocols for Next Protocol
2471 * Negotiation. The returned list must be in wire format. The list is
2472 * returned by setting |out| to point to it and |outlen| to its length. This
2473 * memory will not be modified, but one should assume that the SSL* keeps a
2474 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2475 * wishes to advertise. Otherwise, no such extension will be included in the
2478 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2479 SSL_CTX_npn_advertised_cb_func cb,
2482 ctx->ext.npn_advertised_cb = cb;
2483 ctx->ext.npn_advertised_cb_arg = arg;
2487 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2488 * client needs to select a protocol from the server's provided list. |out|
2489 * must be set to point to the selected protocol (which may be within |in|).
2490 * The length of the protocol name must be written into |outlen|. The
2491 * server's advertised protocols are provided in |in| and |inlen|. The
2492 * callback can assume that |in| is syntactically valid. The client must
2493 * select a protocol. It is fatal to the connection if this callback returns
2494 * a value other than SSL_TLSEXT_ERR_OK.
2496 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2497 SSL_CTX_npn_select_cb_func cb,
2500 ctx->ext.npn_select_cb = cb;
2501 ctx->ext.npn_select_cb_arg = arg;
2506 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2507 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2508 * length-prefixed strings). Returns 0 on success.
2510 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2511 unsigned int protos_len)
2513 OPENSSL_free(ctx->ext.alpn);
2514 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2515 if (ctx->ext.alpn == NULL) {
2516 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2519 ctx->ext.alpn_len = protos_len;
2525 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2526 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2527 * length-prefixed strings). Returns 0 on success.
2529 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2530 unsigned int protos_len)
2532 OPENSSL_free(ssl->ext.alpn);
2533 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2534 if (ssl->ext.alpn == NULL) {
2535 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2538 ssl->ext.alpn_len = protos_len;
2544 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2545 * called during ClientHello processing in order to select an ALPN protocol
2546 * from the client's list of offered protocols.
2548 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2549 SSL_CTX_alpn_select_cb_func cb,
2552 ctx->ext.alpn_select_cb = cb;
2553 ctx->ext.alpn_select_cb_arg = arg;
2557 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2558 * On return it sets |*data| to point to |*len| bytes of protocol name
2559 * (not including the leading length-prefix byte). If the server didn't
2560 * respond with a negotiated protocol then |*len| will be zero.
2562 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2567 *data = ssl->s3->alpn_selected;
2571 *len = (unsigned int)ssl->s3->alpn_selected_len;
2574 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2575 const char *label, size_t llen,
2576 const unsigned char *p, size_t plen,
2579 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2582 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2587 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2589 const unsigned char *session_id = a->session_id;
2591 unsigned char tmp_storage[4];
2593 if (a->session_id_length < sizeof(tmp_storage)) {
2594 memset(tmp_storage, 0, sizeof(tmp_storage));
2595 memcpy(tmp_storage, a->session_id, a->session_id_length);
2596 session_id = tmp_storage;
2600 ((unsigned long)session_id[0]) |
2601 ((unsigned long)session_id[1] << 8L) |
2602 ((unsigned long)session_id[2] << 16L) |
2603 ((unsigned long)session_id[3] << 24L);
2608 * NB: If this function (or indeed the hash function which uses a sort of
2609 * coarser function than this one) is changed, ensure
2610 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2611 * being able to construct an SSL_SESSION that will collide with any existing
2612 * session with a matching session ID.
2614 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2616 if (a->ssl_version != b->ssl_version)
2618 if (a->session_id_length != b->session_id_length)
2620 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2624 * These wrapper functions should remain rather than redeclaring
2625 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2626 * variable. The reason is that the functions aren't static, they're exposed
2630 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2632 SSL_CTX *ret = NULL;
2635 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2639 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2642 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2643 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2646 ret = OPENSSL_zalloc(sizeof(*ret));
2651 ret->min_proto_version = 0;
2652 ret->max_proto_version = 0;
2653 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2654 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2655 /* We take the system default. */
2656 ret->session_timeout = meth->get_timeout();
2657 ret->references = 1;
2658 ret->lock = CRYPTO_THREAD_lock_new();
2659 if (ret->lock == NULL) {
2660 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2664 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2665 ret->verify_mode = SSL_VERIFY_NONE;
2666 if ((ret->cert = ssl_cert_new()) == NULL)
2669 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2670 if (ret->sessions == NULL)
2672 ret->cert_store = X509_STORE_new();
2673 if (ret->cert_store == NULL)
2675 #ifndef OPENSSL_NO_CT
2676 ret->ctlog_store = CTLOG_STORE_new();
2677 if (ret->ctlog_store == NULL)
2680 if (!ssl_create_cipher_list(ret->method,
2681 &ret->cipher_list, &ret->cipher_list_by_id,
2682 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2683 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2684 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2688 ret->param = X509_VERIFY_PARAM_new();
2689 if (ret->param == NULL)
2692 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2693 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2696 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2697 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2701 if ((ret->ca_names = sk_X509_NAME_new_null()) == NULL)
2704 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2707 /* No compression for DTLS */
2708 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2709 ret->comp_methods = SSL_COMP_get_compression_methods();
2711 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2712 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2714 /* Setup RFC5077 ticket keys */
2715 if ((RAND_bytes(ret->ext.tick_key_name,
2716 sizeof(ret->ext.tick_key_name)) <= 0)
2717 || (RAND_bytes(ret->ext.tick_hmac_key,
2718 sizeof(ret->ext.tick_hmac_key)) <= 0)
2719 || (RAND_bytes(ret->ext.tick_aes_key,
2720 sizeof(ret->ext.tick_aes_key)) <= 0))
2721 ret->options |= SSL_OP_NO_TICKET;
2723 #ifndef OPENSSL_NO_SRP
2724 if (!SSL_CTX_SRP_CTX_init(ret))
2727 #ifndef OPENSSL_NO_ENGINE
2728 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2729 # define eng_strx(x) #x
2730 # define eng_str(x) eng_strx(x)
2731 /* Use specific client engine automatically... ignore errors */
2734 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2737 ENGINE_load_builtin_engines();
2738 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2740 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2746 * Default is to connect to non-RI servers. When RI is more widely
2747 * deployed might change this.
2749 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2751 * Disable compression by default to prevent CRIME. Applications can
2752 * re-enable compression by configuring
2753 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2754 * or by using the SSL_CONF library.
2756 ret->options |= SSL_OP_NO_COMPRESSION;
2758 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2761 * Default max early data is a fully loaded single record. Could be split
2762 * across multiple records in practice
2764 ret->max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
2768 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2774 int SSL_CTX_up_ref(SSL_CTX *ctx)
2778 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2781 REF_PRINT_COUNT("SSL_CTX", ctx);
2782 REF_ASSERT_ISNT(i < 2);
2783 return ((i > 1) ? 1 : 0);
2786 void SSL_CTX_free(SSL_CTX *a)
2793 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2794 REF_PRINT_COUNT("SSL_CTX", a);
2797 REF_ASSERT_ISNT(i < 0);
2799 X509_VERIFY_PARAM_free(a->param);
2800 dane_ctx_final(&a->dane);
2803 * Free internal session cache. However: the remove_cb() may reference
2804 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2805 * after the sessions were flushed.
2806 * As the ex_data handling routines might also touch the session cache,
2807 * the most secure solution seems to be: empty (flush) the cache, then
2808 * free ex_data, then finally free the cache.
2809 * (See ticket [openssl.org #212].)
2811 if (a->sessions != NULL)
2812 SSL_CTX_flush_sessions(a, 0);
2814 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2815 lh_SSL_SESSION_free(a->sessions);
2816 X509_STORE_free(a->cert_store);
2817 #ifndef OPENSSL_NO_CT
2818 CTLOG_STORE_free(a->ctlog_store);
2820 sk_SSL_CIPHER_free(a->cipher_list);
2821 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2822 ssl_cert_free(a->cert);
2823 sk_X509_NAME_pop_free(a->ca_names, X509_NAME_free);
2824 sk_X509_pop_free(a->extra_certs, X509_free);
2825 a->comp_methods = NULL;
2826 #ifndef OPENSSL_NO_SRTP
2827 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2829 #ifndef OPENSSL_NO_SRP
2830 SSL_CTX_SRP_CTX_free(a);
2832 #ifndef OPENSSL_NO_ENGINE
2833 ENGINE_finish(a->client_cert_engine);
2836 #ifndef OPENSSL_NO_EC
2837 OPENSSL_free(a->ext.ecpointformats);
2838 OPENSSL_free(a->ext.supportedgroups);
2840 OPENSSL_free(a->ext.alpn);
2842 CRYPTO_THREAD_lock_free(a->lock);
2847 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2849 ctx->default_passwd_callback = cb;
2852 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2854 ctx->default_passwd_callback_userdata = u;
2857 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2859 return ctx->default_passwd_callback;
2862 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2864 return ctx->default_passwd_callback_userdata;
2867 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2869 s->default_passwd_callback = cb;
2872 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2874 s->default_passwd_callback_userdata = u;
2877 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2879 return s->default_passwd_callback;
2882 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2884 return s->default_passwd_callback_userdata;
2887 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2888 int (*cb) (X509_STORE_CTX *, void *),
2891 ctx->app_verify_callback = cb;
2892 ctx->app_verify_arg = arg;
2895 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2896 int (*cb) (int, X509_STORE_CTX *))
2898 ctx->verify_mode = mode;
2899 ctx->default_verify_callback = cb;
2902 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2904 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2907 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2909 ssl_cert_set_cert_cb(c->cert, cb, arg);
2912 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2914 ssl_cert_set_cert_cb(s->cert, cb, arg);
2917 void ssl_set_masks(SSL *s)
2920 uint32_t *pvalid = s->s3->tmp.valid_flags;
2921 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2922 unsigned long mask_k, mask_a;
2923 #ifndef OPENSSL_NO_EC
2924 int have_ecc_cert, ecdsa_ok;
2929 #ifndef OPENSSL_NO_DH
2930 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2935 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2936 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2937 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
2938 #ifndef OPENSSL_NO_EC
2939 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2945 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2946 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2949 #ifndef OPENSSL_NO_GOST
2950 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2951 mask_k |= SSL_kGOST;
2952 mask_a |= SSL_aGOST12;
2954 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2955 mask_k |= SSL_kGOST;
2956 mask_a |= SSL_aGOST12;
2958 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2959 mask_k |= SSL_kGOST;
2960 mask_a |= SSL_aGOST01;
2970 if (rsa_enc || rsa_sign) {
2978 mask_a |= SSL_aNULL;
2981 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
2982 * depending on the key usage extension.
2984 #ifndef OPENSSL_NO_EC
2985 if (have_ecc_cert) {
2987 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
2988 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
2989 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
2992 mask_a |= SSL_aECDSA;
2996 #ifndef OPENSSL_NO_EC
2997 mask_k |= SSL_kECDHE;
3000 #ifndef OPENSSL_NO_PSK
3003 if (mask_k & SSL_kRSA)
3004 mask_k |= SSL_kRSAPSK;
3005 if (mask_k & SSL_kDHE)
3006 mask_k |= SSL_kDHEPSK;
3007 if (mask_k & SSL_kECDHE)
3008 mask_k |= SSL_kECDHEPSK;
3011 s->s3->tmp.mask_k = mask_k;
3012 s->s3->tmp.mask_a = mask_a;
3015 #ifndef OPENSSL_NO_EC
3017 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3019 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3020 /* key usage, if present, must allow signing */
3021 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3022 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3023 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3027 return 1; /* all checks are ok */
3032 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3033 size_t *serverinfo_length)
3035 CERT_PKEY *cpk = s->s3->tmp.cert;
3036 *serverinfo_length = 0;
3038 if (cpk == NULL || cpk->serverinfo == NULL)
3041 *serverinfo = cpk->serverinfo;
3042 *serverinfo_length = cpk->serverinfo_length;
3046 void ssl_update_cache(SSL *s, int mode)
3051 * If the session_id_length is 0, we are not supposed to cache it, and it
3052 * would be rather hard to do anyway :-)
3054 if (s->session->session_id_length == 0)
3057 i = s->session_ctx->session_cache_mode;
3058 if ((i & mode) && (!s->hit)
3059 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
3060 || SSL_CTX_add_session(s->session_ctx, s->session))
3061 && (s->session_ctx->new_session_cb != NULL)) {
3062 SSL_SESSION_up_ref(s->session);
3063 if (!s->session_ctx->new_session_cb(s, s->session))
3064 SSL_SESSION_free(s->session);
3067 /* auto flush every 255 connections */
3068 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3069 if ((((mode & SSL_SESS_CACHE_CLIENT)
3070 ? s->session_ctx->stats.sess_connect_good
3071 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
3072 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3077 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3082 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3087 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3091 if (s->method != meth) {
3092 const SSL_METHOD *sm = s->method;
3093 int (*hf) (SSL *) = s->handshake_func;
3095 if (sm->version == meth->version)
3100 ret = s->method->ssl_new(s);
3103 if (hf == sm->ssl_connect)
3104 s->handshake_func = meth->ssl_connect;
3105 else if (hf == sm->ssl_accept)
3106 s->handshake_func = meth->ssl_accept;
3111 int SSL_get_error(const SSL *s, int i)
3118 return (SSL_ERROR_NONE);
3121 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3122 * where we do encode the error
3124 if ((l = ERR_peek_error()) != 0) {
3125 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3126 return (SSL_ERROR_SYSCALL);
3128 return (SSL_ERROR_SSL);
3131 if (SSL_want_read(s)) {
3132 bio = SSL_get_rbio(s);
3133 if (BIO_should_read(bio))
3134 return (SSL_ERROR_WANT_READ);
3135 else if (BIO_should_write(bio))
3137 * This one doesn't make too much sense ... We never try to write
3138 * to the rbio, and an application program where rbio and wbio
3139 * are separate couldn't even know what it should wait for.
3140 * However if we ever set s->rwstate incorrectly (so that we have
3141 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3142 * wbio *are* the same, this test works around that bug; so it
3143 * might be safer to keep it.
3145 return (SSL_ERROR_WANT_WRITE);
3146 else if (BIO_should_io_special(bio)) {
3147 reason = BIO_get_retry_reason(bio);
3148 if (reason == BIO_RR_CONNECT)
3149 return (SSL_ERROR_WANT_CONNECT);
3150 else if (reason == BIO_RR_ACCEPT)
3151 return (SSL_ERROR_WANT_ACCEPT);
3153 return (SSL_ERROR_SYSCALL); /* unknown */
3157 if (SSL_want_write(s)) {
3158 /* Access wbio directly - in order to use the buffered bio if present */
3160 if (BIO_should_write(bio))
3161 return (SSL_ERROR_WANT_WRITE);
3162 else if (BIO_should_read(bio))
3164 * See above (SSL_want_read(s) with BIO_should_write(bio))
3166 return (SSL_ERROR_WANT_READ);
3167 else if (BIO_should_io_special(bio)) {
3168 reason = BIO_get_retry_reason(bio);
3169 if (reason == BIO_RR_CONNECT)
3170 return (SSL_ERROR_WANT_CONNECT);
3171 else if (reason == BIO_RR_ACCEPT)
3172 return (SSL_ERROR_WANT_ACCEPT);
3174 return (SSL_ERROR_SYSCALL);
3177 if (SSL_want_x509_lookup(s))
3178 return (SSL_ERROR_WANT_X509_LOOKUP);
3179 if (SSL_want_async(s))
3180 return SSL_ERROR_WANT_ASYNC;
3181 if (SSL_want_async_job(s))
3182 return SSL_ERROR_WANT_ASYNC_JOB;
3183 if (SSL_want_early(s))
3184 return SSL_ERROR_WANT_EARLY;
3186 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3187 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3188 return (SSL_ERROR_ZERO_RETURN);
3190 return (SSL_ERROR_SYSCALL);
3193 static int ssl_do_handshake_intern(void *vargs)
3195 struct ssl_async_args *args;
3198 args = (struct ssl_async_args *)vargs;
3201 return s->handshake_func(s);
3204 int SSL_do_handshake(SSL *s)
3208 if (s->handshake_func == NULL) {
3209 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3213 ossl_statem_check_finish_init(s, -1);
3215 s->method->ssl_renegotiate_check(s, 0);
3217 if (SSL_in_init(s) || SSL_in_before(s)) {
3218 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3219 struct ssl_async_args args;
3223 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3225 ret = s->handshake_func(s);
3231 void SSL_set_accept_state(SSL *s)
3235 ossl_statem_clear(s);
3236 s->handshake_func = s->method->ssl_accept;
3240 void SSL_set_connect_state(SSL *s)
3244 ossl_statem_clear(s);
3245 s->handshake_func = s->method->ssl_connect;
3249 int ssl_undefined_function(SSL *s)
3251 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3255 int ssl_undefined_void_function(void)
3257 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3258 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3262 int ssl_undefined_const_function(const SSL *s)
3267 const SSL_METHOD *ssl_bad_method(int ver)
3269 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3273 const char *ssl_protocol_to_string(int version)
3277 case TLS1_3_VERSION:
3280 case TLS1_2_VERSION:
3283 case TLS1_1_VERSION:
3298 case DTLS1_2_VERSION:
3306 const char *SSL_get_version(const SSL *s)
3308 return ssl_protocol_to_string(s->version);
3311 SSL *SSL_dup(SSL *s)
3313 STACK_OF(X509_NAME) *sk;
3318 /* If we're not quiescent, just up_ref! */
3319 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3320 CRYPTO_UP_REF(&s->references, &i, s->lock);
3325 * Otherwise, copy configuration state, and session if set.
3327 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3330 if (s->session != NULL) {
3332 * Arranges to share the same session via up_ref. This "copies"
3333 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3335 if (!SSL_copy_session_id(ret, s))
3339 * No session has been established yet, so we have to expect that
3340 * s->cert or ret->cert will be changed later -- they should not both
3341 * point to the same object, and thus we can't use
3342 * SSL_copy_session_id.
3344 if (!SSL_set_ssl_method(ret, s->method))
3347 if (s->cert != NULL) {
3348 ssl_cert_free(ret->cert);
3349 ret->cert = ssl_cert_dup(s->cert);
3350 if (ret->cert == NULL)
3354 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3355 (int)s->sid_ctx_length))
3359 if (!ssl_dane_dup(ret, s))
3361 ret->version = s->version;
3362 ret->options = s->options;
3363 ret->mode = s->mode;
3364 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3365 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3366 ret->msg_callback = s->msg_callback;
3367 ret->msg_callback_arg = s->msg_callback_arg;
3368 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3369 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3370 ret->generate_session_id = s->generate_session_id;
3372 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3374 /* copy app data, a little dangerous perhaps */
3375 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3378 /* setup rbio, and wbio */
3379 if (s->rbio != NULL) {
3380 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3383 if (s->wbio != NULL) {
3384 if (s->wbio != s->rbio) {
3385 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3388 BIO_up_ref(ret->rbio);
3389 ret->wbio = ret->rbio;
3393 ret->server = s->server;
3394 if (s->handshake_func) {
3396 SSL_set_accept_state(ret);
3398 SSL_set_connect_state(ret);
3400 ret->shutdown = s->shutdown;
3403 ret->default_passwd_callback = s->default_passwd_callback;
3404 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3406 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3408 /* dup the cipher_list and cipher_list_by_id stacks */
3409 if (s->cipher_list != NULL) {
3410 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3413 if (s->cipher_list_by_id != NULL)
3414 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3418 /* Dup the client_CA list */
3419 if (s->ca_names != NULL) {
3420 if ((sk = sk_X509_NAME_dup(s->ca_names)) == NULL)
3423 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3424 xn = sk_X509_NAME_value(sk, i);
3425 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3438 void ssl_clear_cipher_ctx(SSL *s)
3440 if (s->enc_read_ctx != NULL) {
3441 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3442 s->enc_read_ctx = NULL;
3444 if (s->enc_write_ctx != NULL) {
3445 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3446 s->enc_write_ctx = NULL;
3448 #ifndef OPENSSL_NO_COMP
3449 COMP_CTX_free(s->expand);
3451 COMP_CTX_free(s->compress);
3456 X509 *SSL_get_certificate(const SSL *s)
3458 if (s->cert != NULL)
3459 return (s->cert->key->x509);
3464 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3466 if (s->cert != NULL)
3467 return (s->cert->key->privatekey);
3472 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3474 if (ctx->cert != NULL)
3475 return ctx->cert->key->x509;
3480 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3482 if (ctx->cert != NULL)
3483 return ctx->cert->key->privatekey;
3488 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3490 if ((s->session != NULL) && (s->session->cipher != NULL))
3491 return (s->session->cipher);
3495 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3497 #ifndef OPENSSL_NO_COMP
3498 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3504 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3506 #ifndef OPENSSL_NO_COMP
3507 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3513 int ssl_init_wbio_buffer(SSL *s)
3517 if (s->bbio != NULL) {
3518 /* Already buffered. */
3522 bbio = BIO_new(BIO_f_buffer());
3523 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3525 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3529 s->wbio = BIO_push(bbio, s->wbio);
3534 int ssl_free_wbio_buffer(SSL *s)
3536 /* callers ensure s is never null */
3537 if (s->bbio == NULL)
3540 s->wbio = BIO_pop(s->wbio);
3541 if (!ossl_assert(s->wbio != NULL))
3549 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3551 ctx->quiet_shutdown = mode;
3554 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3556 return (ctx->quiet_shutdown);
3559 void SSL_set_quiet_shutdown(SSL *s, int mode)
3561 s->quiet_shutdown = mode;
3564 int SSL_get_quiet_shutdown(const SSL *s)
3566 return (s->quiet_shutdown);
3569 void SSL_set_shutdown(SSL *s, int mode)
3574 int SSL_get_shutdown(const SSL *s)
3579 int SSL_version(const SSL *s)
3584 int SSL_client_version(const SSL *s)
3586 return s->client_version;
3589 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3594 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3597 if (ssl->ctx == ctx)
3600 ctx = ssl->session_ctx;
3601 new_cert = ssl_cert_dup(ctx->cert);
3602 if (new_cert == NULL) {
3606 if (!custom_exts_copy_flags(&new_cert->custext, &ssl->cert->custext)) {
3607 ssl_cert_free(new_cert);
3611 ssl_cert_free(ssl->cert);
3612 ssl->cert = new_cert;
3615 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3616 * so setter APIs must prevent invalid lengths from entering the system.
3618 if (!ossl_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx)))
3622 * If the session ID context matches that of the parent SSL_CTX,
3623 * inherit it from the new SSL_CTX as well. If however the context does
3624 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3625 * leave it unchanged.
3627 if ((ssl->ctx != NULL) &&
3628 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3629 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3630 ssl->sid_ctx_length = ctx->sid_ctx_length;
3631 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3634 SSL_CTX_up_ref(ctx);
3635 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3641 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3643 return (X509_STORE_set_default_paths(ctx->cert_store));
3646 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3648 X509_LOOKUP *lookup;
3650 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3653 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3655 /* Clear any errors if the default directory does not exist */
3661 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3663 X509_LOOKUP *lookup;
3665 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3669 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3671 /* Clear any errors if the default file does not exist */
3677 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3680 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3683 void SSL_set_info_callback(SSL *ssl,
3684 void (*cb) (const SSL *ssl, int type, int val))
3686 ssl->info_callback = cb;
3690 * One compiler (Diab DCC) doesn't like argument names in returned function
3693 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3696 return ssl->info_callback;
3699 void SSL_set_verify_result(SSL *ssl, long arg)
3701 ssl->verify_result = arg;
3704 long SSL_get_verify_result(const SSL *ssl)
3706 return (ssl->verify_result);
3709 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3712 return sizeof(ssl->s3->client_random);
3713 if (outlen > sizeof(ssl->s3->client_random))
3714 outlen = sizeof(ssl->s3->client_random);
3715 memcpy(out, ssl->s3->client_random, outlen);
3719 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3722 return sizeof(ssl->s3->server_random);
3723 if (outlen > sizeof(ssl->s3->server_random))
3724 outlen = sizeof(ssl->s3->server_random);
3725 memcpy(out, ssl->s3->server_random, outlen);
3729 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3730 unsigned char *out, size_t outlen)
3733 return session->master_key_length;
3734 if (outlen > session->master_key_length)
3735 outlen = session->master_key_length;
3736 memcpy(out, session->master_key, outlen);
3740 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3742 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3745 void *SSL_get_ex_data(const SSL *s, int idx)
3747 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3750 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3752 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3755 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3757 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3760 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3762 return (ctx->cert_store);
3765 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3767 X509_STORE_free(ctx->cert_store);
3768 ctx->cert_store = store;
3771 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3774 X509_STORE_up_ref(store);
3775 SSL_CTX_set_cert_store(ctx, store);
3778 int SSL_want(const SSL *s)
3780 return (s->rwstate);
3784 * \brief Set the callback for generating temporary DH keys.
3785 * \param ctx the SSL context.
3786 * \param dh the callback
3789 #ifndef OPENSSL_NO_DH
3790 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3791 DH *(*dh) (SSL *ssl, int is_export,
3794 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3797 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3800 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3804 #ifndef OPENSSL_NO_PSK
3805 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3807 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3808 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3811 OPENSSL_free(ctx->cert->psk_identity_hint);
3812 if (identity_hint != NULL) {
3813 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3814 if (ctx->cert->psk_identity_hint == NULL)
3817 ctx->cert->psk_identity_hint = NULL;
3821 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3826 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3827 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3830 OPENSSL_free(s->cert->psk_identity_hint);
3831 if (identity_hint != NULL) {
3832 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3833 if (s->cert->psk_identity_hint == NULL)
3836 s->cert->psk_identity_hint = NULL;
3840 const char *SSL_get_psk_identity_hint(const SSL *s)
3842 if (s == NULL || s->session == NULL)
3844 return (s->session->psk_identity_hint);
3847 const char *SSL_get_psk_identity(const SSL *s)
3849 if (s == NULL || s->session == NULL)
3851 return (s->session->psk_identity);
3854 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3856 s->psk_client_callback = cb;
3859 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3861 ctx->psk_client_callback = cb;
3864 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3866 s->psk_server_callback = cb;
3869 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3871 ctx->psk_server_callback = cb;
3875 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3876 void (*cb) (int write_p, int version,
3877 int content_type, const void *buf,
3878 size_t len, SSL *ssl, void *arg))
3880 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3883 void SSL_set_msg_callback(SSL *ssl,
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_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3891 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3892 int (*cb) (SSL *ssl,
3896 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3897 (void (*)(void))cb);
3900 void SSL_set_not_resumable_session_callback(SSL *ssl,
3901 int (*cb) (SSL *ssl,
3902 int is_forward_secure))
3904 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3905 (void (*)(void))cb);
3908 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
3909 size_t (*cb) (SSL *ssl, int type,
3910 size_t len, void *arg))
3912 ctx->record_padding_cb = cb;
3915 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg)
3917 ctx->record_padding_arg = arg;
3920 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx)
3922 return ctx->record_padding_arg;
3925 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size)
3927 /* block size of 0 or 1 is basically no padding */
3928 if (block_size == 1)
3929 ctx->block_padding = 0;
3930 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
3931 ctx->block_padding = block_size;
3937 void SSL_set_record_padding_callback(SSL *ssl,
3938 size_t (*cb) (SSL *ssl, int type,
3939 size_t len, void *arg))
3941 ssl->record_padding_cb = cb;
3944 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg)
3946 ssl->record_padding_arg = arg;
3949 void *SSL_get_record_padding_callback_arg(SSL *ssl)
3951 return ssl->record_padding_arg;
3954 int SSL_set_block_padding(SSL *ssl, size_t block_size)
3956 /* block size of 0 or 1 is basically no padding */
3957 if (block_size == 1)
3958 ssl->block_padding = 0;
3959 else if (block_size <= SSL3_RT_MAX_PLAIN_LENGTH)
3960 ssl->block_padding = block_size;
3967 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3968 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3969 * If EVP_MD pointer is passed, initializes ctx with this |md|.
3970 * Returns the newly allocated ctx;
3973 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3975 ssl_clear_hash_ctx(hash);
3976 *hash = EVP_MD_CTX_new();
3977 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3978 EVP_MD_CTX_free(*hash);
3985 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3988 EVP_MD_CTX_free(*hash);
3992 /* Retrieve handshake hashes */
3993 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3996 EVP_MD_CTX *ctx = NULL;
3997 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3998 int hashleni = EVP_MD_CTX_size(hdgst);
4001 if (hashleni < 0 || (size_t)hashleni > outlen)
4004 ctx = EVP_MD_CTX_new();
4008 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
4009 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
4012 *hashlen = hashleni;
4016 EVP_MD_CTX_free(ctx);
4020 int SSL_session_reused(SSL *s)
4025 int SSL_is_server(const SSL *s)
4030 #if OPENSSL_API_COMPAT < 0x10100000L
4031 void SSL_set_debug(SSL *s, int debug)
4033 /* Old function was do-nothing anyway... */
4039 void SSL_set_security_level(SSL *s, int level)
4041 s->cert->sec_level = level;
4044 int SSL_get_security_level(const SSL *s)
4046 return s->cert->sec_level;
4049 void SSL_set_security_callback(SSL *s,
4050 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4051 int op, int bits, int nid,
4052 void *other, void *ex))
4054 s->cert->sec_cb = cb;
4057 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4058 const SSL_CTX *ctx, int op,
4059 int bits, int nid, void *other,
4061 return s->cert->sec_cb;
4064 void SSL_set0_security_ex_data(SSL *s, void *ex)
4066 s->cert->sec_ex = ex;
4069 void *SSL_get0_security_ex_data(const SSL *s)
4071 return s->cert->sec_ex;
4074 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4076 ctx->cert->sec_level = level;
4079 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4081 return ctx->cert->sec_level;
4084 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4085 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4086 int op, int bits, int nid,
4087 void *other, void *ex))
4089 ctx->cert->sec_cb = cb;
4092 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4098 return ctx->cert->sec_cb;
4101 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4103 ctx->cert->sec_ex = ex;
4106 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4108 return ctx->cert->sec_ex;
4112 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4113 * can return unsigned long, instead of the generic long return value from the
4114 * control interface.
4116 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4118 return ctx->options;
4121 unsigned long SSL_get_options(const SSL *s)
4126 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4128 return ctx->options |= op;
4131 unsigned long SSL_set_options(SSL *s, unsigned long op)
4133 return s->options |= op;
4136 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4138 return ctx->options &= ~op;
4141 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4143 return s->options &= ~op;
4146 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4148 return s->verified_chain;
4151 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4153 #ifndef OPENSSL_NO_CT
4156 * Moves SCTs from the |src| stack to the |dst| stack.
4157 * The source of each SCT will be set to |origin|.
4158 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4160 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4162 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4163 sct_source_t origin)
4169 *dst = sk_SCT_new_null();
4171 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4176 while ((sct = sk_SCT_pop(src)) != NULL) {
4177 if (SCT_set_source(sct, origin) != 1)
4180 if (sk_SCT_push(*dst, sct) <= 0)
4188 sk_SCT_push(src, sct); /* Put the SCT back */
4193 * Look for data collected during ServerHello and parse if found.
4194 * Returns the number of SCTs extracted.
4196 static int ct_extract_tls_extension_scts(SSL *s)
4198 int scts_extracted = 0;
4200 if (s->ext.scts != NULL) {
4201 const unsigned char *p = s->ext.scts;
4202 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4204 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4206 SCT_LIST_free(scts);
4209 return scts_extracted;
4213 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4214 * contains an SCT X509 extension. They will be stored in |s->scts|.
4216 * - The number of SCTs extracted, assuming an OCSP response exists.
4217 * - 0 if no OCSP response exists or it contains no SCTs.
4218 * - A negative integer if an error occurs.
4220 static int ct_extract_ocsp_response_scts(SSL *s)
4222 # ifndef OPENSSL_NO_OCSP
4223 int scts_extracted = 0;
4224 const unsigned char *p;
4225 OCSP_BASICRESP *br = NULL;
4226 OCSP_RESPONSE *rsp = NULL;
4227 STACK_OF(SCT) *scts = NULL;
4230 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4233 p = s->ext.ocsp.resp;
4234 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4238 br = OCSP_response_get1_basic(rsp);
4242 for (i = 0; i < OCSP_resp_count(br); ++i) {
4243 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4249 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4251 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4252 if (scts_extracted < 0)
4256 SCT_LIST_free(scts);
4257 OCSP_BASICRESP_free(br);
4258 OCSP_RESPONSE_free(rsp);
4259 return scts_extracted;
4261 /* Behave as if no OCSP response exists */
4267 * Attempts to extract SCTs from the peer certificate.
4268 * Return the number of SCTs extracted, or a negative integer if an error
4271 static int ct_extract_x509v3_extension_scts(SSL *s)
4273 int scts_extracted = 0;
4274 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4277 STACK_OF(SCT) *scts =
4278 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4281 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4283 SCT_LIST_free(scts);
4286 return scts_extracted;
4290 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4291 * response (if it exists) and X509v3 extensions in the certificate.
4292 * Returns NULL if an error occurs.
4294 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4296 if (!s->scts_parsed) {
4297 if (ct_extract_tls_extension_scts(s) < 0 ||
4298 ct_extract_ocsp_response_scts(s) < 0 ||
4299 ct_extract_x509v3_extension_scts(s) < 0)
4309 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4310 const STACK_OF(SCT) *scts, void *unused_arg)
4315 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4316 const STACK_OF(SCT) *scts, void *unused_arg)
4318 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4321 for (i = 0; i < count; ++i) {
4322 SCT *sct = sk_SCT_value(scts, i);
4323 int status = SCT_get_validation_status(sct);
4325 if (status == SCT_VALIDATION_STATUS_VALID)
4328 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4332 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4336 * Since code exists that uses the custom extension handler for CT, look
4337 * for this and throw an error if they have already registered to use CT.
4339 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4340 TLSEXT_TYPE_signed_certificate_timestamp))
4342 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4343 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4347 if (callback != NULL) {
4349 * If we are validating CT, then we MUST accept SCTs served via OCSP
4351 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4355 s->ct_validation_callback = callback;
4356 s->ct_validation_callback_arg = arg;
4361 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4362 ssl_ct_validation_cb callback, void *arg)
4365 * Since code exists that uses the custom extension handler for CT, look for
4366 * this and throw an error if they have already registered to use CT.
4368 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4369 TLSEXT_TYPE_signed_certificate_timestamp))
4371 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4372 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4376 ctx->ct_validation_callback = callback;
4377 ctx->ct_validation_callback_arg = arg;
4381 int SSL_ct_is_enabled(const SSL *s)
4383 return s->ct_validation_callback != NULL;
4386 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4388 return ctx->ct_validation_callback != NULL;
4391 int ssl_validate_ct(SSL *s)
4394 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4396 SSL_DANE *dane = &s->dane;
4397 CT_POLICY_EVAL_CTX *ctx = NULL;
4398 const STACK_OF(SCT) *scts;
4401 * If no callback is set, the peer is anonymous, or its chain is invalid,
4402 * skip SCT validation - just return success. Applications that continue
4403 * handshakes without certificates, with unverified chains, or pinned leaf
4404 * certificates are outside the scope of the WebPKI and CT.
4406 * The above exclusions notwithstanding the vast majority of peers will
4407 * have rather ordinary certificate chains validated by typical
4408 * applications that perform certificate verification and therefore will
4409 * process SCTs when enabled.
4411 if (s->ct_validation_callback == NULL || cert == NULL ||
4412 s->verify_result != X509_V_OK ||
4413 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4417 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4418 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4420 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4421 switch (dane->mtlsa->usage) {
4422 case DANETLS_USAGE_DANE_TA:
4423 case DANETLS_USAGE_DANE_EE:
4428 ctx = CT_POLICY_EVAL_CTX_new();
4430 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4434 issuer = sk_X509_value(s->verified_chain, 1);
4435 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4436 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4437 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4438 CT_POLICY_EVAL_CTX_set_time(
4439 ctx, (uint64_t)SSL_SESSION_get_time(SSL_get0_session(s)) * 1000);
4441 scts = SSL_get0_peer_scts(s);
4444 * This function returns success (> 0) only when all the SCTs are valid, 0
4445 * when some are invalid, and < 0 on various internal errors (out of
4446 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4447 * reason to abort the handshake, that decision is up to the callback.
4448 * Therefore, we error out only in the unexpected case that the return
4449 * value is negative.
4451 * XXX: One might well argue that the return value of this function is an
4452 * unfortunate design choice. Its job is only to determine the validation
4453 * status of each of the provided SCTs. So long as it correctly separates
4454 * the wheat from the chaff it should return success. Failure in this case
4455 * ought to correspond to an inability to carry out its duties.
4457 if (SCT_LIST_validate(scts, ctx) < 0) {
4458 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4462 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4464 ret = 0; /* This function returns 0 on failure */
4467 CT_POLICY_EVAL_CTX_free(ctx);
4469 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4470 * failure return code here. Also the application may wish the complete
4471 * the handshake, and then disconnect cleanly at a higher layer, after
4472 * checking the verification status of the completed connection.
4474 * We therefore force a certificate verification failure which will be
4475 * visible via SSL_get_verify_result() and cached as part of any resumed
4478 * Note: the permissive callback is for information gathering only, always
4479 * returns success, and does not affect verification status. Only the
4480 * strict callback or a custom application-specified callback can trigger
4481 * connection failure or record a verification error.
4484 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4488 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4490 switch (validation_mode) {
4492 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4494 case SSL_CT_VALIDATION_PERMISSIVE:
4495 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4496 case SSL_CT_VALIDATION_STRICT:
4497 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4501 int SSL_enable_ct(SSL *s, int validation_mode)
4503 switch (validation_mode) {
4505 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4507 case SSL_CT_VALIDATION_PERMISSIVE:
4508 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4509 case SSL_CT_VALIDATION_STRICT:
4510 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4514 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4516 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4519 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4521 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4524 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4526 CTLOG_STORE_free(ctx->ctlog_store);
4527 ctx->ctlog_store = logs;
4530 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4532 return ctx->ctlog_store;
4535 #endif /* OPENSSL_NO_CT */
4537 void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn cb, void *arg)
4540 c->early_cb_arg = arg;
4543 int SSL_early_isv2(SSL *s)
4545 if (s->clienthello == NULL)
4547 return s->clienthello->isv2;
4550 unsigned int SSL_early_get0_legacy_version(SSL *s)
4552 if (s->clienthello == NULL)
4554 return s->clienthello->legacy_version;
4557 size_t SSL_early_get0_random(SSL *s, const unsigned char **out)
4559 if (s->clienthello == NULL)
4562 *out = s->clienthello->random;
4563 return SSL3_RANDOM_SIZE;
4566 size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out)
4568 if (s->clienthello == NULL)
4571 *out = s->clienthello->session_id;
4572 return s->clienthello->session_id_len;
4575 size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out)
4577 if (s->clienthello == NULL)
4580 *out = PACKET_data(&s->clienthello->ciphersuites);
4581 return PACKET_remaining(&s->clienthello->ciphersuites);
4584 size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out)
4586 if (s->clienthello == NULL)
4589 *out = s->clienthello->compressions;
4590 return s->clienthello->compressions_len;
4593 int SSL_early_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4599 if (s->clienthello == NULL)
4601 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4602 r = s->clienthello->pre_proc_exts + i;
4603 if (r->present && r->type == type) {
4605 *out = PACKET_data(&r->data);
4607 *outlen = PACKET_remaining(&r->data);
4614 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4616 ctx->keylog_callback = cb;
4619 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4621 return ctx->keylog_callback;
4624 static int nss_keylog_int(const char *prefix,
4626 const uint8_t *parameter_1,
4627 size_t parameter_1_len,
4628 const uint8_t *parameter_2,
4629 size_t parameter_2_len)
4632 char *cursor = NULL;
4637 if (ssl->ctx->keylog_callback == NULL) return 1;
4640 * Our output buffer will contain the following strings, rendered with
4641 * space characters in between, terminated by a NULL character: first the
4642 * prefix, then the first parameter, then the second parameter. The
4643 * meaning of each parameter depends on the specific key material being
4644 * logged. Note that the first and second parameters are encoded in
4645 * hexadecimal, so we need a buffer that is twice their lengths.
4647 prefix_len = strlen(prefix);
4648 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4649 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4650 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4654 strcpy(cursor, prefix);
4655 cursor += prefix_len;
4658 for (i = 0; i < parameter_1_len; i++) {
4659 sprintf(cursor, "%02x", parameter_1[i]);
4664 for (i = 0; i < parameter_2_len; i++) {
4665 sprintf(cursor, "%02x", parameter_2[i]);
4670 ssl->ctx->keylog_callback(ssl, (const char *)out);
4676 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4677 const uint8_t *encrypted_premaster,
4678 size_t encrypted_premaster_len,
4679 const uint8_t *premaster,
4680 size_t premaster_len)
4682 if (encrypted_premaster_len < 8) {
4683 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4687 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4688 return nss_keylog_int("RSA",
4690 encrypted_premaster,
4696 int ssl_log_secret(SSL *ssl,
4698 const uint8_t *secret,
4701 return nss_keylog_int(label,
4703 ssl->s3->client_random,
4709 #define SSLV2_CIPHER_LEN 3
4711 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format,
4716 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4718 if (PACKET_remaining(cipher_suites) == 0) {
4719 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST, SSL_R_NO_CIPHERS_SPECIFIED);
4720 *al = SSL_AD_ILLEGAL_PARAMETER;
4724 if (PACKET_remaining(cipher_suites) % n != 0) {
4725 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST,
4726 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4727 *al = SSL_AD_DECODE_ERROR;
4731 OPENSSL_free(s->s3->tmp.ciphers_raw);
4732 s->s3->tmp.ciphers_raw = NULL;
4733 s->s3->tmp.ciphers_rawlen = 0;
4736 size_t numciphers = PACKET_remaining(cipher_suites) / n;
4737 PACKET sslv2ciphers = *cipher_suites;
4738 unsigned int leadbyte;
4742 * We store the raw ciphers list in SSLv3+ format so we need to do some
4743 * preprocessing to convert the list first. If there are any SSLv2 only
4744 * ciphersuites with a non-zero leading byte then we are going to
4745 * slightly over allocate because we won't store those. But that isn't a
4748 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
4749 s->s3->tmp.ciphers_raw = raw;
4751 *al = SSL_AD_INTERNAL_ERROR;
4754 for (s->s3->tmp.ciphers_rawlen = 0;
4755 PACKET_remaining(&sslv2ciphers) > 0;
4756 raw += TLS_CIPHER_LEN) {
4757 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
4759 && !PACKET_copy_bytes(&sslv2ciphers, raw,
4762 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
4763 *al = SSL_AD_DECODE_ERROR;
4764 OPENSSL_free(s->s3->tmp.ciphers_raw);
4765 s->s3->tmp.ciphers_raw = NULL;
4766 s->s3->tmp.ciphers_rawlen = 0;
4770 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
4772 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
4773 &s->s3->tmp.ciphers_rawlen)) {
4774 *al = SSL_AD_INTERNAL_ERROR;
4782 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
4783 int isv2format, STACK_OF(SSL_CIPHER) **sk,
4784 STACK_OF(SSL_CIPHER) **scsvs)
4789 if (!PACKET_buf_init(&pkt, bytes, len))
4791 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, &alert);
4794 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
4795 STACK_OF(SSL_CIPHER) **skp,
4796 STACK_OF(SSL_CIPHER) **scsvs_out,
4797 int sslv2format, int *al)
4799 const SSL_CIPHER *c;
4800 STACK_OF(SSL_CIPHER) *sk = NULL;
4801 STACK_OF(SSL_CIPHER) *scsvs = NULL;
4803 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
4804 unsigned char cipher[SSLV2_CIPHER_LEN];
4806 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4808 if (PACKET_remaining(cipher_suites) == 0) {
4809 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
4810 *al = SSL_AD_ILLEGAL_PARAMETER;
4814 if (PACKET_remaining(cipher_suites) % n != 0) {
4815 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
4816 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4817 *al = SSL_AD_DECODE_ERROR;
4821 sk = sk_SSL_CIPHER_new_null();
4822 scsvs = sk_SSL_CIPHER_new_null();
4823 if (sk == NULL || scsvs == NULL) {
4824 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4825 *al = SSL_AD_INTERNAL_ERROR;
4829 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
4831 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
4832 * first byte set to zero, while true SSLv2 ciphers have a non-zero
4833 * first byte. We don't support any true SSLv2 ciphers, so skip them.
4835 if (sslv2format && cipher[0] != '\0')
4838 /* For SSLv2-compat, ignore leading 0-byte. */
4839 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
4841 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
4842 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
4843 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4844 *al = SSL_AD_INTERNAL_ERROR;
4849 if (PACKET_remaining(cipher_suites) > 0) {
4850 *al = SSL_AD_DECODE_ERROR;
4851 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_BAD_LENGTH);
4858 sk_SSL_CIPHER_free(sk);
4859 if (scsvs_out != NULL)
4862 sk_SSL_CIPHER_free(scsvs);
4865 sk_SSL_CIPHER_free(sk);
4866 sk_SSL_CIPHER_free(scsvs);
4870 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
4872 ctx->max_early_data = max_early_data;
4877 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
4879 return ctx->max_early_data;
4882 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
4884 s->max_early_data = max_early_data;
4889 uint32_t SSL_get_max_early_data(const SSL *s)
4891 return s->max_early_data;