blob: bc8b161282e1084dae4de21748b37c6995dff85f [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
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08006 */
7
8#include "common.h"
9
Jerry Yucc43c6b2022-01-28 10:24:45 +080010#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080011
Jerry Yubc20bdd2021-08-24 15:59:48 +080012#include <string.h>
13
Jerry Yu56fc07f2021-09-01 17:48:49 +080014#include "mbedtls/debug.h"
15#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080016#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080017
Jerry Yubdc71882021-09-14 19:30:36 +080018#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010019#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080020#include "ssl_tls13_keys.h"
Jerry Yucbd082f2022-08-04 16:55:10 +080021#include "ssl_debug_helpers.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020022#include "md_psa.h"
Jerry Yubdc71882021-09-14 19:30:36 +080023
Valerio Settic9ae8622023-07-25 11:23:50 +020024#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Andrzej Kurek00644842023-05-30 05:45:00 -040025/* Define a local translating function to save code size by not using too many
26 * arguments in each translating place. */
27static int local_err_translation(psa_status_t status)
28{
29 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040030 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040031 psa_generic_status_to_mbedtls);
32}
33#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kureka6033ac2023-05-30 15:16:34 -040034#endif
35
Jerry Yubc20bdd2021-08-24 15:59:48 +080036/* Write extensions */
37
Jerry Yu92c6b402021-08-27 16:59:09 +080038/*
39 * ssl_tls13_write_supported_versions_ext():
40 *
41 * struct {
42 * ProtocolVersion versions<2..254>;
43 * } SupportedVersions;
44 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020045MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010046static int ssl_tls13_write_supported_versions_ext(mbedtls_ssl_context *ssl,
47 unsigned char *buf,
48 unsigned char *end,
49 size_t *out_len)
Jerry Yu92c6b402021-08-27 16:59:09 +080050{
51 unsigned char *p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +010052 unsigned char versions_len = (ssl->handshake->min_tls_version <=
53 MBEDTLS_SSL_VERSION_TLS1_2) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080054
Xiaofei Baid25fab62021-12-02 06:36:27 +000055 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080056
Gilles Peskine449bd832023-01-11 14:50:10 +010057 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding supported versions extension"));
Jerry Yu92c6b402021-08-27 16:59:09 +080058
Jerry Yu388bd0d2021-09-15 18:41:02 +080059 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080060 * - extension_type (2 bytes)
61 * - extension_data_length (2 bytes)
62 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020063 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080064 */
Gilles Peskine449bd832023-01-11 14:50:10 +010065 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 5 + versions_len);
Ronald Crondbe87f02022-02-10 14:35:27 +010066
Gilles Peskine449bd832023-01-11 14:50:10 +010067 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0);
68 MBEDTLS_PUT_UINT16_BE(versions_len + 1, p, 2);
Jerry Yueecfbf02021-08-30 18:32:07 +080069 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080070
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080071 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010072 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080073
Jerry Yu0c63af62021-09-02 12:59:12 +080074 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080075 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010076 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080077 */
Gilles Peskine449bd832023-01-11 14:50:10 +010078 mbedtls_ssl_write_version(p, MBEDTLS_SSL_TRANSPORT_STREAM,
79 MBEDTLS_SSL_VERSION_TLS1_3);
80 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:4]"));
Jerry Yu92c6b402021-08-27 16:59:09 +080081
Jerry Yu92c6b402021-08-27 16:59:09 +080082
Gilles Peskine449bd832023-01-11 14:50:10 +010083 if (ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
84 mbedtls_ssl_write_version(p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
85 MBEDTLS_SSL_VERSION_TLS1_2);
86 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:3]"));
Ronald Crondbe87f02022-02-10 14:35:27 +010087 }
88
89 *out_len = 5 + versions_len;
Jerry Yu4b8f2f72022-10-31 13:31:22 +080090
Jerry Yuc4bf5d62022-10-29 09:08:47 +080091 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +010092 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yu4b8f2f72022-10-31 13:31:22 +080093
Gilles Peskine449bd832023-01-11 14:50:10 +010094 return 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080095}
Jerry Yubc20bdd2021-08-24 15:59:48 +080096
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020097MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010098static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
99 const unsigned char *buf,
100 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800101{
Jerry Yue1b9c292021-09-10 10:08:31 +0800102 ((void) ssl);
103
Gilles Peskine449bd832023-01-11 14:50:10 +0100104 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
105 if (mbedtls_ssl_read_version(buf, ssl->conf->transport) !=
106 MBEDTLS_SSL_VERSION_TLS1_3) {
107 MBEDTLS_SSL_DEBUG_MSG(1, ("unexpected version"));
Jerry Yu4a173382021-10-11 21:45:31 +0800108
Gilles Peskine449bd832023-01-11 14:50:10 +0100109 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
110 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
111 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +0800112 }
113
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 if (&buf[2] != end) {
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000115 MBEDTLS_SSL_DEBUG_MSG(
116 1, ("supported_versions ext data length incorrect"));
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 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
Valerio Settic9ae8622023-07-25 11:23:50 +0200183#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200184 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200185 mbedtls_ssl_tls13_named_group_is_ffdh(group_id)) {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100186 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
187 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
188
189 /* Destroy generated private key. */
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200190 status = psa_destroy_key(ssl->handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500192 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 MBEDTLS_SSL_DEBUG_RET(1, "psa_destroy_key", ret);
194 return ret;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100195 }
196
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200197 ssl->handshake->xxdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 return 0;
199 } else
Valerio Settic9ae8622023-07-25 11:23:50 +0200200#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +0100201 if (0 /* other KEMs? */) {
XiaokangQian647719a2021-12-07 09:16:29 +0000202 /* Do something */
203 }
204
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQian647719a2021-12-07 09:16:29 +0000206}
207
208/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800209 * Functions for writing key_share extension.
210 */
Ronald Cron766c0cd2022-10-18 12:17:11 +0200211#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200212MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100213static int ssl_tls13_get_default_group_id(mbedtls_ssl_context *ssl,
214 uint16_t *group_id)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800215{
216 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
217
Jerry Yu56fc07f2021-09-01 17:48:49 +0800218
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200219#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100220 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Jerry Yu388bd0d2021-09-15 18:41:02 +0800221 /* Pick first available ECDHE group compatible with TLS 1.3 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100222 if (group_list == NULL) {
223 return MBEDTLS_ERR_SSL_BAD_CONFIG;
224 }
Jerry Yu388bd0d2021-09-15 18:41:02 +0800225
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 for (; *group_list != 0; group_list++) {
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200227#if defined(PSA_WANT_ALG_ECDH)
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000228 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
229 *group_list, NULL, NULL) == PSA_SUCCESS) &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
Brett Warren14efd332021-10-06 09:32:11 +0100231 *group_id = *group_list;
Gilles Peskine449bd832023-01-11 14:50:10 +0100232 return 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800233 }
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200234#endif
235#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekield5f79e72023-06-29 09:08:43 +0200236 if (mbedtls_ssl_tls13_named_group_is_ffdh(*group_list)) {
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200237 *group_id = *group_list;
238 return 0;
239 }
240#endif
Jerry Yu56fc07f2021-09-01 17:48:49 +0800241 }
242#else
243 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800244 ((void) group_id);
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200245#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800248}
249
250/*
251 * ssl_tls13_write_key_share_ext
252 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800253 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800254 *
255 * struct {
256 * NamedGroup group;
257 * opaque key_exchange<1..2^16-1>;
258 * } KeyShareEntry;
259 * struct {
260 * KeyShareEntry client_shares<0..2^16-1>;
261 * } KeyShareClientHello;
262 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200263MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100264static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
265 unsigned char *buf,
266 unsigned char *end,
267 size_t *out_len)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800268{
269 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000270 unsigned char *client_shares; /* Start of client_shares */
271 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800272 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800273 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
274
Xiaofei Baid25fab62021-12-02 06:36:27 +0000275 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800276
Jerry Yub60e3cf2021-09-08 16:41:02 +0800277 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800278 * - extension_type (2 bytes)
279 * - extension_data_length (2 bytes)
280 * - client_shares_length (2 bytes)
281 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100282 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800283 p += 6;
284
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello: adding key share extension"));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800286
287 /* HRR could already have requested something else. */
288 group_id = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (!mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) &&
Przemek Stekield5f79e72023-06-29 09:08:43 +0200290 !mbedtls_ssl_tls13_named_group_is_ffdh(group_id)) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 MBEDTLS_SSL_PROC_CHK(ssl_tls13_get_default_group_id(ssl,
292 &group_id));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800293 }
294
295 /*
296 * Dispatch to type-specific key generation function.
297 *
298 * So far, we're only supporting ECDHE. With the introduction
299 * of PQC KEMs, we'll want to have multiple branches, one per
300 * type of KEM, and dispatch to the corresponding crypto. And
301 * only one key share entry is allowed.
302 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000303 client_shares = p;
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200304#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
305 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200306 mbedtls_ssl_tls13_named_group_is_ffdh(group_id)) {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800307 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000308 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800309 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100310 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800311
312 /* Check there is space for header of KeyShareEntry
313 * - group (2 bytes)
314 * - key_exchange_length (2 bytes)
315 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800317 p += 4;
Przemek Stekiel408569f2023-07-06 11:26:44 +0200318 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 ssl, group_id, p, end, &key_exchange_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800320 p += key_exchange_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 if (ret != 0) {
322 return ret;
323 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800324
325 /* Write group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 MBEDTLS_PUT_UINT16_BE(group_id, group, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800327 /* Write key_exchange_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 MBEDTLS_PUT_UINT16_BE(key_exchange_len, group, 2);
329 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200330#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 if (0 /* other KEMs? */) {
Jerry Yu56fc07f2021-09-01 17:48:49 +0800332 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 } else {
334 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800335 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800336
Jerry Yub60e3cf2021-09-08 16:41:02 +0800337 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000338 client_shares_len = p - client_shares;
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 if (client_shares_len == 0) {
340 MBEDTLS_SSL_DEBUG_MSG(1, ("No key share defined."));
341 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu7c522d42021-09-08 17:55:09 +0800342 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800343 /* Write extension_type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800345 /* Write extension_data_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 MBEDTLS_PUT_UINT16_BE(client_shares_len + 2, buf, 2);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800347 /* Write client_shares_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 MBEDTLS_PUT_UINT16_BE(client_shares_len, buf, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800349
350 /* Update offered_group_id field */
351 ssl->handshake->offered_group_id = group_id;
352
353 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000354 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800355
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000356 MBEDTLS_SSL_DEBUG_BUF(
357 3, "client hello, key_share extension", buf, *out_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800358
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800360
361cleanup:
362
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800364}
Ronald Cron766c0cd2022-10-18 12:17:11 +0200365#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +0800366
XiaokangQiand59be772022-01-24 10:12:51 +0000367/*
368 * ssl_tls13_parse_hrr_key_share_ext()
369 * Parse key_share extension in Hello Retry Request
370 *
371 * struct {
372 * NamedGroup selected_group;
373 * } KeyShareHelloRetryRequest;
374 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200375MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100376static int ssl_tls13_parse_hrr_key_share_ext(mbedtls_ssl_context *ssl,
377 const unsigned char *buf,
378 const unsigned char *end)
XiaokangQianb851da82022-01-14 04:03:11 +0000379{
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200380#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQianb851da82022-01-14 04:03:11 +0000381 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000382 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000383 int found = 0;
384
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
386 if (group_list == NULL) {
387 return MBEDTLS_ERR_SSL_BAD_CONFIG;
388 }
XiaokangQianb851da82022-01-14 04:03:11 +0000389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 MBEDTLS_SSL_DEBUG_BUF(3, "key_share extension", p, end - buf);
XiaokangQianb851da82022-01-14 04:03:11 +0000391
392 /* Read selected_group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100393 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
394 selected_group = MBEDTLS_GET_UINT16_BE(p, 0);
395 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_group ( %d )", selected_group));
XiaokangQianb851da82022-01-14 04:03:11 +0000396
397 /* Upon receipt of this extension in a HelloRetryRequest, the client
398 * MUST first verify that the selected_group field corresponds to a
399 * group which was provided in the "supported_groups" extension in the
400 * original ClientHello.
401 * The supported_group was based on the info in ssl->conf->group_list.
402 *
403 * If the server provided a key share that was not sent in the ClientHello
404 * then the client MUST abort the handshake with an "illegal_parameter" alert.
405 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 for (; *group_list != 0; group_list++) {
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200407#if defined(PSA_WANT_ALG_ECDH)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200408 if (mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
409 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
410 *group_list, NULL, NULL) == PSA_ERROR_NOT_SUPPORTED) ||
411 *group_list != selected_group) {
412 found = 1;
413 break;
414 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 }
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200416#endif /* PSA_WANT_ALG_ECDH */
417#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekield5f79e72023-06-29 09:08:43 +0200418 if (mbedtls_ssl_tls13_named_group_is_ffdh(*group_list)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200419 found = 1;
420 break;
421 }
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200422#endif /* PSA_WANT_ALG_FFDH */
XiaokangQianb851da82022-01-14 04:03:11 +0000423 }
424
425 /* Client MUST verify that the selected_group field does not
426 * correspond to a group which was provided in the "key_share"
427 * extension in the original ClientHello. If the server sent an
428 * HRR message with a key share already provided in the
429 * ClientHello then the client MUST abort the handshake with
430 * an "illegal_parameter" alert.
431 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 if (found == 0 || selected_group == ssl->handshake->offered_group_id) {
433 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid key share in HRR"));
XiaokangQianb851da82022-01-14 04:03:11 +0000434 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
436 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
437 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQianb851da82022-01-14 04:03:11 +0000438 }
439
440 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000441 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000442
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 return 0;
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200444#else /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400445 (void) ssl;
446 (void) buf;
447 (void) end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100448 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200449#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQianb851da82022-01-14 04:03:11 +0000450}
451
Jerry Yue1b9c292021-09-10 10:08:31 +0800452/*
Jerry Yub85277e2021-10-13 13:36:05 +0800453 * ssl_tls13_parse_key_share_ext()
454 * Parse key_share extension in Server Hello
455 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800456 * struct {
457 * KeyShareEntry server_share;
458 * } KeyShareServerHello;
459 * struct {
460 * NamedGroup group;
461 * opaque key_exchange<1..2^16-1>;
462 * } KeyShareEntry;
463 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200464MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100465static int ssl_tls13_parse_key_share_ext(mbedtls_ssl_context *ssl,
466 const unsigned char *buf,
467 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800468{
Jerry Yub85277e2021-10-13 13:36:05 +0800469 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800470 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800471 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800472
Jerry Yu4a173382021-10-11 21:45:31 +0800473 /* ...
474 * NamedGroup group; (2 bytes)
475 * ...
476 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
478 group = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +0800479 p += 2;
480
Jerry Yu4a173382021-10-11 21:45:31 +0800481 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800482 offered_group = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 if (offered_group != group) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000484 MBEDTLS_SSL_DEBUG_MSG(
485 1, ("Invalid server key share, our group %u, their group %u",
486 (unsigned) offered_group, (unsigned) group));
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
488 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
489 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yue1b9c292021-09-10 10:08:31 +0800490 }
491
Valerio Settic9ae8622023-07-25 11:23:50 +0200492#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200493 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200494 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200495 MBEDTLS_SSL_DEBUG_MSG(2,
496 ("DHE group name: %s", mbedtls_ssl_named_group_to_str(group)));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200497 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(ssl, p, end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 if (ret != 0) {
499 return ret;
500 }
501 } else
Valerio Settic9ae8622023-07-25 11:23:50 +0200502#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 if (0 /* other KEMs? */) {
Jerry Yue1b9c292021-09-10 10:08:31 +0800504 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 } else {
506 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yue1b9c292021-09-10 10:08:31 +0800507 }
Jerry Yue1b9c292021-09-10 10:08:31 +0800508
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +0800510}
511
XiaokangQiand59be772022-01-24 10:12:51 +0000512/*
513 * ssl_tls13_parse_cookie_ext()
514 * Parse cookie extension in Hello Retry Request
515 *
516 * struct {
517 * opaque cookie<1..2^16-1>;
518 * } Cookie;
519 *
520 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
521 * extension to the client (this is an exception to the usual rule that
522 * the only extensions that may be sent are those that appear in the
523 * ClientHello). When sending the new ClientHello, the client MUST copy
524 * the contents of the extension received in the HelloRetryRequest into
525 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
526 * cookies in their initial ClientHello in subsequent connections.
527 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200528MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100529static int ssl_tls13_parse_cookie_ext(mbedtls_ssl_context *ssl,
530 const unsigned char *buf,
531 const unsigned char *end)
XiaokangQian43550bd2022-01-21 04:32:58 +0000532{
XiaokangQian25c9c902022-02-08 10:49:53 +0000533 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000534 const unsigned char *p = buf;
535 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
536
537 /* Retrieve length field of cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
539 cookie_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian43550bd2022-01-21 04:32:58 +0000540 p += 2;
541
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cookie_len);
543 MBEDTLS_SSL_DEBUG_BUF(3, "cookie extension", p, cookie_len);
XiaokangQian43550bd2022-01-21 04:32:58 +0000544
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 mbedtls_free(handshake->cookie);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800546 handshake->cookie_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 handshake->cookie = mbedtls_calloc(1, cookie_len);
548 if (handshake->cookie == NULL) {
549 MBEDTLS_SSL_DEBUG_MSG(1,
550 ("alloc failed ( %ud bytes )",
551 cookie_len));
552 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
XiaokangQian43550bd2022-01-21 04:32:58 +0000553 }
554
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 memcpy(handshake->cookie, p, cookie_len);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800556 handshake->cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000557
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return 0;
XiaokangQian43550bd2022-01-21 04:32:58 +0000559}
XiaokangQian43550bd2022-01-21 04:32:58 +0000560
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200561MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100562static int ssl_tls13_write_cookie_ext(mbedtls_ssl_context *ssl,
563 unsigned char *buf,
564 unsigned char *end,
565 size_t *out_len)
XiaokangQian0b64eed2022-01-27 10:36:51 +0000566{
567 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000568 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000569 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000570
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 if (handshake->cookie == NULL) {
572 MBEDTLS_SSL_DEBUG_MSG(3, ("no cookie to send; skip extension"));
573 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000574 }
575
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, cookie",
577 handshake->cookie,
578 handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000579
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 MBEDTLS_SSL_CHK_BUF_PTR(p, end, handshake->cookie_len + 6);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000581
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding cookie extension"));
XiaokangQian0b64eed2022-01-27 10:36:51 +0000583
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_COOKIE, p, 0);
585 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len + 2, p, 2);
586 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len, p, 4);
XiaokangQian233397e2022-02-07 08:32:16 +0000587 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000588
589 /* Cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 memcpy(p, handshake->cookie, handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000591
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800592 *out_len = handshake->cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000593
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_COOKIE);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800595
Gilles Peskine449bd832023-01-11 14:50:10 +0100596 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000597}
598
Ronald Cron41a443a2022-10-04 16:38:25 +0200599#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000600/*
601 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
602 *
603 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
604 *
605 * struct {
606 * PskKeyExchangeMode ke_modes<1..255>;
607 * } PskKeyExchangeModes;
608 */
XiaokangQian86981952022-07-19 09:51:50 +0000609MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100610static int ssl_tls13_write_psk_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
611 unsigned char *buf,
612 unsigned char *end,
613 size_t *out_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000614{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000615 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000616 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000617
Gilles Peskine449bd832023-01-11 14:50:10 +0100618 ((void) ke_modes_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000619 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000620
XiaokangQianeb69aee2022-07-05 08:21:43 +0000621 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000622 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000623 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 if (!mbedtls_ssl_conf_tls13_some_psk_enabled(ssl)) {
625 MBEDTLS_SSL_DEBUG_MSG(3, ("skip psk_key_exchange_modes extension"));
626 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000627 }
628
629 /* Require 7 bytes of data, otherwise fail,
630 * even if extension might be shorter.
631 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100632 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000633 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100634 3, ("client hello, adding psk_key_exchange_modes extension"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000635
Gilles Peskine449bd832023-01-11 14:50:10 +0100636 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000637
XiaokangQian008d2bf2022-07-14 07:54:01 +0000638 /* Skip extension length (2 bytes) and
639 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000640 */
641 p += 5;
642
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 if (mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl)) {
XiaokangQianeb69aee2022-07-05 08:21:43 +0000644 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000645 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000646
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding PSK-ECDHE key exchange mode"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000648 }
649
Gilles Peskine449bd832023-01-11 14:50:10 +0100650 if (mbedtls_ssl_conf_tls13_psk_enabled(ssl)) {
Ronald Crona709a0f2022-09-27 16:46:11 +0200651 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
652 ke_modes_len++;
653
Gilles Peskine449bd832023-01-11 14:50:10 +0100654 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding pure PSK key exchange mode"));
Ronald Crona709a0f2022-09-27 16:46:11 +0200655 }
656
XiaokangQian008d2bf2022-07-14 07:54:01 +0000657 /* Now write the extension and ke_modes length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 MBEDTLS_PUT_UINT16_BE(ke_modes_len + 1, buf, 2);
XiaokangQian008d2bf2022-07-14 07:54:01 +0000659 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000660
661 *out_len = p - buf;
Jerry Yu0c354a22022-08-29 15:25:36 +0800662
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800663 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 ssl, MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800665
Gilles Peskine449bd832023-01-11 14:50:10 +0100666 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000667}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800668
Gilles Peskine449bd832023-01-11 14:50:10 +0100669static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg(int ciphersuite)
Jerry Yuf7c12592022-09-28 22:09:38 +0800670{
Jerry Yu21f90952022-10-08 10:30:53 +0800671 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800673
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 if (ciphersuite_info != NULL) {
Dave Rodgman2eab4622023-10-05 13:30:37 +0100675 return mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800677
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return PSA_ALG_NONE;
Jerry Yuf7c12592022-09-28 22:09:38 +0800679}
680
Jerry Yuf75364b2022-09-30 10:30:31 +0800681#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100682static int ssl_tls13_has_configured_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qianb781a232022-11-01 07:39:46 +0000683{
684 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return ssl->handshake->resume &&
Pengyu Lv93566782022-12-07 12:10:05 +0800686 session != NULL && session->ticket != NULL &&
Pengyu Lv9b84ea72023-01-16 14:08:23 +0800687 mbedtls_ssl_conf_tls13_check_kex_modes(
688 ssl, mbedtls_ssl_session_get_ticket_flags(
689 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL));
Xiaokang Qianb781a232022-11-01 07:39:46 +0000690}
691
Xiaokang Qian01323a42022-11-03 02:27:35 +0000692#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100693static int ssl_tls13_early_data_has_valid_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qian01323a42022-11-03 02:27:35 +0000694{
695 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return ssl->handshake->resume &&
697 session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Jerry Yuc2b1bc42023-11-22 10:08:13 +0800698 mbedtls_ssl_session_ticket_allow_early_data(session) &&
699 mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000700}
701#endif
702
Xiaokang Qianb781a232022-11-01 07:39:46 +0000703MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100704static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
705 psa_algorithm_t *hash_alg,
706 const unsigned char **identity,
707 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800708{
709 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800710
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 if (!ssl_tls13_has_configured_ticket(ssl)) {
712 return -1;
713 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800714
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800716 *identity = session->ticket;
717 *identity_len = session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800719}
720
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800721MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100722static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
723 psa_algorithm_t *hash_alg,
724 const unsigned char **psk,
725 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800726{
727
728 mbedtls_ssl_session *session = ssl->session_negotiate;
729
Gilles Peskine449bd832023-01-11 14:50:10 +0100730 if (!ssl_tls13_has_configured_ticket(ssl)) {
731 return -1;
732 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800733
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800735 *psk = session->resumption_key;
736 *psk_len = session->resumption_key_len;
737
Gilles Peskine449bd832023-01-11 14:50:10 +0100738 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800739}
Jerry Yuf7c12592022-09-28 22:09:38 +0800740#endif /* MBEDTLS_SSL_SESSION_TICKETS */
741
742MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100743static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
744 psa_algorithm_t *hash_alg,
745 const unsigned char **identity,
746 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800747{
Jerry Yu8b41e892022-09-30 10:00:20 +0800748
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
750 return -1;
751 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800752
Jerry Yua99cbfa2022-10-08 11:17:14 +0800753 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800754 *identity = ssl->conf->psk_identity;
755 *identity_len = ssl->conf->psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100756 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800757}
758
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800759MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100760static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
761 psa_algorithm_t *hash_alg,
762 const unsigned char **psk,
763 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800764{
Jerry Yu8b41e892022-09-30 10:00:20 +0800765
Gilles Peskine449bd832023-01-11 14:50:10 +0100766 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
767 return -1;
768 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800769
Jerry Yua99cbfa2022-10-08 11:17:14 +0800770 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800771 *psk = ssl->conf->psk;
772 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800774}
775
Gilles Peskine449bd832023-01-11 14:50:10 +0100776static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800777{
778 int configured_psk_count = 0;
779#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 if (ssl_tls13_has_configured_ticket(ssl)) {
781 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800782 configured_psk_count++;
783 }
784#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
786 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800787 configured_psk_count++;
788 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800790}
791
Jerry Yuf7c12592022-09-28 22:09:38 +0800792MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100793static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
794 unsigned char *buf,
795 unsigned char *end,
796 const unsigned char *identity,
797 size_t identity_len,
798 uint32_t obfuscated_ticket_age,
799 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800800{
Jerry Yuf75364b2022-09-30 10:30:31 +0800801 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800802 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800803
804 /*
805 * - identity_len (2 bytes)
806 * - identity (psk_identity_len bytes)
807 * - obfuscated_ticket_age (4 bytes)
808 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800810
Gilles Peskine449bd832023-01-11 14:50:10 +0100811 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
812 memcpy(buf + 2, identity, identity_len);
813 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800814
Gilles Peskine449bd832023-01-11 14:50:10 +0100815 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800816
817 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800818
Gilles Peskine449bd832023-01-11 14:50:10 +0100819 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800820}
821
Jerry Yu8b41e892022-09-30 10:00:20 +0800822MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100823static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
824 unsigned char *buf,
825 unsigned char *end,
826 int psk_type,
827 psa_algorithm_t hash_alg,
828 const unsigned char *psk,
829 size_t psk_len,
830 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800831{
832 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800833 unsigned char binder_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100834 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800835 size_t transcript_len = 0;
836
837 *out_len = 0;
838
Gilles Peskine449bd832023-01-11 14:50:10 +0100839 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800840
841 /*
842 * - binder_len (1 bytes)
843 * - binder (binder_len bytes)
844 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800846
Jerry Yua99cbfa2022-10-08 11:17:14 +0800847 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800848
849 /* Get current state of handshake transcript. */
850 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200851 ssl, mbedtls_md_type_from_psa_alg(hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100852 transcript, sizeof(transcript), &transcript_len);
853 if (ret != 0) {
854 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800855 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100856
857 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
858 psk, psk_len, psk_type,
859 transcript, buf + 1);
860 if (ret != 0) {
861 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
862 return ret;
863 }
864 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800865
866 *out_len = 1 + binder_len;
867
Gilles Peskine449bd832023-01-11 14:50:10 +0100868 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800869}
870
871/*
872 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
873 *
874 * struct {
875 * opaque identity<1..2^16-1>;
876 * uint32 obfuscated_ticket_age;
877 * } PskIdentity;
878 *
879 * opaque PskBinderEntry<32..255>;
880 *
881 * struct {
882 * PskIdentity identities<7..2^16-1>;
883 * PskBinderEntry binders<33..2^16-1>;
884 * } OfferedPsks;
885 *
886 * struct {
887 * select (Handshake.msg_type) {
888 * case client_hello: OfferedPsks;
889 * ...
890 * };
891 * } PreSharedKeyExtension;
892 *
893 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000894int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100895 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
896 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000897{
Jerry Yuf7c12592022-09-28 22:09:38 +0800898 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800899 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800900 unsigned char *p = buf;
Xiaokang Qian854db282022-12-19 07:31:27 +0000901 psa_algorithm_t hash_alg = PSA_ALG_NONE;
Jerry Yuf75364b2022-09-30 10:30:31 +0800902 const unsigned char *identity;
903 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800904 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800905 size_t output_len;
Xiaokang Qian7179f812023-02-03 03:38:44 +0000906
Jerry Yuf7c12592022-09-28 22:09:38 +0800907 *out_len = 0;
908 *binders_len = 0;
909
910 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
912 if (configured_psk_count == 0) {
913 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
914 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800915 }
916
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
918 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800919
Jerry Yuf7c12592022-09-28 22:09:38 +0800920 /* Check if we have space to write the extension, binders included.
921 * - extension_type (2 bytes)
922 * - extension_data_len (2 bytes)
923 * - identities_len (2 bytes)
924 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800926 p += 6;
927
Jerry Yuf75364b2022-09-30 10:30:31 +0800928#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 if (ssl_tls13_ticket_get_identity(
930 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800931#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucebffc32022-12-15 18:00:05 +0800932 mbedtls_ms_time_t now = mbedtls_ms_time();
Jerry Yuf75364b2022-09-30 10:30:31 +0800933 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yucf913512023-11-14 11:06:52 +0800934 /* The ticket age has been checked to be smaller than the
Jerry Yu46c79262023-11-10 13:58:16 +0800935 * `ticket_lifetime` in ssl_prepare_client_hello() which is smaller than
936 * 7 days (enforced in ssl_tls13_parse_new_session_ticket()) . Thus the
937 * cast to `uint32_t` of the ticket age is safe. */
Jerry Yu6916e702022-10-10 21:33:51 +0800938 uint32_t obfuscated_ticket_age =
Jerry Yu342a5552023-11-10 14:23:39 +0800939 (uint32_t) (now - session->ticket_reception_time);
Jerry Yuf75364b2022-09-30 10:30:31 +0800940 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800941
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 ret = ssl_tls13_write_identity(ssl, p, end,
943 identity, identity_len,
944 obfuscated_ticket_age,
945 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800946#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100947 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
948 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800949#endif /* MBEDTLS_HAVE_TIME */
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 if (ret != 0) {
951 return ret;
952 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800953
Jerry Yuf75364b2022-09-30 10:30:31 +0800954 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +0800956 }
957#endif /* MBEDTLS_SSL_SESSION_TICKETS */
958
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 if (ssl_tls13_psk_get_identity(
960 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800961
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
963 &output_len);
964 if (ret != 0) {
965 return ret;
966 }
Jerry Yuf75364b2022-09-30 10:30:31 +0800967
Jerry Yuf7c12592022-09-28 22:09:38 +0800968 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +0800970 }
971
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 MBEDTLS_SSL_DEBUG_MSG(3,
973 ("client hello, adding pre_shared_key extension, "
974 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +0800975
976 /* Take into account the two bytes for the length of the binders. */
977 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800978 /* Check if there is enough space for binders */
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800980
Jerry Yuf7c12592022-09-28 22:09:38 +0800981 /*
982 * - extension_type (2 bytes)
983 * - extension_data_len (2 bytes)
984 * - identities_len (2 bytes)
985 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
987 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
988 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +0800989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800991 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800992
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +0800994
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000996}
997
XiaokangQian86981952022-07-19 09:51:50 +0000998int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001000{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001001 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1002 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001003 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1004 const unsigned char *psk;
1005 size_t psk_len;
1006 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001007
1008 /* Check if we have space to write binders_len.
1009 * - binders_len (2 bytes)
1010 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001012 p += 2;
1013
Jerry Yu6183cc72022-09-30 11:08:57 +08001014#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 ret = ssl_tls13_write_binder(ssl, p, end,
1018 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1019 hash_alg, psk, psk_len,
1020 &output_len);
1021 if (ret != 0) {
1022 return ret;
1023 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001024 p += output_len;
1025 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001026#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001029
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 ret = ssl_tls13_write_binder(ssl, p, end,
1031 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1032 hash_alg, psk, psk_len,
1033 &output_len);
1034 if (ret != 0) {
1035 return ret;
1036 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001037 p += output_len;
1038 }
1039
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001041
1042 /*
1043 * - binders_len (2 bytes)
1044 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001046
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001048
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001049 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001050 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001051
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001053}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001054
1055/*
1056 * struct {
1057 * opaque identity<1..2^16-1>;
1058 * uint32 obfuscated_ticket_age;
1059 * } PskIdentity;
1060 *
1061 * opaque PskBinderEntry<32..255>;
1062 *
1063 * struct {
1064 *
1065 * select (Handshake.msg_type) {
1066 * ...
1067 * case server_hello: uint16 selected_identity;
1068 * };
1069 *
1070 * } PreSharedKeyExtension;
1071 *
1072 */
1073MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001074static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1075 const unsigned char *buf,
1076 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001077{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001078 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001079 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001080 const unsigned char *psk;
1081 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001082 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1085 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001086 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001087
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001089
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1091 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001092
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1094 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1095 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001096 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001097
Jerry Yu4a698342022-09-30 12:22:01 +08001098#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1100 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1101 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001102#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1104 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
1105 } else {
1106 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1107 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001108 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 if (ret != 0) {
1110 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001111 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001112
Dave Rodgman2eab4622023-10-05 13:30:37 +01001113 if (mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ssl->handshake->ciphersuite_info->mac)
Xiaokang Qianeb31cbc2023-02-07 02:08:56 +00001114 != hash_alg) {
1115 MBEDTLS_SSL_DEBUG_MSG(
1116 1, ("Invalid ciphersuite for external psk."));
1117
1118 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1119 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1120 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1121 }
1122
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1124 if (ret != 0) {
1125 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1126 return ret;
1127 }
1128
1129 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001130}
Ronald Cron41a443a2022-10-04 16:38:25 +02001131#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001132
Gilles Peskine449bd832023-01-11 14:50:10 +01001133int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1134 unsigned char *buf,
1135 unsigned char *end,
1136 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001137{
1138 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1139 unsigned char *p = buf;
1140 size_t ext_len;
1141
1142 *out_len = 0;
1143
1144 /* Write supported_versions extension
1145 *
1146 * Supported Versions Extension is mandatory with TLS 1.3.
1147 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1149 if (ret != 0) {
1150 return ret;
1151 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001152 p += ext_len;
1153
1154 /* Echo the cookie if the server provided one in its preceding
1155 * HelloRetryRequest message.
1156 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1158 if (ret != 0) {
1159 return ret;
1160 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001161 p += ext_len;
1162
Ronald Cron766c0cd2022-10-18 12:17:11 +02001163#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1165 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1166 if (ret != 0) {
1167 return ret;
1168 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001169 p += ext_len;
1170 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001171#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001172
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001173#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1175 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1176 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1177 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1178 if (ret != 0) {
1179 return ret;
1180 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001181 p += ext_len;
1182
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001183 /* Initializes the status to `rejected`. It will be updated to
1184 * `accepted` if the EncryptedExtension message contain an early data
1185 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001186 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001187 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 } else {
1189 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001190 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001191 }
1192#endif /* MBEDTLS_SSL_EARLY_DATA */
1193
Ronald Cron41a443a2022-10-04 16:38:25 +02001194#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001195 /* For PSK-based key exchange we need the pre_shared_key extension
1196 * and the psk_key_exchange_modes extension.
1197 *
1198 * The pre_shared_key extension MUST be the last extension in the
1199 * ClientHello. Servers MUST check that it is the last extension and
1200 * otherwise fail the handshake with an "illegal_parameter" alert.
1201 *
1202 * Add the psk_key_exchange_modes extension.
1203 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1205 if (ret != 0) {
1206 return ret;
1207 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001208 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001209#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001210
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001211 *out_len = p - buf;
1212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001214}
1215
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00001216int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl)
Xiaokang Qian126929f2023-01-03 10:29:41 +00001217{
Xiaokang Qian90746132023-01-06 05:54:59 +00001218 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001219
Xiaokang Qian126929f2023-01-03 10:29:41 +00001220#if defined(MBEDTLS_SSL_EARLY_DATA)
1221 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1222 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1223 const unsigned char *psk;
1224 size_t psk_len;
1225 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001226
Xiaokang Qian126929f2023-01-03 10:29:41 +00001227 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
Xiaokang Qian6be82902023-02-03 06:04:43 +00001228#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1229 mbedtls_ssl_handshake_set_state(
1230 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1231#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00001232 MBEDTLS_SSL_DEBUG_MSG(
1233 1, ("Set hs psk for early data when writing the first psk"));
1234
1235 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1236 if (ret != 0) {
1237 MBEDTLS_SSL_DEBUG_RET(
1238 1, "ssl_tls13_ticket_get_psk", ret);
1239 return ret;
1240 }
1241
1242 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1243 if (ret != 0) {
1244 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1245 return ret;
1246 }
1247
Xiaokang Qian64bc9bc2023-02-07 02:32:23 +00001248 /*
1249 * Early data are going to be encrypted using the ciphersuite
1250 * associated with the pre-shared key used for the handshake.
1251 * Note that if the server rejects early data, the handshake
1252 * based on the pre-shared key may complete successfully
1253 * with a selected ciphersuite different from the ciphersuite
1254 * associated with the pre-shared key. Only the hashes of the
1255 * two ciphersuites have to be the same. In that case, the
1256 * encrypted handshake data and application data are
1257 * encrypted using a different ciphersuite than the one used for
1258 * the rejected early data.
1259 */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001260 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1261 ssl->session_negotiate->ciphersuite);
1262 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001263
Tom Cosgrove5c8505f2023-03-07 11:39:52 +00001264 /* Enable psk and psk_ephemeral to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001265 ssl->handshake->key_exchange_mode =
1266 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1267
1268 /* Start the TLS 1.3 key schedule:
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001269 * Set the PSK and derive early secret.
Xiaokang Qian126929f2023-01-03 10:29:41 +00001270 */
1271 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1272 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001273 MBEDTLS_SSL_DEBUG_RET(
1274 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001275 return ret;
1276 }
1277
1278 /* Derive early data key material */
1279 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1280 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001281 MBEDTLS_SSL_DEBUG_RET(
1282 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001283 return ret;
1284 }
1285
Xiaokang Qian126929f2023-01-03 10:29:41 +00001286 }
1287#endif /* MBEDTLS_SSL_EARLY_DATA */
1288 return 0;
1289}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001290/*
Jerry Yu4a173382021-10-11 21:45:31 +08001291 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001292 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001293
Ronald Cronda41b382022-03-30 09:57:11 +02001294/**
1295 * \brief Detect if the ServerHello contains a supported_versions extension
1296 * or not.
1297 *
1298 * \param[in] ssl SSL context
1299 * \param[in] buf Buffer containing the ServerHello message
1300 * \param[in] end End of the buffer containing the ServerHello message
1301 *
1302 * \return 0 if the ServerHello does not contain a supported_versions extension
1303 * \return 1 if the ServerHello contains a supported_versions extension
1304 * \return A negative value if an error occurred while parsing the ServerHello.
1305 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001306MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001307static int ssl_tls13_is_supported_versions_ext_present(
1308 mbedtls_ssl_context *ssl,
1309 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001311{
1312 const unsigned char *p = buf;
1313 size_t legacy_session_id_echo_len;
Ronald Croneff56732023-04-03 17:36:31 +02001314 const unsigned char *supported_versions_data;
1315 const unsigned char *supported_versions_data_end;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001316
1317 /*
1318 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001319 * length:
1320 * - legacy_version 2 bytes
1321 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1322 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001323 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001325 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1326 legacy_session_id_echo_len = *p;
1327
1328 /*
1329 * Jump to the extensions, jumping over:
1330 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1331 * - cipher_suite 2 bytes
1332 * - legacy_compression_method 1 byte
1333 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1335 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001336
Ronald Cron47dce632023-02-08 17:38:29 +01001337 return mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1338 ssl, p, end,
Ronald Croneff56732023-04-03 17:36:31 +02001339 &supported_versions_data, &supported_versions_data_end);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001340}
1341
Jerry Yu7a186a02021-10-15 18:46:14 +08001342/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001343 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1344 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1345 * - 0 otherwise
1346 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001347MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001348static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1349 const unsigned char *buf,
1350 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001351{
1352 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1353 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001355 const unsigned char *last_eight_bytes_of_random;
1356 unsigned char last_byte_of_random;
1357
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001359 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1360
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 if (memcmp(last_eight_bytes_of_random,
1362 magic_downgrade_string,
1363 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001364 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 return last_byte_of_random == 0 ||
1366 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001367 }
1368
Gilles Peskine449bd832023-01-11 14:50:10 +01001369 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001370}
1371
1372/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001373 * - SSL_SERVER_HELLO or
1374 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001375 * to indicate which message is expected and to be parsed next.
1376 */
Ronald Cron828aff62022-05-31 12:04:31 +02001377#define SSL_SERVER_HELLO 0
1378#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001379MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001380static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1381 const unsigned char *buf,
1382 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001383{
Jerry Yue1b9c292021-09-10 10:08:31 +08001384
1385 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1386 *
Jerry Yu4a173382021-10-11 21:45:31 +08001387 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001388 * special value of the SHA-256 of "HelloRetryRequest".
1389 *
1390 * struct {
1391 * ProtocolVersion legacy_version = 0x0303;
1392 * Random random;
1393 * opaque legacy_session_id_echo<0..32>;
1394 * CipherSuite cipher_suite;
1395 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001396 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001397 * } ServerHello;
1398 *
1399 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001400 MBEDTLS_SSL_CHK_BUF_READ_PTR(
1401 buf, end, 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001402
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1404 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1405 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001406 }
1407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001409}
1410
Ronald Cron828aff62022-05-31 12:04:31 +02001411/*
Jerry Yu745bb612021-10-13 22:01:04 +08001412 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001413 * - SSL_SERVER_HELLO or
1414 * - SSL_SERVER_HELLO_HRR or
1415 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001416 */
Ronald Cron828aff62022-05-31 12:04:31 +02001417#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001418MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001419static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1420 const unsigned char *buf,
1421 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001422{
Jerry Yu4a173382021-10-11 21:45:31 +08001423 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001424 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1427 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001428
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001430 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001432
1433 /* If the server is negotiating TLS 1.2 or below and:
1434 * . we did not propose TLS 1.2 or
1435 * . the server responded it is TLS 1.3 capable but negotiating a lower
1436 * version of the protocol and thus we are under downgrade attack
1437 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001438 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001439 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1440 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1441 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1442 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001443 }
1444
Ronald Cronb828c7d2023-04-03 16:37:22 +02001445 /*
1446 * Version 1.2 of the protocol has been negotiated, set the
1447 * ssl->keep_current_message flag for the ServerHello to be kept and
1448 * parsed as a TLS 1.2 ServerHello. We also change ssl->tls_version to
1449 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1450 * will dispatch to the TLS 1.2 state machine.
1451 */
Ronald Cron9f0fba32022-02-10 16:45:15 +01001452 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001453 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001454 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1455 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1456 buf, (size_t) (end - buf)));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1459 ret = ssl_tls13_reset_key_share(ssl);
1460 if (ret != 0) {
1461 return ret;
1462 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001463 }
1464
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001466 }
1467
Jerry Yua66fece2022-07-13 14:30:29 +08001468#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1469 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1470 ssl->session_negotiate->tls_version = ssl->tls_version;
1471#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1472
Jerry Yu50e00e32022-10-31 14:45:01 +08001473 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001474
Gilles Peskine449bd832023-01-11 14:50:10 +01001475 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1476 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001477 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001478 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001479 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001480 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001481 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001482 /* If a client receives a second HelloRetryRequest in the same
1483 * connection (i.e., where the ClientHello was itself in response
1484 * to a HelloRetryRequest), it MUST abort the handshake with an
1485 * "unexpected_message" alert.
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 */
1487 if (handshake->hello_retry_request_count > 0) {
1488 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001489 MBEDTLS_SSL_PEND_FATAL_ALERT(
1490 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1491 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001493 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001494 /*
1495 * Clients must abort the handshake with an "illegal_parameter"
1496 * alert if the HelloRetryRequest would not result in any change
1497 * in the ClientHello.
1498 * In a PSK only key exchange that what we expect.
1499 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1501 MBEDTLS_SSL_DEBUG_MSG(1,
1502 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001503 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1505 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1506 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001507 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001508
Ronald Cron5afb9042022-05-31 12:11:39 +02001509 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001510
Jerry Yu745bb612021-10-13 22:01:04 +08001511 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001512 }
1513
1514cleanup:
1515
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001517}
1518
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001519MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001520static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1521 const unsigned char **buf,
1522 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001523{
1524 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001525 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001526
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1528 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001529
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001531
1532 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1534 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1535 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1536 ssl->session_negotiate->id,
1537 ssl->session_negotiate->id_len);
1538 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1539 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1542 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001543
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001545 }
1546
Jerry Yu4a173382021-10-11 21:45:31 +08001547 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001548 *buf = p;
1549
Gilles Peskine449bd832023-01-11 14:50:10 +01001550 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1551 ssl->session_negotiate->id_len);
1552 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001553}
1554
Jerry Yue1b9c292021-09-10 10:08:31 +08001555/* Parse ServerHello message and configure context
1556 *
1557 * struct {
1558 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1559 * Random random;
1560 * opaque legacy_session_id_echo<0..32>;
1561 * CipherSuite cipher_suite;
1562 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001563 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001564 * } ServerHello;
1565 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001566MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001567static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1568 const unsigned char *buf,
1569 const unsigned char *end,
1570 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001571{
Jerry Yub85277e2021-10-13 13:36:05 +08001572 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001573 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001574 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001575 size_t extensions_len;
1576 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001577 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001578 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001579 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001580 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001581 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001583
1584 /*
1585 * Check there is space for minimal fields
1586 *
1587 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001588 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001589 * - legacy_session_id_echo ( 1 byte ), minimum size
1590 * - cipher_suite ( 2 bytes)
1591 * - legacy_compression_method ( 1 byte )
1592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001594
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1596 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001597
Jerry Yu4a173382021-10-11 21:45:31 +08001598 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001599 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001600 * ...
1601 * with ProtocolVersion defined as:
1602 * uint16 ProtocolVersion;
1603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1605 MBEDTLS_SSL_VERSION_TLS1_2) {
1606 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1607 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1608 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001609 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1610 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001611 }
1612 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001613
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001614 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001615 * Random random;
1616 * ...
1617 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001618 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001619 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 if (!is_hrr) {
1621 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1622 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1623 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1624 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001625 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001626 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001627
Jerry Yu4a173382021-10-11 21:45:31 +08001628 /* ...
1629 * opaque legacy_session_id_echo<0..32>;
1630 * ...
1631 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001633 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001634 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001635 }
1636
Jerry Yu4a173382021-10-11 21:45:31 +08001637 /* ...
1638 * CipherSuite cipher_suite;
1639 * ...
1640 * with CipherSuite defined as:
1641 * uint8 CipherSuite[2];
1642 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1644 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001645 p += 2;
1646
Jerry Yu4a173382021-10-11 21:45:31 +08001647
Gilles Peskine449bd832023-01-11 14:50:10 +01001648 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001649 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001650 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001651 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001652 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1653 ssl->tls_version,
1654 ssl->tls_version) != 0) ||
1655 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001656 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001657 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001658 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001659 * If we received an HRR before and that the proposed selected
1660 * ciphersuite in this server hello is not the same as the one
1661 * proposed in the HRR, we abort the handshake and send an
1662 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001663 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1665 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001666 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001667 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001668
Gilles Peskine449bd832023-01-11 14:50:10 +01001669 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1670 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1671 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001672 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001673 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001674
Jerry Yu4a173382021-10-11 21:45:31 +08001675 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001677
XiaokangQian355e09a2022-01-20 11:14:50 +00001678 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001679 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1680 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001681
1682#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001683 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001684#endif /* MBEDTLS_HAVE_TIME */
1685
Jerry Yu4a173382021-10-11 21:45:31 +08001686 /* ...
1687 * uint8 legacy_compression_method = 0;
1688 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001689 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1691 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1692 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001693 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001694 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001695 }
1696 p++;
1697
Jerry Yub85277e2021-10-13 13:36:05 +08001698 /* ...
1699 * Extension extensions<6..2^16-1>;
1700 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001701 * struct {
1702 * ExtensionType extension_type; (2 bytes)
1703 * opaque extension_data<0..2^16-1>;
1704 * } Extension;
1705 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1707 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001708 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001709
Jerry Yu4a173382021-10-11 21:45:31 +08001710 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001712 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001713
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001715
Jerry Yu50e00e32022-10-31 14:45:01 +08001716 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001717 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1719 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001720
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001722 unsigned int extension_type;
1723 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001724 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001725
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1727 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1728 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001729 p += 4;
1730
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001732 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001733
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001734 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1736 if (ret != 0) {
1737 return ret;
1738 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001739
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001741 case MBEDTLS_TLS_EXT_COOKIE:
1742
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 ret = ssl_tls13_parse_cookie_ext(ssl,
1744 p, extension_data_end);
1745 if (ret != 0) {
1746 MBEDTLS_SSL_DEBUG_RET(1,
1747 "ssl_tls13_parse_cookie_ext",
1748 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001749 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001750 }
XiaokangQianb851da82022-01-14 04:03:11 +00001751 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001752
Jerry Yue1b9c292021-09-10 10:08:31 +08001753 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1755 p,
1756 extension_data_end);
1757 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001758 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001760 break;
1761
Ronald Cron41a443a2022-10-04 16:38:25 +02001762#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001763 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1767 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001768 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1770 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001771 }
1772 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001773#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001774
Jerry Yue1b9c292021-09-10 10:08:31 +08001775 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1777 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001778 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001779 goto cleanup;
1780 }
1781
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 if (is_hrr) {
1783 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1784 p, extension_data_end);
1785 } else {
1786 ret = ssl_tls13_parse_key_share_ext(ssl,
1787 p, extension_data_end);
1788 }
1789 if (ret != 0) {
1790 MBEDTLS_SSL_DEBUG_RET(1,
1791 "ssl_tls13_parse_key_share_ext",
1792 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001793 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001794 }
1795 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001796
1797 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001798 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1799 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001800 }
1801
1802 p += extension_data_len;
1803 }
1804
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001806
XiaokangQiand59be772022-01-24 10:12:51 +00001807cleanup:
1808
Gilles Peskine449bd832023-01-11 14:50:10 +01001809 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1810 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1811 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001812 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1814 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1815 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001816 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1817 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001819}
1820
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001821#if defined(MBEDTLS_DEBUG_C)
1822static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001823{
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001825 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1826 return "psk";
1827 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1828 return "ephemeral";
1829 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1830 return "psk_ephemeral";
1831 default:
1832 return "unknown mode";
1833 }
1834}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001835#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001836
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001837MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001838static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001839{
Jerry Yub85277e2021-10-13 13:36:05 +08001840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001841 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001842
Jerry Yub85277e2021-10-13 13:36:05 +08001843 /* Determine the key exchange mode:
1844 * 1) If both the pre_shared_key and key_share extensions were received
1845 * then the key exchange mode is PSK with EPHEMERAL.
1846 * 2) If only the pre_shared_key extension was received then the key
1847 * exchange mode is PSK-only.
1848 * 3) If only the key_share extension was received then the key
1849 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001850 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 switch (handshake->received_extensions &
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001852 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1853 MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001854 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001856 handshake->key_exchange_mode =
1857 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001858 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001859
Jerry Yu745bb612021-10-13 22:01:04 +08001860 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001862 handshake->key_exchange_mode =
1863 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001864 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001865
Jerry Yu745bb612021-10-13 22:01:04 +08001866 /* Both the pre_shared_key and key_share extensions were received */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001867 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1868 MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
1869 handshake->key_exchange_mode =
1870 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001871 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001872
Jerry Yu745bb612021-10-13 22:01:04 +08001873 /* Neither pre_shared_key nor key_share extension was received */
1874 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001876 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1877 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001878 }
1879
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001880 if (!mbedtls_ssl_conf_tls13_check_kex_modes(
1881 ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001882 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001883 MBEDTLS_SSL_DEBUG_MSG(
1884 2, ("Key exchange mode(%s) is not supported.",
1885 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001886 goto cleanup;
1887 }
1888
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001889 MBEDTLS_SSL_DEBUG_MSG(
1890 3, ("Selected key exchange mode: %s",
1891 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001892
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001893 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001894 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001895 * If we proposed early data then we have already derived an
1896 * early secret using the selected PSK and its associated hash.
1897 * It means that if the negotiated key exchange mode is psk or
1898 * psk_ephemeral, we have already correctly computed the
1899 * early secret and thus we do not do it again. In all other
1900 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001901 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001902#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001903 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1904 handshake->key_exchange_mode ==
1905 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001906#endif
1907 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001908 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1909 if (ret != 0) {
1910 MBEDTLS_SSL_DEBUG_RET(
1911 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1912 goto cleanup;
1913 }
Jerry Yu0b177842021-09-05 19:41:30 +08001914 }
1915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1917 if (ret != 0) {
1918 MBEDTLS_SSL_DEBUG_RET(1,
1919 "mbedtls_ssl_tls13_compute_handshake_transform",
1920 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001921 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001922 }
1923
Gilles Peskine449bd832023-01-11 14:50:10 +01001924 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1925 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Jerry Yu0b177842021-09-05 19:41:30 +08001926 ssl->session_in = ssl->session_negotiate;
1927
Jerry Yu4a173382021-10-11 21:45:31 +08001928cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001930 MBEDTLS_SSL_PEND_FATAL_ALERT(
1931 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001932 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001933 }
Jerry Yue110d252022-05-05 10:19:22 +08001934
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001936}
1937
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001938MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001939static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00001940{
1941 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00001944
XiaokangQian78b1fa72022-01-19 06:56:30 +00001945 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001946 * We are going to re-generate a shared secret corresponding to the group
1947 * selected by the server, which is different from the group for which we
1948 * generated a shared secret in the first client hello.
1949 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001950 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 ret = ssl_tls13_reset_key_share(ssl);
1952 if (ret != 0) {
1953 return ret;
1954 }
XiaokangQian647719a2021-12-07 09:16:29 +00001955
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001956 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00001958}
1959
Jerry Yue1b9c292021-09-10 10:08:31 +08001960/*
Jerry Yu4a173382021-10-11 21:45:31 +08001961 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001962 * Handler for MBEDTLS_SSL_SERVER_HELLO
1963 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001964MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001965static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08001966{
Jerry Yu4a173382021-10-11 21:45:31 +08001967 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001968 unsigned char *buf = NULL;
1969 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001970 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08001973
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001974 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1975 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02001976
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
1978 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00001979 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 } else {
1981 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
1982 }
XiaokangQiand59be772022-01-24 10:12:51 +00001983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01001985 ret = 0;
1986 goto cleanup;
1987 }
1988
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
1990 buf + buf_len,
1991 is_hrr));
1992 if (is_hrr) {
1993 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02001994 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001995
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001996 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1997 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01001998
1999 if (is_hrr) {
2000 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2001#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2002 /* If not offering early data, the client sends a dummy CCS record
2003 * immediately before its second flight. This may either be before
2004 * its second ClientHello or before its encrypted handshake flight.
2005 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002006 mbedtls_ssl_handshake_set_state(
2007 ssl, MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
Gilles Peskine449bd832023-01-11 14:50:10 +01002008#else
2009 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2010#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2011 } else {
2012 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2013 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002014 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002015
2016cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2018 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2019 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002020}
2021
2022/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002023 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002024 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002025 *
2026 * The EncryptedExtensions message contains any extensions which
2027 * should be protected, i.e., any which are not needed to establish
2028 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002029 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002030
XiaokangQian08da26c2021-10-09 10:12:11 +00002031/* Parse EncryptedExtensions message
2032 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002033 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002034 * } EncryptedExtensions;
2035 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002037static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2038 const unsigned char *buf,
2039 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002040{
2041 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002042 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002043 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002044 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002045 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2048 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002049 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002052 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002053
Jan Bruckner5a3629b2023-02-23 12:08:09 +01002054 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2055
Jerry Yu9eba7502022-10-31 13:46:16 +08002056 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002059 unsigned int extension_type;
2060 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002061
XiaokangQian08da26c2021-10-09 10:12:11 +00002062 /*
2063 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002064 * ExtensionType extension_type; (2 bytes)
2065 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002066 * } Extension;
2067 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2069 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2070 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002071 p += 4;
2072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002074
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002075 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2077 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2078 if (ret != 0) {
2079 return ret;
2080 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002083#if defined(MBEDTLS_SSL_ALPN)
2084 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002086
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002087 if ((ret = ssl_tls13_parse_alpn_ext(
2088 ssl, p, (size_t) extension_data_len)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002090 }
2091
2092 break;
2093#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002094
2095#if defined(MBEDTLS_SSL_EARLY_DATA)
2096 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002097
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002099 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2101 MBEDTLS_ERR_SSL_DECODE_ERROR);
2102 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002103 }
2104
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002105 break;
2106#endif /* MBEDTLS_SSL_EARLY_DATA */
2107
Jan Bruckner151f6422023-02-10 12:45:19 +01002108#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2109 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
2110 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
2111
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002112 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
2113 ssl, p, p + extension_data_len);
Jan Bruckner151f6422023-02-10 12:45:19 +01002114
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002115 /* TODO: Return unconditionally here until we handle the record
2116 * size limit correctly. Once handled correctly, only return in
2117 * case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01002118 return ret;
2119
2120 break;
2121#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2122
XiaokangQian08da26c2021-10-09 10:12:11 +00002123 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002124 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002125 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002127 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002128 }
2129
XiaokangQian08da26c2021-10-09 10:12:11 +00002130 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002131 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002132
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2134 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002135
XiaokangQian97799ac2021-10-11 10:05:54 +00002136 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 if (p != end) {
2138 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2139 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2140 MBEDTLS_ERR_SSL_DECODE_ERROR);
2141 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002142 }
2143
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002145}
2146
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002147MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002148static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002149{
2150 int ret;
2151 unsigned char *buf;
2152 size_t buf_len;
Jerry Yu960b7eb2023-10-31 16:40:01 +08002153 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002156
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002157 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2158 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2159 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002160
2161 /* Process the message contents */
2162 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002164
Xiaokang Qianb157e912022-11-23 08:12:26 +00002165#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu960b7eb2023-10-31 16:40:01 +08002166 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
2167 /* RFC8446 4.2.11
2168 * If the server supplies an "early_data" extension, the
2169 * client MUST verify that the server's selected_identity
2170 * is 0. If any other value is returned, the client MUST
2171 * abort the handshake with an "illegal_parameter" alert.
2172 *
2173 * RFC 8446 4.2.10
2174 * In order to accept early data, the server MUST have accepted a PSK
2175 * cipher suite and selected the first key offered in the client's
2176 * "pre_shared_key" extension. In addition, it MUST verify that the
2177 * following values are the same as those associated with the
2178 * selected PSK:
2179 * - The TLS version number
2180 * - The selected cipher suite
2181 * - The selected ALPN [RFC7301] protocol, if any
2182 *
Yanray Wang03a00762023-12-01 17:40:19 +08002183 * The server has sent an early data extension in its Encrypted
2184 * Extension message thus accepted to receive early data. We
2185 * check here that the additional constraints on the handshake
2186 * parameters, when early data are exchanged, are met,
2187 * namely:
Yanray Wang744577a2023-12-01 22:33:59 +08002188 * - a PSK has been selected for the handshake
Yanray Wang03a00762023-12-01 17:40:19 +08002189 * - the selected PSK for the handshake was the first one proposed
2190 * by the client.
2191 * - the selected ciphersuite for the handshake is the ciphersuite
2192 * associated with the selected PSK.
Jerry Yu960b7eb2023-10-31 16:40:01 +08002193 */
Yanray Wang744577a2023-12-01 22:33:59 +08002194 if ((!mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) ||
2195 handshake->selected_identity != 0 ||
Jerry Yu960b7eb2023-10-31 16:40:01 +08002196 handshake->ciphersuite_info->id !=
2197 ssl->session_negotiate->ciphersuite) {
2198
2199 MBEDTLS_SSL_PEND_FATAL_ALERT(
2200 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
2201 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
2202 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
2203 }
2204
Xiaokang Qianb157e912022-11-23 08:12:26 +00002205 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2206 }
2207#endif
2208
Yanray Wanga29db7d2023-11-30 14:06:14 +08002209 /*
Yanray Wang9ae65342023-12-01 17:46:06 +08002210 * In case the client has proposed a PSK associated with a ticket,
2211 * `ssl->session_negotiate->ciphersuite` still contains at this point the
2212 * identifier of the ciphersuite associated with the ticket. This is that
2213 * way because, if an exchange of early data is agreed upon, we need
2214 * it to check that the ciphersuite selected for the handshake is the
2215 * ticket ciphersuite (see above). This information is not needed
2216 * anymore thus we can now set it to the identifier of the ciphersuite
2217 * used in this session under negotiation.
Yanray Wanga29db7d2023-11-30 14:06:14 +08002218 */
2219 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
2220
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002221 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2222 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2223 buf, buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002224
Ronald Cron928cbd32022-10-04 16:14:26 +02002225#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2227 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2228 } else {
2229 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2230 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002231#else
2232 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002234#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002235
2236cleanup:
2237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2239 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002240
2241}
2242
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002243/*
2244 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2245 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002246 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002247 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002248 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002249 *
2250 * If the server sent an "early_data" extension in EncryptedExtensions, the
2251 * client MUST send an EndOfEarlyData message after receiving the server
2252 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002253 */
2254
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002255MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002256static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2257{
2258 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002259 unsigned char *buf = NULL;
2260 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002261 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002262
Xiaokang Qian742578c2022-12-19 06:34:44 +00002263 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
Xiaokang Qian0de0d862023-02-08 06:04:50 +00002264 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
2265 &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002266
Manuel Pégourié-Gonnard63e33dd2023-02-21 15:45:15 +01002267 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_hdr_to_checksum(
2268 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002269
Xiaokang Qian742578c2022-12-19 06:34:44 +00002270 MBEDTLS_SSL_PROC_CHK(
2271 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002272
Xiaokang Qian19d44162023-01-03 03:39:50 +00002273 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002274
2275cleanup:
2276
2277 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2278 return ret;
2279}
2280
Ronald Cron928cbd32022-10-04 16:14:26 +02002281#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002282/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002283 * STATE HANDLING: CertificateRequest
2284 *
Jerry Yud2674312021-10-29 10:08:19 +08002285 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002286#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2287#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002288/* Coordination:
2289 * Deals with the ambiguity of not knowing if a CertificateRequest
2290 * will be sent. Returns a negative code on failure, or
2291 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2292 * - SSL_CERTIFICATE_REQUEST_SKIP
2293 * indicating if a Certificate Request is expected or not.
2294 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002295MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002296static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002297{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002298 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002299
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2301 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2302 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002303 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002304 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2307 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2308 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2309 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002310 }
2311
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002315}
2316
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002317/*
2318 * ssl_tls13_parse_certificate_request()
2319 * Parse certificate request
2320 * struct {
2321 * opaque certificate_request_context<0..2^8-1>;
2322 * Extension extensions<2..2^16-1>;
2323 * } CertificateRequest;
2324 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002325MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002326static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2327 const unsigned char *buf,
2328 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002329{
2330 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2331 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002332 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002333 size_t extensions_len = 0;
2334 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002335 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002336
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002337 /* ...
2338 * opaque certificate_request_context<0..2^8-1>
2339 * ...
2340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002342 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002343 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002344
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 if (certificate_request_context_len > 0) {
2346 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2347 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2348 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002349
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002350 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 mbedtls_calloc(1, certificate_request_context_len);
2352 if (handshake->certificate_request_context == NULL) {
2353 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2354 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002355 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 memcpy(handshake->certificate_request_context, p,
2357 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002358 p += certificate_request_context_len;
2359 }
2360
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002361 /* ...
2362 * Extension extensions<2..2^16-1>;
2363 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002364 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2366 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002367 p += 2;
2368
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002370 extensions_end = p + extensions_len;
2371
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002372 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002375 unsigned int extension_type;
2376 size_t extension_data_len;
2377
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2379 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2380 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002381 p += 4;
2382
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002384
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002385 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2387 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2388 if (ret != 0) {
2389 return ret;
2390 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002393 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 MBEDTLS_SSL_DEBUG_MSG(3,
2395 ("found signature algorithms extension"));
2396 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2397 p + extension_data_len);
2398 if (ret != 0) {
2399 return ret;
2400 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002401
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002402 break;
2403
2404 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002405 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002406 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002408 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002409 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002410
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002411 p += extension_data_len;
2412 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002413
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2415 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002416
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002417 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 if (p != end) {
2419 MBEDTLS_SSL_DEBUG_MSG(1,
2420 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002421 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002422 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002423
Jerry Yu0c354a22022-08-29 15:25:36 +08002424 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002425 *
2426 * The "signature_algorithms" extension MUST be specified
2427 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2429 MBEDTLS_SSL_DEBUG_MSG(3,
2430 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002431 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002432 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002433
Jerry Yu7840f812022-01-29 10:26:51 +08002434 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002436
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002437decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2439 MBEDTLS_ERR_SSL_DECODE_ERROR);
2440 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002441}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002442
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002443/*
2444 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2445 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002446MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002447static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002448{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002449 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002456 unsigned char *buf;
2457 size_t buf_len;
2458
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002459 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2460 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2461 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002462
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002463 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(
2464 ssl, buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002465
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002466 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2467 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2468 buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002470 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 } else {
2472 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002473 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2474 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002475 }
2476
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002478
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002479cleanup:
2480
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2482 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002483}
2484
2485/*
Jerry Yu687101b2021-09-14 16:03:56 +08002486 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2487 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002488MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002489static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002490{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002491 int ret;
2492
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2494 if (ret != 0) {
2495 return ret;
2496 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002497
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2499 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002500}
2501
2502/*
2503 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
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_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002507{
Jerry Yu30b071c2021-09-12 20:16:03 +08002508 int ret;
2509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2511 if (ret != 0) {
2512 return ret;
2513 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2516 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002517}
Ronald Cron928cbd32022-10-04 16:14:26 +02002518#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002519
Jerry Yu687101b2021-09-14 16:03:56 +08002520/*
2521 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2522 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002523MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002524static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002525{
XiaokangQianac0385c2021-11-03 06:40:11 +00002526 int ret;
2527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2529 if (ret != 0) {
2530 return ret;
2531 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002532
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2534 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002535 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2537 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2538 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002539 }
2540
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002541#if defined(MBEDTLS_SSL_EARLY_DATA)
2542 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2543 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002544 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2545 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002546 } else
2547#endif /* MBEDTLS_SSL_EARLY_DATA */
2548 {
2549#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2550 mbedtls_ssl_handshake_set_state(
2551 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2552#else
2553 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2554#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2555 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002558}
2559
2560/*
Jerry Yu566c7812022-01-26 15:41:22 +08002561 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2562 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002563MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002564static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002565{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002566 int non_empty_certificate_msg = 0;
2567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 MBEDTLS_SSL_DEBUG_MSG(1,
2569 ("Switch to handshake traffic keys for outbound traffic"));
2570 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002571
Ronald Cron928cbd32022-10-04 16:14:26 +02002572#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 if (ssl->handshake->client_auth) {
2574 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2575 if (ret != 0) {
2576 return ret;
2577 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002578
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002580 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 }
2582 } else {
2583 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002584 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002585#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 if (non_empty_certificate_msg) {
2588 mbedtls_ssl_handshake_set_state(ssl,
2589 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2590 } else {
2591 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2592 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2593 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002594
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002596}
2597
Ronald Cron928cbd32022-10-04 16:14:26 +02002598#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002599/*
2600 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2601 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002602MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002603static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002604{
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002606
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 if (ret == 0) {
2608 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2609 }
Ronald Crona8b38872022-03-09 07:59:25 +01002610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002612}
Ronald Cron928cbd32022-10-04 16:14:26 +02002613#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002614
2615/*
Jerry Yu687101b2021-09-14 16:03:56 +08002616 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2617 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002618MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002619static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002620{
XiaokangQian0fa66432021-11-15 03:33:57 +00002621 int ret;
2622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2624 if (ret != 0) {
2625 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002626 }
2627
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2629 if (ret != 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002630 MBEDTLS_SSL_DEBUG_RET(
2631 1, "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 return ret;
2633 }
2634
2635 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2636 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002637}
2638
2639/*
2640 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2641 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002642MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002643static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002644{
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2646 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2647 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002648}
2649
2650/*
2651 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2652 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002653MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002654static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002655{
Jerry Yu378254d2021-10-30 21:44:47 +08002656
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2660 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002661}
2662
Jerry Yuf8a49942022-07-07 11:32:32 +00002663#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2664
Yanray Wang920db452023-11-14 17:20:16 +08002665#if defined(MBEDTLS_SSL_EARLY_DATA)
2666/* From RFC 8446 section 4.2.10
2667 *
2668 * struct {
2669 * select (Handshake.msg_type) {
2670 * case new_session_ticket: uint32 max_early_data_size;
2671 * ...
2672 * };
2673 * } EarlyDataIndication;
2674 */
2675MBEDTLS_CHECK_RETURN_CRITICAL
Yanray Wangb3e207d2023-11-30 16:49:49 +08002676static int ssl_tls13_parse_new_session_ticket_early_data_ext(
2677 mbedtls_ssl_context *ssl,
2678 const unsigned char *buf,
2679 const unsigned char *end)
Yanray Wang920db452023-11-14 17:20:16 +08002680{
Yanray Wangd0120842023-11-23 16:35:54 +08002681 mbedtls_ssl_session *session = ssl->session;
2682
Yanray Wang920db452023-11-14 17:20:16 +08002683 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 4);
Yanray Wang920db452023-11-14 17:20:16 +08002684
Yanray Wangd0120842023-11-23 16:35:54 +08002685 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(buf, 0);
2686 mbedtls_ssl_session_set_ticket_flags(
2687 session, MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA);
2688 MBEDTLS_SSL_DEBUG_MSG(
2689 3, ("received max_early_data_size: %u",
2690 (unsigned int) session->max_early_data_size));
Yanray Wang920db452023-11-14 17:20:16 +08002691
Yanray Wangd0120842023-11-23 16:35:54 +08002692 return 0;
Yanray Wang920db452023-11-14 17:20:16 +08002693}
2694#endif /* MBEDTLS_SSL_EARLY_DATA */
2695
Jerry Yua0446a02022-07-13 11:22:55 +08002696MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002697static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2698 const unsigned char *buf,
2699 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002700{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002701 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002702 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002703
Jerry Yuf8a49942022-07-07 11:32:32 +00002704
Jerry Yuedab6372022-10-31 14:37:31 +08002705 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002708 unsigned int extension_type;
2709 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002710 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2713 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2714 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002715 p += 4;
2716
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002718
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002719 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2721 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2722 if (ret != 0) {
2723 return ret;
2724 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002727#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002728 case MBEDTLS_TLS_EXT_EARLY_DATA:
Yanray Wangb3e207d2023-11-30 16:49:49 +08002729 ret = ssl_tls13_parse_new_session_ticket_early_data_ext(
Yanray Wang920db452023-11-14 17:20:16 +08002730 ssl, p, p + extension_data_len);
2731 if (ret != 0) {
2732 MBEDTLS_SSL_DEBUG_RET(
Yanray Wangb3e207d2023-11-30 16:49:49 +08002733 1, "ssl_tls13_parse_new_session_ticket_early_data_ext",
2734 ret);
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002735 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002736 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002737#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002738
Jerry Yuf8a49942022-07-07 11:32:32 +00002739 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002740 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002741 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002743 break;
2744 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002745
Jerry Yuf8a49942022-07-07 11:32:32 +00002746 p += extension_data_len;
2747 }
2748
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2750 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002753}
2754
2755/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002756 * From RFC8446, page 74
2757 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002758 * struct {
2759 * uint32 ticket_lifetime;
2760 * uint32 ticket_age_add;
2761 * opaque ticket_nonce<0..255>;
2762 * opaque ticket<1..2^16-1>;
2763 * Extension extensions<0..2^16-2>;
2764 * } NewSessionTicket;
2765 *
2766 */
Jerry Yua0446a02022-07-13 11:22:55 +08002767MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002768static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2769 unsigned char *buf,
2770 unsigned char *end,
2771 unsigned char **ticket_nonce,
2772 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002773{
2774 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2775 unsigned char *p = buf;
2776 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002777 size_t ticket_len;
2778 unsigned char *ticket;
2779 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002780
Jerry Yucb3b1392022-07-12 06:09:38 +00002781 *ticket_nonce = NULL;
2782 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002783 /*
2784 * ticket_lifetime 4 bytes
2785 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002786 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002787 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2791 MBEDTLS_SSL_DEBUG_MSG(3,
2792 ("ticket_lifetime: %u",
2793 (unsigned int) session->ticket_lifetime));
Jerry Yu8e0174a2023-11-10 13:58:16 +08002794 if (session->ticket_lifetime >
2795 MBEDTLS_SSL_TLS1_3_MAX_ALLOWED_TICKET_LIFETIME) {
Jerry Yu46c79262023-11-10 13:58:16 +08002796 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime exceeds 7 days."));
Jerry Yucf913512023-11-14 11:06:52 +08002797 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu46c79262023-11-10 13:58:16 +08002798 }
Jerry Yuf8a49942022-07-07 11:32:32 +00002799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2801 MBEDTLS_SSL_DEBUG_MSG(3,
2802 ("ticket_age_add: %u",
2803 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002804
Jerry Yucb3b1392022-07-12 06:09:38 +00002805 *ticket_nonce_len = p[8];
2806 p += 9;
2807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002809 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002811 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002812
2813 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2815 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002816 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2818 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002819
2820 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 if (session->ticket != NULL || session->ticket_len > 0) {
2822 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002823 session->ticket = NULL;
2824 session->ticket_len = 0;
2825 }
2826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2828 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2829 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002830 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002832 p += ticket_len;
2833 session->ticket = ticket;
2834 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002835
Pengyu Lv9f926952022-11-17 15:22:33 +08002836 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002837 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002838 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2841 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002842 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2848 if (ret != 0) {
2849 MBEDTLS_SSL_DEBUG_RET(1,
2850 "ssl_tls13_parse_new_session_ticket_exts",
2851 ret);
2852 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002853 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002854
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002855 /* session has been updated, allow export */
2856 session->exported = 0;
2857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002859}
2860
Jerry Yua0446a02022-07-13 11:22:55 +08002861MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002862static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2863 unsigned char *ticket_nonce,
2864 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002865{
2866 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2867 mbedtls_ssl_session *session = ssl->session;
2868 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2869 psa_algorithm_t psa_hash_alg;
2870 int hash_length;
2871
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002872#if defined(MBEDTLS_HAVE_TIME)
2873 /* Store ticket creation time */
Jerry Yu342a5552023-11-10 14:23:39 +08002874 session->ticket_reception_time = mbedtls_ms_time();
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002875#endif
2876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2878 if (ciphersuite_info == NULL) {
2879 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2880 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002881 }
2882
Dave Rodgman2eab4622023-10-05 13:30:37 +01002883 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2885 if (hash_length == -1 ||
2886 (size_t) hash_length > sizeof(session->resumption_key)) {
2887 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002888 }
2889
Jerry Yuf8a49942022-07-07 11:32:32 +00002890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2892 session->app_secrets.resumption_master_secret,
2893 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002894
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002895 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002896 *
2897 * HKDF-Expand-Label( resumption_master_secret,
2898 * "resumption", ticket_nonce, Hash.length )
2899 */
2900 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 psa_hash_alg,
2902 session->app_secrets.resumption_master_secret,
2903 hash_length,
2904 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2905 ticket_nonce,
2906 ticket_nonce_len,
2907 session->resumption_key,
2908 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002909
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 if (ret != 0) {
2911 MBEDTLS_SSL_DEBUG_RET(2,
2912 "Creating the ticket-resumed PSK failed",
2913 ret);
2914 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002915 }
2916
Jerry Yu0a430c82022-07-20 11:02:48 +08002917 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2920 session->resumption_key,
2921 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002922
Pengyu Lv9f926952022-11-17 15:22:33 +08002923 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002924 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002925 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002926 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002927
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002929}
2930
2931/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002932 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002933 */
Jerry Yua0446a02022-07-13 11:22:55 +08002934MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002935static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002936{
2937 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2938 unsigned char *buf;
2939 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002940 unsigned char *ticket_nonce;
2941 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2946 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2947 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2950 ssl, buf, buf + buf_len,
2951 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002952
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2954 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002955
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002957
Jerry Yuf8a49942022-07-07 11:32:32 +00002958cleanup:
2959
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2961 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002962}
2963#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2964
Gilles Peskine449bd832023-01-11 14:50:10 +01002965int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002966{
Jerry Yu92c6b402021-08-27 16:59:09 +08002967 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002970 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002972 break;
2973
Jerry Yu92c6b402021-08-27 16:59:09 +08002974 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002976 break;
2977
2978 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002980 break;
2981
2982 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002984 break;
2985
Ronald Cron928cbd32022-10-04 16:14:26 +02002986#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002987 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002989 break;
2990
Jerry Yu687101b2021-09-14 16:03:56 +08002991 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002993 break;
2994
2995 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002997 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002998#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002999
3000 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003002 break;
3003
Xiaokang Qian125afcb2022-10-28 06:04:06 +00003004 case MBEDTLS_SSL_END_OF_EARLY_DATA:
3005 ret = ssl_tls13_write_end_of_early_data(ssl);
3006 break;
3007
Jerry Yu566c7812022-01-26 15:41:22 +08003008 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08003010 break;
3011
Ronald Cron928cbd32022-10-04 16:14:26 +02003012#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08003013 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08003015 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003016#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08003017
Jerry Yu687101b2021-09-14 16:03:56 +08003018 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003020 break;
3021
3022 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08003024 break;
3025
3026 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08003028 break;
3029
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 /*
3031 * Injection of dummy-CCS's for middlebox compatibility
3032 */
Ronald Cron49ad6192021-11-24 16:25:31 +01003033#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00003034 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3036 if (ret == 0) {
3037 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3038 }
Ronald Cron9f55f632022-02-02 16:02:47 +01003039 break;
3040
3041 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3043 if (ret == 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00003044 mbedtls_ssl_handshake_set_state(
3045 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 }
Ronald Cron49ad6192021-11-24 16:25:31 +01003047 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003048
Xiaokang Qian592021a2023-01-04 10:47:05 +00003049 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3050 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3051 if (ret == 0) {
3052 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3053
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003054#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003055 MBEDTLS_SSL_DEBUG_MSG(
3056 1, ("Switch to early data keys for outbound traffic"));
3057 mbedtls_ssl_set_outbound_transform(
3058 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003059#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003060 }
3061 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003062#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3063
Jerry Yuf8a49942022-07-07 11:32:32 +00003064#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003065 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 ret = ssl_tls13_process_new_session_ticket(ssl);
3067 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003068 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003070 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3071 break;
3072#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3073
Jerry Yu92c6b402021-08-27 16:59:09 +08003074 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003077 }
3078
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003080}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003081
Jerry Yufb4b6472022-01-27 15:03:26 +08003082#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */