blob: a5af5900baba167d363219fb19247b320ef404d1 [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 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 Mezei9607ab42022-02-09 17:00:32 +0100315#endif /* MBEDTLS_TEST_HOOKS */
316
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{
Xiaofei Baib7972842021-11-18 07:29:56 +0000324 const mbedtls_md_info_t *md_info;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100325 unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ];
326 size_t hkdf_label_len;
327
Xiaofei Baib7972842021-11-18 07:29:56 +0000328 if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100329 {
330 /* Should never happen since this is an internal
331 * function, and we know statically which labels
332 * are allowed. */
333 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
334 }
335
Xiaofei Baib7972842021-11-18 07:29:56 +0000336 if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100337 {
338 /* Should not happen, as above. */
339 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
340 }
341
Xiaofei Baib7972842021-11-18 07:29:56 +0000342 if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100343 {
344 /* Should not happen, as above. */
345 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
346 }
347
Xiaofei Baib7972842021-11-18 07:29:56 +0000348 md_info = mbedtls_md_info_from_type( hash_alg );
349 if( md_info == NULL )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100350 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
351
Xiaofei Baib7972842021-11-18 07:29:56 +0000352 ssl_tls13_hkdf_encode_label( buf_len,
353 label, label_len,
354 ctx, ctx_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000355 hkdf_label,
356 &hkdf_label_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100357
Xiaofei Baib7972842021-11-18 07:29:56 +0000358 return( mbedtls_hkdf_expand( md_info,
359 secret, secret_len,
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100360 hkdf_label, hkdf_label_len,
Xiaofei Baib7972842021-11-18 07:29:56 +0000361 buf, buf_len ) );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100362}
363
Hanno Becker3385a4d2020-08-21 13:03:34 +0100364/*
365 * The traffic keying material is generated from the following inputs:
366 *
367 * - One secret value per sender.
368 * - A purpose value indicating the specific value being generated
369 * - The desired lengths of key and IV.
370 *
371 * The expansion itself is based on HKDF:
372 *
373 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
374 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
375 *
376 * [sender] denotes the sending side and the Secret value is provided
377 * by the function caller. Note that we generate server and client side
378 * keys in a single function call.
379 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000380int mbedtls_ssl_tls13_make_traffic_keys(
Hanno Becker3385a4d2020-08-21 13:03:34 +0100381 mbedtls_md_type_t hash_alg,
382 const unsigned char *client_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +0000383 const unsigned char *server_secret, size_t secret_len,
384 size_t key_len, size_t iv_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100385 mbedtls_ssl_key_set *keys )
386{
387 int ret = 0;
388
Xiaofei Bai746f9482021-11-12 08:53:56 +0000389 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000390 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100391 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
392 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100393 keys->client_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100394 if( ret != 0 )
395 return( ret );
396
Xiaofei Bai746f9482021-11-12 08:53:56 +0000397 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000398 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100399 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
400 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100401 keys->server_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100402 if( ret != 0 )
403 return( ret );
404
Xiaofei Bai746f9482021-11-12 08:53:56 +0000405 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000406 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100407 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
408 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100409 keys->client_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100410 if( ret != 0 )
411 return( ret );
412
Xiaofei Bai746f9482021-11-12 08:53:56 +0000413 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000414 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100415 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
416 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100417 keys->server_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100418 if( ret != 0 )
419 return( ret );
420
Hanno Becker493ea7f2020-09-08 11:01:00 +0100421 keys->key_len = key_len;
422 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100423
424 return( 0 );
425}
426
Xiaofei Bai746f9482021-11-12 08:53:56 +0000427int mbedtls_ssl_tls13_derive_secret(
Hanno Beckerb35d5222020-08-21 13:27:44 +0100428 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000429 const unsigned char *secret, size_t secret_len,
430 const unsigned char *label, size_t label_len,
431 const unsigned char *ctx, size_t ctx_len,
Hanno Becker0c42fd92020-09-09 12:58:29 +0100432 int ctx_hashed,
Xiaofei Baib7972842021-11-18 07:29:56 +0000433 unsigned char *dstbuf, size_t dstbuf_len )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100434{
435 int ret;
436 unsigned char hashed_context[ MBEDTLS_MD_MAX_SIZE ];
437
Xiaofei Baib7972842021-11-18 07:29:56 +0000438 const mbedtls_md_info_t *md_info;
439 md_info = mbedtls_md_info_from_type( hash_alg );
440 if( md_info == NULL )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100441 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
442
Hanno Becker0c42fd92020-09-09 12:58:29 +0100443 if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100444 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000445 ret = mbedtls_md( md_info, ctx, ctx_len, hashed_context );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100446 if( ret != 0 )
447 return( ret );
Xiaofei Baib7972842021-11-18 07:29:56 +0000448 ctx_len = mbedtls_md_get_size( md_info );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100449 }
450 else
451 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000452 if( ctx_len > sizeof(hashed_context) )
Hanno Becker97a21562020-09-09 12:57:16 +0100453 {
454 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100455 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100456 * Let's double-check nonetheless to not run at the risk
457 * of getting a stack overflow. */
Hanno Beckerb35d5222020-08-21 13:27:44 +0100458 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Becker97a21562020-09-09 12:57:16 +0100459 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100460
Xiaofei Baib7972842021-11-18 07:29:56 +0000461 memcpy( hashed_context, ctx, ctx_len );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100462 }
463
Xiaofei Bai746f9482021-11-12 08:53:56 +0000464 return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000465 secret, secret_len,
466 label, label_len,
467 hashed_context, ctx_len,
468 dstbuf, dstbuf_len ) );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100469}
470
Xiaofei Bai746f9482021-11-12 08:53:56 +0000471int mbedtls_ssl_tls13_evolve_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100472 mbedtls_md_type_t hash_alg,
473 const unsigned char *secret_old,
474 const unsigned char *input, size_t input_len,
475 unsigned char *secret_new )
476{
477 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
478 size_t hlen, ilen;
Hanno Becker59b50a12020-09-09 10:56:56 +0100479 unsigned char tmp_secret[ MBEDTLS_MD_MAX_SIZE ] = { 0 };
Jerry Yu6eaa41c2021-11-22 18:16:45 +0800480 unsigned char tmp_input [ MBEDTLS_ECP_MAX_BYTES ] = { 0 };
Hanno Beckere9cccb42020-08-20 13:42:46 +0100481
Xiaofei Baib7972842021-11-18 07:29:56 +0000482 const mbedtls_md_info_t *md_info;
483 md_info = mbedtls_md_info_from_type( hash_alg );
484 if( md_info == NULL )
Hanno Beckere9cccb42020-08-20 13:42:46 +0100485 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
486
Xiaofei Baib7972842021-11-18 07:29:56 +0000487 hlen = mbedtls_md_get_size( md_info );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100488
489 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100490 * on the old secret. */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100491 if( secret_old != NULL )
492 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000493 ret = mbedtls_ssl_tls13_derive_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100494 hash_alg,
495 secret_old, hlen,
496 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ),
497 NULL, 0, /* context */
498 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Hanno Becker59b50a12020-09-09 10:56:56 +0100499 tmp_secret, hlen );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100500 if( ret != 0 )
501 goto cleanup;
502 }
503
504 if( input != NULL )
505 {
Hanno Becker59b50a12020-09-09 10:56:56 +0100506 memcpy( tmp_input, input, input_len );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100507 ilen = input_len;
508 }
509 else
510 {
511 ilen = hlen;
512 }
513
514 /* HKDF-Extract takes a salt and input key material.
515 * The salt is the old secret, and the input key material
516 * is the input secret (PSK / ECDHE). */
Xiaofei Baib7972842021-11-18 07:29:56 +0000517 ret = mbedtls_hkdf_extract( md_info,
Hanno Becker59b50a12020-09-09 10:56:56 +0100518 tmp_secret, hlen,
519 tmp_input, ilen,
Hanno Beckere9cccb42020-08-20 13:42:46 +0100520 secret_new );
521 if( ret != 0 )
522 goto cleanup;
523
524 ret = 0;
525
526 cleanup:
527
Hanno Becker59b50a12020-09-09 10:56:56 +0100528 mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) );
529 mbedtls_platform_zeroize( tmp_input, sizeof(tmp_input) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100530 return( ret );
531}
532
Xiaofei Bai746f9482021-11-12 08:53:56 +0000533int mbedtls_ssl_tls13_derive_early_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100534 mbedtls_md_type_t md_type,
535 unsigned char const *early_secret,
536 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000537 mbedtls_ssl_tls13_early_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100538{
539 int ret;
540 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
541 size_t const md_size = mbedtls_md_get_size( md_info );
542
543 /* We should never call this function with an unknown hash,
544 * but add an assertion anyway. */
545 if( md_info == 0 )
546 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
547
548 /*
549 * 0
550 * |
551 * v
552 * PSK -> HKDF-Extract = Early Secret
553 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100554 * +-----> Derive-Secret(., "c e traffic", ClientHello)
555 * | = client_early_traffic_secret
556 * |
557 * +-----> Derive-Secret(., "e exp master", ClientHello)
558 * | = early_exporter_master_secret
559 * v
560 */
561
562 /* Create client_early_traffic_secret */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000563 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100564 early_secret, md_size,
565 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ),
566 transcript, transcript_len,
567 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
568 derived->client_early_traffic_secret,
569 md_size );
570 if( ret != 0 )
571 return( ret );
572
573 /* Create early exporter */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000574 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100575 early_secret, md_size,
576 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ),
577 transcript, transcript_len,
578 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
579 derived->early_exporter_master_secret,
580 md_size );
581 if( ret != 0 )
582 return( ret );
583
584 return( 0 );
585}
586
Xiaofei Bai746f9482021-11-12 08:53:56 +0000587int mbedtls_ssl_tls13_derive_handshake_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100588 mbedtls_md_type_t md_type,
589 unsigned char const *handshake_secret,
590 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000591 mbedtls_ssl_tls13_handshake_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100592{
593 int ret;
594 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
595 size_t const md_size = mbedtls_md_get_size( md_info );
596
597 /* We should never call this function with an unknown hash,
598 * but add an assertion anyway. */
599 if( md_info == 0 )
600 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
601
602 /*
603 *
604 * Handshake Secret
605 * |
606 * +-----> Derive-Secret( ., "c hs traffic",
607 * | ClientHello...ServerHello )
608 * | = client_handshake_traffic_secret
609 * |
610 * +-----> Derive-Secret( ., "s hs traffic",
611 * | ClientHello...ServerHello )
612 * | = server_handshake_traffic_secret
613 *
614 */
615
616 /*
617 * Compute client_handshake_traffic_secret with
618 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
619 */
620
Xiaofei Bai746f9482021-11-12 08:53:56 +0000621 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100622 handshake_secret, md_size,
623 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ),
624 transcript, transcript_len,
625 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
626 derived->client_handshake_traffic_secret,
627 md_size );
628 if( ret != 0 )
629 return( ret );
630
631 /*
632 * Compute server_handshake_traffic_secret with
633 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
634 */
635
Xiaofei Bai746f9482021-11-12 08:53:56 +0000636 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100637 handshake_secret, md_size,
638 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ),
639 transcript, transcript_len,
640 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
641 derived->server_handshake_traffic_secret,
642 md_size );
643 if( ret != 0 )
644 return( ret );
645
646 return( 0 );
647}
648
Xiaofei Bai746f9482021-11-12 08:53:56 +0000649int mbedtls_ssl_tls13_derive_application_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100650 mbedtls_md_type_t md_type,
651 unsigned char const *application_secret,
652 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000653 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100654{
655 int ret;
656 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
657 size_t const md_size = mbedtls_md_get_size( md_info );
658
659 /* We should never call this function with an unknown hash,
660 * but add an assertion anyway. */
661 if( md_info == 0 )
662 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
663
664 /* Generate {client,server}_application_traffic_secret_0
665 *
666 * Master Secret
667 * |
668 * +-----> Derive-Secret( ., "c ap traffic",
669 * | ClientHello...server Finished )
670 * | = client_application_traffic_secret_0
671 * |
672 * +-----> Derive-Secret( ., "s ap traffic",
673 * | ClientHello...Server Finished )
674 * | = server_application_traffic_secret_0
675 * |
676 * +-----> Derive-Secret( ., "exp master",
677 * | ClientHello...server Finished)
678 * | = exporter_master_secret
679 *
680 */
681
Xiaofei Bai746f9482021-11-12 08:53:56 +0000682 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100683 application_secret, md_size,
684 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ),
685 transcript, transcript_len,
686 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
687 derived->client_application_traffic_secret_N,
688 md_size );
689 if( ret != 0 )
690 return( ret );
691
Xiaofei Bai746f9482021-11-12 08:53:56 +0000692 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100693 application_secret, md_size,
694 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ),
695 transcript, transcript_len,
696 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
697 derived->server_application_traffic_secret_N,
698 md_size );
699 if( ret != 0 )
700 return( ret );
701
Xiaofei Bai746f9482021-11-12 08:53:56 +0000702 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100703 application_secret, md_size,
704 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ),
705 transcript, transcript_len,
706 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
707 derived->exporter_master_secret,
708 md_size );
709 if( ret != 0 )
710 return( ret );
711
712 return( 0 );
713}
714
715/* Generate resumption_master_secret for use with the ticket exchange.
716 *
Xiaofei Bai746f9482021-11-12 08:53:56 +0000717 * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets()
Hanno Beckeref5235b2021-05-24 06:39:41 +0100718 * because it uses the transcript hash up to and including ClientFinished. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000719int mbedtls_ssl_tls13_derive_resumption_master_secret(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100720 mbedtls_md_type_t md_type,
721 unsigned char const *application_secret,
722 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000723 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100724{
725 int ret;
726 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
727 size_t const md_size = mbedtls_md_get_size( md_info );
728
729 /* We should never call this function with an unknown hash,
730 * but add an assertion anyway. */
731 if( md_info == 0 )
732 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
733
Xiaofei Bai746f9482021-11-12 08:53:56 +0000734 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100735 application_secret, md_size,
736 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ),
737 transcript, transcript_len,
738 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
739 derived->resumption_master_secret,
740 md_size );
741
742 if( ret != 0 )
743 return( ret );
744
745 return( 0 );
746}
747
XiaokangQiana4c99f22021-11-11 06:46:35 +0000748int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000749{
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000750 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +0000751 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
752 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000753#if defined(MBEDTLS_DEBUG_C)
754 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
755 size_t const md_size = mbedtls_md_get_size( md_info );
756#endif /* MBEDTLS_DEBUG_C */
757
758 /*
759 * Compute MasterSecret
760 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000761 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000762 handshake->tls13_master_secrets.handshake,
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000763 NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000764 handshake->tls13_master_secrets.app );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000765 if( ret != 0 )
766 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000767 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000768 return( ret );
769 }
770
771 MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +0000772 handshake->tls13_master_secrets.app, md_size );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000773
774 return( 0 );
775}
776
Xiaofei Bai746f9482021-11-12 08:53:56 +0000777static int ssl_tls13_calc_finished_core( mbedtls_md_type_t md_type,
778 unsigned char const *base_key,
779 unsigned char const *transcript,
780 unsigned char *dst )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100781{
782 const mbedtls_md_info_t* const md_info = mbedtls_md_info_from_type( md_type );
783 size_t const md_size = mbedtls_md_get_size( md_info );
784 unsigned char finished_key[MBEDTLS_MD_MAX_SIZE];
785 int ret;
786
787 /* We should never call this function with an unknown hash,
788 * but add an assertion anyway. */
789 if( md_info == 0 )
790 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
791
792 /* TLS 1.3 Finished message
793 *
794 * struct {
795 * opaque verify_data[Hash.length];
796 * } Finished;
797 *
798 * verify_data =
799 * HMAC( finished_key,
800 * Hash( Handshake Context +
801 * Certificate* +
802 * CertificateVerify* )
803 * )
804 *
805 * finished_key =
806 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
807 */
808
Xiaofei Bai746f9482021-11-12 08:53:56 +0000809 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100810 md_type, base_key, md_size,
811 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ),
812 NULL, 0,
813 finished_key, md_size );
814 if( ret != 0 )
815 goto exit;
816
817 ret = mbedtls_md_hmac( md_info, finished_key, md_size, transcript, md_size, dst );
818 if( ret != 0 )
819 goto exit;
820
821exit:
822
823 mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) );
824 return( ret );
825}
826
XiaokangQianc5c39d52021-11-09 11:55:10 +0000827int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl,
XiaokangQianaaa0e192021-11-10 03:07:04 +0000828 unsigned char* dst,
829 size_t dst_len,
830 size_t *actual_len,
831 int from )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000832{
XiaokangQiana7634982021-10-22 06:32:32 +0000833 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000834
XiaokangQianaaa0e192021-11-10 03:07:04 +0000835 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000836 size_t transcript_len;
837
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800838 unsigned char *base_key = NULL;
Jerry Yub737f6a2021-12-10 17:55:23 +0800839 size_t base_key_len = 0;
Jerry Yu9c074732021-12-10 17:12:43 +0800840 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets =
841 &ssl->handshake->tls13_hs_secrets;
Jerry Yua5563f62021-12-10 18:14:36 +0800842
843 mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac;
844 const mbedtls_md_info_t* const md_info =
845 mbedtls_md_info_from_type( md_type );
846 size_t const md_size = mbedtls_md_get_size( md_info );
847
848 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) );
849
Jerry Yub737f6a2021-12-10 17:55:23 +0800850 if( from == MBEDTLS_SSL_IS_CLIENT )
851 {
852 base_key = tls13_hs_secrets->client_handshake_traffic_secret;
853 base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret );
854 }
855 else
856 {
857 base_key = tls13_hs_secrets->server_handshake_traffic_secret;
858 base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret );
859 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000860
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000861 if( dst_len < md_size )
Jerry Yu9c074732021-12-10 17:12:43 +0800862 {
863 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
864 goto exit;
865 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000866
867 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
868 transcript, sizeof( transcript ),
869 &transcript_len );
870 if( ret != 0 )
871 {
872 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000873 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000874 }
875 MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len );
876
Xiaofei Bai746f9482021-11-12 08:53:56 +0000877 ret = ssl_tls13_calc_finished_core( md_type, base_key, transcript, dst );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000878 if( ret != 0 )
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000879 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000880 *actual_len = md_size;
881
882 MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, md_size );
XiaokangQianc5c39d52021-11-09 11:55:10 +0000883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000884
885exit:
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800886 /* Erase handshake secrets */
Jerry Yub737f6a2021-12-10 17:55:23 +0800887 mbedtls_platform_zeroize( base_key, base_key_len );
XiaokangQian33062842021-11-11 03:37:45 +0000888 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000889 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000890}
891
Xiaofei Bai746f9482021-11-12 08:53:56 +0000892int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100893 const mbedtls_md_type_t md_type,
894 unsigned char const *psk, size_t psk_len,
895 int psk_type,
896 unsigned char const *transcript,
897 unsigned char *result )
898{
899 int ret = 0;
900 unsigned char binder_key[MBEDTLS_MD_MAX_SIZE];
901 unsigned char early_secret[MBEDTLS_MD_MAX_SIZE];
902 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type( md_type );
903 size_t const md_size = mbedtls_md_get_size( md_info );
904
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100905#if !defined(MBEDTLS_DEBUG_C)
906 ssl = NULL; /* make sure we don't use it except for debug */
907 ((void) ssl);
908#endif
909
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100910 /* We should never call this function with an unknown hash,
911 * but add an assertion anyway. */
912 if( md_info == 0 )
913 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
914
915 /*
916 * 0
917 * |
918 * v
919 * PSK -> HKDF-Extract = Early Secret
920 * |
921 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
922 * | = binder_key
923 * v
924 */
925
Xiaofei Bai746f9482021-11-12 08:53:56 +0000926 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
927 NULL, /* Old secret */
928 psk, psk_len, /* Input */
929 early_secret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100930 if( ret != 0 )
931 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000932 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100933 goto exit;
934 }
935
936 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
937 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000938 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100939 early_secret, md_size,
940 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ),
941 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
942 binder_key, md_size );
943 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) );
944 }
945 else
946 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000947 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100948 early_secret, md_size,
949 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ),
950 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
951 binder_key, md_size );
952 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) );
953 }
954
955 if( ret != 0 )
956 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000957 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100958 goto exit;
959 }
960
961 /*
962 * The binding_value is computed in the same way as the Finished message
963 * but with the BaseKey being the binder_key.
964 */
965
Xiaofei Bai746f9482021-11-12 08:53:56 +0000966 ret = ssl_tls13_calc_finished_core( md_type, binder_key, transcript, result );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100967 if( ret != 0 )
968 goto exit;
969
970 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, md_size );
971
972exit:
973
974 mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) );
975 mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) );
976 return( ret );
977}
978
Hanno Beckerc94060c2021-03-22 07:50:44 +0000979int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform,
980 int endpoint,
981 int ciphersuite,
982 mbedtls_ssl_key_set const *traffic_keys,
983 mbedtls_ssl_context *ssl /* DEBUG ONLY */ )
984{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100985#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000986 int ret;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100987#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000988 mbedtls_cipher_info_t const *cipher_info;
989 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
990 unsigned char const *key_enc;
991 unsigned char const *iv_enc;
992 unsigned char const *key_dec;
993 unsigned char const *iv_dec;
994
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100995#if defined(MBEDTLS_USE_PSA_CRYPTO)
996 psa_key_type_t key_type;
997 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
998 psa_algorithm_t alg;
999 size_t key_bits;
1000 psa_status_t status = PSA_SUCCESS;
1001#endif
1002
Hanno Beckerc94060c2021-03-22 07:50:44 +00001003#if !defined(MBEDTLS_DEBUG_C)
1004 ssl = NULL; /* make sure we don't use it except for those cases */
1005 (void) ssl;
1006#endif
1007
1008 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Hanno Becker7887a772021-04-20 05:27:57 +01001009 if( ciphersuite_info == NULL )
1010 {
1011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
1012 ciphersuite ) );
1013 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1014 }
Hanno Beckerc94060c2021-03-22 07:50:44 +00001015
1016 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
1017 if( cipher_info == NULL )
1018 {
Hanno Becker7887a772021-04-20 05:27:57 +01001019 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
1020 ciphersuite_info->cipher ) );
Hanno Beckerf62a7302021-04-21 05:21:28 +01001021 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Beckerc94060c2021-03-22 07:50:44 +00001022 }
1023
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001024#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001025 /*
1026 * Setup cipher contexts in target transform
1027 */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001028 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
1029 cipher_info ) ) != 0 )
1030 {
1031 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
1032 return( ret );
1033 }
1034
1035 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
1036 cipher_info ) ) != 0 )
1037 {
1038 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
1039 return( ret );
1040 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001041#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001042
1043#if defined(MBEDTLS_SSL_SRV_C)
1044 if( endpoint == MBEDTLS_SSL_IS_SERVER )
1045 {
1046 key_enc = traffic_keys->server_write_key;
1047 key_dec = traffic_keys->client_write_key;
1048 iv_enc = traffic_keys->server_write_iv;
1049 iv_dec = traffic_keys->client_write_iv;
1050 }
1051 else
1052#endif /* MBEDTLS_SSL_SRV_C */
1053#if defined(MBEDTLS_SSL_CLI_C)
1054 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
1055 {
1056 key_enc = traffic_keys->client_write_key;
1057 key_dec = traffic_keys->server_write_key;
1058 iv_enc = traffic_keys->client_write_iv;
1059 iv_dec = traffic_keys->server_write_iv;
1060 }
1061 else
1062#endif /* MBEDTLS_SSL_CLI_C */
1063 {
1064 /* should not happen */
1065 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1066 }
1067
1068 memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len );
1069 memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len );
1070
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001071#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001072 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc,
1073 key_enc, cipher_info->key_bitlen,
1074 MBEDTLS_ENCRYPT ) ) != 0 )
1075 {
1076 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1077 return( ret );
1078 }
1079
1080 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec,
1081 key_dec, cipher_info->key_bitlen,
1082 MBEDTLS_DECRYPT ) ) != 0 )
1083 {
1084 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1085 return( ret );
1086 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001087#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001088
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +01001089 /*
1090 * Setup other fields in SSL transform
1091 */
1092
1093 if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 )
1094 transform->taglen = 8;
1095 else
1096 transform->taglen = 16;
1097
1098 transform->ivlen = traffic_keys->iv_len;
1099 transform->maclen = 0;
1100 transform->fixed_ivlen = transform->ivlen;
1101 transform->minor_ver = MBEDTLS_SSL_MINOR_VERSION_4;
1102
1103 /* We add the true record content type (1 Byte) to the plaintext and
1104 * then pad to the configured granularity. The mimimum length of the
1105 * type-extended and padded plaintext is therefore the padding
1106 * granularity. */
1107 transform->minlen =
1108 transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY;
1109
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001110#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001111 /*
1112 * Setup psa keys and alg
1113 */
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001114 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001115 transform->taglen,
1116 &alg,
1117 &key_type,
1118 &key_bits ) ) != PSA_SUCCESS )
1119 {
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001120 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", psa_ssl_status_to_mbedtls( status ) );
1121 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001122 }
1123
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001124 transform->psa_alg = alg;
1125
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001126 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001127 {
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001128 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
1129 psa_set_key_algorithm( &attributes, alg );
1130 psa_set_key_type( &attributes, key_type );
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001131
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001132 if( ( status = psa_import_key( &attributes,
1133 key_enc,
1134 PSA_BITS_TO_BYTES( key_bits ),
1135 &transform->psa_key_enc ) ) != PSA_SUCCESS )
1136 {
1137 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1138 return( psa_ssl_status_to_mbedtls( status ) );
1139 }
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001140
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001141 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
1142
1143 if( ( status = psa_import_key( &attributes,
1144 key_dec,
1145 PSA_BITS_TO_BYTES( key_bits ),
1146 &transform->psa_key_dec ) ) != PSA_SUCCESS )
1147 {
1148 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1149 return( psa_ssl_status_to_mbedtls( status ) );
1150 }
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001151 }
1152#endif /* MBEDTLS_USE_PSA_CRYPTO */
1153
Hanno Beckerc94060c2021-03-22 07:50:44 +00001154 return( 0 );
1155}
1156
Xiaofei Bai746f9482021-11-12 08:53:56 +00001157int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl )
Jerry Yu89ea3212021-09-09 14:31:24 +08001158{
Jerry Yue3131ef2021-09-16 13:14:15 +08001159 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1160 mbedtls_md_type_t md_type;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001161 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu6ca7c7f2021-09-28 18:51:40 +08001162
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001163 if( handshake->ciphersuite_info == NULL )
Jerry Yu89ea3212021-09-09 14:31:24 +08001164 {
1165 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) );
1166 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1167 }
Jerry Yue3131ef2021-09-16 13:14:15 +08001168
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001169 md_type = handshake->ciphersuite_info->mac;
Jerry Yue06f4532021-09-23 18:35:07 +08001170
Xiaofei Bai746f9482021-11-12 08:53:56 +00001171 ret = mbedtls_ssl_tls13_evolve_secret( md_type, NULL, NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001172 handshake->tls13_master_secrets.early );
Jerry Yu89ea3212021-09-09 14:31:24 +08001173 if( ret != 0 )
1174 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001175 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yu89ea3212021-09-09 14:31:24 +08001176 return( ret );
1177 }
1178
1179 return( 0 );
1180}
1181
Jerry Yuc068b662021-10-11 22:30:19 +08001182/* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for
Jerry Yu61e35e02021-09-16 18:59:08 +08001183 * protecting the handshake messages, as described in Section 7 of TLS 1.3. */
Jerry Yuc068b662021-10-11 22:30:19 +08001184int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl,
1185 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu61e35e02021-09-16 18:59:08 +08001186{
1187 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1188
1189 mbedtls_md_type_t md_type;
1190 mbedtls_md_info_t const *md_info;
1191 size_t md_size;
1192
Jerry Yu435208a2021-10-13 11:22:16 +08001193 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu61e35e02021-09-16 18:59:08 +08001194 size_t transcript_len;
1195
1196 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001197 size_t key_len, iv_len;
Jerry Yu61e35e02021-09-16 18:59:08 +08001198
Jerry Yu435208a2021-10-13 11:22:16 +08001199 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1200 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
Xiaofei Bai746f9482021-11-12 08:53:56 +00001201 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets;
Jerry Yu435208a2021-10-13 11:22:16 +08001202
Jerry Yuc068b662021-10-11 22:30:19 +08001203 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001204
Jerry Yu435208a2021-10-13 11:22:16 +08001205 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001206 key_len = cipher_info->key_bitlen >> 3;
1207 iv_len = cipher_info->iv_size;
Jerry Yu61e35e02021-09-16 18:59:08 +08001208
Jerry Yu435208a2021-10-13 11:22:16 +08001209 md_type = ciphersuite_info->mac;
Jerry Yu61e35e02021-09-16 18:59:08 +08001210 md_info = mbedtls_md_info_from_type( md_type );
1211 md_size = mbedtls_md_get_size( md_info );
1212
1213 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1214 transcript,
1215 sizeof( transcript ),
1216 &transcript_len );
1217 if( ret != 0 )
1218 {
1219 MBEDTLS_SSL_DEBUG_RET( 1,
1220 "mbedtls_ssl_get_handshake_transcript",
1221 ret );
1222 return( ret );
1223 }
1224
Xiaofei Bai746f9482021-11-12 08:53:56 +00001225 ret = mbedtls_ssl_tls13_derive_handshake_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001226 handshake->tls13_master_secrets.handshake,
Jerry Yu435208a2021-10-13 11:22:16 +08001227 transcript, transcript_len, tls13_hs_secrets );
Jerry Yu61e35e02021-09-16 18:59:08 +08001228 if( ret != 0 )
1229 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001230 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets",
Jerry Yu61e35e02021-09-16 18:59:08 +08001231 ret );
1232 return( ret );
1233 }
1234
1235 MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001236 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001237 md_size );
Jerry Yu61e35e02021-09-16 18:59:08 +08001238 MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001239 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001240 md_size );
1241
1242 /*
1243 * Export client handshake traffic secret
1244 */
Jerry Yu61e35e02021-09-16 18:59:08 +08001245 if( ssl->f_export_keys != NULL )
1246 {
1247 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001248 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001249 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001250 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001251 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001252 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001253 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1254
1255 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001256 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001257 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001258 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001259 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001260 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001261 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1262 }
Jerry Yu61e35e02021-09-16 18:59:08 +08001263
Xiaofei Bai746f9482021-11-12 08:53:56 +00001264 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
Jerry Yu435208a2021-10-13 11:22:16 +08001265 tls13_hs_secrets->client_handshake_traffic_secret,
1266 tls13_hs_secrets->server_handshake_traffic_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +00001267 md_size, key_len, iv_len, traffic_keys );
Jerry Yu61e35e02021-09-16 18:59:08 +08001268 if( ret != 0 )
1269 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001270 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
Jerry Yu61e35e02021-09-16 18:59:08 +08001271 goto exit;
1272 }
1273
1274 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key",
1275 traffic_keys->client_write_key,
1276 traffic_keys->key_len);
1277
1278 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key",
1279 traffic_keys->server_write_key,
1280 traffic_keys->key_len);
1281
1282 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv",
1283 traffic_keys->client_write_iv,
1284 traffic_keys->iv_len);
1285
1286 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv",
1287 traffic_keys->server_write_iv,
1288 traffic_keys->iv_len);
1289
Jerry Yuc068b662021-10-11 22:30:19 +08001290 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001291
1292exit:
1293
1294 return( ret );
1295}
1296
Jerry Yuf0ac2352021-10-11 17:47:07 +08001297int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl )
Jerry Yua0650eb2021-09-09 17:14:45 +08001298{
Jerry Yuf0ac2352021-10-11 17:47:07 +08001299 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001300#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED) && defined(MBEDTLS_ECDH_C)
1301 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
1302#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED && MBEDTLS_ECDH_C */
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001303 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1304 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
Jerry Yua0650eb2021-09-09 17:14:45 +08001305#if defined(MBEDTLS_DEBUG_C)
1306 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
1307 size_t const md_size = mbedtls_md_get_size( md_info );
1308#endif /* MBEDTLS_DEBUG_C */
1309
Jerry Yuf0ac2352021-10-11 17:47:07 +08001310#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1311 /*
1312 * Compute ECDHE secret used to compute the handshake secret from which
1313 * client_handshake_traffic_secret and server_handshake_traffic_secret
1314 * are derived in the handshake secret derivation stage.
1315 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001316 if( mbedtls_ssl_tls13_ephemeral_enabled( ssl ) )
Jerry Yuf0ac2352021-10-11 17:47:07 +08001317 {
1318 if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) )
1319 {
1320#if defined(MBEDTLS_ECDH_C)
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001321 /* Compute ECDH shared secret. */
1322 status = psa_raw_key_agreement(
1323 PSA_ALG_ECDH, handshake->ecdh_psa_privkey,
1324 handshake->ecdh_psa_peerkey, handshake->ecdh_psa_peerkey_len,
1325 handshake->premaster, sizeof( handshake->premaster ),
1326 &handshake->pmslen );
1327 if( status != PSA_SUCCESS )
1328 {
1329 ret = psa_ssl_status_to_mbedtls( status );
1330 MBEDTLS_SSL_DEBUG_RET( 1, "psa_raw_key_agreement", ret );
1331 return( ret );
1332 }
1333
1334 status = psa_destroy_key( handshake->ecdh_psa_privkey );
1335 if( status != PSA_SUCCESS )
1336 {
1337 ret = psa_ssl_status_to_mbedtls( status );
1338 MBEDTLS_SSL_DEBUG_RET( 1, "psa_destroy_key", ret );
1339 return( ret );
1340 }
1341
1342 handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Jerry Yuf0ac2352021-10-11 17:47:07 +08001343#endif /* MBEDTLS_ECDH_C */
1344 }
1345 else if( mbedtls_ssl_tls13_named_group_is_dhe( handshake->offered_group_id ) )
1346 {
Jerry Yuf0ac2352021-10-11 17:47:07 +08001347 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DHE not supported." ) );
1348 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1349 }
1350 }
1351#else
1352 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1353#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
Jerry Yua0650eb2021-09-09 17:14:45 +08001354
1355 /*
Jerry Yuf0ac2352021-10-11 17:47:07 +08001356 * Compute the Handshake Secret
Jerry Yua0650eb2021-09-09 17:14:45 +08001357 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001358 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001359 handshake->tls13_master_secrets.early,
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001360 handshake->premaster, handshake->pmslen,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001361 handshake->tls13_master_secrets.handshake );
Jerry Yua0650eb2021-09-09 17:14:45 +08001362 if( ret != 0 )
1363 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001364 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yua0650eb2021-09-09 17:14:45 +08001365 return( ret );
1366 }
1367
1368 MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +00001369 handshake->tls13_master_secrets.handshake, md_size );
Jerry Yua0650eb2021-09-09 17:14:45 +08001370
1371#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001372 mbedtls_platform_zeroize( handshake->premaster, sizeof( handshake->premaster ) );
Jerry Yua0650eb2021-09-09 17:14:45 +08001373#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
1374 return( 0 );
1375}
1376
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001377/* Generate application traffic keys since any records following a 1-RTT Finished message
1378 * MUST be encrypted under the application traffic key.
1379 */
XiaokangQiand0aa3e92021-11-10 06:17:40 +00001380int mbedtls_ssl_tls13_generate_application_keys(
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001381 mbedtls_ssl_context *ssl,
1382 mbedtls_ssl_key_set *traffic_keys )
1383{
XiaokangQiana7634982021-10-22 06:32:32 +00001384 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +00001385 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001386
1387 /* Address at which to store the application secrets */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001388 mbedtls_ssl_tls13_application_secrets * const app_secrets =
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001389 &ssl->session_negotiate->app_secrets;
1390
1391 /* Holding the transcript up to and including the ServerFinished */
XiaokangQian33062842021-11-11 03:37:45 +00001392 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001393 size_t transcript_len;
1394
1395 /* Variables relating to the hash for the chosen ciphersuite. */
1396 mbedtls_md_type_t md_type;
1397 mbedtls_md_info_t const *md_info;
1398 size_t md_size;
1399
1400 /* Variables relating to the cipher for the chosen ciphersuite. */
1401 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001402 size_t key_len, iv_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001403
1404 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) );
1405
1406 /* Extract basic information about hash and ciphersuite */
1407
1408 cipher_info = mbedtls_cipher_info_from_type(
XiaokangQian33062842021-11-11 03:37:45 +00001409 handshake->ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001410 key_len = cipher_info->key_bitlen / 8;
1411 iv_len = cipher_info->iv_size;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001412
XiaokangQian33062842021-11-11 03:37:45 +00001413 md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001414 md_info = mbedtls_md_info_from_type( md_type );
1415 md_size = mbedtls_md_get_size( md_info );
1416
1417 /* Compute current handshake transcript. It's the caller's responsiblity
1418 * to call this at the right time, that is, after the ServerFinished. */
1419
1420 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1421 transcript, sizeof( transcript ),
1422 &transcript_len );
1423 if( ret != 0 )
XiaokangQian4cab0242021-10-12 08:43:37 +00001424 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001425
1426 /* Compute application secrets from master secret and transcript hash. */
1427
Xiaofei Bai746f9482021-11-12 08:53:56 +00001428 ret = mbedtls_ssl_tls13_derive_application_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001429 handshake->tls13_master_secrets.app,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001430 transcript, transcript_len,
1431 app_secrets );
Jerry Yu4a2fa5d2021-12-10 10:19:34 +08001432 /* Erase master secrets */
Jerry Yu23ab7a42021-12-08 14:34:10 +08001433 mbedtls_platform_zeroize( &ssl->handshake->tls13_master_secrets,
Jerry Yu27224f52021-12-09 10:56:50 +08001434 sizeof( ssl->handshake->tls13_master_secrets ) );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001435 if( ret != 0 )
1436 {
1437 MBEDTLS_SSL_DEBUG_RET( 1,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001438 "mbedtls_ssl_tls13_derive_application_secrets", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001439 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001440 }
1441
1442 /* Derive first epoch of IV + Key for application traffic. */
1443
Xiaofei Bai746f9482021-11-12 08:53:56 +00001444 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001445 app_secrets->client_application_traffic_secret_N,
1446 app_secrets->server_application_traffic_secret_N,
Xiaofei Baib7972842021-11-18 07:29:56 +00001447 md_size, key_len, iv_len, traffic_keys );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001448 if( ret != 0 )
1449 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001450 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001451 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001452 }
1453
1454 MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret",
1455 app_secrets->client_application_traffic_secret_N,
1456 md_size );
1457
1458 MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret",
1459 app_secrets->server_application_traffic_secret_N,
1460 md_size );
1461
XiaokangQianac0385c2021-11-03 06:40:11 +00001462 /*
1463 * Export client/server application traffic secret 0
1464 */
1465 if( ssl->f_export_keys != NULL )
1466 {
1467 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001468 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001469 app_secrets->client_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001470 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001471 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001472 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1473 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001474
1475 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001476 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001477 app_secrets->server_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001478 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001479 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001480 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1481 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001482 }
1483
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001484 MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:",
Xiaofei Baib7972842021-11-18 07:29:56 +00001485 traffic_keys->client_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001486 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key",
Xiaofei Baib7972842021-11-18 07:29:56 +00001487 traffic_keys->server_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001488 MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001489 traffic_keys->client_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001490 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001491 traffic_keys->server_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001492
1493 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001494
1495 cleanup:
Jerry Yu2c70a392021-12-08 13:28:49 +08001496 /* randbytes is not used again */
1497 mbedtls_platform_zeroize( ssl->handshake->randbytes,
1498 sizeof( ssl->handshake->randbytes ) );
XiaokangQian33062842021-11-11 03:37:45 +00001499 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001500 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001501}
1502
Ronald Cron6f135e12021-12-08 16:57:54 +01001503#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */