blob: 6ec3170076e60c1884e06d96de898b8013b59f07 [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"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020036#include "md_psa.h"
Jerry Yubdc71882021-09-14 19:30:36 +080037
Andrzej Kureka6033ac2023-05-30 15:16:34 -040038#if defined(PSA_WANT_ALG_ECDH)
Andrzej Kurek00644842023-05-30 05:45:00 -040039/* Define a local translating function to save code size by not using too many
40 * arguments in each translating place. */
41static int local_err_translation(psa_status_t status)
42{
43 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040044 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040045 psa_generic_status_to_mbedtls);
46}
47#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kureka6033ac2023-05-30 15:16:34 -040048#endif
49
Jerry Yubc20bdd2021-08-24 15:59:48 +080050/* Write extensions */
51
Jerry Yu92c6b402021-08-27 16:59:09 +080052/*
53 * ssl_tls13_write_supported_versions_ext():
54 *
55 * struct {
56 * ProtocolVersion versions<2..254>;
57 * } SupportedVersions;
58 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020059MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010060static int ssl_tls13_write_supported_versions_ext(mbedtls_ssl_context *ssl,
61 unsigned char *buf,
62 unsigned char *end,
63 size_t *out_len)
Jerry Yu92c6b402021-08-27 16:59:09 +080064{
65 unsigned char *p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +010066 unsigned char versions_len = (ssl->handshake->min_tls_version <=
67 MBEDTLS_SSL_VERSION_TLS1_2) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080068
Xiaofei Baid25fab62021-12-02 06:36:27 +000069 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080070
Gilles Peskine449bd832023-01-11 14:50:10 +010071 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding supported versions extension"));
Jerry Yu92c6b402021-08-27 16:59:09 +080072
Jerry Yu388bd0d2021-09-15 18:41:02 +080073 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080074 * - extension_type (2 bytes)
75 * - extension_data_length (2 bytes)
76 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020077 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080078 */
Gilles Peskine449bd832023-01-11 14:50:10 +010079 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 5 + versions_len);
Ronald Crondbe87f02022-02-10 14:35:27 +010080
Gilles Peskine449bd832023-01-11 14:50:10 +010081 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0);
82 MBEDTLS_PUT_UINT16_BE(versions_len + 1, p, 2);
Jerry Yueecfbf02021-08-30 18:32:07 +080083 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080084
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080085 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010086 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080087
Jerry Yu0c63af62021-09-02 12:59:12 +080088 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080089 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010090 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080091 */
Gilles Peskine449bd832023-01-11 14:50:10 +010092 mbedtls_ssl_write_version(p, MBEDTLS_SSL_TRANSPORT_STREAM,
93 MBEDTLS_SSL_VERSION_TLS1_3);
94 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:4]"));
Jerry Yu92c6b402021-08-27 16:59:09 +080095
Jerry Yu92c6b402021-08-27 16:59:09 +080096
Gilles Peskine449bd832023-01-11 14:50:10 +010097 if (ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
98 mbedtls_ssl_write_version(p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
99 MBEDTLS_SSL_VERSION_TLS1_2);
100 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:3]"));
Ronald Crondbe87f02022-02-10 14:35:27 +0100101 }
102
103 *out_len = 5 + versions_len;
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800104
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800105 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800107
Gilles Peskine449bd832023-01-11 14:50:10 +0100108 return 0;
Jerry Yu92c6b402021-08-27 16:59:09 +0800109}
Jerry Yubc20bdd2021-08-24 15:59:48 +0800110
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200111MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100112static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
113 const unsigned char *buf,
114 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800115{
Jerry Yue1b9c292021-09-10 10:08:31 +0800116 ((void) ssl);
117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
119 if (mbedtls_ssl_read_version(buf, ssl->conf->transport) !=
120 MBEDTLS_SSL_VERSION_TLS1_3) {
121 MBEDTLS_SSL_DEBUG_MSG(1, ("unexpected version"));
Jerry Yu4a173382021-10-11 21:45:31 +0800122
Gilles Peskine449bd832023-01-11 14:50:10 +0100123 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
124 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
125 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +0800126 }
127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128 if (&buf[2] != end) {
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000129 MBEDTLS_SSL_DEBUG_MSG(
130 1, ("supported_versions ext data length incorrect"));
Gilles Peskine449bd832023-01-11 14:50:10 +0100131 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
132 MBEDTLS_ERR_SSL_DECODE_ERROR);
133 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Ronald Cron98473382022-03-30 20:04:10 +0200134 }
135
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +0800137}
138
lhuang0486cacac2022-01-21 07:34:27 -0800139#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200140MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100141static int ssl_tls13_parse_alpn_ext(mbedtls_ssl_context *ssl,
142 const unsigned char *buf, size_t len)
lhuang0486cacac2022-01-21 07:34:27 -0800143{
lhuang0486cacac2022-01-21 07:34:27 -0800144 const unsigned char *p = buf;
145 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200146 size_t protocol_name_list_len, protocol_name_len;
147 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800148
149 /* If we didn't send it, the server shouldn't send it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (ssl->conf->alpn_list == NULL) {
151 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
152 }
lhuang0486cacac2022-01-21 07:34:27 -0800153
154 /*
155 * opaque ProtocolName<1..2^8-1>;
156 *
157 * struct {
158 * ProtocolName protocol_name_list<2..2^16-1>
159 * } ProtocolNameList;
160 *
161 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
162 */
163
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
165 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
lhuang0486cacac2022-01-21 07:34:27 -0800166 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800167
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
Ronald Cron81a334f2022-05-31 16:04:11 +0200169 protocol_name_list_end = p + protocol_name_list_len;
170
Gilles Peskine449bd832023-01-11 14:50:10 +0100171 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, 1);
Ronald Cron81a334f2022-05-31 16:04:11 +0200172 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800173
174 /* Check that the server chosen protocol was in our list and save it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, protocol_name_len);
176 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
177 if (protocol_name_len == strlen(*alpn) &&
178 memcmp(p, *alpn, protocol_name_len) == 0) {
lhuang0486cacac2022-01-21 07:34:27 -0800179 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 return 0;
lhuang0486cacac2022-01-21 07:34:27 -0800181 }
182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
lhuang0486cacac2022-01-21 07:34:27 -0800185}
186#endif /* MBEDTLS_SSL_ALPN */
187
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200188MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100189static int ssl_tls13_reset_key_share(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +0000190{
191 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 if (group_id == 0) {
194 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
195 }
XiaokangQian647719a2021-12-07 09:16:29 +0000196
Valerio Setti080a22b2023-03-20 15:22:47 +0100197#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100199 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
200 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
201
202 /* Destroy generated private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100203 status = psa_destroy_key(ssl->handshake->ecdh_psa_privkey);
204 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500205 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 MBEDTLS_SSL_DEBUG_RET(1, "psa_destroy_key", ret);
207 return ret;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100208 }
209
210 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 return 0;
212 } else
Valerio Setti080a22b2023-03-20 15:22:47 +0100213#endif /* PSA_WANT_ALG_ECDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100214 if (0 /* other KEMs? */) {
XiaokangQian647719a2021-12-07 09:16:29 +0000215 /* Do something */
216 }
217
Gilles Peskine449bd832023-01-11 14:50:10 +0100218 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQian647719a2021-12-07 09:16:29 +0000219}
220
221/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800222 * Functions for writing key_share extension.
223 */
Ronald Cron766c0cd2022-10-18 12:17:11 +0200224#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200225MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100226static int ssl_tls13_get_default_group_id(mbedtls_ssl_context *ssl,
227 uint16_t *group_id)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800228{
229 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
230
Jerry Yu56fc07f2021-09-01 17:48:49 +0800231
Valerio Setti080a22b2023-03-20 15:22:47 +0100232#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100233 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Jerry Yu388bd0d2021-09-15 18:41:02 +0800234 /* Pick first available ECDHE group compatible with TLS 1.3 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100235 if (group_list == NULL) {
236 return MBEDTLS_ERR_SSL_BAD_CONFIG;
237 }
Jerry Yu388bd0d2021-09-15 18:41:02 +0800238
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 for (; *group_list != 0; group_list++) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000240 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
241 *group_list, NULL, NULL) == PSA_SUCCESS) &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
Brett Warren14efd332021-10-06 09:32:11 +0100243 *group_id = *group_list;
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800245 }
246 }
247#else
248 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800249 ((void) group_id);
Valerio Setti080a22b2023-03-20 15:22:47 +0100250#endif /* PSA_WANT_ALG_ECDH */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800251
252 /*
253 * Add DHE named groups here.
Jerry Yu388bd0d2021-09-15 18:41:02 +0800254 * Pick first available DHE group compatible with TLS 1.3
Jerry Yu56fc07f2021-09-01 17:48:49 +0800255 */
256
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800258}
259
260/*
261 * ssl_tls13_write_key_share_ext
262 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800263 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800264 *
265 * struct {
266 * NamedGroup group;
267 * opaque key_exchange<1..2^16-1>;
268 * } KeyShareEntry;
269 * struct {
270 * KeyShareEntry client_shares<0..2^16-1>;
271 * } KeyShareClientHello;
272 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200273MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100274static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
275 unsigned char *buf,
276 unsigned char *end,
277 size_t *out_len)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800278{
279 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000280 unsigned char *client_shares; /* Start of client_shares */
281 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800282 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800283 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
284
Xiaofei Baid25fab62021-12-02 06:36:27 +0000285 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800286
Jerry Yub60e3cf2021-09-08 16:41:02 +0800287 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800288 * - extension_type (2 bytes)
289 * - extension_data_length (2 bytes)
290 * - client_shares_length (2 bytes)
291 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800293 p += 6;
294
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello: adding key share extension"));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800296
297 /* HRR could already have requested something else. */
298 group_id = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 if (!mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) &&
300 !mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
301 MBEDTLS_SSL_PROC_CHK(ssl_tls13_get_default_group_id(ssl,
302 &group_id));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800303 }
304
305 /*
306 * Dispatch to type-specific key generation function.
307 *
308 * So far, we're only supporting ECDHE. With the introduction
309 * of PQC KEMs, we'll want to have multiple branches, one per
310 * type of KEM, and dispatch to the corresponding crypto. And
311 * only one key share entry is allowed.
312 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000313 client_shares = p;
Valerio Setti080a22b2023-03-20 15:22:47 +0100314#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800316 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000317 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800318 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100319 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800320
321 /* Check there is space for header of KeyShareEntry
322 * - group (2 bytes)
323 * - key_exchange_length (2 bytes)
324 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800326 p += 4;
Jerry Yu89e103c2022-03-30 22:43:29 +0800327 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 ssl, group_id, p, end, &key_exchange_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800329 p += key_exchange_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 if (ret != 0) {
331 return ret;
332 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800333
334 /* Write group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 MBEDTLS_PUT_UINT16_BE(group_id, group, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800336 /* Write key_exchange_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 MBEDTLS_PUT_UINT16_BE(key_exchange_len, group, 2);
338 } else
Valerio Setti080a22b2023-03-20 15:22:47 +0100339#endif /* PSA_WANT_ALG_ECDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 if (0 /* other KEMs? */) {
Jerry Yu56fc07f2021-09-01 17:48:49 +0800341 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 } else {
343 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800344 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800345
Jerry Yub60e3cf2021-09-08 16:41:02 +0800346 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000347 client_shares_len = p - client_shares;
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 if (client_shares_len == 0) {
349 MBEDTLS_SSL_DEBUG_MSG(1, ("No key share defined."));
350 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu7c522d42021-09-08 17:55:09 +0800351 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800352 /* Write extension_type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800354 /* Write extension_data_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 MBEDTLS_PUT_UINT16_BE(client_shares_len + 2, buf, 2);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800356 /* Write client_shares_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 MBEDTLS_PUT_UINT16_BE(client_shares_len, buf, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800358
359 /* Update offered_group_id field */
360 ssl->handshake->offered_group_id = group_id;
361
362 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000363 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800364
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000365 MBEDTLS_SSL_DEBUG_BUF(
366 3, "client hello, key_share extension", buf, *out_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800367
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800369
370cleanup:
371
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800373}
Ronald Cron766c0cd2022-10-18 12:17:11 +0200374#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +0800375
XiaokangQiand59be772022-01-24 10:12:51 +0000376/*
377 * ssl_tls13_parse_hrr_key_share_ext()
378 * Parse key_share extension in Hello Retry Request
379 *
380 * struct {
381 * NamedGroup selected_group;
382 * } KeyShareHelloRetryRequest;
383 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200384MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100385static int ssl_tls13_parse_hrr_key_share_ext(mbedtls_ssl_context *ssl,
386 const unsigned char *buf,
387 const unsigned char *end)
XiaokangQianb851da82022-01-14 04:03:11 +0000388{
Valerio Setti080a22b2023-03-20 15:22:47 +0100389#if defined(PSA_WANT_ALG_ECDH)
XiaokangQianb851da82022-01-14 04:03:11 +0000390 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000391 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000392 int found = 0;
393
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
395 if (group_list == NULL) {
396 return MBEDTLS_ERR_SSL_BAD_CONFIG;
397 }
XiaokangQianb851da82022-01-14 04:03:11 +0000398
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 MBEDTLS_SSL_DEBUG_BUF(3, "key_share extension", p, end - buf);
XiaokangQianb851da82022-01-14 04:03:11 +0000400
401 /* Read selected_group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
403 selected_group = MBEDTLS_GET_UINT16_BE(p, 0);
404 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_group ( %d )", selected_group));
XiaokangQianb851da82022-01-14 04:03:11 +0000405
406 /* Upon receipt of this extension in a HelloRetryRequest, the client
407 * MUST first verify that the selected_group field corresponds to a
408 * group which was provided in the "supported_groups" extension in the
409 * original ClientHello.
410 * The supported_group was based on the info in ssl->conf->group_list.
411 *
412 * If the server provided a key share that was not sent in the ClientHello
413 * then the client MUST abort the handshake with an "illegal_parameter" alert.
414 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 for (; *group_list != 0; group_list++) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000416 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
417 *group_list, NULL, NULL) == PSA_ERROR_NOT_SUPPORTED) ||
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 *group_list != selected_group) {
XiaokangQianb851da82022-01-14 04:03:11 +0000419 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 }
XiaokangQianb851da82022-01-14 04:03:11 +0000421
422 /* We found a match */
423 found = 1;
424 break;
425 }
426
427 /* Client MUST verify that the selected_group field does not
428 * correspond to a group which was provided in the "key_share"
429 * extension in the original ClientHello. If the server sent an
430 * HRR message with a key share already provided in the
431 * ClientHello then the client MUST abort the handshake with
432 * an "illegal_parameter" alert.
433 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 if (found == 0 || selected_group == ssl->handshake->offered_group_id) {
435 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid key share in HRR"));
XiaokangQianb851da82022-01-14 04:03:11 +0000436 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
438 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
439 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQianb851da82022-01-14 04:03:11 +0000440 }
441
442 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000443 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 return 0;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400446#else
447 (void) ssl;
448 (void) buf;
449 (void) end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400451#endif
XiaokangQianb851da82022-01-14 04:03:11 +0000452}
453
Jerry Yue1b9c292021-09-10 10:08:31 +0800454/*
Jerry Yub85277e2021-10-13 13:36:05 +0800455 * ssl_tls13_parse_key_share_ext()
456 * Parse key_share extension in Server Hello
457 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800458 * struct {
459 * KeyShareEntry server_share;
460 * } KeyShareServerHello;
461 * struct {
462 * NamedGroup group;
463 * opaque key_exchange<1..2^16-1>;
464 * } KeyShareEntry;
465 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200466MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100467static int ssl_tls13_parse_key_share_ext(mbedtls_ssl_context *ssl,
468 const unsigned char *buf,
469 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800470{
Jerry Yub85277e2021-10-13 13:36:05 +0800471 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800472 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800473 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800474
Jerry Yu4a173382021-10-11 21:45:31 +0800475 /* ...
476 * NamedGroup group; (2 bytes)
477 * ...
478 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
480 group = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +0800481 p += 2;
482
Jerry Yu4a173382021-10-11 21:45:31 +0800483 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800484 offered_group = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 if (offered_group != group) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000486 MBEDTLS_SSL_DEBUG_MSG(
487 1, ("Invalid server key share, our group %u, their group %u",
488 (unsigned) offered_group, (unsigned) group));
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
490 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
491 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yue1b9c292021-09-10 10:08:31 +0800492 }
493
Valerio Setti080a22b2023-03-20 15:22:47 +0100494#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
496 if (mbedtls_ssl_get_psa_curve_info_from_tls_id(group, NULL, NULL)
497 == PSA_ERROR_NOT_SUPPORTED) {
498 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid TLS curve group id"));
499 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100500 }
501
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000502 MBEDTLS_SSL_DEBUG_MSG(
503 2,
504 ("ECDH curve: %s", mbedtls_ssl_get_curve_name_from_tls_id(group)));
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100505
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(ssl, p, end - p);
507 if (ret != 0) {
508 return ret;
509 }
510 } else
Valerio Setti080a22b2023-03-20 15:22:47 +0100511#endif /* PSA_WANT_ALG_ECDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 if (0 /* other KEMs? */) {
Jerry Yue1b9c292021-09-10 10:08:31 +0800513 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 } else {
515 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yue1b9c292021-09-10 10:08:31 +0800516 }
Jerry Yue1b9c292021-09-10 10:08:31 +0800517
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +0800519}
520
XiaokangQiand59be772022-01-24 10:12:51 +0000521/*
522 * ssl_tls13_parse_cookie_ext()
523 * Parse cookie extension in Hello Retry Request
524 *
525 * struct {
526 * opaque cookie<1..2^16-1>;
527 * } Cookie;
528 *
529 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
530 * extension to the client (this is an exception to the usual rule that
531 * the only extensions that may be sent are those that appear in the
532 * ClientHello). When sending the new ClientHello, the client MUST copy
533 * the contents of the extension received in the HelloRetryRequest into
534 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
535 * cookies in their initial ClientHello in subsequent connections.
536 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200537MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100538static int ssl_tls13_parse_cookie_ext(mbedtls_ssl_context *ssl,
539 const unsigned char *buf,
540 const unsigned char *end)
XiaokangQian43550bd2022-01-21 04:32:58 +0000541{
XiaokangQian25c9c902022-02-08 10:49:53 +0000542 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000543 const unsigned char *p = buf;
544 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
545
546 /* Retrieve length field of cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
548 cookie_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian43550bd2022-01-21 04:32:58 +0000549 p += 2;
550
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cookie_len);
552 MBEDTLS_SSL_DEBUG_BUF(3, "cookie extension", p, cookie_len);
XiaokangQian43550bd2022-01-21 04:32:58 +0000553
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 mbedtls_free(handshake->cookie);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800555 handshake->cookie_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 handshake->cookie = mbedtls_calloc(1, cookie_len);
557 if (handshake->cookie == NULL) {
558 MBEDTLS_SSL_DEBUG_MSG(1,
559 ("alloc failed ( %ud bytes )",
560 cookie_len));
561 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
XiaokangQian43550bd2022-01-21 04:32:58 +0000562 }
563
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 memcpy(handshake->cookie, p, cookie_len);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800565 handshake->cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000566
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return 0;
XiaokangQian43550bd2022-01-21 04:32:58 +0000568}
XiaokangQian43550bd2022-01-21 04:32:58 +0000569
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200570MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100571static int ssl_tls13_write_cookie_ext(mbedtls_ssl_context *ssl,
572 unsigned char *buf,
573 unsigned char *end,
574 size_t *out_len)
XiaokangQian0b64eed2022-01-27 10:36:51 +0000575{
576 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000577 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000578 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000579
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 if (handshake->cookie == NULL) {
581 MBEDTLS_SSL_DEBUG_MSG(3, ("no cookie to send; skip extension"));
582 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000583 }
584
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, cookie",
586 handshake->cookie,
587 handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 MBEDTLS_SSL_CHK_BUF_PTR(p, end, handshake->cookie_len + 6);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000590
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding cookie extension"));
XiaokangQian0b64eed2022-01-27 10:36:51 +0000592
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_COOKIE, p, 0);
594 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len + 2, p, 2);
595 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len, p, 4);
XiaokangQian233397e2022-02-07 08:32:16 +0000596 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000597
598 /* Cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 memcpy(p, handshake->cookie, handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000600
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800601 *out_len = handshake->cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000602
Gilles Peskine449bd832023-01-11 14:50:10 +0100603 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_COOKIE);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800604
Gilles Peskine449bd832023-01-11 14:50:10 +0100605 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000606}
607
Ronald Cron41a443a2022-10-04 16:38:25 +0200608#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000609/*
610 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
611 *
612 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
613 *
614 * struct {
615 * PskKeyExchangeMode ke_modes<1..255>;
616 * } PskKeyExchangeModes;
617 */
XiaokangQian86981952022-07-19 09:51:50 +0000618MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100619static int ssl_tls13_write_psk_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
620 unsigned char *buf,
621 unsigned char *end,
622 size_t *out_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000623{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000624 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000625 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000626
Gilles Peskine449bd832023-01-11 14:50:10 +0100627 ((void) ke_modes_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000628 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000629
XiaokangQianeb69aee2022-07-05 08:21:43 +0000630 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000631 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000632 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100633 if (!mbedtls_ssl_conf_tls13_some_psk_enabled(ssl)) {
634 MBEDTLS_SSL_DEBUG_MSG(3, ("skip psk_key_exchange_modes extension"));
635 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000636 }
637
638 /* Require 7 bytes of data, otherwise fail,
639 * even if extension might be shorter.
640 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100641 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000642 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 3, ("client hello, adding psk_key_exchange_modes extension"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000644
Gilles Peskine449bd832023-01-11 14:50:10 +0100645 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000646
XiaokangQian008d2bf2022-07-14 07:54:01 +0000647 /* Skip extension length (2 bytes) and
648 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000649 */
650 p += 5;
651
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl)) {
XiaokangQianeb69aee2022-07-05 08:21:43 +0000653 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000654 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000655
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding PSK-ECDHE key exchange mode"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000657 }
658
Gilles Peskine449bd832023-01-11 14:50:10 +0100659 if (mbedtls_ssl_conf_tls13_psk_enabled(ssl)) {
Ronald Crona709a0f2022-09-27 16:46:11 +0200660 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
661 ke_modes_len++;
662
Gilles Peskine449bd832023-01-11 14:50:10 +0100663 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding pure PSK key exchange mode"));
Ronald Crona709a0f2022-09-27 16:46:11 +0200664 }
665
XiaokangQian008d2bf2022-07-14 07:54:01 +0000666 /* Now write the extension and ke_modes length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 MBEDTLS_PUT_UINT16_BE(ke_modes_len + 1, buf, 2);
XiaokangQian008d2bf2022-07-14 07:54:01 +0000668 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000669
670 *out_len = p - buf;
Jerry Yu0c354a22022-08-29 15:25:36 +0800671
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800672 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 ssl, MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800674
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000676}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800677
Gilles Peskine449bd832023-01-11 14:50:10 +0100678static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg(int ciphersuite)
Jerry Yuf7c12592022-09-28 22:09:38 +0800679{
Jerry Yu21f90952022-10-08 10:30:53 +0800680 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 if (ciphersuite_info != NULL) {
Manuel Pégourié-Gonnard1f2a5872023-03-28 11:46:17 +0200684 return mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800686
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return PSA_ALG_NONE;
Jerry Yuf7c12592022-09-28 22:09:38 +0800688}
689
Jerry Yuf75364b2022-09-30 10:30:31 +0800690#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100691static int ssl_tls13_has_configured_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qianb781a232022-11-01 07:39:46 +0000692{
693 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return ssl->handshake->resume &&
Pengyu Lv93566782022-12-07 12:10:05 +0800695 session != NULL && session->ticket != NULL &&
Pengyu Lv9b84ea72023-01-16 14:08:23 +0800696 mbedtls_ssl_conf_tls13_check_kex_modes(
697 ssl, mbedtls_ssl_session_get_ticket_flags(
698 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL));
Xiaokang Qianb781a232022-11-01 07:39:46 +0000699}
700
Xiaokang Qian01323a42022-11-03 02:27:35 +0000701#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100702static int ssl_tls13_early_data_has_valid_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qian01323a42022-11-03 02:27:35 +0000703{
704 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 return ssl->handshake->resume &&
706 session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
707 (session->ticket_flags &
708 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) &&
709 mbedtls_ssl_tls13_cipher_suite_is_offered(
710 ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000711}
712#endif
713
Xiaokang Qianb781a232022-11-01 07:39:46 +0000714MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100715static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
716 psa_algorithm_t *hash_alg,
717 const unsigned char **identity,
718 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800719{
720 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 if (!ssl_tls13_has_configured_ticket(ssl)) {
723 return -1;
724 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800725
Gilles Peskine449bd832023-01-11 14:50:10 +0100726 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800727 *identity = session->ticket;
728 *identity_len = session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800730}
731
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800732MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100733static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
734 psa_algorithm_t *hash_alg,
735 const unsigned char **psk,
736 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800737{
738
739 mbedtls_ssl_session *session = ssl->session_negotiate;
740
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 if (!ssl_tls13_has_configured_ticket(ssl)) {
742 return -1;
743 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800744
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800746 *psk = session->resumption_key;
747 *psk_len = session->resumption_key_len;
748
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800750}
Jerry Yuf7c12592022-09-28 22:09:38 +0800751#endif /* MBEDTLS_SSL_SESSION_TICKETS */
752
753MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100754static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
755 psa_algorithm_t *hash_alg,
756 const unsigned char **identity,
757 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800758{
Jerry Yu8b41e892022-09-30 10:00:20 +0800759
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
761 return -1;
762 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800763
Jerry Yua99cbfa2022-10-08 11:17:14 +0800764 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800765 *identity = ssl->conf->psk_identity;
766 *identity_len = ssl->conf->psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100767 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800768}
769
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800770MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100771static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
772 psa_algorithm_t *hash_alg,
773 const unsigned char **psk,
774 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800775{
Jerry Yu8b41e892022-09-30 10:00:20 +0800776
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
778 return -1;
779 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800780
Jerry Yua99cbfa2022-10-08 11:17:14 +0800781 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800782 *psk = ssl->conf->psk;
783 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800785}
786
Gilles Peskine449bd832023-01-11 14:50:10 +0100787static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800788{
789 int configured_psk_count = 0;
790#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 if (ssl_tls13_has_configured_ticket(ssl)) {
792 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800793 configured_psk_count++;
794 }
795#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
797 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800798 configured_psk_count++;
799 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800801}
802
Jerry Yuf7c12592022-09-28 22:09:38 +0800803MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100804static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
805 unsigned char *buf,
806 unsigned char *end,
807 const unsigned char *identity,
808 size_t identity_len,
809 uint32_t obfuscated_ticket_age,
810 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800811{
Jerry Yuf75364b2022-09-30 10:30:31 +0800812 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800813 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800814
815 /*
816 * - identity_len (2 bytes)
817 * - identity (psk_identity_len bytes)
818 * - obfuscated_ticket_age (4 bytes)
819 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800821
Gilles Peskine449bd832023-01-11 14:50:10 +0100822 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
823 memcpy(buf + 2, identity, identity_len);
824 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800825
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800827
828 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800829
Gilles Peskine449bd832023-01-11 14:50:10 +0100830 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800831}
832
Jerry Yu8b41e892022-09-30 10:00:20 +0800833MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100834static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
835 unsigned char *buf,
836 unsigned char *end,
837 int psk_type,
838 psa_algorithm_t hash_alg,
839 const unsigned char *psk,
840 size_t psk_len,
841 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800842{
843 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800844 unsigned char binder_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800846 size_t transcript_len = 0;
847
848 *out_len = 0;
849
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800851
852 /*
853 * - binder_len (1 bytes)
854 * - binder (binder_len bytes)
855 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800857
Jerry Yua99cbfa2022-10-08 11:17:14 +0800858 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800859
860 /* Get current state of handshake transcript. */
861 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200862 ssl, mbedtls_md_type_from_psa_alg(hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100863 transcript, sizeof(transcript), &transcript_len);
864 if (ret != 0) {
865 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800866 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100867
868 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
869 psk, psk_len, psk_type,
870 transcript, buf + 1);
871 if (ret != 0) {
872 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
873 return ret;
874 }
875 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800876
877 *out_len = 1 + binder_len;
878
Gilles Peskine449bd832023-01-11 14:50:10 +0100879 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800880}
881
882/*
883 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
884 *
885 * struct {
886 * opaque identity<1..2^16-1>;
887 * uint32 obfuscated_ticket_age;
888 * } PskIdentity;
889 *
890 * opaque PskBinderEntry<32..255>;
891 *
892 * struct {
893 * PskIdentity identities<7..2^16-1>;
894 * PskBinderEntry binders<33..2^16-1>;
895 * } OfferedPsks;
896 *
897 * struct {
898 * select (Handshake.msg_type) {
899 * case client_hello: OfferedPsks;
900 * ...
901 * };
902 * } PreSharedKeyExtension;
903 *
904 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000905int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
907 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000908{
Jerry Yuf7c12592022-09-28 22:09:38 +0800909 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800910 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800911 unsigned char *p = buf;
Xiaokang Qian854db282022-12-19 07:31:27 +0000912 psa_algorithm_t hash_alg = PSA_ALG_NONE;
Jerry Yuf75364b2022-09-30 10:30:31 +0800913 const unsigned char *identity;
914 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800915 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800916 size_t output_len;
Xiaokang Qian7179f812023-02-03 03:38:44 +0000917
Jerry Yuf7c12592022-09-28 22:09:38 +0800918 *out_len = 0;
919 *binders_len = 0;
920
921 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Gilles Peskine449bd832023-01-11 14:50:10 +0100922 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
923 if (configured_psk_count == 0) {
924 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
925 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800926 }
927
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
929 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800930
Jerry Yuf7c12592022-09-28 22:09:38 +0800931 /* Check if we have space to write the extension, binders included.
932 * - extension_type (2 bytes)
933 * - extension_data_len (2 bytes)
934 * - identities_len (2 bytes)
935 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800937 p += 6;
938
Jerry Yuf75364b2022-09-30 10:30:31 +0800939#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100940 if (ssl_tls13_ticket_get_identity(
941 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800942#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 mbedtls_time_t now = mbedtls_time(NULL);
Jerry Yuf75364b2022-09-30 10:30:31 +0800944 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800945 uint32_t obfuscated_ticket_age =
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 (uint32_t) (now - session->ticket_received);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800947
Jerry Yu3e60cad2023-01-10 14:58:08 +0800948 /*
949 * The ticket timestamp is in seconds but the ticket age is in
950 * milliseconds. If the ticket was received at the end of a second and
951 * re-used here just at the beginning of the next second, the computed
952 * age `now - session->ticket_received` is equal to 1s thus 1000 ms
953 * while the actual age could be just a few milliseconds or tens of
954 * milliseconds. If the server has more accurate ticket timestamps
955 * (typically timestamps in milliseconds), as part of the processing of
956 * the ClientHello, it may compute a ticket lifetime smaller than the
957 * one computed here and potentially reject the ticket. To avoid that,
958 * remove one second to the ticket age if possible.
Jerry Yubdb936b2023-01-07 16:07:46 +0800959 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 if (obfuscated_ticket_age > 0) {
Jerry Yubdb936b2023-01-07 16:07:46 +0800961 obfuscated_ticket_age -= 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 }
Jerry Yubdb936b2023-01-07 16:07:46 +0800963
Jerry Yuf75364b2022-09-30 10:30:31 +0800964 obfuscated_ticket_age *= 1000;
965 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800966
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 ret = ssl_tls13_write_identity(ssl, p, end,
968 identity, identity_len,
969 obfuscated_ticket_age,
970 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800971#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
973 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800974#endif /* MBEDTLS_HAVE_TIME */
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 if (ret != 0) {
976 return ret;
977 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800978
Jerry Yuf75364b2022-09-30 10:30:31 +0800979 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +0800981 }
982#endif /* MBEDTLS_SSL_SESSION_TICKETS */
983
Gilles Peskine449bd832023-01-11 14:50:10 +0100984 if (ssl_tls13_psk_get_identity(
985 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800986
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
988 &output_len);
989 if (ret != 0) {
990 return ret;
991 }
Jerry Yuf75364b2022-09-30 10:30:31 +0800992
Jerry Yuf7c12592022-09-28 22:09:38 +0800993 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +0800995 }
996
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 MBEDTLS_SSL_DEBUG_MSG(3,
998 ("client hello, adding pre_shared_key extension, "
999 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001000
1001 /* Take into account the two bytes for the length of the binders. */
1002 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +08001003 /* Check if there is enough space for binders */
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +08001005
Jerry Yuf7c12592022-09-28 22:09:38 +08001006 /*
1007 * - extension_type (2 bytes)
1008 * - extension_data_len (2 bytes)
1009 * - identities_len (2 bytes)
1010 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
1012 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
1013 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +08001014
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001016 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +08001017
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +08001019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001021}
1022
XiaokangQian86981952022-07-19 09:51:50 +00001023int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001025{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001026 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1027 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001028 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1029 const unsigned char *psk;
1030 size_t psk_len;
1031 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001032
1033 /* Check if we have space to write binders_len.
1034 * - binders_len (2 bytes)
1035 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001037 p += 2;
1038
Jerry Yu6183cc72022-09-30 11:08:57 +08001039#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001041
Gilles Peskine449bd832023-01-11 14:50:10 +01001042 ret = ssl_tls13_write_binder(ssl, p, end,
1043 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1044 hash_alg, psk, psk_len,
1045 &output_len);
1046 if (ret != 0) {
1047 return ret;
1048 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001049 p += output_len;
1050 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001051#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001052
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001054
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 ret = ssl_tls13_write_binder(ssl, p, end,
1056 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1057 hash_alg, psk, psk_len,
1058 &output_len);
1059 if (ret != 0) {
1060 return ret;
1061 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001062 p += output_len;
1063 }
1064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001066
1067 /*
1068 * - binders_len (2 bytes)
1069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001071
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001073
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001074 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001078}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001079
1080/*
1081 * struct {
1082 * opaque identity<1..2^16-1>;
1083 * uint32 obfuscated_ticket_age;
1084 * } PskIdentity;
1085 *
1086 * opaque PskBinderEntry<32..255>;
1087 *
1088 * struct {
1089 *
1090 * select (Handshake.msg_type) {
1091 * ...
1092 * case server_hello: uint16 selected_identity;
1093 * };
1094 *
1095 * } PreSharedKeyExtension;
1096 *
1097 */
1098MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001099static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1100 const unsigned char *buf,
1101 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001102{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001103 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001104 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001105 const unsigned char *psk;
1106 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001107 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1110 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001111 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001112
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001114
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1116 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001117
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1119 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1120 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001121 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001122
Jerry Yu4a698342022-09-30 12:22:01 +08001123#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1125 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1126 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001127#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1129 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
1130 } else {
1131 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1132 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001133 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 if (ret != 0) {
1135 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001136 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001137
Manuel Pégourié-Gonnard1f2a5872023-03-28 11:46:17 +02001138 if (mbedtls_md_psa_alg_from_type(ssl->handshake->ciphersuite_info->mac)
Xiaokang Qianeb31cbc2023-02-07 02:08:56 +00001139 != hash_alg) {
1140 MBEDTLS_SSL_DEBUG_MSG(
1141 1, ("Invalid ciphersuite for external psk."));
1142
1143 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1144 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1145 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1146 }
1147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1149 if (ret != 0) {
1150 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1151 return ret;
1152 }
1153
1154 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001155}
Ronald Cron41a443a2022-10-04 16:38:25 +02001156#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001157
Gilles Peskine449bd832023-01-11 14:50:10 +01001158int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1159 unsigned char *buf,
1160 unsigned char *end,
1161 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001162{
1163 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1164 unsigned char *p = buf;
1165 size_t ext_len;
1166
1167 *out_len = 0;
1168
1169 /* Write supported_versions extension
1170 *
1171 * Supported Versions Extension is mandatory with TLS 1.3.
1172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1174 if (ret != 0) {
1175 return ret;
1176 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001177 p += ext_len;
1178
1179 /* Echo the cookie if the server provided one in its preceding
1180 * HelloRetryRequest message.
1181 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1183 if (ret != 0) {
1184 return ret;
1185 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001186 p += ext_len;
1187
Ronald Cron766c0cd2022-10-18 12:17:11 +02001188#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1190 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1191 if (ret != 0) {
1192 return ret;
1193 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001194 p += ext_len;
1195 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001196#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001197
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001198#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1200 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1201 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1202 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1203 if (ret != 0) {
1204 return ret;
1205 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001206 p += ext_len;
1207
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001208 /* Initializes the status to `rejected`. It will be updated to
1209 * `accepted` if the EncryptedExtension message contain an early data
1210 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001211 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001212 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 } else {
1214 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001215 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001216 }
1217#endif /* MBEDTLS_SSL_EARLY_DATA */
1218
Ronald Cron41a443a2022-10-04 16:38:25 +02001219#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001220 /* For PSK-based key exchange we need the pre_shared_key extension
1221 * and the psk_key_exchange_modes extension.
1222 *
1223 * The pre_shared_key extension MUST be the last extension in the
1224 * ClientHello. Servers MUST check that it is the last extension and
1225 * otherwise fail the handshake with an "illegal_parameter" alert.
1226 *
1227 * Add the psk_key_exchange_modes extension.
1228 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1230 if (ret != 0) {
1231 return ret;
1232 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001233 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001234#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001235
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001236 *out_len = p - buf;
1237
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001239}
1240
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00001241int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl)
Xiaokang Qian126929f2023-01-03 10:29:41 +00001242{
Xiaokang Qian90746132023-01-06 05:54:59 +00001243 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001244
Xiaokang Qian126929f2023-01-03 10:29:41 +00001245#if defined(MBEDTLS_SSL_EARLY_DATA)
1246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1247 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1248 const unsigned char *psk;
1249 size_t psk_len;
1250 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001251
Xiaokang Qian126929f2023-01-03 10:29:41 +00001252 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
Xiaokang Qian6be82902023-02-03 06:04:43 +00001253#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1254 mbedtls_ssl_handshake_set_state(
1255 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1256#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00001257 MBEDTLS_SSL_DEBUG_MSG(
1258 1, ("Set hs psk for early data when writing the first psk"));
1259
1260 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1261 if (ret != 0) {
1262 MBEDTLS_SSL_DEBUG_RET(
1263 1, "ssl_tls13_ticket_get_psk", ret);
1264 return ret;
1265 }
1266
1267 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1268 if (ret != 0) {
1269 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1270 return ret;
1271 }
1272
Xiaokang Qian64bc9bc2023-02-07 02:32:23 +00001273 /*
1274 * Early data are going to be encrypted using the ciphersuite
1275 * associated with the pre-shared key used for the handshake.
1276 * Note that if the server rejects early data, the handshake
1277 * based on the pre-shared key may complete successfully
1278 * with a selected ciphersuite different from the ciphersuite
1279 * associated with the pre-shared key. Only the hashes of the
1280 * two ciphersuites have to be the same. In that case, the
1281 * encrypted handshake data and application data are
1282 * encrypted using a different ciphersuite than the one used for
1283 * the rejected early data.
1284 */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001285 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1286 ssl->session_negotiate->ciphersuite);
1287 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001288
Tom Cosgrove5c8505f2023-03-07 11:39:52 +00001289 /* Enable psk and psk_ephemeral to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001290 ssl->handshake->key_exchange_mode =
1291 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1292
1293 /* Start the TLS 1.3 key schedule:
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001294 * Set the PSK and derive early secret.
Xiaokang Qian126929f2023-01-03 10:29:41 +00001295 */
1296 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1297 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001298 MBEDTLS_SSL_DEBUG_RET(
1299 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001300 return ret;
1301 }
1302
1303 /* Derive early data key material */
1304 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1305 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001306 MBEDTLS_SSL_DEBUG_RET(
1307 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001308 return ret;
1309 }
1310
Xiaokang Qian126929f2023-01-03 10:29:41 +00001311 }
1312#endif /* MBEDTLS_SSL_EARLY_DATA */
1313 return 0;
1314}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001315/*
Jerry Yu4a173382021-10-11 21:45:31 +08001316 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001317 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001318
Ronald Cronda41b382022-03-30 09:57:11 +02001319/**
1320 * \brief Detect if the ServerHello contains a supported_versions extension
1321 * or not.
1322 *
1323 * \param[in] ssl SSL context
1324 * \param[in] buf Buffer containing the ServerHello message
1325 * \param[in] end End of the buffer containing the ServerHello message
1326 *
1327 * \return 0 if the ServerHello does not contain a supported_versions extension
1328 * \return 1 if the ServerHello contains a supported_versions extension
1329 * \return A negative value if an error occurred while parsing the ServerHello.
1330 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001331MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001332static int ssl_tls13_is_supported_versions_ext_present(
1333 mbedtls_ssl_context *ssl,
1334 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001336{
1337 const unsigned char *p = buf;
1338 size_t legacy_session_id_echo_len;
Ronald Croneff56732023-04-03 17:36:31 +02001339 const unsigned char *supported_versions_data;
1340 const unsigned char *supported_versions_data_end;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001341
1342 /*
1343 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001344 * length:
1345 * - legacy_version 2 bytes
1346 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1347 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001348 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001349 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001350 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1351 legacy_session_id_echo_len = *p;
1352
1353 /*
1354 * Jump to the extensions, jumping over:
1355 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1356 * - cipher_suite 2 bytes
1357 * - legacy_compression_method 1 byte
1358 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1360 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001361
Ronald Cron47dce632023-02-08 17:38:29 +01001362 return mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1363 ssl, p, end,
Ronald Croneff56732023-04-03 17:36:31 +02001364 &supported_versions_data, &supported_versions_data_end);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001365}
1366
Jerry Yu7a186a02021-10-15 18:46:14 +08001367/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001368 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1369 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1370 * - 0 otherwise
1371 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001372MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001373static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1374 const unsigned char *buf,
1375 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001376{
1377 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1378 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001379 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001380 const unsigned char *last_eight_bytes_of_random;
1381 unsigned char last_byte_of_random;
1382
Gilles Peskine449bd832023-01-11 14:50:10 +01001383 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001384 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1385
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 if (memcmp(last_eight_bytes_of_random,
1387 magic_downgrade_string,
1388 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001389 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 return last_byte_of_random == 0 ||
1391 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001392 }
1393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001395}
1396
1397/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001398 * - SSL_SERVER_HELLO or
1399 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001400 * to indicate which message is expected and to be parsed next.
1401 */
Ronald Cron828aff62022-05-31 12:04:31 +02001402#define SSL_SERVER_HELLO 0
1403#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001404MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001405static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1406 const unsigned char *buf,
1407 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001408{
Jerry Yue1b9c292021-09-10 10:08:31 +08001409
1410 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1411 *
Jerry Yu4a173382021-10-11 21:45:31 +08001412 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001413 * special value of the SHA-256 of "HelloRetryRequest".
1414 *
1415 * struct {
1416 * ProtocolVersion legacy_version = 0x0303;
1417 * Random random;
1418 * opaque legacy_session_id_echo<0..32>;
1419 * CipherSuite cipher_suite;
1420 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001421 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001422 * } ServerHello;
1423 *
1424 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001425 MBEDTLS_SSL_CHK_BUF_READ_PTR(
1426 buf, end, 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1429 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1430 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001431 }
1432
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001434}
1435
Ronald Cron828aff62022-05-31 12:04:31 +02001436/*
Jerry Yu745bb612021-10-13 22:01:04 +08001437 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001438 * - SSL_SERVER_HELLO or
1439 * - SSL_SERVER_HELLO_HRR or
1440 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001441 */
Ronald Cron828aff62022-05-31 12:04:31 +02001442#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001443MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001444static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1445 const unsigned char *buf,
1446 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001447{
Jerry Yu4a173382021-10-11 21:45:31 +08001448 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001449 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001450
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1452 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001455 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001457
1458 /* If the server is negotiating TLS 1.2 or below and:
1459 * . we did not propose TLS 1.2 or
1460 * . the server responded it is TLS 1.3 capable but negotiating a lower
1461 * version of the protocol and thus we are under downgrade attack
1462 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1465 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1466 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1467 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001468 }
1469
Ronald Cronb828c7d2023-04-03 16:37:22 +02001470 /*
1471 * Version 1.2 of the protocol has been negotiated, set the
1472 * ssl->keep_current_message flag for the ServerHello to be kept and
1473 * parsed as a TLS 1.2 ServerHello. We also change ssl->tls_version to
1474 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1475 * will dispatch to the TLS 1.2 state machine.
1476 */
Ronald Cron9f0fba32022-02-10 16:45:15 +01001477 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001478 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001479 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1480 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1481 buf, (size_t) (end - buf)));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001482
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1484 ret = ssl_tls13_reset_key_share(ssl);
1485 if (ret != 0) {
1486 return ret;
1487 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001488 }
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001491 }
1492
Jerry Yua66fece2022-07-13 14:30:29 +08001493#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1494 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1495 ssl->session_negotiate->tls_version = ssl->tls_version;
1496#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1497
Jerry Yu50e00e32022-10-31 14:45:01 +08001498 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1501 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001502 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001504 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001505 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001507 /* If a client receives a second HelloRetryRequest in the same
1508 * connection (i.e., where the ClientHello was itself in response
1509 * to a HelloRetryRequest), it MUST abort the handshake with an
1510 * "unexpected_message" alert.
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 */
1512 if (handshake->hello_retry_request_count > 0) {
1513 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001514 MBEDTLS_SSL_PEND_FATAL_ALERT(
1515 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1516 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001518 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001519 /*
1520 * Clients must abort the handshake with an "illegal_parameter"
1521 * alert if the HelloRetryRequest would not result in any change
1522 * in the ClientHello.
1523 * In a PSK only key exchange that what we expect.
1524 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1526 MBEDTLS_SSL_DEBUG_MSG(1,
1527 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1530 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1531 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001533
Ronald Cron5afb9042022-05-31 12:11:39 +02001534 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001535
Jerry Yu745bb612021-10-13 22:01:04 +08001536 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001537 }
1538
1539cleanup:
1540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001542}
1543
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001544MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001545static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1546 const unsigned char **buf,
1547 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001548{
1549 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001550 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001551
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1553 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001554
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001556
1557 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1559 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1560 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1561 ssl->session_negotiate->id,
1562 ssl->session_negotiate->id_len);
1563 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1564 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001565
Gilles Peskine449bd832023-01-11 14:50:10 +01001566 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1567 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001568
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001570 }
1571
Jerry Yu4a173382021-10-11 21:45:31 +08001572 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001573 *buf = p;
1574
Gilles Peskine449bd832023-01-11 14:50:10 +01001575 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1576 ssl->session_negotiate->id_len);
1577 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001578}
1579
Jerry Yue1b9c292021-09-10 10:08:31 +08001580/* Parse ServerHello message and configure context
1581 *
1582 * struct {
1583 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1584 * Random random;
1585 * opaque legacy_session_id_echo<0..32>;
1586 * CipherSuite cipher_suite;
1587 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001588 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001589 * } ServerHello;
1590 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001591MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001592static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1593 const unsigned char *buf,
1594 const unsigned char *end,
1595 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001596{
Jerry Yub85277e2021-10-13 13:36:05 +08001597 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001598 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001599 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001600 size_t extensions_len;
1601 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001602 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001603 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001604 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001605 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001606 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001608
1609 /*
1610 * Check there is space for minimal fields
1611 *
1612 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001613 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001614 * - legacy_session_id_echo ( 1 byte ), minimum size
1615 * - cipher_suite ( 2 bytes)
1616 * - legacy_compression_method ( 1 byte )
1617 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001618 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001619
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1621 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001622
Jerry Yu4a173382021-10-11 21:45:31 +08001623 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001624 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001625 * ...
1626 * with ProtocolVersion defined as:
1627 * uint16 ProtocolVersion;
1628 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1630 MBEDTLS_SSL_VERSION_TLS1_2) {
1631 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1632 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1633 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001634 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1635 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001636 }
1637 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001638
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001639 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001640 * Random random;
1641 * ...
1642 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001643 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001644 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 if (!is_hrr) {
1646 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1647 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1648 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1649 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001650 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001651 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001652
Jerry Yu4a173382021-10-11 21:45:31 +08001653 /* ...
1654 * opaque legacy_session_id_echo<0..32>;
1655 * ...
1656 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001658 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001659 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001660 }
1661
Jerry Yu4a173382021-10-11 21:45:31 +08001662 /* ...
1663 * CipherSuite cipher_suite;
1664 * ...
1665 * with CipherSuite defined as:
1666 * uint8 CipherSuite[2];
1667 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1669 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001670 p += 2;
1671
Jerry Yu4a173382021-10-11 21:45:31 +08001672
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001674 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001675 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001676 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1678 ssl->tls_version,
1679 ssl->tls_version) != 0) ||
1680 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001681 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001682 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001683 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001684 * If we received an HRR before and that the proposed selected
1685 * ciphersuite in this server hello is not the same as the one
1686 * proposed in the HRR, we abort the handshake and send an
1687 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001688 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1690 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001691 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001692 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001693
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1695 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1696 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001697 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001698 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001699
Jerry Yu4a173382021-10-11 21:45:31 +08001700 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001702
XiaokangQian355e09a2022-01-20 11:14:50 +00001703 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1705 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001706
1707#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001708 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001709#endif /* MBEDTLS_HAVE_TIME */
1710
Jerry Yu4a173382021-10-11 21:45:31 +08001711 /* ...
1712 * uint8 legacy_compression_method = 0;
1713 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001714 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1716 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1717 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001718 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001719 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001720 }
1721 p++;
1722
Jerry Yub85277e2021-10-13 13:36:05 +08001723 /* ...
1724 * Extension extensions<6..2^16-1>;
1725 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001726 * struct {
1727 * ExtensionType extension_type; (2 bytes)
1728 * opaque extension_data<0..2^16-1>;
1729 * } Extension;
1730 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1732 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001733 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001734
Jerry Yu4a173382021-10-11 21:45:31 +08001735 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001737 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001740
Jerry Yu50e00e32022-10-31 14:45:01 +08001741 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001742 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1744 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001745
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001747 unsigned int extension_type;
1748 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001749 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001750
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1752 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1753 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001754 p += 4;
1755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001757 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001758
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001759 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1761 if (ret != 0) {
1762 return ret;
1763 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001764
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001766 case MBEDTLS_TLS_EXT_COOKIE:
1767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 ret = ssl_tls13_parse_cookie_ext(ssl,
1769 p, extension_data_end);
1770 if (ret != 0) {
1771 MBEDTLS_SSL_DEBUG_RET(1,
1772 "ssl_tls13_parse_cookie_ext",
1773 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001774 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001775 }
XiaokangQianb851da82022-01-14 04:03:11 +00001776 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001777
Jerry Yue1b9c292021-09-10 10:08:31 +08001778 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1780 p,
1781 extension_data_end);
1782 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001783 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001785 break;
1786
Ronald Cron41a443a2022-10-04 16:38:25 +02001787#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001788 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1792 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001793 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1795 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001796 }
1797 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001798#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001799
Jerry Yue1b9c292021-09-10 10:08:31 +08001800 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1802 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001803 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001804 goto cleanup;
1805 }
1806
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 if (is_hrr) {
1808 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1809 p, extension_data_end);
1810 } else {
1811 ret = ssl_tls13_parse_key_share_ext(ssl,
1812 p, extension_data_end);
1813 }
1814 if (ret != 0) {
1815 MBEDTLS_SSL_DEBUG_RET(1,
1816 "ssl_tls13_parse_key_share_ext",
1817 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001818 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001819 }
1820 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001821
1822 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001823 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1824 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001825 }
1826
1827 p += extension_data_len;
1828 }
1829
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001831
XiaokangQiand59be772022-01-24 10:12:51 +00001832cleanup:
1833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1835 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1836 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001837 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1839 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1840 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001841 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1842 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001844}
1845
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001846#if defined(MBEDTLS_DEBUG_C)
1847static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001848{
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001850 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1851 return "psk";
1852 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1853 return "ephemeral";
1854 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1855 return "psk_ephemeral";
1856 default:
1857 return "unknown mode";
1858 }
1859}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001860#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001861
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001862MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001863static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001864{
Jerry Yub85277e2021-10-13 13:36:05 +08001865 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001866 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001867
Jerry Yub85277e2021-10-13 13:36:05 +08001868 /* Determine the key exchange mode:
1869 * 1) If both the pre_shared_key and key_share extensions were received
1870 * then the key exchange mode is PSK with EPHEMERAL.
1871 * 2) If only the pre_shared_key extension was received then the key
1872 * exchange mode is PSK-only.
1873 * 3) If only the key_share extension was received then the key
1874 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001875 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 switch (handshake->received_extensions &
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001877 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1878 MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001879 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001881 handshake->key_exchange_mode =
1882 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001883 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001884
Jerry Yu745bb612021-10-13 22:01:04 +08001885 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001887 handshake->key_exchange_mode =
1888 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001889 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001890
Jerry Yu745bb612021-10-13 22:01:04 +08001891 /* Both the pre_shared_key and key_share extensions were received */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001892 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1893 MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
1894 handshake->key_exchange_mode =
1895 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001896 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001897
Jerry Yu745bb612021-10-13 22:01:04 +08001898 /* Neither pre_shared_key nor key_share extension was received */
1899 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001901 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1902 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001903 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001904#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001905 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1906 (handshake->selected_identity != 0 ||
1907 handshake->ciphersuite_info->id !=
1908 ssl->session_negotiate->ciphersuite)) {
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001909 /* RFC8446 4.2.11
1910 * If the server supplies an "early_data" extension, the
1911 * client MUST verify that the server's selected_identity
1912 * is 0. If any other value is returned, the client MUST
1913 * abort the handshake with an "illegal_parameter" alert.
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001914 *
Xiaokang Qian53c4c272023-02-07 02:42:01 +00001915 * RFC 8446 4.2.10
1916 * In order to accept early data, the server MUST have accepted a PSK
1917 * cipher suite and selected the first key offered in the client's
1918 * "pre_shared_key" extension. In addition, it MUST verify that the
1919 * following values are the same as those associated with the
1920 * selected PSK:
1921 * - The TLS version number
1922 * - The selected cipher suite
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001923 * - The selected ALPN [RFC7301] protocol, if any
1924 *
1925 * We check here that when early data is involved the server
1926 * selected the cipher suite associated to the pre-shared key
1927 * as it must have.
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001928 */
1929 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1930 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1931 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1932 }
1933#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001934
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001935 if (!mbedtls_ssl_conf_tls13_check_kex_modes(
1936 ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001937 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001938 MBEDTLS_SSL_DEBUG_MSG(
1939 2, ("Key exchange mode(%s) is not supported.",
1940 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001941 goto cleanup;
1942 }
1943
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001944 MBEDTLS_SSL_DEBUG_MSG(
1945 3, ("Selected key exchange mode: %s",
1946 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001947
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001948 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001949 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001950 * If we proposed early data then we have already derived an
1951 * early secret using the selected PSK and its associated hash.
1952 * It means that if the negotiated key exchange mode is psk or
1953 * psk_ephemeral, we have already correctly computed the
1954 * early secret and thus we do not do it again. In all other
1955 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001956 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001957#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001958 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1959 handshake->key_exchange_mode ==
1960 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001961#endif
1962 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001963 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1964 if (ret != 0) {
1965 MBEDTLS_SSL_DEBUG_RET(
1966 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1967 goto cleanup;
1968 }
Jerry Yu0b177842021-09-05 19:41:30 +08001969 }
1970
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1972 if (ret != 0) {
1973 MBEDTLS_SSL_DEBUG_RET(1,
1974 "mbedtls_ssl_tls13_compute_handshake_transform",
1975 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001976 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001977 }
1978
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1980 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001981 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
Jerry Yu0b177842021-09-05 19:41:30 +08001982 ssl->session_in = ssl->session_negotiate;
1983
Jerry Yu4a173382021-10-11 21:45:31 +08001984cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001986 MBEDTLS_SSL_PEND_FATAL_ALERT(
1987 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001989 }
Jerry Yue110d252022-05-05 10:19:22 +08001990
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001992}
1993
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001994MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001995static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00001996{
1997 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1998
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00002000
XiaokangQian78b1fa72022-01-19 06:56:30 +00002001 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00002002 * We are going to re-generate a shared secret corresponding to the group
2003 * selected by the server, which is different from the group for which we
2004 * generated a shared secret in the first client hello.
2005 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00002006 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 ret = ssl_tls13_reset_key_share(ssl);
2008 if (ret != 0) {
2009 return ret;
2010 }
XiaokangQian647719a2021-12-07 09:16:29 +00002011
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00002012 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002014}
2015
Jerry Yue1b9c292021-09-10 10:08:31 +08002016/*
Jerry Yu4a173382021-10-11 21:45:31 +08002017 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002018 * Handler for MBEDTLS_SSL_SERVER_HELLO
2019 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002020MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002021static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002022{
Jerry Yu4a173382021-10-11 21:45:31 +08002023 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002024 unsigned char *buf = NULL;
2025 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002026 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002027
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002029
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002030 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2031 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002032
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2034 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002035 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 } else {
2037 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2038 }
XiaokangQiand59be772022-01-24 10:12:51 +00002039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002041 ret = 0;
2042 goto cleanup;
2043 }
2044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2046 buf + buf_len,
2047 is_hrr));
2048 if (is_hrr) {
2049 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002050 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002051
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002052 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2053 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002054
2055 if (is_hrr) {
2056 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2057#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2058 /* If not offering early data, the client sends a dummy CCS record
2059 * immediately before its second flight. This may either be before
2060 * its second ClientHello or before its encrypted handshake flight.
2061 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002062 mbedtls_ssl_handshake_set_state(
2063 ssl, MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
Gilles Peskine449bd832023-01-11 14:50:10 +01002064#else
2065 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2066#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2067 } else {
2068 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2069 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002070 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002071
2072cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2074 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2075 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002076}
2077
2078/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002079 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002080 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002081 *
2082 * The EncryptedExtensions message contains any extensions which
2083 * should be protected, i.e., any which are not needed to establish
2084 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002085 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002086
XiaokangQian08da26c2021-10-09 10:12:11 +00002087/* Parse EncryptedExtensions message
2088 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002089 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002090 * } EncryptedExtensions;
2091 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002092MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002093static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2094 const unsigned char *buf,
2095 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002096{
2097 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002098 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002099 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002100 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002101 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2104 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002105 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002108 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002109
Jan Bruckner5a3629b2023-02-23 12:08:09 +01002110 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2111
Jerry Yu9eba7502022-10-31 13:46:16 +08002112 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002115 unsigned int extension_type;
2116 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002117
XiaokangQian08da26c2021-10-09 10:12:11 +00002118 /*
2119 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002120 * ExtensionType extension_type; (2 bytes)
2121 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002122 * } Extension;
2123 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2125 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2126 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002127 p += 4;
2128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002130
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002131 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2133 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2134 if (ret != 0) {
2135 return ret;
2136 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002137
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002139#if defined(MBEDTLS_SSL_ALPN)
2140 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002142
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002143 if ((ret = ssl_tls13_parse_alpn_ext(
2144 ssl, p, (size_t) extension_data_len)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002146 }
2147
2148 break;
2149#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002150
2151#if defined(MBEDTLS_SSL_EARLY_DATA)
2152 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002153
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002155 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2157 MBEDTLS_ERR_SSL_DECODE_ERROR);
2158 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002159 }
2160
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002161 break;
2162#endif /* MBEDTLS_SSL_EARLY_DATA */
2163
Jan Bruckner151f6422023-02-10 12:45:19 +01002164#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2165 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
2166 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
2167
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002168 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
2169 ssl, p, p + extension_data_len);
Jan Bruckner151f6422023-02-10 12:45:19 +01002170
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002171 /* TODO: Return unconditionally here until we handle the record
2172 * size limit correctly. Once handled correctly, only return in
2173 * case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01002174 return ret;
2175
2176 break;
2177#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2178
XiaokangQian08da26c2021-10-09 10:12:11 +00002179 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002180 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002181 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002183 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002184 }
2185
XiaokangQian08da26c2021-10-09 10:12:11 +00002186 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002187 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2190 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002191
XiaokangQian97799ac2021-10-11 10:05:54 +00002192 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 if (p != end) {
2194 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2195 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2196 MBEDTLS_ERR_SSL_DECODE_ERROR);
2197 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002198 }
2199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002201}
2202
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002203MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002204static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002205{
2206 int ret;
2207 unsigned char *buf;
2208 size_t buf_len;
2209
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002211
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002212 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2213 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2214 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002215
2216 /* Process the message contents */
2217 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002219
Xiaokang Qianb157e912022-11-23 08:12:26 +00002220#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 if (ssl->handshake->received_extensions &
2222 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002223 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2224 }
2225#endif
2226
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002227 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2228 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2229 buf, buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002230
Ronald Cron928cbd32022-10-04 16:14:26 +02002231#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2233 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2234 } else {
2235 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2236 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002237#else
2238 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002240#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002241
2242cleanup:
2243
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2245 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002246
2247}
2248
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002249/*
2250 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2251 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002252 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002253 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002254 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002255 *
2256 * If the server sent an "early_data" extension in EncryptedExtensions, the
2257 * client MUST send an EndOfEarlyData message after receiving the server
2258 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002259 */
2260
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002261MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002262static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2263{
2264 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002265 unsigned char *buf = NULL;
2266 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002267 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002268
Xiaokang Qian742578c2022-12-19 06:34:44 +00002269 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
Xiaokang Qian0de0d862023-02-08 06:04:50 +00002270 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
2271 &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002272
Manuel Pégourié-Gonnard63e33dd2023-02-21 15:45:15 +01002273 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_hdr_to_checksum(
2274 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002275
Xiaokang Qian742578c2022-12-19 06:34:44 +00002276 MBEDTLS_SSL_PROC_CHK(
2277 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002278
Xiaokang Qian19d44162023-01-03 03:39:50 +00002279 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002280
2281cleanup:
2282
2283 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2284 return ret;
2285}
2286
Ronald Cron928cbd32022-10-04 16:14:26 +02002287#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002288/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002289 * STATE HANDLING: CertificateRequest
2290 *
Jerry Yud2674312021-10-29 10:08:19 +08002291 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002292#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2293#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002294/* Coordination:
2295 * Deals with the ambiguity of not knowing if a CertificateRequest
2296 * will be sent. Returns a negative code on failure, or
2297 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2298 * - SSL_CERTIFICATE_REQUEST_SKIP
2299 * indicating if a Certificate Request is expected or not.
2300 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002301MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002302static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002303{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002304 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2307 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2308 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002309 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002310 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002311
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2313 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2314 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2315 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002316 }
2317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002321}
2322
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002323/*
2324 * ssl_tls13_parse_certificate_request()
2325 * Parse certificate request
2326 * struct {
2327 * opaque certificate_request_context<0..2^8-1>;
2328 * Extension extensions<2..2^16-1>;
2329 * } CertificateRequest;
2330 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002331MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002332static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2333 const unsigned char *buf,
2334 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002335{
2336 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2337 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002338 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002339 size_t extensions_len = 0;
2340 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002341 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002342
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002343 /* ...
2344 * opaque certificate_request_context<0..2^8-1>
2345 * ...
2346 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002348 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002349 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002350
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 if (certificate_request_context_len > 0) {
2352 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2353 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2354 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002355
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002356 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 mbedtls_calloc(1, certificate_request_context_len);
2358 if (handshake->certificate_request_context == NULL) {
2359 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2360 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002361 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 memcpy(handshake->certificate_request_context, p,
2363 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002364 p += certificate_request_context_len;
2365 }
2366
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002367 /* ...
2368 * Extension extensions<2..2^16-1>;
2369 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002370 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2372 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002373 p += 2;
2374
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002376 extensions_end = p + extensions_len;
2377
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002378 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002381 unsigned int extension_type;
2382 size_t extension_data_len;
2383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2385 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2386 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002387 p += 4;
2388
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002390
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002391 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2393 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2394 if (ret != 0) {
2395 return ret;
2396 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002397
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002399 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 MBEDTLS_SSL_DEBUG_MSG(3,
2401 ("found signature algorithms extension"));
2402 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2403 p + extension_data_len);
2404 if (ret != 0) {
2405 return ret;
2406 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002407
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002408 break;
2409
2410 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002411 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002412 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002414 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002415 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002416
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002417 p += extension_data_len;
2418 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2421 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002422
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002423 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 if (p != end) {
2425 MBEDTLS_SSL_DEBUG_MSG(1,
2426 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002427 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002428 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002429
Jerry Yu0c354a22022-08-29 15:25:36 +08002430 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002431 *
2432 * The "signature_algorithms" extension MUST be specified
2433 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2435 MBEDTLS_SSL_DEBUG_MSG(3,
2436 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002437 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002438 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002439
Jerry Yu7840f812022-01-29 10:26:51 +08002440 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002442
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002443decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2445 MBEDTLS_ERR_SSL_DECODE_ERROR);
2446 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002447}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002448
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002449/*
2450 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2451 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002452MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002453static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002454{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002455 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002456
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002462 unsigned char *buf;
2463 size_t buf_len;
2464
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002465 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2466 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2467 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002468
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002469 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(
2470 ssl, buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002471
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002472 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2473 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2474 buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002476 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 } else {
2478 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002479 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2480 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002481 }
2482
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002484
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002485cleanup:
2486
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2488 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002489}
2490
2491/*
Jerry Yu687101b2021-09-14 16:03:56 +08002492 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2493 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002494MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002495static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002496{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002497 int ret;
2498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2500 if (ret != 0) {
2501 return ret;
2502 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2505 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002506}
2507
2508/*
2509 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2510 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002511MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002512static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002513{
Jerry Yu30b071c2021-09-12 20:16:03 +08002514 int ret;
2515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2517 if (ret != 0) {
2518 return ret;
2519 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2522 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002523}
Ronald Cron928cbd32022-10-04 16:14:26 +02002524#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002525
Jerry Yu687101b2021-09-14 16:03:56 +08002526/*
2527 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2528 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002529MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002530static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002531{
XiaokangQianac0385c2021-11-03 06:40:11 +00002532 int ret;
2533
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2535 if (ret != 0) {
2536 return ret;
2537 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2540 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002541 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2543 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2544 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002545 }
2546
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002547#if defined(MBEDTLS_SSL_EARLY_DATA)
2548 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2549 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002550 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2551 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002552 } else
2553#endif /* MBEDTLS_SSL_EARLY_DATA */
2554 {
2555#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2556 mbedtls_ssl_handshake_set_state(
2557 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2558#else
2559 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2560#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2561 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002564}
2565
2566/*
Jerry Yu566c7812022-01-26 15:41:22 +08002567 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2568 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002569MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002570static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002571{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002572 int non_empty_certificate_msg = 0;
2573
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 MBEDTLS_SSL_DEBUG_MSG(1,
2575 ("Switch to handshake traffic keys for outbound traffic"));
2576 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002577
Ronald Cron928cbd32022-10-04 16:14:26 +02002578#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 if (ssl->handshake->client_auth) {
2580 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2581 if (ret != 0) {
2582 return ret;
2583 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002584
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002586 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 }
2588 } else {
2589 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002590 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002591#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 if (non_empty_certificate_msg) {
2594 mbedtls_ssl_handshake_set_state(ssl,
2595 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2596 } else {
2597 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2598 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2599 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002602}
2603
Ronald Cron928cbd32022-10-04 16:14:26 +02002604#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002605/*
2606 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2607 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002608MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002609static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002610{
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 if (ret == 0) {
2614 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2615 }
Ronald Crona8b38872022-03-09 07:59:25 +01002616
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002618}
Ronald Cron928cbd32022-10-04 16:14:26 +02002619#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002620
2621/*
Jerry Yu687101b2021-09-14 16:03:56 +08002622 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2623 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002624MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002625static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002626{
XiaokangQian0fa66432021-11-15 03:33:57 +00002627 int ret;
2628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2630 if (ret != 0) {
2631 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002632 }
2633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2635 if (ret != 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002636 MBEDTLS_SSL_DEBUG_RET(
2637 1, "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 return ret;
2639 }
2640
2641 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2642 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002643}
2644
2645/*
2646 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2647 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002648MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002649static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002650{
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2652 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2653 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002654}
2655
2656/*
2657 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2658 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002659MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002660static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002661{
Jerry Yu378254d2021-10-30 21:44:47 +08002662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2666 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002667}
2668
Jerry Yuf8a49942022-07-07 11:32:32 +00002669#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2670
Jerry Yua0446a02022-07-13 11:22:55 +08002671MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002672static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2673 const unsigned char *buf,
2674 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002675{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002676 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002677 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002678
Jerry Yuf8a49942022-07-07 11:32:32 +00002679
Jerry Yuedab6372022-10-31 14:37:31 +08002680 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002681
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002683 unsigned int extension_type;
2684 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002685 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2688 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2689 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002690 p += 4;
2691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002693
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002694 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2696 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2697 if (ret != 0) {
2698 return ret;
2699 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002702#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002703 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002705 MBEDTLS_SSL_PEND_FATAL_ALERT(
2706 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 MBEDTLS_ERR_SSL_DECODE_ERROR);
2708 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002709 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002711 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002713 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002714 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002715#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002716
Jerry Yuf8a49942022-07-07 11:32:32 +00002717 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002718 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002719 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002721 break;
2722 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002723
Jerry Yuf8a49942022-07-07 11:32:32 +00002724 p += extension_data_len;
2725 }
2726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2728 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002729
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002731}
2732
2733/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002734 * From RFC8446, page 74
2735 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002736 * struct {
2737 * uint32 ticket_lifetime;
2738 * uint32 ticket_age_add;
2739 * opaque ticket_nonce<0..255>;
2740 * opaque ticket<1..2^16-1>;
2741 * Extension extensions<0..2^16-2>;
2742 * } NewSessionTicket;
2743 *
2744 */
Jerry Yua0446a02022-07-13 11:22:55 +08002745MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002746static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2747 unsigned char *buf,
2748 unsigned char *end,
2749 unsigned char **ticket_nonce,
2750 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002751{
2752 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2753 unsigned char *p = buf;
2754 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002755 size_t ticket_len;
2756 unsigned char *ticket;
2757 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002758
Jerry Yucb3b1392022-07-12 06:09:38 +00002759 *ticket_nonce = NULL;
2760 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002761 /*
2762 * ticket_lifetime 4 bytes
2763 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002764 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002765 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002767
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2769 MBEDTLS_SSL_DEBUG_MSG(3,
2770 ("ticket_lifetime: %u",
2771 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002772
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2774 MBEDTLS_SSL_DEBUG_MSG(3,
2775 ("ticket_age_add: %u",
2776 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002777
Jerry Yucb3b1392022-07-12 06:09:38 +00002778 *ticket_nonce_len = p[8];
2779 p += 9;
2780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002782 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002784 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002785
2786 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2788 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002789 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2791 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002792
2793 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 if (session->ticket != NULL || session->ticket_len > 0) {
2795 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002796 session->ticket = NULL;
2797 session->ticket_len = 0;
2798 }
2799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2801 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2802 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002803 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002805 p += ticket_len;
2806 session->ticket = ticket;
2807 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002808
Pengyu Lv9f926952022-11-17 15:22:33 +08002809 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002810 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002811 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002812
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2814 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002815 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002817
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2821 if (ret != 0) {
2822 MBEDTLS_SSL_DEBUG_RET(1,
2823 "ssl_tls13_parse_new_session_ticket_exts",
2824 ret);
2825 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002826 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002827
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002828 /* session has been updated, allow export */
2829 session->exported = 0;
2830
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002832}
2833
Jerry Yua0446a02022-07-13 11:22:55 +08002834MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002835static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2836 unsigned char *ticket_nonce,
2837 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002838{
2839 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2840 mbedtls_ssl_session *session = ssl->session;
2841 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2842 psa_algorithm_t psa_hash_alg;
2843 int hash_length;
2844
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002845#if defined(MBEDTLS_HAVE_TIME)
2846 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002848#endif
2849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2851 if (ciphersuite_info == NULL) {
2852 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2853 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002854 }
2855
Manuel Pégourié-Gonnard1f2a5872023-03-28 11:46:17 +02002856 psa_hash_alg = mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2858 if (hash_length == -1 ||
2859 (size_t) hash_length > sizeof(session->resumption_key)) {
2860 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002861 }
2862
Jerry Yuf8a49942022-07-07 11:32:32 +00002863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2865 session->app_secrets.resumption_master_secret,
2866 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002867
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002868 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002869 *
2870 * HKDF-Expand-Label( resumption_master_secret,
2871 * "resumption", ticket_nonce, Hash.length )
2872 */
2873 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 psa_hash_alg,
2875 session->app_secrets.resumption_master_secret,
2876 hash_length,
2877 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2878 ticket_nonce,
2879 ticket_nonce_len,
2880 session->resumption_key,
2881 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002882
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 if (ret != 0) {
2884 MBEDTLS_SSL_DEBUG_RET(2,
2885 "Creating the ticket-resumed PSK failed",
2886 ret);
2887 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002888 }
2889
Jerry Yu0a430c82022-07-20 11:02:48 +08002890 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002891
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2893 session->resumption_key,
2894 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002895
Pengyu Lv9f926952022-11-17 15:22:33 +08002896 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002897 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002898 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002899 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002900
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002902}
2903
2904/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002905 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002906 */
Jerry Yua0446a02022-07-13 11:22:55 +08002907MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002908static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002909{
2910 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2911 unsigned char *buf;
2912 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002913 unsigned char *ticket_nonce;
2914 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2919 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2920 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2923 ssl, buf, buf + buf_len,
2924 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2927 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002928
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002930
Jerry Yuf8a49942022-07-07 11:32:32 +00002931cleanup:
2932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2934 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002935}
2936#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002939{
Jerry Yu92c6b402021-08-27 16:59:09 +08002940 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002941
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002943 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002945 break;
2946
Jerry Yu92c6b402021-08-27 16:59:09 +08002947 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002949 break;
2950
2951 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002953 break;
2954
2955 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002957 break;
2958
Ronald Cron928cbd32022-10-04 16:14:26 +02002959#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002960 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002962 break;
2963
Jerry Yu687101b2021-09-14 16:03:56 +08002964 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002966 break;
2967
2968 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002970 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002971#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002972
2973 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002975 break;
2976
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002977 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2978 ret = ssl_tls13_write_end_of_early_data(ssl);
2979 break;
2980
Jerry Yu566c7812022-01-26 15:41:22 +08002981 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002983 break;
2984
Ronald Cron928cbd32022-10-04 16:14:26 +02002985#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002986 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002988 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002989#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002990
Jerry Yu687101b2021-09-14 16:03:56 +08002991 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002993 break;
2994
2995 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002997 break;
2998
2999 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08003001 break;
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 /*
3004 * Injection of dummy-CCS's for middlebox compatibility
3005 */
Ronald Cron49ad6192021-11-24 16:25:31 +01003006#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00003007 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3009 if (ret == 0) {
3010 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3011 }
Ronald Cron9f55f632022-02-02 16:02:47 +01003012 break;
3013
3014 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3016 if (ret == 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00003017 mbedtls_ssl_handshake_set_state(
3018 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 }
Ronald Cron49ad6192021-11-24 16:25:31 +01003020 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003021
Xiaokang Qian592021a2023-01-04 10:47:05 +00003022 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3023 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3024 if (ret == 0) {
3025 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3026
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003027#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003028 MBEDTLS_SSL_DEBUG_MSG(
3029 1, ("Switch to early data keys for outbound traffic"));
3030 mbedtls_ssl_set_outbound_transform(
3031 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003032#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003033 }
3034 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003035#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3036
Jerry Yuf8a49942022-07-07 11:32:32 +00003037#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003038 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 ret = ssl_tls13_process_new_session_ticket(ssl);
3040 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003041 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003043 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3044 break;
3045#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3046
Jerry Yu92c6b402021-08-27 16:59:09 +08003047 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3049 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003050 }
3051
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003053}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003054
Jerry Yufb4b6472022-01-27 15:03:26 +08003055#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */