blob: e63f83afb9e4acc0eb042df35fd76c69b9a526a5 [file] [log] [blame]
Hanno Beckerbe9d6642020-08-21 13:20:06 +01001/*
2 * TLS 1.3 key schedule
3 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 ( the "License" ); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19
Hanno Becker58c5cea2020-09-08 10:31:33 +010020#include "common.h"
Hanno Beckerbe9d6642020-08-21 13:20:06 +010021
Ronald Cron6f135e12021-12-08 16:57:54 +010022#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerbe9d6642020-08-21 13:20:06 +010023
Hanno Beckerbe9d6642020-08-21 13:20:06 +010024#include <stdint.h>
25#include <string.h>
26
Jerry Yue3131ef2021-09-16 13:14:15 +080027#include "mbedtls/hkdf.h"
28#include "mbedtls/debug.h"
29#include "mbedtls/error.h"
30
31#include "ssl_misc.h"
32#include "ssl_tls13_keys.h"
Gabor Mezeia3eecd22022-02-09 16:57:26 +010033#include "ssl_tls13_invasive.h"
34
35#include "psa/crypto.h"
Jerry Yue3131ef2021-09-16 13:14:15 +080036
Hanno Becker1413bd82020-09-09 12:46:09 +010037#define MBEDTLS_SSL_TLS1_3_LABEL( name, string ) \
Hanno Beckere4435ea2020-09-08 10:43:52 +010038 .name = string,
39
Xiaofei Bai746f9482021-11-12 08:53:56 +000040struct mbedtls_ssl_tls13_labels_struct const mbedtls_ssl_tls13_labels =
Hanno Beckerbe9d6642020-08-21 13:20:06 +010041{
42 /* This seems to work in C, despite the string literal being one
43 * character too long due to the 0-termination. */
Hanno Beckere4435ea2020-09-08 10:43:52 +010044 MBEDTLS_SSL_TLS1_3_LABEL_LIST
Hanno Beckerbe9d6642020-08-21 13:20:06 +010045};
46
Hanno Beckera3a5a4e2020-09-08 11:33:48 +010047#undef MBEDTLS_SSL_TLS1_3_LABEL
Hanno Beckere4435ea2020-09-08 10:43:52 +010048
Hanno Beckerbe9d6642020-08-21 13:20:06 +010049/*
50 * This function creates a HkdfLabel structure used in the TLS 1.3 key schedule.
51 *
52 * The HkdfLabel is specified in RFC 8446 as follows:
53 *
54 * struct HkdfLabel {
55 * uint16 length; // Length of expanded key material
56 * opaque label<7..255>; // Always prefixed by "tls13 "
57 * opaque context<0..255>; // Usually a communication transcript hash
58 * };
59 *
60 * Parameters:
61 * - desired_length: Length of expanded key material
62 * Even though the standard allows expansion to up to
63 * 2**16 Bytes, TLS 1.3 never uses expansion to more than
64 * 255 Bytes, so we require `desired_length` to be at most
65 * 255. This allows us to save a few Bytes of code by
66 * hardcoding the writing of the high bytes.
Xiaofei Baifeecbbb2021-11-23 07:24:58 +000067 * - (label, label_len): label + label length, without "tls13 " prefix
68 * The label length MUST be less than or equal to
69 * MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN
70 * It is the caller's responsibility to ensure this.
71 * All (label, label length) pairs used in TLS 1.3
72 * can be obtained via MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN().
73 * - (ctx, ctx_len): context + context length
74 * The context length MUST be less than or equal to
75 * MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN
76 * It is the caller's responsibility to ensure this.
Hanno Beckerbe9d6642020-08-21 13:20:06 +010077 * - dst: Target buffer for HkdfLabel structure,
78 * This MUST be a writable buffer of size
79 * at least SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN Bytes.
Xiaofei Baifeecbbb2021-11-23 07:24:58 +000080 * - dst_len: Pointer at which to store the actual length of
81 * the HkdfLabel structure on success.
Hanno Beckerbe9d6642020-08-21 13:20:06 +010082 */
83
Xiaofei Baid25fab62021-12-02 06:36:27 +000084static const char tls13_label_prefix[6] = "tls13 ";
Hanno Becker2dfe1322020-09-10 09:23:12 +010085
Hanno Becker9cb0a142020-09-08 10:48:14 +010086#define SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( label_len, context_len ) \
Hanno Beckerbe9d6642020-08-21 13:20:06 +010087 ( 2 /* expansion length */ \
88 + 1 /* label length */ \
Hanno Becker9cb0a142020-09-08 10:48:14 +010089 + label_len \
Hanno Beckerbe9d6642020-08-21 13:20:06 +010090 + 1 /* context length */ \
Hanno Becker9cb0a142020-09-08 10:48:14 +010091 + context_len )
92
93#define SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN \
94 SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( \
Xiaofei Baid25fab62021-12-02 06:36:27 +000095 sizeof(tls13_label_prefix) + \
Hanno Becker9cb0a142020-09-08 10:48:14 +010096 MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN, \
97 MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +010098
Xiaofei Bai746f9482021-11-12 08:53:56 +000099static void ssl_tls13_hkdf_encode_label(
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100100 size_t desired_length,
Xiaofei Baib7972842021-11-18 07:29:56 +0000101 const unsigned char *label, size_t label_len,
102 const unsigned char *ctx, size_t ctx_len,
103 unsigned char *dst, size_t *dst_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100104{
Hanno Becker2dfe1322020-09-10 09:23:12 +0100105 size_t total_label_len =
Xiaofei Baid25fab62021-12-02 06:36:27 +0000106 sizeof(tls13_label_prefix) + label_len;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100107 size_t total_hkdf_lbl_len =
Xiaofei Baib7972842021-11-18 07:29:56 +0000108 SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( total_label_len, ctx_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100109
110 unsigned char *p = dst;
111
Hanno Becker531fe302020-09-16 09:45:27 +0100112 /* Add the size of the expanded key material.
113 * We're hardcoding the high byte to 0 here assuming that we never use
114 * TLS 1.3 HKDF key expansion to more than 255 Bytes. */
115#if MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN > 255
Xiaofei Bai746f9482021-11-12 08:53:56 +0000116#error "The implementation of ssl_tls13_hkdf_encode_label() is not fit for the \
Hanno Becker531fe302020-09-16 09:45:27 +0100117 value of MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN"
118#endif
119
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100120 *p++ = 0;
Joe Subbiani2194dc42021-07-14 12:31:31 +0100121 *p++ = MBEDTLS_BYTE_0( desired_length );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100122
123 /* Add label incl. prefix */
Joe Subbiani2194dc42021-07-14 12:31:31 +0100124 *p++ = MBEDTLS_BYTE_0( total_label_len );
Xiaofei Baid25fab62021-12-02 06:36:27 +0000125 memcpy( p, tls13_label_prefix, sizeof(tls13_label_prefix) );
126 p += sizeof(tls13_label_prefix);
Xiaofei Baib7972842021-11-18 07:29:56 +0000127 memcpy( p, label, label_len );
128 p += label_len;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100129
130 /* Add context value */
Xiaofei Baib7972842021-11-18 07:29:56 +0000131 *p++ = MBEDTLS_BYTE_0( ctx_len );
132 if( ctx_len != 0 )
133 memcpy( p, ctx, ctx_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100134
135 /* Return total length to the caller. */
Xiaofei Baib7972842021-11-18 07:29:56 +0000136 *dst_len = total_hkdf_lbl_len;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100137}
138
Gabor Mezei9607ab42022-02-09 17:00:32 +0100139#if defined( MBEDTLS_TEST_HOOKS )
140
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100141MBEDTLS_STATIC_TESTABLE
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100142int mbedtls_psa_hkdf_extract( psa_algorithm_t alg,
143 const unsigned char *salt, size_t salt_len,
144 const unsigned char *ikm, size_t ikm_len,
145 unsigned char *prk )
146{
147 unsigned char null_salt[PSA_MAC_MAX_SIZE] = { '\0' };
148 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
149 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
150 size_t prk_len;
151 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
152
153 if( salt == NULL || salt_len == 0 )
154 {
155 size_t hash_len;
156
157 if( salt_len != 0 )
158 {
159 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
160 }
161
162 //hash_len = mbedtls_md_get_size( md );
163 hash_len = PSA_HASH_LENGTH( alg );
164
165 if( hash_len == 0 )
166 {
167 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
168 }
169
170 salt = null_salt;
171 salt_len = hash_len;
172 }
173
174 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
175 psa_set_key_algorithm( &attributes, alg );
176 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
177
178 ret = psa_import_key( &attributes, salt, salt_len, &key );
179 if( PSA_SUCCESS != ret )
180 {
181 goto cleanup;
182 }
183
184 ret = psa_mac_compute( key, alg, ikm, ikm_len, prk, PSA_HASH_LENGTH( alg ), &prk_len );
185
186cleanup:
187 psa_destroy_key( key );
188
189 return( ret );
190}
191
192MBEDTLS_STATIC_TESTABLE
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100193psa_status_t mbedtls_psa_hkdf_expand( psa_algorithm_t alg,
194 const unsigned char *prk, size_t prk_len,
195 const unsigned char *info, size_t info_len,
196 unsigned char *okm, size_t okm_len )
197{
198 size_t hash_len;
199 size_t where = 0;
200 size_t n;
201 size_t t_len = 0;
202 size_t i;
203 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
204 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
205 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gabor Mezei833713c2022-02-15 16:16:08 +0100206 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100207 psa_status_t destroy_status = PSA_ERROR_CORRUPTION_DETECTED;
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100208 unsigned char t[PSA_MAC_MAX_SIZE];
209
210 if( okm == NULL )
211 {
212 return( PSA_ERROR_INVALID_ARGUMENT );
213 }
214
215 hash_len = PSA_HASH_LENGTH( alg );
216
217 if( prk_len < hash_len || hash_len == 0 )
218 {
219 return( PSA_ERROR_INVALID_ARGUMENT );
220 }
221
222 if( info == NULL )
223 {
224 info = (const unsigned char *) "";
225 info_len = 0;
226 }
227
228 n = okm_len / hash_len;
229
230 if( okm_len % hash_len != 0 )
231 {
232 n++;
233 }
234
235 /*
236 * Per RFC 5869 Section 2.3, okm_len must not exceed
237 * 255 times the hash length
238 */
239 if( n > 255 )
240 {
241 return( PSA_ERROR_INVALID_ARGUMENT );
242 }
243
244 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
245 psa_set_key_algorithm( &attributes, alg );
246 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
247
Gabor Mezei833713c2022-02-15 16:16:08 +0100248 status = psa_import_key( &attributes, prk, prk_len, &key );
249 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100250 {
251 goto cleanup;
252 }
253
254 memset( t, 0, hash_len );
255
256 /*
257 * Compute T = T(1) | T(2) | T(3) | ... | T(N)
258 * Where T(N) is defined in RFC 5869 Section 2.3
259 */
260 for( i = 1; i <= n; i++ )
261 {
262 size_t num_to_copy;
263 unsigned char c = i & 0xff;
264 size_t len;
265
Gabor Mezei833713c2022-02-15 16:16:08 +0100266 status = psa_mac_sign_setup( &operation, key, alg );
267 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100268 {
269 goto cleanup;
270 }
271
Gabor Mezei833713c2022-02-15 16:16:08 +0100272 status = psa_mac_update( &operation, t, t_len );
273 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100274 {
275 goto cleanup;
276 }
277
Gabor Mezei833713c2022-02-15 16:16:08 +0100278 status = psa_mac_update( &operation, info, info_len );
279 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100280 {
281 goto cleanup;
282 }
283
Gabor Mezei8e360252022-02-17 11:50:02 +0100284 /* The constant concatenated to the end of each T(n) is a single octet. */
Gabor Mezei833713c2022-02-15 16:16:08 +0100285 status = psa_mac_update( &operation, &c, 1 );
286 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100287 {
288 goto cleanup;
289 }
290
Gabor Mezei833713c2022-02-15 16:16:08 +0100291 status = psa_mac_sign_finish( &operation, t, PSA_MAC_MAX_SIZE, &len );
292 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100293 {
294 goto cleanup;
295 }
296
297 num_to_copy = i != n ? hash_len : okm_len - where;
298 memcpy( okm + where, t, num_to_copy );
299 where += hash_len;
300 t_len = hash_len;
301 }
302
303cleanup:
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100304 if( status != PSA_SUCCESS )
305 psa_mac_abort( &operation );
306 destroy_status = psa_destroy_key( key );
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100307
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100308 mbedtls_platform_zeroize( t, sizeof( t ) );
309
310 return( ( status == PSA_SUCCESS ) ? destroy_status : status );
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100311}
312
Gabor Mezei9607ab42022-02-09 17:00:32 +0100313#endif /* MBEDTLS_TEST_HOOKS */
314
Xiaofei Bai746f9482021-11-12 08:53:56 +0000315int mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100316 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000317 const unsigned char *secret, size_t secret_len,
318 const unsigned char *label, size_t label_len,
319 const unsigned char *ctx, size_t ctx_len,
320 unsigned char *buf, size_t buf_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100321{
Xiaofei Baib7972842021-11-18 07:29:56 +0000322 const mbedtls_md_info_t *md_info;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100323 unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ];
324 size_t hkdf_label_len;
325
Xiaofei Baib7972842021-11-18 07:29:56 +0000326 if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100327 {
328 /* Should never happen since this is an internal
329 * function, and we know statically which labels
330 * are allowed. */
331 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
332 }
333
Xiaofei Baib7972842021-11-18 07:29:56 +0000334 if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100335 {
336 /* Should not happen, as above. */
337 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
338 }
339
Xiaofei Baib7972842021-11-18 07:29:56 +0000340 if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100341 {
342 /* Should not happen, as above. */
343 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
344 }
345
Xiaofei Baib7972842021-11-18 07:29:56 +0000346 md_info = mbedtls_md_info_from_type( hash_alg );
347 if( md_info == NULL )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100348 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
349
Xiaofei Baib7972842021-11-18 07:29:56 +0000350 ssl_tls13_hkdf_encode_label( buf_len,
351 label, label_len,
352 ctx, ctx_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000353 hkdf_label,
354 &hkdf_label_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100355
Xiaofei Baib7972842021-11-18 07:29:56 +0000356 return( mbedtls_hkdf_expand( md_info,
357 secret, secret_len,
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100358 hkdf_label, hkdf_label_len,
Xiaofei Baib7972842021-11-18 07:29:56 +0000359 buf, buf_len ) );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100360}
361
Hanno Becker3385a4d2020-08-21 13:03:34 +0100362/*
363 * The traffic keying material is generated from the following inputs:
364 *
365 * - One secret value per sender.
366 * - A purpose value indicating the specific value being generated
367 * - The desired lengths of key and IV.
368 *
369 * The expansion itself is based on HKDF:
370 *
371 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
372 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
373 *
374 * [sender] denotes the sending side and the Secret value is provided
375 * by the function caller. Note that we generate server and client side
376 * keys in a single function call.
377 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000378int mbedtls_ssl_tls13_make_traffic_keys(
Hanno Becker3385a4d2020-08-21 13:03:34 +0100379 mbedtls_md_type_t hash_alg,
380 const unsigned char *client_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +0000381 const unsigned char *server_secret, size_t secret_len,
382 size_t key_len, size_t iv_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100383 mbedtls_ssl_key_set *keys )
384{
385 int ret = 0;
386
Xiaofei Bai746f9482021-11-12 08:53:56 +0000387 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000388 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100389 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
390 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100391 keys->client_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100392 if( ret != 0 )
393 return( ret );
394
Xiaofei Bai746f9482021-11-12 08:53:56 +0000395 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000396 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100397 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
398 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100399 keys->server_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100400 if( ret != 0 )
401 return( ret );
402
Xiaofei Bai746f9482021-11-12 08:53:56 +0000403 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000404 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100405 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
406 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100407 keys->client_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100408 if( ret != 0 )
409 return( ret );
410
Xiaofei Bai746f9482021-11-12 08:53:56 +0000411 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000412 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100413 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
414 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100415 keys->server_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100416 if( ret != 0 )
417 return( ret );
418
Hanno Becker493ea7f2020-09-08 11:01:00 +0100419 keys->key_len = key_len;
420 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100421
422 return( 0 );
423}
424
Xiaofei Bai746f9482021-11-12 08:53:56 +0000425int mbedtls_ssl_tls13_derive_secret(
Hanno Beckerb35d5222020-08-21 13:27:44 +0100426 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000427 const unsigned char *secret, size_t secret_len,
428 const unsigned char *label, size_t label_len,
429 const unsigned char *ctx, size_t ctx_len,
Hanno Becker0c42fd92020-09-09 12:58:29 +0100430 int ctx_hashed,
Xiaofei Baib7972842021-11-18 07:29:56 +0000431 unsigned char *dstbuf, size_t dstbuf_len )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100432{
433 int ret;
434 unsigned char hashed_context[ MBEDTLS_MD_MAX_SIZE ];
435
Xiaofei Baib7972842021-11-18 07:29:56 +0000436 const mbedtls_md_info_t *md_info;
437 md_info = mbedtls_md_info_from_type( hash_alg );
438 if( md_info == NULL )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100439 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
440
Hanno Becker0c42fd92020-09-09 12:58:29 +0100441 if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100442 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000443 ret = mbedtls_md( md_info, ctx, ctx_len, hashed_context );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100444 if( ret != 0 )
445 return( ret );
Xiaofei Baib7972842021-11-18 07:29:56 +0000446 ctx_len = mbedtls_md_get_size( md_info );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100447 }
448 else
449 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000450 if( ctx_len > sizeof(hashed_context) )
Hanno Becker97a21562020-09-09 12:57:16 +0100451 {
452 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100453 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100454 * Let's double-check nonetheless to not run at the risk
455 * of getting a stack overflow. */
Hanno Beckerb35d5222020-08-21 13:27:44 +0100456 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Becker97a21562020-09-09 12:57:16 +0100457 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100458
Xiaofei Baib7972842021-11-18 07:29:56 +0000459 memcpy( hashed_context, ctx, ctx_len );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100460 }
461
Xiaofei Bai746f9482021-11-12 08:53:56 +0000462 return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000463 secret, secret_len,
464 label, label_len,
465 hashed_context, ctx_len,
466 dstbuf, dstbuf_len ) );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100467}
468
Xiaofei Bai746f9482021-11-12 08:53:56 +0000469int mbedtls_ssl_tls13_evolve_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100470 mbedtls_md_type_t hash_alg,
471 const unsigned char *secret_old,
472 const unsigned char *input, size_t input_len,
473 unsigned char *secret_new )
474{
475 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
476 size_t hlen, ilen;
Hanno Becker59b50a12020-09-09 10:56:56 +0100477 unsigned char tmp_secret[ MBEDTLS_MD_MAX_SIZE ] = { 0 };
Jerry Yu6eaa41c2021-11-22 18:16:45 +0800478 unsigned char tmp_input [ MBEDTLS_ECP_MAX_BYTES ] = { 0 };
Hanno Beckere9cccb42020-08-20 13:42:46 +0100479
Xiaofei Baib7972842021-11-18 07:29:56 +0000480 const mbedtls_md_info_t *md_info;
481 md_info = mbedtls_md_info_from_type( hash_alg );
482 if( md_info == NULL )
Hanno Beckere9cccb42020-08-20 13:42:46 +0100483 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
484
Xiaofei Baib7972842021-11-18 07:29:56 +0000485 hlen = mbedtls_md_get_size( md_info );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100486
487 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100488 * on the old secret. */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100489 if( secret_old != NULL )
490 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000491 ret = mbedtls_ssl_tls13_derive_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100492 hash_alg,
493 secret_old, hlen,
494 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ),
495 NULL, 0, /* context */
496 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Hanno Becker59b50a12020-09-09 10:56:56 +0100497 tmp_secret, hlen );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100498 if( ret != 0 )
499 goto cleanup;
500 }
501
502 if( input != NULL )
503 {
Hanno Becker59b50a12020-09-09 10:56:56 +0100504 memcpy( tmp_input, input, input_len );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100505 ilen = input_len;
506 }
507 else
508 {
509 ilen = hlen;
510 }
511
512 /* HKDF-Extract takes a salt and input key material.
513 * The salt is the old secret, and the input key material
514 * is the input secret (PSK / ECDHE). */
Xiaofei Baib7972842021-11-18 07:29:56 +0000515 ret = mbedtls_hkdf_extract( md_info,
Hanno Becker59b50a12020-09-09 10:56:56 +0100516 tmp_secret, hlen,
517 tmp_input, ilen,
Hanno Beckere9cccb42020-08-20 13:42:46 +0100518 secret_new );
519 if( ret != 0 )
520 goto cleanup;
521
522 ret = 0;
523
524 cleanup:
525
Hanno Becker59b50a12020-09-09 10:56:56 +0100526 mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) );
527 mbedtls_platform_zeroize( tmp_input, sizeof(tmp_input) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100528 return( ret );
529}
530
Xiaofei Bai746f9482021-11-12 08:53:56 +0000531int mbedtls_ssl_tls13_derive_early_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100532 mbedtls_md_type_t md_type,
533 unsigned char const *early_secret,
534 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000535 mbedtls_ssl_tls13_early_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100536{
537 int ret;
538 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
539 size_t const md_size = mbedtls_md_get_size( md_info );
540
541 /* We should never call this function with an unknown hash,
542 * but add an assertion anyway. */
543 if( md_info == 0 )
544 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
545
546 /*
547 * 0
548 * |
549 * v
550 * PSK -> HKDF-Extract = Early Secret
551 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100552 * +-----> Derive-Secret(., "c e traffic", ClientHello)
553 * | = client_early_traffic_secret
554 * |
555 * +-----> Derive-Secret(., "e exp master", ClientHello)
556 * | = early_exporter_master_secret
557 * v
558 */
559
560 /* Create client_early_traffic_secret */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000561 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100562 early_secret, md_size,
563 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ),
564 transcript, transcript_len,
565 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
566 derived->client_early_traffic_secret,
567 md_size );
568 if( ret != 0 )
569 return( ret );
570
571 /* Create early exporter */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000572 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100573 early_secret, md_size,
574 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ),
575 transcript, transcript_len,
576 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
577 derived->early_exporter_master_secret,
578 md_size );
579 if( ret != 0 )
580 return( ret );
581
582 return( 0 );
583}
584
Xiaofei Bai746f9482021-11-12 08:53:56 +0000585int mbedtls_ssl_tls13_derive_handshake_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100586 mbedtls_md_type_t md_type,
587 unsigned char const *handshake_secret,
588 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000589 mbedtls_ssl_tls13_handshake_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100590{
591 int ret;
592 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
593 size_t const md_size = mbedtls_md_get_size( md_info );
594
595 /* We should never call this function with an unknown hash,
596 * but add an assertion anyway. */
597 if( md_info == 0 )
598 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
599
600 /*
601 *
602 * Handshake Secret
603 * |
604 * +-----> Derive-Secret( ., "c hs traffic",
605 * | ClientHello...ServerHello )
606 * | = client_handshake_traffic_secret
607 * |
608 * +-----> Derive-Secret( ., "s hs traffic",
609 * | ClientHello...ServerHello )
610 * | = server_handshake_traffic_secret
611 *
612 */
613
614 /*
615 * Compute client_handshake_traffic_secret with
616 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
617 */
618
Xiaofei Bai746f9482021-11-12 08:53:56 +0000619 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100620 handshake_secret, md_size,
621 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ),
622 transcript, transcript_len,
623 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
624 derived->client_handshake_traffic_secret,
625 md_size );
626 if( ret != 0 )
627 return( ret );
628
629 /*
630 * Compute server_handshake_traffic_secret with
631 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
632 */
633
Xiaofei Bai746f9482021-11-12 08:53:56 +0000634 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100635 handshake_secret, md_size,
636 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ),
637 transcript, transcript_len,
638 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
639 derived->server_handshake_traffic_secret,
640 md_size );
641 if( ret != 0 )
642 return( ret );
643
644 return( 0 );
645}
646
Xiaofei Bai746f9482021-11-12 08:53:56 +0000647int mbedtls_ssl_tls13_derive_application_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100648 mbedtls_md_type_t md_type,
649 unsigned char const *application_secret,
650 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000651 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100652{
653 int ret;
654 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
655 size_t const md_size = mbedtls_md_get_size( md_info );
656
657 /* We should never call this function with an unknown hash,
658 * but add an assertion anyway. */
659 if( md_info == 0 )
660 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
661
662 /* Generate {client,server}_application_traffic_secret_0
663 *
664 * Master Secret
665 * |
666 * +-----> Derive-Secret( ., "c ap traffic",
667 * | ClientHello...server Finished )
668 * | = client_application_traffic_secret_0
669 * |
670 * +-----> Derive-Secret( ., "s ap traffic",
671 * | ClientHello...Server Finished )
672 * | = server_application_traffic_secret_0
673 * |
674 * +-----> Derive-Secret( ., "exp master",
675 * | ClientHello...server Finished)
676 * | = exporter_master_secret
677 *
678 */
679
Xiaofei Bai746f9482021-11-12 08:53:56 +0000680 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100681 application_secret, md_size,
682 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ),
683 transcript, transcript_len,
684 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
685 derived->client_application_traffic_secret_N,
686 md_size );
687 if( ret != 0 )
688 return( ret );
689
Xiaofei Bai746f9482021-11-12 08:53:56 +0000690 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100691 application_secret, md_size,
692 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ),
693 transcript, transcript_len,
694 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
695 derived->server_application_traffic_secret_N,
696 md_size );
697 if( ret != 0 )
698 return( ret );
699
Xiaofei Bai746f9482021-11-12 08:53:56 +0000700 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100701 application_secret, md_size,
702 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ),
703 transcript, transcript_len,
704 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
705 derived->exporter_master_secret,
706 md_size );
707 if( ret != 0 )
708 return( ret );
709
710 return( 0 );
711}
712
713/* Generate resumption_master_secret for use with the ticket exchange.
714 *
Xiaofei Bai746f9482021-11-12 08:53:56 +0000715 * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets()
Hanno Beckeref5235b2021-05-24 06:39:41 +0100716 * because it uses the transcript hash up to and including ClientFinished. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000717int mbedtls_ssl_tls13_derive_resumption_master_secret(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100718 mbedtls_md_type_t md_type,
719 unsigned char const *application_secret,
720 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000721 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100722{
723 int ret;
724 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
725 size_t const md_size = mbedtls_md_get_size( md_info );
726
727 /* We should never call this function with an unknown hash,
728 * but add an assertion anyway. */
729 if( md_info == 0 )
730 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
731
Xiaofei Bai746f9482021-11-12 08:53:56 +0000732 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100733 application_secret, md_size,
734 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ),
735 transcript, transcript_len,
736 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
737 derived->resumption_master_secret,
738 md_size );
739
740 if( ret != 0 )
741 return( ret );
742
743 return( 0 );
744}
745
XiaokangQiana4c99f22021-11-11 06:46:35 +0000746int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000747{
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +0000749 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
750 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000751#if defined(MBEDTLS_DEBUG_C)
752 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
753 size_t const md_size = mbedtls_md_get_size( md_info );
754#endif /* MBEDTLS_DEBUG_C */
755
756 /*
757 * Compute MasterSecret
758 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000759 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000760 handshake->tls13_master_secrets.handshake,
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000761 NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000762 handshake->tls13_master_secrets.app );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000763 if( ret != 0 )
764 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000765 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000766 return( ret );
767 }
768
769 MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +0000770 handshake->tls13_master_secrets.app, md_size );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000771
772 return( 0 );
773}
774
Xiaofei Bai746f9482021-11-12 08:53:56 +0000775static int ssl_tls13_calc_finished_core( mbedtls_md_type_t md_type,
776 unsigned char const *base_key,
777 unsigned char const *transcript,
778 unsigned char *dst )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100779{
780 const mbedtls_md_info_t* const md_info = mbedtls_md_info_from_type( md_type );
781 size_t const md_size = mbedtls_md_get_size( md_info );
782 unsigned char finished_key[MBEDTLS_MD_MAX_SIZE];
783 int ret;
784
785 /* We should never call this function with an unknown hash,
786 * but add an assertion anyway. */
787 if( md_info == 0 )
788 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
789
790 /* TLS 1.3 Finished message
791 *
792 * struct {
793 * opaque verify_data[Hash.length];
794 * } Finished;
795 *
796 * verify_data =
797 * HMAC( finished_key,
798 * Hash( Handshake Context +
799 * Certificate* +
800 * CertificateVerify* )
801 * )
802 *
803 * finished_key =
804 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
805 */
806
Xiaofei Bai746f9482021-11-12 08:53:56 +0000807 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100808 md_type, base_key, md_size,
809 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ),
810 NULL, 0,
811 finished_key, md_size );
812 if( ret != 0 )
813 goto exit;
814
815 ret = mbedtls_md_hmac( md_info, finished_key, md_size, transcript, md_size, dst );
816 if( ret != 0 )
817 goto exit;
818
819exit:
820
821 mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) );
822 return( ret );
823}
824
XiaokangQianc5c39d52021-11-09 11:55:10 +0000825int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl,
XiaokangQianaaa0e192021-11-10 03:07:04 +0000826 unsigned char* dst,
827 size_t dst_len,
828 size_t *actual_len,
829 int from )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000830{
XiaokangQiana7634982021-10-22 06:32:32 +0000831 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000832
XiaokangQianaaa0e192021-11-10 03:07:04 +0000833 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000834 size_t transcript_len;
835
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800836 unsigned char *base_key = NULL;
Jerry Yub737f6a2021-12-10 17:55:23 +0800837 size_t base_key_len = 0;
Jerry Yu9c074732021-12-10 17:12:43 +0800838 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets =
839 &ssl->handshake->tls13_hs_secrets;
Jerry Yua5563f62021-12-10 18:14:36 +0800840
841 mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac;
842 const mbedtls_md_info_t* const md_info =
843 mbedtls_md_info_from_type( md_type );
844 size_t const md_size = mbedtls_md_get_size( md_info );
845
846 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) );
847
Jerry Yub737f6a2021-12-10 17:55:23 +0800848 if( from == MBEDTLS_SSL_IS_CLIENT )
849 {
850 base_key = tls13_hs_secrets->client_handshake_traffic_secret;
851 base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret );
852 }
853 else
854 {
855 base_key = tls13_hs_secrets->server_handshake_traffic_secret;
856 base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret );
857 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000858
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000859 if( dst_len < md_size )
Jerry Yu9c074732021-12-10 17:12:43 +0800860 {
861 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
862 goto exit;
863 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000864
865 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
866 transcript, sizeof( transcript ),
867 &transcript_len );
868 if( ret != 0 )
869 {
870 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000871 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000872 }
873 MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len );
874
Xiaofei Bai746f9482021-11-12 08:53:56 +0000875 ret = ssl_tls13_calc_finished_core( md_type, base_key, transcript, dst );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000876 if( ret != 0 )
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000877 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000878 *actual_len = md_size;
879
880 MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, md_size );
XiaokangQianc5c39d52021-11-09 11:55:10 +0000881 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000882
883exit:
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800884 /* Erase handshake secrets */
Jerry Yub737f6a2021-12-10 17:55:23 +0800885 mbedtls_platform_zeroize( base_key, base_key_len );
XiaokangQian33062842021-11-11 03:37:45 +0000886 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000887 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000888}
889
Xiaofei Bai746f9482021-11-12 08:53:56 +0000890int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100891 const mbedtls_md_type_t md_type,
892 unsigned char const *psk, size_t psk_len,
893 int psk_type,
894 unsigned char const *transcript,
895 unsigned char *result )
896{
897 int ret = 0;
898 unsigned char binder_key[MBEDTLS_MD_MAX_SIZE];
899 unsigned char early_secret[MBEDTLS_MD_MAX_SIZE];
900 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type( md_type );
901 size_t const md_size = mbedtls_md_get_size( md_info );
902
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100903#if !defined(MBEDTLS_DEBUG_C)
904 ssl = NULL; /* make sure we don't use it except for debug */
905 ((void) ssl);
906#endif
907
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100908 /* We should never call this function with an unknown hash,
909 * but add an assertion anyway. */
910 if( md_info == 0 )
911 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
912
913 /*
914 * 0
915 * |
916 * v
917 * PSK -> HKDF-Extract = Early Secret
918 * |
919 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
920 * | = binder_key
921 * v
922 */
923
Xiaofei Bai746f9482021-11-12 08:53:56 +0000924 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
925 NULL, /* Old secret */
926 psk, psk_len, /* Input */
927 early_secret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100928 if( ret != 0 )
929 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000930 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100931 goto exit;
932 }
933
934 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
935 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000936 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100937 early_secret, md_size,
938 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ),
939 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
940 binder_key, md_size );
941 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) );
942 }
943 else
944 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000945 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100946 early_secret, md_size,
947 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ),
948 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
949 binder_key, md_size );
950 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) );
951 }
952
953 if( ret != 0 )
954 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000955 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100956 goto exit;
957 }
958
959 /*
960 * The binding_value is computed in the same way as the Finished message
961 * but with the BaseKey being the binder_key.
962 */
963
Xiaofei Bai746f9482021-11-12 08:53:56 +0000964 ret = ssl_tls13_calc_finished_core( md_type, binder_key, transcript, result );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100965 if( ret != 0 )
966 goto exit;
967
968 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, md_size );
969
970exit:
971
972 mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) );
973 mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) );
974 return( ret );
975}
976
Hanno Beckerc94060c2021-03-22 07:50:44 +0000977int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform,
978 int endpoint,
979 int ciphersuite,
980 mbedtls_ssl_key_set const *traffic_keys,
981 mbedtls_ssl_context *ssl /* DEBUG ONLY */ )
982{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100983#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000984 int ret;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100985#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000986 mbedtls_cipher_info_t const *cipher_info;
987 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
988 unsigned char const *key_enc;
989 unsigned char const *iv_enc;
990 unsigned char const *key_dec;
991 unsigned char const *iv_dec;
992
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100993#if defined(MBEDTLS_USE_PSA_CRYPTO)
994 psa_key_type_t key_type;
995 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
996 psa_algorithm_t alg;
997 size_t key_bits;
998 psa_status_t status = PSA_SUCCESS;
999#endif
1000
Hanno Beckerc94060c2021-03-22 07:50:44 +00001001#if !defined(MBEDTLS_DEBUG_C)
1002 ssl = NULL; /* make sure we don't use it except for those cases */
1003 (void) ssl;
1004#endif
1005
1006 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Hanno Becker7887a772021-04-20 05:27:57 +01001007 if( ciphersuite_info == NULL )
1008 {
1009 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
1010 ciphersuite ) );
1011 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1012 }
Hanno Beckerc94060c2021-03-22 07:50:44 +00001013
1014 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
1015 if( cipher_info == NULL )
1016 {
Hanno Becker7887a772021-04-20 05:27:57 +01001017 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
1018 ciphersuite_info->cipher ) );
Hanno Beckerf62a7302021-04-21 05:21:28 +01001019 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Beckerc94060c2021-03-22 07:50:44 +00001020 }
1021
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001022#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001023 /*
1024 * Setup cipher contexts in target transform
1025 */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001026 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
1027 cipher_info ) ) != 0 )
1028 {
1029 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
1030 return( ret );
1031 }
1032
1033 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
1034 cipher_info ) ) != 0 )
1035 {
1036 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
1037 return( ret );
1038 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001039#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001040
1041#if defined(MBEDTLS_SSL_SRV_C)
1042 if( endpoint == MBEDTLS_SSL_IS_SERVER )
1043 {
1044 key_enc = traffic_keys->server_write_key;
1045 key_dec = traffic_keys->client_write_key;
1046 iv_enc = traffic_keys->server_write_iv;
1047 iv_dec = traffic_keys->client_write_iv;
1048 }
1049 else
1050#endif /* MBEDTLS_SSL_SRV_C */
1051#if defined(MBEDTLS_SSL_CLI_C)
1052 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
1053 {
1054 key_enc = traffic_keys->client_write_key;
1055 key_dec = traffic_keys->server_write_key;
1056 iv_enc = traffic_keys->client_write_iv;
1057 iv_dec = traffic_keys->server_write_iv;
1058 }
1059 else
1060#endif /* MBEDTLS_SSL_CLI_C */
1061 {
1062 /* should not happen */
1063 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1064 }
1065
1066 memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len );
1067 memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len );
1068
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001069#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001070 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc,
1071 key_enc, cipher_info->key_bitlen,
1072 MBEDTLS_ENCRYPT ) ) != 0 )
1073 {
1074 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1075 return( ret );
1076 }
1077
1078 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec,
1079 key_dec, cipher_info->key_bitlen,
1080 MBEDTLS_DECRYPT ) ) != 0 )
1081 {
1082 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1083 return( ret );
1084 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001085#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001086
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +01001087 /*
1088 * Setup other fields in SSL transform
1089 */
1090
1091 if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 )
1092 transform->taglen = 8;
1093 else
1094 transform->taglen = 16;
1095
1096 transform->ivlen = traffic_keys->iv_len;
1097 transform->maclen = 0;
1098 transform->fixed_ivlen = transform->ivlen;
1099 transform->minor_ver = MBEDTLS_SSL_MINOR_VERSION_4;
1100
1101 /* We add the true record content type (1 Byte) to the plaintext and
1102 * then pad to the configured granularity. The mimimum length of the
1103 * type-extended and padded plaintext is therefore the padding
1104 * granularity. */
1105 transform->minlen =
1106 transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY;
1107
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001108#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001109 /*
1110 * Setup psa keys and alg
1111 */
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001112 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001113 transform->taglen,
1114 &alg,
1115 &key_type,
1116 &key_bits ) ) != PSA_SUCCESS )
1117 {
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001118 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", psa_ssl_status_to_mbedtls( status ) );
1119 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001120 }
1121
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001122 transform->psa_alg = alg;
1123
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001124 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001125 {
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001126 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
1127 psa_set_key_algorithm( &attributes, alg );
1128 psa_set_key_type( &attributes, key_type );
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001129
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001130 if( ( status = psa_import_key( &attributes,
1131 key_enc,
1132 PSA_BITS_TO_BYTES( key_bits ),
1133 &transform->psa_key_enc ) ) != PSA_SUCCESS )
1134 {
1135 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1136 return( psa_ssl_status_to_mbedtls( status ) );
1137 }
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001138
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001139 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
1140
1141 if( ( status = psa_import_key( &attributes,
1142 key_dec,
1143 PSA_BITS_TO_BYTES( key_bits ),
1144 &transform->psa_key_dec ) ) != PSA_SUCCESS )
1145 {
1146 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1147 return( psa_ssl_status_to_mbedtls( status ) );
1148 }
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001149 }
1150#endif /* MBEDTLS_USE_PSA_CRYPTO */
1151
Hanno Beckerc94060c2021-03-22 07:50:44 +00001152 return( 0 );
1153}
1154
Xiaofei Bai746f9482021-11-12 08:53:56 +00001155int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl )
Jerry Yu89ea3212021-09-09 14:31:24 +08001156{
Jerry Yue3131ef2021-09-16 13:14:15 +08001157 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1158 mbedtls_md_type_t md_type;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001159 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu6ca7c7f2021-09-28 18:51:40 +08001160
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001161 if( handshake->ciphersuite_info == NULL )
Jerry Yu89ea3212021-09-09 14:31:24 +08001162 {
1163 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) );
1164 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1165 }
Jerry Yue3131ef2021-09-16 13:14:15 +08001166
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001167 md_type = handshake->ciphersuite_info->mac;
Jerry Yue06f4532021-09-23 18:35:07 +08001168
Xiaofei Bai746f9482021-11-12 08:53:56 +00001169 ret = mbedtls_ssl_tls13_evolve_secret( md_type, NULL, NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001170 handshake->tls13_master_secrets.early );
Jerry Yu89ea3212021-09-09 14:31:24 +08001171 if( ret != 0 )
1172 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001173 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yu89ea3212021-09-09 14:31:24 +08001174 return( ret );
1175 }
1176
1177 return( 0 );
1178}
1179
Jerry Yuc068b662021-10-11 22:30:19 +08001180/* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for
Jerry Yu61e35e02021-09-16 18:59:08 +08001181 * protecting the handshake messages, as described in Section 7 of TLS 1.3. */
Jerry Yuc068b662021-10-11 22:30:19 +08001182int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl,
1183 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu61e35e02021-09-16 18:59:08 +08001184{
1185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1186
1187 mbedtls_md_type_t md_type;
1188 mbedtls_md_info_t const *md_info;
1189 size_t md_size;
1190
Jerry Yu435208a2021-10-13 11:22:16 +08001191 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu61e35e02021-09-16 18:59:08 +08001192 size_t transcript_len;
1193
1194 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001195 size_t key_len, iv_len;
Jerry Yu61e35e02021-09-16 18:59:08 +08001196
Jerry Yu435208a2021-10-13 11:22:16 +08001197 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1198 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
Xiaofei Bai746f9482021-11-12 08:53:56 +00001199 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets;
Jerry Yu435208a2021-10-13 11:22:16 +08001200
Jerry Yuc068b662021-10-11 22:30:19 +08001201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001202
Jerry Yu435208a2021-10-13 11:22:16 +08001203 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001204 key_len = cipher_info->key_bitlen >> 3;
1205 iv_len = cipher_info->iv_size;
Jerry Yu61e35e02021-09-16 18:59:08 +08001206
Jerry Yu435208a2021-10-13 11:22:16 +08001207 md_type = ciphersuite_info->mac;
Jerry Yu61e35e02021-09-16 18:59:08 +08001208 md_info = mbedtls_md_info_from_type( md_type );
1209 md_size = mbedtls_md_get_size( md_info );
1210
1211 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1212 transcript,
1213 sizeof( transcript ),
1214 &transcript_len );
1215 if( ret != 0 )
1216 {
1217 MBEDTLS_SSL_DEBUG_RET( 1,
1218 "mbedtls_ssl_get_handshake_transcript",
1219 ret );
1220 return( ret );
1221 }
1222
Xiaofei Bai746f9482021-11-12 08:53:56 +00001223 ret = mbedtls_ssl_tls13_derive_handshake_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001224 handshake->tls13_master_secrets.handshake,
Jerry Yu435208a2021-10-13 11:22:16 +08001225 transcript, transcript_len, tls13_hs_secrets );
Jerry Yu61e35e02021-09-16 18:59:08 +08001226 if( ret != 0 )
1227 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001228 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets",
Jerry Yu61e35e02021-09-16 18:59:08 +08001229 ret );
1230 return( ret );
1231 }
1232
1233 MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001234 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001235 md_size );
Jerry Yu61e35e02021-09-16 18:59:08 +08001236 MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001237 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001238 md_size );
1239
1240 /*
1241 * Export client handshake traffic secret
1242 */
Jerry Yu61e35e02021-09-16 18:59:08 +08001243 if( ssl->f_export_keys != NULL )
1244 {
1245 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001246 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001247 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001248 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001249 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001250 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001251 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1252
1253 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001254 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001255 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001256 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001257 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001258 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001259 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1260 }
Jerry Yu61e35e02021-09-16 18:59:08 +08001261
Xiaofei Bai746f9482021-11-12 08:53:56 +00001262 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
Jerry Yu435208a2021-10-13 11:22:16 +08001263 tls13_hs_secrets->client_handshake_traffic_secret,
1264 tls13_hs_secrets->server_handshake_traffic_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +00001265 md_size, key_len, iv_len, traffic_keys );
Jerry Yu61e35e02021-09-16 18:59:08 +08001266 if( ret != 0 )
1267 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001268 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
Jerry Yu61e35e02021-09-16 18:59:08 +08001269 goto exit;
1270 }
1271
1272 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key",
1273 traffic_keys->client_write_key,
1274 traffic_keys->key_len);
1275
1276 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key",
1277 traffic_keys->server_write_key,
1278 traffic_keys->key_len);
1279
1280 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv",
1281 traffic_keys->client_write_iv,
1282 traffic_keys->iv_len);
1283
1284 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv",
1285 traffic_keys->server_write_iv,
1286 traffic_keys->iv_len);
1287
Jerry Yuc068b662021-10-11 22:30:19 +08001288 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001289
1290exit:
1291
1292 return( ret );
1293}
1294
Jerry Yuf0ac2352021-10-11 17:47:07 +08001295int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl )
Jerry Yua0650eb2021-09-09 17:14:45 +08001296{
Jerry Yuf0ac2352021-10-11 17:47:07 +08001297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001298 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1299 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
Jerry Yuf0ac2352021-10-11 17:47:07 +08001300 size_t ephemeral_len = 0;
1301 unsigned char ecdhe[MBEDTLS_ECP_MAX_BYTES];
Jerry Yua0650eb2021-09-09 17:14:45 +08001302#if defined(MBEDTLS_DEBUG_C)
1303 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
1304 size_t const md_size = mbedtls_md_get_size( md_info );
1305#endif /* MBEDTLS_DEBUG_C */
1306
Jerry Yuf0ac2352021-10-11 17:47:07 +08001307#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1308 /*
1309 * Compute ECDHE secret used to compute the handshake secret from which
1310 * client_handshake_traffic_secret and server_handshake_traffic_secret
1311 * are derived in the handshake secret derivation stage.
1312 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001313 if( mbedtls_ssl_tls13_ephemeral_enabled( ssl ) )
Jerry Yuf0ac2352021-10-11 17:47:07 +08001314 {
1315 if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) )
1316 {
1317#if defined(MBEDTLS_ECDH_C)
1318 ret = mbedtls_ecdh_calc_secret( &handshake->ecdh_ctx,
1319 &ephemeral_len, ecdhe, sizeof( ecdhe ),
1320 ssl->conf->f_rng,
1321 ssl->conf->p_rng );
1322 if( ret != 0 )
1323 {
1324 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
1325 return( ret );
1326 }
1327#endif /* MBEDTLS_ECDH_C */
1328 }
1329 else if( mbedtls_ssl_tls13_named_group_is_dhe( handshake->offered_group_id ) )
1330 {
Jerry Yuf0ac2352021-10-11 17:47:07 +08001331 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DHE not supported." ) );
1332 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1333 }
1334 }
1335#else
1336 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1337#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
Jerry Yua0650eb2021-09-09 17:14:45 +08001338
1339 /*
Jerry Yuf0ac2352021-10-11 17:47:07 +08001340 * Compute the Handshake Secret
Jerry Yua0650eb2021-09-09 17:14:45 +08001341 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001342 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001343 handshake->tls13_master_secrets.early,
Xiaofei Baib7972842021-11-18 07:29:56 +00001344 ecdhe, ephemeral_len,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001345 handshake->tls13_master_secrets.handshake );
Jerry Yua0650eb2021-09-09 17:14:45 +08001346 if( ret != 0 )
1347 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001348 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yua0650eb2021-09-09 17:14:45 +08001349 return( ret );
1350 }
1351
1352 MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +00001353 handshake->tls13_master_secrets.handshake, md_size );
Jerry Yua0650eb2021-09-09 17:14:45 +08001354
1355#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1356 mbedtls_platform_zeroize( ecdhe, sizeof( ecdhe ) );
1357#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
1358 return( 0 );
1359}
1360
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001361/* Generate application traffic keys since any records following a 1-RTT Finished message
1362 * MUST be encrypted under the application traffic key.
1363 */
XiaokangQiand0aa3e92021-11-10 06:17:40 +00001364int mbedtls_ssl_tls13_generate_application_keys(
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001365 mbedtls_ssl_context *ssl,
1366 mbedtls_ssl_key_set *traffic_keys )
1367{
XiaokangQiana7634982021-10-22 06:32:32 +00001368 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +00001369 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001370
1371 /* Address at which to store the application secrets */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001372 mbedtls_ssl_tls13_application_secrets * const app_secrets =
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001373 &ssl->session_negotiate->app_secrets;
1374
1375 /* Holding the transcript up to and including the ServerFinished */
XiaokangQian33062842021-11-11 03:37:45 +00001376 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001377 size_t transcript_len;
1378
1379 /* Variables relating to the hash for the chosen ciphersuite. */
1380 mbedtls_md_type_t md_type;
1381 mbedtls_md_info_t const *md_info;
1382 size_t md_size;
1383
1384 /* Variables relating to the cipher for the chosen ciphersuite. */
1385 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001386 size_t key_len, iv_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001387
1388 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) );
1389
1390 /* Extract basic information about hash and ciphersuite */
1391
1392 cipher_info = mbedtls_cipher_info_from_type(
XiaokangQian33062842021-11-11 03:37:45 +00001393 handshake->ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001394 key_len = cipher_info->key_bitlen / 8;
1395 iv_len = cipher_info->iv_size;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001396
XiaokangQian33062842021-11-11 03:37:45 +00001397 md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001398 md_info = mbedtls_md_info_from_type( md_type );
1399 md_size = mbedtls_md_get_size( md_info );
1400
1401 /* Compute current handshake transcript. It's the caller's responsiblity
1402 * to call this at the right time, that is, after the ServerFinished. */
1403
1404 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1405 transcript, sizeof( transcript ),
1406 &transcript_len );
1407 if( ret != 0 )
XiaokangQian4cab0242021-10-12 08:43:37 +00001408 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001409
1410 /* Compute application secrets from master secret and transcript hash. */
1411
Xiaofei Bai746f9482021-11-12 08:53:56 +00001412 ret = mbedtls_ssl_tls13_derive_application_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001413 handshake->tls13_master_secrets.app,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001414 transcript, transcript_len,
1415 app_secrets );
Jerry Yu4a2fa5d2021-12-10 10:19:34 +08001416 /* Erase master secrets */
Jerry Yu23ab7a42021-12-08 14:34:10 +08001417 mbedtls_platform_zeroize( &ssl->handshake->tls13_master_secrets,
Jerry Yu27224f52021-12-09 10:56:50 +08001418 sizeof( ssl->handshake->tls13_master_secrets ) );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001419 if( ret != 0 )
1420 {
1421 MBEDTLS_SSL_DEBUG_RET( 1,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001422 "mbedtls_ssl_tls13_derive_application_secrets", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001423 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001424 }
1425
1426 /* Derive first epoch of IV + Key for application traffic. */
1427
Xiaofei Bai746f9482021-11-12 08:53:56 +00001428 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001429 app_secrets->client_application_traffic_secret_N,
1430 app_secrets->server_application_traffic_secret_N,
Xiaofei Baib7972842021-11-18 07:29:56 +00001431 md_size, key_len, iv_len, traffic_keys );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001432 if( ret != 0 )
1433 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001434 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001435 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001436 }
1437
1438 MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret",
1439 app_secrets->client_application_traffic_secret_N,
1440 md_size );
1441
1442 MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret",
1443 app_secrets->server_application_traffic_secret_N,
1444 md_size );
1445
XiaokangQianac0385c2021-11-03 06:40:11 +00001446 /*
1447 * Export client/server application traffic secret 0
1448 */
1449 if( ssl->f_export_keys != NULL )
1450 {
1451 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001452 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001453 app_secrets->client_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001454 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001455 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001456 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1457 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001458
1459 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001460 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001461 app_secrets->server_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001462 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001463 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001464 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1465 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001466 }
1467
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001468 MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:",
Xiaofei Baib7972842021-11-18 07:29:56 +00001469 traffic_keys->client_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001470 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key",
Xiaofei Baib7972842021-11-18 07:29:56 +00001471 traffic_keys->server_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001472 MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001473 traffic_keys->client_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001474 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001475 traffic_keys->server_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001476
1477 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001478
1479 cleanup:
Jerry Yu2c70a392021-12-08 13:28:49 +08001480 /* randbytes is not used again */
1481 mbedtls_platform_zeroize( ssl->handshake->randbytes,
1482 sizeof( ssl->handshake->randbytes ) );
XiaokangQian33062842021-11-11 03:37:45 +00001483 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001484 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001485}
1486
Ronald Cron6f135e12021-12-08 16:57:54 +01001487#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */