blob: 98926609d938332ff612c6a868f2a36873e438d5 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
2 * TLS 1.3 client-side functions
3 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS ( https://tls.mbed.org )
20 */
21
22#include "common.h"
23
Jerry Yucc43c6b2022-01-28 10:24:45 +080024#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080025
Jerry Yubc20bdd2021-08-24 15:59:48 +080026#include <string.h>
27
Jerry Yu56fc07f2021-09-01 17:48:49 +080028#include "mbedtls/debug.h"
29#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080030#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080031
Jerry Yubdc71882021-09-14 19:30:36 +080032#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010033#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080034#include "ssl_tls13_keys.h"
Jerry Yucbd082f2022-08-04 16:55:10 +080035#include "ssl_debug_helpers.h"
Jerry Yubdc71882021-09-14 19:30:36 +080036
Jerry Yubc20bdd2021-08-24 15:59:48 +080037/* Write extensions */
38
Jerry Yu92c6b402021-08-27 16:59:09 +080039/*
40 * ssl_tls13_write_supported_versions_ext():
41 *
42 * struct {
43 * ProtocolVersion versions<2..254>;
44 * } SupportedVersions;
45 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020046MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010047static int ssl_tls13_write_supported_versions_ext(mbedtls_ssl_context *ssl,
48 unsigned char *buf,
49 unsigned char *end,
50 size_t *out_len)
Jerry Yu92c6b402021-08-27 16:59:09 +080051{
52 unsigned char *p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +010053 unsigned char versions_len = (ssl->handshake->min_tls_version <=
54 MBEDTLS_SSL_VERSION_TLS1_2) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080055
Xiaofei Baid25fab62021-12-02 06:36:27 +000056 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080057
Gilles Peskine449bd832023-01-11 14:50:10 +010058 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding supported versions extension"));
Jerry Yu92c6b402021-08-27 16:59:09 +080059
Jerry Yu388bd0d2021-09-15 18:41:02 +080060 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080061 * - extension_type (2 bytes)
62 * - extension_data_length (2 bytes)
63 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020064 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080065 */
Gilles Peskine449bd832023-01-11 14:50:10 +010066 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 5 + versions_len);
Ronald Crondbe87f02022-02-10 14:35:27 +010067
Gilles Peskine449bd832023-01-11 14:50:10 +010068 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0);
69 MBEDTLS_PUT_UINT16_BE(versions_len + 1, p, 2);
Jerry Yueecfbf02021-08-30 18:32:07 +080070 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080071
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080072 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010073 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080074
Jerry Yu0c63af62021-09-02 12:59:12 +080075 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080076 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010077 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080078 */
Gilles Peskine449bd832023-01-11 14:50:10 +010079 mbedtls_ssl_write_version(p, MBEDTLS_SSL_TRANSPORT_STREAM,
80 MBEDTLS_SSL_VERSION_TLS1_3);
81 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:4]"));
Jerry Yu92c6b402021-08-27 16:59:09 +080082
Jerry Yu92c6b402021-08-27 16:59:09 +080083
Gilles Peskine449bd832023-01-11 14:50:10 +010084 if (ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
85 mbedtls_ssl_write_version(p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
86 MBEDTLS_SSL_VERSION_TLS1_2);
87 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:3]"));
Ronald Crondbe87f02022-02-10 14:35:27 +010088 }
89
90 *out_len = 5 + versions_len;
Jerry Yu4b8f2f72022-10-31 13:31:22 +080091
Jerry Yuc4bf5d62022-10-29 09:08:47 +080092 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +010093 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yu4b8f2f72022-10-31 13:31:22 +080094
Gilles Peskine449bd832023-01-11 14:50:10 +010095 return 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080096}
Jerry Yubc20bdd2021-08-24 15:59:48 +080097
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020098MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010099static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
100 const unsigned char *buf,
101 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800102{
Jerry Yue1b9c292021-09-10 10:08:31 +0800103 ((void) ssl);
104
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
106 if (mbedtls_ssl_read_version(buf, ssl->conf->transport) !=
107 MBEDTLS_SSL_VERSION_TLS1_3) {
108 MBEDTLS_SSL_DEBUG_MSG(1, ("unexpected version"));
Jerry Yu4a173382021-10-11 21:45:31 +0800109
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
111 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
112 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +0800113 }
114
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 if (&buf[2] != end) {
116 MBEDTLS_SSL_DEBUG_MSG(1, ("supported_versions ext data length incorrect"));
117 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
118 MBEDTLS_ERR_SSL_DECODE_ERROR);
119 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Ronald Cron98473382022-03-30 20:04:10 +0200120 }
121
Gilles Peskine449bd832023-01-11 14:50:10 +0100122 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +0800123}
124
lhuang0486cacac2022-01-21 07:34:27 -0800125#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200126MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100127static int ssl_tls13_parse_alpn_ext(mbedtls_ssl_context *ssl,
128 const unsigned char *buf, size_t len)
lhuang0486cacac2022-01-21 07:34:27 -0800129{
lhuang0486cacac2022-01-21 07:34:27 -0800130 const unsigned char *p = buf;
131 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200132 size_t protocol_name_list_len, protocol_name_len;
133 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800134
135 /* If we didn't send it, the server shouldn't send it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 if (ssl->conf->alpn_list == NULL) {
137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
138 }
lhuang0486cacac2022-01-21 07:34:27 -0800139
140 /*
141 * opaque ProtocolName<1..2^8-1>;
142 *
143 * struct {
144 * ProtocolName protocol_name_list<2..2^16-1>
145 * } ProtocolNameList;
146 *
147 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
148 */
149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
151 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
lhuang0486cacac2022-01-21 07:34:27 -0800152 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800153
Gilles Peskine449bd832023-01-11 14:50:10 +0100154 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
Ronald Cron81a334f2022-05-31 16:04:11 +0200155 protocol_name_list_end = p + protocol_name_list_len;
156
Gilles Peskine449bd832023-01-11 14:50:10 +0100157 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, 1);
Ronald Cron81a334f2022-05-31 16:04:11 +0200158 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800159
160 /* Check that the server chosen protocol was in our list and save it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, protocol_name_len);
162 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
163 if (protocol_name_len == strlen(*alpn) &&
164 memcmp(p, *alpn, protocol_name_len) == 0) {
lhuang0486cacac2022-01-21 07:34:27 -0800165 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 return 0;
lhuang0486cacac2022-01-21 07:34:27 -0800167 }
168 }
169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
lhuang0486cacac2022-01-21 07:34:27 -0800171}
172#endif /* MBEDTLS_SSL_ALPN */
173
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200174MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100175static int ssl_tls13_reset_key_share(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +0000176{
177 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100178
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (group_id == 0) {
180 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
181 }
XiaokangQian647719a2021-12-07 09:16:29 +0000182
XiaokangQian355e09a2022-01-20 11:14:50 +0000183#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
187
188 /* Destroy generated private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 status = psa_destroy_key(ssl->handshake->ecdh_psa_privkey);
190 if (status != PSA_SUCCESS) {
191 ret = psa_ssl_status_to_mbedtls(status);
192 MBEDTLS_SSL_DEBUG_RET(1, "psa_destroy_key", ret);
193 return ret;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100194 }
195
196 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100197 return 0;
198 } else
XiaokangQian355e09a2022-01-20 11:14:50 +0000199#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 if (0 /* other KEMs? */) {
XiaokangQian647719a2021-12-07 09:16:29 +0000201 /* Do something */
202 }
203
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQian647719a2021-12-07 09:16:29 +0000205}
206
207/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800208 * Functions for writing key_share extension.
209 */
Ronald Cron766c0cd2022-10-18 12:17:11 +0200210#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200211MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100212static int ssl_tls13_get_default_group_id(mbedtls_ssl_context *ssl,
213 uint16_t *group_id)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800214{
215 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
216
Jerry Yu56fc07f2021-09-01 17:48:49 +0800217
Jerry Yu56fc07f2021-09-01 17:48:49 +0800218#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Jerry Yu388bd0d2021-09-15 18:41:02 +0800220 /* Pick first available ECDHE group compatible with TLS 1.3 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 if (group_list == NULL) {
222 return MBEDTLS_ERR_SSL_BAD_CONFIG;
223 }
Jerry Yu388bd0d2021-09-15 18:41:02 +0800224
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 for (; *group_list != 0; group_list++) {
226 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(*group_list,
227 NULL, NULL) == PSA_SUCCESS) &&
228 mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
Brett Warren14efd332021-10-06 09:32:11 +0100229 *group_id = *group_list;
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 return 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800231 }
232 }
233#else
234 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800235 ((void) group_id);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800236#endif /* MBEDTLS_ECDH_C */
237
238 /*
239 * Add DHE named groups here.
Jerry Yu388bd0d2021-09-15 18:41:02 +0800240 * Pick first available DHE group compatible with TLS 1.3
Jerry Yu56fc07f2021-09-01 17:48:49 +0800241 */
242
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800244}
245
246/*
247 * ssl_tls13_write_key_share_ext
248 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800249 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800250 *
251 * struct {
252 * NamedGroup group;
253 * opaque key_exchange<1..2^16-1>;
254 * } KeyShareEntry;
255 * struct {
256 * KeyShareEntry client_shares<0..2^16-1>;
257 * } KeyShareClientHello;
258 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200259MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100260static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
261 unsigned char *buf,
262 unsigned char *end,
263 size_t *out_len)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800264{
265 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000266 unsigned char *client_shares; /* Start of client_shares */
267 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800268 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800269 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
270
Xiaofei Baid25fab62021-12-02 06:36:27 +0000271 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800272
Jerry Yub60e3cf2021-09-08 16:41:02 +0800273 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800274 * - extension_type (2 bytes)
275 * - extension_data_length (2 bytes)
276 * - client_shares_length (2 bytes)
277 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800279 p += 6;
280
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello: adding key share extension"));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800282
283 /* HRR could already have requested something else. */
284 group_id = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 if (!mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) &&
286 !mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
287 MBEDTLS_SSL_PROC_CHK(ssl_tls13_get_default_group_id(ssl,
288 &group_id));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800289 }
290
291 /*
292 * Dispatch to type-specific key generation function.
293 *
294 * So far, we're only supporting ECDHE. With the introduction
295 * of PQC KEMs, we'll want to have multiple branches, one per
296 * type of KEM, and dispatch to the corresponding crypto. And
297 * only one key share entry is allowed.
298 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000299 client_shares = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800300#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800302 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000303 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800304 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100305 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800306
307 /* Check there is space for header of KeyShareEntry
308 * - group (2 bytes)
309 * - key_exchange_length (2 bytes)
310 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800312 p += 4;
Jerry Yu89e103c2022-03-30 22:43:29 +0800313 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 ssl, group_id, p, end, &key_exchange_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800315 p += key_exchange_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 if (ret != 0) {
317 return ret;
318 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800319
320 /* Write group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 MBEDTLS_PUT_UINT16_BE(group_id, group, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800322 /* Write key_exchange_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 MBEDTLS_PUT_UINT16_BE(key_exchange_len, group, 2);
324 } else
Jerry Yu56fc07f2021-09-01 17:48:49 +0800325#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 if (0 /* other KEMs? */) {
Jerry Yu56fc07f2021-09-01 17:48:49 +0800327 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 } else {
329 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800330 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800331
Jerry Yub60e3cf2021-09-08 16:41:02 +0800332 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000333 client_shares_len = p - client_shares;
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 if (client_shares_len == 0) {
335 MBEDTLS_SSL_DEBUG_MSG(1, ("No key share defined."));
336 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu7c522d42021-09-08 17:55:09 +0800337 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800338 /* Write extension_type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800340 /* Write extension_data_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 MBEDTLS_PUT_UINT16_BE(client_shares_len + 2, buf, 2);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800342 /* Write client_shares_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 MBEDTLS_PUT_UINT16_BE(client_shares_len, buf, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800344
345 /* Update offered_group_id field */
346 ssl->handshake->offered_group_id = group_id;
347
348 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000349 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, key_share extension", buf, *out_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800352
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800354
355cleanup:
356
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800358}
Ronald Cron766c0cd2022-10-18 12:17:11 +0200359#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +0800360
XiaokangQiand59be772022-01-24 10:12:51 +0000361/*
362 * ssl_tls13_parse_hrr_key_share_ext()
363 * Parse key_share extension in Hello Retry Request
364 *
365 * struct {
366 * NamedGroup selected_group;
367 * } KeyShareHelloRetryRequest;
368 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200369MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100370static int ssl_tls13_parse_hrr_key_share_ext(mbedtls_ssl_context *ssl,
371 const unsigned char *buf,
372 const unsigned char *end)
XiaokangQianb851da82022-01-14 04:03:11 +0000373{
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400374#if defined(MBEDTLS_ECDH_C)
XiaokangQianb851da82022-01-14 04:03:11 +0000375 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000376 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000377 int found = 0;
378
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
380 if (group_list == NULL) {
381 return MBEDTLS_ERR_SSL_BAD_CONFIG;
382 }
XiaokangQianb851da82022-01-14 04:03:11 +0000383
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 MBEDTLS_SSL_DEBUG_BUF(3, "key_share extension", p, end - buf);
XiaokangQianb851da82022-01-14 04:03:11 +0000385
386 /* Read selected_group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
388 selected_group = MBEDTLS_GET_UINT16_BE(p, 0);
389 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_group ( %d )", selected_group));
XiaokangQianb851da82022-01-14 04:03:11 +0000390
391 /* Upon receipt of this extension in a HelloRetryRequest, the client
392 * MUST first verify that the selected_group field corresponds to a
393 * group which was provided in the "supported_groups" extension in the
394 * original ClientHello.
395 * The supported_group was based on the info in ssl->conf->group_list.
396 *
397 * If the server provided a key share that was not sent in the ClientHello
398 * then the client MUST abort the handshake with an "illegal_parameter" alert.
399 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 for (; *group_list != 0; group_list++) {
401 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(*group_list,
402 NULL, NULL) == PSA_ERROR_NOT_SUPPORTED) ||
403 *group_list != selected_group) {
XiaokangQianb851da82022-01-14 04:03:11 +0000404 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 }
XiaokangQianb851da82022-01-14 04:03:11 +0000406
407 /* We found a match */
408 found = 1;
409 break;
410 }
411
412 /* Client MUST verify that the selected_group field does not
413 * correspond to a group which was provided in the "key_share"
414 * extension in the original ClientHello. If the server sent an
415 * HRR message with a key share already provided in the
416 * ClientHello then the client MUST abort the handshake with
417 * an "illegal_parameter" alert.
418 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 if (found == 0 || selected_group == ssl->handshake->offered_group_id) {
420 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid key share in HRR"));
XiaokangQianb851da82022-01-14 04:03:11 +0000421 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
423 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
424 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQianb851da82022-01-14 04:03:11 +0000425 }
426
427 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000428 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000429
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 return 0;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400431#else
432 (void) ssl;
433 (void) buf;
434 (void) end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400436#endif
XiaokangQianb851da82022-01-14 04:03:11 +0000437}
438
Jerry Yue1b9c292021-09-10 10:08:31 +0800439/*
Jerry Yub85277e2021-10-13 13:36:05 +0800440 * ssl_tls13_parse_key_share_ext()
441 * Parse key_share extension in Server Hello
442 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800443 * struct {
444 * KeyShareEntry server_share;
445 * } KeyShareServerHello;
446 * struct {
447 * NamedGroup group;
448 * opaque key_exchange<1..2^16-1>;
449 * } KeyShareEntry;
450 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200451MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100452static int ssl_tls13_parse_key_share_ext(mbedtls_ssl_context *ssl,
453 const unsigned char *buf,
454 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800455{
Jerry Yub85277e2021-10-13 13:36:05 +0800456 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800457 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800458 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800459
Jerry Yu4a173382021-10-11 21:45:31 +0800460 /* ...
461 * NamedGroup group; (2 bytes)
462 * ...
463 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
465 group = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +0800466 p += 2;
467
Jerry Yu4a173382021-10-11 21:45:31 +0800468 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800469 offered_group = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 if (offered_group != group) {
471 MBEDTLS_SSL_DEBUG_MSG(1,
472 ("Invalid server key share, our group %u, their group %u",
473 (unsigned) offered_group, (unsigned) group));
474 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
475 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
476 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yue1b9c292021-09-10 10:08:31 +0800477 }
478
479#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
481 if (mbedtls_ssl_get_psa_curve_info_from_tls_id(group, NULL, NULL)
482 == PSA_ERROR_NOT_SUPPORTED) {
483 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid TLS curve group id"));
484 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100485 }
486
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH curve: %s",
488 mbedtls_ssl_get_curve_name_from_tls_id(group)));
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100489
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(ssl, p, end - p);
491 if (ret != 0) {
492 return ret;
493 }
494 } else
Jerry Yue1b9c292021-09-10 10:08:31 +0800495#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100496 if (0 /* other KEMs? */) {
Jerry Yue1b9c292021-09-10 10:08:31 +0800497 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 } else {
499 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yue1b9c292021-09-10 10:08:31 +0800500 }
Jerry Yue1b9c292021-09-10 10:08:31 +0800501
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +0800503}
504
XiaokangQiand59be772022-01-24 10:12:51 +0000505/*
506 * ssl_tls13_parse_cookie_ext()
507 * Parse cookie extension in Hello Retry Request
508 *
509 * struct {
510 * opaque cookie<1..2^16-1>;
511 * } Cookie;
512 *
513 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
514 * extension to the client (this is an exception to the usual rule that
515 * the only extensions that may be sent are those that appear in the
516 * ClientHello). When sending the new ClientHello, the client MUST copy
517 * the contents of the extension received in the HelloRetryRequest into
518 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
519 * cookies in their initial ClientHello in subsequent connections.
520 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200521MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100522static int ssl_tls13_parse_cookie_ext(mbedtls_ssl_context *ssl,
523 const unsigned char *buf,
524 const unsigned char *end)
XiaokangQian43550bd2022-01-21 04:32:58 +0000525{
XiaokangQian25c9c902022-02-08 10:49:53 +0000526 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000527 const unsigned char *p = buf;
528 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
529
530 /* Retrieve length field of cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
532 cookie_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian43550bd2022-01-21 04:32:58 +0000533 p += 2;
534
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cookie_len);
536 MBEDTLS_SSL_DEBUG_BUF(3, "cookie extension", p, cookie_len);
XiaokangQian43550bd2022-01-21 04:32:58 +0000537
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 mbedtls_free(handshake->cookie);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800539 handshake->cookie_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 handshake->cookie = mbedtls_calloc(1, cookie_len);
541 if (handshake->cookie == NULL) {
542 MBEDTLS_SSL_DEBUG_MSG(1,
543 ("alloc failed ( %ud bytes )",
544 cookie_len));
545 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
XiaokangQian43550bd2022-01-21 04:32:58 +0000546 }
547
Gilles Peskine449bd832023-01-11 14:50:10 +0100548 memcpy(handshake->cookie, p, cookie_len);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800549 handshake->cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000550
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 return 0;
XiaokangQian43550bd2022-01-21 04:32:58 +0000552}
XiaokangQian43550bd2022-01-21 04:32:58 +0000553
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200554MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100555static int ssl_tls13_write_cookie_ext(mbedtls_ssl_context *ssl,
556 unsigned char *buf,
557 unsigned char *end,
558 size_t *out_len)
XiaokangQian0b64eed2022-01-27 10:36:51 +0000559{
560 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000561 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000562 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000563
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 if (handshake->cookie == NULL) {
565 MBEDTLS_SSL_DEBUG_MSG(3, ("no cookie to send; skip extension"));
566 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000567 }
568
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, cookie",
570 handshake->cookie,
571 handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000572
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 MBEDTLS_SSL_CHK_BUF_PTR(p, end, handshake->cookie_len + 6);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000574
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding cookie extension"));
XiaokangQian0b64eed2022-01-27 10:36:51 +0000576
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_COOKIE, p, 0);
578 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len + 2, p, 2);
579 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len, p, 4);
XiaokangQian233397e2022-02-07 08:32:16 +0000580 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000581
582 /* Cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 memcpy(p, handshake->cookie, handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000584
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800585 *out_len = handshake->cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000586
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_COOKIE);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000590}
591
Ronald Cron41a443a2022-10-04 16:38:25 +0200592#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000593/*
594 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
595 *
596 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
597 *
598 * struct {
599 * PskKeyExchangeMode ke_modes<1..255>;
600 * } PskKeyExchangeModes;
601 */
XiaokangQian86981952022-07-19 09:51:50 +0000602MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100603static int ssl_tls13_write_psk_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
604 unsigned char *buf,
605 unsigned char *end,
606 size_t *out_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000607{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000608 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000609 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000610
Gilles Peskine449bd832023-01-11 14:50:10 +0100611 ((void) ke_modes_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000612 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000613
XiaokangQianeb69aee2022-07-05 08:21:43 +0000614 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000615 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000616 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 if (!mbedtls_ssl_conf_tls13_some_psk_enabled(ssl)) {
618 MBEDTLS_SSL_DEBUG_MSG(3, ("skip psk_key_exchange_modes extension"));
619 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000620 }
621
622 /* Require 7 bytes of data, otherwise fail,
623 * even if extension might be shorter.
624 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000626 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100627 3, ("client hello, adding psk_key_exchange_modes extension"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000628
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000630
XiaokangQian008d2bf2022-07-14 07:54:01 +0000631 /* Skip extension length (2 bytes) and
632 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000633 */
634 p += 5;
635
Gilles Peskine449bd832023-01-11 14:50:10 +0100636 if (mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl)) {
XiaokangQianeb69aee2022-07-05 08:21:43 +0000637 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000638 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000639
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding PSK-ECDHE key exchange mode"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000641 }
642
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 if (mbedtls_ssl_conf_tls13_psk_enabled(ssl)) {
Ronald Crona709a0f2022-09-27 16:46:11 +0200644 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
645 ke_modes_len++;
646
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding pure PSK key exchange mode"));
Ronald Crona709a0f2022-09-27 16:46:11 +0200648 }
649
XiaokangQian008d2bf2022-07-14 07:54:01 +0000650 /* Now write the extension and ke_modes length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100651 MBEDTLS_PUT_UINT16_BE(ke_modes_len + 1, buf, 2);
XiaokangQian008d2bf2022-07-14 07:54:01 +0000652 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000653
654 *out_len = p - buf;
Jerry Yu0c354a22022-08-29 15:25:36 +0800655
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800656 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100657 ssl, MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800658
Gilles Peskine449bd832023-01-11 14:50:10 +0100659 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000660}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800661
Gilles Peskine449bd832023-01-11 14:50:10 +0100662static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg(int ciphersuite)
Jerry Yuf7c12592022-09-28 22:09:38 +0800663{
Jerry Yu21f90952022-10-08 10:30:53 +0800664 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800666
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 if (ciphersuite_info != NULL) {
668 return mbedtls_psa_translate_md(ciphersuite_info->mac);
669 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 return PSA_ALG_NONE;
Jerry Yuf7c12592022-09-28 22:09:38 +0800672}
673
Jerry Yuf75364b2022-09-30 10:30:31 +0800674#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100675static int ssl_tls13_has_configured_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qianb781a232022-11-01 07:39:46 +0000676{
677 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return ssl->handshake->resume &&
Pengyu Lv93566782022-12-07 12:10:05 +0800679 session != NULL && session->ticket != NULL &&
Pengyu Lv9b84ea72023-01-16 14:08:23 +0800680 mbedtls_ssl_conf_tls13_check_kex_modes(
681 ssl, mbedtls_ssl_session_get_ticket_flags(
682 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL));
Xiaokang Qianb781a232022-11-01 07:39:46 +0000683}
684
Xiaokang Qian01323a42022-11-03 02:27:35 +0000685#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100686static int ssl_tls13_early_data_has_valid_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qian01323a42022-11-03 02:27:35 +0000687{
688 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return ssl->handshake->resume &&
690 session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
691 (session->ticket_flags &
692 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) &&
693 mbedtls_ssl_tls13_cipher_suite_is_offered(
694 ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000695}
696#endif
697
Xiaokang Qianb781a232022-11-01 07:39:46 +0000698MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100699static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
700 psa_algorithm_t *hash_alg,
701 const unsigned char **identity,
702 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800703{
704 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800705
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 if (!ssl_tls13_has_configured_ticket(ssl)) {
707 return -1;
708 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800709
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800711 *identity = session->ticket;
712 *identity_len = session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800714}
715
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800716MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100717static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
718 psa_algorithm_t *hash_alg,
719 const unsigned char **psk,
720 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800721{
722
723 mbedtls_ssl_session *session = ssl->session_negotiate;
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 if (!ssl_tls13_has_configured_ticket(ssl)) {
726 return -1;
727 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800728
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800730 *psk = session->resumption_key;
731 *psk_len = session->resumption_key_len;
732
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800734}
Jerry Yuf7c12592022-09-28 22:09:38 +0800735#endif /* MBEDTLS_SSL_SESSION_TICKETS */
736
737MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100738static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
739 psa_algorithm_t *hash_alg,
740 const unsigned char **identity,
741 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800742{
Jerry Yu8b41e892022-09-30 10:00:20 +0800743
Gilles Peskine449bd832023-01-11 14:50:10 +0100744 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
745 return -1;
746 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800747
Jerry Yua99cbfa2022-10-08 11:17:14 +0800748 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800749 *identity = ssl->conf->psk_identity;
750 *identity_len = ssl->conf->psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800752}
753
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800754MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100755static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
756 psa_algorithm_t *hash_alg,
757 const unsigned char **psk,
758 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800759{
Jerry Yu8b41e892022-09-30 10:00:20 +0800760
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
762 return -1;
763 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800764
Jerry Yua99cbfa2022-10-08 11:17:14 +0800765 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800766 *psk = ssl->conf->psk;
767 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100768 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800769}
770
Gilles Peskine449bd832023-01-11 14:50:10 +0100771static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800772{
773 int configured_psk_count = 0;
774#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 if (ssl_tls13_has_configured_ticket(ssl)) {
776 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800777 configured_psk_count++;
778 }
779#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
781 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800782 configured_psk_count++;
783 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800785}
786
Jerry Yuf7c12592022-09-28 22:09:38 +0800787MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100788static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
789 unsigned char *buf,
790 unsigned char *end,
791 const unsigned char *identity,
792 size_t identity_len,
793 uint32_t obfuscated_ticket_age,
794 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800795{
Jerry Yuf75364b2022-09-30 10:30:31 +0800796 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800797 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800798
799 /*
800 * - identity_len (2 bytes)
801 * - identity (psk_identity_len bytes)
802 * - obfuscated_ticket_age (4 bytes)
803 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100804 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800805
Gilles Peskine449bd832023-01-11 14:50:10 +0100806 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
807 memcpy(buf + 2, identity, identity_len);
808 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800809
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800811
812 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800813
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800815}
816
Jerry Yu8b41e892022-09-30 10:00:20 +0800817MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100818static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
819 unsigned char *buf,
820 unsigned char *end,
821 int psk_type,
822 psa_algorithm_t hash_alg,
823 const unsigned char *psk,
824 size_t psk_len,
825 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800826{
827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800828 unsigned char binder_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100829 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800830 size_t transcript_len = 0;
831
832 *out_len = 0;
833
Gilles Peskine449bd832023-01-11 14:50:10 +0100834 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800835
836 /*
837 * - binder_len (1 bytes)
838 * - binder (binder_len bytes)
839 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100840 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800841
Jerry Yua99cbfa2022-10-08 11:17:14 +0800842 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800843
844 /* Get current state of handshake transcript. */
845 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100846 ssl, mbedtls_hash_info_md_from_psa(hash_alg),
847 transcript, sizeof(transcript), &transcript_len);
848 if (ret != 0) {
849 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800850 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100851
852 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
853 psk, psk_len, psk_type,
854 transcript, buf + 1);
855 if (ret != 0) {
856 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
857 return ret;
858 }
859 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800860
861 *out_len = 1 + binder_len;
862
Gilles Peskine449bd832023-01-11 14:50:10 +0100863 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800864}
865
866/*
867 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
868 *
869 * struct {
870 * opaque identity<1..2^16-1>;
871 * uint32 obfuscated_ticket_age;
872 * } PskIdentity;
873 *
874 * opaque PskBinderEntry<32..255>;
875 *
876 * struct {
877 * PskIdentity identities<7..2^16-1>;
878 * PskBinderEntry binders<33..2^16-1>;
879 * } OfferedPsks;
880 *
881 * struct {
882 * select (Handshake.msg_type) {
883 * case client_hello: OfferedPsks;
884 * ...
885 * };
886 * } PreSharedKeyExtension;
887 *
888 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000889int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100890 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
891 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000892{
Jerry Yuf7c12592022-09-28 22:09:38 +0800893 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800894 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800895 unsigned char *p = buf;
Xiaokang Qian854db282022-12-19 07:31:27 +0000896 psa_algorithm_t hash_alg = PSA_ALG_NONE;
Jerry Yuf75364b2022-09-30 10:30:31 +0800897 const unsigned char *identity;
898 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800899 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800900 size_t output_len;
Xiaokang Qian7179f812023-02-03 03:38:44 +0000901
Jerry Yuf7c12592022-09-28 22:09:38 +0800902 *out_len = 0;
903 *binders_len = 0;
904
905 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
907 if (configured_psk_count == 0) {
908 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
909 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800910 }
911
Gilles Peskine449bd832023-01-11 14:50:10 +0100912 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
913 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800914
Jerry Yuf7c12592022-09-28 22:09:38 +0800915 /* Check if we have space to write the extension, binders included.
916 * - extension_type (2 bytes)
917 * - extension_data_len (2 bytes)
918 * - identities_len (2 bytes)
919 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100920 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800921 p += 6;
922
Jerry Yuf75364b2022-09-30 10:30:31 +0800923#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 if (ssl_tls13_ticket_get_identity(
925 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800926#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 mbedtls_time_t now = mbedtls_time(NULL);
Jerry Yuf75364b2022-09-30 10:30:31 +0800928 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800929 uint32_t obfuscated_ticket_age =
Gilles Peskine449bd832023-01-11 14:50:10 +0100930 (uint32_t) (now - session->ticket_received);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800931
Jerry Yu3e60cad2023-01-10 14:58:08 +0800932 /*
933 * The ticket timestamp is in seconds but the ticket age is in
934 * milliseconds. If the ticket was received at the end of a second and
935 * re-used here just at the beginning of the next second, the computed
936 * age `now - session->ticket_received` is equal to 1s thus 1000 ms
937 * while the actual age could be just a few milliseconds or tens of
938 * milliseconds. If the server has more accurate ticket timestamps
939 * (typically timestamps in milliseconds), as part of the processing of
940 * the ClientHello, it may compute a ticket lifetime smaller than the
941 * one computed here and potentially reject the ticket. To avoid that,
942 * remove one second to the ticket age if possible.
Jerry Yubdb936b2023-01-07 16:07:46 +0800943 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 if (obfuscated_ticket_age > 0) {
Jerry Yubdb936b2023-01-07 16:07:46 +0800945 obfuscated_ticket_age -= 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 }
Jerry Yubdb936b2023-01-07 16:07:46 +0800947
Jerry Yuf75364b2022-09-30 10:30:31 +0800948 obfuscated_ticket_age *= 1000;
949 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800950
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 ret = ssl_tls13_write_identity(ssl, p, end,
952 identity, identity_len,
953 obfuscated_ticket_age,
954 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800955#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
957 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800958#endif /* MBEDTLS_HAVE_TIME */
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 if (ret != 0) {
960 return ret;
961 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800962
Jerry Yuf75364b2022-09-30 10:30:31 +0800963 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +0800965 }
966#endif /* MBEDTLS_SSL_SESSION_TICKETS */
967
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 if (ssl_tls13_psk_get_identity(
969 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800970
Gilles Peskine449bd832023-01-11 14:50:10 +0100971 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
972 &output_len);
973 if (ret != 0) {
974 return ret;
975 }
Jerry Yuf75364b2022-09-30 10:30:31 +0800976
Jerry Yuf7c12592022-09-28 22:09:38 +0800977 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100978 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +0800979 }
980
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 MBEDTLS_SSL_DEBUG_MSG(3,
982 ("client hello, adding pre_shared_key extension, "
983 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +0800984
985 /* Take into account the two bytes for the length of the binders. */
986 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800987 /* Check if there is enough space for binders */
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800989
Jerry Yuf7c12592022-09-28 22:09:38 +0800990 /*
991 * - extension_type (2 bytes)
992 * - extension_data_len (2 bytes)
993 * - identities_len (2 bytes)
994 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
996 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
997 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +0800998
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001000 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +08001001
Gilles Peskine449bd832023-01-11 14:50:10 +01001002 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +08001003
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001005}
1006
XiaokangQian86981952022-07-19 09:51:50 +00001007int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001009{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001010 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1011 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001012 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1013 const unsigned char *psk;
1014 size_t psk_len;
1015 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001016
1017 /* Check if we have space to write binders_len.
1018 * - binders_len (2 bytes)
1019 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001021 p += 2;
1022
Jerry Yu6183cc72022-09-30 11:08:57 +08001023#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001025
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 ret = ssl_tls13_write_binder(ssl, p, end,
1027 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1028 hash_alg, psk, psk_len,
1029 &output_len);
1030 if (ret != 0) {
1031 return ret;
1032 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001033 p += output_len;
1034 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001035#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001036
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001038
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 ret = ssl_tls13_write_binder(ssl, p, end,
1040 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1041 hash_alg, psk, psk_len,
1042 &output_len);
1043 if (ret != 0) {
1044 return ret;
1045 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001046 p += output_len;
1047 }
1048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001050
1051 /*
1052 * - binders_len (2 bytes)
1053 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001055
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001057
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001058 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001062}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001063
1064/*
1065 * struct {
1066 * opaque identity<1..2^16-1>;
1067 * uint32 obfuscated_ticket_age;
1068 * } PskIdentity;
1069 *
1070 * opaque PskBinderEntry<32..255>;
1071 *
1072 * struct {
1073 *
1074 * select (Handshake.msg_type) {
1075 * ...
1076 * case server_hello: uint16 selected_identity;
1077 * };
1078 *
1079 * } PreSharedKeyExtension;
1080 *
1081 */
1082MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001083static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1084 const unsigned char *buf,
1085 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001086{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001087 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001088 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001089 const unsigned char *psk;
1090 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001091 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001092
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1094 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001095 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1100 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001101
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1103 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1104 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001105 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001106
Jerry Yu4a698342022-09-30 12:22:01 +08001107#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1109 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1110 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001111#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1113 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
Xiaokang Qian1d8e86c2023-01-12 03:28:18 +00001114 if (mbedtls_psa_translate_md(ssl->handshake->ciphersuite_info->mac)
1115 != hash_alg) {
Xiaokang Qianf10f4742023-01-06 03:43:56 +00001116 MBEDTLS_SSL_DEBUG_MSG(
1117 1, ("Invalid ciphersuite for external psk."));
1118
1119 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1120 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1121 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1122 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 } else {
1124 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1125 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001126 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 if (ret != 0) {
1128 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001129 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001130
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1132 if (ret != 0) {
1133 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1134 return ret;
1135 }
1136
1137 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001138}
Ronald Cron41a443a2022-10-04 16:38:25 +02001139#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001140
Gilles Peskine449bd832023-01-11 14:50:10 +01001141int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1142 unsigned char *buf,
1143 unsigned char *end,
1144 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001145{
1146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1147 unsigned char *p = buf;
1148 size_t ext_len;
1149
1150 *out_len = 0;
1151
1152 /* Write supported_versions extension
1153 *
1154 * Supported Versions Extension is mandatory with TLS 1.3.
1155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1157 if (ret != 0) {
1158 return ret;
1159 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001160 p += ext_len;
1161
1162 /* Echo the cookie if the server provided one in its preceding
1163 * HelloRetryRequest message.
1164 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1166 if (ret != 0) {
1167 return ret;
1168 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001169 p += ext_len;
1170
Ronald Cron766c0cd2022-10-18 12:17:11 +02001171#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1173 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1174 if (ret != 0) {
1175 return ret;
1176 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001177 p += ext_len;
1178 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001179#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001180
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001181#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1183 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1184 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1185 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1186 if (ret != 0) {
1187 return ret;
1188 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001189 p += ext_len;
1190
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001191 /* Initializes the status to `rejected`. It will be updated to
1192 * `accepted` if the EncryptedExtension message contain an early data
1193 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001194 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001195 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 } else {
1197 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001198 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001199 }
1200#endif /* MBEDTLS_SSL_EARLY_DATA */
1201
Ronald Cron41a443a2022-10-04 16:38:25 +02001202#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001203 /* For PSK-based key exchange we need the pre_shared_key extension
1204 * and the psk_key_exchange_modes extension.
1205 *
1206 * The pre_shared_key extension MUST be the last extension in the
1207 * ClientHello. Servers MUST check that it is the last extension and
1208 * otherwise fail the handshake with an "illegal_parameter" alert.
1209 *
1210 * Add the psk_key_exchange_modes extension.
1211 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1213 if (ret != 0) {
1214 return ret;
1215 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001216 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001217#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001218
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001219 *out_len = p - buf;
1220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001222}
1223
Xiaokang Qian126929f2023-01-03 10:29:41 +00001224int mbedtls_ssl_tls13_finalize_write_client_hello(mbedtls_ssl_context *ssl)
1225{
Xiaokang Qian90746132023-01-06 05:54:59 +00001226 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001227#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1228 mbedtls_ssl_handshake_set_state(
1229 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1230#else
1231 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1232#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1233
Xiaokang Qian126929f2023-01-03 10:29:41 +00001234#if defined(MBEDTLS_SSL_EARLY_DATA)
1235 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1236 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1237 const unsigned char *psk;
1238 size_t psk_len;
1239 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001240
Xiaokang Qian126929f2023-01-03 10:29:41 +00001241 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
1242 MBEDTLS_SSL_DEBUG_MSG(
1243 1, ("Set hs psk for early data when writing the first psk"));
1244
1245 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1246 if (ret != 0) {
1247 MBEDTLS_SSL_DEBUG_RET(
1248 1, "ssl_tls13_ticket_get_psk", ret);
1249 return ret;
1250 }
1251
1252 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1253 if (ret != 0) {
1254 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1255 return ret;
1256 }
1257
1258 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1259 ssl->session_negotiate->ciphersuite);
1260 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian42242442023-01-12 02:26:17 +00001261 /* Enable psk and psk_ephermal to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001262 ssl->handshake->key_exchange_mode =
1263 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1264
1265 /* Start the TLS 1.3 key schedule:
1266 * Set the PSK and derive early secret.
1267 */
1268 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1269 if (ret != 0) {
1270 MBEDTLS_SSL_DEBUG_RET(1,
1271 "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1272 return ret;
1273 }
1274
1275 /* Derive early data key material */
1276 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1277 if (ret != 0) {
1278 MBEDTLS_SSL_DEBUG_RET(1,
1279 "mbedtls_ssl_tls13_compute_early_transform", ret);
1280 return ret;
1281 }
1282
Xiaokang Qian126929f2023-01-03 10:29:41 +00001283 }
1284#endif /* MBEDTLS_SSL_EARLY_DATA */
1285 return 0;
1286}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001287/*
Jerry Yu4a173382021-10-11 21:45:31 +08001288 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001289 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001290
Ronald Cronda41b382022-03-30 09:57:11 +02001291/**
1292 * \brief Detect if the ServerHello contains a supported_versions extension
1293 * or not.
1294 *
1295 * \param[in] ssl SSL context
1296 * \param[in] buf Buffer containing the ServerHello message
1297 * \param[in] end End of the buffer containing the ServerHello message
1298 *
1299 * \return 0 if the ServerHello does not contain a supported_versions extension
1300 * \return 1 if the ServerHello contains a supported_versions extension
1301 * \return A negative value if an error occurred while parsing the ServerHello.
1302 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001303MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001304static int ssl_tls13_is_supported_versions_ext_present(
1305 mbedtls_ssl_context *ssl,
1306 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001307 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001308{
1309 const unsigned char *p = buf;
1310 size_t legacy_session_id_echo_len;
1311 size_t extensions_len;
1312 const unsigned char *extensions_end;
1313
1314 /*
1315 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001316 * length:
1317 * - legacy_version 2 bytes
1318 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1319 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001320 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001322 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1323 legacy_session_id_echo_len = *p;
1324
1325 /*
1326 * Jump to the extensions, jumping over:
1327 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1328 * - cipher_suite 2 bytes
1329 * - legacy_compression_method 1 byte
1330 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1332 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001333
1334 /* Case of no extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 if (p == end) {
1336 return 0;
1337 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001338
1339 /* ...
1340 * Extension extensions<6..2^16-1>;
1341 * ...
1342 * struct {
1343 * ExtensionType extension_type; (2 bytes)
1344 * opaque extension_data<0..2^16-1>;
1345 * } Extension;
1346 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1348 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001349 p += 2;
1350
1351 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001353 extensions_end = p + extensions_len;
1354
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 while (p < extensions_end) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01001356 unsigned int extension_type;
1357 size_t extension_data_len;
1358
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1360 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1361 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001362 p += 4;
1363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if (extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS) {
1365 return 1;
1366 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001367
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001369 p += extension_data_len;
1370 }
1371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 return 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001373}
1374
Jerry Yu7a186a02021-10-15 18:46:14 +08001375/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001376 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1377 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1378 * - 0 otherwise
1379 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001381static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1382 const unsigned char *buf,
1383 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001384{
1385 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1386 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001388 const unsigned char *last_eight_bytes_of_random;
1389 unsigned char last_byte_of_random;
1390
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001392 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 if (memcmp(last_eight_bytes_of_random,
1395 magic_downgrade_string,
1396 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001397 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 return last_byte_of_random == 0 ||
1399 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001400 }
1401
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001403}
1404
1405/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001406 * - SSL_SERVER_HELLO or
1407 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001408 * to indicate which message is expected and to be parsed next.
1409 */
Ronald Cron828aff62022-05-31 12:04:31 +02001410#define SSL_SERVER_HELLO 0
1411#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001412MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001413static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1414 const unsigned char *buf,
1415 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001416{
Jerry Yue1b9c292021-09-10 10:08:31 +08001417
1418 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1419 *
Jerry Yu4a173382021-10-11 21:45:31 +08001420 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001421 * special value of the SHA-256 of "HelloRetryRequest".
1422 *
1423 * struct {
1424 * ProtocolVersion legacy_version = 0x0303;
1425 * Random random;
1426 * opaque legacy_session_id_echo<0..32>;
1427 * CipherSuite cipher_suite;
1428 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001429 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001430 * } ServerHello;
1431 *
1432 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end,
1434 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001435
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1437 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1438 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001439 }
1440
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001442}
1443
Ronald Cron828aff62022-05-31 12:04:31 +02001444/*
Jerry Yu745bb612021-10-13 22:01:04 +08001445 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001446 * - SSL_SERVER_HELLO or
1447 * - SSL_SERVER_HELLO_HRR or
1448 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001449 */
Ronald Cron828aff62022-05-31 12:04:31 +02001450#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001451MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001452static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1453 const unsigned char *buf,
1454 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001455{
Jerry Yu4a173382021-10-11 21:45:31 +08001456 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001457 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001458
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1460 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001461
Gilles Peskine449bd832023-01-11 14:50:10 +01001462 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001463 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001465
1466 /* If the server is negotiating TLS 1.2 or below and:
1467 * . we did not propose TLS 1.2 or
1468 * . the server responded it is TLS 1.3 capable but negotiating a lower
1469 * version of the protocol and thus we are under downgrade attack
1470 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001471 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1473 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1474 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1475 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001476 }
1477
1478 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001479 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1481 buf, (size_t) (end - buf));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001482
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1484 ret = ssl_tls13_reset_key_share(ssl);
1485 if (ret != 0) {
1486 return ret;
1487 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001488 }
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001491 }
1492
Jerry Yua66fece2022-07-13 14:30:29 +08001493#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1494 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1495 ssl->session_negotiate->tls_version = ssl->tls_version;
1496#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1497
Jerry Yu50e00e32022-10-31 14:45:01 +08001498 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1501 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001502 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001504 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001505 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
1507 /* If a client receives a second
1508 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1509 * was itself in response to a HelloRetryRequest), it MUST abort the
1510 * handshake with an "unexpected_message" alert.
1511 */
1512 if (handshake->hello_retry_request_count > 0) {
1513 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
1514 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1515 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
1516 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001517 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001518 /*
1519 * Clients must abort the handshake with an "illegal_parameter"
1520 * alert if the HelloRetryRequest would not result in any change
1521 * in the ClientHello.
1522 * In a PSK only key exchange that what we expect.
1523 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1525 MBEDTLS_SSL_DEBUG_MSG(1,
1526 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1529 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1530 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001532
Ronald Cron5afb9042022-05-31 12:11:39 +02001533 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001534
Jerry Yu745bb612021-10-13 22:01:04 +08001535 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001536 }
1537
1538cleanup:
1539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001541}
1542
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001543MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001544static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1545 const unsigned char **buf,
1546 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001547{
1548 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001549 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001550
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1552 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001553
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001555
1556 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1558 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1559 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1560 ssl->session_negotiate->id,
1561 ssl->session_negotiate->id_len);
1562 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1563 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001564
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1566 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001567
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001569 }
1570
Jerry Yu4a173382021-10-11 21:45:31 +08001571 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001572 *buf = p;
1573
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1575 ssl->session_negotiate->id_len);
1576 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001577}
1578
Jerry Yue1b9c292021-09-10 10:08:31 +08001579/* Parse ServerHello message and configure context
1580 *
1581 * struct {
1582 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1583 * Random random;
1584 * opaque legacy_session_id_echo<0..32>;
1585 * CipherSuite cipher_suite;
1586 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001587 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001588 * } ServerHello;
1589 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001590MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001591static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1592 const unsigned char *buf,
1593 const unsigned char *end,
1594 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001595{
Jerry Yub85277e2021-10-13 13:36:05 +08001596 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001597 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001598 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001599 size_t extensions_len;
1600 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001601 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001602 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001603 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001604 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001605 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001607
1608 /*
1609 * Check there is space for minimal fields
1610 *
1611 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001612 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001613 * - legacy_session_id_echo ( 1 byte ), minimum size
1614 * - cipher_suite ( 2 bytes)
1615 * - legacy_compression_method ( 1 byte )
1616 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001618
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1620 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001621
Jerry Yu4a173382021-10-11 21:45:31 +08001622 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001623 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001624 * ...
1625 * with ProtocolVersion defined as:
1626 * uint16 ProtocolVersion;
1627 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1629 MBEDTLS_SSL_VERSION_TLS1_2) {
1630 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1631 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1632 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001633 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1634 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001635 }
1636 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001637
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001638 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001639 * Random random;
1640 * ...
1641 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001642 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 if (!is_hrr) {
1645 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1646 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1647 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1648 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001649 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001650 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001651
Jerry Yu4a173382021-10-11 21:45:31 +08001652 /* ...
1653 * opaque legacy_session_id_echo<0..32>;
1654 * ...
1655 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001657 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001658 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001659 }
1660
Jerry Yu4a173382021-10-11 21:45:31 +08001661 /* ...
1662 * CipherSuite cipher_suite;
1663 * ...
1664 * with CipherSuite defined as:
1665 * uint8 CipherSuite[2];
1666 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1668 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001669 p += 2;
1670
Jerry Yu4a173382021-10-11 21:45:31 +08001671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001673 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001674 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001675 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1677 ssl->tls_version,
1678 ssl->tls_version) != 0) ||
1679 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001680 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001681 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001682 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001683 * If we received an HRR before and that the proposed selected
1684 * ciphersuite in this server hello is not the same as the one
1685 * proposed in the HRR, we abort the handshake and send an
1686 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001687 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1689 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001690 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001691 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001692
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1694 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1695 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001696 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001697 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001698
Jerry Yu4a173382021-10-11 21:45:31 +08001699 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001701
XiaokangQian355e09a2022-01-20 11:14:50 +00001702 handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian33ff8682023-01-10 06:32:12 +00001703#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianea28a782023-01-12 03:18:31 +00001704 if (handshake->resume == 0)
Xiaokang Qian33ff8682023-01-10 06:32:12 +00001705#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001706 ssl->session_negotiate->ciphersuite = cipher_suite;
1707
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1709 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001710
1711#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 ssl->session_negotiate->start = time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001713#endif /* MBEDTLS_HAVE_TIME */
1714
Jerry Yu4a173382021-10-11 21:45:31 +08001715 /* ...
1716 * uint8 legacy_compression_method = 0;
1717 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001718 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1720 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1721 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001722 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001723 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001724 }
1725 p++;
1726
Jerry Yub85277e2021-10-13 13:36:05 +08001727 /* ...
1728 * Extension extensions<6..2^16-1>;
1729 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001730 * struct {
1731 * ExtensionType extension_type; (2 bytes)
1732 * opaque extension_data<0..2^16-1>;
1733 * } Extension;
1734 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1736 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001737 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001738
Jerry Yu4a173382021-10-11 21:45:31 +08001739 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001741 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001742
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001744
Jerry Yu50e00e32022-10-31 14:45:01 +08001745 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001746 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1748 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001751 unsigned int extension_type;
1752 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001753 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1756 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1757 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001758 p += 4;
1759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001761 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001762
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001763 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1765 if (ret != 0) {
1766 return ret;
1767 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001768
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001770 case MBEDTLS_TLS_EXT_COOKIE:
1771
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 ret = ssl_tls13_parse_cookie_ext(ssl,
1773 p, extension_data_end);
1774 if (ret != 0) {
1775 MBEDTLS_SSL_DEBUG_RET(1,
1776 "ssl_tls13_parse_cookie_ext",
1777 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001778 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001779 }
XiaokangQianb851da82022-01-14 04:03:11 +00001780 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001781
Jerry Yue1b9c292021-09-10 10:08:31 +08001782 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1784 p,
1785 extension_data_end);
1786 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001787 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001789 break;
1790
Ronald Cron41a443a2022-10-04 16:38:25 +02001791#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001792 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001794
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1796 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001797 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1799 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001800 }
1801 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001802#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001803
Jerry Yue1b9c292021-09-10 10:08:31 +08001804 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1806 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001807 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001808 goto cleanup;
1809 }
1810
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 if (is_hrr) {
1812 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1813 p, extension_data_end);
1814 } else {
1815 ret = ssl_tls13_parse_key_share_ext(ssl,
1816 p, extension_data_end);
1817 }
1818 if (ret != 0) {
1819 MBEDTLS_SSL_DEBUG_RET(1,
1820 "ssl_tls13_parse_key_share_ext",
1821 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001822 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001823 }
1824 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001825
1826 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001827 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1828 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001829 }
1830
1831 p += extension_data_len;
1832 }
1833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001835
XiaokangQiand59be772022-01-24 10:12:51 +00001836cleanup:
1837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1839 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1840 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001841 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1843 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1844 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001845 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1846 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001848}
1849
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001850#if defined(MBEDTLS_DEBUG_C)
1851static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001852{
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001854 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1855 return "psk";
1856 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1857 return "ephemeral";
1858 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1859 return "psk_ephemeral";
1860 default:
1861 return "unknown mode";
1862 }
1863}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001864#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001865
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001866MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001867static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001868{
Jerry Yub85277e2021-10-13 13:36:05 +08001869 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001870 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001871
Jerry Yub85277e2021-10-13 13:36:05 +08001872 /* Determine the key exchange mode:
1873 * 1) If both the pre_shared_key and key_share extensions were received
1874 * then the key exchange mode is PSK with EPHEMERAL.
1875 * 2) If only the pre_shared_key extension was received then the key
1876 * exchange mode is PSK-only.
1877 * 3) If only the key_share extension was received then the key
1878 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001879 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 switch (handshake->received_extensions &
1881 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001882 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Ronald Cron79907712022-07-20 17:05:29 +02001884 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
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 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Ronald Cron79907712022-07-20 17:05:29 +02001889 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001890 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001891
Jerry Yu745bb612021-10-13 22:01:04 +08001892 /* Both the pre_shared_key and key_share extensions were received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
Ronald Cron79907712022-07-20 17:05:29 +02001894 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001895 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001896
Jerry Yu745bb612021-10-13 22:01:04 +08001897 /* Neither pre_shared_key nor key_share extension was received */
1898 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001900 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1901 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001902 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001903#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianb5846212023-02-02 08:12:20 +00001904 if (ssl->handshake->received_extensions &
1905 MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001906 ssl->handshake->selected_identity != 0) {
1907 /* RFC8446 4.2.11
1908 * If the server supplies an "early_data" extension, the
1909 * client MUST verify that the server's selected_identity
1910 * is 0. If any other value is returned, the client MUST
1911 * abort the handshake with an "illegal_parameter" alert.
1912 */
1913 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1914 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1915 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1916 }
Xiaokang Qianb5846212023-02-02 08:12:20 +00001917 if (ssl->handshake->received_extensions &
1918 MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1919 ssl->handshake->ciphersuite_info->id !=
1920 ssl->session_negotiate->ciphersuite) {
1921 MBEDTLS_SSL_DEBUG_MSG(
1922 1, ("Invalid ciphersuite for session ticket psk."));
1923
1924 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1925 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1926 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1927 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001928#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001929
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 if (!mbedtls_ssl_conf_tls13_check_kex_modes(ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001931 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01001932 MBEDTLS_SSL_DEBUG_MSG(2,
1933 ("Key exchange mode(%s) is not supported.",
1934 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001935 goto cleanup;
1936 }
1937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 MBEDTLS_SSL_DEBUG_MSG(3,
1939 ("Selected key exchange mode: %s",
1940 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001941
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001942 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001943 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001944 * If we proposed early data then we have already derived an
1945 * early secret using the selected PSK and its associated hash.
1946 * It means that if the negotiated key exchange mode is psk or
1947 * psk_ephemeral, we have already correctly computed the
1948 * early secret and thus we do not do it again. In all other
1949 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001950 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001951#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian42242442023-01-12 02:26:17 +00001952 if ((ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT) ||
1953 (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED &&
1954 handshake->key_exchange_mode ==
1955 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL))
Xiaokang Qian90746132023-01-06 05:54:59 +00001956#endif
1957 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001958 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1959 if (ret != 0) {
1960 MBEDTLS_SSL_DEBUG_RET(
1961 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1962 goto cleanup;
1963 }
Jerry Yu0b177842021-09-05 19:41:30 +08001964 }
1965
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1967 if (ret != 0) {
1968 MBEDTLS_SSL_DEBUG_RET(1,
1969 "mbedtls_ssl_tls13_compute_handshake_transform",
1970 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001971 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001972 }
1973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1975 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Jerry Yu0b177842021-09-05 19:41:30 +08001976 ssl->session_in = ssl->session_negotiate;
1977
Jerry Yu4a173382021-10-11 21:45:31 +08001978cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001980 MBEDTLS_SSL_PEND_FATAL_ALERT(
1981 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001983 }
Jerry Yue110d252022-05-05 10:19:22 +08001984
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001986}
1987
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001988MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001989static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00001990{
1991 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00001994
XiaokangQian78b1fa72022-01-19 06:56:30 +00001995 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001996 * We are going to re-generate a shared secret corresponding to the group
1997 * selected by the server, which is different from the group for which we
1998 * generated a shared secret in the first client hello.
1999 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00002000 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 ret = ssl_tls13_reset_key_share(ssl);
2002 if (ret != 0) {
2003 return ret;
2004 }
XiaokangQian647719a2021-12-07 09:16:29 +00002005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002007}
2008
Jerry Yue1b9c292021-09-10 10:08:31 +08002009/*
Jerry Yu4a173382021-10-11 21:45:31 +08002010 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002011 * Handler for MBEDTLS_SSL_SERVER_HELLO
2012 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002013MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002014static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002015{
Jerry Yu4a173382021-10-11 21:45:31 +08002016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002017 unsigned char *buf = NULL;
2018 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002019 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002020
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002022
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2024 MBEDTLS_SSL_HS_SERVER_HELLO,
2025 &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002026
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2028 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002029 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 } else {
2031 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2032 }
XiaokangQiand59be772022-01-24 10:12:51 +00002033
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002035 ret = 0;
2036 goto cleanup;
2037 }
2038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2040 buf + buf_len,
2041 is_hrr));
2042 if (is_hrr) {
2043 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002044 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002045
2046 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2047 buf, buf_len);
2048
2049 if (is_hrr) {
2050 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2051#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2052 /* If not offering early data, the client sends a dummy CCS record
2053 * immediately before its second flight. This may either be before
2054 * its second ClientHello or before its encrypted handshake flight.
2055 */
2056 mbedtls_ssl_handshake_set_state(ssl,
2057 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
2058#else
2059 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2060#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2061 } else {
2062 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2063 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002064 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002065
2066cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2068 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2069 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002070}
2071
2072/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002073 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002074 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002075 *
2076 * The EncryptedExtensions message contains any extensions which
2077 * should be protected, i.e., any which are not needed to establish
2078 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002079 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002080
XiaokangQian08da26c2021-10-09 10:12:11 +00002081/* Parse EncryptedExtensions message
2082 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002083 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002084 * } EncryptedExtensions;
2085 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002086MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002087static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2088 const unsigned char *buf,
2089 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002090{
2091 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002092 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002093 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002094 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002095 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2098 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002099 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002100
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2102 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002103 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002104
Jerry Yu9eba7502022-10-31 13:46:16 +08002105 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002108 unsigned int extension_type;
2109 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002110
XiaokangQian08da26c2021-10-09 10:12:11 +00002111 /*
2112 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002113 * ExtensionType extension_type; (2 bytes)
2114 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002115 * } Extension;
2116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2118 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2119 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002120 p += 4;
2121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002123
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002124 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2126 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2127 if (ret != 0) {
2128 return ret;
2129 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002130
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002132#if defined(MBEDTLS_SSL_ALPN)
2133 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002135
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 if ((ret = ssl_tls13_parse_alpn_ext(ssl, p, (size_t) extension_data_len)) != 0) {
2137 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002138 }
2139
2140 break;
2141#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002142
2143#if defined(MBEDTLS_SSL_EARLY_DATA)
2144 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002145
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002147 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2149 MBEDTLS_ERR_SSL_DECODE_ERROR);
2150 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002151 }
2152
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002153 break;
2154#endif /* MBEDTLS_SSL_EARLY_DATA */
2155
XiaokangQian08da26c2021-10-09 10:12:11 +00002156 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002157 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002158 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002160 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002161 }
2162
XiaokangQian08da26c2021-10-09 10:12:11 +00002163 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002164 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2167 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002168
XiaokangQian97799ac2021-10-11 10:05:54 +00002169 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (p != end) {
2171 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2172 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2173 MBEDTLS_ERR_SSL_DECODE_ERROR);
2174 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002175 }
2176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002178}
2179
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002180MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002181static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002182{
2183 int ret;
2184 unsigned char *buf;
2185 size_t buf_len;
2186
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2190 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2191 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002192
2193 /* Process the message contents */
2194 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002196
Xiaokang Qianb157e912022-11-23 08:12:26 +00002197#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (ssl->handshake->received_extensions &
2199 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002200 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2201 }
2202#endif
2203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2205 buf, buf_len);
Ronald Cron9d6a5452022-05-30 16:05:38 +02002206
Ronald Cron928cbd32022-10-04 16:14:26 +02002207#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2209 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2210 } else {
2211 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2212 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002213#else
2214 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002216#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002217
2218cleanup:
2219
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2221 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002222
2223}
2224
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002225/*
2226 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2227 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002228 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002229 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002230 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002231 *
2232 * If the server sent an "early_data" extension in EncryptedExtensions, the
2233 * client MUST send an EndOfEarlyData message after receiving the server
2234 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002235 */
2236
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002237MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002238static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2239{
2240 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002241 unsigned char *buf = NULL;
2242 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002243 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002244
Xiaokang Qian742578c2022-12-19 06:34:44 +00002245 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2246 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002247
Xiaokang Qian742578c2022-12-19 06:34:44 +00002248 mbedtls_ssl_add_hs_hdr_to_checksum(
2249 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002250
Xiaokang Qian742578c2022-12-19 06:34:44 +00002251 MBEDTLS_SSL_PROC_CHK(
2252 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002253
Xiaokang Qian43a83f22023-01-06 06:02:54 +00002254 /* TODO: Currently switch outbound back to handshake key in the case of
2255 * MBEDTLS_SSL_CLIENT_CERTIFICATE. If we refine the coordinate function
2256 * of client certificate state machine, we have to move the switch
2257 * outbound function.
2258 */
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002259
Xiaokang Qian19d44162023-01-03 03:39:50 +00002260 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002261
2262cleanup:
2263
2264 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2265 return ret;
2266}
2267
Ronald Cron928cbd32022-10-04 16:14:26 +02002268#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002269/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002270 * STATE HANDLING: CertificateRequest
2271 *
Jerry Yud2674312021-10-29 10:08:19 +08002272 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002273#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2274#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002275/* Coordination:
2276 * Deals with the ambiguity of not knowing if a CertificateRequest
2277 * will be sent. Returns a negative code on failure, or
2278 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2279 * - SSL_CERTIFICATE_REQUEST_SKIP
2280 * indicating if a Certificate Request is expected or not.
2281 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002282MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002283static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002284{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002285 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2288 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2289 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002290 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002291 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002292
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2294 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2295 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2296 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002297 }
2298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002302}
2303
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002304/*
2305 * ssl_tls13_parse_certificate_request()
2306 * Parse certificate request
2307 * struct {
2308 * opaque certificate_request_context<0..2^8-1>;
2309 * Extension extensions<2..2^16-1>;
2310 * } CertificateRequest;
2311 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002312MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002313static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2314 const unsigned char *buf,
2315 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002316{
2317 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2318 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002319 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002320 size_t extensions_len = 0;
2321 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002322 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002323
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002324 /* ...
2325 * opaque certificate_request_context<0..2^8-1>
2326 * ...
2327 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002329 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002330 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 if (certificate_request_context_len > 0) {
2333 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2334 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2335 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002336
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002337 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 mbedtls_calloc(1, certificate_request_context_len);
2339 if (handshake->certificate_request_context == NULL) {
2340 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2341 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002342 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 memcpy(handshake->certificate_request_context, p,
2344 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002345 p += certificate_request_context_len;
2346 }
2347
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002348 /* ...
2349 * Extension extensions<2..2^16-1>;
2350 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002351 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2353 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002354 p += 2;
2355
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002357 extensions_end = p + extensions_len;
2358
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002359 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002362 unsigned int extension_type;
2363 size_t extension_data_len;
2364
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2366 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2367 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002368 p += 4;
2369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002371
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002372 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2374 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2375 if (ret != 0) {
2376 return ret;
2377 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002378
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002380 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 MBEDTLS_SSL_DEBUG_MSG(3,
2382 ("found signature algorithms extension"));
2383 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2384 p + extension_data_len);
2385 if (ret != 0) {
2386 return ret;
2387 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002388
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002389 break;
2390
2391 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002392 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002393 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002395 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002396 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002397
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002398 p += extension_data_len;
2399 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002400
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2402 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002403
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002404 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 if (p != end) {
2406 MBEDTLS_SSL_DEBUG_MSG(1,
2407 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002408 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002409 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002410
Jerry Yu0c354a22022-08-29 15:25:36 +08002411 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002412 *
2413 * The "signature_algorithms" extension MUST be specified
2414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2416 MBEDTLS_SSL_DEBUG_MSG(3,
2417 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002418 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002419 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002420
Jerry Yu7840f812022-01-29 10:26:51 +08002421 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002423
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002424decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2426 MBEDTLS_ERR_SSL_DECODE_ERROR);
2427 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002428}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002429
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002430/*
2431 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2432 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002433MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002434static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002435{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002436 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002437
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002439
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002441
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002443 unsigned char *buf;
2444 size_t buf_len;
2445
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2447 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2448 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002449
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(ssl,
2451 buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2454 buf, buf_len);
2455 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002456 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 } else {
2458 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002459 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2460 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002461 }
2462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002464
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002465cleanup:
2466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2468 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002469}
2470
2471/*
Jerry Yu687101b2021-09-14 16:03:56 +08002472 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2473 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002474MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002475static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002476{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002477 int ret;
2478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2480 if (ret != 0) {
2481 return ret;
2482 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2485 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002486}
2487
2488/*
2489 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2490 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002491MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002492static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002493{
Jerry Yu30b071c2021-09-12 20:16:03 +08002494 int ret;
2495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2497 if (ret != 0) {
2498 return ret;
2499 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002500
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2502 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002503}
Ronald Cron928cbd32022-10-04 16:14:26 +02002504#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002505
Jerry Yu687101b2021-09-14 16:03:56 +08002506/*
2507 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2508 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002509MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002510static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002511{
XiaokangQianac0385c2021-11-03 06:40:11 +00002512 int ret;
2513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2515 if (ret != 0) {
2516 return ret;
2517 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002518
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2520 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002521 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2523 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2524 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002525 }
2526
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002527#if defined(MBEDTLS_SSL_EARLY_DATA)
2528 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2529 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002530 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2531 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002532 } else
2533#endif /* MBEDTLS_SSL_EARLY_DATA */
2534 {
2535#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2536 mbedtls_ssl_handshake_set_state(
2537 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2538#else
2539 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2540#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2541 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002542
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002544}
2545
2546/*
Jerry Yu566c7812022-01-26 15:41:22 +08002547 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2548 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002549MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002550static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002551{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002552 int non_empty_certificate_msg = 0;
2553
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 MBEDTLS_SSL_DEBUG_MSG(1,
2555 ("Switch to handshake traffic keys for outbound traffic"));
2556 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002557
Ronald Cron928cbd32022-10-04 16:14:26 +02002558#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 if (ssl->handshake->client_auth) {
2560 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2561 if (ret != 0) {
2562 return ret;
2563 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002566 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 }
2568 } else {
2569 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002570 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002571#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 if (non_empty_certificate_msg) {
2574 mbedtls_ssl_handshake_set_state(ssl,
2575 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2576 } else {
2577 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2578 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2579 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002582}
2583
Ronald Cron928cbd32022-10-04 16:14:26 +02002584#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002585/*
2586 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2587 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002588MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002589static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002590{
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 if (ret == 0) {
2594 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2595 }
Ronald Crona8b38872022-03-09 07:59:25 +01002596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002598}
Ronald Cron928cbd32022-10-04 16:14:26 +02002599#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002600
2601/*
Jerry Yu687101b2021-09-14 16:03:56 +08002602 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
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_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002606{
XiaokangQian0fa66432021-11-15 03:33:57 +00002607 int ret;
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2610 if (ret != 0) {
2611 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002612 }
2613
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2615 if (ret != 0) {
2616 MBEDTLS_SSL_DEBUG_RET(1,
2617 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
2618 return ret;
2619 }
2620
2621 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2622 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002623}
2624
2625/*
2626 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2627 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002628MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002629static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002630{
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2632 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2633 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002634}
2635
2636/*
2637 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2638 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002639MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002640static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002641{
Jerry Yu378254d2021-10-30 21:44:47 +08002642
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2646 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002647}
2648
Jerry Yuf8a49942022-07-07 11:32:32 +00002649#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2650
Jerry Yua0446a02022-07-13 11:22:55 +08002651MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002652static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2653 const unsigned char *buf,
2654 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002655{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002656 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002657 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002658
Jerry Yuf8a49942022-07-07 11:32:32 +00002659
Jerry Yuedab6372022-10-31 14:37:31 +08002660 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002663 unsigned int extension_type;
2664 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002665 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002666
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2668 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2669 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002670 p += 4;
2671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002673
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002674 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2676 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2677 if (ret != 0) {
2678 return ret;
2679 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002682#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002683 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002685 MBEDTLS_SSL_PEND_FATAL_ALERT(
2686 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 MBEDTLS_ERR_SSL_DECODE_ERROR);
2688 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002689 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002691 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002693 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002694 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002695#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002696
Jerry Yuf8a49942022-07-07 11:32:32 +00002697 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002698 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002699 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002701 break;
2702 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002703
Jerry Yuf8a49942022-07-07 11:32:32 +00002704 p += extension_data_len;
2705 }
2706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2708 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002709
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002711}
2712
2713/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002714 * From RFC8446, page 74
2715 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002716 * struct {
2717 * uint32 ticket_lifetime;
2718 * uint32 ticket_age_add;
2719 * opaque ticket_nonce<0..255>;
2720 * opaque ticket<1..2^16-1>;
2721 * Extension extensions<0..2^16-2>;
2722 * } NewSessionTicket;
2723 *
2724 */
Jerry Yua0446a02022-07-13 11:22:55 +08002725MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002726static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2727 unsigned char *buf,
2728 unsigned char *end,
2729 unsigned char **ticket_nonce,
2730 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002731{
2732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2733 unsigned char *p = buf;
2734 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002735 size_t ticket_len;
2736 unsigned char *ticket;
2737 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002738
Jerry Yucb3b1392022-07-12 06:09:38 +00002739 *ticket_nonce = NULL;
2740 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002741 /*
2742 * ticket_lifetime 4 bytes
2743 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002744 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002745 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002747
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2749 MBEDTLS_SSL_DEBUG_MSG(3,
2750 ("ticket_lifetime: %u",
2751 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002752
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2754 MBEDTLS_SSL_DEBUG_MSG(3,
2755 ("ticket_age_add: %u",
2756 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002757
Jerry Yucb3b1392022-07-12 06:09:38 +00002758 *ticket_nonce_len = p[8];
2759 p += 9;
2760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002762 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002764 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002765
2766 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2768 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002769 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2771 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002772
2773 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 if (session->ticket != NULL || session->ticket_len > 0) {
2775 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002776 session->ticket = NULL;
2777 session->ticket_len = 0;
2778 }
2779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2781 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2782 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002783 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002785 p += ticket_len;
2786 session->ticket = ticket;
2787 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002788
Pengyu Lv9f926952022-11-17 15:22:33 +08002789 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002790 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002791 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2794 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002795 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002797
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2801 if (ret != 0) {
2802 MBEDTLS_SSL_DEBUG_RET(1,
2803 "ssl_tls13_parse_new_session_ticket_exts",
2804 ret);
2805 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002806 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002807
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002808 /* session has been updated, allow export */
2809 session->exported = 0;
2810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002812}
2813
Jerry Yua0446a02022-07-13 11:22:55 +08002814MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002815static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2816 unsigned char *ticket_nonce,
2817 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002818{
2819 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2820 mbedtls_ssl_session *session = ssl->session;
2821 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2822 psa_algorithm_t psa_hash_alg;
2823 int hash_length;
2824
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002825#if defined(MBEDTLS_HAVE_TIME)
2826 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002828#endif
2829
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2831 if (ciphersuite_info == NULL) {
2832 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2833 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002834 }
2835
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2837 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2838 if (hash_length == -1 ||
2839 (size_t) hash_length > sizeof(session->resumption_key)) {
2840 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002841 }
2842
Jerry Yuf8a49942022-07-07 11:32:32 +00002843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2845 session->app_secrets.resumption_master_secret,
2846 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002847
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002848 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002849 *
2850 * HKDF-Expand-Label( resumption_master_secret,
2851 * "resumption", ticket_nonce, Hash.length )
2852 */
2853 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 psa_hash_alg,
2855 session->app_secrets.resumption_master_secret,
2856 hash_length,
2857 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2858 ticket_nonce,
2859 ticket_nonce_len,
2860 session->resumption_key,
2861 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 if (ret != 0) {
2864 MBEDTLS_SSL_DEBUG_RET(2,
2865 "Creating the ticket-resumed PSK failed",
2866 ret);
2867 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002868 }
2869
Jerry Yu0a430c82022-07-20 11:02:48 +08002870 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2873 session->resumption_key,
2874 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002875
Pengyu Lv9f926952022-11-17 15:22:33 +08002876 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002877 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002878 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002879 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002882}
2883
2884/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002885 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002886 */
Jerry Yua0446a02022-07-13 11:22:55 +08002887MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002888static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002889{
2890 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2891 unsigned char *buf;
2892 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002893 unsigned char *ticket_nonce;
2894 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002895
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2899 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2900 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002901
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2903 ssl, buf, buf + buf_len,
2904 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2907 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002910
Jerry Yuf8a49942022-07-07 11:32:32 +00002911cleanup:
2912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2914 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002915}
2916#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002919{
Jerry Yu92c6b402021-08-27 16:59:09 +08002920 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002923 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002925 break;
2926
Jerry Yu92c6b402021-08-27 16:59:09 +08002927 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002929 break;
2930
2931 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002933 break;
2934
2935 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002937 break;
2938
Ronald Cron928cbd32022-10-04 16:14:26 +02002939#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002940 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002942 break;
2943
Jerry Yu687101b2021-09-14 16:03:56 +08002944 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002946 break;
2947
2948 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002950 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002951#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002952
2953 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002955 break;
2956
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002957 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2958 ret = ssl_tls13_write_end_of_early_data(ssl);
2959 break;
2960
Jerry Yu566c7812022-01-26 15:41:22 +08002961 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002963 break;
2964
Ronald Cron928cbd32022-10-04 16:14:26 +02002965#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002966 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002968 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002969#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002970
Jerry Yu687101b2021-09-14 16:03:56 +08002971 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002973 break;
2974
2975 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002977 break;
2978
2979 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002981 break;
2982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 /*
2984 * Injection of dummy-CCS's for middlebox compatibility
2985 */
Ronald Cron49ad6192021-11-24 16:25:31 +01002986#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002987 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2989 if (ret == 0) {
2990 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2991 }
Ronald Cron9f55f632022-02-02 16:02:47 +01002992 break;
2993
2994 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2996 if (ret == 0) {
2997 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2998 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002999 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003000
Xiaokang Qian592021a2023-01-04 10:47:05 +00003001 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3002 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3003 if (ret == 0) {
3004 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3005
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003006#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003007 MBEDTLS_SSL_DEBUG_MSG(
3008 1, ("Switch to early data keys for outbound traffic"));
3009 mbedtls_ssl_set_outbound_transform(
3010 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003011#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003012 }
3013 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003014#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3015
Jerry Yuf8a49942022-07-07 11:32:32 +00003016#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003017 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 ret = ssl_tls13_process_new_session_ticket(ssl);
3019 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003020 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003022 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3023 break;
3024#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3025
Jerry Yu92c6b402021-08-27 16:59:09 +08003026 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3028 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003029 }
3030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003032}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003033
Jerry Yufb4b6472022-01-27 15:03:26 +08003034#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */