2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 * ECC cipher suite support in OpenSSL originally developed by
13 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
15 /* ====================================================================
16 * Copyright 2005 Nokia. All rights reserved.
18 * The portions of the attached software ("Contribution") is developed by
19 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
22 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24 * support (see RFC 4279) to OpenSSL.
26 * No patent licenses or other rights except those expressly stated in
27 * the OpenSSL open source license shall be deemed granted or received
28 * expressly, by implication, estoppel, or otherwise.
30 * No assurances are provided by Nokia that the Contribution does not
31 * infringe the patent or other intellectual property rights of any third
32 * party or that the license provides you with all the necessary rights
33 * to make use of the Contribution.
35 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
45 #include <openssl/objects.h>
46 #include <openssl/lhash.h>
47 #include <openssl/x509v3.h>
48 #include <openssl/rand.h>
49 #include <openssl/ocsp.h>
50 #include <openssl/dh.h>
51 #include <openssl/engine.h>
52 #include <openssl/async.h>
53 #include <openssl/ct.h>
55 const char SSL_version_str[] = OPENSSL_VERSION_TEXT;
57 SSL3_ENC_METHOD ssl3_undef_enc_method = {
59 * evil casts, but these functions are only called if there's a library
62 (int (*)(SSL *, SSL3_RECORD *, size_t, int))ssl_undefined_function,
63 (int (*)(SSL *, SSL3_RECORD *, unsigned char *, int))ssl_undefined_function,
64 ssl_undefined_function,
65 (int (*)(SSL *, unsigned char *, unsigned char *, size_t, size_t *))
66 ssl_undefined_function,
67 (int (*)(SSL *, int))ssl_undefined_function,
68 (size_t (*)(SSL *, const char *, size_t, unsigned char *))
69 ssl_undefined_function,
70 NULL, /* client_finished_label */
71 0, /* client_finished_label_len */
72 NULL, /* server_finished_label */
73 0, /* server_finished_label_len */
74 (int (*)(int))ssl_undefined_function,
75 (int (*)(SSL *, unsigned char *, size_t, const char *,
76 size_t, const unsigned char *, size_t,
77 int use_context))ssl_undefined_function,
80 struct ssl_async_args {
84 enum { READFUNC, WRITEFUNC, OTHERFUNC } type;
86 int (*func_read) (SSL *, void *, size_t, size_t *);
87 int (*func_write) (SSL *, const void *, size_t, size_t *);
88 int (*func_other) (SSL *);
98 DANETLS_MATCHING_FULL, 0, NID_undef
101 DANETLS_MATCHING_2256, 1, NID_sha256
104 DANETLS_MATCHING_2512, 2, NID_sha512
108 static int ssl_write_early_finish(SSL *s);
110 static int dane_ctx_enable(struct dane_ctx_st *dctx)
112 const EVP_MD **mdevp;
114 uint8_t mdmax = DANETLS_MATCHING_LAST;
115 int n = ((int)mdmax) + 1; /* int to handle PrivMatch(255) */
118 if (dctx->mdevp != NULL)
121 mdevp = OPENSSL_zalloc(n * sizeof(*mdevp));
122 mdord = OPENSSL_zalloc(n * sizeof(*mdord));
124 if (mdord == NULL || mdevp == NULL) {
127 SSLerr(SSL_F_DANE_CTX_ENABLE, ERR_R_MALLOC_FAILURE);
131 /* Install default entries */
132 for (i = 0; i < OSSL_NELEM(dane_mds); ++i) {
135 if (dane_mds[i].nid == NID_undef ||
136 (md = EVP_get_digestbynid(dane_mds[i].nid)) == NULL)
138 mdevp[dane_mds[i].mtype] = md;
139 mdord[dane_mds[i].mtype] = dane_mds[i].ord;
149 static void dane_ctx_final(struct dane_ctx_st *dctx)
151 OPENSSL_free(dctx->mdevp);
154 OPENSSL_free(dctx->mdord);
159 static void tlsa_free(danetls_record *t)
163 OPENSSL_free(t->data);
164 EVP_PKEY_free(t->spki);
168 static void dane_final(SSL_DANE *dane)
170 sk_danetls_record_pop_free(dane->trecs, tlsa_free);
173 sk_X509_pop_free(dane->certs, X509_free);
176 X509_free(dane->mcert);
184 * dane_copy - Copy dane configuration, sans verification state.
186 static int ssl_dane_dup(SSL *to, SSL *from)
191 if (!DANETLS_ENABLED(&from->dane))
194 dane_final(&to->dane);
195 to->dane.flags = from->dane.flags;
196 to->dane.dctx = &to->ctx->dane;
197 to->dane.trecs = sk_danetls_record_new_null();
199 if (to->dane.trecs == NULL) {
200 SSLerr(SSL_F_SSL_DANE_DUP, ERR_R_MALLOC_FAILURE);
204 num = sk_danetls_record_num(from->dane.trecs);
205 for (i = 0; i < num; ++i) {
206 danetls_record *t = sk_danetls_record_value(from->dane.trecs, i);
208 if (SSL_dane_tlsa_add(to, t->usage, t->selector, t->mtype,
209 t->data, t->dlen) <= 0)
215 static int dane_mtype_set(struct dane_ctx_st *dctx,
216 const EVP_MD *md, uint8_t mtype, uint8_t ord)
220 if (mtype == DANETLS_MATCHING_FULL && md != NULL) {
221 SSLerr(SSL_F_DANE_MTYPE_SET, SSL_R_DANE_CANNOT_OVERRIDE_MTYPE_FULL);
225 if (mtype > dctx->mdmax) {
226 const EVP_MD **mdevp;
228 int n = ((int)mtype) + 1;
230 mdevp = OPENSSL_realloc(dctx->mdevp, n * sizeof(*mdevp));
232 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
237 mdord = OPENSSL_realloc(dctx->mdord, n * sizeof(*mdord));
239 SSLerr(SSL_F_DANE_MTYPE_SET, ERR_R_MALLOC_FAILURE);
244 /* Zero-fill any gaps */
245 for (i = dctx->mdmax + 1; i < mtype; ++i) {
253 dctx->mdevp[mtype] = md;
254 /* Coerce ordinal of disabled matching types to 0 */
255 dctx->mdord[mtype] = (md == NULL) ? 0 : ord;
260 static const EVP_MD *tlsa_md_get(SSL_DANE *dane, uint8_t mtype)
262 if (mtype > dane->dctx->mdmax)
264 return dane->dctx->mdevp[mtype];
267 static int dane_tlsa_add(SSL_DANE *dane,
270 uint8_t mtype, unsigned char *data, size_t dlen)
273 const EVP_MD *md = NULL;
274 int ilen = (int)dlen;
278 if (dane->trecs == NULL) {
279 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_NOT_ENABLED);
283 if (ilen < 0 || dlen != (size_t)ilen) {
284 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DATA_LENGTH);
288 if (usage > DANETLS_USAGE_LAST) {
289 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE_USAGE);
293 if (selector > DANETLS_SELECTOR_LAST) {
294 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_SELECTOR);
298 if (mtype != DANETLS_MATCHING_FULL) {
299 md = tlsa_md_get(dane, mtype);
301 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_MATCHING_TYPE);
306 if (md != NULL && dlen != (size_t)EVP_MD_size(md)) {
307 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_DIGEST_LENGTH);
311 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_NULL_DATA);
315 if ((t = OPENSSL_zalloc(sizeof(*t))) == NULL) {
316 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
321 t->selector = selector;
323 t->data = OPENSSL_malloc(dlen);
324 if (t->data == NULL) {
326 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
329 memcpy(t->data, data, dlen);
332 /* Validate and cache full certificate or public key */
333 if (mtype == DANETLS_MATCHING_FULL) {
334 const unsigned char *p = data;
336 EVP_PKEY *pkey = NULL;
339 case DANETLS_SELECTOR_CERT:
340 if (!d2i_X509(&cert, &p, ilen) || p < data ||
341 dlen != (size_t)(p - data)) {
343 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
346 if (X509_get0_pubkey(cert) == NULL) {
348 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_CERTIFICATE);
352 if ((DANETLS_USAGE_BIT(usage) & DANETLS_TA_MASK) == 0) {
358 * For usage DANE-TA(2), we support authentication via "2 0 0" TLSA
359 * records that contain full certificates of trust-anchors that are
360 * not present in the wire chain. For usage PKIX-TA(0), we augment
361 * the chain with untrusted Full(0) certificates from DNS, in case
362 * they are missing from the chain.
364 if ((dane->certs == NULL &&
365 (dane->certs = sk_X509_new_null()) == NULL) ||
366 !sk_X509_push(dane->certs, cert)) {
367 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
374 case DANETLS_SELECTOR_SPKI:
375 if (!d2i_PUBKEY(&pkey, &p, ilen) || p < data ||
376 dlen != (size_t)(p - data)) {
378 SSLerr(SSL_F_DANE_TLSA_ADD, SSL_R_DANE_TLSA_BAD_PUBLIC_KEY);
383 * For usage DANE-TA(2), we support authentication via "2 1 0" TLSA
384 * records that contain full bare keys of trust-anchors that are
385 * not present in the wire chain.
387 if (usage == DANETLS_USAGE_DANE_TA)
396 * Find the right insertion point for the new record.
398 * See crypto/x509/x509_vfy.c. We sort DANE-EE(3) records first, so that
399 * they can be processed first, as they require no chain building, and no
400 * expiration or hostname checks. Because DANE-EE(3) is numerically
401 * largest, this is accomplished via descending sort by "usage".
403 * We also sort in descending order by matching ordinal to simplify
404 * the implementation of digest agility in the verification code.
406 * The choice of order for the selector is not significant, so we
407 * use the same descending order for consistency.
409 num = sk_danetls_record_num(dane->trecs);
410 for (i = 0; i < num; ++i) {
411 danetls_record *rec = sk_danetls_record_value(dane->trecs, i);
413 if (rec->usage > usage)
415 if (rec->usage < usage)
417 if (rec->selector > selector)
419 if (rec->selector < selector)
421 if (dane->dctx->mdord[rec->mtype] > dane->dctx->mdord[mtype])
426 if (!sk_danetls_record_insert(dane->trecs, t, i)) {
428 SSLerr(SSL_F_DANE_TLSA_ADD, ERR_R_MALLOC_FAILURE);
431 dane->umask |= DANETLS_USAGE_BIT(usage);
436 static void clear_ciphers(SSL *s)
438 /* clear the current cipher */
439 ssl_clear_cipher_ctx(s);
440 ssl_clear_hash_ctx(&s->read_hash);
441 ssl_clear_hash_ctx(&s->write_hash);
444 int SSL_clear(SSL *s)
446 if (s->method == NULL) {
447 SSLerr(SSL_F_SSL_CLEAR, SSL_R_NO_METHOD_SPECIFIED);
451 if (ssl_clear_bad_session(s)) {
452 SSL_SESSION_free(s->session);
460 if (s->renegotiate) {
461 SSLerr(SSL_F_SSL_CLEAR, ERR_R_INTERNAL_ERROR);
465 ossl_statem_clear(s);
467 s->version = s->method->version;
468 s->client_version = s->version;
469 s->rwstate = SSL_NOTHING;
471 BUF_MEM_free(s->init_buf);
476 s->key_update = SSL_KEY_UPDATE_NONE;
478 /* Reset DANE verification result state */
481 X509_free(s->dane.mcert);
482 s->dane.mcert = NULL;
483 s->dane.mtlsa = NULL;
485 /* Clear the verification result peername */
486 X509_VERIFY_PARAM_move_peername(s->param, NULL);
489 * Check to see if we were changed into a different method, if so, revert
490 * back if we are not doing session-id reuse.
492 if (!ossl_statem_get_in_handshake(s) && (s->session == NULL)
493 && (s->method != s->ctx->method)) {
494 s->method->ssl_free(s);
495 s->method = s->ctx->method;
496 if (!s->method->ssl_new(s))
499 s->method->ssl_clear(s);
501 RECORD_LAYER_clear(&s->rlayer);
506 /** Used to change an SSL_CTXs default SSL method type */
507 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth)
509 STACK_OF(SSL_CIPHER) *sk;
513 sk = ssl_create_cipher_list(ctx->method, &(ctx->cipher_list),
514 &(ctx->cipher_list_by_id),
515 SSL_DEFAULT_CIPHER_LIST, ctx->cert);
516 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= 0)) {
517 SSLerr(SSL_F_SSL_CTX_SET_SSL_VERSION, SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS);
523 SSL *SSL_new(SSL_CTX *ctx)
528 SSLerr(SSL_F_SSL_NEW, SSL_R_NULL_SSL_CTX);
531 if (ctx->method == NULL) {
532 SSLerr(SSL_F_SSL_NEW, SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION);
536 s = OPENSSL_zalloc(sizeof(*s));
540 s->lock = CRYPTO_THREAD_lock_new();
541 if (s->lock == NULL) {
542 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
547 RECORD_LAYER_init(&s->rlayer, s);
549 s->options = ctx->options;
550 s->dane.flags = ctx->dane.flags;
551 s->min_proto_version = ctx->min_proto_version;
552 s->max_proto_version = ctx->max_proto_version;
554 s->max_cert_list = ctx->max_cert_list;
556 s->max_early_data = ctx->max_early_data;
559 * Earlier library versions used to copy the pointer to the CERT, not
560 * its contents; only when setting new parameters for the per-SSL
561 * copy, ssl_cert_new would be called (and the direct reference to
562 * the per-SSL_CTX settings would be lost, but those still were
563 * indirectly accessed for various purposes, and for that reason they
564 * used to be known as s->ctx->default_cert). Now we don't look at the
565 * SSL_CTX's CERT after having duplicated it once.
567 s->cert = ssl_cert_dup(ctx->cert);
571 RECORD_LAYER_set_read_ahead(&s->rlayer, ctx->read_ahead);
572 s->msg_callback = ctx->msg_callback;
573 s->msg_callback_arg = ctx->msg_callback_arg;
574 s->verify_mode = ctx->verify_mode;
575 s->not_resumable_session_cb = ctx->not_resumable_session_cb;
576 s->sid_ctx_length = ctx->sid_ctx_length;
577 OPENSSL_assert(s->sid_ctx_length <= sizeof s->sid_ctx);
578 memcpy(&s->sid_ctx, &ctx->sid_ctx, sizeof(s->sid_ctx));
579 s->verify_callback = ctx->default_verify_callback;
580 s->generate_session_id = ctx->generate_session_id;
582 s->param = X509_VERIFY_PARAM_new();
583 if (s->param == NULL)
585 X509_VERIFY_PARAM_inherit(s->param, ctx->param);
586 s->quiet_shutdown = ctx->quiet_shutdown;
587 s->max_send_fragment = ctx->max_send_fragment;
588 s->split_send_fragment = ctx->split_send_fragment;
589 s->max_pipelines = ctx->max_pipelines;
590 if (s->max_pipelines > 1)
591 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
592 if (ctx->default_read_buf_len > 0)
593 SSL_set_default_read_buffer_len(s, ctx->default_read_buf_len);
598 s->ext.debug_arg = NULL;
599 s->ext.ticket_expected = 0;
600 s->ext.status_type = ctx->ext.status_type;
601 s->ext.status_expected = 0;
602 s->ext.ocsp.ids = NULL;
603 s->ext.ocsp.exts = NULL;
604 s->ext.ocsp.resp = NULL;
605 s->ext.ocsp.resp_len = 0;
607 s->session_ctx = ctx;
608 #ifndef OPENSSL_NO_EC
609 if (ctx->ext.ecpointformats) {
610 s->ext.ecpointformats =
611 OPENSSL_memdup(ctx->ext.ecpointformats,
612 ctx->ext.ecpointformats_len);
613 if (!s->ext.ecpointformats)
615 s->ext.ecpointformats_len =
616 ctx->ext.ecpointformats_len;
618 if (ctx->ext.supportedgroups) {
619 s->ext.supportedgroups =
620 OPENSSL_memdup(ctx->ext.supportedgroups,
621 ctx->ext.supportedgroups_len);
622 if (!s->ext.supportedgroups)
624 s->ext.supportedgroups_len = ctx->ext.supportedgroups_len;
627 #ifndef OPENSSL_NO_NEXTPROTONEG
631 if (s->ctx->ext.alpn) {
632 s->ext.alpn = OPENSSL_malloc(s->ctx->ext.alpn_len);
633 if (s->ext.alpn == NULL)
635 memcpy(s->ext.alpn, s->ctx->ext.alpn, s->ctx->ext.alpn_len);
636 s->ext.alpn_len = s->ctx->ext.alpn_len;
639 s->verified_chain = NULL;
640 s->verify_result = X509_V_OK;
642 s->default_passwd_callback = ctx->default_passwd_callback;
643 s->default_passwd_callback_userdata = ctx->default_passwd_callback_userdata;
645 s->method = ctx->method;
647 s->key_update = SSL_KEY_UPDATE_NONE;
649 if (!s->method->ssl_new(s))
652 s->server = (ctx->method->ssl_accept == ssl_undefined_function) ? 0 : 1;
657 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data))
660 #ifndef OPENSSL_NO_PSK
661 s->psk_client_callback = ctx->psk_client_callback;
662 s->psk_server_callback = ctx->psk_server_callback;
667 #ifndef OPENSSL_NO_CT
668 if (!SSL_set_ct_validation_callback(s, ctx->ct_validation_callback,
669 ctx->ct_validation_callback_arg))
676 SSLerr(SSL_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
680 int SSL_is_dtls(const SSL *s)
682 return SSL_IS_DTLS(s) ? 1 : 0;
685 int SSL_up_ref(SSL *s)
689 if (CRYPTO_UP_REF(&s->references, &i, s->lock) <= 0)
692 REF_PRINT_COUNT("SSL", s);
693 REF_ASSERT_ISNT(i < 2);
694 return ((i > 1) ? 1 : 0);
697 int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
698 unsigned int sid_ctx_len)
700 if (sid_ctx_len > sizeof ctx->sid_ctx) {
701 SSLerr(SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT,
702 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
705 ctx->sid_ctx_length = sid_ctx_len;
706 memcpy(ctx->sid_ctx, sid_ctx, sid_ctx_len);
711 int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
712 unsigned int sid_ctx_len)
714 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
715 SSLerr(SSL_F_SSL_SET_SESSION_ID_CONTEXT,
716 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
719 ssl->sid_ctx_length = sid_ctx_len;
720 memcpy(ssl->sid_ctx, sid_ctx, sid_ctx_len);
725 int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb)
727 CRYPTO_THREAD_write_lock(ctx->lock);
728 ctx->generate_session_id = cb;
729 CRYPTO_THREAD_unlock(ctx->lock);
733 int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb)
735 CRYPTO_THREAD_write_lock(ssl->lock);
736 ssl->generate_session_id = cb;
737 CRYPTO_THREAD_unlock(ssl->lock);
741 int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
745 * A quick examination of SSL_SESSION_hash and SSL_SESSION_cmp shows how
746 * we can "construct" a session to give us the desired check - ie. to
747 * find if there's a session in the hash table that would conflict with
748 * any new session built out of this id/id_len and the ssl_version in use
753 if (id_len > sizeof r.session_id)
756 r.ssl_version = ssl->version;
757 r.session_id_length = id_len;
758 memcpy(r.session_id, id, id_len);
760 CRYPTO_THREAD_read_lock(ssl->session_ctx->lock);
761 p = lh_SSL_SESSION_retrieve(ssl->session_ctx->sessions, &r);
762 CRYPTO_THREAD_unlock(ssl->session_ctx->lock);
766 int SSL_CTX_set_purpose(SSL_CTX *s, int purpose)
768 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
771 int SSL_set_purpose(SSL *s, int purpose)
773 return X509_VERIFY_PARAM_set_purpose(s->param, purpose);
776 int SSL_CTX_set_trust(SSL_CTX *s, int trust)
778 return X509_VERIFY_PARAM_set_trust(s->param, trust);
781 int SSL_set_trust(SSL *s, int trust)
783 return X509_VERIFY_PARAM_set_trust(s->param, trust);
786 int SSL_set1_host(SSL *s, const char *hostname)
788 return X509_VERIFY_PARAM_set1_host(s->param, hostname, 0);
791 int SSL_add1_host(SSL *s, const char *hostname)
793 return X509_VERIFY_PARAM_add1_host(s->param, hostname, 0);
796 void SSL_set_hostflags(SSL *s, unsigned int flags)
798 X509_VERIFY_PARAM_set_hostflags(s->param, flags);
801 const char *SSL_get0_peername(SSL *s)
803 return X509_VERIFY_PARAM_get0_peername(s->param);
806 int SSL_CTX_dane_enable(SSL_CTX *ctx)
808 return dane_ctx_enable(&ctx->dane);
811 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags)
813 unsigned long orig = ctx->dane.flags;
815 ctx->dane.flags |= flags;
819 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags)
821 unsigned long orig = ctx->dane.flags;
823 ctx->dane.flags &= ~flags;
827 int SSL_dane_enable(SSL *s, const char *basedomain)
829 SSL_DANE *dane = &s->dane;
831 if (s->ctx->dane.mdmax == 0) {
832 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_CONTEXT_NOT_DANE_ENABLED);
835 if (dane->trecs != NULL) {
836 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_DANE_ALREADY_ENABLED);
841 * Default SNI name. This rejects empty names, while set1_host below
842 * accepts them and disables host name checks. To avoid side-effects with
843 * invalid input, set the SNI name first.
845 if (s->ext.hostname == NULL) {
846 if (!SSL_set_tlsext_host_name(s, basedomain)) {
847 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
852 /* Primary RFC6125 reference identifier */
853 if (!X509_VERIFY_PARAM_set1_host(s->param, basedomain, 0)) {
854 SSLerr(SSL_F_SSL_DANE_ENABLE, SSL_R_ERROR_SETTING_TLSA_BASE_DOMAIN);
860 dane->dctx = &s->ctx->dane;
861 dane->trecs = sk_danetls_record_new_null();
863 if (dane->trecs == NULL) {
864 SSLerr(SSL_F_SSL_DANE_ENABLE, ERR_R_MALLOC_FAILURE);
870 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags)
872 unsigned long orig = ssl->dane.flags;
874 ssl->dane.flags |= flags;
878 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags)
880 unsigned long orig = ssl->dane.flags;
882 ssl->dane.flags &= ~flags;
886 int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki)
888 SSL_DANE *dane = &s->dane;
890 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
894 *mcert = dane->mcert;
896 *mspki = (dane->mcert == NULL) ? dane->mtlsa->spki : NULL;
901 int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
902 uint8_t *mtype, unsigned const char **data, size_t *dlen)
904 SSL_DANE *dane = &s->dane;
906 if (!DANETLS_ENABLED(dane) || s->verify_result != X509_V_OK)
910 *usage = dane->mtlsa->usage;
912 *selector = dane->mtlsa->selector;
914 *mtype = dane->mtlsa->mtype;
916 *data = dane->mtlsa->data;
918 *dlen = dane->mtlsa->dlen;
923 SSL_DANE *SSL_get0_dane(SSL *s)
928 int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
929 uint8_t mtype, unsigned char *data, size_t dlen)
931 return dane_tlsa_add(&s->dane, usage, selector, mtype, data, dlen);
934 int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md, uint8_t mtype,
937 return dane_mtype_set(&ctx->dane, md, mtype, ord);
940 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
942 return X509_VERIFY_PARAM_set1(ctx->param, vpm);
945 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
947 return X509_VERIFY_PARAM_set1(ssl->param, vpm);
950 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
955 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
960 void SSL_certs_clear(SSL *s)
962 ssl_cert_clear_certs(s->cert);
965 void SSL_free(SSL *s)
972 CRYPTO_DOWN_REF(&s->references, &i, s->lock);
973 REF_PRINT_COUNT("SSL", s);
976 REF_ASSERT_ISNT(i < 0);
978 X509_VERIFY_PARAM_free(s->param);
979 dane_final(&s->dane);
980 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL, s, &s->ex_data);
982 ssl_free_wbio_buffer(s);
984 BIO_free_all(s->wbio);
985 BIO_free_all(s->rbio);
987 BUF_MEM_free(s->init_buf);
989 /* add extra stuff */
990 sk_SSL_CIPHER_free(s->cipher_list);
991 sk_SSL_CIPHER_free(s->cipher_list_by_id);
993 /* Make the next call work :-) */
994 if (s->session != NULL) {
995 ssl_clear_bad_session(s);
996 SSL_SESSION_free(s->session);
1001 ssl_cert_free(s->cert);
1002 /* Free up if allocated */
1004 OPENSSL_free(s->ext.hostname);
1005 SSL_CTX_free(s->session_ctx);
1006 #ifndef OPENSSL_NO_EC
1007 OPENSSL_free(s->ext.ecpointformats);
1008 OPENSSL_free(s->ext.supportedgroups);
1009 #endif /* OPENSSL_NO_EC */
1010 sk_X509_EXTENSION_pop_free(s->ext.ocsp.exts, X509_EXTENSION_free);
1011 #ifndef OPENSSL_NO_OCSP
1012 sk_OCSP_RESPID_pop_free(s->ext.ocsp.ids, OCSP_RESPID_free);
1014 #ifndef OPENSSL_NO_CT
1015 SCT_LIST_free(s->scts);
1016 OPENSSL_free(s->ext.scts);
1018 OPENSSL_free(s->ext.ocsp.resp);
1019 OPENSSL_free(s->ext.alpn);
1020 OPENSSL_free(s->ext.tls13_cookie);
1021 OPENSSL_free(s->clienthello);
1023 sk_X509_NAME_pop_free(s->client_CA, X509_NAME_free);
1025 sk_X509_pop_free(s->verified_chain, X509_free);
1027 if (s->method != NULL)
1028 s->method->ssl_free(s);
1030 RECORD_LAYER_release(&s->rlayer);
1032 SSL_CTX_free(s->ctx);
1034 ASYNC_WAIT_CTX_free(s->waitctx);
1036 #if !defined(OPENSSL_NO_NEXTPROTONEG)
1037 OPENSSL_free(s->ext.npn);
1040 #ifndef OPENSSL_NO_SRTP
1041 sk_SRTP_PROTECTION_PROFILE_free(s->srtp_profiles);
1044 CRYPTO_THREAD_lock_free(s->lock);
1049 void SSL_set0_rbio(SSL *s, BIO *rbio)
1051 BIO_free_all(s->rbio);
1055 void SSL_set0_wbio(SSL *s, BIO *wbio)
1058 * If the output buffering BIO is still in place, remove it
1060 if (s->bbio != NULL)
1061 s->wbio = BIO_pop(s->wbio);
1063 BIO_free_all(s->wbio);
1066 /* Re-attach |bbio| to the new |wbio|. */
1067 if (s->bbio != NULL)
1068 s->wbio = BIO_push(s->bbio, s->wbio);
1071 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio)
1074 * For historical reasons, this function has many different cases in
1075 * ownership handling.
1078 /* If nothing has changed, do nothing */
1079 if (rbio == SSL_get_rbio(s) && wbio == SSL_get_wbio(s))
1083 * If the two arguments are equal then one fewer reference is granted by the
1084 * caller than we want to take
1086 if (rbio != NULL && rbio == wbio)
1090 * If only the wbio is changed only adopt one reference.
1092 if (rbio == SSL_get_rbio(s)) {
1093 SSL_set0_wbio(s, wbio);
1097 * There is an asymmetry here for historical reasons. If only the rbio is
1098 * changed AND the rbio and wbio were originally different, then we only
1099 * adopt one reference.
1101 if (wbio == SSL_get_wbio(s) && SSL_get_rbio(s) != SSL_get_wbio(s)) {
1102 SSL_set0_rbio(s, rbio);
1106 /* Otherwise, adopt both references. */
1107 SSL_set0_rbio(s, rbio);
1108 SSL_set0_wbio(s, wbio);
1111 BIO *SSL_get_rbio(const SSL *s)
1116 BIO *SSL_get_wbio(const SSL *s)
1118 if (s->bbio != NULL) {
1120 * If |bbio| is active, the true caller-configured BIO is its
1123 return BIO_next(s->bbio);
1128 int SSL_get_fd(const SSL *s)
1130 return SSL_get_rfd(s);
1133 int SSL_get_rfd(const SSL *s)
1138 b = SSL_get_rbio(s);
1139 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1141 BIO_get_fd(r, &ret);
1145 int SSL_get_wfd(const SSL *s)
1150 b = SSL_get_wbio(s);
1151 r = BIO_find_type(b, BIO_TYPE_DESCRIPTOR);
1153 BIO_get_fd(r, &ret);
1157 #ifndef OPENSSL_NO_SOCK
1158 int SSL_set_fd(SSL *s, int fd)
1163 bio = BIO_new(BIO_s_socket());
1166 SSLerr(SSL_F_SSL_SET_FD, ERR_R_BUF_LIB);
1169 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1170 SSL_set_bio(s, bio, bio);
1176 int SSL_set_wfd(SSL *s, int fd)
1178 BIO *rbio = SSL_get_rbio(s);
1180 if (rbio == NULL || BIO_method_type(rbio) != BIO_TYPE_SOCKET
1181 || (int)BIO_get_fd(rbio, NULL) != fd) {
1182 BIO *bio = BIO_new(BIO_s_socket());
1185 SSLerr(SSL_F_SSL_SET_WFD, ERR_R_BUF_LIB);
1188 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1189 SSL_set0_wbio(s, bio);
1192 SSL_set0_wbio(s, rbio);
1197 int SSL_set_rfd(SSL *s, int fd)
1199 BIO *wbio = SSL_get_wbio(s);
1201 if (wbio == NULL || BIO_method_type(wbio) != BIO_TYPE_SOCKET
1202 || ((int)BIO_get_fd(wbio, NULL) != fd)) {
1203 BIO *bio = BIO_new(BIO_s_socket());
1206 SSLerr(SSL_F_SSL_SET_RFD, ERR_R_BUF_LIB);
1209 BIO_set_fd(bio, fd, BIO_NOCLOSE);
1210 SSL_set0_rbio(s, bio);
1213 SSL_set0_rbio(s, wbio);
1220 /* return length of latest Finished message we sent, copy to 'buf' */
1221 size_t SSL_get_finished(const SSL *s, void *buf, size_t count)
1225 if (s->s3 != NULL) {
1226 ret = s->s3->tmp.finish_md_len;
1229 memcpy(buf, s->s3->tmp.finish_md, count);
1234 /* return length of latest Finished message we expected, copy to 'buf' */
1235 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count)
1239 if (s->s3 != NULL) {
1240 ret = s->s3->tmp.peer_finish_md_len;
1243 memcpy(buf, s->s3->tmp.peer_finish_md, count);
1248 int SSL_get_verify_mode(const SSL *s)
1250 return (s->verify_mode);
1253 int SSL_get_verify_depth(const SSL *s)
1255 return X509_VERIFY_PARAM_get_depth(s->param);
1258 int (*SSL_get_verify_callback(const SSL *s)) (int, X509_STORE_CTX *) {
1259 return (s->verify_callback);
1262 int SSL_CTX_get_verify_mode(const SSL_CTX *ctx)
1264 return (ctx->verify_mode);
1267 int SSL_CTX_get_verify_depth(const SSL_CTX *ctx)
1269 return X509_VERIFY_PARAM_get_depth(ctx->param);
1272 int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx)) (int, X509_STORE_CTX *) {
1273 return (ctx->default_verify_callback);
1276 void SSL_set_verify(SSL *s, int mode,
1277 int (*callback) (int ok, X509_STORE_CTX *ctx))
1279 s->verify_mode = mode;
1280 if (callback != NULL)
1281 s->verify_callback = callback;
1284 void SSL_set_verify_depth(SSL *s, int depth)
1286 X509_VERIFY_PARAM_set_depth(s->param, depth);
1289 void SSL_set_read_ahead(SSL *s, int yes)
1291 RECORD_LAYER_set_read_ahead(&s->rlayer, yes);
1294 int SSL_get_read_ahead(const SSL *s)
1296 return RECORD_LAYER_get_read_ahead(&s->rlayer);
1299 int SSL_pending(const SSL *s)
1301 size_t pending = s->method->ssl_pending(s);
1304 * SSL_pending cannot work properly if read-ahead is enabled
1305 * (SSL_[CTX_]ctrl(..., SSL_CTRL_SET_READ_AHEAD, 1, NULL)), and it is
1306 * impossible to fix since SSL_pending cannot report errors that may be
1307 * observed while scanning the new data. (Note that SSL_pending() is
1308 * often used as a boolean value, so we'd better not return -1.)
1310 * SSL_pending also cannot work properly if the value >INT_MAX. In that case
1311 * we just return INT_MAX.
1313 return pending < INT_MAX ? (int)pending : INT_MAX;
1316 int SSL_has_pending(const SSL *s)
1319 * Similar to SSL_pending() but returns a 1 to indicate that we have
1320 * unprocessed data available or 0 otherwise (as opposed to the number of
1321 * bytes available). Unlike SSL_pending() this will take into account
1322 * read_ahead data. A 1 return simply indicates that we have unprocessed
1323 * data. That data may not result in any application data, or we may fail
1324 * to parse the records for some reason.
1326 if (RECORD_LAYER_processed_read_pending(&s->rlayer))
1329 return RECORD_LAYER_read_pending(&s->rlayer);
1332 X509 *SSL_get_peer_certificate(const SSL *s)
1336 if ((s == NULL) || (s->session == NULL))
1339 r = s->session->peer;
1349 STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s)
1353 if ((s == NULL) || (s->session == NULL))
1356 r = s->session->peer_chain;
1359 * If we are a client, cert_chain includes the peer's own certificate; if
1360 * we are a server, it does not.
1367 * Now in theory, since the calling process own 't' it should be safe to
1368 * modify. We need to be able to read f without being hassled
1370 int SSL_copy_session_id(SSL *t, const SSL *f)
1373 /* Do we need to to SSL locking? */
1374 if (!SSL_set_session(t, SSL_get_session(f))) {
1379 * what if we are setup for one protocol version but want to talk another
1381 if (t->method != f->method) {
1382 t->method->ssl_free(t);
1383 t->method = f->method;
1384 if (t->method->ssl_new(t) == 0)
1388 CRYPTO_UP_REF(&f->cert->references, &i, f->cert->lock);
1389 ssl_cert_free(t->cert);
1391 if (!SSL_set_session_id_context(t, f->sid_ctx, (int)f->sid_ctx_length)) {
1398 /* Fix this so it checks all the valid key/cert options */
1399 int SSL_CTX_check_private_key(const SSL_CTX *ctx)
1401 if ((ctx == NULL) || (ctx->cert->key->x509 == NULL)) {
1402 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1405 if (ctx->cert->key->privatekey == NULL) {
1406 SSLerr(SSL_F_SSL_CTX_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1409 return (X509_check_private_key
1410 (ctx->cert->key->x509, ctx->cert->key->privatekey));
1413 /* Fix this function so that it takes an optional type parameter */
1414 int SSL_check_private_key(const SSL *ssl)
1417 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
1420 if (ssl->cert->key->x509 == NULL) {
1421 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_CERTIFICATE_ASSIGNED);
1424 if (ssl->cert->key->privatekey == NULL) {
1425 SSLerr(SSL_F_SSL_CHECK_PRIVATE_KEY, SSL_R_NO_PRIVATE_KEY_ASSIGNED);
1428 return (X509_check_private_key(ssl->cert->key->x509,
1429 ssl->cert->key->privatekey));
1432 int SSL_waiting_for_async(SSL *s)
1440 int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds)
1442 ASYNC_WAIT_CTX *ctx = s->waitctx;
1446 return ASYNC_WAIT_CTX_get_all_fds(ctx, fds, numfds);
1449 int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
1450 OSSL_ASYNC_FD *delfd, size_t *numdelfds)
1452 ASYNC_WAIT_CTX *ctx = s->waitctx;
1456 return ASYNC_WAIT_CTX_get_changed_fds(ctx, addfd, numaddfds, delfd,
1460 int SSL_accept(SSL *s)
1462 if (s->handshake_func == NULL) {
1463 /* Not properly initialized yet */
1464 SSL_set_accept_state(s);
1467 return SSL_do_handshake(s);
1470 int SSL_connect(SSL *s)
1472 if (s->handshake_func == NULL) {
1473 /* Not properly initialized yet */
1474 SSL_set_connect_state(s);
1477 return SSL_do_handshake(s);
1480 long SSL_get_default_timeout(const SSL *s)
1482 return (s->method->get_timeout());
1485 static int ssl_start_async_job(SSL *s, struct ssl_async_args *args,
1486 int (*func) (void *))
1489 if (s->waitctx == NULL) {
1490 s->waitctx = ASYNC_WAIT_CTX_new();
1491 if (s->waitctx == NULL)
1494 switch (ASYNC_start_job(&s->job, s->waitctx, &ret, func, args,
1495 sizeof(struct ssl_async_args))) {
1497 s->rwstate = SSL_NOTHING;
1498 SSLerr(SSL_F_SSL_START_ASYNC_JOB, SSL_R_FAILED_TO_INIT_ASYNC);
1501 s->rwstate = SSL_ASYNC_PAUSED;
1504 s->rwstate = SSL_ASYNC_NO_JOBS;
1510 s->rwstate = SSL_NOTHING;
1511 SSLerr(SSL_F_SSL_START_ASYNC_JOB, ERR_R_INTERNAL_ERROR);
1512 /* Shouldn't happen */
1517 static int ssl_io_intern(void *vargs)
1519 struct ssl_async_args *args;
1524 args = (struct ssl_async_args *)vargs;
1528 switch (args->type) {
1530 return args->f.func_read(s, buf, num, &s->asyncrw);
1532 return args->f.func_write(s, buf, num, &s->asyncrw);
1534 return args->f.func_other(s);
1539 int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1541 if (s->handshake_func == NULL) {
1542 SSLerr(SSL_F_SSL_READ_INTERNAL, SSL_R_UNINITIALIZED);
1546 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1547 s->rwstate = SSL_NOTHING;
1551 if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1552 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY) {
1553 SSLerr(SSL_F_SSL_READ_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1557 * If we are a client and haven't received the ServerHello etc then we
1560 ossl_statem_check_finish_init(s, 0);
1562 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1563 struct ssl_async_args args;
1569 args.type = READFUNC;
1570 args.f.func_read = s->method->ssl_read;
1572 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1573 *readbytes = s->asyncrw;
1576 return s->method->ssl_read(s, buf, num, readbytes);
1580 int SSL_read(SSL *s, void *buf, int num)
1586 SSLerr(SSL_F_SSL_READ, SSL_R_BAD_LENGTH);
1590 ret = ssl_read_internal(s, buf, (size_t)num, &readbytes);
1593 * The cast is safe here because ret should be <= INT_MAX because num is
1597 ret = (int)readbytes;
1602 int SSL_read_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1604 int ret = ssl_read_internal(s, buf, num, readbytes);
1611 int SSL_read_early_data(SSL *s, void *buf, size_t num, size_t *readbytes)
1616 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1617 return SSL_READ_EARLY_DATA_ERROR;
1620 switch (s->early_data_state) {
1621 case SSL_EARLY_DATA_NONE:
1622 if (!SSL_in_before(s)) {
1623 SSLerr(SSL_F_SSL_READ_EARLY_DATA,
1624 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1625 return SSL_READ_EARLY_DATA_ERROR;
1629 case SSL_EARLY_DATA_ACCEPT_RETRY:
1630 s->early_data_state = SSL_EARLY_DATA_ACCEPTING;
1631 ret = SSL_accept(s);
1634 s->early_data_state = SSL_EARLY_DATA_ACCEPT_RETRY;
1635 return SSL_READ_EARLY_DATA_ERROR;
1639 case SSL_EARLY_DATA_READ_RETRY:
1640 if (s->ext.early_data == SSL_EARLY_DATA_ACCEPTED) {
1641 s->early_data_state = SSL_EARLY_DATA_READING;
1642 ret = SSL_read_ex(s, buf, num, readbytes);
1644 * Record layer will call ssl_end_of_early_data_seen() if we see
1645 * that alert - which updates the early_data_state to
1646 * SSL_EARLY_DATA_FINISHED_READING
1648 if (ret > 0 || (ret <= 0 && s->early_data_state
1649 != SSL_EARLY_DATA_FINISHED_READING)) {
1650 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1651 return ret > 0 ? SSL_READ_EARLY_DATA_SUCCESS
1652 : SSL_READ_EARLY_DATA_ERROR;
1655 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1658 return SSL_READ_EARLY_DATA_FINISH;
1661 SSLerr(SSL_F_SSL_READ_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1662 return SSL_READ_EARLY_DATA_ERROR;
1666 int ssl_end_of_early_data_seen(SSL *s)
1668 if (s->early_data_state == SSL_EARLY_DATA_READING
1669 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1670 s->early_data_state = SSL_EARLY_DATA_FINISHED_READING;
1671 ossl_statem_finish_early_data(s);
1678 int SSL_get_early_data_status(const SSL *s)
1680 return s->ext.early_data;
1683 static int ssl_peek_internal(SSL *s, void *buf, size_t num, size_t *readbytes)
1685 if (s->handshake_func == NULL) {
1686 SSLerr(SSL_F_SSL_PEEK_INTERNAL, SSL_R_UNINITIALIZED);
1690 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1693 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1694 struct ssl_async_args args;
1700 args.type = READFUNC;
1701 args.f.func_read = s->method->ssl_peek;
1703 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1704 *readbytes = s->asyncrw;
1707 return s->method->ssl_peek(s, buf, num, readbytes);
1711 int SSL_peek(SSL *s, void *buf, int num)
1717 SSLerr(SSL_F_SSL_PEEK, SSL_R_BAD_LENGTH);
1721 ret = ssl_peek_internal(s, buf, (size_t)num, &readbytes);
1724 * The cast is safe here because ret should be <= INT_MAX because num is
1728 ret = (int)readbytes;
1734 int SSL_peek_ex(SSL *s, void *buf, size_t num, size_t *readbytes)
1736 int ret = ssl_peek_internal(s, buf, num, readbytes);
1743 int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written)
1745 if (s->handshake_func == NULL) {
1746 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_UNINITIALIZED);
1750 if (s->shutdown & SSL_SENT_SHUTDOWN) {
1751 s->rwstate = SSL_NOTHING;
1752 SSLerr(SSL_F_SSL_WRITE_INTERNAL, SSL_R_PROTOCOL_IS_SHUTDOWN);
1756 if (s->early_data_state == SSL_EARLY_DATA_WRITE_RETRY) {
1758 * We're still writing early data. We need to stop that so we can write
1761 if (!ssl_write_early_finish(s))
1763 } else if (s->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY
1764 || s->early_data_state == SSL_EARLY_DATA_ACCEPT_RETRY
1765 || s->early_data_state == SSL_EARLY_DATA_READ_RETRY) {
1766 SSLerr(SSL_F_SSL_WRITE_INTERNAL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1769 /* If we are a client and haven't sent the Finished we better do that */
1770 ossl_statem_check_finish_init(s, 1);
1772 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1774 struct ssl_async_args args;
1777 args.buf = (void *)buf;
1779 args.type = WRITEFUNC;
1780 args.f.func_write = s->method->ssl_write;
1782 ret = ssl_start_async_job(s, &args, ssl_io_intern);
1783 *written = s->asyncrw;
1786 return s->method->ssl_write(s, buf, num, written);
1790 int SSL_write(SSL *s, const void *buf, int num)
1796 SSLerr(SSL_F_SSL_WRITE, SSL_R_BAD_LENGTH);
1800 ret = ssl_write_internal(s, buf, (size_t)num, &written);
1803 * The cast is safe here because ret should be <= INT_MAX because num is
1812 int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written)
1814 int ret = ssl_write_internal(s, buf, num, written);
1821 int SSL_write_early_data(SSL *s, const void *buf, size_t num, size_t *written)
1825 switch (s->early_data_state) {
1826 case SSL_EARLY_DATA_NONE:
1828 || !SSL_in_before(s)
1829 || s->session == NULL
1830 || s->session->ext.max_early_data == 0) {
1831 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA,
1832 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1837 case SSL_EARLY_DATA_CONNECT_RETRY:
1838 s->early_data_state = SSL_EARLY_DATA_CONNECTING;
1839 ret = SSL_connect(s);
1842 s->early_data_state = SSL_EARLY_DATA_CONNECT_RETRY;
1847 case SSL_EARLY_DATA_WRITE_RETRY:
1848 s->early_data_state = SSL_EARLY_DATA_WRITING;
1849 ret = SSL_write_ex(s, buf, num, written);
1850 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
1853 case SSL_EARLY_DATA_READ_RETRY:
1854 /* We are a server writing to an unauthenticated client */
1855 s->early_data_state = SSL_EARLY_DATA_UNAUTH_WRITING;
1856 ret = SSL_write_ex(s, buf, num, written);
1857 s->early_data_state = SSL_EARLY_DATA_READ_RETRY;
1861 SSLerr(SSL_F_SSL_WRITE_EARLY_DATA, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1866 static int ssl_write_early_finish(SSL *s)
1870 if (s->early_data_state != SSL_EARLY_DATA_WRITE_RETRY) {
1871 SSLerr(SSL_F_SSL_WRITE_EARLY_FINISH, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1875 s->early_data_state = SSL_EARLY_DATA_WRITING;
1876 ret = ssl3_send_alert(s, SSL3_AL_WARNING, SSL_AD_END_OF_EARLY_DATA);
1878 s->early_data_state = SSL_EARLY_DATA_WRITE_RETRY;
1881 s->early_data_state = SSL_EARLY_DATA_FINISHED_WRITING;
1883 * We set the enc_write_ctx back to NULL because we may end up writing
1884 * in cleartext again if we get a HelloRetryRequest from the server.
1886 EVP_CIPHER_CTX_free(s->enc_write_ctx);
1887 s->enc_write_ctx = NULL;
1888 ossl_statem_set_in_init(s, 1);
1892 int SSL_shutdown(SSL *s)
1895 * Note that this function behaves differently from what one might
1896 * expect. Return values are 0 for no success (yet), 1 for success; but
1897 * calling it once is usually not enough, even if blocking I/O is used
1898 * (see ssl3_shutdown).
1901 if (s->handshake_func == NULL) {
1902 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_UNINITIALIZED);
1906 if (!SSL_in_init(s)) {
1907 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
1908 struct ssl_async_args args;
1911 args.type = OTHERFUNC;
1912 args.f.func_other = s->method->ssl_shutdown;
1914 return ssl_start_async_job(s, &args, ssl_io_intern);
1916 return s->method->ssl_shutdown(s);
1919 SSLerr(SSL_F_SSL_SHUTDOWN, SSL_R_SHUTDOWN_WHILE_IN_INIT);
1924 int SSL_key_update(SSL *s, int updatetype)
1927 * TODO(TLS1.3): How will applications know whether TLSv1.3 has been
1928 * negotiated, and that it is appropriate to call SSL_key_update() instead
1929 * of SSL_renegotiate().
1931 if (!SSL_IS_TLS13(s)) {
1932 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_WRONG_SSL_VERSION);
1936 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
1937 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
1938 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_INVALID_KEY_UPDATE_TYPE);
1942 if (!SSL_is_init_finished(s)) {
1943 SSLerr(SSL_F_SSL_KEY_UPDATE, SSL_R_STILL_IN_INIT);
1947 ossl_statem_set_in_init(s, 1);
1948 s->key_update = updatetype;
1952 int SSL_get_key_update_type(SSL *s)
1954 return s->key_update;
1957 int SSL_renegotiate(SSL *s)
1959 if (SSL_IS_TLS13(s)) {
1960 SSLerr(SSL_F_SSL_RENEGOTIATE, SSL_R_WRONG_SSL_VERSION);
1964 if (s->renegotiate == 0)
1969 return (s->method->ssl_renegotiate(s));
1972 int SSL_renegotiate_abbreviated(SSL *s)
1974 if (SSL_IS_TLS13(s))
1977 if (s->renegotiate == 0)
1982 return (s->method->ssl_renegotiate(s));
1985 int SSL_renegotiate_pending(SSL *s)
1988 * becomes true when negotiation is requested; false again once a
1989 * handshake has finished
1991 return (s->renegotiate != 0);
1994 long SSL_ctrl(SSL *s, int cmd, long larg, void *parg)
1999 case SSL_CTRL_GET_READ_AHEAD:
2000 return (RECORD_LAYER_get_read_ahead(&s->rlayer));
2001 case SSL_CTRL_SET_READ_AHEAD:
2002 l = RECORD_LAYER_get_read_ahead(&s->rlayer);
2003 RECORD_LAYER_set_read_ahead(&s->rlayer, larg);
2006 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2007 s->msg_callback_arg = parg;
2011 return (s->mode |= larg);
2012 case SSL_CTRL_CLEAR_MODE:
2013 return (s->mode &= ~larg);
2014 case SSL_CTRL_GET_MAX_CERT_LIST:
2015 return (long)(s->max_cert_list);
2016 case SSL_CTRL_SET_MAX_CERT_LIST:
2019 l = (long)s->max_cert_list;
2020 s->max_cert_list = (size_t)larg;
2022 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2023 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2025 s->max_send_fragment = larg;
2026 if (s->max_send_fragment < s->split_send_fragment)
2027 s->split_send_fragment = s->max_send_fragment;
2029 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2030 if ((size_t)larg > s->max_send_fragment || larg == 0)
2032 s->split_send_fragment = larg;
2034 case SSL_CTRL_SET_MAX_PIPELINES:
2035 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2037 s->max_pipelines = larg;
2039 RECORD_LAYER_set_read_ahead(&s->rlayer, 1);
2041 case SSL_CTRL_GET_RI_SUPPORT:
2043 return s->s3->send_connection_binding;
2046 case SSL_CTRL_CERT_FLAGS:
2047 return (s->cert->cert_flags |= larg);
2048 case SSL_CTRL_CLEAR_CERT_FLAGS:
2049 return (s->cert->cert_flags &= ~larg);
2051 case SSL_CTRL_GET_RAW_CIPHERLIST:
2053 if (s->s3->tmp.ciphers_raw == NULL)
2055 *(unsigned char **)parg = s->s3->tmp.ciphers_raw;
2056 return (int)s->s3->tmp.ciphers_rawlen;
2058 return TLS_CIPHER_LEN;
2060 case SSL_CTRL_GET_EXTMS_SUPPORT:
2061 if (!s->session || SSL_in_init(s) || ossl_statem_get_in_handshake(s))
2063 if (s->session->flags & SSL_SESS_FLAG_EXTMS)
2067 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2068 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2069 &s->min_proto_version);
2070 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2071 return ssl_set_version_bound(s->ctx->method->version, (int)larg,
2072 &s->max_proto_version);
2074 return (s->method->ssl_ctrl(s, cmd, larg, parg));
2078 long SSL_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
2081 case SSL_CTRL_SET_MSG_CALLBACK:
2082 s->msg_callback = (void (*)
2083 (int write_p, int version, int content_type,
2084 const void *buf, size_t len, SSL *ssl,
2089 return (s->method->ssl_callback_ctrl(s, cmd, fp));
2093 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx)
2095 return ctx->sessions;
2098 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
2101 /* For some cases with ctx == NULL perform syntax checks */
2104 #ifndef OPENSSL_NO_EC
2105 case SSL_CTRL_SET_GROUPS_LIST:
2106 return tls1_set_groups_list(NULL, NULL, parg);
2108 case SSL_CTRL_SET_SIGALGS_LIST:
2109 case SSL_CTRL_SET_CLIENT_SIGALGS_LIST:
2110 return tls1_set_sigalgs_list(NULL, parg, 0);
2117 case SSL_CTRL_GET_READ_AHEAD:
2118 return (ctx->read_ahead);
2119 case SSL_CTRL_SET_READ_AHEAD:
2120 l = ctx->read_ahead;
2121 ctx->read_ahead = larg;
2124 case SSL_CTRL_SET_MSG_CALLBACK_ARG:
2125 ctx->msg_callback_arg = parg;
2128 case SSL_CTRL_GET_MAX_CERT_LIST:
2129 return (long)(ctx->max_cert_list);
2130 case SSL_CTRL_SET_MAX_CERT_LIST:
2133 l = (long)ctx->max_cert_list;
2134 ctx->max_cert_list = (size_t)larg;
2137 case SSL_CTRL_SET_SESS_CACHE_SIZE:
2140 l = (long)ctx->session_cache_size;
2141 ctx->session_cache_size = (size_t)larg;
2143 case SSL_CTRL_GET_SESS_CACHE_SIZE:
2144 return (long)(ctx->session_cache_size);
2145 case SSL_CTRL_SET_SESS_CACHE_MODE:
2146 l = ctx->session_cache_mode;
2147 ctx->session_cache_mode = larg;
2149 case SSL_CTRL_GET_SESS_CACHE_MODE:
2150 return (ctx->session_cache_mode);
2152 case SSL_CTRL_SESS_NUMBER:
2153 return (lh_SSL_SESSION_num_items(ctx->sessions));
2154 case SSL_CTRL_SESS_CONNECT:
2155 return (ctx->stats.sess_connect);
2156 case SSL_CTRL_SESS_CONNECT_GOOD:
2157 return (ctx->stats.sess_connect_good);
2158 case SSL_CTRL_SESS_CONNECT_RENEGOTIATE:
2159 return (ctx->stats.sess_connect_renegotiate);
2160 case SSL_CTRL_SESS_ACCEPT:
2161 return (ctx->stats.sess_accept);
2162 case SSL_CTRL_SESS_ACCEPT_GOOD:
2163 return (ctx->stats.sess_accept_good);
2164 case SSL_CTRL_SESS_ACCEPT_RENEGOTIATE:
2165 return (ctx->stats.sess_accept_renegotiate);
2166 case SSL_CTRL_SESS_HIT:
2167 return (ctx->stats.sess_hit);
2168 case SSL_CTRL_SESS_CB_HIT:
2169 return (ctx->stats.sess_cb_hit);
2170 case SSL_CTRL_SESS_MISSES:
2171 return (ctx->stats.sess_miss);
2172 case SSL_CTRL_SESS_TIMEOUTS:
2173 return (ctx->stats.sess_timeout);
2174 case SSL_CTRL_SESS_CACHE_FULL:
2175 return (ctx->stats.sess_cache_full);
2177 return (ctx->mode |= larg);
2178 case SSL_CTRL_CLEAR_MODE:
2179 return (ctx->mode &= ~larg);
2180 case SSL_CTRL_SET_MAX_SEND_FRAGMENT:
2181 if (larg < 512 || larg > SSL3_RT_MAX_PLAIN_LENGTH)
2183 ctx->max_send_fragment = larg;
2184 if (ctx->max_send_fragment < ctx->split_send_fragment)
2185 ctx->split_send_fragment = ctx->max_send_fragment;
2187 case SSL_CTRL_SET_SPLIT_SEND_FRAGMENT:
2188 if ((size_t)larg > ctx->max_send_fragment || larg == 0)
2190 ctx->split_send_fragment = larg;
2192 case SSL_CTRL_SET_MAX_PIPELINES:
2193 if (larg < 1 || larg > SSL_MAX_PIPELINES)
2195 ctx->max_pipelines = larg;
2197 case SSL_CTRL_CERT_FLAGS:
2198 return (ctx->cert->cert_flags |= larg);
2199 case SSL_CTRL_CLEAR_CERT_FLAGS:
2200 return (ctx->cert->cert_flags &= ~larg);
2201 case SSL_CTRL_SET_MIN_PROTO_VERSION:
2202 return ssl_set_version_bound(ctx->method->version, (int)larg,
2203 &ctx->min_proto_version);
2204 case SSL_CTRL_SET_MAX_PROTO_VERSION:
2205 return ssl_set_version_bound(ctx->method->version, (int)larg,
2206 &ctx->max_proto_version);
2208 return (ctx->method->ssl_ctx_ctrl(ctx, cmd, larg, parg));
2212 long SSL_CTX_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
2215 case SSL_CTRL_SET_MSG_CALLBACK:
2216 ctx->msg_callback = (void (*)
2217 (int write_p, int version, int content_type,
2218 const void *buf, size_t len, SSL *ssl,
2223 return (ctx->method->ssl_ctx_callback_ctrl(ctx, cmd, fp));
2227 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b)
2236 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2237 const SSL_CIPHER *const *bp)
2239 if ((*ap)->id > (*bp)->id)
2241 if ((*ap)->id < (*bp)->id)
2246 /** return a STACK of the ciphers available for the SSL and in order of
2248 STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s)
2251 if (s->cipher_list != NULL) {
2252 return (s->cipher_list);
2253 } else if ((s->ctx != NULL) && (s->ctx->cipher_list != NULL)) {
2254 return (s->ctx->cipher_list);
2260 STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s)
2262 if ((s == NULL) || (s->session == NULL) || !s->server)
2264 return s->session->ciphers;
2267 STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s)
2269 STACK_OF(SSL_CIPHER) *sk = NULL, *ciphers;
2271 ciphers = SSL_get_ciphers(s);
2274 ssl_set_client_disabled(s);
2275 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2276 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
2277 if (!ssl_cipher_disabled(s, c, SSL_SECOP_CIPHER_SUPPORTED)) {
2279 sk = sk_SSL_CIPHER_new_null();
2282 if (!sk_SSL_CIPHER_push(sk, c)) {
2283 sk_SSL_CIPHER_free(sk);
2291 /** return a STACK of the ciphers available for the SSL and in order of
2293 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s)
2296 if (s->cipher_list_by_id != NULL) {
2297 return (s->cipher_list_by_id);
2298 } else if ((s->ctx != NULL) && (s->ctx->cipher_list_by_id != NULL)) {
2299 return (s->ctx->cipher_list_by_id);
2305 /** The old interface to get the same thing as SSL_get_ciphers() */
2306 const char *SSL_get_cipher_list(const SSL *s, int n)
2308 const SSL_CIPHER *c;
2309 STACK_OF(SSL_CIPHER) *sk;
2313 sk = SSL_get_ciphers(s);
2314 if ((sk == NULL) || (sk_SSL_CIPHER_num(sk) <= n))
2316 c = sk_SSL_CIPHER_value(sk, n);
2322 /** return a STACK of the ciphers available for the SSL_CTX and in order of
2324 STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx)
2327 return ctx->cipher_list;
2331 /** specify the ciphers to be used by default by the SSL_CTX */
2332 int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str)
2334 STACK_OF(SSL_CIPHER) *sk;
2336 sk = ssl_create_cipher_list(ctx->method, &ctx->cipher_list,
2337 &ctx->cipher_list_by_id, str, ctx->cert);
2339 * ssl_create_cipher_list may return an empty stack if it was unable to
2340 * find a cipher matching the given rule string (for example if the rule
2341 * string specifies a cipher which has been disabled). This is not an
2342 * error as far as ssl_create_cipher_list is concerned, and hence
2343 * ctx->cipher_list and ctx->cipher_list_by_id has been updated.
2347 else if (sk_SSL_CIPHER_num(sk) == 0) {
2348 SSLerr(SSL_F_SSL_CTX_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2354 /** specify the ciphers to be used by the SSL */
2355 int SSL_set_cipher_list(SSL *s, const char *str)
2357 STACK_OF(SSL_CIPHER) *sk;
2359 sk = ssl_create_cipher_list(s->ctx->method, &s->cipher_list,
2360 &s->cipher_list_by_id, str, s->cert);
2361 /* see comment in SSL_CTX_set_cipher_list */
2364 else if (sk_SSL_CIPHER_num(sk) == 0) {
2365 SSLerr(SSL_F_SSL_SET_CIPHER_LIST, SSL_R_NO_CIPHER_MATCH);
2371 char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len)
2374 STACK_OF(SSL_CIPHER) *sk;
2375 const SSL_CIPHER *c;
2378 if ((s->session == NULL) || (s->session->ciphers == NULL) || (len < 2))
2382 sk = s->session->ciphers;
2384 if (sk_SSL_CIPHER_num(sk) == 0)
2387 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
2390 c = sk_SSL_CIPHER_value(sk, i);
2391 n = strlen(c->name);
2398 memcpy(p, c->name, n + 1);
2407 /** return a servername extension value if provided in Client Hello, or NULL.
2408 * So far, only host_name types are defined (RFC 3546).
2411 const char *SSL_get_servername(const SSL *s, const int type)
2413 if (type != TLSEXT_NAMETYPE_host_name)
2416 return s->session && !s->ext.hostname ?
2417 s->session->ext.hostname : s->ext.hostname;
2420 int SSL_get_servername_type(const SSL *s)
2423 && (!s->ext.hostname ? s->session->
2424 ext.hostname : s->ext.hostname))
2425 return TLSEXT_NAMETYPE_host_name;
2430 * SSL_select_next_proto implements the standard protocol selection. It is
2431 * expected that this function is called from the callback set by
2432 * SSL_CTX_set_next_proto_select_cb. The protocol data is assumed to be a
2433 * vector of 8-bit, length prefixed byte strings. The length byte itself is
2434 * not included in the length. A byte string of length 0 is invalid. No byte
2435 * string may be truncated. The current, but experimental algorithm for
2436 * selecting the protocol is: 1) If the server doesn't support NPN then this
2437 * is indicated to the callback. In this case, the client application has to
2438 * abort the connection or have a default application level protocol. 2) If
2439 * the server supports NPN, but advertises an empty list then the client
2440 * selects the first protocol in its list, but indicates via the API that this
2441 * fallback case was enacted. 3) Otherwise, the client finds the first
2442 * protocol in the server's list that it supports and selects this protocol.
2443 * This is because it's assumed that the server has better information about
2444 * which protocol a client should use. 4) If the client doesn't support any
2445 * of the server's advertised protocols, then this is treated the same as
2446 * case 2. It returns either OPENSSL_NPN_NEGOTIATED if a common protocol was
2447 * found, or OPENSSL_NPN_NO_OVERLAP if the fallback case was reached.
2449 int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
2450 const unsigned char *server,
2451 unsigned int server_len,
2452 const unsigned char *client, unsigned int client_len)
2455 const unsigned char *result;
2456 int status = OPENSSL_NPN_UNSUPPORTED;
2459 * For each protocol in server preference order, see if we support it.
2461 for (i = 0; i < server_len;) {
2462 for (j = 0; j < client_len;) {
2463 if (server[i] == client[j] &&
2464 memcmp(&server[i + 1], &client[j + 1], server[i]) == 0) {
2465 /* We found a match */
2466 result = &server[i];
2467 status = OPENSSL_NPN_NEGOTIATED;
2477 /* There's no overlap between our protocols and the server's list. */
2479 status = OPENSSL_NPN_NO_OVERLAP;
2482 *out = (unsigned char *)result + 1;
2483 *outlen = result[0];
2487 #ifndef OPENSSL_NO_NEXTPROTONEG
2489 * SSL_get0_next_proto_negotiated sets *data and *len to point to the
2490 * client's requested protocol for this connection and returns 0. If the
2491 * client didn't request any protocol, then *data is set to NULL. Note that
2492 * the client can request any protocol it chooses. The value returned from
2493 * this function need not be a member of the list of supported protocols
2494 * provided by the callback.
2496 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
2503 *len = (unsigned int)s->ext.npn_len;
2508 * SSL_CTX_set_npn_advertised_cb sets a callback that is called when
2509 * a TLS server needs a list of supported protocols for Next Protocol
2510 * Negotiation. The returned list must be in wire format. The list is
2511 * returned by setting |out| to point to it and |outlen| to its length. This
2512 * memory will not be modified, but one should assume that the SSL* keeps a
2513 * reference to it. The callback should return SSL_TLSEXT_ERR_OK if it
2514 * wishes to advertise. Otherwise, no such extension will be included in the
2517 void SSL_CTX_set_npn_advertised_cb(SSL_CTX *ctx,
2518 SSL_CTX_npn_advertised_cb_func cb,
2521 ctx->ext.npn_advertised_cb = cb;
2522 ctx->ext.npn_advertised_cb_arg = arg;
2526 * SSL_CTX_set_next_proto_select_cb sets a callback that is called when a
2527 * client needs to select a protocol from the server's provided list. |out|
2528 * must be set to point to the selected protocol (which may be within |in|).
2529 * The length of the protocol name must be written into |outlen|. The
2530 * server's advertised protocols are provided in |in| and |inlen|. The
2531 * callback can assume that |in| is syntactically valid. The client must
2532 * select a protocol. It is fatal to the connection if this callback returns
2533 * a value other than SSL_TLSEXT_ERR_OK.
2535 void SSL_CTX_set_npn_select_cb(SSL_CTX *ctx,
2536 SSL_CTX_npn_select_cb_func cb,
2539 ctx->ext.npn_select_cb = cb;
2540 ctx->ext.npn_select_cb_arg = arg;
2545 * SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
2546 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2547 * length-prefixed strings). Returns 0 on success.
2549 int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
2550 unsigned int protos_len)
2552 OPENSSL_free(ctx->ext.alpn);
2553 ctx->ext.alpn = OPENSSL_memdup(protos, protos_len);
2554 if (ctx->ext.alpn == NULL) {
2555 SSLerr(SSL_F_SSL_CTX_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2558 ctx->ext.alpn_len = protos_len;
2564 * SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
2565 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2566 * length-prefixed strings). Returns 0 on success.
2568 int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
2569 unsigned int protos_len)
2571 OPENSSL_free(ssl->ext.alpn);
2572 ssl->ext.alpn = OPENSSL_memdup(protos, protos_len);
2573 if (ssl->ext.alpn == NULL) {
2574 SSLerr(SSL_F_SSL_SET_ALPN_PROTOS, ERR_R_MALLOC_FAILURE);
2577 ssl->ext.alpn_len = protos_len;
2583 * SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is
2584 * called during ClientHello processing in order to select an ALPN protocol
2585 * from the client's list of offered protocols.
2587 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
2588 SSL_CTX_alpn_select_cb_func cb,
2591 ctx->ext.alpn_select_cb = cb;
2592 ctx->ext.alpn_select_cb_arg = arg;
2596 * SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from
2597 * |ssl|. On return it sets |*data| to point to |*len| bytes of protocol name
2598 * (not including the leading length-prefix byte). If the server didn't
2599 * respond with a negotiated protocol then |*len| will be zero.
2601 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
2606 *data = ssl->s3->alpn_selected;
2610 *len = (unsigned int)ssl->s3->alpn_selected_len;
2613 int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2614 const char *label, size_t llen,
2615 const unsigned char *p, size_t plen,
2618 if (s->version < TLS1_VERSION && s->version != DTLS1_BAD_VER)
2621 return s->method->ssl3_enc->export_keying_material(s, out, olen, label,
2626 static unsigned long ssl_session_hash(const SSL_SESSION *a)
2628 const unsigned char *session_id = a->session_id;
2630 unsigned char tmp_storage[4];
2632 if (a->session_id_length < sizeof(tmp_storage)) {
2633 memset(tmp_storage, 0, sizeof(tmp_storage));
2634 memcpy(tmp_storage, a->session_id, a->session_id_length);
2635 session_id = tmp_storage;
2639 ((unsigned long)session_id[0]) |
2640 ((unsigned long)session_id[1] << 8L) |
2641 ((unsigned long)session_id[2] << 16L) |
2642 ((unsigned long)session_id[3] << 24L);
2647 * NB: If this function (or indeed the hash function which uses a sort of
2648 * coarser function than this one) is changed, ensure
2649 * SSL_CTX_has_matching_session_id() is checked accordingly. It relies on
2650 * being able to construct an SSL_SESSION that will collide with any existing
2651 * session with a matching session ID.
2653 static int ssl_session_cmp(const SSL_SESSION *a, const SSL_SESSION *b)
2655 if (a->ssl_version != b->ssl_version)
2657 if (a->session_id_length != b->session_id_length)
2659 return (memcmp(a->session_id, b->session_id, a->session_id_length));
2663 * These wrapper functions should remain rather than redeclaring
2664 * SSL_SESSION_hash and SSL_SESSION_cmp for void* types and casting each
2665 * variable. The reason is that the functions aren't static, they're exposed
2669 SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth)
2671 SSL_CTX *ret = NULL;
2674 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_NULL_SSL_METHOD_PASSED);
2678 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
2681 if (SSL_get_ex_data_X509_STORE_CTX_idx() < 0) {
2682 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_X509_VERIFICATION_SETUP_PROBLEMS);
2685 ret = OPENSSL_zalloc(sizeof(*ret));
2690 ret->min_proto_version = 0;
2691 ret->max_proto_version = 0;
2692 ret->session_cache_mode = SSL_SESS_CACHE_SERVER;
2693 ret->session_cache_size = SSL_SESSION_CACHE_MAX_SIZE_DEFAULT;
2694 /* We take the system default. */
2695 ret->session_timeout = meth->get_timeout();
2696 ret->references = 1;
2697 ret->lock = CRYPTO_THREAD_lock_new();
2698 if (ret->lock == NULL) {
2699 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2703 ret->max_cert_list = SSL_MAX_CERT_LIST_DEFAULT;
2704 ret->verify_mode = SSL_VERIFY_NONE;
2705 if ((ret->cert = ssl_cert_new()) == NULL)
2708 ret->sessions = lh_SSL_SESSION_new(ssl_session_hash, ssl_session_cmp);
2709 if (ret->sessions == NULL)
2711 ret->cert_store = X509_STORE_new();
2712 if (ret->cert_store == NULL)
2714 #ifndef OPENSSL_NO_CT
2715 ret->ctlog_store = CTLOG_STORE_new();
2716 if (ret->ctlog_store == NULL)
2719 if (!ssl_create_cipher_list(ret->method,
2720 &ret->cipher_list, &ret->cipher_list_by_id,
2721 SSL_DEFAULT_CIPHER_LIST, ret->cert)
2722 || sk_SSL_CIPHER_num(ret->cipher_list) <= 0) {
2723 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_LIBRARY_HAS_NO_CIPHERS);
2727 ret->param = X509_VERIFY_PARAM_new();
2728 if (ret->param == NULL)
2731 if ((ret->md5 = EVP_get_digestbyname("ssl3-md5")) == NULL) {
2732 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES);
2735 if ((ret->sha1 = EVP_get_digestbyname("ssl3-sha1")) == NULL) {
2736 SSLerr(SSL_F_SSL_CTX_NEW, SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES);
2740 if ((ret->client_CA = sk_X509_NAME_new_null()) == NULL)
2743 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_CTX, ret, &ret->ex_data))
2746 /* No compression for DTLS */
2747 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS))
2748 ret->comp_methods = SSL_COMP_get_compression_methods();
2750 ret->max_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2751 ret->split_send_fragment = SSL3_RT_MAX_PLAIN_LENGTH;
2753 /* Setup RFC5077 ticket keys */
2754 if ((RAND_bytes(ret->ext.tick_key_name,
2755 sizeof(ret->ext.tick_key_name)) <= 0)
2756 || (RAND_bytes(ret->ext.tick_hmac_key,
2757 sizeof(ret->ext.tick_hmac_key)) <= 0)
2758 || (RAND_bytes(ret->ext.tick_aes_key,
2759 sizeof(ret->ext.tick_aes_key)) <= 0))
2760 ret->options |= SSL_OP_NO_TICKET;
2762 #ifndef OPENSSL_NO_SRP
2763 if (!SSL_CTX_SRP_CTX_init(ret))
2766 #ifndef OPENSSL_NO_ENGINE
2767 # ifdef OPENSSL_SSL_CLIENT_ENGINE_AUTO
2768 # define eng_strx(x) #x
2769 # define eng_str(x) eng_strx(x)
2770 /* Use specific client engine automatically... ignore errors */
2773 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2776 ENGINE_load_builtin_engines();
2777 eng = ENGINE_by_id(eng_str(OPENSSL_SSL_CLIENT_ENGINE_AUTO));
2779 if (!eng || !SSL_CTX_set_client_cert_engine(ret, eng))
2785 * Default is to connect to non-RI servers. When RI is more widely
2786 * deployed might change this.
2788 ret->options |= SSL_OP_LEGACY_SERVER_CONNECT;
2790 * Disable compression by default to prevent CRIME. Applications can
2791 * re-enable compression by configuring
2792 * SSL_CTX_clear_options(ctx, SSL_OP_NO_COMPRESSION);
2793 * or by using the SSL_CONF library.
2795 ret->options |= SSL_OP_NO_COMPRESSION;
2797 ret->ext.status_type = TLSEXT_STATUSTYPE_nothing;
2800 * Default max early data is a fully loaded single record. Could be split
2801 * across multiple records in practice
2803 ret->max_early_data = SSL3_RT_MAX_PLAIN_LENGTH;
2807 SSLerr(SSL_F_SSL_CTX_NEW, ERR_R_MALLOC_FAILURE);
2813 int SSL_CTX_up_ref(SSL_CTX *ctx)
2817 if (CRYPTO_UP_REF(&ctx->references, &i, ctx->lock) <= 0)
2820 REF_PRINT_COUNT("SSL_CTX", ctx);
2821 REF_ASSERT_ISNT(i < 2);
2822 return ((i > 1) ? 1 : 0);
2825 void SSL_CTX_free(SSL_CTX *a)
2832 CRYPTO_DOWN_REF(&a->references, &i, a->lock);
2833 REF_PRINT_COUNT("SSL_CTX", a);
2836 REF_ASSERT_ISNT(i < 0);
2838 X509_VERIFY_PARAM_free(a->param);
2839 dane_ctx_final(&a->dane);
2842 * Free internal session cache. However: the remove_cb() may reference
2843 * the ex_data of SSL_CTX, thus the ex_data store can only be removed
2844 * after the sessions were flushed.
2845 * As the ex_data handling routines might also touch the session cache,
2846 * the most secure solution seems to be: empty (flush) the cache, then
2847 * free ex_data, then finally free the cache.
2848 * (See ticket [openssl.org #212].)
2850 if (a->sessions != NULL)
2851 SSL_CTX_flush_sessions(a, 0);
2853 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_CTX, a, &a->ex_data);
2854 lh_SSL_SESSION_free(a->sessions);
2855 X509_STORE_free(a->cert_store);
2856 #ifndef OPENSSL_NO_CT
2857 CTLOG_STORE_free(a->ctlog_store);
2859 sk_SSL_CIPHER_free(a->cipher_list);
2860 sk_SSL_CIPHER_free(a->cipher_list_by_id);
2861 ssl_cert_free(a->cert);
2862 sk_X509_NAME_pop_free(a->client_CA, X509_NAME_free);
2863 sk_X509_pop_free(a->extra_certs, X509_free);
2864 a->comp_methods = NULL;
2865 #ifndef OPENSSL_NO_SRTP
2866 sk_SRTP_PROTECTION_PROFILE_free(a->srtp_profiles);
2868 #ifndef OPENSSL_NO_SRP
2869 SSL_CTX_SRP_CTX_free(a);
2871 #ifndef OPENSSL_NO_ENGINE
2872 ENGINE_finish(a->client_cert_engine);
2875 #ifndef OPENSSL_NO_EC
2876 OPENSSL_free(a->ext.ecpointformats);
2877 OPENSSL_free(a->ext.supportedgroups);
2879 OPENSSL_free(a->ext.alpn);
2881 CRYPTO_THREAD_lock_free(a->lock);
2886 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb)
2888 ctx->default_passwd_callback = cb;
2891 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u)
2893 ctx->default_passwd_callback_userdata = u;
2896 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
2898 return ctx->default_passwd_callback;
2901 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
2903 return ctx->default_passwd_callback_userdata;
2906 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb)
2908 s->default_passwd_callback = cb;
2911 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u)
2913 s->default_passwd_callback_userdata = u;
2916 pem_password_cb *SSL_get_default_passwd_cb(SSL *s)
2918 return s->default_passwd_callback;
2921 void *SSL_get_default_passwd_cb_userdata(SSL *s)
2923 return s->default_passwd_callback_userdata;
2926 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
2927 int (*cb) (X509_STORE_CTX *, void *),
2930 ctx->app_verify_callback = cb;
2931 ctx->app_verify_arg = arg;
2934 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2935 int (*cb) (int, X509_STORE_CTX *))
2937 ctx->verify_mode = mode;
2938 ctx->default_verify_callback = cb;
2941 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth)
2943 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
2946 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg), void *arg)
2948 ssl_cert_set_cert_cb(c->cert, cb, arg);
2951 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg)
2953 ssl_cert_set_cert_cb(s->cert, cb, arg);
2956 void ssl_set_masks(SSL *s)
2959 uint32_t *pvalid = s->s3->tmp.valid_flags;
2960 int rsa_enc, rsa_sign, dh_tmp, dsa_sign;
2961 unsigned long mask_k, mask_a;
2962 #ifndef OPENSSL_NO_EC
2963 int have_ecc_cert, ecdsa_ok;
2968 #ifndef OPENSSL_NO_DH
2969 dh_tmp = (c->dh_tmp != NULL || c->dh_tmp_cb != NULL || c->dh_tmp_auto);
2974 rsa_enc = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2975 rsa_sign = pvalid[SSL_PKEY_RSA] & CERT_PKEY_VALID;
2976 dsa_sign = pvalid[SSL_PKEY_DSA_SIGN] & CERT_PKEY_VALID;
2977 #ifndef OPENSSL_NO_EC
2978 have_ecc_cert = pvalid[SSL_PKEY_ECC] & CERT_PKEY_VALID;
2984 fprintf(stderr, "dht=%d re=%d rs=%d ds=%d\n",
2985 dh_tmp, rsa_enc, rsa_sign, dsa_sign);
2988 #ifndef OPENSSL_NO_GOST
2989 if (ssl_has_cert(s, SSL_PKEY_GOST12_512)) {
2990 mask_k |= SSL_kGOST;
2991 mask_a |= SSL_aGOST12;
2993 if (ssl_has_cert(s, SSL_PKEY_GOST12_256)) {
2994 mask_k |= SSL_kGOST;
2995 mask_a |= SSL_aGOST12;
2997 if (ssl_has_cert(s, SSL_PKEY_GOST01)) {
2998 mask_k |= SSL_kGOST;
2999 mask_a |= SSL_aGOST01;
3009 if (rsa_enc || rsa_sign) {
3017 mask_a |= SSL_aNULL;
3020 * An ECC certificate may be usable for ECDH and/or ECDSA cipher suites
3021 * depending on the key usage extension.
3023 #ifndef OPENSSL_NO_EC
3024 if (have_ecc_cert) {
3026 ex_kusage = X509_get_key_usage(c->pkeys[SSL_PKEY_ECC].x509);
3027 ecdsa_ok = ex_kusage & X509v3_KU_DIGITAL_SIGNATURE;
3028 if (!(pvalid[SSL_PKEY_ECC] & CERT_PKEY_SIGN))
3031 mask_a |= SSL_aECDSA;
3035 #ifndef OPENSSL_NO_EC
3036 mask_k |= SSL_kECDHE;
3039 #ifndef OPENSSL_NO_PSK
3042 if (mask_k & SSL_kRSA)
3043 mask_k |= SSL_kRSAPSK;
3044 if (mask_k & SSL_kDHE)
3045 mask_k |= SSL_kDHEPSK;
3046 if (mask_k & SSL_kECDHE)
3047 mask_k |= SSL_kECDHEPSK;
3050 s->s3->tmp.mask_k = mask_k;
3051 s->s3->tmp.mask_a = mask_a;
3054 #ifndef OPENSSL_NO_EC
3056 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s)
3058 if (s->s3->tmp.new_cipher->algorithm_auth & SSL_aECDSA) {
3059 /* key usage, if present, must allow signing */
3060 if (!(X509_get_key_usage(x) & X509v3_KU_DIGITAL_SIGNATURE)) {
3061 SSLerr(SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG,
3062 SSL_R_ECC_CERT_NOT_FOR_SIGNING);
3066 return 1; /* all checks are ok */
3071 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
3072 size_t *serverinfo_length)
3074 CERT_PKEY *cpk = s->s3->tmp.cert;
3075 *serverinfo_length = 0;
3077 if (cpk == NULL || cpk->serverinfo == NULL)
3080 *serverinfo = cpk->serverinfo;
3081 *serverinfo_length = cpk->serverinfo_length;
3085 void ssl_update_cache(SSL *s, int mode)
3090 * If the session_id_length is 0, we are not supposed to cache it, and it
3091 * would be rather hard to do anyway :-)
3093 if (s->session->session_id_length == 0)
3096 i = s->session_ctx->session_cache_mode;
3097 if ((i & mode) && (!s->hit)
3098 && ((i & SSL_SESS_CACHE_NO_INTERNAL_STORE)
3099 || SSL_CTX_add_session(s->session_ctx, s->session))
3100 && (s->session_ctx->new_session_cb != NULL)) {
3101 SSL_SESSION_up_ref(s->session);
3102 if (!s->session_ctx->new_session_cb(s, s->session))
3103 SSL_SESSION_free(s->session);
3106 /* auto flush every 255 connections */
3107 if ((!(i & SSL_SESS_CACHE_NO_AUTO_CLEAR)) && ((i & mode) == mode)) {
3108 if ((((mode & SSL_SESS_CACHE_CLIENT)
3109 ? s->session_ctx->stats.sess_connect_good
3110 : s->session_ctx->stats.sess_accept_good) & 0xff) == 0xff) {
3111 SSL_CTX_flush_sessions(s->session_ctx, (unsigned long)time(NULL));
3116 const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx)
3121 const SSL_METHOD *SSL_get_ssl_method(SSL *s)
3126 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *meth)
3130 if (s->method != meth) {
3131 const SSL_METHOD *sm = s->method;
3132 int (*hf) (SSL *) = s->handshake_func;
3134 if (sm->version == meth->version)
3139 ret = s->method->ssl_new(s);
3142 if (hf == sm->ssl_connect)
3143 s->handshake_func = meth->ssl_connect;
3144 else if (hf == sm->ssl_accept)
3145 s->handshake_func = meth->ssl_accept;
3150 int SSL_get_error(const SSL *s, int i)
3157 return (SSL_ERROR_NONE);
3160 * Make things return SSL_ERROR_SYSCALL when doing SSL_do_handshake etc,
3161 * where we do encode the error
3163 if ((l = ERR_peek_error()) != 0) {
3164 if (ERR_GET_LIB(l) == ERR_LIB_SYS)
3165 return (SSL_ERROR_SYSCALL);
3167 return (SSL_ERROR_SSL);
3170 if (SSL_want_read(s)) {
3171 bio = SSL_get_rbio(s);
3172 if (BIO_should_read(bio))
3173 return (SSL_ERROR_WANT_READ);
3174 else if (BIO_should_write(bio))
3176 * This one doesn't make too much sense ... We never try to write
3177 * to the rbio, and an application program where rbio and wbio
3178 * are separate couldn't even know what it should wait for.
3179 * However if we ever set s->rwstate incorrectly (so that we have
3180 * SSL_want_read(s) instead of SSL_want_write(s)) and rbio and
3181 * wbio *are* the same, this test works around that bug; so it
3182 * might be safer to keep it.
3184 return (SSL_ERROR_WANT_WRITE);
3185 else if (BIO_should_io_special(bio)) {
3186 reason = BIO_get_retry_reason(bio);
3187 if (reason == BIO_RR_CONNECT)
3188 return (SSL_ERROR_WANT_CONNECT);
3189 else if (reason == BIO_RR_ACCEPT)
3190 return (SSL_ERROR_WANT_ACCEPT);
3192 return (SSL_ERROR_SYSCALL); /* unknown */
3196 if (SSL_want_write(s)) {
3198 * Access wbio directly - in order to use the buffered bio if
3202 if (BIO_should_write(bio))
3203 return (SSL_ERROR_WANT_WRITE);
3204 else if (BIO_should_read(bio))
3206 * See above (SSL_want_read(s) with BIO_should_write(bio))
3208 return (SSL_ERROR_WANT_READ);
3209 else if (BIO_should_io_special(bio)) {
3210 reason = BIO_get_retry_reason(bio);
3211 if (reason == BIO_RR_CONNECT)
3212 return (SSL_ERROR_WANT_CONNECT);
3213 else if (reason == BIO_RR_ACCEPT)
3214 return (SSL_ERROR_WANT_ACCEPT);
3216 return (SSL_ERROR_SYSCALL);
3219 if (SSL_want_x509_lookup(s))
3220 return (SSL_ERROR_WANT_X509_LOOKUP);
3221 if (SSL_want_async(s))
3222 return SSL_ERROR_WANT_ASYNC;
3223 if (SSL_want_async_job(s))
3224 return SSL_ERROR_WANT_ASYNC_JOB;
3225 if (SSL_want_early(s))
3226 return SSL_ERROR_WANT_EARLY;
3228 if ((s->shutdown & SSL_RECEIVED_SHUTDOWN) &&
3229 (s->s3->warn_alert == SSL_AD_CLOSE_NOTIFY))
3230 return (SSL_ERROR_ZERO_RETURN);
3232 return (SSL_ERROR_SYSCALL);
3235 static int ssl_do_handshake_intern(void *vargs)
3237 struct ssl_async_args *args;
3240 args = (struct ssl_async_args *)vargs;
3243 return s->handshake_func(s);
3246 int SSL_do_handshake(SSL *s)
3250 if (s->handshake_func == NULL) {
3251 SSLerr(SSL_F_SSL_DO_HANDSHAKE, SSL_R_CONNECTION_TYPE_NOT_SET);
3255 if (s->early_data_state == SSL_EARLY_DATA_WRITE_RETRY) {
3258 edfin = ssl_write_early_finish(s);
3262 ossl_statem_check_finish_init(s, -1);
3264 s->method->ssl_renegotiate_check(s, 0);
3266 if (SSL_in_init(s) || SSL_in_before(s)) {
3267 if ((s->mode & SSL_MODE_ASYNC) && ASYNC_get_current_job() == NULL) {
3268 struct ssl_async_args args;
3272 ret = ssl_start_async_job(s, &args, ssl_do_handshake_intern);
3274 ret = s->handshake_func(s);
3280 void SSL_set_accept_state(SSL *s)
3284 ossl_statem_clear(s);
3285 s->handshake_func = s->method->ssl_accept;
3289 void SSL_set_connect_state(SSL *s)
3293 ossl_statem_clear(s);
3294 s->handshake_func = s->method->ssl_connect;
3298 int ssl_undefined_function(SSL *s)
3300 SSLerr(SSL_F_SSL_UNDEFINED_FUNCTION, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3304 int ssl_undefined_void_function(void)
3306 SSLerr(SSL_F_SSL_UNDEFINED_VOID_FUNCTION,
3307 ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3311 int ssl_undefined_const_function(const SSL *s)
3316 const SSL_METHOD *ssl_bad_method(int ver)
3318 SSLerr(SSL_F_SSL_BAD_METHOD, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
3322 const char *ssl_protocol_to_string(int version)
3326 case TLS1_3_VERSION:
3329 case TLS1_2_VERSION:
3332 case TLS1_1_VERSION:
3347 case DTLS1_2_VERSION:
3355 const char *SSL_get_version(const SSL *s)
3357 return ssl_protocol_to_string(s->version);
3360 SSL *SSL_dup(SSL *s)
3362 STACK_OF(X509_NAME) *sk;
3367 /* If we're not quiescent, just up_ref! */
3368 if (!SSL_in_init(s) || !SSL_in_before(s)) {
3369 CRYPTO_UP_REF(&s->references, &i, s->lock);
3374 * Otherwise, copy configuration state, and session if set.
3376 if ((ret = SSL_new(SSL_get_SSL_CTX(s))) == NULL)
3379 if (s->session != NULL) {
3381 * Arranges to share the same session via up_ref. This "copies"
3382 * session-id, SSL_METHOD, sid_ctx, and 'cert'
3384 if (!SSL_copy_session_id(ret, s))
3388 * No session has been established yet, so we have to expect that
3389 * s->cert or ret->cert will be changed later -- they should not both
3390 * point to the same object, and thus we can't use
3391 * SSL_copy_session_id.
3393 if (!SSL_set_ssl_method(ret, s->method))
3396 if (s->cert != NULL) {
3397 ssl_cert_free(ret->cert);
3398 ret->cert = ssl_cert_dup(s->cert);
3399 if (ret->cert == NULL)
3403 if (!SSL_set_session_id_context(ret, s->sid_ctx,
3404 (int)s->sid_ctx_length))
3408 if (!ssl_dane_dup(ret, s))
3410 ret->version = s->version;
3411 ret->options = s->options;
3412 ret->mode = s->mode;
3413 SSL_set_max_cert_list(ret, SSL_get_max_cert_list(s));
3414 SSL_set_read_ahead(ret, SSL_get_read_ahead(s));
3415 ret->msg_callback = s->msg_callback;
3416 ret->msg_callback_arg = s->msg_callback_arg;
3417 SSL_set_verify(ret, SSL_get_verify_mode(s), SSL_get_verify_callback(s));
3418 SSL_set_verify_depth(ret, SSL_get_verify_depth(s));
3419 ret->generate_session_id = s->generate_session_id;
3421 SSL_set_info_callback(ret, SSL_get_info_callback(s));
3423 /* copy app data, a little dangerous perhaps */
3424 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL, &ret->ex_data, &s->ex_data))
3427 /* setup rbio, and wbio */
3428 if (s->rbio != NULL) {
3429 if (!BIO_dup_state(s->rbio, (char *)&ret->rbio))
3432 if (s->wbio != NULL) {
3433 if (s->wbio != s->rbio) {
3434 if (!BIO_dup_state(s->wbio, (char *)&ret->wbio))
3437 BIO_up_ref(ret->rbio);
3438 ret->wbio = ret->rbio;
3442 ret->server = s->server;
3443 if (s->handshake_func) {
3445 SSL_set_accept_state(ret);
3447 SSL_set_connect_state(ret);
3449 ret->shutdown = s->shutdown;
3452 ret->default_passwd_callback = s->default_passwd_callback;
3453 ret->default_passwd_callback_userdata = s->default_passwd_callback_userdata;
3455 X509_VERIFY_PARAM_inherit(ret->param, s->param);
3457 /* dup the cipher_list and cipher_list_by_id stacks */
3458 if (s->cipher_list != NULL) {
3459 if ((ret->cipher_list = sk_SSL_CIPHER_dup(s->cipher_list)) == NULL)
3462 if (s->cipher_list_by_id != NULL)
3463 if ((ret->cipher_list_by_id = sk_SSL_CIPHER_dup(s->cipher_list_by_id))
3467 /* Dup the client_CA list */
3468 if (s->client_CA != NULL) {
3469 if ((sk = sk_X509_NAME_dup(s->client_CA)) == NULL)
3471 ret->client_CA = sk;
3472 for (i = 0; i < sk_X509_NAME_num(sk); i++) {
3473 xn = sk_X509_NAME_value(sk, i);
3474 if (sk_X509_NAME_set(sk, i, X509_NAME_dup(xn)) == NULL) {
3487 void ssl_clear_cipher_ctx(SSL *s)
3489 if (s->enc_read_ctx != NULL) {
3490 EVP_CIPHER_CTX_free(s->enc_read_ctx);
3491 s->enc_read_ctx = NULL;
3493 if (s->enc_write_ctx != NULL) {
3494 EVP_CIPHER_CTX_free(s->enc_write_ctx);
3495 s->enc_write_ctx = NULL;
3497 #ifndef OPENSSL_NO_COMP
3498 COMP_CTX_free(s->expand);
3500 COMP_CTX_free(s->compress);
3505 X509 *SSL_get_certificate(const SSL *s)
3507 if (s->cert != NULL)
3508 return (s->cert->key->x509);
3513 EVP_PKEY *SSL_get_privatekey(const SSL *s)
3515 if (s->cert != NULL)
3516 return (s->cert->key->privatekey);
3521 X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx)
3523 if (ctx->cert != NULL)
3524 return ctx->cert->key->x509;
3529 EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx)
3531 if (ctx->cert != NULL)
3532 return ctx->cert->key->privatekey;
3537 const SSL_CIPHER *SSL_get_current_cipher(const SSL *s)
3539 if ((s->session != NULL) && (s->session->cipher != NULL))
3540 return (s->session->cipher);
3544 const COMP_METHOD *SSL_get_current_compression(SSL *s)
3546 #ifndef OPENSSL_NO_COMP
3547 return s->compress ? COMP_CTX_get_method(s->compress) : NULL;
3553 const COMP_METHOD *SSL_get_current_expansion(SSL *s)
3555 #ifndef OPENSSL_NO_COMP
3556 return s->expand ? COMP_CTX_get_method(s->expand) : NULL;
3562 int ssl_init_wbio_buffer(SSL *s)
3566 if (s->bbio != NULL) {
3567 /* Already buffered. */
3571 bbio = BIO_new(BIO_f_buffer());
3572 if (bbio == NULL || !BIO_set_read_buffer_size(bbio, 1)) {
3574 SSLerr(SSL_F_SSL_INIT_WBIO_BUFFER, ERR_R_BUF_LIB);
3578 s->wbio = BIO_push(bbio, s->wbio);
3583 void ssl_free_wbio_buffer(SSL *s)
3585 /* callers ensure s is never null */
3586 if (s->bbio == NULL)
3589 s->wbio = BIO_pop(s->wbio);
3590 assert(s->wbio != NULL);
3595 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode)
3597 ctx->quiet_shutdown = mode;
3600 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx)
3602 return (ctx->quiet_shutdown);
3605 void SSL_set_quiet_shutdown(SSL *s, int mode)
3607 s->quiet_shutdown = mode;
3610 int SSL_get_quiet_shutdown(const SSL *s)
3612 return (s->quiet_shutdown);
3615 void SSL_set_shutdown(SSL *s, int mode)
3620 int SSL_get_shutdown(const SSL *s)
3625 int SSL_version(const SSL *s)
3630 int SSL_client_version(const SSL *s)
3632 return s->client_version;
3635 SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl)
3640 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx)
3643 if (ssl->ctx == ctx)
3646 ctx = ssl->session_ctx;
3647 new_cert = ssl_cert_dup(ctx->cert);
3648 if (new_cert == NULL) {
3651 ssl_cert_free(ssl->cert);
3652 ssl->cert = new_cert;
3655 * Program invariant: |sid_ctx| has fixed size (SSL_MAX_SID_CTX_LENGTH),
3656 * so setter APIs must prevent invalid lengths from entering the system.
3658 OPENSSL_assert(ssl->sid_ctx_length <= sizeof(ssl->sid_ctx));
3661 * If the session ID context matches that of the parent SSL_CTX,
3662 * inherit it from the new SSL_CTX as well. If however the context does
3663 * not match (i.e., it was set per-ssl with SSL_set_session_id_context),
3664 * leave it unchanged.
3666 if ((ssl->ctx != NULL) &&
3667 (ssl->sid_ctx_length == ssl->ctx->sid_ctx_length) &&
3668 (memcmp(ssl->sid_ctx, ssl->ctx->sid_ctx, ssl->sid_ctx_length) == 0)) {
3669 ssl->sid_ctx_length = ctx->sid_ctx_length;
3670 memcpy(&ssl->sid_ctx, &ctx->sid_ctx, sizeof(ssl->sid_ctx));
3673 SSL_CTX_up_ref(ctx);
3674 SSL_CTX_free(ssl->ctx); /* decrement reference count */
3680 int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx)
3682 return (X509_STORE_set_default_paths(ctx->cert_store));
3685 int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)
3687 X509_LOOKUP *lookup;
3689 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_hash_dir());
3692 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
3694 /* Clear any errors if the default directory does not exist */
3700 int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)
3702 X509_LOOKUP *lookup;
3704 lookup = X509_STORE_add_lookup(ctx->cert_store, X509_LOOKUP_file());
3708 X509_LOOKUP_load_file(lookup, NULL, X509_FILETYPE_DEFAULT);
3710 /* Clear any errors if the default file does not exist */
3716 int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
3719 return (X509_STORE_load_locations(ctx->cert_store, CAfile, CApath));
3722 void SSL_set_info_callback(SSL *ssl,
3723 void (*cb) (const SSL *ssl, int type, int val))
3725 ssl->info_callback = cb;
3729 * One compiler (Diab DCC) doesn't like argument names in returned function
3732 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL * /* ssl */ ,
3735 return ssl->info_callback;
3738 void SSL_set_verify_result(SSL *ssl, long arg)
3740 ssl->verify_result = arg;
3743 long SSL_get_verify_result(const SSL *ssl)
3745 return (ssl->verify_result);
3748 size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen)
3751 return sizeof(ssl->s3->client_random);
3752 if (outlen > sizeof(ssl->s3->client_random))
3753 outlen = sizeof(ssl->s3->client_random);
3754 memcpy(out, ssl->s3->client_random, outlen);
3758 size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen)
3761 return sizeof(ssl->s3->server_random);
3762 if (outlen > sizeof(ssl->s3->server_random))
3763 outlen = sizeof(ssl->s3->server_random);
3764 memcpy(out, ssl->s3->server_random, outlen);
3768 size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
3769 unsigned char *out, size_t outlen)
3772 return session->master_key_length;
3773 if (outlen > session->master_key_length)
3774 outlen = session->master_key_length;
3775 memcpy(out, session->master_key, outlen);
3779 int SSL_set_ex_data(SSL *s, int idx, void *arg)
3781 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3784 void *SSL_get_ex_data(const SSL *s, int idx)
3786 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3789 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg)
3791 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
3794 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx)
3796 return (CRYPTO_get_ex_data(&s->ex_data, idx));
3799 X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx)
3801 return (ctx->cert_store);
3804 void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store)
3806 X509_STORE_free(ctx->cert_store);
3807 ctx->cert_store = store;
3810 void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store)
3813 X509_STORE_up_ref(store);
3814 SSL_CTX_set_cert_store(ctx, store);
3817 int SSL_want(const SSL *s)
3819 return (s->rwstate);
3823 * \brief Set the callback for generating temporary DH keys.
3824 * \param ctx the SSL context.
3825 * \param dh the callback
3828 #ifndef OPENSSL_NO_DH
3829 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
3830 DH *(*dh) (SSL *ssl, int is_export,
3833 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3836 void SSL_set_tmp_dh_callback(SSL *ssl, DH *(*dh) (SSL *ssl, int is_export,
3839 SSL_callback_ctrl(ssl, SSL_CTRL_SET_TMP_DH_CB, (void (*)(void))dh);
3843 #ifndef OPENSSL_NO_PSK
3844 int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint)
3846 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3847 SSLerr(SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3850 OPENSSL_free(ctx->cert->psk_identity_hint);
3851 if (identity_hint != NULL) {
3852 ctx->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3853 if (ctx->cert->psk_identity_hint == NULL)
3856 ctx->cert->psk_identity_hint = NULL;
3860 int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint)
3865 if (identity_hint != NULL && strlen(identity_hint) > PSK_MAX_IDENTITY_LEN) {
3866 SSLerr(SSL_F_SSL_USE_PSK_IDENTITY_HINT, SSL_R_DATA_LENGTH_TOO_LONG);
3869 OPENSSL_free(s->cert->psk_identity_hint);
3870 if (identity_hint != NULL) {
3871 s->cert->psk_identity_hint = OPENSSL_strdup(identity_hint);
3872 if (s->cert->psk_identity_hint == NULL)
3875 s->cert->psk_identity_hint = NULL;
3879 const char *SSL_get_psk_identity_hint(const SSL *s)
3881 if (s == NULL || s->session == NULL)
3883 return (s->session->psk_identity_hint);
3886 const char *SSL_get_psk_identity(const SSL *s)
3888 if (s == NULL || s->session == NULL)
3890 return (s->session->psk_identity);
3893 void SSL_set_psk_client_callback(SSL *s, SSL_psk_client_cb_func cb)
3895 s->psk_client_callback = cb;
3898 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb)
3900 ctx->psk_client_callback = cb;
3903 void SSL_set_psk_server_callback(SSL *s, SSL_psk_server_cb_func cb)
3905 s->psk_server_callback = cb;
3908 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb)
3910 ctx->psk_server_callback = cb;
3914 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
3915 void (*cb) (int write_p, int version,
3916 int content_type, const void *buf,
3917 size_t len, SSL *ssl, void *arg))
3919 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3922 void SSL_set_msg_callback(SSL *ssl,
3923 void (*cb) (int write_p, int version,
3924 int content_type, const void *buf,
3925 size_t len, SSL *ssl, void *arg))
3927 SSL_callback_ctrl(ssl, SSL_CTRL_SET_MSG_CALLBACK, (void (*)(void))cb);
3930 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
3931 int (*cb) (SSL *ssl,
3935 SSL_CTX_callback_ctrl(ctx, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3936 (void (*)(void))cb);
3939 void SSL_set_not_resumable_session_callback(SSL *ssl,
3940 int (*cb) (SSL *ssl,
3941 int is_forward_secure))
3943 SSL_callback_ctrl(ssl, SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB,
3944 (void (*)(void))cb);
3948 * Allocates new EVP_MD_CTX and sets pointer to it into given pointer
3949 * variable, freeing EVP_MD_CTX previously stored in that variable, if any.
3950 * If EVP_MD pointer is passed, initializes ctx with this md.
3951 * Returns the newly allocated ctx;
3954 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md)
3956 ssl_clear_hash_ctx(hash);
3957 *hash = EVP_MD_CTX_new();
3958 if (*hash == NULL || (md && EVP_DigestInit_ex(*hash, md, NULL) <= 0)) {
3959 EVP_MD_CTX_free(*hash);
3966 void ssl_clear_hash_ctx(EVP_MD_CTX **hash)
3969 EVP_MD_CTX_free(*hash);
3973 /* Retrieve handshake hashes */
3974 int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
3977 EVP_MD_CTX *ctx = NULL;
3978 EVP_MD_CTX *hdgst = s->s3->handshake_dgst;
3979 int hashleni = EVP_MD_CTX_size(hdgst);
3982 if (hashleni < 0 || (size_t)hashleni > outlen)
3985 ctx = EVP_MD_CTX_new();
3989 if (!EVP_MD_CTX_copy_ex(ctx, hdgst)
3990 || EVP_DigestFinal_ex(ctx, out, NULL) <= 0)
3993 *hashlen = hashleni;
3997 EVP_MD_CTX_free(ctx);
4001 int SSL_session_reused(SSL *s)
4006 int SSL_is_server(SSL *s)
4011 #if OPENSSL_API_COMPAT < 0x10100000L
4012 void SSL_set_debug(SSL *s, int debug)
4014 /* Old function was do-nothing anyway... */
4020 void SSL_set_security_level(SSL *s, int level)
4022 s->cert->sec_level = level;
4025 int SSL_get_security_level(const SSL *s)
4027 return s->cert->sec_level;
4030 void SSL_set_security_callback(SSL *s,
4031 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4032 int op, int bits, int nid,
4033 void *other, void *ex))
4035 s->cert->sec_cb = cb;
4038 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
4039 const SSL_CTX *ctx, int op,
4040 int bits, int nid, void *other,
4042 return s->cert->sec_cb;
4045 void SSL_set0_security_ex_data(SSL *s, void *ex)
4047 s->cert->sec_ex = ex;
4050 void *SSL_get0_security_ex_data(const SSL *s)
4052 return s->cert->sec_ex;
4055 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level)
4057 ctx->cert->sec_level = level;
4060 int SSL_CTX_get_security_level(const SSL_CTX *ctx)
4062 return ctx->cert->sec_level;
4065 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
4066 int (*cb) (const SSL *s, const SSL_CTX *ctx,
4067 int op, int bits, int nid,
4068 void *other, void *ex))
4070 ctx->cert->sec_cb = cb;
4073 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
4079 return ctx->cert->sec_cb;
4082 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex)
4084 ctx->cert->sec_ex = ex;
4087 void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx)
4089 return ctx->cert->sec_ex;
4093 * Get/Set/Clear options in SSL_CTX or SSL, formerly macros, now functions that
4094 * can return unsigned long, instead of the generic long return value from the
4095 * control interface.
4097 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx)
4099 return ctx->options;
4102 unsigned long SSL_get_options(const SSL *s)
4107 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op)
4109 return ctx->options |= op;
4112 unsigned long SSL_set_options(SSL *s, unsigned long op)
4114 return s->options |= op;
4117 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op)
4119 return ctx->options &= ~op;
4122 unsigned long SSL_clear_options(SSL *s, unsigned long op)
4124 return s->options &= ~op;
4127 STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s)
4129 return s->verified_chain;
4132 IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
4134 #ifndef OPENSSL_NO_CT
4137 * Moves SCTs from the |src| stack to the |dst| stack.
4138 * The source of each SCT will be set to |origin|.
4139 * If |dst| points to a NULL pointer, a new stack will be created and owned by
4141 * Returns the number of SCTs moved, or a negative integer if an error occurs.
4143 static int ct_move_scts(STACK_OF(SCT) **dst, STACK_OF(SCT) *src,
4144 sct_source_t origin)
4150 *dst = sk_SCT_new_null();
4152 SSLerr(SSL_F_CT_MOVE_SCTS, ERR_R_MALLOC_FAILURE);
4157 while ((sct = sk_SCT_pop(src)) != NULL) {
4158 if (SCT_set_source(sct, origin) != 1)
4161 if (sk_SCT_push(*dst, sct) <= 0)
4169 sk_SCT_push(src, sct); /* Put the SCT back */
4174 * Look for data collected during ServerHello and parse if found.
4175 * Returns the number of SCTs extracted.
4177 static int ct_extract_tls_extension_scts(SSL *s)
4179 int scts_extracted = 0;
4181 if (s->ext.scts != NULL) {
4182 const unsigned char *p = s->ext.scts;
4183 STACK_OF(SCT) *scts = o2i_SCT_LIST(NULL, &p, s->ext.scts_len);
4185 scts_extracted = ct_move_scts(&s->scts, scts, SCT_SOURCE_TLS_EXTENSION);
4187 SCT_LIST_free(scts);
4190 return scts_extracted;
4194 * Checks for an OCSP response and then attempts to extract any SCTs found if it
4195 * contains an SCT X509 extension. They will be stored in |s->scts|.
4197 * - The number of SCTs extracted, assuming an OCSP response exists.
4198 * - 0 if no OCSP response exists or it contains no SCTs.
4199 * - A negative integer if an error occurs.
4201 static int ct_extract_ocsp_response_scts(SSL *s)
4203 # ifndef OPENSSL_NO_OCSP
4204 int scts_extracted = 0;
4205 const unsigned char *p;
4206 OCSP_BASICRESP *br = NULL;
4207 OCSP_RESPONSE *rsp = NULL;
4208 STACK_OF(SCT) *scts = NULL;
4211 if (s->ext.ocsp.resp == NULL || s->ext.ocsp.resp_len == 0)
4214 p = s->ext.ocsp.resp;
4215 rsp = d2i_OCSP_RESPONSE(NULL, &p, (int)s->ext.ocsp.resp_len);
4219 br = OCSP_response_get1_basic(rsp);
4223 for (i = 0; i < OCSP_resp_count(br); ++i) {
4224 OCSP_SINGLERESP *single = OCSP_resp_get0(br, i);
4230 OCSP_SINGLERESP_get1_ext_d2i(single, NID_ct_cert_scts, NULL, NULL);
4232 ct_move_scts(&s->scts, scts, SCT_SOURCE_OCSP_STAPLED_RESPONSE);
4233 if (scts_extracted < 0)
4237 SCT_LIST_free(scts);
4238 OCSP_BASICRESP_free(br);
4239 OCSP_RESPONSE_free(rsp);
4240 return scts_extracted;
4242 /* Behave as if no OCSP response exists */
4248 * Attempts to extract SCTs from the peer certificate.
4249 * Return the number of SCTs extracted, or a negative integer if an error
4252 static int ct_extract_x509v3_extension_scts(SSL *s)
4254 int scts_extracted = 0;
4255 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4258 STACK_OF(SCT) *scts =
4259 X509_get_ext_d2i(cert, NID_ct_precert_scts, NULL, NULL);
4262 ct_move_scts(&s->scts, scts, SCT_SOURCE_X509V3_EXTENSION);
4264 SCT_LIST_free(scts);
4267 return scts_extracted;
4271 * Attempts to find all received SCTs by checking TLS extensions, the OCSP
4272 * response (if it exists) and X509v3 extensions in the certificate.
4273 * Returns NULL if an error occurs.
4275 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s)
4277 if (!s->scts_parsed) {
4278 if (ct_extract_tls_extension_scts(s) < 0 ||
4279 ct_extract_ocsp_response_scts(s) < 0 ||
4280 ct_extract_x509v3_extension_scts(s) < 0)
4290 static int ct_permissive(const CT_POLICY_EVAL_CTX * ctx,
4291 const STACK_OF(SCT) *scts, void *unused_arg)
4296 static int ct_strict(const CT_POLICY_EVAL_CTX * ctx,
4297 const STACK_OF(SCT) *scts, void *unused_arg)
4299 int count = scts != NULL ? sk_SCT_num(scts) : 0;
4302 for (i = 0; i < count; ++i) {
4303 SCT *sct = sk_SCT_value(scts, i);
4304 int status = SCT_get_validation_status(sct);
4306 if (status == SCT_VALIDATION_STATUS_VALID)
4309 SSLerr(SSL_F_CT_STRICT, SSL_R_NO_VALID_SCTS);
4313 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
4317 * Since code exists that uses the custom extension handler for CT, look
4318 * for this and throw an error if they have already registered to use CT.
4320 if (callback != NULL && SSL_CTX_has_client_custom_ext(s->ctx,
4321 TLSEXT_TYPE_signed_certificate_timestamp))
4323 SSLerr(SSL_F_SSL_SET_CT_VALIDATION_CALLBACK,
4324 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4328 if (callback != NULL) {
4330 * If we are validating CT, then we MUST accept SCTs served via OCSP
4332 if (!SSL_set_tlsext_status_type(s, TLSEXT_STATUSTYPE_ocsp))
4336 s->ct_validation_callback = callback;
4337 s->ct_validation_callback_arg = arg;
4342 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
4343 ssl_ct_validation_cb callback, void *arg)
4346 * Since code exists that uses the custom extension handler for CT, look for
4347 * this and throw an error if they have already registered to use CT.
4349 if (callback != NULL && SSL_CTX_has_client_custom_ext(ctx,
4350 TLSEXT_TYPE_signed_certificate_timestamp))
4352 SSLerr(SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK,
4353 SSL_R_CUSTOM_EXT_HANDLER_ALREADY_INSTALLED);
4357 ctx->ct_validation_callback = callback;
4358 ctx->ct_validation_callback_arg = arg;
4362 int SSL_ct_is_enabled(const SSL *s)
4364 return s->ct_validation_callback != NULL;
4367 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx)
4369 return ctx->ct_validation_callback != NULL;
4372 int ssl_validate_ct(SSL *s)
4375 X509 *cert = s->session != NULL ? s->session->peer : NULL;
4377 SSL_DANE *dane = &s->dane;
4378 CT_POLICY_EVAL_CTX *ctx = NULL;
4379 const STACK_OF(SCT) *scts;
4382 * If no callback is set, the peer is anonymous, or its chain is invalid,
4383 * skip SCT validation - just return success. Applications that continue
4384 * handshakes without certificates, with unverified chains, or pinned leaf
4385 * certificates are outside the scope of the WebPKI and CT.
4387 * The above exclusions notwithstanding the vast majority of peers will
4388 * have rather ordinary certificate chains validated by typical
4389 * applications that perform certificate verification and therefore will
4390 * process SCTs when enabled.
4392 if (s->ct_validation_callback == NULL || cert == NULL ||
4393 s->verify_result != X509_V_OK ||
4394 s->verified_chain == NULL || sk_X509_num(s->verified_chain) <= 1)
4398 * CT not applicable for chains validated via DANE-TA(2) or DANE-EE(3)
4399 * trust-anchors. See https://tools.ietf.org/html/rfc7671#section-4.2
4401 if (DANETLS_ENABLED(dane) && dane->mtlsa != NULL) {
4402 switch (dane->mtlsa->usage) {
4403 case DANETLS_USAGE_DANE_TA:
4404 case DANETLS_USAGE_DANE_EE:
4409 ctx = CT_POLICY_EVAL_CTX_new();
4411 SSLerr(SSL_F_SSL_VALIDATE_CT, ERR_R_MALLOC_FAILURE);
4415 issuer = sk_X509_value(s->verified_chain, 1);
4416 CT_POLICY_EVAL_CTX_set1_cert(ctx, cert);
4417 CT_POLICY_EVAL_CTX_set1_issuer(ctx, issuer);
4418 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(ctx, s->ctx->ctlog_store);
4419 CT_POLICY_EVAL_CTX_set_time(ctx, SSL_SESSION_get_time(SSL_get0_session(s)));
4421 scts = SSL_get0_peer_scts(s);
4424 * This function returns success (> 0) only when all the SCTs are valid, 0
4425 * when some are invalid, and < 0 on various internal errors (out of
4426 * memory, etc.). Having some, or even all, invalid SCTs is not sufficient
4427 * reason to abort the handshake, that decision is up to the callback.
4428 * Therefore, we error out only in the unexpected case that the return
4429 * value is negative.
4431 * XXX: One might well argue that the return value of this function is an
4432 * unfortunate design choice. Its job is only to determine the validation
4433 * status of each of the provided SCTs. So long as it correctly separates
4434 * the wheat from the chaff it should return success. Failure in this case
4435 * ought to correspond to an inability to carry out its duties.
4437 if (SCT_LIST_validate(scts, ctx) < 0) {
4438 SSLerr(SSL_F_SSL_VALIDATE_CT, SSL_R_SCT_VERIFICATION_FAILED);
4442 ret = s->ct_validation_callback(ctx, scts, s->ct_validation_callback_arg);
4444 ret = 0; /* This function returns 0 on failure */
4447 CT_POLICY_EVAL_CTX_free(ctx);
4449 * With SSL_VERIFY_NONE the session may be cached and re-used despite a
4450 * failure return code here. Also the application may wish the complete
4451 * the handshake, and then disconnect cleanly at a higher layer, after
4452 * checking the verification status of the completed connection.
4454 * We therefore force a certificate verification failure which will be
4455 * visible via SSL_get_verify_result() and cached as part of any resumed
4458 * Note: the permissive callback is for information gathering only, always
4459 * returns success, and does not affect verification status. Only the
4460 * strict callback or a custom application-specified callback can trigger
4461 * connection failure or record a verification error.
4464 s->verify_result = X509_V_ERR_NO_VALID_SCTS;
4468 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode)
4470 switch (validation_mode) {
4472 SSLerr(SSL_F_SSL_CTX_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4474 case SSL_CT_VALIDATION_PERMISSIVE:
4475 return SSL_CTX_set_ct_validation_callback(ctx, ct_permissive, NULL);
4476 case SSL_CT_VALIDATION_STRICT:
4477 return SSL_CTX_set_ct_validation_callback(ctx, ct_strict, NULL);
4481 int SSL_enable_ct(SSL *s, int validation_mode)
4483 switch (validation_mode) {
4485 SSLerr(SSL_F_SSL_ENABLE_CT, SSL_R_INVALID_CT_VALIDATION_TYPE);
4487 case SSL_CT_VALIDATION_PERMISSIVE:
4488 return SSL_set_ct_validation_callback(s, ct_permissive, NULL);
4489 case SSL_CT_VALIDATION_STRICT:
4490 return SSL_set_ct_validation_callback(s, ct_strict, NULL);
4494 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx)
4496 return CTLOG_STORE_load_default_file(ctx->ctlog_store);
4499 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path)
4501 return CTLOG_STORE_load_file(ctx->ctlog_store, path);
4504 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE * logs)
4506 CTLOG_STORE_free(ctx->ctlog_store);
4507 ctx->ctlog_store = logs;
4510 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx)
4512 return ctx->ctlog_store;
4515 #endif /* OPENSSL_NO_CT */
4517 void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn cb, void *arg)
4520 c->early_cb_arg = arg;
4523 int SSL_early_isv2(SSL *s)
4525 if (s->clienthello == NULL)
4527 return s->clienthello->isv2;
4530 unsigned int SSL_early_get0_legacy_version(SSL *s)
4532 if (s->clienthello == NULL)
4534 return s->clienthello->legacy_version;
4537 size_t SSL_early_get0_random(SSL *s, const unsigned char **out)
4539 if (s->clienthello == NULL)
4542 *out = s->clienthello->random;
4543 return SSL3_RANDOM_SIZE;
4546 size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out)
4548 if (s->clienthello == NULL)
4551 *out = s->clienthello->session_id;
4552 return s->clienthello->session_id_len;
4555 size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out)
4557 if (s->clienthello == NULL)
4560 *out = PACKET_data(&s->clienthello->ciphersuites);
4561 return PACKET_remaining(&s->clienthello->ciphersuites);
4564 size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out)
4566 if (s->clienthello == NULL)
4569 *out = s->clienthello->compressions;
4570 return s->clienthello->compressions_len;
4573 int SSL_early_get0_ext(SSL *s, unsigned int type, const unsigned char **out,
4579 if (s->clienthello == NULL)
4581 for (i = 0; i < s->clienthello->pre_proc_exts_len; ++i) {
4582 r = s->clienthello->pre_proc_exts + i;
4583 if (r->present && r->type == type) {
4585 *out = PACKET_data(&r->data);
4587 *outlen = PACKET_remaining(&r->data);
4594 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb)
4596 ctx->keylog_callback = cb;
4599 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx)
4601 return ctx->keylog_callback;
4604 static int nss_keylog_int(const char *prefix,
4606 const uint8_t *parameter_1,
4607 size_t parameter_1_len,
4608 const uint8_t *parameter_2,
4609 size_t parameter_2_len)
4612 char *cursor = NULL;
4617 if (ssl->ctx->keylog_callback == NULL) return 1;
4620 * Our output buffer will contain the following strings, rendered with
4621 * space characters in between, terminated by a NULL character: first the
4622 * prefix, then the first parameter, then the second parameter. The
4623 * meaning of each parameter depends on the specific key material being
4624 * logged. Note that the first and second parameters are encoded in
4625 * hexadecimal, so we need a buffer that is twice their lengths.
4627 prefix_len = strlen(prefix);
4628 out_len = prefix_len + (2*parameter_1_len) + (2*parameter_2_len) + 3;
4629 if ((out = cursor = OPENSSL_malloc(out_len)) == NULL) {
4630 SSLerr(SSL_F_NSS_KEYLOG_INT, ERR_R_MALLOC_FAILURE);
4634 strcpy(cursor, prefix);
4635 cursor += prefix_len;
4638 for (i = 0; i < parameter_1_len; i++) {
4639 sprintf(cursor, "%02x", parameter_1[i]);
4644 for (i = 0; i < parameter_2_len; i++) {
4645 sprintf(cursor, "%02x", parameter_2[i]);
4650 ssl->ctx->keylog_callback(ssl, (const char *)out);
4656 int ssl_log_rsa_client_key_exchange(SSL *ssl,
4657 const uint8_t *encrypted_premaster,
4658 size_t encrypted_premaster_len,
4659 const uint8_t *premaster,
4660 size_t premaster_len)
4662 if (encrypted_premaster_len < 8) {
4663 SSLerr(SSL_F_SSL_LOG_RSA_CLIENT_KEY_EXCHANGE, ERR_R_INTERNAL_ERROR);
4667 /* We only want the first 8 bytes of the encrypted premaster as a tag. */
4668 return nss_keylog_int("RSA",
4670 encrypted_premaster,
4676 int ssl_log_secret(SSL *ssl,
4678 const uint8_t *secret,
4681 return nss_keylog_int(label,
4683 ssl->s3->client_random,
4689 #define SSLV2_CIPHER_LEN 3
4691 int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format,
4696 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4698 if (PACKET_remaining(cipher_suites) == 0) {
4699 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST, SSL_R_NO_CIPHERS_SPECIFIED);
4700 *al = SSL_AD_ILLEGAL_PARAMETER;
4704 if (PACKET_remaining(cipher_suites) % n != 0) {
4705 SSLerr(SSL_F_SSL_CACHE_CIPHERLIST,
4706 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4707 *al = SSL_AD_DECODE_ERROR;
4711 OPENSSL_free(s->s3->tmp.ciphers_raw);
4712 s->s3->tmp.ciphers_raw = NULL;
4713 s->s3->tmp.ciphers_rawlen = 0;
4716 size_t numciphers = PACKET_remaining(cipher_suites) / n;
4717 PACKET sslv2ciphers = *cipher_suites;
4718 unsigned int leadbyte;
4722 * We store the raw ciphers list in SSLv3+ format so we need to do some
4723 * preprocessing to convert the list first. If there are any SSLv2 only
4724 * ciphersuites with a non-zero leading byte then we are going to
4725 * slightly over allocate because we won't store those. But that isn't a
4728 raw = OPENSSL_malloc(numciphers * TLS_CIPHER_LEN);
4729 s->s3->tmp.ciphers_raw = raw;
4731 *al = SSL_AD_INTERNAL_ERROR;
4734 for (s->s3->tmp.ciphers_rawlen = 0;
4735 PACKET_remaining(&sslv2ciphers) > 0;
4736 raw += TLS_CIPHER_LEN) {
4737 if (!PACKET_get_1(&sslv2ciphers, &leadbyte)
4739 && !PACKET_copy_bytes(&sslv2ciphers, raw,
4742 && !PACKET_forward(&sslv2ciphers, TLS_CIPHER_LEN))) {
4743 *al = SSL_AD_INTERNAL_ERROR;
4744 OPENSSL_free(s->s3->tmp.ciphers_raw);
4745 s->s3->tmp.ciphers_raw = NULL;
4746 s->s3->tmp.ciphers_rawlen = 0;
4750 s->s3->tmp.ciphers_rawlen += TLS_CIPHER_LEN;
4752 } else if (!PACKET_memdup(cipher_suites, &s->s3->tmp.ciphers_raw,
4753 &s->s3->tmp.ciphers_rawlen)) {
4754 *al = SSL_AD_INTERNAL_ERROR;
4762 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
4763 int isv2format, STACK_OF(SSL_CIPHER) **sk,
4764 STACK_OF(SSL_CIPHER) **scsvs)
4769 if (!PACKET_buf_init(&pkt, bytes, len))
4771 return bytes_to_cipher_list(s, &pkt, sk, scsvs, isv2format, &alert);
4774 int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
4775 STACK_OF(SSL_CIPHER) **skp,
4776 STACK_OF(SSL_CIPHER) **scsvs_out,
4777 int sslv2format, int *al)
4779 const SSL_CIPHER *c;
4780 STACK_OF(SSL_CIPHER) *sk = NULL;
4781 STACK_OF(SSL_CIPHER) *scsvs = NULL;
4783 /* 3 = SSLV2_CIPHER_LEN > TLS_CIPHER_LEN = 2. */
4784 unsigned char cipher[SSLV2_CIPHER_LEN];
4786 n = sslv2format ? SSLV2_CIPHER_LEN : TLS_CIPHER_LEN;
4788 if (PACKET_remaining(cipher_suites) == 0) {
4789 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, SSL_R_NO_CIPHERS_SPECIFIED);
4790 *al = SSL_AD_ILLEGAL_PARAMETER;
4794 if (PACKET_remaining(cipher_suites) % n != 0) {
4795 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST,
4796 SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST);
4797 *al = SSL_AD_DECODE_ERROR;
4801 sk = sk_SSL_CIPHER_new_null();
4802 scsvs = sk_SSL_CIPHER_new_null();
4803 if (sk == NULL || scsvs == NULL) {
4804 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4805 *al = SSL_AD_INTERNAL_ERROR;
4809 while (PACKET_copy_bytes(cipher_suites, cipher, n)) {
4811 * SSLv3 ciphers wrapped in an SSLv2-compatible ClientHello have the
4812 * first byte set to zero, while true SSLv2 ciphers have a non-zero
4813 * first byte. We don't support any true SSLv2 ciphers, so skip them.
4815 if (sslv2format && cipher[0] != '\0')
4818 /* For SSLv2-compat, ignore leading 0-byte. */
4819 c = ssl_get_cipher_by_char(s, sslv2format ? &cipher[1] : cipher, 1);
4821 if ((c->valid && !sk_SSL_CIPHER_push(sk, c)) ||
4822 (!c->valid && !sk_SSL_CIPHER_push(scsvs, c))) {
4823 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
4824 *al = SSL_AD_INTERNAL_ERROR;
4829 if (PACKET_remaining(cipher_suites) > 0) {
4830 *al = SSL_AD_INTERNAL_ERROR;
4831 SSLerr(SSL_F_BYTES_TO_CIPHER_LIST, ERR_R_INTERNAL_ERROR);
4838 sk_SSL_CIPHER_free(sk);
4839 if (scsvs_out != NULL)
4842 sk_SSL_CIPHER_free(scsvs);
4845 sk_SSL_CIPHER_free(sk);
4846 sk_SSL_CIPHER_free(scsvs);
4850 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data)
4852 ctx->max_early_data = max_early_data;
4857 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx)
4859 return ctx->max_early_data;
4862 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data)
4864 s->max_early_data = max_early_data;
4869 uint32_t SSL_get_max_early_data(const SSL_CTX *s)
4871 return s->max_early_data;