blob: 299d8bca4d366d1052448a877719fd967247efbb [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
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +010034/* Convert key bits to byte size */
35#define KEY_BYTES( bits ) ( ( (size_t) bits + 7 ) / 8 )
36
37
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(
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100141 mbedtls_md_type_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{
Xiaofei Baib7972842021-11-18 07:29:56 +0000147 const mbedtls_md_info_t *md_info;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100148 unsigned char hkdf_label[ SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN ];
149 size_t hkdf_label_len;
150
Xiaofei Baib7972842021-11-18 07:29:56 +0000151 if( label_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100152 {
153 /* Should never happen since this is an internal
154 * function, and we know statically which labels
155 * are allowed. */
156 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
157 }
158
Xiaofei Baib7972842021-11-18 07:29:56 +0000159 if( ctx_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100160 {
161 /* Should not happen, as above. */
162 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
163 }
164
Xiaofei Baib7972842021-11-18 07:29:56 +0000165 if( buf_len > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100166 {
167 /* Should not happen, as above. */
168 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
169 }
170
Xiaofei Baib7972842021-11-18 07:29:56 +0000171 md_info = mbedtls_md_info_from_type( hash_alg );
172 if( md_info == NULL )
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100173 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
174
Xiaofei Baib7972842021-11-18 07:29:56 +0000175 ssl_tls13_hkdf_encode_label( buf_len,
176 label, label_len,
177 ctx, ctx_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000178 hkdf_label,
179 &hkdf_label_len );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100180
Xiaofei Baib7972842021-11-18 07:29:56 +0000181 return( mbedtls_hkdf_expand( md_info,
182 secret, secret_len,
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100183 hkdf_label, hkdf_label_len,
Xiaofei Baib7972842021-11-18 07:29:56 +0000184 buf, buf_len ) );
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100185}
186
Hanno Becker3385a4d2020-08-21 13:03:34 +0100187/*
188 * The traffic keying material is generated from the following inputs:
189 *
190 * - One secret value per sender.
191 * - A purpose value indicating the specific value being generated
192 * - The desired lengths of key and IV.
193 *
194 * The expansion itself is based on HKDF:
195 *
196 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
197 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
198 *
199 * [sender] denotes the sending side and the Secret value is provided
200 * by the function caller. Note that we generate server and client side
201 * keys in a single function call.
202 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000203int mbedtls_ssl_tls13_make_traffic_keys(
Hanno Becker3385a4d2020-08-21 13:03:34 +0100204 mbedtls_md_type_t hash_alg,
205 const unsigned char *client_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +0000206 const unsigned char *server_secret, size_t secret_len,
207 size_t key_len, size_t iv_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100208 mbedtls_ssl_key_set *keys )
209{
210 int ret = 0;
211
Xiaofei Bai746f9482021-11-12 08:53:56 +0000212 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000213 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100214 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
215 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100216 keys->client_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100217 if( ret != 0 )
218 return( ret );
219
Xiaofei Bai746f9482021-11-12 08:53:56 +0000220 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000221 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100222 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( key ),
223 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100224 keys->server_write_key, key_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100225 if( ret != 0 )
226 return( ret );
227
Xiaofei Bai746f9482021-11-12 08:53:56 +0000228 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000229 client_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100230 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
231 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100232 keys->client_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100233 if( ret != 0 )
234 return( ret );
235
Xiaofei Bai746f9482021-11-12 08:53:56 +0000236 ret = mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000237 server_secret, secret_len,
Hanno Becker3385a4d2020-08-21 13:03:34 +0100238 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( iv ),
239 NULL, 0,
Hanno Becker493ea7f2020-09-08 11:01:00 +0100240 keys->server_write_iv, iv_len );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100241 if( ret != 0 )
242 return( ret );
243
Hanno Becker493ea7f2020-09-08 11:01:00 +0100244 keys->key_len = key_len;
245 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100246
247 return( 0 );
248}
249
Xiaofei Bai746f9482021-11-12 08:53:56 +0000250int mbedtls_ssl_tls13_derive_secret(
Hanno Beckerb35d5222020-08-21 13:27:44 +0100251 mbedtls_md_type_t hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000252 const unsigned char *secret, size_t secret_len,
253 const unsigned char *label, size_t label_len,
254 const unsigned char *ctx, size_t ctx_len,
Hanno Becker0c42fd92020-09-09 12:58:29 +0100255 int ctx_hashed,
Xiaofei Baib7972842021-11-18 07:29:56 +0000256 unsigned char *dstbuf, size_t dstbuf_len )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100257{
258 int ret;
259 unsigned char hashed_context[ MBEDTLS_MD_MAX_SIZE ];
260
Xiaofei Baib7972842021-11-18 07:29:56 +0000261 const mbedtls_md_info_t *md_info;
262 md_info = mbedtls_md_info_from_type( hash_alg );
263 if( md_info == NULL )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100264 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
265
Hanno Becker0c42fd92020-09-09 12:58:29 +0100266 if( ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED )
Hanno Beckerb35d5222020-08-21 13:27:44 +0100267 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000268 ret = mbedtls_md( md_info, ctx, ctx_len, hashed_context );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100269 if( ret != 0 )
270 return( ret );
Xiaofei Baib7972842021-11-18 07:29:56 +0000271 ctx_len = mbedtls_md_get_size( md_info );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100272 }
273 else
274 {
Xiaofei Baib7972842021-11-18 07:29:56 +0000275 if( ctx_len > sizeof(hashed_context) )
Hanno Becker97a21562020-09-09 12:57:16 +0100276 {
277 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100278 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100279 * Let's double-check nonetheless to not run at the risk
280 * of getting a stack overflow. */
Hanno Beckerb35d5222020-08-21 13:27:44 +0100281 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Becker97a21562020-09-09 12:57:16 +0100282 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100283
Xiaofei Baib7972842021-11-18 07:29:56 +0000284 memcpy( hashed_context, ctx, ctx_len );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100285 }
286
Xiaofei Bai746f9482021-11-12 08:53:56 +0000287 return( mbedtls_ssl_tls13_hkdf_expand_label( hash_alg,
Xiaofei Baib7972842021-11-18 07:29:56 +0000288 secret, secret_len,
289 label, label_len,
290 hashed_context, ctx_len,
291 dstbuf, dstbuf_len ) );
Hanno Beckerb35d5222020-08-21 13:27:44 +0100292}
293
Xiaofei Bai746f9482021-11-12 08:53:56 +0000294int mbedtls_ssl_tls13_evolve_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100295 mbedtls_md_type_t hash_alg,
296 const unsigned char *secret_old,
297 const unsigned char *input, size_t input_len,
298 unsigned char *secret_new )
299{
300 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
301 size_t hlen, ilen;
Hanno Becker59b50a12020-09-09 10:56:56 +0100302 unsigned char tmp_secret[ MBEDTLS_MD_MAX_SIZE ] = { 0 };
Jerry Yu6eaa41c2021-11-22 18:16:45 +0800303 unsigned char tmp_input [ MBEDTLS_ECP_MAX_BYTES ] = { 0 };
Hanno Beckere9cccb42020-08-20 13:42:46 +0100304
Xiaofei Baib7972842021-11-18 07:29:56 +0000305 const mbedtls_md_info_t *md_info;
306 md_info = mbedtls_md_info_from_type( hash_alg );
307 if( md_info == NULL )
Hanno Beckere9cccb42020-08-20 13:42:46 +0100308 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
309
Xiaofei Baib7972842021-11-18 07:29:56 +0000310 hlen = mbedtls_md_get_size( md_info );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100311
312 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100313 * on the old secret. */
Hanno Beckere9cccb42020-08-20 13:42:46 +0100314 if( secret_old != NULL )
315 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000316 ret = mbedtls_ssl_tls13_derive_secret(
Hanno Beckere9cccb42020-08-20 13:42:46 +0100317 hash_alg,
318 secret_old, hlen,
319 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( derived ),
320 NULL, 0, /* context */
321 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
Hanno Becker59b50a12020-09-09 10:56:56 +0100322 tmp_secret, hlen );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100323 if( ret != 0 )
324 goto cleanup;
325 }
326
327 if( input != NULL )
328 {
Hanno Becker59b50a12020-09-09 10:56:56 +0100329 memcpy( tmp_input, input, input_len );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100330 ilen = input_len;
331 }
332 else
333 {
334 ilen = hlen;
335 }
336
337 /* HKDF-Extract takes a salt and input key material.
338 * The salt is the old secret, and the input key material
339 * is the input secret (PSK / ECDHE). */
Xiaofei Baib7972842021-11-18 07:29:56 +0000340 ret = mbedtls_hkdf_extract( md_info,
Hanno Becker59b50a12020-09-09 10:56:56 +0100341 tmp_secret, hlen,
342 tmp_input, ilen,
Hanno Beckere9cccb42020-08-20 13:42:46 +0100343 secret_new );
344 if( ret != 0 )
345 goto cleanup;
346
347 ret = 0;
348
349 cleanup:
350
Hanno Becker59b50a12020-09-09 10:56:56 +0100351 mbedtls_platform_zeroize( tmp_secret, sizeof(tmp_secret) );
352 mbedtls_platform_zeroize( tmp_input, sizeof(tmp_input) );
Hanno Beckere9cccb42020-08-20 13:42:46 +0100353 return( ret );
354}
355
Xiaofei Bai746f9482021-11-12 08:53:56 +0000356int mbedtls_ssl_tls13_derive_early_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100357 mbedtls_md_type_t md_type,
358 unsigned char const *early_secret,
359 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000360 mbedtls_ssl_tls13_early_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100361{
362 int ret;
363 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
364 size_t const md_size = mbedtls_md_get_size( md_info );
365
366 /* We should never call this function with an unknown hash,
367 * but add an assertion anyway. */
368 if( md_info == 0 )
369 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
370
371 /*
372 * 0
373 * |
374 * v
375 * PSK -> HKDF-Extract = Early Secret
376 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100377 * +-----> Derive-Secret(., "c e traffic", ClientHello)
378 * | = client_early_traffic_secret
379 * |
380 * +-----> Derive-Secret(., "e exp master", ClientHello)
381 * | = early_exporter_master_secret
382 * v
383 */
384
385 /* Create client_early_traffic_secret */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000386 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100387 early_secret, md_size,
388 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_e_traffic ),
389 transcript, transcript_len,
390 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
391 derived->client_early_traffic_secret,
392 md_size );
393 if( ret != 0 )
394 return( ret );
395
396 /* Create early exporter */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000397 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100398 early_secret, md_size,
399 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( e_exp_master ),
400 transcript, transcript_len,
401 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
402 derived->early_exporter_master_secret,
403 md_size );
404 if( ret != 0 )
405 return( ret );
406
407 return( 0 );
408}
409
Xiaofei Bai746f9482021-11-12 08:53:56 +0000410int mbedtls_ssl_tls13_derive_handshake_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100411 mbedtls_md_type_t md_type,
412 unsigned char const *handshake_secret,
413 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000414 mbedtls_ssl_tls13_handshake_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100415{
416 int ret;
417 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
418 size_t const md_size = mbedtls_md_get_size( md_info );
419
420 /* We should never call this function with an unknown hash,
421 * but add an assertion anyway. */
422 if( md_info == 0 )
423 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
424
425 /*
426 *
427 * Handshake Secret
428 * |
429 * +-----> Derive-Secret( ., "c hs traffic",
430 * | ClientHello...ServerHello )
431 * | = client_handshake_traffic_secret
432 * |
433 * +-----> Derive-Secret( ., "s hs traffic",
434 * | ClientHello...ServerHello )
435 * | = server_handshake_traffic_secret
436 *
437 */
438
439 /*
440 * Compute client_handshake_traffic_secret with
441 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
442 */
443
Xiaofei Bai746f9482021-11-12 08:53:56 +0000444 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100445 handshake_secret, md_size,
446 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_hs_traffic ),
447 transcript, transcript_len,
448 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
449 derived->client_handshake_traffic_secret,
450 md_size );
451 if( ret != 0 )
452 return( ret );
453
454 /*
455 * Compute server_handshake_traffic_secret with
456 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
457 */
458
Xiaofei Bai746f9482021-11-12 08:53:56 +0000459 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100460 handshake_secret, md_size,
461 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_hs_traffic ),
462 transcript, transcript_len,
463 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
464 derived->server_handshake_traffic_secret,
465 md_size );
466 if( ret != 0 )
467 return( ret );
468
469 return( 0 );
470}
471
Xiaofei Bai746f9482021-11-12 08:53:56 +0000472int mbedtls_ssl_tls13_derive_application_secrets(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100473 mbedtls_md_type_t md_type,
474 unsigned char const *application_secret,
475 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000476 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100477{
478 int ret;
479 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
480 size_t const md_size = mbedtls_md_get_size( md_info );
481
482 /* We should never call this function with an unknown hash,
483 * but add an assertion anyway. */
484 if( md_info == 0 )
485 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
486
487 /* Generate {client,server}_application_traffic_secret_0
488 *
489 * Master Secret
490 * |
491 * +-----> Derive-Secret( ., "c ap traffic",
492 * | ClientHello...server Finished )
493 * | = client_application_traffic_secret_0
494 * |
495 * +-----> Derive-Secret( ., "s ap traffic",
496 * | ClientHello...Server Finished )
497 * | = server_application_traffic_secret_0
498 * |
499 * +-----> Derive-Secret( ., "exp master",
500 * | ClientHello...server Finished)
501 * | = exporter_master_secret
502 *
503 */
504
Xiaofei Bai746f9482021-11-12 08:53:56 +0000505 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100506 application_secret, md_size,
507 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( c_ap_traffic ),
508 transcript, transcript_len,
509 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
510 derived->client_application_traffic_secret_N,
511 md_size );
512 if( ret != 0 )
513 return( ret );
514
Xiaofei Bai746f9482021-11-12 08:53:56 +0000515 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100516 application_secret, md_size,
517 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( s_ap_traffic ),
518 transcript, transcript_len,
519 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
520 derived->server_application_traffic_secret_N,
521 md_size );
522 if( ret != 0 )
523 return( ret );
524
Xiaofei Bai746f9482021-11-12 08:53:56 +0000525 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100526 application_secret, md_size,
527 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( exp_master ),
528 transcript, transcript_len,
529 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
530 derived->exporter_master_secret,
531 md_size );
532 if( ret != 0 )
533 return( ret );
534
535 return( 0 );
536}
537
538/* Generate resumption_master_secret for use with the ticket exchange.
539 *
Xiaofei Bai746f9482021-11-12 08:53:56 +0000540 * This is not integrated with mbedtls_ssl_tls13_derive_application_secrets()
Hanno Beckeref5235b2021-05-24 06:39:41 +0100541 * because it uses the transcript hash up to and including ClientFinished. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000542int mbedtls_ssl_tls13_derive_resumption_master_secret(
Hanno Beckeref5235b2021-05-24 06:39:41 +0100543 mbedtls_md_type_t md_type,
544 unsigned char const *application_secret,
545 unsigned char const *transcript, size_t transcript_len,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000546 mbedtls_ssl_tls13_application_secrets *derived )
Hanno Beckeref5235b2021-05-24 06:39:41 +0100547{
548 int ret;
549 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
550 size_t const md_size = mbedtls_md_get_size( md_info );
551
552 /* We should never call this function with an unknown hash,
553 * but add an assertion anyway. */
554 if( md_info == 0 )
555 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
556
Xiaofei Bai746f9482021-11-12 08:53:56 +0000557 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckeref5235b2021-05-24 06:39:41 +0100558 application_secret, md_size,
559 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_master ),
560 transcript, transcript_len,
561 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
562 derived->resumption_master_secret,
563 md_size );
564
565 if( ret != 0 )
566 return( ret );
567
568 return( 0 );
569}
570
XiaokangQiana4c99f22021-11-11 06:46:35 +0000571int mbedtls_ssl_tls13_key_schedule_stage_application( mbedtls_ssl_context *ssl )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000572{
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +0000574 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
575 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000576#if defined(MBEDTLS_DEBUG_C)
577 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
578 size_t const md_size = mbedtls_md_get_size( md_info );
579#endif /* MBEDTLS_DEBUG_C */
580
581 /*
582 * Compute MasterSecret
583 */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000584 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000585 handshake->tls13_master_secrets.handshake,
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000586 NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000587 handshake->tls13_master_secrets.app );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000588 if( ret != 0 )
589 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000590 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000591 return( ret );
592 }
593
594 MBEDTLS_SSL_DEBUG_BUF( 4, "Master secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +0000595 handshake->tls13_master_secrets.app, md_size );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000596
597 return( 0 );
598}
599
Xiaofei Bai746f9482021-11-12 08:53:56 +0000600static int ssl_tls13_calc_finished_core( mbedtls_md_type_t md_type,
601 unsigned char const *base_key,
602 unsigned char const *transcript,
603 unsigned char *dst )
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100604{
605 const mbedtls_md_info_t* const md_info = mbedtls_md_info_from_type( md_type );
606 size_t const md_size = mbedtls_md_get_size( md_info );
607 unsigned char finished_key[MBEDTLS_MD_MAX_SIZE];
608 int ret;
609
610 /* We should never call this function with an unknown hash,
611 * but add an assertion anyway. */
612 if( md_info == 0 )
613 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
614
615 /* TLS 1.3 Finished message
616 *
617 * struct {
618 * opaque verify_data[Hash.length];
619 * } Finished;
620 *
621 * verify_data =
622 * HMAC( finished_key,
623 * Hash( Handshake Context +
624 * Certificate* +
625 * CertificateVerify* )
626 * )
627 *
628 * finished_key =
629 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
630 */
631
Xiaofei Bai746f9482021-11-12 08:53:56 +0000632 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100633 md_type, base_key, md_size,
634 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( finished ),
635 NULL, 0,
636 finished_key, md_size );
637 if( ret != 0 )
638 goto exit;
639
640 ret = mbedtls_md_hmac( md_info, finished_key, md_size, transcript, md_size, dst );
641 if( ret != 0 )
642 goto exit;
643
644exit:
645
646 mbedtls_platform_zeroize( finished_key, sizeof( finished_key ) );
647 return( ret );
648}
649
XiaokangQianc5c39d52021-11-09 11:55:10 +0000650int mbedtls_ssl_tls13_calculate_verify_data( mbedtls_ssl_context* ssl,
XiaokangQianaaa0e192021-11-10 03:07:04 +0000651 unsigned char* dst,
652 size_t dst_len,
653 size_t *actual_len,
654 int from )
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000655{
XiaokangQiana7634982021-10-22 06:32:32 +0000656 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000657
XiaokangQianaaa0e192021-11-10 03:07:04 +0000658 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000659 size_t transcript_len;
660
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800661 unsigned char *base_key = NULL;
Jerry Yub737f6a2021-12-10 17:55:23 +0800662 size_t base_key_len = 0;
Jerry Yu9c074732021-12-10 17:12:43 +0800663 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets =
664 &ssl->handshake->tls13_hs_secrets;
Jerry Yua5563f62021-12-10 18:14:36 +0800665
666 mbedtls_md_type_t const md_type = ssl->handshake->ciphersuite_info->mac;
667 const mbedtls_md_info_t* const md_info =
668 mbedtls_md_info_from_type( md_type );
669 size_t const md_size = mbedtls_md_get_size( md_info );
670
671 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_calculate_verify_data" ) );
672
Jerry Yub737f6a2021-12-10 17:55:23 +0800673 if( from == MBEDTLS_SSL_IS_CLIENT )
674 {
675 base_key = tls13_hs_secrets->client_handshake_traffic_secret;
676 base_key_len = sizeof( tls13_hs_secrets->client_handshake_traffic_secret );
677 }
678 else
679 {
680 base_key = tls13_hs_secrets->server_handshake_traffic_secret;
681 base_key_len = sizeof( tls13_hs_secrets->server_handshake_traffic_secret );
682 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000683
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000684 if( dst_len < md_size )
Jerry Yu9c074732021-12-10 17:12:43 +0800685 {
686 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
687 goto exit;
688 }
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000689
690 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
691 transcript, sizeof( transcript ),
692 &transcript_len );
693 if( ret != 0 )
694 {
695 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_handshake_transcript", ret );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000696 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000697 }
698 MBEDTLS_SSL_DEBUG_BUF( 4, "handshake hash", transcript, transcript_len );
699
Xiaofei Bai746f9482021-11-12 08:53:56 +0000700 ret = ssl_tls13_calc_finished_core( md_type, base_key, transcript, dst );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000701 if( ret != 0 )
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000702 goto exit;
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000703 *actual_len = md_size;
704
705 MBEDTLS_SSL_DEBUG_BUF( 3, "verify_data for finished message", dst, md_size );
XiaokangQianc5c39d52021-11-09 11:55:10 +0000706 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_calculate_verify_data" ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000707
708exit:
Jerry Yu4a2fa5d2021-12-10 10:19:34 +0800709 /* Erase handshake secrets */
Jerry Yub737f6a2021-12-10 17:55:23 +0800710 mbedtls_platform_zeroize( base_key, base_key_len );
XiaokangQian33062842021-11-11 03:37:45 +0000711 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian61bdbbc2021-10-28 08:03:38 +0000712 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000713}
714
Xiaofei Bai746f9482021-11-12 08:53:56 +0000715int mbedtls_ssl_tls13_create_psk_binder( mbedtls_ssl_context *ssl,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100716 const mbedtls_md_type_t md_type,
717 unsigned char const *psk, size_t psk_len,
718 int psk_type,
719 unsigned char const *transcript,
720 unsigned char *result )
721{
722 int ret = 0;
723 unsigned char binder_key[MBEDTLS_MD_MAX_SIZE];
724 unsigned char early_secret[MBEDTLS_MD_MAX_SIZE];
725 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type( md_type );
726 size_t const md_size = mbedtls_md_get_size( md_info );
727
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100728#if !defined(MBEDTLS_DEBUG_C)
729 ssl = NULL; /* make sure we don't use it except for debug */
730 ((void) ssl);
731#endif
732
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100733 /* We should never call this function with an unknown hash,
734 * but add an assertion anyway. */
735 if( md_info == 0 )
736 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
737
738 /*
739 * 0
740 * |
741 * v
742 * PSK -> HKDF-Extract = Early Secret
743 * |
744 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
745 * | = binder_key
746 * v
747 */
748
Xiaofei Bai746f9482021-11-12 08:53:56 +0000749 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
750 NULL, /* Old secret */
751 psk, psk_len, /* Input */
752 early_secret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100753 if( ret != 0 )
754 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000755 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100756 goto exit;
757 }
758
759 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
760 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000761 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100762 early_secret, md_size,
763 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( res_binder ),
764 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
765 binder_key, md_size );
766 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'res binder'" ) );
767 }
768 else
769 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000770 ret = mbedtls_ssl_tls13_derive_secret( md_type,
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100771 early_secret, md_size,
772 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( ext_binder ),
773 NULL, 0, MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED,
774 binder_key, md_size );
775 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Derive Early Secret with 'ext binder'" ) );
776 }
777
778 if( ret != 0 )
779 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000780 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_secret", ret );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100781 goto exit;
782 }
783
784 /*
785 * The binding_value is computed in the same way as the Finished message
786 * but with the BaseKey being the binder_key.
787 */
788
Xiaofei Bai746f9482021-11-12 08:53:56 +0000789 ret = ssl_tls13_calc_finished_core( md_type, binder_key, transcript, result );
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100790 if( ret != 0 )
791 goto exit;
792
793 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder", result, md_size );
794
795exit:
796
797 mbedtls_platform_zeroize( early_secret, sizeof( early_secret ) );
798 mbedtls_platform_zeroize( binder_key, sizeof( binder_key ) );
799 return( ret );
800}
801
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100802static int psa_status_to_mbedtls( psa_status_t status )
803{
804 switch( status )
805 {
806 case PSA_SUCCESS:
807 return( 0 );
808 case PSA_ERROR_INSUFFICIENT_MEMORY:
809 return( MBEDTLS_ERR_CIPHER_ALLOC_FAILED );
810 case PSA_ERROR_NOT_SUPPORTED:
811 return( MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE );
812 default:
813 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
814 }
815}
816
Hanno Beckerc94060c2021-03-22 07:50:44 +0000817int mbedtls_ssl_tls13_populate_transform( mbedtls_ssl_transform *transform,
818 int endpoint,
819 int ciphersuite,
820 mbedtls_ssl_key_set const *traffic_keys,
821 mbedtls_ssl_context *ssl /* DEBUG ONLY */ )
822{
823 int ret;
824 mbedtls_cipher_info_t const *cipher_info;
825 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
826 unsigned char const *key_enc;
827 unsigned char const *iv_enc;
828 unsigned char const *key_dec;
829 unsigned char const *iv_dec;
830
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100831#if defined(MBEDTLS_USE_PSA_CRYPTO)
832 psa_key_type_t key_type;
833 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
834 psa_algorithm_t alg;
835 size_t key_bits;
836 psa_status_t status = PSA_SUCCESS;
837#endif
838
Hanno Beckerc94060c2021-03-22 07:50:44 +0000839#if !defined(MBEDTLS_DEBUG_C)
840 ssl = NULL; /* make sure we don't use it except for those cases */
841 (void) ssl;
842#endif
843
844 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Hanno Becker7887a772021-04-20 05:27:57 +0100845 if( ciphersuite_info == NULL )
846 {
847 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
848 ciphersuite ) );
849 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
850 }
Hanno Beckerc94060c2021-03-22 07:50:44 +0000851
852 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
853 if( cipher_info == NULL )
854 {
Hanno Becker7887a772021-04-20 05:27:57 +0100855 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
856 ciphersuite_info->cipher ) );
Hanno Beckerf62a7302021-04-21 05:21:28 +0100857 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Beckerc94060c2021-03-22 07:50:44 +0000858 }
859
860 /*
861 * Setup cipher contexts in target transform
862 */
863
864 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
865 cipher_info ) ) != 0 )
866 {
867 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
868 return( ret );
869 }
870
871 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
872 cipher_info ) ) != 0 )
873 {
874 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
875 return( ret );
876 }
877
878#if defined(MBEDTLS_SSL_SRV_C)
879 if( endpoint == MBEDTLS_SSL_IS_SERVER )
880 {
881 key_enc = traffic_keys->server_write_key;
882 key_dec = traffic_keys->client_write_key;
883 iv_enc = traffic_keys->server_write_iv;
884 iv_dec = traffic_keys->client_write_iv;
885 }
886 else
887#endif /* MBEDTLS_SSL_SRV_C */
888#if defined(MBEDTLS_SSL_CLI_C)
889 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
890 {
891 key_enc = traffic_keys->client_write_key;
892 key_dec = traffic_keys->server_write_key;
893 iv_enc = traffic_keys->client_write_iv;
894 iv_dec = traffic_keys->server_write_iv;
895 }
896 else
897#endif /* MBEDTLS_SSL_CLI_C */
898 {
899 /* should not happen */
900 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
901 }
902
903 memcpy( transform->iv_enc, iv_enc, traffic_keys->iv_len );
904 memcpy( transform->iv_dec, iv_dec, traffic_keys->iv_len );
905
906 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc,
907 key_enc, cipher_info->key_bitlen,
908 MBEDTLS_ENCRYPT ) ) != 0 )
909 {
910 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
911 return( ret );
912 }
913
914 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec,
915 key_dec, cipher_info->key_bitlen,
916 MBEDTLS_DECRYPT ) ) != 0 )
917 {
918 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
919 return( ret );
920 }
921
Przemyslaw Stekielae77b0a2022-01-12 10:29:03 +0100922#if defined(MBEDTLS_USE_PSA_CRYPTO)
923 if( ( status = mbedtls_cipher_to_psa( cipher_info->type,
924 transform->taglen,
925 &alg,
926 &key_type,
927 &key_bits ) ) != PSA_SUCCESS )
928 {
929 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_to_psa", status );
930 return( psa_status_to_mbedtls( status ) );
931 }
932
933 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT );
934 psa_set_key_algorithm( &attributes, alg );
935
936 transform->psa_alg = alg;
937
938 if( ( status = psa_import_key( &attributes,
939 key_enc,
940 KEY_BYTES( key_bits ),
941 &transform->psa_key_enc ) ) != PSA_SUCCESS )
942 {
943 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", status );
944 return( psa_status_to_mbedtls( status ) );
945 }
946 if( ( status = psa_import_key( &attributes,
947 key_dec,
948 KEY_BYTES( key_bits ),
949 &transform->psa_key_dec ) ) != PSA_SUCCESS )
950 {
951 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", status );
952 return( psa_status_to_mbedtls( status ) );
953 }
954#endif /* MBEDTLS_USE_PSA_CRYPTO */
955
Hanno Beckerc94060c2021-03-22 07:50:44 +0000956 /*
957 * Setup other fields in SSL transform
958 */
959
960 if( ( ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ) != 0 )
961 transform->taglen = 8;
962 else
963 transform->taglen = 16;
964
965 transform->ivlen = traffic_keys->iv_len;
966 transform->maclen = 0;
967 transform->fixed_ivlen = transform->ivlen;
Hanno Beckerc94060c2021-03-22 07:50:44 +0000968 transform->minor_ver = MBEDTLS_SSL_MINOR_VERSION_4;
969
Hanno Beckeredd5bf02021-04-20 05:32:16 +0100970 /* We add the true record content type (1 Byte) to the plaintext and
971 * then pad to the configured granularity. The mimimum length of the
972 * type-extended and padded plaintext is therefore the padding
973 * granularity. */
974 transform->minlen =
Hanno Beckerdfba0652021-08-01 19:16:57 +0100975 transform->taglen + MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY;
Hanno Beckeredd5bf02021-04-20 05:32:16 +0100976
Hanno Beckerc94060c2021-03-22 07:50:44 +0000977 return( 0 );
978}
979
Xiaofei Bai746f9482021-11-12 08:53:56 +0000980int mbedtls_ssl_tls13_key_schedule_stage_early( mbedtls_ssl_context *ssl )
Jerry Yu89ea3212021-09-09 14:31:24 +0800981{
Jerry Yue3131ef2021-09-16 13:14:15 +0800982 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
983 mbedtls_md_type_t md_type;
Jerry Yu5ccfcd42021-10-11 16:39:29 +0800984 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu6ca7c7f2021-09-28 18:51:40 +0800985
Jerry Yu5ccfcd42021-10-11 16:39:29 +0800986 if( handshake->ciphersuite_info == NULL )
Jerry Yu89ea3212021-09-09 14:31:24 +0800987 {
988 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher suite info not found" ) );
989 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
990 }
Jerry Yue3131ef2021-09-16 13:14:15 +0800991
Jerry Yu5ccfcd42021-10-11 16:39:29 +0800992 md_type = handshake->ciphersuite_info->mac;
Jerry Yue06f4532021-09-23 18:35:07 +0800993
Xiaofei Bai746f9482021-11-12 08:53:56 +0000994 ret = mbedtls_ssl_tls13_evolve_secret( md_type, NULL, NULL, 0,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000995 handshake->tls13_master_secrets.early );
Jerry Yu89ea3212021-09-09 14:31:24 +0800996 if( ret != 0 )
997 {
Xiaofei Bai746f9482021-11-12 08:53:56 +0000998 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yu89ea3212021-09-09 14:31:24 +0800999 return( ret );
1000 }
1001
1002 return( 0 );
1003}
1004
Jerry Yuc068b662021-10-11 22:30:19 +08001005/* mbedtls_ssl_tls13_generate_handshake_keys() generates keys necessary for
Jerry Yu61e35e02021-09-16 18:59:08 +08001006 * protecting the handshake messages, as described in Section 7 of TLS 1.3. */
Jerry Yuc068b662021-10-11 22:30:19 +08001007int mbedtls_ssl_tls13_generate_handshake_keys( mbedtls_ssl_context *ssl,
1008 mbedtls_ssl_key_set *traffic_keys )
Jerry Yu61e35e02021-09-16 18:59:08 +08001009{
1010 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1011
1012 mbedtls_md_type_t md_type;
1013 mbedtls_md_info_t const *md_info;
1014 size_t md_size;
1015
Jerry Yu435208a2021-10-13 11:22:16 +08001016 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu61e35e02021-09-16 18:59:08 +08001017 size_t transcript_len;
1018
1019 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001020 size_t key_len, iv_len;
Jerry Yu61e35e02021-09-16 18:59:08 +08001021
Jerry Yu435208a2021-10-13 11:22:16 +08001022 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1023 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = handshake->ciphersuite_info;
Xiaofei Bai746f9482021-11-12 08:53:56 +00001024 mbedtls_ssl_tls13_handshake_secrets *tls13_hs_secrets = &handshake->tls13_hs_secrets;
Jerry Yu435208a2021-10-13 11:22:16 +08001025
Jerry Yuc068b662021-10-11 22:30:19 +08001026 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001027
Jerry Yu435208a2021-10-13 11:22:16 +08001028 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001029 key_len = cipher_info->key_bitlen >> 3;
1030 iv_len = cipher_info->iv_size;
Jerry Yu61e35e02021-09-16 18:59:08 +08001031
Jerry Yu435208a2021-10-13 11:22:16 +08001032 md_type = ciphersuite_info->mac;
Jerry Yu61e35e02021-09-16 18:59:08 +08001033 md_info = mbedtls_md_info_from_type( md_type );
1034 md_size = mbedtls_md_get_size( md_info );
1035
1036 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1037 transcript,
1038 sizeof( transcript ),
1039 &transcript_len );
1040 if( ret != 0 )
1041 {
1042 MBEDTLS_SSL_DEBUG_RET( 1,
1043 "mbedtls_ssl_get_handshake_transcript",
1044 ret );
1045 return( ret );
1046 }
1047
Xiaofei Bai746f9482021-11-12 08:53:56 +00001048 ret = mbedtls_ssl_tls13_derive_handshake_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001049 handshake->tls13_master_secrets.handshake,
Jerry Yu435208a2021-10-13 11:22:16 +08001050 transcript, transcript_len, tls13_hs_secrets );
Jerry Yu61e35e02021-09-16 18:59:08 +08001051 if( ret != 0 )
1052 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001053 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_derive_handshake_secrets",
Jerry Yu61e35e02021-09-16 18:59:08 +08001054 ret );
1055 return( ret );
1056 }
1057
1058 MBEDTLS_SSL_DEBUG_BUF( 4, "Client handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001059 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001060 md_size );
Jerry Yu61e35e02021-09-16 18:59:08 +08001061 MBEDTLS_SSL_DEBUG_BUF( 4, "Server handshake traffic secret",
Jerry Yu435208a2021-10-13 11:22:16 +08001062 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001063 md_size );
1064
1065 /*
1066 * Export client handshake traffic secret
1067 */
Jerry Yu61e35e02021-09-16 18:59:08 +08001068 if( ssl->f_export_keys != NULL )
1069 {
1070 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001071 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001072 tls13_hs_secrets->client_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001073 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001074 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001075 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001076 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1077
1078 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001079 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
Jerry Yu435208a2021-10-13 11:22:16 +08001080 tls13_hs_secrets->server_handshake_traffic_secret,
Jerry Yu61e35e02021-09-16 18:59:08 +08001081 md_size,
Jerry Yu435208a2021-10-13 11:22:16 +08001082 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001083 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
Jerry Yu61e35e02021-09-16 18:59:08 +08001084 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: FIX! */ );
1085 }
Jerry Yu61e35e02021-09-16 18:59:08 +08001086
Xiaofei Bai746f9482021-11-12 08:53:56 +00001087 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
Jerry Yu435208a2021-10-13 11:22:16 +08001088 tls13_hs_secrets->client_handshake_traffic_secret,
1089 tls13_hs_secrets->server_handshake_traffic_secret,
Xiaofei Baib7972842021-11-18 07:29:56 +00001090 md_size, key_len, iv_len, traffic_keys );
Jerry Yu61e35e02021-09-16 18:59:08 +08001091 if( ret != 0 )
1092 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001093 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
Jerry Yu61e35e02021-09-16 18:59:08 +08001094 goto exit;
1095 }
1096
1097 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_key",
1098 traffic_keys->client_write_key,
1099 traffic_keys->key_len);
1100
1101 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_key",
1102 traffic_keys->server_write_key,
1103 traffic_keys->key_len);
1104
1105 MBEDTLS_SSL_DEBUG_BUF( 4, "client_handshake write_iv",
1106 traffic_keys->client_write_iv,
1107 traffic_keys->iv_len);
1108
1109 MBEDTLS_SSL_DEBUG_BUF( 4, "server_handshake write_iv",
1110 traffic_keys->server_write_iv,
1111 traffic_keys->iv_len);
1112
Jerry Yuc068b662021-10-11 22:30:19 +08001113 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_tls13_generate_handshake_keys" ) );
Jerry Yu61e35e02021-09-16 18:59:08 +08001114
1115exit:
1116
1117 return( ret );
1118}
1119
Jerry Yuf0ac2352021-10-11 17:47:07 +08001120int mbedtls_ssl_tls13_key_schedule_stage_handshake( mbedtls_ssl_context *ssl )
Jerry Yua0650eb2021-09-09 17:14:45 +08001121{
Jerry Yuf0ac2352021-10-11 17:47:07 +08001122 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5ccfcd42021-10-11 16:39:29 +08001123 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1124 mbedtls_md_type_t const md_type = handshake->ciphersuite_info->mac;
Jerry Yuf0ac2352021-10-11 17:47:07 +08001125 size_t ephemeral_len = 0;
1126 unsigned char ecdhe[MBEDTLS_ECP_MAX_BYTES];
Jerry Yua0650eb2021-09-09 17:14:45 +08001127#if defined(MBEDTLS_DEBUG_C)
1128 mbedtls_md_info_t const * const md_info = mbedtls_md_info_from_type( md_type );
1129 size_t const md_size = mbedtls_md_get_size( md_info );
1130#endif /* MBEDTLS_DEBUG_C */
1131
Jerry Yuf0ac2352021-10-11 17:47:07 +08001132#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1133 /*
1134 * Compute ECDHE secret used to compute the handshake secret from which
1135 * client_handshake_traffic_secret and server_handshake_traffic_secret
1136 * are derived in the handshake secret derivation stage.
1137 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001138 if( mbedtls_ssl_tls13_ephemeral_enabled( ssl ) )
Jerry Yuf0ac2352021-10-11 17:47:07 +08001139 {
1140 if( mbedtls_ssl_tls13_named_group_is_ecdhe( handshake->offered_group_id ) )
1141 {
1142#if defined(MBEDTLS_ECDH_C)
1143 ret = mbedtls_ecdh_calc_secret( &handshake->ecdh_ctx,
1144 &ephemeral_len, ecdhe, sizeof( ecdhe ),
1145 ssl->conf->f_rng,
1146 ssl->conf->p_rng );
1147 if( ret != 0 )
1148 {
1149 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
1150 return( ret );
1151 }
1152#endif /* MBEDTLS_ECDH_C */
1153 }
1154 else if( mbedtls_ssl_tls13_named_group_is_dhe( handshake->offered_group_id ) )
1155 {
Jerry Yuf0ac2352021-10-11 17:47:07 +08001156 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DHE not supported." ) );
1157 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1158 }
1159 }
1160#else
1161 return( MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE );
1162#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
Jerry Yua0650eb2021-09-09 17:14:45 +08001163
1164 /*
Jerry Yuf0ac2352021-10-11 17:47:07 +08001165 * Compute the Handshake Secret
Jerry Yua0650eb2021-09-09 17:14:45 +08001166 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001167 ret = mbedtls_ssl_tls13_evolve_secret( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001168 handshake->tls13_master_secrets.early,
Xiaofei Baib7972842021-11-18 07:29:56 +00001169 ecdhe, ephemeral_len,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001170 handshake->tls13_master_secrets.handshake );
Jerry Yua0650eb2021-09-09 17:14:45 +08001171 if( ret != 0 )
1172 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001173 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_evolve_secret", ret );
Jerry Yua0650eb2021-09-09 17:14:45 +08001174 return( ret );
1175 }
1176
1177 MBEDTLS_SSL_DEBUG_BUF( 4, "Handshake secret",
Xiaofei Baid25fab62021-12-02 06:36:27 +00001178 handshake->tls13_master_secrets.handshake, md_size );
Jerry Yua0650eb2021-09-09 17:14:45 +08001179
1180#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED)
1181 mbedtls_platform_zeroize( ecdhe, sizeof( ecdhe ) );
1182#endif /* MBEDTLS_KEY_EXCHANGE_SOME_ECDHE_ENABLED */
1183 return( 0 );
1184}
1185
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001186/* Generate application traffic keys since any records following a 1-RTT Finished message
1187 * MUST be encrypted under the application traffic key.
1188 */
XiaokangQiand0aa3e92021-11-10 06:17:40 +00001189int mbedtls_ssl_tls13_generate_application_keys(
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001190 mbedtls_ssl_context *ssl,
1191 mbedtls_ssl_key_set *traffic_keys )
1192{
XiaokangQiana7634982021-10-22 06:32:32 +00001193 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian33062842021-11-11 03:37:45 +00001194 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001195
1196 /* Address at which to store the application secrets */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001197 mbedtls_ssl_tls13_application_secrets * const app_secrets =
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001198 &ssl->session_negotiate->app_secrets;
1199
1200 /* Holding the transcript up to and including the ServerFinished */
XiaokangQian33062842021-11-11 03:37:45 +00001201 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001202 size_t transcript_len;
1203
1204 /* Variables relating to the hash for the chosen ciphersuite. */
1205 mbedtls_md_type_t md_type;
1206 mbedtls_md_info_t const *md_info;
1207 size_t md_size;
1208
1209 /* Variables relating to the cipher for the chosen ciphersuite. */
1210 mbedtls_cipher_info_t const *cipher_info;
Xiaofei Baib7972842021-11-18 07:29:56 +00001211 size_t key_len, iv_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001212
1213 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive application traffic keys" ) );
1214
1215 /* Extract basic information about hash and ciphersuite */
1216
1217 cipher_info = mbedtls_cipher_info_from_type(
XiaokangQian33062842021-11-11 03:37:45 +00001218 handshake->ciphersuite_info->cipher );
Xiaofei Baib7972842021-11-18 07:29:56 +00001219 key_len = cipher_info->key_bitlen / 8;
1220 iv_len = cipher_info->iv_size;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001221
XiaokangQian33062842021-11-11 03:37:45 +00001222 md_type = handshake->ciphersuite_info->mac;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001223 md_info = mbedtls_md_info_from_type( md_type );
1224 md_size = mbedtls_md_get_size( md_info );
1225
1226 /* Compute current handshake transcript. It's the caller's responsiblity
1227 * to call this at the right time, that is, after the ServerFinished. */
1228
1229 ret = mbedtls_ssl_get_handshake_transcript( ssl, md_type,
1230 transcript, sizeof( transcript ),
1231 &transcript_len );
1232 if( ret != 0 )
XiaokangQian4cab0242021-10-12 08:43:37 +00001233 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001234
1235 /* Compute application secrets from master secret and transcript hash. */
1236
Xiaofei Bai746f9482021-11-12 08:53:56 +00001237 ret = mbedtls_ssl_tls13_derive_application_secrets( md_type,
Xiaofei Baid25fab62021-12-02 06:36:27 +00001238 handshake->tls13_master_secrets.app,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001239 transcript, transcript_len,
1240 app_secrets );
Jerry Yu4a2fa5d2021-12-10 10:19:34 +08001241 /* Erase master secrets */
Jerry Yu23ab7a42021-12-08 14:34:10 +08001242 mbedtls_platform_zeroize( &ssl->handshake->tls13_master_secrets,
Jerry Yu27224f52021-12-09 10:56:50 +08001243 sizeof( ssl->handshake->tls13_master_secrets ) );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001244 if( ret != 0 )
1245 {
1246 MBEDTLS_SSL_DEBUG_RET( 1,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001247 "mbedtls_ssl_tls13_derive_application_secrets", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001248 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001249 }
1250
1251 /* Derive first epoch of IV + Key for application traffic. */
1252
Xiaofei Bai746f9482021-11-12 08:53:56 +00001253 ret = mbedtls_ssl_tls13_make_traffic_keys( md_type,
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001254 app_secrets->client_application_traffic_secret_N,
1255 app_secrets->server_application_traffic_secret_N,
Xiaofei Baib7972842021-11-18 07:29:56 +00001256 md_size, key_len, iv_len, traffic_keys );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001257 if( ret != 0 )
1258 {
Xiaofei Bai746f9482021-11-12 08:53:56 +00001259 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_make_traffic_keys", ret );
XiaokangQian4cab0242021-10-12 08:43:37 +00001260 goto cleanup;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001261 }
1262
1263 MBEDTLS_SSL_DEBUG_BUF( 4, "Client application traffic secret",
1264 app_secrets->client_application_traffic_secret_N,
1265 md_size );
1266
1267 MBEDTLS_SSL_DEBUG_BUF( 4, "Server application traffic secret",
1268 app_secrets->server_application_traffic_secret_N,
1269 md_size );
1270
XiaokangQianac0385c2021-11-03 06:40:11 +00001271 /*
1272 * Export client/server application traffic secret 0
1273 */
1274 if( ssl->f_export_keys != NULL )
1275 {
1276 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001277 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001278 app_secrets->client_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001279 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001280 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001281 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1282 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001283
1284 ssl->f_export_keys( ssl->p_export_keys,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001285 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
XiaokangQianac0385c2021-11-03 06:40:11 +00001286 app_secrets->server_application_traffic_secret_N, md_size,
XiaokangQian33062842021-11-11 03:37:45 +00001287 handshake->randbytes,
lhuang04a3890a32022-01-04 09:47:20 -08001288 handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
XiaokangQianb51f8842021-11-04 03:02:47 +00001289 MBEDTLS_SSL_TLS_PRF_NONE /* TODO: this should be replaced by
1290 a new constant for TLS 1.3! */ );
XiaokangQianac0385c2021-11-03 06:40:11 +00001291 }
1292
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001293 MBEDTLS_SSL_DEBUG_BUF( 4, "client application_write_key:",
Xiaofei Baib7972842021-11-18 07:29:56 +00001294 traffic_keys->client_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001295 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write key",
Xiaofei Baib7972842021-11-18 07:29:56 +00001296 traffic_keys->server_write_key, key_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001297 MBEDTLS_SSL_DEBUG_BUF( 4, "client application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001298 traffic_keys->client_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001299 MBEDTLS_SSL_DEBUG_BUF( 4, "server application write IV",
Xiaofei Baib7972842021-11-18 07:29:56 +00001300 traffic_keys->server_write_iv, iv_len );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001301
1302 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive application traffic keys" ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001303
1304 cleanup:
Jerry Yu2c70a392021-12-08 13:28:49 +08001305 /* randbytes is not used again */
1306 mbedtls_platform_zeroize( ssl->handshake->randbytes,
1307 sizeof( ssl->handshake->randbytes ) );
XiaokangQian33062842021-11-11 03:37:45 +00001308 mbedtls_platform_zeroize( transcript, sizeof( transcript ) );
XiaokangQian4cab0242021-10-12 08:43:37 +00001309 return( ret );
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001310}
1311
Ronald Cron6f135e12021-12-08 16:57:54 +01001312#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */