blob: 443e0732133844319f8f4b4e29b62ab024bafd42 [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"
33
Hanno Becker1413bd82020-09-09 12:46:09 +010034#define MBEDTLS_SSL_TLS1_3_LABEL( name, string ) \
Hanno Beckere4435ea2020-09-08 10:43:52 +010035 .name = string,
36
Xiaofei Bai746f9482021-11-12 08:53:56 +000037struct mbedtls_ssl_tls13_labels_struct const mbedtls_ssl_tls13_labels =
Hanno Beckerbe9d6642020-08-21 13:20:06 +010038{
39 /* This seems to work in C, despite the string literal being one
40 * character too long due to the 0-termination. */
Hanno Beckere4435ea2020-09-08 10:43:52 +010041 MBEDTLS_SSL_TLS1_3_LABEL_LIST
Hanno Beckerbe9d6642020-08-21 13:20:06 +010042};
43
Hanno Beckera3a5a4e2020-09-08 11:33:48 +010044#undef MBEDTLS_SSL_TLS1_3_LABEL
Hanno Beckere4435ea2020-09-08 10:43:52 +010045
Hanno Beckerbe9d6642020-08-21 13:20:06 +010046/*
47 * This function creates a HkdfLabel structure used in the TLS 1.3 key schedule.
48 *
49 * The HkdfLabel is specified in RFC 8446 as follows:
50 *
51 * struct HkdfLabel {
52 * uint16 length; // Length of expanded key material
53 * opaque label<7..255>; // Always prefixed by "tls13 "
54 * opaque context<0..255>; // Usually a communication transcript hash
55 * };
56 *
57 * Parameters:
58 * - desired_length: Length of expanded key material
59 * Even though the standard allows expansion to up to
60 * 2**16 Bytes, TLS 1.3 never uses expansion to more than
61 * 255 Bytes, so we require `desired_length` to be at most
62 * 255. This allows us to save a few Bytes of code by
63 * hardcoding the writing of the high bytes.
Xiaofei Baifeecbbb2021-11-23 07:24:58 +000064 * - (label, label_len): label + label length, without "tls13 " prefix
65 * The label length MUST be less than or equal to
66 * MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN
67 * It is the caller's responsibility to ensure this.
68 * All (label, label length) pairs used in TLS 1.3
69 * can be obtained via MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN().
70 * - (ctx, ctx_len): context + context length
71 * The context length MUST be less than or equal to
72 * MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN
73 * It is the caller's responsibility to ensure this.
Hanno Beckerbe9d6642020-08-21 13:20:06 +010074 * - dst: Target buffer for HkdfLabel structure,
75 * This MUST be a writable buffer of size
76 * at least SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN Bytes.
Xiaofei Baifeecbbb2021-11-23 07:24:58 +000077 * - dst_len: Pointer at which to store the actual length of
78 * the HkdfLabel structure on success.
Hanno Beckerbe9d6642020-08-21 13:20:06 +010079 */
80
Xiaofei Baid25fab62021-12-02 06:36:27 +000081static const char tls13_label_prefix[6] = "tls13 ";
Hanno Becker2dfe1322020-09-10 09:23:12 +010082
Hanno Becker9cb0a142020-09-08 10:48:14 +010083#define SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( label_len, context_len ) \
Hanno Beckerbe9d6642020-08-21 13:20:06 +010084 ( 2 /* expansion length */ \
85 + 1 /* label length */ \
Hanno Becker9cb0a142020-09-08 10:48:14 +010086 + label_len \
Hanno Beckerbe9d6642020-08-21 13:20:06 +010087 + 1 /* context length */ \
Hanno Becker9cb0a142020-09-08 10:48:14 +010088 + context_len )
89
90#define SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN \
91 SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( \
Xiaofei Baid25fab62021-12-02 06:36:27 +000092 sizeof(tls13_label_prefix) + \
Hanno Becker9cb0a142020-09-08 10:48:14 +010093 MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN, \
94 MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +010095
Xiaofei Bai746f9482021-11-12 08:53:56 +000096static void ssl_tls13_hkdf_encode_label(
Hanno Beckerbe9d6642020-08-21 13:20:06 +010097 size_t desired_length,
Xiaofei Baib7972842021-11-18 07:29:56 +000098 const unsigned char *label, size_t label_len,
99 const unsigned char *ctx, size_t ctx_len,
100 unsigned char *dst, size_t *dst_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100101{
Hanno Becker2dfe1322020-09-10 09:23:12 +0100102 size_t total_label_len =
Xiaofei Baid25fab62021-12-02 06:36:27 +0000103 sizeof(tls13_label_prefix) + label_len;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100104 size_t total_hkdf_lbl_len =
Xiaofei Baib7972842021-11-18 07:29:56 +0000105 SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( total_label_len, ctx_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100106
107 unsigned char *p = dst;
108
Hanno Becker531fe302020-09-16 09:45:27 +0100109 /* Add the size of the expanded key material.
110 * We're hardcoding the high byte to 0 here assuming that we never use
111 * TLS 1.3 HKDF key expansion to more than 255 Bytes. */
112#if MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN > 255
Xiaofei Bai746f9482021-11-12 08:53:56 +0000113#error "The implementation of ssl_tls13_hkdf_encode_label() is not fit for the \
Hanno Becker531fe302020-09-16 09:45:27 +0100114 value of MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN"
115#endif
116
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100117 *p++ = 0;
Joe Subbiani2194dc42021-07-14 12:31:31 +0100118 *p++ = MBEDTLS_BYTE_0( desired_length );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100119
120 /* Add label incl. prefix */
Joe Subbiani2194dc42021-07-14 12:31:31 +0100121 *p++ = MBEDTLS_BYTE_0( total_label_len );
Xiaofei Baid25fab62021-12-02 06:36:27 +0000122 memcpy( p, tls13_label_prefix, sizeof(tls13_label_prefix) );
123 p += sizeof(tls13_label_prefix);
Xiaofei Baib7972842021-11-18 07:29:56 +0000124 memcpy( p, label, label_len );
125 p += label_len;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100126
127 /* Add context value */
Xiaofei Baib7972842021-11-18 07:29:56 +0000128 *p++ = MBEDTLS_BYTE_0( ctx_len );
129 if( ctx_len != 0 )
130 memcpy( p, ctx, ctx_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100131
132 /* Return total length to the caller. */
Xiaofei Baib7972842021-11-18 07:29:56 +0000133 *dst_len = total_hkdf_lbl_len;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100134}
135
Xiaofei Bai746f9482021-11-12 08:53:56 +0000136int mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100137 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000138 const unsigned char *secret, size_t secret_len,
139 const unsigned char *label, size_t label_len,
140 const unsigned char *ctx, size_t ctx_len,
141 unsigned char *buf, size_t buf_len )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100142{
Xiaofei Baib7972842021-11-18 07:29:56 +0000143 const mbedtls_md_info_t *md_info;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100144 unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ];
145 size_t hkdf_label_len;
146
Xiaofei Baib7972842021-11-18 07:29:56 +0000147 if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100148 {
149 /* Should never happen since this is an internal
150 * function, and we know statically which labels
151 * are allowed. */
152 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
153 }
154
Xiaofei Baib7972842021-11-18 07:29:56 +0000155 if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100156 {
157 /* Should not happen, as above. */
158 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
159 }
160
Xiaofei Baib7972842021-11-18 07:29:56 +0000161 if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100162 {
163 /* Should not happen, as above. */
164 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
165 }
166
Xiaofei Baib7972842021-11-18 07:29:56 +0000167 md_info = mbedtls_md_info_from_type( hash_alg );
168 if( md_info == NULL )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100169 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
170
Xiaofei Baib7972842021-11-18 07:29:56 +0000171 ssl_tls13_hkdf_encode_label( buf_len,
172 label, label_len,
173 ctx, ctx_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000174 hkdf_label,
175 &hkdf_label_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100176
Xiaofei Baib7972842021-11-18 07:29:56 +0000177 return( mbedtls_hkdf_expand( md_info,
178 secret, secret_len,
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100179 hkdf_label, hkdf_label_len,
Xiaofei Baib7972842021-11-18 07:29:56 +0000180 buf, buf_len ) );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100181}
182
Hanno Becker3385a4d2020-08-21 13:03:34 +0100183/*
184 * The traffic keying material is generated from the following inputs:
185 *
186 * - One secret value per sender.
187 * - A purpose value indicating the specific value being generated
188 * - The desired lengths of key and IV.
189 *
190 * The expansion itself is based on HKDF:
191 *
192 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
193 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
194 *
195 * [sender] denotes the sending side and the Secret value is provided
196 * by the function caller. Note that we generate server and client side
197 * keys in a single function call.
198 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000199int mbedtls_ssl_tls13_make_traffic_keys(
Hanno Becker3385a4d2020-08-21 13:03:34 +0100200 mbedtls_md_type_t hash_alg,
201 const unsigned char *client_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +0000202 const unsigned char *server_secret, size_t secret_len,
203 size_t key_len, size_t iv_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100204 mbedtls_ssl_key_set *keys )
205{
206 int ret = 0;
207
Xiaofei Bai746f9482021-11-12 08:53:56 +0000208 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000209 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100210 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
211 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100212 keys->client_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100213 if( ret != 0 )
214 return( ret );
215
Xiaofei Bai746f9482021-11-12 08:53:56 +0000216 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000217 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100218 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
219 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100220 keys->server_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100221 if( ret != 0 )
222 return( ret );
223
Xiaofei Bai746f9482021-11-12 08:53:56 +0000224 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000225 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100226 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
227 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100228 keys->client_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100229 if( ret != 0 )
230 return( ret );
231
Xiaofei Bai746f9482021-11-12 08:53:56 +0000232 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000233 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100234 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
235 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100236 keys->server_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100237 if( ret != 0 )
238 return( ret );
239
Hanno Becker493ea7f2020-09-08 11:01:00 +0100240 keys->key_len = key_len;
241 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100242
243 return( 0 );
244}
245
Xiaofei Bai746f9482021-11-12 08:53:56 +0000246int mbedtls_ssl_tls13_derive_secret(
Hanno Beckerb35d5222020-08-21 13:27:44 +0100247 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000248 const unsigned char *secret, size_t secret_len,
249 const unsigned char *label, size_t label_len,
250 const unsigned char *ctx, size_t ctx_len,
Hanno Becker0c42fd92020-09-09 12:58:29 +0100251 int ctx_hashed,
Xiaofei Baib7972842021-11-18 07:29:56 +0000252 unsigned char *dstbuf, size_t dstbuf_len )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100253{
254 int ret;
255 unsigned char hashed_context[ MBEDTLS_MD_MAX_SIZE ];
256
Xiaofei Baib7972842021-11-18 07:29:56 +0000257 const mbedtls_md_info_t *md_info;
258 md_info = mbedtls_md_info_from_type( hash_alg );
259 if( md_info == NULL )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100260 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
261
Hanno Becker0c42fd92020-09-09 12:58:29 +0100262 if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100263 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000264 ret = mbedtls_md( md_info, ctx, ctx_len, hashed_context );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100265 if( ret != 0 )
266 return( ret );
Xiaofei Baib7972842021-11-18 07:29:56 +0000267 ctx_len = mbedtls_md_get_size( md_info );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100268 }
269 else
270 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000271 if( ctx_len > sizeof(hashed_context) )
Hanno Becker97a21562020-09-09 12:57:16 +0100272 {
273 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100274 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100275 * Let's double-check nonetheless to not run at the risk
276 * of getting a stack overflow. */
Hanno Beckerb35d5222020-08-21 13:27:44 +0100277 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Becker97a21562020-09-09 12:57:16 +0100278 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100279
Xiaofei Baib7972842021-11-18 07:29:56 +0000280 memcpy( hashed_context, ctx, ctx_len );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100281 }
282
Xiaofei Bai746f9482021-11-12 08:53:56 +0000283 return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000284 secret, secret_len,
285 label, label_len,
286 hashed_context, ctx_len,
287 dstbuf, dstbuf_len ) );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100288}
289
Xiaofei Bai746f9482021-11-12 08:53:56 +0000290int mbedtls_ssl_tls13_evolve_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100291 mbedtls_md_type_t hash_alg,
292 const unsigned char *secret_old,
293 const unsigned char *input, size_t input_len,
294 unsigned char *secret_new )
295{
296 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
297 size_t hlen, ilen;
Hanno Becker59b50a12020-09-09 10:56:56 +0100298 unsigned char tmp_secret[ MBEDTLS_MD_MAX_SIZE ] = { 0 };
Jerry Yu6eaa41c2021-11-22 18:16:45 +0800299 unsigned char tmp_input [ MBEDTLS_ECP_MAX_BYTES ] = { 0 };
Hanno Beckere9cccb42020-08-20 13:42:46 +0100300
Xiaofei Baib7972842021-11-18 07:29:56 +0000301 const mbedtls_md_info_t *md_info;
302 md_info = mbedtls_md_info_from_type( hash_alg );
303 if( md_info == NULL )
Hanno Beckere9cccb42020-08-20 13:42:46 +0100304 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
305
Xiaofei Baib7972842021-11-18 07:29:56 +0000306 hlen = mbedtls_md_get_size( md_info );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100307
308 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100309 * on the old secret. */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100310 if( secret_old != NULL )
311 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000312 ret = mbedtls_ssl_tls13_derive_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100313 hash_alg,
314 secret_old, hlen,
315 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ),
316 NULL, 0, /* context */
317 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Hanno Becker59b50a12020-09-09 10:56:56 +0100318 tmp_secret, hlen );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100319 if( ret != 0 )
320 goto cleanup;
321 }
322
323 if( input != NULL )
324 {
Hanno Becker59b50a12020-09-09 10:56:56 +0100325 memcpy( tmp_input, input, input_len );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100326 ilen = input_len;
327 }
328 else
329 {
330 ilen = hlen;
331 }
332
333 /* HKDF-Extract takes a salt and input key material.
334 * The salt is the old secret, and the input key material
335 * is the input secret (PSK / ECDHE). */
Xiaofei Baib7972842021-11-18 07:29:56 +0000336 ret = mbedtls_hkdf_extract( md_info,
Hanno Becker59b50a12020-09-09 10:56:56 +0100337 tmp_secret, hlen,
338 tmp_input, ilen,
Hanno Beckere9cccb42020-08-20 13:42:46 +0100339 secret_new );
340 if( ret != 0 )
341 goto cleanup;
342
343 ret = 0;
344
345 cleanup:
346
Hanno Becker59b50a12020-09-09 10:56:56 +0100347 mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) );
348 mbedtls_platform_zeroize( tmp_input, sizeof(tmp_input) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100349 return( ret );
350}
351
Xiaofei Bai746f9482021-11-12 08:53:56 +0000352int mbedtls_ssl_tls13_derive_early_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100353 mbedtls_md_type_t md_type,
354 unsigned char const *early_secret,
355 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000356 mbedtls_ssl_tls13_early_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100357{
358 int ret;
359 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
360 size_t const md_size = mbedtls_md_get_size( md_info );
361
362 /* We should never call this function with an unknown hash,
363 * but add an assertion anyway. */
364 if( md_info == 0 )
365 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
366
367 /*
368 * 0
369 * |
370 * v
371 * PSK -> HKDF-Extract = Early Secret
372 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100373 * +-----> Derive-Secret(., "c e traffic", ClientHello)
374 * | = client_early_traffic_secret
375 * |
376 * +-----> Derive-Secret(., "e exp master", ClientHello)
377 * | = early_exporter_master_secret
378 * v
379 */
380
381 /* Create client_early_traffic_secret */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000382 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100383 early_secret, md_size,
384 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ),
385 transcript, transcript_len,
386 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
387 derived->client_early_traffic_secret,
388 md_size );
389 if( ret != 0 )
390 return( ret );
391
392 /* Create early exporter */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000393 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100394 early_secret, md_size,
395 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ),
396 transcript, transcript_len,
397 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
398 derived->early_exporter_master_secret,
399 md_size );
400 if( ret != 0 )
401 return( ret );
402
403 return( 0 );
404}
405
Xiaofei Bai746f9482021-11-12 08:53:56 +0000406int mbedtls_ssl_tls13_derive_handshake_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100407 mbedtls_md_type_t md_type,
408 unsigned char const *handshake_secret,
409 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000410 mbedtls_ssl_tls13_handshake_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100411{
412 int ret;
413 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
414 size_t const md_size = mbedtls_md_get_size( md_info );
415
416 /* We should never call this function with an unknown hash,
417 * but add an assertion anyway. */
418 if( md_info == 0 )
419 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
420
421 /*
422 *
423 * Handshake Secret
424 * |
425 * +-----> Derive-Secret( ., "c hs traffic",
426 * | ClientHello...ServerHello )
427 * | = client_handshake_traffic_secret
428 * |
429 * +-----> Derive-Secret( ., "s hs traffic",
430 * | ClientHello...ServerHello )
431 * | = server_handshake_traffic_secret
432 *
433 */
434
435 /*
436 * Compute client_handshake_traffic_secret with
437 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
438 */
439
Xiaofei Bai746f9482021-11-12 08:53:56 +0000440 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100441 handshake_secret, md_size,
442 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ),
443 transcript, transcript_len,
444 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
445 derived->client_handshake_traffic_secret,
446 md_size );
447 if( ret != 0 )
448 return( ret );
449
450 /*
451 * Compute server_handshake_traffic_secret with
452 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
453 */
454
Xiaofei Bai746f9482021-11-12 08:53:56 +0000455 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100456 handshake_secret, md_size,
457 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ),
458 transcript, transcript_len,
459 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
460 derived->server_handshake_traffic_secret,
461 md_size );
462 if( ret != 0 )
463 return( ret );
464
465 return( 0 );
466}
467
Xiaofei Bai746f9482021-11-12 08:53:56 +0000468int mbedtls_ssl_tls13_derive_application_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100469 mbedtls_md_type_t md_type,
470 unsigned char const *application_secret,
471 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000472 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100473{
474 int ret;
475 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
476 size_t const md_size = mbedtls_md_get_size( md_info );
477
478 /* We should never call this function with an unknown hash,
479 * but add an assertion anyway. */
480 if( md_info == 0 )
481 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
482
483 /* Generate {client,server}_application_traffic_secret_0
484 *
485 * Master Secret
486 * |
487 * +-----> Derive-Secret( ., "c ap traffic",
488 * | ClientHello...server Finished )
489 * | = client_application_traffic_secret_0
490 * |
491 * +-----> Derive-Secret( ., "s ap traffic",
492 * | ClientHello...Server Finished )
493 * | = server_application_traffic_secret_0
494 * |
495 * +-----> Derive-Secret( ., "exp master",
496 * | ClientHello...server Finished)
497 * | = exporter_master_secret
498 *
499 */
500
Xiaofei Bai746f9482021-11-12 08:53:56 +0000501 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100502 application_secret, md_size,
503 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ),
504 transcript, transcript_len,
505 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
506 derived->client_application_traffic_secret_N,
507 md_size );
508 if( ret != 0 )
509 return( ret );
510
Xiaofei Bai746f9482021-11-12 08:53:56 +0000511 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100512 application_secret, md_size,
513 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ),
514 transcript, transcript_len,
515 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
516 derived->server_application_traffic_secret_N,
517 md_size );
518 if( ret != 0 )
519 return( ret );
520
Xiaofei Bai746f9482021-11-12 08:53:56 +0000521 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100522 application_secret, md_size,
523 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ),
524 transcript, transcript_len,
525 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
526 derived->exporter_master_secret,
527 md_size );
528 if( ret != 0 )
529 return( ret );
530
531 return( 0 );
532}
533
534/* Generate resumption_master_secret for use with the ticket exchange.
535 *
Xiaofei Bai746f9482021-11-12 08:53:56 +0000536 * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets()
Hanno Beckeref5235b2021-05-24 06:39:41 +0100537 * because it uses the transcript hash up to and including ClientFinished. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000538int mbedtls_ssl_tls13_derive_resumption_master_secret(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100539 mbedtls_md_type_t md_type,
540 unsigned char const *application_secret,
541 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000542 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100543{
544 int ret;
545 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
546 size_t const md_size = mbedtls_md_get_size( md_info );
547
548 /* We should never call this function with an unknown hash,
549 * but add an assertion anyway. */
550 if( md_info == 0 )
551 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
552
Xiaofei Bai746f9482021-11-12 08:53:56 +0000553 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100554 application_secret, md_size,
555 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ),
556 transcript, transcript_len,
557 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
558 derived->resumption_master_secret,
559 md_size );
560
561 if( ret != 0 )
562 return( ret );
563
564 return( 0 );
565}
566
XiaokangQiana4c99f22021-11-11 06:46:35 +0000567int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000568{
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000569 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +0000570 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
571 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000572#if defined(MBEDTLS_DEBUG_C)
573 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
574 size_t const md_size = mbedtls_md_get_size( md_info );
575#endif /* MBEDTLS_DEBUG_C */
576
577 /*
578 * Compute MasterSecret
579 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000580 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000581 handshake->tls13_master_secrets.handshake,
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000582 NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000583 handshake->tls13_master_secrets.app );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000584 if( ret != 0 )
585 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000586 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000587 return( ret );
588 }
589
590 MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +0000591 handshake->tls13_master_secrets.app, md_size );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000592
593 return( 0 );
594}
595
Xiaofei Bai746f9482021-11-12 08:53:56 +0000596static int ssl_tls13_calc_finished_core( mbedtls_md_type_t md_type,
597 unsigned char const *base_key,
598 unsigned char const *transcript,
599 unsigned char *dst )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100600{
601 const mbedtls_md_info_t* const md_info = mbedtls_md_info_from_type( md_type );
602 size_t const md_size = mbedtls_md_get_size( md_info );
603 unsigned char finished_key[MBEDTLS_MD_MAX_SIZE];
604 int ret;
605
606 /* We should never call this function with an unknown hash,
607 * but add an assertion anyway. */
608 if( md_info == 0 )
609 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
610
611 /* TLS 1.3 Finished message
612 *
613 * struct {
614 * opaque verify_data[Hash.length];
615 * } Finished;
616 *
617 * verify_data =
618 * HMAC( finished_key,
619 * Hash( Handshake Context +
620 * Certificate* +
621 * CertificateVerify* )
622 * )
623 *
624 * finished_key =
625 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
626 */
627
Xiaofei Bai746f9482021-11-12 08:53:56 +0000628 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100629 md_type, base_key, md_size,
630 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ),
631 NULL, 0,
632 finished_key, md_size );
633 if( ret != 0 )
634 goto exit;
635
636 ret = mbedtls_md_hmac( md_info, finished_key, md_size, transcript, md_size, dst );
637 if( ret != 0 )
638 goto exit;
639
640exit:
641
642 mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) );
643 return( ret );
644}
645
XiaokangQianc5c39d52021-11-09 11:55:10 +0000646int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl,
XiaokangQianaaa0e192021-11-10 03:07:04 +0000647 unsigned char* dst,
648 size_t dst_len,
649 size_t *actual_len,
650 int from )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000651{
XiaokangQiana7634982021-10-22 06:32:32 +0000652 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000653
XiaokangQianaaa0e192021-11-10 03:07:04 +0000654 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000655 size_t transcript_len;
656
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800657 unsigned char *base_key = NULL;
Jerry Yub737f6a2021-12-10 17:55:23 +0800658 size_t base_key_len = 0;
Jerry Yu9c074732021-12-10 17:12:43 +0800659 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets =
660 &ssl->handshake->tls13_hs_secrets;
Jerry Yua5563f62021-12-10 18:14:36 +0800661
662 mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac;
663 const mbedtls_md_info_t* const md_info =
664 mbedtls_md_info_from_type( md_type );
665 size_t const md_size = mbedtls_md_get_size( md_info );
666
667 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) );
668
Jerry Yub737f6a2021-12-10 17:55:23 +0800669 if( from == MBEDTLS_SSL_IS_CLIENT )
670 {
671 base_key = tls13_hs_secrets->client_handshake_traffic_secret;
672 base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret );
673 }
674 else
675 {
676 base_key = tls13_hs_secrets->server_handshake_traffic_secret;
677 base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret );
678 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000679
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000680 if( dst_len < md_size )
Jerry Yu9c074732021-12-10 17:12:43 +0800681 {
682 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
683 goto exit;
684 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000685
686 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
687 transcript, sizeof( transcript ),
688 &transcript_len );
689 if( ret != 0 )
690 {
691 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000692 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000693 }
694 MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len );
695
Xiaofei Bai746f9482021-11-12 08:53:56 +0000696 ret = ssl_tls13_calc_finished_core( md_type, base_key, transcript, dst );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000697 if( ret != 0 )
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000698 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000699 *actual_len = md_size;
700
701 MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, md_size );
XiaokangQianc5c39d52021-11-09 11:55:10 +0000702 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000703
704exit:
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800705 /* Erase handshake secrets */
Jerry Yub737f6a2021-12-10 17:55:23 +0800706 mbedtls_platform_zeroize( base_key, base_key_len );
XiaokangQian33062842021-11-11 03:37:45 +0000707 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000708 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000709}
710
Xiaofei Bai746f9482021-11-12 08:53:56 +0000711int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100712 const mbedtls_md_type_t md_type,
713 unsigned char const *psk, size_t psk_len,
714 int psk_type,
715 unsigned char const *transcript,
716 unsigned char *result )
717{
718 int ret = 0;
719 unsigned char binder_key[MBEDTLS_MD_MAX_SIZE];
720 unsigned char early_secret[MBEDTLS_MD_MAX_SIZE];
721 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type( md_type );
722 size_t const md_size = mbedtls_md_get_size( md_info );
723
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100724#if !defined(MBEDTLS_DEBUG_C)
725 ssl = NULL; /* make sure we don't use it except for debug */
726 ((void) ssl);
727#endif
728
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100729 /* We should never call this function with an unknown hash,
730 * but add an assertion anyway. */
731 if( md_info == 0 )
732 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
733
734 /*
735 * 0
736 * |
737 * v
738 * PSK -> HKDF-Extract = Early Secret
739 * |
740 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
741 * | = binder_key
742 * v
743 */
744
Xiaofei Bai746f9482021-11-12 08:53:56 +0000745 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
746 NULL, /* Old secret */
747 psk, psk_len, /* Input */
748 early_secret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100749 if( ret != 0 )
750 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000751 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100752 goto exit;
753 }
754
755 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
756 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000757 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100758 early_secret, md_size,
759 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ),
760 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
761 binder_key, md_size );
762 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) );
763 }
764 else
765 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000766 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100767 early_secret, md_size,
768 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ),
769 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
770 binder_key, md_size );
771 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) );
772 }
773
774 if( ret != 0 )
775 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000776 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100777 goto exit;
778 }
779
780 /*
781 * The binding_value is computed in the same way as the Finished message
782 * but with the BaseKey being the binder_key.
783 */
784
Xiaofei Bai746f9482021-11-12 08:53:56 +0000785 ret = ssl_tls13_calc_finished_core( md_type, binder_key, transcript, result );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100786 if( ret != 0 )
787 goto exit;
788
789 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, md_size );
790
791exit:
792
793 mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) );
794 mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) );
795 return( ret );
796}
797
Hanno Beckerc94060c2021-03-22 07:50:44 +0000798int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform,
799 int endpoint,
800 int ciphersuite,
801 mbedtls_ssl_key_set const *traffic_keys,
802 mbedtls_ssl_context *ssl /* DEBUG ONLY */ )
803{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100804#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000805 int ret;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100806#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000807 mbedtls_cipher_info_t const *cipher_info;
808 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
809 unsigned char const *key_enc;
810 unsigned char const *iv_enc;
811 unsigned char const *key_dec;
812 unsigned char const *iv_dec;
813
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100814#if defined(MBEDTLS_USE_PSA_CRYPTO)
815 psa_key_type_t key_type;
816 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
817 psa_algorithm_t alg;
818 size_t key_bits;
819 psa_status_t status = PSA_SUCCESS;
820#endif
821
Hanno Beckerc94060c2021-03-22 07:50:44 +0000822#if !defined(MBEDTLS_DEBUG_C)
823 ssl = NULL; /* make sure we don't use it except for those cases */
824 (void) ssl;
825#endif
826
827 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Hanno Becker7887a772021-04-20 05:27:57 +0100828 if( ciphersuite_info == NULL )
829 {
830 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
831 ciphersuite ) );
832 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
833 }
Hanno Beckerc94060c2021-03-22 07:50:44 +0000834
835 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
836 if( cipher_info == NULL )
837 {
Hanno Becker7887a772021-04-20 05:27:57 +0100838 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
839 ciphersuite_info->cipher ) );
Hanno Beckerf62a7302021-04-21 05:21:28 +0100840 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Beckerc94060c2021-03-22 07:50:44 +0000841 }
842
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100843#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000844 /*
845 * Setup cipher contexts in target transform
846 */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000847 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
848 cipher_info ) ) != 0 )
849 {
850 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
851 return( ret );
852 }
853
854 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
855 cipher_info ) ) != 0 )
856 {
857 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
858 return( ret );
859 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100860#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000861
862#if defined(MBEDTLS_SSL_SRV_C)
863 if( endpoint == MBEDTLS_SSL_IS_SERVER )
864 {
865 key_enc = traffic_keys->server_write_key;
866 key_dec = traffic_keys->client_write_key;
867 iv_enc = traffic_keys->server_write_iv;
868 iv_dec = traffic_keys->client_write_iv;
869 }
870 else
871#endif /* MBEDTLS_SSL_SRV_C */
872#if defined(MBEDTLS_SSL_CLI_C)
873 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
874 {
875 key_enc = traffic_keys->client_write_key;
876 key_dec = traffic_keys->server_write_key;
877 iv_enc = traffic_keys->client_write_iv;
878 iv_dec = traffic_keys->server_write_iv;
879 }
880 else
881#endif /* MBEDTLS_SSL_CLI_C */
882 {
883 /* should not happen */
884 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
885 }
886
887 memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len );
888 memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len );
889
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100890#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Beckerc94060c2021-03-22 07:50:44 +0000891 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc,
892 key_enc, cipher_info->key_bitlen,
893 MBEDTLS_ENCRYPT ) ) != 0 )
894 {
895 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
896 return( ret );
897 }
898
899 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec,
900 key_dec, cipher_info->key_bitlen,
901 MBEDTLS_DECRYPT ) ) != 0 )
902 {
903 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
904 return( ret );
905 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100906#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerc94060c2021-03-22 07:50:44 +0000907
Przemyslaw Stekieldd7b5012022-01-17 15:28:57 +0100908 /*
909 * Setup other fields in SSL transform
910 */
911
912 if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 )
913 transform->taglen = 8;
914 else
915 transform->taglen = 16;
916
917 transform->ivlen = traffic_keys->iv_len;
918 transform->maclen = 0;
919 transform->fixed_ivlen = transform->ivlen;
920 transform->minor_ver = MBEDTLS_SSL_MINOR_VERSION_4;
921
922 /* We add the true record content type (1 Byte) to the plaintext and
923 * then pad to the configured granularity. The mimimum length of the
924 * type-extended and padded plaintext is therefore the padding
925 * granularity. */
926 transform->minlen =
927 transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY;
928
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100929#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100930 /*
931 * Setup psa keys and alg
932 */
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +0100933 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100934 transform->taglen,
935 &alg,
936 &key_type,
937 &key_bits ) ) != PSA_SUCCESS )
938 {
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +0100939 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", psa_ssl_status_to_mbedtls( status ) );
940 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100941 }
942
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100943 transform->psa_alg = alg;
944
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +0100945 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100946 {
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +0100947 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
948 psa_set_key_algorithm( &attributes, alg );
949 psa_set_key_type( &attributes, key_type );
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +0100950
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +0100951 if( ( status = psa_import_key( &attributes,
952 key_enc,
953 PSA_BITS_TO_BYTES( key_bits ),
954 &transform->psa_key_enc ) ) != PSA_SUCCESS )
955 {
956 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
957 return( psa_ssl_status_to_mbedtls( status ) );
958 }
Przemyslaw Stekielfe7397d2022-01-17 15:47:07 +0100959
Przemyslaw Stekielf9cd6082022-02-01 11:25:55 +0100960 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
961
962 if( ( status = psa_import_key( &attributes,
963 key_dec,
964 PSA_BITS_TO_BYTES( key_bits ),
965 &transform->psa_key_dec ) ) != PSA_SUCCESS )
966 {
967 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", psa_ssl_status_to_mbedtls( status ) );
968 return( psa_ssl_status_to_mbedtls( status ) );
969 }
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100970 }
971#endif /* MBEDTLS_USE_PSA_CRYPTO */
972
Hanno Beckerc94060c2021-03-22 07:50:44 +0000973 return( 0 );
974}
975
Xiaofei Bai746f9482021-11-12 08:53:56 +0000976int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl )
Jerry Yu89ea3212021-09-09 14:31:24 +0800977{
Jerry Yue3131ef2021-09-16 13:14:15 +0800978 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
979 mbedtls_md_type_t md_type;
Jerry Yu5ccfcd42021-10-11 16:39:29 +0800980 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu6ca7c7f2021-09-28 18:51:40 +0800981
Jerry Yu5ccfcd42021-10-11 16:39:29 +0800982 if( handshake->ciphersuite_info == NULL )
Jerry Yu89ea3212021-09-09 14:31:24 +0800983 {
984 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) );
985 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
986 }
Jerry Yue3131ef2021-09-16 13:14:15 +0800987
Jerry Yu5ccfcd42021-10-11 16:39:29 +0800988 md_type = handshake->ciphersuite_info->mac;
Jerry Yue06f4532021-09-23 18:35:07 +0800989
Xiaofei Bai746f9482021-11-12 08:53:56 +0000990 ret = mbedtls_ssl_tls13_evolve_secret( md_type, NULL, NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000991 handshake->tls13_master_secrets.early );
Jerry Yu89ea3212021-09-09 14:31:24 +0800992 if( ret != 0 )
993 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000994 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yu89ea3212021-09-09 14:31:24 +0800995 return( ret );
996 }
997
998 return( 0 );
999}
1000
Jerry Yuc068b662021-10-11 22:30:19 +08001001/* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for
Jerry Yu61e35e02021-09-16 18:59:08 +08001002 * protecting the handshake messages, as described in Section 7 of TLS 1.3. */
Jerry Yuc068b662021-10-11 22:30:19 +08001003int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl,
1004 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu61e35e02021-09-16 18:59:08 +08001005{
1006 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1007
1008 mbedtls_md_type_t md_type;
1009 mbedtls_md_info_t const *md_info;
1010 size_t md_size;
1011
Jerry Yu435208a2021-10-13 11:22:16 +08001012 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu61e35e02021-09-16 18:59:08 +08001013 size_t transcript_len;
1014
1015 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001016 size_t key_len, iv_len;
Jerry Yu61e35e02021-09-16 18:59:08 +08001017
Jerry Yu435208a2021-10-13 11:22:16 +08001018 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1019 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
Xiaofei Bai746f9482021-11-12 08:53:56 +00001020 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets;
Jerry Yu435208a2021-10-13 11:22:16 +08001021
Jerry Yuc068b662021-10-11 22:30:19 +08001022 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001023
Jerry Yu435208a2021-10-13 11:22:16 +08001024 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001025 key_len = cipher_info->key_bitlen >> 3;
1026 iv_len = cipher_info->iv_size;
Jerry Yu61e35e02021-09-16 18:59:08 +08001027
Jerry Yu435208a2021-10-13 11:22:16 +08001028 md_type = ciphersuite_info->mac;
Jerry Yu61e35e02021-09-16 18:59:08 +08001029 md_info = mbedtls_md_info_from_type( md_type );
1030 md_size = mbedtls_md_get_size( md_info );
1031
1032 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1033 transcript,
1034 sizeof( transcript ),
1035 &transcript_len );
1036 if( ret != 0 )
1037 {
1038 MBEDTLS_SSL_DEBUG_RET( 1,
1039 "mbedtls_ssl_get_handshake_transcript",
1040 ret );
1041 return( ret );
1042 }
1043
Xiaofei Bai746f9482021-11-12 08:53:56 +00001044 ret = mbedtls_ssl_tls13_derive_handshake_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001045 handshake->tls13_master_secrets.handshake,
Jerry Yu435208a2021-10-13 11:22:16 +08001046 transcript, transcript_len, tls13_hs_secrets );
Jerry Yu61e35e02021-09-16 18:59:08 +08001047 if( ret != 0 )
1048 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001049 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets",
Jerry Yu61e35e02021-09-16 18:59:08 +08001050 ret );
1051 return( ret );
1052 }
1053
1054 MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001055 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001056 md_size );
Jerry Yu61e35e02021-09-16 18:59:08 +08001057 MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001058 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001059 md_size );
1060
1061 /*
1062 * Export client handshake traffic secret
1063 */
Jerry Yu61e35e02021-09-16 18:59:08 +08001064 if( ssl->f_export_keys != NULL )
1065 {
1066 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001067 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001068 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001069 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001070 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001071 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001072 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1073
1074 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001075 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001076 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001077 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001078 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001079 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001080 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1081 }
Jerry Yu61e35e02021-09-16 18:59:08 +08001082
Xiaofei Bai746f9482021-11-12 08:53:56 +00001083 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
Jerry Yu435208a2021-10-13 11:22:16 +08001084 tls13_hs_secrets->client_handshake_traffic_secret,
1085 tls13_hs_secrets->server_handshake_traffic_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +00001086 md_size, key_len, iv_len, traffic_keys );
Jerry Yu61e35e02021-09-16 18:59:08 +08001087 if( ret != 0 )
1088 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001089 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
Jerry Yu61e35e02021-09-16 18:59:08 +08001090 goto exit;
1091 }
1092
1093 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key",
1094 traffic_keys->client_write_key,
1095 traffic_keys->key_len);
1096
1097 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key",
1098 traffic_keys->server_write_key,
1099 traffic_keys->key_len);
1100
1101 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv",
1102 traffic_keys->client_write_iv,
1103 traffic_keys->iv_len);
1104
1105 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv",
1106 traffic_keys->server_write_iv,
1107 traffic_keys->iv_len);
1108
Jerry Yuc068b662021-10-11 22:30:19 +08001109 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001110
1111exit:
1112
1113 return( ret );
1114}
1115
Jerry Yuf0ac2352021-10-11 17:47:07 +08001116int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl )
Jerry Yua0650eb2021-09-09 17:14:45 +08001117{
Jerry Yuf0ac2352021-10-11 17:47:07 +08001118 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001119#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED) && defined(MBEDTLS_ECDH_C)
1120 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
1121#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED && MBEDTLS_ECDH_C */
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001122 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1123 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
Jerry Yua0650eb2021-09-09 17:14:45 +08001124#if defined(MBEDTLS_DEBUG_C)
1125 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
1126 size_t const md_size = mbedtls_md_get_size( md_info );
1127#endif /* MBEDTLS_DEBUG_C */
1128
Jerry Yuf0ac2352021-10-11 17:47:07 +08001129#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1130 /*
1131 * Compute ECDHE secret used to compute the handshake secret from which
1132 * client_handshake_traffic_secret and server_handshake_traffic_secret
1133 * are derived in the handshake secret derivation stage.
1134 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001135 if( mbedtls_ssl_tls13_ephemeral_enabled( ssl ) )
Jerry Yuf0ac2352021-10-11 17:47:07 +08001136 {
1137 if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) )
1138 {
1139#if defined(MBEDTLS_ECDH_C)
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001140 /* Compute ECDH shared secret. */
1141 status = psa_raw_key_agreement(
1142 PSA_ALG_ECDH, handshake->ecdh_psa_privkey,
1143 handshake->ecdh_psa_peerkey, handshake->ecdh_psa_peerkey_len,
1144 handshake->premaster, sizeof( handshake->premaster ),
1145 &handshake->pmslen );
1146 if( status != PSA_SUCCESS )
1147 {
1148 ret = psa_ssl_status_to_mbedtls( status );
1149 MBEDTLS_SSL_DEBUG_RET( 1, "psa_raw_key_agreement", ret );
1150 return( ret );
1151 }
1152
1153 status = psa_destroy_key( handshake->ecdh_psa_privkey );
1154 if( status != PSA_SUCCESS )
1155 {
1156 ret = psa_ssl_status_to_mbedtls( status );
1157 MBEDTLS_SSL_DEBUG_RET( 1, "psa_destroy_key", ret );
1158 return( ret );
1159 }
1160
1161 handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Jerry Yuf0ac2352021-10-11 17:47:07 +08001162#endif /* MBEDTLS_ECDH_C */
1163 }
1164 else if( mbedtls_ssl_tls13_named_group_is_dhe( handshake->offered_group_id ) )
1165 {
Jerry Yuf0ac2352021-10-11 17:47:07 +08001166 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DHE not supported." ) );
1167 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1168 }
1169 }
1170#else
1171 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1172#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
Jerry Yua0650eb2021-09-09 17:14:45 +08001173
1174 /*
Jerry Yuf0ac2352021-10-11 17:47:07 +08001175 * Compute the Handshake Secret
Jerry Yua0650eb2021-09-09 17:14:45 +08001176 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001177 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001178 handshake->tls13_master_secrets.early,
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001179 handshake->premaster, handshake->pmslen,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001180 handshake->tls13_master_secrets.handshake );
Jerry Yua0650eb2021-09-09 17:14:45 +08001181 if( ret != 0 )
1182 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001183 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yua0650eb2021-09-09 17:14:45 +08001184 return( ret );
1185 }
1186
1187 MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +00001188 handshake->tls13_master_secrets.handshake, md_size );
Jerry Yua0650eb2021-09-09 17:14:45 +08001189
1190#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
Przemyslaw Stekielc0824bf2022-02-10 10:37:15 +01001191 mbedtls_platform_zeroize( handshake->premaster, sizeof( handshake->premaster ) );
Jerry Yua0650eb2021-09-09 17:14:45 +08001192#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
1193 return( 0 );
1194}
1195
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001196/* Generate application traffic keys since any records following a 1-RTT Finished message
1197 * MUST be encrypted under the application traffic key.
1198 */
XiaokangQiand0aa3e92021-11-10 06:17:40 +00001199int mbedtls_ssl_tls13_generate_application_keys(
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001200 mbedtls_ssl_context *ssl,
1201 mbedtls_ssl_key_set *traffic_keys )
1202{
XiaokangQiana7634982021-10-22 06:32:32 +00001203 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +00001204 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001205
1206 /* Address at which to store the application secrets */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001207 mbedtls_ssl_tls13_application_secrets * const app_secrets =
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001208 &ssl->session_negotiate->app_secrets;
1209
1210 /* Holding the transcript up to and including the ServerFinished */
XiaokangQian33062842021-11-11 03:37:45 +00001211 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001212 size_t transcript_len;
1213
1214 /* Variables relating to the hash for the chosen ciphersuite. */
1215 mbedtls_md_type_t md_type;
1216 mbedtls_md_info_t const *md_info;
1217 size_t md_size;
1218
1219 /* Variables relating to the cipher for the chosen ciphersuite. */
1220 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001221 size_t key_len, iv_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001222
1223 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) );
1224
1225 /* Extract basic information about hash and ciphersuite */
1226
1227 cipher_info = mbedtls_cipher_info_from_type(
XiaokangQian33062842021-11-11 03:37:45 +00001228 handshake->ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001229 key_len = cipher_info->key_bitlen / 8;
1230 iv_len = cipher_info->iv_size;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001231
XiaokangQian33062842021-11-11 03:37:45 +00001232 md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001233 md_info = mbedtls_md_info_from_type( md_type );
1234 md_size = mbedtls_md_get_size( md_info );
1235
1236 /* Compute current handshake transcript. It's the caller's responsiblity
1237 * to call this at the right time, that is, after the ServerFinished. */
1238
1239 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1240 transcript, sizeof( transcript ),
1241 &transcript_len );
1242 if( ret != 0 )
XiaokangQian4cab0242021-10-12 08:43:37 +00001243 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001244
1245 /* Compute application secrets from master secret and transcript hash. */
1246
Xiaofei Bai746f9482021-11-12 08:53:56 +00001247 ret = mbedtls_ssl_tls13_derive_application_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001248 handshake->tls13_master_secrets.app,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001249 transcript, transcript_len,
1250 app_secrets );
Jerry Yu4a2fa5d2021-12-10 10:19:34 +08001251 /* Erase master secrets */
Jerry Yu23ab7a42021-12-08 14:34:10 +08001252 mbedtls_platform_zeroize( &ssl->handshake->tls13_master_secrets,
Jerry Yu27224f52021-12-09 10:56:50 +08001253 sizeof( ssl->handshake->tls13_master_secrets ) );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001254 if( ret != 0 )
1255 {
1256 MBEDTLS_SSL_DEBUG_RET( 1,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001257 "mbedtls_ssl_tls13_derive_application_secrets", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001258 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001259 }
1260
1261 /* Derive first epoch of IV + Key for application traffic. */
1262
Xiaofei Bai746f9482021-11-12 08:53:56 +00001263 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001264 app_secrets->client_application_traffic_secret_N,
1265 app_secrets->server_application_traffic_secret_N,
Xiaofei Baib7972842021-11-18 07:29:56 +00001266 md_size, key_len, iv_len, traffic_keys );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001267 if( ret != 0 )
1268 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001269 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001270 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001271 }
1272
1273 MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret",
1274 app_secrets->client_application_traffic_secret_N,
1275 md_size );
1276
1277 MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret",
1278 app_secrets->server_application_traffic_secret_N,
1279 md_size );
1280
XiaokangQianac0385c2021-11-03 06:40:11 +00001281 /*
1282 * Export client/server application traffic secret 0
1283 */
1284 if( ssl->f_export_keys != NULL )
1285 {
1286 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001287 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001288 app_secrets->client_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001289 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001290 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001291 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1292 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001293
1294 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001295 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001296 app_secrets->server_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001297 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001298 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001299 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1300 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001301 }
1302
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001303 MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:",
Xiaofei Baib7972842021-11-18 07:29:56 +00001304 traffic_keys->client_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001305 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key",
Xiaofei Baib7972842021-11-18 07:29:56 +00001306 traffic_keys->server_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001307 MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001308 traffic_keys->client_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001309 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001310 traffic_keys->server_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001311
1312 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001313
1314 cleanup:
Jerry Yu2c70a392021-12-08 13:28:49 +08001315 /* randbytes is not used again */
1316 mbedtls_platform_zeroize( ssl->handshake->randbytes,
1317 sizeof( ssl->handshake->randbytes ) );
XiaokangQian33062842021-11-11 03:37:45 +00001318 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001319 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001320}
1321
Ronald Cron6f135e12021-12-08 16:57:54 +01001322#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */