blob: e06e4c91e5c508da5782e746b66a6d131d894bf1 [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 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02007 * This file is part of Mbed TLS ( https://tls.mbed.org )
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08008 */
9
10#include "common.h"
11
Jerry Yucc43c6b2022-01-28 10:24:45 +080012#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080013
Jerry Yubc20bdd2021-08-24 15:59:48 +080014#include <string.h>
15
Jerry Yu56fc07f2021-09-01 17:48:49 +080016#include "mbedtls/debug.h"
17#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080018#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080019
Jerry Yubdc71882021-09-14 19:30:36 +080020#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010021#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080022#include "ssl_tls13_keys.h"
Jerry Yucbd082f2022-08-04 16:55:10 +080023#include "ssl_debug_helpers.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020024#include "md_psa.h"
Jerry Yubdc71882021-09-14 19:30:36 +080025
Valerio Settic9ae8622023-07-25 11:23:50 +020026#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Andrzej Kurek00644842023-05-30 05:45:00 -040027/* Define a local translating function to save code size by not using too many
28 * arguments in each translating place. */
29static int local_err_translation(psa_status_t status)
30{
31 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040032 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040033 psa_generic_status_to_mbedtls);
34}
35#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kureka6033ac2023-05-30 15:16:34 -040036#endif
37
Jerry Yubc20bdd2021-08-24 15:59:48 +080038/* Write extensions */
39
Jerry Yu92c6b402021-08-27 16:59:09 +080040/*
41 * ssl_tls13_write_supported_versions_ext():
42 *
43 * struct {
44 * ProtocolVersion versions<2..254>;
45 * } SupportedVersions;
46 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020047MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010048static int ssl_tls13_write_supported_versions_ext(mbedtls_ssl_context *ssl,
49 unsigned char *buf,
50 unsigned char *end,
51 size_t *out_len)
Jerry Yu92c6b402021-08-27 16:59:09 +080052{
53 unsigned char *p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +010054 unsigned char versions_len = (ssl->handshake->min_tls_version <=
55 MBEDTLS_SSL_VERSION_TLS1_2) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080056
Xiaofei Baid25fab62021-12-02 06:36:27 +000057 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080058
Gilles Peskine449bd832023-01-11 14:50:10 +010059 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding supported versions extension"));
Jerry Yu92c6b402021-08-27 16:59:09 +080060
Jerry Yu388bd0d2021-09-15 18:41:02 +080061 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080062 * - extension_type (2 bytes)
63 * - extension_data_length (2 bytes)
64 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020065 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080066 */
Gilles Peskine449bd832023-01-11 14:50:10 +010067 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 5 + versions_len);
Ronald Crondbe87f02022-02-10 14:35:27 +010068
Gilles Peskine449bd832023-01-11 14:50:10 +010069 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0);
70 MBEDTLS_PUT_UINT16_BE(versions_len + 1, p, 2);
Jerry Yueecfbf02021-08-30 18:32:07 +080071 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080072
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080073 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010074 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080075
Jerry Yu0c63af62021-09-02 12:59:12 +080076 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080077 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010078 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080079 */
Gilles Peskine449bd832023-01-11 14:50:10 +010080 mbedtls_ssl_write_version(p, MBEDTLS_SSL_TRANSPORT_STREAM,
81 MBEDTLS_SSL_VERSION_TLS1_3);
82 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:4]"));
Jerry Yu92c6b402021-08-27 16:59:09 +080083
Jerry Yu92c6b402021-08-27 16:59:09 +080084
Gilles Peskine449bd832023-01-11 14:50:10 +010085 if (ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
86 mbedtls_ssl_write_version(p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
87 MBEDTLS_SSL_VERSION_TLS1_2);
88 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [3:3]"));
Ronald Crondbe87f02022-02-10 14:35:27 +010089 }
90
91 *out_len = 5 + versions_len;
Jerry Yu4b8f2f72022-10-31 13:31:22 +080092
Jerry Yuc4bf5d62022-10-29 09:08:47 +080093 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +010094 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yu4b8f2f72022-10-31 13:31:22 +080095
Gilles Peskine449bd832023-01-11 14:50:10 +010096 return 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080097}
Jerry Yubc20bdd2021-08-24 15:59:48 +080098
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020099MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100100static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
101 const unsigned char *buf,
102 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800103{
Jerry Yue1b9c292021-09-10 10:08:31 +0800104 ((void) ssl);
105
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
107 if (mbedtls_ssl_read_version(buf, ssl->conf->transport) !=
108 MBEDTLS_SSL_VERSION_TLS1_3) {
109 MBEDTLS_SSL_DEBUG_MSG(1, ("unexpected version"));
Jerry Yu4a173382021-10-11 21:45:31 +0800110
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
112 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
113 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +0800114 }
115
Gilles Peskine449bd832023-01-11 14:50:10 +0100116 if (&buf[2] != end) {
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000117 MBEDTLS_SSL_DEBUG_MSG(
118 1, ("supported_versions ext data length incorrect"));
Gilles Peskine449bd832023-01-11 14:50:10 +0100119 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
120 MBEDTLS_ERR_SSL_DECODE_ERROR);
121 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Ronald Cron98473382022-03-30 20:04:10 +0200122 }
123
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +0800125}
126
lhuang0486cacac2022-01-21 07:34:27 -0800127#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200128MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100129static int ssl_tls13_parse_alpn_ext(mbedtls_ssl_context *ssl,
130 const unsigned char *buf, size_t len)
lhuang0486cacac2022-01-21 07:34:27 -0800131{
lhuang0486cacac2022-01-21 07:34:27 -0800132 const unsigned char *p = buf;
133 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200134 size_t protocol_name_list_len, protocol_name_len;
135 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800136
137 /* If we didn't send it, the server shouldn't send it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100138 if (ssl->conf->alpn_list == NULL) {
139 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
140 }
lhuang0486cacac2022-01-21 07:34:27 -0800141
142 /*
143 * opaque ProtocolName<1..2^8-1>;
144 *
145 * struct {
146 * ProtocolName protocol_name_list<2..2^16-1>
147 * } ProtocolNameList;
148 *
149 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
150 */
151
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
153 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
lhuang0486cacac2022-01-21 07:34:27 -0800154 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800155
Gilles Peskine449bd832023-01-11 14:50:10 +0100156 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
Ronald Cron81a334f2022-05-31 16:04:11 +0200157 protocol_name_list_end = p + protocol_name_list_len;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, 1);
Ronald Cron81a334f2022-05-31 16:04:11 +0200160 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800161
162 /* Check that the server chosen protocol was in our list and save it */
Gilles Peskine449bd832023-01-11 14:50:10 +0100163 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end, protocol_name_len);
164 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
165 if (protocol_name_len == strlen(*alpn) &&
166 memcmp(p, *alpn, protocol_name_len) == 0) {
lhuang0486cacac2022-01-21 07:34:27 -0800167 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 return 0;
lhuang0486cacac2022-01-21 07:34:27 -0800169 }
170 }
171
Gilles Peskine449bd832023-01-11 14:50:10 +0100172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
lhuang0486cacac2022-01-21 07:34:27 -0800173}
174#endif /* MBEDTLS_SSL_ALPN */
175
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200176MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100177static int ssl_tls13_reset_key_share(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +0000178{
179 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100180
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 if (group_id == 0) {
182 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
183 }
XiaokangQian647719a2021-12-07 09:16:29 +0000184
Valerio Settic9ae8622023-07-25 11:23:50 +0200185#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200186 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200187 mbedtls_ssl_tls13_named_group_is_ffdh(group_id)) {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100188 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
189 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
190
191 /* Destroy generated private key. */
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200192 status = psa_destroy_key(ssl->handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500194 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 MBEDTLS_SSL_DEBUG_RET(1, "psa_destroy_key", ret);
196 return ret;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100197 }
198
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200199 ssl->handshake->xxdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return 0;
201 } else
Valerio Settic9ae8622023-07-25 11:23:50 +0200202#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +0100203 if (0 /* other KEMs? */) {
XiaokangQian647719a2021-12-07 09:16:29 +0000204 /* Do something */
205 }
206
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQian647719a2021-12-07 09:16:29 +0000208}
209
210/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800211 * Functions for writing key_share extension.
212 */
Ronald Cron766c0cd2022-10-18 12:17:11 +0200213#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200214MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100215static int ssl_tls13_get_default_group_id(mbedtls_ssl_context *ssl,
216 uint16_t *group_id)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800217{
218 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
219
Jerry Yu56fc07f2021-09-01 17:48:49 +0800220
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200221#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100222 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Jerry Yu388bd0d2021-09-15 18:41:02 +0800223 /* Pick first available ECDHE group compatible with TLS 1.3 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100224 if (group_list == NULL) {
225 return MBEDTLS_ERR_SSL_BAD_CONFIG;
226 }
Jerry Yu388bd0d2021-09-15 18:41:02 +0800227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 for (; *group_list != 0; group_list++) {
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200229#if defined(PSA_WANT_ALG_ECDH)
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000230 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
231 *group_list, NULL, NULL) == PSA_SUCCESS) &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100232 mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
Brett Warren14efd332021-10-06 09:32:11 +0100233 *group_id = *group_list;
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 return 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800235 }
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200236#endif
237#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekield5f79e72023-06-29 09:08:43 +0200238 if (mbedtls_ssl_tls13_named_group_is_ffdh(*group_list)) {
Przemek Stekiela05e9c12023-06-15 16:58:51 +0200239 *group_id = *group_list;
240 return 0;
241 }
242#endif
Jerry Yu56fc07f2021-09-01 17:48:49 +0800243 }
244#else
245 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800246 ((void) group_id);
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200247#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800248
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800250}
251
252/*
253 * ssl_tls13_write_key_share_ext
254 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800255 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800256 *
257 * struct {
258 * NamedGroup group;
259 * opaque key_exchange<1..2^16-1>;
260 * } KeyShareEntry;
261 * struct {
262 * KeyShareEntry client_shares<0..2^16-1>;
263 * } KeyShareClientHello;
264 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200265MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100266static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
267 unsigned char *buf,
268 unsigned char *end,
269 size_t *out_len)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800270{
271 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000272 unsigned char *client_shares; /* Start of client_shares */
273 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800274 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800275 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
276
Xiaofei Baid25fab62021-12-02 06:36:27 +0000277 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800278
Jerry Yub60e3cf2021-09-08 16:41:02 +0800279 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800280 * - extension_type (2 bytes)
281 * - extension_data_length (2 bytes)
282 * - client_shares_length (2 bytes)
283 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800285 p += 6;
286
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello: adding key share extension"));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800288
289 /* HRR could already have requested something else. */
290 group_id = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 if (!mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) &&
Przemek Stekield5f79e72023-06-29 09:08:43 +0200292 !mbedtls_ssl_tls13_named_group_is_ffdh(group_id)) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 MBEDTLS_SSL_PROC_CHK(ssl_tls13_get_default_group_id(ssl,
294 &group_id));
Jerry Yu56fc07f2021-09-01 17:48:49 +0800295 }
296
297 /*
298 * Dispatch to type-specific key generation function.
299 *
300 * So far, we're only supporting ECDHE. With the introduction
301 * of PQC KEMs, we'll want to have multiple branches, one per
302 * type of KEM, and dispatch to the corresponding crypto. And
303 * only one key share entry is allowed.
304 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000305 client_shares = p;
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200306#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
307 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group_id) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200308 mbedtls_ssl_tls13_named_group_is_ffdh(group_id)) {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800309 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000310 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800311 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100312 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800313
314 /* Check there is space for header of KeyShareEntry
315 * - group (2 bytes)
316 * - key_exchange_length (2 bytes)
317 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800319 p += 4;
Przemek Stekiel408569f2023-07-06 11:26:44 +0200320 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 ssl, group_id, p, end, &key_exchange_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800322 p += key_exchange_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 if (ret != 0) {
324 return ret;
325 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800326
327 /* Write group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 MBEDTLS_PUT_UINT16_BE(group_id, group, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800329 /* Write key_exchange_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 MBEDTLS_PUT_UINT16_BE(key_exchange_len, group, 2);
331 } else
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200332#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (0 /* other KEMs? */) {
Jerry Yu56fc07f2021-09-01 17:48:49 +0800334 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 } else {
336 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800337 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800338
Jerry Yub60e3cf2021-09-08 16:41:02 +0800339 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000340 client_shares_len = p - client_shares;
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 if (client_shares_len == 0) {
342 MBEDTLS_SSL_DEBUG_MSG(1, ("No key share defined."));
343 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu7c522d42021-09-08 17:55:09 +0800344 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800345 /* Write extension_type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800347 /* Write extension_data_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 MBEDTLS_PUT_UINT16_BE(client_shares_len + 2, buf, 2);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800349 /* Write client_shares_length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 MBEDTLS_PUT_UINT16_BE(client_shares_len, buf, 4);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800351
352 /* Update offered_group_id field */
353 ssl->handshake->offered_group_id = group_id;
354
355 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000356 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800357
Xiaokang Qian91bb3f02023-04-03 09:07:03 +0000358 MBEDTLS_SSL_DEBUG_BUF(
359 3, "client hello, key_share extension", buf, *out_len);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800360
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800362
363cleanup:
364
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return ret;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800366}
Ronald Cron766c0cd2022-10-18 12:17:11 +0200367#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +0800368
XiaokangQiand59be772022-01-24 10:12:51 +0000369/*
370 * ssl_tls13_parse_hrr_key_share_ext()
371 * Parse key_share extension in Hello Retry Request
372 *
373 * struct {
374 * NamedGroup selected_group;
375 * } KeyShareHelloRetryRequest;
376 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200377MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100378static int ssl_tls13_parse_hrr_key_share_ext(mbedtls_ssl_context *ssl,
379 const unsigned char *buf,
380 const unsigned char *end)
XiaokangQianb851da82022-01-14 04:03:11 +0000381{
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200382#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQianb851da82022-01-14 04:03:11 +0000383 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000384 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000385 int found = 0;
386
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
388 if (group_list == NULL) {
389 return MBEDTLS_ERR_SSL_BAD_CONFIG;
390 }
XiaokangQianb851da82022-01-14 04:03:11 +0000391
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 MBEDTLS_SSL_DEBUG_BUF(3, "key_share extension", p, end - buf);
XiaokangQianb851da82022-01-14 04:03:11 +0000393
394 /* Read selected_group */
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
396 selected_group = MBEDTLS_GET_UINT16_BE(p, 0);
397 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_group ( %d )", selected_group));
XiaokangQianb851da82022-01-14 04:03:11 +0000398
399 /* Upon receipt of this extension in a HelloRetryRequest, the client
400 * MUST first verify that the selected_group field corresponds to a
401 * group which was provided in the "supported_groups" extension in the
402 * original ClientHello.
403 * The supported_group was based on the info in ssl->conf->group_list.
404 *
405 * If the server provided a key share that was not sent in the ClientHello
406 * then the client MUST abort the handshake with an "illegal_parameter" alert.
407 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100408 for (; *group_list != 0; group_list++) {
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200409#if defined(PSA_WANT_ALG_ECDH)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200410 if (mbedtls_ssl_tls13_named_group_is_ecdhe(*group_list)) {
411 if ((mbedtls_ssl_get_psa_curve_info_from_tls_id(
412 *group_list, NULL, NULL) == PSA_ERROR_NOT_SUPPORTED) ||
413 *group_list != selected_group) {
414 found = 1;
415 break;
416 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 }
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200418#endif /* PSA_WANT_ALG_ECDH */
419#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekield5f79e72023-06-29 09:08:43 +0200420 if (mbedtls_ssl_tls13_named_group_is_ffdh(*group_list)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200421 found = 1;
422 break;
423 }
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200424#endif /* PSA_WANT_ALG_FFDH */
XiaokangQianb851da82022-01-14 04:03:11 +0000425 }
426
427 /* Client MUST verify that the selected_group field does not
428 * correspond to a group which was provided in the "key_share"
429 * extension in the original ClientHello. If the server sent an
430 * HRR message with a key share already provided in the
431 * ClientHello then the client MUST abort the handshake with
432 * an "illegal_parameter" alert.
433 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 if (found == 0 || selected_group == ssl->handshake->offered_group_id) {
435 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid key share in HRR"));
XiaokangQianb851da82022-01-14 04:03:11 +0000436 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
438 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
439 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQianb851da82022-01-14 04:03:11 +0000440 }
441
442 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000443 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 return 0;
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200446#else /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400447 (void) ssl;
448 (void) buf;
449 (void) end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200451#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQianb851da82022-01-14 04:03:11 +0000452}
453
Jerry Yue1b9c292021-09-10 10:08:31 +0800454/*
Jerry Yub85277e2021-10-13 13:36:05 +0800455 * ssl_tls13_parse_key_share_ext()
456 * Parse key_share extension in Server Hello
457 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800458 * struct {
459 * KeyShareEntry server_share;
460 * } KeyShareServerHello;
461 * struct {
462 * NamedGroup group;
463 * opaque key_exchange<1..2^16-1>;
464 * } KeyShareEntry;
465 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200466MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100467static int ssl_tls13_parse_key_share_ext(mbedtls_ssl_context *ssl,
468 const unsigned char *buf,
469 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +0800470{
Jerry Yub85277e2021-10-13 13:36:05 +0800471 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800472 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800473 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800474
Jerry Yu4a173382021-10-11 21:45:31 +0800475 /* ...
476 * NamedGroup group; (2 bytes)
477 * ...
478 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
480 group = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +0800481 p += 2;
482
Jerry Yu4a173382021-10-11 21:45:31 +0800483 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800484 offered_group = ssl->handshake->offered_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 if (offered_group != group) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +0000486 MBEDTLS_SSL_DEBUG_MSG(
487 1, ("Invalid server key share, our group %u, their group %u",
488 (unsigned) offered_group, (unsigned) group));
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
490 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
491 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yue1b9c292021-09-10 10:08:31 +0800492 }
493
Valerio Settic9ae8622023-07-25 11:23:50 +0200494#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200495 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200496 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +0200497 MBEDTLS_SSL_DEBUG_MSG(2,
498 ("DHE group name: %s", mbedtls_ssl_named_group_to_str(group)));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200499 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(ssl, p, end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +0100500 if (ret != 0) {
501 return ret;
502 }
503 } else
Valerio Settic9ae8622023-07-25 11:23:50 +0200504#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 if (0 /* other KEMs? */) {
Jerry Yue1b9c292021-09-10 10:08:31 +0800506 /* Do something */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 } else {
508 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yue1b9c292021-09-10 10:08:31 +0800509 }
Jerry Yue1b9c292021-09-10 10:08:31 +0800510
Gilles Peskine449bd832023-01-11 14:50:10 +0100511 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +0800512}
513
XiaokangQiand59be772022-01-24 10:12:51 +0000514/*
515 * ssl_tls13_parse_cookie_ext()
516 * Parse cookie extension in Hello Retry Request
517 *
518 * struct {
519 * opaque cookie<1..2^16-1>;
520 * } Cookie;
521 *
522 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
523 * extension to the client (this is an exception to the usual rule that
524 * the only extensions that may be sent are those that appear in the
525 * ClientHello). When sending the new ClientHello, the client MUST copy
526 * the contents of the extension received in the HelloRetryRequest into
527 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
528 * cookies in their initial ClientHello in subsequent connections.
529 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200530MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100531static int ssl_tls13_parse_cookie_ext(mbedtls_ssl_context *ssl,
532 const unsigned char *buf,
533 const unsigned char *end)
XiaokangQian43550bd2022-01-21 04:32:58 +0000534{
XiaokangQian25c9c902022-02-08 10:49:53 +0000535 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000536 const unsigned char *p = buf;
537 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
538
539 /* Retrieve length field of cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
541 cookie_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian43550bd2022-01-21 04:32:58 +0000542 p += 2;
543
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cookie_len);
545 MBEDTLS_SSL_DEBUG_BUF(3, "cookie extension", p, cookie_len);
XiaokangQian43550bd2022-01-21 04:32:58 +0000546
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 mbedtls_free(handshake->cookie);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800548 handshake->cookie_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 handshake->cookie = mbedtls_calloc(1, cookie_len);
550 if (handshake->cookie == NULL) {
551 MBEDTLS_SSL_DEBUG_MSG(1,
552 ("alloc failed ( %ud bytes )",
553 cookie_len));
554 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
XiaokangQian43550bd2022-01-21 04:32:58 +0000555 }
556
Gilles Peskine449bd832023-01-11 14:50:10 +0100557 memcpy(handshake->cookie, p, cookie_len);
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800558 handshake->cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000559
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 return 0;
XiaokangQian43550bd2022-01-21 04:32:58 +0000561}
XiaokangQian43550bd2022-01-21 04:32:58 +0000562
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200563MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100564static int ssl_tls13_write_cookie_ext(mbedtls_ssl_context *ssl,
565 unsigned char *buf,
566 unsigned char *end,
567 size_t *out_len)
XiaokangQian0b64eed2022-01-27 10:36:51 +0000568{
569 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000570 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000571 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000572
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 if (handshake->cookie == NULL) {
574 MBEDTLS_SSL_DEBUG_MSG(3, ("no cookie to send; skip extension"));
575 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000576 }
577
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, cookie",
579 handshake->cookie,
580 handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000581
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 MBEDTLS_SSL_CHK_BUF_PTR(p, end, handshake->cookie_len + 6);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000583
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding cookie extension"));
XiaokangQian0b64eed2022-01-27 10:36:51 +0000585
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_COOKIE, p, 0);
587 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len + 2, p, 2);
588 MBEDTLS_PUT_UINT16_BE(handshake->cookie_len, p, 4);
XiaokangQian233397e2022-02-07 08:32:16 +0000589 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000590
591 /* Cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 memcpy(p, handshake->cookie, handshake->cookie_len);
XiaokangQian0b64eed2022-01-27 10:36:51 +0000593
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800594 *out_len = handshake->cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000595
Gilles Peskine449bd832023-01-11 14:50:10 +0100596 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_COOKIE);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800597
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 return 0;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000599}
600
Ronald Cron41a443a2022-10-04 16:38:25 +0200601#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000602/*
603 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
604 *
605 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
606 *
607 * struct {
608 * PskKeyExchangeMode ke_modes<1..255>;
609 * } PskKeyExchangeModes;
610 */
XiaokangQian86981952022-07-19 09:51:50 +0000611MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100612static int ssl_tls13_write_psk_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
613 unsigned char *buf,
614 unsigned char *end,
615 size_t *out_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000616{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000617 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000618 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000619
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 ((void) ke_modes_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000621 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000622
XiaokangQianeb69aee2022-07-05 08:21:43 +0000623 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000624 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000625 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100626 if (!mbedtls_ssl_conf_tls13_some_psk_enabled(ssl)) {
627 MBEDTLS_SSL_DEBUG_MSG(3, ("skip psk_key_exchange_modes extension"));
628 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000629 }
630
631 /* Require 7 bytes of data, otherwise fail,
632 * even if extension might be shorter.
633 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100634 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000635 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100636 3, ("client hello, adding psk_key_exchange_modes extension"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000637
Gilles Peskine449bd832023-01-11 14:50:10 +0100638 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000639
XiaokangQian008d2bf2022-07-14 07:54:01 +0000640 /* Skip extension length (2 bytes) and
641 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000642 */
643 p += 5;
644
Gilles Peskine449bd832023-01-11 14:50:10 +0100645 if (mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl)) {
XiaokangQianeb69aee2022-07-05 08:21:43 +0000646 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000647 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000648
Gilles Peskine449bd832023-01-11 14:50:10 +0100649 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding PSK-ECDHE key exchange mode"));
XiaokangQianeb69aee2022-07-05 08:21:43 +0000650 }
651
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (mbedtls_ssl_conf_tls13_psk_enabled(ssl)) {
Ronald Crona709a0f2022-09-27 16:46:11 +0200653 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
654 ke_modes_len++;
655
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 MBEDTLS_SSL_DEBUG_MSG(4, ("Adding pure PSK key exchange mode"));
Ronald Crona709a0f2022-09-27 16:46:11 +0200657 }
658
XiaokangQian008d2bf2022-07-14 07:54:01 +0000659 /* Now write the extension and ke_modes length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100660 MBEDTLS_PUT_UINT16_BE(ke_modes_len + 1, buf, 2);
XiaokangQian008d2bf2022-07-14 07:54:01 +0000661 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000662
663 *out_len = p - buf;
Jerry Yu0c354a22022-08-29 15:25:36 +0800664
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800665 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +0100666 ssl, MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800667
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000669}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg(int ciphersuite)
Jerry Yuf7c12592022-09-28 22:09:38 +0800672{
Jerry Yu21f90952022-10-08 10:30:53 +0800673 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800675
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 if (ciphersuite_info != NULL) {
Dave Rodgman2eab4622023-10-05 13:30:37 +0100677 return mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800679
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return PSA_ALG_NONE;
Jerry Yuf7c12592022-09-28 22:09:38 +0800681}
682
Jerry Yuf75364b2022-09-30 10:30:31 +0800683#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100684static int ssl_tls13_has_configured_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qianb781a232022-11-01 07:39:46 +0000685{
686 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return ssl->handshake->resume &&
Pengyu Lv93566782022-12-07 12:10:05 +0800688 session != NULL && session->ticket != NULL &&
Pengyu Lv9b84ea72023-01-16 14:08:23 +0800689 mbedtls_ssl_conf_tls13_check_kex_modes(
690 ssl, mbedtls_ssl_session_get_ticket_flags(
691 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL));
Xiaokang Qianb781a232022-11-01 07:39:46 +0000692}
693
Xiaokang Qian01323a42022-11-03 02:27:35 +0000694#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +0100695static int ssl_tls13_early_data_has_valid_ticket(mbedtls_ssl_context *ssl)
Xiaokang Qian01323a42022-11-03 02:27:35 +0000696{
697 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 return ssl->handshake->resume &&
699 session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
700 (session->ticket_flags &
701 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA) &&
702 mbedtls_ssl_tls13_cipher_suite_is_offered(
703 ssl, session->ciphersuite);
Xiaokang Qian01323a42022-11-03 02:27:35 +0000704}
705#endif
706
Xiaokang Qianb781a232022-11-01 07:39:46 +0000707MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100708static int ssl_tls13_ticket_get_identity(mbedtls_ssl_context *ssl,
709 psa_algorithm_t *hash_alg,
710 const unsigned char **identity,
711 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800712{
713 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800714
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 if (!ssl_tls13_has_configured_ticket(ssl)) {
716 return -1;
717 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800718
Gilles Peskine449bd832023-01-11 14:50:10 +0100719 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yuf7c12592022-09-28 22:09:38 +0800720 *identity = session->ticket;
721 *identity_len = session->ticket_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800723}
724
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800725MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100726static int ssl_tls13_ticket_get_psk(mbedtls_ssl_context *ssl,
727 psa_algorithm_t *hash_alg,
728 const unsigned char **psk,
729 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800730{
731
732 mbedtls_ssl_session *session = ssl->session_negotiate;
733
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 if (!ssl_tls13_has_configured_ticket(ssl)) {
735 return -1;
736 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800737
Gilles Peskine449bd832023-01-11 14:50:10 +0100738 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg(session->ciphersuite);
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800739 *psk = session->resumption_key;
740 *psk_len = session->resumption_key_len;
741
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800743}
Jerry Yuf7c12592022-09-28 22:09:38 +0800744#endif /* MBEDTLS_SSL_SESSION_TICKETS */
745
746MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100747static int ssl_tls13_psk_get_identity(mbedtls_ssl_context *ssl,
748 psa_algorithm_t *hash_alg,
749 const unsigned char **identity,
750 size_t *identity_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800751{
Jerry Yu8b41e892022-09-30 10:00:20 +0800752
Gilles Peskine449bd832023-01-11 14:50:10 +0100753 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
754 return -1;
755 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800756
Jerry Yua99cbfa2022-10-08 11:17:14 +0800757 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800758 *identity = ssl->conf->psk_identity;
759 *identity_len = ssl->conf->psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800761}
762
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800763MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100764static int ssl_tls13_psk_get_psk(mbedtls_ssl_context *ssl,
765 psa_algorithm_t *hash_alg,
766 const unsigned char **psk,
767 size_t *psk_len)
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800768{
Jerry Yu8b41e892022-09-30 10:00:20 +0800769
Gilles Peskine449bd832023-01-11 14:50:10 +0100770 if (!mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
771 return -1;
772 }
Jerry Yu8b41e892022-09-30 10:00:20 +0800773
Jerry Yua99cbfa2022-10-08 11:17:14 +0800774 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800775 *psk = ssl->conf->psk;
776 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 return 0;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800778}
779
Gilles Peskine449bd832023-01-11 14:50:10 +0100780static int ssl_tls13_get_configured_psk_count(mbedtls_ssl_context *ssl)
Jerry Yuf75364b2022-09-30 10:30:31 +0800781{
782 int configured_psk_count = 0;
783#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 if (ssl_tls13_has_configured_ticket(ssl)) {
785 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800786 configured_psk_count++;
787 }
788#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
790 MBEDTLS_SSL_DEBUG_MSG(3, ("PSK is configured"));
Jerry Yuf75364b2022-09-30 10:30:31 +0800791 configured_psk_count++;
792 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 return configured_psk_count;
Jerry Yuf75364b2022-09-30 10:30:31 +0800794}
795
Jerry Yuf7c12592022-09-28 22:09:38 +0800796MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100797static int ssl_tls13_write_identity(mbedtls_ssl_context *ssl,
798 unsigned char *buf,
799 unsigned char *end,
800 const unsigned char *identity,
801 size_t identity_len,
802 uint32_t obfuscated_ticket_age,
803 size_t *out_len)
Jerry Yuf7c12592022-09-28 22:09:38 +0800804{
Jerry Yuf75364b2022-09-30 10:30:31 +0800805 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800806 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800807
808 /*
809 * - identity_len (2 bytes)
810 * - identity (psk_identity_len bytes)
811 * - obfuscated_ticket_age (4 bytes)
812 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100813 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800814
Gilles Peskine449bd832023-01-11 14:50:10 +0100815 MBEDTLS_PUT_UINT16_BE(identity_len, buf, 0);
816 memcpy(buf + 2, identity, identity_len);
817 MBEDTLS_PUT_UINT32_BE(obfuscated_ticket_age, buf, 2 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800818
Gilles Peskine449bd832023-01-11 14:50:10 +0100819 MBEDTLS_SSL_DEBUG_BUF(4, "write identity", buf, 6 + identity_len);
Jerry Yuf7c12592022-09-28 22:09:38 +0800820
821 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800822
Gilles Peskine449bd832023-01-11 14:50:10 +0100823 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800824}
825
Jerry Yu8b41e892022-09-30 10:00:20 +0800826MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100827static int ssl_tls13_write_binder(mbedtls_ssl_context *ssl,
828 unsigned char *buf,
829 unsigned char *end,
830 int psk_type,
831 psa_algorithm_t hash_alg,
832 const unsigned char *psk,
833 size_t psk_len,
834 size_t *out_len)
Jerry Yu8b41e892022-09-30 10:00:20 +0800835{
836 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800837 unsigned char binder_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100838 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8b41e892022-09-30 10:00:20 +0800839 size_t transcript_len = 0;
840
841 *out_len = 0;
842
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 binder_len = PSA_HASH_LENGTH(hash_alg);
Jerry Yu8b41e892022-09-30 10:00:20 +0800844
845 /*
846 * - binder_len (1 bytes)
847 * - binder (binder_len bytes)
848 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100849 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800850
Jerry Yua99cbfa2022-10-08 11:17:14 +0800851 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800852
853 /* Get current state of handshake transcript. */
854 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200855 ssl, mbedtls_md_type_from_psa_alg(hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 transcript, sizeof(transcript), &transcript_len);
857 if (ret != 0) {
858 return ret;
Jerry Yu8b41e892022-09-30 10:00:20 +0800859 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100860
861 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, hash_alg,
862 psk, psk_len, psk_type,
863 transcript, buf + 1);
864 if (ret != 0) {
865 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_create_psk_binder", ret);
866 return ret;
867 }
868 MBEDTLS_SSL_DEBUG_BUF(4, "write binder", buf, 1 + binder_len);
Jerry Yu8b41e892022-09-30 10:00:20 +0800869
870 *out_len = 1 + binder_len;
871
Gilles Peskine449bd832023-01-11 14:50:10 +0100872 return 0;
Jerry Yu8b41e892022-09-30 10:00:20 +0800873}
874
875/*
876 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
877 *
878 * struct {
879 * opaque identity<1..2^16-1>;
880 * uint32 obfuscated_ticket_age;
881 * } PskIdentity;
882 *
883 * opaque PskBinderEntry<32..255>;
884 *
885 * struct {
886 * PskIdentity identities<7..2^16-1>;
887 * PskBinderEntry binders<33..2^16-1>;
888 * } OfferedPsks;
889 *
890 * struct {
891 * select (Handshake.msg_type) {
892 * case client_hello: OfferedPsks;
893 * ...
894 * };
895 * } PreSharedKeyExtension;
896 *
897 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000898int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +0100899 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
900 size_t *out_len, size_t *binders_len)
XiaokangQianeb69aee2022-07-05 08:21:43 +0000901{
Jerry Yuf7c12592022-09-28 22:09:38 +0800902 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800903 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800904 unsigned char *p = buf;
Xiaokang Qian854db282022-12-19 07:31:27 +0000905 psa_algorithm_t hash_alg = PSA_ALG_NONE;
Jerry Yuf75364b2022-09-30 10:30:31 +0800906 const unsigned char *identity;
907 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800908 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800909 size_t output_len;
Xiaokang Qian7179f812023-02-03 03:38:44 +0000910
Jerry Yuf7c12592022-09-28 22:09:38 +0800911 *out_len = 0;
912 *binders_len = 0;
913
914 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 configured_psk_count = ssl_tls13_get_configured_psk_count(ssl);
916 if (configured_psk_count == 0) {
917 MBEDTLS_SSL_DEBUG_MSG(3, ("skip pre_shared_key extensions"));
918 return 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800919 }
920
Gilles Peskine449bd832023-01-11 14:50:10 +0100921 MBEDTLS_SSL_DEBUG_MSG(4, ("Pre-configured PSK number = %d",
922 configured_psk_count));
Jerry Yuf75364b2022-09-30 10:30:31 +0800923
Jerry Yuf7c12592022-09-28 22:09:38 +0800924 /* Check if we have space to write the extension, binders included.
925 * - extension_type (2 bytes)
926 * - extension_data_len (2 bytes)
927 * - identities_len (2 bytes)
928 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yuf7c12592022-09-28 22:09:38 +0800930 p += 6;
931
Jerry Yuf75364b2022-09-30 10:30:31 +0800932#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100933 if (ssl_tls13_ticket_get_identity(
934 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800935#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 mbedtls_time_t now = mbedtls_time(NULL);
Jerry Yuf75364b2022-09-30 10:30:31 +0800937 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800938 uint32_t obfuscated_ticket_age =
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 (uint32_t) (now - session->ticket_received);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800940
Jerry Yu3e60cad2023-01-10 14:58:08 +0800941 /*
942 * The ticket timestamp is in seconds but the ticket age is in
943 * milliseconds. If the ticket was received at the end of a second and
944 * re-used here just at the beginning of the next second, the computed
945 * age `now - session->ticket_received` is equal to 1s thus 1000 ms
946 * while the actual age could be just a few milliseconds or tens of
947 * milliseconds. If the server has more accurate ticket timestamps
948 * (typically timestamps in milliseconds), as part of the processing of
949 * the ClientHello, it may compute a ticket lifetime smaller than the
950 * one computed here and potentially reject the ticket. To avoid that,
951 * remove one second to the ticket age if possible.
Jerry Yubdb936b2023-01-07 16:07:46 +0800952 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 if (obfuscated_ticket_age > 0) {
Jerry Yubdb936b2023-01-07 16:07:46 +0800954 obfuscated_ticket_age -= 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 }
Jerry Yubdb936b2023-01-07 16:07:46 +0800956
Jerry Yuf75364b2022-09-30 10:30:31 +0800957 obfuscated_ticket_age *= 1000;
958 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800959
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 ret = ssl_tls13_write_identity(ssl, p, end,
961 identity, identity_len,
962 obfuscated_ticket_age,
963 &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800964#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len,
966 0, &output_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800967#endif /* MBEDTLS_HAVE_TIME */
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 if (ret != 0) {
969 return ret;
970 }
Jerry Yuf7c12592022-09-28 22:09:38 +0800971
Jerry Yuf75364b2022-09-30 10:30:31 +0800972 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf75364b2022-09-30 10:30:31 +0800974 }
975#endif /* MBEDTLS_SSL_SESSION_TICKETS */
976
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 if (ssl_tls13_psk_get_identity(
978 ssl, &hash_alg, &identity, &identity_len) == 0) {
Jerry Yuf75364b2022-09-30 10:30:31 +0800979
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 ret = ssl_tls13_write_identity(ssl, p, end, identity, identity_len, 0,
981 &output_len);
982 if (ret != 0) {
983 return ret;
984 }
Jerry Yuf75364b2022-09-30 10:30:31 +0800985
Jerry Yuf7c12592022-09-28 22:09:38 +0800986 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 l_binders_len += 1 + PSA_HASH_LENGTH(hash_alg);
Jerry Yuf7c12592022-09-28 22:09:38 +0800988 }
989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 MBEDTLS_SSL_DEBUG_MSG(3,
991 ("client hello, adding pre_shared_key extension, "
992 "omitting PSK binder list"));
Jerry Yua99cbfa2022-10-08 11:17:14 +0800993
994 /* Take into account the two bytes for the length of the binders. */
995 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800996 /* Check if there is enough space for binders */
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 MBEDTLS_SSL_CHK_BUF_PTR(p, end, l_binders_len);
Jerry Yua99cbfa2022-10-08 11:17:14 +0800998
Jerry Yuf7c12592022-09-28 22:09:38 +0800999 /*
1000 * - extension_type (2 bytes)
1001 * - extension_data_len (2 bytes)
1002 * - identities_len (2 bytes)
1003 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0);
1005 MBEDTLS_PUT_UINT16_BE(p - buf - 4 + l_binders_len, buf, 2);
1006 MBEDTLS_PUT_UINT16_BE(p - buf - 6, buf, 4);
Jerry Yuf7c12592022-09-28 22:09:38 +08001007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 *out_len = (p - buf) + l_binders_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001009 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +08001010
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key identities", buf, p - buf);
Jerry Yuf7c12592022-09-28 22:09:38 +08001012
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001014}
1015
XiaokangQian86981952022-07-19 09:51:50 +00001016int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001018{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001019 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1020 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001021 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1022 const unsigned char *psk;
1023 size_t psk_len;
1024 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001025
1026 /* Check if we have space to write binders_len.
1027 * - binders_len (2 bytes)
1028 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001030 p += 2;
1031
Jerry Yu6183cc72022-09-30 11:08:57 +08001032#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 if (ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001034
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 ret = ssl_tls13_write_binder(ssl, p, end,
1036 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1037 hash_alg, psk, psk_len,
1038 &output_len);
1039 if (ret != 0) {
1040 return ret;
1041 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001042 p += output_len;
1043 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001044#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001045
Gilles Peskine449bd832023-01-11 14:50:10 +01001046 if (ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len) == 0) {
Jerry Yu6183cc72022-09-30 11:08:57 +08001047
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 ret = ssl_tls13_write_binder(ssl, p, end,
1049 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1050 hash_alg, psk, psk_len,
1051 &output_len);
1052 if (ret != 0) {
1053 return ret;
1054 }
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001055 p += output_len;
1056 }
1057
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 MBEDTLS_SSL_DEBUG_MSG(3, ("client hello, adding PSK binder list."));
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001059
1060 /*
1061 * - binders_len (2 bytes)
1062 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 MBEDTLS_PUT_UINT16_BE(p - buf - 2, buf, 0);
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key binders", buf, p - buf);
XiaokangQianeb69aee2022-07-05 08:21:43 +00001066
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001067 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yu0c354a22022-08-29 15:25:36 +08001069
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 return 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001071}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001072
1073/*
1074 * struct {
1075 * opaque identity<1..2^16-1>;
1076 * uint32 obfuscated_ticket_age;
1077 * } PskIdentity;
1078 *
1079 * opaque PskBinderEntry<32..255>;
1080 *
1081 * struct {
1082 *
1083 * select (Handshake.msg_type) {
1084 * ...
1085 * case server_hello: uint16 selected_identity;
1086 * };
1087 *
1088 * } PreSharedKeyExtension;
1089 *
1090 */
1091MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001092static int ssl_tls13_parse_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
1093 const unsigned char *buf,
1094 const unsigned char *end)
Jerry Yu0c6105b2022-08-12 17:26:40 +08001095{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001096 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001097 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001098 const unsigned char *psk;
1099 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001100 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001101
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, 2);
1103 selected_identity = MBEDTLS_GET_UINT16_BE(buf, 0);
Xiaokang Qian2a674932023-01-04 03:15:09 +00001104 ssl->handshake->selected_identity = (uint16_t) selected_identity;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 MBEDTLS_SSL_DEBUG_MSG(3, ("selected_identity = %d", selected_identity));
Jerry Yua99cbfa2022-10-08 11:17:14 +08001107
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 if (selected_identity >= ssl_tls13_get_configured_psk_count(ssl)) {
1109 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid PSK identity."));
Jerry Yu4a698342022-09-30 12:22:01 +08001110
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1112 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1113 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yub300e3c2022-09-28 22:12:07 +08001114 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001115
Jerry Yu4a698342022-09-30 12:22:01 +08001116#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 if (selected_identity == 0 && ssl_tls13_has_configured_ticket(ssl)) {
1118 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1119 } else
Jerry Yu4a698342022-09-30 12:22:01 +08001120#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 if (mbedtls_ssl_conf_has_static_psk(ssl->conf)) {
1122 ret = ssl_tls13_psk_get_psk(ssl, &hash_alg, &psk, &psk_len);
1123 } else {
1124 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1125 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yub300e3c2022-09-28 22:12:07 +08001126 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 if (ret != 0) {
1128 return ret;
Jerry Yub300e3c2022-09-28 22:12:07 +08001129 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001130
Dave Rodgman2eab4622023-10-05 13:30:37 +01001131 if (mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ssl->handshake->ciphersuite_info->mac)
Xiaokang Qianeb31cbc2023-02-07 02:08:56 +00001132 != hash_alg) {
1133 MBEDTLS_SSL_DEBUG_MSG(
1134 1, ("Invalid ciphersuite for external psk."));
1135
1136 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1137 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1138 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1139 }
1140
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1142 if (ret != 0) {
1143 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1144 return ret;
1145 }
1146
1147 return 0;
Jerry Yu0c6105b2022-08-12 17:26:40 +08001148}
Ronald Cron41a443a2022-10-04 16:38:25 +02001149#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00001150
Gilles Peskine449bd832023-01-11 14:50:10 +01001151int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1152 unsigned char *buf,
1153 unsigned char *end,
1154 size_t *out_len)
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001155{
1156 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1157 unsigned char *p = buf;
1158 size_t ext_len;
1159
1160 *out_len = 0;
1161
1162 /* Write supported_versions extension
1163 *
1164 * Supported Versions Extension is mandatory with TLS 1.3.
1165 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 ret = ssl_tls13_write_supported_versions_ext(ssl, p, end, &ext_len);
1167 if (ret != 0) {
1168 return ret;
1169 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001170 p += ext_len;
1171
1172 /* Echo the cookie if the server provided one in its preceding
1173 * HelloRetryRequest message.
1174 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 ret = ssl_tls13_write_cookie_ext(ssl, p, end, &ext_len);
1176 if (ret != 0) {
1177 return ret;
1178 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001179 p += ext_len;
1180
Ronald Cron766c0cd2022-10-18 12:17:11 +02001181#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1183 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &ext_len);
1184 if (ret != 0) {
1185 return ret;
1186 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001187 p += ext_len;
1188 }
Ronald Cron766c0cd2022-10-18 12:17:11 +02001189#endif
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001190
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001191#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 if (mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1193 ssl_tls13_early_data_has_valid_ticket(ssl) &&
1194 ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED) {
1195 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &ext_len);
1196 if (ret != 0) {
1197 return ret;
1198 }
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001199 p += ext_len;
1200
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001201 /* Initializes the status to `rejected`. It will be updated to
1202 * `accepted` if the EncryptedExtension message contain an early data
1203 * indication extension.
Xiaokang Qiana042b842022-11-09 01:59:33 +00001204 */
Ronald Cron4a8c9e22022-10-26 18:49:09 +02001205 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 } else {
1207 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write early_data extension"));
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00001208 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001209 }
1210#endif /* MBEDTLS_SSL_EARLY_DATA */
1211
Ronald Cron41a443a2022-10-04 16:38:25 +02001212#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00001213 /* For PSK-based key exchange we need the pre_shared_key extension
1214 * and the psk_key_exchange_modes extension.
1215 *
1216 * The pre_shared_key extension MUST be the last extension in the
1217 * ClientHello. Servers MUST check that it is the last extension and
1218 * otherwise fail the handshake with an "illegal_parameter" alert.
1219 *
1220 * Add the psk_key_exchange_modes extension.
1221 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 ret = ssl_tls13_write_psk_key_exchange_modes_ext(ssl, p, end, &ext_len);
1223 if (ret != 0) {
1224 return ret;
1225 }
XiaokangQianeb69aee2022-07-05 08:21:43 +00001226 p += ext_len;
Ronald Cron41a443a2022-10-04 16:38:25 +02001227#endif
XiaokangQianeb69aee2022-07-05 08:21:43 +00001228
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001229 *out_len = p - buf;
1230
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 return 0;
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001232}
1233
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00001234int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl)
Xiaokang Qian126929f2023-01-03 10:29:41 +00001235{
Xiaokang Qian90746132023-01-06 05:54:59 +00001236 ((void) ssl);
Xiaokang Qian79f77522023-01-28 10:35:29 +00001237
Xiaokang Qian126929f2023-01-03 10:29:41 +00001238#if defined(MBEDTLS_SSL_EARLY_DATA)
1239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1240 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1241 const unsigned char *psk;
1242 size_t psk_len;
1243 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Xiaokang Qian592021a2023-01-04 10:47:05 +00001244
Xiaokang Qian126929f2023-01-03 10:29:41 +00001245 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
Xiaokang Qian6be82902023-02-03 06:04:43 +00001246#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1247 mbedtls_ssl_handshake_set_state(
1248 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO);
1249#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00001250 MBEDTLS_SSL_DEBUG_MSG(
1251 1, ("Set hs psk for early data when writing the first psk"));
1252
1253 ret = ssl_tls13_ticket_get_psk(ssl, &hash_alg, &psk, &psk_len);
1254 if (ret != 0) {
1255 MBEDTLS_SSL_DEBUG_RET(
1256 1, "ssl_tls13_ticket_get_psk", ret);
1257 return ret;
1258 }
1259
1260 ret = mbedtls_ssl_set_hs_psk(ssl, psk, psk_len);
1261 if (ret != 0) {
1262 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
1263 return ret;
1264 }
1265
Xiaokang Qian64bc9bc2023-02-07 02:32:23 +00001266 /*
1267 * Early data are going to be encrypted using the ciphersuite
1268 * associated with the pre-shared key used for the handshake.
1269 * Note that if the server rejects early data, the handshake
1270 * based on the pre-shared key may complete successfully
1271 * with a selected ciphersuite different from the ciphersuite
1272 * associated with the pre-shared key. Only the hashes of the
1273 * two ciphersuites have to be the same. In that case, the
1274 * encrypted handshake data and application data are
1275 * encrypted using a different ciphersuite than the one used for
1276 * the rejected early data.
1277 */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001278 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(
1279 ssl->session_negotiate->ciphersuite);
1280 ssl->handshake->ciphersuite_info = ciphersuite_info;
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001281
Tom Cosgrove5c8505f2023-03-07 11:39:52 +00001282 /* Enable psk and psk_ephemeral to make stage early happy */
Xiaokang Qian126929f2023-01-03 10:29:41 +00001283 ssl->handshake->key_exchange_mode =
1284 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
1285
1286 /* Start the TLS 1.3 key schedule:
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001287 * Set the PSK and derive early secret.
Xiaokang Qian126929f2023-01-03 10:29:41 +00001288 */
1289 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1290 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001291 MBEDTLS_SSL_DEBUG_RET(
1292 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001293 return ret;
1294 }
1295
1296 /* Derive early data key material */
1297 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1298 if (ret != 0) {
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001299 MBEDTLS_SSL_DEBUG_RET(
1300 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
Xiaokang Qian126929f2023-01-03 10:29:41 +00001301 return ret;
1302 }
1303
Xiaokang Qian126929f2023-01-03 10:29:41 +00001304 }
1305#endif /* MBEDTLS_SSL_EARLY_DATA */
1306 return 0;
1307}
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001308/*
Jerry Yu4a173382021-10-11 21:45:31 +08001309 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001310 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001311
Ronald Cronda41b382022-03-30 09:57:11 +02001312/**
1313 * \brief Detect if the ServerHello contains a supported_versions extension
1314 * or not.
1315 *
1316 * \param[in] ssl SSL context
1317 * \param[in] buf Buffer containing the ServerHello message
1318 * \param[in] end End of the buffer containing the ServerHello message
1319 *
1320 * \return 0 if the ServerHello does not contain a supported_versions extension
1321 * \return 1 if the ServerHello contains a supported_versions extension
1322 * \return A negative value if an error occurred while parsing the ServerHello.
1323 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001324MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001325static int ssl_tls13_is_supported_versions_ext_present(
1326 mbedtls_ssl_context *ssl,
1327 const unsigned char *buf,
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 const unsigned char *end)
Ronald Cron9f0fba32022-02-10 16:45:15 +01001329{
1330 const unsigned char *p = buf;
1331 size_t legacy_session_id_echo_len;
Ronald Croneff56732023-04-03 17:36:31 +02001332 const unsigned char *supported_versions_data;
1333 const unsigned char *supported_versions_data_end;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001334
1335 /*
1336 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001337 * length:
1338 * - legacy_version 2 bytes
1339 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1340 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001341 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001343 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1344 legacy_session_id_echo_len = *p;
1345
1346 /*
1347 * Jump to the extensions, jumping over:
1348 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1349 * - cipher_suite 2 bytes
1350 * - legacy_compression_method 1 byte
1351 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len + 4);
1353 p += legacy_session_id_echo_len + 4;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001354
Ronald Cron47dce632023-02-08 17:38:29 +01001355 return mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1356 ssl, p, end,
Ronald Croneff56732023-04-03 17:36:31 +02001357 &supported_versions_data, &supported_versions_data_end);
Ronald Cron9f0fba32022-02-10 16:45:15 +01001358}
1359
Jerry Yu7a186a02021-10-15 18:46:14 +08001360/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001361 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1362 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1363 * - 0 otherwise
1364 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001365MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001366static int ssl_tls13_is_downgrade_negotiation(mbedtls_ssl_context *ssl,
1367 const unsigned char *buf,
1368 const unsigned char *end)
Ronald Cronfd6193c2022-04-05 11:04:20 +02001369{
1370 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1371 static const unsigned char magic_downgrade_string[] =
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
Ronald Cronfd6193c2022-04-05 11:04:20 +02001373 const unsigned char *last_eight_bytes_of_random;
1374 unsigned char last_byte_of_random;
1375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 MBEDTLS_SSL_CHK_BUF_READ_PTR(buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2);
Ronald Cronfd6193c2022-04-05 11:04:20 +02001377 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379 if (memcmp(last_eight_bytes_of_random,
1380 magic_downgrade_string,
1381 sizeof(magic_downgrade_string)) == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001382 last_byte_of_random = last_eight_bytes_of_random[7];
Gilles Peskine449bd832023-01-11 14:50:10 +01001383 return last_byte_of_random == 0 ||
1384 last_byte_of_random == 1;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001385 }
1386
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 return 0;
Ronald Cronfd6193c2022-04-05 11:04:20 +02001388}
1389
1390/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001391 * - SSL_SERVER_HELLO or
1392 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001393 * to indicate which message is expected and to be parsed next.
1394 */
Ronald Cron828aff62022-05-31 12:04:31 +02001395#define SSL_SERVER_HELLO 0
1396#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001397MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001398static int ssl_server_hello_is_hrr(mbedtls_ssl_context *ssl,
1399 const unsigned char *buf,
1400 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001401{
Jerry Yue1b9c292021-09-10 10:08:31 +08001402
1403 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1404 *
Jerry Yu4a173382021-10-11 21:45:31 +08001405 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001406 * special value of the SHA-256 of "HelloRetryRequest".
1407 *
1408 * struct {
1409 * ProtocolVersion legacy_version = 0x0303;
1410 * Random random;
1411 * opaque legacy_session_id_echo<0..32>;
1412 * CipherSuite cipher_suite;
1413 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001414 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001415 * } ServerHello;
1416 *
1417 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001418 MBEDTLS_SSL_CHK_BUF_READ_PTR(
1419 buf, end, 2 + sizeof(mbedtls_ssl_tls13_hello_retry_request_magic));
Jerry Yu4a173382021-10-11 21:45:31 +08001420
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 if (memcmp(buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1422 sizeof(mbedtls_ssl_tls13_hello_retry_request_magic)) == 0) {
1423 return SSL_SERVER_HELLO_HRR;
Jerry Yue1b9c292021-09-10 10:08:31 +08001424 }
1425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 return SSL_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001427}
1428
Ronald Cron828aff62022-05-31 12:04:31 +02001429/*
Jerry Yu745bb612021-10-13 22:01:04 +08001430 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001431 * - SSL_SERVER_HELLO or
1432 * - SSL_SERVER_HELLO_HRR or
1433 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001434 */
Ronald Cron828aff62022-05-31 12:04:31 +02001435#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001436MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001437static int ssl_tls13_preprocess_server_hello(mbedtls_ssl_context *ssl,
1438 const unsigned char *buf,
1439 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001440{
Jerry Yu4a173382021-10-11 21:45:31 +08001441 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001442 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001443
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_is_supported_versions_ext_present(
1445 ssl, buf, end));
Jerry Yua66fece2022-07-13 14:30:29 +08001446
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 if (ret == 0) {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001448 MBEDTLS_SSL_PROC_CHK_NEG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 ssl_tls13_is_downgrade_negotiation(ssl, buf, end));
Ronald Cronfd6193c2022-04-05 11:04:20 +02001450
1451 /* If the server is negotiating TLS 1.2 or below and:
1452 * . we did not propose TLS 1.2 or
1453 * . the server responded it is TLS 1.3 capable but negotiating a lower
1454 * version of the protocol and thus we are under downgrade attack
1455 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 if (handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret) {
1458 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1459 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1460 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001461 }
1462
Ronald Cronb828c7d2023-04-03 16:37:22 +02001463 /*
1464 * Version 1.2 of the protocol has been negotiated, set the
1465 * ssl->keep_current_message flag for the ServerHello to be kept and
1466 * parsed as a TLS 1.2 ServerHello. We also change ssl->tls_version to
1467 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1468 * will dispatch to the TLS 1.2 state machine.
1469 */
Ronald Cron9f0fba32022-02-10 16:45:15 +01001470 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001471 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001472 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1473 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1474 buf, (size_t) (end - buf)));
Ronald Cron9f0fba32022-02-10 16:45:15 +01001475
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 if (mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1477 ret = ssl_tls13_reset_key_share(ssl);
1478 if (ret != 0) {
1479 return ret;
1480 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01001481 }
1482
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 return SSL_SERVER_HELLO_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001484 }
1485
Jerry Yua66fece2022-07-13 14:30:29 +08001486#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1487 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1488 ssl->session_negotiate->tls_version = ssl->tls_version;
1489#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1490
Jerry Yu50e00e32022-10-31 14:45:01 +08001491 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Ronald Cron5afb9042022-05-31 12:11:39 +02001492
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 ret = ssl_server_hello_is_hrr(ssl, buf, end);
1494 switch (ret) {
Ronald Cron828aff62022-05-31 12:04:31 +02001495 case SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 MBEDTLS_SSL_DEBUG_MSG(2, ("received ServerHello message"));
Jerry Yu745bb612021-10-13 22:01:04 +08001497 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001498 case SSL_SERVER_HELLO_HRR:
Gilles Peskine449bd832023-01-11 14:50:10 +01001499 MBEDTLS_SSL_DEBUG_MSG(2, ("received HelloRetryRequest message"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001500 /* If a client receives a second HelloRetryRequest in the same
1501 * connection (i.e., where the ClientHello was itself in response
1502 * to a HelloRetryRequest), it MUST abort the handshake with an
1503 * "unexpected_message" alert.
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 */
1505 if (handshake->hello_retry_request_count > 0) {
1506 MBEDTLS_SSL_DEBUG_MSG(1, ("Multiple HRRs received"));
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001507 MBEDTLS_SSL_PEND_FATAL_ALERT(
1508 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1509 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001511 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001512 /*
1513 * Clients must abort the handshake with an "illegal_parameter"
1514 * alert if the HelloRetryRequest would not result in any change
1515 * in the ClientHello.
1516 * In a PSK only key exchange that what we expect.
1517 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
1519 MBEDTLS_SSL_DEBUG_MSG(1,
1520 ("Unexpected HRR in pure PSK key exchange."));
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1523 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1524 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian2b01dc32022-01-21 02:53:13 +00001525 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001526
Ronald Cron5afb9042022-05-31 12:11:39 +02001527 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001528
Jerry Yu745bb612021-10-13 22:01:04 +08001529 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001530 }
1531
1532cleanup:
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001535}
1536
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001537MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001538static int ssl_tls13_check_server_hello_session_id_echo(mbedtls_ssl_context *ssl,
1539 const unsigned char **buf,
1540 const unsigned char *end)
Jerry Yue1b9c292021-09-10 10:08:31 +08001541{
1542 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001543 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001544
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1546 legacy_session_id_echo_len = *p++;
Jerry Yue1b9c292021-09-10 10:08:31 +08001547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_echo_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001549
1550 /* legacy_session_id_echo */
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 if (ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1552 memcmp(ssl->session_negotiate->id, p, legacy_session_id_echo_len) != 0) {
1553 MBEDTLS_SSL_DEBUG_BUF(3, "Expected Session ID",
1554 ssl->session_negotiate->id,
1555 ssl->session_negotiate->id_len);
1556 MBEDTLS_SSL_DEBUG_BUF(3, "Received Session ID", p,
1557 legacy_session_id_echo_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001558
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1560 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
Jerry Yu4a173382021-10-11 21:45:31 +08001561
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001563 }
1564
Jerry Yu4a173382021-10-11 21:45:31 +08001565 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001566 *buf = p;
1567
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 MBEDTLS_SSL_DEBUG_BUF(3, "Session ID", ssl->session_negotiate->id,
1569 ssl->session_negotiate->id_len);
1570 return 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001571}
1572
Jerry Yue1b9c292021-09-10 10:08:31 +08001573/* Parse ServerHello message and configure context
1574 *
1575 * struct {
1576 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1577 * Random random;
1578 * opaque legacy_session_id_echo<0..32>;
1579 * CipherSuite cipher_suite;
1580 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001581 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001582 * } ServerHello;
1583 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001584MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001585static int ssl_tls13_parse_server_hello(mbedtls_ssl_context *ssl,
1586 const unsigned char *buf,
1587 const unsigned char *end,
1588 int is_hrr)
Jerry Yue1b9c292021-09-10 10:08:31 +08001589{
Jerry Yub85277e2021-10-13 13:36:05 +08001590 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001591 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001592 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001593 size_t extensions_len;
1594 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001595 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001596 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001597 int fatal_alert = 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001598 uint32_t allowed_extensions_mask;
Jerry Yu50e00e32022-10-31 14:45:01 +08001599 int hs_msg_type = is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 MBEDTLS_SSL_HS_SERVER_HELLO;
Jerry Yue1b9c292021-09-10 10:08:31 +08001601
1602 /*
1603 * Check there is space for minimal fields
1604 *
1605 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001606 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001607 * - legacy_session_id_echo ( 1 byte ), minimum size
1608 * - cipher_suite ( 2 bytes)
1609 * - legacy_compression_method ( 1 byte )
1610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6);
Jerry Yue1b9c292021-09-10 10:08:31 +08001612
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 MBEDTLS_SSL_DEBUG_BUF(4, "server hello", p, end - p);
1614 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, version", p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001615
Jerry Yu4a173382021-10-11 21:45:31 +08001616 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001617 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001618 * ...
1619 * with ProtocolVersion defined as:
1620 * uint16 ProtocolVersion;
1621 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1623 MBEDTLS_SSL_VERSION_TLS1_2) {
1624 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1625 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1626 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001627 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1628 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001629 }
1630 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001631
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001632 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001633 * Random random;
1634 * ...
1635 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001636 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001637 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001638 if (!is_hrr) {
1639 memcpy(&handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
1640 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1641 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1642 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
XiaokangQian53f20b72022-01-18 10:47:33 +00001643 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001644 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001645
Jerry Yu4a173382021-10-11 21:45:31 +08001646 /* ...
1647 * opaque legacy_session_id_echo<0..32>;
1648 * ...
1649 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 if (ssl_tls13_check_server_hello_session_id_echo(ssl, &p, end) != 0) {
XiaokangQian52da5582022-01-26 09:49:29 +00001651 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001652 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001653 }
1654
Jerry Yu4a173382021-10-11 21:45:31 +08001655 /* ...
1656 * CipherSuite cipher_suite;
1657 * ...
1658 * with CipherSuite defined as:
1659 * uint8 CipherSuite[2];
1660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1662 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001663 p += 2;
1664
Jerry Yu4a173382021-10-11 21:45:31 +08001665
Gilles Peskine449bd832023-01-11 14:50:10 +01001666 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
Jerry Yu4a173382021-10-11 21:45:31 +08001667 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001668 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001669 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001670 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
1671 ssl->tls_version,
1672 ssl->tls_version) != 0) ||
1673 !mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001674 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001675 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001676 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001677 * If we received an HRR before and that the proposed selected
1678 * ciphersuite in this server hello is not the same as the one
1679 * proposed in the HRR, we abort the handshake and send an
1680 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001681 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001682 else if ((!is_hrr) && (handshake->hello_retry_request_count > 0) &&
1683 (cipher_suite != ssl->session_negotiate->ciphersuite)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001684 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001685 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001686
Gilles Peskine449bd832023-01-11 14:50:10 +01001687 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1688 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid ciphersuite(%04x) parameter",
1689 cipher_suite));
XiaokangQiand59be772022-01-24 10:12:51 +00001690 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001691 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001692
Jerry Yu4a173382021-10-11 21:45:31 +08001693 /* Configure ciphersuites */
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 mbedtls_ssl_optimize_checksum(ssl, ciphersuite_info);
Jerry Yu4a173382021-10-11 21:45:31 +08001695
XiaokangQian355e09a2022-01-20 11:14:50 +00001696 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, chosen ciphersuite: ( %04x ) - %s",
1698 cipher_suite, ciphersuite_info->name));
Jerry Yue1b9c292021-09-10 10:08:31 +08001699
1700#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001701 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yue1b9c292021-09-10 10:08:31 +08001702#endif /* MBEDTLS_HAVE_TIME */
1703
Jerry Yu4a173382021-10-11 21:45:31 +08001704 /* ...
1705 * uint8 legacy_compression_method = 0;
1706 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001707 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
1709 if (p[0] != MBEDTLS_SSL_COMPRESS_NULL) {
1710 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
XiaokangQian52da5582022-01-26 09:49:29 +00001711 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001712 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001713 }
1714 p++;
1715
Jerry Yub85277e2021-10-13 13:36:05 +08001716 /* ...
1717 * Extension extensions<6..2^16-1>;
1718 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001719 * struct {
1720 * ExtensionType extension_type; (2 bytes)
1721 * opaque extension_data<0..2^16-1>;
1722 * } Extension;
1723 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1725 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yue1b9c292021-09-10 10:08:31 +08001726 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001727
Jerry Yu4a173382021-10-11 21:45:31 +08001728 /* Check extensions do not go beyond the buffer of data. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yu4a173382021-10-11 21:45:31 +08001730 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001731
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 MBEDTLS_SSL_DEBUG_BUF(3, "server hello extensions", p, extensions_len);
Jerry Yue1b9c292021-09-10 10:08:31 +08001733
Jerry Yu50e00e32022-10-31 14:45:01 +08001734 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001735 allowed_extensions_mask = is_hrr ?
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR :
1737 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH;
Jerry Yu2c5363e2022-08-04 17:42:49 +08001738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 while (p < extensions_end) {
Jerry Yue1b9c292021-09-10 10:08:31 +08001740 unsigned int extension_type;
1741 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001742 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001743
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1745 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1746 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yue1b9c292021-09-10 10:08:31 +08001747 p += 4;
1748
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian43550bd2022-01-21 04:32:58 +00001750 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001751
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001752 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 ssl, hs_msg_type, extension_type, allowed_extensions_mask);
1754 if (ret != 0) {
1755 return ret;
1756 }
Jerry Yu2c5363e2022-08-04 17:42:49 +08001757
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 switch (extension_type) {
XiaokangQianb851da82022-01-14 04:03:11 +00001759 case MBEDTLS_TLS_EXT_COOKIE:
1760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 ret = ssl_tls13_parse_cookie_ext(ssl,
1762 p, extension_data_end);
1763 if (ret != 0) {
1764 MBEDTLS_SSL_DEBUG_RET(1,
1765 "ssl_tls13_parse_cookie_ext",
1766 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001767 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001768 }
XiaokangQianb851da82022-01-14 04:03:11 +00001769 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001770
Jerry Yue1b9c292021-09-10 10:08:31 +08001771 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 ret = ssl_tls13_parse_supported_versions_ext(ssl,
1773 p,
1774 extension_data_end);
1775 if (ret != 0) {
XiaokangQiand59be772022-01-24 10:12:51 +00001776 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001778 break;
1779
Ronald Cron41a443a2022-10-04 16:38:25 +02001780#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001781 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
Jerry Yu4a173382021-10-11 21:45:31 +08001783
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 if ((ret = ssl_tls13_parse_server_pre_shared_key_ext(
1785 ssl, p, extension_data_end)) != 0) {
XiaokangQianeb69aee2022-07-05 08:21:43 +00001786 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 1, ("ssl_tls13_parse_server_pre_shared_key_ext"), ret);
1788 return ret;
XiaokangQianeb69aee2022-07-05 08:21:43 +00001789 }
1790 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001791#endif
Jerry Yue1b9c292021-09-10 10:08:31 +08001792
Jerry Yue1b9c292021-09-10 10:08:31 +08001793 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 MBEDTLS_SSL_DEBUG_MSG(3, ("found key_shares extension"));
1795 if (!mbedtls_ssl_conf_tls13_some_ephemeral_enabled(ssl)) {
XiaokangQian52da5582022-01-26 09:49:29 +00001796 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001797 goto cleanup;
1798 }
1799
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 if (is_hrr) {
1801 ret = ssl_tls13_parse_hrr_key_share_ext(ssl,
1802 p, extension_data_end);
1803 } else {
1804 ret = ssl_tls13_parse_key_share_ext(ssl,
1805 p, extension_data_end);
1806 }
1807 if (ret != 0) {
1808 MBEDTLS_SSL_DEBUG_RET(1,
1809 "ssl_tls13_parse_key_share_ext",
1810 ret);
XiaokangQiand59be772022-01-24 10:12:51 +00001811 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001812 }
1813 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001814
1815 default:
Jerry Yu9872eb22022-08-29 13:42:01 +08001816 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1817 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001818 }
1819
1820 p += extension_data_len;
1821 }
1822
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 MBEDTLS_SSL_PRINT_EXTS(3, hs_msg_type, handshake->received_extensions);
Jerry Yu2c5363e2022-08-04 17:42:49 +08001824
XiaokangQiand59be772022-01-24 10:12:51 +00001825cleanup:
1826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT) {
1828 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1829 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
XiaokangQiand59be772022-01-24 10:12:51 +00001830 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 } else if (fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER) {
1832 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1833 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
XiaokangQiand59be772022-01-24 10:12:51 +00001834 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1835 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001837}
1838
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001839#if defined(MBEDTLS_DEBUG_C)
1840static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001841{
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 switch (mode) {
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001843 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1844 return "psk";
1845 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1846 return "ephemeral";
1847 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1848 return "psk_ephemeral";
1849 default:
1850 return "unknown mode";
1851 }
1852}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001853#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001854
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001855MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001856static int ssl_tls13_postprocess_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue1b9c292021-09-10 10:08:31 +08001857{
Jerry Yub85277e2021-10-13 13:36:05 +08001858 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001859 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001860
Jerry Yub85277e2021-10-13 13:36:05 +08001861 /* Determine the key exchange mode:
1862 * 1) If both the pre_shared_key and key_share extensions were received
1863 * then the key exchange mode is PSK with EPHEMERAL.
1864 * 2) If only the pre_shared_key extension was received then the key
1865 * exchange mode is PSK-only.
1866 * 3) If only the key_share extension was received then the key
1867 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001868 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 switch (handshake->received_extensions &
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001870 (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1871 MBEDTLS_SSL_EXT_MASK(KEY_SHARE))) {
Jerry Yu745bb612021-10-13 22:01:04 +08001872 /* Only the pre_shared_key extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 case MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001874 handshake->key_exchange_mode =
1875 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001876 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001877
Jerry Yu745bb612021-10-13 22:01:04 +08001878 /* Only the key_share extension was received */
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 case MBEDTLS_SSL_EXT_MASK(KEY_SHARE):
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001880 handshake->key_exchange_mode =
1881 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001882 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001883
Jerry Yu745bb612021-10-13 22:01:04 +08001884 /* Both the pre_shared_key and key_share extensions were received */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001885 case (MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1886 MBEDTLS_SSL_EXT_MASK(KEY_SHARE)):
1887 handshake->key_exchange_mode =
1888 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001889 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001890
Jerry Yu745bb612021-10-13 22:01:04 +08001891 /* Neither pre_shared_key nor key_share extension was received */
1892 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 MBEDTLS_SSL_DEBUG_MSG(1, ("Unknown key exchange."));
Jerry Yu745bb612021-10-13 22:01:04 +08001894 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1895 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001896 }
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001897#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001898 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA) &&
1899 (handshake->selected_identity != 0 ||
1900 handshake->ciphersuite_info->id !=
1901 ssl->session_negotiate->ciphersuite)) {
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001902 /* RFC8446 4.2.11
1903 * If the server supplies an "early_data" extension, the
1904 * client MUST verify that the server's selected_identity
1905 * is 0. If any other value is returned, the client MUST
1906 * abort the handshake with an "illegal_parameter" alert.
Xiaokang Qian02f5e142023-02-06 10:44:17 +00001907 *
Xiaokang Qian53c4c272023-02-07 02:42:01 +00001908 * RFC 8446 4.2.10
1909 * In order to accept early data, the server MUST have accepted a PSK
1910 * cipher suite and selected the first key offered in the client's
1911 * "pre_shared_key" extension. In addition, it MUST verify that the
1912 * following values are the same as those associated with the
1913 * selected PSK:
1914 * - The TLS version number
1915 * - The selected cipher suite
Xiaokang Qian8dc4ce72023-02-07 10:49:50 +00001916 * - The selected ALPN [RFC7301] protocol, if any
1917 *
1918 * We check here that when early data is involved the server
1919 * selected the cipher suite associated to the pre-shared key
1920 * as it must have.
Xiaokang Qian3f616c22023-01-12 03:36:31 +00001921 */
1922 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1923 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1924 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1925 }
1926#endif
Jerry Yu0b177842021-09-05 19:41:30 +08001927
Xiaokang Qian0de0d862023-02-08 06:04:50 +00001928 if (!mbedtls_ssl_conf_tls13_check_kex_modes(
1929 ssl, handshake->key_exchange_mode)) {
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001930 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001931 MBEDTLS_SSL_DEBUG_MSG(
1932 2, ("Key exchange mode(%s) is not supported.",
1933 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001934 goto cleanup;
1935 }
1936
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00001937 MBEDTLS_SSL_DEBUG_MSG(
1938 3, ("Selected key exchange mode: %s",
1939 ssl_tls13_get_kex_mode_str(handshake->key_exchange_mode)));
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001940
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001941 /* Start the TLS 1.3 key scheduling if not already done.
Jerry Yu0b177842021-09-05 19:41:30 +08001942 *
Xiaokang Qian7892b6c2023-02-02 06:05:48 +00001943 * If we proposed early data then we have already derived an
1944 * early secret using the selected PSK and its associated hash.
1945 * It means that if the negotiated key exchange mode is psk or
1946 * psk_ephemeral, we have already correctly computed the
1947 * early secret and thus we do not do it again. In all other
1948 * cases we compute it here.
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001949 */
Xiaokang Qian90746132023-01-06 05:54:59 +00001950#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qiane04afdc2023-02-07 02:19:42 +00001951 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT ||
1952 handshake->key_exchange_mode ==
1953 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
Xiaokang Qian90746132023-01-06 05:54:59 +00001954#endif
1955 {
Xiaokang Qian303f82c52023-01-04 08:43:46 +00001956 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1957 if (ret != 0) {
1958 MBEDTLS_SSL_DEBUG_RET(
1959 1, "mbedtls_ssl_tls13_key_schedule_stage_early", ret);
1960 goto cleanup;
1961 }
Jerry Yu0b177842021-09-05 19:41:30 +08001962 }
1963
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
1965 if (ret != 0) {
1966 MBEDTLS_SSL_DEBUG_RET(1,
1967 "mbedtls_ssl_tls13_compute_handshake_transform",
1968 ret);
Jerry Yu4a173382021-10-11 21:45:31 +08001969 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001970 }
1971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 mbedtls_ssl_set_inbound_transform(ssl, handshake->transform_handshake);
1973 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00001974 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
Jerry Yu0b177842021-09-05 19:41:30 +08001975 ssl->session_in = ssl->session_negotiate;
1976
Jerry Yu4a173382021-10-11 21:45:31 +08001977cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 if (ret != 0) {
Jerry Yu4a173382021-10-11 21:45:31 +08001979 MBEDTLS_SSL_PEND_FATAL_ALERT(
1980 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yu4a173382021-10-11 21:45:31 +08001982 }
Jerry Yue110d252022-05-05 10:19:22 +08001983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 return ret;
Jerry Yue1b9c292021-09-10 10:08:31 +08001985}
1986
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001987MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001988static int ssl_tls13_postprocess_hrr(mbedtls_ssl_context *ssl)
XiaokangQian647719a2021-12-07 09:16:29 +00001989{
1990 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
XiaokangQian647719a2021-12-07 09:16:29 +00001993
XiaokangQian78b1fa72022-01-19 06:56:30 +00001994 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001995 * We are going to re-generate a shared secret corresponding to the group
1996 * selected by the server, which is different from the group for which we
1997 * generated a shared secret in the first client hello.
1998 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001999 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 ret = ssl_tls13_reset_key_share(ssl);
2001 if (ret != 0) {
2002 return ret;
2003 }
XiaokangQian647719a2021-12-07 09:16:29 +00002004
Xiaokang Qian4ef8ba22023-02-06 11:06:16 +00002005 ssl->session_negotiate->ciphersuite = ssl->handshake->ciphersuite_info->id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 return 0;
XiaokangQian647719a2021-12-07 09:16:29 +00002007}
2008
Jerry Yue1b9c292021-09-10 10:08:31 +08002009/*
Jerry Yu4a173382021-10-11 21:45:31 +08002010 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08002011 * Handler for MBEDTLS_SSL_SERVER_HELLO
2012 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002013MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002014static int ssl_tls13_process_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002015{
Jerry Yu4a173382021-10-11 21:45:31 +08002016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00002017 unsigned char *buf = NULL;
2018 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00002019 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08002020
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 MBEDTLS_SSL_DEBUG_MSG(2, ("=> %s", __func__));
Jerry Yue1b9c292021-09-10 10:08:31 +08002022
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002023 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2024 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Ronald Crondb5dfa12022-05-31 11:44:38 +02002025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 ret = ssl_tls13_preprocess_server_hello(ssl, buf, buf + buf_len);
2027 if (ret < 0) {
XiaokangQian16acd4b2022-01-14 07:35:47 +00002028 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 } else {
2030 is_hrr = (ret == SSL_SERVER_HELLO_HRR);
2031 }
XiaokangQiand59be772022-01-24 10:12:51 +00002032
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 if (ret == SSL_SERVER_HELLO_TLS1_2) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01002034 ret = 0;
2035 goto cleanup;
2036 }
2037
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_server_hello(ssl, buf,
2039 buf + buf_len,
2040 is_hrr));
2041 if (is_hrr) {
2042 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_reset_transcript_for_hrr(ssl));
Ronald Cronfb508b82022-05-31 14:49:55 +02002043 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002044
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002045 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2046 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002047
2048 if (is_hrr) {
2049 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_hrr(ssl));
2050#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2051 /* If not offering early data, the client sends a dummy CCS record
2052 * immediately before its second flight. This may either be before
2053 * its second ClientHello or before its encrypted handshake flight.
2054 */
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002055 mbedtls_ssl_handshake_set_state(
2056 ssl, MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO);
Gilles Peskine449bd832023-01-11 14:50:10 +01002057#else
2058 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2059#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2060 } else {
2061 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_server_hello(ssl));
2062 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Ronald Cronfb508b82022-05-31 14:49:55 +02002063 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002064
2065cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 MBEDTLS_SSL_DEBUG_MSG(2, ("<= %s ( %s )", __func__,
2067 is_hrr ? "HelloRetryRequest" : "ServerHello"));
2068 return ret;
Jerry Yu687101b2021-09-14 16:03:56 +08002069}
2070
2071/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002072 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002073 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002074 *
2075 * The EncryptedExtensions message contains any extensions which
2076 * should be protected, i.e., any which are not needed to establish
2077 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002078 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002079
XiaokangQian08da26c2021-10-09 10:12:11 +00002080/* Parse EncryptedExtensions message
2081 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002082 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002083 * } EncryptedExtensions;
2084 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002085MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002086static int ssl_tls13_parse_encrypted_extensions(mbedtls_ssl_context *ssl,
2087 const unsigned char *buf,
2088 const unsigned char *end)
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002089{
2090 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002091 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002092 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002093 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002094 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2097 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08da26c2021-10-09 10:12:11 +00002098 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Ronald Cronc8083592022-05-31 16:24:05 +02002101 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002102
Jan Bruckner5a3629b2023-02-23 12:08:09 +01002103 MBEDTLS_SSL_DEBUG_BUF(3, "encrypted extensions", p, extensions_len);
2104
Jerry Yu9eba7502022-10-31 13:46:16 +08002105 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yucbd082f2022-08-04 16:55:10 +08002106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 while (p < extensions_end) {
XiaokangQian08da26c2021-10-09 10:12:11 +00002108 unsigned int extension_type;
2109 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002110
XiaokangQian08da26c2021-10-09 10:12:11 +00002111 /*
2112 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002113 * ExtensionType extension_type; (2 bytes)
2114 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002115 * } Extension;
2116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2118 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2119 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian08da26c2021-10-09 10:12:11 +00002120 p += 4;
2121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002123
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002124 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, extension_type,
2126 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE);
2127 if (ret != 0) {
2128 return ret;
2129 }
Jerry Yucbd082f2022-08-04 16:55:10 +08002130
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 switch (extension_type) {
lhuang0486cacac2022-01-21 07:34:27 -08002132#if defined(MBEDTLS_SSL_ALPN)
2133 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
lhuang0486cacac2022-01-21 07:34:27 -08002135
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002136 if ((ret = ssl_tls13_parse_alpn_ext(
2137 ssl, p, (size_t) extension_data_len)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 return ret;
lhuang0486cacac2022-01-21 07:34:27 -08002139 }
2140
2141 break;
2142#endif /* MBEDTLS_SSL_ALPN */
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002143
2144#if defined(MBEDTLS_SSL_EARLY_DATA)
2145 case MBEDTLS_TLS_EXT_EARLY_DATA:
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002146
Gilles Peskine449bd832023-01-11 14:50:10 +01002147 if (extension_data_len != 0) {
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002148 /* The message must be empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2150 MBEDTLS_ERR_SSL_DECODE_ERROR);
2151 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qianca09afc2022-11-22 10:05:19 +00002152 }
2153
Xiaokang Qian8bee8992022-10-27 10:21:05 +00002154 break;
2155#endif /* MBEDTLS_SSL_EARLY_DATA */
2156
Jan Bruckner151f6422023-02-10 12:45:19 +01002157#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2158 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
2159 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
2160
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002161 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
2162 ssl, p, p + extension_data_len);
Jan Bruckner151f6422023-02-10 12:45:19 +01002163
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002164 /* TODO: Return unconditionally here until we handle the record
2165 * size limit correctly. Once handled correctly, only return in
2166 * case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01002167 return ret;
2168
2169 break;
2170#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2171
XiaokangQian08da26c2021-10-09 10:12:11 +00002172 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002173 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu9eba7502022-10-31 13:46:16 +08002174 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 extension_type, "( ignored )");
Jerry Yucbd082f2022-08-04 16:55:10 +08002176 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002177 }
2178
XiaokangQian08da26c2021-10-09 10:12:11 +00002179 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002180 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2183 handshake->received_extensions);
Jerry Yucbd082f2022-08-04 16:55:10 +08002184
XiaokangQian97799ac2021-10-11 10:05:54 +00002185 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 if (p != end) {
2187 MBEDTLS_SSL_DEBUG_MSG(1, ("EncryptedExtension lengths misaligned"));
2188 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2189 MBEDTLS_ERR_SSL_DECODE_ERROR);
2190 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002191 }
2192
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 return ret;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002194}
2195
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002196MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002197static int ssl_tls13_process_encrypted_extensions(mbedtls_ssl_context *ssl)
Ronald Cron9d6a5452022-05-30 16:05:38 +02002198{
2199 int ret;
2200 unsigned char *buf;
2201 size_t buf_len;
2202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse encrypted extensions"));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002204
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002205 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2206 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2207 &buf, &buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002208
2209 /* Process the message contents */
2210 MBEDTLS_SSL_PROC_CHK(
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 ssl_tls13_parse_encrypted_extensions(ssl, buf, buf + buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002212
Xiaokang Qianb157e912022-11-23 08:12:26 +00002213#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if (ssl->handshake->received_extensions &
2215 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Xiaokang Qianb157e912022-11-23 08:12:26 +00002216 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
2217 }
2218#endif
2219
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002220 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2221 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2222 buf, buf_len));
Ronald Cron9d6a5452022-05-30 16:05:38 +02002223
Ronald Cron928cbd32022-10-04 16:14:26 +02002224#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2226 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2227 } else {
2228 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2229 }
Ronald Cronfb508b82022-05-31 14:49:55 +02002230#else
2231 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Ronald Cronfb508b82022-05-31 14:49:55 +02002233#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002234
2235cleanup:
2236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse encrypted extensions"));
2238 return ret;
Ronald Cron9d6a5452022-05-30 16:05:38 +02002239
2240}
2241
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002242/*
2243 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
2244 *
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002245 * RFC 8446 section 4.5
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002246 *
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002247 * struct {} EndOfEarlyData;
Xiaokang Qianc81a15a2022-12-19 02:43:33 +00002248 *
2249 * If the server sent an "early_data" extension in EncryptedExtensions, the
2250 * client MUST send an EndOfEarlyData message after receiving the server
2251 * Finished. Otherwise, the client MUST NOT send an EndOfEarlyData message.
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002252 */
2253
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002254MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002255static int ssl_tls13_write_end_of_early_data(mbedtls_ssl_context *ssl)
2256{
2257 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaokang Qian742578c2022-12-19 06:34:44 +00002258 unsigned char *buf = NULL;
2259 size_t buf_len;
Xiaokang Qian57a138d2022-12-19 06:40:47 +00002260 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write EndOfEarlyData"));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002261
Xiaokang Qian742578c2022-12-19 06:34:44 +00002262 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
Xiaokang Qian0de0d862023-02-08 06:04:50 +00002263 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
2264 &buf, &buf_len));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002265
Manuel Pégourié-Gonnard63e33dd2023-02-21 15:45:15 +01002266 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_hdr_to_checksum(
2267 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA, 0));
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002268
Xiaokang Qian742578c2022-12-19 06:34:44 +00002269 MBEDTLS_SSL_PROC_CHK(
2270 mbedtls_ssl_finish_handshake_msg(ssl, buf_len, 0));
Xiaokang Qianda8402d2022-12-15 14:55:35 +00002271
Xiaokang Qian19d44162023-01-03 03:39:50 +00002272 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002273
2274cleanup:
2275
2276 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write EndOfEarlyData"));
2277 return ret;
2278}
2279
Ronald Cron928cbd32022-10-04 16:14:26 +02002280#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002281/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002282 * STATE HANDLING: CertificateRequest
2283 *
Jerry Yud2674312021-10-29 10:08:19 +08002284 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002285#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2286#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002287/* Coordination:
2288 * Deals with the ambiguity of not knowing if a CertificateRequest
2289 * will be sent. Returns a negative code on failure, or
2290 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2291 * - SSL_CERTIFICATE_REQUEST_SKIP
2292 * indicating if a Certificate Request is expected or not.
2293 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002294MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002295static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
Jerry Yud2674312021-10-29 10:08:19 +08002296{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2300 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2301 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002302 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002303 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 if ((ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) &&
2306 (ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST)) {
2307 MBEDTLS_SSL_DEBUG_MSG(3, ("got a certificate request"));
2308 return SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST;
Jerry Yud2674312021-10-29 10:08:19 +08002309 }
2310
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 MBEDTLS_SSL_DEBUG_MSG(3, ("got no certificate request"));
Ronald Cron19385882022-06-15 16:26:13 +02002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 return SSL_CERTIFICATE_REQUEST_SKIP;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002314}
2315
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002316/*
2317 * ssl_tls13_parse_certificate_request()
2318 * Parse certificate request
2319 * struct {
2320 * opaque certificate_request_context<0..2^8-1>;
2321 * Extension extensions<2..2^16-1>;
2322 * } CertificateRequest;
2323 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002324MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002325static int ssl_tls13_parse_certificate_request(mbedtls_ssl_context *ssl,
2326 const unsigned char *buf,
2327 const unsigned char *end)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002328{
2329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2330 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002331 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002332 size_t extensions_len = 0;
2333 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002334 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002335
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002336 /* ...
2337 * opaque certificate_request_context<0..2^8-1>
2338 * ...
2339 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002341 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002342 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002343
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 if (certificate_request_context_len > 0) {
2345 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_request_context_len);
2346 MBEDTLS_SSL_DEBUG_BUF(3, "Certificate Request Context",
2347 p, certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002348
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002349 handshake->certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 mbedtls_calloc(1, certificate_request_context_len);
2351 if (handshake->certificate_request_context == NULL) {
2352 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
2353 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002354 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 memcpy(handshake->certificate_request_context, p,
2356 certificate_request_context_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002357 p += certificate_request_context_len;
2358 }
2359
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002360 /* ...
2361 * Extension extensions<2..2^16-1>;
2362 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2365 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002366 p += 2;
2367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002369 extensions_end = p + extensions_len;
2370
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002371 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yuc55a6af2022-08-04 17:01:21 +08002372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 while (p < extensions_end) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002374 unsigned int extension_type;
2375 size_t extension_data_len;
2376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
2378 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2379 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002380 p += 4;
2381
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002383
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002384 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, extension_type,
2386 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR);
2387 if (ret != 0) {
2388 return ret;
2389 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002390
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 switch (extension_type) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002392 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 MBEDTLS_SSL_DEBUG_MSG(3,
2394 ("found signature algorithms extension"));
2395 ret = mbedtls_ssl_parse_sig_alg_ext(ssl, p,
2396 p + extension_data_len);
2397 if (ret != 0) {
2398 return ret;
2399 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002400
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002401 break;
2402
2403 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002404 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu6d0e78b2022-10-31 14:13:25 +08002405 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 extension_type, "( ignored )");
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002407 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002408 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002409
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002410 p += extension_data_len;
2411 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002412
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2414 handshake->received_extensions);
Jerry Yuc55a6af2022-08-04 17:01:21 +08002415
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002416 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 if (p != end) {
2418 MBEDTLS_SSL_DEBUG_MSG(1,
2419 ("CertificateRequest misaligned"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002420 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002421 }
Jerry Yuc55a6af2022-08-04 17:01:21 +08002422
Jerry Yu0c354a22022-08-29 15:25:36 +08002423 /* RFC 8446 section 4.3.2
Jerry Yuc55a6af2022-08-04 17:01:21 +08002424 *
2425 * The "signature_algorithms" extension MUST be specified
2426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 if ((handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(SIG_ALG)) == 0) {
2428 MBEDTLS_SSL_DEBUG_MSG(3,
2429 ("no signature algorithms extension found"));
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002430 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002431 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002432
Jerry Yu7840f812022-01-29 10:26:51 +08002433 ssl->handshake->client_auth = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 return 0;
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002435
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002436decode_error:
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2438 MBEDTLS_ERR_SSL_DECODE_ERROR);
2439 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002440}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002441
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002442/*
2443 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2444 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002445MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002446static int ssl_tls13_process_certificate_request(mbedtls_ssl_context *ssl)
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002447{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002448 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002449
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate request"));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 if (ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST) {
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002455 unsigned char *buf;
2456 size_t buf_len;
2457
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002458 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2459 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2460 &buf, &buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002461
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002462 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_request(
2463 ssl, buf, buf + buf_len));
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002464
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002465 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
2466 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2467 buf, buf_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002469 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 } else {
2471 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002472 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2473 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002474 }
2475
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
Jerry Yud2674312021-10-29 10:08:19 +08002477
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002478cleanup:
2479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate request"));
2481 return ret;
Jerry Yud2674312021-10-29 10:08:19 +08002482}
2483
2484/*
Jerry Yu687101b2021-09-14 16:03:56 +08002485 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2486 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002487MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002488static int ssl_tls13_process_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002489{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002490 int ret;
2491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2493 if (ret != 0) {
2494 return ret;
2495 }
Xiaofei Bai947571e2021-09-29 09:12:03 +00002496
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2498 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002499}
2500
2501/*
2502 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
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_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002506{
Jerry Yu30b071c2021-09-12 20:16:03 +08002507 int ret;
2508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2510 if (ret != 0) {
2511 return ret;
2512 }
Jerry Yu30b071c2021-09-12 20:16:03 +08002513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2515 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002516}
Ronald Cron928cbd32022-10-04 16:14:26 +02002517#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002518
Jerry Yu687101b2021-09-14 16:03:56 +08002519/*
2520 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2521 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002522MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002523static int ssl_tls13_process_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002524{
XiaokangQianac0385c2021-11-03 06:40:11 +00002525 int ret;
2526
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2528 if (ret != 0) {
2529 return ret;
2530 }
XiaokangQianac0385c2021-11-03 06:40:11 +00002531
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2533 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002534 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2536 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2537 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002538 }
2539
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002540#if defined(MBEDTLS_SSL_EARLY_DATA)
2541 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2542 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
Xiaokang Qianbd0ab062023-02-02 05:56:30 +00002543 } else if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED) {
2544 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Xiaokang Qianbc75bc02022-12-19 06:16:42 +00002545 } else
2546#endif /* MBEDTLS_SSL_EARLY_DATA */
2547 {
2548#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2549 mbedtls_ssl_handshake_set_state(
2550 ssl, MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED);
2551#else
2552 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2553#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2554 }
Ronald Cron49ad6192021-11-24 16:25:31 +01002555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002557}
2558
2559/*
Jerry Yu566c7812022-01-26 15:41:22 +08002560 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2561 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002562MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002563static int ssl_tls13_write_client_certificate(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002564{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002565 int non_empty_certificate_msg = 0;
2566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 MBEDTLS_SSL_DEBUG_MSG(1,
2568 ("Switch to handshake traffic keys for outbound traffic"));
2569 mbedtls_ssl_set_outbound_transform(ssl, ssl->handshake->transform_handshake);
Jerry Yu5cc35062022-01-28 16:16:08 +08002570
Ronald Cron928cbd32022-10-04 16:14:26 +02002571#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 if (ssl->handshake->client_auth) {
2573 int ret = mbedtls_ssl_tls13_write_certificate(ssl);
2574 if (ret != 0) {
2575 return ret;
2576 }
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 if (mbedtls_ssl_own_cert(ssl) != NULL) {
Ronald Cron7a94aca2022-03-09 07:44:27 +01002579 non_empty_certificate_msg = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 }
2581 } else {
2582 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate"));
Ronald Cron7a94aca2022-03-09 07:44:27 +01002583 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002584#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if (non_empty_certificate_msg) {
2587 mbedtls_ssl_handshake_set_state(ssl,
2588 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2589 } else {
2590 MBEDTLS_SSL_DEBUG_MSG(2, ("skip write certificate verify"));
2591 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2592 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 return 0;
Jerry Yu566c7812022-01-26 15:41:22 +08002595}
2596
Ronald Cron928cbd32022-10-04 16:14:26 +02002597#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002598/*
2599 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2600 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002601MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002602static int ssl_tls13_write_client_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu566c7812022-01-26 15:41:22 +08002603{
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
Ronald Crona8b38872022-03-09 07:59:25 +01002605
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 if (ret == 0) {
2607 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2608 }
Ronald Crona8b38872022-03-09 07:59:25 +01002609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 return ret;
Jerry Yu566c7812022-01-26 15:41:22 +08002611}
Ronald Cron928cbd32022-10-04 16:14:26 +02002612#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002613
2614/*
Jerry Yu687101b2021-09-14 16:03:56 +08002615 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2616 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002617MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002618static int ssl_tls13_write_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002619{
XiaokangQian0fa66432021-11-15 03:33:57 +00002620 int ret;
2621
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2623 if (ret != 0) {
2624 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002625 }
2626
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2628 if (ret != 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00002629 MBEDTLS_SSL_DEBUG_RET(
2630 1, "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 return ret;
2632 }
2633
2634 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_FLUSH_BUFFERS);
2635 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002636}
2637
2638/*
2639 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2640 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002641MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002642static int ssl_tls13_flush_buffers(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002643{
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
2645 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2646 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002647}
2648
2649/*
2650 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2651 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002652MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002653static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu687101b2021-09-14 16:03:56 +08002654{
Jerry Yu378254d2021-10-30 21:44:47 +08002655
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yu378254d2021-10-30 21:44:47 +08002657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2659 return 0;
Jerry Yu687101b2021-09-14 16:03:56 +08002660}
2661
Jerry Yuf8a49942022-07-07 11:32:32 +00002662#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2663
Jerry Yua0446a02022-07-13 11:22:55 +08002664MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002665static int ssl_tls13_parse_new_session_ticket_exts(mbedtls_ssl_context *ssl,
2666 const unsigned char *buf,
2667 const unsigned char *end)
Jerry Yuf8a49942022-07-07 11:32:32 +00002668{
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002669 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002670 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002671
Jerry Yuf8a49942022-07-07 11:32:32 +00002672
Jerry Yuedab6372022-10-31 14:37:31 +08002673 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 while (p < end) {
Jerry Yuf8a49942022-07-07 11:32:32 +00002676 unsigned int extension_type;
2677 size_t extension_data_len;
Jerry Yu0c354a22022-08-29 15:25:36 +08002678 int ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
2681 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
2682 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuf8a49942022-07-07 11:32:32 +00002683 p += 4;
2684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extension_data_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002686
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002687 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, extension_type,
2689 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST);
2690 if (ret != 0) {
2691 return ret;
2692 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 switch (extension_type) {
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002695#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002696 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 if (extension_data_len != 4) {
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002698 MBEDTLS_SSL_PEND_FATAL_ALERT(
2699 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 MBEDTLS_ERR_SSL_DECODE_ERROR);
2701 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002702 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 if (ssl->session != NULL) {
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002704 ssl->session->ticket_flags |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA;
Xiaokang Qian2d87a9e2022-11-09 07:55:48 +00002706 }
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002707 break;
Xiaokang Qian0cc43202022-11-16 08:43:50 +00002708#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qianf447e8a2022-11-08 07:02:27 +00002709
Jerry Yuf8a49942022-07-07 11:32:32 +00002710 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08002711 MBEDTLS_SSL_PRINT_EXT(
Jerry Yuedab6372022-10-31 14:37:31 +08002712 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 extension_type, "( ignored )");
Jerry Yuf8a49942022-07-07 11:32:32 +00002714 break;
2715 }
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002716
Jerry Yuf8a49942022-07-07 11:32:32 +00002717 p += extension_data_len;
2718 }
2719
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2721 handshake->received_extensions);
Jerry Yu6ba9f1c2022-08-04 17:53:25 +08002722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002724}
2725
2726/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002727 * From RFC8446, page 74
2728 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002729 * struct {
2730 * uint32 ticket_lifetime;
2731 * uint32 ticket_age_add;
2732 * opaque ticket_nonce<0..255>;
2733 * opaque ticket<1..2^16-1>;
2734 * Extension extensions<0..2^16-2>;
2735 * } NewSessionTicket;
2736 *
2737 */
Jerry Yua0446a02022-07-13 11:22:55 +08002738MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002739static int ssl_tls13_parse_new_session_ticket(mbedtls_ssl_context *ssl,
2740 unsigned char *buf,
2741 unsigned char *end,
2742 unsigned char **ticket_nonce,
2743 size_t *ticket_nonce_len)
Jerry Yuf8a49942022-07-07 11:32:32 +00002744{
2745 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2746 unsigned char *p = buf;
2747 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002748 size_t ticket_len;
2749 unsigned char *ticket;
2750 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002751
Jerry Yucb3b1392022-07-12 06:09:38 +00002752 *ticket_nonce = NULL;
2753 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002754 /*
2755 * ticket_lifetime 4 bytes
2756 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002757 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002758 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 9);
Jerry Yuf8a49942022-07-07 11:32:32 +00002760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
2762 MBEDTLS_SSL_DEBUG_MSG(3,
2763 ("ticket_lifetime: %u",
2764 (unsigned int) session->ticket_lifetime));
Jerry Yuf8a49942022-07-07 11:32:32 +00002765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 4);
2767 MBEDTLS_SSL_DEBUG_MSG(3,
2768 ("ticket_age_add: %u",
2769 (unsigned int) session->ticket_age_add));
Jerry Yuf8a49942022-07-07 11:32:32 +00002770
Jerry Yucb3b1392022-07-12 06:09:38 +00002771 *ticket_nonce_len = p[8];
2772 p += 9;
2773
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002775 *ticket_nonce = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len);
Jerry Yucb3b1392022-07-12 06:09:38 +00002777 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002778
2779 /* Ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2781 ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002782 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ticket_len);
2784 MBEDTLS_SSL_DEBUG_BUF(3, "received ticket", p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002785
2786 /* Check if we previously received a ticket already. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 if (session->ticket != NULL || session->ticket_len > 0) {
2788 mbedtls_free(session->ticket);
Jerry Yuf8a49942022-07-07 11:32:32 +00002789 session->ticket = NULL;
2790 session->ticket_len = 0;
2791 }
2792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 if ((ticket = mbedtls_calloc(1, ticket_len)) == NULL) {
2794 MBEDTLS_SSL_DEBUG_MSG(1, ("ticket alloc failed"));
2795 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yuf8a49942022-07-07 11:32:32 +00002796 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 memcpy(ticket, p, ticket_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002798 p += ticket_len;
2799 session->ticket = ticket;
2800 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002801
Pengyu Lv9f926952022-11-17 15:22:33 +08002802 /* Clear all flags in ticket_flags */
Pengyu Lv80270b22023-01-12 11:54:04 +08002803 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002804 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lv9f926952022-11-17 15:22:33 +08002805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
2807 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuf8a49942022-07-07 11:32:32 +00002808 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 MBEDTLS_SSL_DEBUG_BUF(3, "ticket extension", p, extensions_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002812
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 ret = ssl_tls13_parse_new_session_ticket_exts(ssl, p, p + extensions_len);
2814 if (ret != 0) {
2815 MBEDTLS_SSL_DEBUG_RET(1,
2816 "ssl_tls13_parse_new_session_ticket_exts",
2817 ret);
2818 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002819 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002820
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002821 /* session has been updated, allow export */
2822 session->exported = 0;
2823
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 return 0;
Jerry Yucb3b1392022-07-12 06:09:38 +00002825}
2826
Jerry Yua0446a02022-07-13 11:22:55 +08002827MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002828static int ssl_tls13_postprocess_new_session_ticket(mbedtls_ssl_context *ssl,
2829 unsigned char *ticket_nonce,
2830 size_t ticket_nonce_len)
Jerry Yucb3b1392022-07-12 06:09:38 +00002831{
2832 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2833 mbedtls_ssl_session *session = ssl->session;
2834 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2835 psa_algorithm_t psa_hash_alg;
2836 int hash_length;
2837
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002838#if defined(MBEDTLS_HAVE_TIME)
2839 /* Store ticket creation time */
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 session->ticket_received = mbedtls_time(NULL);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002841#endif
2842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
2844 if (ciphersuite_info == NULL) {
2845 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2846 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf8a49942022-07-07 11:32:32 +00002847 }
2848
Dave Rodgman2eab4622023-10-05 13:30:37 +01002849 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2851 if (hash_length == -1 ||
2852 (size_t) hash_length > sizeof(session->resumption_key)) {
2853 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu3afdf362022-07-20 17:34:14 +08002854 }
2855
Jerry Yuf8a49942022-07-07 11:32:32 +00002856
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2858 session->app_secrets.resumption_master_secret,
2859 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002860
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002861 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002862 *
2863 * HKDF-Expand-Label( resumption_master_secret,
2864 * "resumption", ticket_nonce, Hash.length )
2865 */
2866 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 psa_hash_alg,
2868 session->app_secrets.resumption_master_secret,
2869 hash_length,
2870 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2871 ticket_nonce,
2872 ticket_nonce_len,
2873 session->resumption_key,
2874 hash_length);
Jerry Yuf8a49942022-07-07 11:32:32 +00002875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 if (ret != 0) {
2877 MBEDTLS_SSL_DEBUG_RET(2,
2878 "Creating the ticket-resumed PSK failed",
2879 ret);
2880 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002881 }
2882
Jerry Yu0a430c82022-07-20 11:02:48 +08002883 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2886 session->resumption_key,
2887 session->resumption_key_len);
Jerry Yuf8a49942022-07-07 11:32:32 +00002888
Pengyu Lv9f926952022-11-17 15:22:33 +08002889 /* Set ticket_flags depends on the selected key exchange modes */
Pengyu Lv80270b22023-01-12 11:54:04 +08002890 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002891 session, ssl->conf->tls13_kex_modes);
Pengyu Lv4938a562023-01-16 11:28:49 +08002892 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002893
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 return 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002895}
2896
2897/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002898 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002899 */
Jerry Yua0446a02022-07-13 11:22:55 +08002900MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002901static int ssl_tls13_process_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuf8a49942022-07-07 11:32:32 +00002902{
2903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2904 unsigned char *buf;
2905 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002906 unsigned char *ticket_nonce;
2907 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse new session ticket"));
Jerry Yuf8a49942022-07-07 11:32:32 +00002910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
2912 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2913 &buf, &buf_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_new_session_ticket(
2916 ssl, buf, buf + buf_len,
2917 &ticket_nonce, &ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_new_session_ticket(
2920 ssl, ticket_nonce, ticket_nonce_len));
Jerry Yuf8a49942022-07-07 11:32:32 +00002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002923
Jerry Yuf8a49942022-07-07 11:32:32 +00002924cleanup:
2925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse new session ticket"));
2927 return ret;
Jerry Yuf8a49942022-07-07 11:32:32 +00002928}
2929#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl)
Jerry Yubc20bdd2021-08-24 15:59:48 +08002932{
Jerry Yu92c6b402021-08-27 16:59:09 +08002933 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 switch (ssl->state) {
Jerry Yu92c6b402021-08-27 16:59:09 +08002936 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Jerry Yuddda0502022-12-01 19:43:12 +08002938 break;
2939
Jerry Yu92c6b402021-08-27 16:59:09 +08002940 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 ret = mbedtls_ssl_write_client_hello(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002942 break;
2943
2944 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 ret = ssl_tls13_process_server_hello(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002946 break;
2947
2948 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 ret = ssl_tls13_process_encrypted_extensions(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002950 break;
2951
Ronald Cron928cbd32022-10-04 16:14:26 +02002952#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002953 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 ret = ssl_tls13_process_certificate_request(ssl);
Jerry Yud2674312021-10-29 10:08:19 +08002955 break;
2956
Jerry Yu687101b2021-09-14 16:03:56 +08002957 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 ret = ssl_tls13_process_server_certificate(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002959 break;
2960
2961 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 ret = ssl_tls13_process_certificate_verify(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002963 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002964#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002965
2966 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 ret = ssl_tls13_process_server_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002968 break;
2969
Xiaokang Qian125afcb2022-10-28 06:04:06 +00002970 case MBEDTLS_SSL_END_OF_EARLY_DATA:
2971 ret = ssl_tls13_write_end_of_early_data(ssl);
2972 break;
2973
Jerry Yu566c7812022-01-26 15:41:22 +08002974 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 ret = ssl_tls13_write_client_certificate(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002976 break;
2977
Ronald Cron928cbd32022-10-04 16:14:26 +02002978#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002979 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 ret = ssl_tls13_write_client_certificate_verify(ssl);
Jerry Yu566c7812022-01-26 15:41:22 +08002981 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002982#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002983
Jerry Yu687101b2021-09-14 16:03:56 +08002984 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 ret = ssl_tls13_write_client_finished(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002986 break;
2987
2988 case MBEDTLS_SSL_FLUSH_BUFFERS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002989 ret = ssl_tls13_flush_buffers(ssl);
Jerry Yu687101b2021-09-14 16:03:56 +08002990 break;
2991
2992 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu92c6b402021-08-27 16:59:09 +08002994 break;
2995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 /*
2997 * Injection of dummy-CCS's for middlebox compatibility
2998 */
Ronald Cron49ad6192021-11-24 16:25:31 +01002999#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00003000 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3002 if (ret == 0) {
3003 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3004 }
Ronald Cron9f55f632022-02-02 16:02:47 +01003005 break;
3006
3007 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3009 if (ret == 0) {
Xiaokang Qian958b6ff2023-03-29 10:37:35 +00003010 mbedtls_ssl_handshake_set_state(
3011 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 }
Ronald Cron49ad6192021-11-24 16:25:31 +01003013 break;
Xiaokang Qianf6d8fd32023-02-02 02:46:26 +00003014
Xiaokang Qian592021a2023-01-04 10:47:05 +00003015 case MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO:
3016 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3017 if (ret == 0) {
3018 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
3019
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003020#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian592021a2023-01-04 10:47:05 +00003021 MBEDTLS_SSL_DEBUG_MSG(
3022 1, ("Switch to early data keys for outbound traffic"));
3023 mbedtls_ssl_set_outbound_transform(
3024 ssl, ssl->handshake->transform_earlydata);
Xiaokang Qian33ff8682023-01-10 06:32:12 +00003025#endif
Xiaokang Qian592021a2023-01-04 10:47:05 +00003026 }
3027 break;
Ronald Cron49ad6192021-11-24 16:25:31 +01003028#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3029
Jerry Yuf8a49942022-07-07 11:32:32 +00003030#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003031 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 ret = ssl_tls13_process_new_session_ticket(ssl);
3033 if (ret != 0) {
Jerry Yuf8a49942022-07-07 11:32:32 +00003034 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 }
Jerry Yuf8a49942022-07-07 11:32:32 +00003036 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
3037 break;
3038#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3039
Jerry Yu92c6b402021-08-27 16:59:09 +08003040 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu92c6b402021-08-27 16:59:09 +08003043 }
3044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 return ret;
Jerry Yu92c6b402021-08-27 16:59:09 +08003046}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08003047
Jerry Yufb4b6472022-01-27 15:03:26 +08003048#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */