blob: 90f54f94b85c36de5ac7beec63ecb69987b71515 [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 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +020019 * This file is part of Mbed TLS ( https://tls.mbed.org )
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080020 */
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 Settic9ae8622023-07-25 11:23:50 +020038#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
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
Valerio Settic9ae8622023-07-25 11:23:50 +0200197#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200198 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
Valerio Settic9ae8622023-07-25 11:23:50 +0200214#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
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 Stekiel408569f2023-07-06 11:26:44 +0200332 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_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
Valerio Settic9ae8622023-07-25 11:23:50 +0200506#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200507 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
Valerio Settic9ae8622023-07-25 11:23:50 +0200516#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
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) {
Dave Rodgman2eab4622023-10-05 13:30:37 +0100689 return mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) 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
Jerry Yu06b364f2023-10-18 11:22:50 +08001025 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
1026
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001028}
1029
XiaokangQian86981952022-07-19 09:51:50 +00001030int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001032{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001033 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1034 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001035 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1036 const unsigned char *psk;
1037 size_t psk_len;
1038 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001039
1040 /* Check if we have space to write binders_len.
1041 * - binders_len (2 bytes)
1042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001044 p += 2;
1045
Jerry Yu6183cc72022-09-30 11:08:57 +08001046#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 ret = ssl_tls13_write_binder(ssl, p, end,
1050 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1051 hash_alg, psk, psk_len,
1052 &output_len);
1053 if (ret != 0) {
1054 return ret;
1055 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001056 p += output_len;
1057 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001058#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001059
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001061
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 ret = ssl_tls13_write_binder(ssl, p, end,
1063 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1064 hash_alg, psk, psk_len,
1065 &output_len);
1066 if (ret != 0) {
1067 return ret;
1068 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001069 p += output_len;
1070 }
1071
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001073
1074 /*
1075 * - binders_len (2 bytes)
1076 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001078
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001080
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001081 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001085}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001086
1087/*
1088 * struct {
1089 * opaque identity<1..2^16-1>;
1090 * uint32 obfuscated_ticket_age;
1091 * } PskIdentity;
1092 *
1093 * opaque PskBinderEntry<32..255>;
1094 *
1095 * struct {
1096 *
1097 * select (Handshake.msg_type) {
1098 * ...
1099 * case server_hello: uint16 selected_identity;
1100 * };
1101 *
1102 * } PreSharedKeyExtension;
1103 *
1104 */
1105MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001106static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1107 const unsigned char *buf,
1108 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001109{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001110 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001111 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001112 const unsigned char *psk;
1113 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001114 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001115
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1117 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001118 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001119
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001121
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1123 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001124
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1126 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1127 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001128 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001129
Jerry Yu4a698342022-09-30 12:22:01 +08001130#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1132 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1133 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001134#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1136 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
1137 } else {
1138 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1139 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001140 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 if (ret != 0) {
1142 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001143 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001144
Dave Rodgman2eab4622023-10-05 13:30:37 +01001145 if (mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ssl->handshake->ciphersuite_info->mac)
Xiaokang Qianeb31cbc2023-02-07 02:08:56 +00001146 != hash_alg) {
1147 MBEDTLS_SSL_DEBUG_MSG(
1148 1, ("Invalid ciphersuite for external psk."));
1149
1150 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1151 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1152 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1153 }
1154
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1156 if (ret != 0) {
1157 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1158 return ret;
1159 }
1160
1161 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001162}
Ronald Cron41a443a2022-10-04 16:38:25 +02001163#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001164
Gilles Peskine449bd832023-01-11 14:50:10 +01001165int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1166 unsigned char *buf,
1167 unsigned char *end,
1168 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001169{
1170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1171 unsigned char *p = buf;
1172 size_t ext_len;
1173
1174 *out_len = 0;
1175
1176 /* Write supported_versions extension
1177 *
1178 * Supported Versions Extension is mandatory with TLS 1.3.
1179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1181 if (ret != 0) {
1182 return ret;
1183 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001184 p += ext_len;
1185
1186 /* Echo the cookie if the server provided one in its preceding
1187 * HelloRetryRequest message.
1188 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1190 if (ret != 0) {
1191 return ret;
1192 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001193 p += ext_len;
1194
Ronald Cron766c0cd2022-10-18 12:17:11 +02001195#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1197 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1198 if (ret != 0) {
1199 return ret;
1200 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001201 p += ext_len;
1202 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001203#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001204
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001205#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1207 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1208 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1209 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1210 if (ret != 0) {
1211 return ret;
1212 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001213 p += ext_len;
1214
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001215 /* Initializes the status to `rejected`. It will be updated to
1216 * `accepted` if the EncryptedExtension message contain an early data
1217 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001218 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001219 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 } else {
1221 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001222 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001223 }
1224#endif /* MBEDTLS_SSL_EARLY_DATA */
1225
Ronald Cron41a443a2022-10-04 16:38:25 +02001226#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001227 /* For PSK-based key exchange we need the pre_shared_key extension
1228 * and the psk_key_exchange_modes extension.
1229 *
1230 * The pre_shared_key extension MUST be the last extension in the
1231 * ClientHello. Servers MUST check that it is the last extension and
1232 * otherwise fail the handshake with an "illegal_parameter" alert.
1233 *
1234 * Add the psk_key_exchange_modes extension.
1235 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1237 if (ret != 0) {
1238 return ret;
1239 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001240 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001241#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001242
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001243 *out_len = p - buf;
1244
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001246}
1247
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00001248int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl)
Xiaokang Qian126929f2023-01-03 10:29:41 +00001249{
Xiaokang Qian90746132023-01-06 05:54:59 +00001250 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001251
Xiaokang Qian126929f2023-01-03 10:29:41 +00001252#if defined(MBEDTLS_SSL_EARLY_DATA)
1253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1254 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1255 const unsigned char *psk;
1256 size_t psk_len;
1257 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001258
Xiaokang Qian126929f2023-01-03 10:29:41 +00001259 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
Xiaokang Qian6be82902023-02-03 06:04:43 +00001260#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1261 mbedtls_ssl_handshake_set_state(
1262 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1263#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00001264 MBEDTLS_SSL_DEBUG_MSG(
1265 1, ("Set hs psk for early data when writing the first psk"));
1266
1267 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1268 if (ret != 0) {
1269 MBEDTLS_SSL_DEBUG_RET(
1270 1, "ssl_tls13_ticket_get_psk", ret);
1271 return ret;
1272 }
1273
1274 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1275 if (ret != 0) {
1276 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1277 return ret;
1278 }
1279
Xiaokang Qian64bc9bc2023-02-07 02:32:23 +00001280 /*
1281 * Early data are going to be encrypted using the ciphersuite
1282 * associated with the pre-shared key used for the handshake.
1283 * Note that if the server rejects early data, the handshake
1284 * based on the pre-shared key may complete successfully
1285 * with a selected ciphersuite different from the ciphersuite
1286 * associated with the pre-shared key. Only the hashes of the
1287 * two ciphersuites have to be the same. In that case, the
1288 * encrypted handshake data and application data are
1289 * encrypted using a different ciphersuite than the one used for
1290 * the rejected early data.
1291 */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001292 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1293 ssl->session_negotiate->ciphersuite);
1294 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001295
Tom Cosgrove5c8505f2023-03-07 11:39:52 +00001296 /* Enable psk and psk_ephemeral to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001297 ssl->handshake->key_exchange_mode =
1298 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1299
1300 /* Start the TLS 1.3 key schedule:
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001301 * Set the PSK and derive early secret.
Xiaokang Qian126929f2023-01-03 10:29:41 +00001302 */
1303 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1304 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001305 MBEDTLS_SSL_DEBUG_RET(
1306 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001307 return ret;
1308 }
1309
1310 /* Derive early data key material */
1311 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1312 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001313 MBEDTLS_SSL_DEBUG_RET(
1314 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001315 return ret;
1316 }
1317
Xiaokang Qian126929f2023-01-03 10:29:41 +00001318 }
1319#endif /* MBEDTLS_SSL_EARLY_DATA */
1320 return 0;
1321}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001322/*
Jerry Yu4a173382021-10-11 21:45:31 +08001323 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001324 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001325
Ronald Cronda41b382022-03-30 09:57:11 +02001326/**
1327 * \brief Detect if the ServerHello contains a supported_versions extension
1328 * or not.
1329 *
1330 * \param[in] ssl SSL context
1331 * \param[in] buf Buffer containing the ServerHello message
1332 * \param[in] end End of the buffer containing the ServerHello message
1333 *
1334 * \return 0 if the ServerHello does not contain a supported_versions extension
1335 * \return 1 if the ServerHello contains a supported_versions extension
1336 * \return A negative value if an error occurred while parsing the ServerHello.
1337 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001338MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001339static int ssl_tls13_is_supported_versions_ext_present(
1340 mbedtls_ssl_context *ssl,
1341 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001343{
1344 const unsigned char *p = buf;
1345 size_t legacy_session_id_echo_len;
Ronald Croneff56732023-04-03 17:36:31 +02001346 const unsigned char *supported_versions_data;
1347 const unsigned char *supported_versions_data_end;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001348
1349 /*
1350 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001351 * length:
1352 * - legacy_version 2 bytes
1353 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1354 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001357 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1358 legacy_session_id_echo_len = *p;
1359
1360 /*
1361 * Jump to the extensions, jumping over:
1362 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1363 * - cipher_suite 2 bytes
1364 * - legacy_compression_method 1 byte
1365 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1367 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001368
Ronald Cron47dce632023-02-08 17:38:29 +01001369 return mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1370 ssl, p, end,
Ronald Croneff56732023-04-03 17:36:31 +02001371 &supported_versions_data, &supported_versions_data_end);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001372}
1373
Jerry Yu7a186a02021-10-15 18:46:14 +08001374/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001375 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1376 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1377 * - 0 otherwise
1378 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001379MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001380static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1381 const unsigned char *buf,
1382 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001383{
1384 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1385 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001387 const unsigned char *last_eight_bytes_of_random;
1388 unsigned char last_byte_of_random;
1389
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001391 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 if (memcmp(last_eight_bytes_of_random,
1394 magic_downgrade_string,
1395 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001396 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 return last_byte_of_random == 0 ||
1398 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001399 }
1400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001402}
1403
1404/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001405 * - SSL_SERVER_HELLO or
1406 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001407 * to indicate which message is expected and to be parsed next.
1408 */
Ronald Cron828aff62022-05-31 12:04:31 +02001409#define SSL_SERVER_HELLO 0
1410#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001411MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001412static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1413 const unsigned char *buf,
1414 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001415{
Jerry Yue1b9c292021-09-10 10:08:31 +08001416
1417 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1418 *
Jerry Yu4a173382021-10-11 21:45:31 +08001419 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001420 * special value of the SHA-256 of "HelloRetryRequest".
1421 *
1422 * struct {
1423 * ProtocolVersion legacy_version = 0x0303;
1424 * Random random;
1425 * opaque legacy_session_id_echo<0..32>;
1426 * CipherSuite cipher_suite;
1427 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001428 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001429 * } ServerHello;
1430 *
1431 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001432 MBEDTLS_SSL_CHK_BUF_READ_PTR(
1433 buf, end, 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001434
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1436 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1437 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001438 }
1439
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001441}
1442
Ronald Cron828aff62022-05-31 12:04:31 +02001443/*
Jerry Yu745bb612021-10-13 22:01:04 +08001444 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001445 * - SSL_SERVER_HELLO or
1446 * - SSL_SERVER_HELLO_HRR or
1447 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001448 */
Ronald Cron828aff62022-05-31 12:04:31 +02001449#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001450MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001451static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1452 const unsigned char *buf,
1453 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001454{
Jerry Yu4a173382021-10-11 21:45:31 +08001455 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001456 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1459 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001460
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001462 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001464
1465 /* If the server is negotiating TLS 1.2 or below and:
1466 * . we did not propose TLS 1.2 or
1467 * . the server responded it is TLS 1.3 capable but negotiating a lower
1468 * version of the protocol and thus we are under downgrade attack
1469 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1472 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1473 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1474 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001475 }
1476
Ronald Cronb828c7d2023-04-03 16:37:22 +02001477 /*
1478 * Version 1.2 of the protocol has been negotiated, set the
1479 * ssl->keep_current_message flag for the ServerHello to be kept and
1480 * parsed as a TLS 1.2 ServerHello. We also change ssl->tls_version to
1481 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1482 * will dispatch to the TLS 1.2 state machine.
1483 */
Ronald Cron9f0fba32022-02-10 16:45:15 +01001484 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001485 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001486 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1487 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1488 buf, (size_t) (end - buf)));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1491 ret = ssl_tls13_reset_key_share(ssl);
1492 if (ret != 0) {
1493 return ret;
1494 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001495 }
1496
Gilles Peskine449bd832023-01-11 14:50:10 +01001497 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001498 }
1499
Jerry Yua66fece2022-07-13 14:30:29 +08001500#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1501 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1502 ssl->session_negotiate->tls_version = ssl->tls_version;
1503#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1504
Jerry Yu50e00e32022-10-31 14:45:01 +08001505 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001506
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1508 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001509 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001511 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001512 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001514 /* If a client receives a second HelloRetryRequest in the same
1515 * connection (i.e., where the ClientHello was itself in response
1516 * to a HelloRetryRequest), it MUST abort the handshake with an
1517 * "unexpected_message" alert.
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 */
1519 if (handshake->hello_retry_request_count > 0) {
1520 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001521 MBEDTLS_SSL_PEND_FATAL_ALERT(
1522 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1523 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001525 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526 /*
1527 * Clients must abort the handshake with an "illegal_parameter"
1528 * alert if the HelloRetryRequest would not result in any change
1529 * in the ClientHello.
1530 * In a PSK only key exchange that what we expect.
1531 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1533 MBEDTLS_SSL_DEBUG_MSG(1,
1534 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001535 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1537 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1538 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001539 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001540
Ronald Cron5afb9042022-05-31 12:11:39 +02001541 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001542
Jerry Yu745bb612021-10-13 22:01:04 +08001543 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001544 }
1545
1546cleanup:
1547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001549}
1550
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001551MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001552static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1553 const unsigned char **buf,
1554 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001555{
1556 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001557 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001558
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1560 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001561
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001563
1564 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1566 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1567 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1568 ssl->session_negotiate->id,
1569 ssl->session_negotiate->id_len);
1570 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1571 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001572
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1574 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001575
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001577 }
1578
Jerry Yu4a173382021-10-11 21:45:31 +08001579 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001580 *buf = p;
1581
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1583 ssl->session_negotiate->id_len);
1584 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001585}
1586
Jerry Yue1b9c292021-09-10 10:08:31 +08001587/* Parse ServerHello message and configure context
1588 *
1589 * struct {
1590 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1591 * Random random;
1592 * opaque legacy_session_id_echo<0..32>;
1593 * CipherSuite cipher_suite;
1594 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001595 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001596 * } ServerHello;
1597 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001598MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001599static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1600 const unsigned char *buf,
1601 const unsigned char *end,
1602 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001603{
Jerry Yub85277e2021-10-13 13:36:05 +08001604 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001605 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001606 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001607 size_t extensions_len;
1608 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001609 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001610 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001611 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001612 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001613 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001615
1616 /*
1617 * Check there is space for minimal fields
1618 *
1619 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001620 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001621 * - legacy_session_id_echo ( 1 byte ), minimum size
1622 * - cipher_suite ( 2 bytes)
1623 * - legacy_compression_method ( 1 byte )
1624 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001626
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1628 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001629
Jerry Yu4a173382021-10-11 21:45:31 +08001630 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001631 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001632 * ...
1633 * with ProtocolVersion defined as:
1634 * uint16 ProtocolVersion;
1635 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1637 MBEDTLS_SSL_VERSION_TLS1_2) {
1638 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1639 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1640 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001641 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1642 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001643 }
1644 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001645
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001646 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001647 * Random random;
1648 * ...
1649 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001650 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001651 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001652 if (!is_hrr) {
1653 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1654 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1655 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1656 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001657 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001658 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001659
Jerry Yu4a173382021-10-11 21:45:31 +08001660 /* ...
1661 * opaque legacy_session_id_echo<0..32>;
1662 * ...
1663 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001665 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001666 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001667 }
1668
Jerry Yu4a173382021-10-11 21:45:31 +08001669 /* ...
1670 * CipherSuite cipher_suite;
1671 * ...
1672 * with CipherSuite defined as:
1673 * uint8 CipherSuite[2];
1674 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1676 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001677 p += 2;
1678
Jerry Yu4a173382021-10-11 21:45:31 +08001679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001681 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001682 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001683 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1685 ssl->tls_version,
1686 ssl->tls_version) != 0) ||
1687 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001688 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001689 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001690 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001691 * If we received an HRR before and that the proposed selected
1692 * ciphersuite in this server hello is not the same as the one
1693 * proposed in the HRR, we abort the handshake and send an
1694 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001695 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001696 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1697 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001698 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001699 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001700
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1702 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1703 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001704 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001705 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001706
Jerry Yu4a173382021-10-11 21:45:31 +08001707 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001709
XiaokangQian355e09a2022-01-20 11:14:50 +00001710 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1712 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001713
1714#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001715 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001716#endif /* MBEDTLS_HAVE_TIME */
1717
Jerry Yu4a173382021-10-11 21:45:31 +08001718 /* ...
1719 * uint8 legacy_compression_method = 0;
1720 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001721 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1723 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1724 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001725 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001726 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001727 }
1728 p++;
1729
Jerry Yub85277e2021-10-13 13:36:05 +08001730 /* ...
1731 * Extension extensions<6..2^16-1>;
1732 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001733 * struct {
1734 * ExtensionType extension_type; (2 bytes)
1735 * opaque extension_data<0..2^16-1>;
1736 * } Extension;
1737 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1739 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001740 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001741
Jerry Yu4a173382021-10-11 21:45:31 +08001742 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001744 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001745
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001747
Jerry Yu50e00e32022-10-31 14:45:01 +08001748 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001749 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1751 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001752
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001754 unsigned int extension_type;
1755 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001756 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001757
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1759 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1760 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001761 p += 4;
1762
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001764 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001765
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001766 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1768 if (ret != 0) {
1769 return ret;
1770 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001771
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001773 case MBEDTLS_TLS_EXT_COOKIE:
1774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 ret = ssl_tls13_parse_cookie_ext(ssl,
1776 p, extension_data_end);
1777 if (ret != 0) {
1778 MBEDTLS_SSL_DEBUG_RET(1,
1779 "ssl_tls13_parse_cookie_ext",
1780 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001781 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001782 }
XiaokangQianb851da82022-01-14 04:03:11 +00001783 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001784
Jerry Yue1b9c292021-09-10 10:08:31 +08001785 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1787 p,
1788 extension_data_end);
1789 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001790 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001792 break;
1793
Ronald Cron41a443a2022-10-04 16:38:25 +02001794#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001795 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001797
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1799 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001800 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1802 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001803 }
1804 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001805#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001806
Jerry Yue1b9c292021-09-10 10:08:31 +08001807 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1809 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001810 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001811 goto cleanup;
1812 }
1813
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 if (is_hrr) {
1815 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1816 p, extension_data_end);
1817 } else {
1818 ret = ssl_tls13_parse_key_share_ext(ssl,
1819 p, extension_data_end);
1820 }
1821 if (ret != 0) {
1822 MBEDTLS_SSL_DEBUG_RET(1,
1823 "ssl_tls13_parse_key_share_ext",
1824 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001825 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001826 }
1827 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001828
1829 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001830 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1831 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001832 }
1833
1834 p += extension_data_len;
1835 }
1836
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001838
XiaokangQiand59be772022-01-24 10:12:51 +00001839cleanup:
1840
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1842 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1843 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001844 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1846 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1847 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001848 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1849 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001851}
1852
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001853#if defined(MBEDTLS_DEBUG_C)
1854static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001855{
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001857 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1858 return "psk";
1859 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1860 return "ephemeral";
1861 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1862 return "psk_ephemeral";
1863 default:
1864 return "unknown mode";
1865 }
1866}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001867#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001868
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001869MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001870static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001871{
Jerry Yub85277e2021-10-13 13:36:05 +08001872 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001873 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001874
Jerry Yub85277e2021-10-13 13:36:05 +08001875 /* Determine the key exchange mode:
1876 * 1) If both the pre_shared_key and key_share extensions were received
1877 * then the key exchange mode is PSK with EPHEMERAL.
1878 * 2) If only the pre_shared_key extension was received then the key
1879 * exchange mode is PSK-only.
1880 * 3) If only the key_share extension was received then the key
1881 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001882 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 switch (handshake->received_extensions &
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001884 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1885 MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001886 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001887 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001888 handshake->key_exchange_mode =
1889 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001890 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001891
Jerry Yu745bb612021-10-13 22:01:04 +08001892 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001894 handshake->key_exchange_mode =
1895 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001896 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001897
Jerry Yu745bb612021-10-13 22:01:04 +08001898 /* Both the pre_shared_key and key_share extensions were received */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001899 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1900 MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
1901 handshake->key_exchange_mode =
1902 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001903 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001904
Jerry Yu745bb612021-10-13 22:01:04 +08001905 /* Neither pre_shared_key nor key_share extension was received */
1906 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001907 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001908 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1909 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001910 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001911#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001912 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1913 (handshake->selected_identity != 0 ||
1914 handshake->ciphersuite_info->id !=
1915 ssl->session_negotiate->ciphersuite)) {
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001916 /* RFC8446 4.2.11
1917 * If the server supplies an "early_data" extension, the
1918 * client MUST verify that the server's selected_identity
1919 * is 0. If any other value is returned, the client MUST
1920 * abort the handshake with an "illegal_parameter" alert.
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001921 *
Xiaokang Qian53c4c272023-02-07 02:42:01 +00001922 * RFC 8446 4.2.10
1923 * In order to accept early data, the server MUST have accepted a PSK
1924 * cipher suite and selected the first key offered in the client's
1925 * "pre_shared_key" extension. In addition, it MUST verify that the
1926 * following values are the same as those associated with the
1927 * selected PSK:
1928 * - The TLS version number
1929 * - The selected cipher suite
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001930 * - The selected ALPN [RFC7301] protocol, if any
1931 *
1932 * We check here that when early data is involved the server
1933 * selected the cipher suite associated to the pre-shared key
1934 * as it must have.
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001935 */
1936 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1937 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1938 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1939 }
1940#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001941
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001942 if (!mbedtls_ssl_conf_tls13_check_kex_modes(
1943 ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001944 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001945 MBEDTLS_SSL_DEBUG_MSG(
1946 2, ("Key exchange mode(%s) is not supported.",
1947 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001948 goto cleanup;
1949 }
1950
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001951 MBEDTLS_SSL_DEBUG_MSG(
1952 3, ("Selected key exchange mode: %s",
1953 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001954
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001955 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001956 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001957 * If we proposed early data then we have already derived an
1958 * early secret using the selected PSK and its associated hash.
1959 * It means that if the negotiated key exchange mode is psk or
1960 * psk_ephemeral, we have already correctly computed the
1961 * early secret and thus we do not do it again. In all other
1962 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001963 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001964#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001965 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1966 handshake->key_exchange_mode ==
1967 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001968#endif
1969 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001970 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1971 if (ret != 0) {
1972 MBEDTLS_SSL_DEBUG_RET(
1973 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1974 goto cleanup;
1975 }
Jerry Yu0b177842021-09-05 19:41:30 +08001976 }
1977
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1979 if (ret != 0) {
1980 MBEDTLS_SSL_DEBUG_RET(1,
1981 "mbedtls_ssl_tls13_compute_handshake_transform",
1982 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001983 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001984 }
1985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1987 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001988 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
Jerry Yu0b177842021-09-05 19:41:30 +08001989 ssl->session_in = ssl->session_negotiate;
1990
Jerry Yu4a173382021-10-11 21:45:31 +08001991cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001993 MBEDTLS_SSL_PEND_FATAL_ALERT(
1994 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001996 }
Jerry Yue110d252022-05-05 10:19:22 +08001997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001999}
2000
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002001MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002002static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00002003{
2004 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00002007
XiaokangQian78b1fa72022-01-19 06:56:30 +00002008 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00002009 * We are going to re-generate a shared secret corresponding to the group
2010 * selected by the server, which is different from the group for which we
2011 * generated a shared secret in the first client hello.
2012 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00002013 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 ret = ssl_tls13_reset_key_share(ssl);
2015 if (ret != 0) {
2016 return ret;
2017 }
XiaokangQian647719a2021-12-07 09:16:29 +00002018
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00002019 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002021}
2022
Jerry Yue1b9c292021-09-10 10:08:31 +08002023/*
Jerry Yu4a173382021-10-11 21:45:31 +08002024 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002025 * Handler for MBEDTLS_SSL_SERVER_HELLO
2026 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002027MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002028static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002029{
Jerry Yu4a173382021-10-11 21:45:31 +08002030 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002031 unsigned char *buf = NULL;
2032 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002033 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002036
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002037 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2038 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2041 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002042 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 } else {
2044 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2045 }
XiaokangQiand59be772022-01-24 10:12:51 +00002046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002048 ret = 0;
2049 goto cleanup;
2050 }
2051
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2053 buf + buf_len,
2054 is_hrr));
2055 if (is_hrr) {
2056 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002057 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002058
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002059 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2060 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002061
2062 if (is_hrr) {
2063 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2064#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2065 /* If not offering early data, the client sends a dummy CCS record
2066 * immediately before its second flight. This may either be before
2067 * its second ClientHello or before its encrypted handshake flight.
2068 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002069 mbedtls_ssl_handshake_set_state(
2070 ssl, MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
Gilles Peskine449bd832023-01-11 14:50:10 +01002071#else
2072 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2073#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2074 } else {
2075 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2076 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002077 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002078
2079cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2081 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2082 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002083}
2084
2085/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002086 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002087 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002088 *
2089 * The EncryptedExtensions message contains any extensions which
2090 * should be protected, i.e., any which are not needed to establish
2091 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002092 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002093
XiaokangQian08da26c2021-10-09 10:12:11 +00002094/* Parse EncryptedExtensions message
2095 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002096 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002097 * } EncryptedExtensions;
2098 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002099MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002100static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2101 const unsigned char *buf,
2102 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002103{
2104 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002105 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002106 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002107 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002108 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2111 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002112 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002115 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002116
Jan Bruckner5a3629b2023-02-23 12:08:09 +01002117 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2118
Jerry Yu9eba7502022-10-31 13:46:16 +08002119 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002122 unsigned int extension_type;
2123 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002124
XiaokangQian08da26c2021-10-09 10:12:11 +00002125 /*
2126 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002127 * ExtensionType extension_type; (2 bytes)
2128 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002129 * } Extension;
2130 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2132 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2133 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002134 p += 4;
2135
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002137
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002138 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2140 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2141 if (ret != 0) {
2142 return ret;
2143 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002144
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002146#if defined(MBEDTLS_SSL_ALPN)
2147 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002149
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002150 if ((ret = ssl_tls13_parse_alpn_ext(
2151 ssl, p, (size_t) extension_data_len)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002153 }
2154
2155 break;
2156#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002157
2158#if defined(MBEDTLS_SSL_EARLY_DATA)
2159 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002162 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2164 MBEDTLS_ERR_SSL_DECODE_ERROR);
2165 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002166 }
2167
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002168 break;
2169#endif /* MBEDTLS_SSL_EARLY_DATA */
2170
Jan Bruckner151f6422023-02-10 12:45:19 +01002171#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2172 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
2173 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
2174
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002175 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
2176 ssl, p, p + extension_data_len);
Jan Bruckner151f6422023-02-10 12:45:19 +01002177
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002178 /* TODO: Return unconditionally here until we handle the record
2179 * size limit correctly. Once handled correctly, only return in
2180 * case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01002181 return ret;
2182
2183 break;
2184#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2185
XiaokangQian08da26c2021-10-09 10:12:11 +00002186 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002187 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002188 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002190 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002191 }
2192
XiaokangQian08da26c2021-10-09 10:12:11 +00002193 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002194 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002195
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2197 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002198
XiaokangQian97799ac2021-10-11 10:05:54 +00002199 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 if (p != end) {
2201 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2202 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2203 MBEDTLS_ERR_SSL_DECODE_ERROR);
2204 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002205 }
2206
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002208}
2209
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002210MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002211static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002212{
2213 int ret;
2214 unsigned char *buf;
2215 size_t buf_len;
2216
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002218
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002219 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2220 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2221 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002222
2223 /* Process the message contents */
2224 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002226
Xiaokang Qianb157e912022-11-23 08:12:26 +00002227#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 if (ssl->handshake->received_extensions &
2229 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002230 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2231 }
2232#endif
2233
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002234 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2235 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2236 buf, buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002237
Ronald Cron928cbd32022-10-04 16:14:26 +02002238#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2240 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2241 } else {
2242 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2243 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002244#else
2245 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002247#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002248
2249cleanup:
2250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2252 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002253
2254}
2255
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002256/*
2257 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2258 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002259 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002260 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002261 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002262 *
2263 * If the server sent an "early_data" extension in EncryptedExtensions, the
2264 * client MUST send an EndOfEarlyData message after receiving the server
2265 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002266 */
2267
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002268MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002269static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2270{
2271 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002272 unsigned char *buf = NULL;
2273 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002274 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002275
Xiaokang Qian742578c2022-12-19 06:34:44 +00002276 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
Xiaokang Qian0de0d862023-02-08 06:04:50 +00002277 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
2278 &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002279
Manuel Pégourié-Gonnard63e33dd2023-02-21 15:45:15 +01002280 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_hdr_to_checksum(
2281 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002282
Xiaokang Qian742578c2022-12-19 06:34:44 +00002283 MBEDTLS_SSL_PROC_CHK(
2284 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002285
Xiaokang Qian19d44162023-01-03 03:39:50 +00002286 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002287
2288cleanup:
2289
2290 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2291 return ret;
2292}
2293
Ronald Cron928cbd32022-10-04 16:14:26 +02002294#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002295/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002296 * STATE HANDLING: CertificateRequest
2297 *
Jerry Yud2674312021-10-29 10:08:19 +08002298 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002299#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2300#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002301/* Coordination:
2302 * Deals with the ambiguity of not knowing if a CertificateRequest
2303 * will be sent. Returns a negative code on failure, or
2304 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2305 * - SSL_CERTIFICATE_REQUEST_SKIP
2306 * indicating if a Certificate Request is expected or not.
2307 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002308MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002309static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002310{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002311 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2314 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2315 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002316 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002317 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2320 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2321 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2322 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002323 }
2324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002326
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002328}
2329
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002330/*
2331 * ssl_tls13_parse_certificate_request()
2332 * Parse certificate request
2333 * struct {
2334 * opaque certificate_request_context<0..2^8-1>;
2335 * Extension extensions<2..2^16-1>;
2336 * } CertificateRequest;
2337 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002338MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002339static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2340 const unsigned char *buf,
2341 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002342{
2343 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2344 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002345 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002346 size_t extensions_len = 0;
2347 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002348 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002349
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002350 /* ...
2351 * opaque certificate_request_context<0..2^8-1>
2352 * ...
2353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002355 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002356 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 if (certificate_request_context_len > 0) {
2359 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2360 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2361 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002362
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002363 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 mbedtls_calloc(1, certificate_request_context_len);
2365 if (handshake->certificate_request_context == NULL) {
2366 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2367 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002368 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 memcpy(handshake->certificate_request_context, p,
2370 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002371 p += certificate_request_context_len;
2372 }
2373
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002374 /* ...
2375 * Extension extensions<2..2^16-1>;
2376 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002377 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2379 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002380 p += 2;
2381
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002383 extensions_end = p + extensions_len;
2384
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002385 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002388 unsigned int extension_type;
2389 size_t extension_data_len;
2390
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2392 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2393 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002394 p += 4;
2395
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002397
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002398 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2400 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2401 if (ret != 0) {
2402 return ret;
2403 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002404
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002406 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 MBEDTLS_SSL_DEBUG_MSG(3,
2408 ("found signature algorithms extension"));
2409 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2410 p + extension_data_len);
2411 if (ret != 0) {
2412 return ret;
2413 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002414
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002415 break;
2416
2417 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002418 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002419 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002421 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002422 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002423
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002424 p += extension_data_len;
2425 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002426
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2428 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002429
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002430 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 if (p != end) {
2432 MBEDTLS_SSL_DEBUG_MSG(1,
2433 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002434 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002435 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002436
Jerry Yu0c354a22022-08-29 15:25:36 +08002437 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002438 *
2439 * The "signature_algorithms" extension MUST be specified
2440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2442 MBEDTLS_SSL_DEBUG_MSG(3,
2443 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002444 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002445 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002446
Jerry Yu7840f812022-01-29 10:26:51 +08002447 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002449
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002450decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2452 MBEDTLS_ERR_SSL_DECODE_ERROR);
2453 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002454}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002455
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002456/*
2457 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2458 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002459MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002460static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002461{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002462 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002465
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002469 unsigned char *buf;
2470 size_t buf_len;
2471
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002472 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2473 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2474 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002475
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002476 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(
2477 ssl, buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002478
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002479 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2480 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2481 buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002483 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 } else {
2485 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002486 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2487 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002488 }
2489
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002491
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002492cleanup:
2493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2495 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002496}
2497
2498/*
Jerry Yu687101b2021-09-14 16:03:56 +08002499 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2500 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002501MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002502static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002503{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002504 int ret;
2505
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2507 if (ret != 0) {
2508 return ret;
2509 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2512 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002513}
2514
2515/*
2516 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2517 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002518MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002519static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002520{
Jerry Yu30b071c2021-09-12 20:16:03 +08002521 int ret;
2522
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2524 if (ret != 0) {
2525 return ret;
2526 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2529 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002530}
Ronald Cron928cbd32022-10-04 16:14:26 +02002531#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002532
Jerry Yu687101b2021-09-14 16:03:56 +08002533/*
2534 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2535 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002536MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002537static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002538{
XiaokangQianac0385c2021-11-03 06:40:11 +00002539 int ret;
2540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2542 if (ret != 0) {
2543 return ret;
2544 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2547 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002548 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2550 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2551 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002552 }
2553
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002554#if defined(MBEDTLS_SSL_EARLY_DATA)
2555 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2556 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002557 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2558 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002559 } else
2560#endif /* MBEDTLS_SSL_EARLY_DATA */
2561 {
2562#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2563 mbedtls_ssl_handshake_set_state(
2564 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2565#else
2566 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2567#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2568 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002571}
2572
2573/*
Jerry Yu566c7812022-01-26 15:41:22 +08002574 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2575 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002576MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002577static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002578{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002579 int non_empty_certificate_msg = 0;
2580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 MBEDTLS_SSL_DEBUG_MSG(1,
2582 ("Switch to handshake traffic keys for outbound traffic"));
2583 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002584
Ronald Cron928cbd32022-10-04 16:14:26 +02002585#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if (ssl->handshake->client_auth) {
2587 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2588 if (ret != 0) {
2589 return ret;
2590 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002591
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002593 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 }
2595 } else {
2596 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002597 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002598#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (non_empty_certificate_msg) {
2601 mbedtls_ssl_handshake_set_state(ssl,
2602 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2603 } else {
2604 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2605 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2606 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002609}
2610
Ronald Cron928cbd32022-10-04 16:14:26 +02002611#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002612/*
2613 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2614 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002615MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002616static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002617{
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002619
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 if (ret == 0) {
2621 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2622 }
Ronald Crona8b38872022-03-09 07:59:25 +01002623
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002625}
Ronald Cron928cbd32022-10-04 16:14:26 +02002626#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002627
2628/*
Jerry Yu687101b2021-09-14 16:03:56 +08002629 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2630 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002631MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002632static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002633{
XiaokangQian0fa66432021-11-15 03:33:57 +00002634 int ret;
2635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2637 if (ret != 0) {
2638 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002639 }
2640
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2642 if (ret != 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002643 MBEDTLS_SSL_DEBUG_RET(
2644 1, "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 return ret;
2646 }
2647
2648 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2649 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002650}
2651
2652/*
2653 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2654 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002655MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002656static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002657{
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2659 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2660 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002661}
2662
2663/*
2664 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2665 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002666MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002667static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002668{
Jerry Yu378254d2021-10-30 21:44:47 +08002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2673 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002674}
2675
Jerry Yuf8a49942022-07-07 11:32:32 +00002676#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2677
Jerry Yua0446a02022-07-13 11:22:55 +08002678MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002679static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2680 const unsigned char *buf,
2681 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002682{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002683 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002684 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002685
Jerry Yuf8a49942022-07-07 11:32:32 +00002686
Jerry Yuedab6372022-10-31 14:37:31 +08002687 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002688
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002690 unsigned int extension_type;
2691 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002692 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2695 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2696 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002697 p += 4;
2698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002700
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002701 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2703 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2704 if (ret != 0) {
2705 return ret;
2706 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002707
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002709#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002710 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002712 MBEDTLS_SSL_PEND_FATAL_ALERT(
2713 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 MBEDTLS_ERR_SSL_DECODE_ERROR);
2715 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002716 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002718 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002720 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002721 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002722#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002723
Jerry Yuf8a49942022-07-07 11:32:32 +00002724 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002725 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002726 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002728 break;
2729 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002730
Jerry Yuf8a49942022-07-07 11:32:32 +00002731 p += extension_data_len;
2732 }
2733
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2735 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002736
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002738}
2739
2740/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002741 * From RFC8446, page 74
2742 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002743 * struct {
2744 * uint32 ticket_lifetime;
2745 * uint32 ticket_age_add;
2746 * opaque ticket_nonce<0..255>;
2747 * opaque ticket<1..2^16-1>;
2748 * Extension extensions<0..2^16-2>;
2749 * } NewSessionTicket;
2750 *
2751 */
Jerry Yua0446a02022-07-13 11:22:55 +08002752MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002753static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2754 unsigned char *buf,
2755 unsigned char *end,
2756 unsigned char **ticket_nonce,
2757 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002758{
2759 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2760 unsigned char *p = buf;
2761 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002762 size_t ticket_len;
2763 unsigned char *ticket;
2764 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002765
Jerry Yucb3b1392022-07-12 06:09:38 +00002766 *ticket_nonce = NULL;
2767 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002768 /*
2769 * ticket_lifetime 4 bytes
2770 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002771 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2776 MBEDTLS_SSL_DEBUG_MSG(3,
2777 ("ticket_lifetime: %u",
2778 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2781 MBEDTLS_SSL_DEBUG_MSG(3,
2782 ("ticket_age_add: %u",
2783 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002784
Jerry Yucb3b1392022-07-12 06:09:38 +00002785 *ticket_nonce_len = p[8];
2786 p += 9;
2787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002789 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002791 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002792
2793 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2795 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002796 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2798 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002799
2800 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (session->ticket != NULL || session->ticket_len > 0) {
2802 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002803 session->ticket = NULL;
2804 session->ticket_len = 0;
2805 }
2806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2808 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2809 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002810 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002812 p += ticket_len;
2813 session->ticket = ticket;
2814 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002815
Pengyu Lv9f926952022-11-17 15:22:33 +08002816 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002817 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002818 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2821 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002822 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2828 if (ret != 0) {
2829 MBEDTLS_SSL_DEBUG_RET(1,
2830 "ssl_tls13_parse_new_session_ticket_exts",
2831 ret);
2832 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002833 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002834
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002835 /* session has been updated, allow export */
2836 session->exported = 0;
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002839}
2840
Jerry Yua0446a02022-07-13 11:22:55 +08002841MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002842static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2843 unsigned char *ticket_nonce,
2844 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002845{
2846 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2847 mbedtls_ssl_session *session = ssl->session;
2848 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2849 psa_algorithm_t psa_hash_alg;
2850 int hash_length;
2851
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002852#if defined(MBEDTLS_HAVE_TIME)
2853 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002855#endif
2856
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2858 if (ciphersuite_info == NULL) {
2859 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2860 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002861 }
2862
Dave Rodgman2eab4622023-10-05 13:30:37 +01002863 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2865 if (hash_length == -1 ||
2866 (size_t) hash_length > sizeof(session->resumption_key)) {
2867 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002868 }
2869
Jerry Yuf8a49942022-07-07 11:32:32 +00002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2872 session->app_secrets.resumption_master_secret,
2873 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002874
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002875 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002876 *
2877 * HKDF-Expand-Label( resumption_master_secret,
2878 * "resumption", ticket_nonce, Hash.length )
2879 */
2880 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 psa_hash_alg,
2882 session->app_secrets.resumption_master_secret,
2883 hash_length,
2884 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2885 ticket_nonce,
2886 ticket_nonce_len,
2887 session->resumption_key,
2888 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002889
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 if (ret != 0) {
2891 MBEDTLS_SSL_DEBUG_RET(2,
2892 "Creating the ticket-resumed PSK failed",
2893 ret);
2894 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002895 }
2896
Jerry Yu0a430c82022-07-20 11:02:48 +08002897 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2900 session->resumption_key,
2901 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002902
Pengyu Lv9f926952022-11-17 15:22:33 +08002903 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002904 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002905 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002906 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002909}
2910
2911/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002912 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002913 */
Jerry Yua0446a02022-07-13 11:22:55 +08002914MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002915static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002916{
2917 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2918 unsigned char *buf;
2919 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002920 unsigned char *ticket_nonce;
2921 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002922
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2926 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2927 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002928
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2930 ssl, buf, buf + buf_len,
2931 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2934 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002935
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002937
Jerry Yuf8a49942022-07-07 11:32:32 +00002938cleanup:
2939
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2941 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002942}
2943#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002946{
Jerry Yu92c6b402021-08-27 16:59:09 +08002947 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002950 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002952 break;
2953
Jerry Yu92c6b402021-08-27 16:59:09 +08002954 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002956 break;
2957
2958 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002960 break;
2961
2962 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002964 break;
2965
Ronald Cron928cbd32022-10-04 16:14:26 +02002966#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002967 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002969 break;
2970
Jerry Yu687101b2021-09-14 16:03:56 +08002971 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002973 break;
2974
2975 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002977 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002978#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002979
2980 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002982 break;
2983
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002984 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2985 ret = ssl_tls13_write_end_of_early_data(ssl);
2986 break;
2987
Jerry Yu566c7812022-01-26 15:41:22 +08002988 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002989 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002990 break;
2991
Ronald Cron928cbd32022-10-04 16:14:26 +02002992#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002993 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002995 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002996#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002997
Jerry Yu687101b2021-09-14 16:03:56 +08002998 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003000 break;
3001
3002 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003004 break;
3005
3006 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08003008 break;
3009
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 /*
3011 * Injection of dummy-CCS's for middlebox compatibility
3012 */
Ronald Cron49ad6192021-11-24 16:25:31 +01003013#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00003014 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3016 if (ret == 0) {
3017 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3018 }
Ronald Cron9f55f632022-02-02 16:02:47 +01003019 break;
3020
3021 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3023 if (ret == 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00003024 mbedtls_ssl_handshake_set_state(
3025 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 }
Ronald Cron49ad6192021-11-24 16:25:31 +01003027 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003028
Xiaokang Qian592021a2023-01-04 10:47:05 +00003029 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3030 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3031 if (ret == 0) {
3032 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3033
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003034#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003035 MBEDTLS_SSL_DEBUG_MSG(
3036 1, ("Switch to early data keys for outbound traffic"));
3037 mbedtls_ssl_set_outbound_transform(
3038 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003039#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003040 }
3041 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003042#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3043
Jerry Yuf8a49942022-07-07 11:32:32 +00003044#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003045 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 ret = ssl_tls13_process_new_session_ticket(ssl);
3047 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003048 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003050 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3051 break;
3052#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3053
Jerry Yu92c6b402021-08-27 16:59:09 +08003054 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003057 }
3058
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003060}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003061
Jerry Yufb4b6472022-01-27 15:03:26 +08003062#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */