blob: c5af6da801ffcd77ce2397077eed2eb9dbd49c9e [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
22#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
23
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +020024# include "mbedtls/hkdf.h"
25# include "ssl_misc.h"
26# include "ssl_tls13_keys.h"
27# include "mbedtls/debug.h"
Hanno Beckerbe9d6642020-08-21 13:20:06 +010028
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +020029# include <stdint.h>
30# include <string.h>
Hanno Beckerbe9d6642020-08-21 13:20:06 +010031
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +020032# define MBEDTLS_SSL_TLS1_3_LABEL(name, string) .name = string,
Hanno Beckere4435ea2020-09-08 10:43:52 +010033
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +020034struct mbedtls_ssl_tls1_3_labels_struct const mbedtls_ssl_tls1_3_labels = {
Hanno Beckerbe9d6642020-08-21 13:20:06 +010035 /* This seems to work in C, despite the string literal being one
36 * character too long due to the 0-termination. */
Hanno Beckere4435ea2020-09-08 10:43:52 +010037 MBEDTLS_SSL_TLS1_3_LABEL_LIST
Hanno Beckerbe9d6642020-08-21 13:20:06 +010038};
39
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +020040# undef MBEDTLS_SSL_TLS1_3_LABEL
Hanno Beckere4435ea2020-09-08 10:43:52 +010041
Hanno Beckerbe9d6642020-08-21 13:20:06 +010042/*
43 * This function creates a HkdfLabel structure used in the TLS 1.3 key schedule.
44 *
45 * The HkdfLabel is specified in RFC 8446 as follows:
46 *
47 * struct HkdfLabel {
48 * uint16 length; // Length of expanded key material
49 * opaque label<7..255>; // Always prefixed by "tls13 "
50 * opaque context<0..255>; // Usually a communication transcript hash
51 * };
52 *
53 * Parameters:
54 * - desired_length: Length of expanded key material
55 * Even though the standard allows expansion to up to
56 * 2**16 Bytes, TLS 1.3 never uses expansion to more than
57 * 255 Bytes, so we require `desired_length` to be at most
58 * 255. This allows us to save a few Bytes of code by
59 * hardcoding the writing of the high bytes.
60 * - (label, llen): label + label length, without "tls13 " prefix
Hanno Becker61baae72020-09-16 09:24:14 +010061 * The label length MUST be less than or equal to
62 * MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN
63 * It is the caller's responsibility to ensure this.
Hanno Becker815869a2020-09-08 11:16:16 +010064 * All (label, label length) pairs used in TLS 1.3
65 * can be obtained via MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN().
Hanno Beckerbe9d6642020-08-21 13:20:06 +010066 * - (ctx, clen): context + context length
Hanno Becker61baae72020-09-16 09:24:14 +010067 * The context length MUST be less than or equal to
68 * MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN
69 * It is the caller's responsibility to ensure this.
Hanno Beckerbe9d6642020-08-21 13:20:06 +010070 * - dst: Target buffer for HkdfLabel structure,
71 * This MUST be a writable buffer of size
72 * at least SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN Bytes.
73 * - dlen: Pointer at which to store the actual length of
74 * the HkdfLabel structure on success.
75 */
76
Hanno Becker2dfe1322020-09-10 09:23:12 +010077static const char tls1_3_label_prefix[6] = "tls13 ";
78
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +020079# define SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN(label_len, context_len) \
80 (2 /* expansion length */ \
81 + 1 /* label length */ \
82 + label_len + 1 /* context length */ \
83 + context_len)
Hanno Becker9cb0a142020-09-08 10:48:14 +010084
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +020085# define SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN \
86 SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN( \
87 sizeof(tls1_3_label_prefix) + \
88 MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN, \
89 MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN)
Hanno Beckerbe9d6642020-08-21 13:20:06 +010090
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +020091static void ssl_tls1_3_hkdf_encode_label(size_t desired_length,
92 const unsigned char *label,
93 size_t llen,
94 const unsigned char *ctx,
95 size_t clen,
96 unsigned char *dst,
97 size_t *dlen)
Hanno Beckerbe9d6642020-08-21 13:20:06 +010098{
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +020099 size_t total_label_len = sizeof(tls1_3_label_prefix) + llen;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100100 size_t total_hkdf_lbl_len =
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200101 SSL_TLS1_3_KEY_SCHEDULE_HKDF_LABEL_LEN(total_label_len, clen);
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100102
103 unsigned char *p = dst;
104
Hanno Becker531fe302020-09-16 09:45:27 +0100105 /* Add the size of the expanded key material.
106 * We're hardcoding the high byte to 0 here assuming that we never use
107 * TLS 1.3 HKDF key expansion to more than 255 Bytes. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200108# if MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN > 255
109# error \
110 "The implementation of ssl_tls1_3_hkdf_encode_label() is not fit for the \
Hanno Becker531fe302020-09-16 09:45:27 +0100111 value of MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN"
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200112# endif
Hanno Becker531fe302020-09-16 09:45:27 +0100113
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100114 *p++ = 0;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200115 *p++ = (unsigned char)((desired_length >> 0) & 0xFF);
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100116
117 /* Add label incl. prefix */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200118 *p++ = (unsigned char)(total_label_len & 0xFF);
119 memcpy(p, tls1_3_label_prefix, sizeof(tls1_3_label_prefix));
Hanno Becker2dfe1322020-09-10 09:23:12 +0100120 p += sizeof(tls1_3_label_prefix);
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200121 memcpy(p, label, llen);
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100122 p += llen;
123
124 /* Add context value */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200125 *p++ = (unsigned char)(clen & 0xFF);
126 if (clen != 0)
127 memcpy(p, ctx, clen);
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100128
129 /* Return total length to the caller. */
130 *dlen = total_hkdf_lbl_len;
131}
132
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200133int mbedtls_ssl_tls1_3_hkdf_expand_label(mbedtls_md_type_t hash_alg,
134 const unsigned char *secret,
135 size_t slen,
136 const unsigned char *label,
137 size_t llen,
138 const unsigned char *ctx,
139 size_t clen,
140 unsigned char *buf,
141 size_t blen)
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100142{
143 const mbedtls_md_info_t *md;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200144 unsigned char hkdf_label[SSL_TLS1_3_KEY_SCHEDULE_MAX_HKDF_LABEL_LEN];
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100145 size_t hkdf_label_len;
146
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200147 if (llen > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_LABEL_LEN) {
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100148 /* Should never happen since this is an internal
149 * function, and we know statically which labels
150 * are allowed. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200151 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100152 }
153
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200154 if (clen > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_CONTEXT_LEN) {
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100155 /* Should not happen, as above. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200156 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100157 }
158
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200159 if (blen > MBEDTLS_SSL_TLS1_3_KEY_SCHEDULE_MAX_EXPANSION_LEN) {
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100160 /* Should not happen, as above. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200161 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100162 }
163
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200164 md = mbedtls_md_info_from_type(hash_alg);
165 if (md == NULL)
166 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100167
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200168 ssl_tls1_3_hkdf_encode_label(blen, label, llen, ctx, clen, hkdf_label,
169 &hkdf_label_len);
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100170
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200171 return (mbedtls_hkdf_expand(md, secret, slen, hkdf_label, hkdf_label_len,
172 buf, blen));
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100173}
174
Hanno Becker3385a4d2020-08-21 13:03:34 +0100175/*
176 * The traffic keying material is generated from the following inputs:
177 *
178 * - One secret value per sender.
179 * - A purpose value indicating the specific value being generated
180 * - The desired lengths of key and IV.
181 *
182 * The expansion itself is based on HKDF:
183 *
184 * [sender]_write_key = HKDF-Expand-Label( Secret, "key", "", key_length )
185 * [sender]_write_iv = HKDF-Expand-Label( Secret, "iv" , "", iv_length )
186 *
187 * [sender] denotes the sending side and the Secret value is provided
188 * by the function caller. Note that we generate server and client side
189 * keys in a single function call.
190 */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200191int mbedtls_ssl_tls1_3_make_traffic_keys(mbedtls_md_type_t hash_alg,
192 const unsigned char *client_secret,
193 const unsigned char *server_secret,
194 size_t slen,
195 size_t key_len,
196 size_t iv_len,
197 mbedtls_ssl_key_set *keys)
Hanno Becker3385a4d2020-08-21 13:03:34 +0100198{
199 int ret = 0;
200
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200201 ret = mbedtls_ssl_tls1_3_hkdf_expand_label(
202 hash_alg, client_secret, slen, MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(key),
203 NULL, 0, keys->client_write_key, key_len);
204 if (ret != 0)
205 return ret;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100206
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200207 ret = mbedtls_ssl_tls1_3_hkdf_expand_label(
208 hash_alg, server_secret, slen, MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(key),
209 NULL, 0, keys->server_write_key, key_len);
210 if (ret != 0)
211 return ret;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100212
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200213 ret = mbedtls_ssl_tls1_3_hkdf_expand_label(
214 hash_alg, client_secret, slen, MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(iv),
215 NULL, 0, keys->client_write_iv, iv_len);
216 if (ret != 0)
217 return ret;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100218
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200219 ret = mbedtls_ssl_tls1_3_hkdf_expand_label(
220 hash_alg, server_secret, slen, MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(iv),
221 NULL, 0, keys->server_write_iv, iv_len);
222 if (ret != 0)
223 return ret;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100224
Hanno Becker493ea7f2020-09-08 11:01:00 +0100225 keys->key_len = key_len;
226 keys->iv_len = iv_len;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100227
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200228 return 0;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100229}
230
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200231int mbedtls_ssl_tls1_3_derive_secret(mbedtls_md_type_t hash_alg,
232 const unsigned char *secret,
233 size_t slen,
234 const unsigned char *label,
235 size_t llen,
236 const unsigned char *ctx,
237 size_t clen,
238 int ctx_hashed,
239 unsigned char *dstbuf,
240 size_t buflen)
Hanno Beckerb35d5222020-08-21 13:27:44 +0100241{
242 int ret;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200243 unsigned char hashed_context[MBEDTLS_MD_MAX_SIZE];
Hanno Beckerb35d5222020-08-21 13:27:44 +0100244
245 const mbedtls_md_info_t *md;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200246 md = mbedtls_md_info_from_type(hash_alg);
247 if (md == NULL)
248 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerb35d5222020-08-21 13:27:44 +0100249
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200250 if (ctx_hashed == MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED) {
251 ret = mbedtls_md(md, ctx, clen, hashed_context);
252 if (ret != 0)
253 return ret;
254 clen = mbedtls_md_get_size(md);
255 } else {
256 if (clen > sizeof(hashed_context)) {
Hanno Becker97a21562020-09-09 12:57:16 +0100257 /* This should never happen since this function is internal
Hanno Becker0c42fd92020-09-09 12:58:29 +0100258 * and the code sets `ctx_hashed` correctly.
Hanno Becker97a21562020-09-09 12:57:16 +0100259 * Let's double-check nonetheless to not run at the risk
260 * of getting a stack overflow. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200261 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker97a21562020-09-09 12:57:16 +0100262 }
Hanno Beckerb35d5222020-08-21 13:27:44 +0100263
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200264 memcpy(hashed_context, ctx, clen);
Hanno Beckerb35d5222020-08-21 13:27:44 +0100265 }
266
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200267 return (mbedtls_ssl_tls1_3_hkdf_expand_label(hash_alg, secret, slen, label,
268 llen, hashed_context, clen,
269 dstbuf, buflen));
Hanno Beckerb35d5222020-08-21 13:27:44 +0100270}
271
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200272int mbedtls_ssl_tls1_3_evolve_secret(mbedtls_md_type_t hash_alg,
273 const unsigned char *secret_old,
274 const unsigned char *input,
275 size_t input_len,
276 unsigned char *secret_new)
Hanno Beckere9cccb42020-08-20 13:42:46 +0100277{
278 int ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
279 size_t hlen, ilen;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200280 unsigned char tmp_secret[MBEDTLS_MD_MAX_SIZE] = { 0 };
281 unsigned char tmp_input[MBEDTLS_MD_MAX_SIZE] = { 0 };
Hanno Beckere9cccb42020-08-20 13:42:46 +0100282
283 const mbedtls_md_info_t *md;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200284 md = mbedtls_md_info_from_type(hash_alg);
285 if (md == NULL)
286 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckere9cccb42020-08-20 13:42:46 +0100287
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200288 hlen = mbedtls_md_get_size(md);
Hanno Beckere9cccb42020-08-20 13:42:46 +0100289
290 /* For non-initial runs, call Derive-Secret( ., "derived", "")
Hanno Becker61baae72020-09-16 09:24:14 +0100291 * on the old secret. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200292 if (secret_old != NULL) {
Hanno Beckere9cccb42020-08-20 13:42:46 +0100293 ret = mbedtls_ssl_tls1_3_derive_secret(
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200294 hash_alg, secret_old, hlen,
295 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(derived), NULL, 0, /* context */
296 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED, tmp_secret, hlen);
297 if (ret != 0)
Hanno Beckere9cccb42020-08-20 13:42:46 +0100298 goto cleanup;
299 }
300
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200301 if (input != NULL) {
302 memcpy(tmp_input, input, input_len);
Hanno Beckere9cccb42020-08-20 13:42:46 +0100303 ilen = input_len;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200304 } else {
Hanno Beckere9cccb42020-08-20 13:42:46 +0100305 ilen = hlen;
306 }
307
308 /* HKDF-Extract takes a salt and input key material.
309 * The salt is the old secret, and the input key material
310 * is the input secret (PSK / ECDHE). */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200311 ret =
312 mbedtls_hkdf_extract(md, tmp_secret, hlen, tmp_input, ilen, secret_new);
313 if (ret != 0)
Hanno Beckere9cccb42020-08-20 13:42:46 +0100314 goto cleanup;
315
316 ret = 0;
317
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200318cleanup:
Hanno Beckere9cccb42020-08-20 13:42:46 +0100319
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200320 mbedtls_platform_zeroize(tmp_secret, sizeof(tmp_secret));
321 mbedtls_platform_zeroize(tmp_input, sizeof(tmp_input));
322 return ret;
Hanno Beckere9cccb42020-08-20 13:42:46 +0100323}
324
Hanno Beckeref5235b2021-05-24 06:39:41 +0100325int mbedtls_ssl_tls1_3_derive_early_secrets(
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200326 mbedtls_md_type_t md_type,
327 unsigned char const *early_secret,
328 unsigned char const *transcript,
329 size_t transcript_len,
330 mbedtls_ssl_tls1_3_early_secrets *derived)
Hanno Beckeref5235b2021-05-24 06:39:41 +0100331{
332 int ret;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200333 mbedtls_md_info_t const *const md_info = mbedtls_md_info_from_type(md_type);
334 size_t const md_size = mbedtls_md_get_size(md_info);
Hanno Beckeref5235b2021-05-24 06:39:41 +0100335
336 /* We should never call this function with an unknown hash,
337 * but add an assertion anyway. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200338 if (md_info == 0)
339 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100340
341 /*
342 * 0
343 * |
344 * v
345 * PSK -> HKDF-Extract = Early Secret
346 * |
Hanno Beckeref5235b2021-05-24 06:39:41 +0100347 * +-----> Derive-Secret(., "c e traffic", ClientHello)
348 * | = client_early_traffic_secret
349 * |
350 * +-----> Derive-Secret(., "e exp master", ClientHello)
351 * | = early_exporter_master_secret
352 * v
353 */
354
355 /* Create client_early_traffic_secret */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200356 ret = mbedtls_ssl_tls1_3_derive_secret(
357 md_type, early_secret, md_size,
358 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(c_e_traffic), transcript,
359 transcript_len, MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
360 derived->client_early_traffic_secret, md_size);
361 if (ret != 0)
362 return ret;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100363
364 /* Create early exporter */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200365 ret = mbedtls_ssl_tls1_3_derive_secret(
366 md_type, early_secret, md_size,
367 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(e_exp_master), transcript,
368 transcript_len, MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
369 derived->early_exporter_master_secret, md_size);
370 if (ret != 0)
371 return ret;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100372
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200373 return 0;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100374}
375
376int mbedtls_ssl_tls1_3_derive_handshake_secrets(
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200377 mbedtls_md_type_t md_type,
378 unsigned char const *handshake_secret,
379 unsigned char const *transcript,
380 size_t transcript_len,
381 mbedtls_ssl_tls1_3_handshake_secrets *derived)
Hanno Beckeref5235b2021-05-24 06:39:41 +0100382{
383 int ret;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200384 mbedtls_md_info_t const *const md_info = mbedtls_md_info_from_type(md_type);
385 size_t const md_size = mbedtls_md_get_size(md_info);
Hanno Beckeref5235b2021-05-24 06:39:41 +0100386
387 /* We should never call this function with an unknown hash,
388 * but add an assertion anyway. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200389 if (md_info == 0)
390 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100391
392 /*
393 *
394 * Handshake Secret
395 * |
396 * +-----> Derive-Secret( ., "c hs traffic",
397 * | ClientHello...ServerHello )
398 * | = client_handshake_traffic_secret
399 * |
400 * +-----> Derive-Secret( ., "s hs traffic",
401 * | ClientHello...ServerHello )
402 * | = server_handshake_traffic_secret
403 *
404 */
405
406 /*
407 * Compute client_handshake_traffic_secret with
408 * Derive-Secret( ., "c hs traffic", ClientHello...ServerHello )
409 */
410
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200411 ret = mbedtls_ssl_tls1_3_derive_secret(
412 md_type, handshake_secret, md_size,
413 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(c_hs_traffic), transcript,
414 transcript_len, MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
415 derived->client_handshake_traffic_secret, md_size);
416 if (ret != 0)
417 return ret;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100418
419 /*
420 * Compute server_handshake_traffic_secret with
421 * Derive-Secret( ., "s hs traffic", ClientHello...ServerHello )
422 */
423
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200424 ret = mbedtls_ssl_tls1_3_derive_secret(
425 md_type, handshake_secret, md_size,
426 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(s_hs_traffic), transcript,
427 transcript_len, MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
428 derived->server_handshake_traffic_secret, md_size);
429 if (ret != 0)
430 return ret;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100431
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200432 return 0;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100433}
434
435int mbedtls_ssl_tls1_3_derive_application_secrets(
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200436 mbedtls_md_type_t md_type,
437 unsigned char const *application_secret,
438 unsigned char const *transcript,
439 size_t transcript_len,
440 mbedtls_ssl_tls1_3_application_secrets *derived)
Hanno Beckeref5235b2021-05-24 06:39:41 +0100441{
442 int ret;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200443 mbedtls_md_info_t const *const md_info = mbedtls_md_info_from_type(md_type);
444 size_t const md_size = mbedtls_md_get_size(md_info);
Hanno Beckeref5235b2021-05-24 06:39:41 +0100445
446 /* We should never call this function with an unknown hash,
447 * but add an assertion anyway. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200448 if (md_info == 0)
449 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100450
451 /* Generate {client,server}_application_traffic_secret_0
452 *
453 * Master Secret
454 * |
455 * +-----> Derive-Secret( ., "c ap traffic",
456 * | ClientHello...server Finished )
457 * | = client_application_traffic_secret_0
458 * |
459 * +-----> Derive-Secret( ., "s ap traffic",
460 * | ClientHello...Server Finished )
461 * | = server_application_traffic_secret_0
462 * |
463 * +-----> Derive-Secret( ., "exp master",
464 * | ClientHello...server Finished)
465 * | = exporter_master_secret
466 *
467 */
468
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200469 ret = mbedtls_ssl_tls1_3_derive_secret(
470 md_type, application_secret, md_size,
471 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(c_ap_traffic), transcript,
472 transcript_len, MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
473 derived->client_application_traffic_secret_N, md_size);
474 if (ret != 0)
475 return ret;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100476
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200477 ret = mbedtls_ssl_tls1_3_derive_secret(
478 md_type, application_secret, md_size,
479 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(s_ap_traffic), transcript,
480 transcript_len, MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED,
481 derived->server_application_traffic_secret_N, md_size);
482 if (ret != 0)
483 return ret;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100484
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200485 ret = mbedtls_ssl_tls1_3_derive_secret(
486 md_type, application_secret, md_size,
487 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(exp_master), transcript, transcript_len,
488 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED, derived->exporter_master_secret,
489 md_size);
490 if (ret != 0)
491 return ret;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100492
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200493 return 0;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100494}
495
496/* Generate resumption_master_secret for use with the ticket exchange.
497 *
498 * This is not integrated with mbedtls_ssl_tls1_3_derive_application_secrets()
499 * because it uses the transcript hash up to and including ClientFinished. */
500int mbedtls_ssl_tls1_3_derive_resumption_master_secret(
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200501 mbedtls_md_type_t md_type,
502 unsigned char const *application_secret,
503 unsigned char const *transcript,
504 size_t transcript_len,
505 mbedtls_ssl_tls1_3_application_secrets *derived)
Hanno Beckeref5235b2021-05-24 06:39:41 +0100506{
507 int ret;
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200508 mbedtls_md_info_t const *const md_info = mbedtls_md_info_from_type(md_type);
509 size_t const md_size = mbedtls_md_get_size(md_info);
Hanno Beckeref5235b2021-05-24 06:39:41 +0100510
511 /* We should never call this function with an unknown hash,
512 * but add an assertion anyway. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200513 if (md_info == 0)
514 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100515
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200516 ret = mbedtls_ssl_tls1_3_derive_secret(
517 md_type, application_secret, md_size,
518 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(res_master), transcript, transcript_len,
519 MBEDTLS_SSL_TLS1_3_CONTEXT_HASHED, derived->resumption_master_secret,
520 md_size);
Hanno Beckeref5235b2021-05-24 06:39:41 +0100521
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200522 if (ret != 0)
523 return ret;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100524
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200525 return 0;
Hanno Beckeref5235b2021-05-24 06:39:41 +0100526}
527
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200528static int ssl_tls1_3_calc_finished_core(mbedtls_md_type_t md_type,
529 unsigned char const *base_key,
530 unsigned char const *transcript,
531 unsigned char *dst)
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100532{
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200533 const mbedtls_md_info_t *const md_info = mbedtls_md_info_from_type(md_type);
534 size_t const md_size = mbedtls_md_get_size(md_info);
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100535 unsigned char finished_key[MBEDTLS_MD_MAX_SIZE];
536 int ret;
537
538 /* We should never call this function with an unknown hash,
539 * but add an assertion anyway. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200540 if (md_info == 0)
541 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100542
543 /* TLS 1.3 Finished message
544 *
545 * struct {
546 * opaque verify_data[Hash.length];
547 * } Finished;
548 *
549 * verify_data =
550 * HMAC( finished_key,
551 * Hash( Handshake Context +
552 * Certificate* +
553 * CertificateVerify* )
554 * )
555 *
556 * finished_key =
557 * HKDF-Expand-Label( BaseKey, "finished", "", Hash.length )
558 */
559
560 ret = mbedtls_ssl_tls1_3_hkdf_expand_label(
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200561 md_type, base_key, md_size, MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(finished),
562 NULL, 0, finished_key, md_size);
563 if (ret != 0)
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100564 goto exit;
565
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200566 ret = mbedtls_md_hmac(md_info, finished_key, md_size, transcript, md_size,
567 dst);
568 if (ret != 0)
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100569 goto exit;
570
571exit:
572
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200573 mbedtls_platform_zeroize(finished_key, sizeof(finished_key));
574 return ret;
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100575}
576
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200577int mbedtls_ssl_tls1_3_create_psk_binder(mbedtls_ssl_context *ssl,
578 const mbedtls_md_type_t md_type,
579 unsigned char const *psk,
580 size_t psk_len,
581 int psk_type,
582 unsigned char const *transcript,
583 unsigned char *result)
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100584{
585 int ret = 0;
586 unsigned char binder_key[MBEDTLS_MD_MAX_SIZE];
587 unsigned char early_secret[MBEDTLS_MD_MAX_SIZE];
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200588 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type(md_type);
589 size_t const md_size = mbedtls_md_get_size(md_info);
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100590
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200591# if !defined(MBEDTLS_DEBUG_C)
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100592 ssl = NULL; /* make sure we don't use it except for debug */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200593 ((void)ssl);
594# endif
Hanno Becker28e5f1e2021-05-26 09:29:49 +0100595
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100596 /* We should never call this function with an unknown hash,
597 * but add an assertion anyway. */
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200598 if (md_info == 0)
599 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100600
601 /*
602 * 0
603 * |
604 * v
605 * PSK -> HKDF-Extract = Early Secret
606 * |
607 * +-----> Derive-Secret(., "ext binder" | "res binder", "")
608 * | = binder_key
609 * v
610 */
611
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200612 ret = mbedtls_ssl_tls1_3_evolve_secret(md_type, NULL, /* Old secret */
613 psk, psk_len, /* Input */
614 early_secret);
615 if (ret != 0) {
616 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls1_3_evolve_secret", ret);
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100617 goto exit;
618 }
619
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200620 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
621 ret = mbedtls_ssl_tls1_3_derive_secret(
622 md_type, early_secret, md_size,
623 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(res_binder), NULL, 0,
624 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED, binder_key, md_size);
625 MBEDTLS_SSL_DEBUG_MSG(4, ("Derive Early Secret with 'res binder'"));
626 } else {
627 ret = mbedtls_ssl_tls1_3_derive_secret(
628 md_type, early_secret, md_size,
629 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(ext_binder), NULL, 0,
630 MBEDTLS_SSL_TLS1_3_CONTEXT_UNHASHED, binder_key, md_size);
631 MBEDTLS_SSL_DEBUG_MSG(4, ("Derive Early Secret with 'ext binder'"));
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100632 }
633
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200634 if (ret != 0) {
635 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls1_3_derive_secret", ret);
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100636 goto exit;
637 }
638
639 /*
640 * The binding_value is computed in the same way as the Finished message
641 * but with the BaseKey being the binder_key.
642 */
643
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200644 ret =
645 ssl_tls1_3_calc_finished_core(md_type, binder_key, transcript, result);
646 if (ret != 0)
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100647 goto exit;
648
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200649 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder", result, md_size);
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100650
651exit:
652
Mateusz Starzykc0eabdc2021-08-03 14:09:02 +0200653 mbedtls_platform_zeroize(early_secret, sizeof(early_secret));
654 mbedtls_platform_zeroize(binder_key, sizeof(binder_key));
655 return ret;
Hanno Beckerb7d9bad2021-05-24 06:44:14 +0100656}
657
Hanno Beckerbe9d6642020-08-21 13:20:06 +0100658#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */