blob: add9f6c8fdaecc9b991d34f3111bfeb9ea932623 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
2 * TLS 1.3 client-side functions
3 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS ( https://tls.mbed.org )
20 */
21
22#include "common.h"
23
Jerry Yucc43c6b2022-01-28 10:24:45 +080024#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080025
Jerry Yubc20bdd2021-08-24 15:59:48 +080026#include <string.h>
27
Jerry Yu56fc07f2021-09-01 17:48:49 +080028#include "mbedtls/debug.h"
29#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080030#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080031
Jerry Yubdc71882021-09-14 19:30:36 +080032#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010033#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080034#include "ssl_tls13_keys.h"
Jerry Yucbd082f2022-08-04 16:55:10 +080035#include "ssl_debug_helpers.h"
Jerry Yubdc71882021-09-14 19:30:36 +080036
Jerry Yubc20bdd2021-08-24 15:59:48 +080037/* Write extensions */
38
Jerry Yu92c6b402021-08-27 16:59:09 +080039/*
40 * ssl_tls13_write_supported_versions_ext():
41 *
42 * struct {
43 * ProtocolVersion versions<2..254>;
44 * } SupportedVersions;
45 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020046MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010047static int ssl_tls13_write_supported_versions_ext(mbedtls_ssl_context *ssl,
48 unsigned char *buf,
49 unsigned char *end,
50 size_t *out_len)
Jerry Yu92c6b402021-08-27 16:59:09 +080051{
52 unsigned char *p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +010053 unsigned char versions_len = (ssl->handshake->min_tls_version <=
54 MBEDTLS_SSL_VERSION_TLS1_2) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080055
Xiaofei Baid25fab62021-12-02 06:36:27 +000056 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080057
Gilles Peskine449bd832023-01-11 14:50:10 +010058 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding supported versions extension"));
Jerry Yu92c6b402021-08-27 16:59:09 +080059
Jerry Yu388bd0d2021-09-15 18:41:02 +080060 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080061 * - extension_type (2 bytes)
62 * - extension_data_length (2 bytes)
63 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020064 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080065 */
Gilles Peskine449bd832023-01-11 14:50:10 +010066 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 5 + versions_len);
Ronald Crondbe87f02022-02-10 14:35:27 +010067
Gilles Peskine449bd832023-01-11 14:50:10 +010068 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0);
69 MBEDTLS_PUT_UINT16_BE(versions_len + 1, p, 2);
Jerry Yueecfbf02021-08-30 18:32:07 +080070 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080071
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080072 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010073 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080074
Jerry Yu0c63af62021-09-02 12:59:12 +080075 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080076 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010077 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080078 */
Gilles Peskine449bd832023-01-11 14:50:10 +010079 mbedtls_ssl_write_version(p, MBEDTLS_SSL_TRANSPORT_STREAM,
80 MBEDTLS_SSL_VERSION_TLS1_3);
81 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:4]"));
Jerry Yu92c6b402021-08-27 16:59:09 +080082
Jerry Yu92c6b402021-08-27 16:59:09 +080083
Gilles Peskine449bd832023-01-11 14:50:10 +010084 if (ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
85 mbedtls_ssl_write_version(p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
86 MBEDTLS_SSL_VERSION_TLS1_2);
87 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:3]"));
Ronald Crondbe87f02022-02-10 14:35:27 +010088 }
89
90 *out_len = 5 + versions_len;
Jerry Yu4b8f2f72022-10-31 13:31:22 +080091
Jerry Yuc4bf5d62022-10-29 09:08:47 +080092 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +010093 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yu4b8f2f72022-10-31 13:31:22 +080094
Gilles Peskine449bd832023-01-11 14:50:10 +010095 return 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080096}
Jerry Yubc20bdd2021-08-24 15:59:48 +080097
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020098MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010099static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
100 const unsigned char *buf,
101 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800102{
Jerry Yue1b9c292021-09-10 10:08:31 +0800103 ((void) ssl);
104
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
106 if (mbedtls_ssl_read_version(buf, ssl->conf->transport) !=
107 MBEDTLS_SSL_VERSION_TLS1_3) {
108 MBEDTLS_SSL_DEBUG_MSG(1, ("unexpected version"));
Jerry Yu4a173382021-10-11 21:45:31 +0800109
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
111 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
112 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +0800113 }
114
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 if (&buf[2] != end) {
116 MBEDTLS_SSL_DEBUG_MSG(1, ("supported_versions ext data length incorrect"));
117 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
118 MBEDTLS_ERR_SSL_DECODE_ERROR);
119 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Ronald Cron98473382022-03-30 20:04:10 +0200120 }
121
Gilles Peskine449bd832023-01-11 14:50:10 +0100122 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +0800123}
124
lhuang0486cacac2022-01-21 07:34:27 -0800125#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200126MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100127static int ssl_tls13_parse_alpn_ext(mbedtls_ssl_context *ssl,
128 const unsigned char *buf, size_t len)
lhuang0486cacac2022-01-21 07:34:27 -0800129{
lhuang0486cacac2022-01-21 07:34:27 -0800130 const unsigned char *p = buf;
131 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200132 size_t protocol_name_list_len, protocol_name_len;
133 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800134
135 /* If we didn't send it, the server shouldn't send it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 if (ssl->conf->alpn_list == NULL) {
137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
138 }
lhuang0486cacac2022-01-21 07:34:27 -0800139
140 /*
141 * opaque ProtocolName<1..2^8-1>;
142 *
143 * struct {
144 * ProtocolName protocol_name_list<2..2^16-1>
145 * } ProtocolNameList;
146 *
147 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
148 */
149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
151 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
lhuang0486cacac2022-01-21 07:34:27 -0800152 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800153
Gilles Peskine449bd832023-01-11 14:50:10 +0100154 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
Ronald Cron81a334f2022-05-31 16:04:11 +0200155 protocol_name_list_end = p + protocol_name_list_len;
156
Gilles Peskine449bd832023-01-11 14:50:10 +0100157 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, 1);
Ronald Cron81a334f2022-05-31 16:04:11 +0200158 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800159
160 /* Check that the server chosen protocol was in our list and save it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, protocol_name_len);
162 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
163 if (protocol_name_len == strlen(*alpn) &&
164 memcmp(p, *alpn, protocol_name_len) == 0) {
lhuang0486cacac2022-01-21 07:34:27 -0800165 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 return 0;
lhuang0486cacac2022-01-21 07:34:27 -0800167 }
168 }
169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
lhuang0486cacac2022-01-21 07:34:27 -0800171}
172#endif /* MBEDTLS_SSL_ALPN */
173
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200174MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100175static int ssl_tls13_reset_key_share(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +0000176{
177 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100178
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (group_id == 0) {
180 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
181 }
XiaokangQian647719a2021-12-07 09:16:29 +0000182
XiaokangQian355e09a2022-01-20 11:14:50 +0000183#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
187
188 /* Destroy generated private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 status = psa_destroy_key(ssl->handshake->ecdh_psa_privkey);
190 if (status != PSA_SUCCESS) {
191 ret = psa_ssl_status_to_mbedtls(status);
192 MBEDTLS_SSL_DEBUG_RET(1, "psa_destroy_key", ret);
193 return ret;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100194 }
195
196 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100197 return 0;
198 } else
XiaokangQian355e09a2022-01-20 11:14:50 +0000199#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 if (0 /* other KEMs? */) {
XiaokangQian647719a2021-12-07 09:16:29 +0000201 /* Do something */
202 }
203
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQian647719a2021-12-07 09:16:29 +0000205}
206
207/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800208 * Functions for writing key_share extension.
209 */
Ronald Cron766c0cd2022-10-18 12:17:11 +0200210#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200211MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100212static int ssl_tls13_get_default_group_id(mbedtls_ssl_context *ssl,
213 uint16_t *group_id)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800214{
215 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
216
Jerry Yu56fc07f2021-09-01 17:48:49 +0800217
Jerry Yu56fc07f2021-09-01 17:48:49 +0800218#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Jerry Yu388bd0d2021-09-15 18:41:02 +0800220 /* Pick first available ECDHE group compatible with TLS 1.3 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 if (group_list == NULL) {
222 return MBEDTLS_ERR_SSL_BAD_CONFIG;
223 }
Jerry Yu388bd0d2021-09-15 18:41:02 +0800224
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 for (; *group_list != 0; group_list++) {
226 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(*group_list,
227 NULL, NULL) == PSA_SUCCESS) &&
228 mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
Brett Warren14efd332021-10-06 09:32:11 +0100229 *group_id = *group_list;
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 return 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800231 }
232 }
233#else
234 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800235 ((void) group_id);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800236#endif /* MBEDTLS_ECDH_C */
237
238 /*
239 * Add DHE named groups here.
Jerry Yu388bd0d2021-09-15 18:41:02 +0800240 * Pick first available DHE group compatible with TLS 1.3
Jerry Yu56fc07f2021-09-01 17:48:49 +0800241 */
242
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800244}
245
246/*
247 * ssl_tls13_write_key_share_ext
248 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800249 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800250 *
251 * struct {
252 * NamedGroup group;
253 * opaque key_exchange<1..2^16-1>;
254 * } KeyShareEntry;
255 * struct {
256 * KeyShareEntry client_shares<0..2^16-1>;
257 * } KeyShareClientHello;
258 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200259MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100260static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
261 unsigned char *buf,
262 unsigned char *end,
263 size_t *out_len)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800264{
265 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000266 unsigned char *client_shares; /* Start of client_shares */
267 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800268 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800269 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
270
Xiaofei Baid25fab62021-12-02 06:36:27 +0000271 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800272
Jerry Yub60e3cf2021-09-08 16:41:02 +0800273 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800274 * - extension_type (2 bytes)
275 * - extension_data_length (2 bytes)
276 * - client_shares_length (2 bytes)
277 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800279 p += 6;
280
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello: adding key share extension"));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800282
283 /* HRR could already have requested something else. */
284 group_id = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 if (!mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) &&
286 !mbedtls_ssl_tls13_named_group_is_dhe(group_id)) {
287 MBEDTLS_SSL_PROC_CHK(ssl_tls13_get_default_group_id(ssl,
288 &group_id));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800289 }
290
291 /*
292 * Dispatch to type-specific key generation function.
293 *
294 * So far, we're only supporting ECDHE. With the introduction
295 * of PQC KEMs, we'll want to have multiple branches, one per
296 * type of KEM, and dispatch to the corresponding crypto. And
297 * only one key share entry is allowed.
298 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000299 client_shares = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800300#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id)) {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800302 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000303 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800304 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100305 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800306
307 /* Check there is space for header of KeyShareEntry
308 * - group (2 bytes)
309 * - key_exchange_length (2 bytes)
310 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800312 p += 4;
Jerry Yu89e103c2022-03-30 22:43:29 +0800313 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 ssl, group_id, p, end, &key_exchange_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800315 p += key_exchange_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 if (ret != 0) {
317 return ret;
318 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800319
320 /* Write group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 MBEDTLS_PUT_UINT16_BE(group_id, group, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800322 /* Write key_exchange_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 MBEDTLS_PUT_UINT16_BE(key_exchange_len, group, 2);
324 } else
Jerry Yu56fc07f2021-09-01 17:48:49 +0800325#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 if (0 /* other KEMs? */) {
Jerry Yu56fc07f2021-09-01 17:48:49 +0800327 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 } else {
329 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800330 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800331
Jerry Yub60e3cf2021-09-08 16:41:02 +0800332 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000333 client_shares_len = p - client_shares;
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 if (client_shares_len == 0) {
335 MBEDTLS_SSL_DEBUG_MSG(1, ("No key share defined."));
336 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu7c522d42021-09-08 17:55:09 +0800337 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800338 /* Write extension_type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800340 /* Write extension_data_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 MBEDTLS_PUT_UINT16_BE(client_shares_len + 2, buf, 2);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800342 /* Write client_shares_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 MBEDTLS_PUT_UINT16_BE(client_shares_len, buf, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800344
345 /* Update offered_group_id field */
346 ssl->handshake->offered_group_id = group_id;
347
348 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000349 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, key_share extension", buf, *out_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800352
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800354
355cleanup:
356
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800358}
Ronald Cron766c0cd2022-10-18 12:17:11 +0200359#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +0800360
XiaokangQiand59be772022-01-24 10:12:51 +0000361/*
362 * ssl_tls13_parse_hrr_key_share_ext()
363 * Parse key_share extension in Hello Retry Request
364 *
365 * struct {
366 * NamedGroup selected_group;
367 * } KeyShareHelloRetryRequest;
368 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200369MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100370static int ssl_tls13_parse_hrr_key_share_ext(mbedtls_ssl_context *ssl,
371 const unsigned char *buf,
372 const unsigned char *end)
XiaokangQianb851da82022-01-14 04:03:11 +0000373{
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400374#if defined(MBEDTLS_ECDH_C)
XiaokangQianb851da82022-01-14 04:03:11 +0000375 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000376 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000377 int found = 0;
378
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
380 if (group_list == NULL) {
381 return MBEDTLS_ERR_SSL_BAD_CONFIG;
382 }
XiaokangQianb851da82022-01-14 04:03:11 +0000383
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 MBEDTLS_SSL_DEBUG_BUF(3, "key_share extension", p, end - buf);
XiaokangQianb851da82022-01-14 04:03:11 +0000385
386 /* Read selected_group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
388 selected_group = MBEDTLS_GET_UINT16_BE(p, 0);
389 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_group ( %d )", selected_group));
XiaokangQianb851da82022-01-14 04:03:11 +0000390
391 /* Upon receipt of this extension in a HelloRetryRequest, the client
392 * MUST first verify that the selected_group field corresponds to a
393 * group which was provided in the "supported_groups" extension in the
394 * original ClientHello.
395 * The supported_group was based on the info in ssl->conf->group_list.
396 *
397 * If the server provided a key share that was not sent in the ClientHello
398 * then the client MUST abort the handshake with an "illegal_parameter" alert.
399 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 for (; *group_list != 0; group_list++) {
401 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(*group_list,
402 NULL, NULL) == PSA_ERROR_NOT_SUPPORTED) ||
403 *group_list != selected_group) {
XiaokangQianb851da82022-01-14 04:03:11 +0000404 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 }
XiaokangQianb851da82022-01-14 04:03:11 +0000406
407 /* We found a match */
408 found = 1;
409 break;
410 }
411
412 /* Client MUST verify that the selected_group field does not
413 * correspond to a group which was provided in the "key_share"
414 * extension in the original ClientHello. If the server sent an
415 * HRR message with a key share already provided in the
416 * ClientHello then the client MUST abort the handshake with
417 * an "illegal_parameter" alert.
418 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 if (found == 0 || selected_group == ssl->handshake->offered_group_id) {
420 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid key share in HRR"));
XiaokangQianb851da82022-01-14 04:03:11 +0000421 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
423 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
424 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQianb851da82022-01-14 04:03:11 +0000425 }
426
427 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000428 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000429
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 return 0;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400431#else
432 (void) ssl;
433 (void) buf;
434 (void) end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400436#endif
XiaokangQianb851da82022-01-14 04:03:11 +0000437}
438
Jerry Yue1b9c292021-09-10 10:08:31 +0800439/*
Jerry Yub85277e2021-10-13 13:36:05 +0800440 * ssl_tls13_parse_key_share_ext()
441 * Parse key_share extension in Server Hello
442 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800443 * struct {
444 * KeyShareEntry server_share;
445 * } KeyShareServerHello;
446 * struct {
447 * NamedGroup group;
448 * opaque key_exchange<1..2^16-1>;
449 * } KeyShareEntry;
450 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200451MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100452static int ssl_tls13_parse_key_share_ext(mbedtls_ssl_context *ssl,
453 const unsigned char *buf,
454 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800455{
Jerry Yub85277e2021-10-13 13:36:05 +0800456 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800457 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800458 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800459
Jerry Yu4a173382021-10-11 21:45:31 +0800460 /* ...
461 * NamedGroup group; (2 bytes)
462 * ...
463 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
465 group = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +0800466 p += 2;
467
Jerry Yu4a173382021-10-11 21:45:31 +0800468 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800469 offered_group = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 if (offered_group != group) {
471 MBEDTLS_SSL_DEBUG_MSG(1,
472 ("Invalid server key share, our group %u, their group %u",
473 (unsigned) offered_group, (unsigned) group));
474 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
475 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
476 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yue1b9c292021-09-10 10:08:31 +0800477 }
478
479#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
481 if (mbedtls_ssl_get_psa_curve_info_from_tls_id(group, NULL, NULL)
482 == PSA_ERROR_NOT_SUPPORTED) {
483 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid TLS curve group id"));
484 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100485 }
486
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH curve: %s",
488 mbedtls_ssl_get_curve_name_from_tls_id(group)));
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100489
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(ssl, p, end - p);
491 if (ret != 0) {
492 return ret;
493 }
494 } else
Jerry Yue1b9c292021-09-10 10:08:31 +0800495#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100496 if (0 /* other KEMs? */) {
Jerry Yue1b9c292021-09-10 10:08:31 +0800497 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 } else {
499 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yue1b9c292021-09-10 10:08:31 +0800500 }
Jerry Yue1b9c292021-09-10 10:08:31 +0800501
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +0800503}
504
XiaokangQiand59be772022-01-24 10:12:51 +0000505/*
506 * ssl_tls13_parse_cookie_ext()
507 * Parse cookie extension in Hello Retry Request
508 *
509 * struct {
510 * opaque cookie<1..2^16-1>;
511 * } Cookie;
512 *
513 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
514 * extension to the client (this is an exception to the usual rule that
515 * the only extensions that may be sent are those that appear in the
516 * ClientHello). When sending the new ClientHello, the client MUST copy
517 * the contents of the extension received in the HelloRetryRequest into
518 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
519 * cookies in their initial ClientHello in subsequent connections.
520 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200521MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100522static int ssl_tls13_parse_cookie_ext(mbedtls_ssl_context *ssl,
523 const unsigned char *buf,
524 const unsigned char *end)
XiaokangQian43550bd2022-01-21 04:32:58 +0000525{
XiaokangQian25c9c902022-02-08 10:49:53 +0000526 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000527 const unsigned char *p = buf;
528 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
529
530 /* Retrieve length field of cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
532 cookie_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian43550bd2022-01-21 04:32:58 +0000533 p += 2;
534
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cookie_len);
536 MBEDTLS_SSL_DEBUG_BUF(3, "cookie extension", p, cookie_len);
XiaokangQian43550bd2022-01-21 04:32:58 +0000537
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 mbedtls_free(handshake->cookie);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800539 handshake->cookie_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 handshake->cookie = mbedtls_calloc(1, cookie_len);
541 if (handshake->cookie == NULL) {
542 MBEDTLS_SSL_DEBUG_MSG(1,
543 ("alloc failed ( %ud bytes )",
544 cookie_len));
545 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
XiaokangQian43550bd2022-01-21 04:32:58 +0000546 }
547
Gilles Peskine449bd832023-01-11 14:50:10 +0100548 memcpy(handshake->cookie, p, cookie_len);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800549 handshake->cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000550
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 return 0;
XiaokangQian43550bd2022-01-21 04:32:58 +0000552}
XiaokangQian43550bd2022-01-21 04:32:58 +0000553
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200554MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100555static int ssl_tls13_write_cookie_ext(mbedtls_ssl_context *ssl,
556 unsigned char *buf,
557 unsigned char *end,
558 size_t *out_len)
XiaokangQian0b64eed2022-01-27 10:36:51 +0000559{
560 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000561 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000562 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000563
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 if (handshake->cookie == NULL) {
565 MBEDTLS_SSL_DEBUG_MSG(3, ("no cookie to send; skip extension"));
566 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000567 }
568
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, cookie",
570 handshake->cookie,
571 handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000572
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 MBEDTLS_SSL_CHK_BUF_PTR(p, end, handshake->cookie_len + 6);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000574
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding cookie extension"));
XiaokangQian0b64eed2022-01-27 10:36:51 +0000576
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_COOKIE, p, 0);
578 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len + 2, p, 2);
579 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len, p, 4);
XiaokangQian233397e2022-02-07 08:32:16 +0000580 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000581
582 /* Cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 memcpy(p, handshake->cookie, handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000584
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800585 *out_len = handshake->cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000586
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_COOKIE);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000590}
591
Ronald Cron41a443a2022-10-04 16:38:25 +0200592#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000593/*
594 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
595 *
596 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
597 *
598 * struct {
599 * PskKeyExchangeMode ke_modes<1..255>;
600 * } PskKeyExchangeModes;
601 */
XiaokangQian86981952022-07-19 09:51:50 +0000602MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100603static int ssl_tls13_write_psk_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
604 unsigned char *buf,
605 unsigned char *end,
606 size_t *out_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000607{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000608 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000609 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000610
Gilles Peskine449bd832023-01-11 14:50:10 +0100611 ((void) ke_modes_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000612 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000613
XiaokangQianeb69aee2022-07-05 08:21:43 +0000614 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000615 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000616 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 if (!mbedtls_ssl_conf_tls13_some_psk_enabled(ssl)) {
618 MBEDTLS_SSL_DEBUG_MSG(3, ("skip psk_key_exchange_modes extension"));
619 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000620 }
621
622 /* Require 7 bytes of data, otherwise fail,
623 * even if extension might be shorter.
624 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000626 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100627 3, ("client hello, adding psk_key_exchange_modes extension"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000628
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000630
XiaokangQian008d2bf2022-07-14 07:54:01 +0000631 /* Skip extension length (2 bytes) and
632 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000633 */
634 p += 5;
635
Gilles Peskine449bd832023-01-11 14:50:10 +0100636 if (mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl)) {
XiaokangQianeb69aee2022-07-05 08:21:43 +0000637 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000638 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000639
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding PSK-ECDHE key exchange mode"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000641 }
642
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 if (mbedtls_ssl_conf_tls13_psk_enabled(ssl)) {
Ronald Crona709a0f2022-09-27 16:46:11 +0200644 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
645 ke_modes_len++;
646
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding pure PSK key exchange mode"));
Ronald Crona709a0f2022-09-27 16:46:11 +0200648 }
649
XiaokangQian008d2bf2022-07-14 07:54:01 +0000650 /* Now write the extension and ke_modes length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100651 MBEDTLS_PUT_UINT16_BE(ke_modes_len + 1, buf, 2);
XiaokangQian008d2bf2022-07-14 07:54:01 +0000652 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000653
654 *out_len = p - buf;
Jerry Yu0c354a22022-08-29 15:25:36 +0800655
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800656 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100657 ssl, MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800658
Gilles Peskine449bd832023-01-11 14:50:10 +0100659 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000660}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800661
Gilles Peskine449bd832023-01-11 14:50:10 +0100662static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg(int ciphersuite)
Jerry Yuf7c12592022-09-28 22:09:38 +0800663{
Jerry Yu21f90952022-10-08 10:30:53 +0800664 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800666
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 if (ciphersuite_info != NULL) {
668 return mbedtls_psa_translate_md(ciphersuite_info->mac);
669 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 return PSA_ALG_NONE;
Jerry Yuf7c12592022-09-28 22:09:38 +0800672}
673
Jerry Yuf75364b2022-09-30 10:30:31 +0800674#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100675static int ssl_tls13_has_configured_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qianb781a232022-11-01 07:39:46 +0000676{
677 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return ssl->handshake->resume &&
Pengyu Lv93566782022-12-07 12:10:05 +0800679 session != NULL && session->ticket != NULL &&
Pengyu Lv9b84ea72023-01-16 14:08:23 +0800680 mbedtls_ssl_conf_tls13_check_kex_modes(
681 ssl, mbedtls_ssl_session_get_ticket_flags(
682 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL));
Xiaokang Qianb781a232022-11-01 07:39:46 +0000683}
684
Xiaokang Qian01323a42022-11-03 02:27:35 +0000685#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100686static int ssl_tls13_early_data_has_valid_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qian01323a42022-11-03 02:27:35 +0000687{
688 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return ssl->handshake->resume &&
690 session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
691 (session->ticket_flags &
692 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) &&
693 mbedtls_ssl_tls13_cipher_suite_is_offered(
694 ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000695}
696#endif
697
Xiaokang Qianb781a232022-11-01 07:39:46 +0000698MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100699static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
700 psa_algorithm_t *hash_alg,
701 const unsigned char **identity,
702 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800703{
704 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800705
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 if (!ssl_tls13_has_configured_ticket(ssl)) {
707 return -1;
708 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800709
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800711 *identity = session->ticket;
712 *identity_len = session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800714}
715
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800716MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100717static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
718 psa_algorithm_t *hash_alg,
719 const unsigned char **psk,
720 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800721{
722
723 mbedtls_ssl_session *session = ssl->session_negotiate;
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 if (!ssl_tls13_has_configured_ticket(ssl)) {
726 return -1;
727 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800728
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800730 *psk = session->resumption_key;
731 *psk_len = session->resumption_key_len;
732
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800734}
Jerry Yuf7c12592022-09-28 22:09:38 +0800735#endif /* MBEDTLS_SSL_SESSION_TICKETS */
736
737MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100738static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
739 psa_algorithm_t *hash_alg,
740 const unsigned char **identity,
741 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800742{
Jerry Yu8b41e892022-09-30 10:00:20 +0800743
Gilles Peskine449bd832023-01-11 14:50:10 +0100744 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
745 return -1;
746 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800747
Jerry Yua99cbfa2022-10-08 11:17:14 +0800748 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800749 *identity = ssl->conf->psk_identity;
750 *identity_len = ssl->conf->psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800752}
753
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800754MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100755static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
756 psa_algorithm_t *hash_alg,
757 const unsigned char **psk,
758 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800759{
Jerry Yu8b41e892022-09-30 10:00:20 +0800760
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
762 return -1;
763 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800764
Jerry Yua99cbfa2022-10-08 11:17:14 +0800765 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800766 *psk = ssl->conf->psk;
767 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100768 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800769}
770
Gilles Peskine449bd832023-01-11 14:50:10 +0100771static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800772{
773 int configured_psk_count = 0;
774#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 if (ssl_tls13_has_configured_ticket(ssl)) {
776 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800777 configured_psk_count++;
778 }
779#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
781 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800782 configured_psk_count++;
783 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800785}
786
Jerry Yuf7c12592022-09-28 22:09:38 +0800787MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100788static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
789 unsigned char *buf,
790 unsigned char *end,
791 const unsigned char *identity,
792 size_t identity_len,
793 uint32_t obfuscated_ticket_age,
794 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800795{
Jerry Yuf75364b2022-09-30 10:30:31 +0800796 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800797 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800798
799 /*
800 * - identity_len (2 bytes)
801 * - identity (psk_identity_len bytes)
802 * - obfuscated_ticket_age (4 bytes)
803 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100804 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800805
Gilles Peskine449bd832023-01-11 14:50:10 +0100806 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
807 memcpy(buf + 2, identity, identity_len);
808 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800809
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800811
812 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800813
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800815}
816
Jerry Yu8b41e892022-09-30 10:00:20 +0800817MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100818static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
819 unsigned char *buf,
820 unsigned char *end,
821 int psk_type,
822 psa_algorithm_t hash_alg,
823 const unsigned char *psk,
824 size_t psk_len,
825 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800826{
827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800828 unsigned char binder_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100829 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800830 size_t transcript_len = 0;
831
832 *out_len = 0;
833
Gilles Peskine449bd832023-01-11 14:50:10 +0100834 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800835
836 /*
837 * - binder_len (1 bytes)
838 * - binder (binder_len bytes)
839 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100840 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800841
Jerry Yua99cbfa2022-10-08 11:17:14 +0800842 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800843
844 /* Get current state of handshake transcript. */
845 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100846 ssl, mbedtls_hash_info_md_from_psa(hash_alg),
847 transcript, sizeof(transcript), &transcript_len);
848 if (ret != 0) {
849 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800850 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100851
852 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
853 psk, psk_len, psk_type,
854 transcript, buf + 1);
855 if (ret != 0) {
856 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
857 return ret;
858 }
859 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800860
861 *out_len = 1 + binder_len;
862
Gilles Peskine449bd832023-01-11 14:50:10 +0100863 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800864}
865
866/*
867 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
868 *
869 * struct {
870 * opaque identity<1..2^16-1>;
871 * uint32 obfuscated_ticket_age;
872 * } PskIdentity;
873 *
874 * opaque PskBinderEntry<32..255>;
875 *
876 * struct {
877 * PskIdentity identities<7..2^16-1>;
878 * PskBinderEntry binders<33..2^16-1>;
879 * } OfferedPsks;
880 *
881 * struct {
882 * select (Handshake.msg_type) {
883 * case client_hello: OfferedPsks;
884 * ...
885 * };
886 * } PreSharedKeyExtension;
887 *
888 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000889int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100890 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
891 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000892{
Jerry Yuf7c12592022-09-28 22:09:38 +0800893 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800894 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800895 unsigned char *p = buf;
Xiaokang Qian854db282022-12-19 07:31:27 +0000896 psa_algorithm_t hash_alg = PSA_ALG_NONE;
Jerry Yuf75364b2022-09-30 10:30:31 +0800897 const unsigned char *identity;
898 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800899 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800900 size_t output_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800901 *out_len = 0;
902 *binders_len = 0;
903
904 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Gilles Peskine449bd832023-01-11 14:50:10 +0100905 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
906 if (configured_psk_count == 0) {
907 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
908 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800909 }
910
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
912 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800913
Jerry Yuf7c12592022-09-28 22:09:38 +0800914 /* Check if we have space to write the extension, binders included.
915 * - extension_type (2 bytes)
916 * - extension_data_len (2 bytes)
917 * - identities_len (2 bytes)
918 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800920 p += 6;
921
Jerry Yuf75364b2022-09-30 10:30:31 +0800922#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 if (ssl_tls13_ticket_get_identity(
924 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800925#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +0100926 mbedtls_time_t now = mbedtls_time(NULL);
Jerry Yuf75364b2022-09-30 10:30:31 +0800927 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800928 uint32_t obfuscated_ticket_age =
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 (uint32_t) (now - session->ticket_received);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800930
Jerry Yu3e60cad2023-01-10 14:58:08 +0800931 /*
932 * The ticket timestamp is in seconds but the ticket age is in
933 * milliseconds. If the ticket was received at the end of a second and
934 * re-used here just at the beginning of the next second, the computed
935 * age `now - session->ticket_received` is equal to 1s thus 1000 ms
936 * while the actual age could be just a few milliseconds or tens of
937 * milliseconds. If the server has more accurate ticket timestamps
938 * (typically timestamps in milliseconds), as part of the processing of
939 * the ClientHello, it may compute a ticket lifetime smaller than the
940 * one computed here and potentially reject the ticket. To avoid that,
941 * remove one second to the ticket age if possible.
Jerry Yubdb936b2023-01-07 16:07:46 +0800942 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 if (obfuscated_ticket_age > 0) {
Jerry Yubdb936b2023-01-07 16:07:46 +0800944 obfuscated_ticket_age -= 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 }
Jerry Yubdb936b2023-01-07 16:07:46 +0800946
Jerry Yuf75364b2022-09-30 10:30:31 +0800947 obfuscated_ticket_age *= 1000;
948 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800949
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 ret = ssl_tls13_write_identity(ssl, p, end,
951 identity, identity_len,
952 obfuscated_ticket_age,
953 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800954#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
956 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800957#endif /* MBEDTLS_HAVE_TIME */
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 if (ret != 0) {
959 return ret;
960 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800961
Jerry Yuf75364b2022-09-30 10:30:31 +0800962 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +0800964 }
965#endif /* MBEDTLS_SSL_SESSION_TICKETS */
966
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 if (ssl_tls13_psk_get_identity(
968 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800969
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
971 &output_len);
972 if (ret != 0) {
973 return ret;
974 }
Jerry Yuf75364b2022-09-30 10:30:31 +0800975
Jerry Yuf7c12592022-09-28 22:09:38 +0800976 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +0800978 }
979
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 MBEDTLS_SSL_DEBUG_MSG(3,
981 ("client hello, adding pre_shared_key extension, "
982 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +0800983
984 /* Take into account the two bytes for the length of the binders. */
985 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800986 /* Check if there is enough space for binders */
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800988
Jerry Yuf7c12592022-09-28 22:09:38 +0800989 /*
990 * - extension_type (2 bytes)
991 * - extension_data_len (2 bytes)
992 * - identities_len (2 bytes)
993 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
995 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
996 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +0800997
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800999 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +08001000
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +08001002
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001004}
1005
XiaokangQian86981952022-07-19 09:51:50 +00001006int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001008{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001009 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1010 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001011 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1012 const unsigned char *psk;
1013 size_t psk_len;
1014 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001015
1016 /* Check if we have space to write binders_len.
1017 * - binders_len (2 bytes)
1018 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001020 p += 2;
1021
Jerry Yu6183cc72022-09-30 11:08:57 +08001022#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001024
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 ret = ssl_tls13_write_binder(ssl, p, end,
1026 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1027 hash_alg, psk, psk_len,
1028 &output_len);
1029 if (ret != 0) {
1030 return ret;
1031 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001032 p += output_len;
1033 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001034#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001035
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001037
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 ret = ssl_tls13_write_binder(ssl, p, end,
1039 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1040 hash_alg, psk, psk_len,
1041 &output_len);
1042 if (ret != 0) {
1043 return ret;
1044 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001045 p += output_len;
1046 }
1047
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001049
1050 /*
1051 * - binders_len (2 bytes)
1052 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001054
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001056
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001057 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001059
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001061}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001062
1063/*
1064 * struct {
1065 * opaque identity<1..2^16-1>;
1066 * uint32 obfuscated_ticket_age;
1067 * } PskIdentity;
1068 *
1069 * opaque PskBinderEntry<32..255>;
1070 *
1071 * struct {
1072 *
1073 * select (Handshake.msg_type) {
1074 * ...
1075 * case server_hello: uint16 selected_identity;
1076 * };
1077 *
1078 * } PreSharedKeyExtension;
1079 *
1080 */
1081MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001082static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1083 const unsigned char *buf,
1084 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001085{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001086 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001087 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001088 const unsigned char *psk;
1089 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001090 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001091
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1093 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001094 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001095
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1099 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001100
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1102 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1103 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001104 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001105
Jerry Yu4a698342022-09-30 12:22:01 +08001106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianea28a782023-01-12 03:18:31 +00001107 if (ssl->handshake->ciphersuite_info->id !=
Xiaokang Qianf10f4742023-01-06 03:43:56 +00001108 ssl->session_negotiate->ciphersuite) {
1109 MBEDTLS_SSL_DEBUG_MSG(
1110 1, ("Invalid ciphersuite for session ticket psk."));
1111
1112 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1113 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1114 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1115 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1117 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1118 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001119#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1121 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
Xiaokang Qian1d8e86c2023-01-12 03:28:18 +00001122 if (mbedtls_psa_translate_md(ssl->handshake->ciphersuite_info->mac)
1123 != hash_alg) {
Xiaokang Qianf10f4742023-01-06 03:43:56 +00001124 MBEDTLS_SSL_DEBUG_MSG(
1125 1, ("Invalid ciphersuite for external psk."));
1126
1127 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1128 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1129 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1130 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 } else {
1132 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1133 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001134 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 if (ret != 0) {
1136 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001137 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001138
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1140 if (ret != 0) {
1141 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1142 return ret;
1143 }
1144
1145 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001146}
Ronald Cron41a443a2022-10-04 16:38:25 +02001147#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001148
Gilles Peskine449bd832023-01-11 14:50:10 +01001149int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1150 unsigned char *buf,
1151 unsigned char *end,
1152 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001153{
1154 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1155 unsigned char *p = buf;
1156 size_t ext_len;
1157
1158 *out_len = 0;
1159
1160 /* Write supported_versions extension
1161 *
1162 * Supported Versions Extension is mandatory with TLS 1.3.
1163 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1165 if (ret != 0) {
1166 return ret;
1167 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001168 p += ext_len;
1169
1170 /* Echo the cookie if the server provided one in its preceding
1171 * HelloRetryRequest message.
1172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1174 if (ret != 0) {
1175 return ret;
1176 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001177 p += ext_len;
1178
Ronald Cron766c0cd2022-10-18 12:17:11 +02001179#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1181 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1182 if (ret != 0) {
1183 return ret;
1184 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001185 p += ext_len;
1186 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001187#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001188
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001189#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1191 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1192 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1193 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1194 if (ret != 0) {
1195 return ret;
1196 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001197 p += ext_len;
1198
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001199 /* Initializes the status to `rejected`. It will be updated to
1200 * `accepted` if the EncryptedExtension message contain an early data
1201 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001202 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001203 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 } else {
1205 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001206 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001207 }
1208#endif /* MBEDTLS_SSL_EARLY_DATA */
1209
Ronald Cron41a443a2022-10-04 16:38:25 +02001210#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001211 /* For PSK-based key exchange we need the pre_shared_key extension
1212 * and the psk_key_exchange_modes extension.
1213 *
1214 * The pre_shared_key extension MUST be the last extension in the
1215 * ClientHello. Servers MUST check that it is the last extension and
1216 * otherwise fail the handshake with an "illegal_parameter" alert.
1217 *
1218 * Add the psk_key_exchange_modes extension.
1219 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1221 if (ret != 0) {
1222 return ret;
1223 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001224 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001225#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001226
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001227 *out_len = p - buf;
1228
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001230}
1231
Xiaokang Qian126929f2023-01-03 10:29:41 +00001232int mbedtls_ssl_tls13_finalize_write_client_hello(mbedtls_ssl_context *ssl)
1233{
Xiaokang Qian90746132023-01-06 05:54:59 +00001234 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001235#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1236 mbedtls_ssl_handshake_set_state(
1237 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1238#else
1239 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1240#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1241
Xiaokang Qian126929f2023-01-03 10:29:41 +00001242#if defined(MBEDTLS_SSL_EARLY_DATA)
1243 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1244 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1245 const unsigned char *psk;
1246 size_t psk_len;
1247 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001248
Xiaokang Qian126929f2023-01-03 10:29:41 +00001249 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
1250 MBEDTLS_SSL_DEBUG_MSG(
1251 1, ("Set hs psk for early data when writing the first psk"));
1252
1253 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1254 if (ret != 0) {
1255 MBEDTLS_SSL_DEBUG_RET(
1256 1, "ssl_tls13_ticket_get_psk", ret);
1257 return ret;
1258 }
1259
1260 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1261 if (ret != 0) {
1262 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1263 return ret;
1264 }
1265
1266 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1267 ssl->session_negotiate->ciphersuite);
1268 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian42242442023-01-12 02:26:17 +00001269 /* Enable psk and psk_ephermal to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001270 ssl->handshake->key_exchange_mode =
1271 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1272
1273 /* Start the TLS 1.3 key schedule:
1274 * Set the PSK and derive early secret.
1275 */
1276 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1277 if (ret != 0) {
1278 MBEDTLS_SSL_DEBUG_RET(1,
1279 "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1280 return ret;
1281 }
1282
1283 /* Derive early data key material */
1284 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1285 if (ret != 0) {
1286 MBEDTLS_SSL_DEBUG_RET(1,
1287 "mbedtls_ssl_tls13_compute_early_transform", ret);
1288 return ret;
1289 }
1290
Xiaokang Qian126929f2023-01-03 10:29:41 +00001291 }
1292#endif /* MBEDTLS_SSL_EARLY_DATA */
1293 return 0;
1294}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001295/*
Jerry Yu4a173382021-10-11 21:45:31 +08001296 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001297 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001298
Ronald Cronda41b382022-03-30 09:57:11 +02001299/**
1300 * \brief Detect if the ServerHello contains a supported_versions extension
1301 * or not.
1302 *
1303 * \param[in] ssl SSL context
1304 * \param[in] buf Buffer containing the ServerHello message
1305 * \param[in] end End of the buffer containing the ServerHello message
1306 *
1307 * \return 0 if the ServerHello does not contain a supported_versions extension
1308 * \return 1 if the ServerHello contains a supported_versions extension
1309 * \return A negative value if an error occurred while parsing the ServerHello.
1310 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001311MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001312static int ssl_tls13_is_supported_versions_ext_present(
1313 mbedtls_ssl_context *ssl,
1314 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001316{
1317 const unsigned char *p = buf;
1318 size_t legacy_session_id_echo_len;
1319 size_t extensions_len;
1320 const unsigned char *extensions_end;
1321
1322 /*
1323 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001324 * length:
1325 * - legacy_version 2 bytes
1326 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1327 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001328 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001330 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1331 legacy_session_id_echo_len = *p;
1332
1333 /*
1334 * Jump to the extensions, jumping over:
1335 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1336 * - cipher_suite 2 bytes
1337 * - legacy_compression_method 1 byte
1338 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1340 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001341
1342 /* Case of no extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 if (p == end) {
1344 return 0;
1345 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001346
1347 /* ...
1348 * Extension extensions<6..2^16-1>;
1349 * ...
1350 * struct {
1351 * ExtensionType extension_type; (2 bytes)
1352 * opaque extension_data<0..2^16-1>;
1353 * } Extension;
1354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1356 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001357 p += 2;
1358
1359 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001361 extensions_end = p + extensions_len;
1362
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 while (p < extensions_end) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01001364 unsigned int extension_type;
1365 size_t extension_data_len;
1366
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1368 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1369 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001370 p += 4;
1371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 if (extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS) {
1373 return 1;
1374 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001377 p += extension_data_len;
1378 }
1379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 return 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001381}
1382
Jerry Yu7a186a02021-10-15 18:46:14 +08001383/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001384 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1385 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1386 * - 0 otherwise
1387 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001388MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001389static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1390 const unsigned char *buf,
1391 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001392{
1393 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1394 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001395 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001396 const unsigned char *last_eight_bytes_of_random;
1397 unsigned char last_byte_of_random;
1398
Gilles Peskine449bd832023-01-11 14:50:10 +01001399 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001400 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1401
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 if (memcmp(last_eight_bytes_of_random,
1403 magic_downgrade_string,
1404 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001405 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 return last_byte_of_random == 0 ||
1407 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001408 }
1409
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001411}
1412
1413/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001414 * - SSL_SERVER_HELLO or
1415 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001416 * to indicate which message is expected and to be parsed next.
1417 */
Ronald Cron828aff62022-05-31 12:04:31 +02001418#define SSL_SERVER_HELLO 0
1419#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001420MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001421static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1422 const unsigned char *buf,
1423 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001424{
Jerry Yue1b9c292021-09-10 10:08:31 +08001425
1426 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1427 *
Jerry Yu4a173382021-10-11 21:45:31 +08001428 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001429 * special value of the SHA-256 of "HelloRetryRequest".
1430 *
1431 * struct {
1432 * ProtocolVersion legacy_version = 0x0303;
1433 * Random random;
1434 * opaque legacy_session_id_echo<0..32>;
1435 * CipherSuite cipher_suite;
1436 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001437 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001438 * } ServerHello;
1439 *
1440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end,
1442 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001443
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1445 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1446 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001447 }
1448
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001450}
1451
Ronald Cron828aff62022-05-31 12:04:31 +02001452/*
Jerry Yu745bb612021-10-13 22:01:04 +08001453 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001454 * - SSL_SERVER_HELLO or
1455 * - SSL_SERVER_HELLO_HRR or
1456 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001457 */
Ronald Cron828aff62022-05-31 12:04:31 +02001458#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001459MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001460static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1461 const unsigned char *buf,
1462 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001463{
Jerry Yu4a173382021-10-11 21:45:31 +08001464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001465 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001466
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1468 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001469
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001471 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001473
1474 /* If the server is negotiating TLS 1.2 or below and:
1475 * . we did not propose TLS 1.2 or
1476 * . the server responded it is TLS 1.3 capable but negotiating a lower
1477 * version of the protocol and thus we are under downgrade attack
1478 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001479 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1481 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1482 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1483 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001484 }
1485
1486 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001487 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001488 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1489 buf, (size_t) (end - buf));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001490
Gilles Peskine449bd832023-01-11 14:50:10 +01001491 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1492 ret = ssl_tls13_reset_key_share(ssl);
1493 if (ret != 0) {
1494 return ret;
1495 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001496 }
1497
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001499 }
1500
Jerry Yua66fece2022-07-13 14:30:29 +08001501#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1502 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1503 ssl->session_negotiate->tls_version = ssl->tls_version;
1504#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1505
Jerry Yu50e00e32022-10-31 14:45:01 +08001506 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001507
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1509 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001510 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001512 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001513 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
1515 /* If a client receives a second
1516 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1517 * was itself in response to a HelloRetryRequest), it MUST abort the
1518 * handshake with an "unexpected_message" alert.
1519 */
1520 if (handshake->hello_retry_request_count > 0) {
1521 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
1522 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1523 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
1524 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;
Xiaokang Qian33ff8682023-01-10 06:32:12 +00001711#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianea28a782023-01-12 03:18:31 +00001712 if (handshake->resume == 0)
Xiaokang Qian33ff8682023-01-10 06:32:12 +00001713#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001714 ssl->session_negotiate->ciphersuite = cipher_suite;
1715
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1717 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001718
1719#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 ssl->session_negotiate->start = time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001721#endif /* MBEDTLS_HAVE_TIME */
1722
Jerry Yu4a173382021-10-11 21:45:31 +08001723 /* ...
1724 * uint8 legacy_compression_method = 0;
1725 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001726 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1728 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1729 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001730 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001731 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001732 }
1733 p++;
1734
Jerry Yub85277e2021-10-13 13:36:05 +08001735 /* ...
1736 * Extension extensions<6..2^16-1>;
1737 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001738 * struct {
1739 * ExtensionType extension_type; (2 bytes)
1740 * opaque extension_data<0..2^16-1>;
1741 * } Extension;
1742 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1744 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001745 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001746
Jerry Yu4a173382021-10-11 21:45:31 +08001747 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001749 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001750
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001752
Jerry Yu50e00e32022-10-31 14:45:01 +08001753 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001754 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1756 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001757
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001759 unsigned int extension_type;
1760 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001761 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001762
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1764 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1765 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001766 p += 4;
1767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001769 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001770
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001771 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1773 if (ret != 0) {
1774 return ret;
1775 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001776
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001778 case MBEDTLS_TLS_EXT_COOKIE:
1779
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 ret = ssl_tls13_parse_cookie_ext(ssl,
1781 p, extension_data_end);
1782 if (ret != 0) {
1783 MBEDTLS_SSL_DEBUG_RET(1,
1784 "ssl_tls13_parse_cookie_ext",
1785 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001786 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001787 }
XiaokangQianb851da82022-01-14 04:03:11 +00001788 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001789
Jerry Yue1b9c292021-09-10 10:08:31 +08001790 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1792 p,
1793 extension_data_end);
1794 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001795 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001797 break;
1798
Ronald Cron41a443a2022-10-04 16:38:25 +02001799#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001800 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001802
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1804 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001805 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1807 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001808 }
1809 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001810#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001811
Jerry Yue1b9c292021-09-10 10:08:31 +08001812 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1814 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001815 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001816 goto cleanup;
1817 }
1818
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 if (is_hrr) {
1820 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1821 p, extension_data_end);
1822 } else {
1823 ret = ssl_tls13_parse_key_share_ext(ssl,
1824 p, extension_data_end);
1825 }
1826 if (ret != 0) {
1827 MBEDTLS_SSL_DEBUG_RET(1,
1828 "ssl_tls13_parse_key_share_ext",
1829 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001830 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001831 }
1832 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001833
1834 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001835 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1836 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001837 }
1838
1839 p += extension_data_len;
1840 }
1841
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001843
XiaokangQiand59be772022-01-24 10:12:51 +00001844cleanup:
1845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1847 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1848 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001849 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1851 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1852 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001853 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1854 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001856}
1857
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001858#if defined(MBEDTLS_DEBUG_C)
1859static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001860{
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001862 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1863 return "psk";
1864 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1865 return "ephemeral";
1866 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1867 return "psk_ephemeral";
1868 default:
1869 return "unknown mode";
1870 }
1871}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001872#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001873
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001874MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001875static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001876{
Jerry Yub85277e2021-10-13 13:36:05 +08001877 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001878 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001879
Jerry Yub85277e2021-10-13 13:36:05 +08001880 /* Determine the key exchange mode:
1881 * 1) If both the pre_shared_key and key_share extensions were received
1882 * then the key exchange mode is PSK with EPHEMERAL.
1883 * 2) If only the pre_shared_key extension was received then the key
1884 * exchange mode is PSK-only.
1885 * 3) If only the key_share extension was received then the key
1886 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001887 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 switch (handshake->received_extensions &
1889 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001890 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Ronald Cron79907712022-07-20 17:05:29 +02001892 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001893 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001894
Jerry Yu745bb612021-10-13 22:01:04 +08001895 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Ronald Cron79907712022-07-20 17:05:29 +02001897 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001898 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001899
Jerry Yu745bb612021-10-13 22:01:04 +08001900 /* Both the pre_shared_key and key_share extensions were received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
Ronald Cron79907712022-07-20 17:05:29 +02001902 handshake->key_exchange_mode = 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)
1912 if (ssl->handshake->sent_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1913 ssl->handshake->selected_identity != 0) {
1914 /* RFC8446 4.2.11
1915 * If the server supplies an "early_data" extension, the
1916 * client MUST verify that the server's selected_identity
1917 * is 0. If any other value is returned, the client MUST
1918 * abort the handshake with an "illegal_parameter" alert.
1919 */
1920 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1921 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1922 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1923 }
1924#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001925
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 if (!mbedtls_ssl_conf_tls13_check_kex_modes(ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001927 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 MBEDTLS_SSL_DEBUG_MSG(2,
1929 ("Key exchange mode(%s) is not supported.",
1930 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001931 goto cleanup;
1932 }
1933
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 MBEDTLS_SSL_DEBUG_MSG(3,
1935 ("Selected key exchange mode: %s",
1936 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001937
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001938 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001939 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001940 * If we proposed early data then we have already derived an
1941 * early secret using the selected PSK and its associated hash.
1942 * It means that if the negotiated key exchange mode is psk or
1943 * psk_ephemeral, we have already correctly computed the
1944 * early secret and thus we do not do it again. In all other
1945 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001946 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001947#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian42242442023-01-12 02:26:17 +00001948 if ((ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT) ||
1949 (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED &&
1950 handshake->key_exchange_mode ==
1951 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL))
Xiaokang Qian90746132023-01-06 05:54:59 +00001952#endif
1953 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001954 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1955 if (ret != 0) {
1956 MBEDTLS_SSL_DEBUG_RET(
1957 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1958 goto cleanup;
1959 }
Jerry Yu0b177842021-09-05 19:41:30 +08001960 }
1961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1963 if (ret != 0) {
1964 MBEDTLS_SSL_DEBUG_RET(1,
1965 "mbedtls_ssl_tls13_compute_handshake_transform",
1966 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001967 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001968 }
1969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1971 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Jerry Yu0b177842021-09-05 19:41:30 +08001972 ssl->session_in = ssl->session_negotiate;
1973
Jerry Yu4a173382021-10-11 21:45:31 +08001974cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001976 MBEDTLS_SSL_PEND_FATAL_ALERT(
1977 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001979 }
Jerry Yue110d252022-05-05 10:19:22 +08001980
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001982}
1983
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001984MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001985static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00001986{
1987 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1988
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00001990
XiaokangQian78b1fa72022-01-19 06:56:30 +00001991 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001992 * We are going to re-generate a shared secret corresponding to the group
1993 * selected by the server, which is different from the group for which we
1994 * generated a shared secret in the first client hello.
1995 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001996 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 ret = ssl_tls13_reset_key_share(ssl);
1998 if (ret != 0) {
1999 return ret;
2000 }
XiaokangQian647719a2021-12-07 09:16:29 +00002001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002003}
2004
Jerry Yue1b9c292021-09-10 10:08:31 +08002005/*
Jerry Yu4a173382021-10-11 21:45:31 +08002006 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002007 * Handler for MBEDTLS_SSL_SERVER_HELLO
2008 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002009MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002010static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002011{
Jerry Yu4a173382021-10-11 21:45:31 +08002012 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002013 unsigned char *buf = NULL;
2014 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002015 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002016
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002018
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2020 MBEDTLS_SSL_HS_SERVER_HELLO,
2021 &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002022
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2024 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002025 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 } else {
2027 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2028 }
XiaokangQiand59be772022-01-24 10:12:51 +00002029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002031 ret = 0;
2032 goto cleanup;
2033 }
2034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2036 buf + buf_len,
2037 is_hrr));
2038 if (is_hrr) {
2039 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002040 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002041
2042 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2043 buf, buf_len);
2044
2045 if (is_hrr) {
2046 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2047#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2048 /* If not offering early data, the client sends a dummy CCS record
2049 * immediately before its second flight. This may either be before
2050 * its second ClientHello or before its encrypted handshake flight.
2051 */
2052 mbedtls_ssl_handshake_set_state(ssl,
2053 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
2054#else
2055 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2056#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2057 } else {
2058 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2059 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002060 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002061
2062cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2064 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2065 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002066}
2067
2068/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002069 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002070 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002071 *
2072 * The EncryptedExtensions message contains any extensions which
2073 * should be protected, i.e., any which are not needed to establish
2074 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002075 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002076
XiaokangQian08da26c2021-10-09 10:12:11 +00002077/* Parse EncryptedExtensions message
2078 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002079 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002080 * } EncryptedExtensions;
2081 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002082MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002083static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2084 const unsigned char *buf,
2085 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002086{
2087 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002088 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002089 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002090 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002091 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002092
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2094 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002095 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2098 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002099 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002100
Jerry Yu9eba7502022-10-31 13:46:16 +08002101 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002104 unsigned int extension_type;
2105 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002106
XiaokangQian08da26c2021-10-09 10:12:11 +00002107 /*
2108 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002109 * ExtensionType extension_type; (2 bytes)
2110 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002111 * } Extension;
2112 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2114 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2115 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002116 p += 4;
2117
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002119
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002120 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2122 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2123 if (ret != 0) {
2124 return ret;
2125 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002128#if defined(MBEDTLS_SSL_ALPN)
2129 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 if ((ret = ssl_tls13_parse_alpn_ext(ssl, p, (size_t) extension_data_len)) != 0) {
2133 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002134 }
2135
2136 break;
2137#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002138
2139#if defined(MBEDTLS_SSL_EARLY_DATA)
2140 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002141
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002143 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2145 MBEDTLS_ERR_SSL_DECODE_ERROR);
2146 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002147 }
2148
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002149 break;
2150#endif /* MBEDTLS_SSL_EARLY_DATA */
2151
XiaokangQian08da26c2021-10-09 10:12:11 +00002152 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002153 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002154 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002156 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002157 }
2158
XiaokangQian08da26c2021-10-09 10:12:11 +00002159 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002160 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2163 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002164
XiaokangQian97799ac2021-10-11 10:05:54 +00002165 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 if (p != end) {
2167 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2168 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2169 MBEDTLS_ERR_SSL_DECODE_ERROR);
2170 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002171 }
2172
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002174}
2175
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002176MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002177static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002178{
2179 int ret;
2180 unsigned char *buf;
2181 size_t buf_len;
2182
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002184
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2186 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2187 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002188
2189 /* Process the message contents */
2190 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002192
Xiaokang Qianb157e912022-11-23 08:12:26 +00002193#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 if (ssl->handshake->received_extensions &
2195 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002196 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2197 }
2198#endif
2199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2201 buf, buf_len);
Ronald Cron9d6a5452022-05-30 16:05:38 +02002202
Ronald Cron928cbd32022-10-04 16:14:26 +02002203#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2205 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2206 } else {
2207 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2208 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002209#else
2210 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002212#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002213
2214cleanup:
2215
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2217 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002218
2219}
2220
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002221/*
2222 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2223 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002224 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002225 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002226 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002227 *
2228 * If the server sent an "early_data" extension in EncryptedExtensions, the
2229 * client MUST send an EndOfEarlyData message after receiving the server
2230 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002231 */
2232
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002233MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002234static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2235{
2236 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002237 unsigned char *buf = NULL;
2238 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002239 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002240
Xiaokang Qian742578c2022-12-19 06:34:44 +00002241 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2242 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002243
Xiaokang Qian742578c2022-12-19 06:34:44 +00002244 mbedtls_ssl_add_hs_hdr_to_checksum(
2245 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002246
Xiaokang Qian742578c2022-12-19 06:34:44 +00002247 MBEDTLS_SSL_PROC_CHK(
2248 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002249
Xiaokang Qian43a83f22023-01-06 06:02:54 +00002250 /* TODO: Currently switch outbound back to handshake key in the case of
2251 * MBEDTLS_SSL_CLIENT_CERTIFICATE. If we refine the coordinate function
2252 * of client certificate state machine, we have to move the switch
2253 * outbound function.
2254 */
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002255
Xiaokang Qian19d44162023-01-03 03:39:50 +00002256 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002257
2258cleanup:
2259
2260 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2261 return ret;
2262}
2263
Ronald Cron928cbd32022-10-04 16:14:26 +02002264#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002265/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002266 * STATE HANDLING: CertificateRequest
2267 *
Jerry Yud2674312021-10-29 10:08:19 +08002268 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002269#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2270#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002271/* Coordination:
2272 * Deals with the ambiguity of not knowing if a CertificateRequest
2273 * will be sent. Returns a negative code on failure, or
2274 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2275 * - SSL_CERTIFICATE_REQUEST_SKIP
2276 * indicating if a Certificate Request is expected or not.
2277 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002278MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002279static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002280{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002281 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002282
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2284 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2285 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002286 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002287 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002288
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2290 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2291 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2292 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002293 }
2294
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002296
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002298}
2299
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002300/*
2301 * ssl_tls13_parse_certificate_request()
2302 * Parse certificate request
2303 * struct {
2304 * opaque certificate_request_context<0..2^8-1>;
2305 * Extension extensions<2..2^16-1>;
2306 * } CertificateRequest;
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_parse_certificate_request(mbedtls_ssl_context *ssl,
2310 const unsigned char *buf,
2311 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002312{
2313 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2314 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002315 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002316 size_t extensions_len = 0;
2317 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002318 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002319
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002320 /* ...
2321 * opaque certificate_request_context<0..2^8-1>
2322 * ...
2323 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002325 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002326 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (certificate_request_context_len > 0) {
2329 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2330 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2331 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002332
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002333 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 mbedtls_calloc(1, certificate_request_context_len);
2335 if (handshake->certificate_request_context == NULL) {
2336 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2337 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002338 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 memcpy(handshake->certificate_request_context, p,
2340 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002341 p += certificate_request_context_len;
2342 }
2343
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002344 /* ...
2345 * Extension extensions<2..2^16-1>;
2346 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2349 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002350 p += 2;
2351
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002353 extensions_end = p + extensions_len;
2354
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002355 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002356
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002358 unsigned int extension_type;
2359 size_t extension_data_len;
2360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2362 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2363 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002364 p += 4;
2365
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002367
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002368 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2370 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2371 if (ret != 0) {
2372 return ret;
2373 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002374
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002376 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 MBEDTLS_SSL_DEBUG_MSG(3,
2378 ("found signature algorithms extension"));
2379 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2380 p + extension_data_len);
2381 if (ret != 0) {
2382 return ret;
2383 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002384
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002385 break;
2386
2387 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002388 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002389 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002391 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002392 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002393
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002394 p += extension_data_len;
2395 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002396
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2398 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002399
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002400 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 if (p != end) {
2402 MBEDTLS_SSL_DEBUG_MSG(1,
2403 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002404 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002405 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002406
Jerry Yu0c354a22022-08-29 15:25:36 +08002407 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002408 *
2409 * The "signature_algorithms" extension MUST be specified
2410 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2412 MBEDTLS_SSL_DEBUG_MSG(3,
2413 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002414 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002415 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002416
Jerry Yu7840f812022-01-29 10:26:51 +08002417 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002419
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002420decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2422 MBEDTLS_ERR_SSL_DECODE_ERROR);
2423 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002424}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002425
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002426/*
2427 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2428 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002430static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002431{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002432 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002433
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002435
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002437
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002439 unsigned char *buf;
2440 size_t buf_len;
2441
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(ssl,
2443 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2444 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002445
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(ssl,
2447 buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002448
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 mbedtls_ssl_add_hs_msg_to_checksum(ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2450 buf, buf_len);
2451 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002452 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 } else {
2454 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002455 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2456 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002457 }
2458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002460
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002461cleanup:
2462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2464 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002465}
2466
2467/*
Jerry Yu687101b2021-09-14 16:03:56 +08002468 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2469 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002470MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002471static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002472{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002473 int ret;
2474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2476 if (ret != 0) {
2477 return ret;
2478 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2481 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002482}
2483
2484/*
2485 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2486 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002487MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002488static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002489{
Jerry Yu30b071c2021-09-12 20:16:03 +08002490 int ret;
2491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2493 if (ret != 0) {
2494 return ret;
2495 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002496
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2498 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002499}
Ronald Cron928cbd32022-10-04 16:14:26 +02002500#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002501
Jerry Yu687101b2021-09-14 16:03:56 +08002502/*
2503 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2504 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002505MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002506static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002507{
XiaokangQianac0385c2021-11-03 06:40:11 +00002508 int ret;
2509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2511 if (ret != 0) {
2512 return ret;
2513 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2516 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002517 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2519 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2520 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002521 }
2522
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002523#if defined(MBEDTLS_SSL_EARLY_DATA)
2524 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2525 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002526 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2527 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002528 } else
2529#endif /* MBEDTLS_SSL_EARLY_DATA */
2530 {
2531#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2532 mbedtls_ssl_handshake_set_state(
2533 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2534#else
2535 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2536#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2537 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002540}
2541
2542/*
Jerry Yu566c7812022-01-26 15:41:22 +08002543 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2544 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002545MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002546static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002547{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002548 int non_empty_certificate_msg = 0;
2549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 MBEDTLS_SSL_DEBUG_MSG(1,
2551 ("Switch to handshake traffic keys for outbound traffic"));
2552 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002553
Ronald Cron928cbd32022-10-04 16:14:26 +02002554#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 if (ssl->handshake->client_auth) {
2556 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2557 if (ret != 0) {
2558 return ret;
2559 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002562 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 }
2564 } else {
2565 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002566 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002567#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 if (non_empty_certificate_msg) {
2570 mbedtls_ssl_handshake_set_state(ssl,
2571 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2572 } else {
2573 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2574 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2575 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002578}
2579
Ronald Cron928cbd32022-10-04 16:14:26 +02002580#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002581/*
2582 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2583 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002584MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002585static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002586{
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (ret == 0) {
2590 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2591 }
Ronald Crona8b38872022-03-09 07:59:25 +01002592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002594}
Ronald Cron928cbd32022-10-04 16:14:26 +02002595#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002596
2597/*
Jerry Yu687101b2021-09-14 16:03:56 +08002598 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2599 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002600MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002601static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002602{
XiaokangQian0fa66432021-11-15 03:33:57 +00002603 int ret;
2604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2606 if (ret != 0) {
2607 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002608 }
2609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2611 if (ret != 0) {
2612 MBEDTLS_SSL_DEBUG_RET(1,
2613 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
2614 return ret;
2615 }
2616
2617 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2618 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002619}
2620
2621/*
2622 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2623 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002624MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002625static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002626{
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2628 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2629 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002630}
2631
2632/*
2633 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2634 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002635MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002636static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002637{
Jerry Yu378254d2021-10-30 21:44:47 +08002638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002640
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2642 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002643}
2644
Jerry Yuf8a49942022-07-07 11:32:32 +00002645#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2646
Jerry Yua0446a02022-07-13 11:22:55 +08002647MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002648static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2649 const unsigned char *buf,
2650 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002651{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002652 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002653 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002654
Jerry Yuf8a49942022-07-07 11:32:32 +00002655
Jerry Yuedab6372022-10-31 14:37:31 +08002656 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002659 unsigned int extension_type;
2660 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002661 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2664 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2665 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002666 p += 4;
2667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002669
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002670 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2672 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2673 if (ret != 0) {
2674 return ret;
2675 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002676
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002678#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002679 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002681 MBEDTLS_SSL_PEND_FATAL_ALERT(
2682 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 MBEDTLS_ERR_SSL_DECODE_ERROR);
2684 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002685 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002687 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002689 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002690 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002691#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002692
Jerry Yuf8a49942022-07-07 11:32:32 +00002693 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002694 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002695 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002697 break;
2698 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002699
Jerry Yuf8a49942022-07-07 11:32:32 +00002700 p += extension_data_len;
2701 }
2702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2704 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002707}
2708
2709/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002710 * From RFC8446, page 74
2711 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002712 * struct {
2713 * uint32 ticket_lifetime;
2714 * uint32 ticket_age_add;
2715 * opaque ticket_nonce<0..255>;
2716 * opaque ticket<1..2^16-1>;
2717 * Extension extensions<0..2^16-2>;
2718 * } NewSessionTicket;
2719 *
2720 */
Jerry Yua0446a02022-07-13 11:22:55 +08002721MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002722static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2723 unsigned char *buf,
2724 unsigned char *end,
2725 unsigned char **ticket_nonce,
2726 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002727{
2728 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2729 unsigned char *p = buf;
2730 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002731 size_t ticket_len;
2732 unsigned char *ticket;
2733 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002734
Jerry Yucb3b1392022-07-12 06:09:38 +00002735 *ticket_nonce = NULL;
2736 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002737 /*
2738 * ticket_lifetime 4 bytes
2739 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002740 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002741 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002743
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2745 MBEDTLS_SSL_DEBUG_MSG(3,
2746 ("ticket_lifetime: %u",
2747 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002748
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2750 MBEDTLS_SSL_DEBUG_MSG(3,
2751 ("ticket_age_add: %u",
2752 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002753
Jerry Yucb3b1392022-07-12 06:09:38 +00002754 *ticket_nonce_len = p[8];
2755 p += 9;
2756
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002758 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002760 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002761
2762 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2764 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002765 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2767 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002768
2769 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (session->ticket != NULL || session->ticket_len > 0) {
2771 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002772 session->ticket = NULL;
2773 session->ticket_len = 0;
2774 }
2775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2777 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2778 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002779 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002781 p += ticket_len;
2782 session->ticket = ticket;
2783 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002784
Pengyu Lv9f926952022-11-17 15:22:33 +08002785 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002786 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002787 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2790 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002791 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2797 if (ret != 0) {
2798 MBEDTLS_SSL_DEBUG_RET(1,
2799 "ssl_tls13_parse_new_session_ticket_exts",
2800 ret);
2801 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002802 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002803
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002804 /* session has been updated, allow export */
2805 session->exported = 0;
2806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002808}
2809
Jerry Yua0446a02022-07-13 11:22:55 +08002810MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002811static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2812 unsigned char *ticket_nonce,
2813 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002814{
2815 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2816 mbedtls_ssl_session *session = ssl->session;
2817 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2818 psa_algorithm_t psa_hash_alg;
2819 int hash_length;
2820
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002821#if defined(MBEDTLS_HAVE_TIME)
2822 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002824#endif
2825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2827 if (ciphersuite_info == NULL) {
2828 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2829 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002830 }
2831
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2833 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2834 if (hash_length == -1 ||
2835 (size_t) hash_length > sizeof(session->resumption_key)) {
2836 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002837 }
2838
Jerry Yuf8a49942022-07-07 11:32:32 +00002839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2841 session->app_secrets.resumption_master_secret,
2842 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002843
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002844 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002845 *
2846 * HKDF-Expand-Label( resumption_master_secret,
2847 * "resumption", ticket_nonce, Hash.length )
2848 */
2849 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 psa_hash_alg,
2851 session->app_secrets.resumption_master_secret,
2852 hash_length,
2853 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2854 ticket_nonce,
2855 ticket_nonce_len,
2856 session->resumption_key,
2857 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (ret != 0) {
2860 MBEDTLS_SSL_DEBUG_RET(2,
2861 "Creating the ticket-resumed PSK failed",
2862 ret);
2863 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002864 }
2865
Jerry Yu0a430c82022-07-20 11:02:48 +08002866 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2869 session->resumption_key,
2870 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002871
Pengyu Lv9f926952022-11-17 15:22:33 +08002872 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002873 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002874 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002875 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002878}
2879
2880/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002881 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002882 */
Jerry Yua0446a02022-07-13 11:22:55 +08002883MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002884static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002885{
2886 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2887 unsigned char *buf;
2888 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002889 unsigned char *ticket_nonce;
2890 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002891
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002893
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2895 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2896 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2899 ssl, buf, buf + buf_len,
2900 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002901
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2903 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002906
Jerry Yuf8a49942022-07-07 11:32:32 +00002907cleanup:
2908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2910 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002911}
2912#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2913
Gilles Peskine449bd832023-01-11 14:50:10 +01002914int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002915{
Jerry Yu92c6b402021-08-27 16:59:09 +08002916 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002919 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002921 break;
2922
Jerry Yu92c6b402021-08-27 16:59:09 +08002923 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002925 break;
2926
2927 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002929 break;
2930
2931 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002933 break;
2934
Ronald Cron928cbd32022-10-04 16:14:26 +02002935#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002936 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002938 break;
2939
Jerry Yu687101b2021-09-14 16:03:56 +08002940 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002942 break;
2943
2944 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002946 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002947#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002948
2949 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002951 break;
2952
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002953 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2954 ret = ssl_tls13_write_end_of_early_data(ssl);
2955 break;
2956
Jerry Yu566c7812022-01-26 15:41:22 +08002957 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002959 break;
2960
Ronald Cron928cbd32022-10-04 16:14:26 +02002961#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002962 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002964 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002965#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002966
Jerry Yu687101b2021-09-14 16:03:56 +08002967 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002969 break;
2970
2971 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002973 break;
2974
2975 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002977 break;
2978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 /*
2980 * Injection of dummy-CCS's for middlebox compatibility
2981 */
Ronald Cron49ad6192021-11-24 16:25:31 +01002982#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002983 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2985 if (ret == 0) {
2986 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2987 }
Ronald Cron9f55f632022-02-02 16:02:47 +01002988 break;
2989
2990 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2992 if (ret == 0) {
2993 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2994 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002995 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00002996
Xiaokang Qian592021a2023-01-04 10:47:05 +00002997 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
2998 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2999 if (ret == 0) {
3000 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3001
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003002#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003003 MBEDTLS_SSL_DEBUG_MSG(
3004 1, ("Switch to early data keys for outbound traffic"));
3005 mbedtls_ssl_set_outbound_transform(
3006 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003007#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003008 }
3009 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003010#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3011
Jerry Yuf8a49942022-07-07 11:32:32 +00003012#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003013 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 ret = ssl_tls13_process_new_session_ticket(ssl);
3015 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003016 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003018 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3019 break;
3020#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3021
Jerry Yu92c6b402021-08-27 16:59:09 +08003022 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3024 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003025 }
3026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003028}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003029
Jerry Yufb4b6472022-01-27 15:03:26 +08003030#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */