blob: 8f757462d4d6d29238bd4ba786ecd78aacde8194 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
2 * TLS 1.3 client-side functions
3 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS ( https://tls.mbed.org )
20 */
21
22#include "common.h"
23
Jerry Yucc43c6b2022-01-28 10:24:45 +080024#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080025
Jerry Yubc20bdd2021-08-24 15:59:48 +080026#include <string.h>
27
Jerry Yu56fc07f2021-09-01 17:48:49 +080028#include "mbedtls/debug.h"
29#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080030#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080031
Jerry Yubdc71882021-09-14 19:30:36 +080032#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010033#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080034#include "ssl_tls13_keys.h"
Jerry Yucbd082f2022-08-04 16:55:10 +080035#include "ssl_debug_helpers.h"
Jerry Yubdc71882021-09-14 19:30:36 +080036
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050037#define PSA_TO_MBEDTLS_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
38 psa_to_ssl_errors, \
39 psa_generic_status_to_mbedtls)
40
Jerry Yubc20bdd2021-08-24 15:59:48 +080041/* Write extensions */
42
Jerry Yu92c6b402021-08-27 16:59:09 +080043/*
44 * ssl_tls13_write_supported_versions_ext():
45 *
46 * struct {
47 * ProtocolVersion versions<2..254>;
48 * } SupportedVersions;
49 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020050MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010051static int ssl_tls13_write_supported_versions_ext(mbedtls_ssl_context *ssl,
52 unsigned char *buf,
53 unsigned char *end,
54 size_t *out_len)
Jerry Yu92c6b402021-08-27 16:59:09 +080055{
56 unsigned char *p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +010057 unsigned char versions_len = (ssl->handshake->min_tls_version <=
58 MBEDTLS_SSL_VERSION_TLS1_2) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080059
Xiaofei Baid25fab62021-12-02 06:36:27 +000060 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080061
Gilles Peskine449bd832023-01-11 14:50:10 +010062 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding supported versions extension"));
Jerry Yu92c6b402021-08-27 16:59:09 +080063
Jerry Yu388bd0d2021-09-15 18:41:02 +080064 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080065 * - extension_type (2 bytes)
66 * - extension_data_length (2 bytes)
67 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020068 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080069 */
Gilles Peskine449bd832023-01-11 14:50:10 +010070 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 5 + versions_len);
Ronald Crondbe87f02022-02-10 14:35:27 +010071
Gilles Peskine449bd832023-01-11 14:50:10 +010072 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0);
73 MBEDTLS_PUT_UINT16_BE(versions_len + 1, p, 2);
Jerry Yueecfbf02021-08-30 18:32:07 +080074 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080075
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080076 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010077 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080078
Jerry Yu0c63af62021-09-02 12:59:12 +080079 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080080 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010081 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080082 */
Gilles Peskine449bd832023-01-11 14:50:10 +010083 mbedtls_ssl_write_version(p, MBEDTLS_SSL_TRANSPORT_STREAM,
84 MBEDTLS_SSL_VERSION_TLS1_3);
85 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:4]"));
Jerry Yu92c6b402021-08-27 16:59:09 +080086
Jerry Yu92c6b402021-08-27 16:59:09 +080087
Gilles Peskine449bd832023-01-11 14:50:10 +010088 if (ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
89 mbedtls_ssl_write_version(p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
90 MBEDTLS_SSL_VERSION_TLS1_2);
91 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:3]"));
Ronald Crondbe87f02022-02-10 14:35:27 +010092 }
93
94 *out_len = 5 + versions_len;
Jerry Yu4b8f2f72022-10-31 13:31:22 +080095
Jerry Yuc4bf5d62022-10-29 09:08:47 +080096 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +010097 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yu4b8f2f72022-10-31 13:31:22 +080098
Gilles Peskine449bd832023-01-11 14:50:10 +010099 return 0;
Jerry Yu92c6b402021-08-27 16:59:09 +0800100}
Jerry Yubc20bdd2021-08-24 15:59:48 +0800101
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200102MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100103static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
104 const unsigned char *buf,
105 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800106{
Jerry Yue1b9c292021-09-10 10:08:31 +0800107 ((void) ssl);
108
Gilles Peskine449bd832023-01-11 14:50:10 +0100109 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
110 if (mbedtls_ssl_read_version(buf, ssl->conf->transport) !=
111 MBEDTLS_SSL_VERSION_TLS1_3) {
112 MBEDTLS_SSL_DEBUG_MSG(1, ("unexpected version"));
Jerry Yu4a173382021-10-11 21:45:31 +0800113
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
115 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
116 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +0800117 }
118
Gilles Peskine449bd832023-01-11 14:50:10 +0100119 if (&buf[2] != end) {
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000120 MBEDTLS_SSL_DEBUG_MSG(
121 1, ("supported_versions ext data length incorrect"));
Gilles Peskine449bd832023-01-11 14:50:10 +0100122 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
123 MBEDTLS_ERR_SSL_DECODE_ERROR);
124 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Ronald Cron98473382022-03-30 20:04:10 +0200125 }
126
Gilles Peskine449bd832023-01-11 14:50:10 +0100127 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +0800128}
129
lhuang0486cacac2022-01-21 07:34:27 -0800130#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200131MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100132static int ssl_tls13_parse_alpn_ext(mbedtls_ssl_context *ssl,
133 const unsigned char *buf, size_t len)
lhuang0486cacac2022-01-21 07:34:27 -0800134{
lhuang0486cacac2022-01-21 07:34:27 -0800135 const unsigned char *p = buf;
136 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200137 size_t protocol_name_list_len, protocol_name_len;
138 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800139
140 /* If we didn't send it, the server shouldn't send it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100141 if (ssl->conf->alpn_list == NULL) {
142 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
143 }
lhuang0486cacac2022-01-21 07:34:27 -0800144
145 /*
146 * opaque ProtocolName<1..2^8-1>;
147 *
148 * struct {
149 * ProtocolName protocol_name_list<2..2^16-1>
150 * } ProtocolNameList;
151 *
152 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
153 */
154
Gilles Peskine449bd832023-01-11 14:50:10 +0100155 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
156 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
lhuang0486cacac2022-01-21 07:34:27 -0800157 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
Ronald Cron81a334f2022-05-31 16:04:11 +0200160 protocol_name_list_end = p + protocol_name_list_len;
161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, 1);
Ronald Cron81a334f2022-05-31 16:04:11 +0200163 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800164
165 /* Check that the server chosen protocol was in our list and save it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, protocol_name_len);
167 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
168 if (protocol_name_len == strlen(*alpn) &&
169 memcmp(p, *alpn, protocol_name_len) == 0) {
lhuang0486cacac2022-01-21 07:34:27 -0800170 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +0100171 return 0;
lhuang0486cacac2022-01-21 07:34:27 -0800172 }
173 }
174
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
lhuang0486cacac2022-01-21 07:34:27 -0800176}
177#endif /* MBEDTLS_SSL_ALPN */
178
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200179MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100180static int ssl_tls13_reset_key_share(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +0000181{
182 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (group_id == 0) {
185 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
186 }
XiaokangQian647719a2021-12-07 09:16:29 +0000187
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200188#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
189 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) ||
190 mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100191 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
192 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
193
194 /* Destroy generated private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 status = psa_destroy_key(ssl->handshake->ecdh_psa_privkey);
196 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500197 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 MBEDTLS_SSL_DEBUG_RET(1, "psa_destroy_key", ret);
199 return ret;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100200 }
201
202 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100203 return 0;
204 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200205#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 if (0 /* other KEMs? */) {
XiaokangQian647719a2021-12-07 09:16:29 +0000207 /* Do something */
208 }
209
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQian647719a2021-12-07 09:16:29 +0000211}
212
213/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800214 * Functions for writing key_share extension.
215 */
Ronald Cron766c0cd2022-10-18 12:17:11 +0200216#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200217MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100218static int ssl_tls13_get_default_group_id(mbedtls_ssl_context *ssl,
219 uint16_t *group_id)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800220{
221 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
222
Jerry Yu56fc07f2021-09-01 17:48:49 +0800223
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200224#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Jerry Yu388bd0d2021-09-15 18:41:02 +0800226 /* Pick first available ECDHE group compatible with TLS 1.3 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 if (group_list == NULL) {
228 return MBEDTLS_ERR_SSL_BAD_CONFIG;
229 }
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200230
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 for (; *group_list != 0; group_list++) {
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200232#if defined(PSA_WANT_ALG_ECDH)
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000233 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
234 *group_list, NULL, NULL) == PSA_SUCCESS) &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100235 mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
Brett Warren14efd332021-10-06 09:32:11 +0100236 *group_id = *group_list;
Gilles Peskine449bd832023-01-11 14:50:10 +0100237 return 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800238 }
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200239#endif
240#if defined(PSA_WANT_ALG_FFDH)
241 if (mbedtls_ssl_tls13_named_group_is_dhe(*group_list)) {
242 *group_id = *group_list;
243 return 0;
244 }
245#endif
Jerry Yu56fc07f2021-09-01 17:48:49 +0800246 }
247#else
248 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800249 ((void) group_id);
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200250#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800253}
254
255/*
256 * ssl_tls13_write_key_share_ext
257 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800258 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800259 *
260 * struct {
261 * NamedGroup group;
262 * opaque key_exchange<1..2^16-1>;
263 * } KeyShareEntry;
264 * struct {
265 * KeyShareEntry client_shares<0..2^16-1>;
266 * } KeyShareClientHello;
267 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200268MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100269static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
270 unsigned char *buf,
271 unsigned char *end,
272 size_t *out_len)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800273{
274 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000275 unsigned char *client_shares; /* Start of client_shares */
276 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800277 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800278 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
279
Xiaofei Baid25fab62021-12-02 06:36:27 +0000280 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800281
Jerry Yub60e3cf2021-09-08 16:41:02 +0800282 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800283 * - extension_type (2 bytes)
284 * - extension_data_length (2 bytes)
285 * - client_shares_length (2 bytes)
286 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800288 p += 6;
289
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello: adding key share extension"));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800291
292 /* HRR could already have requested something else. */
293 group_id = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 if (!mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) &&
295 !mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
296 MBEDTLS_SSL_PROC_CHK(ssl_tls13_get_default_group_id(ssl,
297 &group_id));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800298 }
299
300 /*
301 * Dispatch to type-specific key generation function.
302 *
303 * So far, we're only supporting ECDHE. With the introduction
304 * of PQC KEMs, we'll want to have multiple branches, one per
305 * type of KEM, and dispatch to the corresponding crypto. And
306 * only one key share entry is allowed.
307 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000308 client_shares = p;
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200309#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
310 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) ||
311 mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800312 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000313 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800314 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100315 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800316
317 /* Check there is space for header of KeyShareEntry
318 * - group (2 bytes)
319 * - key_exchange_length (2 bytes)
320 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800322 p += 4;
Przemek Stekiel29c219c2023-05-31 15:21:04 +0200323 ret = mbedtls_ssl_tls13_generate_and_write_dh_key_exchange(
324 ssl, group_id, p, end, &key_exchange_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800325 p += key_exchange_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 if (ret != 0) {
327 return ret;
328 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800329
330 /* Write group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 MBEDTLS_PUT_UINT16_BE(group_id, group, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800332 /* Write key_exchange_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 MBEDTLS_PUT_UINT16_BE(key_exchange_len, group, 2);
334 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200335#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 if (0 /* other KEMs? */) {
Jerry Yu56fc07f2021-09-01 17:48:49 +0800337 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 } else {
339 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800340 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800341
Jerry Yub60e3cf2021-09-08 16:41:02 +0800342 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000343 client_shares_len = p - client_shares;
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 if (client_shares_len == 0) {
345 MBEDTLS_SSL_DEBUG_MSG(1, ("No key share defined."));
346 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu7c522d42021-09-08 17:55:09 +0800347 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800348 /* Write extension_type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800350 /* Write extension_data_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 MBEDTLS_PUT_UINT16_BE(client_shares_len + 2, buf, 2);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800352 /* Write client_shares_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 MBEDTLS_PUT_UINT16_BE(client_shares_len, buf, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800354
355 /* Update offered_group_id field */
356 ssl->handshake->offered_group_id = group_id;
357
358 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000359 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800360
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000361 MBEDTLS_SSL_DEBUG_BUF(
362 3, "client hello, key_share extension", buf, *out_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800363
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800365
366cleanup:
367
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800369}
Ronald Cron766c0cd2022-10-18 12:17:11 +0200370#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +0800371
XiaokangQiand59be772022-01-24 10:12:51 +0000372/*
373 * ssl_tls13_parse_hrr_key_share_ext()
374 * Parse key_share extension in Hello Retry Request
375 *
376 * struct {
377 * NamedGroup selected_group;
378 * } KeyShareHelloRetryRequest;
379 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100381static int ssl_tls13_parse_hrr_key_share_ext(mbedtls_ssl_context *ssl,
382 const unsigned char *buf,
383 const unsigned char *end)
XiaokangQianb851da82022-01-14 04:03:11 +0000384{
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200385#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQianb851da82022-01-14 04:03:11 +0000386 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000387 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000388 int found = 0;
389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
391 if (group_list == NULL) {
392 return MBEDTLS_ERR_SSL_BAD_CONFIG;
393 }
XiaokangQianb851da82022-01-14 04:03:11 +0000394
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 MBEDTLS_SSL_DEBUG_BUF(3, "key_share extension", p, end - buf);
XiaokangQianb851da82022-01-14 04:03:11 +0000396
397 /* Read selected_group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
399 selected_group = MBEDTLS_GET_UINT16_BE(p, 0);
400 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_group ( %d )", selected_group));
XiaokangQianb851da82022-01-14 04:03:11 +0000401
402 /* Upon receipt of this extension in a HelloRetryRequest, the client
403 * MUST first verify that the selected_group field corresponds to a
404 * group which was provided in the "supported_groups" extension in the
405 * original ClientHello.
406 * The supported_group was based on the info in ssl->conf->group_list.
407 *
408 * If the server provided a key share that was not sent in the ClientHello
409 * then the client MUST abort the handshake with an "illegal_parameter" alert.
410 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 for (; *group_list != 0; group_list++) {
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200412#if defined(PSA_WANT_ALG_ECDH)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200413 if (mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
414 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
415 *group_list, NULL, NULL) == PSA_ERROR_NOT_SUPPORTED) ||
416 *group_list != selected_group) {
417 found = 1;
418 break;
419 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 }
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200421#endif /* PSA_WANT_ALG_ECDH */
422#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200423 if (mbedtls_ssl_tls13_named_group_is_dhe(*group_list)) {
424 found = 1;
425 break;
426 }
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200427#endif /* PSA_WANT_ALG_FFDH */
XiaokangQianb851da82022-01-14 04:03:11 +0000428 }
429
430 /* Client MUST verify that the selected_group field does not
431 * correspond to a group which was provided in the "key_share"
432 * extension in the original ClientHello. If the server sent an
433 * HRR message with a key share already provided in the
434 * ClientHello then the client MUST abort the handshake with
435 * an "illegal_parameter" alert.
436 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 if (found == 0 || selected_group == ssl->handshake->offered_group_id) {
438 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid key share in HRR"));
XiaokangQianb851da82022-01-14 04:03:11 +0000439 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
441 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
442 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQianb851da82022-01-14 04:03:11 +0000443 }
444
445 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000446 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000447
Gilles Peskine449bd832023-01-11 14:50:10 +0100448 return 0;
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200449#else /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400450 (void) ssl;
451 (void) buf;
452 (void) end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200454#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQianb851da82022-01-14 04:03:11 +0000455}
456
Jerry Yue1b9c292021-09-10 10:08:31 +0800457/*
Jerry Yub85277e2021-10-13 13:36:05 +0800458 * ssl_tls13_parse_key_share_ext()
459 * Parse key_share extension in Server Hello
460 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800461 * struct {
462 * KeyShareEntry server_share;
463 * } KeyShareServerHello;
464 * struct {
465 * NamedGroup group;
466 * opaque key_exchange<1..2^16-1>;
467 * } KeyShareEntry;
468 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200469MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100470static int ssl_tls13_parse_key_share_ext(mbedtls_ssl_context *ssl,
471 const unsigned char *buf,
472 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800473{
Jerry Yub85277e2021-10-13 13:36:05 +0800474 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800475 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800476 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800477
Jerry Yu4a173382021-10-11 21:45:31 +0800478 /* ...
479 * NamedGroup group; (2 bytes)
480 * ...
481 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100482 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
483 group = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +0800484 p += 2;
485
Jerry Yu4a173382021-10-11 21:45:31 +0800486 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800487 offered_group = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100488 if (offered_group != group) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000489 MBEDTLS_SSL_DEBUG_MSG(
490 1, ("Invalid server key share, our group %u, their group %u",
491 (unsigned) offered_group, (unsigned) group));
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
493 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
494 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yue1b9c292021-09-10 10:08:31 +0800495 }
496
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200497#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
498 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
499 mbedtls_ssl_tls13_named_group_is_dhe(group)) {
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200500 MBEDTLS_SSL_DEBUG_MSG(2,
501 ("DHE group name: %s", mbedtls_ssl_named_group_to_str(group)));
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(ssl, p, end - p);
503 if (ret != 0) {
504 return ret;
505 }
506 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200507#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100508 if (0 /* other KEMs? */) {
Jerry Yue1b9c292021-09-10 10:08:31 +0800509 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 } else {
511 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yue1b9c292021-09-10 10:08:31 +0800512 }
Jerry Yue1b9c292021-09-10 10:08:31 +0800513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +0800515}
516
XiaokangQiand59be772022-01-24 10:12:51 +0000517/*
518 * ssl_tls13_parse_cookie_ext()
519 * Parse cookie extension in Hello Retry Request
520 *
521 * struct {
522 * opaque cookie<1..2^16-1>;
523 * } Cookie;
524 *
525 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
526 * extension to the client (this is an exception to the usual rule that
527 * the only extensions that may be sent are those that appear in the
528 * ClientHello). When sending the new ClientHello, the client MUST copy
529 * the contents of the extension received in the HelloRetryRequest into
530 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
531 * cookies in their initial ClientHello in subsequent connections.
532 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200533MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100534static int ssl_tls13_parse_cookie_ext(mbedtls_ssl_context *ssl,
535 const unsigned char *buf,
536 const unsigned char *end)
XiaokangQian43550bd2022-01-21 04:32:58 +0000537{
XiaokangQian25c9c902022-02-08 10:49:53 +0000538 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000539 const unsigned char *p = buf;
540 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
541
542 /* Retrieve length field of cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
544 cookie_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian43550bd2022-01-21 04:32:58 +0000545 p += 2;
546
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cookie_len);
548 MBEDTLS_SSL_DEBUG_BUF(3, "cookie extension", p, cookie_len);
XiaokangQian43550bd2022-01-21 04:32:58 +0000549
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 mbedtls_free(handshake->cookie);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800551 handshake->cookie_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 handshake->cookie = mbedtls_calloc(1, cookie_len);
553 if (handshake->cookie == NULL) {
554 MBEDTLS_SSL_DEBUG_MSG(1,
555 ("alloc failed ( %ud bytes )",
556 cookie_len));
557 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
XiaokangQian43550bd2022-01-21 04:32:58 +0000558 }
559
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 memcpy(handshake->cookie, p, cookie_len);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800561 handshake->cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000562
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 return 0;
XiaokangQian43550bd2022-01-21 04:32:58 +0000564}
XiaokangQian43550bd2022-01-21 04:32:58 +0000565
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200566MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100567static int ssl_tls13_write_cookie_ext(mbedtls_ssl_context *ssl,
568 unsigned char *buf,
569 unsigned char *end,
570 size_t *out_len)
XiaokangQian0b64eed2022-01-27 10:36:51 +0000571{
572 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000573 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000574 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000575
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 if (handshake->cookie == NULL) {
577 MBEDTLS_SSL_DEBUG_MSG(3, ("no cookie to send; skip extension"));
578 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000579 }
580
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, cookie",
582 handshake->cookie,
583 handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000584
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 MBEDTLS_SSL_CHK_BUF_PTR(p, end, handshake->cookie_len + 6);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000586
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding cookie extension"));
XiaokangQian0b64eed2022-01-27 10:36:51 +0000588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_COOKIE, p, 0);
590 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len + 2, p, 2);
591 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len, p, 4);
XiaokangQian233397e2022-02-07 08:32:16 +0000592 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000593
594 /* Cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 memcpy(p, handshake->cookie, handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000596
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800597 *out_len = handshake->cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000598
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_COOKIE);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800600
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000602}
603
Ronald Cron41a443a2022-10-04 16:38:25 +0200604#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000605/*
606 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
607 *
608 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
609 *
610 * struct {
611 * PskKeyExchangeMode ke_modes<1..255>;
612 * } PskKeyExchangeModes;
613 */
XiaokangQian86981952022-07-19 09:51:50 +0000614MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100615static int ssl_tls13_write_psk_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
616 unsigned char *buf,
617 unsigned char *end,
618 size_t *out_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000619{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000620 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000621 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000622
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 ((void) ke_modes_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000624 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000625
XiaokangQianeb69aee2022-07-05 08:21:43 +0000626 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000627 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000628 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 if (!mbedtls_ssl_conf_tls13_some_psk_enabled(ssl)) {
630 MBEDTLS_SSL_DEBUG_MSG(3, ("skip psk_key_exchange_modes extension"));
631 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000632 }
633
634 /* Require 7 bytes of data, otherwise fail,
635 * even if extension might be shorter.
636 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100637 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000638 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100639 3, ("client hello, adding psk_key_exchange_modes extension"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000640
Gilles Peskine449bd832023-01-11 14:50:10 +0100641 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000642
XiaokangQian008d2bf2022-07-14 07:54:01 +0000643 /* Skip extension length (2 bytes) and
644 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000645 */
646 p += 5;
647
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 if (mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl)) {
XiaokangQianeb69aee2022-07-05 08:21:43 +0000649 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000650 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000651
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding PSK-ECDHE key exchange mode"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000653 }
654
Gilles Peskine449bd832023-01-11 14:50:10 +0100655 if (mbedtls_ssl_conf_tls13_psk_enabled(ssl)) {
Ronald Crona709a0f2022-09-27 16:46:11 +0200656 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
657 ke_modes_len++;
658
Gilles Peskine449bd832023-01-11 14:50:10 +0100659 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding pure PSK key exchange mode"));
Ronald Crona709a0f2022-09-27 16:46:11 +0200660 }
661
XiaokangQian008d2bf2022-07-14 07:54:01 +0000662 /* Now write the extension and ke_modes length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100663 MBEDTLS_PUT_UINT16_BE(ke_modes_len + 1, buf, 2);
XiaokangQian008d2bf2022-07-14 07:54:01 +0000664 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000665
666 *out_len = p - buf;
Jerry Yu0c354a22022-08-29 15:25:36 +0800667
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800668 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100669 ssl, MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000672}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800673
Gilles Peskine449bd832023-01-11 14:50:10 +0100674static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg(int ciphersuite)
Jerry Yuf7c12592022-09-28 22:09:38 +0800675{
Jerry Yu21f90952022-10-08 10:30:53 +0800676 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800678
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 if (ciphersuite_info != NULL) {
680 return mbedtls_psa_translate_md(ciphersuite_info->mac);
681 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 return PSA_ALG_NONE;
Jerry Yuf7c12592022-09-28 22:09:38 +0800684}
685
Jerry Yuf75364b2022-09-30 10:30:31 +0800686#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100687static int ssl_tls13_has_configured_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qianb781a232022-11-01 07:39:46 +0000688{
689 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return ssl->handshake->resume &&
Pengyu Lv93566782022-12-07 12:10:05 +0800691 session != NULL && session->ticket != NULL &&
Pengyu Lv9b84ea72023-01-16 14:08:23 +0800692 mbedtls_ssl_conf_tls13_check_kex_modes(
693 ssl, mbedtls_ssl_session_get_ticket_flags(
694 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL));
Xiaokang Qianb781a232022-11-01 07:39:46 +0000695}
696
Xiaokang Qian01323a42022-11-03 02:27:35 +0000697#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100698static int ssl_tls13_early_data_has_valid_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qian01323a42022-11-03 02:27:35 +0000699{
700 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return ssl->handshake->resume &&
702 session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
703 (session->ticket_flags &
704 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) &&
705 mbedtls_ssl_tls13_cipher_suite_is_offered(
706 ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000707}
708#endif
709
Xiaokang Qianb781a232022-11-01 07:39:46 +0000710MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100711static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
712 psa_algorithm_t *hash_alg,
713 const unsigned char **identity,
714 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800715{
716 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800717
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 if (!ssl_tls13_has_configured_ticket(ssl)) {
719 return -1;
720 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800723 *identity = session->ticket;
724 *identity_len = session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800726}
727
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800728MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100729static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
730 psa_algorithm_t *hash_alg,
731 const unsigned char **psk,
732 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800733{
734
735 mbedtls_ssl_session *session = ssl->session_negotiate;
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 if (!ssl_tls13_has_configured_ticket(ssl)) {
738 return -1;
739 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800740
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800742 *psk = session->resumption_key;
743 *psk_len = session->resumption_key_len;
744
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800746}
Jerry Yuf7c12592022-09-28 22:09:38 +0800747#endif /* MBEDTLS_SSL_SESSION_TICKETS */
748
749MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100750static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
751 psa_algorithm_t *hash_alg,
752 const unsigned char **identity,
753 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800754{
Jerry Yu8b41e892022-09-30 10:00:20 +0800755
Gilles Peskine449bd832023-01-11 14:50:10 +0100756 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
757 return -1;
758 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800759
Jerry Yua99cbfa2022-10-08 11:17:14 +0800760 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800761 *identity = ssl->conf->psk_identity;
762 *identity_len = ssl->conf->psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100763 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800764}
765
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800766MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100767static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
768 psa_algorithm_t *hash_alg,
769 const unsigned char **psk,
770 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800771{
Jerry Yu8b41e892022-09-30 10:00:20 +0800772
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
774 return -1;
775 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800776
Jerry Yua99cbfa2022-10-08 11:17:14 +0800777 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800778 *psk = ssl->conf->psk;
779 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800781}
782
Gilles Peskine449bd832023-01-11 14:50:10 +0100783static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800784{
785 int configured_psk_count = 0;
786#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (ssl_tls13_has_configured_ticket(ssl)) {
788 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800789 configured_psk_count++;
790 }
791#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
793 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800794 configured_psk_count++;
795 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800797}
798
Jerry Yuf7c12592022-09-28 22:09:38 +0800799MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100800static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
801 unsigned char *buf,
802 unsigned char *end,
803 const unsigned char *identity,
804 size_t identity_len,
805 uint32_t obfuscated_ticket_age,
806 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800807{
Jerry Yuf75364b2022-09-30 10:30:31 +0800808 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800809 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800810
811 /*
812 * - identity_len (2 bytes)
813 * - identity (psk_identity_len bytes)
814 * - obfuscated_ticket_age (4 bytes)
815 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800817
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
819 memcpy(buf + 2, identity, identity_len);
820 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800821
Gilles Peskine449bd832023-01-11 14:50:10 +0100822 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800823
824 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800825
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800827}
828
Jerry Yu8b41e892022-09-30 10:00:20 +0800829MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100830static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
831 unsigned char *buf,
832 unsigned char *end,
833 int psk_type,
834 psa_algorithm_t hash_alg,
835 const unsigned char *psk,
836 size_t psk_len,
837 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800838{
839 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800840 unsigned char binder_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100841 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800842 size_t transcript_len = 0;
843
844 *out_len = 0;
845
Gilles Peskine449bd832023-01-11 14:50:10 +0100846 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800847
848 /*
849 * - binder_len (1 bytes)
850 * - binder (binder_len bytes)
851 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100852 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800853
Jerry Yua99cbfa2022-10-08 11:17:14 +0800854 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800855
856 /* Get current state of handshake transcript. */
857 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100858 ssl, mbedtls_hash_info_md_from_psa(hash_alg),
859 transcript, sizeof(transcript), &transcript_len);
860 if (ret != 0) {
861 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800862 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100863
864 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
865 psk, psk_len, psk_type,
866 transcript, buf + 1);
867 if (ret != 0) {
868 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
869 return ret;
870 }
871 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800872
873 *out_len = 1 + binder_len;
874
Gilles Peskine449bd832023-01-11 14:50:10 +0100875 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800876}
877
878/*
879 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
880 *
881 * struct {
882 * opaque identity<1..2^16-1>;
883 * uint32 obfuscated_ticket_age;
884 * } PskIdentity;
885 *
886 * opaque PskBinderEntry<32..255>;
887 *
888 * struct {
889 * PskIdentity identities<7..2^16-1>;
890 * PskBinderEntry binders<33..2^16-1>;
891 * } OfferedPsks;
892 *
893 * struct {
894 * select (Handshake.msg_type) {
895 * case client_hello: OfferedPsks;
896 * ...
897 * };
898 * } PreSharedKeyExtension;
899 *
900 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000901int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100902 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
903 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000904{
Jerry Yuf7c12592022-09-28 22:09:38 +0800905 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800906 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800907 unsigned char *p = buf;
Xiaokang Qian854db282022-12-19 07:31:27 +0000908 psa_algorithm_t hash_alg = PSA_ALG_NONE;
Jerry Yuf75364b2022-09-30 10:30:31 +0800909 const unsigned char *identity;
910 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800911 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800912 size_t output_len;
Xiaokang Qian7179f812023-02-03 03:38:44 +0000913
Jerry Yuf7c12592022-09-28 22:09:38 +0800914 *out_len = 0;
915 *binders_len = 0;
916
917 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Gilles Peskine449bd832023-01-11 14:50:10 +0100918 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
919 if (configured_psk_count == 0) {
920 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
921 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800922 }
923
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
925 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800926
Jerry Yuf7c12592022-09-28 22:09:38 +0800927 /* Check if we have space to write the extension, binders included.
928 * - extension_type (2 bytes)
929 * - extension_data_len (2 bytes)
930 * - identities_len (2 bytes)
931 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100932 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800933 p += 6;
934
Jerry Yuf75364b2022-09-30 10:30:31 +0800935#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 if (ssl_tls13_ticket_get_identity(
937 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800938#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 mbedtls_time_t now = mbedtls_time(NULL);
Jerry Yuf75364b2022-09-30 10:30:31 +0800940 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800941 uint32_t obfuscated_ticket_age =
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 (uint32_t) (now - session->ticket_received);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800943
Jerry Yu3e60cad2023-01-10 14:58:08 +0800944 /*
945 * The ticket timestamp is in seconds but the ticket age is in
946 * milliseconds. If the ticket was received at the end of a second and
947 * re-used here just at the beginning of the next second, the computed
948 * age `now - session->ticket_received` is equal to 1s thus 1000 ms
949 * while the actual age could be just a few milliseconds or tens of
950 * milliseconds. If the server has more accurate ticket timestamps
951 * (typically timestamps in milliseconds), as part of the processing of
952 * the ClientHello, it may compute a ticket lifetime smaller than the
953 * one computed here and potentially reject the ticket. To avoid that,
954 * remove one second to the ticket age if possible.
Jerry Yubdb936b2023-01-07 16:07:46 +0800955 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 if (obfuscated_ticket_age > 0) {
Jerry Yubdb936b2023-01-07 16:07:46 +0800957 obfuscated_ticket_age -= 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 }
Jerry Yubdb936b2023-01-07 16:07:46 +0800959
Jerry Yuf75364b2022-09-30 10:30:31 +0800960 obfuscated_ticket_age *= 1000;
961 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800962
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 ret = ssl_tls13_write_identity(ssl, p, end,
964 identity, identity_len,
965 obfuscated_ticket_age,
966 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800967#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
969 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800970#endif /* MBEDTLS_HAVE_TIME */
Gilles Peskine449bd832023-01-11 14:50:10 +0100971 if (ret != 0) {
972 return ret;
973 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800974
Jerry Yuf75364b2022-09-30 10:30:31 +0800975 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +0800977 }
978#endif /* MBEDTLS_SSL_SESSION_TICKETS */
979
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 if (ssl_tls13_psk_get_identity(
981 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800982
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
984 &output_len);
985 if (ret != 0) {
986 return ret;
987 }
Jerry Yuf75364b2022-09-30 10:30:31 +0800988
Jerry Yuf7c12592022-09-28 22:09:38 +0800989 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +0800991 }
992
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 MBEDTLS_SSL_DEBUG_MSG(3,
994 ("client hello, adding pre_shared_key extension, "
995 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +0800996
997 /* Take into account the two bytes for the length of the binders. */
998 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800999 /* Check if there is enough space for binders */
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +08001001
Jerry Yuf7c12592022-09-28 22:09:38 +08001002 /*
1003 * - extension_type (2 bytes)
1004 * - extension_data_len (2 bytes)
1005 * - identities_len (2 bytes)
1006 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
1008 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
1009 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +08001010
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001012 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +08001013
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +08001015
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001017}
1018
XiaokangQian86981952022-07-19 09:51:50 +00001019int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001021{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001022 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1023 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001024 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1025 const unsigned char *psk;
1026 size_t psk_len;
1027 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001028
1029 /* Check if we have space to write binders_len.
1030 * - binders_len (2 bytes)
1031 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001032 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001033 p += 2;
1034
Jerry Yu6183cc72022-09-30 11:08:57 +08001035#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001037
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 ret = ssl_tls13_write_binder(ssl, p, end,
1039 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1040 hash_alg, psk, psk_len,
1041 &output_len);
1042 if (ret != 0) {
1043 return ret;
1044 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001045 p += output_len;
1046 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001047#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001050
Gilles Peskine449bd832023-01-11 14:50:10 +01001051 ret = ssl_tls13_write_binder(ssl, p, end,
1052 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1053 hash_alg, psk, psk_len,
1054 &output_len);
1055 if (ret != 0) {
1056 return ret;
1057 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001058 p += output_len;
1059 }
1060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001062
1063 /*
1064 * - binders_len (2 bytes)
1065 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001069
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001070 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001072
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001074}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001075
1076/*
1077 * struct {
1078 * opaque identity<1..2^16-1>;
1079 * uint32 obfuscated_ticket_age;
1080 * } PskIdentity;
1081 *
1082 * opaque PskBinderEntry<32..255>;
1083 *
1084 * struct {
1085 *
1086 * select (Handshake.msg_type) {
1087 * ...
1088 * case server_hello: uint16 selected_identity;
1089 * };
1090 *
1091 * } PreSharedKeyExtension;
1092 *
1093 */
1094MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001095static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1096 const unsigned char *buf,
1097 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001098{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001099 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001100 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001101 const unsigned char *psk;
1102 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001103 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001104
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1106 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001107 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001110
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1112 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001113
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1115 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1116 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001117 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001118
Jerry Yu4a698342022-09-30 12:22:01 +08001119#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1121 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1122 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001123#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1125 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
1126 } else {
1127 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1128 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001129 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 if (ret != 0) {
1131 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001132 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001133
Xiaokang Qianeb31cbc2023-02-07 02:08:56 +00001134 if (mbedtls_psa_translate_md(ssl->handshake->ciphersuite_info->mac)
1135 != hash_alg) {
1136 MBEDTLS_SSL_DEBUG_MSG(
1137 1, ("Invalid ciphersuite for external psk."));
1138
1139 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1140 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1141 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1142 }
1143
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1145 if (ret != 0) {
1146 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1147 return ret;
1148 }
1149
1150 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001151}
Ronald Cron41a443a2022-10-04 16:38:25 +02001152#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001153
Gilles Peskine449bd832023-01-11 14:50:10 +01001154int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1155 unsigned char *buf,
1156 unsigned char *end,
1157 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001158{
1159 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1160 unsigned char *p = buf;
1161 size_t ext_len;
1162
1163 *out_len = 0;
1164
1165 /* Write supported_versions extension
1166 *
1167 * Supported Versions Extension is mandatory with TLS 1.3.
1168 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1170 if (ret != 0) {
1171 return ret;
1172 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001173 p += ext_len;
1174
1175 /* Echo the cookie if the server provided one in its preceding
1176 * HelloRetryRequest message.
1177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1179 if (ret != 0) {
1180 return ret;
1181 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001182 p += ext_len;
1183
Ronald Cron766c0cd2022-10-18 12:17:11 +02001184#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001185 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1186 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1187 if (ret != 0) {
1188 return ret;
1189 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001190 p += ext_len;
1191 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001192#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001193
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001194#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1196 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1197 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1198 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1199 if (ret != 0) {
1200 return ret;
1201 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001202 p += ext_len;
1203
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001204 /* Initializes the status to `rejected`. It will be updated to
1205 * `accepted` if the EncryptedExtension message contain an early data
1206 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001207 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001208 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 } else {
1210 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001211 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001212 }
1213#endif /* MBEDTLS_SSL_EARLY_DATA */
1214
Ronald Cron41a443a2022-10-04 16:38:25 +02001215#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001216 /* For PSK-based key exchange we need the pre_shared_key extension
1217 * and the psk_key_exchange_modes extension.
1218 *
1219 * The pre_shared_key extension MUST be the last extension in the
1220 * ClientHello. Servers MUST check that it is the last extension and
1221 * otherwise fail the handshake with an "illegal_parameter" alert.
1222 *
1223 * Add the psk_key_exchange_modes extension.
1224 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1226 if (ret != 0) {
1227 return ret;
1228 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001229 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001230#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001231
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001232 *out_len = p - buf;
1233
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001235}
1236
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00001237int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl)
Xiaokang Qian126929f2023-01-03 10:29:41 +00001238{
Xiaokang Qian90746132023-01-06 05:54:59 +00001239 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001240
Xiaokang Qian126929f2023-01-03 10:29:41 +00001241#if defined(MBEDTLS_SSL_EARLY_DATA)
1242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1243 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1244 const unsigned char *psk;
1245 size_t psk_len;
1246 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001247
Xiaokang Qian126929f2023-01-03 10:29:41 +00001248 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
Xiaokang Qian6be82902023-02-03 06:04:43 +00001249#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1250 mbedtls_ssl_handshake_set_state(
1251 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1252#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00001253 MBEDTLS_SSL_DEBUG_MSG(
1254 1, ("Set hs psk for early data when writing the first psk"));
1255
1256 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1257 if (ret != 0) {
1258 MBEDTLS_SSL_DEBUG_RET(
1259 1, "ssl_tls13_ticket_get_psk", ret);
1260 return ret;
1261 }
1262
1263 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1264 if (ret != 0) {
1265 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1266 return ret;
1267 }
1268
Xiaokang Qian64bc9bc2023-02-07 02:32:23 +00001269 /*
1270 * Early data are going to be encrypted using the ciphersuite
1271 * associated with the pre-shared key used for the handshake.
1272 * Note that if the server rejects early data, the handshake
1273 * based on the pre-shared key may complete successfully
1274 * with a selected ciphersuite different from the ciphersuite
1275 * associated with the pre-shared key. Only the hashes of the
1276 * two ciphersuites have to be the same. In that case, the
1277 * encrypted handshake data and application data are
1278 * encrypted using a different ciphersuite than the one used for
1279 * the rejected early data.
1280 */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001281 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1282 ssl->session_negotiate->ciphersuite);
1283 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001284
Tom Cosgrove5c8505f2023-03-07 11:39:52 +00001285 /* Enable psk and psk_ephemeral to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001286 ssl->handshake->key_exchange_mode =
1287 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1288
1289 /* Start the TLS 1.3 key schedule:
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001290 * Set the PSK and derive early secret.
Xiaokang Qian126929f2023-01-03 10:29:41 +00001291 */
1292 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1293 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001294 MBEDTLS_SSL_DEBUG_RET(
1295 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001296 return ret;
1297 }
1298
1299 /* Derive early data key material */
1300 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1301 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001302 MBEDTLS_SSL_DEBUG_RET(
1303 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001304 return ret;
1305 }
1306
Xiaokang Qian126929f2023-01-03 10:29:41 +00001307 }
1308#endif /* MBEDTLS_SSL_EARLY_DATA */
1309 return 0;
1310}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001311/*
Jerry Yu4a173382021-10-11 21:45:31 +08001312 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001313 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001314
Ronald Cronda41b382022-03-30 09:57:11 +02001315/**
1316 * \brief Detect if the ServerHello contains a supported_versions extension
1317 * or not.
1318 *
1319 * \param[in] ssl SSL context
1320 * \param[in] buf Buffer containing the ServerHello message
1321 * \param[in] end End of the buffer containing the ServerHello message
1322 *
1323 * \return 0 if the ServerHello does not contain a supported_versions extension
1324 * \return 1 if the ServerHello contains a supported_versions extension
1325 * \return A negative value if an error occurred while parsing the ServerHello.
1326 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001327MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001328static int ssl_tls13_is_supported_versions_ext_present(
1329 mbedtls_ssl_context *ssl,
1330 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001332{
1333 const unsigned char *p = buf;
1334 size_t legacy_session_id_echo_len;
Ronald Croneff56732023-04-03 17:36:31 +02001335 const unsigned char *supported_versions_data;
1336 const unsigned char *supported_versions_data_end;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001337
1338 /*
1339 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001340 * length:
1341 * - legacy_version 2 bytes
1342 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1343 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001346 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1347 legacy_session_id_echo_len = *p;
1348
1349 /*
1350 * Jump to the extensions, jumping over:
1351 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1352 * - cipher_suite 2 bytes
1353 * - legacy_compression_method 1 byte
1354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1356 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001357
Ronald Cron47dce632023-02-08 17:38:29 +01001358 return mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1359 ssl, p, end,
Ronald Croneff56732023-04-03 17:36:31 +02001360 &supported_versions_data, &supported_versions_data_end);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001361}
1362
Jerry Yu7a186a02021-10-15 18:46:14 +08001363/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001364 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1365 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1366 * - 0 otherwise
1367 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001368MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001369static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1370 const unsigned char *buf,
1371 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001372{
1373 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1374 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001375 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001376 const unsigned char *last_eight_bytes_of_random;
1377 unsigned char last_byte_of_random;
1378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001380 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1381
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 if (memcmp(last_eight_bytes_of_random,
1383 magic_downgrade_string,
1384 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001385 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 return last_byte_of_random == 0 ||
1387 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001388 }
1389
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001391}
1392
1393/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001394 * - SSL_SERVER_HELLO or
1395 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001396 * to indicate which message is expected and to be parsed next.
1397 */
Ronald Cron828aff62022-05-31 12:04:31 +02001398#define SSL_SERVER_HELLO 0
1399#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001400MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001401static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1402 const unsigned char *buf,
1403 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001404{
Jerry Yue1b9c292021-09-10 10:08:31 +08001405
1406 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1407 *
Jerry Yu4a173382021-10-11 21:45:31 +08001408 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001409 * special value of the SHA-256 of "HelloRetryRequest".
1410 *
1411 * struct {
1412 * ProtocolVersion legacy_version = 0x0303;
1413 * Random random;
1414 * opaque legacy_session_id_echo<0..32>;
1415 * CipherSuite cipher_suite;
1416 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001417 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001418 * } ServerHello;
1419 *
1420 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001421 MBEDTLS_SSL_CHK_BUF_READ_PTR(
1422 buf, end, 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1425 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1426 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001427 }
1428
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001430}
1431
Ronald Cron828aff62022-05-31 12:04:31 +02001432/*
Jerry Yu745bb612021-10-13 22:01:04 +08001433 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001434 * - SSL_SERVER_HELLO or
1435 * - SSL_SERVER_HELLO_HRR or
1436 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001437 */
Ronald Cron828aff62022-05-31 12:04:31 +02001438#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001439MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001440static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1441 const unsigned char *buf,
1442 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001443{
Jerry Yu4a173382021-10-11 21:45:31 +08001444 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001445 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001446
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1448 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001449
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001451 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001452 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001453
1454 /* If the server is negotiating TLS 1.2 or below and:
1455 * . we did not propose TLS 1.2 or
1456 * . the server responded it is TLS 1.3 capable but negotiating a lower
1457 * version of the protocol and thus we are under downgrade attack
1458 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1461 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1462 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1463 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001464 }
1465
Ronald Cronb828c7d2023-04-03 16:37:22 +02001466 /*
1467 * Version 1.2 of the protocol has been negotiated, set the
1468 * ssl->keep_current_message flag for the ServerHello to be kept and
1469 * parsed as a TLS 1.2 ServerHello. We also change ssl->tls_version to
1470 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1471 * will dispatch to the TLS 1.2 state machine.
1472 */
Ronald Cron9f0fba32022-02-10 16:45:15 +01001473 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001474 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001475 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1476 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1477 buf, (size_t) (end - buf)));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001478
Gilles Peskine449bd832023-01-11 14:50:10 +01001479 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1480 ret = ssl_tls13_reset_key_share(ssl);
1481 if (ret != 0) {
1482 return ret;
1483 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001484 }
1485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001487 }
1488
Jerry Yua66fece2022-07-13 14:30:29 +08001489#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1490 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1491 ssl->session_negotiate->tls_version = ssl->tls_version;
1492#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1493
Jerry Yu50e00e32022-10-31 14:45:01 +08001494 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001495
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1497 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001498 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001499 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001500 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001501 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001503 /* If a client receives a second HelloRetryRequest in the same
1504 * connection (i.e., where the ClientHello was itself in response
1505 * to a HelloRetryRequest), it MUST abort the handshake with an
1506 * "unexpected_message" alert.
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 */
1508 if (handshake->hello_retry_request_count > 0) {
1509 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001510 MBEDTLS_SSL_PEND_FATAL_ALERT(
1511 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1512 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001514 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001515 /*
1516 * Clients must abort the handshake with an "illegal_parameter"
1517 * alert if the HelloRetryRequest would not result in any change
1518 * in the ClientHello.
1519 * In a PSK only key exchange that what we expect.
1520 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1522 MBEDTLS_SSL_DEBUG_MSG(1,
1523 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001524 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1526 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1527 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001529
Ronald Cron5afb9042022-05-31 12:11:39 +02001530 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001531
Jerry Yu745bb612021-10-13 22:01:04 +08001532 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001533 }
1534
1535cleanup:
1536
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001538}
1539
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001540MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001541static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1542 const unsigned char **buf,
1543 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001544{
1545 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001546 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1549 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001550
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001552
1553 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1555 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1556 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1557 ssl->session_negotiate->id,
1558 ssl->session_negotiate->id_len);
1559 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1560 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001561
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1563 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001564
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001566 }
1567
Jerry Yu4a173382021-10-11 21:45:31 +08001568 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001569 *buf = p;
1570
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1572 ssl->session_negotiate->id_len);
1573 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001574}
1575
Jerry Yue1b9c292021-09-10 10:08:31 +08001576/* Parse ServerHello message and configure context
1577 *
1578 * struct {
1579 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1580 * Random random;
1581 * opaque legacy_session_id_echo<0..32>;
1582 * CipherSuite cipher_suite;
1583 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001584 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001585 * } ServerHello;
1586 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001587MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001588static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1589 const unsigned char *buf,
1590 const unsigned char *end,
1591 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001592{
Jerry Yub85277e2021-10-13 13:36:05 +08001593 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001594 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001595 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001596 size_t extensions_len;
1597 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001598 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001599 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001600 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001601 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001602 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001604
1605 /*
1606 * Check there is space for minimal fields
1607 *
1608 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001609 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001610 * - legacy_session_id_echo ( 1 byte ), minimum size
1611 * - cipher_suite ( 2 bytes)
1612 * - legacy_compression_method ( 1 byte )
1613 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1617 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001618
Jerry Yu4a173382021-10-11 21:45:31 +08001619 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001620 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001621 * ...
1622 * with ProtocolVersion defined as:
1623 * uint16 ProtocolVersion;
1624 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1626 MBEDTLS_SSL_VERSION_TLS1_2) {
1627 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1628 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1629 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001630 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1631 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001632 }
1633 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001634
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001635 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001636 * Random random;
1637 * ...
1638 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001639 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001640 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 if (!is_hrr) {
1642 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1643 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1644 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1645 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001646 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001647 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001648
Jerry Yu4a173382021-10-11 21:45:31 +08001649 /* ...
1650 * opaque legacy_session_id_echo<0..32>;
1651 * ...
1652 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001653 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001654 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001655 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001656 }
1657
Jerry Yu4a173382021-10-11 21:45:31 +08001658 /* ...
1659 * CipherSuite cipher_suite;
1660 * ...
1661 * with CipherSuite defined as:
1662 * uint8 CipherSuite[2];
1663 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1665 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001666 p += 2;
1667
Jerry Yu4a173382021-10-11 21:45:31 +08001668
Gilles Peskine449bd832023-01-11 14:50:10 +01001669 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001670 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001671 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001672 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1674 ssl->tls_version,
1675 ssl->tls_version) != 0) ||
1676 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001677 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001678 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001679 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001680 * If we received an HRR before and that the proposed selected
1681 * ciphersuite in this server hello is not the same as the one
1682 * proposed in the HRR, we abort the handshake and send an
1683 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001684 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001685 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1686 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001687 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001688 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001689
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1691 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1692 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001693 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001694 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001695
Jerry Yu4a173382021-10-11 21:45:31 +08001696 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001698
XiaokangQian355e09a2022-01-20 11:14:50 +00001699 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1701 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001702
1703#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001704 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001705#endif /* MBEDTLS_HAVE_TIME */
1706
Jerry Yu4a173382021-10-11 21:45:31 +08001707 /* ...
1708 * uint8 legacy_compression_method = 0;
1709 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001710 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1712 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1713 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001714 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001715 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001716 }
1717 p++;
1718
Jerry Yub85277e2021-10-13 13:36:05 +08001719 /* ...
1720 * Extension extensions<6..2^16-1>;
1721 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001722 * struct {
1723 * ExtensionType extension_type; (2 bytes)
1724 * opaque extension_data<0..2^16-1>;
1725 * } Extension;
1726 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1728 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001729 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001730
Jerry Yu4a173382021-10-11 21:45:31 +08001731 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001733 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001734
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001736
Jerry Yu50e00e32022-10-31 14:45:01 +08001737 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001738 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1740 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001741
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001743 unsigned int extension_type;
1744 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001745 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001746
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1748 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1749 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001750 p += 4;
1751
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001753 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001754
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001755 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1757 if (ret != 0) {
1758 return ret;
1759 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001762 case MBEDTLS_TLS_EXT_COOKIE:
1763
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 ret = ssl_tls13_parse_cookie_ext(ssl,
1765 p, extension_data_end);
1766 if (ret != 0) {
1767 MBEDTLS_SSL_DEBUG_RET(1,
1768 "ssl_tls13_parse_cookie_ext",
1769 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001770 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001771 }
XiaokangQianb851da82022-01-14 04:03:11 +00001772 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001773
Jerry Yue1b9c292021-09-10 10:08:31 +08001774 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1776 p,
1777 extension_data_end);
1778 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001779 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001781 break;
1782
Ronald Cron41a443a2022-10-04 16:38:25 +02001783#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001784 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001786
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1788 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001789 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1791 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001792 }
1793 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001794#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001795
Jerry Yue1b9c292021-09-10 10:08:31 +08001796 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1798 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001799 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001800 goto cleanup;
1801 }
1802
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 if (is_hrr) {
1804 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1805 p, extension_data_end);
1806 } else {
1807 ret = ssl_tls13_parse_key_share_ext(ssl,
1808 p, extension_data_end);
1809 }
1810 if (ret != 0) {
1811 MBEDTLS_SSL_DEBUG_RET(1,
1812 "ssl_tls13_parse_key_share_ext",
1813 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001814 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001815 }
1816 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001817
1818 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001819 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1820 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001821 }
1822
1823 p += extension_data_len;
1824 }
1825
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001827
XiaokangQiand59be772022-01-24 10:12:51 +00001828cleanup:
1829
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1831 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1832 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001833 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1835 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1836 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001837 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1838 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001840}
1841
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001842#if defined(MBEDTLS_DEBUG_C)
1843static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001844{
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001846 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1847 return "psk";
1848 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1849 return "ephemeral";
1850 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1851 return "psk_ephemeral";
1852 default:
1853 return "unknown mode";
1854 }
1855}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001856#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001857
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001858MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001859static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001860{
Jerry Yub85277e2021-10-13 13:36:05 +08001861 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001862 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001863
Jerry Yub85277e2021-10-13 13:36:05 +08001864 /* Determine the key exchange mode:
1865 * 1) If both the pre_shared_key and key_share extensions were received
1866 * then the key exchange mode is PSK with EPHEMERAL.
1867 * 2) If only the pre_shared_key extension was received then the key
1868 * exchange mode is PSK-only.
1869 * 3) If only the key_share extension was received then the key
1870 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001871 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 switch (handshake->received_extensions &
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001873 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1874 MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001875 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001877 handshake->key_exchange_mode =
1878 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001879 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001880
Jerry Yu745bb612021-10-13 22:01:04 +08001881 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001883 handshake->key_exchange_mode =
1884 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001885 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001886
Jerry Yu745bb612021-10-13 22:01:04 +08001887 /* Both the pre_shared_key and key_share extensions were received */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001888 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1889 MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
1890 handshake->key_exchange_mode =
1891 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001892 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001893
Jerry Yu745bb612021-10-13 22:01:04 +08001894 /* Neither pre_shared_key nor key_share extension was received */
1895 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001897 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1898 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001899 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001900#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001901 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1902 (handshake->selected_identity != 0 ||
1903 handshake->ciphersuite_info->id !=
1904 ssl->session_negotiate->ciphersuite)) {
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001905 /* RFC8446 4.2.11
1906 * If the server supplies an "early_data" extension, the
1907 * client MUST verify that the server's selected_identity
1908 * is 0. If any other value is returned, the client MUST
1909 * abort the handshake with an "illegal_parameter" alert.
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001910 *
Xiaokang Qian53c4c272023-02-07 02:42:01 +00001911 * RFC 8446 4.2.10
1912 * In order to accept early data, the server MUST have accepted a PSK
1913 * cipher suite and selected the first key offered in the client's
1914 * "pre_shared_key" extension. In addition, it MUST verify that the
1915 * following values are the same as those associated with the
1916 * selected PSK:
1917 * - The TLS version number
1918 * - The selected cipher suite
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001919 * - The selected ALPN [RFC7301] protocol, if any
1920 *
1921 * We check here that when early data is involved the server
1922 * selected the cipher suite associated to the pre-shared key
1923 * as it must have.
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001924 */
1925 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1926 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1927 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1928 }
1929#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001930
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001931 if (!mbedtls_ssl_conf_tls13_check_kex_modes(
1932 ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001933 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001934 MBEDTLS_SSL_DEBUG_MSG(
1935 2, ("Key exchange mode(%s) is not supported.",
1936 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001937 goto cleanup;
1938 }
1939
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001940 MBEDTLS_SSL_DEBUG_MSG(
1941 3, ("Selected key exchange mode: %s",
1942 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001943
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001944 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001945 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001946 * If we proposed early data then we have already derived an
1947 * early secret using the selected PSK and its associated hash.
1948 * It means that if the negotiated key exchange mode is psk or
1949 * psk_ephemeral, we have already correctly computed the
1950 * early secret and thus we do not do it again. In all other
1951 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001952 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001953#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001954 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1955 handshake->key_exchange_mode ==
1956 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001957#endif
1958 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001959 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1960 if (ret != 0) {
1961 MBEDTLS_SSL_DEBUG_RET(
1962 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1963 goto cleanup;
1964 }
Jerry Yu0b177842021-09-05 19:41:30 +08001965 }
1966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1968 if (ret != 0) {
1969 MBEDTLS_SSL_DEBUG_RET(1,
1970 "mbedtls_ssl_tls13_compute_handshake_transform",
1971 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001972 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001973 }
1974
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1976 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001977 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
Jerry Yu0b177842021-09-05 19:41:30 +08001978 ssl->session_in = ssl->session_negotiate;
1979
Jerry Yu4a173382021-10-11 21:45:31 +08001980cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001982 MBEDTLS_SSL_PEND_FATAL_ALERT(
1983 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001985 }
Jerry Yue110d252022-05-05 10:19:22 +08001986
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001988}
1989
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001990MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001991static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00001992{
1993 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00001996
XiaokangQian78b1fa72022-01-19 06:56:30 +00001997 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001998 * We are going to re-generate a shared secret corresponding to the group
1999 * selected by the server, which is different from the group for which we
2000 * generated a shared secret in the first client hello.
2001 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00002002 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 ret = ssl_tls13_reset_key_share(ssl);
2004 if (ret != 0) {
2005 return ret;
2006 }
XiaokangQian647719a2021-12-07 09:16:29 +00002007
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00002008 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002010}
2011
Jerry Yue1b9c292021-09-10 10:08:31 +08002012/*
Jerry Yu4a173382021-10-11 21:45:31 +08002013 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002014 * Handler for MBEDTLS_SSL_SERVER_HELLO
2015 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002016MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002017static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002018{
Jerry Yu4a173382021-10-11 21:45:31 +08002019 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002020 unsigned char *buf = NULL;
2021 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002022 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002023
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002025
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002026 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2027 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002028
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2030 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002031 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 } else {
2033 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2034 }
XiaokangQiand59be772022-01-24 10:12:51 +00002035
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002037 ret = 0;
2038 goto cleanup;
2039 }
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2042 buf + buf_len,
2043 is_hrr));
2044 if (is_hrr) {
2045 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002046 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002047
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002048 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2049 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002050
2051 if (is_hrr) {
2052 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2053#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2054 /* If not offering early data, the client sends a dummy CCS record
2055 * immediately before its second flight. This may either be before
2056 * its second ClientHello or before its encrypted handshake flight.
2057 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002058 mbedtls_ssl_handshake_set_state(
2059 ssl, MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
Gilles Peskine449bd832023-01-11 14:50:10 +01002060#else
2061 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2062#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2063 } else {
2064 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2065 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002066 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002067
2068cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2070 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2071 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002072}
2073
2074/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002075 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002076 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002077 *
2078 * The EncryptedExtensions message contains any extensions which
2079 * should be protected, i.e., any which are not needed to establish
2080 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002081 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002082
XiaokangQian08da26c2021-10-09 10:12:11 +00002083/* Parse EncryptedExtensions message
2084 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002085 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002086 * } EncryptedExtensions;
2087 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002088MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002089static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2090 const unsigned char *buf,
2091 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002092{
2093 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002094 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002095 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002096 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002097 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2100 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002101 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002104 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002105
Jan Bruckner5a3629b2023-02-23 12:08:09 +01002106 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2107
Jerry Yu9eba7502022-10-31 13:46:16 +08002108 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002111 unsigned int extension_type;
2112 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002113
XiaokangQian08da26c2021-10-09 10:12:11 +00002114 /*
2115 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002116 * ExtensionType extension_type; (2 bytes)
2117 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002118 * } Extension;
2119 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2121 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2122 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002123 p += 4;
2124
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002126
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002127 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2129 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2130 if (ret != 0) {
2131 return ret;
2132 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002135#if defined(MBEDTLS_SSL_ALPN)
2136 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002138
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002139 if ((ret = ssl_tls13_parse_alpn_ext(
2140 ssl, p, (size_t) extension_data_len)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002142 }
2143
2144 break;
2145#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002146
2147#if defined(MBEDTLS_SSL_EARLY_DATA)
2148 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002149
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002151 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2153 MBEDTLS_ERR_SSL_DECODE_ERROR);
2154 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002155 }
2156
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002157 break;
2158#endif /* MBEDTLS_SSL_EARLY_DATA */
2159
Jan Bruckner151f6422023-02-10 12:45:19 +01002160#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2161 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
2162 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
2163
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002164 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
2165 ssl, p, p + extension_data_len);
Jan Bruckner151f6422023-02-10 12:45:19 +01002166
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002167 /* TODO: Return unconditionally here until we handle the record
2168 * size limit correctly. Once handled correctly, only return in
2169 * case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01002170 return ret;
2171
2172 break;
2173#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2174
XiaokangQian08da26c2021-10-09 10:12:11 +00002175 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002176 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002177 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002179 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002180 }
2181
XiaokangQian08da26c2021-10-09 10:12:11 +00002182 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002183 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002184
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2186 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002187
XiaokangQian97799ac2021-10-11 10:05:54 +00002188 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if (p != end) {
2190 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2191 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2192 MBEDTLS_ERR_SSL_DECODE_ERROR);
2193 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002194 }
2195
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002197}
2198
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002199MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002200static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002201{
2202 int ret;
2203 unsigned char *buf;
2204 size_t buf_len;
2205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002207
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002208 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2209 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2210 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002211
2212 /* Process the message contents */
2213 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002215
Xiaokang Qianb157e912022-11-23 08:12:26 +00002216#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (ssl->handshake->received_extensions &
2218 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002219 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2220 }
2221#endif
2222
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002223 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2224 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2225 buf, buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002226
Ronald Cron928cbd32022-10-04 16:14:26 +02002227#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2229 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2230 } else {
2231 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2232 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002233#else
2234 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002236#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002237
2238cleanup:
2239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2241 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002242
2243}
2244
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002245/*
2246 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2247 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002248 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002249 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002250 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002251 *
2252 * If the server sent an "early_data" extension in EncryptedExtensions, the
2253 * client MUST send an EndOfEarlyData message after receiving the server
2254 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002255 */
2256
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002257MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002258static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2259{
2260 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002261 unsigned char *buf = NULL;
2262 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002263 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002264
Xiaokang Qian742578c2022-12-19 06:34:44 +00002265 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
Xiaokang Qian0de0d862023-02-08 06:04:50 +00002266 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
2267 &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002268
Manuel Pégourié-Gonnard63e33dd2023-02-21 15:45:15 +01002269 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_hdr_to_checksum(
2270 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002271
Xiaokang Qian742578c2022-12-19 06:34:44 +00002272 MBEDTLS_SSL_PROC_CHK(
2273 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002274
Xiaokang Qian19d44162023-01-03 03:39:50 +00002275 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002276
2277cleanup:
2278
2279 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2280 return ret;
2281}
2282
Ronald Cron928cbd32022-10-04 16:14:26 +02002283#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002284/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002285 * STATE HANDLING: CertificateRequest
2286 *
Jerry Yud2674312021-10-29 10:08:19 +08002287 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002288#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2289#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002290/* Coordination:
2291 * Deals with the ambiguity of not knowing if a CertificateRequest
2292 * will be sent. Returns a negative code on failure, or
2293 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2294 * - SSL_CERTIFICATE_REQUEST_SKIP
2295 * indicating if a Certificate Request is expected or not.
2296 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002297MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002298static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002299{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002300 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2303 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2304 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002305 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002306 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2309 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2310 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2311 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002312 }
2313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002317}
2318
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002319/*
2320 * ssl_tls13_parse_certificate_request()
2321 * Parse certificate request
2322 * struct {
2323 * opaque certificate_request_context<0..2^8-1>;
2324 * Extension extensions<2..2^16-1>;
2325 * } CertificateRequest;
2326 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002327MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002328static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2329 const unsigned char *buf,
2330 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002331{
2332 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2333 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002334 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002335 size_t extensions_len = 0;
2336 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002337 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002338
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002339 /* ...
2340 * opaque certificate_request_context<0..2^8-1>
2341 * ...
2342 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002344 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002345 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002346
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 if (certificate_request_context_len > 0) {
2348 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2349 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2350 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002351
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002352 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 mbedtls_calloc(1, certificate_request_context_len);
2354 if (handshake->certificate_request_context == NULL) {
2355 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2356 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002357 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 memcpy(handshake->certificate_request_context, p,
2359 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002360 p += certificate_request_context_len;
2361 }
2362
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002363 /* ...
2364 * Extension extensions<2..2^16-1>;
2365 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2368 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002369 p += 2;
2370
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002372 extensions_end = p + extensions_len;
2373
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002374 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002377 unsigned int extension_type;
2378 size_t extension_data_len;
2379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2381 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2382 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002383 p += 4;
2384
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002386
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002387 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2389 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2390 if (ret != 0) {
2391 return ret;
2392 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002393
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002395 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 MBEDTLS_SSL_DEBUG_MSG(3,
2397 ("found signature algorithms extension"));
2398 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2399 p + extension_data_len);
2400 if (ret != 0) {
2401 return ret;
2402 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002403
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002404 break;
2405
2406 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002407 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002408 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002410 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002411 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002412
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002413 p += extension_data_len;
2414 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002415
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2417 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002418
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002419 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 if (p != end) {
2421 MBEDTLS_SSL_DEBUG_MSG(1,
2422 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002423 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002424 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002425
Jerry Yu0c354a22022-08-29 15:25:36 +08002426 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002427 *
2428 * The "signature_algorithms" extension MUST be specified
2429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2431 MBEDTLS_SSL_DEBUG_MSG(3,
2432 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002433 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002434 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002435
Jerry Yu7840f812022-01-29 10:26:51 +08002436 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002438
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002439decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2441 MBEDTLS_ERR_SSL_DECODE_ERROR);
2442 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002443}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002444
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002445/*
2446 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2447 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002448MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002449static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002450{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002451 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002456
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002458 unsigned char *buf;
2459 size_t buf_len;
2460
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002461 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2462 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2463 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002464
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002465 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(
2466 ssl, buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002467
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002468 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2469 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2470 buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002472 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 } else {
2474 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002475 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2476 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002477 }
2478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002480
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002481cleanup:
2482
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2484 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002485}
2486
2487/*
Jerry Yu687101b2021-09-14 16:03:56 +08002488 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2489 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002490MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002491static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002492{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002493 int ret;
2494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2496 if (ret != 0) {
2497 return ret;
2498 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002499
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2501 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002502}
2503
2504/*
2505 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2506 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002507MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002508static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002509{
Jerry Yu30b071c2021-09-12 20:16:03 +08002510 int ret;
2511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2513 if (ret != 0) {
2514 return ret;
2515 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002516
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2518 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002519}
Ronald Cron928cbd32022-10-04 16:14:26 +02002520#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002521
Jerry Yu687101b2021-09-14 16:03:56 +08002522/*
2523 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2524 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002525MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002526static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002527{
XiaokangQianac0385c2021-11-03 06:40:11 +00002528 int ret;
2529
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2531 if (ret != 0) {
2532 return ret;
2533 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2536 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002537 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2539 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2540 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002541 }
2542
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002543#if defined(MBEDTLS_SSL_EARLY_DATA)
2544 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2545 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002546 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2547 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002548 } else
2549#endif /* MBEDTLS_SSL_EARLY_DATA */
2550 {
2551#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2552 mbedtls_ssl_handshake_set_state(
2553 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2554#else
2555 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2556#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2557 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002558
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002560}
2561
2562/*
Jerry Yu566c7812022-01-26 15:41:22 +08002563 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2564 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002565MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002566static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002567{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002568 int non_empty_certificate_msg = 0;
2569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 MBEDTLS_SSL_DEBUG_MSG(1,
2571 ("Switch to handshake traffic keys for outbound traffic"));
2572 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002573
Ronald Cron928cbd32022-10-04 16:14:26 +02002574#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 if (ssl->handshake->client_auth) {
2576 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2577 if (ret != 0) {
2578 return ret;
2579 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002582 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 }
2584 } else {
2585 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002586 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002587#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (non_empty_certificate_msg) {
2590 mbedtls_ssl_handshake_set_state(ssl,
2591 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2592 } else {
2593 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2594 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2595 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002598}
2599
Ronald Cron928cbd32022-10-04 16:14:26 +02002600#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002601/*
2602 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2603 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002604MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002605static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002606{
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (ret == 0) {
2610 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2611 }
Ronald Crona8b38872022-03-09 07:59:25 +01002612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002614}
Ronald Cron928cbd32022-10-04 16:14:26 +02002615#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002616
2617/*
Jerry Yu687101b2021-09-14 16:03:56 +08002618 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2619 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002620MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002621static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002622{
XiaokangQian0fa66432021-11-15 03:33:57 +00002623 int ret;
2624
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2626 if (ret != 0) {
2627 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002628 }
2629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2631 if (ret != 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002632 MBEDTLS_SSL_DEBUG_RET(
2633 1, "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 return ret;
2635 }
2636
2637 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2638 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002639}
2640
2641/*
2642 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2643 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002644MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002645static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002646{
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2648 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2649 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002650}
2651
2652/*
2653 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2654 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002655MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002656static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002657{
Jerry Yu378254d2021-10-30 21:44:47 +08002658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2662 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002663}
2664
Jerry Yuf8a49942022-07-07 11:32:32 +00002665#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2666
Jerry Yua0446a02022-07-13 11:22:55 +08002667MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002668static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2669 const unsigned char *buf,
2670 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002671{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002672 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002673 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002674
Jerry Yuf8a49942022-07-07 11:32:32 +00002675
Jerry Yuedab6372022-10-31 14:37:31 +08002676 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002679 unsigned int extension_type;
2680 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002681 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2684 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2685 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002686 p += 4;
2687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002689
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002690 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2692 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2693 if (ret != 0) {
2694 return ret;
2695 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002698#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002699 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002701 MBEDTLS_SSL_PEND_FATAL_ALERT(
2702 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 MBEDTLS_ERR_SSL_DECODE_ERROR);
2704 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002705 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002707 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002709 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002710 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002711#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002712
Jerry Yuf8a49942022-07-07 11:32:32 +00002713 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002714 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002715 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002717 break;
2718 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002719
Jerry Yuf8a49942022-07-07 11:32:32 +00002720 p += extension_data_len;
2721 }
2722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2724 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002727}
2728
2729/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002730 * From RFC8446, page 74
2731 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002732 * struct {
2733 * uint32 ticket_lifetime;
2734 * uint32 ticket_age_add;
2735 * opaque ticket_nonce<0..255>;
2736 * opaque ticket<1..2^16-1>;
2737 * Extension extensions<0..2^16-2>;
2738 * } NewSessionTicket;
2739 *
2740 */
Jerry Yua0446a02022-07-13 11:22:55 +08002741MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002742static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2743 unsigned char *buf,
2744 unsigned char *end,
2745 unsigned char **ticket_nonce,
2746 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002747{
2748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2749 unsigned char *p = buf;
2750 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002751 size_t ticket_len;
2752 unsigned char *ticket;
2753 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002754
Jerry Yucb3b1392022-07-12 06:09:38 +00002755 *ticket_nonce = NULL;
2756 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002757 /*
2758 * ticket_lifetime 4 bytes
2759 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002760 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002761 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2765 MBEDTLS_SSL_DEBUG_MSG(3,
2766 ("ticket_lifetime: %u",
2767 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002768
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2770 MBEDTLS_SSL_DEBUG_MSG(3,
2771 ("ticket_age_add: %u",
2772 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002773
Jerry Yucb3b1392022-07-12 06:09:38 +00002774 *ticket_nonce_len = p[8];
2775 p += 9;
2776
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002778 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002780 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002781
2782 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2784 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002785 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2787 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002788
2789 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (session->ticket != NULL || session->ticket_len > 0) {
2791 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002792 session->ticket = NULL;
2793 session->ticket_len = 0;
2794 }
2795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2797 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2798 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002799 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002801 p += ticket_len;
2802 session->ticket = ticket;
2803 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002804
Pengyu Lv9f926952022-11-17 15:22:33 +08002805 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002806 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002807 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002808
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2810 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002811 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002813
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002815
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2817 if (ret != 0) {
2818 MBEDTLS_SSL_DEBUG_RET(1,
2819 "ssl_tls13_parse_new_session_ticket_exts",
2820 ret);
2821 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002822 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002823
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002824 /* session has been updated, allow export */
2825 session->exported = 0;
2826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002828}
2829
Jerry Yua0446a02022-07-13 11:22:55 +08002830MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002831static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2832 unsigned char *ticket_nonce,
2833 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002834{
2835 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2836 mbedtls_ssl_session *session = ssl->session;
2837 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2838 psa_algorithm_t psa_hash_alg;
2839 int hash_length;
2840
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002841#if defined(MBEDTLS_HAVE_TIME)
2842 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002844#endif
2845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2847 if (ciphersuite_info == NULL) {
2848 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2849 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002850 }
2851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2853 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2854 if (hash_length == -1 ||
2855 (size_t) hash_length > sizeof(session->resumption_key)) {
2856 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002857 }
2858
Jerry Yuf8a49942022-07-07 11:32:32 +00002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2861 session->app_secrets.resumption_master_secret,
2862 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002863
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002864 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002865 *
2866 * HKDF-Expand-Label( resumption_master_secret,
2867 * "resumption", ticket_nonce, Hash.length )
2868 */
2869 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 psa_hash_alg,
2871 session->app_secrets.resumption_master_secret,
2872 hash_length,
2873 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2874 ticket_nonce,
2875 ticket_nonce_len,
2876 session->resumption_key,
2877 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 if (ret != 0) {
2880 MBEDTLS_SSL_DEBUG_RET(2,
2881 "Creating the ticket-resumed PSK failed",
2882 ret);
2883 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002884 }
2885
Jerry Yu0a430c82022-07-20 11:02:48 +08002886 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2889 session->resumption_key,
2890 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002891
Pengyu Lv9f926952022-11-17 15:22:33 +08002892 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002893 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002894 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002895 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002898}
2899
2900/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002901 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002902 */
Jerry Yua0446a02022-07-13 11:22:55 +08002903MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002904static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002905{
2906 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2907 unsigned char *buf;
2908 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002909 unsigned char *ticket_nonce;
2910 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002913
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2915 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2916 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2919 ssl, buf, buf + buf_len,
2920 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2923 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002926
Jerry Yuf8a49942022-07-07 11:32:32 +00002927cleanup:
2928
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2930 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002931}
2932#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002935{
Jerry Yu92c6b402021-08-27 16:59:09 +08002936 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002939 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002941 break;
2942
Jerry Yu92c6b402021-08-27 16:59:09 +08002943 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002945 break;
2946
2947 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002949 break;
2950
2951 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002953 break;
2954
Ronald Cron928cbd32022-10-04 16:14:26 +02002955#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002956 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002958 break;
2959
Jerry Yu687101b2021-09-14 16:03:56 +08002960 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002962 break;
2963
2964 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002966 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002967#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002968
2969 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002971 break;
2972
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002973 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2974 ret = ssl_tls13_write_end_of_early_data(ssl);
2975 break;
2976
Jerry Yu566c7812022-01-26 15:41:22 +08002977 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002979 break;
2980
Ronald Cron928cbd32022-10-04 16:14:26 +02002981#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002982 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002984 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002985#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002986
Jerry Yu687101b2021-09-14 16:03:56 +08002987 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002989 break;
2990
2991 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002993 break;
2994
2995 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002997 break;
2998
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 /*
3000 * Injection of dummy-CCS's for middlebox compatibility
3001 */
Ronald Cron49ad6192021-11-24 16:25:31 +01003002#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00003003 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3005 if (ret == 0) {
3006 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3007 }
Ronald Cron9f55f632022-02-02 16:02:47 +01003008 break;
3009
3010 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3012 if (ret == 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00003013 mbedtls_ssl_handshake_set_state(
3014 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 }
Ronald Cron49ad6192021-11-24 16:25:31 +01003016 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003017
Xiaokang Qian592021a2023-01-04 10:47:05 +00003018 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3019 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3020 if (ret == 0) {
3021 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3022
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003023#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003024 MBEDTLS_SSL_DEBUG_MSG(
3025 1, ("Switch to early data keys for outbound traffic"));
3026 mbedtls_ssl_set_outbound_transform(
3027 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003028#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003029 }
3030 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003031#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3032
Jerry Yuf8a49942022-07-07 11:32:32 +00003033#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003034 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 ret = ssl_tls13_process_new_session_ticket(ssl);
3036 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003037 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003039 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3040 break;
3041#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3042
Jerry Yu92c6b402021-08-27 16:59:09 +08003043 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003046 }
3047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003049}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003050
Jerry Yufb4b6472022-01-27 15:03:26 +08003051#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */