blob: 05bcf6f82a4c19c8e745153b26ea1bef819e146e [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
56 */
57/* ====================================================================
58 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
59 *
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
62 * are met:
63 *
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
66 *
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76 *
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
81 *
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
85 *
86 * 6. Redistributions of any form whatsoever must retain the following
87 * acknowledgment:
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90 *
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
104 *
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com).
108 *
109 */
110/* ====================================================================
111 * Copyright 2005 Nokia. All rights reserved.
112 *
113 * The portions of the attached software ("Contribution") is developed by
114 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
115 * license.
116 *
117 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
118 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
119 * support (see RFC 4279) to OpenSSL.
120 *
121 * No patent licenses or other rights except those expressly stated in
122 * the OpenSSL open source license shall be deemed granted or received
123 * expressly, by implication, estoppel, or otherwise.
124 *
125 * No assurances are provided by Nokia that the Contribution does not
126 * infringe the patent or other intellectual property rights of any third
127 * party or that the license provides you with all the necessary rights
128 * to make use of the Contribution.
129 *
130 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
131 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
132 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
133 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
134 * OTHERWISE. */
135
David Benjamin9e4e01e2015-09-15 01:48:04 -0400136#include <openssl/ssl.h>
137
David Benjamine3aa1d92015-06-16 15:34:50 -0400138#include <assert.h>
David Benjamin4d0be242016-09-01 01:10:07 -0400139#include <stdlib.h>
David Benjaminf0ae1702015-04-07 23:05:04 -0400140#include <string.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700141
David Benjamin31b0c9b2017-07-20 14:49:15 -0400142#include <utility>
143
Adam Langley95c29f32014-06-20 12:00:00 -0700144#include <openssl/err.h>
David Benjamin9a4876e2017-09-15 18:22:43 -0400145#include <openssl/hmac.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700146#include <openssl/lhash.h>
147#include <openssl/mem.h>
148#include <openssl/rand.h>
149
David Benjamin2ee94aa2015-04-07 22:38:30 -0400150#include "internal.h"
David Benjamin546f1a52015-04-15 16:46:09 -0400151#include "../crypto/internal.h"
152
Adam Langley95c29f32014-06-20 12:00:00 -0700153
Joshua Liebow-Feeser8c7c6352018-08-26 18:53:36 -0700154BSSL_NAMESPACE_BEGIN
David Benjamin86e95b82017-07-18 16:34:25 -0400155
David Benjaminc11ea9422017-08-29 16:33:21 -0400156// The address of this is a magic value, a pointer to which is returned by
157// SSL_magic_pending_session_ptr(). It allows a session callback to indicate
158// that it needs to asynchronously fetch session information.
Brian Smithefed2212015-01-28 16:20:02 -0800159static const char g_pending_session_magic = 0;
Adam Langleyb2ce0582014-06-20 12:00:00 -0700160
David Benjaminaa585132015-06-29 23:36:17 -0400161static CRYPTO_EX_DATA_CLASS g_ex_data_class =
162 CRYPTO_EX_DATA_CLASS_INIT_WITH_APP_DATA;
David Benjamin9f33fc62015-04-15 17:29:53 -0400163
David Benjamindafbdd42015-09-14 01:40:10 -0400164static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *session);
165static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *session);
Adam Langley95c29f32014-06-20 12:00:00 -0700166
David Benjamin31b0c9b2017-07-20 14:49:15 -0400167UniquePtr<SSL_SESSION> ssl_session_new(const SSL_X509_METHOD *x509_method) {
David Benjaminbfdd1a92018-06-29 16:26:38 -0400168 return MakeUnique<SSL_SESSION>(x509_method);
David Benjaminabb6c1c2015-09-13 14:46:26 -0400169}
170
David Benjamin58150ed2018-06-29 23:58:43 -0400171uint32_t ssl_hash_session_id(Span<const uint8_t> session_id) {
172 // Take the first four bytes of |session_id|. Session IDs are generated by the
173 // server randomly, so we can assume even using the first four bytes results
174 // in a good distribution.
175 uint8_t tmp_storage[sizeof(uint32_t)];
176 if (session_id.size() < sizeof(tmp_storage)) {
177 OPENSSL_memset(tmp_storage, 0, sizeof(tmp_storage));
178 OPENSSL_memcpy(tmp_storage, session_id.data(), session_id.size());
179 session_id = tmp_storage;
180 }
181
182 uint32_t hash =
183 ((uint32_t)session_id[0]) |
184 ((uint32_t)session_id[1] << 8) |
185 ((uint32_t)session_id[2] << 16) |
186 ((uint32_t)session_id[3] << 24);
187
188 return hash;
189}
190
David Benjamin31b0c9b2017-07-20 14:49:15 -0400191UniquePtr<SSL_SESSION> SSL_SESSION_dup(SSL_SESSION *session, int dup_flags) {
192 UniquePtr<SSL_SESSION> new_session = ssl_session_new(session->x509_method);
193 if (!new_session) {
194 return nullptr;
Steven Valdez87eab492016-06-27 16:34:59 -0400195 }
196
Adam Langley364f7a62016-12-12 10:51:00 -0800197 new_session->is_server = session->is_server;
Steven Valdez87eab492016-06-27 16:34:59 -0400198 new_session->ssl_version = session->ssl_version;
Nick Harper6bfd25c2020-03-30 17:15:19 -0700199 new_session->is_quic = session->is_quic;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400200 new_session->sid_ctx_length = session->sid_ctx_length;
David Benjamin17cf2cb2016-12-13 01:07:13 -0500201 OPENSSL_memcpy(new_session->sid_ctx, session->sid_ctx, session->sid_ctx_length);
Steven Valdez4aa154e2016-07-29 14:32:55 -0400202
David Benjaminc11ea9422017-08-29 16:33:21 -0400203 // Copy the key material.
David Benjamin5351c8b2020-11-19 00:25:29 -0500204 new_session->secret_length = session->secret_length;
205 OPENSSL_memcpy(new_session->secret, session->secret, session->secret_length);
Steven Valdez4aa154e2016-07-29 14:32:55 -0400206 new_session->cipher = session->cipher;
207
David Benjaminc11ea9422017-08-29 16:33:21 -0400208 // Copy authentication state.
David Benjaminbfdd1a92018-06-29 16:26:38 -0400209 if (session->psk_identity != nullptr) {
David Benjamin3ba95862019-10-21 16:14:33 -0400210 new_session->psk_identity.reset(
211 OPENSSL_strdup(session->psk_identity.get()));
David Benjaminbfdd1a92018-06-29 16:26:38 -0400212 if (new_session->psk_identity == nullptr) {
David Benjamin31b0c9b2017-07-20 14:49:15 -0400213 return nullptr;
Steven Valdez87eab492016-06-27 16:34:59 -0400214 }
215 }
David Benjaminbfdd1a92018-06-29 16:26:38 -0400216 if (session->certs != nullptr) {
David Benjamin2908dd12018-06-29 17:46:42 -0400217 auto buf_up_ref = [](CRYPTO_BUFFER *buf) {
218 CRYPTO_BUFFER_up_ref(buf);
219 return buf;
220 };
David Benjaminbfdd1a92018-06-29 16:26:38 -0400221 new_session->certs.reset(sk_CRYPTO_BUFFER_deep_copy(
222 session->certs.get(), buf_up_ref, CRYPTO_BUFFER_free));
223 if (new_session->certs == nullptr) {
David Benjamin31b0c9b2017-07-20 14:49:15 -0400224 return nullptr;
Adam Langley68e71242016-12-12 11:06:16 -0800225 }
Adam Langley68e71242016-12-12 11:06:16 -0800226 }
Adam Langley46db7af2017-02-01 15:49:37 -0800227
David Benjamin31b0c9b2017-07-20 14:49:15 -0400228 if (!session->x509_method->session_dup(new_session.get(), session)) {
229 return nullptr;
Steven Valdez87eab492016-06-27 16:34:59 -0400230 }
Adam Langley46db7af2017-02-01 15:49:37 -0800231
Steven Valdez87eab492016-06-27 16:34:59 -0400232 new_session->verify_result = session->verify_result;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400233
David Benjaminbfdd1a92018-06-29 16:26:38 -0400234 new_session->ocsp_response = UpRef(session->ocsp_response);
235 new_session->signed_cert_timestamp_list =
236 UpRef(session->signed_cert_timestamp_list);
Steven Valdez4aa154e2016-07-29 14:32:55 -0400237
David Benjamin17cf2cb2016-12-13 01:07:13 -0500238 OPENSSL_memcpy(new_session->peer_sha256, session->peer_sha256,
239 SHA256_DIGEST_LENGTH);
Steven Valdez87eab492016-06-27 16:34:59 -0400240 new_session->peer_sha256_valid = session->peer_sha256_valid;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400241
David Benjaminf1050fd2016-12-13 20:05:36 -0500242 new_session->peer_signature_algorithm = session->peer_signature_algorithm;
243
David Benjamin01a90572016-09-22 00:11:43 -0400244 new_session->timeout = session->timeout;
David Benjamin17b30832017-01-28 14:00:32 -0500245 new_session->auth_timeout = session->auth_timeout;
David Benjamin01a90572016-09-22 00:11:43 -0400246 new_session->time = session->time;
247
David Benjaminc11ea9422017-08-29 16:33:21 -0400248 // Copy non-authentication connection properties.
Steven Valdez4aa154e2016-07-29 14:32:55 -0400249 if (dup_flags & SSL_SESSION_INCLUDE_NONAUTH) {
250 new_session->session_id_length = session->session_id_length;
David Benjamin17cf2cb2016-12-13 01:07:13 -0500251 OPENSSL_memcpy(new_session->session_id, session->session_id,
252 session->session_id_length);
Steven Valdez4aa154e2016-07-29 14:32:55 -0400253
David Benjamin4882a6c2016-12-11 02:48:12 -0500254 new_session->group_id = session->group_id;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400255
David Benjamin17cf2cb2016-12-13 01:07:13 -0500256 OPENSSL_memcpy(new_session->original_handshake_hash,
257 session->original_handshake_hash,
258 session->original_handshake_hash_len);
Steven Valdez4aa154e2016-07-29 14:32:55 -0400259 new_session->original_handshake_hash_len =
260 session->original_handshake_hash_len;
David Benjaminbfdd1a92018-06-29 16:26:38 -0400261 new_session->ticket_lifetime_hint = session->ticket_lifetime_hint;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400262 new_session->ticket_age_add = session->ticket_age_add;
Steven Valdez08b65f42016-12-07 15:29:45 -0500263 new_session->ticket_max_early_data = session->ticket_max_early_data;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400264 new_session->extended_master_secret = session->extended_master_secret;
Steven Valdez51607f12020-08-05 10:46:05 -0400265 new_session->has_application_settings = session->has_application_settings;
Steven Valdez27a9e6a2017-02-14 13:20:40 -0500266
Steven Valdez51607f12020-08-05 10:46:05 -0400267 if (!new_session->early_alpn.CopyFrom(session->early_alpn) ||
268 !new_session->quic_early_data_context.CopyFrom(
269 session->quic_early_data_context) ||
270 !new_session->local_application_settings.CopyFrom(
271 session->local_application_settings) ||
272 !new_session->peer_application_settings.CopyFrom(
273 session->peer_application_settings)) {
Nick Harper7c522992020-04-30 14:15:49 -0700274 return nullptr;
275 }
Steven Valdez4aa154e2016-07-29 14:32:55 -0400276 }
277
David Benjaminc11ea9422017-08-29 16:33:21 -0400278 // Copy the ticket.
David Benjaminbfdd1a92018-06-29 16:26:38 -0400279 if (dup_flags & SSL_SESSION_INCLUDE_TICKET &&
280 !new_session->ticket.CopyFrom(session->ticket)) {
281 return nullptr;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400282 }
283
David Benjaminc11ea9422017-08-29 16:33:21 -0400284 // The new_session does not get a copy of the ex_data.
Steven Valdez4aa154e2016-07-29 14:32:55 -0400285
David Benjamina3a71e92018-06-29 13:24:45 -0400286 new_session->not_resumable = true;
Steven Valdez87eab492016-06-27 16:34:59 -0400287 return new_session;
Steven Valdez87eab492016-06-27 16:34:59 -0400288}
289
David Benjamin17b30832017-01-28 14:00:32 -0500290void ssl_session_rebase_time(SSL *ssl, SSL_SESSION *session) {
David Benjaminad8f5e12017-02-20 17:00:20 -0500291 struct OPENSSL_timeval now;
David Benjamin123db572016-11-03 16:59:25 -0400292 ssl_get_current_time(ssl, &now);
293
David Benjaminc11ea9422017-08-29 16:33:21 -0400294 // To avoid overflows and underflows, if we've gone back in time, update the
295 // time, but mark the session expired.
David Benjaminad8f5e12017-02-20 17:00:20 -0500296 if (session->time > now.tv_sec) {
David Benjamin123db572016-11-03 16:59:25 -0400297 session->time = now.tv_sec;
298 session->timeout = 0;
David Benjamin17b30832017-01-28 14:00:32 -0500299 session->auth_timeout = 0;
David Benjamin123db572016-11-03 16:59:25 -0400300 return;
301 }
302
David Benjaminc11ea9422017-08-29 16:33:21 -0400303 // Adjust the session time and timeouts. If the session has already expired,
304 // clamp the timeouts at zero.
David Benjaminad8f5e12017-02-20 17:00:20 -0500305 uint64_t delta = now.tv_sec - session->time;
David Benjamin123db572016-11-03 16:59:25 -0400306 session->time = now.tv_sec;
307 if (session->timeout < delta) {
308 session->timeout = 0;
309 } else {
310 session->timeout -= delta;
311 }
David Benjamin17b30832017-01-28 14:00:32 -0500312 if (session->auth_timeout < delta) {
313 session->auth_timeout = 0;
314 } else {
315 session->auth_timeout -= delta;
316 }
317}
318
David Benjaminad8f5e12017-02-20 17:00:20 -0500319void ssl_session_renew_timeout(SSL *ssl, SSL_SESSION *session,
320 uint32_t timeout) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400321 // Rebase the timestamp relative to the current time so |timeout| is measured
322 // correctly.
David Benjamin17b30832017-01-28 14:00:32 -0500323 ssl_session_rebase_time(ssl, session);
324
325 if (session->timeout > timeout) {
326 return;
327 }
328
329 session->timeout = timeout;
330 if (session->timeout > session->auth_timeout) {
331 session->timeout = session->auth_timeout;
332 }
David Benjamin123db572016-11-03 16:59:25 -0400333}
334
David Benjamina4bafd32017-10-03 15:06:29 -0400335uint16_t ssl_session_protocol_version(const SSL_SESSION *session) {
Steven Valdez8f36c512017-06-20 10:55:02 -0400336 uint16_t ret;
337 if (!ssl_protocol_version_from_wire(&ret, session->ssl_version)) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400338 // An |SSL_SESSION| will never have an invalid version. This is enforced by
339 // the parser.
Steven Valdez8f36c512017-06-20 10:55:02 -0400340 assert(0);
341 return 0;
Steven Valdez908ac192017-01-12 13:17:07 -0500342 }
343
Steven Valdez8f36c512017-06-20 10:55:02 -0400344 return ret;
345}
346
David Benjamina4bafd32017-10-03 15:06:29 -0400347const EVP_MD *ssl_session_get_digest(const SSL_SESSION *session) {
348 return ssl_get_handshake_digest(ssl_session_protocol_version(session),
David Benjaminca9e8f52017-08-09 15:02:34 -0400349 session->cipher);
Steven Valdez908ac192017-01-12 13:17:07 -0500350}
351
David Benjamin962b3752021-05-10 15:17:18 -0400352bool ssl_get_new_session(SSL_HANDSHAKE *hs) {
David Benjaminf3c8f8d2016-11-17 17:20:47 +0900353 SSL *const ssl = hs->ssl;
David Benjamindc2aea22015-10-18 12:50:32 -0400354 if (ssl->mode & SSL_MODE_NO_SESSION_CREATION) {
David Benjamin3570d732015-06-29 00:28:17 -0400355 OPENSSL_PUT_ERROR(SSL, SSL_R_SESSION_MAY_NOT_BE_CREATED);
David Benjamin962b3752021-05-10 15:17:18 -0400356 return false;
Adam Langleyfcf25832014-12-18 17:42:32 -0800357 }
358
David Benjamin31b0c9b2017-07-20 14:49:15 -0400359 UniquePtr<SSL_SESSION> session = ssl_session_new(ssl->ctx->x509_method);
David Benjamindc2aea22015-10-18 12:50:32 -0400360 if (session == NULL) {
David Benjamin962b3752021-05-10 15:17:18 -0400361 return false;
Adam Langleyfcf25832014-12-18 17:42:32 -0800362 }
363
David Benjamin962b3752021-05-10 15:17:18 -0400364 session->is_server = ssl->server;
Adam Langley364f7a62016-12-12 10:51:00 -0800365 session->ssl_version = ssl->version;
Nick Harper6bfd25c2020-03-30 17:15:19 -0700366 session->is_quic = ssl->quic_method != nullptr;
Adam Langley364f7a62016-12-12 10:51:00 -0800367
David Benjaminc11ea9422017-08-29 16:33:21 -0400368 // Fill in the time from the |SSL_CTX|'s clock.
David Benjaminad8f5e12017-02-20 17:00:20 -0500369 struct OPENSSL_timeval now;
David Benjamin721e8b72016-08-03 13:13:17 -0400370 ssl_get_current_time(ssl, &now);
371 session->time = now.tv_sec;
372
David Benjamind1e3ce12017-10-06 18:31:15 -0400373 uint16_t version = ssl_protocol_version(ssl);
David Benjamin17b30832017-01-28 14:00:32 -0500374 if (version >= TLS1_3_VERSION) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400375 // TLS 1.3 uses tickets as authenticators, so we are willing to use them for
376 // longer.
David Benjamin98472cb2018-05-02 16:05:36 -0400377 session->timeout = ssl->session_ctx->session_psk_dhe_timeout;
David Benjamin17b30832017-01-28 14:00:32 -0500378 session->auth_timeout = SSL_DEFAULT_SESSION_AUTH_TIMEOUT;
379 } else {
David Benjaminc11ea9422017-08-29 16:33:21 -0400380 // TLS 1.2 resumption does not incorporate new key material, so we use a
381 // much shorter timeout.
David Benjamin98472cb2018-05-02 16:05:36 -0400382 session->timeout = ssl->session_ctx->session_timeout;
383 session->auth_timeout = ssl->session_ctx->session_timeout;
David Benjamin17b30832017-01-28 14:00:32 -0500384 }
Adam Langleyfcf25832014-12-18 17:42:32 -0800385
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700386 if (hs->config->cert->sid_ctx_length > sizeof(session->sid_ctx)) {
David Benjamin3570d732015-06-29 00:28:17 -0400387 OPENSSL_PUT_ERROR(SSL, ERR_R_INTERNAL_ERROR);
David Benjamin962b3752021-05-10 15:17:18 -0400388 return false;
Adam Langleyfcf25832014-12-18 17:42:32 -0800389 }
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700390 OPENSSL_memcpy(session->sid_ctx, hs->config->cert->sid_ctx,
391 hs->config->cert->sid_ctx_length);
392 session->sid_ctx_length = hs->config->cert->sid_ctx_length;
Adam Langleyfcf25832014-12-18 17:42:32 -0800393
David Benjaminc11ea9422017-08-29 16:33:21 -0400394 // The session is marked not resumable until it is completely filled in.
David Benjamina3a71e92018-06-29 13:24:45 -0400395 session->not_resumable = true;
Adam Langley9498e742016-07-18 10:17:16 -0700396 session->verify_result = X509_V_ERR_INVALID_CALL;
Adam Langleyfcf25832014-12-18 17:42:32 -0800397
David Benjamin31b0c9b2017-07-20 14:49:15 -0400398 hs->new_session = std::move(session);
David Benjamin4d0be242016-09-01 01:10:07 -0400399 ssl_set_session(ssl, NULL);
David Benjamin962b3752021-05-10 15:17:18 -0400400 return true;
Adam Langleyfcf25832014-12-18 17:42:32 -0800401}
Adam Langley95c29f32014-06-20 12:00:00 -0700402
Martin Kreichgauer72912d22017-08-04 12:06:43 -0700403int ssl_ctx_rotate_ticket_encryption_key(SSL_CTX *ctx) {
404 OPENSSL_timeval now;
405 ssl_ctx_get_current_time(ctx, &now);
406 {
David Benjaminc11ea9422017-08-29 16:33:21 -0400407 // Avoid acquiring a write lock in the common case (i.e. a non-default key
408 // is used or the default keys have not expired yet).
Martin Kreichgauer72912d22017-08-04 12:06:43 -0700409 MutexReadLock lock(&ctx->lock);
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400410 if (ctx->ticket_key_current &&
411 (ctx->ticket_key_current->next_rotation_tv_sec == 0 ||
412 ctx->ticket_key_current->next_rotation_tv_sec > now.tv_sec) &&
413 (!ctx->ticket_key_prev ||
414 ctx->ticket_key_prev->next_rotation_tv_sec > now.tv_sec)) {
Martin Kreichgauer72912d22017-08-04 12:06:43 -0700415 return 1;
416 }
417 }
418
419 MutexWriteLock lock(&ctx->lock);
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400420 if (!ctx->ticket_key_current ||
421 (ctx->ticket_key_current->next_rotation_tv_sec != 0 &&
422 ctx->ticket_key_current->next_rotation_tv_sec <= now.tv_sec)) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400423 // The current key has not been initialized or it is expired.
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400424 auto new_key = bssl::MakeUnique<TicketKey>();
Martin Kreichgauer72912d22017-08-04 12:06:43 -0700425 if (!new_key) {
426 return 0;
427 }
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400428 RAND_bytes(new_key->name, 16);
429 RAND_bytes(new_key->hmac_key, 16);
430 RAND_bytes(new_key->aes_key, 16);
431 new_key->next_rotation_tv_sec =
432 now.tv_sec + SSL_DEFAULT_TICKET_KEY_ROTATION_INTERVAL;
433 if (ctx->ticket_key_current) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400434 // The current key expired. Rotate it to prev and bump up its rotation
435 // timestamp. Note that even with the new rotation time it may still be
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400436 // expired and get dropped below.
437 ctx->ticket_key_current->next_rotation_tv_sec +=
Martin Kreichgauer72912d22017-08-04 12:06:43 -0700438 SSL_DEFAULT_TICKET_KEY_ROTATION_INTERVAL;
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400439 ctx->ticket_key_prev = std::move(ctx->ticket_key_current);
Martin Kreichgauer72912d22017-08-04 12:06:43 -0700440 }
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400441 ctx->ticket_key_current = std::move(new_key);
Martin Kreichgauer72912d22017-08-04 12:06:43 -0700442 }
443
David Benjaminc11ea9422017-08-29 16:33:21 -0400444 // Drop an expired prev key.
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400445 if (ctx->ticket_key_prev &&
446 ctx->ticket_key_prev->next_rotation_tv_sec <= now.tv_sec) {
447 ctx->ticket_key_prev.reset();
Martin Kreichgauer72912d22017-08-04 12:06:43 -0700448 }
449
450 return 1;
451}
452
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700453static int ssl_encrypt_ticket_with_cipher_ctx(SSL_HANDSHAKE *hs, CBB *out,
Adam Langley4c341d02017-03-08 19:33:21 -0800454 const uint8_t *session_buf,
455 size_t session_len) {
David Benjamin86e95b82017-07-18 16:34:25 -0400456 ScopedEVP_CIPHER_CTX ctx;
457 ScopedHMAC_CTX hctx;
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400458
David Benjaminc11ea9422017-08-29 16:33:21 -0400459 // If the session is too long, emit a dummy value rather than abort the
460 // connection.
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400461 static const size_t kMaxTicketOverhead =
462 16 + EVP_MAX_IV_LENGTH + EVP_MAX_BLOCK_LENGTH + EVP_MAX_MD_SIZE;
463 if (session_len > 0xffff - kMaxTicketOverhead) {
464 static const char kTicketPlaceholder[] = "TICKET TOO LARGE";
David Benjamin0238d8f2017-07-12 17:35:14 -0400465 return CBB_add_bytes(out, (const uint8_t *)kTicketPlaceholder,
466 strlen(kTicketPlaceholder));
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400467 }
468
David Benjaminc11ea9422017-08-29 16:33:21 -0400469 // Initialize HMAC and cipher contexts. If callback present it does all the
470 // work otherwise use generated values from parent ctx.
David Benjamin50596f82018-07-02 19:47:27 -0400471 SSL_CTX *tctx = hs->ssl->session_ctx.get();
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400472 uint8_t iv[EVP_MAX_IV_LENGTH];
473 uint8_t key_name[16];
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400474 if (tctx->ticket_key_cb != NULL) {
475 if (tctx->ticket_key_cb(hs->ssl, key_name, iv, ctx.get(), hctx.get(),
476 1 /* encrypt */) < 0) {
David Benjamin0238d8f2017-07-12 17:35:14 -0400477 return 0;
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400478 }
479 } else {
David Benjaminc11ea9422017-08-29 16:33:21 -0400480 // Rotate ticket key if necessary.
Martin Kreichgauer72912d22017-08-04 12:06:43 -0700481 if (!ssl_ctx_rotate_ticket_encryption_key(tctx)) {
482 return 0;
483 }
484 MutexReadLock lock(&tctx->lock);
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400485 if (!RAND_bytes(iv, 16) ||
David Benjamin0238d8f2017-07-12 17:35:14 -0400486 !EVP_EncryptInit_ex(ctx.get(), EVP_aes_128_cbc(), NULL,
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400487 tctx->ticket_key_current->aes_key, iv) ||
488 !HMAC_Init_ex(hctx.get(), tctx->ticket_key_current->hmac_key, 16,
David Benjamin0238d8f2017-07-12 17:35:14 -0400489 tlsext_tick_md(), NULL)) {
490 return 0;
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400491 }
David Benjamin7bb0fbf2018-07-03 13:55:42 -0400492 OPENSSL_memcpy(key_name, tctx->ticket_key_current->name, 16);
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400493 }
494
495 uint8_t *ptr;
496 if (!CBB_add_bytes(out, key_name, 16) ||
David Benjamin0238d8f2017-07-12 17:35:14 -0400497 !CBB_add_bytes(out, iv, EVP_CIPHER_CTX_iv_length(ctx.get())) ||
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400498 !CBB_reserve(out, &ptr, session_len + EVP_MAX_BLOCK_LENGTH)) {
David Benjamin0238d8f2017-07-12 17:35:14 -0400499 return 0;
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400500 }
501
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400502 size_t total = 0;
David Benjaminfbc45d72016-09-22 01:21:24 -0400503#if defined(BORINGSSL_UNSAFE_FUZZER_MODE)
David Benjamin17cf2cb2016-12-13 01:07:13 -0500504 OPENSSL_memcpy(ptr, session_buf, session_len);
David Benjaminfbc45d72016-09-22 01:21:24 -0400505 total = session_len;
506#else
507 int len;
David Benjamin0238d8f2017-07-12 17:35:14 -0400508 if (!EVP_EncryptUpdate(ctx.get(), ptr + total, &len, session_buf, session_len)) {
509 return 0;
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400510 }
511 total += len;
David Benjamin0238d8f2017-07-12 17:35:14 -0400512 if (!EVP_EncryptFinal_ex(ctx.get(), ptr + total, &len)) {
513 return 0;
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400514 }
515 total += len;
David Benjaminfbc45d72016-09-22 01:21:24 -0400516#endif
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400517 if (!CBB_did_write(out, total)) {
David Benjamin0238d8f2017-07-12 17:35:14 -0400518 return 0;
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400519 }
520
521 unsigned hlen;
David Benjamin0238d8f2017-07-12 17:35:14 -0400522 if (!HMAC_Update(hctx.get(), CBB_data(out), CBB_len(out)) ||
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400523 !CBB_reserve(out, &ptr, EVP_MAX_MD_SIZE) ||
David Benjamin0238d8f2017-07-12 17:35:14 -0400524 !HMAC_Final(hctx.get(), ptr, &hlen) ||
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400525 !CBB_did_write(out, hlen)) {
David Benjamin0238d8f2017-07-12 17:35:14 -0400526 return 0;
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400527 }
528
David Benjamin0238d8f2017-07-12 17:35:14 -0400529 return 1;
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400530}
531
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700532static int ssl_encrypt_ticket_with_method(SSL_HANDSHAKE *hs, CBB *out,
Adam Langley4c341d02017-03-08 19:33:21 -0800533 const uint8_t *session_buf,
534 size_t session_len) {
David Benjamin98472cb2018-05-02 16:05:36 -0400535 SSL *const ssl = hs->ssl;
536 const SSL_TICKET_AEAD_METHOD *method = ssl->session_ctx->ticket_aead_method;
537 const size_t max_overhead = method->max_overhead(ssl);
Adam Langley4c341d02017-03-08 19:33:21 -0800538 const size_t max_out = session_len + max_overhead;
539 if (max_out < max_overhead) {
540 OPENSSL_PUT_ERROR(SSL, ERR_R_OVERFLOW);
541 return 0;
542 }
543
544 uint8_t *ptr;
545 if (!CBB_reserve(out, &ptr, max_out)) {
546 return 0;
547 }
548
549 size_t out_len;
David Benjamin98472cb2018-05-02 16:05:36 -0400550 if (!method->seal(ssl, ptr, &out_len, max_out, session_buf,
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700551 session_len)) {
Adam Langley4c341d02017-03-08 19:33:21 -0800552 OPENSSL_PUT_ERROR(SSL, SSL_R_TICKET_ENCRYPTION_FAILED);
553 return 0;
554 }
555
556 if (!CBB_did_write(out, out_len)) {
557 return 0;
558 }
559
560 return 1;
561}
562
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700563int ssl_encrypt_ticket(SSL_HANDSHAKE *hs, CBB *out,
564 const SSL_SESSION *session) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400565 // Serialize the SSL_SESSION to be encoded into the ticket.
Adam Langley4c341d02017-03-08 19:33:21 -0800566 uint8_t *session_buf = NULL;
567 size_t session_len;
568 if (!SSL_SESSION_to_bytes_for_ticket(session, &session_buf, &session_len)) {
569 return -1;
570 }
571
572 int ret = 0;
David Benjamin98472cb2018-05-02 16:05:36 -0400573 if (hs->ssl->session_ctx->ticket_aead_method) {
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700574 ret = ssl_encrypt_ticket_with_method(hs, out, session_buf, session_len);
Adam Langley4c341d02017-03-08 19:33:21 -0800575 } else {
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700576 ret = ssl_encrypt_ticket_with_cipher_ctx(hs, out, session_buf, session_len);
Adam Langley4c341d02017-03-08 19:33:21 -0800577 }
578
579 OPENSSL_free(session_buf);
580 return ret;
581}
582
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700583int ssl_session_is_context_valid(const SSL_HANDSHAKE *hs,
584 const SSL_SESSION *session) {
Steven Valdez4aa154e2016-07-29 14:32:55 -0400585 if (session == NULL) {
586 return 0;
587 }
588
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700589 return session->sid_ctx_length == hs->config->cert->sid_ctx_length &&
590 OPENSSL_memcmp(session->sid_ctx, hs->config->cert->sid_ctx,
591 hs->config->cert->sid_ctx_length) == 0;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400592}
593
594int ssl_session_is_time_valid(const SSL *ssl, const SSL_SESSION *session) {
595 if (session == NULL) {
596 return 0;
597 }
598
David Benjaminad8f5e12017-02-20 17:00:20 -0500599 struct OPENSSL_timeval now;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400600 ssl_get_current_time(ssl, &now);
David Benjamin1b22f852016-10-27 16:36:32 -0400601
David Benjaminc11ea9422017-08-29 16:33:21 -0400602 // Reject tickets from the future to avoid underflow.
David Benjaminad8f5e12017-02-20 17:00:20 -0500603 if (now.tv_sec < session->time) {
David Benjamin1b22f852016-10-27 16:36:32 -0400604 return 0;
605 }
606
David Benjaminad8f5e12017-02-20 17:00:20 -0500607 return session->timeout > now.tv_sec - session->time;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400608}
609
David Benjamin45738dd2017-02-09 20:01:26 -0500610int ssl_session_is_resumable(const SSL_HANDSHAKE *hs,
611 const SSL_SESSION *session) {
612 const SSL *const ssl = hs->ssl;
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700613 return ssl_session_is_context_valid(hs, session) &&
David Benjaminc11ea9422017-08-29 16:33:21 -0400614 // The session must have been created by the same type of end point as
615 // we're now using it with.
David Benjamin45738dd2017-02-09 20:01:26 -0500616 ssl->server == session->is_server &&
David Benjaminc11ea9422017-08-29 16:33:21 -0400617 // The session must not be expired.
David Benjamin75f99142016-11-12 12:36:06 +0900618 ssl_session_is_time_valid(ssl, session) &&
David Benjamin754d4c92020-02-11 16:27:21 -0500619 // Only resume if the session's version matches the negotiated
620 // version.
David Benjamin75f99142016-11-12 12:36:06 +0900621 ssl->version == session->ssl_version &&
David Benjamin754d4c92020-02-11 16:27:21 -0500622 // Only resume if the session's cipher matches the negotiated one. This
623 // is stricter than necessary for TLS 1.3, which allows cross-cipher
624 // resumption if the PRF hashes match. We require an exact match for
625 // simplicity. If loosening this, the 0-RTT accept logic must be
626 // updated to check the cipher.
David Benjamin45738dd2017-02-09 20:01:26 -0500627 hs->new_cipher == session->cipher &&
David Benjaminc11ea9422017-08-29 16:33:21 -0400628 // If the session contains a client certificate (either the full
629 // certificate or just the hash) then require that the form of the
630 // certificate matches the current configuration.
David Benjaminbfdd1a92018-06-29 16:26:38 -0400631 ((sk_CRYPTO_BUFFER_num(session->certs.get()) == 0 &&
Adam Langley46db7af2017-02-01 15:49:37 -0800632 !session->peer_sha256_valid) ||
David Benjaminbbaf3672016-11-17 10:53:09 +0900633 session->peer_sha256_valid ==
Nick Harper6bfd25c2020-03-30 17:15:19 -0700634 hs->config->retain_only_sha256_of_client_certs) &&
635 // Only resume if the underlying transport protocol hasn't changed.
636 // This is to prevent cross-protocol resumption between QUIC and TCP.
637 (hs->ssl->quic_method != nullptr) == session->is_quic;
David Benjamin75f99142016-11-12 12:36:06 +0900638}
639
David Benjaminc11ea9422017-08-29 16:33:21 -0400640// ssl_lookup_session looks up |session_id| in the session cache and sets
641// |*out_session| to an |SSL_SESSION| object if found.
Steven Valdez398085b2017-08-29 13:25:56 -0400642static enum ssl_hs_wait_t ssl_lookup_session(
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700643 SSL_HANDSHAKE *hs, UniquePtr<SSL_SESSION> *out_session,
David Benjamin58150ed2018-06-29 23:58:43 -0400644 Span<const uint8_t> session_id) {
David Benjamin98472cb2018-05-02 16:05:36 -0400645 SSL *const ssl = hs->ssl;
David Benjamin37af90f2017-07-29 01:42:16 -0400646 out_session->reset();
Adam Langley95c29f32014-06-20 12:00:00 -0700647
David Benjamin58150ed2018-06-29 23:58:43 -0400648 if (session_id.empty() || session_id.size() > SSL_MAX_SSL_SESSION_ID_LENGTH) {
Steven Valdez398085b2017-08-29 13:25:56 -0400649 return ssl_hs_ok;
Adam Langleyfcf25832014-12-18 17:42:32 -0800650 }
Adam Langley95c29f32014-06-20 12:00:00 -0700651
David Benjamin37af90f2017-07-29 01:42:16 -0400652 UniquePtr<SSL_SESSION> session;
David Benjaminc11ea9422017-08-29 16:33:21 -0400653 // Try the internal cache, if it exists.
David Benjamin98472cb2018-05-02 16:05:36 -0400654 if (!(ssl->session_ctx->session_cache_mode &
Adam Langleyfcf25832014-12-18 17:42:32 -0800655 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
David Benjamin58150ed2018-06-29 23:58:43 -0400656 uint32_t hash = ssl_hash_session_id(session_id);
657 auto cmp = [](const void *key, const SSL_SESSION *sess) -> int {
658 Span<const uint8_t> key_id =
659 *reinterpret_cast<const Span<const uint8_t> *>(key);
660 Span<const uint8_t> sess_id =
661 MakeConstSpan(sess->session_id, sess->session_id_length);
662 return key_id == sess_id ? 0 : 1;
663 };
David Benjamin98472cb2018-05-02 16:05:36 -0400664 MutexReadLock lock(&ssl->session_ctx->lock);
David Benjamin58150ed2018-06-29 23:58:43 -0400665 // |lh_SSL_SESSION_retrieve_key| returns a non-owning pointer.
666 session = UpRef(lh_SSL_SESSION_retrieve_key(ssl->session_ctx->sessions,
667 &session_id, hash, cmp));
David Benjaminc11ea9422017-08-29 16:33:21 -0400668 // TODO(davidben): This should probably move it to the front of the list.
Adam Langleyfcf25832014-12-18 17:42:32 -0800669 }
Adam Langley95c29f32014-06-20 12:00:00 -0700670
David Benjaminc11ea9422017-08-29 16:33:21 -0400671 // Fall back to the external cache, if it exists.
David Benjamin98472cb2018-05-02 16:05:36 -0400672 if (!session && ssl->session_ctx->get_session_cb != nullptr) {
Steven Valdez4aa154e2016-07-29 14:32:55 -0400673 int copy = 1;
David Benjamin58150ed2018-06-29 23:58:43 -0400674 session.reset(ssl->session_ctx->get_session_cb(ssl, session_id.data(),
675 session_id.size(), &copy));
David Benjamin37af90f2017-07-29 01:42:16 -0400676 if (!session) {
Steven Valdez398085b2017-08-29 13:25:56 -0400677 return ssl_hs_ok;
Adam Langley81f43352016-08-26 09:22:56 -0700678 }
679
David Benjamin37af90f2017-07-29 01:42:16 -0400680 if (session.get() == SSL_magic_pending_session_ptr()) {
681 session.release(); // This pointer is not actually owned.
Steven Valdez398085b2017-08-29 13:25:56 -0400682 return ssl_hs_pending_session;
Steven Valdez4aa154e2016-07-29 14:32:55 -0400683 }
684
David Benjaminc11ea9422017-08-29 16:33:21 -0400685 // Increment reference count now if the session callback asks us to do so
686 // (note that if the session structures returned by the callback are shared
687 // between threads, it must handle the reference count itself [i.e. copy ==
688 // 0], or things won't be thread-safe).
Steven Valdez4aa154e2016-07-29 14:32:55 -0400689 if (copy) {
David Benjamin37af90f2017-07-29 01:42:16 -0400690 SSL_SESSION_up_ref(session.get());
Steven Valdez4aa154e2016-07-29 14:32:55 -0400691 }
692
David Benjaminc11ea9422017-08-29 16:33:21 -0400693 // Add the externally cached session to the internal cache if necessary.
David Benjamin98472cb2018-05-02 16:05:36 -0400694 if (!(ssl->session_ctx->session_cache_mode &
Steven Valdez4aa154e2016-07-29 14:32:55 -0400695 SSL_SESS_CACHE_NO_INTERNAL_STORE)) {
David Benjamin50596f82018-07-02 19:47:27 -0400696 SSL_CTX_add_session(ssl->session_ctx.get(), session.get());
Steven Valdez4aa154e2016-07-29 14:32:55 -0400697 }
David Benjamine3aa1d92015-06-16 15:34:50 -0400698 }
Steven Valdez4aa154e2016-07-29 14:32:55 -0400699
David Benjamin98472cb2018-05-02 16:05:36 -0400700 if (session && !ssl_session_is_time_valid(ssl, session.get())) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400701 // The session was from the cache, so remove it.
David Benjamin50596f82018-07-02 19:47:27 -0400702 SSL_CTX_remove_session(ssl->session_ctx.get(), session.get());
David Benjamin37af90f2017-07-29 01:42:16 -0400703 session.reset();
David Benjamine3aa1d92015-06-16 15:34:50 -0400704 }
705
David Benjamin37af90f2017-07-29 01:42:16 -0400706 *out_session = std::move(session);
Steven Valdez398085b2017-08-29 13:25:56 -0400707 return ssl_hs_ok;
David Benjamine3aa1d92015-06-16 15:34:50 -0400708}
709
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700710enum ssl_hs_wait_t ssl_get_prev_session(SSL_HANDSHAKE *hs,
Steven Valdez398085b2017-08-29 13:25:56 -0400711 UniquePtr<SSL_SESSION> *out_session,
David Benjaminfd45ee72017-08-31 14:49:09 -0400712 bool *out_tickets_supported,
713 bool *out_renew_ticket,
Steven Valdez398085b2017-08-29 13:25:56 -0400714 const SSL_CLIENT_HELLO *client_hello) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400715 // This is used only by servers.
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700716 assert(hs->ssl->server);
David Benjamin15868b32017-09-26 17:46:58 -0400717 UniquePtr<SSL_SESSION> session;
718 bool renew_ticket = false;
David Benjamine3aa1d92015-06-16 15:34:50 -0400719
David Benjaminc11ea9422017-08-29 16:33:21 -0400720 // If tickets are disabled, always behave as if no tickets are present.
David Benjamin28655672018-07-18 23:23:25 -0400721 CBS ticket;
David Benjaminfd45ee72017-08-31 14:49:09 -0400722 const bool tickets_supported =
Matthew Braithwaiteb7bc80a2018-04-13 15:51:30 -0700723 !(SSL_get_options(hs->ssl) & SSL_OP_NO_TICKET) &&
David Benjamin28655672018-07-18 23:23:25 -0400724 ssl_client_hello_get_extension(client_hello, &ticket,
725 TLSEXT_TYPE_session_ticket);
726 if (tickets_supported && CBS_len(&ticket) != 0) {
727 switch (ssl_process_ticket(hs, &session, &renew_ticket, ticket,
728 MakeConstSpan(client_hello->session_id,
729 client_hello->session_id_len))) {
Adam Langley4c341d02017-03-08 19:33:21 -0800730 case ssl_ticket_aead_success:
731 break;
732 case ssl_ticket_aead_ignore_ticket:
David Benjamin37af90f2017-07-29 01:42:16 -0400733 assert(!session);
Adam Langley4c341d02017-03-08 19:33:21 -0800734 break;
735 case ssl_ticket_aead_error:
Steven Valdez398085b2017-08-29 13:25:56 -0400736 return ssl_hs_error;
Adam Langley4c341d02017-03-08 19:33:21 -0800737 case ssl_ticket_aead_retry:
Steven Valdez398085b2017-08-29 13:25:56 -0400738 return ssl_hs_pending_ticket;
David Benjamine3aa1d92015-06-16 15:34:50 -0400739 }
740 } else {
David Benjaminc11ea9422017-08-29 16:33:21 -0400741 // The client didn't send a ticket, so the session ID is a real ID.
Steven Valdez398085b2017-08-29 13:25:56 -0400742 enum ssl_hs_wait_t lookup_ret = ssl_lookup_session(
David Benjamin58150ed2018-06-29 23:58:43 -0400743 hs, &session,
744 MakeConstSpan(client_hello->session_id, client_hello->session_id_len));
Steven Valdez398085b2017-08-29 13:25:56 -0400745 if (lookup_ret != ssl_hs_ok) {
David Benjamine3aa1d92015-06-16 15:34:50 -0400746 return lookup_ret;
747 }
Adam Langleyfcf25832014-12-18 17:42:32 -0800748 }
Adam Langley95c29f32014-06-20 12:00:00 -0700749
David Benjamin37af90f2017-07-29 01:42:16 -0400750 *out_session = std::move(session);
David Benjamin75f99142016-11-12 12:36:06 +0900751 *out_tickets_supported = tickets_supported;
752 *out_renew_ticket = renew_ticket;
Steven Valdez398085b2017-08-29 13:25:56 -0400753 return ssl_hs_ok;
Adam Langley95c29f32014-06-20 12:00:00 -0700754}
755
David Benjamina10017c2021-06-16 16:00:13 -0400756static bool remove_session(SSL_CTX *ctx, SSL_SESSION *session, bool lock) {
757 if (session == nullptr || session->session_id_length == 0) {
758 return false;
David Benjamin86e95b82017-07-18 16:34:25 -0400759 }
760
David Benjamina10017c2021-06-16 16:00:13 -0400761 if (lock) {
762 CRYPTO_MUTEX_lock_write(&ctx->lock);
763 }
764
765 SSL_SESSION *found_session = lh_SSL_SESSION_retrieve(ctx->sessions, session);
766 bool found = found_session == session;
767 if (found) {
768 found_session = lh_SSL_SESSION_delete(ctx->sessions, session);
769 SSL_SESSION_list_remove(ctx, session);
770 }
771
772 if (lock) {
773 CRYPTO_MUTEX_unlock_write(&ctx->lock);
774 }
775
776 if (found) {
777 // TODO(https://crbug.com/boringssl/251): Callbacks should not be called
778 // under a lock.
779 if (ctx->remove_session_cb != nullptr) {
780 ctx->remove_session_cb(ctx, found_session);
781 }
782 SSL_SESSION_free(found_session);
783 }
784
785 return found;
David Benjamin86e95b82017-07-18 16:34:25 -0400786}
787
788void ssl_set_session(SSL *ssl, SSL_SESSION *session) {
David Benjamin50596f82018-07-02 19:47:27 -0400789 if (ssl->session.get() == session) {
David Benjamin86e95b82017-07-18 16:34:25 -0400790 return;
791 }
792
David Benjamin50596f82018-07-02 19:47:27 -0400793 ssl->session = UpRef(session);
David Benjamin86e95b82017-07-18 16:34:25 -0400794}
795
David Benjaminc11ea9422017-08-29 16:33:21 -0400796// locked by SSL_CTX in the calling function
David Benjamin86e95b82017-07-18 16:34:25 -0400797static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *session) {
798 if (session->next == NULL || session->prev == NULL) {
799 return;
800 }
801
802 if (session->next == (SSL_SESSION *)&ctx->session_cache_tail) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400803 // last element in list
David Benjamin86e95b82017-07-18 16:34:25 -0400804 if (session->prev == (SSL_SESSION *)&ctx->session_cache_head) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400805 // only one element in list
David Benjamin86e95b82017-07-18 16:34:25 -0400806 ctx->session_cache_head = NULL;
807 ctx->session_cache_tail = NULL;
808 } else {
809 ctx->session_cache_tail = session->prev;
810 session->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
811 }
812 } else {
813 if (session->prev == (SSL_SESSION *)&ctx->session_cache_head) {
David Benjaminc11ea9422017-08-29 16:33:21 -0400814 // first element in list
David Benjamin86e95b82017-07-18 16:34:25 -0400815 ctx->session_cache_head = session->next;
816 session->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
David Benjaminc11ea9422017-08-29 16:33:21 -0400817 } else { // middle of list
David Benjamin86e95b82017-07-18 16:34:25 -0400818 session->next->prev = session->prev;
819 session->prev->next = session->next;
820 }
821 }
822 session->prev = session->next = NULL;
823}
824
825static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *session) {
826 if (session->next != NULL && session->prev != NULL) {
827 SSL_SESSION_list_remove(ctx, session);
828 }
829
830 if (ctx->session_cache_head == NULL) {
831 ctx->session_cache_head = session;
832 ctx->session_cache_tail = session;
833 session->prev = (SSL_SESSION *)&(ctx->session_cache_head);
834 session->next = (SSL_SESSION *)&(ctx->session_cache_tail);
835 } else {
836 session->next = ctx->session_cache_head;
837 session->next->prev = session;
838 session->prev = (SSL_SESSION *)&(ctx->session_cache_head);
839 ctx->session_cache_head = session;
840 }
841}
842
David Benjamina10017c2021-06-16 16:00:13 -0400843static bool add_session_locked(SSL_CTX *ctx, UniquePtr<SSL_SESSION> session) {
844 SSL_SESSION *new_session = session.get();
845 SSL_SESSION *old_session;
846 if (!lh_SSL_SESSION_insert(ctx->sessions, &old_session, new_session)) {
847 return false;
848 }
849 // |ctx->sessions| took ownership of |new_session| and gave us back a
850 // reference to |old_session|. (|old_session| may be the same as
851 // |new_session|, in which case we traded identical references with
852 // |ctx->sessions|.)
853 session.release();
854 session.reset(old_session);
855
856 if (old_session != nullptr) {
857 if (old_session == new_session) {
858 // |session| was already in the cache. There are no linked list pointers
859 // to update.
860 return false;
861 }
862
863 // There was a session ID collision. |old_session| was replaced with
864 // |session| in the hash table, so |old_session| must be removed from the
865 // linked list to match.
866 SSL_SESSION_list_remove(ctx, old_session);
867 }
868
869 // This does not increment the reference count. Although |session| is inserted
870 // into two structures (a doubly-linked list and the hash table), |ctx| only
871 // takes one reference.
872 SSL_SESSION_list_add(ctx, new_session);
873
874 // Enforce any cache size limits.
875 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
876 while (lh_SSL_SESSION_num_items(ctx->sessions) >
877 SSL_CTX_sess_get_cache_size(ctx)) {
878 if (!remove_session(ctx, ctx->session_cache_tail,
879 /*lock=*/false)) {
880 break;
881 }
882 }
883 }
884
885 return true;
886}
887
888void ssl_update_cache(SSL *ssl) {
889 SSL_CTX *ctx = ssl->session_ctx.get();
890 SSL_SESSION *session = ssl->s3->established_session.get();
891 int mode = SSL_is_server(ssl) ? SSL_SESS_CACHE_SERVER : SSL_SESS_CACHE_CLIENT;
892 if (!SSL_SESSION_is_resumable(session) ||
893 (ctx->session_cache_mode & mode) != mode) {
894 return;
895 }
896
897 // Clients never use the internal session cache.
898 if (ssl->server &&
899 !(ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_STORE)) {
900 UniquePtr<SSL_SESSION> ref = UpRef(session);
901 bool remove_expired_sessions = false;
902 {
903 MutexWriteLock lock(&ctx->lock);
904 add_session_locked(ctx, std::move(ref));
905
906 if (!(ctx->session_cache_mode & SSL_SESS_CACHE_NO_AUTO_CLEAR)) {
907 // Automatically flush the internal session cache every 255 connections.
908 ctx->handshakes_since_cache_flush++;
909 if (ctx->handshakes_since_cache_flush >= 255) {
910 remove_expired_sessions = true;
911 ctx->handshakes_since_cache_flush = 0;
912 }
913 }
914 }
915
916 if (remove_expired_sessions) {
917 // |SSL_CTX_flush_sessions| takes the lock we just released. We could
918 // merge the critical sections, but we'd then call user code under a
919 // lock, or compute |now| earlier, even when not flushing.
920 OPENSSL_timeval now;
921 ssl_get_current_time(ssl, &now);
922 SSL_CTX_flush_sessions(ctx, now.tv_sec);
923 }
924 }
925
926 if (ctx->new_session_cb != nullptr) {
927 UniquePtr<SSL_SESSION> ref = UpRef(session);
928 if (ctx->new_session_cb(ssl, ref.get())) {
929 // |new_session_cb|'s return value signals whether it took ownership.
930 ref.release();
931 }
932 }
933}
934
Joshua Liebow-Feeser8c7c6352018-08-26 18:53:36 -0700935BSSL_NAMESPACE_END
David Benjamin86e95b82017-07-18 16:34:25 -0400936
937using namespace bssl;
938
David Benjaminbfdd1a92018-06-29 16:26:38 -0400939ssl_session_st::ssl_session_st(const SSL_X509_METHOD *method)
940 : x509_method(method),
941 extended_master_secret(false),
942 peer_sha256_valid(false),
943 not_resumable(false),
944 ticket_age_add_valid(false),
Nick Harper6bfd25c2020-03-30 17:15:19 -0700945 is_server(false),
Steven Valdez51607f12020-08-05 10:46:05 -0400946 is_quic(false),
947 has_application_settings(false) {
David Benjaminbfdd1a92018-06-29 16:26:38 -0400948 CRYPTO_new_ex_data(&ex_data);
949 time = ::time(nullptr);
950}
951
952ssl_session_st::~ssl_session_st() {
953 CRYPTO_free_ex_data(&g_ex_data_class, this, &ex_data);
954 x509_method->session_clear(this);
955}
956
David Benjamin86e95b82017-07-18 16:34:25 -0400957SSL_SESSION *SSL_SESSION_new(const SSL_CTX *ctx) {
David Benjamin31b0c9b2017-07-20 14:49:15 -0400958 return ssl_session_new(ctx->x509_method).release();
David Benjamin86e95b82017-07-18 16:34:25 -0400959}
960
961int SSL_SESSION_up_ref(SSL_SESSION *session) {
962 CRYPTO_refcount_inc(&session->references);
963 return 1;
964}
965
966void SSL_SESSION_free(SSL_SESSION *session) {
967 if (session == NULL ||
968 !CRYPTO_refcount_dec_and_test_zero(&session->references)) {
969 return;
970 }
971
David Benjaminbfdd1a92018-06-29 16:26:38 -0400972 session->~ssl_session_st();
David Benjamin86e95b82017-07-18 16:34:25 -0400973 OPENSSL_free(session);
974}
975
976const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *session,
977 unsigned *out_len) {
978 if (out_len != NULL) {
979 *out_len = session->session_id_length;
980 }
981 return session->session_id;
982}
983
David Benjamincaf8ddd2018-06-03 16:25:55 -0400984int SSL_SESSION_set1_id(SSL_SESSION *session, const uint8_t *sid,
985 size_t sid_len) {
986 if (sid_len > SSL_MAX_SSL_SESSION_ID_LENGTH) {
987 OPENSSL_PUT_ERROR(SSL, SSL_R_SSL_SESSION_ID_TOO_LONG);
988 return 0;
989 }
990
991 // Use memmove in case someone passes in the output of |SSL_SESSION_get_id|.
992 OPENSSL_memmove(session->session_id, sid, sid_len);
993 session->session_id_length = sid_len;
994 return 1;
995}
996
David Benjamin86e95b82017-07-18 16:34:25 -0400997uint32_t SSL_SESSION_get_timeout(const SSL_SESSION *session) {
998 return session->timeout;
999}
1000
1001uint64_t SSL_SESSION_get_time(const SSL_SESSION *session) {
1002 if (session == NULL) {
David Benjaminc11ea9422017-08-29 16:33:21 -04001003 // NULL should crash, but silently accept it here for compatibility.
David Benjamin86e95b82017-07-18 16:34:25 -04001004 return 0;
1005 }
1006 return session->time;
1007}
1008
1009X509 *SSL_SESSION_get0_peer(const SSL_SESSION *session) {
1010 return session->x509_peer;
1011}
1012
David Benjamin855dabc2018-04-25 17:34:24 -04001013const STACK_OF(CRYPTO_BUFFER) *
1014 SSL_SESSION_get0_peer_certificates(const SSL_SESSION *session) {
David Benjaminbfdd1a92018-06-29 16:26:38 -04001015 return session->certs.get();
David Benjamin855dabc2018-04-25 17:34:24 -04001016}
1017
David Benjamin5b220ee2018-05-11 00:54:42 -04001018void SSL_SESSION_get0_signed_cert_timestamp_list(const SSL_SESSION *session,
1019 const uint8_t **out,
1020 size_t *out_len) {
1021 if (session->signed_cert_timestamp_list) {
David Benjaminbfdd1a92018-06-29 16:26:38 -04001022 *out = CRYPTO_BUFFER_data(session->signed_cert_timestamp_list.get());
1023 *out_len = CRYPTO_BUFFER_len(session->signed_cert_timestamp_list.get());
David Benjamin5b220ee2018-05-11 00:54:42 -04001024 } else {
1025 *out = nullptr;
1026 *out_len = 0;
1027 }
1028}
1029
1030void SSL_SESSION_get0_ocsp_response(const SSL_SESSION *session,
1031 const uint8_t **out, size_t *out_len) {
1032 if (session->ocsp_response) {
David Benjaminbfdd1a92018-06-29 16:26:38 -04001033 *out = CRYPTO_BUFFER_data(session->ocsp_response.get());
1034 *out_len = CRYPTO_BUFFER_len(session->ocsp_response.get());
David Benjamin5b220ee2018-05-11 00:54:42 -04001035 } else {
1036 *out = nullptr;
1037 *out_len = 0;
1038 }
1039}
1040
David Benjamin86e95b82017-07-18 16:34:25 -04001041size_t SSL_SESSION_get_master_key(const SSL_SESSION *session, uint8_t *out,
1042 size_t max_out) {
David Benjamin5351c8b2020-11-19 00:25:29 -05001043 // TODO(davidben): Fix secret_length's type and remove these casts.
David Benjamin86e95b82017-07-18 16:34:25 -04001044 if (max_out == 0) {
David Benjamin5351c8b2020-11-19 00:25:29 -05001045 return (size_t)session->secret_length;
David Benjamin86e95b82017-07-18 16:34:25 -04001046 }
David Benjamin5351c8b2020-11-19 00:25:29 -05001047 if (max_out > (size_t)session->secret_length) {
1048 max_out = (size_t)session->secret_length;
David Benjamin86e95b82017-07-18 16:34:25 -04001049 }
David Benjamin5351c8b2020-11-19 00:25:29 -05001050 OPENSSL_memcpy(out, session->secret, max_out);
David Benjamin86e95b82017-07-18 16:34:25 -04001051 return max_out;
1052}
1053
1054uint64_t SSL_SESSION_set_time(SSL_SESSION *session, uint64_t time) {
1055 if (session == NULL) {
1056 return 0;
1057 }
1058
1059 session->time = time;
1060 return time;
1061}
1062
1063uint32_t SSL_SESSION_set_timeout(SSL_SESSION *session, uint32_t timeout) {
1064 if (session == NULL) {
1065 return 0;
1066 }
1067
1068 session->timeout = timeout;
1069 session->auth_timeout = timeout;
1070 return 1;
1071}
1072
David Benjamin3b2ff022018-06-07 13:34:05 -04001073const uint8_t *SSL_SESSION_get0_id_context(const SSL_SESSION *session,
1074 unsigned *out_len) {
1075 if (out_len != NULL) {
1076 *out_len = session->sid_ctx_length;
1077 }
1078 return session->sid_ctx;
1079}
1080
David Benjamin86e95b82017-07-18 16:34:25 -04001081int SSL_SESSION_set1_id_context(SSL_SESSION *session, const uint8_t *sid_ctx,
1082 size_t sid_ctx_len) {
1083 if (sid_ctx_len > sizeof(session->sid_ctx)) {
1084 OPENSSL_PUT_ERROR(SSL, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
1085 return 0;
1086 }
1087
David Benjamin27e377e2017-07-31 19:09:42 -04001088 static_assert(sizeof(session->sid_ctx) < 256, "sid_ctx_len does not fit");
David Benjamin86e95b82017-07-18 16:34:25 -04001089 session->sid_ctx_length = (uint8_t)sid_ctx_len;
1090 OPENSSL_memcpy(session->sid_ctx, sid_ctx, sid_ctx_len);
1091
1092 return 1;
1093}
1094
David Benjamine9c7b1c2017-09-28 14:12:52 -04001095int SSL_SESSION_should_be_single_use(const SSL_SESSION *session) {
David Benjamina4bafd32017-10-03 15:06:29 -04001096 return ssl_session_protocol_version(session) >= TLS1_3_VERSION;
David Benjamine9c7b1c2017-09-28 14:12:52 -04001097}
1098
David Benjamin81f030b2016-08-12 14:48:19 -04001099int SSL_SESSION_is_resumable(const SSL_SESSION *session) {
David Benjamin71a3b822021-05-10 15:57:45 -04001100 return !session->not_resumable &&
1101 (session->session_id_length != 0 || !session->ticket.empty());
David Benjamin81f030b2016-08-12 14:48:19 -04001102}
1103
1104int SSL_SESSION_has_ticket(const SSL_SESSION *session) {
David Benjaminbfdd1a92018-06-29 16:26:38 -04001105 return !session->ticket.empty();
David Benjamin81f030b2016-08-12 14:48:19 -04001106}
1107
1108void SSL_SESSION_get0_ticket(const SSL_SESSION *session,
1109 const uint8_t **out_ticket, size_t *out_len) {
1110 if (out_ticket != nullptr) {
David Benjaminbfdd1a92018-06-29 16:26:38 -04001111 *out_ticket = session->ticket.data();
David Benjamin81f030b2016-08-12 14:48:19 -04001112 }
David Benjaminbfdd1a92018-06-29 16:26:38 -04001113 *out_len = session->ticket.size();
David Benjamin81f030b2016-08-12 14:48:19 -04001114}
1115
David Benjamin02de7bd2018-05-08 18:13:54 -04001116int SSL_SESSION_set_ticket(SSL_SESSION *session, const uint8_t *ticket,
1117 size_t ticket_len) {
David Benjaminbfdd1a92018-06-29 16:26:38 -04001118 return session->ticket.CopyFrom(MakeConstSpan(ticket, ticket_len));
David Benjamin02de7bd2018-05-08 18:13:54 -04001119}
1120
David Benjamin81f030b2016-08-12 14:48:19 -04001121uint32_t SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *session) {
David Benjaminbfdd1a92018-06-29 16:26:38 -04001122 return session->ticket_lifetime_hint;
David Benjamin81f030b2016-08-12 14:48:19 -04001123}
1124
David Benjaminb8b1a9d2018-04-12 18:39:28 -04001125const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *session) {
1126 return session->cipher;
1127}
1128
David Benjamin02de7bd2018-05-08 18:13:54 -04001129int SSL_SESSION_has_peer_sha256(const SSL_SESSION *session) {
1130 return session->peer_sha256_valid;
1131}
1132
1133void SSL_SESSION_get0_peer_sha256(const SSL_SESSION *session,
1134 const uint8_t **out_ptr, size_t *out_len) {
1135 if (session->peer_sha256_valid) {
1136 *out_ptr = session->peer_sha256;
1137 *out_len = sizeof(session->peer_sha256);
1138 } else {
1139 *out_ptr = nullptr;
1140 *out_len = 0;
1141 }
1142}
1143
Steven Valdez5274cea2019-05-08 11:34:57 -04001144int SSL_SESSION_early_data_capable(const SSL_SESSION *session) {
1145 return ssl_session_protocol_version(session) >= TLS1_3_VERSION &&
1146 session->ticket_max_early_data != 0;
1147}
1148
David Benjaminf9e0cda2020-03-23 18:29:09 -04001149SSL_SESSION *SSL_SESSION_copy_without_early_data(SSL_SESSION *session) {
1150 if (!SSL_SESSION_early_data_capable(session)) {
1151 return UpRef(session).release();
1152 }
1153
1154 bssl::UniquePtr<SSL_SESSION> copy =
1155 SSL_SESSION_dup(session, SSL_SESSION_DUP_ALL);
1156 if (!copy) {
1157 return nullptr;
1158 }
1159
1160 copy->ticket_max_early_data = 0;
1161 // Copied sessions are non-resumable until they're completely filled in.
1162 copy->not_resumable = session->not_resumable;
1163 assert(!SSL_SESSION_early_data_capable(copy.get()));
1164 return copy.release();
1165}
1166
David Benjamin86e95b82017-07-18 16:34:25 -04001167SSL_SESSION *SSL_magic_pending_session_ptr(void) {
1168 return (SSL_SESSION *)&g_pending_session_magic;
1169}
1170
1171SSL_SESSION *SSL_get_session(const SSL *ssl) {
David Benjamin10fef972022-08-30 11:38:51 -04001172 // Once the initially handshake completes, we return the most recently
1173 // established session. In particular, if there is a pending renegotiation, we
1174 // do not return information about it until it completes.
1175 //
1176 // Code in the handshake must either use |hs->new_session| (if updating a
1177 // partial session) or |ssl_handshake_session| (if trying to query properties
1178 // consistently across TLS 1.2 resumption and other handshakes).
1179 if (ssl->s3->established_session != nullptr) {
David Benjamin8e7bbba2017-10-13 17:18:35 -04001180 return ssl->s3->established_session.get();
David Benjamin86e95b82017-07-18 16:34:25 -04001181 }
David Benjamin10fef972022-08-30 11:38:51 -04001182
1183 // Otherwise, we must be in the initial handshake.
David Benjamin8e7bbba2017-10-13 17:18:35 -04001184 SSL_HANDSHAKE *hs = ssl->s3->hs.get();
David Benjamin10fef972022-08-30 11:38:51 -04001185 assert(hs != nullptr);
1186 assert(!ssl->s3->initial_handshake_complete);
1187
1188 // Return the 0-RTT session, if in the 0-RTT state. While the handshake has
1189 // not actually completed, the public accessors all report properties as if
1190 // it has.
David Benjamin31b0c9b2017-07-20 14:49:15 -04001191 if (hs->early_session) {
1192 return hs->early_session.get();
David Benjamin86e95b82017-07-18 16:34:25 -04001193 }
David Benjamin10fef972022-08-30 11:38:51 -04001194
1195 // Otherwise, return the partial session.
1196 return (SSL_SESSION *)ssl_handshake_session(hs);
David Benjamin86e95b82017-07-18 16:34:25 -04001197}
1198
1199SSL_SESSION *SSL_get1_session(SSL *ssl) {
1200 SSL_SESSION *ret = SSL_get_session(ssl);
1201 if (ret != NULL) {
1202 SSL_SESSION_up_ref(ret);
1203 }
1204 return ret;
1205}
1206
1207int SSL_SESSION_get_ex_new_index(long argl, void *argp,
1208 CRYPTO_EX_unused *unused,
1209 CRYPTO_EX_dup *dup_unused,
1210 CRYPTO_EX_free *free_func) {
1211 int index;
1212 if (!CRYPTO_get_ex_new_index(&g_ex_data_class, &index, argl, argp,
1213 free_func)) {
1214 return -1;
1215 }
1216 return index;
1217}
1218
1219int SSL_SESSION_set_ex_data(SSL_SESSION *session, int idx, void *arg) {
1220 return CRYPTO_set_ex_data(&session->ex_data, idx, arg);
1221}
1222
1223void *SSL_SESSION_get_ex_data(const SSL_SESSION *session, int idx) {
1224 return CRYPTO_get_ex_data(&session->ex_data, idx);
1225}
1226
David Benjamindafbdd42015-09-14 01:40:10 -04001227int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *session) {
David Benjamin2908dd12018-06-29 17:46:42 -04001228 UniquePtr<SSL_SESSION> owned_session = UpRef(session);
David Benjamin21fa6842017-09-27 17:28:10 -04001229 MutexWriteLock lock(&ctx->lock);
David Benjamina10017c2021-06-16 16:00:13 -04001230 return add_session_locked(ctx, std::move(owned_session));
Adam Langleyfcf25832014-12-18 17:42:32 -08001231}
Adam Langley95c29f32014-06-20 12:00:00 -07001232
David Benjamindafbdd42015-09-14 01:40:10 -04001233int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *session) {
David Benjamina10017c2021-06-16 16:00:13 -04001234 return remove_session(ctx, session, /*lock=*/true);
Adam Langleyfcf25832014-12-18 17:42:32 -08001235}
Adam Langley95c29f32014-06-20 12:00:00 -07001236
David Benjamindafbdd42015-09-14 01:40:10 -04001237int SSL_set_session(SSL *ssl, SSL_SESSION *session) {
David Benjaminc11ea9422017-08-29 16:33:21 -04001238 // SSL_set_session may only be called before the handshake has started.
David Benjamin9e766d72017-02-10 23:14:17 -05001239 if (ssl->s3->initial_handshake_complete ||
1240 ssl->s3->hs == NULL ||
Steven Valdez4d71a9a2017-08-14 15:08:34 -04001241 ssl->s3->hs->state != 0) {
David Benjamin4d0be242016-09-01 01:10:07 -04001242 abort();
1243 }
1244
1245 ssl_set_session(ssl, session);
1246 return 1;
1247}
1248
David Benjaminad8f5e12017-02-20 17:00:20 -05001249uint32_t SSL_CTX_set_timeout(SSL_CTX *ctx, uint32_t timeout) {
David Benjamindafbdd42015-09-14 01:40:10 -04001250 if (ctx == NULL) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001251 return 0;
1252 }
1253
David Benjaminc11ea9422017-08-29 16:33:21 -04001254 // Historically, zero was treated as |SSL_DEFAULT_SESSION_TIMEOUT|.
David Benjamin0b1bb122017-01-28 14:32:53 -05001255 if (timeout == 0) {
1256 timeout = SSL_DEFAULT_SESSION_TIMEOUT;
1257 }
1258
David Benjaminad8f5e12017-02-20 17:00:20 -05001259 uint32_t old_timeout = ctx->session_timeout;
David Benjamindafbdd42015-09-14 01:40:10 -04001260 ctx->session_timeout = timeout;
1261 return old_timeout;
Adam Langleyfcf25832014-12-18 17:42:32 -08001262}
1263
David Benjaminad8f5e12017-02-20 17:00:20 -05001264uint32_t SSL_CTX_get_timeout(const SSL_CTX *ctx) {
David Benjamindafbdd42015-09-14 01:40:10 -04001265 if (ctx == NULL) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001266 return 0;
1267 }
1268
David Benjamindafbdd42015-09-14 01:40:10 -04001269 return ctx->session_timeout;
Adam Langleyfcf25832014-12-18 17:42:32 -08001270}
1271
David Benjaminad8f5e12017-02-20 17:00:20 -05001272void SSL_CTX_set_session_psk_dhe_timeout(SSL_CTX *ctx, uint32_t timeout) {
David Benjamin17b30832017-01-28 14:00:32 -05001273 ctx->session_psk_dhe_timeout = timeout;
1274}
1275
Adam Langleyfcf25832014-12-18 17:42:32 -08001276typedef struct timeout_param_st {
1277 SSL_CTX *ctx;
David Benjaminad8f5e12017-02-20 17:00:20 -05001278 uint64_t time;
David Benjamin60da0cd2015-05-03 15:21:28 -04001279 LHASH_OF(SSL_SESSION) *cache;
Adam Langleyfcf25832014-12-18 17:42:32 -08001280} TIMEOUT_PARAM;
1281
David Benjamindafbdd42015-09-14 01:40:10 -04001282static void timeout_doall_arg(SSL_SESSION *session, void *void_param) {
David Benjamin0238d8f2017-07-12 17:35:14 -04001283 TIMEOUT_PARAM *param = reinterpret_cast<TIMEOUT_PARAM *>(void_param);
Adam Langleyfcf25832014-12-18 17:42:32 -08001284
1285 if (param->time == 0 ||
David Benjaminad8f5e12017-02-20 17:00:20 -05001286 session->time + session->timeout < session->time ||
David Benjamindafbdd42015-09-14 01:40:10 -04001287 param->time > (session->time + session->timeout)) {
David Benjamina10017c2021-06-16 16:00:13 -04001288 // TODO(davidben): This can probably just call |remove_session|.
David Benjamindafbdd42015-09-14 01:40:10 -04001289 (void) lh_SSL_SESSION_delete(param->cache, session);
1290 SSL_SESSION_list_remove(param->ctx, session);
David Benjamina10017c2021-06-16 16:00:13 -04001291 // TODO(https://crbug.com/boringssl/251): Callbacks should not be called
1292 // under a lock.
Adam Langleyfcf25832014-12-18 17:42:32 -08001293 if (param->ctx->remove_session_cb != NULL) {
David Benjamindafbdd42015-09-14 01:40:10 -04001294 param->ctx->remove_session_cb(param->ctx, session);
Adam Langleyfcf25832014-12-18 17:42:32 -08001295 }
David Benjamindafbdd42015-09-14 01:40:10 -04001296 SSL_SESSION_free(session);
Adam Langleyfcf25832014-12-18 17:42:32 -08001297 }
1298}
1299
David Benjaminad8f5e12017-02-20 17:00:20 -05001300void SSL_CTX_flush_sessions(SSL_CTX *ctx, uint64_t time) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001301 TIMEOUT_PARAM tp;
1302
Adam Langley4bdb6e42015-05-15 15:29:21 -07001303 tp.ctx = ctx;
1304 tp.cache = ctx->sessions;
Adam Langleyfcf25832014-12-18 17:42:32 -08001305 if (tp.cache == NULL) {
1306 return;
1307 }
David Benjamindafbdd42015-09-14 01:40:10 -04001308 tp.time = time;
David Benjamin21fa6842017-09-27 17:28:10 -04001309 MutexWriteLock lock(&ctx->lock);
Adam Langleyfcf25832014-12-18 17:42:32 -08001310 lh_SSL_SESSION_doall_arg(tp.cache, timeout_doall_arg, &tp);
Adam Langleyfcf25832014-12-18 17:42:32 -08001311}
1312
Adam Langley95c29f32014-06-20 12:00:00 -07001313void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
David Benjamindafbdd42015-09-14 01:40:10 -04001314 int (*cb)(SSL *ssl, SSL_SESSION *session)) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001315 ctx->new_session_cb = cb;
1316}
Adam Langley95c29f32014-06-20 12:00:00 -07001317
David Benjamindafbdd42015-09-14 01:40:10 -04001318int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl, SSL_SESSION *session) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001319 return ctx->new_session_cb;
1320}
Adam Langley95c29f32014-06-20 12:00:00 -07001321
David Benjamindafbdd42015-09-14 01:40:10 -04001322void SSL_CTX_sess_set_remove_cb(
1323 SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *session)) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001324 ctx->remove_session_cb = cb;
1325}
Adam Langley95c29f32014-06-20 12:00:00 -07001326
Adam Langleyfcf25832014-12-18 17:42:32 -08001327void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(SSL_CTX *ctx,
David Benjamindafbdd42015-09-14 01:40:10 -04001328 SSL_SESSION *session) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001329 return ctx->remove_session_cb;
1330}
Adam Langley95c29f32014-06-20 12:00:00 -07001331
1332void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
David Benjamin81f030b2016-08-12 14:48:19 -04001333 SSL_SESSION *(*cb)(SSL *ssl, const uint8_t *id,
1334 int id_len, int *out_copy)) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001335 ctx->get_session_cb = cb;
1336}
Adam Langley95c29f32014-06-20 12:00:00 -07001337
David Benjamin81f030b2016-08-12 14:48:19 -04001338SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(SSL *ssl,
1339 const uint8_t *id,
1340 int id_len,
1341 int *out_copy) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001342 return ctx->get_session_cb;
1343}
Adam Langley95c29f32014-06-20 12:00:00 -07001344
David Benjamin82170242015-10-17 22:51:17 -04001345void SSL_CTX_set_info_callback(
1346 SSL_CTX *ctx, void (*cb)(const SSL *ssl, int type, int value)) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001347 ctx->info_callback = cb;
1348}
Adam Langley95c29f32014-06-20 12:00:00 -07001349
Adam Langleyfcf25832014-12-18 17:42:32 -08001350void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl, int type,
David Benjamin82170242015-10-17 22:51:17 -04001351 int value) {
Adam Langleyfcf25832014-12-18 17:42:32 -08001352 return ctx->info_callback;
1353}