blob: 2bc2715467fc8f0d9ada9c1f091810347f1c7295 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
2 * TLS 1.3 client-side functions
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 * This file is part of mbed TLS ( https://tls.mbed.org )
20 */
21
22#include "common.h"
23
Jerry Yucc43c6b2022-01-28 10:24:45 +080024#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080025
Jerry Yubc20bdd2021-08-24 15:59:48 +080026#include <string.h>
27
Jerry Yu56fc07f2021-09-01 17:48:49 +080028#include "mbedtls/debug.h"
29#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080030#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080031
Jerry Yubdc71882021-09-14 19:30:36 +080032#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010033#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080034#include "ssl_tls13_keys.h"
Jerry Yucbd082f2022-08-04 16:55:10 +080035#include "ssl_debug_helpers.h"
Jerry Yubdc71882021-09-14 19:30:36 +080036
Jerry Yubc20bdd2021-08-24 15:59:48 +080037/* Write extensions */
38
Jerry Yu92c6b402021-08-27 16:59:09 +080039/*
40 * ssl_tls13_write_supported_versions_ext():
41 *
42 * struct {
43 * ProtocolVersion versions<2..254>;
44 * } SupportedVersions;
45 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020046MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +000047static int ssl_tls13_write_supported_versions_ext(mbedtls_ssl_context *ssl,
48 unsigned char *buf,
49 unsigned char *end,
50 size_t *out_len)
Jerry Yu92c6b402021-08-27 16:59:09 +080051{
52 unsigned char *p = buf;
David Horstmann71159f42023-01-03 12:51:59 +000053 unsigned char versions_len = (ssl->handshake->min_tls_version <=
54 MBEDTLS_SSL_VERSION_TLS1_2) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080055
Xiaofei Baid25fab62021-12-02 06:36:27 +000056 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080057
David Horstmann71159f42023-01-03 12:51:59 +000058 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding supported versions extension"));
Jerry Yu92c6b402021-08-27 16:59:09 +080059
Jerry Yu388bd0d2021-09-15 18:41:02 +080060 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080061 * - extension_type (2 bytes)
62 * - extension_data_length (2 bytes)
63 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020064 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080065 */
David Horstmann71159f42023-01-03 12:51:59 +000066 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 5 + versions_len);
Ronald Crondbe87f02022-02-10 14:35:27 +010067
David Horstmann71159f42023-01-03 12:51:59 +000068 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0);
69 MBEDTLS_PUT_UINT16_BE(versions_len + 1, p, 2);
Jerry Yueecfbf02021-08-30 18:32:07 +080070 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080071
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080072 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010073 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080074
Jerry Yu0c63af62021-09-02 12:59:12 +080075 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080076 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010077 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080078 */
David Horstmann71159f42023-01-03 12:51:59 +000079 mbedtls_ssl_write_version(p, MBEDTLS_SSL_TRANSPORT_STREAM,
80 MBEDTLS_SSL_VERSION_TLS1_3);
81 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:4]"));
Jerry Yu92c6b402021-08-27 16:59:09 +080082
Jerry Yu92c6b402021-08-27 16:59:09 +080083
David Horstmann71159f42023-01-03 12:51:59 +000084 if (ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
85 mbedtls_ssl_write_version(p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
86 MBEDTLS_SSL_VERSION_TLS1_2);
87 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:3]"));
Ronald Crondbe87f02022-02-10 14:35:27 +010088 }
89
90 *out_len = 5 + versions_len;
Jerry Yu4b8f2f72022-10-31 13:31:22 +080091
Jerry Yuc4bf5d62022-10-29 09:08:47 +080092 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
David Horstmann71159f42023-01-03 12:51:59 +000093 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yu4b8f2f72022-10-31 13:31:22 +080094
David Horstmann71159f42023-01-03 12:51:59 +000095 return 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080096}
Jerry Yubc20bdd2021-08-24 15:59:48 +080097
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020098MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +000099static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
100 const unsigned char *buf,
101 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800102{
Jerry Yue1b9c292021-09-10 10:08:31 +0800103 ((void) ssl);
104
David Horstmann71159f42023-01-03 12:51:59 +0000105 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
106 if (mbedtls_ssl_read_version(buf, ssl->conf->transport) !=
107 MBEDTLS_SSL_VERSION_TLS1_3) {
108 MBEDTLS_SSL_DEBUG_MSG(1, ("unexpected version"));
Jerry Yu4a173382021-10-11 21:45:31 +0800109
David Horstmann71159f42023-01-03 12:51:59 +0000110 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
111 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
112 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +0800113 }
114
David Horstmann71159f42023-01-03 12:51:59 +0000115 if (&buf[2] != end) {
116 MBEDTLS_SSL_DEBUG_MSG(1, ("supported_versions ext data length incorrect"));
117 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
118 MBEDTLS_ERR_SSL_DECODE_ERROR);
119 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Ronald Cron98473382022-03-30 20:04:10 +0200120 }
121
David Horstmann71159f42023-01-03 12:51:59 +0000122 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +0800123}
124
lhuang0486cacac2022-01-21 07:34:27 -0800125#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200126MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000127static int ssl_tls13_parse_alpn_ext(mbedtls_ssl_context *ssl,
128 const unsigned char *buf, size_t len)
lhuang0486cacac2022-01-21 07:34:27 -0800129{
lhuang0486cacac2022-01-21 07:34:27 -0800130 const unsigned char *p = buf;
131 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200132 size_t protocol_name_list_len, protocol_name_len;
133 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800134
135 /* If we didn't send it, the server shouldn't send it */
David Horstmann71159f42023-01-03 12:51:59 +0000136 if (ssl->conf->alpn_list == NULL) {
137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
138 }
lhuang0486cacac2022-01-21 07:34:27 -0800139
140 /*
141 * opaque ProtocolName<1..2^8-1>;
142 *
143 * struct {
144 * ProtocolName protocol_name_list<2..2^16-1>
145 * } ProtocolNameList;
146 *
147 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
148 */
149
David Horstmann71159f42023-01-03 12:51:59 +0000150 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
151 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
lhuang0486cacac2022-01-21 07:34:27 -0800152 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800153
David Horstmann71159f42023-01-03 12:51:59 +0000154 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
Ronald Cron81a334f2022-05-31 16:04:11 +0200155 protocol_name_list_end = p + protocol_name_list_len;
156
David Horstmann71159f42023-01-03 12:51:59 +0000157 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, 1);
Ronald Cron81a334f2022-05-31 16:04:11 +0200158 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800159
160 /* Check that the server chosen protocol was in our list and save it */
David Horstmann71159f42023-01-03 12:51:59 +0000161 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, protocol_name_len);
162 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
163 if (protocol_name_len == strlen(*alpn) &&
164 memcmp(p, *alpn, protocol_name_len) == 0) {
lhuang0486cacac2022-01-21 07:34:27 -0800165 ssl->alpn_chosen = *alpn;
David Horstmann71159f42023-01-03 12:51:59 +0000166 return 0;
lhuang0486cacac2022-01-21 07:34:27 -0800167 }
168 }
169
David Horstmann71159f42023-01-03 12:51:59 +0000170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
lhuang0486cacac2022-01-21 07:34:27 -0800171}
172#endif /* MBEDTLS_SSL_ALPN */
173
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200174MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000175static int ssl_tls13_reset_key_share(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +0000176{
177 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100178
David Horstmann71159f42023-01-03 12:51:59 +0000179 if (group_id == 0) {
180 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
181 }
XiaokangQian647719a2021-12-07 09:16:29 +0000182
XiaokangQian355e09a2022-01-20 11:14:50 +0000183#if defined(MBEDTLS_ECDH_C)
David Horstmann71159f42023-01-03 12:51:59 +0000184 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
187
188 /* Destroy generated private key. */
David Horstmann71159f42023-01-03 12:51:59 +0000189 status = psa_destroy_key(ssl->handshake->ecdh_psa_privkey);
190 if (status != PSA_SUCCESS) {
191 ret = psa_ssl_status_to_mbedtls(status);
192 MBEDTLS_SSL_DEBUG_RET(1, "psa_destroy_key", ret);
193 return ret;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100194 }
195
196 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
David Horstmann71159f42023-01-03 12:51:59 +0000197 return 0;
198 } else
XiaokangQian355e09a2022-01-20 11:14:50 +0000199#endif /* MBEDTLS_ECDH_C */
David Horstmann71159f42023-01-03 12:51:59 +0000200 if (0 /* other KEMs? */) {
XiaokangQian647719a2021-12-07 09:16:29 +0000201 /* Do something */
202 }
203
David Horstmann71159f42023-01-03 12:51:59 +0000204 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQian647719a2021-12-07 09:16:29 +0000205}
206
207/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800208 * Functions for writing key_share extension.
209 */
Ronald Cron766c0cd2022-10-18 12:17:11 +0200210#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200211MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000212static int ssl_tls13_get_default_group_id(mbedtls_ssl_context *ssl,
213 uint16_t *group_id)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800214{
215 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
216
Jerry Yu56fc07f2021-09-01 17:48:49 +0800217
Jerry Yu56fc07f2021-09-01 17:48:49 +0800218#if defined(MBEDTLS_ECDH_C)
David Horstmann71159f42023-01-03 12:51:59 +0000219 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Jerry Yu388bd0d2021-09-15 18:41:02 +0800220 /* Pick first available ECDHE group compatible with TLS 1.3 */
David Horstmann71159f42023-01-03 12:51:59 +0000221 if (group_list == NULL) {
222 return MBEDTLS_ERR_SSL_BAD_CONFIG;
223 }
Jerry Yu388bd0d2021-09-15 18:41:02 +0800224
David Horstmann71159f42023-01-03 12:51:59 +0000225 for (; *group_list != 0; group_list++) {
Xiaofei Baieef15042021-11-18 07:29:56 +0000226 const mbedtls_ecp_curve_info *curve_info;
David Horstmann71159f42023-01-03 12:51:59 +0000227 curve_info = mbedtls_ecp_curve_info_from_tls_id(*group_list);
228 if (curve_info != NULL &&
229 mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
Brett Warren14efd332021-10-06 09:32:11 +0100230 *group_id = *group_list;
David Horstmann71159f42023-01-03 12:51:59 +0000231 return 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800232 }
233 }
234#else
235 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800236 ((void) group_id);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800237#endif /* MBEDTLS_ECDH_C */
238
239 /*
240 * Add DHE named groups here.
Jerry Yu388bd0d2021-09-15 18:41:02 +0800241 * Pick first available DHE group compatible with TLS 1.3
Jerry Yu56fc07f2021-09-01 17:48:49 +0800242 */
243
David Horstmann71159f42023-01-03 12:51:59 +0000244 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800245}
246
247/*
248 * ssl_tls13_write_key_share_ext
249 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800250 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800251 *
252 * struct {
253 * NamedGroup group;
254 * opaque key_exchange<1..2^16-1>;
255 * } KeyShareEntry;
256 * struct {
257 * KeyShareEntry client_shares<0..2^16-1>;
258 * } KeyShareClientHello;
259 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200260MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000261static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
262 unsigned char *buf,
263 unsigned char *end,
264 size_t *out_len)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800265{
266 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000267 unsigned char *client_shares; /* Start of client_shares */
268 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800269 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800270 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
271
Xiaofei Baid25fab62021-12-02 06:36:27 +0000272 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800273
Jerry Yub60e3cf2021-09-08 16:41:02 +0800274 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800275 * - extension_type (2 bytes)
276 * - extension_data_length (2 bytes)
277 * - client_shares_length (2 bytes)
278 */
David Horstmann71159f42023-01-03 12:51:59 +0000279 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800280 p += 6;
281
David Horstmann71159f42023-01-03 12:51:59 +0000282 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello: adding key share extension"));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800283
284 /* HRR could already have requested something else. */
285 group_id = ssl->handshake->offered_group_id;
David Horstmann71159f42023-01-03 12:51:59 +0000286 if (!mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) &&
287 !mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
288 MBEDTLS_SSL_PROC_CHK(ssl_tls13_get_default_group_id(ssl,
289 &group_id));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800290 }
291
292 /*
293 * Dispatch to type-specific key generation function.
294 *
295 * So far, we're only supporting ECDHE. With the introduction
296 * of PQC KEMs, we'll want to have multiple branches, one per
297 * type of KEM, and dispatch to the corresponding crypto. And
298 * only one key share entry is allowed.
299 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000300 client_shares = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800301#if defined(MBEDTLS_ECDH_C)
David Horstmann71159f42023-01-03 12:51:59 +0000302 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800303 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000304 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800305 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100306 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800307
308 /* Check there is space for header of KeyShareEntry
309 * - group (2 bytes)
310 * - key_exchange_length (2 bytes)
311 */
David Horstmann71159f42023-01-03 12:51:59 +0000312 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800313 p += 4;
Jerry Yu89e103c2022-03-30 22:43:29 +0800314 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
David Horstmann71159f42023-01-03 12:51:59 +0000315 ssl, group_id, p, end, &key_exchange_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800316 p += key_exchange_len;
David Horstmann71159f42023-01-03 12:51:59 +0000317 if (ret != 0) {
318 return ret;
319 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800320
321 /* Write group */
David Horstmann71159f42023-01-03 12:51:59 +0000322 MBEDTLS_PUT_UINT16_BE(group_id, group, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800323 /* Write key_exchange_length */
David Horstmann71159f42023-01-03 12:51:59 +0000324 MBEDTLS_PUT_UINT16_BE(key_exchange_len, group, 2);
325 } else
Jerry Yu56fc07f2021-09-01 17:48:49 +0800326#endif /* MBEDTLS_ECDH_C */
David Horstmann71159f42023-01-03 12:51:59 +0000327 if (0 /* other KEMs? */) {
Jerry Yu56fc07f2021-09-01 17:48:49 +0800328 /* Do something */
David Horstmann71159f42023-01-03 12:51:59 +0000329 } else {
330 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800331 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800332
Jerry Yub60e3cf2021-09-08 16:41:02 +0800333 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000334 client_shares_len = p - client_shares;
David Horstmann71159f42023-01-03 12:51:59 +0000335 if (client_shares_len == 0) {
336 MBEDTLS_SSL_DEBUG_MSG(1, ("No key share defined."));
337 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu7c522d42021-09-08 17:55:09 +0800338 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800339 /* Write extension_type */
David Horstmann71159f42023-01-03 12:51:59 +0000340 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800341 /* Write extension_data_length */
David Horstmann71159f42023-01-03 12:51:59 +0000342 MBEDTLS_PUT_UINT16_BE(client_shares_len + 2, buf, 2);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800343 /* Write client_shares_length */
David Horstmann71159f42023-01-03 12:51:59 +0000344 MBEDTLS_PUT_UINT16_BE(client_shares_len, buf, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800345
346 /* Update offered_group_id field */
347 ssl->handshake->offered_group_id = group_id;
348
349 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000350 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800351
David Horstmann71159f42023-01-03 12:51:59 +0000352 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, key_share extension", buf, *out_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800353
David Horstmann71159f42023-01-03 12:51:59 +0000354 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800355
356cleanup:
357
David Horstmann71159f42023-01-03 12:51:59 +0000358 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800359}
Ronald Cron766c0cd2022-10-18 12:17:11 +0200360#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +0800361
XiaokangQiand59be772022-01-24 10:12:51 +0000362/*
363 * ssl_tls13_parse_hrr_key_share_ext()
364 * Parse key_share extension in Hello Retry Request
365 *
366 * struct {
367 * NamedGroup selected_group;
368 * } KeyShareHelloRetryRequest;
369 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200370MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000371static int ssl_tls13_parse_hrr_key_share_ext(mbedtls_ssl_context *ssl,
372 const unsigned char *buf,
373 const unsigned char *end)
XiaokangQianb851da82022-01-14 04:03:11 +0000374{
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400375#if defined(MBEDTLS_ECDH_C)
XiaokangQianb851da82022-01-14 04:03:11 +0000376 const mbedtls_ecp_curve_info *curve_info = NULL;
377 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000378 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000379 int found = 0;
380
David Horstmann71159f42023-01-03 12:51:59 +0000381 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
382 if (group_list == NULL) {
383 return MBEDTLS_ERR_SSL_BAD_CONFIG;
384 }
XiaokangQianb851da82022-01-14 04:03:11 +0000385
David Horstmann71159f42023-01-03 12:51:59 +0000386 MBEDTLS_SSL_DEBUG_BUF(3, "key_share extension", p, end - buf);
XiaokangQianb851da82022-01-14 04:03:11 +0000387
388 /* Read selected_group */
David Horstmann71159f42023-01-03 12:51:59 +0000389 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
390 selected_group = MBEDTLS_GET_UINT16_BE(p, 0);
391 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_group ( %d )", selected_group));
XiaokangQianb851da82022-01-14 04:03:11 +0000392
393 /* Upon receipt of this extension in a HelloRetryRequest, the client
394 * MUST first verify that the selected_group field corresponds to a
395 * group which was provided in the "supported_groups" extension in the
396 * original ClientHello.
397 * The supported_group was based on the info in ssl->conf->group_list.
398 *
399 * If the server provided a key share that was not sent in the ClientHello
400 * then the client MUST abort the handshake with an "illegal_parameter" alert.
401 */
David Horstmann71159f42023-01-03 12:51:59 +0000402 for (; *group_list != 0; group_list++) {
403 curve_info = mbedtls_ecp_curve_info_from_tls_id(*group_list);
404 if (curve_info == NULL || curve_info->tls_id != selected_group) {
XiaokangQianb851da82022-01-14 04:03:11 +0000405 continue;
David Horstmann71159f42023-01-03 12:51:59 +0000406 }
XiaokangQianb851da82022-01-14 04:03:11 +0000407
408 /* We found a match */
409 found = 1;
410 break;
411 }
412
413 /* Client MUST verify that the selected_group field does not
414 * correspond to a group which was provided in the "key_share"
415 * extension in the original ClientHello. If the server sent an
416 * HRR message with a key share already provided in the
417 * ClientHello then the client MUST abort the handshake with
418 * an "illegal_parameter" alert.
419 */
David Horstmann71159f42023-01-03 12:51:59 +0000420 if (found == 0 || selected_group == ssl->handshake->offered_group_id) {
421 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid key share in HRR"));
XiaokangQianb851da82022-01-14 04:03:11 +0000422 MBEDTLS_SSL_PEND_FATAL_ALERT(
David Horstmann71159f42023-01-03 12:51:59 +0000423 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
424 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
425 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQianb851da82022-01-14 04:03:11 +0000426 }
427
428 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000429 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000430
David Horstmann71159f42023-01-03 12:51:59 +0000431 return 0;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400432#else
433 (void) ssl;
434 (void) buf;
435 (void) end;
David Horstmann71159f42023-01-03 12:51:59 +0000436 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400437#endif
XiaokangQianb851da82022-01-14 04:03:11 +0000438}
439
Jerry Yue1b9c292021-09-10 10:08:31 +0800440/*
Jerry Yub85277e2021-10-13 13:36:05 +0800441 * ssl_tls13_parse_key_share_ext()
442 * Parse key_share extension in Server Hello
443 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800444 * struct {
445 * KeyShareEntry server_share;
446 * } KeyShareServerHello;
447 * struct {
448 * NamedGroup group;
449 * opaque key_exchange<1..2^16-1>;
450 * } KeyShareEntry;
451 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200452MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000453static int ssl_tls13_parse_key_share_ext(mbedtls_ssl_context *ssl,
454 const unsigned char *buf,
455 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800456{
Jerry Yub85277e2021-10-13 13:36:05 +0800457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800458 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800459 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800460
Jerry Yu4a173382021-10-11 21:45:31 +0800461 /* ...
462 * NamedGroup group; (2 bytes)
463 * ...
464 */
David Horstmann71159f42023-01-03 12:51:59 +0000465 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
466 group = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +0800467 p += 2;
468
Jerry Yu4a173382021-10-11 21:45:31 +0800469 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800470 offered_group = ssl->handshake->offered_group_id;
David Horstmann71159f42023-01-03 12:51:59 +0000471 if (offered_group != group) {
472 MBEDTLS_SSL_DEBUG_MSG(1,
473 ("Invalid server key share, our group %u, their group %u",
474 (unsigned) offered_group, (unsigned) group));
475 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
476 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
477 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yue1b9c292021-09-10 10:08:31 +0800478 }
479
480#if defined(MBEDTLS_ECDH_C)
David Horstmann71159f42023-01-03 12:51:59 +0000481 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100482 const mbedtls_ecp_curve_info *curve_info =
David Horstmann71159f42023-01-03 12:51:59 +0000483 mbedtls_ecp_curve_info_from_tls_id(group);
484 if (curve_info == NULL) {
485 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid TLS curve group id"));
486 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100487 }
488
David Horstmann71159f42023-01-03 12:51:59 +0000489 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH curve: %s", curve_info->name));
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100490
David Horstmann71159f42023-01-03 12:51:59 +0000491 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(ssl, p, end - p);
492 if (ret != 0) {
493 return ret;
494 }
495 } else
Jerry Yue1b9c292021-09-10 10:08:31 +0800496#endif /* MBEDTLS_ECDH_C */
David Horstmann71159f42023-01-03 12:51:59 +0000497 if (0 /* other KEMs? */) {
Jerry Yue1b9c292021-09-10 10:08:31 +0800498 /* Do something */
David Horstmann71159f42023-01-03 12:51:59 +0000499 } else {
500 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yue1b9c292021-09-10 10:08:31 +0800501 }
Jerry Yue1b9c292021-09-10 10:08:31 +0800502
David Horstmann71159f42023-01-03 12:51:59 +0000503 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +0800504}
505
XiaokangQiand59be772022-01-24 10:12:51 +0000506/*
507 * ssl_tls13_parse_cookie_ext()
508 * Parse cookie extension in Hello Retry Request
509 *
510 * struct {
511 * opaque cookie<1..2^16-1>;
512 * } Cookie;
513 *
514 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
515 * extension to the client (this is an exception to the usual rule that
516 * the only extensions that may be sent are those that appear in the
517 * ClientHello). When sending the new ClientHello, the client MUST copy
518 * the contents of the extension received in the HelloRetryRequest into
519 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
520 * cookies in their initial ClientHello in subsequent connections.
521 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200522MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000523static int ssl_tls13_parse_cookie_ext(mbedtls_ssl_context *ssl,
524 const unsigned char *buf,
525 const unsigned char *end)
XiaokangQian43550bd2022-01-21 04:32:58 +0000526{
XiaokangQian25c9c902022-02-08 10:49:53 +0000527 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000528 const unsigned char *p = buf;
529 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
530
531 /* Retrieve length field of cookie */
David Horstmann71159f42023-01-03 12:51:59 +0000532 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
533 cookie_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian43550bd2022-01-21 04:32:58 +0000534 p += 2;
535
David Horstmann71159f42023-01-03 12:51:59 +0000536 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cookie_len);
537 MBEDTLS_SSL_DEBUG_BUF(3, "cookie extension", p, cookie_len);
XiaokangQian43550bd2022-01-21 04:32:58 +0000538
David Horstmann71159f42023-01-03 12:51:59 +0000539 mbedtls_free(handshake->cookie);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800540 handshake->cookie_len = 0;
David Horstmann71159f42023-01-03 12:51:59 +0000541 handshake->cookie = mbedtls_calloc(1, cookie_len);
542 if (handshake->cookie == NULL) {
543 MBEDTLS_SSL_DEBUG_MSG(1,
544 ("alloc failed ( %ud bytes )",
545 cookie_len));
546 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
XiaokangQian43550bd2022-01-21 04:32:58 +0000547 }
548
David Horstmann71159f42023-01-03 12:51:59 +0000549 memcpy(handshake->cookie, p, cookie_len);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800550 handshake->cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000551
David Horstmann71159f42023-01-03 12:51:59 +0000552 return 0;
XiaokangQian43550bd2022-01-21 04:32:58 +0000553}
XiaokangQian43550bd2022-01-21 04:32:58 +0000554
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200555MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000556static int ssl_tls13_write_cookie_ext(mbedtls_ssl_context *ssl,
557 unsigned char *buf,
558 unsigned char *end,
559 size_t *out_len)
XiaokangQian0b64eed2022-01-27 10:36:51 +0000560{
561 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000562 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000563 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000564
David Horstmann71159f42023-01-03 12:51:59 +0000565 if (handshake->cookie == NULL) {
566 MBEDTLS_SSL_DEBUG_MSG(3, ("no cookie to send; skip extension"));
567 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000568 }
569
David Horstmann71159f42023-01-03 12:51:59 +0000570 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, cookie",
571 handshake->cookie,
572 handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000573
David Horstmann71159f42023-01-03 12:51:59 +0000574 MBEDTLS_SSL_CHK_BUF_PTR(p, end, handshake->cookie_len + 6);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000575
David Horstmann71159f42023-01-03 12:51:59 +0000576 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding cookie extension"));
XiaokangQian0b64eed2022-01-27 10:36:51 +0000577
David Horstmann71159f42023-01-03 12:51:59 +0000578 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_COOKIE, p, 0);
579 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len + 2, p, 2);
580 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len, p, 4);
XiaokangQian233397e2022-02-07 08:32:16 +0000581 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000582
583 /* Cookie */
David Horstmann71159f42023-01-03 12:51:59 +0000584 memcpy(p, handshake->cookie, handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000585
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800586 *out_len = handshake->cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000587
David Horstmann71159f42023-01-03 12:51:59 +0000588 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_COOKIE);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800589
David Horstmann71159f42023-01-03 12:51:59 +0000590 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000591}
592
Ronald Cron41a443a2022-10-04 16:38:25 +0200593#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000594/*
595 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
596 *
597 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
598 *
599 * struct {
600 * PskKeyExchangeMode ke_modes<1..255>;
601 * } PskKeyExchangeModes;
602 */
XiaokangQian86981952022-07-19 09:51:50 +0000603MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000604static int ssl_tls13_write_psk_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
605 unsigned char *buf,
606 unsigned char *end,
607 size_t *out_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000608{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000609 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000610 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000611
David Horstmann71159f42023-01-03 12:51:59 +0000612 ((void) ke_modes_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000613 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000614
XiaokangQianeb69aee2022-07-05 08:21:43 +0000615 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000616 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000617 */
David Horstmann71159f42023-01-03 12:51:59 +0000618 if (!mbedtls_ssl_conf_tls13_some_psk_enabled(ssl)) {
619 MBEDTLS_SSL_DEBUG_MSG(3, ("skip psk_key_exchange_modes extension"));
620 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000621 }
622
623 /* Require 7 bytes of data, otherwise fail,
624 * even if extension might be shorter.
625 */
David Horstmann71159f42023-01-03 12:51:59 +0000626 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000627 MBEDTLS_SSL_DEBUG_MSG(
David Horstmann71159f42023-01-03 12:51:59 +0000628 3, ("client hello, adding psk_key_exchange_modes extension"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000629
David Horstmann71159f42023-01-03 12:51:59 +0000630 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000631
XiaokangQian008d2bf2022-07-14 07:54:01 +0000632 /* Skip extension length (2 bytes) and
633 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000634 */
635 p += 5;
636
David Horstmann71159f42023-01-03 12:51:59 +0000637 if (mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl)) {
XiaokangQianeb69aee2022-07-05 08:21:43 +0000638 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000639 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000640
David Horstmann71159f42023-01-03 12:51:59 +0000641 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding PSK-ECDHE key exchange mode"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000642 }
643
David Horstmann71159f42023-01-03 12:51:59 +0000644 if (mbedtls_ssl_conf_tls13_psk_enabled(ssl)) {
Ronald Crona709a0f2022-09-27 16:46:11 +0200645 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
646 ke_modes_len++;
647
David Horstmann71159f42023-01-03 12:51:59 +0000648 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding pure PSK key exchange mode"));
Ronald Crona709a0f2022-09-27 16:46:11 +0200649 }
650
XiaokangQian008d2bf2022-07-14 07:54:01 +0000651 /* Now write the extension and ke_modes length */
David Horstmann71159f42023-01-03 12:51:59 +0000652 MBEDTLS_PUT_UINT16_BE(ke_modes_len + 1, buf, 2);
XiaokangQian008d2bf2022-07-14 07:54:01 +0000653 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000654
655 *out_len = p - buf;
Jerry Yu0c354a22022-08-29 15:25:36 +0800656
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800657 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
David Horstmann71159f42023-01-03 12:51:59 +0000658 ssl, MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800659
David Horstmann71159f42023-01-03 12:51:59 +0000660 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000661}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800662
David Horstmann71159f42023-01-03 12:51:59 +0000663static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg(int ciphersuite)
Jerry Yuf7c12592022-09-28 22:09:38 +0800664{
Jerry Yu21f90952022-10-08 10:30:53 +0800665 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
David Horstmann71159f42023-01-03 12:51:59 +0000666 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800667
David Horstmann71159f42023-01-03 12:51:59 +0000668 if (ciphersuite_info != NULL) {
669 return mbedtls_psa_translate_md(ciphersuite_info->mac);
670 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800671
David Horstmann71159f42023-01-03 12:51:59 +0000672 return PSA_ALG_NONE;
Jerry Yuf7c12592022-09-28 22:09:38 +0800673}
674
Jerry Yuf75364b2022-09-30 10:30:31 +0800675#if defined(MBEDTLS_SSL_SESSION_TICKETS)
David Horstmann71159f42023-01-03 12:51:59 +0000676static int ssl_tls13_has_configured_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qianb781a232022-11-01 07:39:46 +0000677{
678 mbedtls_ssl_session *session = ssl->session_negotiate;
David Horstmann71159f42023-01-03 12:51:59 +0000679 return ssl->handshake->resume &&
680 session != NULL && session->ticket != NULL;
Xiaokang Qianb781a232022-11-01 07:39:46 +0000681}
682
Xiaokang Qian01323a42022-11-03 02:27:35 +0000683#if defined(MBEDTLS_SSL_EARLY_DATA)
David Horstmann71159f42023-01-03 12:51:59 +0000684static int ssl_tls13_early_data_has_valid_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qian01323a42022-11-03 02:27:35 +0000685{
686 mbedtls_ssl_session *session = ssl->session_negotiate;
David Horstmann71159f42023-01-03 12:51:59 +0000687 return ssl->handshake->resume &&
688 session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
689 (session->ticket_flags &
690 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) &&
691 mbedtls_ssl_tls13_cipher_suite_is_offered(
692 ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000693}
694#endif
695
Xiaokang Qianb781a232022-11-01 07:39:46 +0000696MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000697static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
698 psa_algorithm_t *hash_alg,
699 const unsigned char **identity,
700 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800701{
702 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800703
David Horstmann71159f42023-01-03 12:51:59 +0000704 if (!ssl_tls13_has_configured_ticket(ssl)) {
705 return -1;
706 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800707
David Horstmann71159f42023-01-03 12:51:59 +0000708 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800709 *identity = session->ticket;
710 *identity_len = session->ticket_len;
David Horstmann71159f42023-01-03 12:51:59 +0000711 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800712}
713
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800714MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000715static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
716 psa_algorithm_t *hash_alg,
717 const unsigned char **psk,
718 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800719{
720
721 mbedtls_ssl_session *session = ssl->session_negotiate;
722
David Horstmann71159f42023-01-03 12:51:59 +0000723 if (!ssl_tls13_has_configured_ticket(ssl)) {
724 return -1;
725 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800726
David Horstmann71159f42023-01-03 12:51:59 +0000727 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800728 *psk = session->resumption_key;
729 *psk_len = session->resumption_key_len;
730
David Horstmann71159f42023-01-03 12:51:59 +0000731 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800732}
Jerry Yuf7c12592022-09-28 22:09:38 +0800733#endif /* MBEDTLS_SSL_SESSION_TICKETS */
734
735MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000736static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
737 psa_algorithm_t *hash_alg,
738 const unsigned char **identity,
739 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800740{
Jerry Yu8b41e892022-09-30 10:00:20 +0800741
David Horstmann71159f42023-01-03 12:51:59 +0000742 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
743 return -1;
744 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800745
Jerry Yua99cbfa2022-10-08 11:17:14 +0800746 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800747 *identity = ssl->conf->psk_identity;
748 *identity_len = ssl->conf->psk_identity_len;
David Horstmann71159f42023-01-03 12:51:59 +0000749 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800750}
751
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800752MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000753static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
754 psa_algorithm_t *hash_alg,
755 const unsigned char **psk,
756 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800757{
Jerry Yu8b41e892022-09-30 10:00:20 +0800758
David Horstmann71159f42023-01-03 12:51:59 +0000759 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
760 return -1;
761 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800762
Jerry Yua99cbfa2022-10-08 11:17:14 +0800763 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800764 *psk = ssl->conf->psk;
765 *psk_len = ssl->conf->psk_len;
David Horstmann71159f42023-01-03 12:51:59 +0000766 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800767}
768
David Horstmann71159f42023-01-03 12:51:59 +0000769static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800770{
771 int configured_psk_count = 0;
772#if defined(MBEDTLS_SSL_SESSION_TICKETS)
David Horstmann71159f42023-01-03 12:51:59 +0000773 if (ssl_tls13_has_configured_ticket(ssl)) {
774 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800775 configured_psk_count++;
776 }
777#endif
David Horstmann71159f42023-01-03 12:51:59 +0000778 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
779 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800780 configured_psk_count++;
781 }
David Horstmann71159f42023-01-03 12:51:59 +0000782 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800783}
784
Jerry Yuf7c12592022-09-28 22:09:38 +0800785MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000786static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
787 unsigned char *buf,
788 unsigned char *end,
789 const unsigned char *identity,
790 size_t identity_len,
791 uint32_t obfuscated_ticket_age,
792 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800793{
Jerry Yuf75364b2022-09-30 10:30:31 +0800794 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800795 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800796
797 /*
798 * - identity_len (2 bytes)
799 * - identity (psk_identity_len bytes)
800 * - obfuscated_ticket_age (4 bytes)
801 */
David Horstmann71159f42023-01-03 12:51:59 +0000802 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800803
David Horstmann71159f42023-01-03 12:51:59 +0000804 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
805 memcpy(buf + 2, identity, identity_len);
806 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800807
David Horstmann71159f42023-01-03 12:51:59 +0000808 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800809
810 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800811
David Horstmann71159f42023-01-03 12:51:59 +0000812 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800813}
814
Jerry Yu8b41e892022-09-30 10:00:20 +0800815MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +0000816static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
817 unsigned char *buf,
818 unsigned char *end,
819 int psk_type,
820 psa_algorithm_t hash_alg,
821 const unsigned char *psk,
822 size_t psk_len,
823 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800824{
825 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800826 unsigned char binder_len;
David Horstmann71159f42023-01-03 12:51:59 +0000827 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800828 size_t transcript_len = 0;
829
830 *out_len = 0;
831
David Horstmann71159f42023-01-03 12:51:59 +0000832 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800833
834 /*
835 * - binder_len (1 bytes)
836 * - binder (binder_len bytes)
837 */
David Horstmann71159f42023-01-03 12:51:59 +0000838 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800839
Jerry Yua99cbfa2022-10-08 11:17:14 +0800840 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800841
842 /* Get current state of handshake transcript. */
843 ret = mbedtls_ssl_get_handshake_transcript(
David Horstmann71159f42023-01-03 12:51:59 +0000844 ssl, mbedtls_hash_info_md_from_psa(hash_alg),
845 transcript, sizeof(transcript), &transcript_len);
846 if (ret != 0) {
847 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800848 }
David Horstmann71159f42023-01-03 12:51:59 +0000849
850 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
851 psk, psk_len, psk_type,
852 transcript, buf + 1);
853 if (ret != 0) {
854 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
855 return ret;
856 }
857 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800858
859 *out_len = 1 + binder_len;
860
David Horstmann71159f42023-01-03 12:51:59 +0000861 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800862}
863
864/*
865 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
866 *
867 * struct {
868 * opaque identity<1..2^16-1>;
869 * uint32 obfuscated_ticket_age;
870 * } PskIdentity;
871 *
872 * opaque PskBinderEntry<32..255>;
873 *
874 * struct {
875 * PskIdentity identities<7..2^16-1>;
876 * PskBinderEntry binders<33..2^16-1>;
877 * } OfferedPsks;
878 *
879 * struct {
880 * select (Handshake.msg_type) {
881 * case client_hello: OfferedPsks;
882 * ...
883 * };
884 * } PreSharedKeyExtension;
885 *
886 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000887int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
David Horstmann71159f42023-01-03 12:51:59 +0000888 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
889 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000890{
Jerry Yuf7c12592022-09-28 22:09:38 +0800891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800892 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800893 unsigned char *p = buf;
Jerry Yuf75364b2022-09-30 10:30:31 +0800894 psa_algorithm_t hash_alg;
895 const unsigned char *identity;
896 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800897 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800898 size_t output_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800899
900 *out_len = 0;
901 *binders_len = 0;
902
903 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
David Horstmann71159f42023-01-03 12:51:59 +0000904 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
905 if (configured_psk_count == 0) {
906 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
907 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800908 }
909
David Horstmann71159f42023-01-03 12:51:59 +0000910 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
911 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800912
Jerry Yuf7c12592022-09-28 22:09:38 +0800913 /* Check if we have space to write the extension, binders included.
914 * - extension_type (2 bytes)
915 * - extension_data_len (2 bytes)
916 * - identities_len (2 bytes)
917 */
David Horstmann71159f42023-01-03 12:51:59 +0000918 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800919 p += 6;
920
Jerry Yuf75364b2022-09-30 10:30:31 +0800921#if defined(MBEDTLS_SSL_SESSION_TICKETS)
David Horstmann71159f42023-01-03 12:51:59 +0000922 if (ssl_tls13_ticket_get_identity(
923 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800924#if defined(MBEDTLS_HAVE_TIME)
David Horstmann71159f42023-01-03 12:51:59 +0000925 mbedtls_time_t now = mbedtls_time(NULL);
Jerry Yuf75364b2022-09-30 10:30:31 +0800926 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800927 uint32_t obfuscated_ticket_age =
David Horstmann71159f42023-01-03 12:51:59 +0000928 (uint32_t) (now - session->ticket_received);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800929
Jerry Yuf75364b2022-09-30 10:30:31 +0800930 obfuscated_ticket_age *= 1000;
931 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800932
David Horstmann71159f42023-01-03 12:51:59 +0000933 ret = ssl_tls13_write_identity(ssl, p, end,
934 identity, identity_len,
935 obfuscated_ticket_age,
936 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800937#else
David Horstmann71159f42023-01-03 12:51:59 +0000938 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
939 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800940#endif /* MBEDTLS_HAVE_TIME */
David Horstmann71159f42023-01-03 12:51:59 +0000941 if (ret != 0) {
942 return ret;
943 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800944
Jerry Yuf75364b2022-09-30 10:30:31 +0800945 p += output_len;
David Horstmann71159f42023-01-03 12:51:59 +0000946 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +0800947 }
948#endif /* MBEDTLS_SSL_SESSION_TICKETS */
949
David Horstmann71159f42023-01-03 12:51:59 +0000950 if (ssl_tls13_psk_get_identity(
951 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800952
David Horstmann71159f42023-01-03 12:51:59 +0000953 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
954 &output_len);
955 if (ret != 0) {
956 return ret;
957 }
Jerry Yuf75364b2022-09-30 10:30:31 +0800958
Jerry Yuf7c12592022-09-28 22:09:38 +0800959 p += output_len;
David Horstmann71159f42023-01-03 12:51:59 +0000960 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +0800961 }
962
David Horstmann71159f42023-01-03 12:51:59 +0000963 MBEDTLS_SSL_DEBUG_MSG(3,
964 ("client hello, adding pre_shared_key extension, "
965 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +0800966
967 /* Take into account the two bytes for the length of the binders. */
968 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800969 /* Check if there is enough space for binders */
David Horstmann71159f42023-01-03 12:51:59 +0000970 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800971
Jerry Yuf7c12592022-09-28 22:09:38 +0800972 /*
973 * - extension_type (2 bytes)
974 * - extension_data_len (2 bytes)
975 * - identities_len (2 bytes)
976 */
David Horstmann71159f42023-01-03 12:51:59 +0000977 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
978 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
979 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +0800980
David Horstmann71159f42023-01-03 12:51:59 +0000981 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800982 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800983
David Horstmann71159f42023-01-03 12:51:59 +0000984 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +0800985
David Horstmann71159f42023-01-03 12:51:59 +0000986 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000987}
988
XiaokangQian86981952022-07-19 09:51:50 +0000989int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
David Horstmann71159f42023-01-03 12:51:59 +0000990 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000991{
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
993 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +0800994 psa_algorithm_t hash_alg = PSA_ALG_NONE;
995 const unsigned char *psk;
996 size_t psk_len;
997 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800998
999 /* Check if we have space to write binders_len.
1000 * - binders_len (2 bytes)
1001 */
David Horstmann71159f42023-01-03 12:51:59 +00001002 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001003 p += 2;
1004
Jerry Yu6183cc72022-09-30 11:08:57 +08001005#if defined(MBEDTLS_SSL_SESSION_TICKETS)
David Horstmann71159f42023-01-03 12:51:59 +00001006 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001007
David Horstmann71159f42023-01-03 12:51:59 +00001008 ret = ssl_tls13_write_binder(ssl, p, end,
1009 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1010 hash_alg, psk, psk_len,
1011 &output_len);
1012 if (ret != 0) {
1013 return ret;
1014 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001015 p += output_len;
1016 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001017#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001018
David Horstmann71159f42023-01-03 12:51:59 +00001019 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001020
David Horstmann71159f42023-01-03 12:51:59 +00001021 ret = ssl_tls13_write_binder(ssl, p, end,
1022 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1023 hash_alg, psk, psk_len,
1024 &output_len);
1025 if (ret != 0) {
1026 return ret;
1027 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001028 p += output_len;
1029 }
1030
David Horstmann71159f42023-01-03 12:51:59 +00001031 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001032
1033 /*
1034 * - binders_len (2 bytes)
1035 */
David Horstmann71159f42023-01-03 12:51:59 +00001036 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001037
David Horstmann71159f42023-01-03 12:51:59 +00001038 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001039
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001040 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
David Horstmann71159f42023-01-03 12:51:59 +00001041 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001042
David Horstmann71159f42023-01-03 12:51:59 +00001043 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001044}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001045
1046/*
1047 * struct {
1048 * opaque identity<1..2^16-1>;
1049 * uint32 obfuscated_ticket_age;
1050 * } PskIdentity;
1051 *
1052 * opaque PskBinderEntry<32..255>;
1053 *
1054 * struct {
1055 *
1056 * select (Handshake.msg_type) {
1057 * ...
1058 * case server_hello: uint16 selected_identity;
1059 * };
1060 *
1061 * } PreSharedKeyExtension;
1062 *
1063 */
1064MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00001065static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1066 const unsigned char *buf,
1067 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001068{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001069 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001070 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001071 const unsigned char *psk;
1072 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001073 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001074
David Horstmann71159f42023-01-03 12:51:59 +00001075 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1076 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Jerry Yua99cbfa2022-10-08 11:17:14 +08001077
David Horstmann71159f42023-01-03 12:51:59 +00001078 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001079
David Horstmann71159f42023-01-03 12:51:59 +00001080 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1081 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001082
David Horstmann71159f42023-01-03 12:51:59 +00001083 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1084 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1085 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001086 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001087
Jerry Yu4a698342022-09-30 12:22:01 +08001088#if defined(MBEDTLS_SSL_SESSION_TICKETS)
David Horstmann71159f42023-01-03 12:51:59 +00001089 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1090 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1091 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001092#endif
David Horstmann71159f42023-01-03 12:51:59 +00001093 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1094 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
1095 } else {
1096 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1097 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001098 }
David Horstmann71159f42023-01-03 12:51:59 +00001099 if (ret != 0) {
1100 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001101 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001102
David Horstmann71159f42023-01-03 12:51:59 +00001103 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1104 if (ret != 0) {
1105 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1106 return ret;
1107 }
1108
1109 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001110}
Ronald Cron41a443a2022-10-04 16:38:25 +02001111#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001112
David Horstmann71159f42023-01-03 12:51:59 +00001113int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1114 unsigned char *buf,
1115 unsigned char *end,
1116 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001117{
1118 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1119 unsigned char *p = buf;
1120 size_t ext_len;
1121
1122 *out_len = 0;
1123
1124 /* Write supported_versions extension
1125 *
1126 * Supported Versions Extension is mandatory with TLS 1.3.
1127 */
David Horstmann71159f42023-01-03 12:51:59 +00001128 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1129 if (ret != 0) {
1130 return ret;
1131 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001132 p += ext_len;
1133
1134 /* Echo the cookie if the server provided one in its preceding
1135 * HelloRetryRequest message.
1136 */
David Horstmann71159f42023-01-03 12:51:59 +00001137 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1138 if (ret != 0) {
1139 return ret;
1140 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001141 p += ext_len;
1142
Ronald Cron766c0cd2022-10-18 12:17:11 +02001143#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
David Horstmann71159f42023-01-03 12:51:59 +00001144 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1145 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1146 if (ret != 0) {
1147 return ret;
1148 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001149 p += ext_len;
1150 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001151#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001152
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001153#if defined(MBEDTLS_SSL_EARLY_DATA)
David Horstmann71159f42023-01-03 12:51:59 +00001154 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1155 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1156 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1157 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1158 if (ret != 0) {
1159 return ret;
1160 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001161 p += ext_len;
1162
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001163 /* Initializes the status to `rejected`. It will be updated to
1164 * `accepted` if the EncryptedExtension message contain an early data
1165 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001166 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001167 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
David Horstmann71159f42023-01-03 12:51:59 +00001168 } else {
1169 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001170 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001171 }
1172#endif /* MBEDTLS_SSL_EARLY_DATA */
1173
Ronald Cron41a443a2022-10-04 16:38:25 +02001174#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001175 /* For PSK-based key exchange we need the pre_shared_key extension
1176 * and the psk_key_exchange_modes extension.
1177 *
1178 * The pre_shared_key extension MUST be the last extension in the
1179 * ClientHello. Servers MUST check that it is the last extension and
1180 * otherwise fail the handshake with an "illegal_parameter" alert.
1181 *
1182 * Add the psk_key_exchange_modes extension.
1183 */
David Horstmann71159f42023-01-03 12:51:59 +00001184 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1185 if (ret != 0) {
1186 return ret;
1187 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001188 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001189#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001190
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001191 *out_len = p - buf;
1192
David Horstmann71159f42023-01-03 12:51:59 +00001193 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001194}
1195
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001196/*
Jerry Yu4a173382021-10-11 21:45:31 +08001197 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001198 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001199
Ronald Cronda41b382022-03-30 09:57:11 +02001200/**
1201 * \brief Detect if the ServerHello contains a supported_versions extension
1202 * or not.
1203 *
1204 * \param[in] ssl SSL context
1205 * \param[in] buf Buffer containing the ServerHello message
1206 * \param[in] end End of the buffer containing the ServerHello message
1207 *
1208 * \return 0 if the ServerHello does not contain a supported_versions extension
1209 * \return 1 if the ServerHello contains a supported_versions extension
1210 * \return A negative value if an error occurred while parsing the ServerHello.
1211 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001212MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001213static int ssl_tls13_is_supported_versions_ext_present(
1214 mbedtls_ssl_context *ssl,
1215 const unsigned char *buf,
David Horstmann71159f42023-01-03 12:51:59 +00001216 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001217{
1218 const unsigned char *p = buf;
1219 size_t legacy_session_id_echo_len;
1220 size_t extensions_len;
1221 const unsigned char *extensions_end;
1222
1223 /*
1224 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001225 * length:
1226 * - legacy_version 2 bytes
1227 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1228 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001229 */
David Horstmann71159f42023-01-03 12:51:59 +00001230 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001231 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1232 legacy_session_id_echo_len = *p;
1233
1234 /*
1235 * Jump to the extensions, jumping over:
1236 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1237 * - cipher_suite 2 bytes
1238 * - legacy_compression_method 1 byte
1239 */
David Horstmann71159f42023-01-03 12:51:59 +00001240 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1241 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001242
1243 /* Case of no extension */
David Horstmann71159f42023-01-03 12:51:59 +00001244 if (p == end) {
1245 return 0;
1246 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001247
1248 /* ...
1249 * Extension extensions<6..2^16-1>;
1250 * ...
1251 * struct {
1252 * ExtensionType extension_type; (2 bytes)
1253 * opaque extension_data<0..2^16-1>;
1254 * } Extension;
1255 */
David Horstmann71159f42023-01-03 12:51:59 +00001256 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1257 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001258 p += 2;
1259
1260 /* Check extensions do not go beyond the buffer of data. */
David Horstmann71159f42023-01-03 12:51:59 +00001261 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001262 extensions_end = p + extensions_len;
1263
David Horstmann71159f42023-01-03 12:51:59 +00001264 while (p < extensions_end) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01001265 unsigned int extension_type;
1266 size_t extension_data_len;
1267
David Horstmann71159f42023-01-03 12:51:59 +00001268 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1269 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1270 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001271 p += 4;
1272
David Horstmann71159f42023-01-03 12:51:59 +00001273 if (extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS) {
1274 return 1;
1275 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001276
David Horstmann71159f42023-01-03 12:51:59 +00001277 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001278 p += extension_data_len;
1279 }
1280
David Horstmann71159f42023-01-03 12:51:59 +00001281 return 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001282}
1283
Jerry Yu7a186a02021-10-15 18:46:14 +08001284/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001285 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1286 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1287 * - 0 otherwise
1288 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001289MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00001290static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1291 const unsigned char *buf,
1292 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001293{
1294 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1295 static const unsigned char magic_downgrade_string[] =
David Horstmann71159f42023-01-03 12:51:59 +00001296 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001297 const unsigned char *last_eight_bytes_of_random;
1298 unsigned char last_byte_of_random;
1299
David Horstmann71159f42023-01-03 12:51:59 +00001300 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001301 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1302
David Horstmann71159f42023-01-03 12:51:59 +00001303 if (memcmp(last_eight_bytes_of_random,
1304 magic_downgrade_string,
1305 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001306 last_byte_of_random = last_eight_bytes_of_random[7];
David Horstmann71159f42023-01-03 12:51:59 +00001307 return last_byte_of_random == 0 ||
1308 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001309 }
1310
David Horstmann71159f42023-01-03 12:51:59 +00001311 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001312}
1313
1314/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001315 * - SSL_SERVER_HELLO or
1316 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001317 * to indicate which message is expected and to be parsed next.
1318 */
Ronald Cron828aff62022-05-31 12:04:31 +02001319#define SSL_SERVER_HELLO 0
1320#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001321MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00001322static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1323 const unsigned char *buf,
1324 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001325{
Jerry Yue1b9c292021-09-10 10:08:31 +08001326
1327 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1328 *
Jerry Yu4a173382021-10-11 21:45:31 +08001329 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001330 * special value of the SHA-256 of "HelloRetryRequest".
1331 *
1332 * struct {
1333 * ProtocolVersion legacy_version = 0x0303;
1334 * Random random;
1335 * opaque legacy_session_id_echo<0..32>;
1336 * CipherSuite cipher_suite;
1337 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001338 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001339 * } ServerHello;
1340 *
1341 */
David Horstmann71159f42023-01-03 12:51:59 +00001342 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end,
1343 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001344
David Horstmann71159f42023-01-03 12:51:59 +00001345 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1346 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1347 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001348 }
1349
David Horstmann71159f42023-01-03 12:51:59 +00001350 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001351}
1352
Ronald Cron828aff62022-05-31 12:04:31 +02001353/*
Jerry Yu745bb612021-10-13 22:01:04 +08001354 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001355 * - SSL_SERVER_HELLO or
1356 * - SSL_SERVER_HELLO_HRR or
1357 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001358 */
Ronald Cron828aff62022-05-31 12:04:31 +02001359#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001360MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00001361static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1362 const unsigned char *buf,
1363 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001364{
Jerry Yu4a173382021-10-11 21:45:31 +08001365 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001366 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001367
David Horstmann71159f42023-01-03 12:51:59 +00001368 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1369 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001370
David Horstmann71159f42023-01-03 12:51:59 +00001371 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001372 MBEDTLS_SSL_PROC_CHK_NEG(
David Horstmann71159f42023-01-03 12:51:59 +00001373 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001374
1375 /* If the server is negotiating TLS 1.2 or below and:
1376 * . we did not propose TLS 1.2 or
1377 * . the server responded it is TLS 1.3 capable but negotiating a lower
1378 * version of the protocol and thus we are under downgrade attack
1379 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001380 */
David Horstmann71159f42023-01-03 12:51:59 +00001381 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1382 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1383 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1384 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001385 }
1386
1387 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001388 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
David Horstmann71159f42023-01-03 12:51:59 +00001389 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1390 buf, (size_t) (end - buf));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001391
David Horstmann71159f42023-01-03 12:51:59 +00001392 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1393 ret = ssl_tls13_reset_key_share(ssl);
1394 if (ret != 0) {
1395 return ret;
1396 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001397 }
1398
David Horstmann71159f42023-01-03 12:51:59 +00001399 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001400 }
1401
Jerry Yua66fece2022-07-13 14:30:29 +08001402#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1403 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1404 ssl->session_negotiate->tls_version = ssl->tls_version;
1405#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1406
Jerry Yu50e00e32022-10-31 14:45:01 +08001407 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001408
David Horstmann71159f42023-01-03 12:51:59 +00001409 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1410 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001411 case SSL_SERVER_HELLO:
David Horstmann71159f42023-01-03 12:51:59 +00001412 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001413 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001414 case SSL_SERVER_HELLO_HRR:
David Horstmann71159f42023-01-03 12:51:59 +00001415 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
1416 /* If a client receives a second
1417 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1418 * was itself in response to a HelloRetryRequest), it MUST abort the
1419 * handshake with an "unexpected_message" alert.
1420 */
1421 if (handshake->hello_retry_request_count > 0) {
1422 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
1423 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1424 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
1425 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001426 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001427 /*
1428 * Clients must abort the handshake with an "illegal_parameter"
1429 * alert if the HelloRetryRequest would not result in any change
1430 * in the ClientHello.
1431 * In a PSK only key exchange that what we expect.
1432 */
David Horstmann71159f42023-01-03 12:51:59 +00001433 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1434 MBEDTLS_SSL_DEBUG_MSG(1,
1435 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001436 MBEDTLS_SSL_PEND_FATAL_ALERT(
David Horstmann71159f42023-01-03 12:51:59 +00001437 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1438 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1439 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001440 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001441
Ronald Cron5afb9042022-05-31 12:11:39 +02001442 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001443
Jerry Yu745bb612021-10-13 22:01:04 +08001444 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001445 }
1446
1447cleanup:
1448
David Horstmann71159f42023-01-03 12:51:59 +00001449 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001450}
1451
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001452MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00001453static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1454 const unsigned char **buf,
1455 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001456{
1457 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001458 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001459
David Horstmann71159f42023-01-03 12:51:59 +00001460 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1461 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001462
David Horstmann71159f42023-01-03 12:51:59 +00001463 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001464
1465 /* legacy_session_id_echo */
David Horstmann71159f42023-01-03 12:51:59 +00001466 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1467 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1468 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1469 ssl->session_negotiate->id,
1470 ssl->session_negotiate->id_len);
1471 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1472 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001473
David Horstmann71159f42023-01-03 12:51:59 +00001474 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1475 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001476
David Horstmann71159f42023-01-03 12:51:59 +00001477 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001478 }
1479
Jerry Yu4a173382021-10-11 21:45:31 +08001480 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001481 *buf = p;
1482
David Horstmann71159f42023-01-03 12:51:59 +00001483 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1484 ssl->session_negotiate->id_len);
1485 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001486}
1487
Jerry Yue1b9c292021-09-10 10:08:31 +08001488/* Parse ServerHello message and configure context
1489 *
1490 * struct {
1491 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1492 * Random random;
1493 * opaque legacy_session_id_echo<0..32>;
1494 * CipherSuite cipher_suite;
1495 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001496 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001497 * } ServerHello;
1498 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001499MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00001500static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1501 const unsigned char *buf,
1502 const unsigned char *end,
1503 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001504{
Jerry Yub85277e2021-10-13 13:36:05 +08001505 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001506 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001507 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001508 size_t extensions_len;
1509 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001510 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001511 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001512 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001513 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001514 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
David Horstmann71159f42023-01-03 12:51:59 +00001515 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001516
1517 /*
1518 * Check there is space for minimal fields
1519 *
1520 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001521 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001522 * - legacy_session_id_echo ( 1 byte ), minimum size
1523 * - cipher_suite ( 2 bytes)
1524 * - legacy_compression_method ( 1 byte )
1525 */
David Horstmann71159f42023-01-03 12:51:59 +00001526 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001527
David Horstmann71159f42023-01-03 12:51:59 +00001528 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1529 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001530
Jerry Yu4a173382021-10-11 21:45:31 +08001531 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001532 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001533 * ...
1534 * with ProtocolVersion defined as:
1535 * uint16 ProtocolVersion;
1536 */
David Horstmann71159f42023-01-03 12:51:59 +00001537 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1538 MBEDTLS_SSL_VERSION_TLS1_2) {
1539 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1540 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1541 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001542 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1543 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001544 }
1545 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001546
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001547 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001548 * Random random;
1549 * ...
1550 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001551 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001552 */
David Horstmann71159f42023-01-03 12:51:59 +00001553 if (!is_hrr) {
1554 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1555 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1556 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1557 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001558 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001559 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001560
Jerry Yu4a173382021-10-11 21:45:31 +08001561 /* ...
1562 * opaque legacy_session_id_echo<0..32>;
1563 * ...
1564 */
David Horstmann71159f42023-01-03 12:51:59 +00001565 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001566 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001567 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001568 }
1569
Jerry Yu4a173382021-10-11 21:45:31 +08001570 /* ...
1571 * CipherSuite cipher_suite;
1572 * ...
1573 * with CipherSuite defined as:
1574 * uint8 CipherSuite[2];
1575 */
David Horstmann71159f42023-01-03 12:51:59 +00001576 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1577 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001578 p += 2;
1579
Jerry Yu4a173382021-10-11 21:45:31 +08001580
David Horstmann71159f42023-01-03 12:51:59 +00001581 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001582 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001583 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001584 */
David Horstmann71159f42023-01-03 12:51:59 +00001585 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1586 ssl->tls_version,
1587 ssl->tls_version) != 0) ||
1588 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001589 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001590 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001591 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001592 * If we received an HRR before and that the proposed selected
1593 * ciphersuite in this server hello is not the same as the one
1594 * proposed in the HRR, we abort the handshake and send an
1595 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001596 */
David Horstmann71159f42023-01-03 12:51:59 +00001597 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1598 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001599 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001600 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001601
David Horstmann71159f42023-01-03 12:51:59 +00001602 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1603 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1604 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001605 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001606 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001607
Jerry Yu4a173382021-10-11 21:45:31 +08001608 /* Configure ciphersuites */
David Horstmann71159f42023-01-03 12:51:59 +00001609 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001610
XiaokangQian355e09a2022-01-20 11:14:50 +00001611 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yue1b9c292021-09-10 10:08:31 +08001612 ssl->session_negotiate->ciphersuite = cipher_suite;
1613
David Horstmann71159f42023-01-03 12:51:59 +00001614 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1615 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001616
1617#if defined(MBEDTLS_HAVE_TIME)
David Horstmann71159f42023-01-03 12:51:59 +00001618 ssl->session_negotiate->start = time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001619#endif /* MBEDTLS_HAVE_TIME */
1620
Jerry Yu4a173382021-10-11 21:45:31 +08001621 /* ...
1622 * uint8 legacy_compression_method = 0;
1623 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001624 */
David Horstmann71159f42023-01-03 12:51:59 +00001625 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1626 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1627 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001628 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001629 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001630 }
1631 p++;
1632
Jerry Yub85277e2021-10-13 13:36:05 +08001633 /* ...
1634 * Extension extensions<6..2^16-1>;
1635 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001636 * struct {
1637 * ExtensionType extension_type; (2 bytes)
1638 * opaque extension_data<0..2^16-1>;
1639 * } Extension;
1640 */
David Horstmann71159f42023-01-03 12:51:59 +00001641 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1642 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001643 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001644
Jerry Yu4a173382021-10-11 21:45:31 +08001645 /* Check extensions do not go beyond the buffer of data. */
David Horstmann71159f42023-01-03 12:51:59 +00001646 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001647 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001648
David Horstmann71159f42023-01-03 12:51:59 +00001649 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001650
Jerry Yu50e00e32022-10-31 14:45:01 +08001651 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001652 allowed_extensions_mask = is_hrr ?
David Horstmann71159f42023-01-03 12:51:59 +00001653 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1654 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001655
David Horstmann71159f42023-01-03 12:51:59 +00001656 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001657 unsigned int extension_type;
1658 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001659 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001660
David Horstmann71159f42023-01-03 12:51:59 +00001661 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1662 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1663 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001664 p += 4;
1665
David Horstmann71159f42023-01-03 12:51:59 +00001666 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001667 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001668
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001669 ret = mbedtls_ssl_tls13_check_received_extension(
David Horstmann71159f42023-01-03 12:51:59 +00001670 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1671 if (ret != 0) {
1672 return ret;
1673 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001674
David Horstmann71159f42023-01-03 12:51:59 +00001675 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001676 case MBEDTLS_TLS_EXT_COOKIE:
1677
David Horstmann71159f42023-01-03 12:51:59 +00001678 ret = ssl_tls13_parse_cookie_ext(ssl,
1679 p, extension_data_end);
1680 if (ret != 0) {
1681 MBEDTLS_SSL_DEBUG_RET(1,
1682 "ssl_tls13_parse_cookie_ext",
1683 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001684 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001685 }
XiaokangQianb851da82022-01-14 04:03:11 +00001686 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001687
Jerry Yue1b9c292021-09-10 10:08:31 +08001688 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
David Horstmann71159f42023-01-03 12:51:59 +00001689 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1690 p,
1691 extension_data_end);
1692 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001693 goto cleanup;
David Horstmann71159f42023-01-03 12:51:59 +00001694 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001695 break;
1696
Ronald Cron41a443a2022-10-04 16:38:25 +02001697#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001698 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
David Horstmann71159f42023-01-03 12:51:59 +00001699 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001700
David Horstmann71159f42023-01-03 12:51:59 +00001701 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1702 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001703 MBEDTLS_SSL_DEBUG_RET(
David Horstmann71159f42023-01-03 12:51:59 +00001704 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1705 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001706 }
1707 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001708#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001709
Jerry Yue1b9c292021-09-10 10:08:31 +08001710 case MBEDTLS_TLS_EXT_KEY_SHARE:
David Horstmann71159f42023-01-03 12:51:59 +00001711 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1712 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001713 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001714 goto cleanup;
1715 }
1716
David Horstmann71159f42023-01-03 12:51:59 +00001717 if (is_hrr) {
1718 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1719 p, extension_data_end);
1720 } else {
1721 ret = ssl_tls13_parse_key_share_ext(ssl,
1722 p, extension_data_end);
1723 }
1724 if (ret != 0) {
1725 MBEDTLS_SSL_DEBUG_RET(1,
1726 "ssl_tls13_parse_key_share_ext",
1727 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001728 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001729 }
1730 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001731
1732 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001733 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1734 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001735 }
1736
1737 p += extension_data_len;
1738 }
1739
David Horstmann71159f42023-01-03 12:51:59 +00001740 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001741
XiaokangQiand59be772022-01-24 10:12:51 +00001742cleanup:
1743
David Horstmann71159f42023-01-03 12:51:59 +00001744 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1745 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1746 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001747 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
David Horstmann71159f42023-01-03 12:51:59 +00001748 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1749 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1750 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001751 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1752 }
David Horstmann71159f42023-01-03 12:51:59 +00001753 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001754}
1755
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001756#if defined(MBEDTLS_DEBUG_C)
1757static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001758{
David Horstmann71159f42023-01-03 12:51:59 +00001759 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001760 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1761 return "psk";
1762 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1763 return "ephemeral";
1764 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1765 return "psk_ephemeral";
1766 default:
1767 return "unknown mode";
1768 }
1769}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001770#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001771
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001772MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00001773static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001774{
Jerry Yub85277e2021-10-13 13:36:05 +08001775 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001776 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001777
Jerry Yub85277e2021-10-13 13:36:05 +08001778 /* Determine the key exchange mode:
1779 * 1) If both the pre_shared_key and key_share extensions were received
1780 * then the key exchange mode is PSK with EPHEMERAL.
1781 * 2) If only the pre_shared_key extension was received then the key
1782 * exchange mode is PSK-only.
1783 * 3) If only the key_share extension was received then the key
1784 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001785 */
David Horstmann71159f42023-01-03 12:51:59 +00001786 switch (handshake->received_extensions &
1787 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001788 /* Only the pre_shared_key extension was received */
David Horstmann71159f42023-01-03 12:51:59 +00001789 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Ronald Cron79907712022-07-20 17:05:29 +02001790 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001791 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001792
Jerry Yu745bb612021-10-13 22:01:04 +08001793 /* Only the key_share extension was received */
David Horstmann71159f42023-01-03 12:51:59 +00001794 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Ronald Cron79907712022-07-20 17:05:29 +02001795 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001796 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001797
Jerry Yu745bb612021-10-13 22:01:04 +08001798 /* Both the pre_shared_key and key_share extensions were received */
David Horstmann71159f42023-01-03 12:51:59 +00001799 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
Ronald Cron79907712022-07-20 17:05:29 +02001800 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001801 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001802
Jerry Yu745bb612021-10-13 22:01:04 +08001803 /* Neither pre_shared_key nor key_share extension was received */
1804 default:
David Horstmann71159f42023-01-03 12:51:59 +00001805 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001806 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1807 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001808 }
1809
David Horstmann71159f42023-01-03 12:51:59 +00001810 if (!mbedtls_ssl_conf_tls13_check_kex_modes(ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001811 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
David Horstmann71159f42023-01-03 12:51:59 +00001812 MBEDTLS_SSL_DEBUG_MSG(2,
1813 ("Key exchange mode(%s) is not supported.",
1814 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001815 goto cleanup;
1816 }
1817
David Horstmann71159f42023-01-03 12:51:59 +00001818 MBEDTLS_SSL_DEBUG_MSG(3,
1819 ("Selected key exchange mode: %s",
1820 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001821
Jerry Yu0b177842021-09-05 19:41:30 +08001822 /* Start the TLS 1.3 key schedule: Set the PSK and derive early secret.
1823 *
1824 * TODO: We don't have to do this in case we offered 0-RTT and the
1825 * server accepted it. In this case, we could skip generating
1826 * the early secret. */
David Horstmann71159f42023-01-03 12:51:59 +00001827 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1828 if (ret != 0) {
1829 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_key_schedule_stage_early",
1830 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001831 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001832 }
1833
David Horstmann71159f42023-01-03 12:51:59 +00001834 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1835 if (ret != 0) {
1836 MBEDTLS_SSL_DEBUG_RET(1,
1837 "mbedtls_ssl_tls13_compute_handshake_transform",
1838 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001839 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001840 }
1841
David Horstmann71159f42023-01-03 12:51:59 +00001842 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1843 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Jerry Yu0b177842021-09-05 19:41:30 +08001844 ssl->session_in = ssl->session_negotiate;
1845
Jerry Yu4a173382021-10-11 21:45:31 +08001846cleanup:
David Horstmann71159f42023-01-03 12:51:59 +00001847 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001848 MBEDTLS_SSL_PEND_FATAL_ALERT(
1849 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
David Horstmann71159f42023-01-03 12:51:59 +00001850 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001851 }
Jerry Yue110d252022-05-05 10:19:22 +08001852
David Horstmann71159f42023-01-03 12:51:59 +00001853 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001854}
1855
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001856MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00001857static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00001858{
1859 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1860
David Horstmann71159f42023-01-03 12:51:59 +00001861 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00001862
XiaokangQian78b1fa72022-01-19 06:56:30 +00001863 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001864 * We are going to re-generate a shared secret corresponding to the group
1865 * selected by the server, which is different from the group for which we
1866 * generated a shared secret in the first client hello.
1867 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001868 */
David Horstmann71159f42023-01-03 12:51:59 +00001869 ret = ssl_tls13_reset_key_share(ssl);
1870 if (ret != 0) {
1871 return ret;
1872 }
XiaokangQian647719a2021-12-07 09:16:29 +00001873
David Horstmann71159f42023-01-03 12:51:59 +00001874 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00001875}
1876
Jerry Yue1b9c292021-09-10 10:08:31 +08001877/*
Jerry Yu4a173382021-10-11 21:45:31 +08001878 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001879 * Handler for MBEDTLS_SSL_SERVER_HELLO
1880 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001881MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00001882static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08001883{
Jerry Yu4a173382021-10-11 21:45:31 +08001884 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001885 unsigned char *buf = NULL;
1886 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001887 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001888
David Horstmann71159f42023-01-03 12:51:59 +00001889 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08001890
David Horstmann71159f42023-01-03 12:51:59 +00001891 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
1892 MBEDTLS_SSL_HS_SERVER_HELLO,
1893 &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02001894
David Horstmann71159f42023-01-03 12:51:59 +00001895 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
1896 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00001897 goto cleanup;
David Horstmann71159f42023-01-03 12:51:59 +00001898 } else {
1899 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
1900 }
XiaokangQiand59be772022-01-24 10:12:51 +00001901
David Horstmann71159f42023-01-03 12:51:59 +00001902 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01001903 ret = 0;
1904 goto cleanup;
1905 }
1906
David Horstmann71159f42023-01-03 12:51:59 +00001907 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
1908 buf + buf_len,
1909 is_hrr));
1910 if (is_hrr) {
1911 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02001912 }
David Horstmann71159f42023-01-03 12:51:59 +00001913
1914 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1915 buf, buf_len);
1916
1917 if (is_hrr) {
1918 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
1919#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1920 /* If not offering early data, the client sends a dummy CCS record
1921 * immediately before its second flight. This may either be before
1922 * its second ClientHello or before its encrypted handshake flight.
1923 */
1924 mbedtls_ssl_handshake_set_state(ssl,
1925 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
1926#else
1927 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
1928#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1929 } else {
1930 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
1931 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02001932 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001933
1934cleanup:
David Horstmann71159f42023-01-03 12:51:59 +00001935 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
1936 is_hrr ? "HelloRetryRequest" : "ServerHello"));
1937 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08001938}
1939
1940/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001941 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02001942 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001943 *
1944 * The EncryptedExtensions message contains any extensions which
1945 * should be protected, i.e., any which are not needed to establish
1946 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08001947 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001948
XiaokangQian08da26c2021-10-09 10:12:11 +00001949/* Parse EncryptedExtensions message
1950 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001951 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001952 * } EncryptedExtensions;
1953 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001954MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00001955static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
1956 const unsigned char *buf,
1957 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001958{
1959 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00001960 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00001961 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00001962 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001963 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001964
David Horstmann71159f42023-01-03 12:51:59 +00001965 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1966 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00001967 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001968
David Horstmann71159f42023-01-03 12:51:59 +00001969 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
1970 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02001971 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001972
Jerry Yu9eba7502022-10-31 13:46:16 +08001973 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08001974
David Horstmann71159f42023-01-03 12:51:59 +00001975 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00001976 unsigned int extension_type;
1977 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001978
XiaokangQian08da26c2021-10-09 10:12:11 +00001979 /*
1980 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001981 * ExtensionType extension_type; (2 bytes)
1982 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001983 * } Extension;
1984 */
David Horstmann71159f42023-01-03 12:51:59 +00001985 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1986 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1987 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00001988 p += 4;
1989
David Horstmann71159f42023-01-03 12:51:59 +00001990 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001991
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001992 ret = mbedtls_ssl_tls13_check_received_extension(
David Horstmann71159f42023-01-03 12:51:59 +00001993 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
1994 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
1995 if (ret != 0) {
1996 return ret;
1997 }
Jerry Yucbd082f2022-08-04 16:55:10 +08001998
David Horstmann71159f42023-01-03 12:51:59 +00001999 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002000#if defined(MBEDTLS_SSL_ALPN)
2001 case MBEDTLS_TLS_EXT_ALPN:
David Horstmann71159f42023-01-03 12:51:59 +00002002 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002003
David Horstmann71159f42023-01-03 12:51:59 +00002004 if ((ret = ssl_tls13_parse_alpn_ext(ssl, p, (size_t) extension_data_len)) != 0) {
2005 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002006 }
2007
2008 break;
2009#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002010
2011#if defined(MBEDTLS_SSL_EARLY_DATA)
2012 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002013
David Horstmann71159f42023-01-03 12:51:59 +00002014 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002015 /* The message must be empty. */
David Horstmann71159f42023-01-03 12:51:59 +00002016 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2017 MBEDTLS_ERR_SSL_DECODE_ERROR);
2018 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002019 }
2020
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002021 break;
2022#endif /* MBEDTLS_SSL_EARLY_DATA */
2023
XiaokangQian08da26c2021-10-09 10:12:11 +00002024 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002025 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002026 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
David Horstmann71159f42023-01-03 12:51:59 +00002027 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002028 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002029 }
2030
XiaokangQian08da26c2021-10-09 10:12:11 +00002031 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002032 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002033
David Horstmann71159f42023-01-03 12:51:59 +00002034 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2035 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002036
XiaokangQian97799ac2021-10-11 10:05:54 +00002037 /* Check that we consumed all the message. */
David Horstmann71159f42023-01-03 12:51:59 +00002038 if (p != end) {
2039 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2040 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2041 MBEDTLS_ERR_SSL_DECODE_ERROR);
2042 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002043 }
2044
David Horstmann71159f42023-01-03 12:51:59 +00002045 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002046}
2047
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002048MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002049static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002050{
2051 int ret;
2052 unsigned char *buf;
2053 size_t buf_len;
2054
David Horstmann71159f42023-01-03 12:51:59 +00002055 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002056
David Horstmann71159f42023-01-03 12:51:59 +00002057 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2058 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2059 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002060
2061 /* Process the message contents */
2062 MBEDTLS_SSL_PROC_CHK(
David Horstmann71159f42023-01-03 12:51:59 +00002063 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002064
Xiaokang Qianb157e912022-11-23 08:12:26 +00002065#if defined(MBEDTLS_SSL_EARLY_DATA)
David Horstmann71159f42023-01-03 12:51:59 +00002066 if (ssl->handshake->received_extensions &
2067 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002068 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2069 }
2070#endif
2071
David Horstmann71159f42023-01-03 12:51:59 +00002072 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2073 buf, buf_len);
Ronald Cron9d6a5452022-05-30 16:05:38 +02002074
Ronald Cron928cbd32022-10-04 16:14:26 +02002075#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
David Horstmann71159f42023-01-03 12:51:59 +00002076 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2077 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2078 } else {
2079 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2080 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002081#else
2082 ((void) ssl);
David Horstmann71159f42023-01-03 12:51:59 +00002083 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002084#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002085
2086cleanup:
2087
David Horstmann71159f42023-01-03 12:51:59 +00002088 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2089 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002090
2091}
2092
Ronald Cron928cbd32022-10-04 16:14:26 +02002093#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002094/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002095 * STATE HANDLING: CertificateRequest
2096 *
Jerry Yud2674312021-10-29 10:08:19 +08002097 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002098#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2099#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002100/* Coordination:
2101 * Deals with the ambiguity of not knowing if a CertificateRequest
2102 * will be sent. Returns a negative code on failure, or
2103 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2104 * - SSL_CERTIFICATE_REQUEST_SKIP
2105 * indicating if a Certificate Request is expected or not.
2106 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002107MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002108static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002109{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002110 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002111
David Horstmann71159f42023-01-03 12:51:59 +00002112 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2113 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2114 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002115 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002116 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002117
David Horstmann71159f42023-01-03 12:51:59 +00002118 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2119 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2120 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2121 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002122 }
2123
David Horstmann71159f42023-01-03 12:51:59 +00002124 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002125
David Horstmann71159f42023-01-03 12:51:59 +00002126 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002127}
2128
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002129/*
2130 * ssl_tls13_parse_certificate_request()
2131 * Parse certificate request
2132 * struct {
2133 * opaque certificate_request_context<0..2^8-1>;
2134 * Extension extensions<2..2^16-1>;
2135 * } CertificateRequest;
2136 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002137MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002138static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2139 const unsigned char *buf,
2140 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002141{
2142 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2143 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002144 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002145 size_t extensions_len = 0;
2146 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002147 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002148
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002149 /* ...
2150 * opaque certificate_request_context<0..2^8-1>
2151 * ...
2152 */
David Horstmann71159f42023-01-03 12:51:59 +00002153 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002154 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002155 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002156
David Horstmann71159f42023-01-03 12:51:59 +00002157 if (certificate_request_context_len > 0) {
2158 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2159 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2160 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002161
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002162 handshake->certificate_request_context =
David Horstmann71159f42023-01-03 12:51:59 +00002163 mbedtls_calloc(1, certificate_request_context_len);
2164 if (handshake->certificate_request_context == NULL) {
2165 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2166 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002167 }
David Horstmann71159f42023-01-03 12:51:59 +00002168 memcpy(handshake->certificate_request_context, p,
2169 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002170 p += certificate_request_context_len;
2171 }
2172
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002173 /* ...
2174 * Extension extensions<2..2^16-1>;
2175 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002176 */
David Horstmann71159f42023-01-03 12:51:59 +00002177 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2178 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002179 p += 2;
2180
David Horstmann71159f42023-01-03 12:51:59 +00002181 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002182 extensions_end = p + extensions_len;
2183
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002184 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002185
David Horstmann71159f42023-01-03 12:51:59 +00002186 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002187 unsigned int extension_type;
2188 size_t extension_data_len;
2189
David Horstmann71159f42023-01-03 12:51:59 +00002190 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2191 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2192 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002193 p += 4;
2194
David Horstmann71159f42023-01-03 12:51:59 +00002195 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002196
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002197 ret = mbedtls_ssl_tls13_check_received_extension(
David Horstmann71159f42023-01-03 12:51:59 +00002198 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2199 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2200 if (ret != 0) {
2201 return ret;
2202 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002203
David Horstmann71159f42023-01-03 12:51:59 +00002204 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002205 case MBEDTLS_TLS_EXT_SIG_ALG:
David Horstmann71159f42023-01-03 12:51:59 +00002206 MBEDTLS_SSL_DEBUG_MSG(3,
2207 ("found signature algorithms extension"));
2208 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2209 p + extension_data_len);
2210 if (ret != 0) {
2211 return ret;
2212 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002213
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002214 break;
2215
2216 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002217 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002218 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
David Horstmann71159f42023-01-03 12:51:59 +00002219 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002220 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002221 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002222
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002223 p += extension_data_len;
2224 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002225
David Horstmann71159f42023-01-03 12:51:59 +00002226 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2227 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002228
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002229 /* Check that we consumed all the message. */
David Horstmann71159f42023-01-03 12:51:59 +00002230 if (p != end) {
2231 MBEDTLS_SSL_DEBUG_MSG(1,
2232 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002233 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002234 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002235
Jerry Yu0c354a22022-08-29 15:25:36 +08002236 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002237 *
2238 * The "signature_algorithms" extension MUST be specified
2239 */
David Horstmann71159f42023-01-03 12:51:59 +00002240 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2241 MBEDTLS_SSL_DEBUG_MSG(3,
2242 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002243 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002244 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002245
Jerry Yu7840f812022-01-29 10:26:51 +08002246 ssl->handshake->client_auth = 1;
David Horstmann71159f42023-01-03 12:51:59 +00002247 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002248
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002249decode_error:
David Horstmann71159f42023-01-03 12:51:59 +00002250 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2251 MBEDTLS_ERR_SSL_DECODE_ERROR);
2252 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002253}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002254
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002255/*
2256 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2257 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002258MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002259static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002260{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002261 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002262
David Horstmann71159f42023-01-03 12:51:59 +00002263 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002264
David Horstmann71159f42023-01-03 12:51:59 +00002265 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002266
David Horstmann71159f42023-01-03 12:51:59 +00002267 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002268 unsigned char *buf;
2269 size_t buf_len;
2270
David Horstmann71159f42023-01-03 12:51:59 +00002271 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2272 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2273 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002274
David Horstmann71159f42023-01-03 12:51:59 +00002275 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(ssl,
2276 buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002277
David Horstmann71159f42023-01-03 12:51:59 +00002278 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2279 buf, buf_len);
2280 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002281 ret = 0;
David Horstmann71159f42023-01-03 12:51:59 +00002282 } else {
2283 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002284 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2285 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002286 }
2287
David Horstmann71159f42023-01-03 12:51:59 +00002288 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002289
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002290cleanup:
2291
David Horstmann71159f42023-01-03 12:51:59 +00002292 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2293 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002294}
2295
2296/*
Jerry Yu687101b2021-09-14 16:03:56 +08002297 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2298 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002299MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002300static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002301{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002302 int ret;
2303
David Horstmann71159f42023-01-03 12:51:59 +00002304 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2305 if (ret != 0) {
2306 return ret;
2307 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002308
David Horstmann71159f42023-01-03 12:51:59 +00002309 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2310 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002311}
2312
2313/*
2314 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2315 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002316MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002317static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002318{
Jerry Yu30b071c2021-09-12 20:16:03 +08002319 int ret;
2320
David Horstmann71159f42023-01-03 12:51:59 +00002321 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2322 if (ret != 0) {
2323 return ret;
2324 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002325
David Horstmann71159f42023-01-03 12:51:59 +00002326 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2327 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002328}
Ronald Cron928cbd32022-10-04 16:14:26 +02002329#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002330
Jerry Yu687101b2021-09-14 16:03:56 +08002331/*
2332 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2333 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002334MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002335static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002336{
XiaokangQianac0385c2021-11-03 06:40:11 +00002337 int ret;
2338
David Horstmann71159f42023-01-03 12:51:59 +00002339 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2340 if (ret != 0) {
2341 return ret;
2342 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002343
David Horstmann71159f42023-01-03 12:51:59 +00002344 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2345 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002346 MBEDTLS_SSL_PEND_FATAL_ALERT(
David Horstmann71159f42023-01-03 12:51:59 +00002347 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2348 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2349 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002350 }
2351
Ronald Cron49ad6192021-11-24 16:25:31 +01002352#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2353 mbedtls_ssl_handshake_set_state(
2354 ssl,
David Horstmann71159f42023-01-03 12:51:59 +00002355 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
Ronald Cron49ad6192021-11-24 16:25:31 +01002356#else
David Horstmann71159f42023-01-03 12:51:59 +00002357 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Jerry Yu566c7812022-01-26 15:41:22 +08002358#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Ronald Cron49ad6192021-11-24 16:25:31 +01002359
David Horstmann71159f42023-01-03 12:51:59 +00002360 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002361}
2362
2363/*
Jerry Yu566c7812022-01-26 15:41:22 +08002364 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2365 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002366MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002367static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002368{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002369 int non_empty_certificate_msg = 0;
2370
David Horstmann71159f42023-01-03 12:51:59 +00002371 MBEDTLS_SSL_DEBUG_MSG(1,
2372 ("Switch to handshake traffic keys for outbound traffic"));
2373 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002374
Ronald Cron928cbd32022-10-04 16:14:26 +02002375#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
David Horstmann71159f42023-01-03 12:51:59 +00002376 if (ssl->handshake->client_auth) {
2377 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2378 if (ret != 0) {
2379 return ret;
2380 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002381
David Horstmann71159f42023-01-03 12:51:59 +00002382 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002383 non_empty_certificate_msg = 1;
David Horstmann71159f42023-01-03 12:51:59 +00002384 }
2385 } else {
2386 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002387 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002388#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002389
David Horstmann71159f42023-01-03 12:51:59 +00002390 if (non_empty_certificate_msg) {
2391 mbedtls_ssl_handshake_set_state(ssl,
2392 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2393 } else {
2394 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2395 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2396 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002397
David Horstmann71159f42023-01-03 12:51:59 +00002398 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002399}
2400
Ronald Cron928cbd32022-10-04 16:14:26 +02002401#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002402/*
2403 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2404 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002405MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002406static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002407{
David Horstmann71159f42023-01-03 12:51:59 +00002408 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002409
David Horstmann71159f42023-01-03 12:51:59 +00002410 if (ret == 0) {
2411 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2412 }
Ronald Crona8b38872022-03-09 07:59:25 +01002413
David Horstmann71159f42023-01-03 12:51:59 +00002414 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002415}
Ronald Cron928cbd32022-10-04 16:14:26 +02002416#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002417
2418/*
Jerry Yu687101b2021-09-14 16:03:56 +08002419 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2420 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002421MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002422static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002423{
XiaokangQian0fa66432021-11-15 03:33:57 +00002424 int ret;
2425
David Horstmann71159f42023-01-03 12:51:59 +00002426 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2427 if (ret != 0) {
2428 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002429 }
2430
David Horstmann71159f42023-01-03 12:51:59 +00002431 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2432 if (ret != 0) {
2433 MBEDTLS_SSL_DEBUG_RET(1,
2434 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
2435 return ret;
2436 }
2437
2438 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2439 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002440}
2441
2442/*
2443 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2444 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002445MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002446static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002447{
David Horstmann71159f42023-01-03 12:51:59 +00002448 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2449 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2450 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002451}
2452
2453/*
2454 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2455 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002456MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002457static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002458{
Jerry Yu378254d2021-10-30 21:44:47 +08002459
David Horstmann71159f42023-01-03 12:51:59 +00002460 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002461
David Horstmann71159f42023-01-03 12:51:59 +00002462 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2463 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002464}
2465
Jerry Yuf8a49942022-07-07 11:32:32 +00002466#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2467
Jerry Yua0446a02022-07-13 11:22:55 +08002468MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002469static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2470 const unsigned char *buf,
2471 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002472{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002473 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002474 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002475
Jerry Yuf8a49942022-07-07 11:32:32 +00002476
Jerry Yuedab6372022-10-31 14:37:31 +08002477 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002478
David Horstmann71159f42023-01-03 12:51:59 +00002479 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002480 unsigned int extension_type;
2481 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002482 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002483
David Horstmann71159f42023-01-03 12:51:59 +00002484 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2485 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2486 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002487 p += 4;
2488
David Horstmann71159f42023-01-03 12:51:59 +00002489 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002490
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002491 ret = mbedtls_ssl_tls13_check_received_extension(
David Horstmann71159f42023-01-03 12:51:59 +00002492 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2493 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2494 if (ret != 0) {
2495 return ret;
2496 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002497
David Horstmann71159f42023-01-03 12:51:59 +00002498 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002499#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002500 case MBEDTLS_TLS_EXT_EARLY_DATA:
David Horstmann71159f42023-01-03 12:51:59 +00002501 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002502 MBEDTLS_SSL_PEND_FATAL_ALERT(
2503 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
David Horstmann71159f42023-01-03 12:51:59 +00002504 MBEDTLS_ERR_SSL_DECODE_ERROR);
2505 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002506 }
David Horstmann71159f42023-01-03 12:51:59 +00002507 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002508 ssl->session->ticket_flags |=
David Horstmann71159f42023-01-03 12:51:59 +00002509 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002510 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002511 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002512#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002513
Jerry Yuf8a49942022-07-07 11:32:32 +00002514 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002515 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002516 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
David Horstmann71159f42023-01-03 12:51:59 +00002517 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002518 break;
2519 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002520
Jerry Yuf8a49942022-07-07 11:32:32 +00002521 p += extension_data_len;
2522 }
2523
David Horstmann71159f42023-01-03 12:51:59 +00002524 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2525 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002526
David Horstmann71159f42023-01-03 12:51:59 +00002527 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002528}
2529
2530/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002531 * From RFC8446, page 74
2532 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002533 * struct {
2534 * uint32 ticket_lifetime;
2535 * uint32 ticket_age_add;
2536 * opaque ticket_nonce<0..255>;
2537 * opaque ticket<1..2^16-1>;
2538 * Extension extensions<0..2^16-2>;
2539 * } NewSessionTicket;
2540 *
2541 */
Jerry Yua0446a02022-07-13 11:22:55 +08002542MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002543static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2544 unsigned char *buf,
2545 unsigned char *end,
2546 unsigned char **ticket_nonce,
2547 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002548{
2549 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2550 unsigned char *p = buf;
2551 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002552 size_t ticket_len;
2553 unsigned char *ticket;
2554 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002555
Jerry Yucb3b1392022-07-12 06:09:38 +00002556 *ticket_nonce = NULL;
2557 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002558 /*
2559 * ticket_lifetime 4 bytes
2560 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002561 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002562 */
David Horstmann71159f42023-01-03 12:51:59 +00002563 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002564
David Horstmann71159f42023-01-03 12:51:59 +00002565 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2566 MBEDTLS_SSL_DEBUG_MSG(3,
2567 ("ticket_lifetime: %u",
2568 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002569
David Horstmann71159f42023-01-03 12:51:59 +00002570 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2571 MBEDTLS_SSL_DEBUG_MSG(3,
2572 ("ticket_age_add: %u",
2573 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002574
Jerry Yucb3b1392022-07-12 06:09:38 +00002575 *ticket_nonce_len = p[8];
2576 p += 9;
2577
David Horstmann71159f42023-01-03 12:51:59 +00002578 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002579 *ticket_nonce = p;
David Horstmann71159f42023-01-03 12:51:59 +00002580 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002581 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002582
2583 /* Ticket */
David Horstmann71159f42023-01-03 12:51:59 +00002584 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2585 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002586 p += 2;
David Horstmann71159f42023-01-03 12:51:59 +00002587 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2588 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002589
2590 /* Check if we previously received a ticket already. */
David Horstmann71159f42023-01-03 12:51:59 +00002591 if (session->ticket != NULL || session->ticket_len > 0) {
2592 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002593 session->ticket = NULL;
2594 session->ticket_len = 0;
2595 }
2596
David Horstmann71159f42023-01-03 12:51:59 +00002597 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2598 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2599 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002600 }
David Horstmann71159f42023-01-03 12:51:59 +00002601 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002602 p += ticket_len;
2603 session->ticket = ticket;
2604 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002605
David Horstmann71159f42023-01-03 12:51:59 +00002606 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2607 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002608 p += 2;
David Horstmann71159f42023-01-03 12:51:59 +00002609 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002610
David Horstmann71159f42023-01-03 12:51:59 +00002611 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002612
David Horstmann71159f42023-01-03 12:51:59 +00002613 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2614 if (ret != 0) {
2615 MBEDTLS_SSL_DEBUG_RET(1,
2616 "ssl_tls13_parse_new_session_ticket_exts",
2617 ret);
2618 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002619 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002620
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002621 /* session has been updated, allow export */
2622 session->exported = 0;
2623
David Horstmann71159f42023-01-03 12:51:59 +00002624 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002625}
2626
Jerry Yua0446a02022-07-13 11:22:55 +08002627MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002628static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2629 unsigned char *ticket_nonce,
2630 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002631{
2632 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2633 mbedtls_ssl_session *session = ssl->session;
2634 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2635 psa_algorithm_t psa_hash_alg;
2636 int hash_length;
2637
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002638#if defined(MBEDTLS_HAVE_TIME)
2639 /* Store ticket creation time */
David Horstmann71159f42023-01-03 12:51:59 +00002640 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002641#endif
2642
David Horstmann71159f42023-01-03 12:51:59 +00002643 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2644 if (ciphersuite_info == NULL) {
2645 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2646 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002647 }
2648
David Horstmann71159f42023-01-03 12:51:59 +00002649 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2650 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2651 if (hash_length == -1 ||
2652 (size_t) hash_length > sizeof(session->resumption_key)) {
2653 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002654 }
2655
Jerry Yuf8a49942022-07-07 11:32:32 +00002656
David Horstmann71159f42023-01-03 12:51:59 +00002657 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2658 session->app_secrets.resumption_master_secret,
2659 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002660
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002661 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002662 *
2663 * HKDF-Expand-Label( resumption_master_secret,
2664 * "resumption", ticket_nonce, Hash.length )
2665 */
2666 ret = mbedtls_ssl_tls13_hkdf_expand_label(
David Horstmann71159f42023-01-03 12:51:59 +00002667 psa_hash_alg,
2668 session->app_secrets.resumption_master_secret,
2669 hash_length,
2670 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2671 ticket_nonce,
2672 ticket_nonce_len,
2673 session->resumption_key,
2674 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002675
David Horstmann71159f42023-01-03 12:51:59 +00002676 if (ret != 0) {
2677 MBEDTLS_SSL_DEBUG_RET(2,
2678 "Creating the ticket-resumed PSK failed",
2679 ret);
2680 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002681 }
2682
Jerry Yu0a430c82022-07-20 11:02:48 +08002683 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002684
David Horstmann71159f42023-01-03 12:51:59 +00002685 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2686 session->resumption_key,
2687 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002688
David Horstmann71159f42023-01-03 12:51:59 +00002689 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002690}
2691
2692/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002693 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002694 */
Jerry Yua0446a02022-07-13 11:22:55 +08002695MBEDTLS_CHECK_RETURN_CRITICAL
David Horstmann71159f42023-01-03 12:51:59 +00002696static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002697{
2698 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2699 unsigned char *buf;
2700 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002701 unsigned char *ticket_nonce;
2702 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002703
David Horstmann71159f42023-01-03 12:51:59 +00002704 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002705
David Horstmann71159f42023-01-03 12:51:59 +00002706 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2707 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2708 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002709
David Horstmann71159f42023-01-03 12:51:59 +00002710 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2711 ssl, buf, buf + buf_len,
2712 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002713
David Horstmann71159f42023-01-03 12:51:59 +00002714 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2715 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002716
David Horstmann71159f42023-01-03 12:51:59 +00002717 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002718
Jerry Yuf8a49942022-07-07 11:32:32 +00002719cleanup:
2720
David Horstmann71159f42023-01-03 12:51:59 +00002721 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2722 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002723}
2724#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2725
David Horstmann71159f42023-01-03 12:51:59 +00002726int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002727{
Jerry Yu92c6b402021-08-27 16:59:09 +08002728 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002729
David Horstmann71159f42023-01-03 12:51:59 +00002730 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002731 /*
Jerry Yu0c63af62021-09-02 12:59:12 +08002732 * ssl->state is initialized as HELLO_REQUEST. It is the same
2733 * as CLIENT_HELLO state.
Jerry Yu92c6b402021-08-27 16:59:09 +08002734 */
2735 case MBEDTLS_SSL_HELLO_REQUEST:
2736 case MBEDTLS_SSL_CLIENT_HELLO:
David Horstmann71159f42023-01-03 12:51:59 +00002737 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002738 break;
2739
2740 case MBEDTLS_SSL_SERVER_HELLO:
David Horstmann71159f42023-01-03 12:51:59 +00002741 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002742 break;
2743
2744 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
David Horstmann71159f42023-01-03 12:51:59 +00002745 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002746 break;
2747
Ronald Cron928cbd32022-10-04 16:14:26 +02002748#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002749 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
David Horstmann71159f42023-01-03 12:51:59 +00002750 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002751 break;
2752
Jerry Yu687101b2021-09-14 16:03:56 +08002753 case MBEDTLS_SSL_SERVER_CERTIFICATE:
David Horstmann71159f42023-01-03 12:51:59 +00002754 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002755 break;
2756
2757 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
David Horstmann71159f42023-01-03 12:51:59 +00002758 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002759 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002760#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002761
2762 case MBEDTLS_SSL_SERVER_FINISHED:
David Horstmann71159f42023-01-03 12:51:59 +00002763 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002764 break;
2765
Jerry Yu566c7812022-01-26 15:41:22 +08002766 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
David Horstmann71159f42023-01-03 12:51:59 +00002767 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002768 break;
2769
Ronald Cron928cbd32022-10-04 16:14:26 +02002770#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002771 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
David Horstmann71159f42023-01-03 12:51:59 +00002772 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002773 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002774#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002775
Jerry Yu687101b2021-09-14 16:03:56 +08002776 case MBEDTLS_SSL_CLIENT_FINISHED:
David Horstmann71159f42023-01-03 12:51:59 +00002777 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002778 break;
2779
2780 case MBEDTLS_SSL_FLUSH_BUFFERS:
David Horstmann71159f42023-01-03 12:51:59 +00002781 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002782 break;
2783
2784 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
David Horstmann71159f42023-01-03 12:51:59 +00002785 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002786 break;
2787
David Horstmann71159f42023-01-03 12:51:59 +00002788 /*
2789 * Injection of dummy-CCS's for middlebox compatibility
2790 */
Ronald Cron49ad6192021-11-24 16:25:31 +01002791#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002792 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
David Horstmann71159f42023-01-03 12:51:59 +00002793 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2794 if (ret == 0) {
2795 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2796 }
Ronald Cron9f55f632022-02-02 16:02:47 +01002797 break;
2798
2799 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
David Horstmann71159f42023-01-03 12:51:59 +00002800 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2801 if (ret == 0) {
2802 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2803 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002804 break;
2805#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2806
Jerry Yuf8a49942022-07-07 11:32:32 +00002807#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08002808 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
David Horstmann71159f42023-01-03 12:51:59 +00002809 ret = ssl_tls13_process_new_session_ticket(ssl);
2810 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002811 break;
David Horstmann71159f42023-01-03 12:51:59 +00002812 }
Jerry Yuf8a49942022-07-07 11:32:32 +00002813 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
2814 break;
2815#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2816
Jerry Yu92c6b402021-08-27 16:59:09 +08002817 default:
David Horstmann71159f42023-01-03 12:51:59 +00002818 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
2819 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08002820 }
2821
David Horstmann71159f42023-01-03 12:51:59 +00002822 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08002823}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002824
Jerry Yufb4b6472022-01-27 15:03:26 +08002825#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */