blob: 39cbf66b387941d7287ac3952511df1f30f8a784 [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
Valerio Setti080a22b2023-03-20 15:22:47 +0100187#if defined(PSA_WANT_ALG_ECDH)
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
Valerio Setti080a22b2023-03-20 15:22:47 +0100203#endif /* PSA_WANT_ALG_ECDH */
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
Valerio Setti080a22b2023-03-20 15:22:47 +0100222#if defined(PSA_WANT_ALG_ECDH)
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++) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000230 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
231 *group_list, NULL, NULL) == PSA_SUCCESS) &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100232 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);
Valerio Setti080a22b2023-03-20 15:22:47 +0100240#endif /* PSA_WANT_ALG_ECDH */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800241
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;
Valerio Setti080a22b2023-03-20 15:22:47 +0100304#if defined(PSA_WANT_ALG_ECDH)
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
Valerio Setti080a22b2023-03-20 15:22:47 +0100329#endif /* PSA_WANT_ALG_ECDH */
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{
Valerio Setti080a22b2023-03-20 15:22:47 +0100378#if defined(PSA_WANT_ALG_ECDH)
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++) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000405 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
406 *group_list, NULL, NULL) == PSA_ERROR_NOT_SUPPORTED) ||
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 *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) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000475 MBEDTLS_SSL_DEBUG_MSG(
476 1, ("Invalid server key share, our group %u, their group %u",
477 (unsigned) offered_group, (unsigned) group));
Gilles Peskine449bd832023-01-11 14:50:10 +0100478 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
Valerio Setti080a22b2023-03-20 15:22:47 +0100483#if defined(PSA_WANT_ALG_ECDH)
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
Valerio Setti080a22b2023-03-20 15:22:47 +0100499#endif /* PSA_WANT_ALG_ECDH */
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;
Ronald Croneff56732023-04-03 17:36:31 +02001327 const unsigned char *supported_versions_data;
1328 const unsigned char *supported_versions_data_end;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001329
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
Ronald Cron47dce632023-02-08 17:38:29 +01001350 return mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1351 ssl, p, end,
Ronald Croneff56732023-04-03 17:36:31 +02001352 &supported_versions_data, &supported_versions_data_end);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001353}
1354
Jerry Yu7a186a02021-10-15 18:46:14 +08001355/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001356 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1357 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1358 * - 0 otherwise
1359 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001360MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001361static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1362 const unsigned char *buf,
1363 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001364{
1365 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1366 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001368 const unsigned char *last_eight_bytes_of_random;
1369 unsigned char last_byte_of_random;
1370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001372 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1373
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 if (memcmp(last_eight_bytes_of_random,
1375 magic_downgrade_string,
1376 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001377 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 return last_byte_of_random == 0 ||
1379 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001380 }
1381
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001383}
1384
1385/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001386 * - SSL_SERVER_HELLO or
1387 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001388 * to indicate which message is expected and to be parsed next.
1389 */
Ronald Cron828aff62022-05-31 12:04:31 +02001390#define SSL_SERVER_HELLO 0
1391#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001392MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001393static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1394 const unsigned char *buf,
1395 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001396{
Jerry Yue1b9c292021-09-10 10:08:31 +08001397
1398 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1399 *
Jerry Yu4a173382021-10-11 21:45:31 +08001400 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001401 * special value of the SHA-256 of "HelloRetryRequest".
1402 *
1403 * struct {
1404 * ProtocolVersion legacy_version = 0x0303;
1405 * Random random;
1406 * opaque legacy_session_id_echo<0..32>;
1407 * CipherSuite cipher_suite;
1408 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001409 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001410 * } ServerHello;
1411 *
1412 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001413 MBEDTLS_SSL_CHK_BUF_READ_PTR(
1414 buf, end, 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001415
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1417 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1418 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001419 }
1420
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001422}
1423
Ronald Cron828aff62022-05-31 12:04:31 +02001424/*
Jerry Yu745bb612021-10-13 22:01:04 +08001425 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001426 * - SSL_SERVER_HELLO or
1427 * - SSL_SERVER_HELLO_HRR or
1428 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001429 */
Ronald Cron828aff62022-05-31 12:04:31 +02001430#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001431MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001432static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1433 const unsigned char *buf,
1434 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001435{
Jerry Yu4a173382021-10-11 21:45:31 +08001436 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001437 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001438
Gilles Peskine449bd832023-01-11 14:50:10 +01001439 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1440 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001441
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001443 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001445
1446 /* If the server is negotiating TLS 1.2 or below and:
1447 * . we did not propose TLS 1.2 or
1448 * . the server responded it is TLS 1.3 capable but negotiating a lower
1449 * version of the protocol and thus we are under downgrade attack
1450 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001451 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001452 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1453 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1454 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1455 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001456 }
1457
Ronald Cronb828c7d2023-04-03 16:37:22 +02001458 /*
1459 * Version 1.2 of the protocol has been negotiated, set the
1460 * ssl->keep_current_message flag for the ServerHello to be kept and
1461 * parsed as a TLS 1.2 ServerHello. We also change ssl->tls_version to
1462 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1463 * will dispatch to the TLS 1.2 state machine.
1464 */
Ronald Cron9f0fba32022-02-10 16:45:15 +01001465 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001466 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001467 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1468 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1469 buf, (size_t) (end - buf)));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001470
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1472 ret = ssl_tls13_reset_key_share(ssl);
1473 if (ret != 0) {
1474 return ret;
1475 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001476 }
1477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001479 }
1480
Jerry Yua66fece2022-07-13 14:30:29 +08001481#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1482 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1483 ssl->session_negotiate->tls_version = ssl->tls_version;
1484#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1485
Jerry Yu50e00e32022-10-31 14:45:01 +08001486 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001487
Gilles Peskine449bd832023-01-11 14:50:10 +01001488 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1489 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001490 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001491 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001492 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001493 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001495 /* If a client receives a second HelloRetryRequest in the same
1496 * connection (i.e., where the ClientHello was itself in response
1497 * to a HelloRetryRequest), it MUST abort the handshake with an
1498 * "unexpected_message" alert.
Gilles Peskine449bd832023-01-11 14:50:10 +01001499 */
1500 if (handshake->hello_retry_request_count > 0) {
1501 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001502 MBEDTLS_SSL_PEND_FATAL_ALERT(
1503 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1504 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001506 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001507 /*
1508 * Clients must abort the handshake with an "illegal_parameter"
1509 * alert if the HelloRetryRequest would not result in any change
1510 * in the ClientHello.
1511 * In a PSK only key exchange that what we expect.
1512 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1514 MBEDTLS_SSL_DEBUG_MSG(1,
1515 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001516 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1518 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1519 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001521
Ronald Cron5afb9042022-05-31 12:11:39 +02001522 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001523
Jerry Yu745bb612021-10-13 22:01:04 +08001524 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001525 }
1526
1527cleanup:
1528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001530}
1531
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001532MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001533static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1534 const unsigned char **buf,
1535 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001536{
1537 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001538 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1541 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001544
1545 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1547 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1548 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1549 ssl->session_negotiate->id,
1550 ssl->session_negotiate->id_len);
1551 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1552 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001553
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1555 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001556
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001558 }
1559
Jerry Yu4a173382021-10-11 21:45:31 +08001560 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001561 *buf = p;
1562
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1564 ssl->session_negotiate->id_len);
1565 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001566}
1567
Jerry Yue1b9c292021-09-10 10:08:31 +08001568/* Parse ServerHello message and configure context
1569 *
1570 * struct {
1571 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1572 * Random random;
1573 * opaque legacy_session_id_echo<0..32>;
1574 * CipherSuite cipher_suite;
1575 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001576 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001577 * } ServerHello;
1578 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001579MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001580static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1581 const unsigned char *buf,
1582 const unsigned char *end,
1583 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001584{
Jerry Yub85277e2021-10-13 13:36:05 +08001585 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001586 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001587 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001588 size_t extensions_len;
1589 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001590 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001591 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001592 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001593 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001594 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001596
1597 /*
1598 * Check there is space for minimal fields
1599 *
1600 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001601 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001602 * - legacy_session_id_echo ( 1 byte ), minimum size
1603 * - cipher_suite ( 2 bytes)
1604 * - legacy_compression_method ( 1 byte )
1605 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001607
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1609 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001610
Jerry Yu4a173382021-10-11 21:45:31 +08001611 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001612 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001613 * ...
1614 * with ProtocolVersion defined as:
1615 * uint16 ProtocolVersion;
1616 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1618 MBEDTLS_SSL_VERSION_TLS1_2) {
1619 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1620 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1621 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001622 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1623 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001624 }
1625 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001626
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001627 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001628 * Random random;
1629 * ...
1630 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001631 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001632 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 if (!is_hrr) {
1634 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1635 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1636 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1637 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001638 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001639 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001640
Jerry Yu4a173382021-10-11 21:45:31 +08001641 /* ...
1642 * opaque legacy_session_id_echo<0..32>;
1643 * ...
1644 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001646 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001647 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001648 }
1649
Jerry Yu4a173382021-10-11 21:45:31 +08001650 /* ...
1651 * CipherSuite cipher_suite;
1652 * ...
1653 * with CipherSuite defined as:
1654 * uint8 CipherSuite[2];
1655 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1657 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001658 p += 2;
1659
Jerry Yu4a173382021-10-11 21:45:31 +08001660
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001662 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001663 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001664 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001665 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1666 ssl->tls_version,
1667 ssl->tls_version) != 0) ||
1668 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001669 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001670 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001671 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001672 * If we received an HRR before and that the proposed selected
1673 * ciphersuite in this server hello is not the same as the one
1674 * proposed in the HRR, we abort the handshake and send an
1675 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001676 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1678 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001679 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001680 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001681
Gilles Peskine449bd832023-01-11 14:50:10 +01001682 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1683 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1684 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001685 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001686 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001687
Jerry Yu4a173382021-10-11 21:45:31 +08001688 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001690
XiaokangQian355e09a2022-01-20 11:14:50 +00001691 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1693 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001694
1695#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001696 ssl->session_negotiate->start = time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001697#endif /* MBEDTLS_HAVE_TIME */
1698
Jerry Yu4a173382021-10-11 21:45:31 +08001699 /* ...
1700 * uint8 legacy_compression_method = 0;
1701 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001702 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1704 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1705 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001706 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001707 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001708 }
1709 p++;
1710
Jerry Yub85277e2021-10-13 13:36:05 +08001711 /* ...
1712 * Extension extensions<6..2^16-1>;
1713 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001714 * struct {
1715 * ExtensionType extension_type; (2 bytes)
1716 * opaque extension_data<0..2^16-1>;
1717 * } Extension;
1718 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1720 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001721 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001722
Jerry Yu4a173382021-10-11 21:45:31 +08001723 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001725 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001728
Jerry Yu50e00e32022-10-31 14:45:01 +08001729 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001730 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1732 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001735 unsigned int extension_type;
1736 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001737 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1740 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1741 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001742 p += 4;
1743
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001745 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001746
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001747 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1749 if (ret != 0) {
1750 return ret;
1751 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001752
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001754 case MBEDTLS_TLS_EXT_COOKIE:
1755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 ret = ssl_tls13_parse_cookie_ext(ssl,
1757 p, extension_data_end);
1758 if (ret != 0) {
1759 MBEDTLS_SSL_DEBUG_RET(1,
1760 "ssl_tls13_parse_cookie_ext",
1761 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001762 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001763 }
XiaokangQianb851da82022-01-14 04:03:11 +00001764 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001765
Jerry Yue1b9c292021-09-10 10:08:31 +08001766 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1768 p,
1769 extension_data_end);
1770 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001771 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001773 break;
1774
Ronald Cron41a443a2022-10-04 16:38:25 +02001775#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001776 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001778
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1780 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001781 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1783 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001784 }
1785 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001786#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001787
Jerry Yue1b9c292021-09-10 10:08:31 +08001788 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1790 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001791 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001792 goto cleanup;
1793 }
1794
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 if (is_hrr) {
1796 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1797 p, extension_data_end);
1798 } else {
1799 ret = ssl_tls13_parse_key_share_ext(ssl,
1800 p, extension_data_end);
1801 }
1802 if (ret != 0) {
1803 MBEDTLS_SSL_DEBUG_RET(1,
1804 "ssl_tls13_parse_key_share_ext",
1805 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001806 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001807 }
1808 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001809
1810 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001811 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1812 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001813 }
1814
1815 p += extension_data_len;
1816 }
1817
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001819
XiaokangQiand59be772022-01-24 10:12:51 +00001820cleanup:
1821
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1823 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1824 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001825 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1827 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1828 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001829 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1830 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001832}
1833
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001834#if defined(MBEDTLS_DEBUG_C)
1835static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001836{
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001838 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1839 return "psk";
1840 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1841 return "ephemeral";
1842 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1843 return "psk_ephemeral";
1844 default:
1845 return "unknown mode";
1846 }
1847}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001848#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001849
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001850MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001851static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001852{
Jerry Yub85277e2021-10-13 13:36:05 +08001853 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001854 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001855
Jerry Yub85277e2021-10-13 13:36:05 +08001856 /* Determine the key exchange mode:
1857 * 1) If both the pre_shared_key and key_share extensions were received
1858 * then the key exchange mode is PSK with EPHEMERAL.
1859 * 2) If only the pre_shared_key extension was received then the key
1860 * exchange mode is PSK-only.
1861 * 3) If only the key_share extension was received then the key
1862 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001863 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 switch (handshake->received_extensions &
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001865 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1866 MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001867 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001869 handshake->key_exchange_mode =
1870 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001871 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001872
Jerry Yu745bb612021-10-13 22:01:04 +08001873 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001875 handshake->key_exchange_mode =
1876 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001877 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001878
Jerry Yu745bb612021-10-13 22:01:04 +08001879 /* Both the pre_shared_key and key_share extensions were received */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001880 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1881 MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
1882 handshake->key_exchange_mode =
1883 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001884 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001885
Jerry Yu745bb612021-10-13 22:01:04 +08001886 /* Neither pre_shared_key nor key_share extension was received */
1887 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001889 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1890 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001891 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001892#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001893 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1894 (handshake->selected_identity != 0 ||
1895 handshake->ciphersuite_info->id !=
1896 ssl->session_negotiate->ciphersuite)) {
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001897 /* RFC8446 4.2.11
1898 * If the server supplies an "early_data" extension, the
1899 * client MUST verify that the server's selected_identity
1900 * is 0. If any other value is returned, the client MUST
1901 * abort the handshake with an "illegal_parameter" alert.
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001902 *
Xiaokang Qian53c4c272023-02-07 02:42:01 +00001903 * RFC 8446 4.2.10
1904 * In order to accept early data, the server MUST have accepted a PSK
1905 * cipher suite and selected the first key offered in the client's
1906 * "pre_shared_key" extension. In addition, it MUST verify that the
1907 * following values are the same as those associated with the
1908 * selected PSK:
1909 * - The TLS version number
1910 * - The selected cipher suite
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001911 * - The selected ALPN [RFC7301] protocol, if any
1912 *
1913 * We check here that when early data is involved the server
1914 * selected the cipher suite associated to the pre-shared key
1915 * as it must have.
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001916 */
1917 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1918 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1919 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1920 }
1921#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001922
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001923 if (!mbedtls_ssl_conf_tls13_check_kex_modes(
1924 ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001925 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001926 MBEDTLS_SSL_DEBUG_MSG(
1927 2, ("Key exchange mode(%s) is not supported.",
1928 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001929 goto cleanup;
1930 }
1931
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001932 MBEDTLS_SSL_DEBUG_MSG(
1933 3, ("Selected key exchange mode: %s",
1934 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001935
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001936 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001937 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001938 * If we proposed early data then we have already derived an
1939 * early secret using the selected PSK and its associated hash.
1940 * It means that if the negotiated key exchange mode is psk or
1941 * psk_ephemeral, we have already correctly computed the
1942 * early secret and thus we do not do it again. In all other
1943 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001944 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001945#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001946 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1947 handshake->key_exchange_mode ==
1948 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001949#endif
1950 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001951 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1952 if (ret != 0) {
1953 MBEDTLS_SSL_DEBUG_RET(
1954 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1955 goto cleanup;
1956 }
Jerry Yu0b177842021-09-05 19:41:30 +08001957 }
1958
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1960 if (ret != 0) {
1961 MBEDTLS_SSL_DEBUG_RET(1,
1962 "mbedtls_ssl_tls13_compute_handshake_transform",
1963 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001964 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001965 }
1966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1968 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001969 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
Jerry Yu0b177842021-09-05 19:41:30 +08001970 ssl->session_in = ssl->session_negotiate;
1971
Jerry Yu4a173382021-10-11 21:45:31 +08001972cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001974 MBEDTLS_SSL_PEND_FATAL_ALERT(
1975 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001977 }
Jerry Yue110d252022-05-05 10:19:22 +08001978
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001980}
1981
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001982MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001983static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00001984{
1985 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1986
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00001988
XiaokangQian78b1fa72022-01-19 06:56:30 +00001989 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001990 * We are going to re-generate a shared secret corresponding to the group
1991 * selected by the server, which is different from the group for which we
1992 * generated a shared secret in the first client hello.
1993 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001994 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 ret = ssl_tls13_reset_key_share(ssl);
1996 if (ret != 0) {
1997 return ret;
1998 }
XiaokangQian647719a2021-12-07 09:16:29 +00001999
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00002000 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002002}
2003
Jerry Yue1b9c292021-09-10 10:08:31 +08002004/*
Jerry Yu4a173382021-10-11 21:45:31 +08002005 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002006 * Handler for MBEDTLS_SSL_SERVER_HELLO
2007 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002008MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002009static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002010{
Jerry Yu4a173382021-10-11 21:45:31 +08002011 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002012 unsigned char *buf = NULL;
2013 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002014 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002017
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002018 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2019 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002020
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2022 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002023 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 } else {
2025 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2026 }
XiaokangQiand59be772022-01-24 10:12:51 +00002027
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002029 ret = 0;
2030 goto cleanup;
2031 }
2032
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2034 buf + buf_len,
2035 is_hrr));
2036 if (is_hrr) {
2037 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002038 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002039
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002040 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2041 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002042
2043 if (is_hrr) {
2044 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2045#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2046 /* If not offering early data, the client sends a dummy CCS record
2047 * immediately before its second flight. This may either be before
2048 * its second ClientHello or before its encrypted handshake flight.
2049 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002050 mbedtls_ssl_handshake_set_state(
2051 ssl, MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
Gilles Peskine449bd832023-01-11 14:50:10 +01002052#else
2053 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2054#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2055 } else {
2056 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2057 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002058 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002059
2060cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2062 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2063 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002064}
2065
2066/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002067 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002068 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002069 *
2070 * The EncryptedExtensions message contains any extensions which
2071 * should be protected, i.e., any which are not needed to establish
2072 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002073 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002074
XiaokangQian08da26c2021-10-09 10:12:11 +00002075/* Parse EncryptedExtensions message
2076 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002077 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002078 * } EncryptedExtensions;
2079 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002080MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002081static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2082 const unsigned char *buf,
2083 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002084{
2085 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002086 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002087 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002088 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002089 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002090
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2092 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002093 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002096 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002097
Jan Bruckner5a3629b2023-02-23 12:08:09 +01002098 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2099
Jerry Yu9eba7502022-10-31 13:46:16 +08002100 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002101
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002103 unsigned int extension_type;
2104 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002105
XiaokangQian08da26c2021-10-09 10:12:11 +00002106 /*
2107 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002108 * ExtensionType extension_type; (2 bytes)
2109 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002110 * } Extension;
2111 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2113 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2114 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002115 p += 4;
2116
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002118
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002119 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2121 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2122 if (ret != 0) {
2123 return ret;
2124 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002125
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002127#if defined(MBEDTLS_SSL_ALPN)
2128 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002130
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002131 if ((ret = ssl_tls13_parse_alpn_ext(
2132 ssl, p, (size_t) extension_data_len)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002134 }
2135
2136 break;
2137#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002138
2139#if defined(MBEDTLS_SSL_EARLY_DATA)
2140 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002141
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002143 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2145 MBEDTLS_ERR_SSL_DECODE_ERROR);
2146 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002147 }
2148
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002149 break;
2150#endif /* MBEDTLS_SSL_EARLY_DATA */
2151
Jan Bruckner151f6422023-02-10 12:45:19 +01002152#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2153 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
2154 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
2155
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002156 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
2157 ssl, p, p + extension_data_len);
Jan Bruckner151f6422023-02-10 12:45:19 +01002158
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002159 /* TODO: Return unconditionally here until we handle the record
2160 * size limit correctly. Once handled correctly, only return in
2161 * case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01002162 return ret;
2163
2164 break;
2165#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2166
XiaokangQian08da26c2021-10-09 10:12:11 +00002167 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002168 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002169 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002171 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002172 }
2173
XiaokangQian08da26c2021-10-09 10:12:11 +00002174 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002175 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2178 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002179
XiaokangQian97799ac2021-10-11 10:05:54 +00002180 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (p != end) {
2182 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2183 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2184 MBEDTLS_ERR_SSL_DECODE_ERROR);
2185 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002186 }
2187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002189}
2190
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002191MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002192static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002193{
2194 int ret;
2195 unsigned char *buf;
2196 size_t buf_len;
2197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002199
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002200 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2201 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2202 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002203
2204 /* Process the message contents */
2205 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002207
Xiaokang Qianb157e912022-11-23 08:12:26 +00002208#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (ssl->handshake->received_extensions &
2210 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002211 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2212 }
2213#endif
2214
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002215 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2216 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2217 buf, buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002218
Ronald Cron928cbd32022-10-04 16:14:26 +02002219#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2221 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2222 } else {
2223 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2224 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002225#else
2226 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002228#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002229
2230cleanup:
2231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2233 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002234
2235}
2236
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002237/*
2238 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2239 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002240 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002241 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002242 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002243 *
2244 * If the server sent an "early_data" extension in EncryptedExtensions, the
2245 * client MUST send an EndOfEarlyData message after receiving the server
2246 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002247 */
2248
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002249MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002250static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2251{
2252 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002253 unsigned char *buf = NULL;
2254 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002255 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002256
Xiaokang Qian742578c2022-12-19 06:34:44 +00002257 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
Xiaokang Qian0de0d862023-02-08 06:04:50 +00002258 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
2259 &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002260
Manuel Pégourié-Gonnard63e33dd2023-02-21 15:45:15 +01002261 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_hdr_to_checksum(
2262 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002263
Xiaokang Qian742578c2022-12-19 06:34:44 +00002264 MBEDTLS_SSL_PROC_CHK(
2265 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002266
Xiaokang Qian19d44162023-01-03 03:39:50 +00002267 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002268
2269cleanup:
2270
2271 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2272 return ret;
2273}
2274
Ronald Cron928cbd32022-10-04 16:14:26 +02002275#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002276/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002277 * STATE HANDLING: CertificateRequest
2278 *
Jerry Yud2674312021-10-29 10:08:19 +08002279 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002280#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2281#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002282/* Coordination:
2283 * Deals with the ambiguity of not knowing if a CertificateRequest
2284 * will be sent. Returns a negative code on failure, or
2285 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2286 * - SSL_CERTIFICATE_REQUEST_SKIP
2287 * indicating if a Certificate Request is expected or not.
2288 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002289MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002290static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002291{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002292 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002293
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2295 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2296 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002297 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002298 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002299
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2301 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2302 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2303 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002304 }
2305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002309}
2310
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002311/*
2312 * ssl_tls13_parse_certificate_request()
2313 * Parse certificate request
2314 * struct {
2315 * opaque certificate_request_context<0..2^8-1>;
2316 * Extension extensions<2..2^16-1>;
2317 * } CertificateRequest;
2318 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002319MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002320static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2321 const unsigned char *buf,
2322 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002323{
2324 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2325 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002326 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002327 size_t extensions_len = 0;
2328 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002329 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002330
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002331 /* ...
2332 * opaque certificate_request_context<0..2^8-1>
2333 * ...
2334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002336 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002337 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002338
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 if (certificate_request_context_len > 0) {
2340 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2341 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2342 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002343
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002344 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 mbedtls_calloc(1, certificate_request_context_len);
2346 if (handshake->certificate_request_context == NULL) {
2347 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2348 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002349 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 memcpy(handshake->certificate_request_context, p,
2351 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002352 p += certificate_request_context_len;
2353 }
2354
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002355 /* ...
2356 * Extension extensions<2..2^16-1>;
2357 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002358 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2360 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002361 p += 2;
2362
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002364 extensions_end = p + extensions_len;
2365
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002366 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002369 unsigned int extension_type;
2370 size_t extension_data_len;
2371
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2373 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2374 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002375 p += 4;
2376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002378
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002379 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2381 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2382 if (ret != 0) {
2383 return ret;
2384 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002385
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002387 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 MBEDTLS_SSL_DEBUG_MSG(3,
2389 ("found signature algorithms extension"));
2390 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2391 p + extension_data_len);
2392 if (ret != 0) {
2393 return ret;
2394 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002395
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002396 break;
2397
2398 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002399 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002400 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002402 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002403 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002404
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002405 p += extension_data_len;
2406 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002407
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2409 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002410
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002411 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 if (p != end) {
2413 MBEDTLS_SSL_DEBUG_MSG(1,
2414 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002415 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002416 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002417
Jerry Yu0c354a22022-08-29 15:25:36 +08002418 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002419 *
2420 * The "signature_algorithms" extension MUST be specified
2421 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2423 MBEDTLS_SSL_DEBUG_MSG(3,
2424 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002425 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002426 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002427
Jerry Yu7840f812022-01-29 10:26:51 +08002428 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002430
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002431decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2433 MBEDTLS_ERR_SSL_DECODE_ERROR);
2434 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002435}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002436
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002437/*
2438 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2439 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002440MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002441static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002442{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002443 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002444
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002448
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002450 unsigned char *buf;
2451 size_t buf_len;
2452
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002453 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2454 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2455 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002456
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002457 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(
2458 ssl, buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002459
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002460 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2461 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2462 buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002464 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 } else {
2466 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002467 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2468 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002469 }
2470
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002472
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002473cleanup:
2474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2476 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002477}
2478
2479/*
Jerry Yu687101b2021-09-14 16:03:56 +08002480 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2481 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002482MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002483static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002484{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002485 int ret;
2486
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2488 if (ret != 0) {
2489 return ret;
2490 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2493 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002494}
2495
2496/*
2497 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2498 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002499MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002500static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002501{
Jerry Yu30b071c2021-09-12 20:16:03 +08002502 int ret;
2503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2505 if (ret != 0) {
2506 return ret;
2507 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2510 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002511}
Ronald Cron928cbd32022-10-04 16:14:26 +02002512#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002513
Jerry Yu687101b2021-09-14 16:03:56 +08002514/*
2515 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2516 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002517MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002518static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002519{
XiaokangQianac0385c2021-11-03 06:40:11 +00002520 int ret;
2521
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2523 if (ret != 0) {
2524 return ret;
2525 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002526
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2528 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002529 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2531 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2532 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002533 }
2534
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002535#if defined(MBEDTLS_SSL_EARLY_DATA)
2536 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2537 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002538 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2539 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002540 } else
2541#endif /* MBEDTLS_SSL_EARLY_DATA */
2542 {
2543#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2544 mbedtls_ssl_handshake_set_state(
2545 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2546#else
2547 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2548#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2549 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002552}
2553
2554/*
Jerry Yu566c7812022-01-26 15:41:22 +08002555 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2556 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002557MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002558static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002559{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002560 int non_empty_certificate_msg = 0;
2561
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 MBEDTLS_SSL_DEBUG_MSG(1,
2563 ("Switch to handshake traffic keys for outbound traffic"));
2564 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002565
Ronald Cron928cbd32022-10-04 16:14:26 +02002566#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (ssl->handshake->client_auth) {
2568 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2569 if (ret != 0) {
2570 return ret;
2571 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002574 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 }
2576 } else {
2577 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002578 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002579#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (non_empty_certificate_msg) {
2582 mbedtls_ssl_handshake_set_state(ssl,
2583 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2584 } else {
2585 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2586 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2587 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002590}
2591
Ronald Cron928cbd32022-10-04 16:14:26 +02002592#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002593/*
2594 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2595 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002596MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002597static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002598{
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if (ret == 0) {
2602 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2603 }
Ronald Crona8b38872022-03-09 07:59:25 +01002604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002606}
Ronald Cron928cbd32022-10-04 16:14:26 +02002607#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002608
2609/*
Jerry Yu687101b2021-09-14 16:03:56 +08002610 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2611 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002612MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002613static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002614{
XiaokangQian0fa66432021-11-15 03:33:57 +00002615 int ret;
2616
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2618 if (ret != 0) {
2619 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002620 }
2621
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2623 if (ret != 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002624 MBEDTLS_SSL_DEBUG_RET(
2625 1, "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 return ret;
2627 }
2628
2629 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2630 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002631}
2632
2633/*
2634 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2635 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002636MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002637static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002638{
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2640 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2641 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002642}
2643
2644/*
2645 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2646 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002647MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002648static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002649{
Jerry Yu378254d2021-10-30 21:44:47 +08002650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2654 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002655}
2656
Jerry Yuf8a49942022-07-07 11:32:32 +00002657#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2658
Jerry Yua0446a02022-07-13 11:22:55 +08002659MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002660static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2661 const unsigned char *buf,
2662 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002663{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002664 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002665 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002666
Jerry Yuf8a49942022-07-07 11:32:32 +00002667
Jerry Yuedab6372022-10-31 14:37:31 +08002668 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002671 unsigned int extension_type;
2672 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002673 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2676 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2677 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002678 p += 4;
2679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002681
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002682 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2684 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2685 if (ret != 0) {
2686 return ret;
2687 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002688
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002690#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002691 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002693 MBEDTLS_SSL_PEND_FATAL_ALERT(
2694 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 MBEDTLS_ERR_SSL_DECODE_ERROR);
2696 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002697 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002699 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002701 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002702 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002703#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002704
Jerry Yuf8a49942022-07-07 11:32:32 +00002705 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002706 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002707 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002709 break;
2710 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002711
Jerry Yuf8a49942022-07-07 11:32:32 +00002712 p += extension_data_len;
2713 }
2714
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2716 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002717
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002719}
2720
2721/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002722 * From RFC8446, page 74
2723 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002724 * struct {
2725 * uint32 ticket_lifetime;
2726 * uint32 ticket_age_add;
2727 * opaque ticket_nonce<0..255>;
2728 * opaque ticket<1..2^16-1>;
2729 * Extension extensions<0..2^16-2>;
2730 * } NewSessionTicket;
2731 *
2732 */
Jerry Yua0446a02022-07-13 11:22:55 +08002733MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002734static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2735 unsigned char *buf,
2736 unsigned char *end,
2737 unsigned char **ticket_nonce,
2738 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002739{
2740 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2741 unsigned char *p = buf;
2742 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002743 size_t ticket_len;
2744 unsigned char *ticket;
2745 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002746
Jerry Yucb3b1392022-07-12 06:09:38 +00002747 *ticket_nonce = NULL;
2748 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002749 /*
2750 * ticket_lifetime 4 bytes
2751 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002752 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002753 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002755
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2757 MBEDTLS_SSL_DEBUG_MSG(3,
2758 ("ticket_lifetime: %u",
2759 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2762 MBEDTLS_SSL_DEBUG_MSG(3,
2763 ("ticket_age_add: %u",
2764 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002765
Jerry Yucb3b1392022-07-12 06:09:38 +00002766 *ticket_nonce_len = p[8];
2767 p += 9;
2768
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002770 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002772 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002773
2774 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2776 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002777 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2779 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002780
2781 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if (session->ticket != NULL || session->ticket_len > 0) {
2783 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002784 session->ticket = NULL;
2785 session->ticket_len = 0;
2786 }
2787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2789 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2790 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002791 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002793 p += ticket_len;
2794 session->ticket = ticket;
2795 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002796
Pengyu Lv9f926952022-11-17 15:22:33 +08002797 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002798 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002799 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2802 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002803 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2809 if (ret != 0) {
2810 MBEDTLS_SSL_DEBUG_RET(1,
2811 "ssl_tls13_parse_new_session_ticket_exts",
2812 ret);
2813 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002814 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002815
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002816 /* session has been updated, allow export */
2817 session->exported = 0;
2818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002820}
2821
Jerry Yua0446a02022-07-13 11:22:55 +08002822MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002823static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2824 unsigned char *ticket_nonce,
2825 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002826{
2827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2828 mbedtls_ssl_session *session = ssl->session;
2829 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2830 psa_algorithm_t psa_hash_alg;
2831 int hash_length;
2832
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002833#if defined(MBEDTLS_HAVE_TIME)
2834 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002836#endif
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2839 if (ciphersuite_info == NULL) {
2840 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2841 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002842 }
2843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2845 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2846 if (hash_length == -1 ||
2847 (size_t) hash_length > sizeof(session->resumption_key)) {
2848 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002849 }
2850
Jerry Yuf8a49942022-07-07 11:32:32 +00002851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2853 session->app_secrets.resumption_master_secret,
2854 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002855
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002856 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002857 *
2858 * HKDF-Expand-Label( resumption_master_secret,
2859 * "resumption", ticket_nonce, Hash.length )
2860 */
2861 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 psa_hash_alg,
2863 session->app_secrets.resumption_master_secret,
2864 hash_length,
2865 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2866 ticket_nonce,
2867 ticket_nonce_len,
2868 session->resumption_key,
2869 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 if (ret != 0) {
2872 MBEDTLS_SSL_DEBUG_RET(2,
2873 "Creating the ticket-resumed PSK failed",
2874 ret);
2875 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002876 }
2877
Jerry Yu0a430c82022-07-20 11:02:48 +08002878 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002879
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2881 session->resumption_key,
2882 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002883
Pengyu Lv9f926952022-11-17 15:22:33 +08002884 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002885 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002886 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002887 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002888
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002890}
2891
2892/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002893 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002894 */
Jerry Yua0446a02022-07-13 11:22:55 +08002895MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002896static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002897{
2898 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2899 unsigned char *buf;
2900 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002901 unsigned char *ticket_nonce;
2902 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002903
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2907 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2908 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002909
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2911 ssl, buf, buf + buf_len,
2912 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002913
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2915 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002916
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002918
Jerry Yuf8a49942022-07-07 11:32:32 +00002919cleanup:
2920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2922 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002923}
2924#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002927{
Jerry Yu92c6b402021-08-27 16:59:09 +08002928 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002929
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002931 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002933 break;
2934
Jerry Yu92c6b402021-08-27 16:59:09 +08002935 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002937 break;
2938
2939 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002941 break;
2942
2943 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002945 break;
2946
Ronald Cron928cbd32022-10-04 16:14:26 +02002947#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002948 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002950 break;
2951
Jerry Yu687101b2021-09-14 16:03:56 +08002952 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002954 break;
2955
2956 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002958 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002959#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002960
2961 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002963 break;
2964
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002965 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2966 ret = ssl_tls13_write_end_of_early_data(ssl);
2967 break;
2968
Jerry Yu566c7812022-01-26 15:41:22 +08002969 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002971 break;
2972
Ronald Cron928cbd32022-10-04 16:14:26 +02002973#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002974 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002976 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002977#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002978
Jerry Yu687101b2021-09-14 16:03:56 +08002979 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002981 break;
2982
2983 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002985 break;
2986
2987 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002989 break;
2990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 /*
2992 * Injection of dummy-CCS's for middlebox compatibility
2993 */
Ronald Cron49ad6192021-11-24 16:25:31 +01002994#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002995 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2997 if (ret == 0) {
2998 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2999 }
Ronald Cron9f55f632022-02-02 16:02:47 +01003000 break;
3001
3002 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3004 if (ret == 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00003005 mbedtls_ssl_handshake_set_state(
3006 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 }
Ronald Cron49ad6192021-11-24 16:25:31 +01003008 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003009
Xiaokang Qian592021a2023-01-04 10:47:05 +00003010 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3011 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3012 if (ret == 0) {
3013 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3014
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003015#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003016 MBEDTLS_SSL_DEBUG_MSG(
3017 1, ("Switch to early data keys for outbound traffic"));
3018 mbedtls_ssl_set_outbound_transform(
3019 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003020#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003021 }
3022 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003023#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3024
Jerry Yuf8a49942022-07-07 11:32:32 +00003025#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003026 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 ret = ssl_tls13_process_new_session_ticket(ssl);
3028 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003029 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003031 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3032 break;
3033#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3034
Jerry Yu92c6b402021-08-27 16:59:09 +08003035 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3037 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003038 }
3039
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003041}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003042
Jerry Yufb4b6472022-01-27 15:03:26 +08003043#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */