blob: 0c67c8326a0e700fa8fe35cfcbadba261696bf71 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
2 * TLS 1.3 client-side functions
3 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS ( https://tls.mbed.org )
20 */
21
22#include "common.h"
23
Jerry Yucc43c6b2022-01-28 10:24:45 +080024#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080025
Jerry Yubc20bdd2021-08-24 15:59:48 +080026#include <string.h>
27
Jerry Yu56fc07f2021-09-01 17:48:49 +080028#include "mbedtls/debug.h"
29#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080030#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080031
Jerry Yubdc71882021-09-14 19:30:36 +080032#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010033#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080034#include "ssl_tls13_keys.h"
Jerry Yucbd082f2022-08-04 16:55:10 +080035#include "ssl_debug_helpers.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020036#include "md_psa.h"
Jerry Yubdc71882021-09-14 19:30:36 +080037
Valerio Settidbd01cb2023-07-04 09:11:39 +020038#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
Andrzej Kurek00644842023-05-30 05:45:00 -040039/* Define a local translating function to save code size by not using too many
40 * arguments in each translating place. */
41static int local_err_translation(psa_status_t status)
42{
43 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040044 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040045 psa_generic_status_to_mbedtls);
46}
47#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kureka6033ac2023-05-30 15:16:34 -040048#endif
49
Jerry Yubc20bdd2021-08-24 15:59:48 +080050/* Write extensions */
51
Jerry Yu92c6b402021-08-27 16:59:09 +080052/*
53 * ssl_tls13_write_supported_versions_ext():
54 *
55 * struct {
56 * ProtocolVersion versions<2..254>;
57 * } SupportedVersions;
58 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020059MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010060static int ssl_tls13_write_supported_versions_ext(mbedtls_ssl_context *ssl,
61 unsigned char *buf,
62 unsigned char *end,
63 size_t *out_len)
Jerry Yu92c6b402021-08-27 16:59:09 +080064{
65 unsigned char *p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +010066 unsigned char versions_len = (ssl->handshake->min_tls_version <=
67 MBEDTLS_SSL_VERSION_TLS1_2) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080068
Xiaofei Baid25fab62021-12-02 06:36:27 +000069 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080070
Gilles Peskine449bd832023-01-11 14:50:10 +010071 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding supported versions extension"));
Jerry Yu92c6b402021-08-27 16:59:09 +080072
Jerry Yu388bd0d2021-09-15 18:41:02 +080073 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080074 * - extension_type (2 bytes)
75 * - extension_data_length (2 bytes)
76 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020077 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080078 */
Gilles Peskine449bd832023-01-11 14:50:10 +010079 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 5 + versions_len);
Ronald Crondbe87f02022-02-10 14:35:27 +010080
Gilles Peskine449bd832023-01-11 14:50:10 +010081 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0);
82 MBEDTLS_PUT_UINT16_BE(versions_len + 1, p, 2);
Jerry Yueecfbf02021-08-30 18:32:07 +080083 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080084
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080085 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010086 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080087
Jerry Yu0c63af62021-09-02 12:59:12 +080088 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080089 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010090 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080091 */
Gilles Peskine449bd832023-01-11 14:50:10 +010092 mbedtls_ssl_write_version(p, MBEDTLS_SSL_TRANSPORT_STREAM,
93 MBEDTLS_SSL_VERSION_TLS1_3);
94 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:4]"));
Jerry Yu92c6b402021-08-27 16:59:09 +080095
Jerry Yu92c6b402021-08-27 16:59:09 +080096
Gilles Peskine449bd832023-01-11 14:50:10 +010097 if (ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
98 mbedtls_ssl_write_version(p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
99 MBEDTLS_SSL_VERSION_TLS1_2);
100 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:3]"));
Ronald Crondbe87f02022-02-10 14:35:27 +0100101 }
102
103 *out_len = 5 + versions_len;
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800104
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800105 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800107
Gilles Peskine449bd832023-01-11 14:50:10 +0100108 return 0;
Jerry Yu92c6b402021-08-27 16:59:09 +0800109}
Jerry Yubc20bdd2021-08-24 15:59:48 +0800110
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200111MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100112static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
113 const unsigned char *buf,
114 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800115{
Jerry Yue1b9c292021-09-10 10:08:31 +0800116 ((void) ssl);
117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
119 if (mbedtls_ssl_read_version(buf, ssl->conf->transport) !=
120 MBEDTLS_SSL_VERSION_TLS1_3) {
121 MBEDTLS_SSL_DEBUG_MSG(1, ("unexpected version"));
Jerry Yu4a173382021-10-11 21:45:31 +0800122
Gilles Peskine449bd832023-01-11 14:50:10 +0100123 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
124 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
125 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +0800126 }
127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128 if (&buf[2] != end) {
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000129 MBEDTLS_SSL_DEBUG_MSG(
130 1, ("supported_versions ext data length incorrect"));
Gilles Peskine449bd832023-01-11 14:50:10 +0100131 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
132 MBEDTLS_ERR_SSL_DECODE_ERROR);
133 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Ronald Cron98473382022-03-30 20:04:10 +0200134 }
135
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +0800137}
138
lhuang0486cacac2022-01-21 07:34:27 -0800139#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200140MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100141static int ssl_tls13_parse_alpn_ext(mbedtls_ssl_context *ssl,
142 const unsigned char *buf, size_t len)
lhuang0486cacac2022-01-21 07:34:27 -0800143{
lhuang0486cacac2022-01-21 07:34:27 -0800144 const unsigned char *p = buf;
145 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200146 size_t protocol_name_list_len, protocol_name_len;
147 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800148
149 /* If we didn't send it, the server shouldn't send it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (ssl->conf->alpn_list == NULL) {
151 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
152 }
lhuang0486cacac2022-01-21 07:34:27 -0800153
154 /*
155 * opaque ProtocolName<1..2^8-1>;
156 *
157 * struct {
158 * ProtocolName protocol_name_list<2..2^16-1>
159 * } ProtocolNameList;
160 *
161 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
162 */
163
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
165 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
lhuang0486cacac2022-01-21 07:34:27 -0800166 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800167
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
Ronald Cron81a334f2022-05-31 16:04:11 +0200169 protocol_name_list_end = p + protocol_name_list_len;
170
Gilles Peskine449bd832023-01-11 14:50:10 +0100171 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, 1);
Ronald Cron81a334f2022-05-31 16:04:11 +0200172 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800173
174 /* Check that the server chosen protocol was in our list and save it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, protocol_name_len);
176 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
177 if (protocol_name_len == strlen(*alpn) &&
178 memcmp(p, *alpn, protocol_name_len) == 0) {
lhuang0486cacac2022-01-21 07:34:27 -0800179 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 return 0;
lhuang0486cacac2022-01-21 07:34:27 -0800181 }
182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
lhuang0486cacac2022-01-21 07:34:27 -0800185}
186#endif /* MBEDTLS_SSL_ALPN */
187
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200188MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100189static int ssl_tls13_reset_key_share(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +0000190{
191 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 if (group_id == 0) {
194 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
195 }
XiaokangQian647719a2021-12-07 09:16:29 +0000196
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200197#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
198 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200199 mbedtls_ssl_tls13_named_group_is_ffdh(group_id)) {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
201 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
202
203 /* Destroy generated private key. */
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200204 status = psa_destroy_key(ssl->handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500206 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 MBEDTLS_SSL_DEBUG_RET(1, "psa_destroy_key", ret);
208 return ret;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100209 }
210
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200211 ssl->handshake->xxdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return 0;
213 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200214#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 if (0 /* other KEMs? */) {
XiaokangQian647719a2021-12-07 09:16:29 +0000216 /* Do something */
217 }
218
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQian647719a2021-12-07 09:16:29 +0000220}
221
222/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800223 * Functions for writing key_share extension.
224 */
Ronald Cron766c0cd2022-10-18 12:17:11 +0200225#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200226MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100227static int ssl_tls13_get_default_group_id(mbedtls_ssl_context *ssl,
228 uint16_t *group_id)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800229{
230 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
231
Jerry Yu56fc07f2021-09-01 17:48:49 +0800232
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200233#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Jerry Yu388bd0d2021-09-15 18:41:02 +0800235 /* Pick first available ECDHE group compatible with TLS 1.3 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100236 if (group_list == NULL) {
237 return MBEDTLS_ERR_SSL_BAD_CONFIG;
238 }
Jerry Yu388bd0d2021-09-15 18:41:02 +0800239
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 for (; *group_list != 0; group_list++) {
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200241#if defined(PSA_WANT_ALG_ECDH)
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000242 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
243 *group_list, NULL, NULL) == PSA_SUCCESS) &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
Brett Warren14efd332021-10-06 09:32:11 +0100245 *group_id = *group_list;
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 return 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800247 }
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200248#endif
249#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekield5f79e72023-06-29 09:08:43 +0200250 if (mbedtls_ssl_tls13_named_group_is_ffdh(*group_list)) {
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200251 *group_id = *group_list;
252 return 0;
253 }
254#endif
Jerry Yu56fc07f2021-09-01 17:48:49 +0800255 }
256#else
257 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800258 ((void) group_id);
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200259#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800260
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800262}
263
264/*
265 * ssl_tls13_write_key_share_ext
266 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800267 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800268 *
269 * struct {
270 * NamedGroup group;
271 * opaque key_exchange<1..2^16-1>;
272 * } KeyShareEntry;
273 * struct {
274 * KeyShareEntry client_shares<0..2^16-1>;
275 * } KeyShareClientHello;
276 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200277MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100278static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
279 unsigned char *buf,
280 unsigned char *end,
281 size_t *out_len)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800282{
283 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000284 unsigned char *client_shares; /* Start of client_shares */
285 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800286 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800287 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
288
Xiaofei Baid25fab62021-12-02 06:36:27 +0000289 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800290
Jerry Yub60e3cf2021-09-08 16:41:02 +0800291 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800292 * - extension_type (2 bytes)
293 * - extension_data_length (2 bytes)
294 * - client_shares_length (2 bytes)
295 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800297 p += 6;
298
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello: adding key share extension"));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800300
301 /* HRR could already have requested something else. */
302 group_id = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 if (!mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) &&
Przemek Stekield5f79e72023-06-29 09:08:43 +0200304 !mbedtls_ssl_tls13_named_group_is_ffdh(group_id)) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 MBEDTLS_SSL_PROC_CHK(ssl_tls13_get_default_group_id(ssl,
306 &group_id));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800307 }
308
309 /*
310 * Dispatch to type-specific key generation function.
311 *
312 * So far, we're only supporting ECDHE. With the introduction
313 * of PQC KEMs, we'll want to have multiple branches, one per
314 * type of KEM, and dispatch to the corresponding crypto. And
315 * only one key share entry is allowed.
316 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000317 client_shares = p;
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200318#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
319 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200320 mbedtls_ssl_tls13_named_group_is_ffdh(group_id)) {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800321 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000322 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800323 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100324 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800325
326 /* Check there is space for header of KeyShareEntry
327 * - group (2 bytes)
328 * - key_exchange_length (2 bytes)
329 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800331 p += 4;
Przemek Stekiel29c219c2023-05-31 15:21:04 +0200332 ret = mbedtls_ssl_tls13_generate_and_write_dh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 ssl, group_id, p, end, &key_exchange_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800334 p += key_exchange_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 if (ret != 0) {
336 return ret;
337 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800338
339 /* Write group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 MBEDTLS_PUT_UINT16_BE(group_id, group, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800341 /* Write key_exchange_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 MBEDTLS_PUT_UINT16_BE(key_exchange_len, group, 2);
343 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200344#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 if (0 /* other KEMs? */) {
Jerry Yu56fc07f2021-09-01 17:48:49 +0800346 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 } else {
348 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800349 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800350
Jerry Yub60e3cf2021-09-08 16:41:02 +0800351 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000352 client_shares_len = p - client_shares;
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 if (client_shares_len == 0) {
354 MBEDTLS_SSL_DEBUG_MSG(1, ("No key share defined."));
355 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu7c522d42021-09-08 17:55:09 +0800356 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800357 /* Write extension_type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100358 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800359 /* Write extension_data_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 MBEDTLS_PUT_UINT16_BE(client_shares_len + 2, buf, 2);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800361 /* Write client_shares_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 MBEDTLS_PUT_UINT16_BE(client_shares_len, buf, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800363
364 /* Update offered_group_id field */
365 ssl->handshake->offered_group_id = group_id;
366
367 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000368 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800369
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000370 MBEDTLS_SSL_DEBUG_BUF(
371 3, "client hello, key_share extension", buf, *out_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800372
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800374
375cleanup:
376
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800378}
Ronald Cron766c0cd2022-10-18 12:17:11 +0200379#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +0800380
XiaokangQiand59be772022-01-24 10:12:51 +0000381/*
382 * ssl_tls13_parse_hrr_key_share_ext()
383 * Parse key_share extension in Hello Retry Request
384 *
385 * struct {
386 * NamedGroup selected_group;
387 * } KeyShareHelloRetryRequest;
388 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200389MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static int ssl_tls13_parse_hrr_key_share_ext(mbedtls_ssl_context *ssl,
391 const unsigned char *buf,
392 const unsigned char *end)
XiaokangQianb851da82022-01-14 04:03:11 +0000393{
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200394#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQianb851da82022-01-14 04:03:11 +0000395 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000396 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000397 int found = 0;
398
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
400 if (group_list == NULL) {
401 return MBEDTLS_ERR_SSL_BAD_CONFIG;
402 }
XiaokangQianb851da82022-01-14 04:03:11 +0000403
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 MBEDTLS_SSL_DEBUG_BUF(3, "key_share extension", p, end - buf);
XiaokangQianb851da82022-01-14 04:03:11 +0000405
406 /* Read selected_group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
408 selected_group = MBEDTLS_GET_UINT16_BE(p, 0);
409 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_group ( %d )", selected_group));
XiaokangQianb851da82022-01-14 04:03:11 +0000410
411 /* Upon receipt of this extension in a HelloRetryRequest, the client
412 * MUST first verify that the selected_group field corresponds to a
413 * group which was provided in the "supported_groups" extension in the
414 * original ClientHello.
415 * The supported_group was based on the info in ssl->conf->group_list.
416 *
417 * If the server provided a key share that was not sent in the ClientHello
418 * then the client MUST abort the handshake with an "illegal_parameter" alert.
419 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 for (; *group_list != 0; group_list++) {
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200421#if defined(PSA_WANT_ALG_ECDH)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200422 if (mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
423 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
424 *group_list, NULL, NULL) == PSA_ERROR_NOT_SUPPORTED) ||
425 *group_list != selected_group) {
426 found = 1;
427 break;
428 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 }
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200430#endif /* PSA_WANT_ALG_ECDH */
431#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekield5f79e72023-06-29 09:08:43 +0200432 if (mbedtls_ssl_tls13_named_group_is_ffdh(*group_list)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200433 found = 1;
434 break;
435 }
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200436#endif /* PSA_WANT_ALG_FFDH */
XiaokangQianb851da82022-01-14 04:03:11 +0000437 }
438
439 /* Client MUST verify that the selected_group field does not
440 * correspond to a group which was provided in the "key_share"
441 * extension in the original ClientHello. If the server sent an
442 * HRR message with a key share already provided in the
443 * ClientHello then the client MUST abort the handshake with
444 * an "illegal_parameter" alert.
445 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 if (found == 0 || selected_group == ssl->handshake->offered_group_id) {
447 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid key share in HRR"));
XiaokangQianb851da82022-01-14 04:03:11 +0000448 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
450 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
451 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQianb851da82022-01-14 04:03:11 +0000452 }
453
454 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000455 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000456
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 return 0;
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200458#else /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400459 (void) ssl;
460 (void) buf;
461 (void) end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200463#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQianb851da82022-01-14 04:03:11 +0000464}
465
Jerry Yue1b9c292021-09-10 10:08:31 +0800466/*
Jerry Yub85277e2021-10-13 13:36:05 +0800467 * ssl_tls13_parse_key_share_ext()
468 * Parse key_share extension in Server Hello
469 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800470 * struct {
471 * KeyShareEntry server_share;
472 * } KeyShareServerHello;
473 * struct {
474 * NamedGroup group;
475 * opaque key_exchange<1..2^16-1>;
476 * } KeyShareEntry;
477 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200478MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100479static int ssl_tls13_parse_key_share_ext(mbedtls_ssl_context *ssl,
480 const unsigned char *buf,
481 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800482{
Jerry Yub85277e2021-10-13 13:36:05 +0800483 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800484 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800485 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800486
Jerry Yu4a173382021-10-11 21:45:31 +0800487 /* ...
488 * NamedGroup group; (2 bytes)
489 * ...
490 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
492 group = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +0800493 p += 2;
494
Jerry Yu4a173382021-10-11 21:45:31 +0800495 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800496 offered_group = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 if (offered_group != group) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000498 MBEDTLS_SSL_DEBUG_MSG(
499 1, ("Invalid server key share, our group %u, their group %u",
500 (unsigned) offered_group, (unsigned) group));
Gilles Peskine449bd832023-01-11 14:50:10 +0100501 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
502 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
503 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yue1b9c292021-09-10 10:08:31 +0800504 }
505
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200506#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
507 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200508 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200509 MBEDTLS_SSL_DEBUG_MSG(2,
510 ("DHE group name: %s", mbedtls_ssl_named_group_to_str(group)));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200511 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(ssl, p, end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 if (ret != 0) {
513 return ret;
514 }
515 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200516#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 if (0 /* other KEMs? */) {
Jerry Yue1b9c292021-09-10 10:08:31 +0800518 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 } else {
520 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yue1b9c292021-09-10 10:08:31 +0800521 }
Jerry Yue1b9c292021-09-10 10:08:31 +0800522
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +0800524}
525
XiaokangQiand59be772022-01-24 10:12:51 +0000526/*
527 * ssl_tls13_parse_cookie_ext()
528 * Parse cookie extension in Hello Retry Request
529 *
530 * struct {
531 * opaque cookie<1..2^16-1>;
532 * } Cookie;
533 *
534 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
535 * extension to the client (this is an exception to the usual rule that
536 * the only extensions that may be sent are those that appear in the
537 * ClientHello). When sending the new ClientHello, the client MUST copy
538 * the contents of the extension received in the HelloRetryRequest into
539 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
540 * cookies in their initial ClientHello in subsequent connections.
541 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200542MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100543static int ssl_tls13_parse_cookie_ext(mbedtls_ssl_context *ssl,
544 const unsigned char *buf,
545 const unsigned char *end)
XiaokangQian43550bd2022-01-21 04:32:58 +0000546{
XiaokangQian25c9c902022-02-08 10:49:53 +0000547 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000548 const unsigned char *p = buf;
549 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
550
551 /* Retrieve length field of cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
553 cookie_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian43550bd2022-01-21 04:32:58 +0000554 p += 2;
555
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cookie_len);
557 MBEDTLS_SSL_DEBUG_BUF(3, "cookie extension", p, cookie_len);
XiaokangQian43550bd2022-01-21 04:32:58 +0000558
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 mbedtls_free(handshake->cookie);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800560 handshake->cookie_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 handshake->cookie = mbedtls_calloc(1, cookie_len);
562 if (handshake->cookie == NULL) {
563 MBEDTLS_SSL_DEBUG_MSG(1,
564 ("alloc failed ( %ud bytes )",
565 cookie_len));
566 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
XiaokangQian43550bd2022-01-21 04:32:58 +0000567 }
568
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 memcpy(handshake->cookie, p, cookie_len);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800570 handshake->cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000571
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 return 0;
XiaokangQian43550bd2022-01-21 04:32:58 +0000573}
XiaokangQian43550bd2022-01-21 04:32:58 +0000574
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200575MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100576static int ssl_tls13_write_cookie_ext(mbedtls_ssl_context *ssl,
577 unsigned char *buf,
578 unsigned char *end,
579 size_t *out_len)
XiaokangQian0b64eed2022-01-27 10:36:51 +0000580{
581 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000582 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000583 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000584
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 if (handshake->cookie == NULL) {
586 MBEDTLS_SSL_DEBUG_MSG(3, ("no cookie to send; skip extension"));
587 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000588 }
589
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, cookie",
591 handshake->cookie,
592 handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000593
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 MBEDTLS_SSL_CHK_BUF_PTR(p, end, handshake->cookie_len + 6);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000595
Gilles Peskine449bd832023-01-11 14:50:10 +0100596 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding cookie extension"));
XiaokangQian0b64eed2022-01-27 10:36:51 +0000597
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_COOKIE, p, 0);
599 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len + 2, p, 2);
600 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len, p, 4);
XiaokangQian233397e2022-02-07 08:32:16 +0000601 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000602
603 /* Cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 memcpy(p, handshake->cookie, handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000605
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800606 *out_len = handshake->cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000607
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_COOKIE);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800609
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000611}
612
Ronald Cron41a443a2022-10-04 16:38:25 +0200613#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000614/*
615 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
616 *
617 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
618 *
619 * struct {
620 * PskKeyExchangeMode ke_modes<1..255>;
621 * } PskKeyExchangeModes;
622 */
XiaokangQian86981952022-07-19 09:51:50 +0000623MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100624static int ssl_tls13_write_psk_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
625 unsigned char *buf,
626 unsigned char *end,
627 size_t *out_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000628{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000629 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000630 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000631
Gilles Peskine449bd832023-01-11 14:50:10 +0100632 ((void) ke_modes_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000633 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000634
XiaokangQianeb69aee2022-07-05 08:21:43 +0000635 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000636 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000637 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100638 if (!mbedtls_ssl_conf_tls13_some_psk_enabled(ssl)) {
639 MBEDTLS_SSL_DEBUG_MSG(3, ("skip psk_key_exchange_modes extension"));
640 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000641 }
642
643 /* Require 7 bytes of data, otherwise fail,
644 * even if extension might be shorter.
645 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100646 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000647 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 3, ("client hello, adding psk_key_exchange_modes extension"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000649
Gilles Peskine449bd832023-01-11 14:50:10 +0100650 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000651
XiaokangQian008d2bf2022-07-14 07:54:01 +0000652 /* Skip extension length (2 bytes) and
653 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000654 */
655 p += 5;
656
Gilles Peskine449bd832023-01-11 14:50:10 +0100657 if (mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl)) {
XiaokangQianeb69aee2022-07-05 08:21:43 +0000658 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000659 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000660
Gilles Peskine449bd832023-01-11 14:50:10 +0100661 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding PSK-ECDHE key exchange mode"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000662 }
663
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 if (mbedtls_ssl_conf_tls13_psk_enabled(ssl)) {
Ronald Crona709a0f2022-09-27 16:46:11 +0200665 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
666 ke_modes_len++;
667
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding pure PSK key exchange mode"));
Ronald Crona709a0f2022-09-27 16:46:11 +0200669 }
670
XiaokangQian008d2bf2022-07-14 07:54:01 +0000671 /* Now write the extension and ke_modes length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 MBEDTLS_PUT_UINT16_BE(ke_modes_len + 1, buf, 2);
XiaokangQian008d2bf2022-07-14 07:54:01 +0000673 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000674
675 *out_len = p - buf;
Jerry Yu0c354a22022-08-29 15:25:36 +0800676
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800677 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 ssl, MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800679
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000681}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg(int ciphersuite)
Jerry Yuf7c12592022-09-28 22:09:38 +0800684{
Jerry Yu21f90952022-10-08 10:30:53 +0800685 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800687
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 if (ciphersuite_info != NULL) {
Manuel Pégourié-Gonnard1f2a5872023-03-28 11:46:17 +0200689 return mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return PSA_ALG_NONE;
Jerry Yuf7c12592022-09-28 22:09:38 +0800693}
694
Jerry Yuf75364b2022-09-30 10:30:31 +0800695#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100696static int ssl_tls13_has_configured_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qianb781a232022-11-01 07:39:46 +0000697{
698 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return ssl->handshake->resume &&
Pengyu Lv93566782022-12-07 12:10:05 +0800700 session != NULL && session->ticket != NULL &&
Pengyu Lv9b84ea72023-01-16 14:08:23 +0800701 mbedtls_ssl_conf_tls13_check_kex_modes(
702 ssl, mbedtls_ssl_session_get_ticket_flags(
703 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL));
Xiaokang Qianb781a232022-11-01 07:39:46 +0000704}
705
Xiaokang Qian01323a42022-11-03 02:27:35 +0000706#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100707static int ssl_tls13_early_data_has_valid_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qian01323a42022-11-03 02:27:35 +0000708{
709 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 return ssl->handshake->resume &&
711 session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
712 (session->ticket_flags &
713 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) &&
714 mbedtls_ssl_tls13_cipher_suite_is_offered(
715 ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000716}
717#endif
718
Xiaokang Qianb781a232022-11-01 07:39:46 +0000719MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100720static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
721 psa_algorithm_t *hash_alg,
722 const unsigned char **identity,
723 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800724{
725 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800726
Gilles Peskine449bd832023-01-11 14:50:10 +0100727 if (!ssl_tls13_has_configured_ticket(ssl)) {
728 return -1;
729 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800732 *identity = session->ticket;
733 *identity_len = session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800735}
736
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800737MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100738static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
739 psa_algorithm_t *hash_alg,
740 const unsigned char **psk,
741 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800742{
743
744 mbedtls_ssl_session *session = ssl->session_negotiate;
745
Gilles Peskine449bd832023-01-11 14:50:10 +0100746 if (!ssl_tls13_has_configured_ticket(ssl)) {
747 return -1;
748 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800749
Gilles Peskine449bd832023-01-11 14:50:10 +0100750 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800751 *psk = session->resumption_key;
752 *psk_len = session->resumption_key_len;
753
Gilles Peskine449bd832023-01-11 14:50:10 +0100754 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800755}
Jerry Yuf7c12592022-09-28 22:09:38 +0800756#endif /* MBEDTLS_SSL_SESSION_TICKETS */
757
758MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100759static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
760 psa_algorithm_t *hash_alg,
761 const unsigned char **identity,
762 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800763{
Jerry Yu8b41e892022-09-30 10:00:20 +0800764
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
766 return -1;
767 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800768
Jerry Yua99cbfa2022-10-08 11:17:14 +0800769 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800770 *identity = ssl->conf->psk_identity;
771 *identity_len = ssl->conf->psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100772 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800773}
774
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800775MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100776static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
777 psa_algorithm_t *hash_alg,
778 const unsigned char **psk,
779 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800780{
Jerry Yu8b41e892022-09-30 10:00:20 +0800781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
783 return -1;
784 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800785
Jerry Yua99cbfa2022-10-08 11:17:14 +0800786 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800787 *psk = ssl->conf->psk;
788 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800790}
791
Gilles Peskine449bd832023-01-11 14:50:10 +0100792static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800793{
794 int configured_psk_count = 0;
795#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 if (ssl_tls13_has_configured_ticket(ssl)) {
797 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800798 configured_psk_count++;
799 }
800#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100801 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
802 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800803 configured_psk_count++;
804 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800806}
807
Jerry Yuf7c12592022-09-28 22:09:38 +0800808MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100809static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
810 unsigned char *buf,
811 unsigned char *end,
812 const unsigned char *identity,
813 size_t identity_len,
814 uint32_t obfuscated_ticket_age,
815 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800816{
Jerry Yuf75364b2022-09-30 10:30:31 +0800817 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800818 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800819
820 /*
821 * - identity_len (2 bytes)
822 * - identity (psk_identity_len bytes)
823 * - obfuscated_ticket_age (4 bytes)
824 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100825 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800826
Gilles Peskine449bd832023-01-11 14:50:10 +0100827 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
828 memcpy(buf + 2, identity, identity_len);
829 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800830
Gilles Peskine449bd832023-01-11 14:50:10 +0100831 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800832
833 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800834
Gilles Peskine449bd832023-01-11 14:50:10 +0100835 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800836}
837
Jerry Yu8b41e892022-09-30 10:00:20 +0800838MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100839static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
840 unsigned char *buf,
841 unsigned char *end,
842 int psk_type,
843 psa_algorithm_t hash_alg,
844 const unsigned char *psk,
845 size_t psk_len,
846 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800847{
848 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800849 unsigned char binder_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800851 size_t transcript_len = 0;
852
853 *out_len = 0;
854
Gilles Peskine449bd832023-01-11 14:50:10 +0100855 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800856
857 /*
858 * - binder_len (1 bytes)
859 * - binder (binder_len bytes)
860 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100861 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800862
Jerry Yua99cbfa2022-10-08 11:17:14 +0800863 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800864
865 /* Get current state of handshake transcript. */
866 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200867 ssl, mbedtls_md_type_from_psa_alg(hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100868 transcript, sizeof(transcript), &transcript_len);
869 if (ret != 0) {
870 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800871 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100872
873 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
874 psk, psk_len, psk_type,
875 transcript, buf + 1);
876 if (ret != 0) {
877 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
878 return ret;
879 }
880 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800881
882 *out_len = 1 + binder_len;
883
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800885}
886
887/*
888 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
889 *
890 * struct {
891 * opaque identity<1..2^16-1>;
892 * uint32 obfuscated_ticket_age;
893 * } PskIdentity;
894 *
895 * opaque PskBinderEntry<32..255>;
896 *
897 * struct {
898 * PskIdentity identities<7..2^16-1>;
899 * PskBinderEntry binders<33..2^16-1>;
900 * } OfferedPsks;
901 *
902 * struct {
903 * select (Handshake.msg_type) {
904 * case client_hello: OfferedPsks;
905 * ...
906 * };
907 * } PreSharedKeyExtension;
908 *
909 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000910int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
912 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000913{
Jerry Yuf7c12592022-09-28 22:09:38 +0800914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800915 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800916 unsigned char *p = buf;
Xiaokang Qian854db282022-12-19 07:31:27 +0000917 psa_algorithm_t hash_alg = PSA_ALG_NONE;
Jerry Yuf75364b2022-09-30 10:30:31 +0800918 const unsigned char *identity;
919 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800920 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800921 size_t output_len;
Xiaokang Qian7179f812023-02-03 03:38:44 +0000922
Jerry Yuf7c12592022-09-28 22:09:38 +0800923 *out_len = 0;
924 *binders_len = 0;
925
926 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
928 if (configured_psk_count == 0) {
929 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
930 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800931 }
932
Gilles Peskine449bd832023-01-11 14:50:10 +0100933 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
934 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800935
Jerry Yuf7c12592022-09-28 22:09:38 +0800936 /* Check if we have space to write the extension, binders included.
937 * - extension_type (2 bytes)
938 * - extension_data_len (2 bytes)
939 * - identities_len (2 bytes)
940 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100941 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800942 p += 6;
943
Jerry Yuf75364b2022-09-30 10:30:31 +0800944#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 if (ssl_tls13_ticket_get_identity(
946 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800947#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 mbedtls_time_t now = mbedtls_time(NULL);
Jerry Yuf75364b2022-09-30 10:30:31 +0800949 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800950 uint32_t obfuscated_ticket_age =
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 (uint32_t) (now - session->ticket_received);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800952
Jerry Yu3e60cad2023-01-10 14:58:08 +0800953 /*
954 * The ticket timestamp is in seconds but the ticket age is in
955 * milliseconds. If the ticket was received at the end of a second and
956 * re-used here just at the beginning of the next second, the computed
957 * age `now - session->ticket_received` is equal to 1s thus 1000 ms
958 * while the actual age could be just a few milliseconds or tens of
959 * milliseconds. If the server has more accurate ticket timestamps
960 * (typically timestamps in milliseconds), as part of the processing of
961 * the ClientHello, it may compute a ticket lifetime smaller than the
962 * one computed here and potentially reject the ticket. To avoid that,
963 * remove one second to the ticket age if possible.
Jerry Yubdb936b2023-01-07 16:07:46 +0800964 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 if (obfuscated_ticket_age > 0) {
Jerry Yubdb936b2023-01-07 16:07:46 +0800966 obfuscated_ticket_age -= 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 }
Jerry Yubdb936b2023-01-07 16:07:46 +0800968
Jerry Yuf75364b2022-09-30 10:30:31 +0800969 obfuscated_ticket_age *= 1000;
970 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800971
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 ret = ssl_tls13_write_identity(ssl, p, end,
973 identity, identity_len,
974 obfuscated_ticket_age,
975 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800976#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
978 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800979#endif /* MBEDTLS_HAVE_TIME */
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 if (ret != 0) {
981 return ret;
982 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800983
Jerry Yuf75364b2022-09-30 10:30:31 +0800984 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +0800986 }
987#endif /* MBEDTLS_SSL_SESSION_TICKETS */
988
Gilles Peskine449bd832023-01-11 14:50:10 +0100989 if (ssl_tls13_psk_get_identity(
990 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800991
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
993 &output_len);
994 if (ret != 0) {
995 return ret;
996 }
Jerry Yuf75364b2022-09-30 10:30:31 +0800997
Jerry Yuf7c12592022-09-28 22:09:38 +0800998 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +08001000 }
1001
Gilles Peskine449bd832023-01-11 14:50:10 +01001002 MBEDTLS_SSL_DEBUG_MSG(3,
1003 ("client hello, adding pre_shared_key extension, "
1004 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001005
1006 /* Take into account the two bytes for the length of the binders. */
1007 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +08001008 /* Check if there is enough space for binders */
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +08001010
Jerry Yuf7c12592022-09-28 22:09:38 +08001011 /*
1012 * - extension_type (2 bytes)
1013 * - extension_data_len (2 bytes)
1014 * - identities_len (2 bytes)
1015 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
1017 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
1018 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +08001019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001021 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +08001022
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +08001024
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001026}
1027
XiaokangQian86981952022-07-19 09:51:50 +00001028int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001030{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001031 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1032 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001033 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1034 const unsigned char *psk;
1035 size_t psk_len;
1036 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001037
1038 /* Check if we have space to write binders_len.
1039 * - binders_len (2 bytes)
1040 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001041 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001042 p += 2;
1043
Jerry Yu6183cc72022-09-30 11:08:57 +08001044#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001046
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 ret = ssl_tls13_write_binder(ssl, p, end,
1048 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1049 hash_alg, psk, psk_len,
1050 &output_len);
1051 if (ret != 0) {
1052 return ret;
1053 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001054 p += output_len;
1055 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001056#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001057
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001059
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 ret = ssl_tls13_write_binder(ssl, p, end,
1061 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1062 hash_alg, psk, psk_len,
1063 &output_len);
1064 if (ret != 0) {
1065 return ret;
1066 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001067 p += output_len;
1068 }
1069
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001071
1072 /*
1073 * - binders_len (2 bytes)
1074 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001078
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001079 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001081
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001083}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001084
1085/*
1086 * struct {
1087 * opaque identity<1..2^16-1>;
1088 * uint32 obfuscated_ticket_age;
1089 * } PskIdentity;
1090 *
1091 * opaque PskBinderEntry<32..255>;
1092 *
1093 * struct {
1094 *
1095 * select (Handshake.msg_type) {
1096 * ...
1097 * case server_hello: uint16 selected_identity;
1098 * };
1099 *
1100 * } PreSharedKeyExtension;
1101 *
1102 */
1103MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001104static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1105 const unsigned char *buf,
1106 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001107{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001108 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001109 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001110 const unsigned char *psk;
1111 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001112 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001113
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1115 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001116 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001117
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001119
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1121 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001122
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1124 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1125 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001126 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001127
Jerry Yu4a698342022-09-30 12:22:01 +08001128#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1130 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1131 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001132#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1134 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
1135 } else {
1136 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1137 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001138 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 if (ret != 0) {
1140 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001141 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001142
Manuel Pégourié-Gonnard1f2a5872023-03-28 11:46:17 +02001143 if (mbedtls_md_psa_alg_from_type(ssl->handshake->ciphersuite_info->mac)
Xiaokang Qianeb31cbc2023-02-07 02:08:56 +00001144 != hash_alg) {
1145 MBEDTLS_SSL_DEBUG_MSG(
1146 1, ("Invalid ciphersuite for external psk."));
1147
1148 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1149 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1150 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1151 }
1152
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1154 if (ret != 0) {
1155 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1156 return ret;
1157 }
1158
1159 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001160}
Ronald Cron41a443a2022-10-04 16:38:25 +02001161#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001162
Gilles Peskine449bd832023-01-11 14:50:10 +01001163int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1164 unsigned char *buf,
1165 unsigned char *end,
1166 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001167{
1168 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1169 unsigned char *p = buf;
1170 size_t ext_len;
1171
1172 *out_len = 0;
1173
1174 /* Write supported_versions extension
1175 *
1176 * Supported Versions Extension is mandatory with TLS 1.3.
1177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1179 if (ret != 0) {
1180 return ret;
1181 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001182 p += ext_len;
1183
1184 /* Echo the cookie if the server provided one in its preceding
1185 * HelloRetryRequest message.
1186 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1188 if (ret != 0) {
1189 return ret;
1190 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001191 p += ext_len;
1192
Ronald Cron766c0cd2022-10-18 12:17:11 +02001193#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1195 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1196 if (ret != 0) {
1197 return ret;
1198 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001199 p += ext_len;
1200 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001201#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001202
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001203#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1205 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1206 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1207 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1208 if (ret != 0) {
1209 return ret;
1210 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001211 p += ext_len;
1212
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001213 /* Initializes the status to `rejected`. It will be updated to
1214 * `accepted` if the EncryptedExtension message contain an early data
1215 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001216 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001217 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 } else {
1219 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001220 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001221 }
1222#endif /* MBEDTLS_SSL_EARLY_DATA */
1223
Ronald Cron41a443a2022-10-04 16:38:25 +02001224#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001225 /* For PSK-based key exchange we need the pre_shared_key extension
1226 * and the psk_key_exchange_modes extension.
1227 *
1228 * The pre_shared_key extension MUST be the last extension in the
1229 * ClientHello. Servers MUST check that it is the last extension and
1230 * otherwise fail the handshake with an "illegal_parameter" alert.
1231 *
1232 * Add the psk_key_exchange_modes extension.
1233 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1235 if (ret != 0) {
1236 return ret;
1237 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001238 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001239#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001240
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001241 *out_len = p - buf;
1242
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001244}
1245
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00001246int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl)
Xiaokang Qian126929f2023-01-03 10:29:41 +00001247{
Xiaokang Qian90746132023-01-06 05:54:59 +00001248 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001249
Xiaokang Qian126929f2023-01-03 10:29:41 +00001250#if defined(MBEDTLS_SSL_EARLY_DATA)
1251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1252 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1253 const unsigned char *psk;
1254 size_t psk_len;
1255 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001256
Xiaokang Qian126929f2023-01-03 10:29:41 +00001257 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
Xiaokang Qian6be82902023-02-03 06:04:43 +00001258#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1259 mbedtls_ssl_handshake_set_state(
1260 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1261#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00001262 MBEDTLS_SSL_DEBUG_MSG(
1263 1, ("Set hs psk for early data when writing the first psk"));
1264
1265 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1266 if (ret != 0) {
1267 MBEDTLS_SSL_DEBUG_RET(
1268 1, "ssl_tls13_ticket_get_psk", ret);
1269 return ret;
1270 }
1271
1272 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1273 if (ret != 0) {
1274 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1275 return ret;
1276 }
1277
Xiaokang Qian64bc9bc2023-02-07 02:32:23 +00001278 /*
1279 * Early data are going to be encrypted using the ciphersuite
1280 * associated with the pre-shared key used for the handshake.
1281 * Note that if the server rejects early data, the handshake
1282 * based on the pre-shared key may complete successfully
1283 * with a selected ciphersuite different from the ciphersuite
1284 * associated with the pre-shared key. Only the hashes of the
1285 * two ciphersuites have to be the same. In that case, the
1286 * encrypted handshake data and application data are
1287 * encrypted using a different ciphersuite than the one used for
1288 * the rejected early data.
1289 */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001290 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1291 ssl->session_negotiate->ciphersuite);
1292 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001293
Tom Cosgrove5c8505f2023-03-07 11:39:52 +00001294 /* Enable psk and psk_ephemeral to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001295 ssl->handshake->key_exchange_mode =
1296 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1297
1298 /* Start the TLS 1.3 key schedule:
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001299 * Set the PSK and derive early secret.
Xiaokang Qian126929f2023-01-03 10:29:41 +00001300 */
1301 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1302 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001303 MBEDTLS_SSL_DEBUG_RET(
1304 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001305 return ret;
1306 }
1307
1308 /* Derive early data key material */
1309 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1310 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001311 MBEDTLS_SSL_DEBUG_RET(
1312 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001313 return ret;
1314 }
1315
Xiaokang Qian126929f2023-01-03 10:29:41 +00001316 }
1317#endif /* MBEDTLS_SSL_EARLY_DATA */
1318 return 0;
1319}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001320/*
Jerry Yu4a173382021-10-11 21:45:31 +08001321 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001322 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001323
Ronald Cronda41b382022-03-30 09:57:11 +02001324/**
1325 * \brief Detect if the ServerHello contains a supported_versions extension
1326 * or not.
1327 *
1328 * \param[in] ssl SSL context
1329 * \param[in] buf Buffer containing the ServerHello message
1330 * \param[in] end End of the buffer containing the ServerHello message
1331 *
1332 * \return 0 if the ServerHello does not contain a supported_versions extension
1333 * \return 1 if the ServerHello contains a supported_versions extension
1334 * \return A negative value if an error occurred while parsing the ServerHello.
1335 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001336MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001337static int ssl_tls13_is_supported_versions_ext_present(
1338 mbedtls_ssl_context *ssl,
1339 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001341{
1342 const unsigned char *p = buf;
1343 size_t legacy_session_id_echo_len;
Ronald Croneff56732023-04-03 17:36:31 +02001344 const unsigned char *supported_versions_data;
1345 const unsigned char *supported_versions_data_end;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001346
1347 /*
1348 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001349 * length:
1350 * - legacy_version 2 bytes
1351 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1352 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001355 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1356 legacy_session_id_echo_len = *p;
1357
1358 /*
1359 * Jump to the extensions, jumping over:
1360 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1361 * - cipher_suite 2 bytes
1362 * - legacy_compression_method 1 byte
1363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1365 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001366
Ronald Cron47dce632023-02-08 17:38:29 +01001367 return mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1368 ssl, p, end,
Ronald Croneff56732023-04-03 17:36:31 +02001369 &supported_versions_data, &supported_versions_data_end);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001370}
1371
Jerry Yu7a186a02021-10-15 18:46:14 +08001372/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001373 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1374 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1375 * - 0 otherwise
1376 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001377MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001378static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1379 const unsigned char *buf,
1380 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001381{
1382 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1383 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001385 const unsigned char *last_eight_bytes_of_random;
1386 unsigned char last_byte_of_random;
1387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001389 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1390
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 if (memcmp(last_eight_bytes_of_random,
1392 magic_downgrade_string,
1393 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001394 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001395 return last_byte_of_random == 0 ||
1396 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001397 }
1398
Gilles Peskine449bd832023-01-11 14:50:10 +01001399 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001400}
1401
1402/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001403 * - SSL_SERVER_HELLO or
1404 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001405 * to indicate which message is expected and to be parsed next.
1406 */
Ronald Cron828aff62022-05-31 12:04:31 +02001407#define SSL_SERVER_HELLO 0
1408#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001409MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001410static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1411 const unsigned char *buf,
1412 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001413{
Jerry Yue1b9c292021-09-10 10:08:31 +08001414
1415 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1416 *
Jerry Yu4a173382021-10-11 21:45:31 +08001417 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001418 * special value of the SHA-256 of "HelloRetryRequest".
1419 *
1420 * struct {
1421 * ProtocolVersion legacy_version = 0x0303;
1422 * Random random;
1423 * opaque legacy_session_id_echo<0..32>;
1424 * CipherSuite cipher_suite;
1425 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001426 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001427 * } ServerHello;
1428 *
1429 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001430 MBEDTLS_SSL_CHK_BUF_READ_PTR(
1431 buf, end, 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001432
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1434 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1435 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001436 }
1437
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001439}
1440
Ronald Cron828aff62022-05-31 12:04:31 +02001441/*
Jerry Yu745bb612021-10-13 22:01:04 +08001442 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001443 * - SSL_SERVER_HELLO or
1444 * - SSL_SERVER_HELLO_HRR or
1445 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001446 */
Ronald Cron828aff62022-05-31 12:04:31 +02001447#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001448MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001449static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1450 const unsigned char *buf,
1451 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001452{
Jerry Yu4a173382021-10-11 21:45:31 +08001453 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001454 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001455
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1457 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001458
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001460 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001462
1463 /* If the server is negotiating TLS 1.2 or below and:
1464 * . we did not propose TLS 1.2 or
1465 * . the server responded it is TLS 1.3 capable but negotiating a lower
1466 * version of the protocol and thus we are under downgrade attack
1467 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001468 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1470 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1471 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1472 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001473 }
1474
Ronald Cronb828c7d2023-04-03 16:37:22 +02001475 /*
1476 * Version 1.2 of the protocol has been negotiated, set the
1477 * ssl->keep_current_message flag for the ServerHello to be kept and
1478 * parsed as a TLS 1.2 ServerHello. We also change ssl->tls_version to
1479 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1480 * will dispatch to the TLS 1.2 state machine.
1481 */
Ronald Cron9f0fba32022-02-10 16:45:15 +01001482 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001483 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001484 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1485 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1486 buf, (size_t) (end - buf)));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001487
Gilles Peskine449bd832023-01-11 14:50:10 +01001488 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1489 ret = ssl_tls13_reset_key_share(ssl);
1490 if (ret != 0) {
1491 return ret;
1492 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001493 }
1494
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001496 }
1497
Jerry Yua66fece2022-07-13 14:30:29 +08001498#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1499 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1500 ssl->session_negotiate->tls_version = ssl->tls_version;
1501#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1502
Jerry Yu50e00e32022-10-31 14:45:01 +08001503 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001504
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1506 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001507 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001509 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001510 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001512 /* If a client receives a second HelloRetryRequest in the same
1513 * connection (i.e., where the ClientHello was itself in response
1514 * to a HelloRetryRequest), it MUST abort the handshake with an
1515 * "unexpected_message" alert.
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 */
1517 if (handshake->hello_retry_request_count > 0) {
1518 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001519 MBEDTLS_SSL_PEND_FATAL_ALERT(
1520 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1521 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001523 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001524 /*
1525 * Clients must abort the handshake with an "illegal_parameter"
1526 * alert if the HelloRetryRequest would not result in any change
1527 * in the ClientHello.
1528 * In a PSK only key exchange that what we expect.
1529 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1531 MBEDTLS_SSL_DEBUG_MSG(1,
1532 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001533 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1535 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1536 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001537 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001538
Ronald Cron5afb9042022-05-31 12:11:39 +02001539 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001540
Jerry Yu745bb612021-10-13 22:01:04 +08001541 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001542 }
1543
1544cleanup:
1545
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001547}
1548
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001549MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001550static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1551 const unsigned char **buf,
1552 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001553{
1554 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001555 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001556
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1558 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001559
Gilles Peskine449bd832023-01-11 14:50:10 +01001560 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001561
1562 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1564 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1565 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1566 ssl->session_negotiate->id,
1567 ssl->session_negotiate->id_len);
1568 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1569 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001570
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1572 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001573
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001575 }
1576
Jerry Yu4a173382021-10-11 21:45:31 +08001577 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001578 *buf = p;
1579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1581 ssl->session_negotiate->id_len);
1582 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001583}
1584
Jerry Yue1b9c292021-09-10 10:08:31 +08001585/* Parse ServerHello message and configure context
1586 *
1587 * struct {
1588 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1589 * Random random;
1590 * opaque legacy_session_id_echo<0..32>;
1591 * CipherSuite cipher_suite;
1592 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001593 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001594 * } ServerHello;
1595 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001596MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001597static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1598 const unsigned char *buf,
1599 const unsigned char *end,
1600 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001601{
Jerry Yub85277e2021-10-13 13:36:05 +08001602 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001603 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001604 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001605 size_t extensions_len;
1606 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001607 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001608 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001609 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001610 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001611 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001612 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001613
1614 /*
1615 * Check there is space for minimal fields
1616 *
1617 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001618 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001619 * - legacy_session_id_echo ( 1 byte ), minimum size
1620 * - cipher_suite ( 2 bytes)
1621 * - legacy_compression_method ( 1 byte )
1622 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001624
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1626 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001627
Jerry Yu4a173382021-10-11 21:45:31 +08001628 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001629 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001630 * ...
1631 * with ProtocolVersion defined as:
1632 * uint16 ProtocolVersion;
1633 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1635 MBEDTLS_SSL_VERSION_TLS1_2) {
1636 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1637 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1638 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001639 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1640 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001641 }
1642 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001643
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001644 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001645 * Random random;
1646 * ...
1647 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001648 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001649 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 if (!is_hrr) {
1651 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1652 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1653 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1654 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001655 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001656 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001657
Jerry Yu4a173382021-10-11 21:45:31 +08001658 /* ...
1659 * opaque legacy_session_id_echo<0..32>;
1660 * ...
1661 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001663 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001664 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001665 }
1666
Jerry Yu4a173382021-10-11 21:45:31 +08001667 /* ...
1668 * CipherSuite cipher_suite;
1669 * ...
1670 * with CipherSuite defined as:
1671 * uint8 CipherSuite[2];
1672 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1674 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001675 p += 2;
1676
Jerry Yu4a173382021-10-11 21:45:31 +08001677
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001679 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001680 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001681 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001682 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1683 ssl->tls_version,
1684 ssl->tls_version) != 0) ||
1685 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001686 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001687 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001688 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001689 * If we received an HRR before and that the proposed selected
1690 * ciphersuite in this server hello is not the same as the one
1691 * proposed in the HRR, we abort the handshake and send an
1692 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001693 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1695 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001696 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001697 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1700 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1701 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001702 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001703 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001704
Jerry Yu4a173382021-10-11 21:45:31 +08001705 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001707
XiaokangQian355e09a2022-01-20 11:14:50 +00001708 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1710 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001711
1712#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001713 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001714#endif /* MBEDTLS_HAVE_TIME */
1715
Jerry Yu4a173382021-10-11 21:45:31 +08001716 /* ...
1717 * uint8 legacy_compression_method = 0;
1718 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001719 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1721 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1722 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001723 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001724 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001725 }
1726 p++;
1727
Jerry Yub85277e2021-10-13 13:36:05 +08001728 /* ...
1729 * Extension extensions<6..2^16-1>;
1730 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001731 * struct {
1732 * ExtensionType extension_type; (2 bytes)
1733 * opaque extension_data<0..2^16-1>;
1734 * } Extension;
1735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1737 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001738 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001739
Jerry Yu4a173382021-10-11 21:45:31 +08001740 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001742 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001743
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001745
Jerry Yu50e00e32022-10-31 14:45:01 +08001746 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001747 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1749 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001750
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001752 unsigned int extension_type;
1753 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001754 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1757 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1758 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001759 p += 4;
1760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001762 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001763
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001764 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1766 if (ret != 0) {
1767 return ret;
1768 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001769
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001771 case MBEDTLS_TLS_EXT_COOKIE:
1772
Gilles Peskine449bd832023-01-11 14:50:10 +01001773 ret = ssl_tls13_parse_cookie_ext(ssl,
1774 p, extension_data_end);
1775 if (ret != 0) {
1776 MBEDTLS_SSL_DEBUG_RET(1,
1777 "ssl_tls13_parse_cookie_ext",
1778 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001779 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001780 }
XiaokangQianb851da82022-01-14 04:03:11 +00001781 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001782
Jerry Yue1b9c292021-09-10 10:08:31 +08001783 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1785 p,
1786 extension_data_end);
1787 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001788 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001790 break;
1791
Ronald Cron41a443a2022-10-04 16:38:25 +02001792#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001793 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001795
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1797 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001798 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1800 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001801 }
1802 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001803#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001804
Jerry Yue1b9c292021-09-10 10:08:31 +08001805 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1807 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001808 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001809 goto cleanup;
1810 }
1811
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 if (is_hrr) {
1813 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1814 p, extension_data_end);
1815 } else {
1816 ret = ssl_tls13_parse_key_share_ext(ssl,
1817 p, extension_data_end);
1818 }
1819 if (ret != 0) {
1820 MBEDTLS_SSL_DEBUG_RET(1,
1821 "ssl_tls13_parse_key_share_ext",
1822 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001823 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001824 }
1825 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001826
1827 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001828 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1829 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001830 }
1831
1832 p += extension_data_len;
1833 }
1834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001836
XiaokangQiand59be772022-01-24 10:12:51 +00001837cleanup:
1838
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1840 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1841 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001842 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1844 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1845 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001846 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1847 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001849}
1850
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001851#if defined(MBEDTLS_DEBUG_C)
1852static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001853{
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001855 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1856 return "psk";
1857 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1858 return "ephemeral";
1859 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1860 return "psk_ephemeral";
1861 default:
1862 return "unknown mode";
1863 }
1864}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001865#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001866
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001867MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001868static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001869{
Jerry Yub85277e2021-10-13 13:36:05 +08001870 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001871 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001872
Jerry Yub85277e2021-10-13 13:36:05 +08001873 /* Determine the key exchange mode:
1874 * 1) If both the pre_shared_key and key_share extensions were received
1875 * then the key exchange mode is PSK with EPHEMERAL.
1876 * 2) If only the pre_shared_key extension was received then the key
1877 * exchange mode is PSK-only.
1878 * 3) If only the key_share extension was received then the key
1879 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001880 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 switch (handshake->received_extensions &
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001882 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1883 MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001884 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001886 handshake->key_exchange_mode =
1887 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001888 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001889
Jerry Yu745bb612021-10-13 22:01:04 +08001890 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001892 handshake->key_exchange_mode =
1893 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001894 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001895
Jerry Yu745bb612021-10-13 22:01:04 +08001896 /* Both the pre_shared_key and key_share extensions were received */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001897 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1898 MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
1899 handshake->key_exchange_mode =
1900 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001901 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001902
Jerry Yu745bb612021-10-13 22:01:04 +08001903 /* Neither pre_shared_key nor key_share extension was received */
1904 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001906 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1907 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001908 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001909#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001910 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1911 (handshake->selected_identity != 0 ||
1912 handshake->ciphersuite_info->id !=
1913 ssl->session_negotiate->ciphersuite)) {
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001914 /* RFC8446 4.2.11
1915 * If the server supplies an "early_data" extension, the
1916 * client MUST verify that the server's selected_identity
1917 * is 0. If any other value is returned, the client MUST
1918 * abort the handshake with an "illegal_parameter" alert.
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001919 *
Xiaokang Qian53c4c272023-02-07 02:42:01 +00001920 * RFC 8446 4.2.10
1921 * In order to accept early data, the server MUST have accepted a PSK
1922 * cipher suite and selected the first key offered in the client's
1923 * "pre_shared_key" extension. In addition, it MUST verify that the
1924 * following values are the same as those associated with the
1925 * selected PSK:
1926 * - The TLS version number
1927 * - The selected cipher suite
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001928 * - The selected ALPN [RFC7301] protocol, if any
1929 *
1930 * We check here that when early data is involved the server
1931 * selected the cipher suite associated to the pre-shared key
1932 * as it must have.
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001933 */
1934 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1935 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1936 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1937 }
1938#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001939
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001940 if (!mbedtls_ssl_conf_tls13_check_kex_modes(
1941 ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001942 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001943 MBEDTLS_SSL_DEBUG_MSG(
1944 2, ("Key exchange mode(%s) is not supported.",
1945 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001946 goto cleanup;
1947 }
1948
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001949 MBEDTLS_SSL_DEBUG_MSG(
1950 3, ("Selected key exchange mode: %s",
1951 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001952
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001953 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001954 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001955 * If we proposed early data then we have already derived an
1956 * early secret using the selected PSK and its associated hash.
1957 * It means that if the negotiated key exchange mode is psk or
1958 * psk_ephemeral, we have already correctly computed the
1959 * early secret and thus we do not do it again. In all other
1960 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001961 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001962#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001963 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1964 handshake->key_exchange_mode ==
1965 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001966#endif
1967 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001968 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1969 if (ret != 0) {
1970 MBEDTLS_SSL_DEBUG_RET(
1971 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1972 goto cleanup;
1973 }
Jerry Yu0b177842021-09-05 19:41:30 +08001974 }
1975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1977 if (ret != 0) {
1978 MBEDTLS_SSL_DEBUG_RET(1,
1979 "mbedtls_ssl_tls13_compute_handshake_transform",
1980 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001981 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001982 }
1983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1985 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001986 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
Jerry Yu0b177842021-09-05 19:41:30 +08001987 ssl->session_in = ssl->session_negotiate;
1988
Jerry Yu4a173382021-10-11 21:45:31 +08001989cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001991 MBEDTLS_SSL_PEND_FATAL_ALERT(
1992 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001994 }
Jerry Yue110d252022-05-05 10:19:22 +08001995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001997}
1998
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001999MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002000static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00002001{
2002 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00002005
XiaokangQian78b1fa72022-01-19 06:56:30 +00002006 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00002007 * We are going to re-generate a shared secret corresponding to the group
2008 * selected by the server, which is different from the group for which we
2009 * generated a shared secret in the first client hello.
2010 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00002011 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 ret = ssl_tls13_reset_key_share(ssl);
2013 if (ret != 0) {
2014 return ret;
2015 }
XiaokangQian647719a2021-12-07 09:16:29 +00002016
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00002017 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002019}
2020
Jerry Yue1b9c292021-09-10 10:08:31 +08002021/*
Jerry Yu4a173382021-10-11 21:45:31 +08002022 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002023 * Handler for MBEDTLS_SSL_SERVER_HELLO
2024 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002025MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002026static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002027{
Jerry Yu4a173382021-10-11 21:45:31 +08002028 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002029 unsigned char *buf = NULL;
2030 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002031 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002032
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002034
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002035 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2036 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002037
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2039 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002040 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 } else {
2042 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2043 }
XiaokangQiand59be772022-01-24 10:12:51 +00002044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002046 ret = 0;
2047 goto cleanup;
2048 }
2049
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2051 buf + buf_len,
2052 is_hrr));
2053 if (is_hrr) {
2054 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002055 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002056
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002057 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2058 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002059
2060 if (is_hrr) {
2061 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2062#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2063 /* If not offering early data, the client sends a dummy CCS record
2064 * immediately before its second flight. This may either be before
2065 * its second ClientHello or before its encrypted handshake flight.
2066 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002067 mbedtls_ssl_handshake_set_state(
2068 ssl, MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
Gilles Peskine449bd832023-01-11 14:50:10 +01002069#else
2070 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2071#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2072 } else {
2073 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2074 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002075 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002076
2077cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2079 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2080 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002081}
2082
2083/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002084 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002085 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002086 *
2087 * The EncryptedExtensions message contains any extensions which
2088 * should be protected, i.e., any which are not needed to establish
2089 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002090 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002091
XiaokangQian08da26c2021-10-09 10:12:11 +00002092/* Parse EncryptedExtensions message
2093 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002094 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002095 * } EncryptedExtensions;
2096 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002097MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002098static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2099 const unsigned char *buf,
2100 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002101{
2102 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002103 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002104 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002105 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002106 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2109 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002110 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002113 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002114
Jan Bruckner5a3629b2023-02-23 12:08:09 +01002115 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2116
Jerry Yu9eba7502022-10-31 13:46:16 +08002117 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002118
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002120 unsigned int extension_type;
2121 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002122
XiaokangQian08da26c2021-10-09 10:12:11 +00002123 /*
2124 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002125 * ExtensionType extension_type; (2 bytes)
2126 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002127 * } Extension;
2128 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2130 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2131 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002132 p += 4;
2133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002135
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002136 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2138 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2139 if (ret != 0) {
2140 return ret;
2141 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002144#if defined(MBEDTLS_SSL_ALPN)
2145 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002147
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002148 if ((ret = ssl_tls13_parse_alpn_ext(
2149 ssl, p, (size_t) extension_data_len)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002151 }
2152
2153 break;
2154#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002155
2156#if defined(MBEDTLS_SSL_EARLY_DATA)
2157 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002158
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002160 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2162 MBEDTLS_ERR_SSL_DECODE_ERROR);
2163 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002164 }
2165
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002166 break;
2167#endif /* MBEDTLS_SSL_EARLY_DATA */
2168
Jan Bruckner151f6422023-02-10 12:45:19 +01002169#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2170 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
2171 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
2172
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002173 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
2174 ssl, p, p + extension_data_len);
Jan Bruckner151f6422023-02-10 12:45:19 +01002175
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002176 /* TODO: Return unconditionally here until we handle the record
2177 * size limit correctly. Once handled correctly, only return in
2178 * case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01002179 return ret;
2180
2181 break;
2182#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2183
XiaokangQian08da26c2021-10-09 10:12:11 +00002184 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002185 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002186 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002188 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002189 }
2190
XiaokangQian08da26c2021-10-09 10:12:11 +00002191 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002192 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002193
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2195 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002196
XiaokangQian97799ac2021-10-11 10:05:54 +00002197 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (p != end) {
2199 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2200 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2201 MBEDTLS_ERR_SSL_DECODE_ERROR);
2202 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002203 }
2204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002206}
2207
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002208MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002209static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002210{
2211 int ret;
2212 unsigned char *buf;
2213 size_t buf_len;
2214
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002216
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002217 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2218 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2219 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002220
2221 /* Process the message contents */
2222 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002224
Xiaokang Qianb157e912022-11-23 08:12:26 +00002225#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 if (ssl->handshake->received_extensions &
2227 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002228 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2229 }
2230#endif
2231
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002232 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2233 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2234 buf, buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002235
Ronald Cron928cbd32022-10-04 16:14:26 +02002236#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2238 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2239 } else {
2240 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2241 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002242#else
2243 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002245#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002246
2247cleanup:
2248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2250 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002251
2252}
2253
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002254/*
2255 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2256 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002257 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002258 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002259 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002260 *
2261 * If the server sent an "early_data" extension in EncryptedExtensions, the
2262 * client MUST send an EndOfEarlyData message after receiving the server
2263 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002264 */
2265
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002266MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002267static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2268{
2269 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002270 unsigned char *buf = NULL;
2271 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002272 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002273
Xiaokang Qian742578c2022-12-19 06:34:44 +00002274 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
Xiaokang Qian0de0d862023-02-08 06:04:50 +00002275 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
2276 &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002277
Manuel Pégourié-Gonnard63e33dd2023-02-21 15:45:15 +01002278 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_hdr_to_checksum(
2279 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002280
Xiaokang Qian742578c2022-12-19 06:34:44 +00002281 MBEDTLS_SSL_PROC_CHK(
2282 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002283
Xiaokang Qian19d44162023-01-03 03:39:50 +00002284 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002285
2286cleanup:
2287
2288 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2289 return ret;
2290}
2291
Ronald Cron928cbd32022-10-04 16:14:26 +02002292#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002293/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002294 * STATE HANDLING: CertificateRequest
2295 *
Jerry Yud2674312021-10-29 10:08:19 +08002296 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002297#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2298#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002299/* Coordination:
2300 * Deals with the ambiguity of not knowing if a CertificateRequest
2301 * will be sent. Returns a negative code on failure, or
2302 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2303 * - SSL_CERTIFICATE_REQUEST_SKIP
2304 * indicating if a Certificate Request is expected or not.
2305 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002306MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002307static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002308{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002309 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002310
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2312 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2313 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002314 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002315 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2318 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2319 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2320 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002321 }
2322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002326}
2327
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002328/*
2329 * ssl_tls13_parse_certificate_request()
2330 * Parse certificate request
2331 * struct {
2332 * opaque certificate_request_context<0..2^8-1>;
2333 * Extension extensions<2..2^16-1>;
2334 * } CertificateRequest;
2335 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002336MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002337static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2338 const unsigned char *buf,
2339 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002340{
2341 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2342 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002343 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002344 size_t extensions_len = 0;
2345 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002346 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002347
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002348 /* ...
2349 * opaque certificate_request_context<0..2^8-1>
2350 * ...
2351 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002353 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002354 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002355
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (certificate_request_context_len > 0) {
2357 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2358 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2359 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002360
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002361 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 mbedtls_calloc(1, certificate_request_context_len);
2363 if (handshake->certificate_request_context == NULL) {
2364 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2365 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002366 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 memcpy(handshake->certificate_request_context, p,
2368 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002369 p += certificate_request_context_len;
2370 }
2371
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002372 /* ...
2373 * Extension extensions<2..2^16-1>;
2374 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002375 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2377 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002378 p += 2;
2379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002381 extensions_end = p + extensions_len;
2382
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002383 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002384
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002386 unsigned int extension_type;
2387 size_t extension_data_len;
2388
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2390 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2391 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002392 p += 4;
2393
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002395
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002396 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2398 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2399 if (ret != 0) {
2400 return ret;
2401 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002404 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 MBEDTLS_SSL_DEBUG_MSG(3,
2406 ("found signature algorithms extension"));
2407 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2408 p + extension_data_len);
2409 if (ret != 0) {
2410 return ret;
2411 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002412
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002413 break;
2414
2415 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002416 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002417 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002419 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002420 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002421
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002422 p += extension_data_len;
2423 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002424
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2426 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002427
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002428 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 if (p != end) {
2430 MBEDTLS_SSL_DEBUG_MSG(1,
2431 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002432 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002433 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002434
Jerry Yu0c354a22022-08-29 15:25:36 +08002435 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002436 *
2437 * The "signature_algorithms" extension MUST be specified
2438 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2440 MBEDTLS_SSL_DEBUG_MSG(3,
2441 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002442 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002443 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002444
Jerry Yu7840f812022-01-29 10:26:51 +08002445 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002447
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002448decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2450 MBEDTLS_ERR_SSL_DECODE_ERROR);
2451 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002452}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002453
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002454/*
2455 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2456 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002457MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002458static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002459{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002460 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002461
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002465
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002467 unsigned char *buf;
2468 size_t buf_len;
2469
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002470 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2471 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2472 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002473
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002474 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(
2475 ssl, buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002476
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002477 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2478 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2479 buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002481 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 } else {
2483 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002484 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2485 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002486 }
2487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002489
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002490cleanup:
2491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2493 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002494}
2495
2496/*
Jerry Yu687101b2021-09-14 16:03:56 +08002497 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2498 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002499MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002500static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002501{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002502 int ret;
2503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2505 if (ret != 0) {
2506 return ret;
2507 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2510 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002511}
2512
2513/*
2514 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2515 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002516MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002517static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002518{
Jerry Yu30b071c2021-09-12 20:16:03 +08002519 int ret;
2520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2522 if (ret != 0) {
2523 return ret;
2524 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002525
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2527 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002528}
Ronald Cron928cbd32022-10-04 16:14:26 +02002529#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002530
Jerry Yu687101b2021-09-14 16:03:56 +08002531/*
2532 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2533 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002534MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002535static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002536{
XiaokangQianac0385c2021-11-03 06:40:11 +00002537 int ret;
2538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2540 if (ret != 0) {
2541 return ret;
2542 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2545 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002546 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2548 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2549 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002550 }
2551
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002552#if defined(MBEDTLS_SSL_EARLY_DATA)
2553 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2554 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002555 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2556 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002557 } else
2558#endif /* MBEDTLS_SSL_EARLY_DATA */
2559 {
2560#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2561 mbedtls_ssl_handshake_set_state(
2562 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2563#else
2564 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2565#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2566 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002569}
2570
2571/*
Jerry Yu566c7812022-01-26 15:41:22 +08002572 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2573 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002574MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002575static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002576{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002577 int non_empty_certificate_msg = 0;
2578
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 MBEDTLS_SSL_DEBUG_MSG(1,
2580 ("Switch to handshake traffic keys for outbound traffic"));
2581 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002582
Ronald Cron928cbd32022-10-04 16:14:26 +02002583#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (ssl->handshake->client_auth) {
2585 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2586 if (ret != 0) {
2587 return ret;
2588 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002589
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002591 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 }
2593 } else {
2594 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002595 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002596#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002597
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 if (non_empty_certificate_msg) {
2599 mbedtls_ssl_handshake_set_state(ssl,
2600 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2601 } else {
2602 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2603 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2604 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002605
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002607}
2608
Ronald Cron928cbd32022-10-04 16:14:26 +02002609#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002610/*
2611 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2612 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002613MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002614static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002615{
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (ret == 0) {
2619 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2620 }
Ronald Crona8b38872022-03-09 07:59:25 +01002621
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002623}
Ronald Cron928cbd32022-10-04 16:14:26 +02002624#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002625
2626/*
Jerry Yu687101b2021-09-14 16:03:56 +08002627 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2628 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002629MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002630static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002631{
XiaokangQian0fa66432021-11-15 03:33:57 +00002632 int ret;
2633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2635 if (ret != 0) {
2636 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002637 }
2638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2640 if (ret != 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002641 MBEDTLS_SSL_DEBUG_RET(
2642 1, "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 return ret;
2644 }
2645
2646 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2647 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002648}
2649
2650/*
2651 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2652 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002653MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002654static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002655{
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2657 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2658 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002659}
2660
2661/*
2662 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2663 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002664MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002665static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002666{
Jerry Yu378254d2021-10-30 21:44:47 +08002667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2671 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002672}
2673
Jerry Yuf8a49942022-07-07 11:32:32 +00002674#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2675
Jerry Yua0446a02022-07-13 11:22:55 +08002676MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002677static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2678 const unsigned char *buf,
2679 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002680{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002681 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002682 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002683
Jerry Yuf8a49942022-07-07 11:32:32 +00002684
Jerry Yuedab6372022-10-31 14:37:31 +08002685 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002688 unsigned int extension_type;
2689 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002690 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2693 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2694 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002695 p += 4;
2696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002698
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002699 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2701 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2702 if (ret != 0) {
2703 return ret;
2704 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002707#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002708 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002710 MBEDTLS_SSL_PEND_FATAL_ALERT(
2711 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 MBEDTLS_ERR_SSL_DECODE_ERROR);
2713 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002714 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002716 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002718 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002719 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002720#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002721
Jerry Yuf8a49942022-07-07 11:32:32 +00002722 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002723 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002724 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002726 break;
2727 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002728
Jerry Yuf8a49942022-07-07 11:32:32 +00002729 p += extension_data_len;
2730 }
2731
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2733 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002734
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002736}
2737
2738/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002739 * From RFC8446, page 74
2740 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002741 * struct {
2742 * uint32 ticket_lifetime;
2743 * uint32 ticket_age_add;
2744 * opaque ticket_nonce<0..255>;
2745 * opaque ticket<1..2^16-1>;
2746 * Extension extensions<0..2^16-2>;
2747 * } NewSessionTicket;
2748 *
2749 */
Jerry Yua0446a02022-07-13 11:22:55 +08002750MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002751static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2752 unsigned char *buf,
2753 unsigned char *end,
2754 unsigned char **ticket_nonce,
2755 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002756{
2757 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2758 unsigned char *p = buf;
2759 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002760 size_t ticket_len;
2761 unsigned char *ticket;
2762 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002763
Jerry Yucb3b1392022-07-12 06:09:38 +00002764 *ticket_nonce = NULL;
2765 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002766 /*
2767 * ticket_lifetime 4 bytes
2768 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002769 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002772
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2774 MBEDTLS_SSL_DEBUG_MSG(3,
2775 ("ticket_lifetime: %u",
2776 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002777
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2779 MBEDTLS_SSL_DEBUG_MSG(3,
2780 ("ticket_age_add: %u",
2781 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002782
Jerry Yucb3b1392022-07-12 06:09:38 +00002783 *ticket_nonce_len = p[8];
2784 p += 9;
2785
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002787 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002789 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002790
2791 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2793 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002794 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2796 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002797
2798 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 if (session->ticket != NULL || session->ticket_len > 0) {
2800 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002801 session->ticket = NULL;
2802 session->ticket_len = 0;
2803 }
2804
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2806 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2807 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002808 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002810 p += ticket_len;
2811 session->ticket = ticket;
2812 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002813
Pengyu Lv9f926952022-11-17 15:22:33 +08002814 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002815 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002816 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002817
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2819 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002820 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2826 if (ret != 0) {
2827 MBEDTLS_SSL_DEBUG_RET(1,
2828 "ssl_tls13_parse_new_session_ticket_exts",
2829 ret);
2830 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002831 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002832
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002833 /* session has been updated, allow export */
2834 session->exported = 0;
2835
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002837}
2838
Jerry Yua0446a02022-07-13 11:22:55 +08002839MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002840static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2841 unsigned char *ticket_nonce,
2842 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002843{
2844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2845 mbedtls_ssl_session *session = ssl->session;
2846 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2847 psa_algorithm_t psa_hash_alg;
2848 int hash_length;
2849
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002850#if defined(MBEDTLS_HAVE_TIME)
2851 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002853#endif
2854
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2856 if (ciphersuite_info == NULL) {
2857 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2858 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002859 }
2860
Manuel Pégourié-Gonnard1f2a5872023-03-28 11:46:17 +02002861 psa_hash_alg = mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2863 if (hash_length == -1 ||
2864 (size_t) hash_length > sizeof(session->resumption_key)) {
2865 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002866 }
2867
Jerry Yuf8a49942022-07-07 11:32:32 +00002868
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2870 session->app_secrets.resumption_master_secret,
2871 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002872
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002873 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002874 *
2875 * HKDF-Expand-Label( resumption_master_secret,
2876 * "resumption", ticket_nonce, Hash.length )
2877 */
2878 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 psa_hash_alg,
2880 session->app_secrets.resumption_master_secret,
2881 hash_length,
2882 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2883 ticket_nonce,
2884 ticket_nonce_len,
2885 session->resumption_key,
2886 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 if (ret != 0) {
2889 MBEDTLS_SSL_DEBUG_RET(2,
2890 "Creating the ticket-resumed PSK failed",
2891 ret);
2892 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002893 }
2894
Jerry Yu0a430c82022-07-20 11:02:48 +08002895 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2898 session->resumption_key,
2899 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002900
Pengyu Lv9f926952022-11-17 15:22:33 +08002901 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002902 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002903 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002904 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002907}
2908
2909/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002910 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002911 */
Jerry Yua0446a02022-07-13 11:22:55 +08002912MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002913static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002914{
2915 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2916 unsigned char *buf;
2917 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002918 unsigned char *ticket_nonce;
2919 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002922
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2924 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2925 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002926
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2928 ssl, buf, buf + buf_len,
2929 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2932 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002935
Jerry Yuf8a49942022-07-07 11:32:32 +00002936cleanup:
2937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2939 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002940}
2941#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002944{
Jerry Yu92c6b402021-08-27 16:59:09 +08002945 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002948 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002950 break;
2951
Jerry Yu92c6b402021-08-27 16:59:09 +08002952 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002954 break;
2955
2956 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002958 break;
2959
2960 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002962 break;
2963
Ronald Cron928cbd32022-10-04 16:14:26 +02002964#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002965 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002967 break;
2968
Jerry Yu687101b2021-09-14 16:03:56 +08002969 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002971 break;
2972
2973 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002975 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002976#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002977
2978 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002980 break;
2981
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002982 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2983 ret = ssl_tls13_write_end_of_early_data(ssl);
2984 break;
2985
Jerry Yu566c7812022-01-26 15:41:22 +08002986 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002988 break;
2989
Ronald Cron928cbd32022-10-04 16:14:26 +02002990#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002991 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002993 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002994#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002995
Jerry Yu687101b2021-09-14 16:03:56 +08002996 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002998 break;
2999
3000 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003002 break;
3003
3004 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08003006 break;
3007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 /*
3009 * Injection of dummy-CCS's for middlebox compatibility
3010 */
Ronald Cron49ad6192021-11-24 16:25:31 +01003011#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00003012 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3014 if (ret == 0) {
3015 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3016 }
Ronald Cron9f55f632022-02-02 16:02:47 +01003017 break;
3018
3019 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3021 if (ret == 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00003022 mbedtls_ssl_handshake_set_state(
3023 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 }
Ronald Cron49ad6192021-11-24 16:25:31 +01003025 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003026
Xiaokang Qian592021a2023-01-04 10:47:05 +00003027 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3028 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3029 if (ret == 0) {
3030 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3031
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003032#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003033 MBEDTLS_SSL_DEBUG_MSG(
3034 1, ("Switch to early data keys for outbound traffic"));
3035 mbedtls_ssl_set_outbound_transform(
3036 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003037#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003038 }
3039 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003040#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3041
Jerry Yuf8a49942022-07-07 11:32:32 +00003042#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003043 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 ret = ssl_tls13_process_new_session_ticket(ssl);
3045 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003046 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003048 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3049 break;
3050#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3051
Jerry Yu92c6b402021-08-27 16:59:09 +08003052 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003055 }
3056
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003058}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003059
Jerry Yufb4b6472022-01-27 15:03:26 +08003060#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */