1/* 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-2007 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
136#include <openssl/ssl.h>
137
138#include <assert.h>
139#include <string.h>
140
141#include <utility>
142
143#include <openssl/err.h>
144#include <openssl/evp.h>
145#include <openssl/hmac.h>
146#include <openssl/md5.h>
147#include <openssl/mem.h>
148#include <openssl/nid.h>
149#include <openssl/rand.h>
150
151#include "../crypto/fipsmodule/tls/internal.h"
152#include "../crypto/internal.h"
153#include "internal.h"
154
155
156BSSL_NAMESPACE_BEGIN
157
158bool tls1_prf(const EVP_MD *digest, Span<uint8_t> out,
159 Span<const uint8_t> secret, Span<const char> label,
160 Span<const uint8_t> seed1, Span<const uint8_t> seed2) {
161 return 1 == CRYPTO_tls1_prf(digest, out.data(), out.size(), secret.data(),
162 secret.size(), label.data(), label.size(),
163 seed1.data(), seed1.size(), seed2.data(),
164 seed2.size());
165}
166
167static bool get_key_block_lengths(const SSL *ssl, size_t *out_mac_secret_len,
168 size_t *out_key_len, size_t *out_iv_len,
169 const SSL_CIPHER *cipher) {
170 const EVP_AEAD *aead = NULL;
171 if (!ssl_cipher_get_evp_aead(&aead, out_mac_secret_len, out_iv_len, cipher,
172 ssl_protocol_version(ssl), SSL_is_dtls(ssl))) {
173 OPENSSL_PUT_ERROR(SSL, SSL_R_CIPHER_OR_HASH_UNAVAILABLE);
174 return false;
175 }
176
177 *out_key_len = EVP_AEAD_key_length(aead);
178 if (*out_mac_secret_len > 0) {
179 // For "stateful" AEADs (i.e. compatibility with pre-AEAD cipher suites) the
180 // key length reported by |EVP_AEAD_key_length| will include the MAC key
181 // bytes and initial implicit IV.
182 if (*out_key_len < *out_mac_secret_len + *out_iv_len) {
183 OPENSSL_PUT_ERROR(SSL, ERR_R_INTERNAL_ERROR);
184 return false;
185 }
186 *out_key_len -= *out_mac_secret_len + *out_iv_len;
187 }
188
189 return true;
190}
191
192int tls1_configure_aead(SSL *ssl, evp_aead_direction_t direction,
193 Array<uint8_t> *key_block_cache,
194 const SSL_CIPHER *cipher,
195 Span<const uint8_t> iv_override) {
196 size_t mac_secret_len, key_len, iv_len;
197 if (!get_key_block_lengths(ssl, &mac_secret_len, &key_len, &iv_len, cipher)) {
198 return 0;
199 }
200
201 // Ensure that |key_block_cache| is set up.
202 const size_t key_block_size = 2 * (mac_secret_len + key_len + iv_len);
203 if (key_block_cache->empty()) {
204 if (!key_block_cache->Init(key_block_size) ||
205 !SSL_generate_key_block(ssl, key_block_cache->data(), key_block_size)) {
206 return 0;
207 }
208 }
209 assert(key_block_cache->size() == key_block_size);
210
211 Span<const uint8_t> key_block = *key_block_cache;
212 Span<const uint8_t> mac_secret, key, iv;
213 if (direction == (ssl->server ? evp_aead_open : evp_aead_seal)) {
214 // Use the client write (server read) keys.
215 mac_secret = key_block.subspan(0, mac_secret_len);
216 key = key_block.subspan(2 * mac_secret_len, key_len);
217 iv = key_block.subspan(2 * mac_secret_len + 2 * key_len, iv_len);
218 } else {
219 // Use the server write (client read) keys.
220 mac_secret = key_block.subspan(mac_secret_len, mac_secret_len);
221 key = key_block.subspan(2 * mac_secret_len + key_len, key_len);
222 iv = key_block.subspan(2 * mac_secret_len + 2 * key_len + iv_len, iv_len);
223 }
224
225 if (!iv_override.empty()) {
226 if (iv_override.size() != iv_len) {
227 return 0;
228 }
229 iv = iv_override;
230 }
231
232 UniquePtr<SSLAEADContext> aead_ctx = SSLAEADContext::Create(
233 direction, ssl->version, SSL_is_dtls(ssl), cipher, key, mac_secret, iv);
234 if (!aead_ctx) {
235 return 0;
236 }
237
238 if (direction == evp_aead_open) {
239 return ssl->method->set_read_state(ssl, std::move(aead_ctx));
240 }
241
242 return ssl->method->set_write_state(ssl, std::move(aead_ctx));
243}
244
245int tls1_change_cipher_state(SSL_HANDSHAKE *hs,
246 evp_aead_direction_t direction) {
247 return tls1_configure_aead(hs->ssl, direction, &hs->key_block,
248 hs->new_cipher, {});
249}
250
251int tls1_generate_master_secret(SSL_HANDSHAKE *hs, uint8_t *out,
252 Span<const uint8_t> premaster) {
253 static const char kMasterSecretLabel[] = "master secret";
254 static const char kExtendedMasterSecretLabel[] = "extended master secret";
255
256 const SSL *ssl = hs->ssl;
257 auto out_span = MakeSpan(out, SSL3_MASTER_SECRET_SIZE);
258 if (hs->extended_master_secret) {
259 auto label = MakeConstSpan(kExtendedMasterSecretLabel,
260 sizeof(kExtendedMasterSecretLabel) - 1);
261 uint8_t digests[EVP_MAX_MD_SIZE];
262 size_t digests_len;
263 if (!hs->transcript.GetHash(digests, &digests_len) ||
264 !tls1_prf(hs->transcript.Digest(), out_span, premaster, label,
265 MakeConstSpan(digests, digests_len), {})) {
266 return 0;
267 }
268 } else {
269 auto label =
270 MakeConstSpan(kMasterSecretLabel, sizeof(kMasterSecretLabel) - 1);
271 if (!tls1_prf(hs->transcript.Digest(), out_span, premaster, label,
272 ssl->s3->client_random, ssl->s3->server_random)) {
273 return 0;
274 }
275 }
276
277 return SSL3_MASTER_SECRET_SIZE;
278}
279
280BSSL_NAMESPACE_END
281
282using namespace bssl;
283
284size_t SSL_get_key_block_len(const SSL *ssl) {
285 size_t mac_secret_len, key_len, fixed_iv_len;
286 if (!get_key_block_lengths(ssl, &mac_secret_len, &key_len, &fixed_iv_len,
287 SSL_get_current_cipher(ssl))) {
288 ERR_clear_error();
289 return 0;
290 }
291
292 return 2 * (mac_secret_len + key_len + fixed_iv_len);
293}
294
295int SSL_generate_key_block(const SSL *ssl, uint8_t *out, size_t out_len) {
296 const SSL_SESSION *session = SSL_get_session(ssl);
297 auto out_span = MakeSpan(out, out_len);
298 auto master_key =
299 MakeConstSpan(session->master_key, session->master_key_length);
300 static const char kLabel[] = "key expansion";
301 auto label = MakeConstSpan(kLabel, sizeof(kLabel) - 1);
302
303 const EVP_MD *digest = ssl_session_get_digest(session);
304 return tls1_prf(digest, out_span, master_key, label, ssl->s3->server_random,
305 ssl->s3->client_random);
306}
307
308int SSL_export_keying_material(SSL *ssl, uint8_t *out, size_t out_len,
309 const char *label, size_t label_len,
310 const uint8_t *context, size_t context_len,
311 int use_context) {
312 // Exporters may be used in False Start and server 0-RTT, where the handshake
313 // has progressed enough. Otherwise, they may not be used during a handshake.
314 if (SSL_in_init(ssl) &&
315 !SSL_in_false_start(ssl) &&
316 !(SSL_is_server(ssl) && SSL_in_early_data(ssl))) {
317 OPENSSL_PUT_ERROR(SSL, SSL_R_HANDSHAKE_NOT_COMPLETE);
318 return 0;
319 }
320
321 if (ssl_protocol_version(ssl) >= TLS1_3_VERSION) {
322 if (!use_context) {
323 context = nullptr;
324 context_len = 0;
325 }
326 return tls13_export_keying_material(
327 ssl, MakeSpan(out, out_len),
328 MakeConstSpan(ssl->s3->exporter_secret, ssl->s3->exporter_secret_len),
329 MakeConstSpan(label, label_len), MakeConstSpan(context, context_len));
330 }
331
332 size_t seed_len = 2 * SSL3_RANDOM_SIZE;
333 if (use_context) {
334 if (context_len >= 1u << 16) {
335 OPENSSL_PUT_ERROR(SSL, ERR_R_OVERFLOW);
336 return 0;
337 }
338 seed_len += 2 + context_len;
339 }
340 Array<uint8_t> seed;
341 if (!seed.Init(seed_len)) {
342 OPENSSL_PUT_ERROR(SSL, ERR_R_MALLOC_FAILURE);
343 return 0;
344 }
345
346 OPENSSL_memcpy(seed.data(), ssl->s3->client_random, SSL3_RANDOM_SIZE);
347 OPENSSL_memcpy(seed.data() + SSL3_RANDOM_SIZE, ssl->s3->server_random,
348 SSL3_RANDOM_SIZE);
349 if (use_context) {
350 seed[2 * SSL3_RANDOM_SIZE] = static_cast<uint8_t>(context_len >> 8);
351 seed[2 * SSL3_RANDOM_SIZE + 1] = static_cast<uint8_t>(context_len);
352 OPENSSL_memcpy(seed.data() + 2 * SSL3_RANDOM_SIZE + 2, context, context_len);
353 }
354
355 const SSL_SESSION *session = SSL_get_session(ssl);
356 const EVP_MD *digest = ssl_session_get_digest(session);
357 return tls1_prf(
358 digest, MakeSpan(out, out_len),
359 MakeConstSpan(session->master_key, session->master_key_length),
360 MakeConstSpan(label, label_len), seed, {});
361}
362
363int SSL_export_early_keying_material(
364 SSL *ssl, uint8_t *out, size_t out_len, const char *label, size_t label_len,
365 const uint8_t *context, size_t context_len) {
366 if (!SSL_in_early_data(ssl) &&
367 (!ssl->s3->have_version ||
368 ssl_protocol_version(ssl) < TLS1_3_VERSION)) {
369 OPENSSL_PUT_ERROR(SSL, SSL_R_WRONG_SSL_VERSION);
370 return 0;
371 }
372
373 // The early exporter only exists if we accepted early data or offered it as
374 // a client.
375 if (!SSL_in_early_data(ssl) && !SSL_early_data_accepted(ssl)) {
376 OPENSSL_PUT_ERROR(SSL, SSL_R_EARLY_DATA_NOT_IN_USE);
377 return 0;
378 }
379
380 return tls13_export_keying_material(
381 ssl, MakeSpan(out, out_len),
382 MakeConstSpan(ssl->s3->early_exporter_secret,
383 ssl->s3->early_exporter_secret_len),
384 MakeConstSpan(label, label_len), MakeConstSpan(context, context_len));
385}
386