blob: 513fb10ee0c3b6eef068bf3fc3e95e63156e8edf [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
142psa_status_t mbedtls_psa_hkdf_expand( psa_algorithm_t alg,
143 const unsigned char *prk, size_t prk_len,
144 const unsigned char *info, size_t info_len,
145 unsigned char *okm, size_t okm_len )
146{
147 size_t hash_len;
148 size_t where = 0;
149 size_t n;
150 size_t t_len = 0;
151 size_t i;
152 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
153 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
154 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gabor Mezei833713c2022-02-15 16:16:08 +0100155 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100156 unsigned char t[PSA_MAC_MAX_SIZE];
157
158 if( okm == NULL )
159 {
160 return( PSA_ERROR_INVALID_ARGUMENT );
161 }
162
163 hash_len = PSA_HASH_LENGTH( alg );
164
165 if( prk_len < hash_len || hash_len == 0 )
166 {
167 return( PSA_ERROR_INVALID_ARGUMENT );
168 }
169
170 if( info == NULL )
171 {
172 info = (const unsigned char *) "";
173 info_len = 0;
174 }
175
176 n = okm_len / hash_len;
177
178 if( okm_len % hash_len != 0 )
179 {
180 n++;
181 }
182
183 /*
184 * Per RFC 5869 Section 2.3, okm_len must not exceed
185 * 255 times the hash length
186 */
187 if( n > 255 )
188 {
189 return( PSA_ERROR_INVALID_ARGUMENT );
190 }
191
192 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
193 psa_set_key_algorithm( &attributes, alg );
194 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
195
Gabor Mezei833713c2022-02-15 16:16:08 +0100196 status = psa_import_key( &attributes, prk, prk_len, &key );
197 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100198 {
199 goto cleanup;
200 }
201
202 memset( t, 0, hash_len );
203
204 /*
205 * Compute T = T(1) | T(2) | T(3) | ... | T(N)
206 * Where T(N) is defined in RFC 5869 Section 2.3
207 */
208 for( i = 1; i <= n; i++ )
209 {
210 size_t num_to_copy;
211 unsigned char c = i & 0xff;
212 size_t len;
213
Gabor Mezei833713c2022-02-15 16:16:08 +0100214 status = psa_mac_sign_setup( &operation, key, alg );
215 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100216 {
217 goto cleanup;
218 }
219
Gabor Mezei833713c2022-02-15 16:16:08 +0100220 status = psa_mac_update( &operation, t, t_len );
221 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100222 {
223 goto cleanup;
224 }
225
Gabor Mezei833713c2022-02-15 16:16:08 +0100226 status = psa_mac_update( &operation, info, info_len );
227 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100228 {
229 goto cleanup;
230 }
231
232 /* The constant concatenated to the end of each T(n) is a single octet.
233 * */
Gabor Mezei833713c2022-02-15 16:16:08 +0100234 status = psa_mac_update( &operation, &c, 1 );
235 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100236 {
237 goto cleanup;
238 }
239
Gabor Mezei833713c2022-02-15 16:16:08 +0100240 status = psa_mac_sign_finish( &operation, t, PSA_MAC_MAX_SIZE, &len );
241 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100242 {
243 goto cleanup;
244 }
245
246 num_to_copy = i != n ? hash_len : okm_len - where;
247 memcpy( okm + where, t, num_to_copy );
248 where += hash_len;
249 t_len = hash_len;
250 }
251
252cleanup:
253 psa_destroy_key( key );
254 mbedtls_platform_zeroize( t, sizeof( t ) );
255 psa_mac_abort( &operation );
256
Gabor Mezei833713c2022-02-15 16:16:08 +0100257 return( status );
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100258}
259
Gabor Mezei9607ab42022-02-09 17:00:32 +0100260#endif /* MBEDTLS_TEST_HOOKS */
261
Xiaofei Bai746f9482021-11-12 08:53:56 +0000262int mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100263 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000264 const unsigned char *secret, size_t secret_len,
265 const unsigned char *label, size_t label_len,
266 const unsigned char *ctx, size_t ctx_len,
267 unsigned char *buf, size_t buf_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100268{
Xiaofei Baib7972842021-11-18 07:29:56 +0000269 const mbedtls_md_info_t *md_info;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100270 unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ];
271 size_t hkdf_label_len;
272
Xiaofei Baib7972842021-11-18 07:29:56 +0000273 if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100274 {
275 /* Should never happen since this is an internal
276 * function, and we know statically which labels
277 * are allowed. */
278 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
279 }
280
Xiaofei Baib7972842021-11-18 07:29:56 +0000281 if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100282 {
283 /* Should not happen, as above. */
284 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
285 }
286
Xiaofei Baib7972842021-11-18 07:29:56 +0000287 if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100288 {
289 /* Should not happen, as above. */
290 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
291 }
292
Xiaofei Baib7972842021-11-18 07:29:56 +0000293 md_info = mbedtls_md_info_from_type( hash_alg );
294 if( md_info == NULL )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100295 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
296
Xiaofei Baib7972842021-11-18 07:29:56 +0000297 ssl_tls13_hkdf_encode_label( buf_len,
298 label, label_len,
299 ctx, ctx_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000300 hkdf_label,
301 &hkdf_label_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100302
Xiaofei Baib7972842021-11-18 07:29:56 +0000303 return( mbedtls_hkdf_expand( md_info,
304 secret, secret_len,
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100305 hkdf_label, hkdf_label_len,
Xiaofei Baib7972842021-11-18 07:29:56 +0000306 buf, buf_len ) );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100307}
308
Hanno Becker3385a4d2020-08-21 13:03:34 +0100309/*
310 * The traffic keying material is generated from the following inputs:
311 *
312 * - One secret value per sender.
313 * - A purpose value indicating the specific value being generated
314 * - The desired lengths of key and IV.
315 *
316 * The expansion itself is based on HKDF:
317 *
318 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
319 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
320 *
321 * [sender] denotes the sending side and the Secret value is provided
322 * by the function caller. Note that we generate server and client side
323 * keys in a single function call.
324 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000325int mbedtls_ssl_tls13_make_traffic_keys(
Hanno Becker3385a4d2020-08-21 13:03:34 +0100326 mbedtls_md_type_t hash_alg,
327 const unsigned char *client_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +0000328 const unsigned char *server_secret, size_t secret_len,
329 size_t key_len, size_t iv_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100330 mbedtls_ssl_key_set *keys )
331{
332 int ret = 0;
333
Xiaofei Bai746f9482021-11-12 08:53:56 +0000334 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000335 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100336 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
337 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100338 keys->client_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100339 if( ret != 0 )
340 return( ret );
341
Xiaofei Bai746f9482021-11-12 08:53:56 +0000342 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000343 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100344 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
345 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100346 keys->server_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100347 if( ret != 0 )
348 return( ret );
349
Xiaofei Bai746f9482021-11-12 08:53:56 +0000350 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000351 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100352 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
353 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100354 keys->client_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100355 if( ret != 0 )
356 return( ret );
357
Xiaofei Bai746f9482021-11-12 08:53:56 +0000358 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000359 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100360 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
361 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100362 keys->server_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100363 if( ret != 0 )
364 return( ret );
365
Hanno Becker493ea7f2020-09-08 11:01:00 +0100366 keys->key_len = key_len;
367 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100368
369 return( 0 );
370}
371
Xiaofei Bai746f9482021-11-12 08:53:56 +0000372int mbedtls_ssl_tls13_derive_secret(
Hanno Beckerb35d5222020-08-21 13:27:44 +0100373 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000374 const unsigned char *secret, size_t secret_len,
375 const unsigned char *label, size_t label_len,
376 const unsigned char *ctx, size_t ctx_len,
Hanno Becker0c42fd92020-09-09 12:58:29 +0100377 int ctx_hashed,
Xiaofei Baib7972842021-11-18 07:29:56 +0000378 unsigned char *dstbuf, size_t dstbuf_len )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100379{
380 int ret;
381 unsigned char hashed_context[ MBEDTLS_MD_MAX_SIZE ];
382
Xiaofei Baib7972842021-11-18 07:29:56 +0000383 const mbedtls_md_info_t *md_info;
384 md_info = mbedtls_md_info_from_type( hash_alg );
385 if( md_info == NULL )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100386 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
387
Hanno Becker0c42fd92020-09-09 12:58:29 +0100388 if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100389 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000390 ret = mbedtls_md( md_info, ctx, ctx_len, hashed_context );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100391 if( ret != 0 )
392 return( ret );
Xiaofei Baib7972842021-11-18 07:29:56 +0000393 ctx_len = mbedtls_md_get_size( md_info );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100394 }
395 else
396 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000397 if( ctx_len > sizeof(hashed_context) )
Hanno Becker97a21562020-09-09 12:57:16 +0100398 {
399 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100400 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100401 * Let's double-check nonetheless to not run at the risk
402 * of getting a stack overflow. */
Hanno Beckerb35d5222020-08-21 13:27:44 +0100403 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Becker97a21562020-09-09 12:57:16 +0100404 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100405
Xiaofei Baib7972842021-11-18 07:29:56 +0000406 memcpy( hashed_context, ctx, ctx_len );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100407 }
408
Xiaofei Bai746f9482021-11-12 08:53:56 +0000409 return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000410 secret, secret_len,
411 label, label_len,
412 hashed_context, ctx_len,
413 dstbuf, dstbuf_len ) );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100414}
415
Xiaofei Bai746f9482021-11-12 08:53:56 +0000416int mbedtls_ssl_tls13_evolve_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100417 mbedtls_md_type_t hash_alg,
418 const unsigned char *secret_old,
419 const unsigned char *input, size_t input_len,
420 unsigned char *secret_new )
421{
422 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
423 size_t hlen, ilen;
Hanno Becker59b50a12020-09-09 10:56:56 +0100424 unsigned char tmp_secret[ MBEDTLS_MD_MAX_SIZE ] = { 0 };
Jerry Yu6eaa41c2021-11-22 18:16:45 +0800425 unsigned char tmp_input [ MBEDTLS_ECP_MAX_BYTES ] = { 0 };
Hanno Beckere9cccb42020-08-20 13:42:46 +0100426
Xiaofei Baib7972842021-11-18 07:29:56 +0000427 const mbedtls_md_info_t *md_info;
428 md_info = mbedtls_md_info_from_type( hash_alg );
429 if( md_info == NULL )
Hanno Beckere9cccb42020-08-20 13:42:46 +0100430 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
431
Xiaofei Baib7972842021-11-18 07:29:56 +0000432 hlen = mbedtls_md_get_size( md_info );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100433
434 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100435 * on the old secret. */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100436 if( secret_old != NULL )
437 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000438 ret = mbedtls_ssl_tls13_derive_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100439 hash_alg,
440 secret_old, hlen,
441 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ),
442 NULL, 0, /* context */
443 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Hanno Becker59b50a12020-09-09 10:56:56 +0100444 tmp_secret, hlen );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100445 if( ret != 0 )
446 goto cleanup;
447 }
448
449 if( input != NULL )
450 {
Hanno Becker59b50a12020-09-09 10:56:56 +0100451 memcpy( tmp_input, input, input_len );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100452 ilen = input_len;
453 }
454 else
455 {
456 ilen = hlen;
457 }
458
459 /* HKDF-Extract takes a salt and input key material.
460 * The salt is the old secret, and the input key material
461 * is the input secret (PSK / ECDHE). */
Xiaofei Baib7972842021-11-18 07:29:56 +0000462 ret = mbedtls_hkdf_extract( md_info,
Hanno Becker59b50a12020-09-09 10:56:56 +0100463 tmp_secret, hlen,
464 tmp_input, ilen,
Hanno Beckere9cccb42020-08-20 13:42:46 +0100465 secret_new );
466 if( ret != 0 )
467 goto cleanup;
468
469 ret = 0;
470
471 cleanup:
472
Hanno Becker59b50a12020-09-09 10:56:56 +0100473 mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) );
474 mbedtls_platform_zeroize( tmp_input, sizeof(tmp_input) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100475 return( ret );
476}
477
Xiaofei Bai746f9482021-11-12 08:53:56 +0000478int mbedtls_ssl_tls13_derive_early_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100479 mbedtls_md_type_t md_type,
480 unsigned char const *early_secret,
481 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000482 mbedtls_ssl_tls13_early_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100483{
484 int ret;
485 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
486 size_t const md_size = mbedtls_md_get_size( md_info );
487
488 /* We should never call this function with an unknown hash,
489 * but add an assertion anyway. */
490 if( md_info == 0 )
491 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
492
493 /*
494 * 0
495 * |
496 * v
497 * PSK -> HKDF-Extract = Early Secret
498 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100499 * +-----> Derive-Secret(., "c e traffic", ClientHello)
500 * | = client_early_traffic_secret
501 * |
502 * +-----> Derive-Secret(., "e exp master", ClientHello)
503 * | = early_exporter_master_secret
504 * v
505 */
506
507 /* Create client_early_traffic_secret */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000508 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100509 early_secret, md_size,
510 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ),
511 transcript, transcript_len,
512 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
513 derived->client_early_traffic_secret,
514 md_size );
515 if( ret != 0 )
516 return( ret );
517
518 /* Create early exporter */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000519 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100520 early_secret, md_size,
521 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ),
522 transcript, transcript_len,
523 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
524 derived->early_exporter_master_secret,
525 md_size );
526 if( ret != 0 )
527 return( ret );
528
529 return( 0 );
530}
531
Xiaofei Bai746f9482021-11-12 08:53:56 +0000532int mbedtls_ssl_tls13_derive_handshake_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100533 mbedtls_md_type_t md_type,
534 unsigned char const *handshake_secret,
535 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000536 mbedtls_ssl_tls13_handshake_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100537{
538 int ret;
539 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
540 size_t const md_size = mbedtls_md_get_size( md_info );
541
542 /* We should never call this function with an unknown hash,
543 * but add an assertion anyway. */
544 if( md_info == 0 )
545 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
546
547 /*
548 *
549 * Handshake Secret
550 * |
551 * +-----> Derive-Secret( ., "c hs traffic",
552 * | ClientHello...ServerHello )
553 * | = client_handshake_traffic_secret
554 * |
555 * +-----> Derive-Secret( ., "s hs traffic",
556 * | ClientHello...ServerHello )
557 * | = server_handshake_traffic_secret
558 *
559 */
560
561 /*
562 * Compute client_handshake_traffic_secret with
563 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
564 */
565
Xiaofei Bai746f9482021-11-12 08:53:56 +0000566 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100567 handshake_secret, md_size,
568 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ),
569 transcript, transcript_len,
570 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
571 derived->client_handshake_traffic_secret,
572 md_size );
573 if( ret != 0 )
574 return( ret );
575
576 /*
577 * Compute server_handshake_traffic_secret with
578 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
579 */
580
Xiaofei Bai746f9482021-11-12 08:53:56 +0000581 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100582 handshake_secret, md_size,
583 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ),
584 transcript, transcript_len,
585 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
586 derived->server_handshake_traffic_secret,
587 md_size );
588 if( ret != 0 )
589 return( ret );
590
591 return( 0 );
592}
593
Xiaofei Bai746f9482021-11-12 08:53:56 +0000594int mbedtls_ssl_tls13_derive_application_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100595 mbedtls_md_type_t md_type,
596 unsigned char const *application_secret,
597 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000598 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100599{
600 int ret;
601 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
602 size_t const md_size = mbedtls_md_get_size( md_info );
603
604 /* We should never call this function with an unknown hash,
605 * but add an assertion anyway. */
606 if( md_info == 0 )
607 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
608
609 /* Generate {client,server}_application_traffic_secret_0
610 *
611 * Master Secret
612 * |
613 * +-----> Derive-Secret( ., "c ap traffic",
614 * | ClientHello...server Finished )
615 * | = client_application_traffic_secret_0
616 * |
617 * +-----> Derive-Secret( ., "s ap traffic",
618 * | ClientHello...Server Finished )
619 * | = server_application_traffic_secret_0
620 * |
621 * +-----> Derive-Secret( ., "exp master",
622 * | ClientHello...server Finished)
623 * | = exporter_master_secret
624 *
625 */
626
Xiaofei Bai746f9482021-11-12 08:53:56 +0000627 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100628 application_secret, md_size,
629 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ),
630 transcript, transcript_len,
631 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
632 derived->client_application_traffic_secret_N,
633 md_size );
634 if( ret != 0 )
635 return( ret );
636
Xiaofei Bai746f9482021-11-12 08:53:56 +0000637 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100638 application_secret, md_size,
639 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ),
640 transcript, transcript_len,
641 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
642 derived->server_application_traffic_secret_N,
643 md_size );
644 if( ret != 0 )
645 return( ret );
646
Xiaofei Bai746f9482021-11-12 08:53:56 +0000647 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100648 application_secret, md_size,
649 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ),
650 transcript, transcript_len,
651 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
652 derived->exporter_master_secret,
653 md_size );
654 if( ret != 0 )
655 return( ret );
656
657 return( 0 );
658}
659
660/* Generate resumption_master_secret for use with the ticket exchange.
661 *
Xiaofei Bai746f9482021-11-12 08:53:56 +0000662 * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets()
Hanno Beckeref5235b2021-05-24 06:39:41 +0100663 * because it uses the transcript hash up to and including ClientFinished. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000664int mbedtls_ssl_tls13_derive_resumption_master_secret(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100665 mbedtls_md_type_t md_type,
666 unsigned char const *application_secret,
667 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000668 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100669{
670 int ret;
671 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
672 size_t const md_size = mbedtls_md_get_size( md_info );
673
674 /* We should never call this function with an unknown hash,
675 * but add an assertion anyway. */
676 if( md_info == 0 )
677 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
678
Xiaofei Bai746f9482021-11-12 08:53:56 +0000679 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100680 application_secret, md_size,
681 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ),
682 transcript, transcript_len,
683 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
684 derived->resumption_master_secret,
685 md_size );
686
687 if( ret != 0 )
688 return( ret );
689
690 return( 0 );
691}
692
XiaokangQiana4c99f22021-11-11 06:46:35 +0000693int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000694{
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +0000696 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
697 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000698#if defined(MBEDTLS_DEBUG_C)
699 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
700 size_t const md_size = mbedtls_md_get_size( md_info );
701#endif /* MBEDTLS_DEBUG_C */
702
703 /*
704 * Compute MasterSecret
705 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000706 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000707 handshake->tls13_master_secrets.handshake,
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000708 NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000709 handshake->tls13_master_secrets.app );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000710 if( ret != 0 )
711 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000712 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000713 return( ret );
714 }
715
716 MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +0000717 handshake->tls13_master_secrets.app, md_size );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000718
719 return( 0 );
720}
721
Xiaofei Bai746f9482021-11-12 08:53:56 +0000722static int ssl_tls13_calc_finished_core( mbedtls_md_type_t md_type,
723 unsigned char const *base_key,
724 unsigned char const *transcript,
725 unsigned char *dst )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100726{
727 const mbedtls_md_info_t* const md_info = mbedtls_md_info_from_type( md_type );
728 size_t const md_size = mbedtls_md_get_size( md_info );
729 unsigned char finished_key[MBEDTLS_MD_MAX_SIZE];
730 int ret;
731
732 /* We should never call this function with an unknown hash,
733 * but add an assertion anyway. */
734 if( md_info == 0 )
735 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
736
737 /* TLS 1.3 Finished message
738 *
739 * struct {
740 * opaque verify_data[Hash.length];
741 * } Finished;
742 *
743 * verify_data =
744 * HMAC( finished_key,
745 * Hash( Handshake Context +
746 * Certificate* +
747 * CertificateVerify* )
748 * )
749 *
750 * finished_key =
751 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
752 */
753
Xiaofei Bai746f9482021-11-12 08:53:56 +0000754 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100755 md_type, base_key, md_size,
756 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ),
757 NULL, 0,
758 finished_key, md_size );
759 if( ret != 0 )
760 goto exit;
761
762 ret = mbedtls_md_hmac( md_info, finished_key, md_size, transcript, md_size, dst );
763 if( ret != 0 )
764 goto exit;
765
766exit:
767
768 mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) );
769 return( ret );
770}
771
XiaokangQianc5c39d52021-11-09 11:55:10 +0000772int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl,
XiaokangQianaaa0e192021-11-10 03:07:04 +0000773 unsigned char* dst,
774 size_t dst_len,
775 size_t *actual_len,
776 int from )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000777{
XiaokangQiana7634982021-10-22 06:32:32 +0000778 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000779
XiaokangQianaaa0e192021-11-10 03:07:04 +0000780 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000781 size_t transcript_len;
782
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800783 unsigned char *base_key = NULL;
Jerry Yub737f6a2021-12-10 17:55:23 +0800784 size_t base_key_len = 0;
Jerry Yu9c074732021-12-10 17:12:43 +0800785 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets =
786 &ssl->handshake->tls13_hs_secrets;
Jerry Yua5563f62021-12-10 18:14:36 +0800787
788 mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac;
789 const mbedtls_md_info_t* const md_info =
790 mbedtls_md_info_from_type( md_type );
791 size_t const md_size = mbedtls_md_get_size( md_info );
792
793 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) );
794
Jerry Yub737f6a2021-12-10 17:55:23 +0800795 if( from == MBEDTLS_SSL_IS_CLIENT )
796 {
797 base_key = tls13_hs_secrets->client_handshake_traffic_secret;
798 base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret );
799 }
800 else
801 {
802 base_key = tls13_hs_secrets->server_handshake_traffic_secret;
803 base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret );
804 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000805
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000806 if( dst_len < md_size )
Jerry Yu9c074732021-12-10 17:12:43 +0800807 {
808 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
809 goto exit;
810 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000811
812 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
813 transcript, sizeof( transcript ),
814 &transcript_len );
815 if( ret != 0 )
816 {
817 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000818 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000819 }
820 MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len );
821
Xiaofei Bai746f9482021-11-12 08:53:56 +0000822 ret = ssl_tls13_calc_finished_core( md_type, base_key, transcript, dst );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000823 if( ret != 0 )
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000824 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000825 *actual_len = md_size;
826
827 MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, md_size );
XiaokangQianc5c39d52021-11-09 11:55:10 +0000828 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000829
830exit:
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800831 /* Erase handshake secrets */
Jerry Yub737f6a2021-12-10 17:55:23 +0800832 mbedtls_platform_zeroize( base_key, base_key_len );
XiaokangQian33062842021-11-11 03:37:45 +0000833 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000834 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000835}
836
Xiaofei Bai746f9482021-11-12 08:53:56 +0000837int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100838 const mbedtls_md_type_t md_type,
839 unsigned char const *psk, size_t psk_len,
840 int psk_type,
841 unsigned char const *transcript,
842 unsigned char *result )
843{
844 int ret = 0;
845 unsigned char binder_key[MBEDTLS_MD_MAX_SIZE];
846 unsigned char early_secret[MBEDTLS_MD_MAX_SIZE];
847 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type( md_type );
848 size_t const md_size = mbedtls_md_get_size( md_info );
849
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100850#if !defined(MBEDTLS_DEBUG_C)
851 ssl = NULL; /* make sure we don't use it except for debug */
852 ((void) ssl);
853#endif
854
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100855 /* We should never call this function with an unknown hash,
856 * but add an assertion anyway. */
857 if( md_info == 0 )
858 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
859
860 /*
861 * 0
862 * |
863 * v
864 * PSK -> HKDF-Extract = Early Secret
865 * |
866 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
867 * | = binder_key
868 * v
869 */
870
Xiaofei Bai746f9482021-11-12 08:53:56 +0000871 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
872 NULL, /* Old secret */
873 psk, psk_len, /* Input */
874 early_secret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100875 if( ret != 0 )
876 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000877 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100878 goto exit;
879 }
880
881 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
882 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000883 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100884 early_secret, md_size,
885 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ),
886 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
887 binder_key, md_size );
888 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) );
889 }
890 else
891 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000892 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100893 early_secret, md_size,
894 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ),
895 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
896 binder_key, md_size );
897 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) );
898 }
899
900 if( ret != 0 )
901 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000902 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100903 goto exit;
904 }
905
906 /*
907 * The binding_value is computed in the same way as the Finished message
908 * but with the BaseKey being the binder_key.
909 */
910
Xiaofei Bai746f9482021-11-12 08:53:56 +0000911 ret = ssl_tls13_calc_finished_core( md_type, binder_key, transcript, result );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100912 if( ret != 0 )
913 goto exit;
914
915 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, md_size );
916
917exit:
918
919 mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) );
920 mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) );
921 return( ret );
922}
923
Hanno Beckerc94060c2021-03-22 07:50:44 +0000924int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform,
925 int endpoint,
926 int ciphersuite,
927 mbedtls_ssl_key_set const *traffic_keys,
928 mbedtls_ssl_context *ssl /* DEBUG ONLY */ )
929{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100930#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000931 int ret;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100932#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000933 mbedtls_cipher_info_t const *cipher_info;
934 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
935 unsigned char const *key_enc;
936 unsigned char const *iv_enc;
937 unsigned char const *key_dec;
938 unsigned char const *iv_dec;
939
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100940#if defined(MBEDTLS_USE_PSA_CRYPTO)
941 psa_key_type_t key_type;
942 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
943 psa_algorithm_t alg;
944 size_t key_bits;
945 psa_status_t status = PSA_SUCCESS;
946#endif
947
Hanno Beckerc94060c2021-03-22 07:50:44 +0000948#if !defined(MBEDTLS_DEBUG_C)
949 ssl = NULL; /* make sure we don't use it except for those cases */
950 (void) ssl;
951#endif
952
953 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Hanno Becker7887a772021-04-20 05:27:57 +0100954 if( ciphersuite_info == NULL )
955 {
956 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
957 ciphersuite ) );
958 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
959 }
Hanno Beckerc94060c2021-03-22 07:50:44 +0000960
961 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
962 if( cipher_info == NULL )
963 {
Hanno Becker7887a772021-04-20 05:27:57 +0100964 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
965 ciphersuite_info->cipher ) );
Hanno Beckerf62a7302021-04-21 05:21:28 +0100966 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Beckerc94060c2021-03-22 07:50:44 +0000967 }
968
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100969#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000970 /*
971 * Setup cipher contexts in target transform
972 */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000973 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
974 cipher_info ) ) != 0 )
975 {
976 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
977 return( ret );
978 }
979
980 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
981 cipher_info ) ) != 0 )
982 {
983 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
984 return( ret );
985 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100986#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000987
988#if defined(MBEDTLS_SSL_SRV_C)
989 if( endpoint == MBEDTLS_SSL_IS_SERVER )
990 {
991 key_enc = traffic_keys->server_write_key;
992 key_dec = traffic_keys->client_write_key;
993 iv_enc = traffic_keys->server_write_iv;
994 iv_dec = traffic_keys->client_write_iv;
995 }
996 else
997#endif /* MBEDTLS_SSL_SRV_C */
998#if defined(MBEDTLS_SSL_CLI_C)
999 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
1000 {
1001 key_enc = traffic_keys->client_write_key;
1002 key_dec = traffic_keys->server_write_key;
1003 iv_enc = traffic_keys->client_write_iv;
1004 iv_dec = traffic_keys->server_write_iv;
1005 }
1006 else
1007#endif /* MBEDTLS_SSL_CLI_C */
1008 {
1009 /* should not happen */
1010 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1011 }
1012
1013 memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len );
1014 memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len );
1015
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001016#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001017 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc,
1018 key_enc, cipher_info->key_bitlen,
1019 MBEDTLS_ENCRYPT ) ) != 0 )
1020 {
1021 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1022 return( ret );
1023 }
1024
1025 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec,
1026 key_dec, cipher_info->key_bitlen,
1027 MBEDTLS_DECRYPT ) ) != 0 )
1028 {
1029 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1030 return( ret );
1031 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001032#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001033
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +01001034 /*
1035 * Setup other fields in SSL transform
1036 */
1037
1038 if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 )
1039 transform->taglen = 8;
1040 else
1041 transform->taglen = 16;
1042
1043 transform->ivlen = traffic_keys->iv_len;
1044 transform->maclen = 0;
1045 transform->fixed_ivlen = transform->ivlen;
1046 transform->minor_ver = MBEDTLS_SSL_MINOR_VERSION_4;
1047
1048 /* We add the true record content type (1 Byte) to the plaintext and
1049 * then pad to the configured granularity. The mimimum length of the
1050 * type-extended and padded plaintext is therefore the padding
1051 * granularity. */
1052 transform->minlen =
1053 transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY;
1054
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001055#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001056 /*
1057 * Setup psa keys and alg
1058 */
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001059 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001060 transform->taglen,
1061 &alg,
1062 &key_type,
1063 &key_bits ) ) != PSA_SUCCESS )
1064 {
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001065 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", psa_ssl_status_to_mbedtls( status ) );
1066 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001067 }
1068
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001069 transform->psa_alg = alg;
1070
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001071 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001072 {
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001073 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
1074 psa_set_key_algorithm( &attributes, alg );
1075 psa_set_key_type( &attributes, key_type );
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001076
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001077 if( ( status = psa_import_key( &attributes,
1078 key_enc,
1079 PSA_BITS_TO_BYTES( key_bits ),
1080 &transform->psa_key_enc ) ) != PSA_SUCCESS )
1081 {
1082 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1083 return( psa_ssl_status_to_mbedtls( status ) );
1084 }
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001085
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001086 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
1087
1088 if( ( status = psa_import_key( &attributes,
1089 key_dec,
1090 PSA_BITS_TO_BYTES( key_bits ),
1091 &transform->psa_key_dec ) ) != PSA_SUCCESS )
1092 {
1093 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1094 return( psa_ssl_status_to_mbedtls( status ) );
1095 }
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001096 }
1097#endif /* MBEDTLS_USE_PSA_CRYPTO */
1098
Hanno Beckerc94060c2021-03-22 07:50:44 +00001099 return( 0 );
1100}
1101
Xiaofei Bai746f9482021-11-12 08:53:56 +00001102int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl )
Jerry Yu89ea3212021-09-09 14:31:24 +08001103{
Jerry Yue3131ef2021-09-16 13:14:15 +08001104 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1105 mbedtls_md_type_t md_type;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001106 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu6ca7c7f2021-09-28 18:51:40 +08001107
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001108 if( handshake->ciphersuite_info == NULL )
Jerry Yu89ea3212021-09-09 14:31:24 +08001109 {
1110 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) );
1111 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1112 }
Jerry Yue3131ef2021-09-16 13:14:15 +08001113
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001114 md_type = handshake->ciphersuite_info->mac;
Jerry Yue06f4532021-09-23 18:35:07 +08001115
Xiaofei Bai746f9482021-11-12 08:53:56 +00001116 ret = mbedtls_ssl_tls13_evolve_secret( md_type, NULL, NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001117 handshake->tls13_master_secrets.early );
Jerry Yu89ea3212021-09-09 14:31:24 +08001118 if( ret != 0 )
1119 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001120 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yu89ea3212021-09-09 14:31:24 +08001121 return( ret );
1122 }
1123
1124 return( 0 );
1125}
1126
Jerry Yuc068b662021-10-11 22:30:19 +08001127/* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for
Jerry Yu61e35e02021-09-16 18:59:08 +08001128 * protecting the handshake messages, as described in Section 7 of TLS 1.3. */
Jerry Yuc068b662021-10-11 22:30:19 +08001129int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl,
1130 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu61e35e02021-09-16 18:59:08 +08001131{
1132 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1133
1134 mbedtls_md_type_t md_type;
1135 mbedtls_md_info_t const *md_info;
1136 size_t md_size;
1137
Jerry Yu435208a2021-10-13 11:22:16 +08001138 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu61e35e02021-09-16 18:59:08 +08001139 size_t transcript_len;
1140
1141 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001142 size_t key_len, iv_len;
Jerry Yu61e35e02021-09-16 18:59:08 +08001143
Jerry Yu435208a2021-10-13 11:22:16 +08001144 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1145 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
Xiaofei Bai746f9482021-11-12 08:53:56 +00001146 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets;
Jerry Yu435208a2021-10-13 11:22:16 +08001147
Jerry Yuc068b662021-10-11 22:30:19 +08001148 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001149
Jerry Yu435208a2021-10-13 11:22:16 +08001150 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001151 key_len = cipher_info->key_bitlen >> 3;
1152 iv_len = cipher_info->iv_size;
Jerry Yu61e35e02021-09-16 18:59:08 +08001153
Jerry Yu435208a2021-10-13 11:22:16 +08001154 md_type = ciphersuite_info->mac;
Jerry Yu61e35e02021-09-16 18:59:08 +08001155 md_info = mbedtls_md_info_from_type( md_type );
1156 md_size = mbedtls_md_get_size( md_info );
1157
1158 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1159 transcript,
1160 sizeof( transcript ),
1161 &transcript_len );
1162 if( ret != 0 )
1163 {
1164 MBEDTLS_SSL_DEBUG_RET( 1,
1165 "mbedtls_ssl_get_handshake_transcript",
1166 ret );
1167 return( ret );
1168 }
1169
Xiaofei Bai746f9482021-11-12 08:53:56 +00001170 ret = mbedtls_ssl_tls13_derive_handshake_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001171 handshake->tls13_master_secrets.handshake,
Jerry Yu435208a2021-10-13 11:22:16 +08001172 transcript, transcript_len, tls13_hs_secrets );
Jerry Yu61e35e02021-09-16 18:59:08 +08001173 if( ret != 0 )
1174 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001175 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets",
Jerry Yu61e35e02021-09-16 18:59:08 +08001176 ret );
1177 return( ret );
1178 }
1179
1180 MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001181 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001182 md_size );
Jerry Yu61e35e02021-09-16 18:59:08 +08001183 MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001184 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001185 md_size );
1186
1187 /*
1188 * Export client handshake traffic secret
1189 */
Jerry Yu61e35e02021-09-16 18:59:08 +08001190 if( ssl->f_export_keys != NULL )
1191 {
1192 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001193 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001194 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001195 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001196 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001197 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001198 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1199
1200 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001201 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001202 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001203 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001204 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001205 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001206 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1207 }
Jerry Yu61e35e02021-09-16 18:59:08 +08001208
Xiaofei Bai746f9482021-11-12 08:53:56 +00001209 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
Jerry Yu435208a2021-10-13 11:22:16 +08001210 tls13_hs_secrets->client_handshake_traffic_secret,
1211 tls13_hs_secrets->server_handshake_traffic_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +00001212 md_size, key_len, iv_len, traffic_keys );
Jerry Yu61e35e02021-09-16 18:59:08 +08001213 if( ret != 0 )
1214 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001215 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
Jerry Yu61e35e02021-09-16 18:59:08 +08001216 goto exit;
1217 }
1218
1219 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key",
1220 traffic_keys->client_write_key,
1221 traffic_keys->key_len);
1222
1223 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key",
1224 traffic_keys->server_write_key,
1225 traffic_keys->key_len);
1226
1227 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv",
1228 traffic_keys->client_write_iv,
1229 traffic_keys->iv_len);
1230
1231 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv",
1232 traffic_keys->server_write_iv,
1233 traffic_keys->iv_len);
1234
Jerry Yuc068b662021-10-11 22:30:19 +08001235 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001236
1237exit:
1238
1239 return( ret );
1240}
1241
Jerry Yuf0ac2352021-10-11 17:47:07 +08001242int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl )
Jerry Yua0650eb2021-09-09 17:14:45 +08001243{
Jerry Yuf0ac2352021-10-11 17:47:07 +08001244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001245 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1246 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
Jerry Yuf0ac2352021-10-11 17:47:07 +08001247 size_t ephemeral_len = 0;
1248 unsigned char ecdhe[MBEDTLS_ECP_MAX_BYTES];
Jerry Yua0650eb2021-09-09 17:14:45 +08001249#if defined(MBEDTLS_DEBUG_C)
1250 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
1251 size_t const md_size = mbedtls_md_get_size( md_info );
1252#endif /* MBEDTLS_DEBUG_C */
1253
Jerry Yuf0ac2352021-10-11 17:47:07 +08001254#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1255 /*
1256 * Compute ECDHE secret used to compute the handshake secret from which
1257 * client_handshake_traffic_secret and server_handshake_traffic_secret
1258 * are derived in the handshake secret derivation stage.
1259 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001260 if( mbedtls_ssl_tls13_ephemeral_enabled( ssl ) )
Jerry Yuf0ac2352021-10-11 17:47:07 +08001261 {
1262 if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) )
1263 {
1264#if defined(MBEDTLS_ECDH_C)
1265 ret = mbedtls_ecdh_calc_secret( &handshake->ecdh_ctx,
1266 &ephemeral_len, ecdhe, sizeof( ecdhe ),
1267 ssl->conf->f_rng,
1268 ssl->conf->p_rng );
1269 if( ret != 0 )
1270 {
1271 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
1272 return( ret );
1273 }
1274#endif /* MBEDTLS_ECDH_C */
1275 }
1276 else if( mbedtls_ssl_tls13_named_group_is_dhe( handshake->offered_group_id ) )
1277 {
Jerry Yuf0ac2352021-10-11 17:47:07 +08001278 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DHE not supported." ) );
1279 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1280 }
1281 }
1282#else
1283 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1284#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
Jerry Yua0650eb2021-09-09 17:14:45 +08001285
1286 /*
Jerry Yuf0ac2352021-10-11 17:47:07 +08001287 * Compute the Handshake Secret
Jerry Yua0650eb2021-09-09 17:14:45 +08001288 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001289 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001290 handshake->tls13_master_secrets.early,
Xiaofei Baib7972842021-11-18 07:29:56 +00001291 ecdhe, ephemeral_len,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001292 handshake->tls13_master_secrets.handshake );
Jerry Yua0650eb2021-09-09 17:14:45 +08001293 if( ret != 0 )
1294 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001295 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yua0650eb2021-09-09 17:14:45 +08001296 return( ret );
1297 }
1298
1299 MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +00001300 handshake->tls13_master_secrets.handshake, md_size );
Jerry Yua0650eb2021-09-09 17:14:45 +08001301
1302#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1303 mbedtls_platform_zeroize( ecdhe, sizeof( ecdhe ) );
1304#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
1305 return( 0 );
1306}
1307
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001308/* Generate application traffic keys since any records following a 1-RTT Finished message
1309 * MUST be encrypted under the application traffic key.
1310 */
XiaokangQiand0aa3e92021-11-10 06:17:40 +00001311int mbedtls_ssl_tls13_generate_application_keys(
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001312 mbedtls_ssl_context *ssl,
1313 mbedtls_ssl_key_set *traffic_keys )
1314{
XiaokangQiana7634982021-10-22 06:32:32 +00001315 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +00001316 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001317
1318 /* Address at which to store the application secrets */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001319 mbedtls_ssl_tls13_application_secrets * const app_secrets =
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001320 &ssl->session_negotiate->app_secrets;
1321
1322 /* Holding the transcript up to and including the ServerFinished */
XiaokangQian33062842021-11-11 03:37:45 +00001323 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001324 size_t transcript_len;
1325
1326 /* Variables relating to the hash for the chosen ciphersuite. */
1327 mbedtls_md_type_t md_type;
1328 mbedtls_md_info_t const *md_info;
1329 size_t md_size;
1330
1331 /* Variables relating to the cipher for the chosen ciphersuite. */
1332 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001333 size_t key_len, iv_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001334
1335 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) );
1336
1337 /* Extract basic information about hash and ciphersuite */
1338
1339 cipher_info = mbedtls_cipher_info_from_type(
XiaokangQian33062842021-11-11 03:37:45 +00001340 handshake->ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001341 key_len = cipher_info->key_bitlen / 8;
1342 iv_len = cipher_info->iv_size;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001343
XiaokangQian33062842021-11-11 03:37:45 +00001344 md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001345 md_info = mbedtls_md_info_from_type( md_type );
1346 md_size = mbedtls_md_get_size( md_info );
1347
1348 /* Compute current handshake transcript. It's the caller's responsiblity
1349 * to call this at the right time, that is, after the ServerFinished. */
1350
1351 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1352 transcript, sizeof( transcript ),
1353 &transcript_len );
1354 if( ret != 0 )
XiaokangQian4cab0242021-10-12 08:43:37 +00001355 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001356
1357 /* Compute application secrets from master secret and transcript hash. */
1358
Xiaofei Bai746f9482021-11-12 08:53:56 +00001359 ret = mbedtls_ssl_tls13_derive_application_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001360 handshake->tls13_master_secrets.app,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001361 transcript, transcript_len,
1362 app_secrets );
Jerry Yu4a2fa5d2021-12-10 10:19:34 +08001363 /* Erase master secrets */
Jerry Yu23ab7a42021-12-08 14:34:10 +08001364 mbedtls_platform_zeroize( &ssl->handshake->tls13_master_secrets,
Jerry Yu27224f52021-12-09 10:56:50 +08001365 sizeof( ssl->handshake->tls13_master_secrets ) );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001366 if( ret != 0 )
1367 {
1368 MBEDTLS_SSL_DEBUG_RET( 1,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001369 "mbedtls_ssl_tls13_derive_application_secrets", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001370 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001371 }
1372
1373 /* Derive first epoch of IV + Key for application traffic. */
1374
Xiaofei Bai746f9482021-11-12 08:53:56 +00001375 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001376 app_secrets->client_application_traffic_secret_N,
1377 app_secrets->server_application_traffic_secret_N,
Xiaofei Baib7972842021-11-18 07:29:56 +00001378 md_size, key_len, iv_len, traffic_keys );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001379 if( ret != 0 )
1380 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001381 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001382 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001383 }
1384
1385 MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret",
1386 app_secrets->client_application_traffic_secret_N,
1387 md_size );
1388
1389 MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret",
1390 app_secrets->server_application_traffic_secret_N,
1391 md_size );
1392
XiaokangQianac0385c2021-11-03 06:40:11 +00001393 /*
1394 * Export client/server application traffic secret 0
1395 */
1396 if( ssl->f_export_keys != NULL )
1397 {
1398 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001399 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001400 app_secrets->client_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001401 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001402 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001403 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1404 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001405
1406 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001407 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001408 app_secrets->server_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001409 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001410 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001411 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1412 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001413 }
1414
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001415 MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:",
Xiaofei Baib7972842021-11-18 07:29:56 +00001416 traffic_keys->client_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001417 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key",
Xiaofei Baib7972842021-11-18 07:29:56 +00001418 traffic_keys->server_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001419 MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001420 traffic_keys->client_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001421 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001422 traffic_keys->server_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001423
1424 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001425
1426 cleanup:
Jerry Yu2c70a392021-12-08 13:28:49 +08001427 /* randbytes is not used again */
1428 mbedtls_platform_zeroize( ssl->handshake->randbytes,
1429 sizeof( ssl->handshake->randbytes ) );
XiaokangQian33062842021-11-11 03:37:45 +00001430 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001431 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001432}
1433
Ronald Cron6f135e12021-12-08 16:57:54 +01001434#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */