blob: c01da956a5f1c86a61b2b51b67aad2a1f965afd7 [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"
Jerry Yue110d252022-05-05 10:19:22 +080030#include "mbedtls/platform.h"
Jerry Yue3131ef2021-09-16 13:14:15 +080031
32#include "ssl_misc.h"
33#include "ssl_tls13_keys.h"
Gabor Mezeia3eecd22022-02-09 16:57:26 +010034#include "ssl_tls13_invasive.h"
35
36#include "psa/crypto.h"
Jerry Yue3131ef2021-09-16 13:14:15 +080037
Hanno Becker1413bd82020-09-09 12:46:09 +010038#define MBEDTLS_SSL_TLS1_3_LABEL( name, string ) \
Hanno Beckere4435ea2020-09-08 10:43:52 +010039 .name = string,
40
Xiaofei Bai746f9482021-11-12 08:53:56 +000041struct mbedtls_ssl_tls13_labels_struct const mbedtls_ssl_tls13_labels =
Hanno Beckerbe9d6642020-08-21 13:20:06 +010042{
43 /* This seems to work in C, despite the string literal being one
44 * character too long due to the 0-termination. */
Hanno Beckere4435ea2020-09-08 10:43:52 +010045 MBEDTLS_SSL_TLS1_3_LABEL_LIST
Hanno Beckerbe9d6642020-08-21 13:20:06 +010046};
47
Hanno Beckera3a5a4e2020-09-08 11:33:48 +010048#undef MBEDTLS_SSL_TLS1_3_LABEL
Hanno Beckere4435ea2020-09-08 10:43:52 +010049
Hanno Beckerbe9d6642020-08-21 13:20:06 +010050/*
51 * This function creates a HkdfLabel structure used in the TLS 1.3 key schedule.
52 *
53 * The HkdfLabel is specified in RFC 8446 as follows:
54 *
55 * struct HkdfLabel {
56 * uint16 length; // Length of expanded key material
57 * opaque label<7..255>; // Always prefixed by "tls13 "
58 * opaque context<0..255>; // Usually a communication transcript hash
59 * };
60 *
61 * Parameters:
62 * - desired_length: Length of expanded key material
63 * Even though the standard allows expansion to up to
64 * 2**16 Bytes, TLS 1.3 never uses expansion to more than
65 * 255 Bytes, so we require `desired_length` to be at most
66 * 255. This allows us to save a few Bytes of code by
67 * hardcoding the writing of the high bytes.
Xiaofei Baifeecbbb2021-11-23 07:24:58 +000068 * - (label, label_len): label + label length, without "tls13 " prefix
69 * The label length MUST be less than or equal to
70 * MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN
71 * It is the caller's responsibility to ensure this.
72 * All (label, label length) pairs used in TLS 1.3
73 * can be obtained via MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN().
74 * - (ctx, ctx_len): context + context length
75 * The context length MUST be less than or equal to
76 * MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN
77 * It is the caller's responsibility to ensure this.
Hanno Beckerbe9d6642020-08-21 13:20:06 +010078 * - dst: Target buffer for HkdfLabel structure,
79 * This MUST be a writable buffer of size
80 * at least SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN Bytes.
Xiaofei Baifeecbbb2021-11-23 07:24:58 +000081 * - dst_len: Pointer at which to store the actual length of
82 * the HkdfLabel structure on success.
Hanno Beckerbe9d6642020-08-21 13:20:06 +010083 */
84
Xiaofei Baid25fab62021-12-02 06:36:27 +000085static const char tls13_label_prefix[6] = "tls13 ";
Hanno Becker2dfe1322020-09-10 09:23:12 +010086
Hanno Becker9cb0a142020-09-08 10:48:14 +010087#define SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( label_len, context_len ) \
Hanno Beckerbe9d6642020-08-21 13:20:06 +010088 ( 2 /* expansion length */ \
89 + 1 /* label length */ \
Hanno Becker9cb0a142020-09-08 10:48:14 +010090 + label_len \
Hanno Beckerbe9d6642020-08-21 13:20:06 +010091 + 1 /* context length */ \
Hanno Becker9cb0a142020-09-08 10:48:14 +010092 + context_len )
93
94#define SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN \
95 SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( \
Xiaofei Baid25fab62021-12-02 06:36:27 +000096 sizeof(tls13_label_prefix) + \
Hanno Becker9cb0a142020-09-08 10:48:14 +010097 MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN, \
98 MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +010099
Xiaofei Bai746f9482021-11-12 08:53:56 +0000100static void ssl_tls13_hkdf_encode_label(
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100101 size_t desired_length,
Xiaofei Baib7972842021-11-18 07:29:56 +0000102 const unsigned char *label, size_t label_len,
103 const unsigned char *ctx, size_t ctx_len,
104 unsigned char *dst, size_t *dst_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100105{
Hanno Becker2dfe1322020-09-10 09:23:12 +0100106 size_t total_label_len =
Xiaofei Baid25fab62021-12-02 06:36:27 +0000107 sizeof(tls13_label_prefix) + label_len;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100108 size_t total_hkdf_lbl_len =
Xiaofei Baib7972842021-11-18 07:29:56 +0000109 SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( total_label_len, ctx_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100110
111 unsigned char *p = dst;
112
Hanno Becker531fe302020-09-16 09:45:27 +0100113 /* Add the size of the expanded key material.
114 * We're hardcoding the high byte to 0 here assuming that we never use
115 * TLS 1.3 HKDF key expansion to more than 255 Bytes. */
116#if MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN > 255
Xiaofei Bai746f9482021-11-12 08:53:56 +0000117#error "The implementation of ssl_tls13_hkdf_encode_label() is not fit for the \
Hanno Becker531fe302020-09-16 09:45:27 +0100118 value of MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN"
119#endif
120
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100121 *p++ = 0;
Joe Subbiani2194dc42021-07-14 12:31:31 +0100122 *p++ = MBEDTLS_BYTE_0( desired_length );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100123
124 /* Add label incl. prefix */
Joe Subbiani2194dc42021-07-14 12:31:31 +0100125 *p++ = MBEDTLS_BYTE_0( total_label_len );
Xiaofei Baid25fab62021-12-02 06:36:27 +0000126 memcpy( p, tls13_label_prefix, sizeof(tls13_label_prefix) );
127 p += sizeof(tls13_label_prefix);
Xiaofei Baib7972842021-11-18 07:29:56 +0000128 memcpy( p, label, label_len );
129 p += label_len;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100130
131 /* Add context value */
Xiaofei Baib7972842021-11-18 07:29:56 +0000132 *p++ = MBEDTLS_BYTE_0( ctx_len );
133 if( ctx_len != 0 )
134 memcpy( p, ctx, ctx_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100135
136 /* Return total length to the caller. */
Xiaofei Baib7972842021-11-18 07:29:56 +0000137 *dst_len = total_hkdf_lbl_len;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100138}
139
Xiaofei Bai746f9482021-11-12 08:53:56 +0000140int mbedtls_ssl_tls13_hkdf_expand_label(
Gabor Mezei07732f72022-03-26 17:04:19 +0100141 psa_algorithm_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000142 const unsigned char *secret, size_t secret_len,
143 const unsigned char *label, size_t label_len,
144 const unsigned char *ctx, size_t ctx_len,
145 unsigned char *buf, size_t buf_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100146{
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100147 unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ];
Przemek Stekiel1b0ebdf2022-06-23 09:22:49 +0200148 size_t hkdf_label_len = 0;
Przemek Stekiel38ab4002022-06-23 09:05:40 +0200149 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
150 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekield5ae3652022-05-13 12:10:08 +0200151 psa_key_derivation_operation_t operation =
152 PSA_KEY_DERIVATION_OPERATION_INIT;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100153
Xiaofei Baib7972842021-11-18 07:29:56 +0000154 if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100155 {
156 /* Should never happen since this is an internal
157 * function, and we know statically which labels
158 * are allowed. */
159 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
160 }
161
Xiaofei Baib7972842021-11-18 07:29:56 +0000162 if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100163 {
164 /* Should not happen, as above. */
165 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
166 }
167
Xiaofei Baib7972842021-11-18 07:29:56 +0000168 if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100169 {
170 /* Should not happen, as above. */
171 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
172 }
173
Gabor Mezei07732f72022-03-26 17:04:19 +0100174 if( ! PSA_ALG_IS_HASH( hash_alg ) )
Gabor Mezei58db6532022-03-21 12:12:37 +0100175 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
176
Xiaofei Baib7972842021-11-18 07:29:56 +0000177 ssl_tls13_hkdf_encode_label( buf_len,
178 label, label_len,
179 ctx, ctx_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000180 hkdf_label,
181 &hkdf_label_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100182
Przemek Stekield5ae3652022-05-13 12:10:08 +0200183 status = psa_key_derivation_setup( &operation, PSA_ALG_HKDF_EXPAND( hash_alg ) );
Przemek Stekield5ae3652022-05-13 12:10:08 +0200184
Przemek Stekiel38ab4002022-06-23 09:05:40 +0200185 if( status != PSA_SUCCESS )
186 goto cleanup;
187
188 status = psa_key_derivation_input_bytes( &operation,
189 PSA_KEY_DERIVATION_INPUT_SECRET,
190 secret,
191 secret_len );
192
193 if( status != PSA_SUCCESS )
194 goto cleanup;
195
196 status = psa_key_derivation_input_bytes( &operation,
197 PSA_KEY_DERIVATION_INPUT_INFO,
198 hkdf_label,
199 hkdf_label_len );
200
201 if( status != PSA_SUCCESS )
202 goto cleanup;
203
204 status = psa_key_derivation_output_bytes( &operation,
205 buf,
206 buf_len );
207
208 if( status != PSA_SUCCESS )
209 goto cleanup;
210
211cleanup:
212 abort_status = psa_key_derivation_abort( &operation );
213 status = ( status == PSA_SUCCESS ? abort_status : status );
Przemek Stekiel1b0ebdf2022-06-23 09:22:49 +0200214 mbedtls_platform_zeroize( hkdf_label, hkdf_label_len );
Przemek Stekield5ae3652022-05-13 12:10:08 +0200215 return( psa_ssl_status_to_mbedtls ( status ) );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100216}
217
Jerry Yua8771832022-11-21 23:16:54 +0800218static int ssl_tls13_make_traffic_key(
219 psa_algorithm_t hash_alg,
220 const unsigned char *secret, size_t secret_len,
221 unsigned char *key, size_t key_len,
222 unsigned char *iv, size_t iv_len )
223{
224 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
225
226 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
227 secret, secret_len,
228 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
229 NULL, 0,
230 key, key_len );
231 if( ret != 0 )
232 return( ret );
233
234 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
235 secret, secret_len,
236 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
237 NULL, 0,
238 iv, iv_len );
239 return( ret );
240}
241
Hanno Becker3385a4d2020-08-21 13:03:34 +0100242/*
243 * The traffic keying material is generated from the following inputs:
244 *
245 * - One secret value per sender.
246 * - A purpose value indicating the specific value being generated
247 * - The desired lengths of key and IV.
248 *
249 * The expansion itself is based on HKDF:
250 *
251 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
252 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
253 *
254 * [sender] denotes the sending side and the Secret value is provided
255 * by the function caller. Note that we generate server and client side
256 * keys in a single function call.
257 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000258int mbedtls_ssl_tls13_make_traffic_keys(
Gabor Mezei07732f72022-03-26 17:04:19 +0100259 psa_algorithm_t hash_alg,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100260 const unsigned char *client_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +0000261 const unsigned char *server_secret, size_t secret_len,
262 size_t key_len, size_t iv_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100263 mbedtls_ssl_key_set *keys )
264{
265 int ret = 0;
266
Jerry Yua8771832022-11-21 23:16:54 +0800267 ret = ssl_tls13_make_traffic_key(
268 hash_alg, client_secret, secret_len,
269 keys->client_write_key, key_len,
270 keys->client_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100271 if( ret != 0 )
272 return( ret );
273
Jerry Yua8771832022-11-21 23:16:54 +0800274 ret = ssl_tls13_make_traffic_key(
275 hash_alg, server_secret, secret_len,
276 keys->server_write_key, key_len,
277 keys->server_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100278 if( ret != 0 )
279 return( ret );
280
Hanno Becker493ea7f2020-09-08 11:01:00 +0100281 keys->key_len = key_len;
282 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100283
284 return( 0 );
285}
286
Xiaofei Bai746f9482021-11-12 08:53:56 +0000287int mbedtls_ssl_tls13_derive_secret(
Gabor Mezei07732f72022-03-26 17:04:19 +0100288 psa_algorithm_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000289 const unsigned char *secret, size_t secret_len,
290 const unsigned char *label, size_t label_len,
291 const unsigned char *ctx, size_t ctx_len,
Hanno Becker0c42fd92020-09-09 12:58:29 +0100292 int ctx_hashed,
Xiaofei Baib7972842021-11-18 07:29:56 +0000293 unsigned char *dstbuf, size_t dstbuf_len )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100294{
295 int ret;
Gabor Mezei07732f72022-03-26 17:04:19 +0100296 unsigned char hashed_context[ PSA_HASH_MAX_SIZE ];
Hanno Becker0c42fd92020-09-09 12:58:29 +0100297 if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100298 {
Gabor Mezei07732f72022-03-26 17:04:19 +0100299 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
300
301 status = psa_hash_compute( hash_alg, ctx, ctx_len, hashed_context,
302 PSA_HASH_LENGTH( hash_alg ), &ctx_len );
303 if( status != PSA_SUCCESS )
304 {
305 ret = psa_ssl_status_to_mbedtls( status );
306 return ret;
307 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100308 }
309 else
310 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000311 if( ctx_len > sizeof(hashed_context) )
Hanno Becker97a21562020-09-09 12:57:16 +0100312 {
313 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100314 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100315 * Let's double-check nonetheless to not run at the risk
316 * of getting a stack overflow. */
Hanno Beckerb35d5222020-08-21 13:27:44 +0100317 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Becker97a21562020-09-09 12:57:16 +0100318 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100319
Xiaofei Baib7972842021-11-18 07:29:56 +0000320 memcpy( hashed_context, ctx, ctx_len );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100321 }
322
Xiaofei Bai746f9482021-11-12 08:53:56 +0000323 return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000324 secret, secret_len,
325 label, label_len,
326 hashed_context, ctx_len,
327 dstbuf, dstbuf_len ) );
Gabor Mezei07732f72022-03-26 17:04:19 +0100328
Hanno Beckerb35d5222020-08-21 13:27:44 +0100329}
330
Xiaofei Bai746f9482021-11-12 08:53:56 +0000331int mbedtls_ssl_tls13_evolve_secret(
Gabor Mezei07732f72022-03-26 17:04:19 +0100332 psa_algorithm_t hash_alg,
Hanno Beckere9cccb42020-08-20 13:42:46 +0100333 const unsigned char *secret_old,
334 const unsigned char *input, size_t input_len,
335 unsigned char *secret_new )
336{
337 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekiel38ab4002022-06-23 09:05:40 +0200338 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
339 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron831fee62022-10-05 16:22:59 +0200340 size_t hlen;
Gabor Mezei07732f72022-03-26 17:04:19 +0100341 unsigned char tmp_secret[ PSA_MAC_MAX_SIZE ] = { 0 };
Ronald Cron831fee62022-10-05 16:22:59 +0200342 const unsigned char all_zeroes_input[ MBEDTLS_TLS1_3_MD_MAX_SIZE ] = { 0 };
343 const unsigned char *l_input = NULL;
344 size_t l_input_len;
345
Przemek Stekield5ae3652022-05-13 12:10:08 +0200346 psa_key_derivation_operation_t operation =
347 PSA_KEY_DERIVATION_OPERATION_INIT;
Gabor Mezei07732f72022-03-26 17:04:19 +0100348
349 if( ! PSA_ALG_IS_HASH( hash_alg ) )
Gabor Mezei58db6532022-03-21 12:12:37 +0100350 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
351
Gabor Mezei07732f72022-03-26 17:04:19 +0100352 hlen = PSA_HASH_LENGTH( hash_alg );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100353
354 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100355 * on the old secret. */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100356 if( secret_old != NULL )
357 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000358 ret = mbedtls_ssl_tls13_derive_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100359 hash_alg,
360 secret_old, hlen,
361 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ),
362 NULL, 0, /* context */
363 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Hanno Becker59b50a12020-09-09 10:56:56 +0100364 tmp_secret, hlen );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100365 if( ret != 0 )
366 goto cleanup;
367 }
368
Przemek Stekiel38ab4002022-06-23 09:05:40 +0200369 ret = 0;
370
Jerry Yu6cf6b472022-08-16 14:50:28 +0800371 if( input != NULL && input_len != 0 )
Hanno Beckere9cccb42020-08-20 13:42:46 +0100372 {
Ronald Cron831fee62022-10-05 16:22:59 +0200373 l_input = input;
374 l_input_len = input_len;
Hanno Beckere9cccb42020-08-20 13:42:46 +0100375 }
376 else
377 {
Ronald Cron831fee62022-10-05 16:22:59 +0200378 l_input = all_zeroes_input;
379 l_input_len = hlen;
Hanno Beckere9cccb42020-08-20 13:42:46 +0100380 }
381
Przemek Stekield5ae3652022-05-13 12:10:08 +0200382 status = psa_key_derivation_setup( &operation,
383 PSA_ALG_HKDF_EXTRACT( hash_alg ) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100384
Przemek Stekiel38ab4002022-06-23 09:05:40 +0200385 if( status != PSA_SUCCESS )
386 goto cleanup;
387
388 status = psa_key_derivation_input_bytes( &operation,
389 PSA_KEY_DERIVATION_INPUT_SALT,
390 tmp_secret,
391 hlen );
392
393 if( status != PSA_SUCCESS )
394 goto cleanup;
395
396 status = psa_key_derivation_input_bytes( &operation,
397 PSA_KEY_DERIVATION_INPUT_SECRET,
Ronald Cron831fee62022-10-05 16:22:59 +0200398 l_input, l_input_len );
Przemek Stekiel38ab4002022-06-23 09:05:40 +0200399
400 if( status != PSA_SUCCESS )
401 goto cleanup;
402
403 status = psa_key_derivation_output_bytes( &operation,
404 secret_new,
405 PSA_HASH_LENGTH( hash_alg ) );
406
407 if( status != PSA_SUCCESS )
408 goto cleanup;
409
Hanno Beckere9cccb42020-08-20 13:42:46 +0100410 cleanup:
Przemek Stekiel38ab4002022-06-23 09:05:40 +0200411 abort_status = psa_key_derivation_abort( &operation );
412 status = ( status == PSA_SUCCESS ? abort_status : status );
413 ret = ( ret == 0 ? psa_ssl_status_to_mbedtls ( status ) : ret );
Hanno Becker59b50a12020-09-09 10:56:56 +0100414 mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100415 return( ret );
416}
417
Xiaofei Bai746f9482021-11-12 08:53:56 +0000418int mbedtls_ssl_tls13_derive_early_secrets(
Gabor Mezei07732f72022-03-26 17:04:19 +0100419 psa_algorithm_t hash_alg,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100420 unsigned char const *early_secret,
421 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000422 mbedtls_ssl_tls13_early_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100423{
424 int ret;
Gabor Mezei07732f72022-03-26 17:04:19 +0100425 size_t const hash_len = PSA_HASH_LENGTH( hash_alg );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100426
427 /* We should never call this function with an unknown hash,
428 * but add an assertion anyway. */
Gabor Mezei07732f72022-03-26 17:04:19 +0100429 if( ! PSA_ALG_IS_HASH( hash_alg ) )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100430 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
431
432 /*
433 * 0
434 * |
435 * v
436 * PSK -> HKDF-Extract = Early Secret
437 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100438 * +-----> Derive-Secret(., "c e traffic", ClientHello)
439 * | = client_early_traffic_secret
440 * |
441 * +-----> Derive-Secret(., "e exp master", ClientHello)
442 * | = early_exporter_master_secret
443 * v
444 */
445
446 /* Create client_early_traffic_secret */
Gabor Mezei07732f72022-03-26 17:04:19 +0100447 ret = mbedtls_ssl_tls13_derive_secret( hash_alg,
448 early_secret, hash_len,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100449 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ),
450 transcript, transcript_len,
451 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
452 derived->client_early_traffic_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +0100453 hash_len );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100454 if( ret != 0 )
455 return( ret );
456
457 /* Create early exporter */
Gabor Mezei07732f72022-03-26 17:04:19 +0100458 ret = mbedtls_ssl_tls13_derive_secret( hash_alg,
459 early_secret, hash_len,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100460 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ),
461 transcript, transcript_len,
462 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
463 derived->early_exporter_master_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +0100464 hash_len );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100465 if( ret != 0 )
466 return( ret );
467
468 return( 0 );
469}
470
Xiaofei Bai746f9482021-11-12 08:53:56 +0000471int mbedtls_ssl_tls13_derive_handshake_secrets(
Gabor Mezei07732f72022-03-26 17:04:19 +0100472 psa_algorithm_t hash_alg,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100473 unsigned char const *handshake_secret,
474 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000475 mbedtls_ssl_tls13_handshake_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100476{
477 int ret;
Gabor Mezei07732f72022-03-26 17:04:19 +0100478 size_t const hash_len = PSA_HASH_LENGTH( hash_alg );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100479
480 /* We should never call this function with an unknown hash,
481 * but add an assertion anyway. */
Gabor Mezei07732f72022-03-26 17:04:19 +0100482 if( ! PSA_ALG_IS_HASH( hash_alg ) )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100483 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
484
485 /*
486 *
487 * Handshake Secret
488 * |
489 * +-----> Derive-Secret( ., "c hs traffic",
490 * | ClientHello...ServerHello )
491 * | = client_handshake_traffic_secret
492 * |
493 * +-----> Derive-Secret( ., "s hs traffic",
494 * | ClientHello...ServerHello )
495 * | = server_handshake_traffic_secret
496 *
497 */
498
499 /*
500 * Compute client_handshake_traffic_secret with
501 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
502 */
503
Gabor Mezei07732f72022-03-26 17:04:19 +0100504 ret = mbedtls_ssl_tls13_derive_secret( hash_alg,
505 handshake_secret, hash_len,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100506 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ),
507 transcript, transcript_len,
508 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
509 derived->client_handshake_traffic_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +0100510 hash_len );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100511 if( ret != 0 )
512 return( ret );
513
514 /*
515 * Compute server_handshake_traffic_secret with
516 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
517 */
518
Gabor Mezei07732f72022-03-26 17:04:19 +0100519 ret = mbedtls_ssl_tls13_derive_secret( hash_alg,
520 handshake_secret, hash_len,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100521 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ),
522 transcript, transcript_len,
523 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
524 derived->server_handshake_traffic_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +0100525 hash_len );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100526 if( ret != 0 )
527 return( ret );
528
529 return( 0 );
530}
531
Xiaofei Bai746f9482021-11-12 08:53:56 +0000532int mbedtls_ssl_tls13_derive_application_secrets(
Gabor Mezei07732f72022-03-26 17:04:19 +0100533 psa_algorithm_t hash_alg,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100534 unsigned char const *application_secret,
535 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000536 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100537{
538 int ret;
Gabor Mezei07732f72022-03-26 17:04:19 +0100539 size_t const hash_len = PSA_HASH_LENGTH( hash_alg );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100540
541 /* We should never call this function with an unknown hash,
542 * but add an assertion anyway. */
Gabor Mezei07732f72022-03-26 17:04:19 +0100543 if( ! PSA_ALG_IS_HASH( hash_alg ) )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100544 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
545
546 /* Generate {client,server}_application_traffic_secret_0
547 *
548 * Master Secret
549 * |
550 * +-----> Derive-Secret( ., "c ap traffic",
551 * | ClientHello...server Finished )
552 * | = client_application_traffic_secret_0
553 * |
554 * +-----> Derive-Secret( ., "s ap traffic",
555 * | ClientHello...Server Finished )
556 * | = server_application_traffic_secret_0
557 * |
558 * +-----> Derive-Secret( ., "exp master",
559 * | ClientHello...server Finished)
560 * | = exporter_master_secret
561 *
562 */
563
Gabor Mezei07732f72022-03-26 17:04:19 +0100564 ret = mbedtls_ssl_tls13_derive_secret( hash_alg,
565 application_secret, hash_len,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100566 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ),
567 transcript, transcript_len,
568 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
569 derived->client_application_traffic_secret_N,
Gabor Mezei07732f72022-03-26 17:04:19 +0100570 hash_len );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100571 if( ret != 0 )
572 return( ret );
573
Gabor Mezei07732f72022-03-26 17:04:19 +0100574 ret = mbedtls_ssl_tls13_derive_secret( hash_alg,
575 application_secret, hash_len,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100576 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ),
577 transcript, transcript_len,
578 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
579 derived->server_application_traffic_secret_N,
Gabor Mezei07732f72022-03-26 17:04:19 +0100580 hash_len );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100581 if( ret != 0 )
582 return( ret );
583
Gabor Mezei07732f72022-03-26 17:04:19 +0100584 ret = mbedtls_ssl_tls13_derive_secret( hash_alg,
585 application_secret, hash_len,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100586 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ),
587 transcript, transcript_len,
588 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
589 derived->exporter_master_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +0100590 hash_len );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100591 if( ret != 0 )
592 return( ret );
593
594 return( 0 );
595}
596
597/* Generate resumption_master_secret for use with the ticket exchange.
598 *
Xiaofei Bai746f9482021-11-12 08:53:56 +0000599 * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets()
Hanno Beckeref5235b2021-05-24 06:39:41 +0100600 * because it uses the transcript hash up to and including ClientFinished. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000601int mbedtls_ssl_tls13_derive_resumption_master_secret(
Gabor Mezei07732f72022-03-26 17:04:19 +0100602 psa_algorithm_t hash_alg,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100603 unsigned char const *application_secret,
604 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000605 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100606{
607 int ret;
Gabor Mezei07732f72022-03-26 17:04:19 +0100608 size_t const hash_len = PSA_HASH_LENGTH( hash_alg );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100609
610 /* We should never call this function with an unknown hash,
611 * but add an assertion anyway. */
Gabor Mezei07732f72022-03-26 17:04:19 +0100612 if( ! PSA_ALG_IS_HASH( hash_alg ) )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100613 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
614
Gabor Mezei07732f72022-03-26 17:04:19 +0100615 ret = mbedtls_ssl_tls13_derive_secret( hash_alg,
616 application_secret, hash_len,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100617 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ),
618 transcript, transcript_len,
619 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
620 derived->resumption_master_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +0100621 hash_len );
Hanno Beckeref5235b2021-05-24 06:39:41 +0100622
623 if( ret != 0 )
624 return( ret );
625
626 return( 0 );
627}
628
XiaokangQiana4c99f22021-11-11 06:46:35 +0000629int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000630{
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000631 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +0000632 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +0200633 psa_algorithm_t const hash_alg = mbedtls_hash_info_psa_from_md(
Gabor Mezei07732f72022-03-26 17:04:19 +0100634 handshake->ciphersuite_info->mac );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000635
636 /*
637 * Compute MasterSecret
638 */
Gabor Mezei07732f72022-03-26 17:04:19 +0100639 ret = mbedtls_ssl_tls13_evolve_secret( hash_alg,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000640 handshake->tls13_master_secrets.handshake,
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000641 NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000642 handshake->tls13_master_secrets.app );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000643 if( ret != 0 )
644 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000645 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000646 return( ret );
647 }
648
649 MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret",
Gabor Mezei07732f72022-03-26 17:04:19 +0100650 handshake->tls13_master_secrets.app, PSA_HASH_LENGTH( hash_alg ) );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000651
652 return( 0 );
653}
654
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200655MBEDTLS_CHECK_RETURN_CRITICAL
Gabor Mezei07732f72022-03-26 17:04:19 +0100656static int ssl_tls13_calc_finished_core( psa_algorithm_t hash_alg,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000657 unsigned char const *base_key,
658 unsigned char const *transcript,
Gabor Mezei07732f72022-03-26 17:04:19 +0100659 unsigned char *dst,
660 size_t *dst_len )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100661{
Gabor Mezei07732f72022-03-26 17:04:19 +0100662 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
663 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
664 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
665 size_t hash_len = PSA_HASH_LENGTH( hash_alg );
666 unsigned char finished_key[PSA_MAC_MAX_SIZE];
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100667 int ret;
Gabor Mezei07732f72022-03-26 17:04:19 +0100668 psa_algorithm_t alg;
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100669
670 /* We should never call this function with an unknown hash,
671 * but add an assertion anyway. */
Gabor Mezei07732f72022-03-26 17:04:19 +0100672 if( ! PSA_ALG_IS_HASH( hash_alg ) )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100673 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
674
675 /* TLS 1.3 Finished message
676 *
677 * struct {
678 * opaque verify_data[Hash.length];
679 * } Finished;
680 *
681 * verify_data =
682 * HMAC( finished_key,
683 * Hash( Handshake Context +
684 * Certificate* +
685 * CertificateVerify* )
686 * )
687 *
688 * finished_key =
689 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
690 */
691
Xiaofei Bai746f9482021-11-12 08:53:56 +0000692 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gabor Mezei07732f72022-03-26 17:04:19 +0100693 hash_alg, base_key, hash_len,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100694 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ),
695 NULL, 0,
Gabor Mezei07732f72022-03-26 17:04:19 +0100696 finished_key, hash_len );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100697 if( ret != 0 )
698 goto exit;
699
Gabor Mezei07732f72022-03-26 17:04:19 +0100700 alg = PSA_ALG_HMAC( hash_alg );
701 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
702 psa_set_key_algorithm( &attributes, alg );
703 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
704
705 status = psa_import_key( &attributes, finished_key, hash_len, &key );
706 if( status != PSA_SUCCESS )
707 {
708 ret = psa_ssl_status_to_mbedtls( status );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100709 goto exit;
Gabor Mezei07732f72022-03-26 17:04:19 +0100710 }
711
712 status = psa_mac_compute( key, alg, transcript, hash_len,
713 dst, hash_len, dst_len );
714 ret = psa_ssl_status_to_mbedtls( status );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100715
716exit:
717
Gabor Mezei07732f72022-03-26 17:04:19 +0100718 status = psa_destroy_key( key );
719 if( ret == 0 )
720 ret = psa_ssl_status_to_mbedtls( status );
721
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100722 mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) );
Gabor Mezei07732f72022-03-26 17:04:19 +0100723
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100724 return( ret );
725}
726
XiaokangQianc5c39d52021-11-09 11:55:10 +0000727int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl,
XiaokangQianaaa0e192021-11-10 03:07:04 +0000728 unsigned char* dst,
729 size_t dst_len,
730 size_t *actual_len,
731 int from )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000732{
XiaokangQiana7634982021-10-22 06:32:32 +0000733 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000734
XiaokangQianaaa0e192021-11-10 03:07:04 +0000735 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000736 size_t transcript_len;
737
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800738 unsigned char *base_key = NULL;
Jerry Yub737f6a2021-12-10 17:55:23 +0800739 size_t base_key_len = 0;
Jerry Yu9c074732021-12-10 17:12:43 +0800740 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets =
741 &ssl->handshake->tls13_hs_secrets;
Jerry Yua5563f62021-12-10 18:14:36 +0800742
743 mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac;
Gabor Mezei07732f72022-03-26 17:04:19 +0100744
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +0200745 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md(
Gabor Mezei07732f72022-03-26 17:04:19 +0100746 ssl->handshake->ciphersuite_info->mac );
Gabor Mezei29e7ca82022-03-29 17:08:49 +0200747 size_t const hash_len = PSA_HASH_LENGTH( hash_alg );
Jerry Yua5563f62021-12-10 18:14:36 +0800748
749 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) );
750
Jerry Yub737f6a2021-12-10 17:55:23 +0800751 if( from == MBEDTLS_SSL_IS_CLIENT )
752 {
753 base_key = tls13_hs_secrets->client_handshake_traffic_secret;
754 base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret );
755 }
756 else
757 {
758 base_key = tls13_hs_secrets->server_handshake_traffic_secret;
759 base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret );
760 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000761
Gabor Mezei29e7ca82022-03-29 17:08:49 +0200762 if( dst_len < hash_len )
Jerry Yu9c074732021-12-10 17:12:43 +0800763 {
764 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
765 goto exit;
766 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000767
768 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
769 transcript, sizeof( transcript ),
770 &transcript_len );
771 if( ret != 0 )
772 {
773 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000774 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000775 }
776 MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len );
777
Gabor Mezei07732f72022-03-26 17:04:19 +0100778 ret = ssl_tls13_calc_finished_core( hash_alg, base_key, transcript, dst, actual_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000779 if( ret != 0 )
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000780 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000781
Gabor Mezei29e7ca82022-03-29 17:08:49 +0200782 MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, hash_len );
XiaokangQianc5c39d52021-11-09 11:55:10 +0000783 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000784
785exit:
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800786 /* Erase handshake secrets */
Jerry Yub737f6a2021-12-10 17:55:23 +0800787 mbedtls_platform_zeroize( base_key, base_key_len );
XiaokangQian33062842021-11-11 03:37:45 +0000788 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000789 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000790}
791
Xiaofei Bai746f9482021-11-12 08:53:56 +0000792int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl,
Gabor Mezei07732f72022-03-26 17:04:19 +0100793 const psa_algorithm_t hash_alg,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100794 unsigned char const *psk, size_t psk_len,
795 int psk_type,
796 unsigned char const *transcript,
797 unsigned char *result )
798{
799 int ret = 0;
Gabor Mezeied6d6582022-03-26 17:28:06 +0100800 unsigned char binder_key[PSA_MAC_MAX_SIZE];
801 unsigned char early_secret[PSA_MAC_MAX_SIZE];
Gabor Mezei07732f72022-03-26 17:04:19 +0100802 size_t const hash_len = PSA_HASH_LENGTH( hash_alg );
803 size_t actual_len;
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100804
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100805#if !defined(MBEDTLS_DEBUG_C)
806 ssl = NULL; /* make sure we don't use it except for debug */
807 ((void) ssl);
808#endif
809
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100810 /* We should never call this function with an unknown hash,
811 * but add an assertion anyway. */
Gabor Mezei07732f72022-03-26 17:04:19 +0100812 if( ! PSA_ALG_IS_HASH( hash_alg ) )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100813 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
814
815 /*
816 * 0
817 * |
818 * v
819 * PSK -> HKDF-Extract = Early Secret
820 * |
821 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
822 * | = binder_key
823 * v
824 */
825
Gabor Mezei07732f72022-03-26 17:04:19 +0100826 ret = mbedtls_ssl_tls13_evolve_secret( hash_alg,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000827 NULL, /* Old secret */
828 psk, psk_len, /* Input */
829 early_secret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100830 if( ret != 0 )
831 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000832 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100833 goto exit;
834 }
835
Ronald Cron295d93e2022-07-19 08:21:29 +0200836 MBEDTLS_SSL_DEBUG_BUF( 4, "mbedtls_ssl_tls13_create_psk_binder",
837 early_secret, hash_len ) ;
838
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100839 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
840 {
Gabor Mezei07732f72022-03-26 17:04:19 +0100841 ret = mbedtls_ssl_tls13_derive_secret( hash_alg,
842 early_secret, hash_len,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100843 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ),
844 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Gabor Mezei07732f72022-03-26 17:04:19 +0100845 binder_key, hash_len );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100846 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) );
847 }
848 else
849 {
Gabor Mezei07732f72022-03-26 17:04:19 +0100850 ret = mbedtls_ssl_tls13_derive_secret( hash_alg,
851 early_secret, hash_len,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100852 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ),
853 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Gabor Mezei07732f72022-03-26 17:04:19 +0100854 binder_key, hash_len );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100855 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) );
856 }
857
858 if( ret != 0 )
859 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000860 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100861 goto exit;
862 }
863
864 /*
865 * The binding_value is computed in the same way as the Finished message
866 * but with the BaseKey being the binder_key.
867 */
868
Gabor Mezei07732f72022-03-26 17:04:19 +0100869 ret = ssl_tls13_calc_finished_core( hash_alg, binder_key, transcript,
870 result, &actual_len );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100871 if( ret != 0 )
872 goto exit;
873
Gabor Mezei07732f72022-03-26 17:04:19 +0100874 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, actual_len );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100875
876exit:
877
878 mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) );
879 mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) );
880 return( ret );
881}
882
Hanno Beckerc94060c2021-03-22 07:50:44 +0000883int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform,
884 int endpoint,
885 int ciphersuite,
886 mbedtls_ssl_key_set const *traffic_keys,
887 mbedtls_ssl_context *ssl /* DEBUG ONLY */ )
888{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100889#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000890 int ret;
891 mbedtls_cipher_info_t const *cipher_info;
Neil Armstronga8093f52022-05-04 17:44:05 +0200892#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000893 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
894 unsigned char const *key_enc;
895 unsigned char const *iv_enc;
896 unsigned char const *key_dec;
897 unsigned char const *iv_dec;
898
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100899#if defined(MBEDTLS_USE_PSA_CRYPTO)
900 psa_key_type_t key_type;
901 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
902 psa_algorithm_t alg;
903 size_t key_bits;
904 psa_status_t status = PSA_SUCCESS;
905#endif
906
Hanno Beckerc94060c2021-03-22 07:50:44 +0000907#if !defined(MBEDTLS_DEBUG_C)
908 ssl = NULL; /* make sure we don't use it except for those cases */
909 (void) ssl;
910#endif
911
912 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Hanno Becker7887a772021-04-20 05:27:57 +0100913 if( ciphersuite_info == NULL )
914 {
915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
916 ciphersuite ) );
917 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
918 }
Hanno Beckerc94060c2021-03-22 07:50:44 +0000919
Neil Armstronga8093f52022-05-04 17:44:05 +0200920#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000921 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
922 if( cipher_info == NULL )
923 {
Hanno Becker7887a772021-04-20 05:27:57 +0100924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
925 ciphersuite_info->cipher ) );
Hanno Beckerf62a7302021-04-21 05:21:28 +0100926 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Beckerc94060c2021-03-22 07:50:44 +0000927 }
928
929 /*
930 * Setup cipher contexts in target transform
931 */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000932 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
933 cipher_info ) ) != 0 )
934 {
935 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
936 return( ret );
937 }
938
939 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
940 cipher_info ) ) != 0 )
941 {
942 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
943 return( ret );
944 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100945#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000946
947#if defined(MBEDTLS_SSL_SRV_C)
948 if( endpoint == MBEDTLS_SSL_IS_SERVER )
949 {
950 key_enc = traffic_keys->server_write_key;
951 key_dec = traffic_keys->client_write_key;
952 iv_enc = traffic_keys->server_write_iv;
953 iv_dec = traffic_keys->client_write_iv;
954 }
955 else
956#endif /* MBEDTLS_SSL_SRV_C */
957#if defined(MBEDTLS_SSL_CLI_C)
958 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
959 {
960 key_enc = traffic_keys->client_write_key;
961 key_dec = traffic_keys->server_write_key;
962 iv_enc = traffic_keys->client_write_iv;
963 iv_dec = traffic_keys->server_write_iv;
964 }
965 else
966#endif /* MBEDTLS_SSL_CLI_C */
967 {
968 /* should not happen */
969 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
970 }
971
972 memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len );
973 memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len );
974
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100975#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000976 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc,
977 key_enc, cipher_info->key_bitlen,
978 MBEDTLS_ENCRYPT ) ) != 0 )
979 {
980 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
981 return( ret );
982 }
983
984 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec,
985 key_dec, cipher_info->key_bitlen,
986 MBEDTLS_DECRYPT ) ) != 0 )
987 {
988 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
989 return( ret );
990 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100991#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000992
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +0100993 /*
994 * Setup other fields in SSL transform
995 */
996
997 if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 )
998 transform->taglen = 8;
999 else
1000 transform->taglen = 16;
1001
1002 transform->ivlen = traffic_keys->iv_len;
1003 transform->maclen = 0;
1004 transform->fixed_ivlen = transform->ivlen;
Glenn Strauss07c64162022-03-14 12:34:51 -04001005 transform->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +01001006
1007 /* We add the true record content type (1 Byte) to the plaintext and
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001008 * then pad to the configured granularity. The minimum length of the
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +01001009 * type-extended and padded plaintext is therefore the padding
1010 * granularity. */
1011 transform->minlen =
1012 transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY;
1013
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001014#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001015 /*
1016 * Setup psa keys and alg
1017 */
Neil Armstronga8093f52022-05-04 17:44:05 +02001018 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001019 transform->taglen,
1020 &alg,
1021 &key_type,
1022 &key_bits ) ) != PSA_SUCCESS )
1023 {
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001024 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", psa_ssl_status_to_mbedtls( status ) );
1025 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001026 }
1027
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001028 transform->psa_alg = alg;
1029
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001030 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001031 {
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001032 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
1033 psa_set_key_algorithm( &attributes, alg );
1034 psa_set_key_type( &attributes, key_type );
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001035
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001036 if( ( status = psa_import_key( &attributes,
1037 key_enc,
1038 PSA_BITS_TO_BYTES( key_bits ),
1039 &transform->psa_key_enc ) ) != PSA_SUCCESS )
1040 {
1041 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1042 return( psa_ssl_status_to_mbedtls( status ) );
1043 }
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +01001044
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +01001045 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
1046
1047 if( ( status = psa_import_key( &attributes,
1048 key_dec,
1049 PSA_BITS_TO_BYTES( key_bits ),
1050 &transform->psa_key_dec ) ) != PSA_SUCCESS )
1051 {
1052 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
1053 return( psa_ssl_status_to_mbedtls( status ) );
1054 }
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +01001055 }
1056#endif /* MBEDTLS_USE_PSA_CRYPTO */
1057
Hanno Beckerc94060c2021-03-22 07:50:44 +00001058 return( 0 );
1059}
1060
Jerry Yu84a6eda2022-11-04 11:17:35 +08001061MBEDTLS_CHECK_RETURN_CRITICAL
1062static int ssl_tls13_get_cipher_key_info(
1063 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
1064 size_t *key_len, size_t *iv_len )
1065{
1066 psa_key_type_t key_type;
1067 psa_algorithm_t alg;
1068 size_t taglen;
1069 size_t key_bits;
1070 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1071
1072 if( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG )
1073 taglen = 8;
1074 else
1075 taglen = 16;
1076
1077 status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher, taglen,
1078 &alg, &key_type, &key_bits );
1079 if( status != PSA_SUCCESS )
1080 return psa_ssl_status_to_mbedtls( status );
1081
1082 *key_len = PSA_BITS_TO_BYTES( key_bits );
1083
1084 /* TLS 1.3 only have AEAD ciphers, IV length is unconditionally 12 bytes */
1085 *iv_len = 12;
1086
1087 return 0;
1088}
1089
Jerry Yu91b560f2022-11-04 14:10:34 +08001090#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu3ce61ff2022-11-21 22:45:58 +08001091/*
1092 * ssl_tls13_generate_early_key() generates the key necessary for protecting
1093 * the early application data and the EndOfEarlyData handshake message
1094 * as described in section 7 of RFC 8446.
1095 *
1096 * NOTE: That only one key is generated, the key for the traffic from the
1097 * client to the server. The TLS 1.3 specification does not define a secret
1098 * and thus a key for server early traffic.
1099 */
Jerry Yu91b560f2022-11-04 14:10:34 +08001100MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3ce61ff2022-11-21 22:45:58 +08001101static int ssl_tls13_generate_early_key( mbedtls_ssl_context *ssl,
1102 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu91b560f2022-11-04 14:10:34 +08001103{
1104 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1105
1106 mbedtls_md_type_t md_type;
1107
1108 psa_algorithm_t hash_alg;
1109 size_t hash_len;
1110
1111 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1112 size_t transcript_len;
1113
1114 size_t key_len, iv_len;
1115
1116 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1117 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
1118 mbedtls_ssl_tls13_early_secrets *tls13_early_secrets = &handshake->tls13_early_secrets;
1119
Jerry Yu3ce61ff2022-11-21 22:45:58 +08001120 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_tls13_generate_early_key" ) );
Jerry Yu91b560f2022-11-04 14:10:34 +08001121
1122 ret = ssl_tls13_get_cipher_key_info( ciphersuite_info, &key_len, &iv_len );
1123 if( ret != 0 )
1124 {
1125 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_get_cipher_key_info", ret );
1126 return ret;
1127 }
1128
1129 md_type = ciphersuite_info->mac;
1130
1131 hash_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
1132 hash_len = PSA_HASH_LENGTH( hash_alg );
1133
1134 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1135 transcript,
1136 sizeof( transcript ),
1137 &transcript_len );
1138 if( ret != 0 )
1139 {
1140 MBEDTLS_SSL_DEBUG_RET( 1,
1141 "mbedtls_ssl_get_handshake_transcript",
1142 ret );
1143 return( ret );
1144 }
1145
Jerry Yub094e122022-11-21 13:03:47 +08001146 ret = mbedtls_ssl_tls13_derive_early_secrets(
1147 hash_alg, handshake->tls13_master_secrets.early,
1148 transcript, transcript_len, tls13_early_secrets );
Jerry Yu91b560f2022-11-04 14:10:34 +08001149 if( ret != 0 )
1150 {
1151 MBEDTLS_SSL_DEBUG_RET(
1152 1, "mbedtls_ssl_tls13_derive_early_secrets", ret );
1153 return( ret );
1154 }
1155
1156 MBEDTLS_SSL_DEBUG_BUF(
1157 4, "Client early traffic secret",
Jerry Yub094e122022-11-21 13:03:47 +08001158 tls13_early_secrets->client_early_traffic_secret, hash_len );
Jerry Yu91b560f2022-11-04 14:10:34 +08001159
1160 /*
1161 * Export client handshake traffic secret
1162 */
1163 if( ssl->f_export_keys != NULL )
1164 {
Jerry Yub094e122022-11-21 13:03:47 +08001165 ssl->f_export_keys(
1166 ssl->p_export_keys,
1167 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_EARLY_SECRET,
1168 tls13_early_secrets->client_early_traffic_secret,
1169 hash_len,
1170 handshake->randbytes,
1171 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
1172 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
Jerry Yu91b560f2022-11-04 14:10:34 +08001173 }
1174
Jerry Yua8771832022-11-21 23:16:54 +08001175 ret = ssl_tls13_make_traffic_key(
Jerry Yub094e122022-11-21 13:03:47 +08001176 hash_alg,
1177 tls13_early_secrets->client_early_traffic_secret,
Jerry Yua8771832022-11-21 23:16:54 +08001178 hash_len, traffic_keys->client_write_key, key_len,
1179 traffic_keys->client_write_iv, iv_len );
Jerry Yu91b560f2022-11-04 14:10:34 +08001180 if( ret != 0 )
1181 {
1182 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
1183 goto exit;
1184 }
Jerry Yua8771832022-11-21 23:16:54 +08001185 traffic_keys->key_len = key_len;
1186 traffic_keys->iv_len = iv_len;
Jerry Yu91b560f2022-11-04 14:10:34 +08001187
Jerry Yu3ce61ff2022-11-21 22:45:58 +08001188 MBEDTLS_SSL_DEBUG_BUF( 4, "client early write_key",
Jerry Yu91b560f2022-11-04 14:10:34 +08001189 traffic_keys->client_write_key,
1190 traffic_keys->key_len);
1191
Jerry Yu3ce61ff2022-11-21 22:45:58 +08001192 MBEDTLS_SSL_DEBUG_BUF( 4, "client early write_iv",
Jerry Yu91b560f2022-11-04 14:10:34 +08001193 traffic_keys->client_write_iv,
1194 traffic_keys->iv_len);
1195
Jerry Yu3ce61ff2022-11-21 22:45:58 +08001196 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_tls13_generate_early_key" ) );
Jerry Yu91b560f2022-11-04 14:10:34 +08001197
1198exit:
1199
1200 return( ret );
1201}
1202
1203int mbedtls_ssl_tls13_compute_early_transform( mbedtls_ssl_context *ssl )
1204{
1205 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1206 mbedtls_ssl_key_set traffic_keys;
1207 mbedtls_ssl_transform *transform_earlydata = NULL;
1208 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1209
1210 /* Next evolution in key schedule: Establish early_data secret and
1211 * key material. */
Jerry Yu3ce61ff2022-11-21 22:45:58 +08001212 ret = ssl_tls13_generate_early_key( ssl, &traffic_keys );
Jerry Yu91b560f2022-11-04 14:10:34 +08001213 if( ret != 0 )
1214 {
Jerry Yu3ce61ff2022-11-21 22:45:58 +08001215 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_generate_early_key",
Jerry Yu91b560f2022-11-04 14:10:34 +08001216 ret );
1217 goto cleanup;
1218 }
1219
1220 transform_earlydata = mbedtls_calloc( 1, sizeof( mbedtls_ssl_transform ) );
1221 if( transform_earlydata == NULL )
1222 {
1223 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
1224 goto cleanup;
1225 }
1226
1227 ret = mbedtls_ssl_tls13_populate_transform(
1228 transform_earlydata,
1229 ssl->conf->endpoint,
1230 ssl->session_negotiate->ciphersuite,
1231 &traffic_keys,
1232 ssl );
1233 if( ret != 0 )
1234 {
1235 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_populate_transform", ret );
1236 goto cleanup;
1237 }
1238 handshake->transform_earlydata = transform_earlydata;
1239
1240cleanup:
1241 mbedtls_platform_zeroize( &traffic_keys, sizeof( traffic_keys ) );
1242 if( ret != 0 )
1243 mbedtls_free( transform_earlydata );
1244
1245 return( ret );
1246}
1247#endif /* MBEDTLS_SSL_EARLY_DATA */
1248
Xiaofei Bai746f9482021-11-12 08:53:56 +00001249int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl )
Jerry Yu89ea3212021-09-09 14:31:24 +08001250{
Jerry Yue3131ef2021-09-16 13:14:15 +08001251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gabor Mezei07732f72022-03-26 17:04:19 +01001252 psa_algorithm_t hash_alg;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001253 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Ronald Cron295d93e2022-07-19 08:21:29 +02001254 unsigned char *psk = NULL;
1255 size_t psk_len = 0;
Jerry Yu6ca7c7f2021-09-28 18:51:40 +08001256
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001257 if( handshake->ciphersuite_info == NULL )
Jerry Yu89ea3212021-09-09 14:31:24 +08001258 {
1259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) );
1260 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1261 }
Jerry Yue3131ef2021-09-16 13:14:15 +08001262
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02001263 hash_alg = mbedtls_hash_info_psa_from_md( handshake->ciphersuite_info->mac );
Ronald Cron41a443a2022-10-04 16:38:25 +02001264#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5d01c052022-08-17 10:18:10 +08001265 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Ronald Cron295d93e2022-07-19 08:21:29 +02001266 {
Jerry Yu5d01c052022-08-17 10:18:10 +08001267 ret = mbedtls_ssl_tls13_export_handshake_psk( ssl, &psk, &psk_len );
1268 if( ret != 0 )
1269 {
1270 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_export_handshake_psk",
1271 ret );
1272 return( ret );
1273 }
Ronald Cron295d93e2022-07-19 08:21:29 +02001274 }
Jerry Yu5d01c052022-08-17 10:18:10 +08001275#endif
Ronald Cron295d93e2022-07-19 08:21:29 +02001276
1277 ret = mbedtls_ssl_tls13_evolve_secret( hash_alg, NULL, psk, psk_len,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001278 handshake->tls13_master_secrets.early );
Ronald Cron295d93e2022-07-19 08:21:29 +02001279#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Ronald Cron41a443a2022-10-04 16:38:25 +02001280 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cron295d93e2022-07-19 08:21:29 +02001281 mbedtls_free( (void*)psk );
1282#endif
Jerry Yu89ea3212021-09-09 14:31:24 +08001283 if( ret != 0 )
1284 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001285 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yu89ea3212021-09-09 14:31:24 +08001286 return( ret );
1287 }
1288
Ronald Cron295d93e2022-07-19 08:21:29 +02001289 MBEDTLS_SSL_DEBUG_BUF( 4, "mbedtls_ssl_tls13_key_schedule_stage_early",
1290 handshake->tls13_master_secrets.early,
1291 PSA_HASH_LENGTH( hash_alg ) );
Jerry Yu89ea3212021-09-09 14:31:24 +08001292 return( 0 );
1293}
1294
Jerry Yuc068b662021-10-11 22:30:19 +08001295/* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for
Jerry Yu61e35e02021-09-16 18:59:08 +08001296 * protecting the handshake messages, as described in Section 7 of TLS 1.3. */
Jerry Yuc068b662021-10-11 22:30:19 +08001297int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl,
1298 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu61e35e02021-09-16 18:59:08 +08001299{
1300 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu61e35e02021-09-16 18:59:08 +08001301 mbedtls_md_type_t md_type;
Gabor Mezei07732f72022-03-26 17:04:19 +01001302 psa_algorithm_t hash_alg;
1303 size_t hash_len;
Jerry Yu435208a2021-10-13 11:22:16 +08001304 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu61e35e02021-09-16 18:59:08 +08001305 size_t transcript_len;
Jerry Yub094e122022-11-21 13:03:47 +08001306 size_t key_len;
1307 size_t iv_len;
Jerry Yu61e35e02021-09-16 18:59:08 +08001308
Jerry Yu435208a2021-10-13 11:22:16 +08001309 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1310 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
Xiaofei Bai746f9482021-11-12 08:53:56 +00001311 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets;
Jerry Yu435208a2021-10-13 11:22:16 +08001312
Jerry Yuc068b662021-10-11 22:30:19 +08001313 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001314
Jerry Yub094e122022-11-21 13:03:47 +08001315 ret = ssl_tls13_get_cipher_key_info( ciphersuite_info, &key_len, &iv_len );
Neil Armstrongb818e162022-05-17 09:24:52 +02001316 if( ret != 0 )
Neil Armstrong4f4f2712022-05-05 15:34:39 +02001317 {
Jerry Yu84a6eda2022-11-04 11:17:35 +08001318 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_get_cipher_key_info", ret );
Neil Armstrong4f4f2712022-05-05 15:34:39 +02001319 return ret;
1320 }
1321
Jerry Yu435208a2021-10-13 11:22:16 +08001322 md_type = ciphersuite_info->mac;
Gabor Mezei07732f72022-03-26 17:04:19 +01001323
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02001324 hash_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
Gabor Mezei07732f72022-03-26 17:04:19 +01001325 hash_len = PSA_HASH_LENGTH( hash_alg );
Jerry Yu61e35e02021-09-16 18:59:08 +08001326
1327 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1328 transcript,
1329 sizeof( transcript ),
1330 &transcript_len );
1331 if( ret != 0 )
1332 {
1333 MBEDTLS_SSL_DEBUG_RET( 1,
1334 "mbedtls_ssl_get_handshake_transcript",
1335 ret );
1336 return( ret );
1337 }
1338
Gabor Mezei07732f72022-03-26 17:04:19 +01001339 ret = mbedtls_ssl_tls13_derive_handshake_secrets( hash_alg,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001340 handshake->tls13_master_secrets.handshake,
Jerry Yu435208a2021-10-13 11:22:16 +08001341 transcript, transcript_len, tls13_hs_secrets );
Jerry Yu61e35e02021-09-16 18:59:08 +08001342 if( ret != 0 )
1343 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001344 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets",
Jerry Yu61e35e02021-09-16 18:59:08 +08001345 ret );
1346 return( ret );
1347 }
1348
1349 MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001350 tls13_hs_secrets->client_handshake_traffic_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +01001351 hash_len );
Jerry Yu61e35e02021-09-16 18:59:08 +08001352 MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001353 tls13_hs_secrets->server_handshake_traffic_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +01001354 hash_len );
Jerry Yu61e35e02021-09-16 18:59:08 +08001355
1356 /*
1357 * Export client handshake traffic secret
1358 */
Jerry Yu61e35e02021-09-16 18:59:08 +08001359 if( ssl->f_export_keys != NULL )
1360 {
1361 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001362 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001363 tls13_hs_secrets->client_handshake_traffic_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +01001364 hash_len,
Jerry Yu435208a2021-10-13 11:22:16 +08001365 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001366 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001367 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1368
1369 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001370 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001371 tls13_hs_secrets->server_handshake_traffic_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +01001372 hash_len,
Jerry Yu435208a2021-10-13 11:22:16 +08001373 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001374 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001375 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1376 }
Jerry Yu61e35e02021-09-16 18:59:08 +08001377
Gabor Mezei07732f72022-03-26 17:04:19 +01001378 ret = mbedtls_ssl_tls13_make_traffic_keys( hash_alg,
Jerry Yu435208a2021-10-13 11:22:16 +08001379 tls13_hs_secrets->client_handshake_traffic_secret,
1380 tls13_hs_secrets->server_handshake_traffic_secret,
Gabor Mezei07732f72022-03-26 17:04:19 +01001381 hash_len, key_len, iv_len, traffic_keys );
Jerry Yu61e35e02021-09-16 18:59:08 +08001382 if( ret != 0 )
1383 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001384 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
Jerry Yu61e35e02021-09-16 18:59:08 +08001385 goto exit;
1386 }
1387
1388 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key",
1389 traffic_keys->client_write_key,
1390 traffic_keys->key_len);
1391
1392 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key",
1393 traffic_keys->server_write_key,
1394 traffic_keys->key_len);
1395
1396 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv",
1397 traffic_keys->client_write_iv,
1398 traffic_keys->iv_len);
1399
1400 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv",
1401 traffic_keys->server_write_iv,
1402 traffic_keys->iv_len);
1403
Jerry Yuc068b662021-10-11 22:30:19 +08001404 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001405
1406exit:
1407
1408 return( ret );
1409}
1410
Jerry Yuf0ac2352021-10-11 17:47:07 +08001411int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl )
Jerry Yua0650eb2021-09-09 17:14:45 +08001412{
Jerry Yuf0ac2352021-10-11 17:47:07 +08001413 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001414 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02001415 psa_algorithm_t const hash_alg = mbedtls_hash_info_psa_from_md(
Gabor Mezei07732f72022-03-26 17:04:19 +01001416 handshake->ciphersuite_info->mac );
Ronald Cron3b056202022-10-05 17:20:21 +02001417 unsigned char *shared_secret = NULL;
1418 size_t shared_secret_len = 0;
Jerry Yua0650eb2021-09-09 17:14:45 +08001419
Ronald Crona2900bc2022-10-20 14:37:35 +02001420#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Jerry Yuf0ac2352021-10-11 17:47:07 +08001421 /*
1422 * Compute ECDHE secret used to compute the handshake secret from which
1423 * client_handshake_traffic_secret and server_handshake_traffic_secret
1424 * are derived in the handshake secret derivation stage.
1425 */
Ronald Cron79907712022-07-20 17:05:29 +02001426 if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yuf0ac2352021-10-11 17:47:07 +08001427 {
1428 if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) )
1429 {
1430#if defined(MBEDTLS_ECDH_C)
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001431 /* Compute ECDH shared secret. */
Ronald Cron4c7edb22022-10-05 15:37:11 +02001432 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron3b056202022-10-05 17:20:21 +02001433 psa_key_attributes_t key_attributes = PSA_KEY_ATTRIBUTES_INIT;
1434
1435 status = psa_get_key_attributes( handshake->ecdh_psa_privkey,
1436 &key_attributes );
1437 if( status != PSA_SUCCESS )
1438 ret = psa_ssl_status_to_mbedtls( status );
1439
1440 shared_secret_len = PSA_BITS_TO_BYTES(
1441 psa_get_key_bits( &key_attributes ) );
1442 shared_secret = mbedtls_calloc( 1, shared_secret_len );
1443 if( shared_secret == NULL )
1444 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001445
Ronald Cron4c7edb22022-10-05 15:37:11 +02001446 status = psa_raw_key_agreement(
1447 PSA_ALG_ECDH, handshake->ecdh_psa_privkey,
1448 handshake->ecdh_psa_peerkey, handshake->ecdh_psa_peerkey_len,
Ronald Cron3b056202022-10-05 17:20:21 +02001449 shared_secret, shared_secret_len, &shared_secret_len );
Ronald Cron4c7edb22022-10-05 15:37:11 +02001450 if( status != PSA_SUCCESS )
1451 {
1452 ret = psa_ssl_status_to_mbedtls( status );
1453 MBEDTLS_SSL_DEBUG_RET( 1, "psa_raw_key_agreement", ret );
Ronald Cron3b056202022-10-05 17:20:21 +02001454 goto cleanup;
Ronald Cron4c7edb22022-10-05 15:37:11 +02001455 }
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001456
Ronald Cron4c7edb22022-10-05 15:37:11 +02001457 status = psa_destroy_key( handshake->ecdh_psa_privkey );
1458 if( status != PSA_SUCCESS )
1459 {
1460 ret = psa_ssl_status_to_mbedtls( status );
1461 MBEDTLS_SSL_DEBUG_RET( 1, "psa_destroy_key", ret );
Ronald Cron3b056202022-10-05 17:20:21 +02001462 goto cleanup;
Ronald Cron4c7edb22022-10-05 15:37:11 +02001463 }
1464
1465 handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Jerry Yuf0ac2352021-10-11 17:47:07 +08001466#endif /* MBEDTLS_ECDH_C */
1467 }
Ronald Cron9a6a49c2022-10-17 08:52:30 +02001468 else
Jerry Yuf0ac2352021-10-11 17:47:07 +08001469 {
Ronald Cron9a6a49c2022-10-17 08:52:30 +02001470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Group not supported." ) );
Ronald Cronb15d4d82022-10-17 08:47:32 +02001471 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Jerry Yuf0ac2352021-10-11 17:47:07 +08001472 }
1473 }
Ronald Crona2900bc2022-10-20 14:37:35 +02001474#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yua0650eb2021-09-09 17:14:45 +08001475
1476 /*
Jerry Yuf0ac2352021-10-11 17:47:07 +08001477 * Compute the Handshake Secret
Jerry Yua0650eb2021-09-09 17:14:45 +08001478 */
Gabor Mezei07732f72022-03-26 17:04:19 +01001479 ret = mbedtls_ssl_tls13_evolve_secret( hash_alg,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001480 handshake->tls13_master_secrets.early,
Ronald Cron3b056202022-10-05 17:20:21 +02001481 shared_secret, shared_secret_len,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001482 handshake->tls13_master_secrets.handshake );
Jerry Yua0650eb2021-09-09 17:14:45 +08001483 if( ret != 0 )
1484 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001485 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Ronald Cron3b056202022-10-05 17:20:21 +02001486 goto cleanup;
Jerry Yua0650eb2021-09-09 17:14:45 +08001487 }
1488
1489 MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret",
Gabor Mezei07732f72022-03-26 17:04:19 +01001490 handshake->tls13_master_secrets.handshake,
1491 PSA_HASH_LENGTH( hash_alg ) );
Jerry Yua0650eb2021-09-09 17:14:45 +08001492
Ronald Cron3b056202022-10-05 17:20:21 +02001493cleanup:
1494 if( shared_secret != NULL )
1495 {
1496 mbedtls_platform_zeroize( shared_secret, shared_secret_len );
1497 mbedtls_free( shared_secret );
1498 }
1499
1500 return( ret );
Jerry Yua0650eb2021-09-09 17:14:45 +08001501}
1502
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001503/* Generate application traffic keys since any records following a 1-RTT Finished message
1504 * MUST be encrypted under the application traffic key.
1505 */
XiaokangQiand0aa3e92021-11-10 06:17:40 +00001506int mbedtls_ssl_tls13_generate_application_keys(
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001507 mbedtls_ssl_context *ssl,
1508 mbedtls_ssl_key_set *traffic_keys )
1509{
XiaokangQiana7634982021-10-22 06:32:32 +00001510 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +00001511 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001512
1513 /* Address at which to store the application secrets */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001514 mbedtls_ssl_tls13_application_secrets * const app_secrets =
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001515 &ssl->session_negotiate->app_secrets;
1516
1517 /* Holding the transcript up to and including the ServerFinished */
XiaokangQian33062842021-11-11 03:37:45 +00001518 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001519 size_t transcript_len;
1520
1521 /* Variables relating to the hash for the chosen ciphersuite. */
1522 mbedtls_md_type_t md_type;
Gabor Mezei07732f72022-03-26 17:04:19 +01001523
1524 psa_algorithm_t hash_alg;
1525 size_t hash_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001526
1527 /* Variables relating to the cipher for the chosen ciphersuite. */
Xiaofei Baib7972842021-11-18 07:29:56 +00001528 size_t key_len, iv_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001529
1530 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) );
1531
1532 /* Extract basic information about hash and ciphersuite */
1533
Jerry Yu84a6eda2022-11-04 11:17:35 +08001534 ret = ssl_tls13_get_cipher_key_info( handshake->ciphersuite_info,
Jerry Yub094e122022-11-21 13:03:47 +08001535 &key_len, &iv_len );
Neil Armstrongb818e162022-05-17 09:24:52 +02001536 if( ret != 0 )
Neil Armstrong4f4f2712022-05-05 15:34:39 +02001537 {
Jerry Yu84a6eda2022-11-04 11:17:35 +08001538 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_get_cipher_key_info", ret );
Neil Armstrong4f4f2712022-05-05 15:34:39 +02001539 goto cleanup;
1540 }
1541
XiaokangQian33062842021-11-11 03:37:45 +00001542 md_type = handshake->ciphersuite_info->mac;
Gabor Mezei07732f72022-03-26 17:04:19 +01001543
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02001544 hash_alg = mbedtls_hash_info_psa_from_md( handshake->ciphersuite_info->mac );
Gabor Mezei07732f72022-03-26 17:04:19 +01001545 hash_len = PSA_HASH_LENGTH( hash_alg );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001546
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001547 /* Compute current handshake transcript. It's the caller's responsibility
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001548 * to call this at the right time, that is, after the ServerFinished. */
1549
1550 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1551 transcript, sizeof( transcript ),
1552 &transcript_len );
1553 if( ret != 0 )
XiaokangQian4cab0242021-10-12 08:43:37 +00001554 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001555
1556 /* Compute application secrets from master secret and transcript hash. */
1557
Gabor Mezei07732f72022-03-26 17:04:19 +01001558 ret = mbedtls_ssl_tls13_derive_application_secrets( hash_alg,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001559 handshake->tls13_master_secrets.app,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001560 transcript, transcript_len,
1561 app_secrets );
1562 if( ret != 0 )
1563 {
1564 MBEDTLS_SSL_DEBUG_RET( 1,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001565 "mbedtls_ssl_tls13_derive_application_secrets", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001566 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001567 }
1568
1569 /* Derive first epoch of IV + Key for application traffic. */
1570
Gabor Mezei07732f72022-03-26 17:04:19 +01001571 ret = mbedtls_ssl_tls13_make_traffic_keys( hash_alg,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001572 app_secrets->client_application_traffic_secret_N,
1573 app_secrets->server_application_traffic_secret_N,
Gabor Mezei07732f72022-03-26 17:04:19 +01001574 hash_len, key_len, iv_len, traffic_keys );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001575 if( ret != 0 )
1576 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001577 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001578 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001579 }
1580
1581 MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret",
1582 app_secrets->client_application_traffic_secret_N,
Gabor Mezei07732f72022-03-26 17:04:19 +01001583 hash_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001584
1585 MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret",
1586 app_secrets->server_application_traffic_secret_N,
Gabor Mezei07732f72022-03-26 17:04:19 +01001587 hash_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001588
XiaokangQianac0385c2021-11-03 06:40:11 +00001589 /*
1590 * Export client/server application traffic secret 0
1591 */
1592 if( ssl->f_export_keys != NULL )
1593 {
1594 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001595 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
Gabor Mezei07732f72022-03-26 17:04:19 +01001596 app_secrets->client_application_traffic_secret_N, hash_len,
XiaokangQian33062842021-11-11 03:37:45 +00001597 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001598 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001599 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1600 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001601
1602 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001603 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
Gabor Mezei07732f72022-03-26 17:04:19 +01001604 app_secrets->server_application_traffic_secret_N, hash_len,
XiaokangQian33062842021-11-11 03:37:45 +00001605 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001606 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001607 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1608 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001609 }
1610
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001611 MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:",
Xiaofei Baib7972842021-11-18 07:29:56 +00001612 traffic_keys->client_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001613 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key",
Xiaofei Baib7972842021-11-18 07:29:56 +00001614 traffic_keys->server_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001615 MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001616 traffic_keys->client_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001617 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001618 traffic_keys->server_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001619
1620 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001621
1622 cleanup:
Jerry Yu2c70a392021-12-08 13:28:49 +08001623 /* randbytes is not used again */
1624 mbedtls_platform_zeroize( ssl->handshake->randbytes,
1625 sizeof( ssl->handshake->randbytes ) );
Jerry Yuef2b98a2022-05-06 16:40:05 +08001626
XiaokangQian33062842021-11-11 03:37:45 +00001627 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001628 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001629}
1630
Jerry Yuf86eb752022-05-06 11:16:55 +08001631int mbedtls_ssl_tls13_compute_handshake_transform( mbedtls_ssl_context *ssl )
Jerry Yue110d252022-05-05 10:19:22 +08001632{
Jerry Yuef2b98a2022-05-06 16:40:05 +08001633 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue110d252022-05-05 10:19:22 +08001634 mbedtls_ssl_key_set traffic_keys;
1635 mbedtls_ssl_transform *transform_handshake = NULL;
1636 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1637
1638 /* Compute handshake secret */
1639 ret = mbedtls_ssl_tls13_key_schedule_stage_handshake( ssl );
1640 if( ret != 0 )
1641 {
1642 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_master_secret", ret );
1643 goto cleanup;
1644 }
1645
1646 /* Next evolution in key schedule: Establish handshake secret and
1647 * key material. */
1648 ret = mbedtls_ssl_tls13_generate_handshake_keys( ssl, &traffic_keys );
1649 if( ret != 0 )
1650 {
1651 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_generate_handshake_keys",
1652 ret );
1653 goto cleanup;
1654 }
1655
1656 transform_handshake = mbedtls_calloc( 1, sizeof( mbedtls_ssl_transform ) );
1657 if( transform_handshake == NULL )
1658 {
1659 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
1660 goto cleanup;
1661 }
1662
Jerry Yuef2b98a2022-05-06 16:40:05 +08001663 ret = mbedtls_ssl_tls13_populate_transform(
1664 transform_handshake,
1665 ssl->conf->endpoint,
1666 ssl->session_negotiate->ciphersuite,
1667 &traffic_keys,
1668 ssl );
Jerry Yue110d252022-05-05 10:19:22 +08001669 if( ret != 0 )
1670 {
1671 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_populate_transform", ret );
1672 goto cleanup;
1673 }
1674 handshake->transform_handshake = transform_handshake;
1675
1676cleanup:
1677 mbedtls_platform_zeroize( &traffic_keys, sizeof( traffic_keys ) );
1678 if( ret != 0 )
Jerry Yue110d252022-05-05 10:19:22 +08001679 mbedtls_free( transform_handshake );
Jerry Yue110d252022-05-05 10:19:22 +08001680
1681 return( ret );
1682}
1683
Jerry Yu466dda82022-09-13 11:20:20 +08001684int mbedtls_ssl_tls13_compute_resumption_master_secret( mbedtls_ssl_context *ssl )
Jerry Yuff226982022-04-16 16:52:57 +08001685{
Jerry Yu46bffe02022-09-13 11:25:28 +08001686 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu49d63f82022-08-03 12:28:08 +08001687 mbedtls_md_type_t md_type;
Jerry Yu46bffe02022-09-13 11:25:28 +08001688 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1689 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu49d63f82022-08-03 12:28:08 +08001690 size_t transcript_len;
1691
1692 MBEDTLS_SSL_DEBUG_MSG( 2,
Jerry Yu466dda82022-09-13 11:20:20 +08001693 ( "=> mbedtls_ssl_tls13_compute_resumption_master_secret" ) );
Jerry Yu49d63f82022-08-03 12:28:08 +08001694
Jerry Yu46bffe02022-09-13 11:25:28 +08001695 md_type = handshake->ciphersuite_info->mac;
Jerry Yu49d63f82022-08-03 12:28:08 +08001696
1697 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1698 transcript, sizeof( transcript ),
1699 &transcript_len );
1700 if( ret != 0 )
1701 return( ret );
1702
1703 ret = mbedtls_ssl_tls13_derive_resumption_master_secret(
1704 mbedtls_psa_translate_md( md_type ),
Jerry Yu46bffe02022-09-13 11:25:28 +08001705 handshake->tls13_master_secrets.app,
Jerry Yu49d63f82022-08-03 12:28:08 +08001706 transcript, transcript_len,
1707 &ssl->session_negotiate->app_secrets );
1708 if( ret != 0 )
1709 return( ret );
1710
Jerry Yuff226982022-04-16 16:52:57 +08001711 /* Erase master secrets */
Jerry Yu46bffe02022-09-13 11:25:28 +08001712 mbedtls_platform_zeroize( &handshake->tls13_master_secrets,
1713 sizeof( handshake->tls13_master_secrets ) );
Jerry Yu49d63f82022-08-03 12:28:08 +08001714
1715 MBEDTLS_SSL_DEBUG_BUF( 4, "Resumption master secret",
1716 ssl->session_negotiate->app_secrets.resumption_master_secret,
Jerry Yu6ee726e2022-09-16 16:32:27 +08001717 PSA_HASH_LENGTH( mbedtls_psa_translate_md( md_type ) ) ) ;
Jerry Yu46bffe02022-09-13 11:25:28 +08001718
Jerry Yu49d63f82022-08-03 12:28:08 +08001719 MBEDTLS_SSL_DEBUG_MSG( 2,
Jerry Yu466dda82022-09-13 11:20:20 +08001720 ( "<= mbedtls_ssl_tls13_compute_resumption_master_secret" ) );
Jerry Yuff226982022-04-16 16:52:57 +08001721 return( 0 );
1722}
1723
Jerry Yufd5ea042022-05-19 14:29:48 +08001724int mbedtls_ssl_tls13_compute_application_transform( mbedtls_ssl_context *ssl )
1725{
1726 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1727 mbedtls_ssl_key_set traffic_keys;
1728 mbedtls_ssl_transform *transform_application = NULL;
1729
1730 ret = mbedtls_ssl_tls13_key_schedule_stage_application( ssl );
1731 if( ret != 0 )
1732 {
1733 MBEDTLS_SSL_DEBUG_RET( 1,
1734 "mbedtls_ssl_tls13_key_schedule_stage_application", ret );
1735 goto cleanup;
1736 }
1737
1738 ret = mbedtls_ssl_tls13_generate_application_keys( ssl, &traffic_keys );
1739 if( ret != 0 )
1740 {
1741 MBEDTLS_SSL_DEBUG_RET( 1,
1742 "mbedtls_ssl_tls13_generate_application_keys", ret );
1743 goto cleanup;
1744 }
1745
1746 transform_application =
1747 mbedtls_calloc( 1, sizeof( mbedtls_ssl_transform ) );
1748 if( transform_application == NULL )
1749 {
1750 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
1751 goto cleanup;
1752 }
1753
1754 ret = mbedtls_ssl_tls13_populate_transform(
1755 transform_application,
1756 ssl->conf->endpoint,
1757 ssl->session_negotiate->ciphersuite,
1758 &traffic_keys,
1759 ssl );
1760 if( ret != 0 )
1761 {
1762 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_populate_transform", ret );
1763 goto cleanup;
1764 }
1765
1766 ssl->transform_application = transform_application;
1767
1768cleanup:
1769
1770 mbedtls_platform_zeroize( &traffic_keys, sizeof( traffic_keys ) );
1771 if( ret != 0 )
1772 {
1773 mbedtls_free( transform_application );
1774 }
1775 return( ret );
1776}
1777
Ronald Cron41a443a2022-10-04 16:38:25 +02001778#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu40f37712022-07-26 16:58:57 +08001779int mbedtls_ssl_tls13_export_handshake_psk( mbedtls_ssl_context *ssl,
1780 unsigned char **psk,
1781 size_t *psk_len )
1782{
Jerry Yu40f37712022-07-26 16:58:57 +08001783#if defined(MBEDTLS_USE_PSA_CRYPTO)
1784 psa_key_attributes_t key_attributes = PSA_KEY_ATTRIBUTES_INIT;
Jerry Yuc5a23a02022-08-25 10:51:44 +08001785 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu40f37712022-07-26 16:58:57 +08001786
1787 *psk_len = 0;
1788 *psk = NULL;
1789
1790 if( mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Jerry Yu29d9faa2022-08-23 17:52:45 +08001791 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu40f37712022-07-26 16:58:57 +08001792
1793 status = psa_get_key_attributes( ssl->handshake->psk_opaque, &key_attributes );
Jerry Yu6cf6b472022-08-16 14:50:28 +08001794 if( status != PSA_SUCCESS )
Jerry Yu40f37712022-07-26 16:58:57 +08001795 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu40f37712022-07-26 16:58:57 +08001796
1797 *psk_len = PSA_BITS_TO_BYTES( psa_get_key_bits( &key_attributes ) );
1798 *psk = mbedtls_calloc( 1, *psk_len );
1799 if( *psk == NULL )
Jerry Yu40f37712022-07-26 16:58:57 +08001800 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Jerry Yu40f37712022-07-26 16:58:57 +08001801
1802 status = psa_export_key( ssl->handshake->psk_opaque,
1803 (uint8_t *)*psk, *psk_len, psk_len );
Jerry Yu6cf6b472022-08-16 14:50:28 +08001804 if( status != PSA_SUCCESS )
Jerry Yu40f37712022-07-26 16:58:57 +08001805 {
1806 mbedtls_free( (void *)*psk );
Jerry Yu5d01c052022-08-17 10:18:10 +08001807 *psk = NULL;
Jerry Yu40f37712022-07-26 16:58:57 +08001808 return( psa_ssl_status_to_mbedtls( status ) );
1809 }
Jerry Yu5d01c052022-08-17 10:18:10 +08001810 return( 0 );
Jerry Yu40f37712022-07-26 16:58:57 +08001811#else
1812 *psk = ssl->handshake->psk;
1813 *psk_len = ssl->handshake->psk_len;
Jerry Yu5d01c052022-08-17 10:18:10 +08001814 if( *psk == NULL )
Jerry Yu29d9faa2022-08-23 17:52:45 +08001815 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu5d01c052022-08-17 10:18:10 +08001816 return( 0 );
Jerry Yu40f37712022-07-26 16:58:57 +08001817#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu40f37712022-07-26 16:58:57 +08001818}
Ronald Cron41a443a2022-10-04 16:38:25 +02001819#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu40f37712022-07-26 16:58:57 +08001820
Ronald Cron6f135e12021-12-08 16:57:54 +01001821#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40f37712022-07-26 16:58:57 +08001822