blob: d6a027a4cb1d633911f2c8b51153df3960263420 [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 Mezei58db6532022-03-21 12:12:37 +0100139#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gabor Mezei9607ab42022-02-09 17:00:32 +0100140
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 Mezei26c67412022-02-15 15:46:17 +0100151 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gabor Mezei0e7c6f42022-02-15 15:47:54 +0100152 psa_status_t destroy_status = PSA_ERROR_CORRUPTION_DETECTED;
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100153
154 if( salt == NULL || salt_len == 0 )
155 {
156 size_t hash_len;
157
158 if( salt_len != 0 )
159 {
Gabor Mezeic5efb8e2022-02-08 13:15:45 +0100160 return( PSA_ERROR_INVALID_ARGUMENT );
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100161 }
162
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100163 hash_len = PSA_HASH_LENGTH( alg );
164
165 if( hash_len == 0 )
166 {
Gabor Mezeic5efb8e2022-02-08 13:15:45 +0100167 return( PSA_ERROR_INVALID_ARGUMENT );
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100168 }
169
Gabor Mezeid860e0f2022-02-15 16:02:59 +0100170 /* salt_len <= sizeof( salt ) because
171 PSA_HASH_LENGTH( alg ) <= PSA_MAC_MAX_SIZE. */
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100172 salt = null_salt;
173 salt_len = hash_len;
174 }
175
176 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
177 psa_set_key_algorithm( &attributes, alg );
178 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
179
Gabor Mezei26c67412022-02-15 15:46:17 +0100180 status = psa_import_key( &attributes, salt, salt_len, &key );
181 if( status != PSA_SUCCESS )
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100182 {
183 goto cleanup;
184 }
185
Gabor Mezei26c67412022-02-15 15:46:17 +0100186 status = psa_mac_compute( key, alg, ikm, ikm_len, prk, prk_size, prk_len );
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100187
188cleanup:
Gabor Mezei0e7c6f42022-02-15 15:47:54 +0100189 destroy_status = psa_destroy_key( key );
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100190
Gabor Mezei0e7c6f42022-02-15 15:47:54 +0100191 return( ( status == PSA_SUCCESS ) ? destroy_status : status );
Gabor Mezei9f4bb312022-01-31 16:33:47 +0100192}
193
194MBEDTLS_STATIC_TESTABLE
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100195psa_status_t mbedtls_psa_hkdf_expand( psa_algorithm_t alg,
196 const unsigned char *prk, size_t prk_len,
197 const unsigned char *info, size_t info_len,
198 unsigned char *okm, size_t okm_len )
199{
200 size_t hash_len;
201 size_t where = 0;
202 size_t n;
203 size_t t_len = 0;
204 size_t i;
205 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
206 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
207 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gabor Mezei833713c2022-02-15 16:16:08 +0100208 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100209 psa_status_t destroy_status = PSA_ERROR_CORRUPTION_DETECTED;
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100210 unsigned char t[PSA_MAC_MAX_SIZE];
211
212 if( okm == NULL )
213 {
214 return( PSA_ERROR_INVALID_ARGUMENT );
215 }
216
217 hash_len = PSA_HASH_LENGTH( alg );
218
219 if( prk_len < hash_len || hash_len == 0 )
220 {
221 return( PSA_ERROR_INVALID_ARGUMENT );
222 }
223
224 if( info == NULL )
225 {
226 info = (const unsigned char *) "";
227 info_len = 0;
228 }
229
230 n = okm_len / hash_len;
231
232 if( okm_len % hash_len != 0 )
233 {
234 n++;
235 }
236
237 /*
238 * Per RFC 5869 Section 2.3, okm_len must not exceed
239 * 255 times the hash length
240 */
241 if( n > 255 )
242 {
243 return( PSA_ERROR_INVALID_ARGUMENT );
244 }
245
246 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
247 psa_set_key_algorithm( &attributes, alg );
248 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
249
Gabor Mezei833713c2022-02-15 16:16:08 +0100250 status = psa_import_key( &attributes, prk, prk_len, &key );
251 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100252 {
253 goto cleanup;
254 }
255
256 memset( t, 0, hash_len );
257
258 /*
259 * Compute T = T(1) | T(2) | T(3) | ... | T(N)
260 * Where T(N) is defined in RFC 5869 Section 2.3
261 */
262 for( i = 1; i <= n; i++ )
263 {
264 size_t num_to_copy;
265 unsigned char c = i & 0xff;
266 size_t len;
267
Gabor Mezei833713c2022-02-15 16:16:08 +0100268 status = psa_mac_sign_setup( &operation, key, alg );
269 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100270 {
271 goto cleanup;
272 }
273
Gabor Mezei833713c2022-02-15 16:16:08 +0100274 status = psa_mac_update( &operation, t, t_len );
275 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100276 {
277 goto cleanup;
278 }
279
Gabor Mezei833713c2022-02-15 16:16:08 +0100280 status = psa_mac_update( &operation, info, info_len );
281 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100282 {
283 goto cleanup;
284 }
285
Gabor Mezei8e360252022-02-17 11:50:02 +0100286 /* The constant concatenated to the end of each T(n) is a single octet. */
Gabor Mezei833713c2022-02-15 16:16:08 +0100287 status = psa_mac_update( &operation, &c, 1 );
288 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100289 {
290 goto cleanup;
291 }
292
Gabor Mezei833713c2022-02-15 16:16:08 +0100293 status = psa_mac_sign_finish( &operation, t, PSA_MAC_MAX_SIZE, &len );
294 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100295 {
296 goto cleanup;
297 }
298
299 num_to_copy = i != n ? hash_len : okm_len - where;
300 memcpy( okm + where, t, num_to_copy );
301 where += hash_len;
302 t_len = hash_len;
303 }
304
305cleanup:
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100306 if( status != PSA_SUCCESS )
307 psa_mac_abort( &operation );
308 destroy_status = psa_destroy_key( key );
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100309
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100310 mbedtls_platform_zeroize( t, sizeof( t ) );
311
312 return( ( status == PSA_SUCCESS ) ? destroy_status : status );
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100313}
314
Gabor Mezei58db6532022-03-21 12:12:37 +0100315#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gabor Mezei9607ab42022-02-09 17:00:32 +0100316
Xiaofei Bai746f9482021-11-12 08:53:56 +0000317int mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100318 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000319 const unsigned char *secret, size_t secret_len,
320 const unsigned char *label, size_t label_len,
321 const unsigned char *ctx, size_t ctx_len,
322 unsigned char *buf, size_t buf_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100323{
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100324 unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ];
325 size_t hkdf_label_len;
326
Gabor Mezei58db6532022-03-21 12:12:37 +0100327#if defined(MBEDTLS_USE_PSA_CRYPTO)
328 psa_algorithm_t alg;
329#else
330 const mbedtls_md_info_t *md_info;
331#endif
332
Xiaofei Baib7972842021-11-18 07:29:56 +0000333 if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100334 {
335 /* Should never happen since this is an internal
336 * function, and we know statically which labels
337 * are allowed. */
338 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
339 }
340
Xiaofei Baib7972842021-11-18 07:29:56 +0000341 if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100342 {
343 /* Should not happen, as above. */
344 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
345 }
346
Xiaofei Baib7972842021-11-18 07:29:56 +0000347 if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100348 {
349 /* Should not happen, as above. */
350 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
351 }
352
Gabor Mezei58db6532022-03-21 12:12:37 +0100353#if defined(MBEDTLS_USE_PSA_CRYPTO)
354 alg = mbedtls_psa_translate_md( hash_alg );
355 if( ! PSA_ALG_IS_HASH( alg ) )
356 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
357
358 alg = PSA_ALG_HMAC( alg );
359#else
Xiaofei Baib7972842021-11-18 07:29:56 +0000360 md_info = mbedtls_md_info_from_type( hash_alg );
361 if( md_info == NULL )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100362 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Gabor Mezei58db6532022-03-21 12:12:37 +0100363#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100364
Xiaofei Baib7972842021-11-18 07:29:56 +0000365 ssl_tls13_hkdf_encode_label( buf_len,
366 label, label_len,
367 ctx, ctx_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000368 hkdf_label,
369 &hkdf_label_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100370
Gabor Mezei58db6532022-03-21 12:12:37 +0100371#if defined(MBEDTLS_USE_PSA_CRYPTO)
372 return( psa_ssl_status_to_mbedtls(
373 mbedtls_psa_hkdf_expand( alg,
374 secret, secret_len,
375 hkdf_label, hkdf_label_len,
376 buf, buf_len ) ) );
377#else
378 return mbedtls_hkdf_expand( md_info,
379 secret, secret_len,
380 hkdf_label, hkdf_label_len,
381 buf, buf_len );
382#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100383}
384
Hanno Becker3385a4d2020-08-21 13:03:34 +0100385/*
386 * The traffic keying material is generated from the following inputs:
387 *
388 * - One secret value per sender.
389 * - A purpose value indicating the specific value being generated
390 * - The desired lengths of key and IV.
391 *
392 * The expansion itself is based on HKDF:
393 *
394 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
395 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
396 *
397 * [sender] denotes the sending side and the Secret value is provided
398 * by the function caller. Note that we generate server and client side
399 * keys in a single function call.
400 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000401int mbedtls_ssl_tls13_make_traffic_keys(
Hanno Becker3385a4d2020-08-21 13:03:34 +0100402 mbedtls_md_type_t hash_alg,
403 const unsigned char *client_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +0000404 const unsigned char *server_secret, size_t secret_len,
405 size_t key_len, size_t iv_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100406 mbedtls_ssl_key_set *keys )
407{
408 int ret = 0;
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 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100412 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
413 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100414 keys->client_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100415 if( ret != 0 )
416 return( ret );
417
Xiaofei Bai746f9482021-11-12 08:53:56 +0000418 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000419 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100420 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
421 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100422 keys->server_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100423 if( ret != 0 )
424 return( ret );
425
Xiaofei Bai746f9482021-11-12 08:53:56 +0000426 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000427 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100428 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
429 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100430 keys->client_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100431 if( ret != 0 )
432 return( ret );
433
Xiaofei Bai746f9482021-11-12 08:53:56 +0000434 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000435 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100436 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
437 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100438 keys->server_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100439 if( ret != 0 )
440 return( ret );
441
Hanno Becker493ea7f2020-09-08 11:01:00 +0100442 keys->key_len = key_len;
443 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100444
445 return( 0 );
446}
447
Xiaofei Bai746f9482021-11-12 08:53:56 +0000448int mbedtls_ssl_tls13_derive_secret(
Hanno Beckerb35d5222020-08-21 13:27:44 +0100449 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000450 const unsigned char *secret, size_t secret_len,
451 const unsigned char *label, size_t label_len,
452 const unsigned char *ctx, size_t ctx_len,
Hanno Becker0c42fd92020-09-09 12:58:29 +0100453 int ctx_hashed,
Xiaofei Baib7972842021-11-18 07:29:56 +0000454 unsigned char *dstbuf, size_t dstbuf_len )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100455{
456 int ret;
457 unsigned char hashed_context[ MBEDTLS_MD_MAX_SIZE ];
458
Xiaofei Baib7972842021-11-18 07:29:56 +0000459 const mbedtls_md_info_t *md_info;
460 md_info = mbedtls_md_info_from_type( hash_alg );
461 if( md_info == NULL )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100462 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
463
Hanno Becker0c42fd92020-09-09 12:58:29 +0100464 if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100465 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000466 ret = mbedtls_md( md_info, ctx, ctx_len, hashed_context );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100467 if( ret != 0 )
468 return( ret );
Xiaofei Baib7972842021-11-18 07:29:56 +0000469 ctx_len = mbedtls_md_get_size( md_info );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100470 }
471 else
472 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000473 if( ctx_len > sizeof(hashed_context) )
Hanno Becker97a21562020-09-09 12:57:16 +0100474 {
475 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100476 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100477 * Let's double-check nonetheless to not run at the risk
478 * of getting a stack overflow. */
Hanno Beckerb35d5222020-08-21 13:27:44 +0100479 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Becker97a21562020-09-09 12:57:16 +0100480 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100481
Xiaofei Baib7972842021-11-18 07:29:56 +0000482 memcpy( hashed_context, ctx, ctx_len );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100483 }
484
Xiaofei Bai746f9482021-11-12 08:53:56 +0000485 return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000486 secret, secret_len,
487 label, label_len,
488 hashed_context, ctx_len,
489 dstbuf, dstbuf_len ) );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100490}
491
Xiaofei Bai746f9482021-11-12 08:53:56 +0000492int mbedtls_ssl_tls13_evolve_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100493 mbedtls_md_type_t hash_alg,
494 const unsigned char *secret_old,
495 const unsigned char *input, size_t input_len,
496 unsigned char *secret_new )
497{
498 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
499 size_t hlen, ilen;
Hanno Becker59b50a12020-09-09 10:56:56 +0100500 unsigned char tmp_secret[ MBEDTLS_MD_MAX_SIZE ] = { 0 };
Jerry Yu6eaa41c2021-11-22 18:16:45 +0800501 unsigned char tmp_input [ MBEDTLS_ECP_MAX_BYTES ] = { 0 };
Hanno Beckere9cccb42020-08-20 13:42:46 +0100502
Gabor Mezei58db6532022-03-21 12:12:37 +0100503#if defined(MBEDTLS_USE_PSA_CRYPTO)
504 size_t secret_len;
505 psa_algorithm_t alg = mbedtls_psa_translate_md( hash_alg );
506 if( ! PSA_ALG_IS_HASH( alg ) )
507 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
508
509 alg = PSA_ALG_HMAC( alg );
510 hlen = PSA_HASH_LENGTH( alg );
511#else
Xiaofei Baib7972842021-11-18 07:29:56 +0000512 const mbedtls_md_info_t *md_info;
513 md_info = mbedtls_md_info_from_type( hash_alg );
514 if( md_info == NULL )
Hanno Beckere9cccb42020-08-20 13:42:46 +0100515 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
516
Xiaofei Baib7972842021-11-18 07:29:56 +0000517 hlen = mbedtls_md_get_size( md_info );
Gabor Mezei58db6532022-03-21 12:12:37 +0100518#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100519
520 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100521 * on the old secret. */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100522 if( secret_old != NULL )
523 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000524 ret = mbedtls_ssl_tls13_derive_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100525 hash_alg,
526 secret_old, hlen,
527 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ),
528 NULL, 0, /* context */
529 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Hanno Becker59b50a12020-09-09 10:56:56 +0100530 tmp_secret, hlen );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100531 if( ret != 0 )
532 goto cleanup;
533 }
534
535 if( input != NULL )
536 {
Hanno Becker59b50a12020-09-09 10:56:56 +0100537 memcpy( tmp_input, input, input_len );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100538 ilen = input_len;
539 }
540 else
541 {
542 ilen = hlen;
543 }
544
545 /* HKDF-Extract takes a salt and input key material.
546 * The salt is the old secret, and the input key material
547 * is the input secret (PSK / ECDHE). */
Gabor Mezei58db6532022-03-21 12:12:37 +0100548#if defined(MBEDTLS_USE_PSA_CRYPTO)
549 ret = psa_ssl_status_to_mbedtls(
550 mbedtls_psa_hkdf_extract( alg,
551 tmp_secret, hlen,
552 tmp_input, ilen,
553 secret_new, hlen, &secret_len ) );
554#else
Xiaofei Baib7972842021-11-18 07:29:56 +0000555 ret = mbedtls_hkdf_extract( md_info,
Hanno Becker59b50a12020-09-09 10:56:56 +0100556 tmp_secret, hlen,
557 tmp_input, ilen,
Hanno Beckere9cccb42020-08-20 13:42:46 +0100558 secret_new );
Gabor Mezei58db6532022-03-21 12:12:37 +0100559#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100560
561 cleanup:
562
Hanno Becker59b50a12020-09-09 10:56:56 +0100563 mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) );
564 mbedtls_platform_zeroize( tmp_input, sizeof(tmp_input) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100565 return( ret );
566}
567
Xiaofei Bai746f9482021-11-12 08:53:56 +0000568int mbedtls_ssl_tls13_derive_early_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100569 mbedtls_md_type_t md_type,
570 unsigned char const *early_secret,
571 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000572 mbedtls_ssl_tls13_early_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100573{
574 int ret;
575 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
576 size_t const md_size = mbedtls_md_get_size( md_info );
577
578 /* We should never call this function with an unknown hash,
579 * but add an assertion anyway. */
580 if( md_info == 0 )
581 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
582
583 /*
584 * 0
585 * |
586 * v
587 * PSK -> HKDF-Extract = Early Secret
588 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100589 * +-----> Derive-Secret(., "c e traffic", ClientHello)
590 * | = client_early_traffic_secret
591 * |
592 * +-----> Derive-Secret(., "e exp master", ClientHello)
593 * | = early_exporter_master_secret
594 * v
595 */
596
597 /* Create client_early_traffic_secret */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000598 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100599 early_secret, md_size,
600 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ),
601 transcript, transcript_len,
602 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
603 derived->client_early_traffic_secret,
604 md_size );
605 if( ret != 0 )
606 return( ret );
607
608 /* Create early exporter */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000609 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100610 early_secret, md_size,
611 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ),
612 transcript, transcript_len,
613 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
614 derived->early_exporter_master_secret,
615 md_size );
616 if( ret != 0 )
617 return( ret );
618
619 return( 0 );
620}
621
Xiaofei Bai746f9482021-11-12 08:53:56 +0000622int mbedtls_ssl_tls13_derive_handshake_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100623 mbedtls_md_type_t md_type,
624 unsigned char const *handshake_secret,
625 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000626 mbedtls_ssl_tls13_handshake_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100627{
628 int ret;
629 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
630 size_t const md_size = mbedtls_md_get_size( md_info );
631
632 /* We should never call this function with an unknown hash,
633 * but add an assertion anyway. */
634 if( md_info == 0 )
635 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
636
637 /*
638 *
639 * Handshake Secret
640 * |
641 * +-----> Derive-Secret( ., "c hs traffic",
642 * | ClientHello...ServerHello )
643 * | = client_handshake_traffic_secret
644 * |
645 * +-----> Derive-Secret( ., "s hs traffic",
646 * | ClientHello...ServerHello )
647 * | = server_handshake_traffic_secret
648 *
649 */
650
651 /*
652 * Compute client_handshake_traffic_secret with
653 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
654 */
655
Xiaofei Bai746f9482021-11-12 08:53:56 +0000656 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100657 handshake_secret, md_size,
658 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ),
659 transcript, transcript_len,
660 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
661 derived->client_handshake_traffic_secret,
662 md_size );
663 if( ret != 0 )
664 return( ret );
665
666 /*
667 * Compute server_handshake_traffic_secret with
668 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
669 */
670
Xiaofei Bai746f9482021-11-12 08:53:56 +0000671 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100672 handshake_secret, md_size,
673 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ),
674 transcript, transcript_len,
675 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
676 derived->server_handshake_traffic_secret,
677 md_size );
678 if( ret != 0 )
679 return( ret );
680
681 return( 0 );
682}
683
Xiaofei Bai746f9482021-11-12 08:53:56 +0000684int mbedtls_ssl_tls13_derive_application_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100685 mbedtls_md_type_t md_type,
686 unsigned char const *application_secret,
687 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000688 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100689{
690 int ret;
691 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
692 size_t const md_size = mbedtls_md_get_size( md_info );
693
694 /* We should never call this function with an unknown hash,
695 * but add an assertion anyway. */
696 if( md_info == 0 )
697 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
698
699 /* Generate {client,server}_application_traffic_secret_0
700 *
701 * Master Secret
702 * |
703 * +-----> Derive-Secret( ., "c ap traffic",
704 * | ClientHello...server Finished )
705 * | = client_application_traffic_secret_0
706 * |
707 * +-----> Derive-Secret( ., "s ap traffic",
708 * | ClientHello...Server Finished )
709 * | = server_application_traffic_secret_0
710 * |
711 * +-----> Derive-Secret( ., "exp master",
712 * | ClientHello...server Finished)
713 * | = exporter_master_secret
714 *
715 */
716
Xiaofei Bai746f9482021-11-12 08:53:56 +0000717 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100718 application_secret, md_size,
719 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ),
720 transcript, transcript_len,
721 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
722 derived->client_application_traffic_secret_N,
723 md_size );
724 if( ret != 0 )
725 return( ret );
726
Xiaofei Bai746f9482021-11-12 08:53:56 +0000727 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100728 application_secret, md_size,
729 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ),
730 transcript, transcript_len,
731 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
732 derived->server_application_traffic_secret_N,
733 md_size );
734 if( ret != 0 )
735 return( ret );
736
Xiaofei Bai746f9482021-11-12 08:53:56 +0000737 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100738 application_secret, md_size,
739 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ),
740 transcript, transcript_len,
741 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
742 derived->exporter_master_secret,
743 md_size );
744 if( ret != 0 )
745 return( ret );
746
747 return( 0 );
748}
749
750/* Generate resumption_master_secret for use with the ticket exchange.
751 *
Xiaofei Bai746f9482021-11-12 08:53:56 +0000752 * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets()
Hanno Beckeref5235b2021-05-24 06:39:41 +0100753 * because it uses the transcript hash up to and including ClientFinished. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000754int mbedtls_ssl_tls13_derive_resumption_master_secret(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100755 mbedtls_md_type_t md_type,
756 unsigned char const *application_secret,
757 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000758 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100759{
760 int ret;
761 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
762 size_t const md_size = mbedtls_md_get_size( md_info );
763
764 /* We should never call this function with an unknown hash,
765 * but add an assertion anyway. */
766 if( md_info == 0 )
767 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
768
Xiaofei Bai746f9482021-11-12 08:53:56 +0000769 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100770 application_secret, md_size,
771 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ),
772 transcript, transcript_len,
773 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
774 derived->resumption_master_secret,
775 md_size );
776
777 if( ret != 0 )
778 return( ret );
779
780 return( 0 );
781}
782
XiaokangQiana4c99f22021-11-11 06:46:35 +0000783int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000784{
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000785 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +0000786 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
787 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000788#if defined(MBEDTLS_DEBUG_C)
789 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
790 size_t const md_size = mbedtls_md_get_size( md_info );
791#endif /* MBEDTLS_DEBUG_C */
792
793 /*
794 * Compute MasterSecret
795 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000796 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000797 handshake->tls13_master_secrets.handshake,
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000798 NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000799 handshake->tls13_master_secrets.app );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000800 if( ret != 0 )
801 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000802 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000803 return( ret );
804 }
805
806 MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +0000807 handshake->tls13_master_secrets.app, md_size );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000808
809 return( 0 );
810}
811
Xiaofei Bai746f9482021-11-12 08:53:56 +0000812static int ssl_tls13_calc_finished_core( mbedtls_md_type_t md_type,
813 unsigned char const *base_key,
814 unsigned char const *transcript,
815 unsigned char *dst )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100816{
817 const mbedtls_md_info_t* const md_info = mbedtls_md_info_from_type( md_type );
818 size_t const md_size = mbedtls_md_get_size( md_info );
819 unsigned char finished_key[MBEDTLS_MD_MAX_SIZE];
820 int ret;
821
822 /* We should never call this function with an unknown hash,
823 * but add an assertion anyway. */
824 if( md_info == 0 )
825 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
826
827 /* TLS 1.3 Finished message
828 *
829 * struct {
830 * opaque verify_data[Hash.length];
831 * } Finished;
832 *
833 * verify_data =
834 * HMAC( finished_key,
835 * Hash( Handshake Context +
836 * Certificate* +
837 * CertificateVerify* )
838 * )
839 *
840 * finished_key =
841 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
842 */
843
Xiaofei Bai746f9482021-11-12 08:53:56 +0000844 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100845 md_type, base_key, md_size,
846 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ),
847 NULL, 0,
848 finished_key, md_size );
849 if( ret != 0 )
850 goto exit;
851
852 ret = mbedtls_md_hmac( md_info, finished_key, md_size, transcript, md_size, dst );
853 if( ret != 0 )
854 goto exit;
855
856exit:
857
858 mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) );
859 return( ret );
860}
861
XiaokangQianc5c39d52021-11-09 11:55:10 +0000862int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl,
XiaokangQianaaa0e192021-11-10 03:07:04 +0000863 unsigned char* dst,
864 size_t dst_len,
865 size_t *actual_len,
866 int from )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000867{
XiaokangQiana7634982021-10-22 06:32:32 +0000868 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000869
XiaokangQianaaa0e192021-11-10 03:07:04 +0000870 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000871 size_t transcript_len;
872
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800873 unsigned char *base_key = NULL;
Jerry Yub737f6a2021-12-10 17:55:23 +0800874 size_t base_key_len = 0;
Jerry Yu9c074732021-12-10 17:12:43 +0800875 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets =
876 &ssl->handshake->tls13_hs_secrets;
Jerry Yua5563f62021-12-10 18:14:36 +0800877
878 mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac;
879 const mbedtls_md_info_t* const md_info =
880 mbedtls_md_info_from_type( md_type );
881 size_t const md_size = mbedtls_md_get_size( md_info );
882
883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) );
884
Jerry Yub737f6a2021-12-10 17:55:23 +0800885 if( from == MBEDTLS_SSL_IS_CLIENT )
886 {
887 base_key = tls13_hs_secrets->client_handshake_traffic_secret;
888 base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret );
889 }
890 else
891 {
892 base_key = tls13_hs_secrets->server_handshake_traffic_secret;
893 base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret );
894 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000895
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000896 if( dst_len < md_size )
Jerry Yu9c074732021-12-10 17:12:43 +0800897 {
898 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
899 goto exit;
900 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000901
902 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
903 transcript, sizeof( transcript ),
904 &transcript_len );
905 if( ret != 0 )
906 {
907 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000908 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000909 }
910 MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len );
911
Xiaofei Bai746f9482021-11-12 08:53:56 +0000912 ret = ssl_tls13_calc_finished_core( md_type, base_key, transcript, dst );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000913 if( ret != 0 )
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000914 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000915 *actual_len = md_size;
916
917 MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, md_size );
XiaokangQianc5c39d52021-11-09 11:55:10 +0000918 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000919
920exit:
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800921 /* Erase handshake secrets */
Jerry Yub737f6a2021-12-10 17:55:23 +0800922 mbedtls_platform_zeroize( base_key, base_key_len );
XiaokangQian33062842021-11-11 03:37:45 +0000923 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000924 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000925}
926
Xiaofei Bai746f9482021-11-12 08:53:56 +0000927int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100928 const mbedtls_md_type_t md_type,
929 unsigned char const *psk, size_t psk_len,
930 int psk_type,
931 unsigned char const *transcript,
932 unsigned char *result )
933{
934 int ret = 0;
935 unsigned char binder_key[MBEDTLS_MD_MAX_SIZE];
936 unsigned char early_secret[MBEDTLS_MD_MAX_SIZE];
937 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type( md_type );
938 size_t const md_size = mbedtls_md_get_size( md_info );
939
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100940#if !defined(MBEDTLS_DEBUG_C)
941 ssl = NULL; /* make sure we don't use it except for debug */
942 ((void) ssl);
943#endif
944
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100945 /* We should never call this function with an unknown hash,
946 * but add an assertion anyway. */
947 if( md_info == 0 )
948 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
949
950 /*
951 * 0
952 * |
953 * v
954 * PSK -> HKDF-Extract = Early Secret
955 * |
956 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
957 * | = binder_key
958 * v
959 */
960
Xiaofei Bai746f9482021-11-12 08:53:56 +0000961 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
962 NULL, /* Old secret */
963 psk, psk_len, /* Input */
964 early_secret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100965 if( ret != 0 )
966 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000967 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100968 goto exit;
969 }
970
971 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
972 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000973 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100974 early_secret, md_size,
975 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ),
976 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
977 binder_key, md_size );
978 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) );
979 }
980 else
981 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000982 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100983 early_secret, md_size,
984 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ),
985 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
986 binder_key, md_size );
987 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) );
988 }
989
990 if( ret != 0 )
991 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000992 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100993 goto exit;
994 }
995
996 /*
997 * The binding_value is computed in the same way as the Finished message
998 * but with the BaseKey being the binder_key.
999 */
1000
Xiaofei Bai746f9482021-11-12 08:53:56 +00001001 ret = ssl_tls13_calc_finished_core( md_type, binder_key, transcript, result );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +01001002 if( ret != 0 )
1003 goto exit;
1004
1005 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, md_size );
1006
1007exit:
1008
1009 mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) );
1010 mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) );
1011 return( ret );
1012}
1013
Hanno Beckerc94060c2021-03-22 07:50:44 +00001014int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform,
1015 int endpoint,
1016 int ciphersuite,
1017 mbedtls_ssl_key_set const *traffic_keys,
1018 mbedtls_ssl_context *ssl /* DEBUG ONLY */ )
1019{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001020#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001021 int ret;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001022#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001023 mbedtls_cipher_info_t const *cipher_info;
1024 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
1025 unsigned char const *key_enc;
1026 unsigned char const *iv_enc;
1027 unsigned char const *key_dec;
1028 unsigned char const *iv_dec;
1029
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001030#if defined(MBEDTLS_USE_PSA_CRYPTO)
1031 psa_key_type_t key_type;
1032 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1033 psa_algorithm_t alg;
1034 size_t key_bits;
1035 psa_status_t status = PSA_SUCCESS;
1036#endif
1037
Hanno Beckerc94060c2021-03-22 07:50:44 +00001038#if !defined(MBEDTLS_DEBUG_C)
1039 ssl = NULL; /* make sure we don't use it except for those cases */
1040 (void) ssl;
1041#endif
1042
1043 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Hanno Becker7887a772021-04-20 05:27:57 +01001044 if( ciphersuite_info == NULL )
1045 {
1046 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
1047 ciphersuite ) );
1048 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1049 }
Hanno Beckerc94060c2021-03-22 07:50:44 +00001050
1051 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
1052 if( cipher_info == NULL )
1053 {
Hanno Becker7887a772021-04-20 05:27:57 +01001054 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
1055 ciphersuite_info->cipher ) );
Hanno Beckerf62a7302021-04-21 05:21:28 +01001056 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Beckerc94060c2021-03-22 07:50:44 +00001057 }
1058
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001059#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001060 /*
1061 * Setup cipher contexts in target transform
1062 */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001063 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
1064 cipher_info ) ) != 0 )
1065 {
1066 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
1067 return( ret );
1068 }
1069
1070 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
1071 cipher_info ) ) != 0 )
1072 {
1073 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
1074 return( ret );
1075 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001076#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001077
1078#if defined(MBEDTLS_SSL_SRV_C)
1079 if( endpoint == MBEDTLS_SSL_IS_SERVER )
1080 {
1081 key_enc = traffic_keys->server_write_key;
1082 key_dec = traffic_keys->client_write_key;
1083 iv_enc = traffic_keys->server_write_iv;
1084 iv_dec = traffic_keys->client_write_iv;
1085 }
1086 else
1087#endif /* MBEDTLS_SSL_SRV_C */
1088#if defined(MBEDTLS_SSL_CLI_C)
1089 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
1090 {
1091 key_enc = traffic_keys->client_write_key;
1092 key_dec = traffic_keys->server_write_key;
1093 iv_enc = traffic_keys->client_write_iv;
1094 iv_dec = traffic_keys->server_write_iv;
1095 }
1096 else
1097#endif /* MBEDTLS_SSL_CLI_C */
1098 {
1099 /* should not happen */
1100 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1101 }
1102
1103 memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len );
1104 memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len );
1105
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001106#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001107 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc,
1108 key_enc, cipher_info->key_bitlen,
1109 MBEDTLS_ENCRYPT ) ) != 0 )
1110 {
1111 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1112 return( ret );
1113 }
1114
1115 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec,
1116 key_dec, cipher_info->key_bitlen,
1117 MBEDTLS_DECRYPT ) ) != 0 )
1118 {
1119 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1120 return( ret );
1121 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001122#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001123
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +01001124 /*
1125 * Setup other fields in SSL transform
1126 */
1127
1128 if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 )
1129 transform->taglen = 8;
1130 else
1131 transform->taglen = 16;
1132
1133 transform->ivlen = traffic_keys->iv_len;
1134 transform->maclen = 0;
1135 transform->fixed_ivlen = transform->ivlen;
1136 transform->minor_ver = MBEDTLS_SSL_MINOR_VERSION_4;
1137
1138 /* We add the true record content type (1 Byte) to the plaintext and
1139 * then pad to the configured granularity. The mimimum length of the
1140 * type-extended and padded plaintext is therefore the padding
1141 * granularity. */
1142 transform->minlen =
1143 transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY;
1144
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001145#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001146 /*
1147 * Setup psa keys and alg
1148 */
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001149 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001150 transform->taglen,
1151 &alg,
1152 &key_type,
1153 &key_bits ) ) != PSA_SUCCESS )
1154 {
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001155 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", psa_ssl_status_to_mbedtls( status ) );
1156 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001157 }
1158
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001159 transform->psa_alg = alg;
1160
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001161 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001162 {
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001163 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
1164 psa_set_key_algorithm( &attributes, alg );
1165 psa_set_key_type( &attributes, key_type );
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001166
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001167 if( ( status = psa_import_key( &attributes,
1168 key_enc,
1169 PSA_BITS_TO_BYTES( key_bits ),
1170 &transform->psa_key_enc ) ) != PSA_SUCCESS )
1171 {
1172 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1173 return( psa_ssl_status_to_mbedtls( status ) );
1174 }
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001175
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001176 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
1177
1178 if( ( status = psa_import_key( &attributes,
1179 key_dec,
1180 PSA_BITS_TO_BYTES( key_bits ),
1181 &transform->psa_key_dec ) ) != PSA_SUCCESS )
1182 {
1183 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1184 return( psa_ssl_status_to_mbedtls( status ) );
1185 }
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001186 }
1187#endif /* MBEDTLS_USE_PSA_CRYPTO */
1188
Hanno Beckerc94060c2021-03-22 07:50:44 +00001189 return( 0 );
1190}
1191
Xiaofei Bai746f9482021-11-12 08:53:56 +00001192int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl )
Jerry Yu89ea3212021-09-09 14:31:24 +08001193{
Jerry Yue3131ef2021-09-16 13:14:15 +08001194 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1195 mbedtls_md_type_t md_type;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001196 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu6ca7c7f2021-09-28 18:51:40 +08001197
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001198 if( handshake->ciphersuite_info == NULL )
Jerry Yu89ea3212021-09-09 14:31:24 +08001199 {
1200 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) );
1201 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1202 }
Jerry Yue3131ef2021-09-16 13:14:15 +08001203
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001204 md_type = handshake->ciphersuite_info->mac;
Jerry Yue06f4532021-09-23 18:35:07 +08001205
Xiaofei Bai746f9482021-11-12 08:53:56 +00001206 ret = mbedtls_ssl_tls13_evolve_secret( md_type, NULL, NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001207 handshake->tls13_master_secrets.early );
Jerry Yu89ea3212021-09-09 14:31:24 +08001208 if( ret != 0 )
1209 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001210 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yu89ea3212021-09-09 14:31:24 +08001211 return( ret );
1212 }
1213
1214 return( 0 );
1215}
1216
Jerry Yuc068b662021-10-11 22:30:19 +08001217/* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for
Jerry Yu61e35e02021-09-16 18:59:08 +08001218 * protecting the handshake messages, as described in Section 7 of TLS 1.3. */
Jerry Yuc068b662021-10-11 22:30:19 +08001219int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl,
1220 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu61e35e02021-09-16 18:59:08 +08001221{
1222 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1223
1224 mbedtls_md_type_t md_type;
1225 mbedtls_md_info_t const *md_info;
1226 size_t md_size;
1227
Jerry Yu435208a2021-10-13 11:22:16 +08001228 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu61e35e02021-09-16 18:59:08 +08001229 size_t transcript_len;
1230
1231 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001232 size_t key_len, iv_len;
Jerry Yu61e35e02021-09-16 18:59:08 +08001233
Jerry Yu435208a2021-10-13 11:22:16 +08001234 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1235 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
Xiaofei Bai746f9482021-11-12 08:53:56 +00001236 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets;
Jerry Yu435208a2021-10-13 11:22:16 +08001237
Jerry Yuc068b662021-10-11 22:30:19 +08001238 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001239
Jerry Yu435208a2021-10-13 11:22:16 +08001240 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001241 key_len = cipher_info->key_bitlen >> 3;
1242 iv_len = cipher_info->iv_size;
Jerry Yu61e35e02021-09-16 18:59:08 +08001243
Jerry Yu435208a2021-10-13 11:22:16 +08001244 md_type = ciphersuite_info->mac;
Jerry Yu61e35e02021-09-16 18:59:08 +08001245 md_info = mbedtls_md_info_from_type( md_type );
1246 md_size = mbedtls_md_get_size( md_info );
1247
1248 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1249 transcript,
1250 sizeof( transcript ),
1251 &transcript_len );
1252 if( ret != 0 )
1253 {
1254 MBEDTLS_SSL_DEBUG_RET( 1,
1255 "mbedtls_ssl_get_handshake_transcript",
1256 ret );
1257 return( ret );
1258 }
1259
Xiaofei Bai746f9482021-11-12 08:53:56 +00001260 ret = mbedtls_ssl_tls13_derive_handshake_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001261 handshake->tls13_master_secrets.handshake,
Jerry Yu435208a2021-10-13 11:22:16 +08001262 transcript, transcript_len, tls13_hs_secrets );
Jerry Yu61e35e02021-09-16 18:59:08 +08001263 if( ret != 0 )
1264 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001265 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets",
Jerry Yu61e35e02021-09-16 18:59:08 +08001266 ret );
1267 return( ret );
1268 }
1269
1270 MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001271 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001272 md_size );
Jerry Yu61e35e02021-09-16 18:59:08 +08001273 MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001274 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001275 md_size );
1276
1277 /*
1278 * Export client handshake traffic secret
1279 */
Jerry Yu61e35e02021-09-16 18:59:08 +08001280 if( ssl->f_export_keys != NULL )
1281 {
1282 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001283 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001284 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001285 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001286 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001287 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001288 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1289
1290 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001291 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001292 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001293 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001294 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001295 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001296 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1297 }
Jerry Yu61e35e02021-09-16 18:59:08 +08001298
Xiaofei Bai746f9482021-11-12 08:53:56 +00001299 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
Jerry Yu435208a2021-10-13 11:22:16 +08001300 tls13_hs_secrets->client_handshake_traffic_secret,
1301 tls13_hs_secrets->server_handshake_traffic_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +00001302 md_size, key_len, iv_len, traffic_keys );
Jerry Yu61e35e02021-09-16 18:59:08 +08001303 if( ret != 0 )
1304 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001305 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
Jerry Yu61e35e02021-09-16 18:59:08 +08001306 goto exit;
1307 }
1308
1309 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key",
1310 traffic_keys->client_write_key,
1311 traffic_keys->key_len);
1312
1313 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key",
1314 traffic_keys->server_write_key,
1315 traffic_keys->key_len);
1316
1317 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv",
1318 traffic_keys->client_write_iv,
1319 traffic_keys->iv_len);
1320
1321 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv",
1322 traffic_keys->server_write_iv,
1323 traffic_keys->iv_len);
1324
Jerry Yuc068b662021-10-11 22:30:19 +08001325 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001326
1327exit:
1328
1329 return( ret );
1330}
1331
Jerry Yuf0ac2352021-10-11 17:47:07 +08001332int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl )
Jerry Yua0650eb2021-09-09 17:14:45 +08001333{
Jerry Yuf0ac2352021-10-11 17:47:07 +08001334 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001335#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED) && defined(MBEDTLS_ECDH_C)
1336 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
1337#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED && MBEDTLS_ECDH_C */
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001338 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1339 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
Jerry Yua0650eb2021-09-09 17:14:45 +08001340#if defined(MBEDTLS_DEBUG_C)
1341 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
1342 size_t const md_size = mbedtls_md_get_size( md_info );
1343#endif /* MBEDTLS_DEBUG_C */
1344
Jerry Yuf0ac2352021-10-11 17:47:07 +08001345#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1346 /*
1347 * Compute ECDHE secret used to compute the handshake secret from which
1348 * client_handshake_traffic_secret and server_handshake_traffic_secret
1349 * are derived in the handshake secret derivation stage.
1350 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001351 if( mbedtls_ssl_tls13_ephemeral_enabled( ssl ) )
Jerry Yuf0ac2352021-10-11 17:47:07 +08001352 {
1353 if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) )
1354 {
1355#if defined(MBEDTLS_ECDH_C)
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001356 /* Compute ECDH shared secret. */
1357 status = psa_raw_key_agreement(
1358 PSA_ALG_ECDH, handshake->ecdh_psa_privkey,
1359 handshake->ecdh_psa_peerkey, handshake->ecdh_psa_peerkey_len,
1360 handshake->premaster, sizeof( handshake->premaster ),
1361 &handshake->pmslen );
1362 if( status != PSA_SUCCESS )
1363 {
1364 ret = psa_ssl_status_to_mbedtls( status );
1365 MBEDTLS_SSL_DEBUG_RET( 1, "psa_raw_key_agreement", ret );
1366 return( ret );
1367 }
1368
1369 status = psa_destroy_key( handshake->ecdh_psa_privkey );
1370 if( status != PSA_SUCCESS )
1371 {
1372 ret = psa_ssl_status_to_mbedtls( status );
1373 MBEDTLS_SSL_DEBUG_RET( 1, "psa_destroy_key", ret );
1374 return( ret );
1375 }
1376
1377 handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Jerry Yuf0ac2352021-10-11 17:47:07 +08001378#endif /* MBEDTLS_ECDH_C */
1379 }
1380 else if( mbedtls_ssl_tls13_named_group_is_dhe( handshake->offered_group_id ) )
1381 {
Jerry Yuf0ac2352021-10-11 17:47:07 +08001382 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DHE not supported." ) );
1383 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1384 }
1385 }
1386#else
1387 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1388#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
Jerry Yua0650eb2021-09-09 17:14:45 +08001389
1390 /*
Jerry Yuf0ac2352021-10-11 17:47:07 +08001391 * Compute the Handshake Secret
Jerry Yua0650eb2021-09-09 17:14:45 +08001392 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001393 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001394 handshake->tls13_master_secrets.early,
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001395 handshake->premaster, handshake->pmslen,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001396 handshake->tls13_master_secrets.handshake );
Jerry Yua0650eb2021-09-09 17:14:45 +08001397 if( ret != 0 )
1398 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001399 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yua0650eb2021-09-09 17:14:45 +08001400 return( ret );
1401 }
1402
1403 MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +00001404 handshake->tls13_master_secrets.handshake, md_size );
Jerry Yua0650eb2021-09-09 17:14:45 +08001405
1406#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001407 mbedtls_platform_zeroize( handshake->premaster, sizeof( handshake->premaster ) );
Jerry Yua0650eb2021-09-09 17:14:45 +08001408#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
1409 return( 0 );
1410}
1411
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001412/* Generate application traffic keys since any records following a 1-RTT Finished message
1413 * MUST be encrypted under the application traffic key.
1414 */
XiaokangQiand0aa3e92021-11-10 06:17:40 +00001415int mbedtls_ssl_tls13_generate_application_keys(
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001416 mbedtls_ssl_context *ssl,
1417 mbedtls_ssl_key_set *traffic_keys )
1418{
XiaokangQiana7634982021-10-22 06:32:32 +00001419 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +00001420 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001421
1422 /* Address at which to store the application secrets */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001423 mbedtls_ssl_tls13_application_secrets * const app_secrets =
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001424 &ssl->session_negotiate->app_secrets;
1425
1426 /* Holding the transcript up to and including the ServerFinished */
XiaokangQian33062842021-11-11 03:37:45 +00001427 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001428 size_t transcript_len;
1429
1430 /* Variables relating to the hash for the chosen ciphersuite. */
1431 mbedtls_md_type_t md_type;
1432 mbedtls_md_info_t const *md_info;
1433 size_t md_size;
1434
1435 /* Variables relating to the cipher for the chosen ciphersuite. */
1436 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001437 size_t key_len, iv_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001438
1439 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) );
1440
1441 /* Extract basic information about hash and ciphersuite */
1442
1443 cipher_info = mbedtls_cipher_info_from_type(
XiaokangQian33062842021-11-11 03:37:45 +00001444 handshake->ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001445 key_len = cipher_info->key_bitlen / 8;
1446 iv_len = cipher_info->iv_size;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001447
XiaokangQian33062842021-11-11 03:37:45 +00001448 md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001449 md_info = mbedtls_md_info_from_type( md_type );
1450 md_size = mbedtls_md_get_size( md_info );
1451
1452 /* Compute current handshake transcript. It's the caller's responsiblity
1453 * to call this at the right time, that is, after the ServerFinished. */
1454
1455 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1456 transcript, sizeof( transcript ),
1457 &transcript_len );
1458 if( ret != 0 )
XiaokangQian4cab0242021-10-12 08:43:37 +00001459 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001460
1461 /* Compute application secrets from master secret and transcript hash. */
1462
Xiaofei Bai746f9482021-11-12 08:53:56 +00001463 ret = mbedtls_ssl_tls13_derive_application_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001464 handshake->tls13_master_secrets.app,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001465 transcript, transcript_len,
1466 app_secrets );
Jerry Yu4a2fa5d2021-12-10 10:19:34 +08001467 /* Erase master secrets */
Jerry Yu23ab7a42021-12-08 14:34:10 +08001468 mbedtls_platform_zeroize( &ssl->handshake->tls13_master_secrets,
Jerry Yu27224f52021-12-09 10:56:50 +08001469 sizeof( ssl->handshake->tls13_master_secrets ) );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001470 if( ret != 0 )
1471 {
1472 MBEDTLS_SSL_DEBUG_RET( 1,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001473 "mbedtls_ssl_tls13_derive_application_secrets", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001474 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001475 }
1476
1477 /* Derive first epoch of IV + Key for application traffic. */
1478
Xiaofei Bai746f9482021-11-12 08:53:56 +00001479 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001480 app_secrets->client_application_traffic_secret_N,
1481 app_secrets->server_application_traffic_secret_N,
Xiaofei Baib7972842021-11-18 07:29:56 +00001482 md_size, key_len, iv_len, traffic_keys );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001483 if( ret != 0 )
1484 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001485 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001486 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001487 }
1488
1489 MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret",
1490 app_secrets->client_application_traffic_secret_N,
1491 md_size );
1492
1493 MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret",
1494 app_secrets->server_application_traffic_secret_N,
1495 md_size );
1496
XiaokangQianac0385c2021-11-03 06:40:11 +00001497 /*
1498 * Export client/server application traffic secret 0
1499 */
1500 if( ssl->f_export_keys != NULL )
1501 {
1502 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001503 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001504 app_secrets->client_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001505 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001506 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001507 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1508 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001509
1510 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001511 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001512 app_secrets->server_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001513 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001514 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001515 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1516 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001517 }
1518
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001519 MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:",
Xiaofei Baib7972842021-11-18 07:29:56 +00001520 traffic_keys->client_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001521 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key",
Xiaofei Baib7972842021-11-18 07:29:56 +00001522 traffic_keys->server_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001523 MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001524 traffic_keys->client_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001525 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001526 traffic_keys->server_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001527
1528 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001529
1530 cleanup:
Jerry Yu2c70a392021-12-08 13:28:49 +08001531 /* randbytes is not used again */
1532 mbedtls_platform_zeroize( ssl->handshake->randbytes,
1533 sizeof( ssl->handshake->randbytes ) );
XiaokangQian33062842021-11-11 03:37:45 +00001534 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001535 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001536}
1537
Ronald Cron6f135e12021-12-08 16:57:54 +01001538#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */