blob: 33c2d1c66c231e84ad73770cc88490c2b439f73d [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 Mezeia3eecd22022-02-09 16:57:26 +0100139MBEDTLS_STATIC_TESTABLE
140psa_status_t mbedtls_psa_hkdf_expand( psa_algorithm_t alg,
141 const unsigned char *prk, size_t prk_len,
142 const unsigned char *info, size_t info_len,
143 unsigned char *okm, size_t okm_len )
144{
145 size_t hash_len;
146 size_t where = 0;
147 size_t n;
148 size_t t_len = 0;
149 size_t i;
150 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
151 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
152 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
153 psa_status_t ret = PSA_ERROR_CORRUPTION_DETECTED;
154 unsigned char t[PSA_MAC_MAX_SIZE];
155
156 if( okm == NULL )
157 {
158 return( PSA_ERROR_INVALID_ARGUMENT );
159 }
160
161 hash_len = PSA_HASH_LENGTH( alg );
162
163 if( prk_len < hash_len || hash_len == 0 )
164 {
165 return( PSA_ERROR_INVALID_ARGUMENT );
166 }
167
168 if( info == NULL )
169 {
170 info = (const unsigned char *) "";
171 info_len = 0;
172 }
173
174 n = okm_len / hash_len;
175
176 if( okm_len % hash_len != 0 )
177 {
178 n++;
179 }
180
181 /*
182 * Per RFC 5869 Section 2.3, okm_len must not exceed
183 * 255 times the hash length
184 */
185 if( n > 255 )
186 {
187 return( PSA_ERROR_INVALID_ARGUMENT );
188 }
189
190 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
191 psa_set_key_algorithm( &attributes, alg );
192 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
193
194 ret = psa_import_key( &attributes, prk, prk_len, &key );
195 if( PSA_SUCCESS != ret )
196 {
197 goto cleanup;
198 }
199
200 memset( t, 0, hash_len );
201
202 /*
203 * Compute T = T(1) | T(2) | T(3) | ... | T(N)
204 * Where T(N) is defined in RFC 5869 Section 2.3
205 */
206 for( i = 1; i <= n; i++ )
207 {
208 size_t num_to_copy;
209 unsigned char c = i & 0xff;
210 size_t len;
211
212 ret = psa_mac_sign_setup( &operation, key, alg );
213 if( PSA_SUCCESS != ret )
214 {
215 goto cleanup;
216 }
217
218 ret = psa_mac_update( &operation, t, t_len );
219 if( PSA_SUCCESS != ret )
220 {
221 goto cleanup;
222 }
223
224 ret = psa_mac_update( &operation, info, info_len );
225 if( PSA_SUCCESS != ret )
226 {
227 goto cleanup;
228 }
229
230 /* The constant concatenated to the end of each T(n) is a single octet.
231 * */
232 ret = psa_mac_update( &operation, &c, 1 );
233 if( PSA_SUCCESS != ret )
234 {
235 goto cleanup;
236 }
237
238 ret = psa_mac_sign_finish( &operation, t, PSA_MAC_MAX_SIZE, &len );
239 if( PSA_SUCCESS != ret )
240 {
241 goto cleanup;
242 }
243
244 num_to_copy = i != n ? hash_len : okm_len - where;
245 memcpy( okm + where, t, num_to_copy );
246 where += hash_len;
247 t_len = hash_len;
248 }
249
250cleanup:
251 psa_destroy_key( key );
252 mbedtls_platform_zeroize( t, sizeof( t ) );
253 psa_mac_abort( &operation );
254
255 return( ret );
256}
257
Xiaofei Bai746f9482021-11-12 08:53:56 +0000258int mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100259 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000260 const unsigned char *secret, size_t secret_len,
261 const unsigned char *label, size_t label_len,
262 const unsigned char *ctx, size_t ctx_len,
263 unsigned char *buf, size_t buf_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100264{
Xiaofei Baib7972842021-11-18 07:29:56 +0000265 const mbedtls_md_info_t *md_info;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100266 unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ];
267 size_t hkdf_label_len;
268
Xiaofei Baib7972842021-11-18 07:29:56 +0000269 if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100270 {
271 /* Should never happen since this is an internal
272 * function, and we know statically which labels
273 * are allowed. */
274 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
275 }
276
Xiaofei Baib7972842021-11-18 07:29:56 +0000277 if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100278 {
279 /* Should not happen, as above. */
280 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
281 }
282
Xiaofei Baib7972842021-11-18 07:29:56 +0000283 if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_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 md_info = mbedtls_md_info_from_type( hash_alg );
290 if( md_info == NULL )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100291 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
292
Xiaofei Baib7972842021-11-18 07:29:56 +0000293 ssl_tls13_hkdf_encode_label( buf_len,
294 label, label_len,
295 ctx, ctx_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000296 hkdf_label,
297 &hkdf_label_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100298
Xiaofei Baib7972842021-11-18 07:29:56 +0000299 return( mbedtls_hkdf_expand( md_info,
300 secret, secret_len,
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100301 hkdf_label, hkdf_label_len,
Xiaofei Baib7972842021-11-18 07:29:56 +0000302 buf, buf_len ) );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100303}
304
Hanno Becker3385a4d2020-08-21 13:03:34 +0100305/*
306 * The traffic keying material is generated from the following inputs:
307 *
308 * - One secret value per sender.
309 * - A purpose value indicating the specific value being generated
310 * - The desired lengths of key and IV.
311 *
312 * The expansion itself is based on HKDF:
313 *
314 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
315 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
316 *
317 * [sender] denotes the sending side and the Secret value is provided
318 * by the function caller. Note that we generate server and client side
319 * keys in a single function call.
320 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000321int mbedtls_ssl_tls13_make_traffic_keys(
Hanno Becker3385a4d2020-08-21 13:03:34 +0100322 mbedtls_md_type_t hash_alg,
323 const unsigned char *client_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +0000324 const unsigned char *server_secret, size_t secret_len,
325 size_t key_len, size_t iv_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100326 mbedtls_ssl_key_set *keys )
327{
328 int ret = 0;
329
Xiaofei Bai746f9482021-11-12 08:53:56 +0000330 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000331 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100332 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
333 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100334 keys->client_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100335 if( ret != 0 )
336 return( ret );
337
Xiaofei Bai746f9482021-11-12 08:53:56 +0000338 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000339 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100340 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
341 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100342 keys->server_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100343 if( ret != 0 )
344 return( ret );
345
Xiaofei Bai746f9482021-11-12 08:53:56 +0000346 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000347 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100348 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
349 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100350 keys->client_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100351 if( ret != 0 )
352 return( ret );
353
Xiaofei Bai746f9482021-11-12 08:53:56 +0000354 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000355 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100356 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
357 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100358 keys->server_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100359 if( ret != 0 )
360 return( ret );
361
Hanno Becker493ea7f2020-09-08 11:01:00 +0100362 keys->key_len = key_len;
363 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100364
365 return( 0 );
366}
367
Xiaofei Bai746f9482021-11-12 08:53:56 +0000368int mbedtls_ssl_tls13_derive_secret(
Hanno Beckerb35d5222020-08-21 13:27:44 +0100369 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000370 const unsigned char *secret, size_t secret_len,
371 const unsigned char *label, size_t label_len,
372 const unsigned char *ctx, size_t ctx_len,
Hanno Becker0c42fd92020-09-09 12:58:29 +0100373 int ctx_hashed,
Xiaofei Baib7972842021-11-18 07:29:56 +0000374 unsigned char *dstbuf, size_t dstbuf_len )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100375{
376 int ret;
377 unsigned char hashed_context[ MBEDTLS_MD_MAX_SIZE ];
378
Xiaofei Baib7972842021-11-18 07:29:56 +0000379 const mbedtls_md_info_t *md_info;
380 md_info = mbedtls_md_info_from_type( hash_alg );
381 if( md_info == NULL )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100382 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
383
Hanno Becker0c42fd92020-09-09 12:58:29 +0100384 if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100385 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000386 ret = mbedtls_md( md_info, ctx, ctx_len, hashed_context );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100387 if( ret != 0 )
388 return( ret );
Xiaofei Baib7972842021-11-18 07:29:56 +0000389 ctx_len = mbedtls_md_get_size( md_info );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100390 }
391 else
392 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000393 if( ctx_len > sizeof(hashed_context) )
Hanno Becker97a21562020-09-09 12:57:16 +0100394 {
395 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100396 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100397 * Let's double-check nonetheless to not run at the risk
398 * of getting a stack overflow. */
Hanno Beckerb35d5222020-08-21 13:27:44 +0100399 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Becker97a21562020-09-09 12:57:16 +0100400 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100401
Xiaofei Baib7972842021-11-18 07:29:56 +0000402 memcpy( hashed_context, ctx, ctx_len );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100403 }
404
Xiaofei Bai746f9482021-11-12 08:53:56 +0000405 return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000406 secret, secret_len,
407 label, label_len,
408 hashed_context, ctx_len,
409 dstbuf, dstbuf_len ) );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100410}
411
Xiaofei Bai746f9482021-11-12 08:53:56 +0000412int mbedtls_ssl_tls13_evolve_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100413 mbedtls_md_type_t hash_alg,
414 const unsigned char *secret_old,
415 const unsigned char *input, size_t input_len,
416 unsigned char *secret_new )
417{
418 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
419 size_t hlen, ilen;
Hanno Becker59b50a12020-09-09 10:56:56 +0100420 unsigned char tmp_secret[ MBEDTLS_MD_MAX_SIZE ] = { 0 };
Jerry Yu6eaa41c2021-11-22 18:16:45 +0800421 unsigned char tmp_input [ MBEDTLS_ECP_MAX_BYTES ] = { 0 };
Hanno Beckere9cccb42020-08-20 13:42:46 +0100422
Xiaofei Baib7972842021-11-18 07:29:56 +0000423 const mbedtls_md_info_t *md_info;
424 md_info = mbedtls_md_info_from_type( hash_alg );
425 if( md_info == NULL )
Hanno Beckere9cccb42020-08-20 13:42:46 +0100426 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
427
Xiaofei Baib7972842021-11-18 07:29:56 +0000428 hlen = mbedtls_md_get_size( md_info );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100429
430 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100431 * on the old secret. */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100432 if( secret_old != NULL )
433 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000434 ret = mbedtls_ssl_tls13_derive_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100435 hash_alg,
436 secret_old, hlen,
437 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ),
438 NULL, 0, /* context */
439 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Hanno Becker59b50a12020-09-09 10:56:56 +0100440 tmp_secret, hlen );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100441 if( ret != 0 )
442 goto cleanup;
443 }
444
445 if( input != NULL )
446 {
Hanno Becker59b50a12020-09-09 10:56:56 +0100447 memcpy( tmp_input, input, input_len );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100448 ilen = input_len;
449 }
450 else
451 {
452 ilen = hlen;
453 }
454
455 /* HKDF-Extract takes a salt and input key material.
456 * The salt is the old secret, and the input key material
457 * is the input secret (PSK / ECDHE). */
Xiaofei Baib7972842021-11-18 07:29:56 +0000458 ret = mbedtls_hkdf_extract( md_info,
Hanno Becker59b50a12020-09-09 10:56:56 +0100459 tmp_secret, hlen,
460 tmp_input, ilen,
Hanno Beckere9cccb42020-08-20 13:42:46 +0100461 secret_new );
462 if( ret != 0 )
463 goto cleanup;
464
465 ret = 0;
466
467 cleanup:
468
Hanno Becker59b50a12020-09-09 10:56:56 +0100469 mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) );
470 mbedtls_platform_zeroize( tmp_input, sizeof(tmp_input) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100471 return( ret );
472}
473
Xiaofei Bai746f9482021-11-12 08:53:56 +0000474int mbedtls_ssl_tls13_derive_early_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100475 mbedtls_md_type_t md_type,
476 unsigned char const *early_secret,
477 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000478 mbedtls_ssl_tls13_early_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100479{
480 int ret;
481 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
482 size_t const md_size = mbedtls_md_get_size( md_info );
483
484 /* We should never call this function with an unknown hash,
485 * but add an assertion anyway. */
486 if( md_info == 0 )
487 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
488
489 /*
490 * 0
491 * |
492 * v
493 * PSK -> HKDF-Extract = Early Secret
494 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100495 * +-----> Derive-Secret(., "c e traffic", ClientHello)
496 * | = client_early_traffic_secret
497 * |
498 * +-----> Derive-Secret(., "e exp master", ClientHello)
499 * | = early_exporter_master_secret
500 * v
501 */
502
503 /* Create client_early_traffic_secret */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000504 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100505 early_secret, md_size,
506 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ),
507 transcript, transcript_len,
508 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
509 derived->client_early_traffic_secret,
510 md_size );
511 if( ret != 0 )
512 return( ret );
513
514 /* Create early exporter */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000515 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100516 early_secret, md_size,
517 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ),
518 transcript, transcript_len,
519 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
520 derived->early_exporter_master_secret,
521 md_size );
522 if( ret != 0 )
523 return( ret );
524
525 return( 0 );
526}
527
Xiaofei Bai746f9482021-11-12 08:53:56 +0000528int mbedtls_ssl_tls13_derive_handshake_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100529 mbedtls_md_type_t md_type,
530 unsigned char const *handshake_secret,
531 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000532 mbedtls_ssl_tls13_handshake_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100533{
534 int ret;
535 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
536 size_t const md_size = mbedtls_md_get_size( md_info );
537
538 /* We should never call this function with an unknown hash,
539 * but add an assertion anyway. */
540 if( md_info == 0 )
541 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
542
543 /*
544 *
545 * Handshake Secret
546 * |
547 * +-----> Derive-Secret( ., "c hs traffic",
548 * | ClientHello...ServerHello )
549 * | = client_handshake_traffic_secret
550 * |
551 * +-----> Derive-Secret( ., "s hs traffic",
552 * | ClientHello...ServerHello )
553 * | = server_handshake_traffic_secret
554 *
555 */
556
557 /*
558 * Compute client_handshake_traffic_secret with
559 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
560 */
561
Xiaofei Bai746f9482021-11-12 08:53:56 +0000562 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100563 handshake_secret, md_size,
564 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ),
565 transcript, transcript_len,
566 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
567 derived->client_handshake_traffic_secret,
568 md_size );
569 if( ret != 0 )
570 return( ret );
571
572 /*
573 * Compute server_handshake_traffic_secret with
574 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
575 */
576
Xiaofei Bai746f9482021-11-12 08:53:56 +0000577 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100578 handshake_secret, md_size,
579 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ),
580 transcript, transcript_len,
581 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
582 derived->server_handshake_traffic_secret,
583 md_size );
584 if( ret != 0 )
585 return( ret );
586
587 return( 0 );
588}
589
Xiaofei Bai746f9482021-11-12 08:53:56 +0000590int mbedtls_ssl_tls13_derive_application_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100591 mbedtls_md_type_t md_type,
592 unsigned char const *application_secret,
593 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000594 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100595{
596 int ret;
597 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
598 size_t const md_size = mbedtls_md_get_size( md_info );
599
600 /* We should never call this function with an unknown hash,
601 * but add an assertion anyway. */
602 if( md_info == 0 )
603 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
604
605 /* Generate {client,server}_application_traffic_secret_0
606 *
607 * Master Secret
608 * |
609 * +-----> Derive-Secret( ., "c ap traffic",
610 * | ClientHello...server Finished )
611 * | = client_application_traffic_secret_0
612 * |
613 * +-----> Derive-Secret( ., "s ap traffic",
614 * | ClientHello...Server Finished )
615 * | = server_application_traffic_secret_0
616 * |
617 * +-----> Derive-Secret( ., "exp master",
618 * | ClientHello...server Finished)
619 * | = exporter_master_secret
620 *
621 */
622
Xiaofei Bai746f9482021-11-12 08:53:56 +0000623 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100624 application_secret, md_size,
625 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ),
626 transcript, transcript_len,
627 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
628 derived->client_application_traffic_secret_N,
629 md_size );
630 if( ret != 0 )
631 return( ret );
632
Xiaofei Bai746f9482021-11-12 08:53:56 +0000633 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100634 application_secret, md_size,
635 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ),
636 transcript, transcript_len,
637 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
638 derived->server_application_traffic_secret_N,
639 md_size );
640 if( ret != 0 )
641 return( ret );
642
Xiaofei Bai746f9482021-11-12 08:53:56 +0000643 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100644 application_secret, md_size,
645 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ),
646 transcript, transcript_len,
647 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
648 derived->exporter_master_secret,
649 md_size );
650 if( ret != 0 )
651 return( ret );
652
653 return( 0 );
654}
655
656/* Generate resumption_master_secret for use with the ticket exchange.
657 *
Xiaofei Bai746f9482021-11-12 08:53:56 +0000658 * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets()
Hanno Beckeref5235b2021-05-24 06:39:41 +0100659 * because it uses the transcript hash up to and including ClientFinished. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000660int mbedtls_ssl_tls13_derive_resumption_master_secret(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100661 mbedtls_md_type_t md_type,
662 unsigned char const *application_secret,
663 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000664 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100665{
666 int ret;
667 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
668 size_t const md_size = mbedtls_md_get_size( md_info );
669
670 /* We should never call this function with an unknown hash,
671 * but add an assertion anyway. */
672 if( md_info == 0 )
673 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
674
Xiaofei Bai746f9482021-11-12 08:53:56 +0000675 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100676 application_secret, md_size,
677 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ),
678 transcript, transcript_len,
679 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
680 derived->resumption_master_secret,
681 md_size );
682
683 if( ret != 0 )
684 return( ret );
685
686 return( 0 );
687}
688
XiaokangQiana4c99f22021-11-11 06:46:35 +0000689int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000690{
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000691 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +0000692 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
693 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000694#if defined(MBEDTLS_DEBUG_C)
695 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
696 size_t const md_size = mbedtls_md_get_size( md_info );
697#endif /* MBEDTLS_DEBUG_C */
698
699 /*
700 * Compute MasterSecret
701 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000702 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000703 handshake->tls13_master_secrets.handshake,
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000704 NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000705 handshake->tls13_master_secrets.app );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000706 if( ret != 0 )
707 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000708 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000709 return( ret );
710 }
711
712 MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +0000713 handshake->tls13_master_secrets.app, md_size );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000714
715 return( 0 );
716}
717
Xiaofei Bai746f9482021-11-12 08:53:56 +0000718static int ssl_tls13_calc_finished_core( mbedtls_md_type_t md_type,
719 unsigned char const *base_key,
720 unsigned char const *transcript,
721 unsigned char *dst )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100722{
723 const mbedtls_md_info_t* const md_info = mbedtls_md_info_from_type( md_type );
724 size_t const md_size = mbedtls_md_get_size( md_info );
725 unsigned char finished_key[MBEDTLS_MD_MAX_SIZE];
726 int ret;
727
728 /* We should never call this function with an unknown hash,
729 * but add an assertion anyway. */
730 if( md_info == 0 )
731 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
732
733 /* TLS 1.3 Finished message
734 *
735 * struct {
736 * opaque verify_data[Hash.length];
737 * } Finished;
738 *
739 * verify_data =
740 * HMAC( finished_key,
741 * Hash( Handshake Context +
742 * Certificate* +
743 * CertificateVerify* )
744 * )
745 *
746 * finished_key =
747 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
748 */
749
Xiaofei Bai746f9482021-11-12 08:53:56 +0000750 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100751 md_type, base_key, md_size,
752 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ),
753 NULL, 0,
754 finished_key, md_size );
755 if( ret != 0 )
756 goto exit;
757
758 ret = mbedtls_md_hmac( md_info, finished_key, md_size, transcript, md_size, dst );
759 if( ret != 0 )
760 goto exit;
761
762exit:
763
764 mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) );
765 return( ret );
766}
767
XiaokangQianc5c39d52021-11-09 11:55:10 +0000768int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl,
XiaokangQianaaa0e192021-11-10 03:07:04 +0000769 unsigned char* dst,
770 size_t dst_len,
771 size_t *actual_len,
772 int from )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000773{
XiaokangQiana7634982021-10-22 06:32:32 +0000774 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000775
XiaokangQianaaa0e192021-11-10 03:07:04 +0000776 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000777 size_t transcript_len;
778
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800779 unsigned char *base_key = NULL;
Jerry Yub737f6a2021-12-10 17:55:23 +0800780 size_t base_key_len = 0;
Jerry Yu9c074732021-12-10 17:12:43 +0800781 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets =
782 &ssl->handshake->tls13_hs_secrets;
Jerry Yua5563f62021-12-10 18:14:36 +0800783
784 mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac;
785 const mbedtls_md_info_t* const md_info =
786 mbedtls_md_info_from_type( md_type );
787 size_t const md_size = mbedtls_md_get_size( md_info );
788
789 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) );
790
Jerry Yub737f6a2021-12-10 17:55:23 +0800791 if( from == MBEDTLS_SSL_IS_CLIENT )
792 {
793 base_key = tls13_hs_secrets->client_handshake_traffic_secret;
794 base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret );
795 }
796 else
797 {
798 base_key = tls13_hs_secrets->server_handshake_traffic_secret;
799 base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret );
800 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000801
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000802 if( dst_len < md_size )
Jerry Yu9c074732021-12-10 17:12:43 +0800803 {
804 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
805 goto exit;
806 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000807
808 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
809 transcript, sizeof( transcript ),
810 &transcript_len );
811 if( ret != 0 )
812 {
813 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000814 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000815 }
816 MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len );
817
Xiaofei Bai746f9482021-11-12 08:53:56 +0000818 ret = ssl_tls13_calc_finished_core( md_type, base_key, transcript, dst );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000819 if( ret != 0 )
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000820 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000821 *actual_len = md_size;
822
823 MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, md_size );
XiaokangQianc5c39d52021-11-09 11:55:10 +0000824 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000825
826exit:
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800827 /* Erase handshake secrets */
Jerry Yub737f6a2021-12-10 17:55:23 +0800828 mbedtls_platform_zeroize( base_key, base_key_len );
XiaokangQian33062842021-11-11 03:37:45 +0000829 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000830 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000831}
832
Xiaofei Bai746f9482021-11-12 08:53:56 +0000833int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100834 const mbedtls_md_type_t md_type,
835 unsigned char const *psk, size_t psk_len,
836 int psk_type,
837 unsigned char const *transcript,
838 unsigned char *result )
839{
840 int ret = 0;
841 unsigned char binder_key[MBEDTLS_MD_MAX_SIZE];
842 unsigned char early_secret[MBEDTLS_MD_MAX_SIZE];
843 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type( md_type );
844 size_t const md_size = mbedtls_md_get_size( md_info );
845
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100846#if !defined(MBEDTLS_DEBUG_C)
847 ssl = NULL; /* make sure we don't use it except for debug */
848 ((void) ssl);
849#endif
850
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100851 /* We should never call this function with an unknown hash,
852 * but add an assertion anyway. */
853 if( md_info == 0 )
854 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
855
856 /*
857 * 0
858 * |
859 * v
860 * PSK -> HKDF-Extract = Early Secret
861 * |
862 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
863 * | = binder_key
864 * v
865 */
866
Xiaofei Bai746f9482021-11-12 08:53:56 +0000867 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
868 NULL, /* Old secret */
869 psk, psk_len, /* Input */
870 early_secret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100871 if( ret != 0 )
872 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000873 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100874 goto exit;
875 }
876
877 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
878 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000879 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100880 early_secret, md_size,
881 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ),
882 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
883 binder_key, md_size );
884 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) );
885 }
886 else
887 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000888 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100889 early_secret, md_size,
890 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ),
891 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
892 binder_key, md_size );
893 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) );
894 }
895
896 if( ret != 0 )
897 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000898 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100899 goto exit;
900 }
901
902 /*
903 * The binding_value is computed in the same way as the Finished message
904 * but with the BaseKey being the binder_key.
905 */
906
Xiaofei Bai746f9482021-11-12 08:53:56 +0000907 ret = ssl_tls13_calc_finished_core( md_type, binder_key, transcript, result );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100908 if( ret != 0 )
909 goto exit;
910
911 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, md_size );
912
913exit:
914
915 mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) );
916 mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) );
917 return( ret );
918}
919
Hanno Beckerc94060c2021-03-22 07:50:44 +0000920int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform,
921 int endpoint,
922 int ciphersuite,
923 mbedtls_ssl_key_set const *traffic_keys,
924 mbedtls_ssl_context *ssl /* DEBUG ONLY */ )
925{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100926#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000927 int ret;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100928#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000929 mbedtls_cipher_info_t const *cipher_info;
930 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
931 unsigned char const *key_enc;
932 unsigned char const *iv_enc;
933 unsigned char const *key_dec;
934 unsigned char const *iv_dec;
935
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100936#if defined(MBEDTLS_USE_PSA_CRYPTO)
937 psa_key_type_t key_type;
938 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
939 psa_algorithm_t alg;
940 size_t key_bits;
941 psa_status_t status = PSA_SUCCESS;
942#endif
943
Hanno Beckerc94060c2021-03-22 07:50:44 +0000944#if !defined(MBEDTLS_DEBUG_C)
945 ssl = NULL; /* make sure we don't use it except for those cases */
946 (void) ssl;
947#endif
948
949 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Hanno Becker7887a772021-04-20 05:27:57 +0100950 if( ciphersuite_info == NULL )
951 {
952 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
953 ciphersuite ) );
954 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
955 }
Hanno Beckerc94060c2021-03-22 07:50:44 +0000956
957 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
958 if( cipher_info == NULL )
959 {
Hanno Becker7887a772021-04-20 05:27:57 +0100960 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
961 ciphersuite_info->cipher ) );
Hanno Beckerf62a7302021-04-21 05:21:28 +0100962 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Beckerc94060c2021-03-22 07:50:44 +0000963 }
964
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100965#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000966 /*
967 * Setup cipher contexts in target transform
968 */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000969 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
970 cipher_info ) ) != 0 )
971 {
972 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
973 return( ret );
974 }
975
976 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
977 cipher_info ) ) != 0 )
978 {
979 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
980 return( ret );
981 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100982#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000983
984#if defined(MBEDTLS_SSL_SRV_C)
985 if( endpoint == MBEDTLS_SSL_IS_SERVER )
986 {
987 key_enc = traffic_keys->server_write_key;
988 key_dec = traffic_keys->client_write_key;
989 iv_enc = traffic_keys->server_write_iv;
990 iv_dec = traffic_keys->client_write_iv;
991 }
992 else
993#endif /* MBEDTLS_SSL_SRV_C */
994#if defined(MBEDTLS_SSL_CLI_C)
995 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
996 {
997 key_enc = traffic_keys->client_write_key;
998 key_dec = traffic_keys->server_write_key;
999 iv_enc = traffic_keys->client_write_iv;
1000 iv_dec = traffic_keys->server_write_iv;
1001 }
1002 else
1003#endif /* MBEDTLS_SSL_CLI_C */
1004 {
1005 /* should not happen */
1006 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1007 }
1008
1009 memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len );
1010 memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len );
1011
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001012#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +00001013 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc,
1014 key_enc, cipher_info->key_bitlen,
1015 MBEDTLS_ENCRYPT ) ) != 0 )
1016 {
1017 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1018 return( ret );
1019 }
1020
1021 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec,
1022 key_dec, cipher_info->key_bitlen,
1023 MBEDTLS_DECRYPT ) ) != 0 )
1024 {
1025 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
1026 return( ret );
1027 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001028#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +00001029
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +01001030 /*
1031 * Setup other fields in SSL transform
1032 */
1033
1034 if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 )
1035 transform->taglen = 8;
1036 else
1037 transform->taglen = 16;
1038
1039 transform->ivlen = traffic_keys->iv_len;
1040 transform->maclen = 0;
1041 transform->fixed_ivlen = transform->ivlen;
1042 transform->minor_ver = MBEDTLS_SSL_MINOR_VERSION_4;
1043
1044 /* We add the true record content type (1 Byte) to the plaintext and
1045 * then pad to the configured granularity. The mimimum length of the
1046 * type-extended and padded plaintext is therefore the padding
1047 * granularity. */
1048 transform->minlen =
1049 transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY;
1050
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001051#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001052 /*
1053 * Setup psa keys and alg
1054 */
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001055 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001056 transform->taglen,
1057 &alg,
1058 &key_type,
1059 &key_bits ) ) != PSA_SUCCESS )
1060 {
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001061 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", psa_ssl_status_to_mbedtls( status ) );
1062 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001063 }
1064
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001065 transform->psa_alg = alg;
1066
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001067 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001068 {
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001069 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
1070 psa_set_key_algorithm( &attributes, alg );
1071 psa_set_key_type( &attributes, key_type );
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001072
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001073 if( ( status = psa_import_key( &attributes,
1074 key_enc,
1075 PSA_BITS_TO_BYTES( key_bits ),
1076 &transform->psa_key_enc ) ) != PSA_SUCCESS )
1077 {
1078 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1079 return( psa_ssl_status_to_mbedtls( status ) );
1080 }
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001081
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001082 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
1083
1084 if( ( status = psa_import_key( &attributes,
1085 key_dec,
1086 PSA_BITS_TO_BYTES( key_bits ),
1087 &transform->psa_key_dec ) ) != PSA_SUCCESS )
1088 {
1089 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1090 return( psa_ssl_status_to_mbedtls( status ) );
1091 }
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001092 }
1093#endif /* MBEDTLS_USE_PSA_CRYPTO */
1094
Hanno Beckerc94060c2021-03-22 07:50:44 +00001095 return( 0 );
1096}
1097
Xiaofei Bai746f9482021-11-12 08:53:56 +00001098int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl )
Jerry Yu89ea3212021-09-09 14:31:24 +08001099{
Jerry Yue3131ef2021-09-16 13:14:15 +08001100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1101 mbedtls_md_type_t md_type;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001102 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu6ca7c7f2021-09-28 18:51:40 +08001103
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001104 if( handshake->ciphersuite_info == NULL )
Jerry Yu89ea3212021-09-09 14:31:24 +08001105 {
1106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) );
1107 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1108 }
Jerry Yue3131ef2021-09-16 13:14:15 +08001109
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001110 md_type = handshake->ciphersuite_info->mac;
Jerry Yue06f4532021-09-23 18:35:07 +08001111
Xiaofei Bai746f9482021-11-12 08:53:56 +00001112 ret = mbedtls_ssl_tls13_evolve_secret( md_type, NULL, NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001113 handshake->tls13_master_secrets.early );
Jerry Yu89ea3212021-09-09 14:31:24 +08001114 if( ret != 0 )
1115 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001116 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yu89ea3212021-09-09 14:31:24 +08001117 return( ret );
1118 }
1119
1120 return( 0 );
1121}
1122
Jerry Yuc068b662021-10-11 22:30:19 +08001123/* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for
Jerry Yu61e35e02021-09-16 18:59:08 +08001124 * protecting the handshake messages, as described in Section 7 of TLS 1.3. */
Jerry Yuc068b662021-10-11 22:30:19 +08001125int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl,
1126 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu61e35e02021-09-16 18:59:08 +08001127{
1128 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1129
1130 mbedtls_md_type_t md_type;
1131 mbedtls_md_info_t const *md_info;
1132 size_t md_size;
1133
Jerry Yu435208a2021-10-13 11:22:16 +08001134 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu61e35e02021-09-16 18:59:08 +08001135 size_t transcript_len;
1136
1137 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001138 size_t key_len, iv_len;
Jerry Yu61e35e02021-09-16 18:59:08 +08001139
Jerry Yu435208a2021-10-13 11:22:16 +08001140 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1141 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
Xiaofei Bai746f9482021-11-12 08:53:56 +00001142 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets;
Jerry Yu435208a2021-10-13 11:22:16 +08001143
Jerry Yuc068b662021-10-11 22:30:19 +08001144 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001145
Jerry Yu435208a2021-10-13 11:22:16 +08001146 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001147 key_len = cipher_info->key_bitlen >> 3;
1148 iv_len = cipher_info->iv_size;
Jerry Yu61e35e02021-09-16 18:59:08 +08001149
Jerry Yu435208a2021-10-13 11:22:16 +08001150 md_type = ciphersuite_info->mac;
Jerry Yu61e35e02021-09-16 18:59:08 +08001151 md_info = mbedtls_md_info_from_type( md_type );
1152 md_size = mbedtls_md_get_size( md_info );
1153
1154 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1155 transcript,
1156 sizeof( transcript ),
1157 &transcript_len );
1158 if( ret != 0 )
1159 {
1160 MBEDTLS_SSL_DEBUG_RET( 1,
1161 "mbedtls_ssl_get_handshake_transcript",
1162 ret );
1163 return( ret );
1164 }
1165
Xiaofei Bai746f9482021-11-12 08:53:56 +00001166 ret = mbedtls_ssl_tls13_derive_handshake_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001167 handshake->tls13_master_secrets.handshake,
Jerry Yu435208a2021-10-13 11:22:16 +08001168 transcript, transcript_len, tls13_hs_secrets );
Jerry Yu61e35e02021-09-16 18:59:08 +08001169 if( ret != 0 )
1170 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001171 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets",
Jerry Yu61e35e02021-09-16 18:59:08 +08001172 ret );
1173 return( ret );
1174 }
1175
1176 MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001177 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001178 md_size );
Jerry Yu61e35e02021-09-16 18:59:08 +08001179 MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001180 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001181 md_size );
1182
1183 /*
1184 * Export client handshake traffic secret
1185 */
Jerry Yu61e35e02021-09-16 18:59:08 +08001186 if( ssl->f_export_keys != NULL )
1187 {
1188 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001189 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001190 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001191 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001192 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001193 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001194 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1195
1196 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001197 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001198 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001199 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001200 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001201 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001202 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1203 }
Jerry Yu61e35e02021-09-16 18:59:08 +08001204
Xiaofei Bai746f9482021-11-12 08:53:56 +00001205 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
Jerry Yu435208a2021-10-13 11:22:16 +08001206 tls13_hs_secrets->client_handshake_traffic_secret,
1207 tls13_hs_secrets->server_handshake_traffic_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +00001208 md_size, key_len, iv_len, traffic_keys );
Jerry Yu61e35e02021-09-16 18:59:08 +08001209 if( ret != 0 )
1210 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001211 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
Jerry Yu61e35e02021-09-16 18:59:08 +08001212 goto exit;
1213 }
1214
1215 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key",
1216 traffic_keys->client_write_key,
1217 traffic_keys->key_len);
1218
1219 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key",
1220 traffic_keys->server_write_key,
1221 traffic_keys->key_len);
1222
1223 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv",
1224 traffic_keys->client_write_iv,
1225 traffic_keys->iv_len);
1226
1227 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv",
1228 traffic_keys->server_write_iv,
1229 traffic_keys->iv_len);
1230
Jerry Yuc068b662021-10-11 22:30:19 +08001231 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001232
1233exit:
1234
1235 return( ret );
1236}
1237
Jerry Yuf0ac2352021-10-11 17:47:07 +08001238int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl )
Jerry Yua0650eb2021-09-09 17:14:45 +08001239{
Jerry Yuf0ac2352021-10-11 17:47:07 +08001240 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001241 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1242 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
Jerry Yuf0ac2352021-10-11 17:47:07 +08001243 size_t ephemeral_len = 0;
1244 unsigned char ecdhe[MBEDTLS_ECP_MAX_BYTES];
Jerry Yua0650eb2021-09-09 17:14:45 +08001245#if defined(MBEDTLS_DEBUG_C)
1246 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
1247 size_t const md_size = mbedtls_md_get_size( md_info );
1248#endif /* MBEDTLS_DEBUG_C */
1249
Jerry Yuf0ac2352021-10-11 17:47:07 +08001250#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1251 /*
1252 * Compute ECDHE secret used to compute the handshake secret from which
1253 * client_handshake_traffic_secret and server_handshake_traffic_secret
1254 * are derived in the handshake secret derivation stage.
1255 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001256 if( mbedtls_ssl_tls13_ephemeral_enabled( ssl ) )
Jerry Yuf0ac2352021-10-11 17:47:07 +08001257 {
1258 if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) )
1259 {
1260#if defined(MBEDTLS_ECDH_C)
1261 ret = mbedtls_ecdh_calc_secret( &handshake->ecdh_ctx,
1262 &ephemeral_len, ecdhe, sizeof( ecdhe ),
1263 ssl->conf->f_rng,
1264 ssl->conf->p_rng );
1265 if( ret != 0 )
1266 {
1267 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
1268 return( ret );
1269 }
1270#endif /* MBEDTLS_ECDH_C */
1271 }
1272 else if( mbedtls_ssl_tls13_named_group_is_dhe( handshake->offered_group_id ) )
1273 {
Jerry Yuf0ac2352021-10-11 17:47:07 +08001274 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DHE not supported." ) );
1275 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1276 }
1277 }
1278#else
1279 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1280#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
Jerry Yua0650eb2021-09-09 17:14:45 +08001281
1282 /*
Jerry Yuf0ac2352021-10-11 17:47:07 +08001283 * Compute the Handshake Secret
Jerry Yua0650eb2021-09-09 17:14:45 +08001284 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001285 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001286 handshake->tls13_master_secrets.early,
Xiaofei Baib7972842021-11-18 07:29:56 +00001287 ecdhe, ephemeral_len,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001288 handshake->tls13_master_secrets.handshake );
Jerry Yua0650eb2021-09-09 17:14:45 +08001289 if( ret != 0 )
1290 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001291 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yua0650eb2021-09-09 17:14:45 +08001292 return( ret );
1293 }
1294
1295 MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +00001296 handshake->tls13_master_secrets.handshake, md_size );
Jerry Yua0650eb2021-09-09 17:14:45 +08001297
1298#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1299 mbedtls_platform_zeroize( ecdhe, sizeof( ecdhe ) );
1300#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
1301 return( 0 );
1302}
1303
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001304/* Generate application traffic keys since any records following a 1-RTT Finished message
1305 * MUST be encrypted under the application traffic key.
1306 */
XiaokangQiand0aa3e92021-11-10 06:17:40 +00001307int mbedtls_ssl_tls13_generate_application_keys(
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001308 mbedtls_ssl_context *ssl,
1309 mbedtls_ssl_key_set *traffic_keys )
1310{
XiaokangQiana7634982021-10-22 06:32:32 +00001311 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +00001312 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001313
1314 /* Address at which to store the application secrets */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001315 mbedtls_ssl_tls13_application_secrets * const app_secrets =
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001316 &ssl->session_negotiate->app_secrets;
1317
1318 /* Holding the transcript up to and including the ServerFinished */
XiaokangQian33062842021-11-11 03:37:45 +00001319 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001320 size_t transcript_len;
1321
1322 /* Variables relating to the hash for the chosen ciphersuite. */
1323 mbedtls_md_type_t md_type;
1324 mbedtls_md_info_t const *md_info;
1325 size_t md_size;
1326
1327 /* Variables relating to the cipher for the chosen ciphersuite. */
1328 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001329 size_t key_len, iv_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001330
1331 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) );
1332
1333 /* Extract basic information about hash and ciphersuite */
1334
1335 cipher_info = mbedtls_cipher_info_from_type(
XiaokangQian33062842021-11-11 03:37:45 +00001336 handshake->ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001337 key_len = cipher_info->key_bitlen / 8;
1338 iv_len = cipher_info->iv_size;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001339
XiaokangQian33062842021-11-11 03:37:45 +00001340 md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001341 md_info = mbedtls_md_info_from_type( md_type );
1342 md_size = mbedtls_md_get_size( md_info );
1343
1344 /* Compute current handshake transcript. It's the caller's responsiblity
1345 * to call this at the right time, that is, after the ServerFinished. */
1346
1347 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1348 transcript, sizeof( transcript ),
1349 &transcript_len );
1350 if( ret != 0 )
XiaokangQian4cab0242021-10-12 08:43:37 +00001351 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001352
1353 /* Compute application secrets from master secret and transcript hash. */
1354
Xiaofei Bai746f9482021-11-12 08:53:56 +00001355 ret = mbedtls_ssl_tls13_derive_application_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001356 handshake->tls13_master_secrets.app,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001357 transcript, transcript_len,
1358 app_secrets );
Jerry Yu4a2fa5d2021-12-10 10:19:34 +08001359 /* Erase master secrets */
Jerry Yu23ab7a42021-12-08 14:34:10 +08001360 mbedtls_platform_zeroize( &ssl->handshake->tls13_master_secrets,
Jerry Yu27224f52021-12-09 10:56:50 +08001361 sizeof( ssl->handshake->tls13_master_secrets ) );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001362 if( ret != 0 )
1363 {
1364 MBEDTLS_SSL_DEBUG_RET( 1,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001365 "mbedtls_ssl_tls13_derive_application_secrets", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001366 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001367 }
1368
1369 /* Derive first epoch of IV + Key for application traffic. */
1370
Xiaofei Bai746f9482021-11-12 08:53:56 +00001371 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001372 app_secrets->client_application_traffic_secret_N,
1373 app_secrets->server_application_traffic_secret_N,
Xiaofei Baib7972842021-11-18 07:29:56 +00001374 md_size, key_len, iv_len, traffic_keys );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001375 if( ret != 0 )
1376 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001377 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001378 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001379 }
1380
1381 MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret",
1382 app_secrets->client_application_traffic_secret_N,
1383 md_size );
1384
1385 MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret",
1386 app_secrets->server_application_traffic_secret_N,
1387 md_size );
1388
XiaokangQianac0385c2021-11-03 06:40:11 +00001389 /*
1390 * Export client/server application traffic secret 0
1391 */
1392 if( ssl->f_export_keys != NULL )
1393 {
1394 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001395 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001396 app_secrets->client_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001397 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001398 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001399 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1400 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001401
1402 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001403 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001404 app_secrets->server_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001405 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001406 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001407 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1408 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001409 }
1410
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001411 MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:",
Xiaofei Baib7972842021-11-18 07:29:56 +00001412 traffic_keys->client_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001413 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key",
Xiaofei Baib7972842021-11-18 07:29:56 +00001414 traffic_keys->server_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001415 MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001416 traffic_keys->client_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001417 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001418 traffic_keys->server_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001419
1420 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001421
1422 cleanup:
Jerry Yu2c70a392021-12-08 13:28:49 +08001423 /* randbytes is not used again */
1424 mbedtls_platform_zeroize( ssl->handshake->randbytes,
1425 sizeof( ssl->handshake->randbytes ) );
XiaokangQian33062842021-11-11 03:37:45 +00001426 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001427 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001428}
1429
Ronald Cron6f135e12021-12-08 16:57:54 +01001430#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */