blob: 885dd16fbfb84ff731cad26cd57e4583fed82264 [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 Mezei8d5a4cb2022-02-15 16:23:17 +0100156 psa_status_t destroy_status = PSA_ERROR_CORRUPTION_DETECTED;
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100157 unsigned char t[PSA_MAC_MAX_SIZE];
158
159 if( okm == NULL )
160 {
161 return( PSA_ERROR_INVALID_ARGUMENT );
162 }
163
164 hash_len = PSA_HASH_LENGTH( alg );
165
166 if( prk_len < hash_len || hash_len == 0 )
167 {
168 return( PSA_ERROR_INVALID_ARGUMENT );
169 }
170
171 if( info == NULL )
172 {
173 info = (const unsigned char *) "";
174 info_len = 0;
175 }
176
177 n = okm_len / hash_len;
178
179 if( okm_len % hash_len != 0 )
180 {
181 n++;
182 }
183
184 /*
185 * Per RFC 5869 Section 2.3, okm_len must not exceed
186 * 255 times the hash length
187 */
188 if( n > 255 )
189 {
190 return( PSA_ERROR_INVALID_ARGUMENT );
191 }
192
193 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
194 psa_set_key_algorithm( &attributes, alg );
195 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
196
Gabor Mezei833713c2022-02-15 16:16:08 +0100197 status = psa_import_key( &attributes, prk, prk_len, &key );
198 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100199 {
200 goto cleanup;
201 }
202
203 memset( t, 0, hash_len );
204
205 /*
206 * Compute T = T(1) | T(2) | T(3) | ... | T(N)
207 * Where T(N) is defined in RFC 5869 Section 2.3
208 */
209 for( i = 1; i <= n; i++ )
210 {
211 size_t num_to_copy;
212 unsigned char c = i & 0xff;
213 size_t len;
214
Gabor Mezei833713c2022-02-15 16:16:08 +0100215 status = psa_mac_sign_setup( &operation, key, alg );
216 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100217 {
218 goto cleanup;
219 }
220
Gabor Mezei833713c2022-02-15 16:16:08 +0100221 status = psa_mac_update( &operation, t, t_len );
222 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100223 {
224 goto cleanup;
225 }
226
Gabor Mezei833713c2022-02-15 16:16:08 +0100227 status = psa_mac_update( &operation, info, info_len );
228 if( status != PSA_SUCCESS )
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100229 {
230 goto cleanup;
231 }
232
Gabor Mezei8e360252022-02-17 11:50:02 +0100233 /* The constant concatenated to the end of each T(n) is a single octet. */
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:
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100253 if( status != PSA_SUCCESS )
254 psa_mac_abort( &operation );
255 destroy_status = psa_destroy_key( key );
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100256
Gabor Mezei8d5a4cb2022-02-15 16:23:17 +0100257 mbedtls_platform_zeroize( t, sizeof( t ) );
258
259 return( ( status == PSA_SUCCESS ) ? destroy_status : status );
Gabor Mezeia3eecd22022-02-09 16:57:26 +0100260}
261
Gabor Mezei9607ab42022-02-09 17:00:32 +0100262#endif /* MBEDTLS_TEST_HOOKS */
263
Xiaofei Bai746f9482021-11-12 08:53:56 +0000264int mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100265 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000266 const unsigned char *secret, size_t secret_len,
267 const unsigned char *label, size_t label_len,
268 const unsigned char *ctx, size_t ctx_len,
269 unsigned char *buf, size_t buf_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100270{
Xiaofei Baib7972842021-11-18 07:29:56 +0000271 const mbedtls_md_info_t *md_info;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100272 unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ];
273 size_t hkdf_label_len;
274
Xiaofei Baib7972842021-11-18 07:29:56 +0000275 if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100276 {
277 /* Should never happen since this is an internal
278 * function, and we know statically which labels
279 * are allowed. */
280 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
281 }
282
Xiaofei Baib7972842021-11-18 07:29:56 +0000283 if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100284 {
285 /* Should not happen, as above. */
286 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
287 }
288
Xiaofei Baib7972842021-11-18 07:29:56 +0000289 if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100290 {
291 /* Should not happen, as above. */
292 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
293 }
294
Xiaofei Baib7972842021-11-18 07:29:56 +0000295 md_info = mbedtls_md_info_from_type( hash_alg );
296 if( md_info == NULL )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100297 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
298
Xiaofei Baib7972842021-11-18 07:29:56 +0000299 ssl_tls13_hkdf_encode_label( buf_len,
300 label, label_len,
301 ctx, ctx_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000302 hkdf_label,
303 &hkdf_label_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100304
Xiaofei Baib7972842021-11-18 07:29:56 +0000305 return( mbedtls_hkdf_expand( md_info,
306 secret, secret_len,
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100307 hkdf_label, hkdf_label_len,
Xiaofei Baib7972842021-11-18 07:29:56 +0000308 buf, buf_len ) );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100309}
310
Hanno Becker3385a4d2020-08-21 13:03:34 +0100311/*
312 * The traffic keying material is generated from the following inputs:
313 *
314 * - One secret value per sender.
315 * - A purpose value indicating the specific value being generated
316 * - The desired lengths of key and IV.
317 *
318 * The expansion itself is based on HKDF:
319 *
320 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
321 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
322 *
323 * [sender] denotes the sending side and the Secret value is provided
324 * by the function caller. Note that we generate server and client side
325 * keys in a single function call.
326 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000327int mbedtls_ssl_tls13_make_traffic_keys(
Hanno Becker3385a4d2020-08-21 13:03:34 +0100328 mbedtls_md_type_t hash_alg,
329 const unsigned char *client_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +0000330 const unsigned char *server_secret, size_t secret_len,
331 size_t key_len, size_t iv_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100332 mbedtls_ssl_key_set *keys )
333{
334 int ret = 0;
335
Xiaofei Bai746f9482021-11-12 08:53:56 +0000336 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000337 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100338 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
339 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100340 keys->client_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100341 if( ret != 0 )
342 return( ret );
343
Xiaofei Bai746f9482021-11-12 08:53:56 +0000344 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000345 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100346 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
347 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100348 keys->server_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100349 if( ret != 0 )
350 return( ret );
351
Xiaofei Bai746f9482021-11-12 08:53:56 +0000352 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000353 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100354 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
355 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100356 keys->client_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100357 if( ret != 0 )
358 return( ret );
359
Xiaofei Bai746f9482021-11-12 08:53:56 +0000360 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000361 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100362 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
363 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100364 keys->server_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100365 if( ret != 0 )
366 return( ret );
367
Hanno Becker493ea7f2020-09-08 11:01:00 +0100368 keys->key_len = key_len;
369 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100370
371 return( 0 );
372}
373
Xiaofei Bai746f9482021-11-12 08:53:56 +0000374int mbedtls_ssl_tls13_derive_secret(
Hanno Beckerb35d5222020-08-21 13:27:44 +0100375 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000376 const unsigned char *secret, size_t secret_len,
377 const unsigned char *label, size_t label_len,
378 const unsigned char *ctx, size_t ctx_len,
Hanno Becker0c42fd92020-09-09 12:58:29 +0100379 int ctx_hashed,
Xiaofei Baib7972842021-11-18 07:29:56 +0000380 unsigned char *dstbuf, size_t dstbuf_len )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100381{
382 int ret;
383 unsigned char hashed_context[ MBEDTLS_MD_MAX_SIZE ];
384
Xiaofei Baib7972842021-11-18 07:29:56 +0000385 const mbedtls_md_info_t *md_info;
386 md_info = mbedtls_md_info_from_type( hash_alg );
387 if( md_info == NULL )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100388 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
389
Hanno Becker0c42fd92020-09-09 12:58:29 +0100390 if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100391 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000392 ret = mbedtls_md( md_info, ctx, ctx_len, hashed_context );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100393 if( ret != 0 )
394 return( ret );
Xiaofei Baib7972842021-11-18 07:29:56 +0000395 ctx_len = mbedtls_md_get_size( md_info );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100396 }
397 else
398 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000399 if( ctx_len > sizeof(hashed_context) )
Hanno Becker97a21562020-09-09 12:57:16 +0100400 {
401 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100402 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100403 * Let's double-check nonetheless to not run at the risk
404 * of getting a stack overflow. */
Hanno Beckerb35d5222020-08-21 13:27:44 +0100405 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Becker97a21562020-09-09 12:57:16 +0100406 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100407
Xiaofei Baib7972842021-11-18 07:29:56 +0000408 memcpy( hashed_context, ctx, ctx_len );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100409 }
410
Xiaofei Bai746f9482021-11-12 08:53:56 +0000411 return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000412 secret, secret_len,
413 label, label_len,
414 hashed_context, ctx_len,
415 dstbuf, dstbuf_len ) );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100416}
417
Xiaofei Bai746f9482021-11-12 08:53:56 +0000418int mbedtls_ssl_tls13_evolve_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100419 mbedtls_md_type_t hash_alg,
420 const unsigned char *secret_old,
421 const unsigned char *input, size_t input_len,
422 unsigned char *secret_new )
423{
424 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
425 size_t hlen, ilen;
Hanno Becker59b50a12020-09-09 10:56:56 +0100426 unsigned char tmp_secret[ MBEDTLS_MD_MAX_SIZE ] = { 0 };
Jerry Yu6eaa41c2021-11-22 18:16:45 +0800427 unsigned char tmp_input [ MBEDTLS_ECP_MAX_BYTES ] = { 0 };
Hanno Beckere9cccb42020-08-20 13:42:46 +0100428
Xiaofei Baib7972842021-11-18 07:29:56 +0000429 const mbedtls_md_info_t *md_info;
430 md_info = mbedtls_md_info_from_type( hash_alg );
431 if( md_info == NULL )
Hanno Beckere9cccb42020-08-20 13:42:46 +0100432 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
433
Xiaofei Baib7972842021-11-18 07:29:56 +0000434 hlen = mbedtls_md_get_size( md_info );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100435
436 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100437 * on the old secret. */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100438 if( secret_old != NULL )
439 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000440 ret = mbedtls_ssl_tls13_derive_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100441 hash_alg,
442 secret_old, hlen,
443 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ),
444 NULL, 0, /* context */
445 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Hanno Becker59b50a12020-09-09 10:56:56 +0100446 tmp_secret, hlen );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100447 if( ret != 0 )
448 goto cleanup;
449 }
450
451 if( input != NULL )
452 {
Hanno Becker59b50a12020-09-09 10:56:56 +0100453 memcpy( tmp_input, input, input_len );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100454 ilen = input_len;
455 }
456 else
457 {
458 ilen = hlen;
459 }
460
461 /* HKDF-Extract takes a salt and input key material.
462 * The salt is the old secret, and the input key material
463 * is the input secret (PSK / ECDHE). */
Xiaofei Baib7972842021-11-18 07:29:56 +0000464 ret = mbedtls_hkdf_extract( md_info,
Hanno Becker59b50a12020-09-09 10:56:56 +0100465 tmp_secret, hlen,
466 tmp_input, ilen,
Hanno Beckere9cccb42020-08-20 13:42:46 +0100467 secret_new );
468 if( ret != 0 )
469 goto cleanup;
470
471 ret = 0;
472
473 cleanup:
474
Hanno Becker59b50a12020-09-09 10:56:56 +0100475 mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) );
476 mbedtls_platform_zeroize( tmp_input, sizeof(tmp_input) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100477 return( ret );
478}
479
Xiaofei Bai746f9482021-11-12 08:53:56 +0000480int mbedtls_ssl_tls13_derive_early_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100481 mbedtls_md_type_t md_type,
482 unsigned char const *early_secret,
483 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000484 mbedtls_ssl_tls13_early_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100485{
486 int ret;
487 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
488 size_t const md_size = mbedtls_md_get_size( md_info );
489
490 /* We should never call this function with an unknown hash,
491 * but add an assertion anyway. */
492 if( md_info == 0 )
493 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
494
495 /*
496 * 0
497 * |
498 * v
499 * PSK -> HKDF-Extract = Early Secret
500 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100501 * +-----> Derive-Secret(., "c e traffic", ClientHello)
502 * | = client_early_traffic_secret
503 * |
504 * +-----> Derive-Secret(., "e exp master", ClientHello)
505 * | = early_exporter_master_secret
506 * v
507 */
508
509 /* Create client_early_traffic_secret */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000510 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100511 early_secret, md_size,
512 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ),
513 transcript, transcript_len,
514 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
515 derived->client_early_traffic_secret,
516 md_size );
517 if( ret != 0 )
518 return( ret );
519
520 /* Create early exporter */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000521 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100522 early_secret, md_size,
523 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ),
524 transcript, transcript_len,
525 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
526 derived->early_exporter_master_secret,
527 md_size );
528 if( ret != 0 )
529 return( ret );
530
531 return( 0 );
532}
533
Xiaofei Bai746f9482021-11-12 08:53:56 +0000534int mbedtls_ssl_tls13_derive_handshake_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100535 mbedtls_md_type_t md_type,
536 unsigned char const *handshake_secret,
537 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000538 mbedtls_ssl_tls13_handshake_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100539{
540 int ret;
541 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
542 size_t const md_size = mbedtls_md_get_size( md_info );
543
544 /* We should never call this function with an unknown hash,
545 * but add an assertion anyway. */
546 if( md_info == 0 )
547 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
548
549 /*
550 *
551 * Handshake Secret
552 * |
553 * +-----> Derive-Secret( ., "c hs traffic",
554 * | ClientHello...ServerHello )
555 * | = client_handshake_traffic_secret
556 * |
557 * +-----> Derive-Secret( ., "s hs traffic",
558 * | ClientHello...ServerHello )
559 * | = server_handshake_traffic_secret
560 *
561 */
562
563 /*
564 * Compute client_handshake_traffic_secret with
565 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
566 */
567
Xiaofei Bai746f9482021-11-12 08:53:56 +0000568 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100569 handshake_secret, md_size,
570 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ),
571 transcript, transcript_len,
572 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
573 derived->client_handshake_traffic_secret,
574 md_size );
575 if( ret != 0 )
576 return( ret );
577
578 /*
579 * Compute server_handshake_traffic_secret with
580 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
581 */
582
Xiaofei Bai746f9482021-11-12 08:53:56 +0000583 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100584 handshake_secret, md_size,
585 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ),
586 transcript, transcript_len,
587 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
588 derived->server_handshake_traffic_secret,
589 md_size );
590 if( ret != 0 )
591 return( ret );
592
593 return( 0 );
594}
595
Xiaofei Bai746f9482021-11-12 08:53:56 +0000596int mbedtls_ssl_tls13_derive_application_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100597 mbedtls_md_type_t md_type,
598 unsigned char const *application_secret,
599 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000600 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100601{
602 int ret;
603 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
604 size_t const md_size = mbedtls_md_get_size( md_info );
605
606 /* We should never call this function with an unknown hash,
607 * but add an assertion anyway. */
608 if( md_info == 0 )
609 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
610
611 /* Generate {client,server}_application_traffic_secret_0
612 *
613 * Master Secret
614 * |
615 * +-----> Derive-Secret( ., "c ap traffic",
616 * | ClientHello...server Finished )
617 * | = client_application_traffic_secret_0
618 * |
619 * +-----> Derive-Secret( ., "s ap traffic",
620 * | ClientHello...Server Finished )
621 * | = server_application_traffic_secret_0
622 * |
623 * +-----> Derive-Secret( ., "exp master",
624 * | ClientHello...server Finished)
625 * | = exporter_master_secret
626 *
627 */
628
Xiaofei Bai746f9482021-11-12 08:53:56 +0000629 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100630 application_secret, md_size,
631 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ),
632 transcript, transcript_len,
633 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
634 derived->client_application_traffic_secret_N,
635 md_size );
636 if( ret != 0 )
637 return( ret );
638
Xiaofei Bai746f9482021-11-12 08:53:56 +0000639 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100640 application_secret, md_size,
641 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ),
642 transcript, transcript_len,
643 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
644 derived->server_application_traffic_secret_N,
645 md_size );
646 if( ret != 0 )
647 return( ret );
648
Xiaofei Bai746f9482021-11-12 08:53:56 +0000649 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100650 application_secret, md_size,
651 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ),
652 transcript, transcript_len,
653 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
654 derived->exporter_master_secret,
655 md_size );
656 if( ret != 0 )
657 return( ret );
658
659 return( 0 );
660}
661
662/* Generate resumption_master_secret for use with the ticket exchange.
663 *
Xiaofei Bai746f9482021-11-12 08:53:56 +0000664 * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets()
Hanno Beckeref5235b2021-05-24 06:39:41 +0100665 * because it uses the transcript hash up to and including ClientFinished. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000666int mbedtls_ssl_tls13_derive_resumption_master_secret(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100667 mbedtls_md_type_t md_type,
668 unsigned char const *application_secret,
669 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000670 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100671{
672 int ret;
673 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
674 size_t const md_size = mbedtls_md_get_size( md_info );
675
676 /* We should never call this function with an unknown hash,
677 * but add an assertion anyway. */
678 if( md_info == 0 )
679 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
680
Xiaofei Bai746f9482021-11-12 08:53:56 +0000681 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100682 application_secret, md_size,
683 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ),
684 transcript, transcript_len,
685 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
686 derived->resumption_master_secret,
687 md_size );
688
689 if( ret != 0 )
690 return( ret );
691
692 return( 0 );
693}
694
XiaokangQiana4c99f22021-11-11 06:46:35 +0000695int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000696{
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +0000698 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
699 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000700#if defined(MBEDTLS_DEBUG_C)
701 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
702 size_t const md_size = mbedtls_md_get_size( md_info );
703#endif /* MBEDTLS_DEBUG_C */
704
705 /*
706 * Compute MasterSecret
707 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000708 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000709 handshake->tls13_master_secrets.handshake,
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000710 NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000711 handshake->tls13_master_secrets.app );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000712 if( ret != 0 )
713 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000714 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000715 return( ret );
716 }
717
718 MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +0000719 handshake->tls13_master_secrets.app, md_size );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000720
721 return( 0 );
722}
723
Xiaofei Bai746f9482021-11-12 08:53:56 +0000724static int ssl_tls13_calc_finished_core( mbedtls_md_type_t md_type,
725 unsigned char const *base_key,
726 unsigned char const *transcript,
727 unsigned char *dst )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100728{
729 const mbedtls_md_info_t* const md_info = mbedtls_md_info_from_type( md_type );
730 size_t const md_size = mbedtls_md_get_size( md_info );
731 unsigned char finished_key[MBEDTLS_MD_MAX_SIZE];
732 int ret;
733
734 /* We should never call this function with an unknown hash,
735 * but add an assertion anyway. */
736 if( md_info == 0 )
737 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
738
739 /* TLS 1.3 Finished message
740 *
741 * struct {
742 * opaque verify_data[Hash.length];
743 * } Finished;
744 *
745 * verify_data =
746 * HMAC( finished_key,
747 * Hash( Handshake Context +
748 * Certificate* +
749 * CertificateVerify* )
750 * )
751 *
752 * finished_key =
753 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
754 */
755
Xiaofei Bai746f9482021-11-12 08:53:56 +0000756 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100757 md_type, base_key, md_size,
758 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ),
759 NULL, 0,
760 finished_key, md_size );
761 if( ret != 0 )
762 goto exit;
763
764 ret = mbedtls_md_hmac( md_info, finished_key, md_size, transcript, md_size, dst );
765 if( ret != 0 )
766 goto exit;
767
768exit:
769
770 mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) );
771 return( ret );
772}
773
XiaokangQianc5c39d52021-11-09 11:55:10 +0000774int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl,
XiaokangQianaaa0e192021-11-10 03:07:04 +0000775 unsigned char* dst,
776 size_t dst_len,
777 size_t *actual_len,
778 int from )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000779{
XiaokangQiana7634982021-10-22 06:32:32 +0000780 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000781
XiaokangQianaaa0e192021-11-10 03:07:04 +0000782 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000783 size_t transcript_len;
784
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800785 unsigned char *base_key = NULL;
Jerry Yub737f6a2021-12-10 17:55:23 +0800786 size_t base_key_len = 0;
Jerry Yu9c074732021-12-10 17:12:43 +0800787 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets =
788 &ssl->handshake->tls13_hs_secrets;
Jerry Yua5563f62021-12-10 18:14:36 +0800789
790 mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac;
791 const mbedtls_md_info_t* const md_info =
792 mbedtls_md_info_from_type( md_type );
793 size_t const md_size = mbedtls_md_get_size( md_info );
794
795 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) );
796
Jerry Yub737f6a2021-12-10 17:55:23 +0800797 if( from == MBEDTLS_SSL_IS_CLIENT )
798 {
799 base_key = tls13_hs_secrets->client_handshake_traffic_secret;
800 base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret );
801 }
802 else
803 {
804 base_key = tls13_hs_secrets->server_handshake_traffic_secret;
805 base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret );
806 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000807
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000808 if( dst_len < md_size )
Jerry Yu9c074732021-12-10 17:12:43 +0800809 {
810 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
811 goto exit;
812 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000813
814 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
815 transcript, sizeof( transcript ),
816 &transcript_len );
817 if( ret != 0 )
818 {
819 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000820 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000821 }
822 MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len );
823
Xiaofei Bai746f9482021-11-12 08:53:56 +0000824 ret = ssl_tls13_calc_finished_core( md_type, base_key, transcript, dst );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000825 if( ret != 0 )
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000826 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000827 *actual_len = md_size;
828
829 MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, md_size );
XiaokangQianc5c39d52021-11-09 11:55:10 +0000830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000831
832exit:
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800833 /* Erase handshake secrets */
Jerry Yub737f6a2021-12-10 17:55:23 +0800834 mbedtls_platform_zeroize( base_key, base_key_len );
XiaokangQian33062842021-11-11 03:37:45 +0000835 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000836 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000837}
838
Xiaofei Bai746f9482021-11-12 08:53:56 +0000839int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100840 const mbedtls_md_type_t md_type,
841 unsigned char const *psk, size_t psk_len,
842 int psk_type,
843 unsigned char const *transcript,
844 unsigned char *result )
845{
846 int ret = 0;
847 unsigned char binder_key[MBEDTLS_MD_MAX_SIZE];
848 unsigned char early_secret[MBEDTLS_MD_MAX_SIZE];
849 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type( md_type );
850 size_t const md_size = mbedtls_md_get_size( md_info );
851
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100852#if !defined(MBEDTLS_DEBUG_C)
853 ssl = NULL; /* make sure we don't use it except for debug */
854 ((void) ssl);
855#endif
856
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100857 /* We should never call this function with an unknown hash,
858 * but add an assertion anyway. */
859 if( md_info == 0 )
860 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
861
862 /*
863 * 0
864 * |
865 * v
866 * PSK -> HKDF-Extract = Early Secret
867 * |
868 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
869 * | = binder_key
870 * v
871 */
872
Xiaofei Bai746f9482021-11-12 08:53:56 +0000873 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
874 NULL, /* Old secret */
875 psk, psk_len, /* Input */
876 early_secret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100877 if( ret != 0 )
878 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000879 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100880 goto exit;
881 }
882
883 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
884 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000885 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100886 early_secret, md_size,
887 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ),
888 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
889 binder_key, md_size );
890 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) );
891 }
892 else
893 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000894 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100895 early_secret, md_size,
896 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ),
897 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
898 binder_key, md_size );
899 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) );
900 }
901
902 if( ret != 0 )
903 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000904 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100905 goto exit;
906 }
907
908 /*
909 * The binding_value is computed in the same way as the Finished message
910 * but with the BaseKey being the binder_key.
911 */
912
Xiaofei Bai746f9482021-11-12 08:53:56 +0000913 ret = ssl_tls13_calc_finished_core( md_type, binder_key, transcript, result );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100914 if( ret != 0 )
915 goto exit;
916
917 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, md_size );
918
919exit:
920
921 mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) );
922 mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) );
923 return( ret );
924}
925
Hanno Beckerc94060c2021-03-22 07:50:44 +0000926int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform,
927 int endpoint,
928 int ciphersuite,
929 mbedtls_ssl_key_set const *traffic_keys,
930 mbedtls_ssl_context *ssl /* DEBUG ONLY */ )
931{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100932#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000933 int ret;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100934#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000935 mbedtls_cipher_info_t const *cipher_info;
936 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
937 unsigned char const *key_enc;
938 unsigned char const *iv_enc;
939 unsigned char const *key_dec;
940 unsigned char const *iv_dec;
941
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100942#if defined(MBEDTLS_USE_PSA_CRYPTO)
943 psa_key_type_t key_type;
944 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
945 psa_algorithm_t alg;
946 size_t key_bits;
947 psa_status_t status = PSA_SUCCESS;
948#endif
949
Hanno Beckerc94060c2021-03-22 07:50:44 +0000950#if !defined(MBEDTLS_DEBUG_C)
951 ssl = NULL; /* make sure we don't use it except for those cases */
952 (void) ssl;
953#endif
954
955 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Hanno Becker7887a772021-04-20 05:27:57 +0100956 if( ciphersuite_info == NULL )
957 {
958 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
959 ciphersuite ) );
960 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
961 }
Hanno Beckerc94060c2021-03-22 07:50:44 +0000962
963 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
964 if( cipher_info == NULL )
965 {
Hanno Becker7887a772021-04-20 05:27:57 +0100966 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
967 ciphersuite_info->cipher ) );
Hanno Beckerf62a7302021-04-21 05:21:28 +0100968 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Beckerc94060c2021-03-22 07:50:44 +0000969 }
970
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100971#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000972 /*
973 * Setup cipher contexts in target transform
974 */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000975 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
976 cipher_info ) ) != 0 )
977 {
978 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
979 return( ret );
980 }
981
982 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
983 cipher_info ) ) != 0 )
984 {
985 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
986 return( ret );
987 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100988#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000989
990#if defined(MBEDTLS_SSL_SRV_C)
991 if( endpoint == MBEDTLS_SSL_IS_SERVER )
992 {
993 key_enc = traffic_keys->server_write_key;
994 key_dec = traffic_keys->client_write_key;
995 iv_enc = traffic_keys->server_write_iv;
996 iv_dec = traffic_keys->client_write_iv;
997 }
998 else
999#endif /* MBEDTLS_SSL_SRV_C */
1000#if defined(MBEDTLS_SSL_CLI_C)
1001 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
1002 {
1003 key_enc = traffic_keys->client_write_key;
1004 key_dec = traffic_keys->server_write_key;
1005 iv_enc = traffic_keys->client_write_iv;
1006 iv_dec = traffic_keys->server_write_iv;
1007 }
1008 else
1009#endif /* MBEDTLS_SSL_CLI_C */
1010 {
1011 /* should not happen */
1012 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1013 }
1014
1015 memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len );
1016 memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len );
1017
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001018#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001019 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc,
1020 key_enc, cipher_info->key_bitlen,
1021 MBEDTLS_ENCRYPT ) ) != 0 )
1022 {
1023 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1024 return( ret );
1025 }
1026
1027 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec,
1028 key_dec, cipher_info->key_bitlen,
1029 MBEDTLS_DECRYPT ) ) != 0 )
1030 {
1031 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1032 return( ret );
1033 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001034#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001035
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +01001036 /*
1037 * Setup other fields in SSL transform
1038 */
1039
1040 if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 )
1041 transform->taglen = 8;
1042 else
1043 transform->taglen = 16;
1044
1045 transform->ivlen = traffic_keys->iv_len;
1046 transform->maclen = 0;
1047 transform->fixed_ivlen = transform->ivlen;
1048 transform->minor_ver = MBEDTLS_SSL_MINOR_VERSION_4;
1049
1050 /* We add the true record content type (1 Byte) to the plaintext and
1051 * then pad to the configured granularity. The mimimum length of the
1052 * type-extended and padded plaintext is therefore the padding
1053 * granularity. */
1054 transform->minlen =
1055 transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY;
1056
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001057#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001058 /*
1059 * Setup psa keys and alg
1060 */
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001061 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001062 transform->taglen,
1063 &alg,
1064 &key_type,
1065 &key_bits ) ) != PSA_SUCCESS )
1066 {
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001067 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", psa_ssl_status_to_mbedtls( status ) );
1068 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001069 }
1070
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001071 transform->psa_alg = alg;
1072
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001073 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001074 {
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001075 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
1076 psa_set_key_algorithm( &attributes, alg );
1077 psa_set_key_type( &attributes, key_type );
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001078
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001079 if( ( status = psa_import_key( &attributes,
1080 key_enc,
1081 PSA_BITS_TO_BYTES( key_bits ),
1082 &transform->psa_key_enc ) ) != PSA_SUCCESS )
1083 {
1084 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1085 return( psa_ssl_status_to_mbedtls( status ) );
1086 }
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001087
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001088 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
1089
1090 if( ( status = psa_import_key( &attributes,
1091 key_dec,
1092 PSA_BITS_TO_BYTES( key_bits ),
1093 &transform->psa_key_dec ) ) != PSA_SUCCESS )
1094 {
1095 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1096 return( psa_ssl_status_to_mbedtls( status ) );
1097 }
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001098 }
1099#endif /* MBEDTLS_USE_PSA_CRYPTO */
1100
Hanno Beckerc94060c2021-03-22 07:50:44 +00001101 return( 0 );
1102}
1103
Xiaofei Bai746f9482021-11-12 08:53:56 +00001104int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl )
Jerry Yu89ea3212021-09-09 14:31:24 +08001105{
Jerry Yue3131ef2021-09-16 13:14:15 +08001106 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1107 mbedtls_md_type_t md_type;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001108 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu6ca7c7f2021-09-28 18:51:40 +08001109
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001110 if( handshake->ciphersuite_info == NULL )
Jerry Yu89ea3212021-09-09 14:31:24 +08001111 {
1112 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) );
1113 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1114 }
Jerry Yue3131ef2021-09-16 13:14:15 +08001115
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001116 md_type = handshake->ciphersuite_info->mac;
Jerry Yue06f4532021-09-23 18:35:07 +08001117
Xiaofei Bai746f9482021-11-12 08:53:56 +00001118 ret = mbedtls_ssl_tls13_evolve_secret( md_type, NULL, NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001119 handshake->tls13_master_secrets.early );
Jerry Yu89ea3212021-09-09 14:31:24 +08001120 if( ret != 0 )
1121 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001122 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yu89ea3212021-09-09 14:31:24 +08001123 return( ret );
1124 }
1125
1126 return( 0 );
1127}
1128
Jerry Yuc068b662021-10-11 22:30:19 +08001129/* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for
Jerry Yu61e35e02021-09-16 18:59:08 +08001130 * protecting the handshake messages, as described in Section 7 of TLS 1.3. */
Jerry Yuc068b662021-10-11 22:30:19 +08001131int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl,
1132 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu61e35e02021-09-16 18:59:08 +08001133{
1134 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1135
1136 mbedtls_md_type_t md_type;
1137 mbedtls_md_info_t const *md_info;
1138 size_t md_size;
1139
Jerry Yu435208a2021-10-13 11:22:16 +08001140 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu61e35e02021-09-16 18:59:08 +08001141 size_t transcript_len;
1142
1143 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001144 size_t key_len, iv_len;
Jerry Yu61e35e02021-09-16 18:59:08 +08001145
Jerry Yu435208a2021-10-13 11:22:16 +08001146 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1147 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
Xiaofei Bai746f9482021-11-12 08:53:56 +00001148 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets;
Jerry Yu435208a2021-10-13 11:22:16 +08001149
Jerry Yuc068b662021-10-11 22:30:19 +08001150 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001151
Jerry Yu435208a2021-10-13 11:22:16 +08001152 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001153 key_len = cipher_info->key_bitlen >> 3;
1154 iv_len = cipher_info->iv_size;
Jerry Yu61e35e02021-09-16 18:59:08 +08001155
Jerry Yu435208a2021-10-13 11:22:16 +08001156 md_type = ciphersuite_info->mac;
Jerry Yu61e35e02021-09-16 18:59:08 +08001157 md_info = mbedtls_md_info_from_type( md_type );
1158 md_size = mbedtls_md_get_size( md_info );
1159
1160 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1161 transcript,
1162 sizeof( transcript ),
1163 &transcript_len );
1164 if( ret != 0 )
1165 {
1166 MBEDTLS_SSL_DEBUG_RET( 1,
1167 "mbedtls_ssl_get_handshake_transcript",
1168 ret );
1169 return( ret );
1170 }
1171
Xiaofei Bai746f9482021-11-12 08:53:56 +00001172 ret = mbedtls_ssl_tls13_derive_handshake_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001173 handshake->tls13_master_secrets.handshake,
Jerry Yu435208a2021-10-13 11:22:16 +08001174 transcript, transcript_len, tls13_hs_secrets );
Jerry Yu61e35e02021-09-16 18:59:08 +08001175 if( ret != 0 )
1176 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001177 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets",
Jerry Yu61e35e02021-09-16 18:59:08 +08001178 ret );
1179 return( ret );
1180 }
1181
1182 MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001183 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001184 md_size );
Jerry Yu61e35e02021-09-16 18:59:08 +08001185 MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001186 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001187 md_size );
1188
1189 /*
1190 * Export client handshake traffic secret
1191 */
Jerry Yu61e35e02021-09-16 18:59:08 +08001192 if( ssl->f_export_keys != NULL )
1193 {
1194 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001195 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001196 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001197 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001198 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001199 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001200 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1201
1202 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001203 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001204 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001205 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001206 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001207 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001208 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1209 }
Jerry Yu61e35e02021-09-16 18:59:08 +08001210
Xiaofei Bai746f9482021-11-12 08:53:56 +00001211 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
Jerry Yu435208a2021-10-13 11:22:16 +08001212 tls13_hs_secrets->client_handshake_traffic_secret,
1213 tls13_hs_secrets->server_handshake_traffic_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +00001214 md_size, key_len, iv_len, traffic_keys );
Jerry Yu61e35e02021-09-16 18:59:08 +08001215 if( ret != 0 )
1216 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001217 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
Jerry Yu61e35e02021-09-16 18:59:08 +08001218 goto exit;
1219 }
1220
1221 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key",
1222 traffic_keys->client_write_key,
1223 traffic_keys->key_len);
1224
1225 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key",
1226 traffic_keys->server_write_key,
1227 traffic_keys->key_len);
1228
1229 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv",
1230 traffic_keys->client_write_iv,
1231 traffic_keys->iv_len);
1232
1233 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv",
1234 traffic_keys->server_write_iv,
1235 traffic_keys->iv_len);
1236
Jerry Yuc068b662021-10-11 22:30:19 +08001237 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001238
1239exit:
1240
1241 return( ret );
1242}
1243
Jerry Yuf0ac2352021-10-11 17:47:07 +08001244int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl )
Jerry Yua0650eb2021-09-09 17:14:45 +08001245{
Jerry Yuf0ac2352021-10-11 17:47:07 +08001246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001247 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1248 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
Jerry Yuf0ac2352021-10-11 17:47:07 +08001249 size_t ephemeral_len = 0;
1250 unsigned char ecdhe[MBEDTLS_ECP_MAX_BYTES];
Jerry Yua0650eb2021-09-09 17:14:45 +08001251#if defined(MBEDTLS_DEBUG_C)
1252 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
1253 size_t const md_size = mbedtls_md_get_size( md_info );
1254#endif /* MBEDTLS_DEBUG_C */
1255
Jerry Yuf0ac2352021-10-11 17:47:07 +08001256#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1257 /*
1258 * Compute ECDHE secret used to compute the handshake secret from which
1259 * client_handshake_traffic_secret and server_handshake_traffic_secret
1260 * are derived in the handshake secret derivation stage.
1261 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001262 if( mbedtls_ssl_tls13_ephemeral_enabled( ssl ) )
Jerry Yuf0ac2352021-10-11 17:47:07 +08001263 {
1264 if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) )
1265 {
1266#if defined(MBEDTLS_ECDH_C)
1267 ret = mbedtls_ecdh_calc_secret( &handshake->ecdh_ctx,
1268 &ephemeral_len, ecdhe, sizeof( ecdhe ),
1269 ssl->conf->f_rng,
1270 ssl->conf->p_rng );
1271 if( ret != 0 )
1272 {
1273 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
1274 return( ret );
1275 }
1276#endif /* MBEDTLS_ECDH_C */
1277 }
1278 else if( mbedtls_ssl_tls13_named_group_is_dhe( handshake->offered_group_id ) )
1279 {
Jerry Yuf0ac2352021-10-11 17:47:07 +08001280 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DHE not supported." ) );
1281 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1282 }
1283 }
1284#else
1285 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1286#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
Jerry Yua0650eb2021-09-09 17:14:45 +08001287
1288 /*
Jerry Yuf0ac2352021-10-11 17:47:07 +08001289 * Compute the Handshake Secret
Jerry Yua0650eb2021-09-09 17:14:45 +08001290 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001291 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001292 handshake->tls13_master_secrets.early,
Xiaofei Baib7972842021-11-18 07:29:56 +00001293 ecdhe, ephemeral_len,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001294 handshake->tls13_master_secrets.handshake );
Jerry Yua0650eb2021-09-09 17:14:45 +08001295 if( ret != 0 )
1296 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001297 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yua0650eb2021-09-09 17:14:45 +08001298 return( ret );
1299 }
1300
1301 MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +00001302 handshake->tls13_master_secrets.handshake, md_size );
Jerry Yua0650eb2021-09-09 17:14:45 +08001303
1304#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1305 mbedtls_platform_zeroize( ecdhe, sizeof( ecdhe ) );
1306#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
1307 return( 0 );
1308}
1309
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001310/* Generate application traffic keys since any records following a 1-RTT Finished message
1311 * MUST be encrypted under the application traffic key.
1312 */
XiaokangQiand0aa3e92021-11-10 06:17:40 +00001313int mbedtls_ssl_tls13_generate_application_keys(
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001314 mbedtls_ssl_context *ssl,
1315 mbedtls_ssl_key_set *traffic_keys )
1316{
XiaokangQiana7634982021-10-22 06:32:32 +00001317 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +00001318 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001319
1320 /* Address at which to store the application secrets */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001321 mbedtls_ssl_tls13_application_secrets * const app_secrets =
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001322 &ssl->session_negotiate->app_secrets;
1323
1324 /* Holding the transcript up to and including the ServerFinished */
XiaokangQian33062842021-11-11 03:37:45 +00001325 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001326 size_t transcript_len;
1327
1328 /* Variables relating to the hash for the chosen ciphersuite. */
1329 mbedtls_md_type_t md_type;
1330 mbedtls_md_info_t const *md_info;
1331 size_t md_size;
1332
1333 /* Variables relating to the cipher for the chosen ciphersuite. */
1334 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001335 size_t key_len, iv_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001336
1337 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) );
1338
1339 /* Extract basic information about hash and ciphersuite */
1340
1341 cipher_info = mbedtls_cipher_info_from_type(
XiaokangQian33062842021-11-11 03:37:45 +00001342 handshake->ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001343 key_len = cipher_info->key_bitlen / 8;
1344 iv_len = cipher_info->iv_size;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001345
XiaokangQian33062842021-11-11 03:37:45 +00001346 md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001347 md_info = mbedtls_md_info_from_type( md_type );
1348 md_size = mbedtls_md_get_size( md_info );
1349
1350 /* Compute current handshake transcript. It's the caller's responsiblity
1351 * to call this at the right time, that is, after the ServerFinished. */
1352
1353 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1354 transcript, sizeof( transcript ),
1355 &transcript_len );
1356 if( ret != 0 )
XiaokangQian4cab0242021-10-12 08:43:37 +00001357 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001358
1359 /* Compute application secrets from master secret and transcript hash. */
1360
Xiaofei Bai746f9482021-11-12 08:53:56 +00001361 ret = mbedtls_ssl_tls13_derive_application_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001362 handshake->tls13_master_secrets.app,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001363 transcript, transcript_len,
1364 app_secrets );
Jerry Yu4a2fa5d2021-12-10 10:19:34 +08001365 /* Erase master secrets */
Jerry Yu23ab7a42021-12-08 14:34:10 +08001366 mbedtls_platform_zeroize( &ssl->handshake->tls13_master_secrets,
Jerry Yu27224f52021-12-09 10:56:50 +08001367 sizeof( ssl->handshake->tls13_master_secrets ) );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001368 if( ret != 0 )
1369 {
1370 MBEDTLS_SSL_DEBUG_RET( 1,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001371 "mbedtls_ssl_tls13_derive_application_secrets", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001372 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001373 }
1374
1375 /* Derive first epoch of IV + Key for application traffic. */
1376
Xiaofei Bai746f9482021-11-12 08:53:56 +00001377 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001378 app_secrets->client_application_traffic_secret_N,
1379 app_secrets->server_application_traffic_secret_N,
Xiaofei Baib7972842021-11-18 07:29:56 +00001380 md_size, key_len, iv_len, traffic_keys );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001381 if( ret != 0 )
1382 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001383 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001384 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001385 }
1386
1387 MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret",
1388 app_secrets->client_application_traffic_secret_N,
1389 md_size );
1390
1391 MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret",
1392 app_secrets->server_application_traffic_secret_N,
1393 md_size );
1394
XiaokangQianac0385c2021-11-03 06:40:11 +00001395 /*
1396 * Export client/server application traffic secret 0
1397 */
1398 if( ssl->f_export_keys != NULL )
1399 {
1400 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001401 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001402 app_secrets->client_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001403 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001404 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001405 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1406 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001407
1408 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001409 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001410 app_secrets->server_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001411 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001412 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001413 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1414 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001415 }
1416
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001417 MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:",
Xiaofei Baib7972842021-11-18 07:29:56 +00001418 traffic_keys->client_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001419 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key",
Xiaofei Baib7972842021-11-18 07:29:56 +00001420 traffic_keys->server_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001421 MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001422 traffic_keys->client_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001423 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001424 traffic_keys->server_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001425
1426 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001427
1428 cleanup:
Jerry Yu2c70a392021-12-08 13:28:49 +08001429 /* randbytes is not used again */
1430 mbedtls_platform_zeroize( ssl->handshake->randbytes,
1431 sizeof( ssl->handshake->randbytes ) );
XiaokangQian33062842021-11-11 03:37:45 +00001432 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001433 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001434}
1435
Ronald Cron6f135e12021-12-08 16:57:54 +01001436#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */