blob: 32ad7aaed8da69999a8c3d7bf86a338db004c572 [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 &&
698 (session->ticket_flags &
699 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) &&
700 mbedtls_ssl_tls13_cipher_suite_is_offered(
701 ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000702}
703#endif
704
Xiaokang Qianb781a232022-11-01 07:39:46 +0000705MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100706static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
707 psa_algorithm_t *hash_alg,
708 const unsigned char **identity,
709 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800710{
711 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 if (!ssl_tls13_has_configured_ticket(ssl)) {
714 return -1;
715 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800716
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800718 *identity = session->ticket;
719 *identity_len = session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800721}
722
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800723MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100724static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
725 psa_algorithm_t *hash_alg,
726 const unsigned char **psk,
727 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800728{
729
730 mbedtls_ssl_session *session = ssl->session_negotiate;
731
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (!ssl_tls13_has_configured_ticket(ssl)) {
733 return -1;
734 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800735
Gilles Peskine449bd832023-01-11 14:50:10 +0100736 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800737 *psk = session->resumption_key;
738 *psk_len = session->resumption_key_len;
739
Gilles Peskine449bd832023-01-11 14:50:10 +0100740 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800741}
Jerry Yuf7c12592022-09-28 22:09:38 +0800742#endif /* MBEDTLS_SSL_SESSION_TICKETS */
743
744MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100745static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
746 psa_algorithm_t *hash_alg,
747 const unsigned char **identity,
748 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800749{
Jerry Yu8b41e892022-09-30 10:00:20 +0800750
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
752 return -1;
753 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800754
Jerry Yua99cbfa2022-10-08 11:17:14 +0800755 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800756 *identity = ssl->conf->psk_identity;
757 *identity_len = ssl->conf->psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800759}
760
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800761MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100762static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
763 psa_algorithm_t *hash_alg,
764 const unsigned char **psk,
765 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800766{
Jerry Yu8b41e892022-09-30 10:00:20 +0800767
Gilles Peskine449bd832023-01-11 14:50:10 +0100768 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
769 return -1;
770 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800771
Jerry Yua99cbfa2022-10-08 11:17:14 +0800772 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800773 *psk = ssl->conf->psk;
774 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800776}
777
Gilles Peskine449bd832023-01-11 14:50:10 +0100778static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800779{
780 int configured_psk_count = 0;
781#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 if (ssl_tls13_has_configured_ticket(ssl)) {
783 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800784 configured_psk_count++;
785 }
786#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
788 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800789 configured_psk_count++;
790 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800792}
793
Jerry Yuf7c12592022-09-28 22:09:38 +0800794MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100795static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
796 unsigned char *buf,
797 unsigned char *end,
798 const unsigned char *identity,
799 size_t identity_len,
800 uint32_t obfuscated_ticket_age,
801 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800802{
Jerry Yuf75364b2022-09-30 10:30:31 +0800803 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800804 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800805
806 /*
807 * - identity_len (2 bytes)
808 * - identity (psk_identity_len bytes)
809 * - obfuscated_ticket_age (4 bytes)
810 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100811 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800812
Gilles Peskine449bd832023-01-11 14:50:10 +0100813 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
814 memcpy(buf + 2, identity, identity_len);
815 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800816
Gilles Peskine449bd832023-01-11 14:50:10 +0100817 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800818
819 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800820
Gilles Peskine449bd832023-01-11 14:50:10 +0100821 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800822}
823
Jerry Yu8b41e892022-09-30 10:00:20 +0800824MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100825static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
826 unsigned char *buf,
827 unsigned char *end,
828 int psk_type,
829 psa_algorithm_t hash_alg,
830 const unsigned char *psk,
831 size_t psk_len,
832 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800833{
834 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800835 unsigned char binder_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100836 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800837 size_t transcript_len = 0;
838
839 *out_len = 0;
840
Gilles Peskine449bd832023-01-11 14:50:10 +0100841 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800842
843 /*
844 * - binder_len (1 bytes)
845 * - binder (binder_len bytes)
846 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800848
Jerry Yua99cbfa2022-10-08 11:17:14 +0800849 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800850
851 /* Get current state of handshake transcript. */
852 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200853 ssl, mbedtls_md_type_from_psa_alg(hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 transcript, sizeof(transcript), &transcript_len);
855 if (ret != 0) {
856 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800857 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100858
859 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
860 psk, psk_len, psk_type,
861 transcript, buf + 1);
862 if (ret != 0) {
863 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
864 return ret;
865 }
866 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800867
868 *out_len = 1 + binder_len;
869
Gilles Peskine449bd832023-01-11 14:50:10 +0100870 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800871}
872
873/*
874 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
875 *
876 * struct {
877 * opaque identity<1..2^16-1>;
878 * uint32 obfuscated_ticket_age;
879 * } PskIdentity;
880 *
881 * opaque PskBinderEntry<32..255>;
882 *
883 * struct {
884 * PskIdentity identities<7..2^16-1>;
885 * PskBinderEntry binders<33..2^16-1>;
886 * } OfferedPsks;
887 *
888 * struct {
889 * select (Handshake.msg_type) {
890 * case client_hello: OfferedPsks;
891 * ...
892 * };
893 * } PreSharedKeyExtension;
894 *
895 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000896int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
898 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000899{
Jerry Yuf7c12592022-09-28 22:09:38 +0800900 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800901 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800902 unsigned char *p = buf;
Xiaokang Qian854db282022-12-19 07:31:27 +0000903 psa_algorithm_t hash_alg = PSA_ALG_NONE;
Jerry Yuf75364b2022-09-30 10:30:31 +0800904 const unsigned char *identity;
905 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800906 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800907 size_t output_len;
Xiaokang Qian7179f812023-02-03 03:38:44 +0000908
Jerry Yuf7c12592022-09-28 22:09:38 +0800909 *out_len = 0;
910 *binders_len = 0;
911
912 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Gilles Peskine449bd832023-01-11 14:50:10 +0100913 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
914 if (configured_psk_count == 0) {
915 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
916 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800917 }
918
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
920 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800921
Jerry Yuf7c12592022-09-28 22:09:38 +0800922 /* Check if we have space to write the extension, binders included.
923 * - extension_type (2 bytes)
924 * - extension_data_len (2 bytes)
925 * - identities_len (2 bytes)
926 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800928 p += 6;
929
Jerry Yuf75364b2022-09-30 10:30:31 +0800930#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 if (ssl_tls13_ticket_get_identity(
932 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800933#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucebffc32022-12-15 18:00:05 +0800934 mbedtls_ms_time_t now = mbedtls_ms_time();
Jerry Yuf75364b2022-09-30 10:30:31 +0800935 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800936 uint32_t obfuscated_ticket_age =
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 (uint32_t) (now - session->ticket_received);
Jerry Yuf75364b2022-09-30 10:30:31 +0800938 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800939
Gilles Peskine449bd832023-01-11 14:50:10 +0100940 ret = ssl_tls13_write_identity(ssl, p, end,
941 identity, identity_len,
942 obfuscated_ticket_age,
943 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800944#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
946 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800947#endif /* MBEDTLS_HAVE_TIME */
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 if (ret != 0) {
949 return ret;
950 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800951
Jerry Yuf75364b2022-09-30 10:30:31 +0800952 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +0800954 }
955#endif /* MBEDTLS_SSL_SESSION_TICKETS */
956
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 if (ssl_tls13_psk_get_identity(
958 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800959
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
961 &output_len);
962 if (ret != 0) {
963 return ret;
964 }
Jerry Yuf75364b2022-09-30 10:30:31 +0800965
Jerry Yuf7c12592022-09-28 22:09:38 +0800966 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +0800968 }
969
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 MBEDTLS_SSL_DEBUG_MSG(3,
971 ("client hello, adding pre_shared_key extension, "
972 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +0800973
974 /* Take into account the two bytes for the length of the binders. */
975 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800976 /* Check if there is enough space for binders */
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800978
Jerry Yuf7c12592022-09-28 22:09:38 +0800979 /*
980 * - extension_type (2 bytes)
981 * - extension_data_len (2 bytes)
982 * - identities_len (2 bytes)
983 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100984 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
985 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
986 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +0800987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800989 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800990
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +0800992
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000994}
995
XiaokangQian86981952022-07-19 09:51:50 +0000996int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000998{
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800999 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1000 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001001 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1002 const unsigned char *psk;
1003 size_t psk_len;
1004 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001005
1006 /* Check if we have space to write binders_len.
1007 * - binders_len (2 bytes)
1008 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001010 p += 2;
1011
Jerry Yu6183cc72022-09-30 11:08:57 +08001012#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001014
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 ret = ssl_tls13_write_binder(ssl, p, end,
1016 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1017 hash_alg, psk, psk_len,
1018 &output_len);
1019 if (ret != 0) {
1020 return ret;
1021 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001022 p += output_len;
1023 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001024#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001025
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 ret = ssl_tls13_write_binder(ssl, p, end,
1029 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1030 hash_alg, psk, psk_len,
1031 &output_len);
1032 if (ret != 0) {
1033 return ret;
1034 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001035 p += output_len;
1036 }
1037
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001039
1040 /*
1041 * - binders_len (2 bytes)
1042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001044
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001046
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001047 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001049
Gilles Peskine449bd832023-01-11 14:50:10 +01001050 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001051}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001052
1053/*
1054 * struct {
1055 * opaque identity<1..2^16-1>;
1056 * uint32 obfuscated_ticket_age;
1057 * } PskIdentity;
1058 *
1059 * opaque PskBinderEntry<32..255>;
1060 *
1061 * struct {
1062 *
1063 * select (Handshake.msg_type) {
1064 * ...
1065 * case server_hello: uint16 selected_identity;
1066 * };
1067 *
1068 * } PreSharedKeyExtension;
1069 *
1070 */
1071MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001072static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1073 const unsigned char *buf,
1074 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001075{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001076 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001077 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001078 const unsigned char *psk;
1079 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001080 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001081
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1083 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001084 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001087
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1089 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1092 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1093 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001094 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001095
Jerry Yu4a698342022-09-30 12:22:01 +08001096#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1098 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1099 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001100#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1102 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
1103 } else {
1104 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1105 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001106 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 if (ret != 0) {
1108 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001109 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001110
Dave Rodgman2eab4622023-10-05 13:30:37 +01001111 if (mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ssl->handshake->ciphersuite_info->mac)
Xiaokang Qianeb31cbc2023-02-07 02:08:56 +00001112 != hash_alg) {
1113 MBEDTLS_SSL_DEBUG_MSG(
1114 1, ("Invalid ciphersuite for external psk."));
1115
1116 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1117 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1118 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1119 }
1120
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1122 if (ret != 0) {
1123 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1124 return ret;
1125 }
1126
1127 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001128}
Ronald Cron41a443a2022-10-04 16:38:25 +02001129#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001130
Gilles Peskine449bd832023-01-11 14:50:10 +01001131int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1132 unsigned char *buf,
1133 unsigned char *end,
1134 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001135{
1136 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1137 unsigned char *p = buf;
1138 size_t ext_len;
1139
1140 *out_len = 0;
1141
1142 /* Write supported_versions extension
1143 *
1144 * Supported Versions Extension is mandatory with TLS 1.3.
1145 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1147 if (ret != 0) {
1148 return ret;
1149 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001150 p += ext_len;
1151
1152 /* Echo the cookie if the server provided one in its preceding
1153 * HelloRetryRequest message.
1154 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1156 if (ret != 0) {
1157 return ret;
1158 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001159 p += ext_len;
1160
Ronald Cron766c0cd2022-10-18 12:17:11 +02001161#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1163 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1164 if (ret != 0) {
1165 return ret;
1166 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001167 p += ext_len;
1168 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001169#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001170
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001171#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1173 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1174 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1175 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1176 if (ret != 0) {
1177 return ret;
1178 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001179 p += ext_len;
1180
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001181 /* Initializes the status to `rejected`. It will be updated to
1182 * `accepted` if the EncryptedExtension message contain an early data
1183 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001184 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001185 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 } else {
1187 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001188 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001189 }
1190#endif /* MBEDTLS_SSL_EARLY_DATA */
1191
Ronald Cron41a443a2022-10-04 16:38:25 +02001192#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001193 /* For PSK-based key exchange we need the pre_shared_key extension
1194 * and the psk_key_exchange_modes extension.
1195 *
1196 * The pre_shared_key extension MUST be the last extension in the
1197 * ClientHello. Servers MUST check that it is the last extension and
1198 * otherwise fail the handshake with an "illegal_parameter" alert.
1199 *
1200 * Add the psk_key_exchange_modes extension.
1201 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1203 if (ret != 0) {
1204 return ret;
1205 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001206 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001207#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001208
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001209 *out_len = p - buf;
1210
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001212}
1213
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00001214int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl)
Xiaokang Qian126929f2023-01-03 10:29:41 +00001215{
Xiaokang Qian90746132023-01-06 05:54:59 +00001216 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001217
Xiaokang Qian126929f2023-01-03 10:29:41 +00001218#if defined(MBEDTLS_SSL_EARLY_DATA)
1219 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1220 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1221 const unsigned char *psk;
1222 size_t psk_len;
1223 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001224
Xiaokang Qian126929f2023-01-03 10:29:41 +00001225 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
Xiaokang Qian6be82902023-02-03 06:04:43 +00001226#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1227 mbedtls_ssl_handshake_set_state(
1228 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1229#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00001230 MBEDTLS_SSL_DEBUG_MSG(
1231 1, ("Set hs psk for early data when writing the first psk"));
1232
1233 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1234 if (ret != 0) {
1235 MBEDTLS_SSL_DEBUG_RET(
1236 1, "ssl_tls13_ticket_get_psk", ret);
1237 return ret;
1238 }
1239
1240 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1241 if (ret != 0) {
1242 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1243 return ret;
1244 }
1245
Xiaokang Qian64bc9bc2023-02-07 02:32:23 +00001246 /*
1247 * Early data are going to be encrypted using the ciphersuite
1248 * associated with the pre-shared key used for the handshake.
1249 * Note that if the server rejects early data, the handshake
1250 * based on the pre-shared key may complete successfully
1251 * with a selected ciphersuite different from the ciphersuite
1252 * associated with the pre-shared key. Only the hashes of the
1253 * two ciphersuites have to be the same. In that case, the
1254 * encrypted handshake data and application data are
1255 * encrypted using a different ciphersuite than the one used for
1256 * the rejected early data.
1257 */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001258 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1259 ssl->session_negotiate->ciphersuite);
1260 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001261
Tom Cosgrove5c8505f2023-03-07 11:39:52 +00001262 /* Enable psk and psk_ephemeral to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001263 ssl->handshake->key_exchange_mode =
1264 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1265
1266 /* Start the TLS 1.3 key schedule:
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001267 * Set the PSK and derive early secret.
Xiaokang Qian126929f2023-01-03 10:29:41 +00001268 */
1269 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1270 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001271 MBEDTLS_SSL_DEBUG_RET(
1272 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001273 return ret;
1274 }
1275
1276 /* Derive early data key material */
1277 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1278 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001279 MBEDTLS_SSL_DEBUG_RET(
1280 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001281 return ret;
1282 }
1283
Xiaokang Qian126929f2023-01-03 10:29:41 +00001284 }
1285#endif /* MBEDTLS_SSL_EARLY_DATA */
1286 return 0;
1287}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001288/*
Jerry Yu4a173382021-10-11 21:45:31 +08001289 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001290 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001291
Ronald Cronda41b382022-03-30 09:57:11 +02001292/**
1293 * \brief Detect if the ServerHello contains a supported_versions extension
1294 * or not.
1295 *
1296 * \param[in] ssl SSL context
1297 * \param[in] buf Buffer containing the ServerHello message
1298 * \param[in] end End of the buffer containing the ServerHello message
1299 *
1300 * \return 0 if the ServerHello does not contain a supported_versions extension
1301 * \return 1 if the ServerHello contains a supported_versions extension
1302 * \return A negative value if an error occurred while parsing the ServerHello.
1303 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001304MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001305static int ssl_tls13_is_supported_versions_ext_present(
1306 mbedtls_ssl_context *ssl,
1307 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001308 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001309{
1310 const unsigned char *p = buf;
1311 size_t legacy_session_id_echo_len;
Ronald Croneff56732023-04-03 17:36:31 +02001312 const unsigned char *supported_versions_data;
1313 const unsigned char *supported_versions_data_end;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001314
1315 /*
1316 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001317 * length:
1318 * - legacy_version 2 bytes
1319 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1320 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001323 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1324 legacy_session_id_echo_len = *p;
1325
1326 /*
1327 * Jump to the extensions, jumping over:
1328 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1329 * - cipher_suite 2 bytes
1330 * - legacy_compression_method 1 byte
1331 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1333 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001334
Ronald Cron47dce632023-02-08 17:38:29 +01001335 return mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1336 ssl, p, end,
Ronald Croneff56732023-04-03 17:36:31 +02001337 &supported_versions_data, &supported_versions_data_end);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001338}
1339
Jerry Yu7a186a02021-10-15 18:46:14 +08001340/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001341 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1342 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1343 * - 0 otherwise
1344 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001345MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001346static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1347 const unsigned char *buf,
1348 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001349{
1350 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1351 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001353 const unsigned char *last_eight_bytes_of_random;
1354 unsigned char last_byte_of_random;
1355
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001357 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1358
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 if (memcmp(last_eight_bytes_of_random,
1360 magic_downgrade_string,
1361 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001362 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 return last_byte_of_random == 0 ||
1364 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001365 }
1366
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001368}
1369
1370/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001371 * - SSL_SERVER_HELLO or
1372 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001373 * to indicate which message is expected and to be parsed next.
1374 */
Ronald Cron828aff62022-05-31 12:04:31 +02001375#define SSL_SERVER_HELLO 0
1376#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001377MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001378static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1379 const unsigned char *buf,
1380 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001381{
Jerry Yue1b9c292021-09-10 10:08:31 +08001382
1383 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1384 *
Jerry Yu4a173382021-10-11 21:45:31 +08001385 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001386 * special value of the SHA-256 of "HelloRetryRequest".
1387 *
1388 * struct {
1389 * ProtocolVersion legacy_version = 0x0303;
1390 * Random random;
1391 * opaque legacy_session_id_echo<0..32>;
1392 * CipherSuite cipher_suite;
1393 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001394 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001395 * } ServerHello;
1396 *
1397 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001398 MBEDTLS_SSL_CHK_BUF_READ_PTR(
1399 buf, end, 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1402 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1403 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001404 }
1405
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001407}
1408
Ronald Cron828aff62022-05-31 12:04:31 +02001409/*
Jerry Yu745bb612021-10-13 22:01:04 +08001410 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001411 * - SSL_SERVER_HELLO or
1412 * - SSL_SERVER_HELLO_HRR or
1413 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001414 */
Ronald Cron828aff62022-05-31 12:04:31 +02001415#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001416MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001417static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1418 const unsigned char *buf,
1419 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001420{
Jerry Yu4a173382021-10-11 21:45:31 +08001421 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001422 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1425 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001426
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001428 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001430
1431 /* If the server is negotiating TLS 1.2 or below and:
1432 * . we did not propose TLS 1.2 or
1433 * . the server responded it is TLS 1.3 capable but negotiating a lower
1434 * version of the protocol and thus we are under downgrade attack
1435 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001436 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1438 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1439 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1440 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001441 }
1442
Ronald Cronb828c7d2023-04-03 16:37:22 +02001443 /*
1444 * Version 1.2 of the protocol has been negotiated, set the
1445 * ssl->keep_current_message flag for the ServerHello to be kept and
1446 * parsed as a TLS 1.2 ServerHello. We also change ssl->tls_version to
1447 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1448 * will dispatch to the TLS 1.2 state machine.
1449 */
Ronald Cron9f0fba32022-02-10 16:45:15 +01001450 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001451 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001452 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1453 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1454 buf, (size_t) (end - buf)));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001455
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1457 ret = ssl_tls13_reset_key_share(ssl);
1458 if (ret != 0) {
1459 return ret;
1460 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001461 }
1462
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001464 }
1465
Jerry Yua66fece2022-07-13 14:30:29 +08001466#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1467 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1468 ssl->session_negotiate->tls_version = ssl->tls_version;
1469#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1470
Jerry Yu50e00e32022-10-31 14:45:01 +08001471 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001472
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1474 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001475 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001477 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001478 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001479 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001480 /* If a client receives a second HelloRetryRequest in the same
1481 * connection (i.e., where the ClientHello was itself in response
1482 * to a HelloRetryRequest), it MUST abort the handshake with an
1483 * "unexpected_message" alert.
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 */
1485 if (handshake->hello_retry_request_count > 0) {
1486 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001487 MBEDTLS_SSL_PEND_FATAL_ALERT(
1488 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1489 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001491 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001492 /*
1493 * Clients must abort the handshake with an "illegal_parameter"
1494 * alert if the HelloRetryRequest would not result in any change
1495 * in the ClientHello.
1496 * In a PSK only key exchange that what we expect.
1497 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1499 MBEDTLS_SSL_DEBUG_MSG(1,
1500 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001501 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1503 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1504 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001505 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001506
Ronald Cron5afb9042022-05-31 12:11:39 +02001507 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001508
Jerry Yu745bb612021-10-13 22:01:04 +08001509 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001510 }
1511
1512cleanup:
1513
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001515}
1516
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001517MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001518static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1519 const unsigned char **buf,
1520 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001521{
1522 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001523 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1526 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001527
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001529
1530 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1532 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1533 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1534 ssl->session_negotiate->id,
1535 ssl->session_negotiate->id_len);
1536 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1537 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001538
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1540 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001541
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001543 }
1544
Jerry Yu4a173382021-10-11 21:45:31 +08001545 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001546 *buf = p;
1547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1549 ssl->session_negotiate->id_len);
1550 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001551}
1552
Jerry Yue1b9c292021-09-10 10:08:31 +08001553/* Parse ServerHello message and configure context
1554 *
1555 * struct {
1556 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1557 * Random random;
1558 * opaque legacy_session_id_echo<0..32>;
1559 * CipherSuite cipher_suite;
1560 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001561 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001562 * } ServerHello;
1563 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001564MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001565static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1566 const unsigned char *buf,
1567 const unsigned char *end,
1568 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001569{
Jerry Yub85277e2021-10-13 13:36:05 +08001570 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001571 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001572 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001573 size_t extensions_len;
1574 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001575 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001576 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001577 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001578 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001579 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001581
1582 /*
1583 * Check there is space for minimal fields
1584 *
1585 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001586 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001587 * - legacy_session_id_echo ( 1 byte ), minimum size
1588 * - cipher_suite ( 2 bytes)
1589 * - legacy_compression_method ( 1 byte )
1590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001592
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1594 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001595
Jerry Yu4a173382021-10-11 21:45:31 +08001596 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001597 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001598 * ...
1599 * with ProtocolVersion defined as:
1600 * uint16 ProtocolVersion;
1601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1603 MBEDTLS_SSL_VERSION_TLS1_2) {
1604 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1605 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1606 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001607 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1608 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001609 }
1610 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001611
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001612 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001613 * Random random;
1614 * ...
1615 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001616 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001617 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001618 if (!is_hrr) {
1619 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1620 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1621 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1622 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001623 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001624 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001625
Jerry Yu4a173382021-10-11 21:45:31 +08001626 /* ...
1627 * opaque legacy_session_id_echo<0..32>;
1628 * ...
1629 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001631 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001632 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001633 }
1634
Jerry Yu4a173382021-10-11 21:45:31 +08001635 /* ...
1636 * CipherSuite cipher_suite;
1637 * ...
1638 * with CipherSuite defined as:
1639 * uint8 CipherSuite[2];
1640 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1642 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001643 p += 2;
1644
Jerry Yu4a173382021-10-11 21:45:31 +08001645
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001647 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001648 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001649 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1651 ssl->tls_version,
1652 ssl->tls_version) != 0) ||
1653 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001654 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001655 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001656 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001657 * If we received an HRR before and that the proposed selected
1658 * ciphersuite in this server hello is not the same as the one
1659 * proposed in the HRR, we abort the handshake and send an
1660 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001661 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1663 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001664 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001665 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001666
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1668 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1669 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001670 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001671 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001672
Jerry Yu4a173382021-10-11 21:45:31 +08001673 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001675
XiaokangQian355e09a2022-01-20 11:14:50 +00001676 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1678 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001679
1680#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001681 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001682#endif /* MBEDTLS_HAVE_TIME */
1683
Jerry Yu4a173382021-10-11 21:45:31 +08001684 /* ...
1685 * uint8 legacy_compression_method = 0;
1686 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001687 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1689 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1690 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001691 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001692 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001693 }
1694 p++;
1695
Jerry Yub85277e2021-10-13 13:36:05 +08001696 /* ...
1697 * Extension extensions<6..2^16-1>;
1698 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001699 * struct {
1700 * ExtensionType extension_type; (2 bytes)
1701 * opaque extension_data<0..2^16-1>;
1702 * } Extension;
1703 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1705 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001706 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001707
Jerry Yu4a173382021-10-11 21:45:31 +08001708 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001710 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001711
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001713
Jerry Yu50e00e32022-10-31 14:45:01 +08001714 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001715 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1717 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001718
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001720 unsigned int extension_type;
1721 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001722 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001723
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1725 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1726 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001727 p += 4;
1728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001730 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001731
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001732 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1734 if (ret != 0) {
1735 return ret;
1736 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001739 case MBEDTLS_TLS_EXT_COOKIE:
1740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 ret = ssl_tls13_parse_cookie_ext(ssl,
1742 p, extension_data_end);
1743 if (ret != 0) {
1744 MBEDTLS_SSL_DEBUG_RET(1,
1745 "ssl_tls13_parse_cookie_ext",
1746 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001747 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001748 }
XiaokangQianb851da82022-01-14 04:03:11 +00001749 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001750
Jerry Yue1b9c292021-09-10 10:08:31 +08001751 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1753 p,
1754 extension_data_end);
1755 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001756 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001758 break;
1759
Ronald Cron41a443a2022-10-04 16:38:25 +02001760#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001761 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001763
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1765 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001766 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1768 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001769 }
1770 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001771#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001772
Jerry Yue1b9c292021-09-10 10:08:31 +08001773 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1775 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001776 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001777 goto cleanup;
1778 }
1779
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 if (is_hrr) {
1781 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1782 p, extension_data_end);
1783 } else {
1784 ret = ssl_tls13_parse_key_share_ext(ssl,
1785 p, extension_data_end);
1786 }
1787 if (ret != 0) {
1788 MBEDTLS_SSL_DEBUG_RET(1,
1789 "ssl_tls13_parse_key_share_ext",
1790 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001791 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001792 }
1793 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001794
1795 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001796 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1797 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001798 }
1799
1800 p += extension_data_len;
1801 }
1802
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001804
XiaokangQiand59be772022-01-24 10:12:51 +00001805cleanup:
1806
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1808 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1809 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001810 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1812 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1813 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001814 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1815 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001817}
1818
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001819#if defined(MBEDTLS_DEBUG_C)
1820static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001821{
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001823 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1824 return "psk";
1825 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1826 return "ephemeral";
1827 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1828 return "psk_ephemeral";
1829 default:
1830 return "unknown mode";
1831 }
1832}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001833#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001834
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001835MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001836static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001837{
Jerry Yub85277e2021-10-13 13:36:05 +08001838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001839 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001840
Jerry Yub85277e2021-10-13 13:36:05 +08001841 /* Determine the key exchange mode:
1842 * 1) If both the pre_shared_key and key_share extensions were received
1843 * then the key exchange mode is PSK with EPHEMERAL.
1844 * 2) If only the pre_shared_key extension was received then the key
1845 * exchange mode is PSK-only.
1846 * 3) If only the key_share extension was received then the key
1847 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 switch (handshake->received_extensions &
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001850 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1851 MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001852 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001854 handshake->key_exchange_mode =
1855 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001856 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001857
Jerry Yu745bb612021-10-13 22:01:04 +08001858 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001860 handshake->key_exchange_mode =
1861 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001862 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001863
Jerry Yu745bb612021-10-13 22:01:04 +08001864 /* Both the pre_shared_key and key_share extensions were received */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001865 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1866 MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
1867 handshake->key_exchange_mode =
1868 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001869 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001870
Jerry Yu745bb612021-10-13 22:01:04 +08001871 /* Neither pre_shared_key nor key_share extension was received */
1872 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001874 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1875 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001876 }
1877
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001878 if (!mbedtls_ssl_conf_tls13_check_kex_modes(
1879 ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001880 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001881 MBEDTLS_SSL_DEBUG_MSG(
1882 2, ("Key exchange mode(%s) is not supported.",
1883 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001884 goto cleanup;
1885 }
1886
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001887 MBEDTLS_SSL_DEBUG_MSG(
1888 3, ("Selected key exchange mode: %s",
1889 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001890
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001891 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001892 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001893 * If we proposed early data then we have already derived an
1894 * early secret using the selected PSK and its associated hash.
1895 * It means that if the negotiated key exchange mode is psk or
1896 * psk_ephemeral, we have already correctly computed the
1897 * early secret and thus we do not do it again. In all other
1898 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001899 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001900#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001901 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1902 handshake->key_exchange_mode ==
1903 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001904#endif
1905 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001906 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1907 if (ret != 0) {
1908 MBEDTLS_SSL_DEBUG_RET(
1909 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1910 goto cleanup;
1911 }
Jerry Yu0b177842021-09-05 19:41:30 +08001912 }
1913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1915 if (ret != 0) {
1916 MBEDTLS_SSL_DEBUG_RET(1,
1917 "mbedtls_ssl_tls13_compute_handshake_transform",
1918 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001919 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001920 }
1921
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1923 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001924 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
Jerry Yu0b177842021-09-05 19:41:30 +08001925 ssl->session_in = ssl->session_negotiate;
1926
Jerry Yu4a173382021-10-11 21:45:31 +08001927cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001929 MBEDTLS_SSL_PEND_FATAL_ALERT(
1930 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001932 }
Jerry Yue110d252022-05-05 10:19:22 +08001933
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001935}
1936
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001937MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001938static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00001939{
1940 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1941
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00001943
XiaokangQian78b1fa72022-01-19 06:56:30 +00001944 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001945 * We are going to re-generate a shared secret corresponding to the group
1946 * selected by the server, which is different from the group for which we
1947 * generated a shared secret in the first client hello.
1948 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001949 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 ret = ssl_tls13_reset_key_share(ssl);
1951 if (ret != 0) {
1952 return ret;
1953 }
XiaokangQian647719a2021-12-07 09:16:29 +00001954
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001955 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00001957}
1958
Jerry Yue1b9c292021-09-10 10:08:31 +08001959/*
Jerry Yu4a173382021-10-11 21:45:31 +08001960 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001961 * Handler for MBEDTLS_SSL_SERVER_HELLO
1962 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001963MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001964static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08001965{
Jerry Yu4a173382021-10-11 21:45:31 +08001966 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001967 unsigned char *buf = NULL;
1968 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001969 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001970
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08001972
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001973 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1974 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02001975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
1977 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00001978 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 } else {
1980 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
1981 }
XiaokangQiand59be772022-01-24 10:12:51 +00001982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01001984 ret = 0;
1985 goto cleanup;
1986 }
1987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
1989 buf + buf_len,
1990 is_hrr));
1991 if (is_hrr) {
1992 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02001993 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001994
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001995 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1996 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01001997
1998 if (is_hrr) {
1999 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2000#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2001 /* If not offering early data, the client sends a dummy CCS record
2002 * immediately before its second flight. This may either be before
2003 * its second ClientHello or before its encrypted handshake flight.
2004 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002005 mbedtls_ssl_handshake_set_state(
2006 ssl, MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
Gilles Peskine449bd832023-01-11 14:50:10 +01002007#else
2008 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2009#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2010 } else {
2011 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2012 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002013 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002014
2015cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2017 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2018 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002019}
2020
2021/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002022 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002023 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002024 *
2025 * The EncryptedExtensions message contains any extensions which
2026 * should be protected, i.e., any which are not needed to establish
2027 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002028 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002029
XiaokangQian08da26c2021-10-09 10:12:11 +00002030/* Parse EncryptedExtensions message
2031 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002032 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002033 * } EncryptedExtensions;
2034 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002035MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002036static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2037 const unsigned char *buf,
2038 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002039{
2040 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002041 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002042 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002043 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002044 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002045
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2047 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002048 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002049
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002051 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002052
Jan Bruckner5a3629b2023-02-23 12:08:09 +01002053 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2054
Jerry Yu9eba7502022-10-31 13:46:16 +08002055 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002058 unsigned int extension_type;
2059 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002060
XiaokangQian08da26c2021-10-09 10:12:11 +00002061 /*
2062 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002063 * ExtensionType extension_type; (2 bytes)
2064 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002065 * } Extension;
2066 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2068 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2069 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002070 p += 4;
2071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002073
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002074 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2076 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2077 if (ret != 0) {
2078 return ret;
2079 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002080
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002082#if defined(MBEDTLS_SSL_ALPN)
2083 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002085
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002086 if ((ret = ssl_tls13_parse_alpn_ext(
2087 ssl, p, (size_t) extension_data_len)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002089 }
2090
2091 break;
2092#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002093
2094#if defined(MBEDTLS_SSL_EARLY_DATA)
2095 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002098 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2100 MBEDTLS_ERR_SSL_DECODE_ERROR);
2101 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002102 }
2103
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002104 break;
2105#endif /* MBEDTLS_SSL_EARLY_DATA */
2106
Jan Bruckner151f6422023-02-10 12:45:19 +01002107#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2108 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
2109 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
2110
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002111 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
2112 ssl, p, p + extension_data_len);
Jan Bruckner151f6422023-02-10 12:45:19 +01002113
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002114 /* TODO: Return unconditionally here until we handle the record
2115 * size limit correctly. Once handled correctly, only return in
2116 * case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01002117 return ret;
2118
2119 break;
2120#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2121
XiaokangQian08da26c2021-10-09 10:12:11 +00002122 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002123 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002124 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002126 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002127 }
2128
XiaokangQian08da26c2021-10-09 10:12:11 +00002129 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002130 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2133 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002134
XiaokangQian97799ac2021-10-11 10:05:54 +00002135 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 if (p != end) {
2137 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2138 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2139 MBEDTLS_ERR_SSL_DECODE_ERROR);
2140 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002141 }
2142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002144}
2145
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002146MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002147static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002148{
2149 int ret;
2150 unsigned char *buf;
2151 size_t buf_len;
Jerry Yu960b7eb2023-10-31 16:40:01 +08002152#if defined(MBEDTLS_SSL_EARLY_DATA)
2153 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
2154#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002157
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002158 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2159 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2160 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002161
2162 /* Process the message contents */
2163 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002165
Xiaokang Qianb157e912022-11-23 08:12:26 +00002166#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu960b7eb2023-10-31 16:40:01 +08002167 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
2168 /* RFC8446 4.2.11
2169 * If the server supplies an "early_data" extension, the
2170 * client MUST verify that the server's selected_identity
2171 * is 0. If any other value is returned, the client MUST
2172 * abort the handshake with an "illegal_parameter" alert.
2173 *
2174 * RFC 8446 4.2.10
2175 * In order to accept early data, the server MUST have accepted a PSK
2176 * cipher suite and selected the first key offered in the client's
2177 * "pre_shared_key" extension. In addition, it MUST verify that the
2178 * following values are the same as those associated with the
2179 * selected PSK:
2180 * - The TLS version number
2181 * - The selected cipher suite
2182 * - The selected ALPN [RFC7301] protocol, if any
2183 *
2184 * We check here that when early data is involved the server
2185 * selected the cipher suite associated to the pre-shared key
2186 * as it must have.
2187 */
2188 if (handshake->selected_identity != 0 ||
2189 handshake->ciphersuite_info->id !=
2190 ssl->session_negotiate->ciphersuite) {
2191
2192 MBEDTLS_SSL_PEND_FATAL_ALERT(
2193 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
2194 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
2195 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
2196 }
2197
Xiaokang Qianb157e912022-11-23 08:12:26 +00002198 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2199 }
2200#endif
2201
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002202 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2203 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2204 buf, buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002205
Ronald Cron928cbd32022-10-04 16:14:26 +02002206#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2208 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2209 } else {
2210 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2211 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002212#else
2213 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002215#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002216
2217cleanup:
2218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2220 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002221
2222}
2223
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002224/*
2225 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2226 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002227 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002228 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002229 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002230 *
2231 * If the server sent an "early_data" extension in EncryptedExtensions, the
2232 * client MUST send an EndOfEarlyData message after receiving the server
2233 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002234 */
2235
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002236MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002237static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2238{
2239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002240 unsigned char *buf = NULL;
2241 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002242 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002243
Xiaokang Qian742578c2022-12-19 06:34:44 +00002244 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
Xiaokang Qian0de0d862023-02-08 06:04:50 +00002245 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
2246 &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002247
Manuel Pégourié-Gonnard63e33dd2023-02-21 15:45:15 +01002248 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_hdr_to_checksum(
2249 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002250
Xiaokang Qian742578c2022-12-19 06:34:44 +00002251 MBEDTLS_SSL_PROC_CHK(
2252 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002253
Xiaokang Qian19d44162023-01-03 03:39:50 +00002254 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002255
2256cleanup:
2257
2258 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2259 return ret;
2260}
2261
Ronald Cron928cbd32022-10-04 16:14:26 +02002262#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002263/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002264 * STATE HANDLING: CertificateRequest
2265 *
Jerry Yud2674312021-10-29 10:08:19 +08002266 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002267#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2268#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002269/* Coordination:
2270 * Deals with the ambiguity of not knowing if a CertificateRequest
2271 * will be sent. Returns a negative code on failure, or
2272 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2273 * - SSL_CERTIFICATE_REQUEST_SKIP
2274 * indicating if a Certificate Request is expected or not.
2275 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002276MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002277static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002278{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002279 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002280
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2282 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2283 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002284 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002285 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2288 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2289 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2290 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002291 }
2292
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002294
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002296}
2297
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002298/*
2299 * ssl_tls13_parse_certificate_request()
2300 * Parse certificate request
2301 * struct {
2302 * opaque certificate_request_context<0..2^8-1>;
2303 * Extension extensions<2..2^16-1>;
2304 * } CertificateRequest;
2305 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002306MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002307static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2308 const unsigned char *buf,
2309 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002310{
2311 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2312 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002313 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002314 size_t extensions_len = 0;
2315 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002316 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002317
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002318 /* ...
2319 * opaque certificate_request_context<0..2^8-1>
2320 * ...
2321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002323 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002324 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 if (certificate_request_context_len > 0) {
2327 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2328 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2329 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002330
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002331 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 mbedtls_calloc(1, certificate_request_context_len);
2333 if (handshake->certificate_request_context == NULL) {
2334 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2335 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002336 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 memcpy(handshake->certificate_request_context, p,
2338 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002339 p += certificate_request_context_len;
2340 }
2341
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002342 /* ...
2343 * Extension extensions<2..2^16-1>;
2344 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002345 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2347 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002348 p += 2;
2349
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002351 extensions_end = p + extensions_len;
2352
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002353 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002354
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002356 unsigned int extension_type;
2357 size_t extension_data_len;
2358
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2360 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2361 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002362 p += 4;
2363
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002365
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002366 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2368 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2369 if (ret != 0) {
2370 return ret;
2371 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002374 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 MBEDTLS_SSL_DEBUG_MSG(3,
2376 ("found signature algorithms extension"));
2377 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2378 p + extension_data_len);
2379 if (ret != 0) {
2380 return ret;
2381 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002382
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002383 break;
2384
2385 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002386 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002387 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002389 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002390 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002391
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002392 p += extension_data_len;
2393 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2396 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002397
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002398 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 if (p != end) {
2400 MBEDTLS_SSL_DEBUG_MSG(1,
2401 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002402 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002403 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002404
Jerry Yu0c354a22022-08-29 15:25:36 +08002405 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002406 *
2407 * The "signature_algorithms" extension MUST be specified
2408 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2410 MBEDTLS_SSL_DEBUG_MSG(3,
2411 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002412 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002413 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002414
Jerry Yu7840f812022-01-29 10:26:51 +08002415 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002417
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002418decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2420 MBEDTLS_ERR_SSL_DECODE_ERROR);
2421 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002422}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002423
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002424/*
2425 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2426 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002427MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002428static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002429{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002430 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002431
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002433
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002435
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002437 unsigned char *buf;
2438 size_t buf_len;
2439
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002440 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2441 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2442 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002443
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002444 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(
2445 ssl, buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002446
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002447 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2448 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2449 buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002451 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 } else {
2453 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002454 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2455 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002456 }
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002459
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002460cleanup:
2461
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2463 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002464}
2465
2466/*
Jerry Yu687101b2021-09-14 16:03:56 +08002467 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2468 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002469MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002470static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002471{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002472 int ret;
2473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2475 if (ret != 0) {
2476 return ret;
2477 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2480 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002481}
2482
2483/*
2484 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2485 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002486MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002487static int ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002488{
Jerry Yu30b071c2021-09-12 20:16:03 +08002489 int ret;
2490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2492 if (ret != 0) {
2493 return ret;
2494 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2497 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002498}
Ronald Cron928cbd32022-10-04 16:14:26 +02002499#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002500
Jerry Yu687101b2021-09-14 16:03:56 +08002501/*
2502 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2503 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002504MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002505static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002506{
XiaokangQianac0385c2021-11-03 06:40:11 +00002507 int ret;
2508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2510 if (ret != 0) {
2511 return ret;
2512 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2515 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002516 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2518 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2519 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002520 }
2521
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002522#if defined(MBEDTLS_SSL_EARLY_DATA)
2523 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2524 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002525 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2526 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002527 } else
2528#endif /* MBEDTLS_SSL_EARLY_DATA */
2529 {
2530#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2531 mbedtls_ssl_handshake_set_state(
2532 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2533#else
2534 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2535#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2536 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002537
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002539}
2540
2541/*
Jerry Yu566c7812022-01-26 15:41:22 +08002542 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2543 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002544MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002545static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002546{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002547 int non_empty_certificate_msg = 0;
2548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 MBEDTLS_SSL_DEBUG_MSG(1,
2550 ("Switch to handshake traffic keys for outbound traffic"));
2551 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002552
Ronald Cron928cbd32022-10-04 16:14:26 +02002553#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 if (ssl->handshake->client_auth) {
2555 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2556 if (ret != 0) {
2557 return ret;
2558 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002561 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 }
2563 } else {
2564 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002565 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002566#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 if (non_empty_certificate_msg) {
2569 mbedtls_ssl_handshake_set_state(ssl,
2570 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2571 } else {
2572 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2573 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2574 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002577}
2578
Ronald Cron928cbd32022-10-04 16:14:26 +02002579#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002580/*
2581 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2582 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002583MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002584static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002585{
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 if (ret == 0) {
2589 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2590 }
Ronald Crona8b38872022-03-09 07:59:25 +01002591
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002593}
Ronald Cron928cbd32022-10-04 16:14:26 +02002594#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002595
2596/*
Jerry Yu687101b2021-09-14 16:03:56 +08002597 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2598 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002599MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002600static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002601{
XiaokangQian0fa66432021-11-15 03:33:57 +00002602 int ret;
2603
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2605 if (ret != 0) {
2606 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002607 }
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2610 if (ret != 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002611 MBEDTLS_SSL_DEBUG_RET(
2612 1, "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 return ret;
2614 }
2615
2616 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2617 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002618}
2619
2620/*
2621 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2622 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002623MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002624static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002625{
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2627 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2628 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002629}
2630
2631/*
2632 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2633 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002634MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002635static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002636{
Jerry Yu378254d2021-10-30 21:44:47 +08002637
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2641 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002642}
2643
Jerry Yuf8a49942022-07-07 11:32:32 +00002644#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2645
Jerry Yua0446a02022-07-13 11:22:55 +08002646MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002647static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2648 const unsigned char *buf,
2649 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002650{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002651 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002652 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002653
Jerry Yuf8a49942022-07-07 11:32:32 +00002654
Jerry Yuedab6372022-10-31 14:37:31 +08002655 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002656
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002658 unsigned int extension_type;
2659 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002660 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2663 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2664 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002665 p += 4;
2666
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002668
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002669 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2671 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2672 if (ret != 0) {
2673 return ret;
2674 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002677#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002678 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002680 MBEDTLS_SSL_PEND_FATAL_ALERT(
2681 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 MBEDTLS_ERR_SSL_DECODE_ERROR);
2683 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002684 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002686 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002688 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002689 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002690#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002691
Jerry Yuf8a49942022-07-07 11:32:32 +00002692 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002693 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002694 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002696 break;
2697 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002698
Jerry Yuf8a49942022-07-07 11:32:32 +00002699 p += extension_data_len;
2700 }
2701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2703 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002706}
2707
2708/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002709 * From RFC8446, page 74
2710 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002711 * struct {
2712 * uint32 ticket_lifetime;
2713 * uint32 ticket_age_add;
2714 * opaque ticket_nonce<0..255>;
2715 * opaque ticket<1..2^16-1>;
2716 * Extension extensions<0..2^16-2>;
2717 * } NewSessionTicket;
2718 *
2719 */
Jerry Yua0446a02022-07-13 11:22:55 +08002720MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002721static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2722 unsigned char *buf,
2723 unsigned char *end,
2724 unsigned char **ticket_nonce,
2725 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002726{
2727 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2728 unsigned char *p = buf;
2729 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002730 size_t ticket_len;
2731 unsigned char *ticket;
2732 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002733
Jerry Yucb3b1392022-07-12 06:09:38 +00002734 *ticket_nonce = NULL;
2735 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002736 /*
2737 * ticket_lifetime 4 bytes
2738 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002739 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002740 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2744 MBEDTLS_SSL_DEBUG_MSG(3,
2745 ("ticket_lifetime: %u",
2746 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002747
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2749 MBEDTLS_SSL_DEBUG_MSG(3,
2750 ("ticket_age_add: %u",
2751 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002752
Jerry Yucb3b1392022-07-12 06:09:38 +00002753 *ticket_nonce_len = p[8];
2754 p += 9;
2755
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002757 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002759 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002760
2761 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2763 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002764 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2766 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002767
2768 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 if (session->ticket != NULL || session->ticket_len > 0) {
2770 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002771 session->ticket = NULL;
2772 session->ticket_len = 0;
2773 }
2774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2776 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2777 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002778 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002780 p += ticket_len;
2781 session->ticket = ticket;
2782 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002783
Pengyu Lv9f926952022-11-17 15:22:33 +08002784 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002785 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002786 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2789 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002790 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2796 if (ret != 0) {
2797 MBEDTLS_SSL_DEBUG_RET(1,
2798 "ssl_tls13_parse_new_session_ticket_exts",
2799 ret);
2800 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002801 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002802
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002803 /* session has been updated, allow export */
2804 session->exported = 0;
2805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002807}
2808
Jerry Yua0446a02022-07-13 11:22:55 +08002809MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002810static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2811 unsigned char *ticket_nonce,
2812 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002813{
2814 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2815 mbedtls_ssl_session *session = ssl->session;
2816 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2817 psa_algorithm_t psa_hash_alg;
2818 int hash_length;
2819
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002820#if defined(MBEDTLS_HAVE_TIME)
2821 /* Store ticket creation time */
Jerry Yucebffc32022-12-15 18:00:05 +08002822 session->ticket_received = mbedtls_ms_time();
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002823#endif
2824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2826 if (ciphersuite_info == NULL) {
2827 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2828 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002829 }
2830
Dave Rodgman2eab4622023-10-05 13:30:37 +01002831 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2833 if (hash_length == -1 ||
2834 (size_t) hash_length > sizeof(session->resumption_key)) {
2835 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002836 }
2837
Jerry Yuf8a49942022-07-07 11:32:32 +00002838
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2840 session->app_secrets.resumption_master_secret,
2841 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002842
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002843 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002844 *
2845 * HKDF-Expand-Label( resumption_master_secret,
2846 * "resumption", ticket_nonce, Hash.length )
2847 */
2848 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 psa_hash_alg,
2850 session->app_secrets.resumption_master_secret,
2851 hash_length,
2852 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2853 ticket_nonce,
2854 ticket_nonce_len,
2855 session->resumption_key,
2856 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (ret != 0) {
2859 MBEDTLS_SSL_DEBUG_RET(2,
2860 "Creating the ticket-resumed PSK failed",
2861 ret);
2862 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002863 }
2864
Jerry Yu0a430c82022-07-20 11:02:48 +08002865 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2868 session->resumption_key,
2869 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002870
Pengyu Lv9f926952022-11-17 15:22:33 +08002871 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002872 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002873 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002874 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002877}
2878
2879/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002880 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002881 */
Jerry Yua0446a02022-07-13 11:22:55 +08002882MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002883static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002884{
2885 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2886 unsigned char *buf;
2887 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002888 unsigned char *ticket_nonce;
2889 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2894 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2895 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2898 ssl, buf, buf + buf_len,
2899 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002900
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2902 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002903
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002905
Jerry Yuf8a49942022-07-07 11:32:32 +00002906cleanup:
2907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2909 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002910}
2911#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002914{
Jerry Yu92c6b402021-08-27 16:59:09 +08002915 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002916
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002918 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002920 break;
2921
Jerry Yu92c6b402021-08-27 16:59:09 +08002922 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002924 break;
2925
2926 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002928 break;
2929
2930 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002932 break;
2933
Ronald Cron928cbd32022-10-04 16:14:26 +02002934#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002935 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002937 break;
2938
Jerry Yu687101b2021-09-14 16:03:56 +08002939 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002941 break;
2942
2943 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002945 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002946#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002947
2948 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002950 break;
2951
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002952 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2953 ret = ssl_tls13_write_end_of_early_data(ssl);
2954 break;
2955
Jerry Yu566c7812022-01-26 15:41:22 +08002956 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002958 break;
2959
Ronald Cron928cbd32022-10-04 16:14:26 +02002960#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002961 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002963 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002964#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002965
Jerry Yu687101b2021-09-14 16:03:56 +08002966 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002968 break;
2969
2970 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002972 break;
2973
2974 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002976 break;
2977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 /*
2979 * Injection of dummy-CCS's for middlebox compatibility
2980 */
Ronald Cron49ad6192021-11-24 16:25:31 +01002981#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002982 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2984 if (ret == 0) {
2985 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2986 }
Ronald Cron9f55f632022-02-02 16:02:47 +01002987 break;
2988
2989 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2991 if (ret == 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002992 mbedtls_ssl_handshake_set_state(
2993 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002995 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00002996
Xiaokang Qian592021a2023-01-04 10:47:05 +00002997 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
2998 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2999 if (ret == 0) {
3000 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3001
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003002#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003003 MBEDTLS_SSL_DEBUG_MSG(
3004 1, ("Switch to early data keys for outbound traffic"));
3005 mbedtls_ssl_set_outbound_transform(
3006 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003007#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003008 }
3009 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003010#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3011
Jerry Yuf8a49942022-07-07 11:32:32 +00003012#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003013 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 ret = ssl_tls13_process_new_session_ticket(ssl);
3015 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003016 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003018 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3019 break;
3020#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3021
Jerry Yu92c6b402021-08-27 16:59:09 +08003022 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3024 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003025 }
3026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003028}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003029
Jerry Yufb4b6472022-01-27 15:03:26 +08003030#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */