blob: 8f143498fd7ecef2afe76d28775c84ac8bd43021 [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"
Przemek Stekielc89f3ea2023-05-18 15:45:53 +020036#include "mbedtls/dhm.h"
Jerry Yubdc71882021-09-14 19:30:36 +080037
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050038#define PSA_TO_MBEDTLS_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
39 psa_to_ssl_errors, \
40 psa_generic_status_to_mbedtls)
41
Jerry Yubc20bdd2021-08-24 15:59:48 +080042/* Write extensions */
43
Jerry Yu92c6b402021-08-27 16:59:09 +080044/*
45 * ssl_tls13_write_supported_versions_ext():
46 *
47 * struct {
48 * ProtocolVersion versions<2..254>;
49 * } SupportedVersions;
50 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020051MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010052static int ssl_tls13_write_supported_versions_ext(mbedtls_ssl_context *ssl,
53 unsigned char *buf,
54 unsigned char *end,
55 size_t *out_len)
Jerry Yu92c6b402021-08-27 16:59:09 +080056{
57 unsigned char *p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +010058 unsigned char versions_len = (ssl->handshake->min_tls_version <=
59 MBEDTLS_SSL_VERSION_TLS1_2) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080060
Xiaofei Baid25fab62021-12-02 06:36:27 +000061 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080062
Gilles Peskine449bd832023-01-11 14:50:10 +010063 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding supported versions extension"));
Jerry Yu92c6b402021-08-27 16:59:09 +080064
Jerry Yu388bd0d2021-09-15 18:41:02 +080065 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080066 * - extension_type (2 bytes)
67 * - extension_data_length (2 bytes)
68 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020069 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080070 */
Gilles Peskine449bd832023-01-11 14:50:10 +010071 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 5 + versions_len);
Ronald Crondbe87f02022-02-10 14:35:27 +010072
Gilles Peskine449bd832023-01-11 14:50:10 +010073 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0);
74 MBEDTLS_PUT_UINT16_BE(versions_len + 1, p, 2);
Jerry Yueecfbf02021-08-30 18:32:07 +080075 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080076
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080077 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010078 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080079
Jerry Yu0c63af62021-09-02 12:59:12 +080080 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080081 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010082 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080083 */
Gilles Peskine449bd832023-01-11 14:50:10 +010084 mbedtls_ssl_write_version(p, MBEDTLS_SSL_TRANSPORT_STREAM,
85 MBEDTLS_SSL_VERSION_TLS1_3);
86 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:4]"));
Jerry Yu92c6b402021-08-27 16:59:09 +080087
Jerry Yu92c6b402021-08-27 16:59:09 +080088
Gilles Peskine449bd832023-01-11 14:50:10 +010089 if (ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
90 mbedtls_ssl_write_version(p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
91 MBEDTLS_SSL_VERSION_TLS1_2);
92 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:3]"));
Ronald Crondbe87f02022-02-10 14:35:27 +010093 }
94
95 *out_len = 5 + versions_len;
Jerry Yu4b8f2f72022-10-31 13:31:22 +080096
Jerry Yuc4bf5d62022-10-29 09:08:47 +080097 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +010098 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yu4b8f2f72022-10-31 13:31:22 +080099
Gilles Peskine449bd832023-01-11 14:50:10 +0100100 return 0;
Jerry Yu92c6b402021-08-27 16:59:09 +0800101}
Jerry Yubc20bdd2021-08-24 15:59:48 +0800102
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200103MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100104static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
105 const unsigned char *buf,
106 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800107{
Jerry Yue1b9c292021-09-10 10:08:31 +0800108 ((void) ssl);
109
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
111 if (mbedtls_ssl_read_version(buf, ssl->conf->transport) !=
112 MBEDTLS_SSL_VERSION_TLS1_3) {
113 MBEDTLS_SSL_DEBUG_MSG(1, ("unexpected version"));
Jerry Yu4a173382021-10-11 21:45:31 +0800114
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
116 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
117 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +0800118 }
119
Gilles Peskine449bd832023-01-11 14:50:10 +0100120 if (&buf[2] != end) {
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000121 MBEDTLS_SSL_DEBUG_MSG(
122 1, ("supported_versions ext data length incorrect"));
Gilles Peskine449bd832023-01-11 14:50:10 +0100123 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
124 MBEDTLS_ERR_SSL_DECODE_ERROR);
125 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Ronald Cron98473382022-03-30 20:04:10 +0200126 }
127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +0800129}
130
lhuang0486cacac2022-01-21 07:34:27 -0800131#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200132MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100133static int ssl_tls13_parse_alpn_ext(mbedtls_ssl_context *ssl,
134 const unsigned char *buf, size_t len)
lhuang0486cacac2022-01-21 07:34:27 -0800135{
lhuang0486cacac2022-01-21 07:34:27 -0800136 const unsigned char *p = buf;
137 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200138 size_t protocol_name_list_len, protocol_name_len;
139 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800140
141 /* If we didn't send it, the server shouldn't send it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 if (ssl->conf->alpn_list == NULL) {
143 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
144 }
lhuang0486cacac2022-01-21 07:34:27 -0800145
146 /*
147 * opaque ProtocolName<1..2^8-1>;
148 *
149 * struct {
150 * ProtocolName protocol_name_list<2..2^16-1>
151 * } ProtocolNameList;
152 *
153 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
154 */
155
Gilles Peskine449bd832023-01-11 14:50:10 +0100156 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
157 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
lhuang0486cacac2022-01-21 07:34:27 -0800158 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
Ronald Cron81a334f2022-05-31 16:04:11 +0200161 protocol_name_list_end = p + protocol_name_list_len;
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, 1);
Ronald Cron81a334f2022-05-31 16:04:11 +0200164 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800165
166 /* Check that the server chosen protocol was in our list and save it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100167 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, protocol_name_len);
168 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
169 if (protocol_name_len == strlen(*alpn) &&
170 memcmp(p, *alpn, protocol_name_len) == 0) {
lhuang0486cacac2022-01-21 07:34:27 -0800171 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +0100172 return 0;
lhuang0486cacac2022-01-21 07:34:27 -0800173 }
174 }
175
Gilles Peskine449bd832023-01-11 14:50:10 +0100176 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
lhuang0486cacac2022-01-21 07:34:27 -0800177}
178#endif /* MBEDTLS_SSL_ALPN */
179
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200180MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100181static int ssl_tls13_reset_key_share(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +0000182{
183 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100184
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 if (group_id == 0) {
186 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
187 }
XiaokangQian647719a2021-12-07 09:16:29 +0000188
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200189#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
190 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) ||
191 mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100192 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
193 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
194
195 /* Destroy generated private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 status = psa_destroy_key(ssl->handshake->ecdh_psa_privkey);
197 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500198 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100199 MBEDTLS_SSL_DEBUG_RET(1, "psa_destroy_key", ret);
200 return ret;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100201 }
202
203 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 return 0;
205 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200206#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 if (0 /* other KEMs? */) {
XiaokangQian647719a2021-12-07 09:16:29 +0000208 /* Do something */
209 }
210
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQian647719a2021-12-07 09:16:29 +0000212}
213
214/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800215 * Functions for writing key_share extension.
216 */
Ronald Cron766c0cd2022-10-18 12:17:11 +0200217#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200218MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100219static int ssl_tls13_get_default_group_id(mbedtls_ssl_context *ssl,
220 uint16_t *group_id)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800221{
222 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
223
Jerry Yu56fc07f2021-09-01 17:48:49 +0800224
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200225#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Jerry Yu388bd0d2021-09-15 18:41:02 +0800227 /* Pick first available ECDHE group compatible with TLS 1.3 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 if (group_list == NULL) {
229 return MBEDTLS_ERR_SSL_BAD_CONFIG;
230 }
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200231#if defined(PSA_WANT_ALG_FFDH)
232 if (*group_list >= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 &&
233 *group_list <= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192) {
234 *group_id = *group_list;
235 return 0;
236 }
237#endif /* PSA_WANT_ALG_FFDH */
238#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 for (; *group_list != 0; group_list++) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000240 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
241 *group_list, NULL, NULL) == PSA_SUCCESS) &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
Brett Warren14efd332021-10-06 09:32:11 +0100243 *group_id = *group_list;
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800245 }
246 }
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200247#endif /* PSA_WANT_ALG_ECDH */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800248#else
249 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800250 ((void) group_id);
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200251#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800252
253 /*
254 * Add DHE named groups here.
Jerry Yu388bd0d2021-09-15 18:41:02 +0800255 * Pick first available DHE group compatible with TLS 1.3
Jerry Yu56fc07f2021-09-01 17:48:49 +0800256 */
257
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800259}
260
261/*
262 * ssl_tls13_write_key_share_ext
263 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800264 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800265 *
266 * struct {
267 * NamedGroup group;
268 * opaque key_exchange<1..2^16-1>;
269 * } KeyShareEntry;
270 * struct {
271 * KeyShareEntry client_shares<0..2^16-1>;
272 * } KeyShareClientHello;
273 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200274MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100275static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
276 unsigned char *buf,
277 unsigned char *end,
278 size_t *out_len)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800279{
280 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000281 unsigned char *client_shares; /* Start of client_shares */
282 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800283 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800284 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
285
Xiaofei Baid25fab62021-12-02 06:36:27 +0000286 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800287
Jerry Yub60e3cf2021-09-08 16:41:02 +0800288 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800289 * - extension_type (2 bytes)
290 * - extension_data_length (2 bytes)
291 * - client_shares_length (2 bytes)
292 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800294 p += 6;
295
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello: adding key share extension"));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800297
298 /* HRR could already have requested something else. */
299 group_id = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (!mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) &&
301 !mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
302 MBEDTLS_SSL_PROC_CHK(ssl_tls13_get_default_group_id(ssl,
303 &group_id));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800304 }
305
306 /*
307 * Dispatch to type-specific key generation function.
308 *
309 * So far, we're only supporting ECDHE. With the introduction
310 * of PQC KEMs, we'll want to have multiple branches, one per
311 * type of KEM, and dispatch to the corresponding crypto. And
312 * only one key share entry is allowed.
313 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000314 client_shares = p;
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200315#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
316 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) ||
317 mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800318 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000319 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800320 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100321 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800322
323 /* Check there is space for header of KeyShareEntry
324 * - group (2 bytes)
325 * - key_exchange_length (2 bytes)
326 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800328 p += 4;
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200329#if defined(PSA_WANT_ALG_ECDH)
330 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
331 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
332 ssl, group_id, p, end, &key_exchange_len);
333 }
334#endif /* PSA_WANT_ALG_ECDH */
335#if defined(PSA_WANT_ALG_FFDH)
336 if (mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
337 ret = mbedtls_ssl_tls13_generate_and_write_dhe_key_exchange(
338 ssl, group_id, p, end, &key_exchange_len);
339 }
340#endif /* PSA_WANT_ALG_FFDH */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800341 p += key_exchange_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 if (ret != 0) {
343 return ret;
344 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800345
346 /* Write group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 MBEDTLS_PUT_UINT16_BE(group_id, group, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800348 /* Write key_exchange_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 MBEDTLS_PUT_UINT16_BE(key_exchange_len, group, 2);
350 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200351#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 if (0 /* other KEMs? */) {
Jerry Yu56fc07f2021-09-01 17:48:49 +0800353 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 } else {
355 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800356 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800357
Jerry Yub60e3cf2021-09-08 16:41:02 +0800358 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000359 client_shares_len = p - client_shares;
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 if (client_shares_len == 0) {
361 MBEDTLS_SSL_DEBUG_MSG(1, ("No key share defined."));
362 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu7c522d42021-09-08 17:55:09 +0800363 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800364 /* Write extension_type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800366 /* Write extension_data_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 MBEDTLS_PUT_UINT16_BE(client_shares_len + 2, buf, 2);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800368 /* Write client_shares_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 MBEDTLS_PUT_UINT16_BE(client_shares_len, buf, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800370
371 /* Update offered_group_id field */
372 ssl->handshake->offered_group_id = group_id;
373
374 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000375 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800376
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000377 MBEDTLS_SSL_DEBUG_BUF(
378 3, "client hello, key_share extension", buf, *out_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800379
Gilles Peskine449bd832023-01-11 14:50:10 +0100380 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800381
382cleanup:
383
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800385}
Ronald Cron766c0cd2022-10-18 12:17:11 +0200386#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +0800387
XiaokangQiand59be772022-01-24 10:12:51 +0000388/*
389 * ssl_tls13_parse_hrr_key_share_ext()
390 * Parse key_share extension in Hello Retry Request
391 *
392 * struct {
393 * NamedGroup selected_group;
394 * } KeyShareHelloRetryRequest;
395 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200396MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100397static int ssl_tls13_parse_hrr_key_share_ext(mbedtls_ssl_context *ssl,
398 const unsigned char *buf,
399 const unsigned char *end)
XiaokangQianb851da82022-01-14 04:03:11 +0000400{
Valerio Setti080a22b2023-03-20 15:22:47 +0100401#if defined(PSA_WANT_ALG_ECDH)
XiaokangQianb851da82022-01-14 04:03:11 +0000402 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000403 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000404 int found = 0;
405
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
407 if (group_list == NULL) {
408 return MBEDTLS_ERR_SSL_BAD_CONFIG;
409 }
XiaokangQianb851da82022-01-14 04:03:11 +0000410
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 MBEDTLS_SSL_DEBUG_BUF(3, "key_share extension", p, end - buf);
XiaokangQianb851da82022-01-14 04:03:11 +0000412
413 /* Read selected_group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
415 selected_group = MBEDTLS_GET_UINT16_BE(p, 0);
416 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_group ( %d )", selected_group));
XiaokangQianb851da82022-01-14 04:03:11 +0000417
418 /* Upon receipt of this extension in a HelloRetryRequest, the client
419 * MUST first verify that the selected_group field corresponds to a
420 * group which was provided in the "supported_groups" extension in the
421 * original ClientHello.
422 * The supported_group was based on the info in ssl->conf->group_list.
423 *
424 * If the server provided a key share that was not sent in the ClientHello
425 * then the client MUST abort the handshake with an "illegal_parameter" alert.
426 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 for (; *group_list != 0; group_list++) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200428 if (mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
429 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
430 *group_list, NULL, NULL) == PSA_ERROR_NOT_SUPPORTED) ||
431 *group_list != selected_group) {
432 found = 1;
433 break;
434 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 }
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200436 if (mbedtls_ssl_tls13_named_group_is_dhe(*group_list)) {
437 found = 1;
438 break;
439 }
XiaokangQianb851da82022-01-14 04:03:11 +0000440 }
441
442 /* Client MUST verify that the selected_group field does not
443 * correspond to a group which was provided in the "key_share"
444 * extension in the original ClientHello. If the server sent an
445 * HRR message with a key share already provided in the
446 * ClientHello then the client MUST abort the handshake with
447 * an "illegal_parameter" alert.
448 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 if (found == 0 || selected_group == ssl->handshake->offered_group_id) {
450 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid key share in HRR"));
XiaokangQianb851da82022-01-14 04:03:11 +0000451 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
453 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
454 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQianb851da82022-01-14 04:03:11 +0000455 }
456
457 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000458 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000459
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 return 0;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400461#else
462 (void) ssl;
463 (void) buf;
464 (void) end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100465 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400466#endif
XiaokangQianb851da82022-01-14 04:03:11 +0000467}
468
Jerry Yue1b9c292021-09-10 10:08:31 +0800469/*
Jerry Yub85277e2021-10-13 13:36:05 +0800470 * ssl_tls13_parse_key_share_ext()
471 * Parse key_share extension in Server Hello
472 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800473 * struct {
474 * KeyShareEntry server_share;
475 * } KeyShareServerHello;
476 * struct {
477 * NamedGroup group;
478 * opaque key_exchange<1..2^16-1>;
479 * } KeyShareEntry;
480 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200481MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100482static int ssl_tls13_parse_key_share_ext(mbedtls_ssl_context *ssl,
483 const unsigned char *buf,
484 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800485{
Jerry Yub85277e2021-10-13 13:36:05 +0800486 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800487 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800488 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800489
Jerry Yu4a173382021-10-11 21:45:31 +0800490 /* ...
491 * NamedGroup group; (2 bytes)
492 * ...
493 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
495 group = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +0800496 p += 2;
497
Jerry Yu4a173382021-10-11 21:45:31 +0800498 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800499 offered_group = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100500 if (offered_group != group) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000501 MBEDTLS_SSL_DEBUG_MSG(
502 1, ("Invalid server key share, our group %u, their group %u",
503 (unsigned) offered_group, (unsigned) group));
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
505 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
506 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yue1b9c292021-09-10 10:08:31 +0800507 }
508
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200509#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
510 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
511 mbedtls_ssl_tls13_named_group_is_dhe(group)) {
Valerio Setti080a22b2023-03-20 15:22:47 +0100512#if defined(PSA_WANT_ALG_ECDH)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200513 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
514 if (mbedtls_ssl_get_psa_curve_info_from_tls_id(group, NULL, NULL)
515 == PSA_ERROR_NOT_SUPPORTED) {
516 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid TLS curve group id"));
517 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
518 }
519
520 MBEDTLS_SSL_DEBUG_MSG(
521 2,
522 ("ECDH curve: %s", mbedtls_ssl_get_curve_name_from_tls_id(group)));
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100523 }
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200524#endif /* PSA_WANT_ALG_ECDH */
525#if defined(PSA_WANT_ALG_FFDH)
526 if (mbedtls_ssl_tls13_named_group_is_dhe(group)) {
527 MBEDTLS_SSL_DEBUG_MSG(2,
528 ("DHE group name: %s", mbedtls_ssl_ffdh_name_from_group(group)));
529 }
530#endif /* PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(ssl, p, end - p);
532 if (ret != 0) {
533 return ret;
534 }
535 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200536#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 if (0 /* other KEMs? */) {
Jerry Yue1b9c292021-09-10 10:08:31 +0800538 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100539 } else {
540 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yue1b9c292021-09-10 10:08:31 +0800541 }
Jerry Yue1b9c292021-09-10 10:08:31 +0800542
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +0800544}
545
XiaokangQiand59be772022-01-24 10:12:51 +0000546/*
547 * ssl_tls13_parse_cookie_ext()
548 * Parse cookie extension in Hello Retry Request
549 *
550 * struct {
551 * opaque cookie<1..2^16-1>;
552 * } Cookie;
553 *
554 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
555 * extension to the client (this is an exception to the usual rule that
556 * the only extensions that may be sent are those that appear in the
557 * ClientHello). When sending the new ClientHello, the client MUST copy
558 * the contents of the extension received in the HelloRetryRequest into
559 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
560 * cookies in their initial ClientHello in subsequent connections.
561 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200562MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100563static int ssl_tls13_parse_cookie_ext(mbedtls_ssl_context *ssl,
564 const unsigned char *buf,
565 const unsigned char *end)
XiaokangQian43550bd2022-01-21 04:32:58 +0000566{
XiaokangQian25c9c902022-02-08 10:49:53 +0000567 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000568 const unsigned char *p = buf;
569 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
570
571 /* Retrieve length field of cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
573 cookie_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian43550bd2022-01-21 04:32:58 +0000574 p += 2;
575
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cookie_len);
577 MBEDTLS_SSL_DEBUG_BUF(3, "cookie extension", p, cookie_len);
XiaokangQian43550bd2022-01-21 04:32:58 +0000578
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 mbedtls_free(handshake->cookie);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800580 handshake->cookie_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 handshake->cookie = mbedtls_calloc(1, cookie_len);
582 if (handshake->cookie == NULL) {
583 MBEDTLS_SSL_DEBUG_MSG(1,
584 ("alloc failed ( %ud bytes )",
585 cookie_len));
586 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
XiaokangQian43550bd2022-01-21 04:32:58 +0000587 }
588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 memcpy(handshake->cookie, p, cookie_len);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800590 handshake->cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return 0;
XiaokangQian43550bd2022-01-21 04:32:58 +0000593}
XiaokangQian43550bd2022-01-21 04:32:58 +0000594
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200595MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100596static int ssl_tls13_write_cookie_ext(mbedtls_ssl_context *ssl,
597 unsigned char *buf,
598 unsigned char *end,
599 size_t *out_len)
XiaokangQian0b64eed2022-01-27 10:36:51 +0000600{
601 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000602 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000603 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000604
Gilles Peskine449bd832023-01-11 14:50:10 +0100605 if (handshake->cookie == NULL) {
606 MBEDTLS_SSL_DEBUG_MSG(3, ("no cookie to send; skip extension"));
607 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000608 }
609
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, cookie",
611 handshake->cookie,
612 handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000613
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 MBEDTLS_SSL_CHK_BUF_PTR(p, end, handshake->cookie_len + 6);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000615
Gilles Peskine449bd832023-01-11 14:50:10 +0100616 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding cookie extension"));
XiaokangQian0b64eed2022-01-27 10:36:51 +0000617
Gilles Peskine449bd832023-01-11 14:50:10 +0100618 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_COOKIE, p, 0);
619 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len + 2, p, 2);
620 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len, p, 4);
XiaokangQian233397e2022-02-07 08:32:16 +0000621 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000622
623 /* Cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 memcpy(p, handshake->cookie, handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000625
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800626 *out_len = handshake->cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000627
Gilles Peskine449bd832023-01-11 14:50:10 +0100628 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_COOKIE);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800629
Gilles Peskine449bd832023-01-11 14:50:10 +0100630 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000631}
632
Ronald Cron41a443a2022-10-04 16:38:25 +0200633#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000634/*
635 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
636 *
637 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
638 *
639 * struct {
640 * PskKeyExchangeMode ke_modes<1..255>;
641 * } PskKeyExchangeModes;
642 */
XiaokangQian86981952022-07-19 09:51:50 +0000643MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100644static int ssl_tls13_write_psk_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
645 unsigned char *buf,
646 unsigned char *end,
647 size_t *out_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000648{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000649 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000650 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000651
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 ((void) ke_modes_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000653 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000654
XiaokangQianeb69aee2022-07-05 08:21:43 +0000655 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000656 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000657 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 if (!mbedtls_ssl_conf_tls13_some_psk_enabled(ssl)) {
659 MBEDTLS_SSL_DEBUG_MSG(3, ("skip psk_key_exchange_modes extension"));
660 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000661 }
662
663 /* Require 7 bytes of data, otherwise fail,
664 * even if extension might be shorter.
665 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100666 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000667 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 3, ("client hello, adding psk_key_exchange_modes extension"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000669
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000671
XiaokangQian008d2bf2022-07-14 07:54:01 +0000672 /* Skip extension length (2 bytes) and
673 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000674 */
675 p += 5;
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 if (mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl)) {
XiaokangQianeb69aee2022-07-05 08:21:43 +0000678 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000679 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000680
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding PSK-ECDHE key exchange mode"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000682 }
683
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 if (mbedtls_ssl_conf_tls13_psk_enabled(ssl)) {
Ronald Crona709a0f2022-09-27 16:46:11 +0200685 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
686 ke_modes_len++;
687
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding pure PSK key exchange mode"));
Ronald Crona709a0f2022-09-27 16:46:11 +0200689 }
690
XiaokangQian008d2bf2022-07-14 07:54:01 +0000691 /* Now write the extension and ke_modes length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 MBEDTLS_PUT_UINT16_BE(ke_modes_len + 1, buf, 2);
XiaokangQian008d2bf2022-07-14 07:54:01 +0000693 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000694
695 *out_len = p - buf;
Jerry Yu0c354a22022-08-29 15:25:36 +0800696
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800697 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 ssl, MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800699
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000701}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg(int ciphersuite)
Jerry Yuf7c12592022-09-28 22:09:38 +0800704{
Jerry Yu21f90952022-10-08 10:30:53 +0800705 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800707
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 if (ciphersuite_info != NULL) {
709 return mbedtls_psa_translate_md(ciphersuite_info->mac);
710 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800711
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 return PSA_ALG_NONE;
Jerry Yuf7c12592022-09-28 22:09:38 +0800713}
714
Jerry Yuf75364b2022-09-30 10:30:31 +0800715#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100716static int ssl_tls13_has_configured_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qianb781a232022-11-01 07:39:46 +0000717{
718 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100719 return ssl->handshake->resume &&
Pengyu Lv93566782022-12-07 12:10:05 +0800720 session != NULL && session->ticket != NULL &&
Pengyu Lv9b84ea72023-01-16 14:08:23 +0800721 mbedtls_ssl_conf_tls13_check_kex_modes(
722 ssl, mbedtls_ssl_session_get_ticket_flags(
723 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL));
Xiaokang Qianb781a232022-11-01 07:39:46 +0000724}
725
Xiaokang Qian01323a42022-11-03 02:27:35 +0000726#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100727static int ssl_tls13_early_data_has_valid_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qian01323a42022-11-03 02:27:35 +0000728{
729 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100730 return ssl->handshake->resume &&
731 session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
732 (session->ticket_flags &
733 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) &&
734 mbedtls_ssl_tls13_cipher_suite_is_offered(
735 ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000736}
737#endif
738
Xiaokang Qianb781a232022-11-01 07:39:46 +0000739MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100740static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
741 psa_algorithm_t *hash_alg,
742 const unsigned char **identity,
743 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800744{
745 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800746
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 if (!ssl_tls13_has_configured_ticket(ssl)) {
748 return -1;
749 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800750
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800752 *identity = session->ticket;
753 *identity_len = session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100754 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800755}
756
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800757MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100758static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
759 psa_algorithm_t *hash_alg,
760 const unsigned char **psk,
761 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800762{
763
764 mbedtls_ssl_session *session = ssl->session_negotiate;
765
Gilles Peskine449bd832023-01-11 14:50:10 +0100766 if (!ssl_tls13_has_configured_ticket(ssl)) {
767 return -1;
768 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800769
Gilles Peskine449bd832023-01-11 14:50:10 +0100770 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800771 *psk = session->resumption_key;
772 *psk_len = session->resumption_key_len;
773
Gilles Peskine449bd832023-01-11 14:50:10 +0100774 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800775}
Jerry Yuf7c12592022-09-28 22:09:38 +0800776#endif /* MBEDTLS_SSL_SESSION_TICKETS */
777
778MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100779static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
780 psa_algorithm_t *hash_alg,
781 const unsigned char **identity,
782 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800783{
Jerry Yu8b41e892022-09-30 10:00:20 +0800784
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
786 return -1;
787 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800788
Jerry Yua99cbfa2022-10-08 11:17:14 +0800789 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800790 *identity = ssl->conf->psk_identity;
791 *identity_len = ssl->conf->psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800793}
794
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800795MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100796static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
797 psa_algorithm_t *hash_alg,
798 const unsigned char **psk,
799 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800800{
Jerry Yu8b41e892022-09-30 10:00:20 +0800801
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
803 return -1;
804 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800805
Jerry Yua99cbfa2022-10-08 11:17:14 +0800806 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800807 *psk = ssl->conf->psk;
808 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800810}
811
Gilles Peskine449bd832023-01-11 14:50:10 +0100812static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800813{
814 int configured_psk_count = 0;
815#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 if (ssl_tls13_has_configured_ticket(ssl)) {
817 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800818 configured_psk_count++;
819 }
820#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100821 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
822 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800823 configured_psk_count++;
824 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100825 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800826}
827
Jerry Yuf7c12592022-09-28 22:09:38 +0800828MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100829static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
830 unsigned char *buf,
831 unsigned char *end,
832 const unsigned char *identity,
833 size_t identity_len,
834 uint32_t obfuscated_ticket_age,
835 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800836{
Jerry Yuf75364b2022-09-30 10:30:31 +0800837 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800838 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800839
840 /*
841 * - identity_len (2 bytes)
842 * - identity (psk_identity_len bytes)
843 * - obfuscated_ticket_age (4 bytes)
844 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800846
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
848 memcpy(buf + 2, identity, identity_len);
849 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800850
Gilles Peskine449bd832023-01-11 14:50:10 +0100851 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800852
853 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800854
Gilles Peskine449bd832023-01-11 14:50:10 +0100855 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800856}
857
Jerry Yu8b41e892022-09-30 10:00:20 +0800858MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100859static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
860 unsigned char *buf,
861 unsigned char *end,
862 int psk_type,
863 psa_algorithm_t hash_alg,
864 const unsigned char *psk,
865 size_t psk_len,
866 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800867{
868 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800869 unsigned char binder_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100870 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800871 size_t transcript_len = 0;
872
873 *out_len = 0;
874
Gilles Peskine449bd832023-01-11 14:50:10 +0100875 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800876
877 /*
878 * - binder_len (1 bytes)
879 * - binder (binder_len bytes)
880 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800882
Jerry Yua99cbfa2022-10-08 11:17:14 +0800883 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800884
885 /* Get current state of handshake transcript. */
886 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100887 ssl, mbedtls_hash_info_md_from_psa(hash_alg),
888 transcript, sizeof(transcript), &transcript_len);
889 if (ret != 0) {
890 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800891 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100892
893 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
894 psk, psk_len, psk_type,
895 transcript, buf + 1);
896 if (ret != 0) {
897 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
898 return ret;
899 }
900 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800901
902 *out_len = 1 + binder_len;
903
Gilles Peskine449bd832023-01-11 14:50:10 +0100904 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800905}
906
907/*
908 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
909 *
910 * struct {
911 * opaque identity<1..2^16-1>;
912 * uint32 obfuscated_ticket_age;
913 * } PskIdentity;
914 *
915 * opaque PskBinderEntry<32..255>;
916 *
917 * struct {
918 * PskIdentity identities<7..2^16-1>;
919 * PskBinderEntry binders<33..2^16-1>;
920 * } OfferedPsks;
921 *
922 * struct {
923 * select (Handshake.msg_type) {
924 * case client_hello: OfferedPsks;
925 * ...
926 * };
927 * } PreSharedKeyExtension;
928 *
929 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000930int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
932 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000933{
Jerry Yuf7c12592022-09-28 22:09:38 +0800934 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800935 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800936 unsigned char *p = buf;
Xiaokang Qian854db282022-12-19 07:31:27 +0000937 psa_algorithm_t hash_alg = PSA_ALG_NONE;
Jerry Yuf75364b2022-09-30 10:30:31 +0800938 const unsigned char *identity;
939 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800940 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800941 size_t output_len;
Xiaokang Qian7179f812023-02-03 03:38:44 +0000942
Jerry Yuf7c12592022-09-28 22:09:38 +0800943 *out_len = 0;
944 *binders_len = 0;
945
946 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Gilles Peskine449bd832023-01-11 14:50:10 +0100947 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
948 if (configured_psk_count == 0) {
949 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
950 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800951 }
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
954 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800955
Jerry Yuf7c12592022-09-28 22:09:38 +0800956 /* Check if we have space to write the extension, binders included.
957 * - extension_type (2 bytes)
958 * - extension_data_len (2 bytes)
959 * - identities_len (2 bytes)
960 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800962 p += 6;
963
Jerry Yuf75364b2022-09-30 10:30:31 +0800964#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 if (ssl_tls13_ticket_get_identity(
966 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800967#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 mbedtls_time_t now = mbedtls_time(NULL);
Jerry Yuf75364b2022-09-30 10:30:31 +0800969 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800970 uint32_t obfuscated_ticket_age =
Gilles Peskine449bd832023-01-11 14:50:10 +0100971 (uint32_t) (now - session->ticket_received);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800972
Jerry Yu3e60cad2023-01-10 14:58:08 +0800973 /*
974 * The ticket timestamp is in seconds but the ticket age is in
975 * milliseconds. If the ticket was received at the end of a second and
976 * re-used here just at the beginning of the next second, the computed
977 * age `now - session->ticket_received` is equal to 1s thus 1000 ms
978 * while the actual age could be just a few milliseconds or tens of
979 * milliseconds. If the server has more accurate ticket timestamps
980 * (typically timestamps in milliseconds), as part of the processing of
981 * the ClientHello, it may compute a ticket lifetime smaller than the
982 * one computed here and potentially reject the ticket. To avoid that,
983 * remove one second to the ticket age if possible.
Jerry Yubdb936b2023-01-07 16:07:46 +0800984 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 if (obfuscated_ticket_age > 0) {
Jerry Yubdb936b2023-01-07 16:07:46 +0800986 obfuscated_ticket_age -= 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 }
Jerry Yubdb936b2023-01-07 16:07:46 +0800988
Jerry Yuf75364b2022-09-30 10:30:31 +0800989 obfuscated_ticket_age *= 1000;
990 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800991
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 ret = ssl_tls13_write_identity(ssl, p, end,
993 identity, identity_len,
994 obfuscated_ticket_age,
995 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800996#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
998 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800999#endif /* MBEDTLS_HAVE_TIME */
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 if (ret != 0) {
1001 return ret;
1002 }
Jerry Yuf7c12592022-09-28 22:09:38 +08001003
Jerry Yuf75364b2022-09-30 10:30:31 +08001004 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +08001006 }
1007#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1008
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 if (ssl_tls13_psk_get_identity(
1010 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +08001011
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
1013 &output_len);
1014 if (ret != 0) {
1015 return ret;
1016 }
Jerry Yuf75364b2022-09-30 10:30:31 +08001017
Jerry Yuf7c12592022-09-28 22:09:38 +08001018 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +08001020 }
1021
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 MBEDTLS_SSL_DEBUG_MSG(3,
1023 ("client hello, adding pre_shared_key extension, "
1024 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001025
1026 /* Take into account the two bytes for the length of the binders. */
1027 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +08001028 /* Check if there is enough space for binders */
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +08001030
Jerry Yuf7c12592022-09-28 22:09:38 +08001031 /*
1032 * - extension_type (2 bytes)
1033 * - extension_data_len (2 bytes)
1034 * - identities_len (2 bytes)
1035 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
1037 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
1038 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +08001039
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001041 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +08001042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +08001044
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001046}
1047
XiaokangQian86981952022-07-19 09:51:50 +00001048int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001050{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1052 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001053 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1054 const unsigned char *psk;
1055 size_t psk_len;
1056 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001057
1058 /* Check if we have space to write binders_len.
1059 * - binders_len (2 bytes)
1060 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001062 p += 2;
1063
Jerry Yu6183cc72022-09-30 11:08:57 +08001064#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001066
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 ret = ssl_tls13_write_binder(ssl, p, end,
1068 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1069 hash_alg, psk, psk_len,
1070 &output_len);
1071 if (ret != 0) {
1072 return ret;
1073 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001074 p += output_len;
1075 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001076#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001077
Gilles Peskine449bd832023-01-11 14:50:10 +01001078 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 ret = ssl_tls13_write_binder(ssl, p, end,
1081 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1082 hash_alg, psk, psk_len,
1083 &output_len);
1084 if (ret != 0) {
1085 return ret;
1086 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001087 p += output_len;
1088 }
1089
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001091
1092 /*
1093 * - binders_len (2 bytes)
1094 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001098
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001099 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001101
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001103}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001104
1105/*
1106 * struct {
1107 * opaque identity<1..2^16-1>;
1108 * uint32 obfuscated_ticket_age;
1109 * } PskIdentity;
1110 *
1111 * opaque PskBinderEntry<32..255>;
1112 *
1113 * struct {
1114 *
1115 * select (Handshake.msg_type) {
1116 * ...
1117 * case server_hello: uint16 selected_identity;
1118 * };
1119 *
1120 * } PreSharedKeyExtension;
1121 *
1122 */
1123MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001124static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1125 const unsigned char *buf,
1126 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001127{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001128 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001129 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001130 const unsigned char *psk;
1131 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001132 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001133
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1135 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001136 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001139
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1141 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001142
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1144 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1145 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001146 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001147
Jerry Yu4a698342022-09-30 12:22:01 +08001148#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1150 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1151 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001152#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1154 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
1155 } else {
1156 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1157 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001158 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 if (ret != 0) {
1160 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001161 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001162
Xiaokang Qianeb31cbc2023-02-07 02:08:56 +00001163 if (mbedtls_psa_translate_md(ssl->handshake->ciphersuite_info->mac)
1164 != hash_alg) {
1165 MBEDTLS_SSL_DEBUG_MSG(
1166 1, ("Invalid ciphersuite for external psk."));
1167
1168 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1169 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1170 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1171 }
1172
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1174 if (ret != 0) {
1175 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1176 return ret;
1177 }
1178
1179 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001180}
Ronald Cron41a443a2022-10-04 16:38:25 +02001181#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001182
Gilles Peskine449bd832023-01-11 14:50:10 +01001183int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1184 unsigned char *buf,
1185 unsigned char *end,
1186 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001187{
1188 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1189 unsigned char *p = buf;
1190 size_t ext_len;
1191
1192 *out_len = 0;
1193
1194 /* Write supported_versions extension
1195 *
1196 * Supported Versions Extension is mandatory with TLS 1.3.
1197 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1199 if (ret != 0) {
1200 return ret;
1201 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001202 p += ext_len;
1203
1204 /* Echo the cookie if the server provided one in its preceding
1205 * HelloRetryRequest message.
1206 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1208 if (ret != 0) {
1209 return ret;
1210 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001211 p += ext_len;
1212
Ronald Cron766c0cd2022-10-18 12:17:11 +02001213#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1215 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1216 if (ret != 0) {
1217 return ret;
1218 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001219 p += ext_len;
1220 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001221#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001222
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001223#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1225 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1226 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1227 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1228 if (ret != 0) {
1229 return ret;
1230 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001231 p += ext_len;
1232
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001233 /* Initializes the status to `rejected`. It will be updated to
1234 * `accepted` if the EncryptedExtension message contain an early data
1235 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001236 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001237 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 } else {
1239 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001240 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001241 }
1242#endif /* MBEDTLS_SSL_EARLY_DATA */
1243
Ronald Cron41a443a2022-10-04 16:38:25 +02001244#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001245 /* For PSK-based key exchange we need the pre_shared_key extension
1246 * and the psk_key_exchange_modes extension.
1247 *
1248 * The pre_shared_key extension MUST be the last extension in the
1249 * ClientHello. Servers MUST check that it is the last extension and
1250 * otherwise fail the handshake with an "illegal_parameter" alert.
1251 *
1252 * Add the psk_key_exchange_modes extension.
1253 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1255 if (ret != 0) {
1256 return ret;
1257 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001258 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001259#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001260
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001261 *out_len = p - buf;
1262
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001264}
1265
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00001266int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl)
Xiaokang Qian126929f2023-01-03 10:29:41 +00001267{
Xiaokang Qian90746132023-01-06 05:54:59 +00001268 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001269
Xiaokang Qian126929f2023-01-03 10:29:41 +00001270#if defined(MBEDTLS_SSL_EARLY_DATA)
1271 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1272 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1273 const unsigned char *psk;
1274 size_t psk_len;
1275 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001276
Xiaokang Qian126929f2023-01-03 10:29:41 +00001277 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
Xiaokang Qian6be82902023-02-03 06:04:43 +00001278#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1279 mbedtls_ssl_handshake_set_state(
1280 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1281#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00001282 MBEDTLS_SSL_DEBUG_MSG(
1283 1, ("Set hs psk for early data when writing the first psk"));
1284
1285 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1286 if (ret != 0) {
1287 MBEDTLS_SSL_DEBUG_RET(
1288 1, "ssl_tls13_ticket_get_psk", ret);
1289 return ret;
1290 }
1291
1292 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1293 if (ret != 0) {
1294 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1295 return ret;
1296 }
1297
Xiaokang Qian64bc9bc2023-02-07 02:32:23 +00001298 /*
1299 * Early data are going to be encrypted using the ciphersuite
1300 * associated with the pre-shared key used for the handshake.
1301 * Note that if the server rejects early data, the handshake
1302 * based on the pre-shared key may complete successfully
1303 * with a selected ciphersuite different from the ciphersuite
1304 * associated with the pre-shared key. Only the hashes of the
1305 * two ciphersuites have to be the same. In that case, the
1306 * encrypted handshake data and application data are
1307 * encrypted using a different ciphersuite than the one used for
1308 * the rejected early data.
1309 */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001310 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1311 ssl->session_negotiate->ciphersuite);
1312 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001313
Tom Cosgrove5c8505f2023-03-07 11:39:52 +00001314 /* Enable psk and psk_ephemeral to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001315 ssl->handshake->key_exchange_mode =
1316 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1317
1318 /* Start the TLS 1.3 key schedule:
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001319 * Set the PSK and derive early secret.
Xiaokang Qian126929f2023-01-03 10:29:41 +00001320 */
1321 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1322 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001323 MBEDTLS_SSL_DEBUG_RET(
1324 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001325 return ret;
1326 }
1327
1328 /* Derive early data key material */
1329 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1330 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001331 MBEDTLS_SSL_DEBUG_RET(
1332 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001333 return ret;
1334 }
1335
Xiaokang Qian126929f2023-01-03 10:29:41 +00001336 }
1337#endif /* MBEDTLS_SSL_EARLY_DATA */
1338 return 0;
1339}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001340/*
Jerry Yu4a173382021-10-11 21:45:31 +08001341 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001342 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001343
Ronald Cronda41b382022-03-30 09:57:11 +02001344/**
1345 * \brief Detect if the ServerHello contains a supported_versions extension
1346 * or not.
1347 *
1348 * \param[in] ssl SSL context
1349 * \param[in] buf Buffer containing the ServerHello message
1350 * \param[in] end End of the buffer containing the ServerHello message
1351 *
1352 * \return 0 if the ServerHello does not contain a supported_versions extension
1353 * \return 1 if the ServerHello contains a supported_versions extension
1354 * \return A negative value if an error occurred while parsing the ServerHello.
1355 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001356MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001357static int ssl_tls13_is_supported_versions_ext_present(
1358 mbedtls_ssl_context *ssl,
1359 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001361{
1362 const unsigned char *p = buf;
1363 size_t legacy_session_id_echo_len;
Ronald Croneff56732023-04-03 17:36:31 +02001364 const unsigned char *supported_versions_data;
1365 const unsigned char *supported_versions_data_end;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001366
1367 /*
1368 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001369 * length:
1370 * - legacy_version 2 bytes
1371 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1372 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001373 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001375 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1376 legacy_session_id_echo_len = *p;
1377
1378 /*
1379 * Jump to the extensions, jumping over:
1380 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1381 * - cipher_suite 2 bytes
1382 * - legacy_compression_method 1 byte
1383 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1385 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001386
Ronald Cron47dce632023-02-08 17:38:29 +01001387 return mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1388 ssl, p, end,
Ronald Croneff56732023-04-03 17:36:31 +02001389 &supported_versions_data, &supported_versions_data_end);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001390}
1391
Jerry Yu7a186a02021-10-15 18:46:14 +08001392/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001393 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1394 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1395 * - 0 otherwise
1396 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001397MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001398static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1399 const unsigned char *buf,
1400 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001401{
1402 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1403 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001405 const unsigned char *last_eight_bytes_of_random;
1406 unsigned char last_byte_of_random;
1407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001409 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1410
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 if (memcmp(last_eight_bytes_of_random,
1412 magic_downgrade_string,
1413 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001414 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 return last_byte_of_random == 0 ||
1416 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001417 }
1418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001420}
1421
1422/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001423 * - SSL_SERVER_HELLO or
1424 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001425 * to indicate which message is expected and to be parsed next.
1426 */
Ronald Cron828aff62022-05-31 12:04:31 +02001427#define SSL_SERVER_HELLO 0
1428#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001430static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1431 const unsigned char *buf,
1432 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001433{
Jerry Yue1b9c292021-09-10 10:08:31 +08001434
1435 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1436 *
Jerry Yu4a173382021-10-11 21:45:31 +08001437 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001438 * special value of the SHA-256 of "HelloRetryRequest".
1439 *
1440 * struct {
1441 * ProtocolVersion legacy_version = 0x0303;
1442 * Random random;
1443 * opaque legacy_session_id_echo<0..32>;
1444 * CipherSuite cipher_suite;
1445 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001446 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001447 * } ServerHello;
1448 *
1449 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001450 MBEDTLS_SSL_CHK_BUF_READ_PTR(
1451 buf, end, 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001452
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1454 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1455 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001456 }
1457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001459}
1460
Ronald Cron828aff62022-05-31 12:04:31 +02001461/*
Jerry Yu745bb612021-10-13 22:01:04 +08001462 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001463 * - SSL_SERVER_HELLO or
1464 * - SSL_SERVER_HELLO_HRR or
1465 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001466 */
Ronald Cron828aff62022-05-31 12:04:31 +02001467#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001468MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001469static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1470 const unsigned char *buf,
1471 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001472{
Jerry Yu4a173382021-10-11 21:45:31 +08001473 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001474 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001475
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1477 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001478
Gilles Peskine449bd832023-01-11 14:50:10 +01001479 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001480 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001481 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001482
1483 /* If the server is negotiating TLS 1.2 or below and:
1484 * . we did not propose TLS 1.2 or
1485 * . the server responded it is TLS 1.3 capable but negotiating a lower
1486 * version of the protocol and thus we are under downgrade attack
1487 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001488 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1490 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1491 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1492 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001493 }
1494
Ronald Cronb828c7d2023-04-03 16:37:22 +02001495 /*
1496 * Version 1.2 of the protocol has been negotiated, set the
1497 * ssl->keep_current_message flag for the ServerHello to be kept and
1498 * parsed as a TLS 1.2 ServerHello. We also change ssl->tls_version to
1499 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1500 * will dispatch to the TLS 1.2 state machine.
1501 */
Ronald Cron9f0fba32022-02-10 16:45:15 +01001502 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001503 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001504 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1505 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1506 buf, (size_t) (end - buf)));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001507
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1509 ret = ssl_tls13_reset_key_share(ssl);
1510 if (ret != 0) {
1511 return ret;
1512 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001513 }
1514
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001516 }
1517
Jerry Yua66fece2022-07-13 14:30:29 +08001518#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1519 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1520 ssl->session_negotiate->tls_version = ssl->tls_version;
1521#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1522
Jerry Yu50e00e32022-10-31 14:45:01 +08001523 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1526 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001527 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001529 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001530 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001532 /* If a client receives a second HelloRetryRequest in the same
1533 * connection (i.e., where the ClientHello was itself in response
1534 * to a HelloRetryRequest), it MUST abort the handshake with an
1535 * "unexpected_message" alert.
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 */
1537 if (handshake->hello_retry_request_count > 0) {
1538 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001539 MBEDTLS_SSL_PEND_FATAL_ALERT(
1540 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1541 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001543 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544 /*
1545 * Clients must abort the handshake with an "illegal_parameter"
1546 * alert if the HelloRetryRequest would not result in any change
1547 * in the ClientHello.
1548 * In a PSK only key exchange that what we expect.
1549 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001550 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1551 MBEDTLS_SSL_DEBUG_MSG(1,
1552 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001553 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1555 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1556 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001557 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001558
Ronald Cron5afb9042022-05-31 12:11:39 +02001559 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001560
Jerry Yu745bb612021-10-13 22:01:04 +08001561 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001562 }
1563
1564cleanup:
1565
Gilles Peskine449bd832023-01-11 14:50:10 +01001566 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001567}
1568
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001569MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001570static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1571 const unsigned char **buf,
1572 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001573{
1574 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001575 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001576
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1578 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001581
1582 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1584 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1585 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1586 ssl->session_negotiate->id,
1587 ssl->session_negotiate->id_len);
1588 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1589 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001590
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1592 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001593
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001595 }
1596
Jerry Yu4a173382021-10-11 21:45:31 +08001597 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001598 *buf = p;
1599
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1601 ssl->session_negotiate->id_len);
1602 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001603}
1604
Jerry Yue1b9c292021-09-10 10:08:31 +08001605/* Parse ServerHello message and configure context
1606 *
1607 * struct {
1608 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1609 * Random random;
1610 * opaque legacy_session_id_echo<0..32>;
1611 * CipherSuite cipher_suite;
1612 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001613 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001614 * } ServerHello;
1615 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001616MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001617static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1618 const unsigned char *buf,
1619 const unsigned char *end,
1620 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001621{
Jerry Yub85277e2021-10-13 13:36:05 +08001622 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001623 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001624 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001625 size_t extensions_len;
1626 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001627 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001628 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001629 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001630 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001631 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001633
1634 /*
1635 * Check there is space for minimal fields
1636 *
1637 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001638 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001639 * - legacy_session_id_echo ( 1 byte ), minimum size
1640 * - cipher_suite ( 2 bytes)
1641 * - legacy_compression_method ( 1 byte )
1642 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001644
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1646 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001647
Jerry Yu4a173382021-10-11 21:45:31 +08001648 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001649 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001650 * ...
1651 * with ProtocolVersion defined as:
1652 * uint16 ProtocolVersion;
1653 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001654 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1655 MBEDTLS_SSL_VERSION_TLS1_2) {
1656 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1657 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1658 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001659 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1660 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001661 }
1662 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001663
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001664 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001665 * Random random;
1666 * ...
1667 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001668 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001669 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001670 if (!is_hrr) {
1671 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1672 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1673 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1674 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001675 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001676 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001677
Jerry Yu4a173382021-10-11 21:45:31 +08001678 /* ...
1679 * opaque legacy_session_id_echo<0..32>;
1680 * ...
1681 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001682 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001683 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001684 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001685 }
1686
Jerry Yu4a173382021-10-11 21:45:31 +08001687 /* ...
1688 * CipherSuite cipher_suite;
1689 * ...
1690 * with CipherSuite defined as:
1691 * uint8 CipherSuite[2];
1692 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1694 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001695 p += 2;
1696
Jerry Yu4a173382021-10-11 21:45:31 +08001697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001699 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001700 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001701 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1703 ssl->tls_version,
1704 ssl->tls_version) != 0) ||
1705 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001706 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001707 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001708 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001709 * If we received an HRR before and that the proposed selected
1710 * ciphersuite in this server hello is not the same as the one
1711 * proposed in the HRR, we abort the handshake and send an
1712 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001713 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1715 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001716 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001717 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001718
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1720 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1721 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001722 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001723 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001724
Jerry Yu4a173382021-10-11 21:45:31 +08001725 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001727
XiaokangQian355e09a2022-01-20 11:14:50 +00001728 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1730 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001731
1732#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001733 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001734#endif /* MBEDTLS_HAVE_TIME */
1735
Jerry Yu4a173382021-10-11 21:45:31 +08001736 /* ...
1737 * uint8 legacy_compression_method = 0;
1738 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001739 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1741 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1742 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001743 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001744 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001745 }
1746 p++;
1747
Jerry Yub85277e2021-10-13 13:36:05 +08001748 /* ...
1749 * Extension extensions<6..2^16-1>;
1750 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001751 * struct {
1752 * ExtensionType extension_type; (2 bytes)
1753 * opaque extension_data<0..2^16-1>;
1754 * } Extension;
1755 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1757 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001758 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001759
Jerry Yu4a173382021-10-11 21:45:31 +08001760 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001762 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001763
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001765
Jerry Yu50e00e32022-10-31 14:45:01 +08001766 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001767 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1769 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001772 unsigned int extension_type;
1773 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001774 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001775
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1777 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1778 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001779 p += 4;
1780
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001782 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001783
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001784 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1786 if (ret != 0) {
1787 return ret;
1788 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001789
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001791 case MBEDTLS_TLS_EXT_COOKIE:
1792
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 ret = ssl_tls13_parse_cookie_ext(ssl,
1794 p, extension_data_end);
1795 if (ret != 0) {
1796 MBEDTLS_SSL_DEBUG_RET(1,
1797 "ssl_tls13_parse_cookie_ext",
1798 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001799 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001800 }
XiaokangQianb851da82022-01-14 04:03:11 +00001801 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001802
Jerry Yue1b9c292021-09-10 10:08:31 +08001803 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1805 p,
1806 extension_data_end);
1807 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001808 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001809 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001810 break;
1811
Ronald Cron41a443a2022-10-04 16:38:25 +02001812#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001813 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001815
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1817 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001818 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1820 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001821 }
1822 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001823#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001824
Jerry Yue1b9c292021-09-10 10:08:31 +08001825 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1827 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001828 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001829 goto cleanup;
1830 }
1831
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 if (is_hrr) {
1833 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1834 p, extension_data_end);
1835 } else {
1836 ret = ssl_tls13_parse_key_share_ext(ssl,
1837 p, extension_data_end);
1838 }
1839 if (ret != 0) {
1840 MBEDTLS_SSL_DEBUG_RET(1,
1841 "ssl_tls13_parse_key_share_ext",
1842 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001843 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001844 }
1845 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001846
1847 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001848 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1849 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001850 }
1851
1852 p += extension_data_len;
1853 }
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001856
XiaokangQiand59be772022-01-24 10:12:51 +00001857cleanup:
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1860 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1861 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001862 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1864 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1865 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001866 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1867 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001869}
1870
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001871#if defined(MBEDTLS_DEBUG_C)
1872static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001873{
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001875 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1876 return "psk";
1877 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1878 return "ephemeral";
1879 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1880 return "psk_ephemeral";
1881 default:
1882 return "unknown mode";
1883 }
1884}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001885#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001886
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001887MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001888static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001889{
Jerry Yub85277e2021-10-13 13:36:05 +08001890 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001891 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001892
Jerry Yub85277e2021-10-13 13:36:05 +08001893 /* Determine the key exchange mode:
1894 * 1) If both the pre_shared_key and key_share extensions were received
1895 * then the key exchange mode is PSK with EPHEMERAL.
1896 * 2) If only the pre_shared_key extension was received then the key
1897 * exchange mode is PSK-only.
1898 * 3) If only the key_share extension was received then the key
1899 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001900 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 switch (handshake->received_extensions &
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001902 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1903 MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001904 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001906 handshake->key_exchange_mode =
1907 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001908 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001909
Jerry Yu745bb612021-10-13 22:01:04 +08001910 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001912 handshake->key_exchange_mode =
1913 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001914 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001915
Jerry Yu745bb612021-10-13 22:01:04 +08001916 /* Both the pre_shared_key and key_share extensions were received */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001917 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1918 MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
1919 handshake->key_exchange_mode =
1920 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001921 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001922
Jerry Yu745bb612021-10-13 22:01:04 +08001923 /* Neither pre_shared_key nor key_share extension was received */
1924 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001926 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1927 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001928 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001929#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001930 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1931 (handshake->selected_identity != 0 ||
1932 handshake->ciphersuite_info->id !=
1933 ssl->session_negotiate->ciphersuite)) {
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001934 /* RFC8446 4.2.11
1935 * If the server supplies an "early_data" extension, the
1936 * client MUST verify that the server's selected_identity
1937 * is 0. If any other value is returned, the client MUST
1938 * abort the handshake with an "illegal_parameter" alert.
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001939 *
Xiaokang Qian53c4c272023-02-07 02:42:01 +00001940 * RFC 8446 4.2.10
1941 * In order to accept early data, the server MUST have accepted a PSK
1942 * cipher suite and selected the first key offered in the client's
1943 * "pre_shared_key" extension. In addition, it MUST verify that the
1944 * following values are the same as those associated with the
1945 * selected PSK:
1946 * - The TLS version number
1947 * - The selected cipher suite
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001948 * - The selected ALPN [RFC7301] protocol, if any
1949 *
1950 * We check here that when early data is involved the server
1951 * selected the cipher suite associated to the pre-shared key
1952 * as it must have.
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001953 */
1954 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1955 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1956 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1957 }
1958#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001959
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001960 if (!mbedtls_ssl_conf_tls13_check_kex_modes(
1961 ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001962 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001963 MBEDTLS_SSL_DEBUG_MSG(
1964 2, ("Key exchange mode(%s) is not supported.",
1965 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001966 goto cleanup;
1967 }
1968
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001969 MBEDTLS_SSL_DEBUG_MSG(
1970 3, ("Selected key exchange mode: %s",
1971 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001972
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001973 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001974 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001975 * If we proposed early data then we have already derived an
1976 * early secret using the selected PSK and its associated hash.
1977 * It means that if the negotiated key exchange mode is psk or
1978 * psk_ephemeral, we have already correctly computed the
1979 * early secret and thus we do not do it again. In all other
1980 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001981 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001982#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001983 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1984 handshake->key_exchange_mode ==
1985 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001986#endif
1987 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001988 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1989 if (ret != 0) {
1990 MBEDTLS_SSL_DEBUG_RET(
1991 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1992 goto cleanup;
1993 }
Jerry Yu0b177842021-09-05 19:41:30 +08001994 }
1995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1997 if (ret != 0) {
1998 MBEDTLS_SSL_DEBUG_RET(1,
1999 "mbedtls_ssl_tls13_compute_handshake_transform",
2000 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08002001 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08002002 }
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
2005 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00002006 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
Jerry Yu0b177842021-09-05 19:41:30 +08002007 ssl->session_in = ssl->session_negotiate;
2008
Jerry Yu4a173382021-10-11 21:45:31 +08002009cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08002011 MBEDTLS_SSL_PEND_FATAL_ALERT(
2012 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08002014 }
Jerry Yue110d252022-05-05 10:19:22 +08002015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08002017}
2018
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002019MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002020static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00002021{
2022 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2023
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00002025
XiaokangQian78b1fa72022-01-19 06:56:30 +00002026 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00002027 * We are going to re-generate a shared secret corresponding to the group
2028 * selected by the server, which is different from the group for which we
2029 * generated a shared secret in the first client hello.
2030 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00002031 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 ret = ssl_tls13_reset_key_share(ssl);
2033 if (ret != 0) {
2034 return ret;
2035 }
XiaokangQian647719a2021-12-07 09:16:29 +00002036
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00002037 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002039}
2040
Jerry Yue1b9c292021-09-10 10:08:31 +08002041/*
Jerry Yu4a173382021-10-11 21:45:31 +08002042 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002043 * Handler for MBEDTLS_SSL_SERVER_HELLO
2044 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002045MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002046static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002047{
Jerry Yu4a173382021-10-11 21:45:31 +08002048 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002049 unsigned char *buf = NULL;
2050 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002051 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002054
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002055 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2056 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2059 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002060 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 } else {
2062 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2063 }
XiaokangQiand59be772022-01-24 10:12:51 +00002064
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002066 ret = 0;
2067 goto cleanup;
2068 }
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2071 buf + buf_len,
2072 is_hrr));
2073 if (is_hrr) {
2074 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002075 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002076
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002077 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2078 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002079
2080 if (is_hrr) {
2081 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2082#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2083 /* If not offering early data, the client sends a dummy CCS record
2084 * immediately before its second flight. This may either be before
2085 * its second ClientHello or before its encrypted handshake flight.
2086 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002087 mbedtls_ssl_handshake_set_state(
2088 ssl, MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
Gilles Peskine449bd832023-01-11 14:50:10 +01002089#else
2090 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2091#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2092 } else {
2093 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2094 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002095 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002096
2097cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2099 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2100 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002101}
2102
2103/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002104 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002105 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002106 *
2107 * The EncryptedExtensions message contains any extensions which
2108 * should be protected, i.e., any which are not needed to establish
2109 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002110 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002111
XiaokangQian08da26c2021-10-09 10:12:11 +00002112/* Parse EncryptedExtensions message
2113 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002114 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002115 * } EncryptedExtensions;
2116 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002117MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002118static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2119 const unsigned char *buf,
2120 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002121{
2122 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002123 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002124 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002125 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002126 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002127
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2129 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002130 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002133 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002134
Jan Bruckner5a3629b2023-02-23 12:08:09 +01002135 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2136
Jerry Yu9eba7502022-10-31 13:46:16 +08002137 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002140 unsigned int extension_type;
2141 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002142
XiaokangQian08da26c2021-10-09 10:12:11 +00002143 /*
2144 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002145 * ExtensionType extension_type; (2 bytes)
2146 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002147 * } Extension;
2148 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2150 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2151 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002152 p += 4;
2153
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002155
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002156 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2158 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2159 if (ret != 0) {
2160 return ret;
2161 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002164#if defined(MBEDTLS_SSL_ALPN)
2165 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002167
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002168 if ((ret = ssl_tls13_parse_alpn_ext(
2169 ssl, p, (size_t) extension_data_len)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002171 }
2172
2173 break;
2174#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002175
2176#if defined(MBEDTLS_SSL_EARLY_DATA)
2177 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002180 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2182 MBEDTLS_ERR_SSL_DECODE_ERROR);
2183 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002184 }
2185
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002186 break;
2187#endif /* MBEDTLS_SSL_EARLY_DATA */
2188
Jan Bruckner151f6422023-02-10 12:45:19 +01002189#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2190 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
2191 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
2192
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002193 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
2194 ssl, p, p + extension_data_len);
Jan Bruckner151f6422023-02-10 12:45:19 +01002195
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002196 /* TODO: Return unconditionally here until we handle the record
2197 * size limit correctly. Once handled correctly, only return in
2198 * case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01002199 return ret;
2200
2201 break;
2202#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2203
XiaokangQian08da26c2021-10-09 10:12:11 +00002204 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002205 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002206 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002208 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002209 }
2210
XiaokangQian08da26c2021-10-09 10:12:11 +00002211 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002212 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2215 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002216
XiaokangQian97799ac2021-10-11 10:05:54 +00002217 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 if (p != end) {
2219 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2220 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2221 MBEDTLS_ERR_SSL_DECODE_ERROR);
2222 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002223 }
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002226}
2227
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002228MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002229static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002230{
2231 int ret;
2232 unsigned char *buf;
2233 size_t buf_len;
2234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002236
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002237 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2238 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2239 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002240
2241 /* Process the message contents */
2242 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002244
Xiaokang Qianb157e912022-11-23 08:12:26 +00002245#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (ssl->handshake->received_extensions &
2247 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002248 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2249 }
2250#endif
2251
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002252 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2253 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2254 buf, buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002255
Ronald Cron928cbd32022-10-04 16:14:26 +02002256#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2258 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2259 } else {
2260 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2261 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002262#else
2263 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002265#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002266
2267cleanup:
2268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2270 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002271
2272}
2273
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002274/*
2275 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2276 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002277 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002278 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002279 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002280 *
2281 * If the server sent an "early_data" extension in EncryptedExtensions, the
2282 * client MUST send an EndOfEarlyData message after receiving the server
2283 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002284 */
2285
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002286MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002287static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2288{
2289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002290 unsigned char *buf = NULL;
2291 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002292 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002293
Xiaokang Qian742578c2022-12-19 06:34:44 +00002294 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
Xiaokang Qian0de0d862023-02-08 06:04:50 +00002295 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
2296 &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002297
Manuel Pégourié-Gonnard63e33dd2023-02-21 15:45:15 +01002298 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_hdr_to_checksum(
2299 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002300
Xiaokang Qian742578c2022-12-19 06:34:44 +00002301 MBEDTLS_SSL_PROC_CHK(
2302 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002303
Xiaokang Qian19d44162023-01-03 03:39:50 +00002304 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002305
2306cleanup:
2307
2308 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2309 return ret;
2310}
2311
Ronald Cron928cbd32022-10-04 16:14:26 +02002312#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002313/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002314 * STATE HANDLING: CertificateRequest
2315 *
Jerry Yud2674312021-10-29 10:08:19 +08002316 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002317#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2318#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002319/* Coordination:
2320 * Deals with the ambiguity of not knowing if a CertificateRequest
2321 * will be sent. Returns a negative code on failure, or
2322 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2323 * - SSL_CERTIFICATE_REQUEST_SKIP
2324 * indicating if a Certificate Request is expected or not.
2325 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002326MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002327static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002328{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2332 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2333 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002334 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002335 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002336
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2338 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2339 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2340 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002341 }
2342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002344
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002346}
2347
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002348/*
2349 * ssl_tls13_parse_certificate_request()
2350 * Parse certificate request
2351 * struct {
2352 * opaque certificate_request_context<0..2^8-1>;
2353 * Extension extensions<2..2^16-1>;
2354 * } CertificateRequest;
2355 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002356MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002357static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2358 const unsigned char *buf,
2359 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002360{
2361 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2362 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002363 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002364 size_t extensions_len = 0;
2365 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002366 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002367
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002368 /* ...
2369 * opaque certificate_request_context<0..2^8-1>
2370 * ...
2371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002373 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002374 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (certificate_request_context_len > 0) {
2377 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2378 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2379 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002380
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002381 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 mbedtls_calloc(1, certificate_request_context_len);
2383 if (handshake->certificate_request_context == NULL) {
2384 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2385 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002386 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 memcpy(handshake->certificate_request_context, p,
2388 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002389 p += certificate_request_context_len;
2390 }
2391
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002392 /* ...
2393 * Extension extensions<2..2^16-1>;
2394 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002395 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2397 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002398 p += 2;
2399
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002401 extensions_end = p + extensions_len;
2402
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002403 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002404
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002406 unsigned int extension_type;
2407 size_t extension_data_len;
2408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2410 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2411 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002412 p += 4;
2413
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002415
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002416 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2418 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2419 if (ret != 0) {
2420 return ret;
2421 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002422
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002424 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 MBEDTLS_SSL_DEBUG_MSG(3,
2426 ("found signature algorithms extension"));
2427 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2428 p + extension_data_len);
2429 if (ret != 0) {
2430 return ret;
2431 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002432
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002433 break;
2434
2435 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002436 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002437 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002439 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002440 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002441
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002442 p += extension_data_len;
2443 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002444
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2446 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002447
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002448 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 if (p != end) {
2450 MBEDTLS_SSL_DEBUG_MSG(1,
2451 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002452 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002453 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002454
Jerry Yu0c354a22022-08-29 15:25:36 +08002455 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002456 *
2457 * The "signature_algorithms" extension MUST be specified
2458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2460 MBEDTLS_SSL_DEBUG_MSG(3,
2461 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002462 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002463 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002464
Jerry Yu7840f812022-01-29 10:26:51 +08002465 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002467
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002468decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2470 MBEDTLS_ERR_SSL_DECODE_ERROR);
2471 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002472}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002473
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002474/*
2475 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2476 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002477MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002478static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002479{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002480 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002485
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002487 unsigned char *buf;
2488 size_t buf_len;
2489
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002490 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2491 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2492 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002493
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002494 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(
2495 ssl, buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002496
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002497 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2498 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2499 buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002501 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 } else {
2503 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002504 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2505 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002506 }
2507
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002509
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002510cleanup:
2511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2513 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002514}
2515
2516/*
Jerry Yu687101b2021-09-14 16:03:56 +08002517 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2518 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002519MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002520static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002521{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002522 int ret;
2523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2525 if (ret != 0) {
2526 return ret;
2527 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002528
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2530 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002531}
2532
2533/*
2534 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2535 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002536MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002537static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002538{
Jerry Yu30b071c2021-09-12 20:16:03 +08002539 int ret;
2540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2542 if (ret != 0) {
2543 return ret;
2544 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2547 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002548}
Ronald Cron928cbd32022-10-04 16:14:26 +02002549#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002550
Jerry Yu687101b2021-09-14 16:03:56 +08002551/*
2552 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2553 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002554MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002555static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002556{
XiaokangQianac0385c2021-11-03 06:40:11 +00002557 int ret;
2558
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2560 if (ret != 0) {
2561 return ret;
2562 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2565 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002566 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2568 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2569 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002570 }
2571
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002572#if defined(MBEDTLS_SSL_EARLY_DATA)
2573 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2574 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002575 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2576 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002577 } else
2578#endif /* MBEDTLS_SSL_EARLY_DATA */
2579 {
2580#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2581 mbedtls_ssl_handshake_set_state(
2582 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2583#else
2584 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2585#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2586 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002589}
2590
2591/*
Jerry Yu566c7812022-01-26 15:41:22 +08002592 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2593 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002594MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002595static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002596{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002597 int non_empty_certificate_msg = 0;
2598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 MBEDTLS_SSL_DEBUG_MSG(1,
2600 ("Switch to handshake traffic keys for outbound traffic"));
2601 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002602
Ronald Cron928cbd32022-10-04 16:14:26 +02002603#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (ssl->handshake->client_auth) {
2605 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2606 if (ret != 0) {
2607 return ret;
2608 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002611 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 }
2613 } else {
2614 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002615 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002616#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (non_empty_certificate_msg) {
2619 mbedtls_ssl_handshake_set_state(ssl,
2620 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2621 } else {
2622 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2623 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2624 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002625
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002627}
2628
Ronald Cron928cbd32022-10-04 16:14:26 +02002629#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002630/*
2631 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2632 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002633MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002634static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002635{
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002637
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 if (ret == 0) {
2639 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2640 }
Ronald Crona8b38872022-03-09 07:59:25 +01002641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002643}
Ronald Cron928cbd32022-10-04 16:14:26 +02002644#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002645
2646/*
Jerry Yu687101b2021-09-14 16:03:56 +08002647 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2648 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002649MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002650static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002651{
XiaokangQian0fa66432021-11-15 03:33:57 +00002652 int ret;
2653
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2655 if (ret != 0) {
2656 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002657 }
2658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2660 if (ret != 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002661 MBEDTLS_SSL_DEBUG_RET(
2662 1, "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 return ret;
2664 }
2665
2666 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2667 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002668}
2669
2670/*
2671 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2672 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002673MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002674static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002675{
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2677 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2678 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002679}
2680
2681/*
2682 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2683 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002685static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002686{
Jerry Yu378254d2021-10-30 21:44:47 +08002687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2691 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002692}
2693
Jerry Yuf8a49942022-07-07 11:32:32 +00002694#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2695
Jerry Yua0446a02022-07-13 11:22:55 +08002696MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002697static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2698 const unsigned char *buf,
2699 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002700{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002701 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002702 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002703
Jerry Yuf8a49942022-07-07 11:32:32 +00002704
Jerry Yuedab6372022-10-31 14:37:31 +08002705 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002708 unsigned int extension_type;
2709 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002710 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2713 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2714 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002715 p += 4;
2716
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002718
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002719 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2721 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2722 if (ret != 0) {
2723 return ret;
2724 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002727#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002728 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002730 MBEDTLS_SSL_PEND_FATAL_ALERT(
2731 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 MBEDTLS_ERR_SSL_DECODE_ERROR);
2733 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002734 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002736 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002738 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002739 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002740#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002741
Jerry Yuf8a49942022-07-07 11:32:32 +00002742 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002743 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002744 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002746 break;
2747 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002748
Jerry Yuf8a49942022-07-07 11:32:32 +00002749 p += extension_data_len;
2750 }
2751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2753 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002756}
2757
2758/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002759 * From RFC8446, page 74
2760 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002761 * struct {
2762 * uint32 ticket_lifetime;
2763 * uint32 ticket_age_add;
2764 * opaque ticket_nonce<0..255>;
2765 * opaque ticket<1..2^16-1>;
2766 * Extension extensions<0..2^16-2>;
2767 * } NewSessionTicket;
2768 *
2769 */
Jerry Yua0446a02022-07-13 11:22:55 +08002770MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002771static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2772 unsigned char *buf,
2773 unsigned char *end,
2774 unsigned char **ticket_nonce,
2775 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002776{
2777 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2778 unsigned char *p = buf;
2779 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002780 size_t ticket_len;
2781 unsigned char *ticket;
2782 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002783
Jerry Yucb3b1392022-07-12 06:09:38 +00002784 *ticket_nonce = NULL;
2785 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002786 /*
2787 * ticket_lifetime 4 bytes
2788 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002789 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002790 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2794 MBEDTLS_SSL_DEBUG_MSG(3,
2795 ("ticket_lifetime: %u",
2796 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002797
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2799 MBEDTLS_SSL_DEBUG_MSG(3,
2800 ("ticket_age_add: %u",
2801 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002802
Jerry Yucb3b1392022-07-12 06:09:38 +00002803 *ticket_nonce_len = p[8];
2804 p += 9;
2805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002807 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002809 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002810
2811 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2813 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002814 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2816 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002817
2818 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 if (session->ticket != NULL || session->ticket_len > 0) {
2820 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002821 session->ticket = NULL;
2822 session->ticket_len = 0;
2823 }
2824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2826 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2827 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002828 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002830 p += ticket_len;
2831 session->ticket = ticket;
2832 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002833
Pengyu Lv9f926952022-11-17 15:22:33 +08002834 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002835 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002836 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2839 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002840 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2846 if (ret != 0) {
2847 MBEDTLS_SSL_DEBUG_RET(1,
2848 "ssl_tls13_parse_new_session_ticket_exts",
2849 ret);
2850 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002851 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002852
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002853 /* session has been updated, allow export */
2854 session->exported = 0;
2855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002857}
2858
Jerry Yua0446a02022-07-13 11:22:55 +08002859MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002860static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2861 unsigned char *ticket_nonce,
2862 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002863{
2864 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2865 mbedtls_ssl_session *session = ssl->session;
2866 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2867 psa_algorithm_t psa_hash_alg;
2868 int hash_length;
2869
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002870#if defined(MBEDTLS_HAVE_TIME)
2871 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002873#endif
2874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2876 if (ciphersuite_info == NULL) {
2877 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2878 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002879 }
2880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2882 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2883 if (hash_length == -1 ||
2884 (size_t) hash_length > sizeof(session->resumption_key)) {
2885 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002886 }
2887
Jerry Yuf8a49942022-07-07 11:32:32 +00002888
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2890 session->app_secrets.resumption_master_secret,
2891 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002892
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002893 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002894 *
2895 * HKDF-Expand-Label( resumption_master_secret,
2896 * "resumption", ticket_nonce, Hash.length )
2897 */
2898 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 psa_hash_alg,
2900 session->app_secrets.resumption_master_secret,
2901 hash_length,
2902 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2903 ticket_nonce,
2904 ticket_nonce_len,
2905 session->resumption_key,
2906 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 if (ret != 0) {
2909 MBEDTLS_SSL_DEBUG_RET(2,
2910 "Creating the ticket-resumed PSK failed",
2911 ret);
2912 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002913 }
2914
Jerry Yu0a430c82022-07-20 11:02:48 +08002915 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002916
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2918 session->resumption_key,
2919 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002920
Pengyu Lv9f926952022-11-17 15:22:33 +08002921 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002922 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002923 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002924 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002927}
2928
2929/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002930 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002931 */
Jerry Yua0446a02022-07-13 11:22:55 +08002932MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002933static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002934{
2935 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2936 unsigned char *buf;
2937 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002938 unsigned char *ticket_nonce;
2939 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002940
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2944 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2945 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2948 ssl, buf, buf + buf_len,
2949 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002950
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2952 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002953
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002955
Jerry Yuf8a49942022-07-07 11:32:32 +00002956cleanup:
2957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2959 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002960}
2961#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2962
Gilles Peskine449bd832023-01-11 14:50:10 +01002963int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002964{
Jerry Yu92c6b402021-08-27 16:59:09 +08002965 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002966
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002968 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002970 break;
2971
Jerry Yu92c6b402021-08-27 16:59:09 +08002972 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002974 break;
2975
2976 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002978 break;
2979
2980 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002982 break;
2983
Ronald Cron928cbd32022-10-04 16:14:26 +02002984#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002985 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002987 break;
2988
Jerry Yu687101b2021-09-14 16:03:56 +08002989 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002991 break;
2992
2993 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002995 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002996#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002997
2998 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003000 break;
3001
Xiaokang Qian125afcb2022-10-28 06:04:06 +00003002 case MBEDTLS_SSL_END_OF_EARLY_DATA:
3003 ret = ssl_tls13_write_end_of_early_data(ssl);
3004 break;
3005
Jerry Yu566c7812022-01-26 15:41:22 +08003006 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08003008 break;
3009
Ronald Cron928cbd32022-10-04 16:14:26 +02003010#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08003011 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08003013 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003014#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08003015
Jerry Yu687101b2021-09-14 16:03:56 +08003016 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003018 break;
3019
3020 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003022 break;
3023
3024 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08003026 break;
3027
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 /*
3029 * Injection of dummy-CCS's for middlebox compatibility
3030 */
Ronald Cron49ad6192021-11-24 16:25:31 +01003031#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00003032 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3034 if (ret == 0) {
3035 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3036 }
Ronald Cron9f55f632022-02-02 16:02:47 +01003037 break;
3038
3039 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3041 if (ret == 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00003042 mbedtls_ssl_handshake_set_state(
3043 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 }
Ronald Cron49ad6192021-11-24 16:25:31 +01003045 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003046
Xiaokang Qian592021a2023-01-04 10:47:05 +00003047 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3048 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3049 if (ret == 0) {
3050 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3051
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003052#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003053 MBEDTLS_SSL_DEBUG_MSG(
3054 1, ("Switch to early data keys for outbound traffic"));
3055 mbedtls_ssl_set_outbound_transform(
3056 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003057#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003058 }
3059 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003060#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3061
Jerry Yuf8a49942022-07-07 11:32:32 +00003062#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003063 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 ret = ssl_tls13_process_new_session_ticket(ssl);
3065 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003066 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003068 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3069 break;
3070#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3071
Jerry Yu92c6b402021-08-27 16:59:09 +08003072 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3074 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003075 }
3076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003078}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003079
Jerry Yufb4b6472022-01-27 15:03:26 +08003080#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */