blob: 9c73c7a1a58b7055ebab4406639e6d62469c13b6 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
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
Gilles Peskine449bd832023-01-11 14:50:10 +01006 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08007
8#include "common.h"
9
Jerry Yufb4b6472022-01-27 15:03:26 +080010#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080011
Valerio Settib4f50762024-01-17 10:24:52 +010012#include "debug_internal.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000013#include "mbedtls/error.h"
14#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000015#include "mbedtls/constant_time.h"
Manuel Pégourié-Gonnardd55d66f2023-06-20 10:14:58 +020016#include "mbedtls/oid.h"
Valerio Setti384fbde2024-01-02 13:26:40 +010017#include "mbedtls/psa_util.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080018
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000019#include "ssl_misc.h"
20#include "ssl_tls13_keys.h"
21#include "ssl_debug_helpers.h"
22
Jerry Yuf35ba382022-08-23 17:58:26 +080023
Jerry Yuc5a23a02022-08-25 10:51:44 +080024static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +010025 mbedtls_ssl_context *ssl,
26 unsigned int cipher_suite)
Jerry Yuf35ba382022-08-23 17:58:26 +080027{
28 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +010029 if (!mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
30 return NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +080031 }
Gilles Peskine449bd832023-01-11 14:50:10 +010032
33 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
34 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
35 ssl->tls_version,
36 ssl->tls_version) != 0)) {
37 return NULL;
38 }
39 return ciphersuite_info;
Jerry Yuf35ba382022-08-23 17:58:26 +080040}
41
Ronald Cron89089cc2024-02-14 18:18:08 +010042static void ssl_tls13_select_ciphersuite(
43 mbedtls_ssl_context *ssl,
44 const unsigned char *cipher_suites,
45 const unsigned char *cipher_suites_end,
46 int psk_ciphersuite_id,
47 psa_algorithm_t psk_hash_alg,
48 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
49{
50 *selected_ciphersuite_info = NULL;
51
52 /*
Ronald Cron38117652024-03-05 09:05:46 +010053 * In a compliant ClientHello the byte-length of the list of ciphersuites
54 * is even and this function relies on this fact. This should have been
55 * checked in the main ClientHello parsing function. Double check here.
Ronald Cron89089cc2024-02-14 18:18:08 +010056 */
57 if ((cipher_suites_end - cipher_suites) & 1) {
58 return;
59 }
60
61 for (const unsigned char *p = cipher_suites;
62 p < cipher_suites_end; p += 2) {
63 /*
64 * "cipher_suites_end - p is even" is an invariant of the loop. As
65 * cipher_suites_end - p > 0, we have cipher_suites_end - p >= 2 and it
66 * is thus safe to read two bytes.
67 */
68 uint16_t id = MBEDTLS_GET_UINT16_BE(p, 0);
69
70 const mbedtls_ssl_ciphersuite_t *info =
71 ssl_tls13_validate_peer_ciphersuite(ssl, id);
72 if (info == NULL) {
73 continue;
74 }
75
76 /*
Ronald Cron7cab4f82024-03-07 15:09:09 +010077 * If a valid PSK ciphersuite identifier has been passed in, we want
78 * an exact match.
Ronald Cron89089cc2024-02-14 18:18:08 +010079 */
80 if (psk_ciphersuite_id != 0) {
81 if (id != psk_ciphersuite_id) {
82 continue;
83 }
84 } else if (psk_hash_alg != PSA_ALG_NONE) {
85 if (mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) info->mac) !=
86 psk_hash_alg) {
87 continue;
88 }
89 }
90
91 *selected_ciphersuite_info = info;
92 return;
93 }
94
Ronald Cron19521dd2024-03-07 15:09:41 +010095 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite, psk_ciphersuite_id=%x, psk_hash_alg=%x",
96 (unsigned) psk_ciphersuite_id, psk_hash_alg));
Ronald Cron89089cc2024-02-14 18:18:08 +010097}
98
Ronald Cron41a443a2022-10-04 16:38:25 +020099#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +0000100/* From RFC 8446:
101 *
102 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
103 * struct {
104 * PskKeyExchangeMode ke_modes<1..255>;
105 * } PskKeyExchangeModes;
106 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800107MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100108static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
109 const unsigned char *buf,
110 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +0000111{
Jerry Yu299e31f2022-07-13 23:06:36 +0800112 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +0000113 size_t ke_modes_len;
114 int ke_modes = 0;
115
Jerry Yu854dd9e2022-07-15 14:28:27 +0800116 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +0800118 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +0000119 /* Currently, there are only two PSK modes, so even without looking
120 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100121 if (ke_modes_len > 2) {
122 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
123 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
124 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +0800125 }
Jerry Yue19e3b92022-07-08 12:04:51 +0000126
Gilles Peskine449bd832023-01-11 14:50:10 +0100127 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +0000128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 while (ke_modes_len-- != 0) {
130 switch (*p++) {
131 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
132 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
133 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
134 break;
135 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
136 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
137 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
138 break;
139 default:
140 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
141 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
142 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +0000143 }
144 }
145
146 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +0000148}
Jerry Yu1c105562022-07-10 06:32:38 +0000149
Ronald Cron38117652024-03-05 09:05:46 +0100150/*
151 * Non-error return values of
152 * ssl_tls13_offered_psks_check_identity_match_ticket() and
153 * ssl_tls13_offered_psks_check_identity_match(). They are positive to
154 * not collide with error codes that are negative. Zero
155 * (SSL_TLS1_3_PSK_IDENTITY_MATCH) in case of success as it may be propagated
156 * up by the callers of this function as a generic success condition.
157 *
158 * The return value SSL_TLS1_3_PSK_IDENTITY_MATCH_BUT_PSK_NOT_USABLE means
Ronald Cron7cab4f82024-03-07 15:09:09 +0100159 * that the pre-shared-key identity matches that of a ticket or an externally-
Ronald Cron38117652024-03-05 09:05:46 +0100160 * provisioned pre-shared-key. We have thus been able to retrieve the
161 * attributes of the pre-shared-key but at least one of them does not meet
162 * some criteria and the pre-shared-key cannot be used. For example, a ticket
163 * is expired or its version is not TLS 1.3. Note eventually that the return
164 * value SSL_TLS1_3_PSK_IDENTITY_MATCH_BUT_PSK_NOT_USABLE does not have
165 * anything to do with binder check. A binder check is done only when a
166 * suitable pre-shared-key has been selected and only for that selected
167 * pre-shared-key: if the binder check fails, we fail the handshake and we do
168 * not try to find another pre-shared-key for which the binder check would
169 * succeed as recommended by the specification.
170 */
Ronald Cronfbae94a2023-12-05 18:15:14 +0100171#define SSL_TLS1_3_PSK_IDENTITY_DOES_NOT_MATCH 2
172#define SSL_TLS1_3_PSK_IDENTITY_MATCH_BUT_PSK_NOT_USABLE 1
173#define SSL_TLS1_3_PSK_IDENTITY_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800174
175#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lv29daf4a2023-10-30 17:13:30 +0800176MBEDTLS_CHECK_RETURN_CRITICAL
Pengyu Lvbc4aab72023-12-01 15:37:24 +0800177static int ssl_tls13_key_exchange_is_psk_available(mbedtls_ssl_context *ssl);
Pengyu Lv29daf4a2023-10-30 17:13:30 +0800178MBEDTLS_CHECK_RETURN_CRITICAL
Pengyu Lvbc4aab72023-12-01 15:37:24 +0800179static int ssl_tls13_key_exchange_is_psk_ephemeral_available(mbedtls_ssl_context *ssl);
Jerry Yu95699e72022-08-21 19:22:23 +0800180
181MBEDTLS_CHECK_RETURN_CRITICAL
182static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 mbedtls_ssl_context *ssl,
184 const unsigned char *identity,
185 size_t identity_len,
186 uint32_t obfuscated_ticket_age,
187 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800188{
Jerry Yufd310eb2022-09-06 09:16:35 +0800189 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800190 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800191#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucebffc32022-12-15 18:00:05 +0800192 mbedtls_ms_time_t now;
193 mbedtls_ms_time_t server_age;
Jerry Yu713ce1f2023-11-17 15:32:12 +0800194 uint32_t client_age;
Jerry Yucebffc32022-12-15 18:00:05 +0800195 mbedtls_ms_time_t age_diff;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800196#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800197
198 ((void) obfuscated_ticket_age);
199
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800201
Jerry Yufd310eb2022-09-06 09:16:35 +0800202 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100203 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
Ronald Cronfbae94a2023-12-05 18:15:14 +0100204 return SSL_TLS1_3_PSK_IDENTITY_DOES_NOT_MATCH;
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 }
Jerry Yu95699e72022-08-21 19:22:23 +0800206
Jerry Yu4746b102022-09-13 11:11:48 +0800207 /* We create a copy of the encrypted ticket since the ticket parsing
208 * function is allowed to use its input buffer as an output buffer
209 * (in-place decryption). We do, however, need the original buffer for
210 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800211 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 ticket_buffer = mbedtls_calloc(1, identity_len);
213 if (ticket_buffer == NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100214 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800215 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100216 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800217
Ronald Cronfbae94a2023-12-05 18:15:14 +0100218 ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
219 session,
220 ticket_buffer, identity_len);
Ronald Cronf602f7b2024-03-05 09:11:55 +0100221 switch (ret) {
222 case 0:
223 ret = SSL_TLS1_3_PSK_IDENTITY_MATCH;
224 break;
225
226 case MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
Ronald Cronfbae94a2023-12-05 18:15:14 +0100228 ret = SSL_TLS1_3_PSK_IDENTITY_MATCH_BUT_PSK_NOT_USABLE;
Ronald Cronf602f7b2024-03-05 09:11:55 +0100229 break;
230
231 case MBEDTLS_ERR_SSL_INVALID_MAC:
232 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
Ronald Cronfbae94a2023-12-05 18:15:14 +0100233 ret = SSL_TLS1_3_PSK_IDENTITY_DOES_NOT_MATCH;
Ronald Cronf602f7b2024-03-05 09:11:55 +0100234 break;
235
236 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100237 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
Ronald Cronf602f7b2024-03-05 09:11:55 +0100238 ret = SSL_TLS1_3_PSK_IDENTITY_DOES_NOT_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800239 }
240
241 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800243
Ronald Cronfbae94a2023-12-05 18:15:14 +0100244 if (ret != SSL_TLS1_3_PSK_IDENTITY_MATCH) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800245 goto exit;
246 }
Jerry Yu95699e72022-08-21 19:22:23 +0800247
Ronald Cron38117652024-03-05 09:05:46 +0100248 /*
249 * The identity matches that of a ticket. Now check that it has suitable
250 * attributes and bet it will not be the case.
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800251 */
Ronald Cronfbae94a2023-12-05 18:15:14 +0100252 ret = SSL_TLS1_3_PSK_IDENTITY_MATCH_BUT_PSK_NOT_USABLE;
Pengyu Lv29daf4a2023-10-30 17:13:30 +0800253
Ronald Cronfbae94a2023-12-05 18:15:14 +0100254 if (session->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
255 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket TLS version is not 1.3."));
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800256 goto exit;
257 }
258
Gilles Peskine449bd832023-01-11 14:50:10 +0100259#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucebffc32022-12-15 18:00:05 +0800260 now = mbedtls_ms_time();
Gilles Peskine449bd832023-01-11 14:50:10 +0100261
Jerry Yu25ba4d42023-11-10 14:12:20 +0800262 if (now < session->ticket_creation_time) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu713ce1f2023-11-17 15:32:12 +0800264 3, ("Invalid ticket creation time ( now = %" MBEDTLS_PRINTF_MS_TIME
265 ", creation_time = %" MBEDTLS_PRINTF_MS_TIME " )",
Jerry Yu25ba4d42023-11-10 14:12:20 +0800266 now, session->ticket_creation_time));
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 goto exit;
268 }
269
Jerry Yu25ba4d42023-11-10 14:12:20 +0800270 server_age = now - session->ticket_creation_time;
Jerry Yu95699e72022-08-21 19:22:23 +0800271
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800272 /* RFC 8446 section 4.6.1
273 *
274 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
275 *
276 * RFC 8446 section 4.2.11.1
277 *
278 * Clients MUST NOT attempt to use tickets which have ages greater than
279 * the "ticket_lifetime" value which was provided with the ticket.
280 *
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800281 */
Jerry Yu8e0174a2023-11-10 13:58:16 +0800282 if (server_age > MBEDTLS_SSL_TLS1_3_MAX_ALLOWED_TICKET_LIFETIME * 1000) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800283 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yud84c14f2023-11-16 13:33:57 +0800284 3, ("Ticket age exceeds limitation ticket_age = %" MBEDTLS_PRINTF_MS_TIME,
Jerry Yucebffc32022-12-15 18:00:05 +0800285 server_age));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800286 goto exit;
287 }
Jerry Yu95699e72022-08-21 19:22:23 +0800288
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800289 /* RFC 8446 section 4.2.10
290 *
291 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
292 * the ticket age for the selected PSK identity (computed by subtracting
293 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
294 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800295 *
Jerry Yu31b601a2023-11-10 11:27:21 +0800296 * NOTE: The typical accuracy of an RTC crystal is ±100 to ±20 parts per
297 * million (360 to 72 milliseconds per hour). Default tolerance
Jerry Yu9cb953a2023-11-15 09:54:11 +0800298 * window is 6s, thus in the worst case clients and servers must
Jerry Yu31b601a2023-11-10 11:27:21 +0800299 * sync up their system time every 6000/360/2~=8 hours.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800300 */
Jerry Yucebffc32022-12-15 18:00:05 +0800301 client_age = obfuscated_ticket_age - session->ticket_age_add;
Jerry Yu60e99722023-11-20 09:55:24 +0800302 age_diff = server_age - (mbedtls_ms_time_t) client_age;
Jerry Yu28e7c552023-11-10 12:05:56 +0800303 if (age_diff < -MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE ||
Jerry Yucebffc32022-12-15 18:00:05 +0800304 age_diff > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800305 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yuf16efbc2023-10-30 11:06:24 +0800306 3, ("Ticket age outside tolerance window ( diff = %"
307 MBEDTLS_PRINTF_MS_TIME ")",
Jerry Yucebffc32022-12-15 18:00:05 +0800308 age_diff));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800309 goto exit;
310 }
Jerry Yu95699e72022-08-21 19:22:23 +0800311#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800312
Ronald Cron38117652024-03-05 09:05:46 +0100313 /*
314 * All good, we have found a suitable ticket.
315 */
Ronald Cronfbae94a2023-12-05 18:15:14 +0100316 ret = SSL_TLS1_3_PSK_IDENTITY_MATCH;
317
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800318exit:
Ronald Cronfbae94a2023-12-05 18:15:14 +0100319 if (ret != SSL_TLS1_3_PSK_IDENTITY_MATCH) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 mbedtls_ssl_session_free(session);
321 }
Jerry Yu95699e72022-08-21 19:22:23 +0800322
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
324 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800325}
326#endif /* MBEDTLS_SSL_SESSION_TICKETS */
327
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800328MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000329static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 mbedtls_ssl_context *ssl,
331 const unsigned char *identity,
332 size_t identity_len,
333 uint32_t obfuscated_ticket_age,
334 int *psk_type,
335 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000336{
Ronald Cron606671e2023-02-17 11:36:33 +0100337 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
338
Jerry Yu95699e72022-08-21 19:22:23 +0800339 ((void) session);
340 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800341 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800342
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800344
Jerry Yu95699e72022-08-21 19:22:23 +0800345#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Cron7a30cf52024-02-23 14:38:59 +0100346 ret = ssl_tls13_offered_psks_check_identity_match_ticket(
347 ssl, identity, identity_len, obfuscated_ticket_age, session);
348 if (ret == SSL_TLS1_3_PSK_IDENTITY_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800349 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Ronald Cron606671e2023-02-17 11:36:33 +0100350 ret = mbedtls_ssl_set_hs_psk(ssl,
351 session->resumption_key,
352 session->resumption_key_len);
353 if (ret != 0) {
354 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
355 return ret;
356 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100357
358 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
359 session->resumption_key,
360 session->resumption_key_len);
361 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
362 (unsigned) obfuscated_ticket_age));
Ronald Cronfbae94a2023-12-05 18:15:14 +0100363 return SSL_TLS1_3_PSK_IDENTITY_MATCH;
Ronald Cron7a30cf52024-02-23 14:38:59 +0100364 } else if (ret == SSL_TLS1_3_PSK_IDENTITY_MATCH_BUT_PSK_NOT_USABLE) {
365 return SSL_TLS1_3_PSK_IDENTITY_MATCH_BUT_PSK_NOT_USABLE;
Jerry Yu95699e72022-08-21 19:22:23 +0800366 }
367#endif /* MBEDTLS_SSL_SESSION_TICKETS */
368
Jerry Yu1c105562022-07-10 06:32:38 +0000369 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (ssl->conf->f_psk != NULL) {
371 if (ssl->conf->f_psk(
372 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
Ronald Cronfbae94a2023-12-05 18:15:14 +0100373 return SSL_TLS1_3_PSK_IDENTITY_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000374 }
Ronald Cronfbae94a2023-12-05 18:15:14 +0100375 return SSL_TLS1_3_PSK_IDENTITY_DOES_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000376 }
377
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000379 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100380 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800381 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 mbedtls_ct_memcmp(ssl->conf->psk_identity,
383 identity, identity_len) == 0) {
Ronald Cron606671e2023-02-17 11:36:33 +0100384 ret = mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
385 if (ret != 0) {
386 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
387 return ret;
388 }
Ronald Cronfbae94a2023-12-05 18:15:14 +0100389 return SSL_TLS1_3_PSK_IDENTITY_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000390 }
391
Ronald Cronfbae94a2023-12-05 18:15:14 +0100392 return SSL_TLS1_3_PSK_IDENTITY_DOES_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000393}
394
Ronald Cron38117652024-03-05 09:05:46 +0100395/*
396 * Non-error return values of ssl_tls13_offered_psks_check_binder_match().
397 * They are positive to not collide with error codes that are negative. Zero
398 * (SSL_TLS1_3_BINDER_MATCH) in case of success as it may be propagated up
399 * by the callers of this function as a generic success condition.
400 */
Ronald Cron6e311272023-12-05 17:57:01 +0100401#define SSL_TLS1_3_BINDER_DOES_NOT_MATCH 1
402#define SSL_TLS1_3_BINDER_MATCH 0
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800403MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000404static int ssl_tls13_offered_psks_check_binder_match(
405 mbedtls_ssl_context *ssl,
406 const unsigned char *binder, size_t binder_len,
407 int psk_type, psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000408{
409 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800410
Jerry Yudaf375a2022-07-20 21:31:43 +0800411 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000412 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800413 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800414 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800415 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000416
Jerry Yu1c105562022-07-10 06:32:38 +0000417 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800418 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200419 ssl, mbedtls_md_type_from_psa_alg(psk_hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 transcript, sizeof(transcript), &transcript_len);
421 if (ret != 0) {
422 return ret;
423 }
Jerry Yu1c105562022-07-10 06:32:38 +0000424
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
426 if (ret != 0) {
427 return ret;
428 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800429
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
431 psk, psk_len, psk_type,
432 transcript,
433 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800434#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800436#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 if (ret != 0) {
438 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
439 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000440 }
441
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
443 server_computed_binder, transcript_len);
444 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000445
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
Ronald Cron6e311272023-12-05 17:57:01 +0100447 return SSL_TLS1_3_BINDER_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000448 }
449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 mbedtls_platform_zeroize(server_computed_binder,
451 sizeof(server_computed_binder));
Ronald Cron6e311272023-12-05 17:57:01 +0100452 return SSL_TLS1_3_BINDER_DOES_NOT_MATCH;
Jerry Yuf35ba382022-08-23 17:58:26 +0800453}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800454
Jerry Yu82534862022-08-30 10:42:33 +0800455#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800456MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100457static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
458 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800459{
Jerry Yu82534862022-08-30 10:42:33 +0800460 dst->ticket_age_add = src->ticket_age_add;
461 dst->ticket_flags = src->ticket_flags;
462 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100463 if (src->resumption_key_len == 0) {
464 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
465 }
466 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800467
Jerry Yu33bf2402022-12-12 16:01:43 +0800468#if defined(MBEDTLS_SSL_EARLY_DATA)
469 dst->max_early_data_size = src->max_early_data_size;
Waleed Elmelegy2824a202024-02-23 17:51:47 +0000470
471#if defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +0000472 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
473 ret = mbedtls_ssl_session_set_alpn(dst, src->ticket_alpn);
474 if (ret != 0) {
475 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +0000476 }
477#endif /* MBEDTLS_SSL_ALPN */
478#endif /* MBEDTLS_SSL_EARLY_DATA*/
Jerry Yu33bf2402022-12-12 16:01:43 +0800479
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800481}
482#endif /* MBEDTLS_SSL_SESSION_TICKETS */
483
Ronald Cron79cdd412024-02-20 17:19:28 +0100484struct psk_attributes {
485 int type;
486 int key_exchange_mode;
Ronald Cron74a16292024-02-23 17:07:41 +0100487 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Ronald Cron79cdd412024-02-20 17:19:28 +0100488};
Ronald Cron16cc3702024-03-07 15:04:56 +0100489#define PSK_ATTRIBUTES_INIT { 0, 0, NULL }
Ronald Cron79cdd412024-02-20 17:19:28 +0100490
Jerry Yu1c105562022-07-10 06:32:38 +0000491/* Parser for pre_shared_key extension in client hello
492 * struct {
493 * opaque identity<1..2^16-1>;
494 * uint32 obfuscated_ticket_age;
495 * } PskIdentity;
496 *
497 * opaque PskBinderEntry<32..255>;
498 *
499 * struct {
500 * PskIdentity identities<7..2^16-1>;
501 * PskBinderEntry binders<33..2^16-1>;
502 * } OfferedPsks;
503 *
504 * struct {
505 * select (Handshake.msg_type) {
506 * case client_hello: OfferedPsks;
507 * ....
508 * };
509 * } PreSharedKeyExtension;
510 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800511MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000512static int ssl_tls13_parse_pre_shared_key_ext(
513 mbedtls_ssl_context *ssl,
514 const unsigned char *pre_shared_key_ext,
515 const unsigned char *pre_shared_key_ext_end,
516 const unsigned char *ciphersuites,
Ronald Cron79cdd412024-02-20 17:19:28 +0100517 const unsigned char *ciphersuites_end,
518 struct psk_attributes *psk)
Jerry Yu1c105562022-07-10 06:32:38 +0000519{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100520 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800521 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800522 const unsigned char *p_identity_len;
523 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000524 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800525 const unsigned char *binders;
526 const unsigned char *p_binder_len;
527 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000528 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800529 int matched_identity = -1;
530 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000531
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
533 pre_shared_key_ext,
534 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000535
Jerry Yu96a2e362022-07-21 15:11:34 +0800536 /* identities_len 2 bytes
537 * identities_data >= 7 bytes
538 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100539 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
540 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800541 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
543 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800544 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000545
Jerry Yu96a2e362022-07-21 15:11:34 +0800546 /* binders_len 2 bytes
547 * binders >= 33 bytes
548 */
Jerry Yu568ec252022-07-22 21:27:34 +0800549 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
551 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800552 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800554 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000555
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100556 ret = ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
557 identities_end - pre_shared_key_ext);
558 if (0 != ret) {
559 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
560 return ret;
561 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800562
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000564 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800565 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800566 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800567 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800568 size_t binder_len;
Ronald Cron89089cc2024-02-14 18:18:08 +0100569 int psk_ciphersuite_id;
570 psa_algorithm_t psk_hash_alg;
Ronald Croncf284562024-02-16 18:54:10 +0100571 int allowed_key_exchange_modes;
Ronald Cron74a16292024-02-23 17:07:41 +0100572
Jerry Yu82534862022-08-30 10:42:33 +0800573#if defined(MBEDTLS_SSL_SESSION_TICKETS)
574 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800576#endif
Jerry Yubb852022022-07-20 21:10:44 +0800577
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
579 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800580 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
582 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800583 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000584
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800586 binder_len = *p_binder_len;
587 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800589 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800590
Jerry Yu96a2e362022-07-21 15:11:34 +0800591 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000593 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 }
Jerry Yu1c105562022-07-10 06:32:38 +0000595
Jerry Yu96a2e362022-07-21 15:11:34 +0800596 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 ssl, identity, identity_len, obfuscated_ticket_age,
Ronald Cron79cdd412024-02-20 17:19:28 +0100598 &psk->type, &session);
Ronald Cronfbae94a2023-12-05 18:15:14 +0100599 if (ret != SSL_TLS1_3_PSK_IDENTITY_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800600 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800602
Gilles Peskine449bd832023-01-11 14:50:10 +0100603 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
Ronald Cron89089cc2024-02-14 18:18:08 +0100604
Ronald Cron79cdd412024-02-20 17:19:28 +0100605 switch (psk->type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800606 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
Ronald Cron89089cc2024-02-14 18:18:08 +0100607 psk_ciphersuite_id = 0;
608 psk_hash_alg = PSA_ALG_SHA_256;
Ronald Croncf284562024-02-16 18:54:10 +0100609 allowed_key_exchange_modes =
610 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
Jerry Yu0baf9072022-08-25 11:21:04 +0800611 break;
Jerry Yu82534862022-08-30 10:42:33 +0800612#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Cronf7e99162024-02-14 16:04:02 +0100613 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Ronald Cron89089cc2024-02-14 18:18:08 +0100614 psk_ciphersuite_id = session.ciphersuite;
615 psk_hash_alg = PSA_ALG_NONE;
Ronald Croncf284562024-02-16 18:54:10 +0100616 ssl->session_negotiate->ticket_flags = session.ticket_flags;
617 allowed_key_exchange_modes =
618 session.ticket_flags &
619 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
Jerry Yu0baf9072022-08-25 11:21:04 +0800620 break;
Ronald Cronf7e99162024-02-14 16:04:02 +0100621#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800622 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800624 }
Ronald Cron89089cc2024-02-14 18:18:08 +0100625
Ronald Cron79cdd412024-02-20 17:19:28 +0100626 psk->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
627
Ronald Croncf284562024-02-16 18:54:10 +0100628 if ((allowed_key_exchange_modes &
629 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) &&
630 ssl_tls13_key_exchange_is_psk_ephemeral_available(ssl)) {
Ronald Cron79cdd412024-02-20 17:19:28 +0100631 psk->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Ronald Croncf284562024-02-16 18:54:10 +0100632 } else if ((allowed_key_exchange_modes &
633 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) &&
634 ssl_tls13_key_exchange_is_psk_available(ssl)) {
Ronald Cron79cdd412024-02-20 17:19:28 +0100635 psk->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Ronald Croncf284562024-02-16 18:54:10 +0100636 }
637
Ronald Cron79cdd412024-02-20 17:19:28 +0100638 if (psk->key_exchange_mode == MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE) {
Ronald Croncf284562024-02-16 18:54:10 +0100639 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable PSK key exchange mode"));
640 continue;
641 }
642
Ronald Cron89089cc2024-02-14 18:18:08 +0100643 ssl_tls13_select_ciphersuite(ssl, ciphersuites, ciphersuites_end,
644 psk_ciphersuite_id, psk_hash_alg,
Ronald Cron74a16292024-02-23 17:07:41 +0100645 &psk->ciphersuite_info);
Ronald Cron89089cc2024-02-14 18:18:08 +0100646
Ronald Cron74a16292024-02-23 17:07:41 +0100647 if (psk->ciphersuite_info == NULL) {
Ronald Cron89089cc2024-02-14 18:18:08 +0100648#if defined(MBEDTLS_SSL_SESSION_TICKETS)
649 mbedtls_ssl_session_free(&session);
650#endif
651 /*
652 * We consider finding a ciphersuite suitable for the PSK as part
653 * of the validation of its binder. Thus if we do not find one, we
654 * abort the handshake with a decrypt_error alert.
655 */
Jerry Yuf35ba382022-08-23 17:58:26 +0800656 MBEDTLS_SSL_PEND_FATAL_ALERT(
657 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Ronald Cron89089cc2024-02-14 18:18:08 +0100659 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800660 }
661
Jerry Yu96a2e362022-07-21 15:11:34 +0800662 ret = ssl_tls13_offered_psks_check_binder_match(
Ronald Cron79cdd412024-02-20 17:19:28 +0100663 ssl, binder, binder_len, psk->type,
Ronald Cron74a16292024-02-23 17:07:41 +0100664 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) psk->ciphersuite_info->mac));
Ronald Cron6e311272023-12-05 17:57:01 +0100665 if (ret != SSL_TLS1_3_BINDER_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800666 /* For security reasons, the handshake should be aborted when we
667 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
668 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800669#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800671#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000673 MBEDTLS_SSL_DEBUG_RET(
674 1, "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800675 MBEDTLS_SSL_PEND_FATAL_ALERT(
676 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
678 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800679 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800680
681 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800682
Jerry Yu82534862022-08-30 10:42:33 +0800683#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Cron79cdd412024-02-20 17:19:28 +0100684 if (psk->type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
686 &session);
687 mbedtls_ssl_session_free(&session);
688 if (ret != 0) {
689 return ret;
690 }
Jerry Yu82534862022-08-30 10:42:33 +0800691 }
692#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000693 }
694
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 if (p_identity_len != identities_end || p_binder_len != binders_end) {
696 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
697 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
698 MBEDTLS_ERR_SSL_DECODE_ERROR);
699 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000700 }
701
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800702 /* Update the handshake transcript with the binder list. */
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000703 ret = ssl->handshake->update_checksum(
704 ssl, identities_end, (size_t) (binders_end - identities_end));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100705 if (0 != ret) {
706 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
707 return ret;
708 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 if (matched_identity == -1) {
Ronald Croncf284562024-02-16 18:54:10 +0100710 MBEDTLS_SSL_DEBUG_MSG(3, ("No usable PSK or ticket."));
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000712 }
713
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 ssl->handshake->selected_identity = (uint16_t) matched_identity;
715 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000716
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000718}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000719
720/*
721 * struct {
722 * select ( Handshake.msg_type ) {
723 * ....
724 * case server_hello:
725 * uint16 selected_identity;
726 * }
727 * } PreSharedKeyExtension;
728 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100729static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
730 unsigned char *buf,
731 unsigned char *end,
732 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000733{
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000735
736 *olen = 0;
737
David Horstmann21b89762022-10-06 18:34:28 +0100738 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000739#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100740 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000741#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000743#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100744 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000745 /* We shouldn't have called this extension writer unless we've
746 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000748 }
749
Gilles Peskine449bd832023-01-11 14:50:10 +0100750 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
751 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000752
Gilles Peskine449bd832023-01-11 14:50:10 +0100753 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
754 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000755
Gilles Peskine449bd832023-01-11 14:50:10 +0100756 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000757
758 *olen = 6;
759
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
761 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000762
Gilles Peskine449bd832023-01-11 14:50:10 +0100763 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800764
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000766}
767
Ronald Cron41a443a2022-10-04 16:38:25 +0200768#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000769
XiaokangQian7807f9f2022-02-15 10:04:37 +0000770/* From RFC 8446:
771 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000772 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000773 * } SupportedVersions;
774 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200775MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100776static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
777 const unsigned char *buf,
778 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000779{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000780 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000781 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000782 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000783 uint16_t tls_version;
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100784 int found_supported_version = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000785
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000787 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000788 p += 1;
789
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000791 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 while (p < versions_end) {
793 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
794 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000795 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000796
Ronald Cron3bd2b022023-04-03 16:45:39 +0200797 if (MBEDTLS_SSL_VERSION_TLS1_3 == tls_version) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100798 found_supported_version = 1;
799 break;
800 }
801
Ronald Cron3bd2b022023-04-03 16:45:39 +0200802 if ((MBEDTLS_SSL_VERSION_TLS1_2 == tls_version) &&
803 mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100804 found_supported_version = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000805 break;
806 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000807 }
808
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100809 if (!found_supported_version) {
810 MBEDTLS_SSL_DEBUG_MSG(1, ("No supported version found."));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000811
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
813 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
814 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000815 }
816
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100817 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version: [%04x]",
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000819
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100820 return (int) tls_version;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000821}
822
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200823#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000824/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000825 *
826 * From RFC 8446:
827 * enum {
828 * ... (0xFFFF)
829 * } NamedGroup;
830 * struct {
831 * NamedGroup named_group_list<2..2^16-1>;
832 * } NamedGroupList;
833 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200834MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100835static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
836 const unsigned char *buf,
837 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000838{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000839 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000840 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000841 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000842
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
844 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
845 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000846 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000848 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000849 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000850
Gilles Peskine449bd832023-01-11 14:50:10 +0100851 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000852 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100853 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
854 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000855 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000856
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 MBEDTLS_SSL_DEBUG_MSG(2,
858 ("got named group: %s(%04x)",
859 mbedtls_ssl_named_group_to_str(named_group),
860 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000861
Gilles Peskine449bd832023-01-11 14:50:10 +0100862 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
863 !mbedtls_ssl_named_group_is_supported(named_group) ||
864 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000865 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000866 }
867
Gilles Peskine449bd832023-01-11 14:50:10 +0100868 MBEDTLS_SSL_DEBUG_MSG(2,
869 ("add named group %s(%04x) into received list.",
870 mbedtls_ssl_named_group_to_str(named_group),
871 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800872
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000873 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000874 }
875
Gilles Peskine449bd832023-01-11 14:50:10 +0100876 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000877
878}
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200879#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000880
XiaokangQian08037552022-04-20 07:16:41 +0000881#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
882
Valerio Settic9ae8622023-07-25 11:23:50 +0200883#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000884/*
885 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000886 * extension is correct and stores the first acceptable key share and its
887 * associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000888 *
889 * Possible return values are:
890 * - 0: Successful processing of the client provided key share extension.
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000891 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by
892 * the client does not match a group supported by the server. A
893 * HelloRetryRequest will be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000894 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800895 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200896MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100897static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
898 const unsigned char *buf,
899 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000900{
XiaokangQianb67384d2022-04-19 00:02:38 +0000901 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000902 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000903 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800904 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000905
906 /* From RFC 8446:
907 *
908 * struct {
909 * KeyShareEntry client_shares<0..2^16-1>;
910 * } KeyShareClientHello;
911 *
912 */
913
Gilles Peskine449bd832023-01-11 14:50:10 +0100914 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
915 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000916 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000918
919 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000920 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000921
922 /* We try to find a suitable key share entry and copy it to the
923 * handshake context. Later, we have to find out whether we can do
924 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000925 * dismiss it and send a HelloRetryRequest message.
926 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000927
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000929 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800930 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800931 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000932
933 /*
934 * struct {
935 * NamedGroup group;
936 * opaque key_exchange<1..2^16-1>;
937 * } KeyShareEntry;
938 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
940 group = MBEDTLS_GET_UINT16_BE(p, 0);
941 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800942 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800943 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800945 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000946
947 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000948 * for input validation purposes.
949 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
951 !mbedtls_ssl_named_group_is_supported(group) ||
952 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000953 continue;
954 }
XiaokangQian060d8672022-04-21 09:24:56 +0000955
XiaokangQian7807f9f2022-02-15 10:04:37 +0000956 /*
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200957 * ECDHE and FFDHE groups are supported
XiaokangQian7807f9f2022-02-15 10:04:37 +0000958 */
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200959 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200960 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200961 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH/FFDH group: %s (%04x)",
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 mbedtls_ssl_named_group_to_str(group),
963 group));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200964 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 ssl, key_exchange - 2, key_exchange_len + 2);
966 if (ret != 0) {
967 return ret;
968 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000969
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 } else {
971 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
972 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000973 continue;
974 }
975
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000976 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000977 }
978
Jerry Yuc1be19f2022-04-23 16:11:39 +0800979
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 if (ssl->handshake->offered_group_id == 0) {
981 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
982 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000983 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100984 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000985}
Valerio Settic9ae8622023-07-25 11:23:50 +0200986#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000987
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200988MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100989static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
990 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000991{
Jerry Yu0c354a22022-08-29 15:25:36 +0800992 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000994}
995
Jerry Yue5991322022-11-07 14:03:44 +0800996#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200997MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000998static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001000{
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 return ssl_tls13_client_hello_has_exts(
1002 ssl,
1003 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
1004 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
1005 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001006}
Jerry Yue5991322022-11-07 14:03:44 +08001007#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001008
Jerry Yue5991322022-11-07 14:03:44 +08001009#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +00001010MBEDTLS_CHECK_RETURN_CRITICAL
1011static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001013{
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 return ssl_tls13_client_hello_has_exts(
1015 ssl,
1016 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1017 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +00001018}
Jerry Yue5991322022-11-07 14:03:44 +08001019#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +00001020
Jerry Yue5991322022-11-07 14:03:44 +08001021#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +00001022MBEDTLS_CHECK_RETURN_CRITICAL
1023static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001025{
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 return ssl_tls13_client_hello_has_exts(
1027 ssl,
1028 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
1029 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
1030 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1031 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +00001032}
Jerry Yue5991322022-11-07 14:03:44 +08001033#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +00001034
Pengyu Lv306a01d2023-02-02 16:35:47 +08001035#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
1036MBEDTLS_CHECK_RETURN_CRITICAL
Pengyu Lvbc4aab72023-12-01 15:37:24 +08001037static int ssl_tls13_key_exchange_is_psk_available(mbedtls_ssl_context *ssl)
Pengyu Lv306a01d2023-02-02 16:35:47 +08001038{
Jerry Yue5991322022-11-07 14:03:44 +08001039#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Ronald Crone8c162d2024-02-21 10:15:44 +01001040 return mbedtls_ssl_conf_tls13_is_psk_enabled(ssl) &&
Pengyu Lvb2cfafb2023-11-14 13:56:13 +08001041 mbedtls_ssl_tls13_is_psk_supported(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001042 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001043#else
1044 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001046#endif
Jerry Yu77f01482022-07-11 07:03:24 +00001047}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001048
Jerry Yu77f01482022-07-11 07:03:24 +00001049MBEDTLS_CHECK_RETURN_CRITICAL
Pengyu Lvbc4aab72023-12-01 15:37:24 +08001050static int ssl_tls13_key_exchange_is_psk_ephemeral_available(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001051{
Jerry Yue5991322022-11-07 14:03:44 +08001052#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Ronald Crone8c162d2024-02-21 10:15:44 +01001053 return mbedtls_ssl_conf_tls13_is_psk_ephemeral_enabled(ssl) &&
Pengyu Lvb2cfafb2023-11-14 13:56:13 +08001054 mbedtls_ssl_tls13_is_psk_ephemeral_supported(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001056#else
1057 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001059#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001060}
1061#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
1062
1063MBEDTLS_CHECK_RETURN_CRITICAL
1064static int ssl_tls13_key_exchange_is_ephemeral_available(mbedtls_ssl_context *ssl)
1065{
1066#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
1067 return mbedtls_ssl_conf_tls13_is_ephemeral_enabled(ssl) &&
1068 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
1069#else
1070 ((void) ssl);
1071 return 0;
1072#endif
1073}
1074
XiaokangQian81802f42022-06-10 13:25:22 +00001075#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001076 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001077
1078#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001079static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001080{
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001082 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001084 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001086 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001088 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001090 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001092 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001094 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001096 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001098 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001100 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001102 }
1103}
1104#endif /* MBEDTLS_USE_PSA_CRYPTO */
1105
XiaokangQian23c5be62022-06-07 02:04:34 +00001106/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001107 * Pick best ( private key, certificate chain ) pair based on the signature
1108 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001109 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001110MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001111static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001112{
XiaokangQianfb665a82022-06-15 03:57:21 +00001113 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001114 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001115
1116#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001118 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001120#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001122
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 if (key_cert_list == NULL) {
1124 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1125 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001126 }
1127
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1129 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001130 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001132
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001134 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001136
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 for (key_cert = key_cert_list; key_cert != NULL;
1138 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001139#if defined(MBEDTLS_USE_PSA_CRYPTO)
1140 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1141#endif /* MBEDTLS_USE_PSA_CRYPTO */
1142
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1144 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001145
1146 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 * This avoids sending the client a cert it'll reject based on
1148 * keyUsage or other extensions.
1149 */
1150 if (mbedtls_x509_crt_check_key_usage(
1151 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001152 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001153 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1155 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1156 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001157 continue;
1158 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001159
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 MBEDTLS_SSL_DEBUG_MSG(3,
1161 ("ssl_tls13_pick_key_cert:"
1162 "check signature algorithm %s [%04x]",
1163 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1164 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001165#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001167#endif /* MBEDTLS_USE_PSA_CRYPTO */
1168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1170 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001171#if defined(MBEDTLS_USE_PSA_CRYPTO)
1172 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1174 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001175#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001177 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 MBEDTLS_SSL_DEBUG_MSG(3,
1179 ("ssl_tls13_pick_key_cert:"
1180 "selected signature algorithm"
1181 " %s [%04x]",
1182 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1183 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001184 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001185 3, "selected certificate (chain)",
1186 ssl->handshake->key_cert->cert);
1187 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001188 }
XiaokangQian81802f42022-06-10 13:25:22 +00001189 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001190 }
1191
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1193 "no suitable certificate found"));
1194 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001195}
XiaokangQian81802f42022-06-10 13:25:22 +00001196#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001197 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001198
XiaokangQian4080a7f2022-04-11 09:55:18 +00001199/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001200 *
1201 * STATE HANDLING: ClientHello
1202 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001203 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001204 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001205 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001206 *
1207 * In this case, the server progresses to sending its ServerHello.
1208 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001209 * 2) The ClientHello was well-formed but didn't match the server's
1210 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001211 *
1212 * For example, the client might not have offered a key share which
1213 * the server supports, or the server might require a cookie.
1214 *
1215 * In this case, the server sends a HelloRetryRequest.
1216 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001217 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001218 *
1219 * In this case, we abort the handshake.
1220 *
1221 */
1222
1223/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001224 * Structure of this message:
1225 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001226 * uint16 ProtocolVersion;
1227 * opaque Random[32];
1228 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001229 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001230 * struct {
1231 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1232 * Random random;
1233 * opaque legacy_session_id<0..32>;
1234 * CipherSuite cipher_suites<2..2^16-2>;
1235 * opaque legacy_compression_methods<1..2^8-1>;
1236 * Extension extensions<8..2^16-1>;
1237 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001238 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001239
1240#define SSL_CLIENT_HELLO_OK 0
1241#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001242#define SSL_CLIENT_HELLO_TLS1_2 2
XiaokangQianed582dd2022-04-13 08:21:05 +00001243
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001244MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001245static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1246 const unsigned char *buf,
1247 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001248{
XiaokangQianb67384d2022-04-19 00:02:38 +00001249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1250 const unsigned char *p = buf;
Ronald Crond540d992023-03-07 09:41:48 +01001251 const unsigned char *random;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001252 size_t legacy_session_id_len;
Ronald Croncada4102023-03-07 09:51:39 +01001253 const unsigned char *legacy_session_id;
XiaokangQian318dc762022-04-20 09:43:51 +00001254 size_t cipher_suites_len;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001255 const unsigned char *cipher_suites;
XiaokangQian060d8672022-04-21 09:24:56 +00001256 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001257 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001258 const unsigned char *extensions_end;
Ronald Croneff56732023-04-03 17:36:31 +02001259 const unsigned char *supported_versions_data;
1260 const unsigned char *supported_versions_data_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001261 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001262 int hrr_required = 0;
Ronald Cron8a74f072023-06-14 17:59:29 +02001263 int no_usable_share_for_key_agreement = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001264
Ronald Cron41a443a2022-10-04 16:38:25 +02001265#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cron79cdd412024-02-20 17:19:28 +01001266 int got_psk = 0;
1267 struct psk_attributes psk = PSK_ATTRIBUTES_INIT;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001268 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001269 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001270#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001271
XiaokangQian7807f9f2022-02-15 10:04:37 +00001272 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001273 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001274 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001275 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001276 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001277 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001278 * .. . .. ciphersuite list length ( 2 bytes )
1279 * .. . .. ciphersuite list
1280 * .. . .. compression alg. list length ( 1 byte )
1281 * .. . .. compression alg. list
1282 * .. . .. extensions length ( 2 bytes, optional )
1283 * .. . .. extensions ( optional )
1284 */
1285
XiaokangQianb67384d2022-04-19 00:02:38 +00001286 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001287 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001288 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1289 * read at least up to session id length without worrying.
1290 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001291 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001292
1293 /* ...
1294 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1295 * ...
1296 * with ProtocolVersion defined as:
1297 * uint16 ProtocolVersion;
1298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1300 MBEDTLS_SSL_VERSION_TLS1_2) {
1301 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1302 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1303 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1304 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001305 }
1306 p += 2;
1307
Jerry Yuc1be19f2022-04-23 16:11:39 +08001308 /* ...
1309 * Random random;
1310 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001311 * with Random defined as:
1312 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001313 */
Ronald Crond540d992023-03-07 09:41:48 +01001314 random = p;
XiaokangQian08037552022-04-20 07:16:41 +00001315 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001316
Jerry Yuc1be19f2022-04-23 16:11:39 +08001317 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001318 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001319 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001320 */
Ronald Croncada4102023-03-07 09:51:39 +01001321 legacy_session_id_len = *(p++);
1322 legacy_session_id = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001323
XiaokangQianb67384d2022-04-19 00:02:38 +00001324 /*
1325 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001326 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001327 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001329 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001330
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001331 /* ...
1332 * CipherSuite cipher_suites<2..2^16-2>;
1333 * ...
1334 * with CipherSuite defined as:
1335 * uint8 CipherSuite[2];
1336 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001338 p += 2;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001339 cipher_suites = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001340
Ronald Cronfc7ae872023-02-16 15:32:19 +01001341 /*
1342 * The length of the ciphersuite list has to be even.
1343 */
1344 if (cipher_suites_len & 1) {
1345 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1346 MBEDTLS_ERR_SSL_DECODE_ERROR);
1347 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1348 }
1349
XiaokangQianb67384d2022-04-19 00:02:38 +00001350 /* Check we have enough data for the ciphersuite list, the legacy
1351 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001352 *
1353 * cipher_suites cipher_suites_len bytes
1354 * legacy_compression_methods 2 bytes
1355 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
Ronald Cron8c527d02023-03-07 15:47:47 +01001358 p += cipher_suites_len;
1359 cipher_suites_end = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001360
1361 /*
Ronald Cron8c527d02023-03-07 15:47:47 +01001362 * Search for the supported versions extension and parse it to determine
1363 * if the client supports TLS 1.3.
1364 */
1365 ret = mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1366 ssl, p + 2, end,
Ronald Croneff56732023-04-03 17:36:31 +02001367 &supported_versions_data, &supported_versions_data_end);
Ronald Cron8c527d02023-03-07 15:47:47 +01001368 if (ret < 0) {
1369 MBEDTLS_SSL_DEBUG_RET(1,
1370 ("mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts"), ret);
1371 return ret;
1372 }
1373
1374 if (ret == 0) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001375 return SSL_CLIENT_HELLO_TLS1_2;
Ronald Cron8c527d02023-03-07 15:47:47 +01001376 }
1377
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001378 if (ret == 1) {
1379 ret = ssl_tls13_parse_supported_versions_ext(ssl,
Ronald Croneff56732023-04-03 17:36:31 +02001380 supported_versions_data,
1381 supported_versions_data_end);
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001382 if (ret < 0) {
1383 MBEDTLS_SSL_DEBUG_RET(1,
1384 ("ssl_tls13_parse_supported_versions_ext"), ret);
1385 return ret;
1386 }
1387
Ronald Cronb828c7d2023-04-03 16:37:22 +02001388 /*
1389 * The supported versions extension was parsed successfully as the
1390 * value returned by ssl_tls13_parse_supported_versions_ext() is
1391 * positive. The return value is then equal to
1392 * MBEDTLS_SSL_VERSION_TLS1_2 or MBEDTLS_SSL_VERSION_TLS1_3, defining
1393 * the TLS version to negotiate.
1394 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001395 if (MBEDTLS_SSL_VERSION_TLS1_2 == ret) {
1396 return SSL_CLIENT_HELLO_TLS1_2;
1397 }
Ronald Cron8c527d02023-03-07 15:47:47 +01001398 }
1399
1400 /*
1401 * We negotiate TLS 1.3.
Ronald Cron64582392023-03-07 09:21:40 +01001402 */
1403 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Ronald Cron64582392023-03-07 09:21:40 +01001404 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1405 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Ronald Cron64582392023-03-07 09:21:40 +01001406
1407 /*
Ronald Crondad02b22023-04-06 09:57:52 +02001408 * We are negotiating the version 1.3 of the protocol. Do what we have
Ronald Croncada4102023-03-07 09:51:39 +01001409 * postponed: copy of the client random bytes, copy of the legacy session
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001410 * identifier and selection of the TLS 1.3 cipher suite.
Ronald Crond540d992023-03-07 09:41:48 +01001411 */
1412 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1413 random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1414 memcpy(&handshake->randbytes[0], random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1415
Ronald Croncada4102023-03-07 09:51:39 +01001416 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1417 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1418 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1419 }
1420 ssl->session_negotiate->id_len = legacy_session_id_len;
1421 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1422 legacy_session_id, legacy_session_id_len);
1423 memcpy(&ssl->session_negotiate->id[0],
1424 legacy_session_id, legacy_session_id_len);
1425
Ronald Crond540d992023-03-07 09:41:48 +01001426 /*
Jerry Yu5725f1c2022-08-21 17:27:16 +08001427 * Search for a matching ciphersuite
1428 */
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001429 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, list of cipher suites",
1430 cipher_suites, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001431
Ronald Cron89089cc2024-02-14 18:18:08 +01001432 ssl_tls13_select_ciphersuite(ssl, cipher_suites, cipher_suites_end,
1433 0, PSA_ALG_NONE, &handshake->ciphersuite_info);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001434
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 if (handshake->ciphersuite_info == NULL) {
1436 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1437 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1438 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001439 }
Ronald Cron89089cc2024-02-14 18:18:08 +01001440 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
1441
1442 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1443 ((unsigned) handshake->ciphersuite_info->id),
1444 handshake->ciphersuite_info->name));
Jerry Yuc1be19f2022-04-23 16:11:39 +08001445
XiaokangQian4080a7f2022-04-11 09:55:18 +00001446 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001447 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001448 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001449 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1451 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1452 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1453 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1454 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001455 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001456 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001457
Jerry Yuc1be19f2022-04-23 16:11:39 +08001458 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001459 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001460 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001461 * with Extension defined as:
1462 * struct {
1463 * ExtensionType extension_type;
1464 * opaque extension_data<0..2^16-1>;
1465 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001468 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001470 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001471
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
Jerry Yu63a459c2022-10-31 13:38:40 +08001473 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001474
Gilles Peskine449bd832023-01-11 14:50:10 +01001475 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001476 unsigned int extension_type;
1477 size_t extension_data_len;
1478 const unsigned char *extension_data_end;
Jerry Yu263dbf72022-10-26 10:51:27 +08001479 uint32_t allowed_exts = MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH;
1480
Ronald Cron5fbd2702024-02-14 10:03:36 +01001481 if (ssl->handshake->hello_retry_request_flag) {
Jerry Yu263dbf72022-10-26 10:51:27 +08001482 /* Do not accept early data extension in 2nd ClientHello */
1483 allowed_exts &= ~MBEDTLS_SSL_EXT_MASK(EARLY_DATA);
1484 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001485
Jerry Yu0c354a22022-08-29 15:25:36 +08001486 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001487 *
1488 * The "pre_shared_key" extension MUST be the last extension in the
1489 * ClientHello (this facilitates implementation as described below).
1490 * Servers MUST check that it is the last extension and otherwise fail
1491 * the handshake with an "illegal_parameter" alert.
1492 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001494 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001496 MBEDTLS_SSL_PEND_FATAL_ALERT(
1497 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1499 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001500 }
1501
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1503 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1504 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001505 p += 4;
1506
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001508 extension_data_end = p + extension_data_len;
1509
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001510 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
Jerry Yu263dbf72022-10-26 10:51:27 +08001512 allowed_exts);
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 if (ret != 0) {
1514 return ret;
1515 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001516
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001518#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1519 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1521 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1522 extension_data_end);
1523 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001524 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 1, "mbedtls_ssl_parse_servername_ext", ret);
1526 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001527 }
XiaokangQian40a35232022-05-07 09:02:40 +00001528 break;
1529#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1530
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001531#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001532 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001534
1535 /* Supported Groups Extension
1536 *
1537 * When sent by the client, the "supported_groups" extension
1538 * indicates the named groups which the client supports,
1539 * ordered from most preferred to least preferred.
1540 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001541 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 ssl, p, extension_data_end);
1543 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001544 MBEDTLS_SSL_DEBUG_RET(
Xiaokang Qian8bce0e62023-04-04 10:15:48 +00001545 1, "ssl_tls13_parse_supported_groups_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001547 }
1548
XiaokangQian7807f9f2022-02-15 10:04:37 +00001549 break;
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001550#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH*/
XiaokangQian7807f9f2022-02-15 10:04:37 +00001551
Valerio Settic9ae8622023-07-25 11:23:50 +02001552#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001553 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001555
1556 /*
1557 * Key Share Extension
1558 *
1559 * When sent by the client, the "key_share" extension
1560 * contains the endpoint's cryptographic parameters for
1561 * ECDHE/DHE key establishment methods.
1562 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001563 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 ssl, p, extension_data_end);
1565 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
Ronald Cron8a74f072023-06-14 17:59:29 +02001566 MBEDTLS_SSL_DEBUG_MSG(2, ("No usable share for key agreement."));
1567 no_usable_share_for_key_agreement = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001568 }
1569
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001571 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001572 1, "ssl_tls13_parse_key_shares_ext", ret);
1573 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001574 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001575
XiaokangQian7807f9f2022-02-15 10:04:37 +00001576 break;
Valerio Settic9ae8622023-07-25 11:23:50 +02001577#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001578
1579 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Ronald Cron8c527d02023-03-07 15:47:47 +01001580 /* Already parsed */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001581 break;
1582
Ronald Cron41a443a2022-10-04 16:38:25 +02001583#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001584 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001585 MBEDTLS_SSL_DEBUG_MSG(
1586 3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001587
1588 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 ssl, p, extension_data_end);
1590 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001591 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1593 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001594 }
1595
Jerry Yue19e3b92022-07-08 12:04:51 +00001596 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001597#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001598
Jerry Yu1c105562022-07-10 06:32:38 +00001599 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1601 if ((handshake->received_extensions &
1602 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001603 MBEDTLS_SSL_PEND_FATAL_ALERT(
1604 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1606 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001607 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001608#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001609 /* Delay processing of the PSK identity once we have
1610 * found out which algorithms to use. We keep a pointer
1611 * to the buffer and the size for later processing.
1612 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001613 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001614 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001615#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001616 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001617
XiaokangQianacb39922022-06-17 10:18:48 +00001618#if defined(MBEDTLS_SSL_ALPN)
1619 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001621
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1623 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001624 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1626 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001627 }
XiaokangQianacb39922022-06-17 10:18:48 +00001628 break;
1629#endif /* MBEDTLS_SSL_ALPN */
1630
Ronald Cron928cbd32022-10-04 16:14:26 +02001631#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001632 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001634
Gabor Mezei078e8032022-04-27 21:17:56 +02001635 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 ssl, p, extension_data_end);
1637 if (ret != 0) {
Xiaokang Qian49f39c12023-04-06 02:31:02 +00001638 MBEDTLS_SSL_DEBUG_RET(
1639 1, "mbedtls_ssl_parse_sig_alg_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001640 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001641 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001642 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001643#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001644
Jan Bruckner151f6422023-02-10 12:45:19 +01001645#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1646 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
1647 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
1648
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001649 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
1650 ssl, p, extension_data_end);
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001651 if (ret != 0) {
1652 MBEDTLS_SSL_DEBUG_RET(
1653 1, ("mbedtls_ssl_tls13_parse_record_size_limit_ext"), ret);
1654 return ret;
1655 }
Jan Bruckner151f6422023-02-10 12:45:19 +01001656 break;
1657#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1658
XiaokangQian7807f9f2022-02-15 10:04:37 +00001659 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001660 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001661 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001663 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001664 }
1665
1666 p += extension_data_len;
1667 }
1668
Gilles Peskine449bd832023-01-11 14:50:10 +01001669 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1670 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001671
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001672 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1673 MBEDTLS_SSL_HS_CLIENT_HELLO,
1674 p - buf);
1675 if (0 != ret) {
1676 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1677 return ret;
1678 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001679
Ronald Cron41a443a2022-10-04 16:38:25 +02001680#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001681 /* Update checksum with either
1682 * - The entire content of the CH message, if no PSK extension is present
1683 * - The content up to but excluding the PSK extension, if present.
Ronald Cron7cab4f82024-03-07 15:09:09 +01001684 * Always parse the pre-shared-key extension when present in the
Ronald Cron12e72f12024-02-14 15:49:38 +01001685 * ClientHello even if some pre-requisites for PSK key exchange modes are
1686 * not met. That way we always validate the syntax of the extension.
XiaokangQian7807f9f2022-02-15 10:04:37 +00001687 */
Ronald Cron12e72f12024-02-14 15:49:38 +01001688 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001689 ret = handshake->update_checksum(ssl, buf,
1690 pre_shared_key_ext - buf);
1691 if (0 != ret) {
1692 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1693 return ret;
1694 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1696 pre_shared_key_ext,
1697 pre_shared_key_ext_end,
1698 cipher_suites,
Ronald Cron79cdd412024-02-20 17:19:28 +01001699 cipher_suites_end,
1700 &psk);
1701 if (ret == 0) {
1702 got_psk = 1;
1703 } else if (ret != MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001704 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1706 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001707 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001709#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001710 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001711 ret = handshake->update_checksum(ssl, buf, p - buf);
1712 if (0 != ret) {
1713 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1714 return ret;
1715 }
Jerry Yu1c105562022-07-10 06:32:38 +00001716 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001717
Ronald Cron79cdd412024-02-20 17:19:28 +01001718 /*
1719 * Determine the key exchange algorithm to use.
1720 * There are three types of key exchanges supported in TLS 1.3:
1721 * - (EC)DH with ECDSA,
1722 * - (EC)DH with PSK,
1723 * - plain PSK.
1724 *
1725 * The PSK-based key exchanges may additionally be used with 0-RTT.
1726 *
1727 * Our built-in order of preference is
1728 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1729 * 2 ) Certificate Mode ( ephemeral )
1730 * 3 ) Plain PSK Mode ( psk )
1731 */
1732#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
1733 if (got_psk && (psk.key_exchange_mode ==
1734 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL)) {
1735 handshake->key_exchange_mode =
1736 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
1737 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1738
1739 } else
1740#endif
1741 if (ssl_tls13_key_exchange_is_ephemeral_available(ssl)) {
1742 handshake->key_exchange_mode =
1743 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
1744 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1745
1746 }
1747#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
1748 else if (got_psk && (psk.key_exchange_mode ==
1749 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK)) {
1750 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
1751 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1752 }
1753#endif
1754 else {
1755 MBEDTLS_SSL_DEBUG_MSG(
1756 1,
1757 ("ClientHello message misses mandatory extensions."));
1758 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1759 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1760 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001762
Ronald Cron3e47eec2024-02-21 10:29:24 +01001763#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cron74a16292024-02-23 17:07:41 +01001764 if (handshake->key_exchange_mode &
1765 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL) {
1766 handshake->ciphersuite_info = psk.ciphersuite_info;
1767 ssl->session_negotiate->ciphersuite = psk.ciphersuite_info->id;
1768
1769 MBEDTLS_SSL_DEBUG_MSG(2, ("Select PSK ciphersuite: %04x - %s",
1770 ((unsigned) psk.ciphersuite_info->id),
1771 psk.ciphersuite_info->name));
1772
1773 if (psk.type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
1774 handshake->resume = 1;
1775 }
Ronald Cron79cdd412024-02-20 17:19:28 +01001776 }
Ronald Cron3e47eec2024-02-21 10:29:24 +01001777#endif
Ronald Cron79cdd412024-02-20 17:19:28 +01001778
1779 if (handshake->key_exchange_mode !=
Ronald Cron8a74f072023-06-14 17:59:29 +02001780 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) {
1781 hrr_required = (no_usable_share_for_key_agreement != 0);
1782 }
1783
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001785
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001787}
1788
Jerry Yuab0da372023-02-08 13:55:24 +08001789#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001790static int ssl_tls13_check_early_data_requirements(mbedtls_ssl_context *ssl)
Jerry Yuab0da372023-02-08 13:55:24 +08001791{
1792 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1793
Jerry Yu985c9672022-12-04 14:06:30 +08001794 if (ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_DISABLED) {
1795 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu985c9672022-12-04 14:06:30 +08001796 1,
Jerry Yu454dda32023-10-31 15:13:54 +08001797 ("EarlyData: rejected, feature disabled in server configuration."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001798 return -1;
Ronald Cron7b6ee942024-01-12 10:29:55 +01001799 }
1800
Jerry Yu454dda32023-10-31 15:13:54 +08001801 if (!handshake->resume) {
1802 /* We currently support early data only in the case of PSKs established
1803 via a NewSessionTicket message thus in the case of a session
1804 resumption. */
Jerry Yu985c9672022-12-04 14:06:30 +08001805 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001806 1, ("EarlyData: rejected, not a session resumption."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001807 return -1;
Jerry Yu985c9672022-12-04 14:06:30 +08001808 }
1809
Jerry Yu82fd6c12023-10-31 16:32:19 +08001810 /* RFC 8446 4.2.10
1811 *
1812 * In order to accept early data, the server MUST have accepted a PSK cipher
1813 * suite and selected the first key offered in the client's "pre_shared_key"
1814 * extension. In addition, it MUST verify that the following values are the
1815 * same as those associated with the selected PSK:
1816 * - The TLS version number
1817 * - The selected cipher suite
1818 * - The selected ALPN [RFC7301] protocol, if any
1819 *
1820 * NOTE:
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001821 * - The TLS version number is checked in
1822 * ssl_tls13_offered_psks_check_identity_match_ticket().
1823 * - ALPN is not checked for the time being (TODO).
Jerry Yu82fd6c12023-10-31 16:32:19 +08001824 */
1825
1826 if (handshake->selected_identity != 0) {
1827 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001828 1, ("EarlyData: rejected, the selected key in "
1829 "`pre_shared_key` is not the first one."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001830 return -1;
Jerry Yu82fd6c12023-10-31 16:32:19 +08001831 }
1832
1833 if (handshake->ciphersuite_info->id !=
1834 ssl->session_negotiate->ciphersuite) {
1835 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001836 1, ("EarlyData: rejected, the selected ciphersuite is not the one "
1837 "of the selected pre-shared key."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001838 return -1;
Jerry Yu82fd6c12023-10-31 16:32:19 +08001839
1840 }
Jerry Yu985c9672022-12-04 14:06:30 +08001841
Pengyu Lv94a42cc2023-12-06 10:04:17 +08001842 if (!mbedtls_ssl_tls13_session_ticket_allow_early_data(ssl->session_negotiate)) {
Jerry Yufceddb32022-12-12 15:30:34 +08001843 MBEDTLS_SSL_DEBUG_MSG(
1844 1,
Jerry Yuea96ac32023-11-21 17:06:36 +08001845 ("EarlyData: rejected, early_data not allowed in ticket "
1846 "permission bits."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001847 return -1;
Jerry Yufceddb32022-12-12 15:30:34 +08001848 }
Jerry Yu985c9672022-12-04 14:06:30 +08001849
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001850 return 0;
Jerry Yuab0da372023-02-08 13:55:24 +08001851}
1852#endif /* MBEDTLS_SSL_EARLY_DATA */
1853
XiaokangQian75fe8c72022-06-15 09:42:45 +00001854/* Update the handshake state machine */
1855
Ronald Cronce7d76e2022-07-08 18:56:49 +02001856MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b6ee942024-01-12 10:29:55 +01001857static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl,
1858 int hrr_required)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001859{
1860 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1861
XiaokangQian7807f9f2022-02-15 10:04:37 +00001862 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001863 * Server certificate selection
1864 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1866 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1867 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001868 }
1869#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1870 ssl->handshake->sni_name = NULL;
1871 ssl->handshake->sni_name_len = 0;
1872#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001873
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1875 if (ret != 0) {
1876 MBEDTLS_SSL_DEBUG_RET(1,
1877 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1878 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001879 }
1880
Jerry Yuab0da372023-02-08 13:55:24 +08001881#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001882 if (ssl->handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Ronald Cron31e2d832024-02-05 16:45:57 +01001883 ssl->handshake->early_data_accepted =
1884 (!hrr_required) && (ssl_tls13_check_early_data_requirements(ssl) == 0);
Jerry Yu4e9b70e2022-12-04 14:08:02 +08001885
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001886 if (ssl->handshake->early_data_accepted) {
1887 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1888 if (ret != 0) {
1889 MBEDTLS_SSL_DEBUG_RET(
1890 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
1891 return ret;
1892 }
1893 } else {
1894 ssl->discard_early_data_record =
1895 hrr_required ?
1896 MBEDTLS_SSL_EARLY_DATA_DISCARD :
1897 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD;
Jerry Yu4e9b70e2022-12-04 14:08:02 +08001898 }
1899 }
Ronald Cron7b6ee942024-01-12 10:29:55 +01001900#else
1901 ((void) hrr_required);
Jerry Yuab0da372023-02-08 13:55:24 +08001902#endif /* MBEDTLS_SSL_EARLY_DATA */
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001905}
1906
1907/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001908 * Main entry point from the state machine; orchestrates the otherfunctions.
1909 */
1910
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001911MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001912static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001913{
1914
XiaokangQian08037552022-04-20 07:16:41 +00001915 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001917 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001918 int parse_client_hello_ret;
1919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001921
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1923 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1924 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001925
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1927 buf + buflen));
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001928 parse_client_hello_ret = ret; /* Store positive return value of
1929 * parse_client_hello,
1930 * as negative error codes are handled
Jerry Yuf41553b2022-05-09 22:20:30 +08001931 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001932
Ronald Cronb828c7d2023-04-03 16:37:22 +02001933 /*
Yanray Wang90acdc62023-12-08 10:29:42 +08001934 * Version 1.2 of the protocol has to be used for the handshake.
1935 * If TLS 1.2 is not supported, abort the handshake. Otherwise, set the
Ronald Cronb828c7d2023-04-03 16:37:22 +02001936 * ssl->keep_current_message flag for the ClientHello to be kept and parsed
1937 * as a TLS 1.2 ClientHello. We also change ssl->tls_version to
1938 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1939 * will dispatch to the TLS 1.2 state machine.
1940 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001941 if (SSL_CLIENT_HELLO_TLS1_2 == parse_client_hello_ret) {
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001942 /* Check if server supports TLS 1.2 */
Yanray Wang408ba6f2023-12-08 10:18:03 +08001943 if (!mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001944 MBEDTLS_SSL_DEBUG_MSG(
Yanray Wang177e49a2023-12-08 10:51:04 +08001945 1, ("TLS 1.2 not supported."));
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001946 MBEDTLS_SSL_PEND_FATAL_ALERT(
Yanray Wang2bef9172023-12-08 10:21:53 +08001947 MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1948 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1949 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001950 }
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001951 ssl->keep_current_message = 1;
1952 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
1953 return 0;
1954 }
1955
Ronald Cron7b6ee942024-01-12 10:29:55 +01001956 MBEDTLS_SSL_PROC_CHK(
1957 ssl_tls13_postprocess_client_hello(ssl, parse_client_hello_ret ==
1958 SSL_CLIENT_HELLO_HRR_REQUIRED));
Jerry Yu582dd062022-04-22 21:59:01 +08001959
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001960 if (SSL_CLIENT_HELLO_OK == parse_client_hello_ret) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1962 } else {
1963 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1964 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001965
1966cleanup:
1967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1969 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001970}
1971
1972/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001973 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001974 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001975MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001976static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001977{
Jerry Yu637a3f12022-04-20 21:37:58 +08001978 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1979 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001981
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1983 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1984 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1985 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001986 }
1987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1989 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001990
1991#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001992 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001993#endif /* MBEDTLS_HAVE_TIME */
1994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001996}
1997
Jerry Yu3bf2c642022-03-30 22:02:12 +08001998/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001999 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08002000 *
2001 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08002002 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002003 * } SupportedVersions;
2004 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002005MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08002006static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 mbedtls_ssl_context *ssl,
2008 unsigned char *buf,
2009 unsigned char *end,
2010 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002011{
Jerry Yu3bf2c642022-03-30 22:02:12 +08002012 *out_len = 0;
2013
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002015
2016 /* Check if we have space to write the extension:
2017 * - extension_type (2 bytes)
2018 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08002019 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002020 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002022
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002024
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002026
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 mbedtls_ssl_write_version(buf + 4,
2028 ssl->conf->transport,
2029 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002030
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
2032 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002033
Jerry Yu349a6132022-04-14 20:52:56 +08002034 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002035
Jerry Yub95dd362022-11-08 21:19:34 +08002036 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08002038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002040}
2041
Jerry Yud9436a12022-04-20 22:28:09 +08002042
Jerry Yu3bf2c642022-03-30 22:02:12 +08002043
2044/* Generate and export a single key share. For hybrid KEMs, this can
2045 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002046MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002047static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
2048 uint16_t named_group,
2049 unsigned char *buf,
2050 unsigned char *end,
2051 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002052{
2053 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08002054
2055 *out_len = 0;
2056
Valerio Settic9ae8622023-07-25 11:23:50 +02002057#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02002058 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +02002059 mbedtls_ssl_tls13_named_group_is_ffdh(named_group)) {
Przemek Stekiel408569f2023-07-06 11:26:44 +02002060 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 ssl, named_group, buf, end, out_len);
2062 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08002063 MBEDTLS_SSL_DEBUG_RET(
Przemek Stekiel408569f2023-07-06 11:26:44 +02002064 1, "mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 ret);
2066 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002067 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 } else
Valerio Settic9ae8622023-07-25 11:23:50 +02002069#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (0 /* Other kinds of KEMs */) {
2071 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08002072 ((void) ssl);
2073 ((void) named_group);
2074 ((void) buf);
2075 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002076 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2077 }
2078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002080}
2081
2082/*
2083 * ssl_tls13_write_key_share_ext
2084 *
2085 * Structure of key_share extension in ServerHello:
2086 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08002087 * struct {
2088 * NamedGroup group;
2089 * opaque key_exchange<1..2^16-1>;
2090 * } KeyShareEntry;
2091 * struct {
2092 * KeyShareEntry server_share;
2093 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002094 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002095MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002096static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
2097 unsigned char *buf,
2098 unsigned char *end,
2099 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002100{
Jerry Yu955ddd72022-04-22 22:27:33 +08002101 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002102 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08002103 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002104 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002105 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002106
2107 *out_len = 0;
2108
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002110
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
2112 mbedtls_ssl_named_group_to_str(group),
2113 group));
Jerry Yu58af2332022-09-06 11:19:31 +08002114
Jerry Yu3bf2c642022-03-30 22:02:12 +08002115 /* Check if we have space for header and length fields:
2116 * - extension_type (2 bytes)
2117 * - extension_data_length (2 bytes)
2118 * - group (2 bytes)
2119 * - key_exchange_length (2 bytes)
2120 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
2122 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
2123 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002124 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08002125
Jerry Yu3bf2c642022-03-30 22:02:12 +08002126 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
2127 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08002128 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 ssl, group, server_share + 4, end, &key_exchange_length);
2130 if (ret != 0) {
2131 return ret;
2132 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002133 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08002134
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002138
Jerry Yu57d48412022-04-20 21:50:42 +08002139 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08002140
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002144}
Jerry Yud9436a12022-04-20 22:28:09 +08002145
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002146MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002147static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
2148 unsigned char *buf,
2149 unsigned char *end,
2150 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002151{
2152 uint16_t selected_group = ssl->handshake->hrr_selected_group;
2153 /* key_share Extension
2154 *
2155 * struct {
2156 * select (Handshake.msg_type) {
2157 * ...
2158 * case hello_retry_request:
2159 * NamedGroup selected_group;
2160 * ...
2161 * };
2162 * } KeyShare;
2163 */
2164
2165 *out_len = 0;
2166
Jerry Yub0ac10b2022-05-05 11:10:08 +08002167 /*
2168 * For a pure PSK key exchange, there is no group to agree upon. The purpose
2169 * of the HRR is then to transmit a cookie to force the client to demonstrate
2170 * reachability at their apparent network address (primarily useful for DTLS).
2171 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2173 return 0;
2174 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002175
2176 /* We should only send the key_share extension if the client's initial
2177 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if (ssl->handshake->offered_group_id != 0) {
2179 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
2180 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002181 }
2182
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 if (selected_group == 0) {
2184 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
2185 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002186 }
2187
Jerry Yub0ac10b2022-05-05 11:10:08 +08002188 /* Check if we have enough space:
2189 * - extension_type (2 bytes)
2190 * - extension_data_length (2 bytes)
2191 * - selected_group (2 bytes)
2192 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
2196 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
2197 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 MBEDTLS_SSL_DEBUG_MSG(3,
2200 ("HRR selected_group: %s (%x)",
2201 mbedtls_ssl_named_group_to_str(selected_group),
2202 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002203
2204 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002207
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002209}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002210
2211/*
2212 * Structure of ServerHello message:
2213 *
2214 * struct {
2215 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2216 * Random random;
2217 * opaque legacy_session_id_echo<0..32>;
2218 * CipherSuite cipher_suite;
2219 * uint8 legacy_compression_method = 0;
2220 * Extension extensions<6..2^16-1>;
2221 * } ServerHello;
2222 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002223MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002224static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2225 unsigned char *buf,
2226 unsigned char *end,
2227 size_t *out_len,
2228 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002229{
Jerry Yu955ddd72022-04-22 22:27:33 +08002230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002231 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002232 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002233 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002234
2235 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002236 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002237
Jerry Yucfc04b32022-04-21 09:31:58 +08002238 /* ...
2239 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2240 * ...
2241 * with ProtocolVersion defined as:
2242 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002243 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2245 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002246 p += 2;
2247
Jerry Yu1c3e6882022-04-20 21:23:40 +08002248 /* ...
2249 * Random random;
2250 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002251 * with Random defined as:
2252 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002253 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2255 if (is_hrr) {
2256 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2257 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2258 } else {
2259 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2260 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002261 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2263 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002264 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2265
Jerry Yucfc04b32022-04-21 09:31:58 +08002266 /* ...
2267 * opaque legacy_session_id_echo<0..32>;
2268 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2271 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2272 if (ssl->session_negotiate->id_len > 0) {
2273 memcpy(p, &ssl->session_negotiate->id[0],
2274 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002275 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002276
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2278 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002279 }
2280
Jerry Yucfc04b32022-04-21 09:31:58 +08002281 /* ...
2282 * CipherSuite cipher_suite;
2283 * ...
2284 * with CipherSuite defined as:
2285 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2288 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002289 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 MBEDTLS_SSL_DEBUG_MSG(3,
2291 ("server hello, chosen ciphersuite: %s ( id=%d )",
2292 mbedtls_ssl_get_ciphersuite_name(
2293 ssl->session_negotiate->ciphersuite),
2294 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002295
Jerry Yucfc04b32022-04-21 09:31:58 +08002296 /* ...
2297 * uint8 legacy_compression_method = 0;
2298 * ...
2299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002301 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002302
Jerry Yucfc04b32022-04-21 09:31:58 +08002303 /* ...
2304 * Extension extensions<6..2^16-1>;
2305 * ...
2306 * struct {
2307 * ExtensionType extension_type; (2 bytes)
2308 * opaque extension_data<0..2^16-1>;
2309 * } Extension;
2310 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002312 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002313 p += 2;
2314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2316 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002317 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2319 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002320 }
2321 p += output_len;
2322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2324 if (is_hrr) {
2325 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2326 } else {
2327 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2328 }
2329 if (ret != 0) {
2330 return ret;
2331 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002332 p += output_len;
2333 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002334
Ronald Cron41a443a2022-10-04 16:38:25 +02002335#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2337 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2338 if (ret != 0) {
2339 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2340 ret);
2341 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002342 }
2343 p += output_len;
2344 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002345#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002346
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002348
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2350 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002351
Jerry Yud9436a12022-04-20 22:28:09 +08002352 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002353
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002355
Jerry Yu7de2ff02022-11-08 21:43:46 +08002356 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002357 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 MBEDTLS_SSL_HS_SERVER_HELLO,
2359 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002362}
2363
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002364MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002365static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002366{
2367 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2369 if (ret != 0) {
2370 MBEDTLS_SSL_DEBUG_RET(1,
2371 "mbedtls_ssl_tls13_compute_handshake_transform",
2372 ret);
2373 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002374 }
2375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002377}
2378
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002379MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002380static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002381{
Jerry Yu637a3f12022-04-20 21:37:58 +08002382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002383 unsigned char *buf;
2384 size_t buf_len, msg_len;
2385
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002387
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002389
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002390 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2391 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002392
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2394 buf + buf_len,
2395 &msg_len,
2396 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002397
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002398 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002399 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002400
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2402 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002403
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002404 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002405
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002406#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2407 /* The server sends a dummy change_cipher_spec record immediately
2408 * after its first handshake message. This may either be after
2409 * a ServerHello or a HelloRetryRequest.
2410 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002411 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002413#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002415#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002416
Jerry Yuf4b27e42022-03-30 17:32:21 +08002417cleanup:
2418
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2420 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002421}
2422
Jerry Yu23d1a252022-05-12 18:08:59 +08002423
2424/*
2425 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2426 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002427MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002428static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002429{
2430 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5fbd2702024-02-14 10:03:36 +01002431 if (ssl->handshake->hello_retry_request_flag) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2433 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2434 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2435 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002436 }
2437
2438 /*
2439 * Create stateless transcript hash for HRR
2440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2442 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2443 if (ret != 0) {
2444 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2445 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002446 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002448
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002450}
2451
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002452MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002453static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002454{
2455 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2456 unsigned char *buf;
2457 size_t buf_len, msg_len;
2458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2464 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2465 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2468 buf + buf_len,
2469 &msg_len,
2470 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002471 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002472 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002473
2474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2476 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002477
Ronald Cron5fbd2702024-02-14 10:03:36 +01002478 ssl->handshake->hello_retry_request_flag = 1;
Jerry Yu23d1a252022-05-12 18:08:59 +08002479
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002480#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2481 /* The server sends a dummy change_cipher_spec record immediately
2482 * after its first handshake message. This may either be after
2483 * a ServerHello or a HelloRetryRequest.
2484 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002485 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002487#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002489#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002490
2491cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2493 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002494}
2495
Jerry Yu5b64ae92022-03-30 17:15:02 +08002496/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002497 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2498 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002499
2500/*
2501 * struct {
2502 * Extension extensions<0..2 ^ 16 - 1>;
2503 * } EncryptedExtensions;
2504 *
2505 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002506MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002507static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2508 unsigned char *buf,
2509 unsigned char *end,
2510 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002511{
XiaokangQianacb39922022-06-17 10:18:48 +00002512 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002513 unsigned char *p = buf;
2514 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002515 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002516 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002517
Jerry Yu4d3841a2022-04-16 12:37:19 +08002518 *out_len = 0;
2519
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002521 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002522 p += 2;
2523
Jerry Yu8937eb42022-05-03 12:12:14 +08002524 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002525 ((void) ret);
2526 ((void) output_len);
2527
2528#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2530 if (ret != 0) {
2531 return ret;
2532 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002533 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002534#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002535
Jerry Yu71c14f12022-12-12 11:10:35 +08002536#if defined(MBEDTLS_SSL_EARLY_DATA)
Ronald Cron78a38f62024-02-01 18:30:31 +01002537 if (ssl->handshake->early_data_accepted) {
Jerry Yu52335392023-11-23 18:06:06 +08002538 ret = mbedtls_ssl_tls13_write_early_data_ext(
Jerry Yuc59c5862023-12-05 10:40:49 +08002539 ssl, 0, p, end, &output_len);
Jerry Yu71c14f12022-12-12 11:10:35 +08002540 if (ret != 0) {
2541 return ret;
2542 }
2543 p += output_len;
2544 }
2545#endif /* MBEDTLS_SSL_EARLY_DATA */
2546
Waleed Elmelegy47d29462024-01-03 17:31:52 +00002547#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Waleed Elmelegyfbe42742024-01-05 18:11:10 +00002548 if (ssl->handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(RECORD_SIZE_LIMIT)) {
Waleed Elmelegyd2fc90e2024-01-04 18:04:53 +00002549 ret = mbedtls_ssl_tls13_write_record_size_limit_ext(
2550 ssl, p, end, &output_len);
2551 if (ret != 0) {
2552 return ret;
2553 }
2554 p += output_len;
Waleed Elmelegy47d29462024-01-03 17:31:52 +00002555 }
Waleed Elmelegy47d29462024-01-03 17:31:52 +00002556#endif
2557
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 extensions_len = (p - p_extensions_len) - 2;
2559 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002560
2561 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002564
Jerry Yu7de2ff02022-11-08 21:43:46 +08002565 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002569}
2570
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002571MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002572static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002573{
2574 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2575 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002576 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 mbedtls_ssl_set_outbound_transform(ssl,
2579 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002580 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002582
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002584
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002585 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2586 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2587 &buf, &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2590 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002591
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002592 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002593 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2594 buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002595
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2597 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002598
Ronald Cron928cbd32022-10-04 16:14:26 +02002599#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2601 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2602 } else {
2603 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2604 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002605#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002607#endif
2608
Jerry Yu4d3841a2022-04-16 12:37:19 +08002609cleanup:
2610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2612 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002613}
2614
Ronald Cron928cbd32022-10-04 16:14:26 +02002615#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002616#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2617#define SSL_CERTIFICATE_REQUEST_SKIP 1
2618/* Coordination:
2619 * Check whether a CertificateRequest message should be written.
2620 * Returns a negative code on failure, or
2621 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2622 * - SSL_CERTIFICATE_REQUEST_SKIP
2623 * indicating if the writing of the CertificateRequest
2624 * should be skipped or not.
2625 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002626MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002627static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002628{
2629 int authmode;
2630
XiaokangQian40a35232022-05-07 09:02:40 +00002631#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002633 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002635#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002636 authmode = ssl->conf->authmode;
2637
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002639 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002641 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002642
XiaokangQianc3017f62022-05-13 05:55:41 +00002643 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002646}
2647
XiaokangQiancec9ae62022-05-06 07:28:50 +00002648/*
2649 * struct {
2650 * opaque certificate_request_context<0..2^8-1>;
2651 * Extension extensions<2..2^16-1>;
2652 * } CertificateRequest;
2653 *
2654 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002655MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002656static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2657 unsigned char *buf,
2658 const unsigned char *end,
2659 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002660{
2661 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2662 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002663 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002664 unsigned char *p_extensions_len;
2665
2666 *out_len = 0;
2667
2668 /* Check if we have enough space:
2669 * - certificate_request_context (1 byte)
2670 * - extensions length (2 bytes)
2671 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002673
2674 /*
2675 * Write certificate_request_context
2676 */
2677 /*
2678 * We use a zero length context for the normal handshake
2679 * messages. For post-authentication handshake messages
2680 * this request context would be set to a non-zero value.
2681 */
2682 *p++ = 0x0;
2683
2684 /*
2685 * Write extensions
2686 */
2687 /* The extensions must contain the signature_algorithms. */
2688 p_extensions_len = p;
2689 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2691 if (ret != 0) {
2692 return ret;
2693 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002694
XiaokangQianec6efb92022-05-06 09:53:10 +00002695 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002697
2698 *out_len = p - buf;
2699
Jerry Yu7de2ff02022-11-08 21:43:46 +08002700 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002704}
2705
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002706MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002707static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002708{
2709 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2710
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002714
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002716 unsigned char *buf;
2717 size_t buf_len, msg_len;
2718
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002719 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2720 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2721 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2724 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002725
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002726 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002727 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2728 buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002729
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2731 ssl, buf_len, msg_len));
2732 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2733 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002734 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 } else {
2736 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002737 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2738 goto cleanup;
2739 }
2740
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002742cleanup:
2743
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2745 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002746}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002747
Jerry Yu4d3841a2022-04-16 12:37:19 +08002748/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002749 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002750 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002751MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002752static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002753{
Jerry Yu5a26f302022-05-10 20:46:40 +08002754 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002755
2756#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2758 mbedtls_ssl_own_cert(ssl) == NULL) {
2759 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2760 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2761 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2762 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002763 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002764#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2767 if (ret != 0) {
2768 return ret;
2769 }
2770 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2771 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002772}
2773
2774/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002775 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002776 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002777MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002778static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002779{
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2781 if (ret != 0) {
2782 return ret;
2783 }
2784 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2785 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002786}
Ronald Cron928cbd32022-10-04 16:14:26 +02002787#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002788
Jerry Yu9b72e392023-12-01 16:27:08 +08002789/*
2790 * RFC 8446 section A.2
2791 *
2792 * | Send ServerHello
2793 * | K_send = handshake
2794 * | Send EncryptedExtensions
2795 * | [Send CertificateRequest]
2796 * Can send | [Send Certificate + CertificateVerify]
2797 * app data | Send Finished
2798 * after --> | K_send = application
2799 * here +--------+--------+
2800 * No 0-RTT | | 0-RTT
2801 * | |
2802 * K_recv = handshake | | K_recv = early data
2803 * [Skip decrypt errors] | +------> WAIT_EOED -+
2804 * | | Recv | | Recv EndOfEarlyData
2805 * | | early data | | K_recv = handshake
2806 * | +------------+ |
2807 * | |
2808 * +> WAIT_FLIGHT2 <--------+
2809 * |
2810 * +--------+--------+
2811 * No auth | | Client auth
2812 * | |
2813 * | v
2814 * | WAIT_CERT
2815 * | Recv | | Recv Certificate
2816 * | empty | v
2817 * | Certificate | WAIT_CV
2818 * | | | Recv
2819 * | v | CertificateVerify
2820 * +-> WAIT_FINISHED <---+
2821 * | Recv Finished
2822 *
2823 *
2824 * The following function handles the state changes after WAIT_FLIGHT2 in the
Jerry Yu3be85072023-12-04 09:58:54 +08002825 * above diagram. We are not going to receive early data related messages
2826 * anymore, prepare to receive the first handshake message of the client
2827 * second flight.
Jerry Yu9b72e392023-12-01 16:27:08 +08002828 */
Jerry Yu3be85072023-12-04 09:58:54 +08002829static void ssl_tls13_prepare_for_handshake_second_flight(
2830 mbedtls_ssl_context *ssl)
Jerry Yu9b72e392023-12-01 16:27:08 +08002831{
Jerry Yu9b72e392023-12-01 16:27:08 +08002832 if (ssl->handshake->certificate_request_sent) {
2833 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2834 } else {
Jerry Yu42020fb2023-12-05 17:35:53 +08002835 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
Jerry Yuebb1b1d2023-12-05 11:02:15 +08002836 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Jerry Yuebb1b1d2023-12-05 11:02:15 +08002837
Jerry Yu9b72e392023-12-01 16:27:08 +08002838 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2839 }
Jerry Yu9b72e392023-12-01 16:27:08 +08002840}
2841
Jerry Yu83da34e2022-04-16 13:59:52 +08002842/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002843 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002844 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002845MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002846static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002847{
Jerry Yud6e253d2022-05-18 13:59:24 +08002848 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2851 if (ret != 0) {
2852 return ret;
2853 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002854
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2856 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002857 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2859 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2860 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002861 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002862
Jerry Yu87b5ed42022-12-12 13:07:07 +08002863#if defined(MBEDTLS_SSL_EARLY_DATA)
Ronald Cron78a38f62024-02-01 18:30:31 +01002864 if (ssl->handshake->early_data_accepted) {
Jerry Yu0af63dc2023-12-01 17:14:51 +08002865 /* See RFC 8446 section A.2 for more information */
Jerry Yu87b5ed42022-12-12 13:07:07 +08002866 MBEDTLS_SSL_DEBUG_MSG(
2867 1, ("Switch to early keys for inbound traffic. "
2868 "( K_recv = early data )"));
2869 mbedtls_ssl_set_inbound_transform(
2870 ssl, ssl->handshake->transform_earlydata);
2871 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
2872 return 0;
2873 }
2874#endif /* MBEDTLS_SSL_EARLY_DATA */
Jerry Yu0af63dc2023-12-01 17:14:51 +08002875 MBEDTLS_SSL_DEBUG_MSG(
2876 1, ("Switch to handshake keys for inbound traffic "
2877 "( K_recv = handshake )"));
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002879
Jerry Yu3be85072023-12-04 09:58:54 +08002880 ssl_tls13_prepare_for_handshake_second_flight(ssl);
Jerry Yu7d8c3fe2022-12-12 12:59:44 +08002881
2882 return 0;
2883}
2884
Jerry Yu87b5ed42022-12-12 13:07:07 +08002885#if defined(MBEDTLS_SSL_EARLY_DATA)
2886/*
Jerry Yu59d420f2023-12-01 16:30:34 +08002887 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
Jerry Yu87b5ed42022-12-12 13:07:07 +08002888 */
Jerry Yu3be85072023-12-04 09:58:54 +08002889#define SSL_GOT_END_OF_EARLY_DATA 0
Jerry Yub55f9eb2023-12-05 10:27:17 +08002890#define SSL_GOT_EARLY_DATA 1
Jerry Yud5c34962023-12-01 16:32:31 +08002891/* Coordination:
Jerry Yu3be85072023-12-04 09:58:54 +08002892 * Deals with the ambiguity of not knowing if the next message is an
2893 * EndOfEarlyData message or an application message containing early data.
Jerry Yud5c34962023-12-01 16:32:31 +08002894 * Returns a negative code on failure, or
Jerry Yu3be85072023-12-04 09:58:54 +08002895 * - SSL_GOT_END_OF_EARLY_DATA
Jerry Yub55f9eb2023-12-05 10:27:17 +08002896 * - SSL_GOT_EARLY_DATA
Jerry Yud5c34962023-12-01 16:32:31 +08002897 * indicating which message is received.
2898 */
2899MBEDTLS_CHECK_RETURN_CRITICAL
2900static int ssl_tls13_end_of_early_data_coordinate(mbedtls_ssl_context *ssl)
2901{
2902 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub4ed4602023-12-01 16:34:00 +08002903
2904 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2905 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2906 return ret;
2907 }
2908 ssl->keep_current_message = 1;
2909
2910 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2911 ssl->in_msg[0] == MBEDTLS_SSL_HS_END_OF_EARLY_DATA) {
Jerry Yub55f9eb2023-12-05 10:27:17 +08002912 MBEDTLS_SSL_DEBUG_MSG(3, ("Received an end_of_early_data message."));
Jerry Yu3be85072023-12-04 09:58:54 +08002913 return SSL_GOT_END_OF_EARLY_DATA;
Jerry Yub4ed4602023-12-01 16:34:00 +08002914 }
2915
2916 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Croned7d4bf2024-01-31 07:55:19 +01002917 if (ssl->in_offt == NULL) {
Ronald Cron85718042024-02-22 10:22:09 +01002918 MBEDTLS_SSL_DEBUG_MSG(3, ("Received early data"));
Ronald Croned7d4bf2024-01-31 07:55:19 +01002919 /* Set the reading pointer */
2920 ssl->in_offt = ssl->in_msg;
Ronald Cron85718042024-02-22 10:22:09 +01002921 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, ssl->in_msglen);
2922 if (ret != 0) {
2923 return ret;
2924 }
Ronald Croned7d4bf2024-01-31 07:55:19 +01002925 }
Jerry Yub55f9eb2023-12-05 10:27:17 +08002926 return SSL_GOT_EARLY_DATA;
Jerry Yub4ed4602023-12-01 16:34:00 +08002927 }
2928
Jerry Yu7bb40a32023-12-04 10:04:15 +08002929 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
2930 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Jerry Yub4ed4602023-12-01 16:34:00 +08002931 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud5c34962023-12-01 16:32:31 +08002932}
2933
2934MBEDTLS_CHECK_RETURN_CRITICAL
2935static int ssl_tls13_parse_end_of_early_data(mbedtls_ssl_context *ssl,
2936 const unsigned char *buf,
2937 const unsigned char *end)
2938{
Jerry Yu75c9ab72023-12-01 16:41:40 +08002939 /* RFC 8446 section 4.5
2940 *
2941 * struct {} EndOfEarlyData;
2942 */
Jerry Yufbf03992023-12-04 10:00:37 +08002943 if (buf != end) {
2944 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2945 MBEDTLS_ERR_SSL_DECODE_ERROR);
2946 return MBEDTLS_ERR_SSL_DECODE_ERROR;
2947 }
2948 return 0;
Jerry Yud5c34962023-12-01 16:32:31 +08002949}
2950
Jerry Yud5c34962023-12-01 16:32:31 +08002951/*
2952 * RFC 8446 section A.2
2953 *
2954 * | Send ServerHello
2955 * | K_send = handshake
2956 * | Send EncryptedExtensions
2957 * | [Send CertificateRequest]
2958 * Can send | [Send Certificate + CertificateVerify]
2959 * app data | Send Finished
2960 * after --> | K_send = application
2961 * here +--------+--------+
2962 * No 0-RTT | | 0-RTT
2963 * | |
2964 * K_recv = handshake | | K_recv = early data
2965 * [Skip decrypt errors] | +------> WAIT_EOED -+
2966 * | | Recv | | Recv EndOfEarlyData
2967 * | | early data | | K_recv = handshake
2968 * | +------------+ |
2969 * | |
2970 * +> WAIT_FLIGHT2 <--------+
2971 * |
2972 * +--------+--------+
2973 * No auth | | Client auth
2974 * | |
2975 * | v
2976 * | WAIT_CERT
2977 * | Recv | | Recv Certificate
2978 * | empty | v
2979 * | Certificate | WAIT_CV
2980 * | | | Recv
2981 * | v | CertificateVerify
2982 * +-> WAIT_FINISHED <---+
2983 * | Recv Finished
2984 *
2985 * The function handles actions and state changes from 0-RTT to WAIT_FLIGHT2 in
2986 * the above diagram.
2987 */
Jerry Yu87b5ed42022-12-12 13:07:07 +08002988MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu59d420f2023-12-01 16:30:34 +08002989static int ssl_tls13_process_end_of_early_data(mbedtls_ssl_context *ssl)
Jerry Yu87b5ed42022-12-12 13:07:07 +08002990{
2991 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud5c34962023-12-01 16:32:31 +08002992
2993 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_tls13_process_end_of_early_data"));
2994
2995 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_end_of_early_data_coordinate(ssl));
2996
Jerry Yu3be85072023-12-04 09:58:54 +08002997 if (ret == SSL_GOT_END_OF_EARLY_DATA) {
Jerry Yud5c34962023-12-01 16:32:31 +08002998 unsigned char *buf;
2999 size_t buf_len;
3000
3001 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
3002 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
3003 &buf, &buf_len));
3004
3005 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_end_of_early_data(
3006 ssl, buf, buf + buf_len));
3007
Jerry Yue9655122023-12-01 16:44:40 +08003008 MBEDTLS_SSL_DEBUG_MSG(
3009 1, ("Switch to handshake keys for inbound traffic"
3010 "( K_recv = handshake )"));
3011 mbedtls_ssl_set_inbound_transform(
3012 ssl, ssl->handshake->transform_handshake);
3013
Jerry Yud5c34962023-12-01 16:32:31 +08003014 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
3015 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
3016 buf, buf_len));
Jerry Yue9655122023-12-01 16:44:40 +08003017
Jerry Yu3be85072023-12-04 09:58:54 +08003018 ssl_tls13_prepare_for_handshake_second_flight(ssl);
Jerry Yud5c34962023-12-01 16:32:31 +08003019
Jerry Yub55f9eb2023-12-05 10:27:17 +08003020 } else if (ret == SSL_GOT_EARLY_DATA) {
Jerry Yud9ca3542023-12-06 17:23:52 +08003021 ret = MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA;
3022 goto cleanup;
Jerry Yud5c34962023-12-01 16:32:31 +08003023 } else {
3024 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
3025 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3026 goto cleanup;
3027 }
3028
Jerry Yud5c34962023-12-01 16:32:31 +08003029cleanup:
3030 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_tls13_process_end_of_early_data"));
Jerry Yu87b5ed42022-12-12 13:07:07 +08003031 return ret;
3032}
3033#endif /* MBEDTLS_SSL_EARLY_DATA */
3034
Jerry Yu69dd8d42022-04-16 12:51:26 +08003035/*
Jerry Yud6e253d2022-05-18 13:59:24 +08003036 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08003037 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003038MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003039static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08003040{
Jerry Yud6e253d2022-05-18 13:59:24 +08003041 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3042
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
3044 if (ret != 0) {
3045 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08003046 }
3047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
3049 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003050 MBEDTLS_SSL_DEBUG_RET(
3051 1, "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 }
3053
3054 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
3055 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08003056}
3057
3058/*
Jerry Yud6e253d2022-05-18 13:59:24 +08003059 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08003060 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003061MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003062static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08003063{
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08003065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00003067
Pengyu Lv3643fdb2023-01-12 16:46:28 +08003068#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
3069 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08003070/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
3071 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
3072 * expected to be resolved with issue#6395.
3073 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08003074 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lvb2cfafb2023-11-14 13:56:13 +08003075 if (mbedtls_ssl_tls13_is_some_psk_supported(ssl)) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003076 mbedtls_ssl_handshake_set_state(
3077 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08003078 } else
Jerry Yufca4d572022-07-21 10:37:48 +08003079#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08003080 {
3081 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3082 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08003084}
3085
3086/*
Jerry Yua8d3c502022-10-30 14:51:23 +08003087 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003088 */
3089#define SSL_NEW_SESSION_TICKET_SKIP 0
3090#define SSL_NEW_SESSION_TICKET_WRITE 1
3091MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003092static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00003093{
3094 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 if (ssl->conf->f_ticket_write == NULL) {
3096 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
3097 " callback is not set"));
3098 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08003099 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 if (ssl->conf->new_session_tickets_count == 0) {
3101 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
3102 " configured count is zero"));
3103 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08003104 }
3105
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 if (ssl->handshake->new_session_tickets_count == 0) {
3107 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
3108 "been sent."));
3109 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00003110 }
3111
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00003113}
3114
3115#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3116MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003117static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
3118 unsigned char *ticket_nonce,
3119 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00003120{
3121 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3122 mbedtls_ssl_session *session = ssl->session;
3123 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
3124 psa_algorithm_t psa_hash_alg;
3125 int hash_length;
3126
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00003128
Pengyu Lv9f926952022-11-17 15:22:33 +08003129 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003130 mbedtls_ssl_tls13_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08003131 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08003132#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003133 mbedtls_ssl_tls13_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08003134 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08003135#endif
Jerry Yu95648b02023-12-06 15:03:34 +08003136
3137#if defined(MBEDTLS_SSL_EARLY_DATA)
3138 if (ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED &&
3139 ssl->conf->max_early_data_size > 0) {
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003140 mbedtls_ssl_tls13_session_set_ticket_flags(
Jerry Yu95648b02023-12-06 15:03:34 +08003141 session, MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA);
Ronald Cronc2865192024-02-07 14:01:03 +01003142 session->max_early_data_size = ssl->conf->max_early_data_size;
Jerry Yu95648b02023-12-06 15:03:34 +08003143 }
3144#endif /* MBEDTLS_SSL_EARLY_DATA */
3145
Pengyu Lv4938a562023-01-16 11:28:49 +08003146 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08003147
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003148#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003149 ret = mbedtls_ssl_session_set_alpn(session, ssl->alpn_chosen);
3150 if (ret != 0) {
3151 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003152 }
3153#endif
3154
Jerry Yue67bef42022-07-07 07:29:42 +00003155 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
3157 (unsigned char *) &session->ticket_age_add,
3158 sizeof(session->ticket_age_add)) != 0)) {
3159 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
3160 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003161 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
3163 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00003164
3165 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
3167 if (ret != 0) {
3168 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
3169 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003170 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
3172 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00003173
3174 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
Dave Rodgman2eab4622023-10-05 13:30:37 +01003176 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
3178 if (hash_length == -1 ||
3179 (size_t) hash_length > sizeof(session->resumption_key)) {
3180 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08003181 }
3182
Jerry Yue67bef42022-07-07 07:29:42 +00003183 /* In this code the psk key length equals the length of the hash */
3184 session->resumption_key_len = hash_length;
3185 session->ciphersuite = ciphersuite_info->id;
3186
3187 /* Compute resumption key
3188 *
3189 * HKDF-Expand-Label( resumption_master_secret,
3190 * "resumption", ticket_nonce, Hash.length )
3191 */
3192 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 psa_hash_alg,
3194 session->app_secrets.resumption_master_secret,
3195 hash_length,
3196 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
3197 ticket_nonce,
3198 ticket_nonce_size,
3199 session->resumption_key,
3200 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00003201
Gilles Peskine449bd832023-01-11 14:50:10 +01003202 if (ret != 0) {
3203 MBEDTLS_SSL_DEBUG_RET(2,
3204 "Creating the ticket-resumed PSK failed",
3205 ret);
3206 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003207 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003208 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
3209 session->resumption_key,
3210 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00003211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
3213 session->app_secrets.resumption_master_secret,
3214 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00003217}
3218
3219/* This function creates a NewSessionTicket message in the following format:
3220 *
3221 * struct {
3222 * uint32 ticket_lifetime;
3223 * uint32 ticket_age_add;
3224 * opaque ticket_nonce<0..255>;
3225 * opaque ticket<1..2^16-1>;
3226 * Extension extensions<0..2^16-2>;
3227 * } NewSessionTicket;
3228 *
3229 * The ticket inside the NewSessionTicket message is an encrypted container
3230 * carrying the necessary information so that the server is later able to
3231 * re-start the communication.
3232 *
3233 * The following fields are placed inside the ticket by the
3234 * f_ticket_write() function:
3235 *
Jerry Yu0069abc2023-11-23 21:07:28 +08003236 * - creation time (ticket_creation_time)
3237 * - flags (ticket_flags)
Jerry Yue67bef42022-07-07 07:29:42 +00003238 * - age add (ticket_age_add)
Jerry Yu0069abc2023-11-23 21:07:28 +08003239 * - key (resumption_key)
3240 * - key length (resumption_key_len)
Jerry Yue67bef42022-07-07 07:29:42 +00003241 * - ciphersuite (ciphersuite)
Jerry Yu0069abc2023-11-23 21:07:28 +08003242 * - max_early_data_size (max_early_data_size)
Jerry Yue67bef42022-07-07 07:29:42 +00003243 */
3244MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003245static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
3246 unsigned char *buf,
3247 unsigned char *end,
3248 size_t *out_len,
3249 unsigned char *ticket_nonce,
3250 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00003251{
3252 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3253 unsigned char *p = buf;
3254 mbedtls_ssl_session *session = ssl->session;
3255 size_t ticket_len;
3256 uint32_t ticket_lifetime;
Jerry Yu01da35e2022-12-12 15:09:22 +08003257 unsigned char *p_extensions_len;
Jerry Yue67bef42022-07-07 07:29:42 +00003258
3259 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00003261
3262 /*
3263 * ticket_lifetime 4 bytes
3264 * ticket_age_add 4 bytes
3265 * ticket_nonce 1 + ticket_nonce_size bytes
3266 * ticket >=2 bytes
3267 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00003269
3270 /* Generate ticket and ticket_lifetime */
Ronald Cron3c0072b2023-11-22 10:00:14 +01003271#if defined(MBEDTLS_HAVE_TIME)
3272 session->ticket_creation_time = mbedtls_ms_time();
3273#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
3275 session,
3276 p + 9 + ticket_nonce_size + 2,
3277 end,
3278 &ticket_len,
3279 &ticket_lifetime);
3280 if (ret != 0) {
3281 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
3282 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003283 }
3284 /* RFC 8446 4.6.1
3285 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
3286 * unsigned integer in network byte order from the time of ticket
3287 * issuance. Servers MUST NOT use any value greater than
3288 * 604800 seconds (7 days). The value of zero indicates that the
3289 * ticket should be discarded immediately. Clients MUST NOT cache
3290 * tickets for longer than 7 days, regardless of the ticket_lifetime,
3291 * and MAY delete tickets earlier based on local policy. A server
3292 * MAY treat a ticket as valid for a shorter period of time than what
3293 * is stated in the ticket_lifetime.
3294 */
Jerry Yu8e0174a2023-11-10 13:58:16 +08003295 if (ticket_lifetime > MBEDTLS_SSL_TLS1_3_MAX_ALLOWED_TICKET_LIFETIME) {
3296 ticket_lifetime = MBEDTLS_SSL_TLS1_3_MAX_ALLOWED_TICKET_LIFETIME;
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 }
3298 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
3299 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
3300 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00003301
3302 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
3304 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
3305 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00003306
3307 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 p[8] = (unsigned char) ticket_nonce_size;
3309 if (ticket_nonce_size > 0) {
3310 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00003311 }
3312 p += 9 + ticket_nonce_size;
3313
3314 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00003316 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00003318 p += ticket_len;
3319
3320 /* Ticket Extensions
3321 *
Jerry Yu01da35e2022-12-12 15:09:22 +08003322 * Extension extensions<0..2^16-2>;
Jerry Yue67bef42022-07-07 07:29:42 +00003323 */
Jerry Yuedab6372022-10-31 14:37:31 +08003324 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
3325
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu01da35e2022-12-12 15:09:22 +08003327 p_extensions_len = p;
Jerry Yue67bef42022-07-07 07:29:42 +00003328 p += 2;
3329
Jerry Yu01da35e2022-12-12 15:09:22 +08003330#if defined(MBEDTLS_SSL_EARLY_DATA)
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003331 if (mbedtls_ssl_tls13_session_ticket_allow_early_data(session)) {
Jerry Yu95648b02023-12-06 15:03:34 +08003332 size_t output_len;
3333
Jerry Yuf135bac2023-11-23 18:10:51 +08003334 if ((ret = mbedtls_ssl_tls13_write_early_data_ext(
Jerry Yuc59c5862023-12-05 10:40:49 +08003335 ssl, 1, p, end, &output_len)) != 0) {
Jerry Yuf135bac2023-11-23 18:10:51 +08003336 MBEDTLS_SSL_DEBUG_RET(
3337 1, "mbedtls_ssl_tls13_write_early_data_ext", ret);
3338 return ret;
3339 }
3340 p += output_len;
Jerry Yu9e7f9bc2023-11-27 16:52:07 +08003341 } else {
3342 MBEDTLS_SSL_DEBUG_MSG(
3343 4, ("early_data not allowed, "
3344 "skip early_data extension in NewSessionTicket"));
Jerry Yu01da35e2022-12-12 15:09:22 +08003345 }
Jerry Yuf135bac2023-11-23 18:10:51 +08003346
Jerry Yu01da35e2022-12-12 15:09:22 +08003347#endif /* MBEDTLS_SSL_EARLY_DATA */
3348
3349 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
3350
Jerry Yue67bef42022-07-07 07:29:42 +00003351 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
3353 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00003354
Jerry Yu7de2ff02022-11-08 21:43:46 +08003355 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08003357
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00003359}
3360
3361/*
Jerry Yua8d3c502022-10-30 14:51:23 +08003362 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003364static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00003365{
3366 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3367
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00003369
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00003371 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
3372 unsigned char *buf;
3373 size_t buf_len, msg_len;
3374
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
3376 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003377
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003378 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
3379 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
3380 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00003381
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
3383 ssl, buf, buf + buf_len, &msg_len,
3384 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003385
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
3387 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08003388
Jerry Yu359e65f2022-09-22 23:47:43 +08003389 /* Limit session tickets count to one when resumption connection.
3390 *
3391 * See document of mbedtls_ssl_conf_new_session_tickets.
3392 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003393 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08003394 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003395 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08003396 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08003398
Jerry Yua8d3c502022-10-30 14:51:23 +08003399 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003400 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
3401 } else {
3402 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00003403 }
3404
Jerry Yue67bef42022-07-07 07:29:42 +00003405cleanup:
3406
Gilles Peskine449bd832023-01-11 14:50:10 +01003407 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003408}
3409#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3410
3411/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00003412 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00003413 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003414int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08003415{
XiaokangQian08037552022-04-20 07:16:41 +00003416 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003417
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
3419 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3420 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003421
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
Dave Rodgman2eab4622023-10-05 13:30:37 +01003423 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state),
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08003425
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00003427 /* start state */
3428 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00003430 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003431 break;
3432
XiaokangQian7807f9f2022-02-15 10:04:37 +00003433 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003434 ret = ssl_tls13_process_client_hello(ssl);
3435 if (ret != 0) {
3436 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
3437 }
Jerry Yuf41553b2022-05-09 22:20:30 +08003438 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003439
Jerry Yuf41553b2022-05-09 22:20:30 +08003440 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003441 ret = ssl_tls13_write_hello_retry_request(ssl);
3442 if (ret != 0) {
3443 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
3444 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08003445 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003446 break;
3447
Jerry Yu5b64ae92022-03-30 17:15:02 +08003448 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08003450 break;
3451
Xiaofei Baicba64af2022-02-15 10:00:56 +00003452 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 ret = ssl_tls13_write_encrypted_extensions(ssl);
3454 if (ret != 0) {
3455 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
3456 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00003457 }
Jerry Yu48330562022-05-06 21:35:44 +08003458 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08003459
Ronald Cron928cbd32022-10-04 16:14:26 +02003460#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003461 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003462 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003463 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003464
Jerry Yu83da34e2022-04-16 13:59:52 +08003465 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003466 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003467 break;
3468
3469 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003471 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003472#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003473
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 /*
3475 * Injection of dummy-CCS's for middlebox compatibility
3476 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003477#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003478 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003479 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3480 if (ret == 0) {
3481 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3482 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003483 break;
3484
3485 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Ronald Crone273f722024-02-13 18:22:26 +01003486 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3487 if (ret != 0) {
3488 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003489 }
Ronald Cronfe59ff72024-01-24 14:31:50 +01003490 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003491 break;
3492#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3493
Jerry Yu69dd8d42022-04-16 12:51:26 +08003494 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003495 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003496 break;
3497
Jerry Yu87b5ed42022-12-12 13:07:07 +08003498#if defined(MBEDTLS_SSL_EARLY_DATA)
3499 case MBEDTLS_SSL_END_OF_EARLY_DATA:
Jerry Yu59d420f2023-12-01 16:30:34 +08003500 ret = ssl_tls13_process_end_of_early_data(ssl);
Jerry Yu87b5ed42022-12-12 13:07:07 +08003501 break;
3502#endif /* MBEDTLS_SSL_EARLY_DATA */
3503
Jerry Yu69dd8d42022-04-16 12:51:26 +08003504 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003505 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003506 break;
3507
Jerry Yu69dd8d42022-04-16 12:51:26 +08003508 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003510 break;
3511
Ronald Cron766c0cd2022-10-18 12:17:11 +02003512#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003513 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003514 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3515 if (ret == 0) {
3516 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003517 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3519 } else {
3520 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003521 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003522 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003523 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003524 }
3525 break;
3526
3527 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003528 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3529 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003530 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003531 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003532 }
3533 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003534#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003535
Jerry Yue67bef42022-07-07 07:29:42 +00003536#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003537 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003538 ret = ssl_tls13_write_new_session_ticket(ssl);
3539 if (ret != 0) {
3540 MBEDTLS_SSL_DEBUG_RET(1,
3541 "ssl_tls13_write_new_session_ticket ",
3542 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003543 }
3544 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003545 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003546 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003547 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003548 * as part of ssl_prepare_handshake_step.
3549 */
3550 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003551
Gilles Peskine449bd832023-01-11 14:50:10 +01003552 if (ssl->handshake->new_session_tickets_count == 0) {
3553 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3554 } else {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003555 mbedtls_ssl_handshake_set_state(
3556 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Gilles Peskine449bd832023-01-11 14:50:10 +01003557 }
Jerry Yue67bef42022-07-07 07:29:42 +00003558 break;
3559
3560#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3561
XiaokangQian7807f9f2022-02-15 10:04:37 +00003562 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003563 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3564 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003565 }
3566
Gilles Peskine449bd832023-01-11 14:50:10 +01003567 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003568}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003569
Jerry Yufb4b6472022-01-27 15:03:26 +08003570#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */