blob: af5e3805fb39b2343e2b40b556980758dff55bbe [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
Ronald Crona5c5c582024-03-19 13:54:15 +0100417 if (binder_len != PSA_HASH_LENGTH(psk_hash_alg)) {
418 return SSL_TLS1_3_BINDER_DOES_NOT_MATCH;
419 }
420
Jerry Yu1c105562022-07-10 06:32:38 +0000421 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800422 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200423 ssl, mbedtls_md_type_from_psa_alg(psk_hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 transcript, sizeof(transcript), &transcript_len);
425 if (ret != 0) {
426 return ret;
427 }
Jerry Yu1c105562022-07-10 06:32:38 +0000428
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
430 if (ret != 0) {
431 return ret;
432 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800433
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
435 psk, psk_len, psk_type,
436 transcript,
437 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800438#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800440#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 if (ret != 0) {
442 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
443 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000444 }
445
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
447 server_computed_binder, transcript_len);
448 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000449
Ronald Crona5c5c582024-03-19 13:54:15 +0100450 if (mbedtls_ct_memcmp(server_computed_binder,
451 binder,
452 PSA_HASH_LENGTH(psk_hash_alg)) == 0) {
Ronald Cron6e311272023-12-05 17:57:01 +0100453 return SSL_TLS1_3_BINDER_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000454 }
455
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 mbedtls_platform_zeroize(server_computed_binder,
457 sizeof(server_computed_binder));
Ronald Cron6e311272023-12-05 17:57:01 +0100458 return SSL_TLS1_3_BINDER_DOES_NOT_MATCH;
Jerry Yuf35ba382022-08-23 17:58:26 +0800459}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800460
Jerry Yu82534862022-08-30 10:42:33 +0800461#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800462MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100463static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
464 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800465{
Jerry Yu82534862022-08-30 10:42:33 +0800466 dst->ticket_age_add = src->ticket_age_add;
467 dst->ticket_flags = src->ticket_flags;
468 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 if (src->resumption_key_len == 0) {
470 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
471 }
472 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800473
Jerry Yu33bf2402022-12-12 16:01:43 +0800474#if defined(MBEDTLS_SSL_EARLY_DATA)
475 dst->max_early_data_size = src->max_early_data_size;
476#endif
477
Gilles Peskine449bd832023-01-11 14:50:10 +0100478 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800479}
480#endif /* MBEDTLS_SSL_SESSION_TICKETS */
481
Ronald Cron79cdd412024-02-20 17:19:28 +0100482struct psk_attributes {
483 int type;
484 int key_exchange_mode;
Ronald Cron74a16292024-02-23 17:07:41 +0100485 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Ronald Cron79cdd412024-02-20 17:19:28 +0100486};
Ronald Cron16cc3702024-03-07 15:04:56 +0100487#define PSK_ATTRIBUTES_INIT { 0, 0, NULL }
Ronald Cron79cdd412024-02-20 17:19:28 +0100488
Jerry Yu1c105562022-07-10 06:32:38 +0000489/* Parser for pre_shared_key extension in client hello
490 * struct {
491 * opaque identity<1..2^16-1>;
492 * uint32 obfuscated_ticket_age;
493 * } PskIdentity;
494 *
495 * opaque PskBinderEntry<32..255>;
496 *
497 * struct {
498 * PskIdentity identities<7..2^16-1>;
499 * PskBinderEntry binders<33..2^16-1>;
500 * } OfferedPsks;
501 *
502 * struct {
503 * select (Handshake.msg_type) {
504 * case client_hello: OfferedPsks;
505 * ....
506 * };
507 * } PreSharedKeyExtension;
508 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800509MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000510static int ssl_tls13_parse_pre_shared_key_ext(
511 mbedtls_ssl_context *ssl,
512 const unsigned char *pre_shared_key_ext,
513 const unsigned char *pre_shared_key_ext_end,
514 const unsigned char *ciphersuites,
Ronald Cron79cdd412024-02-20 17:19:28 +0100515 const unsigned char *ciphersuites_end,
516 struct psk_attributes *psk)
Jerry Yu1c105562022-07-10 06:32:38 +0000517{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800519 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800520 const unsigned char *p_identity_len;
521 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000522 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800523 const unsigned char *binders;
524 const unsigned char *p_binder_len;
525 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000526 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800527 int matched_identity = -1;
528 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000529
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
531 pre_shared_key_ext,
532 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000533
Jerry Yu96a2e362022-07-21 15:11:34 +0800534 /* identities_len 2 bytes
535 * identities_data >= 7 bytes
536 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
538 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800539 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
541 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800542 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000543
Jerry Yu96a2e362022-07-21 15:11:34 +0800544 /* binders_len 2 bytes
545 * binders >= 33 bytes
546 */
Jerry Yu568ec252022-07-22 21:27:34 +0800547 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100548 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
549 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800550 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800552 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000553
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100554 ret = ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
555 identities_end - pre_shared_key_ext);
556 if (0 != ret) {
557 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
558 return ret;
559 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800560
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000562 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800563 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800564 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800565 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800566 size_t binder_len;
Ronald Cron89089cc2024-02-14 18:18:08 +0100567 int psk_ciphersuite_id;
568 psa_algorithm_t psk_hash_alg;
Ronald Croncf284562024-02-16 18:54:10 +0100569 int allowed_key_exchange_modes;
Ronald Cron74a16292024-02-23 17:07:41 +0100570
Jerry Yu82534862022-08-30 10:42:33 +0800571#if defined(MBEDTLS_SSL_SESSION_TICKETS)
572 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800574#endif
Jerry Yubb852022022-07-20 21:10:44 +0800575
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
577 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800578 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
580 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800581 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000582
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800584 binder_len = *p_binder_len;
585 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800587 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800588
Jerry Yu96a2e362022-07-21 15:11:34 +0800589 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000591 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 }
Jerry Yu1c105562022-07-10 06:32:38 +0000593
Jerry Yu96a2e362022-07-21 15:11:34 +0800594 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 ssl, identity, identity_len, obfuscated_ticket_age,
Ronald Cron79cdd412024-02-20 17:19:28 +0100596 &psk->type, &session);
Ronald Cronfbae94a2023-12-05 18:15:14 +0100597 if (ret != SSL_TLS1_3_PSK_IDENTITY_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800598 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800600
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
Ronald Cron89089cc2024-02-14 18:18:08 +0100602
Ronald Cron79cdd412024-02-20 17:19:28 +0100603 switch (psk->type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800604 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
Ronald Cron89089cc2024-02-14 18:18:08 +0100605 psk_ciphersuite_id = 0;
606 psk_hash_alg = PSA_ALG_SHA_256;
Ronald Croncf284562024-02-16 18:54:10 +0100607 allowed_key_exchange_modes =
608 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
Jerry Yu0baf9072022-08-25 11:21:04 +0800609 break;
Jerry Yu82534862022-08-30 10:42:33 +0800610#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Cronf7e99162024-02-14 16:04:02 +0100611 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Ronald Cron89089cc2024-02-14 18:18:08 +0100612 psk_ciphersuite_id = session.ciphersuite;
613 psk_hash_alg = PSA_ALG_NONE;
Ronald Croncf284562024-02-16 18:54:10 +0100614 ssl->session_negotiate->ticket_flags = session.ticket_flags;
615 allowed_key_exchange_modes =
616 session.ticket_flags &
617 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL;
Jerry Yu0baf9072022-08-25 11:21:04 +0800618 break;
Ronald Cronf7e99162024-02-14 16:04:02 +0100619#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800620 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800622 }
Ronald Cron89089cc2024-02-14 18:18:08 +0100623
Ronald Cron79cdd412024-02-20 17:19:28 +0100624 psk->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
625
Ronald Croncf284562024-02-16 18:54:10 +0100626 if ((allowed_key_exchange_modes &
627 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) &&
628 ssl_tls13_key_exchange_is_psk_ephemeral_available(ssl)) {
Ronald Cron79cdd412024-02-20 17:19:28 +0100629 psk->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Ronald Croncf284562024-02-16 18:54:10 +0100630 } else if ((allowed_key_exchange_modes &
631 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) &&
632 ssl_tls13_key_exchange_is_psk_available(ssl)) {
Ronald Cron79cdd412024-02-20 17:19:28 +0100633 psk->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Ronald Croncf284562024-02-16 18:54:10 +0100634 }
635
Ronald Cron79cdd412024-02-20 17:19:28 +0100636 if (psk->key_exchange_mode == MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE) {
Ronald Croncf284562024-02-16 18:54:10 +0100637 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable PSK key exchange mode"));
638 continue;
639 }
640
Ronald Cron89089cc2024-02-14 18:18:08 +0100641 ssl_tls13_select_ciphersuite(ssl, ciphersuites, ciphersuites_end,
642 psk_ciphersuite_id, psk_hash_alg,
Ronald Cron74a16292024-02-23 17:07:41 +0100643 &psk->ciphersuite_info);
Ronald Cron89089cc2024-02-14 18:18:08 +0100644
Ronald Cron74a16292024-02-23 17:07:41 +0100645 if (psk->ciphersuite_info == NULL) {
Ronald Cron89089cc2024-02-14 18:18:08 +0100646#if defined(MBEDTLS_SSL_SESSION_TICKETS)
647 mbedtls_ssl_session_free(&session);
648#endif
649 /*
650 * We consider finding a ciphersuite suitable for the PSK as part
651 * of the validation of its binder. Thus if we do not find one, we
652 * abort the handshake with a decrypt_error alert.
653 */
Jerry Yuf35ba382022-08-23 17:58:26 +0800654 MBEDTLS_SSL_PEND_FATAL_ALERT(
655 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Ronald Cron89089cc2024-02-14 18:18:08 +0100657 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800658 }
659
Jerry Yu96a2e362022-07-21 15:11:34 +0800660 ret = ssl_tls13_offered_psks_check_binder_match(
Ronald Cron79cdd412024-02-20 17:19:28 +0100661 ssl, binder, binder_len, psk->type,
Ronald Cron74a16292024-02-23 17:07:41 +0100662 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) psk->ciphersuite_info->mac));
Ronald Cron6e311272023-12-05 17:57:01 +0100663 if (ret != SSL_TLS1_3_BINDER_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800664 /* For security reasons, the handshake should be aborted when we
665 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
666 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800667#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800669#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000671 MBEDTLS_SSL_DEBUG_RET(
672 1, "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800673 MBEDTLS_SSL_PEND_FATAL_ALERT(
674 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
676 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800677 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800678
679 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800680
Jerry Yu82534862022-08-30 10:42:33 +0800681#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Cron79cdd412024-02-20 17:19:28 +0100682 if (psk->type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
684 &session);
685 mbedtls_ssl_session_free(&session);
686 if (ret != 0) {
687 return ret;
688 }
Jerry Yu82534862022-08-30 10:42:33 +0800689 }
690#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000691 }
692
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 if (p_identity_len != identities_end || p_binder_len != binders_end) {
694 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
695 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
696 MBEDTLS_ERR_SSL_DECODE_ERROR);
697 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000698 }
699
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800700 /* Update the handshake transcript with the binder list. */
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000701 ret = ssl->handshake->update_checksum(
702 ssl, identities_end, (size_t) (binders_end - identities_end));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100703 if (0 != ret) {
704 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
705 return ret;
706 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 if (matched_identity == -1) {
Ronald Croncf284562024-02-16 18:54:10 +0100708 MBEDTLS_SSL_DEBUG_MSG(3, ("No usable PSK or ticket."));
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000710 }
711
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 ssl->handshake->selected_identity = (uint16_t) matched_identity;
713 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000714
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000716}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000717
718/*
719 * struct {
720 * select ( Handshake.msg_type ) {
721 * ....
722 * case server_hello:
723 * uint16 selected_identity;
724 * }
725 * } PreSharedKeyExtension;
726 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100727static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
728 unsigned char *buf,
729 unsigned char *end,
730 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000731{
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000733
734 *olen = 0;
735
David Horstmann21b89762022-10-06 18:34:28 +0100736 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000737#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100738 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000739#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100740 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000741#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000743 /* We shouldn't have called this extension writer unless we've
744 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000746 }
747
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
749 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000750
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
752 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000753
Gilles Peskine449bd832023-01-11 14:50:10 +0100754 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000755
756 *olen = 6;
757
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
759 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000760
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800762
Gilles Peskine449bd832023-01-11 14:50:10 +0100763 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000764}
765
Ronald Cron41a443a2022-10-04 16:38:25 +0200766#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000767
XiaokangQian7807f9f2022-02-15 10:04:37 +0000768/* From RFC 8446:
769 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000770 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000771 * } SupportedVersions;
772 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200773MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100774static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
775 const unsigned char *buf,
776 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000777{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000778 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000779 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000780 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000781 uint16_t tls_version;
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100782 int found_supported_version = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000783
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000785 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000786 p += 1;
787
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000789 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 while (p < versions_end) {
791 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
792 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000793 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000794
Ronald Cron3bd2b022023-04-03 16:45:39 +0200795 if (MBEDTLS_SSL_VERSION_TLS1_3 == tls_version) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100796 found_supported_version = 1;
797 break;
798 }
799
Ronald Cron3bd2b022023-04-03 16:45:39 +0200800 if ((MBEDTLS_SSL_VERSION_TLS1_2 == tls_version) &&
801 mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100802 found_supported_version = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000803 break;
804 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000805 }
806
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100807 if (!found_supported_version) {
808 MBEDTLS_SSL_DEBUG_MSG(1, ("No supported version found."));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000809
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
811 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
812 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000813 }
814
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100815 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version: [%04x]",
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000817
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100818 return (int) tls_version;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000819}
820
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200821#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000822/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000823 *
824 * From RFC 8446:
825 * enum {
826 * ... (0xFFFF)
827 * } NamedGroup;
828 * struct {
829 * NamedGroup named_group_list<2..2^16-1>;
830 * } NamedGroupList;
831 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200832MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100833static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
834 const unsigned char *buf,
835 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000836{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000837 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000838 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000839 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000840
Gilles Peskine449bd832023-01-11 14:50:10 +0100841 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
842 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
843 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000844 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000846 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000847 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000848
Gilles Peskine449bd832023-01-11 14:50:10 +0100849 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000850 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100851 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
852 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000853 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000854
Gilles Peskine449bd832023-01-11 14:50:10 +0100855 MBEDTLS_SSL_DEBUG_MSG(2,
856 ("got named group: %s(%04x)",
857 mbedtls_ssl_named_group_to_str(named_group),
858 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000859
Gilles Peskine449bd832023-01-11 14:50:10 +0100860 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
861 !mbedtls_ssl_named_group_is_supported(named_group) ||
862 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000863 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000864 }
865
Gilles Peskine449bd832023-01-11 14:50:10 +0100866 MBEDTLS_SSL_DEBUG_MSG(2,
867 ("add named group %s(%04x) into received list.",
868 mbedtls_ssl_named_group_to_str(named_group),
869 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800870
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000871 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000872 }
873
Gilles Peskine449bd832023-01-11 14:50:10 +0100874 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000875
876}
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200877#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000878
XiaokangQian08037552022-04-20 07:16:41 +0000879#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
880
Valerio Settic9ae8622023-07-25 11:23:50 +0200881#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000882/*
883 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000884 * extension is correct and stores the first acceptable key share and its
885 * associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000886 *
887 * Possible return values are:
888 * - 0: Successful processing of the client provided key share extension.
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000889 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by
890 * the client does not match a group supported by the server. A
891 * HelloRetryRequest will be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000892 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800893 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200894MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100895static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
896 const unsigned char *buf,
897 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000898{
XiaokangQianb67384d2022-04-19 00:02:38 +0000899 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000900 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000901 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800902 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000903
904 /* From RFC 8446:
905 *
906 * struct {
907 * KeyShareEntry client_shares<0..2^16-1>;
908 * } KeyShareClientHello;
909 *
910 */
911
Gilles Peskine449bd832023-01-11 14:50:10 +0100912 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
913 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000914 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000916
917 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000918 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000919
920 /* We try to find a suitable key share entry and copy it to the
921 * handshake context. Later, we have to find out whether we can do
922 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000923 * dismiss it and send a HelloRetryRequest message.
924 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000925
Gilles Peskine449bd832023-01-11 14:50:10 +0100926 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000927 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800928 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800929 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000930
931 /*
932 * struct {
933 * NamedGroup group;
934 * opaque key_exchange<1..2^16-1>;
935 * } KeyShareEntry;
936 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
938 group = MBEDTLS_GET_UINT16_BE(p, 0);
939 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800940 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800941 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800943 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000944
945 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000946 * for input validation purposes.
947 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
949 !mbedtls_ssl_named_group_is_supported(group) ||
950 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000951 continue;
952 }
XiaokangQian060d8672022-04-21 09:24:56 +0000953
XiaokangQian7807f9f2022-02-15 10:04:37 +0000954 /*
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200955 * ECDHE and FFDHE groups are supported
XiaokangQian7807f9f2022-02-15 10:04:37 +0000956 */
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200957 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200958 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200959 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH/FFDH group: %s (%04x)",
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 mbedtls_ssl_named_group_to_str(group),
961 group));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200962 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 ssl, key_exchange - 2, key_exchange_len + 2);
964 if (ret != 0) {
965 return ret;
966 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000967
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 } else {
969 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
970 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000971 continue;
972 }
973
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000974 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000975 }
976
Jerry Yuc1be19f2022-04-23 16:11:39 +0800977
Gilles Peskine449bd832023-01-11 14:50:10 +0100978 if (ssl->handshake->offered_group_id == 0) {
979 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
980 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000981 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000983}
Valerio Settic9ae8622023-07-25 11:23:50 +0200984#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000985
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200986MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100987static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
988 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000989{
Jerry Yu0c354a22022-08-29 15:25:36 +0800990 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000992}
993
Jerry Yue5991322022-11-07 14:03:44 +0800994#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200995MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000996static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000998{
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 return ssl_tls13_client_hello_has_exts(
1000 ssl,
1001 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
1002 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
1003 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001004}
Jerry Yue5991322022-11-07 14:03:44 +08001005#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001006
Jerry Yue5991322022-11-07 14:03:44 +08001007#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +00001008MBEDTLS_CHECK_RETURN_CRITICAL
1009static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001011{
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 return ssl_tls13_client_hello_has_exts(
1013 ssl,
1014 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1015 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +00001016}
Jerry Yue5991322022-11-07 14:03:44 +08001017#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +00001018
Jerry Yue5991322022-11-07 14:03:44 +08001019#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +00001020MBEDTLS_CHECK_RETURN_CRITICAL
1021static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001023{
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 return ssl_tls13_client_hello_has_exts(
1025 ssl,
1026 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
1027 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
1028 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1029 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +00001030}
Jerry Yue5991322022-11-07 14:03:44 +08001031#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +00001032
Pengyu Lv306a01d2023-02-02 16:35:47 +08001033#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
1034MBEDTLS_CHECK_RETURN_CRITICAL
Pengyu Lvbc4aab72023-12-01 15:37:24 +08001035static int ssl_tls13_key_exchange_is_psk_available(mbedtls_ssl_context *ssl)
Pengyu Lv306a01d2023-02-02 16:35:47 +08001036{
Jerry Yue5991322022-11-07 14:03:44 +08001037#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Ronald Crone8c162d2024-02-21 10:15:44 +01001038 return mbedtls_ssl_conf_tls13_is_psk_enabled(ssl) &&
Pengyu Lvb2cfafb2023-11-14 13:56:13 +08001039 mbedtls_ssl_tls13_is_psk_supported(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001041#else
1042 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001044#endif
Jerry Yu77f01482022-07-11 07:03:24 +00001045}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001046
Jerry Yu77f01482022-07-11 07:03:24 +00001047MBEDTLS_CHECK_RETURN_CRITICAL
Pengyu Lvbc4aab72023-12-01 15:37:24 +08001048static int ssl_tls13_key_exchange_is_psk_ephemeral_available(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001049{
Jerry Yue5991322022-11-07 14:03:44 +08001050#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Ronald Crone8c162d2024-02-21 10:15:44 +01001051 return mbedtls_ssl_conf_tls13_is_psk_ephemeral_enabled(ssl) &&
Pengyu Lvb2cfafb2023-11-14 13:56:13 +08001052 mbedtls_ssl_tls13_is_psk_ephemeral_supported(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001054#else
1055 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001057#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001058}
1059#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
1060
1061MBEDTLS_CHECK_RETURN_CRITICAL
1062static int ssl_tls13_key_exchange_is_ephemeral_available(mbedtls_ssl_context *ssl)
1063{
1064#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
1065 return mbedtls_ssl_conf_tls13_is_ephemeral_enabled(ssl) &&
1066 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
1067#else
1068 ((void) ssl);
1069 return 0;
1070#endif
1071}
1072
XiaokangQian81802f42022-06-10 13:25:22 +00001073#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001074 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001075
1076#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001077static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001078{
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001080 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001082 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001084 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001086 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001088 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001090 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001092 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001094 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001096 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001098 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001100 }
1101}
1102#endif /* MBEDTLS_USE_PSA_CRYPTO */
1103
XiaokangQian23c5be62022-06-07 02:04:34 +00001104/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001105 * Pick best ( private key, certificate chain ) pair based on the signature
1106 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001107 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001108MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001109static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001110{
XiaokangQianfb665a82022-06-15 03:57:21 +00001111 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001112 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001113
1114#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001116 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001118#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001120
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 if (key_cert_list == NULL) {
1122 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1123 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001124 }
1125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1127 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001128 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001130
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001132 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001134
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 for (key_cert = key_cert_list; key_cert != NULL;
1136 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001137#if defined(MBEDTLS_USE_PSA_CRYPTO)
1138 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1139#endif /* MBEDTLS_USE_PSA_CRYPTO */
1140
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1142 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001143
1144 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 * This avoids sending the client a cert it'll reject based on
1146 * keyUsage or other extensions.
1147 */
1148 if (mbedtls_x509_crt_check_key_usage(
1149 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001150 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001151 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1153 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1154 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001155 continue;
1156 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001157
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 MBEDTLS_SSL_DEBUG_MSG(3,
1159 ("ssl_tls13_pick_key_cert:"
1160 "check signature algorithm %s [%04x]",
1161 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1162 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001163#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001165#endif /* MBEDTLS_USE_PSA_CRYPTO */
1166
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1168 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001169#if defined(MBEDTLS_USE_PSA_CRYPTO)
1170 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1172 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001173#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001175 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 MBEDTLS_SSL_DEBUG_MSG(3,
1177 ("ssl_tls13_pick_key_cert:"
1178 "selected signature algorithm"
1179 " %s [%04x]",
1180 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1181 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001182 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 3, "selected certificate (chain)",
1184 ssl->handshake->key_cert->cert);
1185 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001186 }
XiaokangQian81802f42022-06-10 13:25:22 +00001187 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001188 }
1189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1191 "no suitable certificate found"));
1192 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001193}
XiaokangQian81802f42022-06-10 13:25:22 +00001194#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001195 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001196
XiaokangQian4080a7f2022-04-11 09:55:18 +00001197/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001198 *
1199 * STATE HANDLING: ClientHello
1200 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001201 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001202 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001203 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001204 *
1205 * In this case, the server progresses to sending its ServerHello.
1206 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001207 * 2) The ClientHello was well-formed but didn't match the server's
1208 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001209 *
1210 * For example, the client might not have offered a key share which
1211 * the server supports, or the server might require a cookie.
1212 *
1213 * In this case, the server sends a HelloRetryRequest.
1214 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001215 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001216 *
1217 * In this case, we abort the handshake.
1218 *
1219 */
1220
1221/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001222 * Structure of this message:
1223 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001224 * uint16 ProtocolVersion;
1225 * opaque Random[32];
1226 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001227 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001228 * struct {
1229 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1230 * Random random;
1231 * opaque legacy_session_id<0..32>;
1232 * CipherSuite cipher_suites<2..2^16-2>;
1233 * opaque legacy_compression_methods<1..2^8-1>;
1234 * Extension extensions<8..2^16-1>;
1235 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001236 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001237
1238#define SSL_CLIENT_HELLO_OK 0
1239#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001240#define SSL_CLIENT_HELLO_TLS1_2 2
XiaokangQianed582dd2022-04-13 08:21:05 +00001241
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001242MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001243static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1244 const unsigned char *buf,
1245 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001246{
XiaokangQianb67384d2022-04-19 00:02:38 +00001247 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1248 const unsigned char *p = buf;
Ronald Crond540d992023-03-07 09:41:48 +01001249 const unsigned char *random;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001250 size_t legacy_session_id_len;
Ronald Croncada4102023-03-07 09:51:39 +01001251 const unsigned char *legacy_session_id;
XiaokangQian318dc762022-04-20 09:43:51 +00001252 size_t cipher_suites_len;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001253 const unsigned char *cipher_suites;
XiaokangQian060d8672022-04-21 09:24:56 +00001254 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001255 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001256 const unsigned char *extensions_end;
Ronald Croneff56732023-04-03 17:36:31 +02001257 const unsigned char *supported_versions_data;
1258 const unsigned char *supported_versions_data_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001259 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001260 int hrr_required = 0;
Ronald Cron8a74f072023-06-14 17:59:29 +02001261 int no_usable_share_for_key_agreement = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001262
Ronald Cron41a443a2022-10-04 16:38:25 +02001263#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cron79cdd412024-02-20 17:19:28 +01001264 int got_psk = 0;
1265 struct psk_attributes psk = PSK_ATTRIBUTES_INIT;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001266 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001267 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001268#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001269
XiaokangQian7807f9f2022-02-15 10:04:37 +00001270 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001271 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001272 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001273 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001274 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001275 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001276 * .. . .. ciphersuite list length ( 2 bytes )
1277 * .. . .. ciphersuite list
1278 * .. . .. compression alg. list length ( 1 byte )
1279 * .. . .. compression alg. list
1280 * .. . .. extensions length ( 2 bytes, optional )
1281 * .. . .. extensions ( optional )
1282 */
1283
XiaokangQianb67384d2022-04-19 00:02:38 +00001284 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001285 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001286 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1287 * read at least up to session id length without worrying.
1288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001290
1291 /* ...
1292 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1293 * ...
1294 * with ProtocolVersion defined as:
1295 * uint16 ProtocolVersion;
1296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001297 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1298 MBEDTLS_SSL_VERSION_TLS1_2) {
1299 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1300 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1301 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1302 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001303 }
1304 p += 2;
1305
Jerry Yuc1be19f2022-04-23 16:11:39 +08001306 /* ...
1307 * Random random;
1308 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001309 * with Random defined as:
1310 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001311 */
Ronald Crond540d992023-03-07 09:41:48 +01001312 random = p;
XiaokangQian08037552022-04-20 07:16:41 +00001313 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001314
Jerry Yuc1be19f2022-04-23 16:11:39 +08001315 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001316 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001317 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001318 */
Ronald Croncada4102023-03-07 09:51:39 +01001319 legacy_session_id_len = *(p++);
1320 legacy_session_id = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001321
XiaokangQianb67384d2022-04-19 00:02:38 +00001322 /*
1323 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001324 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001325 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001326 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001327 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001328
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001329 /* ...
1330 * CipherSuite cipher_suites<2..2^16-2>;
1331 * ...
1332 * with CipherSuite defined as:
1333 * uint8 CipherSuite[2];
1334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001336 p += 2;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001337 cipher_suites = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001338
Ronald Cronfc7ae872023-02-16 15:32:19 +01001339 /*
1340 * The length of the ciphersuite list has to be even.
1341 */
1342 if (cipher_suites_len & 1) {
1343 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1344 MBEDTLS_ERR_SSL_DECODE_ERROR);
1345 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1346 }
1347
XiaokangQianb67384d2022-04-19 00:02:38 +00001348 /* Check we have enough data for the ciphersuite list, the legacy
1349 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001350 *
1351 * cipher_suites cipher_suites_len bytes
1352 * legacy_compression_methods 2 bytes
1353 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
Ronald Cron8c527d02023-03-07 15:47:47 +01001356 p += cipher_suites_len;
1357 cipher_suites_end = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001358
1359 /*
Ronald Cron8c527d02023-03-07 15:47:47 +01001360 * Search for the supported versions extension and parse it to determine
1361 * if the client supports TLS 1.3.
1362 */
1363 ret = mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1364 ssl, p + 2, end,
Ronald Croneff56732023-04-03 17:36:31 +02001365 &supported_versions_data, &supported_versions_data_end);
Ronald Cron8c527d02023-03-07 15:47:47 +01001366 if (ret < 0) {
1367 MBEDTLS_SSL_DEBUG_RET(1,
1368 ("mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts"), ret);
1369 return ret;
1370 }
1371
1372 if (ret == 0) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001373 return SSL_CLIENT_HELLO_TLS1_2;
Ronald Cron8c527d02023-03-07 15:47:47 +01001374 }
1375
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001376 if (ret == 1) {
1377 ret = ssl_tls13_parse_supported_versions_ext(ssl,
Ronald Croneff56732023-04-03 17:36:31 +02001378 supported_versions_data,
1379 supported_versions_data_end);
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001380 if (ret < 0) {
1381 MBEDTLS_SSL_DEBUG_RET(1,
1382 ("ssl_tls13_parse_supported_versions_ext"), ret);
1383 return ret;
1384 }
1385
Ronald Cronb828c7d2023-04-03 16:37:22 +02001386 /*
1387 * The supported versions extension was parsed successfully as the
1388 * value returned by ssl_tls13_parse_supported_versions_ext() is
1389 * positive. The return value is then equal to
1390 * MBEDTLS_SSL_VERSION_TLS1_2 or MBEDTLS_SSL_VERSION_TLS1_3, defining
1391 * the TLS version to negotiate.
1392 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001393 if (MBEDTLS_SSL_VERSION_TLS1_2 == ret) {
1394 return SSL_CLIENT_HELLO_TLS1_2;
1395 }
Ronald Cron8c527d02023-03-07 15:47:47 +01001396 }
1397
1398 /*
1399 * We negotiate TLS 1.3.
Ronald Cron64582392023-03-07 09:21:40 +01001400 */
1401 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Ronald Cron64582392023-03-07 09:21:40 +01001402 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1403 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Ronald Cron64582392023-03-07 09:21:40 +01001404
1405 /*
Ronald Crondad02b22023-04-06 09:57:52 +02001406 * We are negotiating the version 1.3 of the protocol. Do what we have
Ronald Croncada4102023-03-07 09:51:39 +01001407 * postponed: copy of the client random bytes, copy of the legacy session
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001408 * identifier and selection of the TLS 1.3 cipher suite.
Ronald Crond540d992023-03-07 09:41:48 +01001409 */
1410 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1411 random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1412 memcpy(&handshake->randbytes[0], random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1413
Ronald Croncada4102023-03-07 09:51:39 +01001414 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1415 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1416 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1417 }
1418 ssl->session_negotiate->id_len = legacy_session_id_len;
1419 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1420 legacy_session_id, legacy_session_id_len);
1421 memcpy(&ssl->session_negotiate->id[0],
1422 legacy_session_id, legacy_session_id_len);
1423
Ronald Crond540d992023-03-07 09:41:48 +01001424 /*
Jerry Yu5725f1c2022-08-21 17:27:16 +08001425 * Search for a matching ciphersuite
1426 */
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001427 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, list of cipher suites",
1428 cipher_suites, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001429
Ronald Cron89089cc2024-02-14 18:18:08 +01001430 ssl_tls13_select_ciphersuite(ssl, cipher_suites, cipher_suites_end,
1431 0, PSA_ALG_NONE, &handshake->ciphersuite_info);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001432
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 if (handshake->ciphersuite_info == NULL) {
1434 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1435 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1436 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001437 }
Ronald Cron89089cc2024-02-14 18:18:08 +01001438 ssl->session_negotiate->ciphersuite = handshake->ciphersuite_info->id;
1439
1440 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1441 ((unsigned) handshake->ciphersuite_info->id),
1442 handshake->ciphersuite_info->name));
Jerry Yuc1be19f2022-04-23 16:11:39 +08001443
XiaokangQian4080a7f2022-04-11 09:55:18 +00001444 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001445 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001446 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001447 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1449 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1450 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1451 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1452 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001453 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001454 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001455
Jerry Yuc1be19f2022-04-23 16:11:39 +08001456 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001457 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001458 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001459 * with Extension defined as:
1460 * struct {
1461 * ExtensionType extension_type;
1462 * opaque extension_data<0..2^16-1>;
1463 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001466 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001468 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001469
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
Jerry Yu63a459c2022-10-31 13:38:40 +08001471 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001472
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001474 unsigned int extension_type;
1475 size_t extension_data_len;
1476 const unsigned char *extension_data_end;
Jerry Yu263dbf72022-10-26 10:51:27 +08001477 uint32_t allowed_exts = MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH;
1478
Ronald Cron5fbd2702024-02-14 10:03:36 +01001479 if (ssl->handshake->hello_retry_request_flag) {
Jerry Yu263dbf72022-10-26 10:51:27 +08001480 /* Do not accept early data extension in 2nd ClientHello */
1481 allowed_exts &= ~MBEDTLS_SSL_EXT_MASK(EARLY_DATA);
1482 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001483
Jerry Yu0c354a22022-08-29 15:25:36 +08001484 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001485 *
1486 * The "pre_shared_key" extension MUST be the last extension in the
1487 * ClientHello (this facilitates implementation as described below).
1488 * Servers MUST check that it is the last extension and otherwise fail
1489 * the handshake with an "illegal_parameter" alert.
1490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001491 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001492 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001494 MBEDTLS_SSL_PEND_FATAL_ALERT(
1495 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1497 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001498 }
1499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1501 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1502 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001503 p += 4;
1504
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001506 extension_data_end = p + extension_data_len;
1507
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001508 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
Jerry Yu263dbf72022-10-26 10:51:27 +08001510 allowed_exts);
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 if (ret != 0) {
1512 return ret;
1513 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001514
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001516#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1517 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1519 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1520 extension_data_end);
1521 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001522 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 1, "mbedtls_ssl_parse_servername_ext", ret);
1524 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001525 }
XiaokangQian40a35232022-05-07 09:02:40 +00001526 break;
1527#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1528
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001529#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001530 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001532
1533 /* Supported Groups Extension
1534 *
1535 * When sent by the client, the "supported_groups" extension
1536 * indicates the named groups which the client supports,
1537 * ordered from most preferred to least preferred.
1538 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001539 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 ssl, p, extension_data_end);
1541 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001542 MBEDTLS_SSL_DEBUG_RET(
Xiaokang Qian8bce0e62023-04-04 10:15:48 +00001543 1, "ssl_tls13_parse_supported_groups_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001545 }
1546
XiaokangQian7807f9f2022-02-15 10:04:37 +00001547 break;
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001548#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH*/
XiaokangQian7807f9f2022-02-15 10:04:37 +00001549
Valerio Settic9ae8622023-07-25 11:23:50 +02001550#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001551 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001553
1554 /*
1555 * Key Share Extension
1556 *
1557 * When sent by the client, the "key_share" extension
1558 * contains the endpoint's cryptographic parameters for
1559 * ECDHE/DHE key establishment methods.
1560 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001561 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 ssl, p, extension_data_end);
1563 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
Ronald Cron8a74f072023-06-14 17:59:29 +02001564 MBEDTLS_SSL_DEBUG_MSG(2, ("No usable share for key agreement."));
1565 no_usable_share_for_key_agreement = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001566 }
1567
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001569 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 1, "ssl_tls13_parse_key_shares_ext", ret);
1571 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001572 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001573
XiaokangQian7807f9f2022-02-15 10:04:37 +00001574 break;
Valerio Settic9ae8622023-07-25 11:23:50 +02001575#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001576
1577 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Ronald Cron8c527d02023-03-07 15:47:47 +01001578 /* Already parsed */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001579 break;
1580
Ronald Cron41a443a2022-10-04 16:38:25 +02001581#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001582 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001583 MBEDTLS_SSL_DEBUG_MSG(
1584 3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001585
1586 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 ssl, p, extension_data_end);
1588 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001589 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1591 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001592 }
1593
Jerry Yue19e3b92022-07-08 12:04:51 +00001594 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001595#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001596
Jerry Yu1c105562022-07-10 06:32:38 +00001597 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1599 if ((handshake->received_extensions &
1600 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001601 MBEDTLS_SSL_PEND_FATAL_ALERT(
1602 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1604 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001605 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001606#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001607 /* Delay processing of the PSK identity once we have
1608 * found out which algorithms to use. We keep a pointer
1609 * to the buffer and the size for later processing.
1610 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001611 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001612 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001613#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001614 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001615
XiaokangQianacb39922022-06-17 10:18:48 +00001616#if defined(MBEDTLS_SSL_ALPN)
1617 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001618 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001619
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1621 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001622 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1624 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001625 }
XiaokangQianacb39922022-06-17 10:18:48 +00001626 break;
1627#endif /* MBEDTLS_SSL_ALPN */
1628
Ronald Cron928cbd32022-10-04 16:14:26 +02001629#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001630 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001632
Gabor Mezei078e8032022-04-27 21:17:56 +02001633 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 ssl, p, extension_data_end);
1635 if (ret != 0) {
Xiaokang Qian49f39c12023-04-06 02:31:02 +00001636 MBEDTLS_SSL_DEBUG_RET(
1637 1, "mbedtls_ssl_parse_sig_alg_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001638 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001639 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001640 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001641#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001642
Jan Bruckner151f6422023-02-10 12:45:19 +01001643#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1644 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
1645 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
1646
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001647 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
1648 ssl, p, extension_data_end);
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001649 if (ret != 0) {
1650 MBEDTLS_SSL_DEBUG_RET(
1651 1, ("mbedtls_ssl_tls13_parse_record_size_limit_ext"), ret);
1652 return ret;
1653 }
Jan Bruckner151f6422023-02-10 12:45:19 +01001654 break;
1655#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1656
XiaokangQian7807f9f2022-02-15 10:04:37 +00001657 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001658 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001659 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001661 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001662 }
1663
1664 p += extension_data_len;
1665 }
1666
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1668 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001669
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001670 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1671 MBEDTLS_SSL_HS_CLIENT_HELLO,
1672 p - buf);
1673 if (0 != ret) {
1674 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1675 return ret;
1676 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001677
Ronald Cron41a443a2022-10-04 16:38:25 +02001678#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001679 /* Update checksum with either
1680 * - The entire content of the CH message, if no PSK extension is present
1681 * - The content up to but excluding the PSK extension, if present.
Ronald Cron7cab4f82024-03-07 15:09:09 +01001682 * Always parse the pre-shared-key extension when present in the
Ronald Cron12e72f12024-02-14 15:49:38 +01001683 * ClientHello even if some pre-requisites for PSK key exchange modes are
1684 * not met. That way we always validate the syntax of the extension.
XiaokangQian7807f9f2022-02-15 10:04:37 +00001685 */
Ronald Cron12e72f12024-02-14 15:49:38 +01001686 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001687 ret = handshake->update_checksum(ssl, buf,
1688 pre_shared_key_ext - buf);
1689 if (0 != ret) {
1690 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1691 return ret;
1692 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1694 pre_shared_key_ext,
1695 pre_shared_key_ext_end,
1696 cipher_suites,
Ronald Cron79cdd412024-02-20 17:19:28 +01001697 cipher_suites_end,
1698 &psk);
1699 if (ret == 0) {
1700 got_psk = 1;
1701 } else if (ret != MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001702 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1704 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001705 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001707#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001708 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001709 ret = handshake->update_checksum(ssl, buf, p - buf);
1710 if (0 != ret) {
1711 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1712 return ret;
1713 }
Jerry Yu1c105562022-07-10 06:32:38 +00001714 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001715
Ronald Cron79cdd412024-02-20 17:19:28 +01001716 /*
1717 * Determine the key exchange algorithm to use.
1718 * There are three types of key exchanges supported in TLS 1.3:
1719 * - (EC)DH with ECDSA,
1720 * - (EC)DH with PSK,
1721 * - plain PSK.
1722 *
1723 * The PSK-based key exchanges may additionally be used with 0-RTT.
1724 *
1725 * Our built-in order of preference is
1726 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1727 * 2 ) Certificate Mode ( ephemeral )
1728 * 3 ) Plain PSK Mode ( psk )
1729 */
1730#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
1731 if (got_psk && (psk.key_exchange_mode ==
1732 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL)) {
1733 handshake->key_exchange_mode =
1734 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
1735 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1736
1737 } else
1738#endif
1739 if (ssl_tls13_key_exchange_is_ephemeral_available(ssl)) {
1740 handshake->key_exchange_mode =
1741 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
1742 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1743
1744 }
1745#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
1746 else if (got_psk && (psk.key_exchange_mode ==
1747 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK)) {
1748 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
1749 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1750 }
1751#endif
1752 else {
1753 MBEDTLS_SSL_DEBUG_MSG(
1754 1,
1755 ("ClientHello message misses mandatory extensions."));
1756 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1757 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1758 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001760
Ronald Cron3e47eec2024-02-21 10:29:24 +01001761#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cron74a16292024-02-23 17:07:41 +01001762 if (handshake->key_exchange_mode &
1763 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL) {
1764 handshake->ciphersuite_info = psk.ciphersuite_info;
1765 ssl->session_negotiate->ciphersuite = psk.ciphersuite_info->id;
1766
1767 MBEDTLS_SSL_DEBUG_MSG(2, ("Select PSK ciphersuite: %04x - %s",
1768 ((unsigned) psk.ciphersuite_info->id),
1769 psk.ciphersuite_info->name));
1770
1771 if (psk.type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
1772 handshake->resume = 1;
1773 }
Ronald Cron79cdd412024-02-20 17:19:28 +01001774 }
Ronald Cron3e47eec2024-02-21 10:29:24 +01001775#endif
Ronald Cron79cdd412024-02-20 17:19:28 +01001776
1777 if (handshake->key_exchange_mode !=
Ronald Cron8a74f072023-06-14 17:59:29 +02001778 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) {
1779 hrr_required = (no_usable_share_for_key_agreement != 0);
1780 }
1781
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001783
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001785}
1786
Jerry Yuab0da372023-02-08 13:55:24 +08001787#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001788static int ssl_tls13_check_early_data_requirements(mbedtls_ssl_context *ssl)
Jerry Yuab0da372023-02-08 13:55:24 +08001789{
1790 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1791
Jerry Yu985c9672022-12-04 14:06:30 +08001792 if (ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_DISABLED) {
1793 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu985c9672022-12-04 14:06:30 +08001794 1,
Jerry Yu454dda32023-10-31 15:13:54 +08001795 ("EarlyData: rejected, feature disabled in server configuration."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001796 return -1;
Ronald Cron7b6ee942024-01-12 10:29:55 +01001797 }
1798
Jerry Yu454dda32023-10-31 15:13:54 +08001799 if (!handshake->resume) {
1800 /* We currently support early data only in the case of PSKs established
1801 via a NewSessionTicket message thus in the case of a session
1802 resumption. */
Jerry Yu985c9672022-12-04 14:06:30 +08001803 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001804 1, ("EarlyData: rejected, not a session resumption."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001805 return -1;
Jerry Yu985c9672022-12-04 14:06:30 +08001806 }
1807
Jerry Yu82fd6c12023-10-31 16:32:19 +08001808 /* RFC 8446 4.2.10
1809 *
1810 * In order to accept early data, the server MUST have accepted a PSK cipher
1811 * suite and selected the first key offered in the client's "pre_shared_key"
1812 * extension. In addition, it MUST verify that the following values are the
1813 * same as those associated with the selected PSK:
1814 * - The TLS version number
1815 * - The selected cipher suite
1816 * - The selected ALPN [RFC7301] protocol, if any
1817 *
1818 * NOTE:
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001819 * - The TLS version number is checked in
1820 * ssl_tls13_offered_psks_check_identity_match_ticket().
1821 * - ALPN is not checked for the time being (TODO).
Jerry Yu82fd6c12023-10-31 16:32:19 +08001822 */
1823
1824 if (handshake->selected_identity != 0) {
1825 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001826 1, ("EarlyData: rejected, the selected key in "
1827 "`pre_shared_key` is not the first one."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001828 return -1;
Jerry Yu82fd6c12023-10-31 16:32:19 +08001829 }
1830
1831 if (handshake->ciphersuite_info->id !=
1832 ssl->session_negotiate->ciphersuite) {
1833 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001834 1, ("EarlyData: rejected, the selected ciphersuite is not the one "
1835 "of the selected pre-shared key."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001836 return -1;
Jerry Yu82fd6c12023-10-31 16:32:19 +08001837
1838 }
Jerry Yu985c9672022-12-04 14:06:30 +08001839
Pengyu Lv94a42cc2023-12-06 10:04:17 +08001840 if (!mbedtls_ssl_tls13_session_ticket_allow_early_data(ssl->session_negotiate)) {
Jerry Yufceddb32022-12-12 15:30:34 +08001841 MBEDTLS_SSL_DEBUG_MSG(
1842 1,
Jerry Yuea96ac32023-11-21 17:06:36 +08001843 ("EarlyData: rejected, early_data not allowed in ticket "
1844 "permission bits."));
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001845 return -1;
Jerry Yufceddb32022-12-12 15:30:34 +08001846 }
Jerry Yu985c9672022-12-04 14:06:30 +08001847
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001848 return 0;
Jerry Yuab0da372023-02-08 13:55:24 +08001849}
1850#endif /* MBEDTLS_SSL_EARLY_DATA */
1851
XiaokangQian75fe8c72022-06-15 09:42:45 +00001852/* Update the handshake state machine */
1853
Ronald Cronce7d76e2022-07-08 18:56:49 +02001854MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b6ee942024-01-12 10:29:55 +01001855static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl,
1856 int hrr_required)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001857{
1858 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1859
XiaokangQian7807f9f2022-02-15 10:04:37 +00001860 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001861 * Server certificate selection
1862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1864 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1865 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001866 }
1867#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1868 ssl->handshake->sni_name = NULL;
1869 ssl->handshake->sni_name_len = 0;
1870#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1873 if (ret != 0) {
1874 MBEDTLS_SSL_DEBUG_RET(1,
1875 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1876 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001877 }
1878
Jerry Yuab0da372023-02-08 13:55:24 +08001879#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001880 if (ssl->handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) {
Ronald Cron31e2d832024-02-05 16:45:57 +01001881 ssl->handshake->early_data_accepted =
1882 (!hrr_required) && (ssl_tls13_check_early_data_requirements(ssl) == 0);
Jerry Yu4e9b70e2022-12-04 14:08:02 +08001883
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001884 if (ssl->handshake->early_data_accepted) {
1885 ret = mbedtls_ssl_tls13_compute_early_transform(ssl);
1886 if (ret != 0) {
1887 MBEDTLS_SSL_DEBUG_RET(
1888 1, "mbedtls_ssl_tls13_compute_early_transform", ret);
1889 return ret;
1890 }
1891 } else {
1892 ssl->discard_early_data_record =
1893 hrr_required ?
1894 MBEDTLS_SSL_EARLY_DATA_DISCARD :
1895 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD;
Jerry Yu4e9b70e2022-12-04 14:08:02 +08001896 }
1897 }
Ronald Cron7b6ee942024-01-12 10:29:55 +01001898#else
1899 ((void) hrr_required);
Jerry Yuab0da372023-02-08 13:55:24 +08001900#endif /* MBEDTLS_SSL_EARLY_DATA */
1901
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001903}
1904
1905/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001906 * Main entry point from the state machine; orchestrates the otherfunctions.
1907 */
1908
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001909MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001910static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001911{
1912
XiaokangQian08037552022-04-20 07:16:41 +00001913 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001915 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001916 int parse_client_hello_ret;
1917
Gilles Peskine449bd832023-01-11 14:50:10 +01001918 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1921 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1922 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001923
Gilles Peskine449bd832023-01-11 14:50:10 +01001924 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1925 buf + buflen));
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001926 parse_client_hello_ret = ret; /* Store positive return value of
1927 * parse_client_hello,
1928 * as negative error codes are handled
Jerry Yuf41553b2022-05-09 22:20:30 +08001929 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001930
Ronald Cronb828c7d2023-04-03 16:37:22 +02001931 /*
Yanray Wang90acdc62023-12-08 10:29:42 +08001932 * Version 1.2 of the protocol has to be used for the handshake.
1933 * If TLS 1.2 is not supported, abort the handshake. Otherwise, set the
Ronald Cronb828c7d2023-04-03 16:37:22 +02001934 * ssl->keep_current_message flag for the ClientHello to be kept and parsed
1935 * as a TLS 1.2 ClientHello. We also change ssl->tls_version to
1936 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1937 * will dispatch to the TLS 1.2 state machine.
1938 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001939 if (SSL_CLIENT_HELLO_TLS1_2 == parse_client_hello_ret) {
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001940 /* Check if server supports TLS 1.2 */
Yanray Wang408ba6f2023-12-08 10:18:03 +08001941 if (!mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001942 MBEDTLS_SSL_DEBUG_MSG(
Yanray Wang177e49a2023-12-08 10:51:04 +08001943 1, ("TLS 1.2 not supported."));
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001944 MBEDTLS_SSL_PEND_FATAL_ALERT(
Yanray Wang2bef9172023-12-08 10:21:53 +08001945 MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1946 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1947 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
Yanray Wangfb0f47b2023-12-04 15:27:28 +08001948 }
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001949 ssl->keep_current_message = 1;
1950 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
1951 return 0;
1952 }
1953
Ronald Cron7b6ee942024-01-12 10:29:55 +01001954 MBEDTLS_SSL_PROC_CHK(
1955 ssl_tls13_postprocess_client_hello(ssl, parse_client_hello_ret ==
1956 SSL_CLIENT_HELLO_HRR_REQUIRED));
Jerry Yu582dd062022-04-22 21:59:01 +08001957
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001958 if (SSL_CLIENT_HELLO_OK == parse_client_hello_ret) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1960 } else {
1961 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1962 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001963
1964cleanup:
1965
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1967 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001968}
1969
1970/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001971 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001972 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001973MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001974static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001975{
Jerry Yu637a3f12022-04-20 21:37:58 +08001976 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1977 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1981 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1982 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1983 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001984 }
1985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1987 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001988
1989#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001990 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001991#endif /* MBEDTLS_HAVE_TIME */
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001994}
1995
Jerry Yu3bf2c642022-03-30 22:02:12 +08001996/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001997 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001998 *
1999 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08002000 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002001 * } SupportedVersions;
2002 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002003MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08002004static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 mbedtls_ssl_context *ssl,
2006 unsigned char *buf,
2007 unsigned char *end,
2008 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002009{
Jerry Yu3bf2c642022-03-30 22:02:12 +08002010 *out_len = 0;
2011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002013
2014 /* Check if we have space to write the extension:
2015 * - extension_type (2 bytes)
2016 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08002017 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002018 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002020
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002022
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002024
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 mbedtls_ssl_write_version(buf + 4,
2026 ssl->conf->transport,
2027 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002028
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
2030 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002031
Jerry Yu349a6132022-04-14 20:52:56 +08002032 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002033
Jerry Yub95dd362022-11-08 21:19:34 +08002034 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08002036
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002038}
2039
Jerry Yud9436a12022-04-20 22:28:09 +08002040
Jerry Yu3bf2c642022-03-30 22:02:12 +08002041
2042/* Generate and export a single key share. For hybrid KEMs, this can
2043 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002044MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002045static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
2046 uint16_t named_group,
2047 unsigned char *buf,
2048 unsigned char *end,
2049 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002050{
2051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08002052
2053 *out_len = 0;
2054
Valerio Settic9ae8622023-07-25 11:23:50 +02002055#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02002056 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +02002057 mbedtls_ssl_tls13_named_group_is_ffdh(named_group)) {
Przemek Stekiel408569f2023-07-06 11:26:44 +02002058 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 ssl, named_group, buf, end, out_len);
2060 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08002061 MBEDTLS_SSL_DEBUG_RET(
Przemek Stekiel408569f2023-07-06 11:26:44 +02002062 1, "mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 ret);
2064 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002065 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 } else
Valerio Settic9ae8622023-07-25 11:23:50 +02002067#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if (0 /* Other kinds of KEMs */) {
2069 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08002070 ((void) ssl);
2071 ((void) named_group);
2072 ((void) buf);
2073 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002074 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2075 }
2076
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002078}
2079
2080/*
2081 * ssl_tls13_write_key_share_ext
2082 *
2083 * Structure of key_share extension in ServerHello:
2084 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08002085 * struct {
2086 * NamedGroup group;
2087 * opaque key_exchange<1..2^16-1>;
2088 * } KeyShareEntry;
2089 * struct {
2090 * KeyShareEntry server_share;
2091 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002092 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002093MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002094static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
2095 unsigned char *buf,
2096 unsigned char *end,
2097 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002098{
Jerry Yu955ddd72022-04-22 22:27:33 +08002099 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002100 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08002101 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002102 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002103 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002104
2105 *out_len = 0;
2106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002108
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
2110 mbedtls_ssl_named_group_to_str(group),
2111 group));
Jerry Yu58af2332022-09-06 11:19:31 +08002112
Jerry Yu3bf2c642022-03-30 22:02:12 +08002113 /* Check if we have space for header and length fields:
2114 * - extension_type (2 bytes)
2115 * - extension_data_length (2 bytes)
2116 * - group (2 bytes)
2117 * - key_exchange_length (2 bytes)
2118 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
2120 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
2121 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002122 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08002123
Jerry Yu3bf2c642022-03-30 22:02:12 +08002124 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
2125 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08002126 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 ssl, group, server_share + 4, end, &key_exchange_length);
2128 if (ret != 0) {
2129 return ret;
2130 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002131 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08002132
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002134
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002136
Jerry Yu57d48412022-04-20 21:50:42 +08002137 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08002138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002140
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002142}
Jerry Yud9436a12022-04-20 22:28:09 +08002143
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002144MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002145static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
2146 unsigned char *buf,
2147 unsigned char *end,
2148 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002149{
2150 uint16_t selected_group = ssl->handshake->hrr_selected_group;
2151 /* key_share Extension
2152 *
2153 * struct {
2154 * select (Handshake.msg_type) {
2155 * ...
2156 * case hello_retry_request:
2157 * NamedGroup selected_group;
2158 * ...
2159 * };
2160 * } KeyShare;
2161 */
2162
2163 *out_len = 0;
2164
Jerry Yub0ac10b2022-05-05 11:10:08 +08002165 /*
2166 * For a pure PSK key exchange, there is no group to agree upon. The purpose
2167 * of the HRR is then to transmit a cookie to force the client to demonstrate
2168 * reachability at their apparent network address (primarily useful for DTLS).
2169 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2171 return 0;
2172 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002173
2174 /* We should only send the key_share extension if the client's initial
2175 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 if (ssl->handshake->offered_group_id != 0) {
2177 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
2178 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002179 }
2180
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (selected_group == 0) {
2182 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
2183 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002184 }
2185
Jerry Yub0ac10b2022-05-05 11:10:08 +08002186 /* Check if we have enough space:
2187 * - extension_type (2 bytes)
2188 * - extension_data_length (2 bytes)
2189 * - selected_group (2 bytes)
2190 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002192
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
2194 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
2195 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002196
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 MBEDTLS_SSL_DEBUG_MSG(3,
2198 ("HRR selected_group: %s (%x)",
2199 mbedtls_ssl_named_group_to_str(selected_group),
2200 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002201
2202 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002207}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002208
2209/*
2210 * Structure of ServerHello message:
2211 *
2212 * struct {
2213 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2214 * Random random;
2215 * opaque legacy_session_id_echo<0..32>;
2216 * CipherSuite cipher_suite;
2217 * uint8 legacy_compression_method = 0;
2218 * Extension extensions<6..2^16-1>;
2219 * } ServerHello;
2220 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002221MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002222static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2223 unsigned char *buf,
2224 unsigned char *end,
2225 size_t *out_len,
2226 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002227{
Jerry Yu955ddd72022-04-22 22:27:33 +08002228 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002229 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002230 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002231 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002232
2233 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002234 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002235
Jerry Yucfc04b32022-04-21 09:31:58 +08002236 /* ...
2237 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2238 * ...
2239 * with ProtocolVersion defined as:
2240 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002241 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2243 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002244 p += 2;
2245
Jerry Yu1c3e6882022-04-20 21:23:40 +08002246 /* ...
2247 * Random random;
2248 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002249 * with Random defined as:
2250 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002251 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2253 if (is_hrr) {
2254 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2255 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2256 } else {
2257 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2258 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002259 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2261 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002262 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2263
Jerry Yucfc04b32022-04-21 09:31:58 +08002264 /* ...
2265 * opaque legacy_session_id_echo<0..32>;
2266 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002267 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2269 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2270 if (ssl->session_negotiate->id_len > 0) {
2271 memcpy(p, &ssl->session_negotiate->id[0],
2272 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002273 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002274
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2276 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002277 }
2278
Jerry Yucfc04b32022-04-21 09:31:58 +08002279 /* ...
2280 * CipherSuite cipher_suite;
2281 * ...
2282 * with CipherSuite defined as:
2283 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002284 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2286 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002287 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 MBEDTLS_SSL_DEBUG_MSG(3,
2289 ("server hello, chosen ciphersuite: %s ( id=%d )",
2290 mbedtls_ssl_get_ciphersuite_name(
2291 ssl->session_negotiate->ciphersuite),
2292 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002293
Jerry Yucfc04b32022-04-21 09:31:58 +08002294 /* ...
2295 * uint8 legacy_compression_method = 0;
2296 * ...
2297 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002299 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002300
Jerry Yucfc04b32022-04-21 09:31:58 +08002301 /* ...
2302 * Extension extensions<6..2^16-1>;
2303 * ...
2304 * struct {
2305 * ExtensionType extension_type; (2 bytes)
2306 * opaque extension_data<0..2^16-1>;
2307 * } Extension;
2308 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002310 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002311 p += 2;
2312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2314 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002315 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2317 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002318 }
2319 p += output_len;
2320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2322 if (is_hrr) {
2323 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2324 } else {
2325 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2326 }
2327 if (ret != 0) {
2328 return ret;
2329 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002330 p += output_len;
2331 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002332
Ronald Cron41a443a2022-10-04 16:38:25 +02002333#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2335 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2336 if (ret != 0) {
2337 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2338 ret);
2339 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002340 }
2341 p += output_len;
2342 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002343#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002344
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002346
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2348 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002349
Jerry Yud9436a12022-04-20 22:28:09 +08002350 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002351
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002353
Jerry Yu7de2ff02022-11-08 21:43:46 +08002354 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002355 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 MBEDTLS_SSL_HS_SERVER_HELLO,
2357 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002358
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002360}
2361
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002362MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002363static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002364{
2365 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2367 if (ret != 0) {
2368 MBEDTLS_SSL_DEBUG_RET(1,
2369 "mbedtls_ssl_tls13_compute_handshake_transform",
2370 ret);
2371 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002372 }
2373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002375}
2376
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002377MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002378static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002379{
Jerry Yu637a3f12022-04-20 21:37:58 +08002380 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002381 unsigned char *buf;
2382 size_t buf_len, msg_len;
2383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002385
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002387
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002388 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2389 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002390
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2392 buf + buf_len,
2393 &msg_len,
2394 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002395
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002396 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002397 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002398
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2400 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002401
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002402 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002403
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002404#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2405 /* The server sends a dummy change_cipher_spec record immediately
2406 * after its first handshake message. This may either be after
2407 * a ServerHello or a HelloRetryRequest.
2408 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002409 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002411#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002413#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002414
Jerry Yuf4b27e42022-03-30 17:32:21 +08002415cleanup:
2416
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2418 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002419}
2420
Jerry Yu23d1a252022-05-12 18:08:59 +08002421
2422/*
2423 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2424 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002425MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002426static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002427{
2428 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5fbd2702024-02-14 10:03:36 +01002429 if (ssl->handshake->hello_retry_request_flag) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2431 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2432 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2433 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002434 }
2435
2436 /*
2437 * Create stateless transcript hash for HRR
2438 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2440 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2441 if (ret != 0) {
2442 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2443 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002444 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002448}
2449
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002450MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002451static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002452{
2453 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2454 unsigned char *buf;
2455 size_t buf_len, msg_len;
2456
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2462 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2463 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2466 buf + buf_len,
2467 &msg_len,
2468 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002469 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002470 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002471
2472
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2474 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002475
Ronald Cron5fbd2702024-02-14 10:03:36 +01002476 ssl->handshake->hello_retry_request_flag = 1;
Jerry Yu23d1a252022-05-12 18:08:59 +08002477
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002478#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2479 /* The server sends a dummy change_cipher_spec record immediately
2480 * after its first handshake message. This may either be after
2481 * a ServerHello or a HelloRetryRequest.
2482 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002483 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002485#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002487#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002488
2489cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2491 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002492}
2493
Jerry Yu5b64ae92022-03-30 17:15:02 +08002494/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002495 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2496 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002497
2498/*
2499 * struct {
2500 * Extension extensions<0..2 ^ 16 - 1>;
2501 * } EncryptedExtensions;
2502 *
2503 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002504MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002505static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2506 unsigned char *buf,
2507 unsigned char *end,
2508 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002509{
XiaokangQianacb39922022-06-17 10:18:48 +00002510 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002511 unsigned char *p = buf;
2512 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002513 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002514 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002515
Jerry Yu4d3841a2022-04-16 12:37:19 +08002516 *out_len = 0;
2517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002519 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002520 p += 2;
2521
Jerry Yu8937eb42022-05-03 12:12:14 +08002522 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002523 ((void) ret);
2524 ((void) output_len);
2525
2526#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2528 if (ret != 0) {
2529 return ret;
2530 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002531 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002532#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002533
Jerry Yu71c14f12022-12-12 11:10:35 +08002534#if defined(MBEDTLS_SSL_EARLY_DATA)
Ronald Cron78a38f62024-02-01 18:30:31 +01002535 if (ssl->handshake->early_data_accepted) {
Jerry Yu52335392023-11-23 18:06:06 +08002536 ret = mbedtls_ssl_tls13_write_early_data_ext(
Jerry Yuc59c5862023-12-05 10:40:49 +08002537 ssl, 0, p, end, &output_len);
Jerry Yu71c14f12022-12-12 11:10:35 +08002538 if (ret != 0) {
2539 return ret;
2540 }
2541 p += output_len;
2542 }
2543#endif /* MBEDTLS_SSL_EARLY_DATA */
2544
Waleed Elmelegy47d29462024-01-03 17:31:52 +00002545#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Waleed Elmelegyfbe42742024-01-05 18:11:10 +00002546 if (ssl->handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(RECORD_SIZE_LIMIT)) {
Waleed Elmelegyd2fc90e2024-01-04 18:04:53 +00002547 ret = mbedtls_ssl_tls13_write_record_size_limit_ext(
2548 ssl, p, end, &output_len);
2549 if (ret != 0) {
2550 return ret;
2551 }
2552 p += output_len;
Waleed Elmelegy47d29462024-01-03 17:31:52 +00002553 }
Waleed Elmelegy47d29462024-01-03 17:31:52 +00002554#endif
2555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 extensions_len = (p - p_extensions_len) - 2;
2557 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002558
2559 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002562
Jerry Yu7de2ff02022-11-08 21:43:46 +08002563 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002567}
2568
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002569MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002570static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002571{
2572 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2573 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002574 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 mbedtls_ssl_set_outbound_transform(ssl,
2577 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002578 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002582
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002583 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2584 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2585 &buf, &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2588 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002589
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002590 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002591 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2592 buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2595 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002596
Ronald Cron928cbd32022-10-04 16:14:26 +02002597#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2599 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2600 } else {
2601 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2602 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002603#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002605#endif
2606
Jerry Yu4d3841a2022-04-16 12:37:19 +08002607cleanup:
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2610 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002611}
2612
Ronald Cron928cbd32022-10-04 16:14:26 +02002613#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002614#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2615#define SSL_CERTIFICATE_REQUEST_SKIP 1
2616/* Coordination:
2617 * Check whether a CertificateRequest message should be written.
2618 * Returns a negative code on failure, or
2619 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2620 * - SSL_CERTIFICATE_REQUEST_SKIP
2621 * indicating if the writing of the CertificateRequest
2622 * should be skipped or not.
2623 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002624MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002625static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002626{
2627 int authmode;
2628
XiaokangQian40a35232022-05-07 09:02:40 +00002629#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002631 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002633#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002634 authmode = ssl->conf->authmode;
2635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002637 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002639 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002640
XiaokangQianc3017f62022-05-13 05:55:41 +00002641 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002642
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002644}
2645
XiaokangQiancec9ae62022-05-06 07:28:50 +00002646/*
2647 * struct {
2648 * opaque certificate_request_context<0..2^8-1>;
2649 * Extension extensions<2..2^16-1>;
2650 * } CertificateRequest;
2651 *
2652 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002653MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002654static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2655 unsigned char *buf,
2656 const unsigned char *end,
2657 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002658{
2659 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2660 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002661 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002662 unsigned char *p_extensions_len;
2663
2664 *out_len = 0;
2665
2666 /* Check if we have enough space:
2667 * - certificate_request_context (1 byte)
2668 * - extensions length (2 bytes)
2669 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002671
2672 /*
2673 * Write certificate_request_context
2674 */
2675 /*
2676 * We use a zero length context for the normal handshake
2677 * messages. For post-authentication handshake messages
2678 * this request context would be set to a non-zero value.
2679 */
2680 *p++ = 0x0;
2681
2682 /*
2683 * Write extensions
2684 */
2685 /* The extensions must contain the signature_algorithms. */
2686 p_extensions_len = p;
2687 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2689 if (ret != 0) {
2690 return ret;
2691 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002692
XiaokangQianec6efb92022-05-06 09:53:10 +00002693 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002695
2696 *out_len = p - buf;
2697
Jerry Yu7de2ff02022-11-08 21:43:46 +08002698 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002702}
2703
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002704MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002705static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002706{
2707 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2708
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002710
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002714 unsigned char *buf;
2715 size_t buf_len, msg_len;
2716
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002717 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2718 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2719 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002720
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2722 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002723
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002724 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002725 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2726 buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002727
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2729 ssl, buf_len, msg_len));
2730 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2731 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002732 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002733 } else {
2734 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002735 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2736 goto cleanup;
2737 }
2738
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002740cleanup:
2741
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2743 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002744}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002745
Jerry Yu4d3841a2022-04-16 12:37:19 +08002746/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002747 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002748 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002749MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002750static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002751{
Jerry Yu5a26f302022-05-10 20:46:40 +08002752 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002753
2754#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2756 mbedtls_ssl_own_cert(ssl) == NULL) {
2757 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2758 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2759 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2760 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002761 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002762#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2765 if (ret != 0) {
2766 return ret;
2767 }
2768 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2769 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002770}
2771
2772/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002773 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002774 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002775MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002776static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002777{
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2779 if (ret != 0) {
2780 return ret;
2781 }
2782 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2783 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002784}
Ronald Cron928cbd32022-10-04 16:14:26 +02002785#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002786
Jerry Yu9b72e392023-12-01 16:27:08 +08002787/*
2788 * RFC 8446 section A.2
2789 *
2790 * | Send ServerHello
2791 * | K_send = handshake
2792 * | Send EncryptedExtensions
2793 * | [Send CertificateRequest]
2794 * Can send | [Send Certificate + CertificateVerify]
2795 * app data | Send Finished
2796 * after --> | K_send = application
2797 * here +--------+--------+
2798 * No 0-RTT | | 0-RTT
2799 * | |
2800 * K_recv = handshake | | K_recv = early data
2801 * [Skip decrypt errors] | +------> WAIT_EOED -+
2802 * | | Recv | | Recv EndOfEarlyData
2803 * | | early data | | K_recv = handshake
2804 * | +------------+ |
2805 * | |
2806 * +> WAIT_FLIGHT2 <--------+
2807 * |
2808 * +--------+--------+
2809 * No auth | | Client auth
2810 * | |
2811 * | v
2812 * | WAIT_CERT
2813 * | Recv | | Recv Certificate
2814 * | empty | v
2815 * | Certificate | WAIT_CV
2816 * | | | Recv
2817 * | v | CertificateVerify
2818 * +-> WAIT_FINISHED <---+
2819 * | Recv Finished
2820 *
2821 *
2822 * The following function handles the state changes after WAIT_FLIGHT2 in the
Jerry Yu3be85072023-12-04 09:58:54 +08002823 * above diagram. We are not going to receive early data related messages
2824 * anymore, prepare to receive the first handshake message of the client
2825 * second flight.
Jerry Yu9b72e392023-12-01 16:27:08 +08002826 */
Jerry Yu3be85072023-12-04 09:58:54 +08002827static void ssl_tls13_prepare_for_handshake_second_flight(
2828 mbedtls_ssl_context *ssl)
Jerry Yu9b72e392023-12-01 16:27:08 +08002829{
Jerry Yu9b72e392023-12-01 16:27:08 +08002830 if (ssl->handshake->certificate_request_sent) {
2831 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2832 } else {
Jerry Yu42020fb2023-12-05 17:35:53 +08002833 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
Jerry Yuebb1b1d2023-12-05 11:02:15 +08002834 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Jerry Yuebb1b1d2023-12-05 11:02:15 +08002835
Jerry Yu9b72e392023-12-01 16:27:08 +08002836 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2837 }
Jerry Yu9b72e392023-12-01 16:27:08 +08002838}
2839
Jerry Yu83da34e2022-04-16 13:59:52 +08002840/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002841 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002842 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002843MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002844static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002845{
Jerry Yud6e253d2022-05-18 13:59:24 +08002846 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2849 if (ret != 0) {
2850 return ret;
2851 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002852
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2854 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002855 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2857 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2858 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002859 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002860
Jerry Yu87b5ed42022-12-12 13:07:07 +08002861#if defined(MBEDTLS_SSL_EARLY_DATA)
Ronald Cron78a38f62024-02-01 18:30:31 +01002862 if (ssl->handshake->early_data_accepted) {
Jerry Yu0af63dc2023-12-01 17:14:51 +08002863 /* See RFC 8446 section A.2 for more information */
Jerry Yu87b5ed42022-12-12 13:07:07 +08002864 MBEDTLS_SSL_DEBUG_MSG(
2865 1, ("Switch to early keys for inbound traffic. "
2866 "( K_recv = early data )"));
2867 mbedtls_ssl_set_inbound_transform(
2868 ssl, ssl->handshake->transform_earlydata);
2869 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
2870 return 0;
2871 }
2872#endif /* MBEDTLS_SSL_EARLY_DATA */
Jerry Yu0af63dc2023-12-01 17:14:51 +08002873 MBEDTLS_SSL_DEBUG_MSG(
2874 1, ("Switch to handshake keys for inbound traffic "
2875 "( K_recv = handshake )"));
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002877
Jerry Yu3be85072023-12-04 09:58:54 +08002878 ssl_tls13_prepare_for_handshake_second_flight(ssl);
Jerry Yu7d8c3fe2022-12-12 12:59:44 +08002879
2880 return 0;
2881}
2882
Jerry Yu87b5ed42022-12-12 13:07:07 +08002883#if defined(MBEDTLS_SSL_EARLY_DATA)
2884/*
Jerry Yu59d420f2023-12-01 16:30:34 +08002885 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
Jerry Yu87b5ed42022-12-12 13:07:07 +08002886 */
Jerry Yu3be85072023-12-04 09:58:54 +08002887#define SSL_GOT_END_OF_EARLY_DATA 0
Jerry Yub55f9eb2023-12-05 10:27:17 +08002888#define SSL_GOT_EARLY_DATA 1
Jerry Yud5c34962023-12-01 16:32:31 +08002889/* Coordination:
Jerry Yu3be85072023-12-04 09:58:54 +08002890 * Deals with the ambiguity of not knowing if the next message is an
2891 * EndOfEarlyData message or an application message containing early data.
Jerry Yud5c34962023-12-01 16:32:31 +08002892 * Returns a negative code on failure, or
Jerry Yu3be85072023-12-04 09:58:54 +08002893 * - SSL_GOT_END_OF_EARLY_DATA
Jerry Yub55f9eb2023-12-05 10:27:17 +08002894 * - SSL_GOT_EARLY_DATA
Jerry Yud5c34962023-12-01 16:32:31 +08002895 * indicating which message is received.
2896 */
2897MBEDTLS_CHECK_RETURN_CRITICAL
2898static int ssl_tls13_end_of_early_data_coordinate(mbedtls_ssl_context *ssl)
2899{
2900 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub4ed4602023-12-01 16:34:00 +08002901
2902 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
2903 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
2904 return ret;
2905 }
2906 ssl->keep_current_message = 1;
2907
2908 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2909 ssl->in_msg[0] == MBEDTLS_SSL_HS_END_OF_EARLY_DATA) {
Jerry Yub55f9eb2023-12-05 10:27:17 +08002910 MBEDTLS_SSL_DEBUG_MSG(3, ("Received an end_of_early_data message."));
Jerry Yu3be85072023-12-04 09:58:54 +08002911 return SSL_GOT_END_OF_EARLY_DATA;
Jerry Yub4ed4602023-12-01 16:34:00 +08002912 }
2913
2914 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Croned7d4bf2024-01-31 07:55:19 +01002915 if (ssl->in_offt == NULL) {
Ronald Cron85718042024-02-22 10:22:09 +01002916 MBEDTLS_SSL_DEBUG_MSG(3, ("Received early data"));
Ronald Croned7d4bf2024-01-31 07:55:19 +01002917 /* Set the reading pointer */
2918 ssl->in_offt = ssl->in_msg;
Ronald Cron85718042024-02-22 10:22:09 +01002919 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, ssl->in_msglen);
2920 if (ret != 0) {
2921 return ret;
2922 }
Ronald Croned7d4bf2024-01-31 07:55:19 +01002923 }
Jerry Yub55f9eb2023-12-05 10:27:17 +08002924 return SSL_GOT_EARLY_DATA;
Jerry Yub4ed4602023-12-01 16:34:00 +08002925 }
2926
Jerry Yu7bb40a32023-12-04 10:04:15 +08002927 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
2928 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
Jerry Yub4ed4602023-12-01 16:34:00 +08002929 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud5c34962023-12-01 16:32:31 +08002930}
2931
2932MBEDTLS_CHECK_RETURN_CRITICAL
2933static int ssl_tls13_parse_end_of_early_data(mbedtls_ssl_context *ssl,
2934 const unsigned char *buf,
2935 const unsigned char *end)
2936{
Jerry Yu75c9ab72023-12-01 16:41:40 +08002937 /* RFC 8446 section 4.5
2938 *
2939 * struct {} EndOfEarlyData;
2940 */
Jerry Yufbf03992023-12-04 10:00:37 +08002941 if (buf != end) {
2942 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2943 MBEDTLS_ERR_SSL_DECODE_ERROR);
2944 return MBEDTLS_ERR_SSL_DECODE_ERROR;
2945 }
2946 return 0;
Jerry Yud5c34962023-12-01 16:32:31 +08002947}
2948
Jerry Yud5c34962023-12-01 16:32:31 +08002949/*
2950 * RFC 8446 section A.2
2951 *
2952 * | Send ServerHello
2953 * | K_send = handshake
2954 * | Send EncryptedExtensions
2955 * | [Send CertificateRequest]
2956 * Can send | [Send Certificate + CertificateVerify]
2957 * app data | Send Finished
2958 * after --> | K_send = application
2959 * here +--------+--------+
2960 * No 0-RTT | | 0-RTT
2961 * | |
2962 * K_recv = handshake | | K_recv = early data
2963 * [Skip decrypt errors] | +------> WAIT_EOED -+
2964 * | | Recv | | Recv EndOfEarlyData
2965 * | | early data | | K_recv = handshake
2966 * | +------------+ |
2967 * | |
2968 * +> WAIT_FLIGHT2 <--------+
2969 * |
2970 * +--------+--------+
2971 * No auth | | Client auth
2972 * | |
2973 * | v
2974 * | WAIT_CERT
2975 * | Recv | | Recv Certificate
2976 * | empty | v
2977 * | Certificate | WAIT_CV
2978 * | | | Recv
2979 * | v | CertificateVerify
2980 * +-> WAIT_FINISHED <---+
2981 * | Recv Finished
2982 *
2983 * The function handles actions and state changes from 0-RTT to WAIT_FLIGHT2 in
2984 * the above diagram.
2985 */
Jerry Yu87b5ed42022-12-12 13:07:07 +08002986MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu59d420f2023-12-01 16:30:34 +08002987static int ssl_tls13_process_end_of_early_data(mbedtls_ssl_context *ssl)
Jerry Yu87b5ed42022-12-12 13:07:07 +08002988{
2989 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud5c34962023-12-01 16:32:31 +08002990
2991 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_tls13_process_end_of_early_data"));
2992
2993 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_end_of_early_data_coordinate(ssl));
2994
Jerry Yu3be85072023-12-04 09:58:54 +08002995 if (ret == SSL_GOT_END_OF_EARLY_DATA) {
Jerry Yud5c34962023-12-01 16:32:31 +08002996 unsigned char *buf;
2997 size_t buf_len;
2998
2999 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
3000 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
3001 &buf, &buf_len));
3002
3003 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_end_of_early_data(
3004 ssl, buf, buf + buf_len));
3005
Jerry Yue9655122023-12-01 16:44:40 +08003006 MBEDTLS_SSL_DEBUG_MSG(
3007 1, ("Switch to handshake keys for inbound traffic"
3008 "( K_recv = handshake )"));
3009 mbedtls_ssl_set_inbound_transform(
3010 ssl, ssl->handshake->transform_handshake);
3011
Jerry Yud5c34962023-12-01 16:32:31 +08003012 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
3013 ssl, MBEDTLS_SSL_HS_END_OF_EARLY_DATA,
3014 buf, buf_len));
Jerry Yue9655122023-12-01 16:44:40 +08003015
Jerry Yu3be85072023-12-04 09:58:54 +08003016 ssl_tls13_prepare_for_handshake_second_flight(ssl);
Jerry Yud5c34962023-12-01 16:32:31 +08003017
Jerry Yub55f9eb2023-12-05 10:27:17 +08003018 } else if (ret == SSL_GOT_EARLY_DATA) {
Jerry Yud9ca3542023-12-06 17:23:52 +08003019 ret = MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA;
3020 goto cleanup;
Jerry Yud5c34962023-12-01 16:32:31 +08003021 } else {
3022 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
3023 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3024 goto cleanup;
3025 }
3026
Jerry Yud5c34962023-12-01 16:32:31 +08003027cleanup:
3028 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_tls13_process_end_of_early_data"));
Jerry Yu87b5ed42022-12-12 13:07:07 +08003029 return ret;
3030}
3031#endif /* MBEDTLS_SSL_EARLY_DATA */
3032
Jerry Yu69dd8d42022-04-16 12:51:26 +08003033/*
Jerry Yud6e253d2022-05-18 13:59:24 +08003034 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08003035 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003037static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08003038{
Jerry Yud6e253d2022-05-18 13:59:24 +08003039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
3042 if (ret != 0) {
3043 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08003044 }
3045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
3047 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003048 MBEDTLS_SSL_DEBUG_RET(
3049 1, "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 }
3051
3052 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
3053 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08003054}
3055
3056/*
Jerry Yud6e253d2022-05-18 13:59:24 +08003057 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08003058 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003059MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003060static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08003061{
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08003063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00003065
Pengyu Lv3643fdb2023-01-12 16:46:28 +08003066#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
3067 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08003068/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
3069 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
3070 * expected to be resolved with issue#6395.
3071 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08003072 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lvb2cfafb2023-11-14 13:56:13 +08003073 if (mbedtls_ssl_tls13_is_some_psk_supported(ssl)) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003074 mbedtls_ssl_handshake_set_state(
3075 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08003076 } else
Jerry Yufca4d572022-07-21 10:37:48 +08003077#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08003078 {
3079 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3080 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08003082}
3083
3084/*
Jerry Yua8d3c502022-10-30 14:51:23 +08003085 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003086 */
3087#define SSL_NEW_SESSION_TICKET_SKIP 0
3088#define SSL_NEW_SESSION_TICKET_WRITE 1
3089MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003090static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00003091{
3092 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 if (ssl->conf->f_ticket_write == NULL) {
3094 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
3095 " callback is not set"));
3096 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08003097 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 if (ssl->conf->new_session_tickets_count == 0) {
3099 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
3100 " configured count is zero"));
3101 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08003102 }
3103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 if (ssl->handshake->new_session_tickets_count == 0) {
3105 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
3106 "been sent."));
3107 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00003108 }
3109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00003111}
3112
3113#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3114MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003115static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
3116 unsigned char *ticket_nonce,
3117 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00003118{
3119 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3120 mbedtls_ssl_session *session = ssl->session;
3121 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
3122 psa_algorithm_t psa_hash_alg;
3123 int hash_length;
3124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00003126
Pengyu Lv9f926952022-11-17 15:22:33 +08003127 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003128 mbedtls_ssl_tls13_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08003129 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08003130#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003131 mbedtls_ssl_tls13_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08003132 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08003133#endif
Jerry Yu95648b02023-12-06 15:03:34 +08003134
3135#if defined(MBEDTLS_SSL_EARLY_DATA)
3136 if (ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_ENABLED &&
3137 ssl->conf->max_early_data_size > 0) {
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003138 mbedtls_ssl_tls13_session_set_ticket_flags(
Jerry Yu95648b02023-12-06 15:03:34 +08003139 session, MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA);
Ronald Cronc2865192024-02-07 14:01:03 +01003140 session->max_early_data_size = ssl->conf->max_early_data_size;
Jerry Yu95648b02023-12-06 15:03:34 +08003141 }
3142#endif /* MBEDTLS_SSL_EARLY_DATA */
3143
Pengyu Lv4938a562023-01-16 11:28:49 +08003144 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08003145
Jerry Yue67bef42022-07-07 07:29:42 +00003146 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
3148 (unsigned char *) &session->ticket_age_add,
3149 sizeof(session->ticket_age_add)) != 0)) {
3150 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
3151 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003152 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
3154 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00003155
3156 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01003157 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
3158 if (ret != 0) {
3159 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
3160 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003161 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
3163 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00003164
3165 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
Dave Rodgman2eab4622023-10-05 13:30:37 +01003167 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
3169 if (hash_length == -1 ||
3170 (size_t) hash_length > sizeof(session->resumption_key)) {
3171 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08003172 }
3173
Jerry Yue67bef42022-07-07 07:29:42 +00003174 /* In this code the psk key length equals the length of the hash */
3175 session->resumption_key_len = hash_length;
3176 session->ciphersuite = ciphersuite_info->id;
3177
3178 /* Compute resumption key
3179 *
3180 * HKDF-Expand-Label( resumption_master_secret,
3181 * "resumption", ticket_nonce, Hash.length )
3182 */
3183 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 psa_hash_alg,
3185 session->app_secrets.resumption_master_secret,
3186 hash_length,
3187 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
3188 ticket_nonce,
3189 ticket_nonce_size,
3190 session->resumption_key,
3191 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00003192
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 if (ret != 0) {
3194 MBEDTLS_SSL_DEBUG_RET(2,
3195 "Creating the ticket-resumed PSK failed",
3196 ret);
3197 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003198 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
3200 session->resumption_key,
3201 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00003202
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
3204 session->app_secrets.resumption_master_secret,
3205 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00003206
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00003208}
3209
3210/* This function creates a NewSessionTicket message in the following format:
3211 *
3212 * struct {
3213 * uint32 ticket_lifetime;
3214 * uint32 ticket_age_add;
3215 * opaque ticket_nonce<0..255>;
3216 * opaque ticket<1..2^16-1>;
3217 * Extension extensions<0..2^16-2>;
3218 * } NewSessionTicket;
3219 *
3220 * The ticket inside the NewSessionTicket message is an encrypted container
3221 * carrying the necessary information so that the server is later able to
3222 * re-start the communication.
3223 *
3224 * The following fields are placed inside the ticket by the
3225 * f_ticket_write() function:
3226 *
Jerry Yu0069abc2023-11-23 21:07:28 +08003227 * - creation time (ticket_creation_time)
3228 * - flags (ticket_flags)
Jerry Yue67bef42022-07-07 07:29:42 +00003229 * - age add (ticket_age_add)
Jerry Yu0069abc2023-11-23 21:07:28 +08003230 * - key (resumption_key)
3231 * - key length (resumption_key_len)
Jerry Yue67bef42022-07-07 07:29:42 +00003232 * - ciphersuite (ciphersuite)
Jerry Yu0069abc2023-11-23 21:07:28 +08003233 * - max_early_data_size (max_early_data_size)
Jerry Yue67bef42022-07-07 07:29:42 +00003234 */
3235MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003236static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
3237 unsigned char *buf,
3238 unsigned char *end,
3239 size_t *out_len,
3240 unsigned char *ticket_nonce,
3241 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00003242{
3243 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3244 unsigned char *p = buf;
3245 mbedtls_ssl_session *session = ssl->session;
3246 size_t ticket_len;
3247 uint32_t ticket_lifetime;
Jerry Yu01da35e2022-12-12 15:09:22 +08003248 unsigned char *p_extensions_len;
Jerry Yue67bef42022-07-07 07:29:42 +00003249
3250 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00003252
3253 /*
3254 * ticket_lifetime 4 bytes
3255 * ticket_age_add 4 bytes
3256 * ticket_nonce 1 + ticket_nonce_size bytes
3257 * ticket >=2 bytes
3258 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003259 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00003260
3261 /* Generate ticket and ticket_lifetime */
Ronald Cron3c0072b2023-11-22 10:00:14 +01003262#if defined(MBEDTLS_HAVE_TIME)
3263 session->ticket_creation_time = mbedtls_ms_time();
3264#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
3266 session,
3267 p + 9 + ticket_nonce_size + 2,
3268 end,
3269 &ticket_len,
3270 &ticket_lifetime);
3271 if (ret != 0) {
3272 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
3273 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003274 }
3275 /* RFC 8446 4.6.1
3276 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
3277 * unsigned integer in network byte order from the time of ticket
3278 * issuance. Servers MUST NOT use any value greater than
3279 * 604800 seconds (7 days). The value of zero indicates that the
3280 * ticket should be discarded immediately. Clients MUST NOT cache
3281 * tickets for longer than 7 days, regardless of the ticket_lifetime,
3282 * and MAY delete tickets earlier based on local policy. A server
3283 * MAY treat a ticket as valid for a shorter period of time than what
3284 * is stated in the ticket_lifetime.
3285 */
Jerry Yu8e0174a2023-11-10 13:58:16 +08003286 if (ticket_lifetime > MBEDTLS_SSL_TLS1_3_MAX_ALLOWED_TICKET_LIFETIME) {
3287 ticket_lifetime = MBEDTLS_SSL_TLS1_3_MAX_ALLOWED_TICKET_LIFETIME;
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 }
3289 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
3290 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
3291 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00003292
3293 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
3295 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
3296 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00003297
3298 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 p[8] = (unsigned char) ticket_nonce_size;
3300 if (ticket_nonce_size > 0) {
3301 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00003302 }
3303 p += 9 + ticket_nonce_size;
3304
3305 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00003307 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00003309 p += ticket_len;
3310
3311 /* Ticket Extensions
3312 *
Jerry Yu01da35e2022-12-12 15:09:22 +08003313 * Extension extensions<0..2^16-2>;
Jerry Yue67bef42022-07-07 07:29:42 +00003314 */
Jerry Yuedab6372022-10-31 14:37:31 +08003315 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
3316
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu01da35e2022-12-12 15:09:22 +08003318 p_extensions_len = p;
Jerry Yue67bef42022-07-07 07:29:42 +00003319 p += 2;
3320
Jerry Yu01da35e2022-12-12 15:09:22 +08003321#if defined(MBEDTLS_SSL_EARLY_DATA)
Pengyu Lv94a42cc2023-12-06 10:04:17 +08003322 if (mbedtls_ssl_tls13_session_ticket_allow_early_data(session)) {
Jerry Yu95648b02023-12-06 15:03:34 +08003323 size_t output_len;
3324
Jerry Yuf135bac2023-11-23 18:10:51 +08003325 if ((ret = mbedtls_ssl_tls13_write_early_data_ext(
Jerry Yuc59c5862023-12-05 10:40:49 +08003326 ssl, 1, p, end, &output_len)) != 0) {
Jerry Yuf135bac2023-11-23 18:10:51 +08003327 MBEDTLS_SSL_DEBUG_RET(
3328 1, "mbedtls_ssl_tls13_write_early_data_ext", ret);
3329 return ret;
3330 }
3331 p += output_len;
Jerry Yu9e7f9bc2023-11-27 16:52:07 +08003332 } else {
3333 MBEDTLS_SSL_DEBUG_MSG(
3334 4, ("early_data not allowed, "
3335 "skip early_data extension in NewSessionTicket"));
Jerry Yu01da35e2022-12-12 15:09:22 +08003336 }
Jerry Yuf135bac2023-11-23 18:10:51 +08003337
Jerry Yu01da35e2022-12-12 15:09:22 +08003338#endif /* MBEDTLS_SSL_EARLY_DATA */
3339
3340 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
3341
Jerry Yue67bef42022-07-07 07:29:42 +00003342 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01003343 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
3344 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00003345
Jerry Yu7de2ff02022-11-08 21:43:46 +08003346 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08003348
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00003350}
3351
3352/*
Jerry Yua8d3c502022-10-30 14:51:23 +08003353 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003355static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00003356{
3357 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3358
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00003360
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00003362 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
3363 unsigned char *buf;
3364 size_t buf_len, msg_len;
3365
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
3367 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003368
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003369 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
3370 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
3371 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00003372
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
3374 ssl, buf, buf + buf_len, &msg_len,
3375 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003376
Gilles Peskine449bd832023-01-11 14:50:10 +01003377 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
3378 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08003379
Jerry Yu359e65f2022-09-22 23:47:43 +08003380 /* Limit session tickets count to one when resumption connection.
3381 *
3382 * See document of mbedtls_ssl_conf_new_session_tickets.
3383 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08003385 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08003387 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01003388 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08003389
Jerry Yua8d3c502022-10-30 14:51:23 +08003390 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003391 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
3392 } else {
3393 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00003394 }
3395
Jerry Yue67bef42022-07-07 07:29:42 +00003396cleanup:
3397
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003399}
3400#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3401
3402/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00003403 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00003404 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003405int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08003406{
XiaokangQian08037552022-04-20 07:16:41 +00003407 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003408
Gilles Peskine449bd832023-01-11 14:50:10 +01003409 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
3410 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3411 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003412
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
Dave Rodgman2eab4622023-10-05 13:30:37 +01003414 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state),
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08003416
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00003418 /* start state */
3419 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00003421 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003422 break;
3423
XiaokangQian7807f9f2022-02-15 10:04:37 +00003424 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003425 ret = ssl_tls13_process_client_hello(ssl);
3426 if (ret != 0) {
3427 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
3428 }
Jerry Yuf41553b2022-05-09 22:20:30 +08003429 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003430
Jerry Yuf41553b2022-05-09 22:20:30 +08003431 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 ret = ssl_tls13_write_hello_retry_request(ssl);
3433 if (ret != 0) {
3434 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
3435 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08003436 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003437 break;
3438
Jerry Yu5b64ae92022-03-30 17:15:02 +08003439 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08003441 break;
3442
Xiaofei Baicba64af2022-02-15 10:00:56 +00003443 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 ret = ssl_tls13_write_encrypted_extensions(ssl);
3445 if (ret != 0) {
3446 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
3447 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00003448 }
Jerry Yu48330562022-05-06 21:35:44 +08003449 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08003450
Ronald Cron928cbd32022-10-04 16:14:26 +02003451#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003452 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003454 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003455
Jerry Yu83da34e2022-04-16 13:59:52 +08003456 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003458 break;
3459
3460 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003461 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003462 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003463#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003464
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 /*
3466 * Injection of dummy-CCS's for middlebox compatibility
3467 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003468#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003469 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3471 if (ret == 0) {
3472 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3473 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003474 break;
3475
3476 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Ronald Crone273f722024-02-13 18:22:26 +01003477 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3478 if (ret != 0) {
3479 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003480 }
Ronald Cronfe59ff72024-01-24 14:31:50 +01003481 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003482 break;
3483#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3484
Jerry Yu69dd8d42022-04-16 12:51:26 +08003485 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003486 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003487 break;
3488
Jerry Yu87b5ed42022-12-12 13:07:07 +08003489#if defined(MBEDTLS_SSL_EARLY_DATA)
3490 case MBEDTLS_SSL_END_OF_EARLY_DATA:
Jerry Yu59d420f2023-12-01 16:30:34 +08003491 ret = ssl_tls13_process_end_of_early_data(ssl);
Jerry Yu87b5ed42022-12-12 13:07:07 +08003492 break;
3493#endif /* MBEDTLS_SSL_EARLY_DATA */
3494
Jerry Yu69dd8d42022-04-16 12:51:26 +08003495 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003496 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003497 break;
3498
Jerry Yu69dd8d42022-04-16 12:51:26 +08003499 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003500 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003501 break;
3502
Ronald Cron766c0cd2022-10-18 12:17:11 +02003503#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003504 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003505 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3506 if (ret == 0) {
3507 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003508 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3510 } else {
3511 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003512 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003513 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003514 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003515 }
3516 break;
3517
3518 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003519 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3520 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003521 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003522 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003523 }
3524 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003525#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003526
Jerry Yue67bef42022-07-07 07:29:42 +00003527#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003528 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003529 ret = ssl_tls13_write_new_session_ticket(ssl);
3530 if (ret != 0) {
3531 MBEDTLS_SSL_DEBUG_RET(1,
3532 "ssl_tls13_write_new_session_ticket ",
3533 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003534 }
3535 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003536 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003537 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003538 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003539 * as part of ssl_prepare_handshake_step.
3540 */
3541 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003542
Gilles Peskine449bd832023-01-11 14:50:10 +01003543 if (ssl->handshake->new_session_tickets_count == 0) {
3544 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3545 } else {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003546 mbedtls_ssl_handshake_set_state(
3547 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Gilles Peskine449bd832023-01-11 14:50:10 +01003548 }
Jerry Yue67bef42022-07-07 07:29:42 +00003549 break;
3550
3551#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3552
XiaokangQian7807f9f2022-02-15 10:04:37 +00003553 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003554 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3555 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003556 }
3557
Gilles Peskine449bd832023-01-11 14:50:10 +01003558 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003559}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003560
Jerry Yufb4b6472022-01-27 15:03:26 +08003561#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */