blob: 429d1241c3f37e1c8f6d43960fa0ab522e12d890 [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 Mezei62bf0242022-02-07 18:12:07 +0100142psa_status_t 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, size_t prk_size,
146 size_t *prk_len )
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100147{
148 unsigned char null_salt[PSA_MAC_MAX_SIZE] = { '\0' };
149 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
150 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gabor Mezei62bf0242022-02-07 18:12:07 +0100151 psa_status_t ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100152
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
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100162 hash_len = PSA_HASH_LENGTH( alg );
163
164 if( hash_len == 0 )
165 {
166 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
167 }
168
169 salt = null_salt;
170 salt_len = hash_len;
171 }
172
173 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
174 psa_set_key_algorithm( &attributes, alg );
175 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
176
177 ret = psa_import_key( &attributes, salt, salt_len, &key );
178 if( PSA_SUCCESS != ret )
179 {
180 goto cleanup;
181 }
182
Gabor Mezei62bf0242022-02-07 18:12:07 +0100183 ret = psa_mac_compute( key, alg, ikm, ikm_len, prk, prk_size, prk_len );
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100184
185cleanup:
186 psa_destroy_key( key );
187
188 return( ret );
189}
190
191MBEDTLS_STATIC_TESTABLE
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100192psa_status_t mbedtls_psa_hkdf_expand( psa_algorithm_t alg,
193 const unsigned char *prk, size_t prk_len,
194 const unsigned char *info, size_t info_len,
195 unsigned char *okm, size_t okm_len )
196{
197 size_t hash_len;
198 size_t where = 0;
199 size_t n;
200 size_t t_len = 0;
201 size_t i;
202 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
203 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
204 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gabor Mezei833713c2022-02-15 16:16:08 +0100205 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100206 psa_status_t destroy_status = PSA_ERROR_CORRUPTION_DETECTED;
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100207 unsigned char t[PSA_MAC_MAX_SIZE];
208
209 if( okm == NULL )
210 {
211 return( PSA_ERROR_INVALID_ARGUMENT );
212 }
213
214 hash_len = PSA_HASH_LENGTH( alg );
215
216 if( prk_len < hash_len || hash_len == 0 )
217 {
218 return( PSA_ERROR_INVALID_ARGUMENT );
219 }
220
221 if( info == NULL )
222 {
223 info = (const unsigned char *) "";
224 info_len = 0;
225 }
226
227 n = okm_len / hash_len;
228
229 if( okm_len % hash_len != 0 )
230 {
231 n++;
232 }
233
234 /*
235 * Per RFC 5869 Section 2.3, okm_len must not exceed
236 * 255 times the hash length
237 */
238 if( n > 255 )
239 {
240 return( PSA_ERROR_INVALID_ARGUMENT );
241 }
242
243 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
244 psa_set_key_algorithm( &attributes, alg );
245 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
246
Gabor Mezei833713c2022-02-15 16:16:08 +0100247 status = psa_import_key( &attributes, prk, prk_len, &key );
248 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100249 {
250 goto cleanup;
251 }
252
253 memset( t, 0, hash_len );
254
255 /*
256 * Compute T = T(1) | T(2) | T(3) | ... | T(N)
257 * Where T(N) is defined in RFC 5869 Section 2.3
258 */
259 for( i = 1; i <= n; i++ )
260 {
261 size_t num_to_copy;
262 unsigned char c = i & 0xff;
263 size_t len;
264
Gabor Mezei833713c2022-02-15 16:16:08 +0100265 status = psa_mac_sign_setup( &operation, key, alg );
266 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100267 {
268 goto cleanup;
269 }
270
Gabor Mezei833713c2022-02-15 16:16:08 +0100271 status = psa_mac_update( &operation, t, t_len );
272 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100273 {
274 goto cleanup;
275 }
276
Gabor Mezei833713c2022-02-15 16:16:08 +0100277 status = psa_mac_update( &operation, info, info_len );
278 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100279 {
280 goto cleanup;
281 }
282
Gabor Mezei8e360252022-02-17 11:50:02 +0100283 /* The constant concatenated to the end of each T(n) is a single octet. */
Gabor Mezei833713c2022-02-15 16:16:08 +0100284 status = psa_mac_update( &operation, &c, 1 );
285 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100286 {
287 goto cleanup;
288 }
289
Gabor Mezei833713c2022-02-15 16:16:08 +0100290 status = psa_mac_sign_finish( &operation, t, PSA_MAC_MAX_SIZE, &len );
291 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100292 {
293 goto cleanup;
294 }
295
296 num_to_copy = i != n ? hash_len : okm_len - where;
297 memcpy( okm + where, t, num_to_copy );
298 where += hash_len;
299 t_len = hash_len;
300 }
301
302cleanup:
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100303 if( status != PSA_SUCCESS )
304 psa_mac_abort( &operation );
305 destroy_status = psa_destroy_key( key );
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100306
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100307 mbedtls_platform_zeroize( t, sizeof( t ) );
308
309 return( ( status == PSA_SUCCESS ) ? destroy_status : status );
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100310}
311
Gabor Mezei9607ab42022-02-09 17:00:32 +0100312#endif /* MBEDTLS_TEST_HOOKS */
313
Xiaofei Bai746f9482021-11-12 08:53:56 +0000314int mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100315 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000316 const unsigned char *secret, size_t secret_len,
317 const unsigned char *label, size_t label_len,
318 const unsigned char *ctx, size_t ctx_len,
319 unsigned char *buf, size_t buf_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100320{
Xiaofei Baib7972842021-11-18 07:29:56 +0000321 const mbedtls_md_info_t *md_info;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100322 unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ];
323 size_t hkdf_label_len;
324
Xiaofei Baib7972842021-11-18 07:29:56 +0000325 if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100326 {
327 /* Should never happen since this is an internal
328 * function, and we know statically which labels
329 * are allowed. */
330 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
331 }
332
Xiaofei Baib7972842021-11-18 07:29:56 +0000333 if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100334 {
335 /* Should not happen, as above. */
336 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
337 }
338
Xiaofei Baib7972842021-11-18 07:29:56 +0000339 if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100340 {
341 /* Should not happen, as above. */
342 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
343 }
344
Xiaofei Baib7972842021-11-18 07:29:56 +0000345 md_info = mbedtls_md_info_from_type( hash_alg );
346 if( md_info == NULL )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100347 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
348
Xiaofei Baib7972842021-11-18 07:29:56 +0000349 ssl_tls13_hkdf_encode_label( buf_len,
350 label, label_len,
351 ctx, ctx_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000352 hkdf_label,
353 &hkdf_label_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100354
Xiaofei Baib7972842021-11-18 07:29:56 +0000355 return( mbedtls_hkdf_expand( md_info,
356 secret, secret_len,
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100357 hkdf_label, hkdf_label_len,
Xiaofei Baib7972842021-11-18 07:29:56 +0000358 buf, buf_len ) );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100359}
360
Hanno Becker3385a4d2020-08-21 13:03:34 +0100361/*
362 * The traffic keying material is generated from the following inputs:
363 *
364 * - One secret value per sender.
365 * - A purpose value indicating the specific value being generated
366 * - The desired lengths of key and IV.
367 *
368 * The expansion itself is based on HKDF:
369 *
370 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
371 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
372 *
373 * [sender] denotes the sending side and the Secret value is provided
374 * by the function caller. Note that we generate server and client side
375 * keys in a single function call.
376 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000377int mbedtls_ssl_tls13_make_traffic_keys(
Hanno Becker3385a4d2020-08-21 13:03:34 +0100378 mbedtls_md_type_t hash_alg,
379 const unsigned char *client_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +0000380 const unsigned char *server_secret, size_t secret_len,
381 size_t key_len, size_t iv_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100382 mbedtls_ssl_key_set *keys )
383{
384 int ret = 0;
385
Xiaofei Bai746f9482021-11-12 08:53:56 +0000386 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000387 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100388 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
389 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100390 keys->client_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100391 if( ret != 0 )
392 return( ret );
393
Xiaofei Bai746f9482021-11-12 08:53:56 +0000394 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000395 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100396 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
397 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100398 keys->server_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100399 if( ret != 0 )
400 return( ret );
401
Xiaofei Bai746f9482021-11-12 08:53:56 +0000402 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000403 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100404 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
405 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100406 keys->client_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100407 if( ret != 0 )
408 return( ret );
409
Xiaofei Bai746f9482021-11-12 08:53:56 +0000410 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000411 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100412 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
413 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100414 keys->server_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100415 if( ret != 0 )
416 return( ret );
417
Hanno Becker493ea7f2020-09-08 11:01:00 +0100418 keys->key_len = key_len;
419 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100420
421 return( 0 );
422}
423
Xiaofei Bai746f9482021-11-12 08:53:56 +0000424int mbedtls_ssl_tls13_derive_secret(
Hanno Beckerb35d5222020-08-21 13:27:44 +0100425 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000426 const unsigned char *secret, size_t secret_len,
427 const unsigned char *label, size_t label_len,
428 const unsigned char *ctx, size_t ctx_len,
Hanno Becker0c42fd92020-09-09 12:58:29 +0100429 int ctx_hashed,
Xiaofei Baib7972842021-11-18 07:29:56 +0000430 unsigned char *dstbuf, size_t dstbuf_len )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100431{
432 int ret;
433 unsigned char hashed_context[ MBEDTLS_MD_MAX_SIZE ];
434
Xiaofei Baib7972842021-11-18 07:29:56 +0000435 const mbedtls_md_info_t *md_info;
436 md_info = mbedtls_md_info_from_type( hash_alg );
437 if( md_info == NULL )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100438 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
439
Hanno Becker0c42fd92020-09-09 12:58:29 +0100440 if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100441 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000442 ret = mbedtls_md( md_info, ctx, ctx_len, hashed_context );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100443 if( ret != 0 )
444 return( ret );
Xiaofei Baib7972842021-11-18 07:29:56 +0000445 ctx_len = mbedtls_md_get_size( md_info );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100446 }
447 else
448 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000449 if( ctx_len > sizeof(hashed_context) )
Hanno Becker97a21562020-09-09 12:57:16 +0100450 {
451 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100452 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100453 * Let's double-check nonetheless to not run at the risk
454 * of getting a stack overflow. */
Hanno Beckerb35d5222020-08-21 13:27:44 +0100455 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Becker97a21562020-09-09 12:57:16 +0100456 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100457
Xiaofei Baib7972842021-11-18 07:29:56 +0000458 memcpy( hashed_context, ctx, ctx_len );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100459 }
460
Xiaofei Bai746f9482021-11-12 08:53:56 +0000461 return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000462 secret, secret_len,
463 label, label_len,
464 hashed_context, ctx_len,
465 dstbuf, dstbuf_len ) );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100466}
467
Xiaofei Bai746f9482021-11-12 08:53:56 +0000468int mbedtls_ssl_tls13_evolve_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100469 mbedtls_md_type_t hash_alg,
470 const unsigned char *secret_old,
471 const unsigned char *input, size_t input_len,
472 unsigned char *secret_new )
473{
474 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
475 size_t hlen, ilen;
Hanno Becker59b50a12020-09-09 10:56:56 +0100476 unsigned char tmp_secret[ MBEDTLS_MD_MAX_SIZE ] = { 0 };
Jerry Yu6eaa41c2021-11-22 18:16:45 +0800477 unsigned char tmp_input [ MBEDTLS_ECP_MAX_BYTES ] = { 0 };
Hanno Beckere9cccb42020-08-20 13:42:46 +0100478
Xiaofei Baib7972842021-11-18 07:29:56 +0000479 const mbedtls_md_info_t *md_info;
480 md_info = mbedtls_md_info_from_type( hash_alg );
481 if( md_info == NULL )
Hanno Beckere9cccb42020-08-20 13:42:46 +0100482 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
483
Xiaofei Baib7972842021-11-18 07:29:56 +0000484 hlen = mbedtls_md_get_size( md_info );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100485
486 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100487 * on the old secret. */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100488 if( secret_old != NULL )
489 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000490 ret = mbedtls_ssl_tls13_derive_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100491 hash_alg,
492 secret_old, hlen,
493 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ),
494 NULL, 0, /* context */
495 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Hanno Becker59b50a12020-09-09 10:56:56 +0100496 tmp_secret, hlen );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100497 if( ret != 0 )
498 goto cleanup;
499 }
500
501 if( input != NULL )
502 {
Hanno Becker59b50a12020-09-09 10:56:56 +0100503 memcpy( tmp_input, input, input_len );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100504 ilen = input_len;
505 }
506 else
507 {
508 ilen = hlen;
509 }
510
511 /* HKDF-Extract takes a salt and input key material.
512 * The salt is the old secret, and the input key material
513 * is the input secret (PSK / ECDHE). */
Xiaofei Baib7972842021-11-18 07:29:56 +0000514 ret = mbedtls_hkdf_extract( md_info,
Hanno Becker59b50a12020-09-09 10:56:56 +0100515 tmp_secret, hlen,
516 tmp_input, ilen,
Hanno Beckere9cccb42020-08-20 13:42:46 +0100517 secret_new );
518 if( ret != 0 )
519 goto cleanup;
520
521 ret = 0;
522
523 cleanup:
524
Hanno Becker59b50a12020-09-09 10:56:56 +0100525 mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) );
526 mbedtls_platform_zeroize( tmp_input, sizeof(tmp_input) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100527 return( ret );
528}
529
Xiaofei Bai746f9482021-11-12 08:53:56 +0000530int mbedtls_ssl_tls13_derive_early_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100531 mbedtls_md_type_t md_type,
532 unsigned char const *early_secret,
533 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000534 mbedtls_ssl_tls13_early_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100535{
536 int ret;
537 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
538 size_t const md_size = mbedtls_md_get_size( md_info );
539
540 /* We should never call this function with an unknown hash,
541 * but add an assertion anyway. */
542 if( md_info == 0 )
543 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
544
545 /*
546 * 0
547 * |
548 * v
549 * PSK -> HKDF-Extract = Early Secret
550 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100551 * +-----> Derive-Secret(., "c e traffic", ClientHello)
552 * | = client_early_traffic_secret
553 * |
554 * +-----> Derive-Secret(., "e exp master", ClientHello)
555 * | = early_exporter_master_secret
556 * v
557 */
558
559 /* Create client_early_traffic_secret */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000560 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100561 early_secret, md_size,
562 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ),
563 transcript, transcript_len,
564 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
565 derived->client_early_traffic_secret,
566 md_size );
567 if( ret != 0 )
568 return( ret );
569
570 /* Create early exporter */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000571 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100572 early_secret, md_size,
573 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ),
574 transcript, transcript_len,
575 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
576 derived->early_exporter_master_secret,
577 md_size );
578 if( ret != 0 )
579 return( ret );
580
581 return( 0 );
582}
583
Xiaofei Bai746f9482021-11-12 08:53:56 +0000584int mbedtls_ssl_tls13_derive_handshake_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100585 mbedtls_md_type_t md_type,
586 unsigned char const *handshake_secret,
587 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000588 mbedtls_ssl_tls13_handshake_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100589{
590 int ret;
591 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
592 size_t const md_size = mbedtls_md_get_size( md_info );
593
594 /* We should never call this function with an unknown hash,
595 * but add an assertion anyway. */
596 if( md_info == 0 )
597 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
598
599 /*
600 *
601 * Handshake Secret
602 * |
603 * +-----> Derive-Secret( ., "c hs traffic",
604 * | ClientHello...ServerHello )
605 * | = client_handshake_traffic_secret
606 * |
607 * +-----> Derive-Secret( ., "s hs traffic",
608 * | ClientHello...ServerHello )
609 * | = server_handshake_traffic_secret
610 *
611 */
612
613 /*
614 * Compute client_handshake_traffic_secret with
615 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
616 */
617
Xiaofei Bai746f9482021-11-12 08:53:56 +0000618 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100619 handshake_secret, md_size,
620 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ),
621 transcript, transcript_len,
622 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
623 derived->client_handshake_traffic_secret,
624 md_size );
625 if( ret != 0 )
626 return( ret );
627
628 /*
629 * Compute server_handshake_traffic_secret with
630 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
631 */
632
Xiaofei Bai746f9482021-11-12 08:53:56 +0000633 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100634 handshake_secret, md_size,
635 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ),
636 transcript, transcript_len,
637 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
638 derived->server_handshake_traffic_secret,
639 md_size );
640 if( ret != 0 )
641 return( ret );
642
643 return( 0 );
644}
645
Xiaofei Bai746f9482021-11-12 08:53:56 +0000646int mbedtls_ssl_tls13_derive_application_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100647 mbedtls_md_type_t md_type,
648 unsigned char const *application_secret,
649 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000650 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100651{
652 int ret;
653 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
654 size_t const md_size = mbedtls_md_get_size( md_info );
655
656 /* We should never call this function with an unknown hash,
657 * but add an assertion anyway. */
658 if( md_info == 0 )
659 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
660
661 /* Generate {client,server}_application_traffic_secret_0
662 *
663 * Master Secret
664 * |
665 * +-----> Derive-Secret( ., "c ap traffic",
666 * | ClientHello...server Finished )
667 * | = client_application_traffic_secret_0
668 * |
669 * +-----> Derive-Secret( ., "s ap traffic",
670 * | ClientHello...Server Finished )
671 * | = server_application_traffic_secret_0
672 * |
673 * +-----> Derive-Secret( ., "exp master",
674 * | ClientHello...server Finished)
675 * | = exporter_master_secret
676 *
677 */
678
Xiaofei Bai746f9482021-11-12 08:53:56 +0000679 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100680 application_secret, md_size,
681 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ),
682 transcript, transcript_len,
683 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
684 derived->client_application_traffic_secret_N,
685 md_size );
686 if( ret != 0 )
687 return( ret );
688
Xiaofei Bai746f9482021-11-12 08:53:56 +0000689 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100690 application_secret, md_size,
691 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ),
692 transcript, transcript_len,
693 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
694 derived->server_application_traffic_secret_N,
695 md_size );
696 if( ret != 0 )
697 return( ret );
698
Xiaofei Bai746f9482021-11-12 08:53:56 +0000699 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100700 application_secret, md_size,
701 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ),
702 transcript, transcript_len,
703 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
704 derived->exporter_master_secret,
705 md_size );
706 if( ret != 0 )
707 return( ret );
708
709 return( 0 );
710}
711
712/* Generate resumption_master_secret for use with the ticket exchange.
713 *
Xiaofei Bai746f9482021-11-12 08:53:56 +0000714 * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets()
Hanno Beckeref5235b2021-05-24 06:39:41 +0100715 * because it uses the transcript hash up to and including ClientFinished. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000716int mbedtls_ssl_tls13_derive_resumption_master_secret(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100717 mbedtls_md_type_t md_type,
718 unsigned char const *application_secret,
719 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000720 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100721{
722 int ret;
723 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
724 size_t const md_size = mbedtls_md_get_size( md_info );
725
726 /* We should never call this function with an unknown hash,
727 * but add an assertion anyway. */
728 if( md_info == 0 )
729 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
730
Xiaofei Bai746f9482021-11-12 08:53:56 +0000731 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100732 application_secret, md_size,
733 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ),
734 transcript, transcript_len,
735 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
736 derived->resumption_master_secret,
737 md_size );
738
739 if( ret != 0 )
740 return( ret );
741
742 return( 0 );
743}
744
XiaokangQiana4c99f22021-11-11 06:46:35 +0000745int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000746{
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000747 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +0000748 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
749 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000750#if defined(MBEDTLS_DEBUG_C)
751 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
752 size_t const md_size = mbedtls_md_get_size( md_info );
753#endif /* MBEDTLS_DEBUG_C */
754
755 /*
756 * Compute MasterSecret
757 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000758 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000759 handshake->tls13_master_secrets.handshake,
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000760 NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000761 handshake->tls13_master_secrets.app );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000762 if( ret != 0 )
763 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000764 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000765 return( ret );
766 }
767
768 MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +0000769 handshake->tls13_master_secrets.app, md_size );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000770
771 return( 0 );
772}
773
Xiaofei Bai746f9482021-11-12 08:53:56 +0000774static int ssl_tls13_calc_finished_core( mbedtls_md_type_t md_type,
775 unsigned char const *base_key,
776 unsigned char const *transcript,
777 unsigned char *dst )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100778{
779 const mbedtls_md_info_t* const md_info = mbedtls_md_info_from_type( md_type );
780 size_t const md_size = mbedtls_md_get_size( md_info );
781 unsigned char finished_key[MBEDTLS_MD_MAX_SIZE];
782 int ret;
783
784 /* We should never call this function with an unknown hash,
785 * but add an assertion anyway. */
786 if( md_info == 0 )
787 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
788
789 /* TLS 1.3 Finished message
790 *
791 * struct {
792 * opaque verify_data[Hash.length];
793 * } Finished;
794 *
795 * verify_data =
796 * HMAC( finished_key,
797 * Hash( Handshake Context +
798 * Certificate* +
799 * CertificateVerify* )
800 * )
801 *
802 * finished_key =
803 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
804 */
805
Xiaofei Bai746f9482021-11-12 08:53:56 +0000806 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100807 md_type, base_key, md_size,
808 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ),
809 NULL, 0,
810 finished_key, md_size );
811 if( ret != 0 )
812 goto exit;
813
814 ret = mbedtls_md_hmac( md_info, finished_key, md_size, transcript, md_size, dst );
815 if( ret != 0 )
816 goto exit;
817
818exit:
819
820 mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) );
821 return( ret );
822}
823
XiaokangQianc5c39d52021-11-09 11:55:10 +0000824int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl,
XiaokangQianaaa0e192021-11-10 03:07:04 +0000825 unsigned char* dst,
826 size_t dst_len,
827 size_t *actual_len,
828 int from )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000829{
XiaokangQiana7634982021-10-22 06:32:32 +0000830 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000831
XiaokangQianaaa0e192021-11-10 03:07:04 +0000832 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000833 size_t transcript_len;
834
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800835 unsigned char *base_key = NULL;
Jerry Yub737f6a2021-12-10 17:55:23 +0800836 size_t base_key_len = 0;
Jerry Yu9c074732021-12-10 17:12:43 +0800837 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets =
838 &ssl->handshake->tls13_hs_secrets;
Jerry Yua5563f62021-12-10 18:14:36 +0800839
840 mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac;
841 const mbedtls_md_info_t* const md_info =
842 mbedtls_md_info_from_type( md_type );
843 size_t const md_size = mbedtls_md_get_size( md_info );
844
845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) );
846
Jerry Yub737f6a2021-12-10 17:55:23 +0800847 if( from == MBEDTLS_SSL_IS_CLIENT )
848 {
849 base_key = tls13_hs_secrets->client_handshake_traffic_secret;
850 base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret );
851 }
852 else
853 {
854 base_key = tls13_hs_secrets->server_handshake_traffic_secret;
855 base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret );
856 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000857
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000858 if( dst_len < md_size )
Jerry Yu9c074732021-12-10 17:12:43 +0800859 {
860 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
861 goto exit;
862 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000863
864 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
865 transcript, sizeof( transcript ),
866 &transcript_len );
867 if( ret != 0 )
868 {
869 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000870 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000871 }
872 MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len );
873
Xiaofei Bai746f9482021-11-12 08:53:56 +0000874 ret = ssl_tls13_calc_finished_core( md_type, base_key, transcript, dst );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000875 if( ret != 0 )
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000876 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000877 *actual_len = md_size;
878
879 MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, md_size );
XiaokangQianc5c39d52021-11-09 11:55:10 +0000880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000881
882exit:
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800883 /* Erase handshake secrets */
Jerry Yub737f6a2021-12-10 17:55:23 +0800884 mbedtls_platform_zeroize( base_key, base_key_len );
XiaokangQian33062842021-11-11 03:37:45 +0000885 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000886 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000887}
888
Xiaofei Bai746f9482021-11-12 08:53:56 +0000889int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100890 const mbedtls_md_type_t md_type,
891 unsigned char const *psk, size_t psk_len,
892 int psk_type,
893 unsigned char const *transcript,
894 unsigned char *result )
895{
896 int ret = 0;
897 unsigned char binder_key[MBEDTLS_MD_MAX_SIZE];
898 unsigned char early_secret[MBEDTLS_MD_MAX_SIZE];
899 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type( md_type );
900 size_t const md_size = mbedtls_md_get_size( md_info );
901
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100902#if !defined(MBEDTLS_DEBUG_C)
903 ssl = NULL; /* make sure we don't use it except for debug */
904 ((void) ssl);
905#endif
906
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100907 /* We should never call this function with an unknown hash,
908 * but add an assertion anyway. */
909 if( md_info == 0 )
910 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
911
912 /*
913 * 0
914 * |
915 * v
916 * PSK -> HKDF-Extract = Early Secret
917 * |
918 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
919 * | = binder_key
920 * v
921 */
922
Xiaofei Bai746f9482021-11-12 08:53:56 +0000923 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
924 NULL, /* Old secret */
925 psk, psk_len, /* Input */
926 early_secret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100927 if( ret != 0 )
928 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000929 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100930 goto exit;
931 }
932
933 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
934 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000935 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100936 early_secret, md_size,
937 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ),
938 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
939 binder_key, md_size );
940 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) );
941 }
942 else
943 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000944 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100945 early_secret, md_size,
946 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ),
947 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
948 binder_key, md_size );
949 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) );
950 }
951
952 if( ret != 0 )
953 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000954 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100955 goto exit;
956 }
957
958 /*
959 * The binding_value is computed in the same way as the Finished message
960 * but with the BaseKey being the binder_key.
961 */
962
Xiaofei Bai746f9482021-11-12 08:53:56 +0000963 ret = ssl_tls13_calc_finished_core( md_type, binder_key, transcript, result );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100964 if( ret != 0 )
965 goto exit;
966
967 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, md_size );
968
969exit:
970
971 mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) );
972 mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) );
973 return( ret );
974}
975
Hanno Beckerc94060c2021-03-22 07:50:44 +0000976int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform,
977 int endpoint,
978 int ciphersuite,
979 mbedtls_ssl_key_set const *traffic_keys,
980 mbedtls_ssl_context *ssl /* DEBUG ONLY */ )
981{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100982#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000983 int ret;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100984#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000985 mbedtls_cipher_info_t const *cipher_info;
986 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
987 unsigned char const *key_enc;
988 unsigned char const *iv_enc;
989 unsigned char const *key_dec;
990 unsigned char const *iv_dec;
991
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100992#if defined(MBEDTLS_USE_PSA_CRYPTO)
993 psa_key_type_t key_type;
994 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
995 psa_algorithm_t alg;
996 size_t key_bits;
997 psa_status_t status = PSA_SUCCESS;
998#endif
999
Hanno Beckerc94060c2021-03-22 07:50:44 +00001000#if !defined(MBEDTLS_DEBUG_C)
1001 ssl = NULL; /* make sure we don't use it except for those cases */
1002 (void) ssl;
1003#endif
1004
1005 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Hanno Becker7887a772021-04-20 05:27:57 +01001006 if( ciphersuite_info == NULL )
1007 {
1008 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
1009 ciphersuite ) );
1010 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1011 }
Hanno Beckerc94060c2021-03-22 07:50:44 +00001012
1013 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
1014 if( cipher_info == NULL )
1015 {
Hanno Becker7887a772021-04-20 05:27:57 +01001016 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
1017 ciphersuite_info->cipher ) );
Hanno Beckerf62a7302021-04-21 05:21:28 +01001018 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Beckerc94060c2021-03-22 07:50:44 +00001019 }
1020
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001021#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001022 /*
1023 * Setup cipher contexts in target transform
1024 */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001025 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
1026 cipher_info ) ) != 0 )
1027 {
1028 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
1029 return( ret );
1030 }
1031
1032 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
1033 cipher_info ) ) != 0 )
1034 {
1035 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
1036 return( ret );
1037 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001038#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001039
1040#if defined(MBEDTLS_SSL_SRV_C)
1041 if( endpoint == MBEDTLS_SSL_IS_SERVER )
1042 {
1043 key_enc = traffic_keys->server_write_key;
1044 key_dec = traffic_keys->client_write_key;
1045 iv_enc = traffic_keys->server_write_iv;
1046 iv_dec = traffic_keys->client_write_iv;
1047 }
1048 else
1049#endif /* MBEDTLS_SSL_SRV_C */
1050#if defined(MBEDTLS_SSL_CLI_C)
1051 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
1052 {
1053 key_enc = traffic_keys->client_write_key;
1054 key_dec = traffic_keys->server_write_key;
1055 iv_enc = traffic_keys->client_write_iv;
1056 iv_dec = traffic_keys->server_write_iv;
1057 }
1058 else
1059#endif /* MBEDTLS_SSL_CLI_C */
1060 {
1061 /* should not happen */
1062 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1063 }
1064
1065 memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len );
1066 memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len );
1067
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001068#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001069 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc,
1070 key_enc, cipher_info->key_bitlen,
1071 MBEDTLS_ENCRYPT ) ) != 0 )
1072 {
1073 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1074 return( ret );
1075 }
1076
1077 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec,
1078 key_dec, cipher_info->key_bitlen,
1079 MBEDTLS_DECRYPT ) ) != 0 )
1080 {
1081 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1082 return( ret );
1083 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001084#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001085
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +01001086 /*
1087 * Setup other fields in SSL transform
1088 */
1089
1090 if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 )
1091 transform->taglen = 8;
1092 else
1093 transform->taglen = 16;
1094
1095 transform->ivlen = traffic_keys->iv_len;
1096 transform->maclen = 0;
1097 transform->fixed_ivlen = transform->ivlen;
1098 transform->minor_ver = MBEDTLS_SSL_MINOR_VERSION_4;
1099
1100 /* We add the true record content type (1 Byte) to the plaintext and
1101 * then pad to the configured granularity. The mimimum length of the
1102 * type-extended and padded plaintext is therefore the padding
1103 * granularity. */
1104 transform->minlen =
1105 transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY;
1106
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001107#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001108 /*
1109 * Setup psa keys and alg
1110 */
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001111 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001112 transform->taglen,
1113 &alg,
1114 &key_type,
1115 &key_bits ) ) != PSA_SUCCESS )
1116 {
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001117 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", psa_ssl_status_to_mbedtls( status ) );
1118 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001119 }
1120
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001121 transform->psa_alg = alg;
1122
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001123 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001124 {
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001125 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
1126 psa_set_key_algorithm( &attributes, alg );
1127 psa_set_key_type( &attributes, key_type );
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001128
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001129 if( ( status = psa_import_key( &attributes,
1130 key_enc,
1131 PSA_BITS_TO_BYTES( key_bits ),
1132 &transform->psa_key_enc ) ) != PSA_SUCCESS )
1133 {
1134 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1135 return( psa_ssl_status_to_mbedtls( status ) );
1136 }
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001137
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001138 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
1139
1140 if( ( status = psa_import_key( &attributes,
1141 key_dec,
1142 PSA_BITS_TO_BYTES( key_bits ),
1143 &transform->psa_key_dec ) ) != PSA_SUCCESS )
1144 {
1145 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1146 return( psa_ssl_status_to_mbedtls( status ) );
1147 }
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001148 }
1149#endif /* MBEDTLS_USE_PSA_CRYPTO */
1150
Hanno Beckerc94060c2021-03-22 07:50:44 +00001151 return( 0 );
1152}
1153
Xiaofei Bai746f9482021-11-12 08:53:56 +00001154int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl )
Jerry Yu89ea3212021-09-09 14:31:24 +08001155{
Jerry Yue3131ef2021-09-16 13:14:15 +08001156 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1157 mbedtls_md_type_t md_type;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001158 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu6ca7c7f2021-09-28 18:51:40 +08001159
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001160 if( handshake->ciphersuite_info == NULL )
Jerry Yu89ea3212021-09-09 14:31:24 +08001161 {
1162 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) );
1163 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1164 }
Jerry Yue3131ef2021-09-16 13:14:15 +08001165
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001166 md_type = handshake->ciphersuite_info->mac;
Jerry Yue06f4532021-09-23 18:35:07 +08001167
Xiaofei Bai746f9482021-11-12 08:53:56 +00001168 ret = mbedtls_ssl_tls13_evolve_secret( md_type, NULL, NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001169 handshake->tls13_master_secrets.early );
Jerry Yu89ea3212021-09-09 14:31:24 +08001170 if( ret != 0 )
1171 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001172 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yu89ea3212021-09-09 14:31:24 +08001173 return( ret );
1174 }
1175
1176 return( 0 );
1177}
1178
Jerry Yuc068b662021-10-11 22:30:19 +08001179/* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for
Jerry Yu61e35e02021-09-16 18:59:08 +08001180 * protecting the handshake messages, as described in Section 7 of TLS 1.3. */
Jerry Yuc068b662021-10-11 22:30:19 +08001181int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl,
1182 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu61e35e02021-09-16 18:59:08 +08001183{
1184 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1185
1186 mbedtls_md_type_t md_type;
1187 mbedtls_md_info_t const *md_info;
1188 size_t md_size;
1189
Jerry Yu435208a2021-10-13 11:22:16 +08001190 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu61e35e02021-09-16 18:59:08 +08001191 size_t transcript_len;
1192
1193 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001194 size_t key_len, iv_len;
Jerry Yu61e35e02021-09-16 18:59:08 +08001195
Jerry Yu435208a2021-10-13 11:22:16 +08001196 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1197 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
Xiaofei Bai746f9482021-11-12 08:53:56 +00001198 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets;
Jerry Yu435208a2021-10-13 11:22:16 +08001199
Jerry Yuc068b662021-10-11 22:30:19 +08001200 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001201
Jerry Yu435208a2021-10-13 11:22:16 +08001202 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001203 key_len = cipher_info->key_bitlen >> 3;
1204 iv_len = cipher_info->iv_size;
Jerry Yu61e35e02021-09-16 18:59:08 +08001205
Jerry Yu435208a2021-10-13 11:22:16 +08001206 md_type = ciphersuite_info->mac;
Jerry Yu61e35e02021-09-16 18:59:08 +08001207 md_info = mbedtls_md_info_from_type( md_type );
1208 md_size = mbedtls_md_get_size( md_info );
1209
1210 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1211 transcript,
1212 sizeof( transcript ),
1213 &transcript_len );
1214 if( ret != 0 )
1215 {
1216 MBEDTLS_SSL_DEBUG_RET( 1,
1217 "mbedtls_ssl_get_handshake_transcript",
1218 ret );
1219 return( ret );
1220 }
1221
Xiaofei Bai746f9482021-11-12 08:53:56 +00001222 ret = mbedtls_ssl_tls13_derive_handshake_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001223 handshake->tls13_master_secrets.handshake,
Jerry Yu435208a2021-10-13 11:22:16 +08001224 transcript, transcript_len, tls13_hs_secrets );
Jerry Yu61e35e02021-09-16 18:59:08 +08001225 if( ret != 0 )
1226 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001227 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets",
Jerry Yu61e35e02021-09-16 18:59:08 +08001228 ret );
1229 return( ret );
1230 }
1231
1232 MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001233 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001234 md_size );
Jerry Yu61e35e02021-09-16 18:59:08 +08001235 MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001236 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001237 md_size );
1238
1239 /*
1240 * Export client handshake traffic secret
1241 */
Jerry Yu61e35e02021-09-16 18:59:08 +08001242 if( ssl->f_export_keys != NULL )
1243 {
1244 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001245 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001246 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001247 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001248 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001249 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001250 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1251
1252 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001253 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001254 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001255 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001256 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001257 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001258 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1259 }
Jerry Yu61e35e02021-09-16 18:59:08 +08001260
Xiaofei Bai746f9482021-11-12 08:53:56 +00001261 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
Jerry Yu435208a2021-10-13 11:22:16 +08001262 tls13_hs_secrets->client_handshake_traffic_secret,
1263 tls13_hs_secrets->server_handshake_traffic_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +00001264 md_size, key_len, iv_len, traffic_keys );
Jerry Yu61e35e02021-09-16 18:59:08 +08001265 if( ret != 0 )
1266 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001267 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
Jerry Yu61e35e02021-09-16 18:59:08 +08001268 goto exit;
1269 }
1270
1271 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key",
1272 traffic_keys->client_write_key,
1273 traffic_keys->key_len);
1274
1275 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key",
1276 traffic_keys->server_write_key,
1277 traffic_keys->key_len);
1278
1279 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv",
1280 traffic_keys->client_write_iv,
1281 traffic_keys->iv_len);
1282
1283 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv",
1284 traffic_keys->server_write_iv,
1285 traffic_keys->iv_len);
1286
Jerry Yuc068b662021-10-11 22:30:19 +08001287 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001288
1289exit:
1290
1291 return( ret );
1292}
1293
Jerry Yuf0ac2352021-10-11 17:47:07 +08001294int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl )
Jerry Yua0650eb2021-09-09 17:14:45 +08001295{
Jerry Yuf0ac2352021-10-11 17:47:07 +08001296 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001297 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1298 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
Jerry Yuf0ac2352021-10-11 17:47:07 +08001299 size_t ephemeral_len = 0;
1300 unsigned char ecdhe[MBEDTLS_ECP_MAX_BYTES];
Jerry Yua0650eb2021-09-09 17:14:45 +08001301#if defined(MBEDTLS_DEBUG_C)
1302 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
1303 size_t const md_size = mbedtls_md_get_size( md_info );
1304#endif /* MBEDTLS_DEBUG_C */
1305
Jerry Yuf0ac2352021-10-11 17:47:07 +08001306#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1307 /*
1308 * Compute ECDHE secret used to compute the handshake secret from which
1309 * client_handshake_traffic_secret and server_handshake_traffic_secret
1310 * are derived in the handshake secret derivation stage.
1311 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001312 if( mbedtls_ssl_tls13_ephemeral_enabled( ssl ) )
Jerry Yuf0ac2352021-10-11 17:47:07 +08001313 {
1314 if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) )
1315 {
1316#if defined(MBEDTLS_ECDH_C)
1317 ret = mbedtls_ecdh_calc_secret( &handshake->ecdh_ctx,
1318 &ephemeral_len, ecdhe, sizeof( ecdhe ),
1319 ssl->conf->f_rng,
1320 ssl->conf->p_rng );
1321 if( ret != 0 )
1322 {
1323 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
1324 return( ret );
1325 }
1326#endif /* MBEDTLS_ECDH_C */
1327 }
1328 else if( mbedtls_ssl_tls13_named_group_is_dhe( handshake->offered_group_id ) )
1329 {
Jerry Yuf0ac2352021-10-11 17:47:07 +08001330 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DHE not supported." ) );
1331 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1332 }
1333 }
1334#else
1335 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1336#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
Jerry Yua0650eb2021-09-09 17:14:45 +08001337
1338 /*
Jerry Yuf0ac2352021-10-11 17:47:07 +08001339 * Compute the Handshake Secret
Jerry Yua0650eb2021-09-09 17:14:45 +08001340 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001341 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001342 handshake->tls13_master_secrets.early,
Xiaofei Baib7972842021-11-18 07:29:56 +00001343 ecdhe, ephemeral_len,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001344 handshake->tls13_master_secrets.handshake );
Jerry Yua0650eb2021-09-09 17:14:45 +08001345 if( ret != 0 )
1346 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001347 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yua0650eb2021-09-09 17:14:45 +08001348 return( ret );
1349 }
1350
1351 MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +00001352 handshake->tls13_master_secrets.handshake, md_size );
Jerry Yua0650eb2021-09-09 17:14:45 +08001353
1354#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1355 mbedtls_platform_zeroize( ecdhe, sizeof( ecdhe ) );
1356#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
1357 return( 0 );
1358}
1359
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001360/* Generate application traffic keys since any records following a 1-RTT Finished message
1361 * MUST be encrypted under the application traffic key.
1362 */
XiaokangQiand0aa3e92021-11-10 06:17:40 +00001363int mbedtls_ssl_tls13_generate_application_keys(
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001364 mbedtls_ssl_context *ssl,
1365 mbedtls_ssl_key_set *traffic_keys )
1366{
XiaokangQiana7634982021-10-22 06:32:32 +00001367 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +00001368 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001369
1370 /* Address at which to store the application secrets */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001371 mbedtls_ssl_tls13_application_secrets * const app_secrets =
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001372 &ssl->session_negotiate->app_secrets;
1373
1374 /* Holding the transcript up to and including the ServerFinished */
XiaokangQian33062842021-11-11 03:37:45 +00001375 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001376 size_t transcript_len;
1377
1378 /* Variables relating to the hash for the chosen ciphersuite. */
1379 mbedtls_md_type_t md_type;
1380 mbedtls_md_info_t const *md_info;
1381 size_t md_size;
1382
1383 /* Variables relating to the cipher for the chosen ciphersuite. */
1384 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001385 size_t key_len, iv_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001386
1387 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) );
1388
1389 /* Extract basic information about hash and ciphersuite */
1390
1391 cipher_info = mbedtls_cipher_info_from_type(
XiaokangQian33062842021-11-11 03:37:45 +00001392 handshake->ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001393 key_len = cipher_info->key_bitlen / 8;
1394 iv_len = cipher_info->iv_size;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001395
XiaokangQian33062842021-11-11 03:37:45 +00001396 md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001397 md_info = mbedtls_md_info_from_type( md_type );
1398 md_size = mbedtls_md_get_size( md_info );
1399
1400 /* Compute current handshake transcript. It's the caller's responsiblity
1401 * to call this at the right time, that is, after the ServerFinished. */
1402
1403 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1404 transcript, sizeof( transcript ),
1405 &transcript_len );
1406 if( ret != 0 )
XiaokangQian4cab0242021-10-12 08:43:37 +00001407 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001408
1409 /* Compute application secrets from master secret and transcript hash. */
1410
Xiaofei Bai746f9482021-11-12 08:53:56 +00001411 ret = mbedtls_ssl_tls13_derive_application_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001412 handshake->tls13_master_secrets.app,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001413 transcript, transcript_len,
1414 app_secrets );
Jerry Yu4a2fa5d2021-12-10 10:19:34 +08001415 /* Erase master secrets */
Jerry Yu23ab7a42021-12-08 14:34:10 +08001416 mbedtls_platform_zeroize( &ssl->handshake->tls13_master_secrets,
Jerry Yu27224f52021-12-09 10:56:50 +08001417 sizeof( ssl->handshake->tls13_master_secrets ) );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001418 if( ret != 0 )
1419 {
1420 MBEDTLS_SSL_DEBUG_RET( 1,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001421 "mbedtls_ssl_tls13_derive_application_secrets", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001422 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001423 }
1424
1425 /* Derive first epoch of IV + Key for application traffic. */
1426
Xiaofei Bai746f9482021-11-12 08:53:56 +00001427 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001428 app_secrets->client_application_traffic_secret_N,
1429 app_secrets->server_application_traffic_secret_N,
Xiaofei Baib7972842021-11-18 07:29:56 +00001430 md_size, key_len, iv_len, traffic_keys );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001431 if( ret != 0 )
1432 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001433 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001434 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001435 }
1436
1437 MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret",
1438 app_secrets->client_application_traffic_secret_N,
1439 md_size );
1440
1441 MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret",
1442 app_secrets->server_application_traffic_secret_N,
1443 md_size );
1444
XiaokangQianac0385c2021-11-03 06:40:11 +00001445 /*
1446 * Export client/server application traffic secret 0
1447 */
1448 if( ssl->f_export_keys != NULL )
1449 {
1450 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001451 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001452 app_secrets->client_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001453 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001454 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001455 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1456 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001457
1458 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001459 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001460 app_secrets->server_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001461 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001462 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001463 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1464 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001465 }
1466
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001467 MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:",
Xiaofei Baib7972842021-11-18 07:29:56 +00001468 traffic_keys->client_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001469 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key",
Xiaofei Baib7972842021-11-18 07:29:56 +00001470 traffic_keys->server_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001471 MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001472 traffic_keys->client_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001473 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001474 traffic_keys->server_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001475
1476 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001477
1478 cleanup:
Jerry Yu2c70a392021-12-08 13:28:49 +08001479 /* randbytes is not used again */
1480 mbedtls_platform_zeroize( ssl->handshake->randbytes,
1481 sizeof( ssl->handshake->randbytes ) );
XiaokangQian33062842021-11-11 03:37:45 +00001482 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001483 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001484}
1485
Ronald Cron6f135e12021-12-08 16:57:54 +01001486#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */