blob: 2c30da8918074dd49da747d81087f37e692f1760 [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 Elmelegy5bc52632024-03-12 16:25:08 +0000472 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +0000473 if (ret != 0) {
474 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +0000475 }
476#endif /* MBEDTLS_SSL_ALPN */
477#endif /* MBEDTLS_SSL_EARLY_DATA*/
Jerry Yu33bf2402022-12-12 16:01:43 +0800478
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800480}
481#endif /* MBEDTLS_SSL_SESSION_TICKETS */
482
Ronald Cron79cdd412024-02-20 17:19:28 +0100483struct psk_attributes {
484 int type;
485 int key_exchange_mode;
Ronald Cron74a16292024-02-23 17:07:41 +0100486 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Ronald Cron79cdd412024-02-20 17:19:28 +0100487};
Ronald Cron16cc3702024-03-07 15:04:56 +0100488#define PSK_ATTRIBUTES_INIT { 0, 0, NULL }
Ronald Cron79cdd412024-02-20 17:19:28 +0100489
Jerry Yu1c105562022-07-10 06:32:38 +0000490/* Parser for pre_shared_key extension in client hello
491 * struct {
492 * opaque identity<1..2^16-1>;
493 * uint32 obfuscated_ticket_age;
494 * } PskIdentity;
495 *
496 * opaque PskBinderEntry<32..255>;
497 *
498 * struct {
499 * PskIdentity identities<7..2^16-1>;
500 * PskBinderEntry binders<33..2^16-1>;
501 * } OfferedPsks;
502 *
503 * struct {
504 * select (Handshake.msg_type) {
505 * case client_hello: OfferedPsks;
506 * ....
507 * };
508 * } PreSharedKeyExtension;
509 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800510MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000511static int ssl_tls13_parse_pre_shared_key_ext(
512 mbedtls_ssl_context *ssl,
513 const unsigned char *pre_shared_key_ext,
514 const unsigned char *pre_shared_key_ext_end,
515 const unsigned char *ciphersuites,
Ronald Cron79cdd412024-02-20 17:19:28 +0100516 const unsigned char *ciphersuites_end,
517 struct psk_attributes *psk)
Jerry Yu1c105562022-07-10 06:32:38 +0000518{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100519 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800520 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800521 const unsigned char *p_identity_len;
522 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000523 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800524 const unsigned char *binders;
525 const unsigned char *p_binder_len;
526 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000527 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800528 int matched_identity = -1;
529 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000530
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
532 pre_shared_key_ext,
533 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000534
Jerry Yu96a2e362022-07-21 15:11:34 +0800535 /* identities_len 2 bytes
536 * identities_data >= 7 bytes
537 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
539 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800540 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
542 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800543 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000544
Jerry Yu96a2e362022-07-21 15:11:34 +0800545 /* binders_len 2 bytes
546 * binders >= 33 bytes
547 */
Jerry Yu568ec252022-07-22 21:27:34 +0800548 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
550 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800551 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800553 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000554
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100555 ret = ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
556 identities_end - pre_shared_key_ext);
557 if (0 != ret) {
558 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
559 return ret;
560 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800561
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000563 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800564 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800565 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800566 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800567 size_t binder_len;
Ronald Cron89089cc2024-02-14 18:18:08 +0100568 int psk_ciphersuite_id;
569 psa_algorithm_t psk_hash_alg;
Ronald Croncf284562024-02-16 18:54:10 +0100570 int allowed_key_exchange_modes;
Ronald Cron74a16292024-02-23 17:07:41 +0100571
Jerry Yu82534862022-08-30 10:42:33 +0800572#if defined(MBEDTLS_SSL_SESSION_TICKETS)
573 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800575#endif
Jerry Yubb852022022-07-20 21:10:44 +0800576
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
578 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800579 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
581 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800582 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000583
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800585 binder_len = *p_binder_len;
586 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800588 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800589
Jerry Yu96a2e362022-07-21 15:11:34 +0800590 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000592 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 }
Jerry Yu1c105562022-07-10 06:32:38 +0000594
Jerry Yu96a2e362022-07-21 15:11:34 +0800595 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100596 ssl, identity, identity_len, obfuscated_ticket_age,
Ronald Cron79cdd412024-02-20 17:19:28 +0100597 &psk->type, &session);
Ronald Cronfbae94a2023-12-05 18:15:14 +0100598 if (ret != SSL_TLS1_3_PSK_IDENTITY_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800599 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800601
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
Ronald Cron89089cc2024-02-14 18:18:08 +0100603
Ronald Cron79cdd412024-02-20 17:19:28 +0100604 switch (psk->type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800605 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
Ronald Cron89089cc2024-02-14 18:18:08 +0100606 psk_ciphersuite_id = 0;
607 psk_hash_alg = PSA_ALG_SHA_256;
Ronald Croncf284562024-02-16 18:54:10 +0100608 allowed_key_exchange_modes =
609 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
Jerry Yu0baf9072022-08-25 11:21:04 +0800610 break;
Jerry Yu82534862022-08-30 10:42:33 +0800611#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Cronf7e99162024-02-14 16:04:02 +0100612 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Ronald Cron89089cc2024-02-14 18:18:08 +0100613 psk_ciphersuite_id = session.ciphersuite;
614 psk_hash_alg = PSA_ALG_NONE;
Ronald Croncf284562024-02-16 18:54:10 +0100615 ssl->session_negotiate->ticket_flags = session.ticket_flags;
616 allowed_key_exchange_modes =
617 session.ticket_flags &
618 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
Jerry Yu0baf9072022-08-25 11:21:04 +0800619 break;
Ronald Cronf7e99162024-02-14 16:04:02 +0100620#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800621 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100622 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800623 }
Ronald Cron89089cc2024-02-14 18:18:08 +0100624
Ronald Cron79cdd412024-02-20 17:19:28 +0100625 psk->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
626
Ronald Croncf284562024-02-16 18:54:10 +0100627 if ((allowed_key_exchange_modes &
628 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) &&
629 ssl_tls13_key_exchange_is_psk_ephemeral_available(ssl)) {
Ronald Cron79cdd412024-02-20 17:19:28 +0100630 psk->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Ronald Croncf284562024-02-16 18:54:10 +0100631 } else if ((allowed_key_exchange_modes &
632 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) &&
633 ssl_tls13_key_exchange_is_psk_available(ssl)) {
Ronald Cron79cdd412024-02-20 17:19:28 +0100634 psk->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Ronald Croncf284562024-02-16 18:54:10 +0100635 }
636
Ronald Cron79cdd412024-02-20 17:19:28 +0100637 if (psk->key_exchange_mode == MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE) {
Ronald Croncf284562024-02-16 18:54:10 +0100638 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable PSK key exchange mode"));
639 continue;
640 }
641
Ronald Cron89089cc2024-02-14 18:18:08 +0100642 ssl_tls13_select_ciphersuite(ssl, ciphersuites, ciphersuites_end,
643 psk_ciphersuite_id, psk_hash_alg,
Ronald Cron74a16292024-02-23 17:07:41 +0100644 &psk->ciphersuite_info);
Ronald Cron89089cc2024-02-14 18:18:08 +0100645
Ronald Cron74a16292024-02-23 17:07:41 +0100646 if (psk->ciphersuite_info == NULL) {
Ronald Cron89089cc2024-02-14 18:18:08 +0100647#if defined(MBEDTLS_SSL_SESSION_TICKETS)
648 mbedtls_ssl_session_free(&session);
649#endif
650 /*
651 * We consider finding a ciphersuite suitable for the PSK as part
652 * of the validation of its binder. Thus if we do not find one, we
653 * abort the handshake with a decrypt_error alert.
654 */
Jerry Yuf35ba382022-08-23 17:58:26 +0800655 MBEDTLS_SSL_PEND_FATAL_ALERT(
656 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100657 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Ronald Cron89089cc2024-02-14 18:18:08 +0100658 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800659 }
660
Jerry Yu96a2e362022-07-21 15:11:34 +0800661 ret = ssl_tls13_offered_psks_check_binder_match(
Ronald Cron79cdd412024-02-20 17:19:28 +0100662 ssl, binder, binder_len, psk->type,
Ronald Cron74a16292024-02-23 17:07:41 +0100663 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) psk->ciphersuite_info->mac));
Ronald Cron6e311272023-12-05 17:57:01 +0100664 if (ret != SSL_TLS1_3_BINDER_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800665 /* For security reasons, the handshake should be aborted when we
666 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
667 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800668#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100669 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800670#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000672 MBEDTLS_SSL_DEBUG_RET(
673 1, "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800674 MBEDTLS_SSL_PEND_FATAL_ALERT(
675 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
677 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800678 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800679
680 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800681
Jerry Yu82534862022-08-30 10:42:33 +0800682#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Cron79cdd412024-02-20 17:19:28 +0100683 if (psk->type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
685 &session);
686 mbedtls_ssl_session_free(&session);
687 if (ret != 0) {
688 return ret;
689 }
Jerry Yu82534862022-08-30 10:42:33 +0800690 }
691#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000692 }
693
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 if (p_identity_len != identities_end || p_binder_len != binders_end) {
695 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
696 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
697 MBEDTLS_ERR_SSL_DECODE_ERROR);
698 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000699 }
700
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800701 /* Update the handshake transcript with the binder list. */
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000702 ret = ssl->handshake->update_checksum(
703 ssl, identities_end, (size_t) (binders_end - identities_end));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100704 if (0 != ret) {
705 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
706 return ret;
707 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 if (matched_identity == -1) {
Ronald Croncf284562024-02-16 18:54:10 +0100709 MBEDTLS_SSL_DEBUG_MSG(3, ("No usable PSK or ticket."));
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000711 }
712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 ssl->handshake->selected_identity = (uint16_t) matched_identity;
714 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000715
Gilles Peskine449bd832023-01-11 14:50:10 +0100716 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000717}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000718
719/*
720 * struct {
721 * select ( Handshake.msg_type ) {
722 * ....
723 * case server_hello:
724 * uint16 selected_identity;
725 * }
726 * } PreSharedKeyExtension;
727 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100728static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
729 unsigned char *buf,
730 unsigned char *end,
731 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000732{
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000734
735 *olen = 0;
736
David Horstmann21b89762022-10-06 18:34:28 +0100737 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000738#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000740#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000742#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000744 /* We shouldn't have called this extension writer unless we've
745 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100746 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000747 }
748
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
750 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000751
Gilles Peskine449bd832023-01-11 14:50:10 +0100752 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
753 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000754
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000756
757 *olen = 6;
758
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
760 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000761
Gilles Peskine449bd832023-01-11 14:50:10 +0100762 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800763
Gilles Peskine449bd832023-01-11 14:50:10 +0100764 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000765}
766
Ronald Cron41a443a2022-10-04 16:38:25 +0200767#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000768
XiaokangQian7807f9f2022-02-15 10:04:37 +0000769/* From RFC 8446:
770 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000771 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000772 * } SupportedVersions;
773 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200774MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100775static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
776 const unsigned char *buf,
777 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000778{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000779 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000780 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000781 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000782 uint16_t tls_version;
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100783 int found_supported_version = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000784
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000786 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000787 p += 1;
788
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000790 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 while (p < versions_end) {
792 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
793 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000794 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000795
Ronald Cron3bd2b022023-04-03 16:45:39 +0200796 if (MBEDTLS_SSL_VERSION_TLS1_3 == tls_version) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100797 found_supported_version = 1;
798 break;
799 }
800
Ronald Cron3bd2b022023-04-03 16:45:39 +0200801 if ((MBEDTLS_SSL_VERSION_TLS1_2 == tls_version) &&
802 mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100803 found_supported_version = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000804 break;
805 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000806 }
807
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100808 if (!found_supported_version) {
809 MBEDTLS_SSL_DEBUG_MSG(1, ("No supported version found."));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000810
Gilles Peskine449bd832023-01-11 14:50:10 +0100811 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
812 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
813 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000814 }
815
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100816 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version: [%04x]",
Gilles Peskine449bd832023-01-11 14:50:10 +0100817 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000818
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100819 return (int) tls_version;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000820}
821
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200822#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000823/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000824 *
825 * From RFC 8446:
826 * enum {
827 * ... (0xFFFF)
828 * } NamedGroup;
829 * struct {
830 * NamedGroup named_group_list<2..2^16-1>;
831 * } NamedGroupList;
832 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200833MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100834static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
835 const unsigned char *buf,
836 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000837{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000838 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000839 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000840 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000841
Gilles Peskine449bd832023-01-11 14:50:10 +0100842 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
843 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
844 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000845 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100846 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000847 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000848 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000849
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000851 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100852 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
853 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000854 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000855
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 MBEDTLS_SSL_DEBUG_MSG(2,
857 ("got named group: %s(%04x)",
858 mbedtls_ssl_named_group_to_str(named_group),
859 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000860
Gilles Peskine449bd832023-01-11 14:50:10 +0100861 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
862 !mbedtls_ssl_named_group_is_supported(named_group) ||
863 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000864 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000865 }
866
Gilles Peskine449bd832023-01-11 14:50:10 +0100867 MBEDTLS_SSL_DEBUG_MSG(2,
868 ("add named group %s(%04x) into received list.",
869 mbedtls_ssl_named_group_to_str(named_group),
870 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800871
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000872 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000873 }
874
Gilles Peskine449bd832023-01-11 14:50:10 +0100875 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000876
877}
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200878#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000879
XiaokangQian08037552022-04-20 07:16:41 +0000880#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
881
Valerio Settic9ae8622023-07-25 11:23:50 +0200882#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000883/*
884 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000885 * extension is correct and stores the first acceptable key share and its
886 * associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000887 *
888 * Possible return values are:
889 * - 0: Successful processing of the client provided key share extension.
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000890 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by
891 * the client does not match a group supported by the server. A
892 * HelloRetryRequest will be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000893 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800894 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200895MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100896static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
897 const unsigned char *buf,
898 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000899{
XiaokangQianb67384d2022-04-19 00:02:38 +0000900 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000901 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000902 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800903 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000904
905 /* From RFC 8446:
906 *
907 * struct {
908 * KeyShareEntry client_shares<0..2^16-1>;
909 * } KeyShareClientHello;
910 *
911 */
912
Gilles Peskine449bd832023-01-11 14:50:10 +0100913 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
914 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000915 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000917
918 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000919 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000920
921 /* We try to find a suitable key share entry and copy it to the
922 * handshake context. Later, we have to find out whether we can do
923 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000924 * dismiss it and send a HelloRetryRequest message.
925 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000926
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000928 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800929 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800930 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000931
932 /*
933 * struct {
934 * NamedGroup group;
935 * opaque key_exchange<1..2^16-1>;
936 * } KeyShareEntry;
937 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
939 group = MBEDTLS_GET_UINT16_BE(p, 0);
940 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800941 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800942 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800944 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000945
946 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000947 * for input validation purposes.
948 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
950 !mbedtls_ssl_named_group_is_supported(group) ||
951 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000952 continue;
953 }
XiaokangQian060d8672022-04-21 09:24:56 +0000954
XiaokangQian7807f9f2022-02-15 10:04:37 +0000955 /*
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200956 * ECDHE and FFDHE groups are supported
XiaokangQian7807f9f2022-02-15 10:04:37 +0000957 */
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200958 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200959 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200960 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH/FFDH group: %s (%04x)",
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 mbedtls_ssl_named_group_to_str(group),
962 group));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200963 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 ssl, key_exchange - 2, key_exchange_len + 2);
965 if (ret != 0) {
966 return ret;
967 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000968
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 } else {
970 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
971 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000972 continue;
973 }
974
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000975 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000976 }
977
Jerry Yuc1be19f2022-04-23 16:11:39 +0800978
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 if (ssl->handshake->offered_group_id == 0) {
980 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
981 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000982 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000984}
Valerio Settic9ae8622023-07-25 11:23:50 +0200985#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000986
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200987MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100988static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
989 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000990{
Jerry Yu0c354a22022-08-29 15:25:36 +0800991 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000993}
994
Jerry Yue5991322022-11-07 14:03:44 +0800995#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200996MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000997static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000999{
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 return ssl_tls13_client_hello_has_exts(
1001 ssl,
1002 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
1003 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
1004 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001005}
Jerry Yue5991322022-11-07 14:03:44 +08001006#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001007
Jerry Yue5991322022-11-07 14:03:44 +08001008#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +00001009MBEDTLS_CHECK_RETURN_CRITICAL
1010static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001012{
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 return ssl_tls13_client_hello_has_exts(
1014 ssl,
1015 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1016 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +00001017}
Jerry Yue5991322022-11-07 14:03:44 +08001018#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +00001019
Jerry Yue5991322022-11-07 14:03:44 +08001020#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +00001021MBEDTLS_CHECK_RETURN_CRITICAL
1022static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001024{
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 return ssl_tls13_client_hello_has_exts(
1026 ssl,
1027 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
1028 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
1029 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1030 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +00001031}
Jerry Yue5991322022-11-07 14:03:44 +08001032#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +00001033
Pengyu Lv306a01d2023-02-02 16:35:47 +08001034#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
1035MBEDTLS_CHECK_RETURN_CRITICAL
Pengyu Lvbc4aab72023-12-01 15:37:24 +08001036static int ssl_tls13_key_exchange_is_psk_available(mbedtls_ssl_context *ssl)
Pengyu Lv306a01d2023-02-02 16:35:47 +08001037{
Jerry Yue5991322022-11-07 14:03:44 +08001038#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Ronald Crone8c162d2024-02-21 10:15:44 +01001039 return mbedtls_ssl_conf_tls13_is_psk_enabled(ssl) &&
Pengyu Lvb2cfafb2023-11-14 13:56:13 +08001040 mbedtls_ssl_tls13_is_psk_supported(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001041 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001042#else
1043 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001045#endif
Jerry Yu77f01482022-07-11 07:03:24 +00001046}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001047
Jerry Yu77f01482022-07-11 07:03:24 +00001048MBEDTLS_CHECK_RETURN_CRITICAL
Pengyu Lvbc4aab72023-12-01 15:37:24 +08001049static int ssl_tls13_key_exchange_is_psk_ephemeral_available(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001050{
Jerry Yue5991322022-11-07 14:03:44 +08001051#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Ronald Crone8c162d2024-02-21 10:15:44 +01001052 return mbedtls_ssl_conf_tls13_is_psk_ephemeral_enabled(ssl) &&
Pengyu Lvb2cfafb2023-11-14 13:56:13 +08001053 mbedtls_ssl_tls13_is_psk_ephemeral_supported(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001055#else
1056 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001058#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001059}
1060#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
1061
1062MBEDTLS_CHECK_RETURN_CRITICAL
1063static int ssl_tls13_key_exchange_is_ephemeral_available(mbedtls_ssl_context *ssl)
1064{
1065#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
1066 return mbedtls_ssl_conf_tls13_is_ephemeral_enabled(ssl) &&
1067 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
1068#else
1069 ((void) ssl);
1070 return 0;
1071#endif
1072}
1073
XiaokangQian81802f42022-06-10 13:25:22 +00001074#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001075 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001076
1077#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001078static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001079{
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001081 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001083 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001085 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001087 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001089 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001091 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001093 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001095 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001097 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001099 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001101 }
1102}
1103#endif /* MBEDTLS_USE_PSA_CRYPTO */
1104
XiaokangQian23c5be62022-06-07 02:04:34 +00001105/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001106 * Pick best ( private key, certificate chain ) pair based on the signature
1107 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001108 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001109MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001110static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001111{
XiaokangQianfb665a82022-06-15 03:57:21 +00001112 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001113 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001114
1115#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001117 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001119#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001121
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 if (key_cert_list == NULL) {
1123 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1124 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001125 }
1126
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1128 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001129 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001133 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001135
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 for (key_cert = key_cert_list; key_cert != NULL;
1137 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001138#if defined(MBEDTLS_USE_PSA_CRYPTO)
1139 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1140#endif /* MBEDTLS_USE_PSA_CRYPTO */
1141
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1143 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001144
1145 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 * This avoids sending the client a cert it'll reject based on
1147 * keyUsage or other extensions.
1148 */
1149 if (mbedtls_x509_crt_check_key_usage(
1150 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001151 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001152 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1154 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1155 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001156 continue;
1157 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001158
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 MBEDTLS_SSL_DEBUG_MSG(3,
1160 ("ssl_tls13_pick_key_cert:"
1161 "check signature algorithm %s [%04x]",
1162 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1163 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001164#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001166#endif /* MBEDTLS_USE_PSA_CRYPTO */
1167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1169 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001170#if defined(MBEDTLS_USE_PSA_CRYPTO)
1171 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1173 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001174#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001176 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 MBEDTLS_SSL_DEBUG_MSG(3,
1178 ("ssl_tls13_pick_key_cert:"
1179 "selected signature algorithm"
1180 " %s [%04x]",
1181 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1182 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001183 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 3, "selected certificate (chain)",
1185 ssl->handshake->key_cert->cert);
1186 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001187 }
XiaokangQian81802f42022-06-10 13:25:22 +00001188 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001189 }
1190
Gilles Peskine449bd832023-01-11 14:50:10 +01001191 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1192 "no suitable certificate found"));
1193 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001194}
XiaokangQian81802f42022-06-10 13:25:22 +00001195#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001196 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001197
XiaokangQian4080a7f2022-04-11 09:55:18 +00001198/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001199 *
1200 * STATE HANDLING: ClientHello
1201 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001202 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001203 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001204 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001205 *
1206 * In this case, the server progresses to sending its ServerHello.
1207 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001208 * 2) The ClientHello was well-formed but didn't match the server's
1209 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001210 *
1211 * For example, the client might not have offered a key share which
1212 * the server supports, or the server might require a cookie.
1213 *
1214 * In this case, the server sends a HelloRetryRequest.
1215 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001216 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001217 *
1218 * In this case, we abort the handshake.
1219 *
1220 */
1221
1222/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001223 * Structure of this message:
1224 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001225 * uint16 ProtocolVersion;
1226 * opaque Random[32];
1227 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001228 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001229 * struct {
1230 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1231 * Random random;
1232 * opaque legacy_session_id<0..32>;
1233 * CipherSuite cipher_suites<2..2^16-2>;
1234 * opaque legacy_compression_methods<1..2^8-1>;
1235 * Extension extensions<8..2^16-1>;
1236 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001237 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001238
1239#define SSL_CLIENT_HELLO_OK 0
1240#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001241#define SSL_CLIENT_HELLO_TLS1_2 2
XiaokangQianed582dd2022-04-13 08:21:05 +00001242
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001243MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001244static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1245 const unsigned char *buf,
1246 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001247{
XiaokangQianb67384d2022-04-19 00:02:38 +00001248 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1249 const unsigned char *p = buf;
Ronald Crond540d992023-03-07 09:41:48 +01001250 const unsigned char *random;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001251 size_t legacy_session_id_len;
Ronald Croncada4102023-03-07 09:51:39 +01001252 const unsigned char *legacy_session_id;
XiaokangQian318dc762022-04-20 09:43:51 +00001253 size_t cipher_suites_len;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001254 const unsigned char *cipher_suites;
XiaokangQian060d8672022-04-21 09:24:56 +00001255 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001256 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001257 const unsigned char *extensions_end;
Ronald Croneff56732023-04-03 17:36:31 +02001258 const unsigned char *supported_versions_data;
1259 const unsigned char *supported_versions_data_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001260 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001261 int hrr_required = 0;
Ronald Cron8a74f072023-06-14 17:59:29 +02001262 int no_usable_share_for_key_agreement = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001263
Ronald Cron41a443a2022-10-04 16:38:25 +02001264#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cron79cdd412024-02-20 17:19:28 +01001265 int got_psk = 0;
1266 struct psk_attributes psk = PSK_ATTRIBUTES_INIT;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001267 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001268 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001269#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001270
XiaokangQian7807f9f2022-02-15 10:04:37 +00001271 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001272 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001273 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001274 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001275 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001276 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001277 * .. . .. ciphersuite list length ( 2 bytes )
1278 * .. . .. ciphersuite list
1279 * .. . .. compression alg. list length ( 1 byte )
1280 * .. . .. compression alg. list
1281 * .. . .. extensions length ( 2 bytes, optional )
1282 * .. . .. extensions ( optional )
1283 */
1284
XiaokangQianb67384d2022-04-19 00:02:38 +00001285 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001286 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001287 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1288 * read at least up to session id length without worrying.
1289 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001291
1292 /* ...
1293 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1294 * ...
1295 * with ProtocolVersion defined as:
1296 * uint16 ProtocolVersion;
1297 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1299 MBEDTLS_SSL_VERSION_TLS1_2) {
1300 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1301 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1302 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1303 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001304 }
1305 p += 2;
1306
Jerry Yuc1be19f2022-04-23 16:11:39 +08001307 /* ...
1308 * Random random;
1309 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001310 * with Random defined as:
1311 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001312 */
Ronald Crond540d992023-03-07 09:41:48 +01001313 random = p;
XiaokangQian08037552022-04-20 07:16:41 +00001314 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001315
Jerry Yuc1be19f2022-04-23 16:11:39 +08001316 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001317 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001318 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001319 */
Ronald Croncada4102023-03-07 09:51:39 +01001320 legacy_session_id_len = *(p++);
1321 legacy_session_id = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001322
XiaokangQianb67384d2022-04-19 00:02:38 +00001323 /*
1324 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001325 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001326 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001328 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001329
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001330 /* ...
1331 * CipherSuite cipher_suites<2..2^16-2>;
1332 * ...
1333 * with CipherSuite defined as:
1334 * uint8 CipherSuite[2];
1335 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001337 p += 2;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001338 cipher_suites = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001339
Ronald Cronfc7ae872023-02-16 15:32:19 +01001340 /*
1341 * The length of the ciphersuite list has to be even.
1342 */
1343 if (cipher_suites_len & 1) {
1344 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1345 MBEDTLS_ERR_SSL_DECODE_ERROR);
1346 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1347 }
1348
XiaokangQianb67384d2022-04-19 00:02:38 +00001349 /* Check we have enough data for the ciphersuite list, the legacy
1350 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001351 *
1352 * cipher_suites cipher_suites_len bytes
1353 * legacy_compression_methods 2 bytes
1354 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
Ronald Cron8c527d02023-03-07 15:47:47 +01001357 p += cipher_suites_len;
1358 cipher_suites_end = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001359
1360 /*
Ronald Cron8c527d02023-03-07 15:47:47 +01001361 * Search for the supported versions extension and parse it to determine
1362 * if the client supports TLS 1.3.
1363 */
1364 ret = mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1365 ssl, p + 2, end,
Ronald Croneff56732023-04-03 17:36:31 +02001366 &supported_versions_data, &supported_versions_data_end);
Ronald Cron8c527d02023-03-07 15:47:47 +01001367 if (ret < 0) {
1368 MBEDTLS_SSL_DEBUG_RET(1,
1369 ("mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts"), ret);
1370 return ret;
1371 }
1372
1373 if (ret == 0) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001374 return SSL_CLIENT_HELLO_TLS1_2;
Ronald Cron8c527d02023-03-07 15:47:47 +01001375 }
1376
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001377 if (ret == 1) {
1378 ret = ssl_tls13_parse_supported_versions_ext(ssl,
Ronald Croneff56732023-04-03 17:36:31 +02001379 supported_versions_data,
1380 supported_versions_data_end);
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001381 if (ret < 0) {
1382 MBEDTLS_SSL_DEBUG_RET(1,
1383 ("ssl_tls13_parse_supported_versions_ext"), ret);
1384 return ret;
1385 }
1386
Ronald Cronb828c7d2023-04-03 16:37:22 +02001387 /*
1388 * The supported versions extension was parsed successfully as the
1389 * value returned by ssl_tls13_parse_supported_versions_ext() is
1390 * positive. The return value is then equal to
1391 * MBEDTLS_SSL_VERSION_TLS1_2 or MBEDTLS_SSL_VERSION_TLS1_3, defining
1392 * the TLS version to negotiate.
1393 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001394 if (MBEDTLS_SSL_VERSION_TLS1_2 == ret) {
1395 return SSL_CLIENT_HELLO_TLS1_2;
1396 }
Ronald Cron8c527d02023-03-07 15:47:47 +01001397 }
1398
1399 /*
1400 * We negotiate TLS 1.3.
Ronald Cron64582392023-03-07 09:21:40 +01001401 */
1402 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Ronald Cron64582392023-03-07 09:21:40 +01001403 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1404 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Ronald Cron64582392023-03-07 09:21:40 +01001405
1406 /*
Ronald Crondad02b22023-04-06 09:57:52 +02001407 * We are negotiating the version 1.3 of the protocol. Do what we have
Ronald Croncada4102023-03-07 09:51:39 +01001408 * postponed: copy of the client random bytes, copy of the legacy session
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001409 * identifier and selection of the TLS 1.3 cipher suite.
Ronald Crond540d992023-03-07 09:41:48 +01001410 */
1411 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1412 random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1413 memcpy(&handshake->randbytes[0], random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1414
Ronald Croncada4102023-03-07 09:51:39 +01001415 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1416 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1417 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1418 }
1419 ssl->session_negotiate->id_len = legacy_session_id_len;
1420 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1421 legacy_session_id, legacy_session_id_len);
1422 memcpy(&ssl->session_negotiate->id[0],
1423 legacy_session_id, legacy_session_id_len);
1424
Ronald Crond540d992023-03-07 09:41:48 +01001425 /*
Jerry Yu5725f1c2022-08-21 17:27:16 +08001426 * Search for a matching ciphersuite
1427 */
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001428 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, list of cipher suites",
1429 cipher_suites, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001430
Ronald Cron89089cc2024-02-14 18:18:08 +01001431 ssl_tls13_select_ciphersuite(ssl, cipher_suites, cipher_suites_end,
1432 0, PSA_ALG_NONE, &handshake->ciphersuite_info);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001433
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 if (handshake->ciphersuite_info == NULL) {
1435 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1436 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1437 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001438 }
Ronald Cron89089cc2024-02-14 18:18:08 +01001439 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
1440
1441 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1442 ((unsigned) handshake->ciphersuite_info->id),
1443 handshake->ciphersuite_info->name));
Jerry Yuc1be19f2022-04-23 16:11:39 +08001444
XiaokangQian4080a7f2022-04-11 09:55:18 +00001445 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001446 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001447 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001448 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1450 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1451 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1452 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1453 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001454 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001455 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001456
Jerry Yuc1be19f2022-04-23 16:11:39 +08001457 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001458 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001459 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001460 * with Extension defined as:
1461 * struct {
1462 * ExtensionType extension_type;
1463 * opaque extension_data<0..2^16-1>;
1464 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001467 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001469 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001470
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
Jerry Yu63a459c2022-10-31 13:38:40 +08001472 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001473
Gilles Peskine449bd832023-01-11 14:50:10 +01001474 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001475 unsigned int extension_type;
1476 size_t extension_data_len;
1477 const unsigned char *extension_data_end;
Jerry Yu263dbf72022-10-26 10:51:27 +08001478 uint32_t allowed_exts = MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH;
1479
Ronald Cron5fbd2702024-02-14 10:03:36 +01001480 if (ssl->handshake->hello_retry_request_flag) {
Jerry Yu263dbf72022-10-26 10:51:27 +08001481 /* Do not accept early data extension in 2nd ClientHello */
1482 allowed_exts &= ~MBEDTLS_SSL_EXT_MASK(EARLY_DATA);
1483 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001484
Jerry Yu0c354a22022-08-29 15:25:36 +08001485 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001486 *
1487 * The "pre_shared_key" extension MUST be the last extension in the
1488 * ClientHello (this facilitates implementation as described below).
1489 * Servers MUST check that it is the last extension and otherwise fail
1490 * the handshake with an "illegal_parameter" alert.
1491 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001493 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001495 MBEDTLS_SSL_PEND_FATAL_ALERT(
1496 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001497 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1498 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001499 }
1500
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1502 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1503 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001504 p += 4;
1505
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001507 extension_data_end = p + extension_data_len;
1508
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001509 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
Jerry Yu263dbf72022-10-26 10:51:27 +08001511 allowed_exts);
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 if (ret != 0) {
1513 return ret;
1514 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001515
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001517#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1518 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1520 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1521 extension_data_end);
1522 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001523 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 1, "mbedtls_ssl_parse_servername_ext", ret);
1525 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001526 }
XiaokangQian40a35232022-05-07 09:02:40 +00001527 break;
1528#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1529
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001530#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001531 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001533
1534 /* Supported Groups Extension
1535 *
1536 * When sent by the client, the "supported_groups" extension
1537 * indicates the named groups which the client supports,
1538 * ordered from most preferred to least preferred.
1539 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001540 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 ssl, p, extension_data_end);
1542 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001543 MBEDTLS_SSL_DEBUG_RET(
Xiaokang Qian8bce0e62023-04-04 10:15:48 +00001544 1, "ssl_tls13_parse_supported_groups_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001546 }
1547
XiaokangQian7807f9f2022-02-15 10:04:37 +00001548 break;
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001549#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH*/
XiaokangQian7807f9f2022-02-15 10:04:37 +00001550
Valerio Settic9ae8622023-07-25 11:23:50 +02001551#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001552 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001554
1555 /*
1556 * Key Share Extension
1557 *
1558 * When sent by the client, the "key_share" extension
1559 * contains the endpoint's cryptographic parameters for
1560 * ECDHE/DHE key establishment methods.
1561 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001562 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 ssl, p, extension_data_end);
1564 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
Ronald Cron8a74f072023-06-14 17:59:29 +02001565 MBEDTLS_SSL_DEBUG_MSG(2, ("No usable share for key agreement."));
1566 no_usable_share_for_key_agreement = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001567 }
1568
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001570 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 1, "ssl_tls13_parse_key_shares_ext", ret);
1572 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001573 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001574
XiaokangQian7807f9f2022-02-15 10:04:37 +00001575 break;
Valerio Settic9ae8622023-07-25 11:23:50 +02001576#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001577
1578 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Ronald Cron8c527d02023-03-07 15:47:47 +01001579 /* Already parsed */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001580 break;
1581
Ronald Cron41a443a2022-10-04 16:38:25 +02001582#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001583 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001584 MBEDTLS_SSL_DEBUG_MSG(
1585 3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001586
1587 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 ssl, p, extension_data_end);
1589 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001590 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1592 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001593 }
1594
Jerry Yue19e3b92022-07-08 12:04:51 +00001595 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001596#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001597
Jerry Yu1c105562022-07-10 06:32:38 +00001598 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1600 if ((handshake->received_extensions &
1601 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001602 MBEDTLS_SSL_PEND_FATAL_ALERT(
1603 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1605 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001606 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001607#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001608 /* Delay processing of the PSK identity once we have
1609 * found out which algorithms to use. We keep a pointer
1610 * to the buffer and the size for later processing.
1611 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001612 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001613 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001614#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001615 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001616
XiaokangQianacb39922022-06-17 10:18:48 +00001617#if defined(MBEDTLS_SSL_ALPN)
1618 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001620
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1622 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001623 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1625 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001626 }
XiaokangQianacb39922022-06-17 10:18:48 +00001627 break;
1628#endif /* MBEDTLS_SSL_ALPN */
1629
Ronald Cron928cbd32022-10-04 16:14:26 +02001630#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001631 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001633
Gabor Mezei078e8032022-04-27 21:17:56 +02001634 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 ssl, p, extension_data_end);
1636 if (ret != 0) {
Xiaokang Qian49f39c12023-04-06 02:31:02 +00001637 MBEDTLS_SSL_DEBUG_RET(
1638 1, "mbedtls_ssl_parse_sig_alg_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001639 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001640 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001641 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001642#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001643
Jan Bruckner151f6422023-02-10 12:45:19 +01001644#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1645 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
1646 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
1647
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001648 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
1649 ssl, p, extension_data_end);
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001650 if (ret != 0) {
1651 MBEDTLS_SSL_DEBUG_RET(
1652 1, ("mbedtls_ssl_tls13_parse_record_size_limit_ext"), ret);
1653 return ret;
1654 }
Jan Bruckner151f6422023-02-10 12:45:19 +01001655 break;
1656#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1657
XiaokangQian7807f9f2022-02-15 10:04:37 +00001658 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001659 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001660 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001662 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001663 }
1664
1665 p += extension_data_len;
1666 }
1667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1669 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001670
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001671 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1672 MBEDTLS_SSL_HS_CLIENT_HELLO,
1673 p - buf);
1674 if (0 != ret) {
1675 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1676 return ret;
1677 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001678
Ronald Cron41a443a2022-10-04 16:38:25 +02001679#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001680 /* Update checksum with either
1681 * - The entire content of the CH message, if no PSK extension is present
1682 * - The content up to but excluding the PSK extension, if present.
Ronald Cron7cab4f82024-03-07 15:09:09 +01001683 * Always parse the pre-shared-key extension when present in the
Ronald Cron12e72f12024-02-14 15:49:38 +01001684 * ClientHello even if some pre-requisites for PSK key exchange modes are
1685 * not met. That way we always validate the syntax of the extension.
XiaokangQian7807f9f2022-02-15 10:04:37 +00001686 */
Ronald Cron12e72f12024-02-14 15:49:38 +01001687 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001688 ret = handshake->update_checksum(ssl, buf,
1689 pre_shared_key_ext - buf);
1690 if (0 != ret) {
1691 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1692 return ret;
1693 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1695 pre_shared_key_ext,
1696 pre_shared_key_ext_end,
1697 cipher_suites,
Ronald Cron79cdd412024-02-20 17:19:28 +01001698 cipher_suites_end,
1699 &psk);
1700 if (ret == 0) {
1701 got_psk = 1;
1702 } else if (ret != MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001703 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1705 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001706 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001708#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001709 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001710 ret = handshake->update_checksum(ssl, buf, p - buf);
1711 if (0 != ret) {
1712 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1713 return ret;
1714 }
Jerry Yu1c105562022-07-10 06:32:38 +00001715 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001716
Ronald Cron79cdd412024-02-20 17:19:28 +01001717 /*
1718 * Determine the key exchange algorithm to use.
1719 * There are three types of key exchanges supported in TLS 1.3:
1720 * - (EC)DH with ECDSA,
1721 * - (EC)DH with PSK,
1722 * - plain PSK.
1723 *
1724 * The PSK-based key exchanges may additionally be used with 0-RTT.
1725 *
1726 * Our built-in order of preference is
1727 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1728 * 2 ) Certificate Mode ( ephemeral )
1729 * 3 ) Plain PSK Mode ( psk )
1730 */
1731#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
1732 if (got_psk && (psk.key_exchange_mode ==
1733 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL)) {
1734 handshake->key_exchange_mode =
1735 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
1736 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1737
1738 } else
1739#endif
1740 if (ssl_tls13_key_exchange_is_ephemeral_available(ssl)) {
1741 handshake->key_exchange_mode =
1742 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
1743 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1744
1745 }
1746#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
1747 else if (got_psk && (psk.key_exchange_mode ==
1748 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK)) {
1749 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
1750 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1751 }
1752#endif
1753 else {
1754 MBEDTLS_SSL_DEBUG_MSG(
1755 1,
1756 ("ClientHello message misses mandatory extensions."));
1757 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1758 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1759 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001761
Ronald Cron3e47eec2024-02-21 10:29:24 +01001762#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cron74a16292024-02-23 17:07:41 +01001763 if (handshake->key_exchange_mode &
1764 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL) {
1765 handshake->ciphersuite_info = psk.ciphersuite_info;
1766 ssl->session_negotiate->ciphersuite = psk.ciphersuite_info->id;
1767
1768 MBEDTLS_SSL_DEBUG_MSG(2, ("Select PSK ciphersuite: %04x - %s",
1769 ((unsigned) psk.ciphersuite_info->id),
1770 psk.ciphersuite_info->name));
1771
1772 if (psk.type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
1773 handshake->resume = 1;
1774 }
Ronald Cron79cdd412024-02-20 17:19:28 +01001775 }
Ronald Cron3e47eec2024-02-21 10:29:24 +01001776#endif
Ronald Cron79cdd412024-02-20 17:19:28 +01001777
1778 if (handshake->key_exchange_mode !=
Ronald Cron8a74f072023-06-14 17:59:29 +02001779 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) {
1780 hrr_required = (no_usable_share_for_key_agreement != 0);
1781 }
1782
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001784
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001786}
1787
Jerry Yuab0da372023-02-08 13:55:24 +08001788#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001789static int ssl_tls13_check_early_data_requirements(mbedtls_ssl_context *ssl)
Jerry Yuab0da372023-02-08 13:55:24 +08001790{
1791 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1792
Jerry Yu985c9672022-12-04 14:06:30 +08001793 if (ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_DISABLED) {
1794 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu985c9672022-12-04 14:06:30 +08001795 1,
Jerry Yu454dda32023-10-31 15:13:54 +08001796 ("EarlyData: rejected, feature disabled in server configuration."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001797 return -1;
Ronald Cron7b6ee942024-01-12 10:29:55 +01001798 }
1799
Jerry Yu454dda32023-10-31 15:13:54 +08001800 if (!handshake->resume) {
1801 /* We currently support early data only in the case of PSKs established
1802 via a NewSessionTicket message thus in the case of a session
1803 resumption. */
Jerry Yu985c9672022-12-04 14:06:30 +08001804 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001805 1, ("EarlyData: rejected, not a session resumption."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001806 return -1;
Jerry Yu985c9672022-12-04 14:06:30 +08001807 }
1808
Jerry Yu82fd6c12023-10-31 16:32:19 +08001809 /* RFC 8446 4.2.10
1810 *
1811 * In order to accept early data, the server MUST have accepted a PSK cipher
1812 * suite and selected the first key offered in the client's "pre_shared_key"
1813 * extension. In addition, it MUST verify that the following values are the
1814 * same as those associated with the selected PSK:
1815 * - The TLS version number
1816 * - The selected cipher suite
1817 * - The selected ALPN [RFC7301] protocol, if any
1818 *
1819 * NOTE:
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001820 * - The TLS version number is checked in
1821 * ssl_tls13_offered_psks_check_identity_match_ticket().
1822 * - ALPN is not checked for the time being (TODO).
Jerry Yu82fd6c12023-10-31 16:32:19 +08001823 */
1824
1825 if (handshake->selected_identity != 0) {
1826 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001827 1, ("EarlyData: rejected, the selected key in "
1828 "`pre_shared_key` is not the first one."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001829 return -1;
Jerry Yu82fd6c12023-10-31 16:32:19 +08001830 }
1831
1832 if (handshake->ciphersuite_info->id !=
1833 ssl->session_negotiate->ciphersuite) {
1834 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001835 1, ("EarlyData: rejected, the selected ciphersuite is not the one "
1836 "of the selected pre-shared key."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001837 return -1;
Jerry Yu82fd6c12023-10-31 16:32:19 +08001838
1839 }
Jerry Yu985c9672022-12-04 14:06:30 +08001840
Pengyu Lv94a42cc2023-12-06 10:04:17 +08001841 if (!mbedtls_ssl_tls13_session_ticket_allow_early_data(ssl->session_negotiate)) {
Jerry Yufceddb32022-12-12 15:30:34 +08001842 MBEDTLS_SSL_DEBUG_MSG(
1843 1,
Jerry Yuea96ac32023-11-21 17:06:36 +08001844 ("EarlyData: rejected, early_data not allowed in ticket "
1845 "permission bits."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001846 return -1;
Jerry Yufceddb32022-12-12 15:30:34 +08001847 }
Jerry Yu985c9672022-12-04 14:06:30 +08001848
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001849 return 0;
Jerry Yuab0da372023-02-08 13:55:24 +08001850}
1851#endif /* MBEDTLS_SSL_EARLY_DATA */
1852
XiaokangQian75fe8c72022-06-15 09:42:45 +00001853/* Update the handshake state machine */
1854
Ronald Cronce7d76e2022-07-08 18:56:49 +02001855MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b6ee942024-01-12 10:29:55 +01001856static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl,
1857 int hrr_required)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001858{
1859 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1860
XiaokangQian7807f9f2022-02-15 10:04:37 +00001861 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001862 * Server certificate selection
1863 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1865 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1866 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001867 }
1868#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1869 ssl->handshake->sni_name = NULL;
1870 ssl->handshake->sni_name_len = 0;
1871#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1874 if (ret != 0) {
1875 MBEDTLS_SSL_DEBUG_RET(1,
1876 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1877 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001878 }
1879
Jerry Yuab0da372023-02-08 13:55:24 +08001880#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001881 if (ssl->handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Ronald Cron31e2d832024-02-05 16:45:57 +01001882 ssl->handshake->early_data_accepted =
1883 (!hrr_required) && (ssl_tls13_check_early_data_requirements(ssl) == 0);
Jerry Yu4e9b70e2022-12-04 14:08:02 +08001884
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001885 if (ssl->handshake->early_data_accepted) {
1886 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1887 if (ret != 0) {
1888 MBEDTLS_SSL_DEBUG_RET(
1889 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
1890 return ret;
1891 }
1892 } else {
1893 ssl->discard_early_data_record =
1894 hrr_required ?
1895 MBEDTLS_SSL_EARLY_DATA_DISCARD :
1896 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD;
Jerry Yu4e9b70e2022-12-04 14:08:02 +08001897 }
1898 }
Ronald Cron7b6ee942024-01-12 10:29:55 +01001899#else
1900 ((void) hrr_required);
Jerry Yuab0da372023-02-08 13:55:24 +08001901#endif /* MBEDTLS_SSL_EARLY_DATA */
1902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001904}
1905
1906/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001907 * Main entry point from the state machine; orchestrates the otherfunctions.
1908 */
1909
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001910MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001911static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001912{
1913
XiaokangQian08037552022-04-20 07:16:41 +00001914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001916 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001917 int parse_client_hello_ret;
1918
Gilles Peskine449bd832023-01-11 14:50:10 +01001919 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001920
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1922 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1923 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001924
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1926 buf + buflen));
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001927 parse_client_hello_ret = ret; /* Store positive return value of
1928 * parse_client_hello,
1929 * as negative error codes are handled
Jerry Yuf41553b2022-05-09 22:20:30 +08001930 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001931
Ronald Cronb828c7d2023-04-03 16:37:22 +02001932 /*
Yanray Wang90acdc62023-12-08 10:29:42 +08001933 * Version 1.2 of the protocol has to be used for the handshake.
1934 * If TLS 1.2 is not supported, abort the handshake. Otherwise, set the
Ronald Cronb828c7d2023-04-03 16:37:22 +02001935 * ssl->keep_current_message flag for the ClientHello to be kept and parsed
1936 * as a TLS 1.2 ClientHello. We also change ssl->tls_version to
1937 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1938 * will dispatch to the TLS 1.2 state machine.
1939 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001940 if (SSL_CLIENT_HELLO_TLS1_2 == parse_client_hello_ret) {
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001941 /* Check if server supports TLS 1.2 */
Yanray Wang408ba6f2023-12-08 10:18:03 +08001942 if (!mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001943 MBEDTLS_SSL_DEBUG_MSG(
Yanray Wang177e49a2023-12-08 10:51:04 +08001944 1, ("TLS 1.2 not supported."));
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001945 MBEDTLS_SSL_PEND_FATAL_ALERT(
Yanray Wang2bef9172023-12-08 10:21:53 +08001946 MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1947 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1948 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001949 }
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001950 ssl->keep_current_message = 1;
1951 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
1952 return 0;
1953 }
1954
Ronald Cron7b6ee942024-01-12 10:29:55 +01001955 MBEDTLS_SSL_PROC_CHK(
1956 ssl_tls13_postprocess_client_hello(ssl, parse_client_hello_ret ==
1957 SSL_CLIENT_HELLO_HRR_REQUIRED));
Jerry Yu582dd062022-04-22 21:59:01 +08001958
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001959 if (SSL_CLIENT_HELLO_OK == parse_client_hello_ret) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1961 } else {
1962 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1963 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001964
1965cleanup:
1966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1968 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001969}
1970
1971/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001972 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001973 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001974MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001975static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001976{
Jerry Yu637a3f12022-04-20 21:37:58 +08001977 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1978 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001980
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1982 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1983 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1984 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001985 }
1986
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1988 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001989
1990#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001991 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001992#endif /* MBEDTLS_HAVE_TIME */
1993
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001995}
1996
Jerry Yu3bf2c642022-03-30 22:02:12 +08001997/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001998 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001999 *
2000 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08002001 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002002 * } SupportedVersions;
2003 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002004MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08002005static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 mbedtls_ssl_context *ssl,
2007 unsigned char *buf,
2008 unsigned char *end,
2009 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002010{
Jerry Yu3bf2c642022-03-30 22:02:12 +08002011 *out_len = 0;
2012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002014
2015 /* Check if we have space to write the extension:
2016 * - extension_type (2 bytes)
2017 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08002018 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002019 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002021
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002023
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 mbedtls_ssl_write_version(buf + 4,
2027 ssl->conf->transport,
2028 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
2031 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002032
Jerry Yu349a6132022-04-14 20:52:56 +08002033 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002034
Jerry Yub95dd362022-11-08 21:19:34 +08002035 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08002037
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002039}
2040
Jerry Yud9436a12022-04-20 22:28:09 +08002041
Jerry Yu3bf2c642022-03-30 22:02:12 +08002042
2043/* Generate and export a single key share. For hybrid KEMs, this can
2044 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002045MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002046static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
2047 uint16_t named_group,
2048 unsigned char *buf,
2049 unsigned char *end,
2050 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002051{
2052 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08002053
2054 *out_len = 0;
2055
Valerio Settic9ae8622023-07-25 11:23:50 +02002056#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02002057 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +02002058 mbedtls_ssl_tls13_named_group_is_ffdh(named_group)) {
Przemek Stekiel408569f2023-07-06 11:26:44 +02002059 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 ssl, named_group, buf, end, out_len);
2061 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08002062 MBEDTLS_SSL_DEBUG_RET(
Przemek Stekiel408569f2023-07-06 11:26:44 +02002063 1, "mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 ret);
2065 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002066 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 } else
Valerio Settic9ae8622023-07-25 11:23:50 +02002068#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (0 /* Other kinds of KEMs */) {
2070 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08002071 ((void) ssl);
2072 ((void) named_group);
2073 ((void) buf);
2074 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002075 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2076 }
2077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002079}
2080
2081/*
2082 * ssl_tls13_write_key_share_ext
2083 *
2084 * Structure of key_share extension in ServerHello:
2085 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08002086 * struct {
2087 * NamedGroup group;
2088 * opaque key_exchange<1..2^16-1>;
2089 * } KeyShareEntry;
2090 * struct {
2091 * KeyShareEntry server_share;
2092 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002093 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002094MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002095static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
2096 unsigned char *buf,
2097 unsigned char *end,
2098 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002099{
Jerry Yu955ddd72022-04-22 22:27:33 +08002100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002101 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08002102 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002103 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002104 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002105
2106 *out_len = 0;
2107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
2111 mbedtls_ssl_named_group_to_str(group),
2112 group));
Jerry Yu58af2332022-09-06 11:19:31 +08002113
Jerry Yu3bf2c642022-03-30 22:02:12 +08002114 /* Check if we have space for header and length fields:
2115 * - extension_type (2 bytes)
2116 * - extension_data_length (2 bytes)
2117 * - group (2 bytes)
2118 * - key_exchange_length (2 bytes)
2119 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
2121 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
2122 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002123 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08002124
Jerry Yu3bf2c642022-03-30 22:02:12 +08002125 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
2126 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08002127 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 ssl, group, server_share + 4, end, &key_exchange_length);
2129 if (ret != 0) {
2130 return ret;
2131 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002132 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08002133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002135
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002137
Jerry Yu57d48412022-04-20 21:50:42 +08002138 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002141
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002143}
Jerry Yud9436a12022-04-20 22:28:09 +08002144
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002145MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002146static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
2147 unsigned char *buf,
2148 unsigned char *end,
2149 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002150{
2151 uint16_t selected_group = ssl->handshake->hrr_selected_group;
2152 /* key_share Extension
2153 *
2154 * struct {
2155 * select (Handshake.msg_type) {
2156 * ...
2157 * case hello_retry_request:
2158 * NamedGroup selected_group;
2159 * ...
2160 * };
2161 * } KeyShare;
2162 */
2163
2164 *out_len = 0;
2165
Jerry Yub0ac10b2022-05-05 11:10:08 +08002166 /*
2167 * For a pure PSK key exchange, there is no group to agree upon. The purpose
2168 * of the HRR is then to transmit a cookie to force the client to demonstrate
2169 * reachability at their apparent network address (primarily useful for DTLS).
2170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002171 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2172 return 0;
2173 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002174
2175 /* We should only send the key_share extension if the client's initial
2176 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if (ssl->handshake->offered_group_id != 0) {
2178 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
2179 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002180 }
2181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 if (selected_group == 0) {
2183 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
2184 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002185 }
2186
Jerry Yub0ac10b2022-05-05 11:10:08 +08002187 /* Check if we have enough space:
2188 * - extension_type (2 bytes)
2189 * - extension_data_length (2 bytes)
2190 * - selected_group (2 bytes)
2191 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002193
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
2195 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
2196 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 MBEDTLS_SSL_DEBUG_MSG(3,
2199 ("HRR selected_group: %s (%x)",
2200 mbedtls_ssl_named_group_to_str(selected_group),
2201 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002202
2203 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002206
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002208}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002209
2210/*
2211 * Structure of ServerHello message:
2212 *
2213 * struct {
2214 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2215 * Random random;
2216 * opaque legacy_session_id_echo<0..32>;
2217 * CipherSuite cipher_suite;
2218 * uint8 legacy_compression_method = 0;
2219 * Extension extensions<6..2^16-1>;
2220 * } ServerHello;
2221 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002222MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002223static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2224 unsigned char *buf,
2225 unsigned char *end,
2226 size_t *out_len,
2227 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002228{
Jerry Yu955ddd72022-04-22 22:27:33 +08002229 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002230 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002231 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002232 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002233
2234 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002235 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002236
Jerry Yucfc04b32022-04-21 09:31:58 +08002237 /* ...
2238 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2239 * ...
2240 * with ProtocolVersion defined as:
2241 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002242 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2244 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002245 p += 2;
2246
Jerry Yu1c3e6882022-04-20 21:23:40 +08002247 /* ...
2248 * Random random;
2249 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002250 * with Random defined as:
2251 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002252 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2254 if (is_hrr) {
2255 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2256 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2257 } else {
2258 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2259 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002260 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2262 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002263 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2264
Jerry Yucfc04b32022-04-21 09:31:58 +08002265 /* ...
2266 * opaque legacy_session_id_echo<0..32>;
2267 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002268 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2270 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2271 if (ssl->session_negotiate->id_len > 0) {
2272 memcpy(p, &ssl->session_negotiate->id[0],
2273 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002274 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002275
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2277 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002278 }
2279
Jerry Yucfc04b32022-04-21 09:31:58 +08002280 /* ...
2281 * CipherSuite cipher_suite;
2282 * ...
2283 * with CipherSuite defined as:
2284 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2287 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002288 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 MBEDTLS_SSL_DEBUG_MSG(3,
2290 ("server hello, chosen ciphersuite: %s ( id=%d )",
2291 mbedtls_ssl_get_ciphersuite_name(
2292 ssl->session_negotiate->ciphersuite),
2293 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002294
Jerry Yucfc04b32022-04-21 09:31:58 +08002295 /* ...
2296 * uint8 legacy_compression_method = 0;
2297 * ...
2298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002300 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002301
Jerry Yucfc04b32022-04-21 09:31:58 +08002302 /* ...
2303 * Extension extensions<6..2^16-1>;
2304 * ...
2305 * struct {
2306 * ExtensionType extension_type; (2 bytes)
2307 * opaque extension_data<0..2^16-1>;
2308 * } Extension;
2309 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002311 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002312 p += 2;
2313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2315 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002316 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2318 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002319 }
2320 p += output_len;
2321
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2323 if (is_hrr) {
2324 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2325 } else {
2326 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2327 }
2328 if (ret != 0) {
2329 return ret;
2330 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002331 p += output_len;
2332 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002333
Ronald Cron41a443a2022-10-04 16:38:25 +02002334#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2336 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2337 if (ret != 0) {
2338 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2339 ret);
2340 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002341 }
2342 p += output_len;
2343 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002344#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002347
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2349 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002350
Jerry Yud9436a12022-04-20 22:28:09 +08002351 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002354
Jerry Yu7de2ff02022-11-08 21:43:46 +08002355 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002356 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 MBEDTLS_SSL_HS_SERVER_HELLO,
2358 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002359
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002361}
2362
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002363MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002364static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002365{
2366 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2368 if (ret != 0) {
2369 MBEDTLS_SSL_DEBUG_RET(1,
2370 "mbedtls_ssl_tls13_compute_handshake_transform",
2371 ret);
2372 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002373 }
2374
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002376}
2377
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002378MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002379static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002380{
Jerry Yu637a3f12022-04-20 21:37:58 +08002381 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002382 unsigned char *buf;
2383 size_t buf_len, msg_len;
2384
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002388
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002389 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2390 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2393 buf + buf_len,
2394 &msg_len,
2395 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002396
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002397 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002398 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002399
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2401 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002402
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002403 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002404
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002405#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2406 /* The server sends a dummy change_cipher_spec record immediately
2407 * after its first handshake message. This may either be after
2408 * a ServerHello or a HelloRetryRequest.
2409 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002410 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002412#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002414#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002415
Jerry Yuf4b27e42022-03-30 17:32:21 +08002416cleanup:
2417
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2419 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002420}
2421
Jerry Yu23d1a252022-05-12 18:08:59 +08002422
2423/*
2424 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2425 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002426MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002427static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002428{
2429 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5fbd2702024-02-14 10:03:36 +01002430 if (ssl->handshake->hello_retry_request_flag) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2432 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2433 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2434 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002435 }
2436
2437 /*
2438 * Create stateless transcript hash for HRR
2439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2441 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2442 if (ret != 0) {
2443 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2444 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002445 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002447
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002449}
2450
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002451MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002452static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002453{
2454 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2455 unsigned char *buf;
2456 size_t buf_len, msg_len;
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002459
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002461
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2463 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2464 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002465
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2467 buf + buf_len,
2468 &msg_len,
2469 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002470 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002471 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002472
2473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2475 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002476
Ronald Cron5fbd2702024-02-14 10:03:36 +01002477 ssl->handshake->hello_retry_request_flag = 1;
Jerry Yu23d1a252022-05-12 18:08:59 +08002478
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002479#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2480 /* The server sends a dummy change_cipher_spec record immediately
2481 * after its first handshake message. This may either be after
2482 * a ServerHello or a HelloRetryRequest.
2483 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002484 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002486#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002488#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002489
2490cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2492 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002493}
2494
Jerry Yu5b64ae92022-03-30 17:15:02 +08002495/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002496 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2497 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002498
2499/*
2500 * struct {
2501 * Extension extensions<0..2 ^ 16 - 1>;
2502 * } EncryptedExtensions;
2503 *
2504 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002505MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002506static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2507 unsigned char *buf,
2508 unsigned char *end,
2509 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002510{
XiaokangQianacb39922022-06-17 10:18:48 +00002511 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002512 unsigned char *p = buf;
2513 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002514 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002515 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002516
Jerry Yu4d3841a2022-04-16 12:37:19 +08002517 *out_len = 0;
2518
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002520 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002521 p += 2;
2522
Jerry Yu8937eb42022-05-03 12:12:14 +08002523 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002524 ((void) ret);
2525 ((void) output_len);
2526
2527#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2529 if (ret != 0) {
2530 return ret;
2531 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002532 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002533#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002534
Jerry Yu71c14f12022-12-12 11:10:35 +08002535#if defined(MBEDTLS_SSL_EARLY_DATA)
Ronald Cron78a38f62024-02-01 18:30:31 +01002536 if (ssl->handshake->early_data_accepted) {
Jerry Yu52335392023-11-23 18:06:06 +08002537 ret = mbedtls_ssl_tls13_write_early_data_ext(
Jerry Yuc59c5862023-12-05 10:40:49 +08002538 ssl, 0, p, end, &output_len);
Jerry Yu71c14f12022-12-12 11:10:35 +08002539 if (ret != 0) {
2540 return ret;
2541 }
2542 p += output_len;
2543 }
2544#endif /* MBEDTLS_SSL_EARLY_DATA */
2545
Waleed Elmelegy47d29462024-01-03 17:31:52 +00002546#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Waleed Elmelegyfbe42742024-01-05 18:11:10 +00002547 if (ssl->handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(RECORD_SIZE_LIMIT)) {
Waleed Elmelegyd2fc90e2024-01-04 18:04:53 +00002548 ret = mbedtls_ssl_tls13_write_record_size_limit_ext(
2549 ssl, p, end, &output_len);
2550 if (ret != 0) {
2551 return ret;
2552 }
2553 p += output_len;
Waleed Elmelegy47d29462024-01-03 17:31:52 +00002554 }
Waleed Elmelegy47d29462024-01-03 17:31:52 +00002555#endif
2556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 extensions_len = (p - p_extensions_len) - 2;
2558 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002559
2560 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002561
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002563
Jerry Yu7de2ff02022-11-08 21:43:46 +08002564 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002568}
2569
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002570MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002571static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002572{
2573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2574 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002575 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 mbedtls_ssl_set_outbound_transform(ssl,
2578 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002579 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002581
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002583
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002584 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2585 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2586 &buf, &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2589 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002590
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002591 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002592 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2593 buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002594
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2596 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002597
Ronald Cron928cbd32022-10-04 16:14:26 +02002598#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2600 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2601 } else {
2602 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2603 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002604#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002606#endif
2607
Jerry Yu4d3841a2022-04-16 12:37:19 +08002608cleanup:
2609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2611 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002612}
2613
Ronald Cron928cbd32022-10-04 16:14:26 +02002614#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002615#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2616#define SSL_CERTIFICATE_REQUEST_SKIP 1
2617/* Coordination:
2618 * Check whether a CertificateRequest message should be written.
2619 * Returns a negative code on failure, or
2620 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2621 * - SSL_CERTIFICATE_REQUEST_SKIP
2622 * indicating if the writing of the CertificateRequest
2623 * should be skipped or not.
2624 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002625MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002626static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002627{
2628 int authmode;
2629
XiaokangQian40a35232022-05-07 09:02:40 +00002630#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002632 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002634#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002635 authmode = ssl->conf->authmode;
2636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002638 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002640 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002641
XiaokangQianc3017f62022-05-13 05:55:41 +00002642 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002643
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002645}
2646
XiaokangQiancec9ae62022-05-06 07:28:50 +00002647/*
2648 * struct {
2649 * opaque certificate_request_context<0..2^8-1>;
2650 * Extension extensions<2..2^16-1>;
2651 * } CertificateRequest;
2652 *
2653 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002654MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002655static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2656 unsigned char *buf,
2657 const unsigned char *end,
2658 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002659{
2660 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2661 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002662 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002663 unsigned char *p_extensions_len;
2664
2665 *out_len = 0;
2666
2667 /* Check if we have enough space:
2668 * - certificate_request_context (1 byte)
2669 * - extensions length (2 bytes)
2670 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002672
2673 /*
2674 * Write certificate_request_context
2675 */
2676 /*
2677 * We use a zero length context for the normal handshake
2678 * messages. For post-authentication handshake messages
2679 * this request context would be set to a non-zero value.
2680 */
2681 *p++ = 0x0;
2682
2683 /*
2684 * Write extensions
2685 */
2686 /* The extensions must contain the signature_algorithms. */
2687 p_extensions_len = p;
2688 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2690 if (ret != 0) {
2691 return ret;
2692 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002693
XiaokangQianec6efb92022-05-06 09:53:10 +00002694 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002696
2697 *out_len = p - buf;
2698
Jerry Yu7de2ff02022-11-08 21:43:46 +08002699 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002703}
2704
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002705MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002706static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002707{
2708 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2709
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002713
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002715 unsigned char *buf;
2716 size_t buf_len, msg_len;
2717
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002718 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2719 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2720 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2723 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002724
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002725 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002726 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2727 buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002728
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2730 ssl, buf_len, msg_len));
2731 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2732 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002733 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 } else {
2735 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002736 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2737 goto cleanup;
2738 }
2739
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002741cleanup:
2742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2744 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002745}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002746
Jerry Yu4d3841a2022-04-16 12:37:19 +08002747/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002748 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002749 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002750MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002751static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002752{
Jerry Yu5a26f302022-05-10 20:46:40 +08002753 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002754
2755#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2757 mbedtls_ssl_own_cert(ssl) == NULL) {
2758 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2759 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2760 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2761 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002762 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002763#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002764
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2766 if (ret != 0) {
2767 return ret;
2768 }
2769 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2770 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002771}
2772
2773/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002774 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002775 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002776MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002777static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002778{
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2780 if (ret != 0) {
2781 return ret;
2782 }
2783 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2784 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002785}
Ronald Cron928cbd32022-10-04 16:14:26 +02002786#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002787
Jerry Yu9b72e392023-12-01 16:27:08 +08002788/*
2789 * RFC 8446 section A.2
2790 *
2791 * | Send ServerHello
2792 * | K_send = handshake
2793 * | Send EncryptedExtensions
2794 * | [Send CertificateRequest]
2795 * Can send | [Send Certificate + CertificateVerify]
2796 * app data | Send Finished
2797 * after --> | K_send = application
2798 * here +--------+--------+
2799 * No 0-RTT | | 0-RTT
2800 * | |
2801 * K_recv = handshake | | K_recv = early data
2802 * [Skip decrypt errors] | +------> WAIT_EOED -+
2803 * | | Recv | | Recv EndOfEarlyData
2804 * | | early data | | K_recv = handshake
2805 * | +------------+ |
2806 * | |
2807 * +> WAIT_FLIGHT2 <--------+
2808 * |
2809 * +--------+--------+
2810 * No auth | | Client auth
2811 * | |
2812 * | v
2813 * | WAIT_CERT
2814 * | Recv | | Recv Certificate
2815 * | empty | v
2816 * | Certificate | WAIT_CV
2817 * | | | Recv
2818 * | v | CertificateVerify
2819 * +-> WAIT_FINISHED <---+
2820 * | Recv Finished
2821 *
2822 *
2823 * The following function handles the state changes after WAIT_FLIGHT2 in the
Jerry Yu3be85072023-12-04 09:58:54 +08002824 * above diagram. We are not going to receive early data related messages
2825 * anymore, prepare to receive the first handshake message of the client
2826 * second flight.
Jerry Yu9b72e392023-12-01 16:27:08 +08002827 */
Jerry Yu3be85072023-12-04 09:58:54 +08002828static void ssl_tls13_prepare_for_handshake_second_flight(
2829 mbedtls_ssl_context *ssl)
Jerry Yu9b72e392023-12-01 16:27:08 +08002830{
Jerry Yu9b72e392023-12-01 16:27:08 +08002831 if (ssl->handshake->certificate_request_sent) {
2832 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2833 } else {
Jerry Yu42020fb2023-12-05 17:35:53 +08002834 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
Jerry Yuebb1b1d2023-12-05 11:02:15 +08002835 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Jerry Yuebb1b1d2023-12-05 11:02:15 +08002836
Jerry Yu9b72e392023-12-01 16:27:08 +08002837 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2838 }
Jerry Yu9b72e392023-12-01 16:27:08 +08002839}
2840
Jerry Yu83da34e2022-04-16 13:59:52 +08002841/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002842 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002843 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002844MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002845static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002846{
Jerry Yud6e253d2022-05-18 13:59:24 +08002847 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002848
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2850 if (ret != 0) {
2851 return ret;
2852 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2855 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002856 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2858 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2859 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002860 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002861
Jerry Yu87b5ed42022-12-12 13:07:07 +08002862#if defined(MBEDTLS_SSL_EARLY_DATA)
Ronald Cron78a38f62024-02-01 18:30:31 +01002863 if (ssl->handshake->early_data_accepted) {
Jerry Yu0af63dc2023-12-01 17:14:51 +08002864 /* See RFC 8446 section A.2 for more information */
Jerry Yu87b5ed42022-12-12 13:07:07 +08002865 MBEDTLS_SSL_DEBUG_MSG(
2866 1, ("Switch to early keys for inbound traffic. "
2867 "( K_recv = early data )"));
2868 mbedtls_ssl_set_inbound_transform(
2869 ssl, ssl->handshake->transform_earlydata);
2870 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
2871 return 0;
2872 }
2873#endif /* MBEDTLS_SSL_EARLY_DATA */
Jerry Yu0af63dc2023-12-01 17:14:51 +08002874 MBEDTLS_SSL_DEBUG_MSG(
2875 1, ("Switch to handshake keys for inbound traffic "
2876 "( K_recv = handshake )"));
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002878
Jerry Yu3be85072023-12-04 09:58:54 +08002879 ssl_tls13_prepare_for_handshake_second_flight(ssl);
Jerry Yu7d8c3fe2022-12-12 12:59:44 +08002880
2881 return 0;
2882}
2883
Jerry Yu87b5ed42022-12-12 13:07:07 +08002884#if defined(MBEDTLS_SSL_EARLY_DATA)
2885/*
Jerry Yu59d420f2023-12-01 16:30:34 +08002886 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
Jerry Yu87b5ed42022-12-12 13:07:07 +08002887 */
Jerry Yu3be85072023-12-04 09:58:54 +08002888#define SSL_GOT_END_OF_EARLY_DATA 0
Jerry Yub55f9eb2023-12-05 10:27:17 +08002889#define SSL_GOT_EARLY_DATA 1
Jerry Yud5c34962023-12-01 16:32:31 +08002890/* Coordination:
Jerry Yu3be85072023-12-04 09:58:54 +08002891 * Deals with the ambiguity of not knowing if the next message is an
2892 * EndOfEarlyData message or an application message containing early data.
Jerry Yud5c34962023-12-01 16:32:31 +08002893 * Returns a negative code on failure, or
Jerry Yu3be85072023-12-04 09:58:54 +08002894 * - SSL_GOT_END_OF_EARLY_DATA
Jerry Yub55f9eb2023-12-05 10:27:17 +08002895 * - SSL_GOT_EARLY_DATA
Jerry Yud5c34962023-12-01 16:32:31 +08002896 * indicating which message is received.
2897 */
2898MBEDTLS_CHECK_RETURN_CRITICAL
2899static int ssl_tls13_end_of_early_data_coordinate(mbedtls_ssl_context *ssl)
2900{
2901 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub4ed4602023-12-01 16:34:00 +08002902
2903 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2904 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2905 return ret;
2906 }
2907 ssl->keep_current_message = 1;
2908
2909 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2910 ssl->in_msg[0] == MBEDTLS_SSL_HS_END_OF_EARLY_DATA) {
Jerry Yub55f9eb2023-12-05 10:27:17 +08002911 MBEDTLS_SSL_DEBUG_MSG(3, ("Received an end_of_early_data message."));
Jerry Yu3be85072023-12-04 09:58:54 +08002912 return SSL_GOT_END_OF_EARLY_DATA;
Jerry Yub4ed4602023-12-01 16:34:00 +08002913 }
2914
2915 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Croned7d4bf2024-01-31 07:55:19 +01002916 if (ssl->in_offt == NULL) {
Ronald Cron85718042024-02-22 10:22:09 +01002917 MBEDTLS_SSL_DEBUG_MSG(3, ("Received early data"));
Ronald Croned7d4bf2024-01-31 07:55:19 +01002918 /* Set the reading pointer */
2919 ssl->in_offt = ssl->in_msg;
Ronald Cron85718042024-02-22 10:22:09 +01002920 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, ssl->in_msglen);
2921 if (ret != 0) {
2922 return ret;
2923 }
Ronald Croned7d4bf2024-01-31 07:55:19 +01002924 }
Jerry Yub55f9eb2023-12-05 10:27:17 +08002925 return SSL_GOT_EARLY_DATA;
Jerry Yub4ed4602023-12-01 16:34:00 +08002926 }
2927
Jerry Yu7bb40a32023-12-04 10:04:15 +08002928 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
2929 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Jerry Yub4ed4602023-12-01 16:34:00 +08002930 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud5c34962023-12-01 16:32:31 +08002931}
2932
2933MBEDTLS_CHECK_RETURN_CRITICAL
2934static int ssl_tls13_parse_end_of_early_data(mbedtls_ssl_context *ssl,
2935 const unsigned char *buf,
2936 const unsigned char *end)
2937{
Jerry Yu75c9ab72023-12-01 16:41:40 +08002938 /* RFC 8446 section 4.5
2939 *
2940 * struct {} EndOfEarlyData;
2941 */
Jerry Yufbf03992023-12-04 10:00:37 +08002942 if (buf != end) {
2943 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2944 MBEDTLS_ERR_SSL_DECODE_ERROR);
2945 return MBEDTLS_ERR_SSL_DECODE_ERROR;
2946 }
2947 return 0;
Jerry Yud5c34962023-12-01 16:32:31 +08002948}
2949
Jerry Yud5c34962023-12-01 16:32:31 +08002950/*
2951 * RFC 8446 section A.2
2952 *
2953 * | Send ServerHello
2954 * | K_send = handshake
2955 * | Send EncryptedExtensions
2956 * | [Send CertificateRequest]
2957 * Can send | [Send Certificate + CertificateVerify]
2958 * app data | Send Finished
2959 * after --> | K_send = application
2960 * here +--------+--------+
2961 * No 0-RTT | | 0-RTT
2962 * | |
2963 * K_recv = handshake | | K_recv = early data
2964 * [Skip decrypt errors] | +------> WAIT_EOED -+
2965 * | | Recv | | Recv EndOfEarlyData
2966 * | | early data | | K_recv = handshake
2967 * | +------------+ |
2968 * | |
2969 * +> WAIT_FLIGHT2 <--------+
2970 * |
2971 * +--------+--------+
2972 * No auth | | Client auth
2973 * | |
2974 * | v
2975 * | WAIT_CERT
2976 * | Recv | | Recv Certificate
2977 * | empty | v
2978 * | Certificate | WAIT_CV
2979 * | | | Recv
2980 * | v | CertificateVerify
2981 * +-> WAIT_FINISHED <---+
2982 * | Recv Finished
2983 *
2984 * The function handles actions and state changes from 0-RTT to WAIT_FLIGHT2 in
2985 * the above diagram.
2986 */
Jerry Yu87b5ed42022-12-12 13:07:07 +08002987MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu59d420f2023-12-01 16:30:34 +08002988static int ssl_tls13_process_end_of_early_data(mbedtls_ssl_context *ssl)
Jerry Yu87b5ed42022-12-12 13:07:07 +08002989{
2990 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud5c34962023-12-01 16:32:31 +08002991
2992 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_tls13_process_end_of_early_data"));
2993
2994 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_end_of_early_data_coordinate(ssl));
2995
Jerry Yu3be85072023-12-04 09:58:54 +08002996 if (ret == SSL_GOT_END_OF_EARLY_DATA) {
Jerry Yud5c34962023-12-01 16:32:31 +08002997 unsigned char *buf;
2998 size_t buf_len;
2999
3000 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
3001 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
3002 &buf, &buf_len));
3003
3004 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_end_of_early_data(
3005 ssl, buf, buf + buf_len));
3006
Jerry Yue9655122023-12-01 16:44:40 +08003007 MBEDTLS_SSL_DEBUG_MSG(
3008 1, ("Switch to handshake keys for inbound traffic"
3009 "( K_recv = handshake )"));
3010 mbedtls_ssl_set_inbound_transform(
3011 ssl, ssl->handshake->transform_handshake);
3012
Jerry Yud5c34962023-12-01 16:32:31 +08003013 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
3014 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
3015 buf, buf_len));
Jerry Yue9655122023-12-01 16:44:40 +08003016
Jerry Yu3be85072023-12-04 09:58:54 +08003017 ssl_tls13_prepare_for_handshake_second_flight(ssl);
Jerry Yud5c34962023-12-01 16:32:31 +08003018
Jerry Yub55f9eb2023-12-05 10:27:17 +08003019 } else if (ret == SSL_GOT_EARLY_DATA) {
Jerry Yud9ca3542023-12-06 17:23:52 +08003020 ret = MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA;
3021 goto cleanup;
Jerry Yud5c34962023-12-01 16:32:31 +08003022 } else {
3023 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
3024 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3025 goto cleanup;
3026 }
3027
Jerry Yud5c34962023-12-01 16:32:31 +08003028cleanup:
3029 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_tls13_process_end_of_early_data"));
Jerry Yu87b5ed42022-12-12 13:07:07 +08003030 return ret;
3031}
3032#endif /* MBEDTLS_SSL_EARLY_DATA */
3033
Jerry Yu69dd8d42022-04-16 12:51:26 +08003034/*
Jerry Yud6e253d2022-05-18 13:59:24 +08003035 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08003036 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003037MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003038static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08003039{
Jerry Yud6e253d2022-05-18 13:59:24 +08003040 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3041
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
3043 if (ret != 0) {
3044 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08003045 }
3046
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
3048 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003049 MBEDTLS_SSL_DEBUG_RET(
3050 1, "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 }
3052
3053 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
3054 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08003055}
3056
3057/*
Jerry Yud6e253d2022-05-18 13:59:24 +08003058 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08003059 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003061static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08003062{
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08003064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00003066
Pengyu Lv3643fdb2023-01-12 16:46:28 +08003067#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
3068 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08003069/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
3070 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
3071 * expected to be resolved with issue#6395.
3072 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08003073 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lvb2cfafb2023-11-14 13:56:13 +08003074 if (mbedtls_ssl_tls13_is_some_psk_supported(ssl)) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003075 mbedtls_ssl_handshake_set_state(
3076 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08003077 } else
Jerry Yufca4d572022-07-21 10:37:48 +08003078#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08003079 {
3080 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3081 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08003083}
3084
3085/*
Jerry Yua8d3c502022-10-30 14:51:23 +08003086 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003087 */
3088#define SSL_NEW_SESSION_TICKET_SKIP 0
3089#define SSL_NEW_SESSION_TICKET_WRITE 1
3090MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003091static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00003092{
3093 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 if (ssl->conf->f_ticket_write == NULL) {
3095 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
3096 " callback is not set"));
3097 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08003098 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 if (ssl->conf->new_session_tickets_count == 0) {
3100 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
3101 " configured count is zero"));
3102 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08003103 }
3104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 if (ssl->handshake->new_session_tickets_count == 0) {
3106 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
3107 "been sent."));
3108 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00003109 }
3110
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00003112}
3113
3114#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3115MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003116static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
3117 unsigned char *ticket_nonce,
3118 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00003119{
3120 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3121 mbedtls_ssl_session *session = ssl->session;
3122 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
3123 psa_algorithm_t psa_hash_alg;
3124 int hash_length;
3125
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00003127
Pengyu Lv9f926952022-11-17 15:22:33 +08003128 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003129 mbedtls_ssl_tls13_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08003130 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08003131#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003132 mbedtls_ssl_tls13_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08003133 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08003134#endif
Jerry Yu95648b02023-12-06 15:03:34 +08003135
3136#if defined(MBEDTLS_SSL_EARLY_DATA)
3137 if (ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED &&
3138 ssl->conf->max_early_data_size > 0) {
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003139 mbedtls_ssl_tls13_session_set_ticket_flags(
Jerry Yu95648b02023-12-06 15:03:34 +08003140 session, MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA);
Ronald Cronc2865192024-02-07 14:01:03 +01003141 session->max_early_data_size = ssl->conf->max_early_data_size;
Jerry Yu95648b02023-12-06 15:03:34 +08003142 }
3143#endif /* MBEDTLS_SSL_EARLY_DATA */
3144
Pengyu Lv4938a562023-01-16 11:28:49 +08003145 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08003146
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003147#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy5bc52632024-03-12 16:25:08 +00003148 if (session->ticket_alpn == NULL) {
3149 ret = mbedtls_ssl_session_set_ticket_alpn(session, ssl->alpn_chosen);
3150 if (ret != 0) {
3151 return ret;
3152 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003153 }
3154#endif
3155
Jerry Yue67bef42022-07-07 07:29:42 +00003156 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01003157 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
3158 (unsigned char *) &session->ticket_age_add,
3159 sizeof(session->ticket_age_add)) != 0)) {
3160 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
3161 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003162 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
3164 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00003165
3166 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
3168 if (ret != 0) {
3169 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
3170 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003171 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
3173 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00003174
3175 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
Dave Rodgman2eab4622023-10-05 13:30:37 +01003177 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01003178 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
3179 if (hash_length == -1 ||
3180 (size_t) hash_length > sizeof(session->resumption_key)) {
3181 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08003182 }
3183
Jerry Yue67bef42022-07-07 07:29:42 +00003184 /* In this code the psk key length equals the length of the hash */
3185 session->resumption_key_len = hash_length;
3186 session->ciphersuite = ciphersuite_info->id;
3187
3188 /* Compute resumption key
3189 *
3190 * HKDF-Expand-Label( resumption_master_secret,
3191 * "resumption", ticket_nonce, Hash.length )
3192 */
3193 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01003194 psa_hash_alg,
3195 session->app_secrets.resumption_master_secret,
3196 hash_length,
3197 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
3198 ticket_nonce,
3199 ticket_nonce_size,
3200 session->resumption_key,
3201 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00003202
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 if (ret != 0) {
3204 MBEDTLS_SSL_DEBUG_RET(2,
3205 "Creating the ticket-resumed PSK failed",
3206 ret);
3207 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003208 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
3210 session->resumption_key,
3211 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00003212
Gilles Peskine449bd832023-01-11 14:50:10 +01003213 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
3214 session->app_secrets.resumption_master_secret,
3215 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00003216
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00003218}
3219
3220/* This function creates a NewSessionTicket message in the following format:
3221 *
3222 * struct {
3223 * uint32 ticket_lifetime;
3224 * uint32 ticket_age_add;
3225 * opaque ticket_nonce<0..255>;
3226 * opaque ticket<1..2^16-1>;
3227 * Extension extensions<0..2^16-2>;
3228 * } NewSessionTicket;
3229 *
3230 * The ticket inside the NewSessionTicket message is an encrypted container
3231 * carrying the necessary information so that the server is later able to
3232 * re-start the communication.
3233 *
3234 * The following fields are placed inside the ticket by the
3235 * f_ticket_write() function:
3236 *
Jerry Yu0069abc2023-11-23 21:07:28 +08003237 * - creation time (ticket_creation_time)
3238 * - flags (ticket_flags)
Jerry Yue67bef42022-07-07 07:29:42 +00003239 * - age add (ticket_age_add)
Jerry Yu0069abc2023-11-23 21:07:28 +08003240 * - key (resumption_key)
3241 * - key length (resumption_key_len)
Jerry Yue67bef42022-07-07 07:29:42 +00003242 * - ciphersuite (ciphersuite)
Jerry Yu0069abc2023-11-23 21:07:28 +08003243 * - max_early_data_size (max_early_data_size)
Jerry Yue67bef42022-07-07 07:29:42 +00003244 */
3245MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003246static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
3247 unsigned char *buf,
3248 unsigned char *end,
3249 size_t *out_len,
3250 unsigned char *ticket_nonce,
3251 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00003252{
3253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3254 unsigned char *p = buf;
3255 mbedtls_ssl_session *session = ssl->session;
3256 size_t ticket_len;
3257 uint32_t ticket_lifetime;
Jerry Yu01da35e2022-12-12 15:09:22 +08003258 unsigned char *p_extensions_len;
Jerry Yue67bef42022-07-07 07:29:42 +00003259
3260 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00003262
3263 /*
3264 * ticket_lifetime 4 bytes
3265 * ticket_age_add 4 bytes
3266 * ticket_nonce 1 + ticket_nonce_size bytes
3267 * ticket >=2 bytes
3268 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00003270
3271 /* Generate ticket and ticket_lifetime */
Ronald Cron3c0072b2023-11-22 10:00:14 +01003272#if defined(MBEDTLS_HAVE_TIME)
3273 session->ticket_creation_time = mbedtls_ms_time();
3274#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
3276 session,
3277 p + 9 + ticket_nonce_size + 2,
3278 end,
3279 &ticket_len,
3280 &ticket_lifetime);
3281 if (ret != 0) {
3282 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
3283 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003284 }
Jerry Yuce794882023-11-22 15:01:18 +08003285
3286 /* RFC 8446 section 4.6.1
3287 *
Jerry Yue67bef42022-07-07 07:29:42 +00003288 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
Jerry Yuce794882023-11-22 15:01:18 +08003289 * unsigned integer in network byte order from the time of ticket
3290 * issuance. Servers MUST NOT use any value greater than
3291 * 604800 seconds (7 days) ...
Jerry Yue67bef42022-07-07 07:29:42 +00003292 */
Jerry Yu8e0174a2023-11-10 13:58:16 +08003293 if (ticket_lifetime > MBEDTLS_SSL_TLS1_3_MAX_ALLOWED_TICKET_LIFETIME) {
Jerry Yuce794882023-11-22 15:01:18 +08003294 MBEDTLS_SSL_DEBUG_MSG(
3295 1, ("Ticket lifetime (%u) is greater than 7 days.",
3296 (unsigned int) ticket_lifetime));
3297 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 }
Jerry Yuce794882023-11-22 15:01:18 +08003299
Gilles Peskine449bd832023-01-11 14:50:10 +01003300 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
3301 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
3302 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00003303
3304 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
3306 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
3307 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00003308
3309 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 p[8] = (unsigned char) ticket_nonce_size;
3311 if (ticket_nonce_size > 0) {
3312 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00003313 }
3314 p += 9 + ticket_nonce_size;
3315
3316 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00003318 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00003320 p += ticket_len;
3321
3322 /* Ticket Extensions
3323 *
Jerry Yu01da35e2022-12-12 15:09:22 +08003324 * Extension extensions<0..2^16-2>;
Jerry Yue67bef42022-07-07 07:29:42 +00003325 */
Jerry Yuedab6372022-10-31 14:37:31 +08003326 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
3327
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu01da35e2022-12-12 15:09:22 +08003329 p_extensions_len = p;
Jerry Yue67bef42022-07-07 07:29:42 +00003330 p += 2;
3331
Jerry Yu01da35e2022-12-12 15:09:22 +08003332#if defined(MBEDTLS_SSL_EARLY_DATA)
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003333 if (mbedtls_ssl_tls13_session_ticket_allow_early_data(session)) {
Jerry Yu95648b02023-12-06 15:03:34 +08003334 size_t output_len;
3335
Jerry Yuf135bac2023-11-23 18:10:51 +08003336 if ((ret = mbedtls_ssl_tls13_write_early_data_ext(
Jerry Yuc59c5862023-12-05 10:40:49 +08003337 ssl, 1, p, end, &output_len)) != 0) {
Jerry Yuf135bac2023-11-23 18:10:51 +08003338 MBEDTLS_SSL_DEBUG_RET(
3339 1, "mbedtls_ssl_tls13_write_early_data_ext", ret);
3340 return ret;
3341 }
3342 p += output_len;
Jerry Yu9e7f9bc2023-11-27 16:52:07 +08003343 } else {
3344 MBEDTLS_SSL_DEBUG_MSG(
3345 4, ("early_data not allowed, "
3346 "skip early_data extension in NewSessionTicket"));
Jerry Yu01da35e2022-12-12 15:09:22 +08003347 }
Jerry Yuf135bac2023-11-23 18:10:51 +08003348
Jerry Yu01da35e2022-12-12 15:09:22 +08003349#endif /* MBEDTLS_SSL_EARLY_DATA */
3350
3351 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
3352
Jerry Yue67bef42022-07-07 07:29:42 +00003353 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
3355 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00003356
Jerry Yu7de2ff02022-11-08 21:43:46 +08003357 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08003359
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00003361}
3362
3363/*
Jerry Yua8d3c502022-10-30 14:51:23 +08003364 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003365 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003366static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00003367{
3368 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3369
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00003371
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00003373 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
3374 unsigned char *buf;
3375 size_t buf_len, msg_len;
3376
Gilles Peskine449bd832023-01-11 14:50:10 +01003377 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
3378 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003379
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003380 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
3381 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
3382 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00003383
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
3385 ssl, buf, buf + buf_len, &msg_len,
3386 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003387
Gilles Peskine449bd832023-01-11 14:50:10 +01003388 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
3389 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08003390
Jerry Yu359e65f2022-09-22 23:47:43 +08003391 /* Limit session tickets count to one when resumption connection.
3392 *
3393 * See document of mbedtls_ssl_conf_new_session_tickets.
3394 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003395 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08003396 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08003398 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01003399 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08003400
Jerry Yua8d3c502022-10-30 14:51:23 +08003401 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003402 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
3403 } else {
3404 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00003405 }
3406
Jerry Yue67bef42022-07-07 07:29:42 +00003407cleanup:
3408
Gilles Peskine449bd832023-01-11 14:50:10 +01003409 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003410}
3411#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3412
3413/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00003414 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00003415 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003416int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08003417{
XiaokangQian08037552022-04-20 07:16:41 +00003418 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003419
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
3421 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3422 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003423
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
Dave Rodgman2eab4622023-10-05 13:30:37 +01003425 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state),
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08003427
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00003429 /* start state */
3430 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00003432 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003433 break;
3434
XiaokangQian7807f9f2022-02-15 10:04:37 +00003435 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003436 ret = ssl_tls13_process_client_hello(ssl);
3437 if (ret != 0) {
3438 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
3439 }
Jerry Yuf41553b2022-05-09 22:20:30 +08003440 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003441
Jerry Yuf41553b2022-05-09 22:20:30 +08003442 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003443 ret = ssl_tls13_write_hello_retry_request(ssl);
3444 if (ret != 0) {
3445 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
3446 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08003447 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003448 break;
3449
Jerry Yu5b64ae92022-03-30 17:15:02 +08003450 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003451 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08003452 break;
3453
Xiaofei Baicba64af2022-02-15 10:00:56 +00003454 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 ret = ssl_tls13_write_encrypted_extensions(ssl);
3456 if (ret != 0) {
3457 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
3458 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00003459 }
Jerry Yu48330562022-05-06 21:35:44 +08003460 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08003461
Ronald Cron928cbd32022-10-04 16:14:26 +02003462#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003463 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003464 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003465 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003466
Jerry Yu83da34e2022-04-16 13:59:52 +08003467 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003468 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003469 break;
3470
3471 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003472 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003473 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003474#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003475
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 /*
3477 * Injection of dummy-CCS's for middlebox compatibility
3478 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003479#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003480 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003481 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3482 if (ret == 0) {
3483 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3484 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003485 break;
3486
3487 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Ronald Crone273f722024-02-13 18:22:26 +01003488 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3489 if (ret != 0) {
3490 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003491 }
Ronald Cronfe59ff72024-01-24 14:31:50 +01003492 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003493 break;
3494#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3495
Jerry Yu69dd8d42022-04-16 12:51:26 +08003496 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003497 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003498 break;
3499
Jerry Yu87b5ed42022-12-12 13:07:07 +08003500#if defined(MBEDTLS_SSL_EARLY_DATA)
3501 case MBEDTLS_SSL_END_OF_EARLY_DATA:
Jerry Yu59d420f2023-12-01 16:30:34 +08003502 ret = ssl_tls13_process_end_of_early_data(ssl);
Jerry Yu87b5ed42022-12-12 13:07:07 +08003503 break;
3504#endif /* MBEDTLS_SSL_EARLY_DATA */
3505
Jerry Yu69dd8d42022-04-16 12:51:26 +08003506 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003507 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003508 break;
3509
Jerry Yu69dd8d42022-04-16 12:51:26 +08003510 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003511 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003512 break;
3513
Ronald Cron766c0cd2022-10-18 12:17:11 +02003514#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003515 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003516 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3517 if (ret == 0) {
3518 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003519 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003520 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3521 } else {
3522 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003523 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003524 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003525 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003526 }
3527 break;
3528
3529 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003530 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3531 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003532 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003533 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003534 }
3535 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003536#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003537
Jerry Yue67bef42022-07-07 07:29:42 +00003538#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003539 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003540 ret = ssl_tls13_write_new_session_ticket(ssl);
3541 if (ret != 0) {
3542 MBEDTLS_SSL_DEBUG_RET(1,
3543 "ssl_tls13_write_new_session_ticket ",
3544 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003545 }
3546 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003547 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003548 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003549 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003550 * as part of ssl_prepare_handshake_step.
3551 */
3552 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003553
Gilles Peskine449bd832023-01-11 14:50:10 +01003554 if (ssl->handshake->new_session_tickets_count == 0) {
3555 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3556 } else {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003557 mbedtls_ssl_handshake_set_state(
3558 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Gilles Peskine449bd832023-01-11 14:50:10 +01003559 }
Jerry Yue67bef42022-07-07 07:29:42 +00003560 break;
3561
3562#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3563
XiaokangQian7807f9f2022-02-15 10:04:37 +00003564 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003565 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3566 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003567 }
3568
Gilles Peskine449bd832023-01-11 14:50:10 +01003569 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003570}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003571
Jerry Yufb4b6472022-01-27 15:03:26 +08003572#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */