blob: f7f9f99927e879736e5ab45d1240495314ab5a33 [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);
1114 } else {
1115 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1116 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001117 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 if (ret != 0) {
1119 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001120 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001121
Xiaokang Qianeb31cbc2023-02-07 02:08:56 +00001122 if (mbedtls_psa_translate_md(ssl->handshake->ciphersuite_info->mac)
1123 != hash_alg) {
1124 MBEDTLS_SSL_DEBUG_MSG(
1125 1, ("Invalid ciphersuite for external psk."));
1126
1127 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1128 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1129 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1130 }
1131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1133 if (ret != 0) {
1134 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1135 return ret;
1136 }
1137
1138 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001139}
Ronald Cron41a443a2022-10-04 16:38:25 +02001140#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001141
Gilles Peskine449bd832023-01-11 14:50:10 +01001142int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1143 unsigned char *buf,
1144 unsigned char *end,
1145 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001146{
1147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1148 unsigned char *p = buf;
1149 size_t ext_len;
1150
1151 *out_len = 0;
1152
1153 /* Write supported_versions extension
1154 *
1155 * Supported Versions Extension is mandatory with TLS 1.3.
1156 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1158 if (ret != 0) {
1159 return ret;
1160 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001161 p += ext_len;
1162
1163 /* Echo the cookie if the server provided one in its preceding
1164 * HelloRetryRequest message.
1165 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1167 if (ret != 0) {
1168 return ret;
1169 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001170 p += ext_len;
1171
Ronald Cron766c0cd2022-10-18 12:17:11 +02001172#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1174 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1175 if (ret != 0) {
1176 return ret;
1177 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001178 p += ext_len;
1179 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001180#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001181
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001182#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1184 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1185 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1186 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1187 if (ret != 0) {
1188 return ret;
1189 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001190 p += ext_len;
1191
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001192 /* Initializes the status to `rejected`. It will be updated to
1193 * `accepted` if the EncryptedExtension message contain an early data
1194 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001195 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001196 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 } else {
1198 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001199 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001200 }
1201#endif /* MBEDTLS_SSL_EARLY_DATA */
1202
Ronald Cron41a443a2022-10-04 16:38:25 +02001203#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001204 /* For PSK-based key exchange we need the pre_shared_key extension
1205 * and the psk_key_exchange_modes extension.
1206 *
1207 * The pre_shared_key extension MUST be the last extension in the
1208 * ClientHello. Servers MUST check that it is the last extension and
1209 * otherwise fail the handshake with an "illegal_parameter" alert.
1210 *
1211 * Add the psk_key_exchange_modes extension.
1212 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1214 if (ret != 0) {
1215 return ret;
1216 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001217 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001218#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001219
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001220 *out_len = p - buf;
1221
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001223}
1224
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00001225int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl)
Xiaokang Qian126929f2023-01-03 10:29:41 +00001226{
Xiaokang Qian90746132023-01-06 05:54:59 +00001227 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001228
Xiaokang Qian126929f2023-01-03 10:29:41 +00001229#if defined(MBEDTLS_SSL_EARLY_DATA)
1230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1231 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1232 const unsigned char *psk;
1233 size_t psk_len;
1234 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001235
Xiaokang Qian126929f2023-01-03 10:29:41 +00001236 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
Xiaokang Qian6be82902023-02-03 06:04:43 +00001237#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1238 mbedtls_ssl_handshake_set_state(
1239 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1240#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00001241 MBEDTLS_SSL_DEBUG_MSG(
1242 1, ("Set hs psk for early data when writing the first psk"));
1243
1244 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1245 if (ret != 0) {
1246 MBEDTLS_SSL_DEBUG_RET(
1247 1, "ssl_tls13_ticket_get_psk", ret);
1248 return ret;
1249 }
1250
1251 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1252 if (ret != 0) {
1253 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1254 return ret;
1255 }
1256
Xiaokang Qian64bc9bc2023-02-07 02:32:23 +00001257 /*
1258 * Early data are going to be encrypted using the ciphersuite
1259 * associated with the pre-shared key used for the handshake.
1260 * Note that if the server rejects early data, the handshake
1261 * based on the pre-shared key may complete successfully
1262 * with a selected ciphersuite different from the ciphersuite
1263 * associated with the pre-shared key. Only the hashes of the
1264 * two ciphersuites have to be the same. In that case, the
1265 * encrypted handshake data and application data are
1266 * encrypted using a different ciphersuite than the one used for
1267 * the rejected early data.
1268 */
1269
Xiaokang Qian126929f2023-01-03 10:29:41 +00001270 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1271 ssl->session_negotiate->ciphersuite);
1272 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian42242442023-01-12 02:26:17 +00001273 /* Enable psk and psk_ephermal to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001274 ssl->handshake->key_exchange_mode =
1275 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1276
1277 /* Start the TLS 1.3 key schedule:
1278 * Set the PSK and derive early secret.
1279 */
1280 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1281 if (ret != 0) {
1282 MBEDTLS_SSL_DEBUG_RET(1,
1283 "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1284 return ret;
1285 }
1286
1287 /* Derive early data key material */
1288 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1289 if (ret != 0) {
1290 MBEDTLS_SSL_DEBUG_RET(1,
1291 "mbedtls_ssl_tls13_compute_early_transform", ret);
1292 return ret;
1293 }
1294
Xiaokang Qian126929f2023-01-03 10:29:41 +00001295 }
1296#endif /* MBEDTLS_SSL_EARLY_DATA */
1297 return 0;
1298}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001299/*
Jerry Yu4a173382021-10-11 21:45:31 +08001300 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001301 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001302
Ronald Cronda41b382022-03-30 09:57:11 +02001303/**
1304 * \brief Detect if the ServerHello contains a supported_versions extension
1305 * or not.
1306 *
1307 * \param[in] ssl SSL context
1308 * \param[in] buf Buffer containing the ServerHello message
1309 * \param[in] end End of the buffer containing the ServerHello message
1310 *
1311 * \return 0 if the ServerHello does not contain a supported_versions extension
1312 * \return 1 if the ServerHello contains a supported_versions extension
1313 * \return A negative value if an error occurred while parsing the ServerHello.
1314 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001315MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001316static int ssl_tls13_is_supported_versions_ext_present(
1317 mbedtls_ssl_context *ssl,
1318 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001320{
1321 const unsigned char *p = buf;
1322 size_t legacy_session_id_echo_len;
1323 size_t extensions_len;
1324 const unsigned char *extensions_end;
1325
1326 /*
1327 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001328 * length:
1329 * - legacy_version 2 bytes
1330 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1331 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001332 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001334 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1335 legacy_session_id_echo_len = *p;
1336
1337 /*
1338 * Jump to the extensions, jumping over:
1339 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1340 * - cipher_suite 2 bytes
1341 * - legacy_compression_method 1 byte
1342 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1344 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001345
1346 /* Case of no extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 if (p == end) {
1348 return 0;
1349 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001350
1351 /* ...
1352 * Extension extensions<6..2^16-1>;
1353 * ...
1354 * struct {
1355 * ExtensionType extension_type; (2 bytes)
1356 * opaque extension_data<0..2^16-1>;
1357 * } Extension;
1358 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1360 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001361 p += 2;
1362
1363 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001365 extensions_end = p + extensions_len;
1366
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 while (p < extensions_end) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01001368 unsigned int extension_type;
1369 size_t extension_data_len;
1370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1372 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1373 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001374 p += 4;
1375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 if (extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS) {
1377 return 1;
1378 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001381 p += extension_data_len;
1382 }
1383
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 return 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001385}
1386
Jerry Yu7a186a02021-10-15 18:46:14 +08001387/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001388 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1389 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1390 * - 0 otherwise
1391 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001392MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001393static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1394 const unsigned char *buf,
1395 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001396{
1397 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1398 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001399 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001400 const unsigned char *last_eight_bytes_of_random;
1401 unsigned char last_byte_of_random;
1402
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001404 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1405
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 if (memcmp(last_eight_bytes_of_random,
1407 magic_downgrade_string,
1408 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001409 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 return last_byte_of_random == 0 ||
1411 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001412 }
1413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001415}
1416
1417/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001418 * - SSL_SERVER_HELLO or
1419 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001420 * to indicate which message is expected and to be parsed next.
1421 */
Ronald Cron828aff62022-05-31 12:04:31 +02001422#define SSL_SERVER_HELLO 0
1423#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001424MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001425static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1426 const unsigned char *buf,
1427 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001428{
Jerry Yue1b9c292021-09-10 10:08:31 +08001429
1430 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1431 *
Jerry Yu4a173382021-10-11 21:45:31 +08001432 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001433 * special value of the SHA-256 of "HelloRetryRequest".
1434 *
1435 * struct {
1436 * ProtocolVersion legacy_version = 0x0303;
1437 * Random random;
1438 * opaque legacy_session_id_echo<0..32>;
1439 * CipherSuite cipher_suite;
1440 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001441 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001442 * } ServerHello;
1443 *
1444 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end,
1446 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001447
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1449 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1450 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001451 }
1452
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001454}
1455
Ronald Cron828aff62022-05-31 12:04:31 +02001456/*
Jerry Yu745bb612021-10-13 22:01:04 +08001457 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001458 * - SSL_SERVER_HELLO or
1459 * - SSL_SERVER_HELLO_HRR or
1460 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001461 */
Ronald Cron828aff62022-05-31 12:04:31 +02001462#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001463MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001464static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1465 const unsigned char *buf,
1466 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001467{
Jerry Yu4a173382021-10-11 21:45:31 +08001468 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001469 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001470
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1472 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001473
Gilles Peskine449bd832023-01-11 14:50:10 +01001474 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001475 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001477
1478 /* If the server is negotiating TLS 1.2 or below and:
1479 * . we did not propose TLS 1.2 or
1480 * . the server responded it is TLS 1.3 capable but negotiating a lower
1481 * version of the protocol and thus we are under downgrade attack
1482 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1485 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1486 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1487 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001488 }
1489
1490 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001491 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1493 buf, (size_t) (end - buf));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001494
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1496 ret = ssl_tls13_reset_key_share(ssl);
1497 if (ret != 0) {
1498 return ret;
1499 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001500 }
1501
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001503 }
1504
Jerry Yua66fece2022-07-13 14:30:29 +08001505#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1506 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1507 ssl->session_negotiate->tls_version = ssl->tls_version;
1508#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1509
Jerry Yu50e00e32022-10-31 14:45:01 +08001510 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001511
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1513 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001514 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001516 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001517 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
1519 /* If a client receives a second
1520 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1521 * was itself in response to a HelloRetryRequest), it MUST abort the
1522 * handshake with an "unexpected_message" alert.
1523 */
1524 if (handshake->hello_retry_request_count > 0) {
1525 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
1526 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1527 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
1528 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001529 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001530 /*
1531 * Clients must abort the handshake with an "illegal_parameter"
1532 * alert if the HelloRetryRequest would not result in any change
1533 * in the ClientHello.
1534 * In a PSK only key exchange that what we expect.
1535 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1537 MBEDTLS_SSL_DEBUG_MSG(1,
1538 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001539 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1541 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1542 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001543 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001544
Ronald Cron5afb9042022-05-31 12:11:39 +02001545 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001546
Jerry Yu745bb612021-10-13 22:01:04 +08001547 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001548 }
1549
1550cleanup:
1551
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001553}
1554
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001555MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001556static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1557 const unsigned char **buf,
1558 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001559{
1560 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001561 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001562
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1564 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001565
Gilles Peskine449bd832023-01-11 14:50:10 +01001566 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001567
1568 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1570 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1571 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1572 ssl->session_negotiate->id,
1573 ssl->session_negotiate->id_len);
1574 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1575 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001576
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1578 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001581 }
1582
Jerry Yu4a173382021-10-11 21:45:31 +08001583 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001584 *buf = p;
1585
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1587 ssl->session_negotiate->id_len);
1588 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001589}
1590
Jerry Yue1b9c292021-09-10 10:08:31 +08001591/* Parse ServerHello message and configure context
1592 *
1593 * struct {
1594 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1595 * Random random;
1596 * opaque legacy_session_id_echo<0..32>;
1597 * CipherSuite cipher_suite;
1598 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001599 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001600 * } ServerHello;
1601 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001602MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001603static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1604 const unsigned char *buf,
1605 const unsigned char *end,
1606 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001607{
Jerry Yub85277e2021-10-13 13:36:05 +08001608 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001609 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001610 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001611 size_t extensions_len;
1612 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001613 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001614 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001615 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001616 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001617 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001618 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001619
1620 /*
1621 * Check there is space for minimal fields
1622 *
1623 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001624 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001625 * - legacy_session_id_echo ( 1 byte ), minimum size
1626 * - cipher_suite ( 2 bytes)
1627 * - legacy_compression_method ( 1 byte )
1628 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1632 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001633
Jerry Yu4a173382021-10-11 21:45:31 +08001634 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001635 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001636 * ...
1637 * with ProtocolVersion defined as:
1638 * uint16 ProtocolVersion;
1639 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001640 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1641 MBEDTLS_SSL_VERSION_TLS1_2) {
1642 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1643 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1644 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001645 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1646 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001647 }
1648 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001649
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001650 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001651 * Random random;
1652 * ...
1653 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001654 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001655 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 if (!is_hrr) {
1657 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1658 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1659 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1660 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001661 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001662 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001663
Jerry Yu4a173382021-10-11 21:45:31 +08001664 /* ...
1665 * opaque legacy_session_id_echo<0..32>;
1666 * ...
1667 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001669 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001670 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001671 }
1672
Jerry Yu4a173382021-10-11 21:45:31 +08001673 /* ...
1674 * CipherSuite cipher_suite;
1675 * ...
1676 * with CipherSuite defined as:
1677 * uint8 CipherSuite[2];
1678 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001679 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1680 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001681 p += 2;
1682
Jerry Yu4a173382021-10-11 21:45:31 +08001683
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001685 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001686 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001687 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1689 ssl->tls_version,
1690 ssl->tls_version) != 0) ||
1691 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001692 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001693 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001694 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001695 * If we received an HRR before and that the proposed selected
1696 * ciphersuite in this server hello is not the same as the one
1697 * proposed in the HRR, we abort the handshake and send an
1698 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001699 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1701 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001702 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001703 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001704
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1706 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1707 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001708 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001709 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001710
Jerry Yu4a173382021-10-11 21:45:31 +08001711 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001713
XiaokangQian355e09a2022-01-20 11:14:50 +00001714 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1716 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001717
1718#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 ssl->session_negotiate->start = time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001720#endif /* MBEDTLS_HAVE_TIME */
1721
Jerry Yu4a173382021-10-11 21:45:31 +08001722 /* ...
1723 * uint8 legacy_compression_method = 0;
1724 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001725 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1727 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1728 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001729 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001730 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001731 }
1732 p++;
1733
Jerry Yub85277e2021-10-13 13:36:05 +08001734 /* ...
1735 * Extension extensions<6..2^16-1>;
1736 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001737 * struct {
1738 * ExtensionType extension_type; (2 bytes)
1739 * opaque extension_data<0..2^16-1>;
1740 * } Extension;
1741 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1743 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001744 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001745
Jerry Yu4a173382021-10-11 21:45:31 +08001746 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001748 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001751
Jerry Yu50e00e32022-10-31 14:45:01 +08001752 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001753 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1755 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001756
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001758 unsigned int extension_type;
1759 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001760 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1763 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1764 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001765 p += 4;
1766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001768 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001769
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001770 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1772 if (ret != 0) {
1773 return ret;
1774 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001775
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001777 case MBEDTLS_TLS_EXT_COOKIE:
1778
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 ret = ssl_tls13_parse_cookie_ext(ssl,
1780 p, extension_data_end);
1781 if (ret != 0) {
1782 MBEDTLS_SSL_DEBUG_RET(1,
1783 "ssl_tls13_parse_cookie_ext",
1784 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001785 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001786 }
XiaokangQianb851da82022-01-14 04:03:11 +00001787 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001788
Jerry Yue1b9c292021-09-10 10:08:31 +08001789 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1791 p,
1792 extension_data_end);
1793 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001794 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001796 break;
1797
Ronald Cron41a443a2022-10-04 16:38:25 +02001798#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001799 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001801
Gilles Peskine449bd832023-01-11 14:50:10 +01001802 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1803 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001804 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1806 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001807 }
1808 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001809#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001810
Jerry Yue1b9c292021-09-10 10:08:31 +08001811 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1813 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001814 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001815 goto cleanup;
1816 }
1817
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 if (is_hrr) {
1819 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1820 p, extension_data_end);
1821 } else {
1822 ret = ssl_tls13_parse_key_share_ext(ssl,
1823 p, extension_data_end);
1824 }
1825 if (ret != 0) {
1826 MBEDTLS_SSL_DEBUG_RET(1,
1827 "ssl_tls13_parse_key_share_ext",
1828 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001829 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001830 }
1831 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001832
1833 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001834 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1835 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001836 }
1837
1838 p += extension_data_len;
1839 }
1840
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001842
XiaokangQiand59be772022-01-24 10:12:51 +00001843cleanup:
1844
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1846 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1847 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001848 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1850 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1851 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001852 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1853 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001855}
1856
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001857#if defined(MBEDTLS_DEBUG_C)
1858static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001859{
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001861 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1862 return "psk";
1863 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1864 return "ephemeral";
1865 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1866 return "psk_ephemeral";
1867 default:
1868 return "unknown mode";
1869 }
1870}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001871#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001872
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001873MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001874static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001875{
Jerry Yub85277e2021-10-13 13:36:05 +08001876 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001877 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001878
Jerry Yub85277e2021-10-13 13:36:05 +08001879 /* Determine the key exchange mode:
1880 * 1) If both the pre_shared_key and key_share extensions were received
1881 * then the key exchange mode is PSK with EPHEMERAL.
1882 * 2) If only the pre_shared_key extension was received then the key
1883 * exchange mode is PSK-only.
1884 * 3) If only the key_share extension was received then the key
1885 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001886 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001887 switch (handshake->received_extensions &
1888 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001889 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Ronald Cron79907712022-07-20 17:05:29 +02001891 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001892 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001893
Jerry Yu745bb612021-10-13 22:01:04 +08001894 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Ronald Cron79907712022-07-20 17:05:29 +02001896 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001897 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001898
Jerry Yu745bb612021-10-13 22:01:04 +08001899 /* Both the pre_shared_key and key_share extensions were received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
Ronald Cron79907712022-07-20 17:05:29 +02001901 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001902 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001903
Jerry Yu745bb612021-10-13 22:01:04 +08001904 /* Neither pre_shared_key nor key_share extension was received */
1905 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001907 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1908 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001909 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001910#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001911 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1912 (handshake->selected_identity != 0 ||
1913 handshake->ciphersuite_info->id !=
1914 ssl->session_negotiate->ciphersuite)) {
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001915 /* RFC8446 4.2.11
1916 * If the server supplies an "early_data" extension, the
1917 * client MUST verify that the server's selected_identity
1918 * is 0. If any other value is returned, the client MUST
1919 * abort the handshake with an "illegal_parameter" alert.
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001920 *
Xiaokang Qian53c4c272023-02-07 02:42:01 +00001921 * RFC 8446 4.2.10
1922 * In order to accept early data, the server MUST have accepted a PSK
1923 * cipher suite and selected the first key offered in the client's
1924 * "pre_shared_key" extension. In addition, it MUST verify that the
1925 * following values are the same as those associated with the
1926 * selected PSK:
1927 * - The TLS version number
1928 * - The selected cipher suite
1929 * - The selected ALPN [RFC7301] protocol, if any (not checked yet)
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001930 */
1931 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1932 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1933 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1934 }
1935#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001936
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 if (!mbedtls_ssl_conf_tls13_check_kex_modes(ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001938 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01001939 MBEDTLS_SSL_DEBUG_MSG(2,
1940 ("Key exchange mode(%s) is not supported.",
1941 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001942 goto cleanup;
1943 }
1944
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 MBEDTLS_SSL_DEBUG_MSG(3,
1946 ("Selected key exchange mode: %s",
1947 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001948
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001949 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001950 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001951 * If we proposed early data then we have already derived an
1952 * early secret using the selected PSK and its associated hash.
1953 * It means that if the negotiated key exchange mode is psk or
1954 * psk_ephemeral, we have already correctly computed the
1955 * early secret and thus we do not do it again. In all other
1956 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001957 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001958#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001959 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1960 handshake->key_exchange_mode ==
1961 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001962#endif
1963 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001964 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1965 if (ret != 0) {
1966 MBEDTLS_SSL_DEBUG_RET(
1967 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1968 goto cleanup;
1969 }
Jerry Yu0b177842021-09-05 19:41:30 +08001970 }
1971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1973 if (ret != 0) {
1974 MBEDTLS_SSL_DEBUG_RET(1,
1975 "mbedtls_ssl_tls13_compute_handshake_transform",
1976 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001977 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001978 }
1979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1981 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001982 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
Jerry Yu0b177842021-09-05 19:41:30 +08001983 ssl->session_in = ssl->session_negotiate;
1984
Jerry Yu4a173382021-10-11 21:45:31 +08001985cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001987 MBEDTLS_SSL_PEND_FATAL_ALERT(
1988 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001990 }
Jerry Yue110d252022-05-05 10:19:22 +08001991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001993}
1994
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001995MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001996static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00001997{
1998 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00002001
XiaokangQian78b1fa72022-01-19 06:56:30 +00002002 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00002003 * We are going to re-generate a shared secret corresponding to the group
2004 * selected by the server, which is different from the group for which we
2005 * generated a shared secret in the first client hello.
2006 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00002007 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 ret = ssl_tls13_reset_key_share(ssl);
2009 if (ret != 0) {
2010 return ret;
2011 }
XiaokangQian647719a2021-12-07 09:16:29 +00002012
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00002013 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002015}
2016
Jerry Yue1b9c292021-09-10 10:08:31 +08002017/*
Jerry Yu4a173382021-10-11 21:45:31 +08002018 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002019 * Handler for MBEDTLS_SSL_SERVER_HELLO
2020 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002021MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002022static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002023{
Jerry Yu4a173382021-10-11 21:45:31 +08002024 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002025 unsigned char *buf = NULL;
2026 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002027 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002028
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002030
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2032 MBEDTLS_SSL_HS_SERVER_HELLO,
2033 &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2036 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002037 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 } else {
2039 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2040 }
XiaokangQiand59be772022-01-24 10:12:51 +00002041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002043 ret = 0;
2044 goto cleanup;
2045 }
2046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2048 buf + buf_len,
2049 is_hrr));
2050 if (is_hrr) {
2051 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002052 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002053
2054 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2055 buf, buf_len);
2056
2057 if (is_hrr) {
2058 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2059#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2060 /* If not offering early data, the client sends a dummy CCS record
2061 * immediately before its second flight. This may either be before
2062 * its second ClientHello or before its encrypted handshake flight.
2063 */
2064 mbedtls_ssl_handshake_set_state(ssl,
2065 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
2066#else
2067 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2068#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2069 } else {
2070 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2071 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002072 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002073
2074cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2076 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2077 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002078}
2079
2080/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002081 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002082 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002083 *
2084 * The EncryptedExtensions message contains any extensions which
2085 * should be protected, i.e., any which are not needed to establish
2086 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002087 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002088
XiaokangQian08da26c2021-10-09 10:12:11 +00002089/* Parse EncryptedExtensions message
2090 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002091 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002092 * } EncryptedExtensions;
2093 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002094MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002095static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2096 const unsigned char *buf,
2097 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002098{
2099 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002100 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002101 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002102 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002103 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2106 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002107 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002108
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2110 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002111 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002112
Jerry Yu9eba7502022-10-31 13:46:16 +08002113 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002114
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002116 unsigned int extension_type;
2117 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002118
XiaokangQian08da26c2021-10-09 10:12:11 +00002119 /*
2120 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002121 * ExtensionType extension_type; (2 bytes)
2122 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002123 * } Extension;
2124 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2126 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2127 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002128 p += 4;
2129
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002131
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002132 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2134 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2135 if (ret != 0) {
2136 return ret;
2137 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002140#if defined(MBEDTLS_SSL_ALPN)
2141 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002143
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 if ((ret = ssl_tls13_parse_alpn_ext(ssl, p, (size_t) extension_data_len)) != 0) {
2145 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002146 }
2147
2148 break;
2149#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002150
2151#if defined(MBEDTLS_SSL_EARLY_DATA)
2152 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002153
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002155 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2157 MBEDTLS_ERR_SSL_DECODE_ERROR);
2158 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002159 }
2160
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002161 break;
2162#endif /* MBEDTLS_SSL_EARLY_DATA */
2163
XiaokangQian08da26c2021-10-09 10:12:11 +00002164 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002165 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002166 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002168 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002169 }
2170
XiaokangQian08da26c2021-10-09 10:12:11 +00002171 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002172 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002173
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2175 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002176
XiaokangQian97799ac2021-10-11 10:05:54 +00002177 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if (p != end) {
2179 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2180 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2181 MBEDTLS_ERR_SSL_DECODE_ERROR);
2182 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002183 }
2184
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002186}
2187
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002188MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002189static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002190{
2191 int ret;
2192 unsigned char *buf;
2193 size_t buf_len;
2194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002196
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2198 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2199 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002200
2201 /* Process the message contents */
2202 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002204
Xiaokang Qianb157e912022-11-23 08:12:26 +00002205#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 if (ssl->handshake->received_extensions &
2207 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002208 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2209 }
2210#endif
2211
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2213 buf, buf_len);
Ronald Cron9d6a5452022-05-30 16:05:38 +02002214
Ronald Cron928cbd32022-10-04 16:14:26 +02002215#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2217 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2218 } else {
2219 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2220 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002221#else
2222 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002224#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002225
2226cleanup:
2227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2229 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002230
2231}
2232
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002233/*
2234 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2235 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002236 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002237 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002238 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002239 *
2240 * If the server sent an "early_data" extension in EncryptedExtensions, the
2241 * client MUST send an EndOfEarlyData message after receiving the server
2242 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002243 */
2244
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002245MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002246static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2247{
2248 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002249 unsigned char *buf = NULL;
2250 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002251 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002252
Xiaokang Qian742578c2022-12-19 06:34:44 +00002253 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2254 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002255
Xiaokang Qian742578c2022-12-19 06:34:44 +00002256 mbedtls_ssl_add_hs_hdr_to_checksum(
2257 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002258
Xiaokang Qian742578c2022-12-19 06:34:44 +00002259 MBEDTLS_SSL_PROC_CHK(
2260 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002261
Xiaokang Qian19d44162023-01-03 03:39:50 +00002262 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002263
2264cleanup:
2265
2266 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2267 return ret;
2268}
2269
Ronald Cron928cbd32022-10-04 16:14:26 +02002270#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002271/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002272 * STATE HANDLING: CertificateRequest
2273 *
Jerry Yud2674312021-10-29 10:08:19 +08002274 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002275#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2276#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002277/* Coordination:
2278 * Deals with the ambiguity of not knowing if a CertificateRequest
2279 * will be sent. Returns a negative code on failure, or
2280 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2281 * - SSL_CERTIFICATE_REQUEST_SKIP
2282 * indicating if a Certificate Request is expected or not.
2283 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002284MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002285static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002286{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002287 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002288
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2290 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2291 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002292 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002293 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002294
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2296 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2297 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2298 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002299 }
2300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002304}
2305
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002306/*
2307 * ssl_tls13_parse_certificate_request()
2308 * Parse certificate request
2309 * struct {
2310 * opaque certificate_request_context<0..2^8-1>;
2311 * Extension extensions<2..2^16-1>;
2312 * } CertificateRequest;
2313 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002314MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002315static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2316 const unsigned char *buf,
2317 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002318{
2319 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2320 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002321 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002322 size_t extensions_len = 0;
2323 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002324 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002325
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002326 /* ...
2327 * opaque certificate_request_context<0..2^8-1>
2328 * ...
2329 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002331 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002332 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002333
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 if (certificate_request_context_len > 0) {
2335 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2336 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2337 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002338
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002339 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 mbedtls_calloc(1, certificate_request_context_len);
2341 if (handshake->certificate_request_context == NULL) {
2342 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2343 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002344 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 memcpy(handshake->certificate_request_context, p,
2346 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002347 p += certificate_request_context_len;
2348 }
2349
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002350 /* ...
2351 * Extension extensions<2..2^16-1>;
2352 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2355 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002356 p += 2;
2357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002359 extensions_end = p + extensions_len;
2360
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002361 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002362
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002364 unsigned int extension_type;
2365 size_t extension_data_len;
2366
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2368 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2369 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002370 p += 4;
2371
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002373
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002374 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2376 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2377 if (ret != 0) {
2378 return ret;
2379 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002380
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002382 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 MBEDTLS_SSL_DEBUG_MSG(3,
2384 ("found signature algorithms extension"));
2385 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2386 p + extension_data_len);
2387 if (ret != 0) {
2388 return ret;
2389 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002390
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002391 break;
2392
2393 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002394 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002395 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002397 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002398 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002399
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002400 p += extension_data_len;
2401 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2404 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002405
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002406 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 if (p != end) {
2408 MBEDTLS_SSL_DEBUG_MSG(1,
2409 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002410 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002411 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002412
Jerry Yu0c354a22022-08-29 15:25:36 +08002413 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002414 *
2415 * The "signature_algorithms" extension MUST be specified
2416 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2418 MBEDTLS_SSL_DEBUG_MSG(3,
2419 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002420 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002421 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002422
Jerry Yu7840f812022-01-29 10:26:51 +08002423 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002425
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002426decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2428 MBEDTLS_ERR_SSL_DECODE_ERROR);
2429 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002430}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002431
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002432/*
2433 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2434 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002435MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002436static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002437{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002438 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002439
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002441
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002445 unsigned char *buf;
2446 size_t buf_len;
2447
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2449 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2450 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(ssl,
2453 buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2456 buf, buf_len);
2457 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002458 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 } else {
2460 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002461 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2462 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002463 }
2464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002466
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002467cleanup:
2468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2470 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002471}
2472
2473/*
Jerry Yu687101b2021-09-14 16:03:56 +08002474 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2475 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002476MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002477static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002478{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002479 int ret;
2480
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2482 if (ret != 0) {
2483 return ret;
2484 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002485
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2487 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002488}
2489
2490/*
2491 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2492 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002493MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002494static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002495{
Jerry Yu30b071c2021-09-12 20:16:03 +08002496 int ret;
2497
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2499 if (ret != 0) {
2500 return ret;
2501 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002502
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2504 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002505}
Ronald Cron928cbd32022-10-04 16:14:26 +02002506#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002507
Jerry Yu687101b2021-09-14 16:03:56 +08002508/*
2509 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2510 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002511MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002512static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002513{
XiaokangQianac0385c2021-11-03 06:40:11 +00002514 int ret;
2515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2517 if (ret != 0) {
2518 return ret;
2519 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2522 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002523 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2525 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2526 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002527 }
2528
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002529#if defined(MBEDTLS_SSL_EARLY_DATA)
2530 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2531 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002532 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2533 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002534 } else
2535#endif /* MBEDTLS_SSL_EARLY_DATA */
2536 {
2537#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2538 mbedtls_ssl_handshake_set_state(
2539 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2540#else
2541 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2542#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2543 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002544
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002546}
2547
2548/*
Jerry Yu566c7812022-01-26 15:41:22 +08002549 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2550 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002551MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002552static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002553{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002554 int non_empty_certificate_msg = 0;
2555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 MBEDTLS_SSL_DEBUG_MSG(1,
2557 ("Switch to handshake traffic keys for outbound traffic"));
2558 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002559
Ronald Cron928cbd32022-10-04 16:14:26 +02002560#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 if (ssl->handshake->client_auth) {
2562 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2563 if (ret != 0) {
2564 return ret;
2565 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002568 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 }
2570 } else {
2571 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002572 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002573#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 if (non_empty_certificate_msg) {
2576 mbedtls_ssl_handshake_set_state(ssl,
2577 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2578 } else {
2579 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2580 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2581 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002582
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002584}
2585
Ronald Cron928cbd32022-10-04 16:14:26 +02002586#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002587/*
2588 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2589 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002590MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002591static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002592{
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002594
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 if (ret == 0) {
2596 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2597 }
Ronald Crona8b38872022-03-09 07:59:25 +01002598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002600}
Ronald Cron928cbd32022-10-04 16:14:26 +02002601#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002602
2603/*
Jerry Yu687101b2021-09-14 16:03:56 +08002604 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2605 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002606MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002607static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002608{
XiaokangQian0fa66432021-11-15 03:33:57 +00002609 int ret;
2610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2612 if (ret != 0) {
2613 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002614 }
2615
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2617 if (ret != 0) {
2618 MBEDTLS_SSL_DEBUG_RET(1,
2619 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
2620 return ret;
2621 }
2622
2623 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2624 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002625}
2626
2627/*
2628 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2629 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002630MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002631static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002632{
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2634 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2635 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002636}
2637
2638/*
2639 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2640 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002641MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002642static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002643{
Jerry Yu378254d2021-10-30 21:44:47 +08002644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2648 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002649}
2650
Jerry Yuf8a49942022-07-07 11:32:32 +00002651#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2652
Jerry Yua0446a02022-07-13 11:22:55 +08002653MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002654static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2655 const unsigned char *buf,
2656 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002657{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002658 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002659 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002660
Jerry Yuf8a49942022-07-07 11:32:32 +00002661
Jerry Yuedab6372022-10-31 14:37:31 +08002662 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002665 unsigned int extension_type;
2666 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002667 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2670 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2671 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002672 p += 4;
2673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002675
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002676 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2678 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2679 if (ret != 0) {
2680 return ret;
2681 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002684#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002685 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002687 MBEDTLS_SSL_PEND_FATAL_ALERT(
2688 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 MBEDTLS_ERR_SSL_DECODE_ERROR);
2690 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002691 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002693 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002695 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002696 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002697#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002698
Jerry Yuf8a49942022-07-07 11:32:32 +00002699 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002700 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002701 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002703 break;
2704 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002705
Jerry Yuf8a49942022-07-07 11:32:32 +00002706 p += extension_data_len;
2707 }
2708
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2710 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002713}
2714
2715/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002716 * From RFC8446, page 74
2717 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002718 * struct {
2719 * uint32 ticket_lifetime;
2720 * uint32 ticket_age_add;
2721 * opaque ticket_nonce<0..255>;
2722 * opaque ticket<1..2^16-1>;
2723 * Extension extensions<0..2^16-2>;
2724 * } NewSessionTicket;
2725 *
2726 */
Jerry Yua0446a02022-07-13 11:22:55 +08002727MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002728static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2729 unsigned char *buf,
2730 unsigned char *end,
2731 unsigned char **ticket_nonce,
2732 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002733{
2734 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2735 unsigned char *p = buf;
2736 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002737 size_t ticket_len;
2738 unsigned char *ticket;
2739 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002740
Jerry Yucb3b1392022-07-12 06:09:38 +00002741 *ticket_nonce = NULL;
2742 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002743 /*
2744 * ticket_lifetime 4 bytes
2745 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002746 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2751 MBEDTLS_SSL_DEBUG_MSG(3,
2752 ("ticket_lifetime: %u",
2753 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2756 MBEDTLS_SSL_DEBUG_MSG(3,
2757 ("ticket_age_add: %u",
2758 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002759
Jerry Yucb3b1392022-07-12 06:09:38 +00002760 *ticket_nonce_len = p[8];
2761 p += 9;
2762
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002764 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002766 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002767
2768 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2770 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002771 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2773 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002774
2775 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 if (session->ticket != NULL || session->ticket_len > 0) {
2777 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002778 session->ticket = NULL;
2779 session->ticket_len = 0;
2780 }
2781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2783 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2784 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002785 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002787 p += ticket_len;
2788 session->ticket = ticket;
2789 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002790
Pengyu Lv9f926952022-11-17 15:22:33 +08002791 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002792 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002793 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2796 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002797 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002801
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2803 if (ret != 0) {
2804 MBEDTLS_SSL_DEBUG_RET(1,
2805 "ssl_tls13_parse_new_session_ticket_exts",
2806 ret);
2807 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002808 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002809
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002810 /* session has been updated, allow export */
2811 session->exported = 0;
2812
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002814}
2815
Jerry Yua0446a02022-07-13 11:22:55 +08002816MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002817static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2818 unsigned char *ticket_nonce,
2819 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002820{
2821 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2822 mbedtls_ssl_session *session = ssl->session;
2823 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2824 psa_algorithm_t psa_hash_alg;
2825 int hash_length;
2826
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002827#if defined(MBEDTLS_HAVE_TIME)
2828 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002830#endif
2831
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2833 if (ciphersuite_info == NULL) {
2834 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2835 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002836 }
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2839 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2840 if (hash_length == -1 ||
2841 (size_t) hash_length > sizeof(session->resumption_key)) {
2842 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002843 }
2844
Jerry Yuf8a49942022-07-07 11:32:32 +00002845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2847 session->app_secrets.resumption_master_secret,
2848 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002849
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002850 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002851 *
2852 * HKDF-Expand-Label( resumption_master_secret,
2853 * "resumption", ticket_nonce, Hash.length )
2854 */
2855 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 psa_hash_alg,
2857 session->app_secrets.resumption_master_secret,
2858 hash_length,
2859 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2860 ticket_nonce,
2861 ticket_nonce_len,
2862 session->resumption_key,
2863 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002864
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 if (ret != 0) {
2866 MBEDTLS_SSL_DEBUG_RET(2,
2867 "Creating the ticket-resumed PSK failed",
2868 ret);
2869 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002870 }
2871
Jerry Yu0a430c82022-07-20 11:02:48 +08002872 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2875 session->resumption_key,
2876 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002877
Pengyu Lv9f926952022-11-17 15:22:33 +08002878 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002879 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002880 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002881 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002882
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002884}
2885
2886/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002887 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002888 */
Jerry Yua0446a02022-07-13 11:22:55 +08002889MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002890static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002891{
2892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2893 unsigned char *buf;
2894 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002895 unsigned char *ticket_nonce;
2896 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002899
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2901 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2902 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002903
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2905 ssl, buf, buf + buf_len,
2906 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2909 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002912
Jerry Yuf8a49942022-07-07 11:32:32 +00002913cleanup:
2914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2916 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002917}
2918#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2919
Gilles Peskine449bd832023-01-11 14:50:10 +01002920int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002921{
Jerry Yu92c6b402021-08-27 16:59:09 +08002922 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002925 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002927 break;
2928
Jerry Yu92c6b402021-08-27 16:59:09 +08002929 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002931 break;
2932
2933 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002935 break;
2936
2937 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002939 break;
2940
Ronald Cron928cbd32022-10-04 16:14:26 +02002941#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002942 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002944 break;
2945
Jerry Yu687101b2021-09-14 16:03:56 +08002946 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002948 break;
2949
2950 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002952 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002953#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002954
2955 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002957 break;
2958
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002959 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2960 ret = ssl_tls13_write_end_of_early_data(ssl);
2961 break;
2962
Jerry Yu566c7812022-01-26 15:41:22 +08002963 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002965 break;
2966
Ronald Cron928cbd32022-10-04 16:14:26 +02002967#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002968 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002970 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002971#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002972
Jerry Yu687101b2021-09-14 16:03:56 +08002973 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002975 break;
2976
2977 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002979 break;
2980
2981 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002983 break;
2984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 /*
2986 * Injection of dummy-CCS's for middlebox compatibility
2987 */
Ronald Cron49ad6192021-11-24 16:25:31 +01002988#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002989 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2991 if (ret == 0) {
2992 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2993 }
Ronald Cron9f55f632022-02-02 16:02:47 +01002994 break;
2995
2996 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2998 if (ret == 0) {
2999 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
3000 }
Ronald Cron49ad6192021-11-24 16:25:31 +01003001 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003002
Xiaokang Qian592021a2023-01-04 10:47:05 +00003003 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3004 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3005 if (ret == 0) {
3006 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3007
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003008#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003009 MBEDTLS_SSL_DEBUG_MSG(
3010 1, ("Switch to early data keys for outbound traffic"));
3011 mbedtls_ssl_set_outbound_transform(
3012 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003013#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003014 }
3015 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003016#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3017
Jerry Yuf8a49942022-07-07 11:32:32 +00003018#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003019 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 ret = ssl_tls13_process_new_session_ticket(ssl);
3021 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003022 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003024 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3025 break;
3026#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3027
Jerry Yu92c6b402021-08-27 16:59:09 +08003028 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3030 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003031 }
3032
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003034}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003035
Jerry Yufb4b6472022-01-27 15:03:26 +08003036#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */