blob: 17c1baecf79e956ab58178948245c26cd532a706 [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
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050037#define PSA_TO_MBEDTLS_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
38 psa_to_ssl_errors, \
39 psa_generic_status_to_mbedtls)
40
Jerry Yubc20bdd2021-08-24 15:59:48 +080041/* Write extensions */
42
Jerry Yu92c6b402021-08-27 16:59:09 +080043/*
44 * ssl_tls13_write_supported_versions_ext():
45 *
46 * struct {
47 * ProtocolVersion versions<2..254>;
48 * } SupportedVersions;
49 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020050MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010051static int ssl_tls13_write_supported_versions_ext(mbedtls_ssl_context *ssl,
52 unsigned char *buf,
53 unsigned char *end,
54 size_t *out_len)
Jerry Yu92c6b402021-08-27 16:59:09 +080055{
56 unsigned char *p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +010057 unsigned char versions_len = (ssl->handshake->min_tls_version <=
58 MBEDTLS_SSL_VERSION_TLS1_2) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080059
Xiaofei Baid25fab62021-12-02 06:36:27 +000060 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080061
Gilles Peskine449bd832023-01-11 14:50:10 +010062 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding supported versions extension"));
Jerry Yu92c6b402021-08-27 16:59:09 +080063
Jerry Yu388bd0d2021-09-15 18:41:02 +080064 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080065 * - extension_type (2 bytes)
66 * - extension_data_length (2 bytes)
67 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020068 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080069 */
Gilles Peskine449bd832023-01-11 14:50:10 +010070 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 5 + versions_len);
Ronald Crondbe87f02022-02-10 14:35:27 +010071
Gilles Peskine449bd832023-01-11 14:50:10 +010072 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0);
73 MBEDTLS_PUT_UINT16_BE(versions_len + 1, p, 2);
Jerry Yueecfbf02021-08-30 18:32:07 +080074 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080075
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080076 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010077 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080078
Jerry Yu0c63af62021-09-02 12:59:12 +080079 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080080 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010081 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080082 */
Gilles Peskine449bd832023-01-11 14:50:10 +010083 mbedtls_ssl_write_version(p, MBEDTLS_SSL_TRANSPORT_STREAM,
84 MBEDTLS_SSL_VERSION_TLS1_3);
85 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:4]"));
Jerry Yu92c6b402021-08-27 16:59:09 +080086
Jerry Yu92c6b402021-08-27 16:59:09 +080087
Gilles Peskine449bd832023-01-11 14:50:10 +010088 if (ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
89 mbedtls_ssl_write_version(p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
90 MBEDTLS_SSL_VERSION_TLS1_2);
91 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:3]"));
Ronald Crondbe87f02022-02-10 14:35:27 +010092 }
93
94 *out_len = 5 + versions_len;
Jerry Yu4b8f2f72022-10-31 13:31:22 +080095
Jerry Yuc4bf5d62022-10-29 09:08:47 +080096 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +010097 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yu4b8f2f72022-10-31 13:31:22 +080098
Gilles Peskine449bd832023-01-11 14:50:10 +010099 return 0;
Jerry Yu92c6b402021-08-27 16:59:09 +0800100}
Jerry Yubc20bdd2021-08-24 15:59:48 +0800101
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200102MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100103static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
104 const unsigned char *buf,
105 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800106{
Jerry Yue1b9c292021-09-10 10:08:31 +0800107 ((void) ssl);
108
Gilles Peskine449bd832023-01-11 14:50:10 +0100109 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
110 if (mbedtls_ssl_read_version(buf, ssl->conf->transport) !=
111 MBEDTLS_SSL_VERSION_TLS1_3) {
112 MBEDTLS_SSL_DEBUG_MSG(1, ("unexpected version"));
Jerry Yu4a173382021-10-11 21:45:31 +0800113
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
115 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
116 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +0800117 }
118
Gilles Peskine449bd832023-01-11 14:50:10 +0100119 if (&buf[2] != end) {
120 MBEDTLS_SSL_DEBUG_MSG(1, ("supported_versions ext data length incorrect"));
121 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
122 MBEDTLS_ERR_SSL_DECODE_ERROR);
123 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Ronald Cron98473382022-03-30 20:04:10 +0200124 }
125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +0800127}
128
lhuang0486cacac2022-01-21 07:34:27 -0800129#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200130MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100131static int ssl_tls13_parse_alpn_ext(mbedtls_ssl_context *ssl,
132 const unsigned char *buf, size_t len)
lhuang0486cacac2022-01-21 07:34:27 -0800133{
lhuang0486cacac2022-01-21 07:34:27 -0800134 const unsigned char *p = buf;
135 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200136 size_t protocol_name_list_len, protocol_name_len;
137 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800138
139 /* If we didn't send it, the server shouldn't send it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 if (ssl->conf->alpn_list == NULL) {
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
142 }
lhuang0486cacac2022-01-21 07:34:27 -0800143
144 /*
145 * opaque ProtocolName<1..2^8-1>;
146 *
147 * struct {
148 * ProtocolName protocol_name_list<2..2^16-1>
149 * } ProtocolNameList;
150 *
151 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
152 */
153
Gilles Peskine449bd832023-01-11 14:50:10 +0100154 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
155 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
lhuang0486cacac2022-01-21 07:34:27 -0800156 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800157
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
Ronald Cron81a334f2022-05-31 16:04:11 +0200159 protocol_name_list_end = p + protocol_name_list_len;
160
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, 1);
Ronald Cron81a334f2022-05-31 16:04:11 +0200162 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800163
164 /* Check that the server chosen protocol was in our list and save it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100165 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, protocol_name_len);
166 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
167 if (protocol_name_len == strlen(*alpn) &&
168 memcmp(p, *alpn, protocol_name_len) == 0) {
lhuang0486cacac2022-01-21 07:34:27 -0800169 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 return 0;
lhuang0486cacac2022-01-21 07:34:27 -0800171 }
172 }
173
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
lhuang0486cacac2022-01-21 07:34:27 -0800175}
176#endif /* MBEDTLS_SSL_ALPN */
177
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200178MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100179static int ssl_tls13_reset_key_share(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +0000180{
181 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 if (group_id == 0) {
184 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
185 }
XiaokangQian647719a2021-12-07 09:16:29 +0000186
XiaokangQian355e09a2022-01-20 11:14:50 +0000187#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100188 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100189 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
190 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
191
192 /* Destroy generated private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 status = psa_destroy_key(ssl->handshake->ecdh_psa_privkey);
194 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500195 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 MBEDTLS_SSL_DEBUG_RET(1, "psa_destroy_key", ret);
197 return ret;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100198 }
199
200 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100201 return 0;
202 } else
XiaokangQian355e09a2022-01-20 11:14:50 +0000203#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 if (0 /* other KEMs? */) {
XiaokangQian647719a2021-12-07 09:16:29 +0000205 /* Do something */
206 }
207
Gilles Peskine449bd832023-01-11 14:50:10 +0100208 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQian647719a2021-12-07 09:16:29 +0000209}
210
211/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800212 * Functions for writing key_share extension.
213 */
Ronald Cron766c0cd2022-10-18 12:17:11 +0200214#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200215MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100216static int ssl_tls13_get_default_group_id(mbedtls_ssl_context *ssl,
217 uint16_t *group_id)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800218{
219 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
220
Jerry Yu56fc07f2021-09-01 17:48:49 +0800221
Jerry Yu56fc07f2021-09-01 17:48:49 +0800222#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100223 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Jerry Yu388bd0d2021-09-15 18:41:02 +0800224 /* Pick first available ECDHE group compatible with TLS 1.3 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 if (group_list == NULL) {
226 return MBEDTLS_ERR_SSL_BAD_CONFIG;
227 }
Jerry Yu388bd0d2021-09-15 18:41:02 +0800228
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 for (; *group_list != 0; group_list++) {
230 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(*group_list,
231 NULL, NULL) == PSA_SUCCESS) &&
232 mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
Brett Warren14efd332021-10-06 09:32:11 +0100233 *group_id = *group_list;
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 return 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800235 }
236 }
237#else
238 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800239 ((void) group_id);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800240#endif /* MBEDTLS_ECDH_C */
241
242 /*
243 * Add DHE named groups here.
Jerry Yu388bd0d2021-09-15 18:41:02 +0800244 * Pick first available DHE group compatible with TLS 1.3
Jerry Yu56fc07f2021-09-01 17:48:49 +0800245 */
246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800248}
249
250/*
251 * ssl_tls13_write_key_share_ext
252 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800253 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800254 *
255 * struct {
256 * NamedGroup group;
257 * opaque key_exchange<1..2^16-1>;
258 * } KeyShareEntry;
259 * struct {
260 * KeyShareEntry client_shares<0..2^16-1>;
261 * } KeyShareClientHello;
262 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200263MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100264static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
265 unsigned char *buf,
266 unsigned char *end,
267 size_t *out_len)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800268{
269 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000270 unsigned char *client_shares; /* Start of client_shares */
271 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800272 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800273 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
274
Xiaofei Baid25fab62021-12-02 06:36:27 +0000275 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800276
Jerry Yub60e3cf2021-09-08 16:41:02 +0800277 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800278 * - extension_type (2 bytes)
279 * - extension_data_length (2 bytes)
280 * - client_shares_length (2 bytes)
281 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100282 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800283 p += 6;
284
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello: adding key share extension"));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800286
287 /* HRR could already have requested something else. */
288 group_id = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (!mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) &&
290 !mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
291 MBEDTLS_SSL_PROC_CHK(ssl_tls13_get_default_group_id(ssl,
292 &group_id));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800293 }
294
295 /*
296 * Dispatch to type-specific key generation function.
297 *
298 * So far, we're only supporting ECDHE. With the introduction
299 * of PQC KEMs, we'll want to have multiple branches, one per
300 * type of KEM, and dispatch to the corresponding crypto. And
301 * only one key share entry is allowed.
302 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000303 client_shares = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800304#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800306 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000307 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800308 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100309 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800310
311 /* Check there is space for header of KeyShareEntry
312 * - group (2 bytes)
313 * - key_exchange_length (2 bytes)
314 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800316 p += 4;
Jerry Yu89e103c2022-03-30 22:43:29 +0800317 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 ssl, group_id, p, end, &key_exchange_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800319 p += key_exchange_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 if (ret != 0) {
321 return ret;
322 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800323
324 /* Write group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 MBEDTLS_PUT_UINT16_BE(group_id, group, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800326 /* Write key_exchange_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 MBEDTLS_PUT_UINT16_BE(key_exchange_len, group, 2);
328 } else
Jerry Yu56fc07f2021-09-01 17:48:49 +0800329#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 if (0 /* other KEMs? */) {
Jerry Yu56fc07f2021-09-01 17:48:49 +0800331 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 } else {
333 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800334 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800335
Jerry Yub60e3cf2021-09-08 16:41:02 +0800336 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000337 client_shares_len = p - client_shares;
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 if (client_shares_len == 0) {
339 MBEDTLS_SSL_DEBUG_MSG(1, ("No key share defined."));
340 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu7c522d42021-09-08 17:55:09 +0800341 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800342 /* Write extension_type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800344 /* Write extension_data_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 MBEDTLS_PUT_UINT16_BE(client_shares_len + 2, buf, 2);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800346 /* Write client_shares_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 MBEDTLS_PUT_UINT16_BE(client_shares_len, buf, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800348
349 /* Update offered_group_id field */
350 ssl->handshake->offered_group_id = group_id;
351
352 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000353 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800354
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, key_share extension", buf, *out_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800356
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800358
359cleanup:
360
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800362}
Ronald Cron766c0cd2022-10-18 12:17:11 +0200363#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +0800364
XiaokangQiand59be772022-01-24 10:12:51 +0000365/*
366 * ssl_tls13_parse_hrr_key_share_ext()
367 * Parse key_share extension in Hello Retry Request
368 *
369 * struct {
370 * NamedGroup selected_group;
371 * } KeyShareHelloRetryRequest;
372 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200373MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100374static int ssl_tls13_parse_hrr_key_share_ext(mbedtls_ssl_context *ssl,
375 const unsigned char *buf,
376 const unsigned char *end)
XiaokangQianb851da82022-01-14 04:03:11 +0000377{
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400378#if defined(MBEDTLS_ECDH_C)
XiaokangQianb851da82022-01-14 04:03:11 +0000379 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000380 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000381 int found = 0;
382
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
384 if (group_list == NULL) {
385 return MBEDTLS_ERR_SSL_BAD_CONFIG;
386 }
XiaokangQianb851da82022-01-14 04:03:11 +0000387
Gilles Peskine449bd832023-01-11 14:50:10 +0100388 MBEDTLS_SSL_DEBUG_BUF(3, "key_share extension", p, end - buf);
XiaokangQianb851da82022-01-14 04:03:11 +0000389
390 /* Read selected_group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100391 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
392 selected_group = MBEDTLS_GET_UINT16_BE(p, 0);
393 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_group ( %d )", selected_group));
XiaokangQianb851da82022-01-14 04:03:11 +0000394
395 /* Upon receipt of this extension in a HelloRetryRequest, the client
396 * MUST first verify that the selected_group field corresponds to a
397 * group which was provided in the "supported_groups" extension in the
398 * original ClientHello.
399 * The supported_group was based on the info in ssl->conf->group_list.
400 *
401 * If the server provided a key share that was not sent in the ClientHello
402 * then the client MUST abort the handshake with an "illegal_parameter" alert.
403 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 for (; *group_list != 0; group_list++) {
405 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(*group_list,
406 NULL, NULL) == PSA_ERROR_NOT_SUPPORTED) ||
407 *group_list != selected_group) {
XiaokangQianb851da82022-01-14 04:03:11 +0000408 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 }
XiaokangQianb851da82022-01-14 04:03:11 +0000410
411 /* We found a match */
412 found = 1;
413 break;
414 }
415
416 /* Client MUST verify that the selected_group field does not
417 * correspond to a group which was provided in the "key_share"
418 * extension in the original ClientHello. If the server sent an
419 * HRR message with a key share already provided in the
420 * ClientHello then the client MUST abort the handshake with
421 * an "illegal_parameter" alert.
422 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 if (found == 0 || selected_group == ssl->handshake->offered_group_id) {
424 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid key share in HRR"));
XiaokangQianb851da82022-01-14 04:03:11 +0000425 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
427 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
428 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQianb851da82022-01-14 04:03:11 +0000429 }
430
431 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000432 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000433
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 return 0;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400435#else
436 (void) ssl;
437 (void) buf;
438 (void) end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400440#endif
XiaokangQianb851da82022-01-14 04:03:11 +0000441}
442
Jerry Yue1b9c292021-09-10 10:08:31 +0800443/*
Jerry Yub85277e2021-10-13 13:36:05 +0800444 * ssl_tls13_parse_key_share_ext()
445 * Parse key_share extension in Server Hello
446 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800447 * struct {
448 * KeyShareEntry server_share;
449 * } KeyShareServerHello;
450 * struct {
451 * NamedGroup group;
452 * opaque key_exchange<1..2^16-1>;
453 * } KeyShareEntry;
454 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200455MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100456static int ssl_tls13_parse_key_share_ext(mbedtls_ssl_context *ssl,
457 const unsigned char *buf,
458 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800459{
Jerry Yub85277e2021-10-13 13:36:05 +0800460 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800461 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800462 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800463
Jerry Yu4a173382021-10-11 21:45:31 +0800464 /* ...
465 * NamedGroup group; (2 bytes)
466 * ...
467 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
469 group = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +0800470 p += 2;
471
Jerry Yu4a173382021-10-11 21:45:31 +0800472 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800473 offered_group = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 if (offered_group != group) {
475 MBEDTLS_SSL_DEBUG_MSG(1,
476 ("Invalid server key share, our group %u, their group %u",
477 (unsigned) offered_group, (unsigned) group));
478 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
479 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
480 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yue1b9c292021-09-10 10:08:31 +0800481 }
482
483#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
485 if (mbedtls_ssl_get_psa_curve_info_from_tls_id(group, NULL, NULL)
486 == PSA_ERROR_NOT_SUPPORTED) {
487 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid TLS curve group id"));
488 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH curve: %s",
492 mbedtls_ssl_get_curve_name_from_tls_id(group)));
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100493
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(ssl, p, end - p);
495 if (ret != 0) {
496 return ret;
497 }
498 } else
Jerry Yue1b9c292021-09-10 10:08:31 +0800499#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100500 if (0 /* other KEMs? */) {
Jerry Yue1b9c292021-09-10 10:08:31 +0800501 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 } else {
503 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yue1b9c292021-09-10 10:08:31 +0800504 }
Jerry Yue1b9c292021-09-10 10:08:31 +0800505
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +0800507}
508
XiaokangQiand59be772022-01-24 10:12:51 +0000509/*
510 * ssl_tls13_parse_cookie_ext()
511 * Parse cookie extension in Hello Retry Request
512 *
513 * struct {
514 * opaque cookie<1..2^16-1>;
515 * } Cookie;
516 *
517 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
518 * extension to the client (this is an exception to the usual rule that
519 * the only extensions that may be sent are those that appear in the
520 * ClientHello). When sending the new ClientHello, the client MUST copy
521 * the contents of the extension received in the HelloRetryRequest into
522 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
523 * cookies in their initial ClientHello in subsequent connections.
524 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200525MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100526static int ssl_tls13_parse_cookie_ext(mbedtls_ssl_context *ssl,
527 const unsigned char *buf,
528 const unsigned char *end)
XiaokangQian43550bd2022-01-21 04:32:58 +0000529{
XiaokangQian25c9c902022-02-08 10:49:53 +0000530 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000531 const unsigned char *p = buf;
532 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
533
534 /* Retrieve length field of cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
536 cookie_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian43550bd2022-01-21 04:32:58 +0000537 p += 2;
538
Gilles Peskine449bd832023-01-11 14:50:10 +0100539 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cookie_len);
540 MBEDTLS_SSL_DEBUG_BUF(3, "cookie extension", p, cookie_len);
XiaokangQian43550bd2022-01-21 04:32:58 +0000541
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 mbedtls_free(handshake->cookie);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800543 handshake->cookie_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 handshake->cookie = mbedtls_calloc(1, cookie_len);
545 if (handshake->cookie == NULL) {
546 MBEDTLS_SSL_DEBUG_MSG(1,
547 ("alloc failed ( %ud bytes )",
548 cookie_len));
549 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
XiaokangQian43550bd2022-01-21 04:32:58 +0000550 }
551
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 memcpy(handshake->cookie, p, cookie_len);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800553 handshake->cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000554
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return 0;
XiaokangQian43550bd2022-01-21 04:32:58 +0000556}
XiaokangQian43550bd2022-01-21 04:32:58 +0000557
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200558MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100559static int ssl_tls13_write_cookie_ext(mbedtls_ssl_context *ssl,
560 unsigned char *buf,
561 unsigned char *end,
562 size_t *out_len)
XiaokangQian0b64eed2022-01-27 10:36:51 +0000563{
564 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000565 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000566 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000567
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 if (handshake->cookie == NULL) {
569 MBEDTLS_SSL_DEBUG_MSG(3, ("no cookie to send; skip extension"));
570 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000571 }
572
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, cookie",
574 handshake->cookie,
575 handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000576
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 MBEDTLS_SSL_CHK_BUF_PTR(p, end, handshake->cookie_len + 6);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000578
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding cookie extension"));
XiaokangQian0b64eed2022-01-27 10:36:51 +0000580
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_COOKIE, p, 0);
582 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len + 2, p, 2);
583 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len, p, 4);
XiaokangQian233397e2022-02-07 08:32:16 +0000584 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000585
586 /* Cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 memcpy(p, handshake->cookie, handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000588
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800589 *out_len = handshake->cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000590
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_COOKIE);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800592
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000594}
595
Ronald Cron41a443a2022-10-04 16:38:25 +0200596#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000597/*
598 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
599 *
600 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
601 *
602 * struct {
603 * PskKeyExchangeMode ke_modes<1..255>;
604 * } PskKeyExchangeModes;
605 */
XiaokangQian86981952022-07-19 09:51:50 +0000606MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100607static int ssl_tls13_write_psk_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
608 unsigned char *buf,
609 unsigned char *end,
610 size_t *out_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000611{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000612 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000613 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000614
Gilles Peskine449bd832023-01-11 14:50:10 +0100615 ((void) ke_modes_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000616 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000617
XiaokangQianeb69aee2022-07-05 08:21:43 +0000618 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000619 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000620 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 if (!mbedtls_ssl_conf_tls13_some_psk_enabled(ssl)) {
622 MBEDTLS_SSL_DEBUG_MSG(3, ("skip psk_key_exchange_modes extension"));
623 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000624 }
625
626 /* Require 7 bytes of data, otherwise fail,
627 * even if extension might be shorter.
628 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000630 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100631 3, ("client hello, adding psk_key_exchange_modes extension"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000632
Gilles Peskine449bd832023-01-11 14:50:10 +0100633 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000634
XiaokangQian008d2bf2022-07-14 07:54:01 +0000635 /* Skip extension length (2 bytes) and
636 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000637 */
638 p += 5;
639
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 if (mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl)) {
XiaokangQianeb69aee2022-07-05 08:21:43 +0000641 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000642 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000643
Gilles Peskine449bd832023-01-11 14:50:10 +0100644 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding PSK-ECDHE key exchange mode"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000645 }
646
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 if (mbedtls_ssl_conf_tls13_psk_enabled(ssl)) {
Ronald Crona709a0f2022-09-27 16:46:11 +0200648 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
649 ke_modes_len++;
650
Gilles Peskine449bd832023-01-11 14:50:10 +0100651 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding pure PSK key exchange mode"));
Ronald Crona709a0f2022-09-27 16:46:11 +0200652 }
653
XiaokangQian008d2bf2022-07-14 07:54:01 +0000654 /* Now write the extension and ke_modes length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100655 MBEDTLS_PUT_UINT16_BE(ke_modes_len + 1, buf, 2);
XiaokangQian008d2bf2022-07-14 07:54:01 +0000656 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000657
658 *out_len = p - buf;
Jerry Yu0c354a22022-08-29 15:25:36 +0800659
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800660 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100661 ssl, MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800662
Gilles Peskine449bd832023-01-11 14:50:10 +0100663 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000664}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800665
Gilles Peskine449bd832023-01-11 14:50:10 +0100666static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg(int ciphersuite)
Jerry Yuf7c12592022-09-28 22:09:38 +0800667{
Jerry Yu21f90952022-10-08 10:30:53 +0800668 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100669 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 if (ciphersuite_info != NULL) {
672 return mbedtls_psa_translate_md(ciphersuite_info->mac);
673 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800674
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 return PSA_ALG_NONE;
Jerry Yuf7c12592022-09-28 22:09:38 +0800676}
677
Jerry Yuf75364b2022-09-30 10:30:31 +0800678#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100679static int ssl_tls13_has_configured_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qianb781a232022-11-01 07:39:46 +0000680{
681 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return ssl->handshake->resume &&
Pengyu Lv93566782022-12-07 12:10:05 +0800683 session != NULL && session->ticket != NULL &&
Pengyu Lv9b84ea72023-01-16 14:08:23 +0800684 mbedtls_ssl_conf_tls13_check_kex_modes(
685 ssl, mbedtls_ssl_session_get_ticket_flags(
686 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL));
Xiaokang Qianb781a232022-11-01 07:39:46 +0000687}
688
Xiaokang Qian01323a42022-11-03 02:27:35 +0000689#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100690static int ssl_tls13_early_data_has_valid_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qian01323a42022-11-03 02:27:35 +0000691{
692 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return ssl->handshake->resume &&
694 session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
695 (session->ticket_flags &
696 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) &&
697 mbedtls_ssl_tls13_cipher_suite_is_offered(
698 ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000699}
700#endif
701
Xiaokang Qianb781a232022-11-01 07:39:46 +0000702MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100703static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
704 psa_algorithm_t *hash_alg,
705 const unsigned char **identity,
706 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800707{
708 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800709
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (!ssl_tls13_has_configured_ticket(ssl)) {
711 return -1;
712 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800713
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800715 *identity = session->ticket;
716 *identity_len = session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800718}
719
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800720MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100721static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
722 psa_algorithm_t *hash_alg,
723 const unsigned char **psk,
724 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800725{
726
727 mbedtls_ssl_session *session = ssl->session_negotiate;
728
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 if (!ssl_tls13_has_configured_ticket(ssl)) {
730 return -1;
731 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800732
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800734 *psk = session->resumption_key;
735 *psk_len = session->resumption_key_len;
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800738}
Jerry Yuf7c12592022-09-28 22:09:38 +0800739#endif /* MBEDTLS_SSL_SESSION_TICKETS */
740
741MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100742static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
743 psa_algorithm_t *hash_alg,
744 const unsigned char **identity,
745 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800746{
Jerry Yu8b41e892022-09-30 10:00:20 +0800747
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
749 return -1;
750 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800751
Jerry Yua99cbfa2022-10-08 11:17:14 +0800752 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800753 *identity = ssl->conf->psk_identity;
754 *identity_len = ssl->conf->psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800756}
757
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800758MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100759static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
760 psa_algorithm_t *hash_alg,
761 const unsigned char **psk,
762 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800763{
Jerry Yu8b41e892022-09-30 10:00:20 +0800764
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
766 return -1;
767 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800768
Jerry Yua99cbfa2022-10-08 11:17:14 +0800769 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800770 *psk = ssl->conf->psk;
771 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100772 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800773}
774
Gilles Peskine449bd832023-01-11 14:50:10 +0100775static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800776{
777 int configured_psk_count = 0;
778#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 if (ssl_tls13_has_configured_ticket(ssl)) {
780 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800781 configured_psk_count++;
782 }
783#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
785 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800786 configured_psk_count++;
787 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800789}
790
Jerry Yuf7c12592022-09-28 22:09:38 +0800791MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100792static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
793 unsigned char *buf,
794 unsigned char *end,
795 const unsigned char *identity,
796 size_t identity_len,
797 uint32_t obfuscated_ticket_age,
798 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800799{
Jerry Yuf75364b2022-09-30 10:30:31 +0800800 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800801 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800802
803 /*
804 * - identity_len (2 bytes)
805 * - identity (psk_identity_len bytes)
806 * - obfuscated_ticket_age (4 bytes)
807 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800809
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
811 memcpy(buf + 2, identity, identity_len);
812 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800813
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800815
816 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800817
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800819}
820
Jerry Yu8b41e892022-09-30 10:00:20 +0800821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100822static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
823 unsigned char *buf,
824 unsigned char *end,
825 int psk_type,
826 psa_algorithm_t hash_alg,
827 const unsigned char *psk,
828 size_t psk_len,
829 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800830{
831 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800832 unsigned char binder_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100833 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800834 size_t transcript_len = 0;
835
836 *out_len = 0;
837
Gilles Peskine449bd832023-01-11 14:50:10 +0100838 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800839
840 /*
841 * - binder_len (1 bytes)
842 * - binder (binder_len bytes)
843 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800845
Jerry Yua99cbfa2022-10-08 11:17:14 +0800846 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800847
848 /* Get current state of handshake transcript. */
849 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 ssl, mbedtls_hash_info_md_from_psa(hash_alg),
851 transcript, sizeof(transcript), &transcript_len);
852 if (ret != 0) {
853 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800854 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100855
856 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
857 psk, psk_len, psk_type,
858 transcript, buf + 1);
859 if (ret != 0) {
860 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
861 return ret;
862 }
863 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800864
865 *out_len = 1 + binder_len;
866
Gilles Peskine449bd832023-01-11 14:50:10 +0100867 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800868}
869
870/*
871 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
872 *
873 * struct {
874 * opaque identity<1..2^16-1>;
875 * uint32 obfuscated_ticket_age;
876 * } PskIdentity;
877 *
878 * opaque PskBinderEntry<32..255>;
879 *
880 * struct {
881 * PskIdentity identities<7..2^16-1>;
882 * PskBinderEntry binders<33..2^16-1>;
883 * } OfferedPsks;
884 *
885 * struct {
886 * select (Handshake.msg_type) {
887 * case client_hello: OfferedPsks;
888 * ...
889 * };
890 * } PreSharedKeyExtension;
891 *
892 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000893int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100894 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
895 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000896{
Jerry Yuf7c12592022-09-28 22:09:38 +0800897 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800898 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800899 unsigned char *p = buf;
Xiaokang Qian854db282022-12-19 07:31:27 +0000900 psa_algorithm_t hash_alg = PSA_ALG_NONE;
Jerry Yuf75364b2022-09-30 10:30:31 +0800901 const unsigned char *identity;
902 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800903 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800904 size_t output_len;
Xiaokang Qian7179f812023-02-03 03:38:44 +0000905
Jerry Yuf7c12592022-09-28 22:09:38 +0800906 *out_len = 0;
907 *binders_len = 0;
908
909 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Gilles Peskine449bd832023-01-11 14:50:10 +0100910 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
911 if (configured_psk_count == 0) {
912 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
913 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800914 }
915
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
917 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800918
Jerry Yuf7c12592022-09-28 22:09:38 +0800919 /* Check if we have space to write the extension, binders included.
920 * - extension_type (2 bytes)
921 * - extension_data_len (2 bytes)
922 * - identities_len (2 bytes)
923 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800925 p += 6;
926
Jerry Yuf75364b2022-09-30 10:30:31 +0800927#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 if (ssl_tls13_ticket_get_identity(
929 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800930#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 mbedtls_time_t now = mbedtls_time(NULL);
Jerry Yuf75364b2022-09-30 10:30:31 +0800932 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800933 uint32_t obfuscated_ticket_age =
Gilles Peskine449bd832023-01-11 14:50:10 +0100934 (uint32_t) (now - session->ticket_received);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800935
Jerry Yu3e60cad2023-01-10 14:58:08 +0800936 /*
937 * The ticket timestamp is in seconds but the ticket age is in
938 * milliseconds. If the ticket was received at the end of a second and
939 * re-used here just at the beginning of the next second, the computed
940 * age `now - session->ticket_received` is equal to 1s thus 1000 ms
941 * while the actual age could be just a few milliseconds or tens of
942 * milliseconds. If the server has more accurate ticket timestamps
943 * (typically timestamps in milliseconds), as part of the processing of
944 * the ClientHello, it may compute a ticket lifetime smaller than the
945 * one computed here and potentially reject the ticket. To avoid that,
946 * remove one second to the ticket age if possible.
Jerry Yubdb936b2023-01-07 16:07:46 +0800947 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 if (obfuscated_ticket_age > 0) {
Jerry Yubdb936b2023-01-07 16:07:46 +0800949 obfuscated_ticket_age -= 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 }
Jerry Yubdb936b2023-01-07 16:07:46 +0800951
Jerry Yuf75364b2022-09-30 10:30:31 +0800952 obfuscated_ticket_age *= 1000;
953 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800954
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 ret = ssl_tls13_write_identity(ssl, p, end,
956 identity, identity_len,
957 obfuscated_ticket_age,
958 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800959#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
961 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800962#endif /* MBEDTLS_HAVE_TIME */
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 if (ret != 0) {
964 return ret;
965 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800966
Jerry Yuf75364b2022-09-30 10:30:31 +0800967 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +0800969 }
970#endif /* MBEDTLS_SSL_SESSION_TICKETS */
971
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 if (ssl_tls13_psk_get_identity(
973 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800974
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
976 &output_len);
977 if (ret != 0) {
978 return ret;
979 }
Jerry Yuf75364b2022-09-30 10:30:31 +0800980
Jerry Yuf7c12592022-09-28 22:09:38 +0800981 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +0800983 }
984
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 MBEDTLS_SSL_DEBUG_MSG(3,
986 ("client hello, adding pre_shared_key extension, "
987 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +0800988
989 /* Take into account the two bytes for the length of the binders. */
990 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800991 /* Check if there is enough space for binders */
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800993
Jerry Yuf7c12592022-09-28 22:09:38 +0800994 /*
995 * - extension_type (2 bytes)
996 * - extension_data_len (2 bytes)
997 * - identities_len (2 bytes)
998 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
1000 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
1001 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +08001002
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001004 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +08001005
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +08001007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001009}
1010
XiaokangQian86981952022-07-19 09:51:50 +00001011int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001013{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001014 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1015 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001016 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1017 const unsigned char *psk;
1018 size_t psk_len;
1019 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001020
1021 /* Check if we have space to write binders_len.
1022 * - binders_len (2 bytes)
1023 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001025 p += 2;
1026
Jerry Yu6183cc72022-09-30 11:08:57 +08001027#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001029
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 ret = ssl_tls13_write_binder(ssl, p, end,
1031 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1032 hash_alg, psk, psk_len,
1033 &output_len);
1034 if (ret != 0) {
1035 return ret;
1036 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001037 p += output_len;
1038 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001039#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001040
Gilles Peskine449bd832023-01-11 14:50:10 +01001041 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 ret = ssl_tls13_write_binder(ssl, p, end,
1044 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1045 hash_alg, psk, psk_len,
1046 &output_len);
1047 if (ret != 0) {
1048 return ret;
1049 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001050 p += output_len;
1051 }
1052
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001054
1055 /*
1056 * - binders_len (2 bytes)
1057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001059
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001061
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001062 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001066}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001067
1068/*
1069 * struct {
1070 * opaque identity<1..2^16-1>;
1071 * uint32 obfuscated_ticket_age;
1072 * } PskIdentity;
1073 *
1074 * opaque PskBinderEntry<32..255>;
1075 *
1076 * struct {
1077 *
1078 * select (Handshake.msg_type) {
1079 * ...
1080 * case server_hello: uint16 selected_identity;
1081 * };
1082 *
1083 * } PreSharedKeyExtension;
1084 *
1085 */
1086MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001087static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1088 const unsigned char *buf,
1089 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001090{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001091 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001092 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001093 const unsigned char *psk;
1094 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001095 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1098 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001099 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001100
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001102
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1104 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1107 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1108 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001109 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001110
Jerry Yu4a698342022-09-30 12:22:01 +08001111#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1113 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1114 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001115#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1117 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
1118 } else {
1119 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1120 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001121 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 if (ret != 0) {
1123 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001124 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001125
Xiaokang Qianeb31cbc2023-02-07 02:08:56 +00001126 if (mbedtls_psa_translate_md(ssl->handshake->ciphersuite_info->mac)
1127 != hash_alg) {
1128 MBEDTLS_SSL_DEBUG_MSG(
1129 1, ("Invalid ciphersuite for external psk."));
1130
1131 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1132 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1133 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1134 }
1135
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1137 if (ret != 0) {
1138 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1139 return ret;
1140 }
1141
1142 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001143}
Ronald Cron41a443a2022-10-04 16:38:25 +02001144#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001145
Gilles Peskine449bd832023-01-11 14:50:10 +01001146int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1147 unsigned char *buf,
1148 unsigned char *end,
1149 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001150{
1151 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1152 unsigned char *p = buf;
1153 size_t ext_len;
1154
1155 *out_len = 0;
1156
1157 /* Write supported_versions extension
1158 *
1159 * Supported Versions Extension is mandatory with TLS 1.3.
1160 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1162 if (ret != 0) {
1163 return ret;
1164 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001165 p += ext_len;
1166
1167 /* Echo the cookie if the server provided one in its preceding
1168 * HelloRetryRequest message.
1169 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1171 if (ret != 0) {
1172 return ret;
1173 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001174 p += ext_len;
1175
Ronald Cron766c0cd2022-10-18 12:17:11 +02001176#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1178 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1179 if (ret != 0) {
1180 return ret;
1181 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001182 p += ext_len;
1183 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001184#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001185
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001186#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1188 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1189 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1190 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1191 if (ret != 0) {
1192 return ret;
1193 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001194 p += ext_len;
1195
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001196 /* Initializes the status to `rejected`. It will be updated to
1197 * `accepted` if the EncryptedExtension message contain an early data
1198 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001199 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001200 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 } else {
1202 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001203 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001204 }
1205#endif /* MBEDTLS_SSL_EARLY_DATA */
1206
Ronald Cron41a443a2022-10-04 16:38:25 +02001207#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001208 /* For PSK-based key exchange we need the pre_shared_key extension
1209 * and the psk_key_exchange_modes extension.
1210 *
1211 * The pre_shared_key extension MUST be the last extension in the
1212 * ClientHello. Servers MUST check that it is the last extension and
1213 * otherwise fail the handshake with an "illegal_parameter" alert.
1214 *
1215 * Add the psk_key_exchange_modes extension.
1216 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1218 if (ret != 0) {
1219 return ret;
1220 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001221 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001222#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001223
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001224 *out_len = p - buf;
1225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001227}
1228
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00001229int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl)
Xiaokang Qian126929f2023-01-03 10:29:41 +00001230{
Xiaokang Qian90746132023-01-06 05:54:59 +00001231 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001232
Xiaokang Qian126929f2023-01-03 10:29:41 +00001233#if defined(MBEDTLS_SSL_EARLY_DATA)
1234 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1235 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1236 const unsigned char *psk;
1237 size_t psk_len;
1238 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001239
Xiaokang Qian126929f2023-01-03 10:29:41 +00001240 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
Xiaokang Qian6be82902023-02-03 06:04:43 +00001241#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1242 mbedtls_ssl_handshake_set_state(
1243 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1244#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00001245 MBEDTLS_SSL_DEBUG_MSG(
1246 1, ("Set hs psk for early data when writing the first psk"));
1247
1248 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1249 if (ret != 0) {
1250 MBEDTLS_SSL_DEBUG_RET(
1251 1, "ssl_tls13_ticket_get_psk", ret);
1252 return ret;
1253 }
1254
1255 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1256 if (ret != 0) {
1257 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1258 return ret;
1259 }
1260
Xiaokang Qian64bc9bc2023-02-07 02:32:23 +00001261 /*
1262 * Early data are going to be encrypted using the ciphersuite
1263 * associated with the pre-shared key used for the handshake.
1264 * Note that if the server rejects early data, the handshake
1265 * based on the pre-shared key may complete successfully
1266 * with a selected ciphersuite different from the ciphersuite
1267 * associated with the pre-shared key. Only the hashes of the
1268 * two ciphersuites have to be the same. In that case, the
1269 * encrypted handshake data and application data are
1270 * encrypted using a different ciphersuite than the one used for
1271 * the rejected early data.
1272 */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001273 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1274 ssl->session_negotiate->ciphersuite);
1275 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001276
Tom Cosgrove5c8505f2023-03-07 11:39:52 +00001277 /* Enable psk and psk_ephemeral to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001278 ssl->handshake->key_exchange_mode =
1279 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1280
1281 /* Start the TLS 1.3 key schedule:
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001282 * Set the PSK and derive early secret.
Xiaokang Qian126929f2023-01-03 10:29:41 +00001283 */
1284 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1285 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001286 MBEDTLS_SSL_DEBUG_RET(
1287 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001288 return ret;
1289 }
1290
1291 /* Derive early data key material */
1292 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1293 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001294 MBEDTLS_SSL_DEBUG_RET(
1295 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001296 return ret;
1297 }
1298
Xiaokang Qian126929f2023-01-03 10:29:41 +00001299 }
1300#endif /* MBEDTLS_SSL_EARLY_DATA */
1301 return 0;
1302}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001303/*
Jerry Yu4a173382021-10-11 21:45:31 +08001304 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001305 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001306
Ronald Cronda41b382022-03-30 09:57:11 +02001307/**
1308 * \brief Detect if the ServerHello contains a supported_versions extension
1309 * or not.
1310 *
1311 * \param[in] ssl SSL context
1312 * \param[in] buf Buffer containing the ServerHello message
1313 * \param[in] end End of the buffer containing the ServerHello message
1314 *
1315 * \return 0 if the ServerHello does not contain a supported_versions extension
1316 * \return 1 if the ServerHello contains a supported_versions extension
1317 * \return A negative value if an error occurred while parsing the ServerHello.
1318 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001319MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001320static int ssl_tls13_is_supported_versions_ext_present(
1321 mbedtls_ssl_context *ssl,
1322 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001324{
1325 const unsigned char *p = buf;
1326 size_t legacy_session_id_echo_len;
1327 size_t extensions_len;
1328 const unsigned char *extensions_end;
1329
1330 /*
1331 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001332 * length:
1333 * - legacy_version 2 bytes
1334 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1335 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001336 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001338 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1339 legacy_session_id_echo_len = *p;
1340
1341 /*
1342 * Jump to the extensions, jumping over:
1343 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1344 * - cipher_suite 2 bytes
1345 * - legacy_compression_method 1 byte
1346 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1348 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001349
1350 /* Case of no extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 if (p == end) {
1352 return 0;
1353 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001354
1355 /* ...
1356 * Extension extensions<6..2^16-1>;
1357 * ...
1358 * struct {
1359 * ExtensionType extension_type; (2 bytes)
1360 * opaque extension_data<0..2^16-1>;
1361 * } Extension;
1362 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1364 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001365 p += 2;
1366
1367 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001369 extensions_end = p + extensions_len;
1370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 while (p < extensions_end) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01001372 unsigned int extension_type;
1373 size_t extension_data_len;
1374
Gilles Peskine449bd832023-01-11 14:50:10 +01001375 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1376 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1377 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001378 p += 4;
1379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 if (extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS) {
1381 return 1;
1382 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001383
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001385 p += extension_data_len;
1386 }
1387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 return 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001389}
1390
Jerry Yu7a186a02021-10-15 18:46:14 +08001391/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001392 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1393 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1394 * - 0 otherwise
1395 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001396MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001397static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1398 const unsigned char *buf,
1399 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001400{
1401 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1402 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001404 const unsigned char *last_eight_bytes_of_random;
1405 unsigned char last_byte_of_random;
1406
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001408 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1409
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 if (memcmp(last_eight_bytes_of_random,
1411 magic_downgrade_string,
1412 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001413 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 return last_byte_of_random == 0 ||
1415 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001416 }
1417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001419}
1420
1421/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001422 * - SSL_SERVER_HELLO or
1423 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001424 * to indicate which message is expected and to be parsed next.
1425 */
Ronald Cron828aff62022-05-31 12:04:31 +02001426#define SSL_SERVER_HELLO 0
1427#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001428MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001429static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1430 const unsigned char *buf,
1431 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001432{
Jerry Yue1b9c292021-09-10 10:08:31 +08001433
1434 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1435 *
Jerry Yu4a173382021-10-11 21:45:31 +08001436 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001437 * special value of the SHA-256 of "HelloRetryRequest".
1438 *
1439 * struct {
1440 * ProtocolVersion legacy_version = 0x0303;
1441 * Random random;
1442 * opaque legacy_session_id_echo<0..32>;
1443 * CipherSuite cipher_suite;
1444 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001445 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001446 * } ServerHello;
1447 *
1448 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end,
1450 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001451
Gilles Peskine449bd832023-01-11 14:50:10 +01001452 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1453 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1454 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001455 }
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001458}
1459
Ronald Cron828aff62022-05-31 12:04:31 +02001460/*
Jerry Yu745bb612021-10-13 22:01:04 +08001461 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001462 * - SSL_SERVER_HELLO or
1463 * - SSL_SERVER_HELLO_HRR or
1464 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001465 */
Ronald Cron828aff62022-05-31 12:04:31 +02001466#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001467MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001468static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1469 const unsigned char *buf,
1470 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001471{
Jerry Yu4a173382021-10-11 21:45:31 +08001472 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001473 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001474
Gilles Peskine449bd832023-01-11 14:50:10 +01001475 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1476 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001479 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001481
1482 /* If the server is negotiating TLS 1.2 or below and:
1483 * . we did not propose TLS 1.2 or
1484 * . the server responded it is TLS 1.3 capable but negotiating a lower
1485 * version of the protocol and thus we are under downgrade attack
1486 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001487 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001488 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1489 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1490 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1491 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001492 }
1493
1494 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001495 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001496 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01001497 MBEDTLS_SSL_HS_SERVER_HELLO,
1498 buf, (size_t) (end - buf)));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1501 ret = ssl_tls13_reset_key_share(ssl);
1502 if (ret != 0) {
1503 return ret;
1504 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001505 }
1506
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001508 }
1509
Jerry Yua66fece2022-07-13 14:30:29 +08001510#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1511 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1512 ssl->session_negotiate->tls_version = ssl->tls_version;
1513#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1514
Jerry Yu50e00e32022-10-31 14:45:01 +08001515 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001516
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1518 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001519 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001521 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001522 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
1524 /* If a client receives a second
1525 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1526 * was itself in response to a HelloRetryRequest), it MUST abort the
1527 * handshake with an "unexpected_message" alert.
1528 */
1529 if (handshake->hello_retry_request_count > 0) {
1530 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
1531 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1532 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
1533 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001534 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001535 /*
1536 * Clients must abort the handshake with an "illegal_parameter"
1537 * alert if the HelloRetryRequest would not result in any change
1538 * in the ClientHello.
1539 * In a PSK only key exchange that what we expect.
1540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1542 MBEDTLS_SSL_DEBUG_MSG(1,
1543 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1546 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1547 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001548 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001549
Ronald Cron5afb9042022-05-31 12:11:39 +02001550 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001551
Jerry Yu745bb612021-10-13 22:01:04 +08001552 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001553 }
1554
1555cleanup:
1556
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001558}
1559
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001560MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001561static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1562 const unsigned char **buf,
1563 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001564{
1565 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001566 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001567
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1569 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001570
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001572
1573 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1575 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1576 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1577 ssl->session_negotiate->id,
1578 ssl->session_negotiate->id_len);
1579 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1580 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001581
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1583 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001584
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001586 }
1587
Jerry Yu4a173382021-10-11 21:45:31 +08001588 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001589 *buf = p;
1590
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1592 ssl->session_negotiate->id_len);
1593 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001594}
1595
Jerry Yue1b9c292021-09-10 10:08:31 +08001596/* Parse ServerHello message and configure context
1597 *
1598 * struct {
1599 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1600 * Random random;
1601 * opaque legacy_session_id_echo<0..32>;
1602 * CipherSuite cipher_suite;
1603 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001604 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001605 * } ServerHello;
1606 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001607MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001608static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1609 const unsigned char *buf,
1610 const unsigned char *end,
1611 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001612{
Jerry Yub85277e2021-10-13 13:36:05 +08001613 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001614 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001615 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001616 size_t extensions_len;
1617 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001618 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001619 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001620 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001621 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001622 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001624
1625 /*
1626 * Check there is space for minimal fields
1627 *
1628 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001629 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001630 * - legacy_session_id_echo ( 1 byte ), minimum size
1631 * - cipher_suite ( 2 bytes)
1632 * - legacy_compression_method ( 1 byte )
1633 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001635
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1637 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001638
Jerry Yu4a173382021-10-11 21:45:31 +08001639 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001640 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001641 * ...
1642 * with ProtocolVersion defined as:
1643 * uint16 ProtocolVersion;
1644 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1646 MBEDTLS_SSL_VERSION_TLS1_2) {
1647 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1648 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1649 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001650 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1651 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001652 }
1653 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001654
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001655 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001656 * Random random;
1657 * ...
1658 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001659 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 if (!is_hrr) {
1662 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1663 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1664 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1665 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001666 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001667 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001668
Jerry Yu4a173382021-10-11 21:45:31 +08001669 /* ...
1670 * opaque legacy_session_id_echo<0..32>;
1671 * ...
1672 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001674 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001675 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001676 }
1677
Jerry Yu4a173382021-10-11 21:45:31 +08001678 /* ...
1679 * CipherSuite cipher_suite;
1680 * ...
1681 * with CipherSuite defined as:
1682 * uint8 CipherSuite[2];
1683 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1685 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001686 p += 2;
1687
Jerry Yu4a173382021-10-11 21:45:31 +08001688
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001690 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001691 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001692 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1694 ssl->tls_version,
1695 ssl->tls_version) != 0) ||
1696 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001697 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001698 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001699 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001700 * If we received an HRR before and that the proposed selected
1701 * ciphersuite in this server hello is not the same as the one
1702 * proposed in the HRR, we abort the handshake and send an
1703 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001704 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1706 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001707 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001708 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001709
Gilles Peskine449bd832023-01-11 14:50:10 +01001710 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1711 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1712 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001713 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001714 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001715
Jerry Yu4a173382021-10-11 21:45:31 +08001716 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001718
XiaokangQian355e09a2022-01-20 11:14:50 +00001719 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1721 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001722
1723#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 ssl->session_negotiate->start = time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001725#endif /* MBEDTLS_HAVE_TIME */
1726
Jerry Yu4a173382021-10-11 21:45:31 +08001727 /* ...
1728 * uint8 legacy_compression_method = 0;
1729 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001730 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1732 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1733 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001734 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001735 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001736 }
1737 p++;
1738
Jerry Yub85277e2021-10-13 13:36:05 +08001739 /* ...
1740 * Extension extensions<6..2^16-1>;
1741 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001742 * struct {
1743 * ExtensionType extension_type; (2 bytes)
1744 * opaque extension_data<0..2^16-1>;
1745 * } Extension;
1746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1748 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001749 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001750
Jerry Yu4a173382021-10-11 21:45:31 +08001751 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001753 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001756
Jerry Yu50e00e32022-10-31 14:45:01 +08001757 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001758 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1760 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001763 unsigned int extension_type;
1764 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001765 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1768 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1769 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001770 p += 4;
1771
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001773 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001774
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001775 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1777 if (ret != 0) {
1778 return ret;
1779 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001780
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001782 case MBEDTLS_TLS_EXT_COOKIE:
1783
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 ret = ssl_tls13_parse_cookie_ext(ssl,
1785 p, extension_data_end);
1786 if (ret != 0) {
1787 MBEDTLS_SSL_DEBUG_RET(1,
1788 "ssl_tls13_parse_cookie_ext",
1789 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001790 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001791 }
XiaokangQianb851da82022-01-14 04:03:11 +00001792 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001793
Jerry Yue1b9c292021-09-10 10:08:31 +08001794 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1796 p,
1797 extension_data_end);
1798 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001799 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001801 break;
1802
Ronald Cron41a443a2022-10-04 16:38:25 +02001803#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001804 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001806
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1808 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001809 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1811 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001812 }
1813 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001814#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001815
Jerry Yue1b9c292021-09-10 10:08:31 +08001816 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1818 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001819 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001820 goto cleanup;
1821 }
1822
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 if (is_hrr) {
1824 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1825 p, extension_data_end);
1826 } else {
1827 ret = ssl_tls13_parse_key_share_ext(ssl,
1828 p, extension_data_end);
1829 }
1830 if (ret != 0) {
1831 MBEDTLS_SSL_DEBUG_RET(1,
1832 "ssl_tls13_parse_key_share_ext",
1833 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001834 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001835 }
1836 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001837
1838 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001839 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1840 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001841 }
1842
1843 p += extension_data_len;
1844 }
1845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001847
XiaokangQiand59be772022-01-24 10:12:51 +00001848cleanup:
1849
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1851 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1852 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001853 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1855 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1856 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001857 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1858 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001860}
1861
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001862#if defined(MBEDTLS_DEBUG_C)
1863static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001864{
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001866 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1867 return "psk";
1868 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1869 return "ephemeral";
1870 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1871 return "psk_ephemeral";
1872 default:
1873 return "unknown mode";
1874 }
1875}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001876#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001877
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001878MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001879static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001880{
Jerry Yub85277e2021-10-13 13:36:05 +08001881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001882 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001883
Jerry Yub85277e2021-10-13 13:36:05 +08001884 /* Determine the key exchange mode:
1885 * 1) If both the pre_shared_key and key_share extensions were received
1886 * then the key exchange mode is PSK with EPHEMERAL.
1887 * 2) If only the pre_shared_key extension was received then the key
1888 * exchange mode is PSK-only.
1889 * 3) If only the key_share extension was received then the key
1890 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001891 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 switch (handshake->received_extensions &
1893 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001894 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Ronald Cron79907712022-07-20 17:05:29 +02001896 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001897 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001898
Jerry Yu745bb612021-10-13 22:01:04 +08001899 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Ronald Cron79907712022-07-20 17:05:29 +02001901 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001902 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001903
Jerry Yu745bb612021-10-13 22:01:04 +08001904 /* Both the pre_shared_key and key_share extensions were received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
Ronald Cron79907712022-07-20 17:05:29 +02001906 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001907 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001908
Jerry Yu745bb612021-10-13 22:01:04 +08001909 /* Neither pre_shared_key nor key_share extension was received */
1910 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001912 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1913 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001914 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001915#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001916 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1917 (handshake->selected_identity != 0 ||
1918 handshake->ciphersuite_info->id !=
1919 ssl->session_negotiate->ciphersuite)) {
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001920 /* RFC8446 4.2.11
1921 * If the server supplies an "early_data" extension, the
1922 * client MUST verify that the server's selected_identity
1923 * is 0. If any other value is returned, the client MUST
1924 * abort the handshake with an "illegal_parameter" alert.
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001925 *
Xiaokang Qian53c4c272023-02-07 02:42:01 +00001926 * RFC 8446 4.2.10
1927 * In order to accept early data, the server MUST have accepted a PSK
1928 * cipher suite and selected the first key offered in the client's
1929 * "pre_shared_key" extension. In addition, it MUST verify that the
1930 * following values are the same as those associated with the
1931 * selected PSK:
1932 * - The TLS version number
1933 * - The selected cipher suite
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001934 * - The selected ALPN [RFC7301] protocol, if any
1935 *
1936 * We check here that when early data is involved the server
1937 * selected the cipher suite associated to the pre-shared key
1938 * as it must have.
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001939 */
1940 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1941 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1942 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1943 }
1944#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001945
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001946 if (!mbedtls_ssl_conf_tls13_check_kex_modes(
1947 ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001948 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 MBEDTLS_SSL_DEBUG_MSG(2,
1950 ("Key exchange mode(%s) is not supported.",
1951 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001952 goto cleanup;
1953 }
1954
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 MBEDTLS_SSL_DEBUG_MSG(3,
1956 ("Selected key exchange mode: %s",
1957 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001958
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001959 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001960 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001961 * If we proposed early data then we have already derived an
1962 * early secret using the selected PSK and its associated hash.
1963 * It means that if the negotiated key exchange mode is psk or
1964 * psk_ephemeral, we have already correctly computed the
1965 * early secret and thus we do not do it again. In all other
1966 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001967 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001968#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001969 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1970 handshake->key_exchange_mode ==
1971 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001972#endif
1973 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001974 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1975 if (ret != 0) {
1976 MBEDTLS_SSL_DEBUG_RET(
1977 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1978 goto cleanup;
1979 }
Jerry Yu0b177842021-09-05 19:41:30 +08001980 }
1981
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1983 if (ret != 0) {
1984 MBEDTLS_SSL_DEBUG_RET(1,
1985 "mbedtls_ssl_tls13_compute_handshake_transform",
1986 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001987 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001988 }
1989
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1991 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001992 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
Jerry Yu0b177842021-09-05 19:41:30 +08001993 ssl->session_in = ssl->session_negotiate;
1994
Jerry Yu4a173382021-10-11 21:45:31 +08001995cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001997 MBEDTLS_SSL_PEND_FATAL_ALERT(
1998 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08002000 }
Jerry Yue110d252022-05-05 10:19:22 +08002001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08002003}
2004
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002005MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002006static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00002007{
2008 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00002011
XiaokangQian78b1fa72022-01-19 06:56:30 +00002012 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00002013 * We are going to re-generate a shared secret corresponding to the group
2014 * selected by the server, which is different from the group for which we
2015 * generated a shared secret in the first client hello.
2016 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00002017 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 ret = ssl_tls13_reset_key_share(ssl);
2019 if (ret != 0) {
2020 return ret;
2021 }
XiaokangQian647719a2021-12-07 09:16:29 +00002022
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00002023 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002025}
2026
Jerry Yue1b9c292021-09-10 10:08:31 +08002027/*
Jerry Yu4a173382021-10-11 21:45:31 +08002028 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002029 * Handler for MBEDTLS_SSL_SERVER_HELLO
2030 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002031MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002032static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002033{
Jerry Yu4a173382021-10-11 21:45:31 +08002034 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002035 unsigned char *buf = NULL;
2036 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002037 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2042 MBEDTLS_SSL_HS_SERVER_HELLO,
2043 &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2046 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002047 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 } else {
2049 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2050 }
XiaokangQiand59be772022-01-24 10:12:51 +00002051
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002053 ret = 0;
2054 goto cleanup;
2055 }
2056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2058 buf + buf_len,
2059 is_hrr));
2060 if (is_hrr) {
2061 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002062 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002063
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002064 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002065 MBEDTLS_SSL_HS_SERVER_HELLO, buf,
2066 buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002067
2068 if (is_hrr) {
2069 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2070#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2071 /* If not offering early data, the client sends a dummy CCS record
2072 * immediately before its second flight. This may either be before
2073 * its second ClientHello or before its encrypted handshake flight.
2074 */
2075 mbedtls_ssl_handshake_set_state(ssl,
2076 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
2077#else
2078 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2079#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2080 } else {
2081 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2082 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002083 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002084
2085cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2087 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2088 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002089}
2090
2091/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002092 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002093 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002094 *
2095 * The EncryptedExtensions message contains any extensions which
2096 * should be protected, i.e., any which are not needed to establish
2097 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002098 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002099
XiaokangQian08da26c2021-10-09 10:12:11 +00002100/* Parse EncryptedExtensions message
2101 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002102 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002103 * } EncryptedExtensions;
2104 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002105MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002106static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2107 const unsigned char *buf,
2108 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002109{
2110 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002111 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002112 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002113 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002114 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2117 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002118 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002119
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002121 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002122
Jan Bruckner5a3629b2023-02-23 12:08:09 +01002123 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2124
Jerry Yu9eba7502022-10-31 13:46:16 +08002125 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002128 unsigned int extension_type;
2129 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002130
XiaokangQian08da26c2021-10-09 10:12:11 +00002131 /*
2132 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002133 * ExtensionType extension_type; (2 bytes)
2134 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002135 * } Extension;
2136 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2138 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2139 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002140 p += 4;
2141
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002143
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002144 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2146 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2147 if (ret != 0) {
2148 return ret;
2149 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002150
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002152#if defined(MBEDTLS_SSL_ALPN)
2153 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if ((ret = ssl_tls13_parse_alpn_ext(ssl, p, (size_t) extension_data_len)) != 0) {
2157 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002158 }
2159
2160 break;
2161#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002162
2163#if defined(MBEDTLS_SSL_EARLY_DATA)
2164 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002167 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2169 MBEDTLS_ERR_SSL_DECODE_ERROR);
2170 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002171 }
2172
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002173 break;
2174#endif /* MBEDTLS_SSL_EARLY_DATA */
2175
Jan Bruckner151f6422023-02-10 12:45:19 +01002176#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2177 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
2178 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
2179
2180 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(ssl, p, p + extension_data_len);
2181
2182 return ret;
2183
2184 break;
2185#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2186
XiaokangQian08da26c2021-10-09 10:12:11 +00002187 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002188 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002189 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002191 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002192 }
2193
XiaokangQian08da26c2021-10-09 10:12:11 +00002194 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002195 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002196
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2198 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002199
XiaokangQian97799ac2021-10-11 10:05:54 +00002200 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 if (p != end) {
2202 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2203 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2204 MBEDTLS_ERR_SSL_DECODE_ERROR);
2205 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002206 }
2207
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002209}
2210
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002211MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002212static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002213{
2214 int ret;
2215 unsigned char *buf;
2216 size_t buf_len;
2217
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002219
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2221 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2222 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002223
2224 /* Process the message contents */
2225 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002227
Xiaokang Qianb157e912022-11-23 08:12:26 +00002228#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 if (ssl->handshake->received_extensions &
2230 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002231 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2232 }
2233#endif
2234
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002235 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002236 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2237 buf, buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002238
Ronald Cron928cbd32022-10-04 16:14:26 +02002239#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2241 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2242 } else {
2243 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2244 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002245#else
2246 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002248#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002249
2250cleanup:
2251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2253 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002254
2255}
2256
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002257/*
2258 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2259 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002260 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002261 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002262 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002263 *
2264 * If the server sent an "early_data" extension in EncryptedExtensions, the
2265 * client MUST send an EndOfEarlyData message after receiving the server
2266 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002267 */
2268
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002269MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002270static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2271{
2272 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002273 unsigned char *buf = NULL;
2274 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002275 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002276
Xiaokang Qian742578c2022-12-19 06:34:44 +00002277 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
Xiaokang Qian0de0d862023-02-08 06:04:50 +00002278 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
2279 &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002280
Manuel Pégourié-Gonnard63e33dd2023-02-21 15:45:15 +01002281 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_hdr_to_checksum(
2282 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002283
Xiaokang Qian742578c2022-12-19 06:34:44 +00002284 MBEDTLS_SSL_PROC_CHK(
2285 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002286
Xiaokang Qian19d44162023-01-03 03:39:50 +00002287 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002288
2289cleanup:
2290
2291 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2292 return ret;
2293}
2294
Ronald Cron928cbd32022-10-04 16:14:26 +02002295#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002296/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002297 * STATE HANDLING: CertificateRequest
2298 *
Jerry Yud2674312021-10-29 10:08:19 +08002299 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002300#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2301#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002302/* Coordination:
2303 * Deals with the ambiguity of not knowing if a CertificateRequest
2304 * will be sent. Returns a negative code on failure, or
2305 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2306 * - SSL_CERTIFICATE_REQUEST_SKIP
2307 * indicating if a Certificate Request is expected or not.
2308 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002309MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002310static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002311{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002312 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2315 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2316 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002317 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002318 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2321 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2322 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2323 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002324 }
2325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002329}
2330
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002331/*
2332 * ssl_tls13_parse_certificate_request()
2333 * Parse certificate request
2334 * struct {
2335 * opaque certificate_request_context<0..2^8-1>;
2336 * Extension extensions<2..2^16-1>;
2337 * } CertificateRequest;
2338 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002339MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002340static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2341 const unsigned char *buf,
2342 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002343{
2344 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2345 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002346 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002347 size_t extensions_len = 0;
2348 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002349 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002350
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002351 /* ...
2352 * opaque certificate_request_context<0..2^8-1>
2353 * ...
2354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002356 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002357 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002358
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 if (certificate_request_context_len > 0) {
2360 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2361 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2362 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002363
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002364 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 mbedtls_calloc(1, certificate_request_context_len);
2366 if (handshake->certificate_request_context == NULL) {
2367 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2368 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002369 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 memcpy(handshake->certificate_request_context, p,
2371 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002372 p += certificate_request_context_len;
2373 }
2374
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002375 /* ...
2376 * Extension extensions<2..2^16-1>;
2377 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002378 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2380 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002381 p += 2;
2382
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002384 extensions_end = p + extensions_len;
2385
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002386 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002387
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002389 unsigned int extension_type;
2390 size_t extension_data_len;
2391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2393 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2394 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002395 p += 4;
2396
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002398
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002399 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2401 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2402 if (ret != 0) {
2403 return ret;
2404 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002407 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 MBEDTLS_SSL_DEBUG_MSG(3,
2409 ("found signature algorithms extension"));
2410 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2411 p + extension_data_len);
2412 if (ret != 0) {
2413 return ret;
2414 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002415
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002416 break;
2417
2418 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002419 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002420 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002422 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002423 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002424
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002425 p += extension_data_len;
2426 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002427
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2429 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002430
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002431 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 if (p != end) {
2433 MBEDTLS_SSL_DEBUG_MSG(1,
2434 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002435 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002436 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002437
Jerry Yu0c354a22022-08-29 15:25:36 +08002438 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002439 *
2440 * The "signature_algorithms" extension MUST be specified
2441 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2443 MBEDTLS_SSL_DEBUG_MSG(3,
2444 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002445 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002446 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002447
Jerry Yu7840f812022-01-29 10:26:51 +08002448 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002450
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002451decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2453 MBEDTLS_ERR_SSL_DECODE_ERROR);
2454 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002455}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002456
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002457/*
2458 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2459 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002460MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002461static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002462{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002463 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002470 unsigned char *buf;
2471 size_t buf_len;
2472
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2474 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2475 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002476
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(ssl,
2478 buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002479
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002480 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002481 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2482 buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002484 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 } else {
2486 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002487 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2488 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002489 }
2490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002492
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002493cleanup:
2494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2496 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002497}
2498
2499/*
Jerry Yu687101b2021-09-14 16:03:56 +08002500 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2501 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002502MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002503static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002504{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002505 int ret;
2506
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2508 if (ret != 0) {
2509 return ret;
2510 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2513 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002514}
2515
2516/*
2517 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2518 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002519MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002520static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002521{
Jerry Yu30b071c2021-09-12 20:16:03 +08002522 int ret;
2523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2525 if (ret != 0) {
2526 return ret;
2527 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002528
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2530 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002531}
Ronald Cron928cbd32022-10-04 16:14:26 +02002532#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002533
Jerry Yu687101b2021-09-14 16:03:56 +08002534/*
2535 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2536 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002537MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002538static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002539{
XiaokangQianac0385c2021-11-03 06:40:11 +00002540 int ret;
2541
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2543 if (ret != 0) {
2544 return ret;
2545 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002546
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2548 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002549 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2551 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2552 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002553 }
2554
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002555#if defined(MBEDTLS_SSL_EARLY_DATA)
2556 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2557 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002558 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2559 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002560 } else
2561#endif /* MBEDTLS_SSL_EARLY_DATA */
2562 {
2563#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2564 mbedtls_ssl_handshake_set_state(
2565 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2566#else
2567 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2568#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2569 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002572}
2573
2574/*
Jerry Yu566c7812022-01-26 15:41:22 +08002575 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2576 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002577MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002578static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002579{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002580 int non_empty_certificate_msg = 0;
2581
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 MBEDTLS_SSL_DEBUG_MSG(1,
2583 ("Switch to handshake traffic keys for outbound traffic"));
2584 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002585
Ronald Cron928cbd32022-10-04 16:14:26 +02002586#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 if (ssl->handshake->client_auth) {
2588 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2589 if (ret != 0) {
2590 return ret;
2591 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002594 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 }
2596 } else {
2597 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002598 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002599#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if (non_empty_certificate_msg) {
2602 mbedtls_ssl_handshake_set_state(ssl,
2603 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2604 } else {
2605 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2606 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2607 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002610}
2611
Ronald Cron928cbd32022-10-04 16:14:26 +02002612#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002613/*
2614 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2615 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002616MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002617static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002618{
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002620
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 if (ret == 0) {
2622 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2623 }
Ronald Crona8b38872022-03-09 07:59:25 +01002624
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002626}
Ronald Cron928cbd32022-10-04 16:14:26 +02002627#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002628
2629/*
Jerry Yu687101b2021-09-14 16:03:56 +08002630 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2631 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002632MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002633static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002634{
XiaokangQian0fa66432021-11-15 03:33:57 +00002635 int ret;
2636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2638 if (ret != 0) {
2639 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002640 }
2641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2643 if (ret != 0) {
2644 MBEDTLS_SSL_DEBUG_RET(1,
2645 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
2646 return ret;
2647 }
2648
2649 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2650 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002651}
2652
2653/*
2654 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2655 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002656MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002657static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002658{
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2660 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2661 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002662}
2663
2664/*
2665 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2666 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002667MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002668static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002669{
Jerry Yu378254d2021-10-30 21:44:47 +08002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2674 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002675}
2676
Jerry Yuf8a49942022-07-07 11:32:32 +00002677#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2678
Jerry Yua0446a02022-07-13 11:22:55 +08002679MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002680static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2681 const unsigned char *buf,
2682 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002683{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002684 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002685 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002686
Jerry Yuf8a49942022-07-07 11:32:32 +00002687
Jerry Yuedab6372022-10-31 14:37:31 +08002688 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002691 unsigned int extension_type;
2692 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002693 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2696 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2697 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002698 p += 4;
2699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002701
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002702 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2704 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2705 if (ret != 0) {
2706 return ret;
2707 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002708
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002710#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002711 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002713 MBEDTLS_SSL_PEND_FATAL_ALERT(
2714 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 MBEDTLS_ERR_SSL_DECODE_ERROR);
2716 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002717 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002719 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002721 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002722 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002723#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002724
Jerry Yuf8a49942022-07-07 11:32:32 +00002725 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002726 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002727 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002729 break;
2730 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002731
Jerry Yuf8a49942022-07-07 11:32:32 +00002732 p += extension_data_len;
2733 }
2734
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2736 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002737
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002739}
2740
2741/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002742 * From RFC8446, page 74
2743 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002744 * struct {
2745 * uint32 ticket_lifetime;
2746 * uint32 ticket_age_add;
2747 * opaque ticket_nonce<0..255>;
2748 * opaque ticket<1..2^16-1>;
2749 * Extension extensions<0..2^16-2>;
2750 * } NewSessionTicket;
2751 *
2752 */
Jerry Yua0446a02022-07-13 11:22:55 +08002753MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002754static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2755 unsigned char *buf,
2756 unsigned char *end,
2757 unsigned char **ticket_nonce,
2758 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002759{
2760 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2761 unsigned char *p = buf;
2762 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002763 size_t ticket_len;
2764 unsigned char *ticket;
2765 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002766
Jerry Yucb3b1392022-07-12 06:09:38 +00002767 *ticket_nonce = NULL;
2768 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002769 /*
2770 * ticket_lifetime 4 bytes
2771 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002772 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002773 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2777 MBEDTLS_SSL_DEBUG_MSG(3,
2778 ("ticket_lifetime: %u",
2779 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2782 MBEDTLS_SSL_DEBUG_MSG(3,
2783 ("ticket_age_add: %u",
2784 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002785
Jerry Yucb3b1392022-07-12 06:09:38 +00002786 *ticket_nonce_len = p[8];
2787 p += 9;
2788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002790 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002792 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002793
2794 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2796 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002797 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2799 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002800
2801 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 if (session->ticket != NULL || session->ticket_len > 0) {
2803 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002804 session->ticket = NULL;
2805 session->ticket_len = 0;
2806 }
2807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2809 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2810 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002811 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002813 p += ticket_len;
2814 session->ticket = ticket;
2815 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002816
Pengyu Lv9f926952022-11-17 15:22:33 +08002817 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002818 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002819 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002820
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2822 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002823 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002827
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2829 if (ret != 0) {
2830 MBEDTLS_SSL_DEBUG_RET(1,
2831 "ssl_tls13_parse_new_session_ticket_exts",
2832 ret);
2833 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002834 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002835
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002836 /* session has been updated, allow export */
2837 session->exported = 0;
2838
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002840}
2841
Jerry Yua0446a02022-07-13 11:22:55 +08002842MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002843static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2844 unsigned char *ticket_nonce,
2845 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002846{
2847 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2848 mbedtls_ssl_session *session = ssl->session;
2849 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2850 psa_algorithm_t psa_hash_alg;
2851 int hash_length;
2852
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002853#if defined(MBEDTLS_HAVE_TIME)
2854 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002856#endif
2857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2859 if (ciphersuite_info == NULL) {
2860 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2861 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002862 }
2863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2865 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2866 if (hash_length == -1 ||
2867 (size_t) hash_length > sizeof(session->resumption_key)) {
2868 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002869 }
2870
Jerry Yuf8a49942022-07-07 11:32:32 +00002871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2873 session->app_secrets.resumption_master_secret,
2874 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002875
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002876 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002877 *
2878 * HKDF-Expand-Label( resumption_master_secret,
2879 * "resumption", ticket_nonce, Hash.length )
2880 */
2881 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 psa_hash_alg,
2883 session->app_secrets.resumption_master_secret,
2884 hash_length,
2885 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2886 ticket_nonce,
2887 ticket_nonce_len,
2888 session->resumption_key,
2889 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 if (ret != 0) {
2892 MBEDTLS_SSL_DEBUG_RET(2,
2893 "Creating the ticket-resumed PSK failed",
2894 ret);
2895 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002896 }
2897
Jerry Yu0a430c82022-07-20 11:02:48 +08002898 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002899
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2901 session->resumption_key,
2902 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002903
Pengyu Lv9f926952022-11-17 15:22:33 +08002904 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002905 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002906 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002907 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002910}
2911
2912/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002913 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002914 */
Jerry Yua0446a02022-07-13 11:22:55 +08002915MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002916static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002917{
2918 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2919 unsigned char *buf;
2920 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002921 unsigned char *ticket_nonce;
2922 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2927 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2928 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002929
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2931 ssl, buf, buf + buf_len,
2932 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2935 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002938
Jerry Yuf8a49942022-07-07 11:32:32 +00002939cleanup:
2940
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2942 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002943}
2944#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2945
Gilles Peskine449bd832023-01-11 14:50:10 +01002946int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002947{
Jerry Yu92c6b402021-08-27 16:59:09 +08002948 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002949
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002951 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002953 break;
2954
Jerry Yu92c6b402021-08-27 16:59:09 +08002955 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002957 break;
2958
2959 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002961 break;
2962
2963 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002965 break;
2966
Ronald Cron928cbd32022-10-04 16:14:26 +02002967#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002968 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002970 break;
2971
Jerry Yu687101b2021-09-14 16:03:56 +08002972 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002974 break;
2975
2976 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002978 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002979#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002980
2981 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002983 break;
2984
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002985 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2986 ret = ssl_tls13_write_end_of_early_data(ssl);
2987 break;
2988
Jerry Yu566c7812022-01-26 15:41:22 +08002989 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002991 break;
2992
Ronald Cron928cbd32022-10-04 16:14:26 +02002993#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002994 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002996 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002997#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002998
Jerry Yu687101b2021-09-14 16:03:56 +08002999 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003001 break;
3002
3003 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003005 break;
3006
3007 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08003009 break;
3010
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 /*
3012 * Injection of dummy-CCS's for middlebox compatibility
3013 */
Ronald Cron49ad6192021-11-24 16:25:31 +01003014#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00003015 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3017 if (ret == 0) {
3018 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3019 }
Ronald Cron9f55f632022-02-02 16:02:47 +01003020 break;
3021
3022 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3024 if (ret == 0) {
3025 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
3026 }
Ronald Cron49ad6192021-11-24 16:25:31 +01003027 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003028
Xiaokang Qian592021a2023-01-04 10:47:05 +00003029 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3030 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3031 if (ret == 0) {
3032 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3033
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003034#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003035 MBEDTLS_SSL_DEBUG_MSG(
3036 1, ("Switch to early data keys for outbound traffic"));
3037 mbedtls_ssl_set_outbound_transform(
3038 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003039#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003040 }
3041 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003042#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3043
Jerry Yuf8a49942022-07-07 11:32:32 +00003044#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003045 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 ret = ssl_tls13_process_new_session_ticket(ssl);
3047 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003048 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003050 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3051 break;
3052#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3053
Jerry Yu92c6b402021-08-27 16:59:09 +08003054 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003057 }
3058
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003060}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003061
Jerry Yufb4b6472022-01-27 15:03:26 +08003062#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */