blob: 7b1849cb9e9c21bbb80b75f8bbcbdcca28398e13 [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
Jerry Yu687101b2021-09-14 16:03:56 +080012#include "mbedtls/debug.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"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020017#include "md_psa.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 Cron41a443a2022-10-04 16:38:25 +020042#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000043/* From RFC 8446:
44 *
45 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
46 * struct {
47 * PskKeyExchangeMode ke_modes<1..255>;
48 * } PskKeyExchangeModes;
49 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080050MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010051static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
52 const unsigned char *buf,
53 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +000054{
Jerry Yu299e31f2022-07-13 23:06:36 +080055 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000056 size_t ke_modes_len;
57 int ke_modes = 0;
58
Jerry Yu854dd9e2022-07-15 14:28:27 +080059 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +010060 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +080061 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000062 /* Currently, there are only two PSK modes, so even without looking
63 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +010064 if (ke_modes_len > 2) {
65 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
66 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
67 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +080068 }
Jerry Yue19e3b92022-07-08 12:04:51 +000069
Gilles Peskine449bd832023-01-11 14:50:10 +010070 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +000071
Gilles Peskine449bd832023-01-11 14:50:10 +010072 while (ke_modes_len-- != 0) {
73 switch (*p++) {
74 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
75 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
76 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
77 break;
78 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
79 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
80 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
81 break;
82 default:
83 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
84 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
85 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +000086 }
87 }
88
89 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +010090 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +000091}
Jerry Yu1c105562022-07-10 06:32:38 +000092
Jerry Yue9d4fc02022-08-20 19:21:15 +080093#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
94#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +080095
96#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lv29daf4a2023-10-30 17:13:30 +080097MBEDTLS_CHECK_RETURN_CRITICAL
98static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl);
99MBEDTLS_CHECK_RETURN_CRITICAL
100static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl);
Jerry Yu95699e72022-08-21 19:22:23 +0800101
102MBEDTLS_CHECK_RETURN_CRITICAL
103static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100104 mbedtls_ssl_context *ssl,
105 const unsigned char *identity,
106 size_t identity_len,
107 uint32_t obfuscated_ticket_age,
108 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800109{
Jerry Yufd310eb2022-09-06 09:16:35 +0800110 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800111 unsigned char *ticket_buffer;
Pengyu Lv29daf4a2023-10-30 17:13:30 +0800112 unsigned int key_exchanges;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800113#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucebffc32022-12-15 18:00:05 +0800114 mbedtls_ms_time_t now;
115 mbedtls_ms_time_t server_age;
Jerry Yu713ce1f2023-11-17 15:32:12 +0800116 uint32_t client_age;
Jerry Yucebffc32022-12-15 18:00:05 +0800117 mbedtls_ms_time_t age_diff;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800118#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800119
120 ((void) obfuscated_ticket_age);
121
Gilles Peskine449bd832023-01-11 14:50:10 +0100122 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800123
Jerry Yufd310eb2022-09-06 09:16:35 +0800124 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
126 return 0;
127 }
Jerry Yu95699e72022-08-21 19:22:23 +0800128
Jerry Yu4746b102022-09-13 11:11:48 +0800129 /* We create a copy of the encrypted ticket since the ticket parsing
130 * function is allowed to use its input buffer as an output buffer
131 * (in-place decryption). We do, however, need the original buffer for
132 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800133 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100134 ticket_buffer = mbedtls_calloc(1, identity_len);
135 if (ticket_buffer == NULL) {
136 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
137 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800138 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800140
Gilles Peskine449bd832023-01-11 14:50:10 +0100141 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
142 session,
143 ticket_buffer, identity_len)) != 0) {
144 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
145 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
146 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
147 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
148 } else {
149 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
150 }
Jerry Yu95699e72022-08-21 19:22:23 +0800151 }
152
153 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100154 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800155
Jerry Yuce3b95e2023-10-31 16:02:04 +0800156 if (ret == 0 && session->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu7ef9fd82023-11-07 14:30:38 +0800157 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket TLS version is not 1.3."));
158 /* TODO: Define new return value for this case. */
Jerry Yuce3b95e2023-10-31 16:02:04 +0800159 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
160 }
Jerry Yuce3b95e2023-10-31 16:02:04 +0800161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800163 goto exit;
164 }
Jerry Yu95699e72022-08-21 19:22:23 +0800165
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800166 /* RFC 8446 section 4.2.9
167 *
168 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
169 * compatible with the advertised modes; however, if a server does so,
170 * the impact will just be that the client's attempts at resumption fail.
171 *
172 * We regard the ticket with incompatible key exchange modes as not match.
173 */
Pengyu Lv18946532023-01-12 12:28:09 +0800174 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
Pengyu Lv29daf4a2023-10-30 17:13:30 +0800175 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv29daf4a2023-10-30 17:13:30 +0800176
177 key_exchanges = 0;
Pengyu Lvdbd1e0d2023-10-31 10:08:10 +0800178 if (mbedtls_ssl_session_ticket_allow_psk_ephemeral(session) &&
Pengyu Lv29daf4a2023-10-30 17:13:30 +0800179 ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
180 key_exchanges |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
181 }
Pengyu Lvdbd1e0d2023-10-31 10:08:10 +0800182 if (mbedtls_ssl_session_ticket_allow_psk(session) &&
Pengyu Lv29daf4a2023-10-30 17:13:30 +0800183 ssl_tls13_check_psk_key_exchange(ssl)) {
184 key_exchanges |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
185 }
186
187 if (key_exchanges == 0) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800188 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
189 goto exit;
190 }
191
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
193#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucebffc32022-12-15 18:00:05 +0800194 now = mbedtls_ms_time();
Gilles Peskine449bd832023-01-11 14:50:10 +0100195
Jerry Yu25ba4d42023-11-10 14:12:20 +0800196 if (now < session->ticket_creation_time) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100197 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu713ce1f2023-11-17 15:32:12 +0800198 3, ("Invalid ticket creation time ( now = %" MBEDTLS_PRINTF_MS_TIME
199 ", creation_time = %" MBEDTLS_PRINTF_MS_TIME " )",
Jerry Yu25ba4d42023-11-10 14:12:20 +0800200 now, session->ticket_creation_time));
Gilles Peskine449bd832023-01-11 14:50:10 +0100201 goto exit;
202 }
203
Jerry Yu25ba4d42023-11-10 14:12:20 +0800204 server_age = now - session->ticket_creation_time;
Jerry Yu95699e72022-08-21 19:22:23 +0800205
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800206 /* RFC 8446 section 4.6.1
207 *
208 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
209 *
210 * RFC 8446 section 4.2.11.1
211 *
212 * Clients MUST NOT attempt to use tickets which have ages greater than
213 * the "ticket_lifetime" value which was provided with the ticket.
214 *
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800215 */
Jerry Yu8e0174a2023-11-10 13:58:16 +0800216 if (server_age > MBEDTLS_SSL_TLS1_3_MAX_ALLOWED_TICKET_LIFETIME * 1000) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800217 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yud84c14f2023-11-16 13:33:57 +0800218 3, ("Ticket age exceeds limitation ticket_age = %" MBEDTLS_PRINTF_MS_TIME,
Jerry Yucebffc32022-12-15 18:00:05 +0800219 server_age));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800220 goto exit;
221 }
Jerry Yu95699e72022-08-21 19:22:23 +0800222
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800223 /* RFC 8446 section 4.2.10
224 *
225 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
226 * the ticket age for the selected PSK identity (computed by subtracting
227 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
228 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800229 *
Jerry Yu31b601a2023-11-10 11:27:21 +0800230 * NOTE: The typical accuracy of an RTC crystal is ±100 to ±20 parts per
231 * million (360 to 72 milliseconds per hour). Default tolerance
Jerry Yu9cb953a2023-11-15 09:54:11 +0800232 * window is 6s, thus in the worst case clients and servers must
Jerry Yu31b601a2023-11-10 11:27:21 +0800233 * sync up their system time every 6000/360/2~=8 hours.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800234 */
Jerry Yucebffc32022-12-15 18:00:05 +0800235 client_age = obfuscated_ticket_age - session->ticket_age_add;
Jerry Yu60e99722023-11-20 09:55:24 +0800236 age_diff = server_age - (mbedtls_ms_time_t) client_age;
Jerry Yu28e7c552023-11-10 12:05:56 +0800237 if (age_diff < -MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE ||
Jerry Yucebffc32022-12-15 18:00:05 +0800238 age_diff > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800239 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yuf16efbc2023-10-30 11:06:24 +0800240 3, ("Ticket age outside tolerance window ( diff = %"
241 MBEDTLS_PRINTF_MS_TIME ")",
Jerry Yucebffc32022-12-15 18:00:05 +0800242 age_diff));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800243 goto exit;
244 }
245
246 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800247
248#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800249
250exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 if (ret != 0) {
252 mbedtls_ssl_session_free(session);
253 }
Jerry Yu95699e72022-08-21 19:22:23 +0800254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
256 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800257}
258#endif /* MBEDTLS_SSL_SESSION_TICKETS */
259
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800260MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000261static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 mbedtls_ssl_context *ssl,
263 const unsigned char *identity,
264 size_t identity_len,
265 uint32_t obfuscated_ticket_age,
266 int *psk_type,
267 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000268{
Ronald Cron606671e2023-02-17 11:36:33 +0100269 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
270
Jerry Yu95699e72022-08-21 19:22:23 +0800271 ((void) session);
272 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800273 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800274
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800276 ssl->handshake->resume = 0;
277
Jerry Yu95699e72022-08-21 19:22:23 +0800278#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800280 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800282 ssl->handshake->resume = 1;
283 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Ronald Cron606671e2023-02-17 11:36:33 +0100284 ret = mbedtls_ssl_set_hs_psk(ssl,
285 session->resumption_key,
286 session->resumption_key_len);
287 if (ret != 0) {
288 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
289 return ret;
290 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100291
292 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
293 session->resumption_key,
294 session->resumption_key_len);
295 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
296 (unsigned) obfuscated_ticket_age));
297 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800298 }
299#endif /* MBEDTLS_SSL_SESSION_TICKETS */
300
Jerry Yu1c105562022-07-10 06:32:38 +0000301 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 if (ssl->conf->f_psk != NULL) {
303 if (ssl->conf->f_psk(
304 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
305 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000306 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000308 }
309
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000311 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800313 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 mbedtls_ct_memcmp(ssl->conf->psk_identity,
315 identity, identity_len) == 0) {
Ronald Cron606671e2023-02-17 11:36:33 +0100316 ret = mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
317 if (ret != 0) {
318 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
319 return ret;
320 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000322 }
323
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000325}
326
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800327MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000328static int ssl_tls13_offered_psks_check_binder_match(
329 mbedtls_ssl_context *ssl,
330 const unsigned char *binder, size_t binder_len,
331 int psk_type, psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000332{
333 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800334
Jerry Yudaf375a2022-07-20 21:31:43 +0800335 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000336 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800337 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800338 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800339 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000340
Jerry Yu1c105562022-07-10 06:32:38 +0000341 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800342 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200343 ssl, mbedtls_md_type_from_psa_alg(psk_hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 transcript, sizeof(transcript), &transcript_len);
345 if (ret != 0) {
346 return ret;
347 }
Jerry Yu1c105562022-07-10 06:32:38 +0000348
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
350 if (ret != 0) {
351 return ret;
352 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800353
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
355 psk, psk_len, psk_type,
356 transcript,
357 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800358#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800360#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 if (ret != 0) {
362 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
363 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000364 }
365
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
367 server_computed_binder, transcript_len);
368 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000369
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
371 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000372 }
373
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 mbedtls_platform_zeroize(server_computed_binder,
375 sizeof(server_computed_binder));
376 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000377}
Jerry Yu96a2e362022-07-21 15:11:34 +0800378
Jerry Yu5725f1c2022-08-21 17:27:16 +0800379MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800380static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 mbedtls_ssl_context *ssl,
382 const unsigned char *cipher_suites,
383 const unsigned char *cipher_suites_end,
384 uint16_t *selected_ciphersuite,
385 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800386{
Jerry Yuf35ba382022-08-23 17:58:26 +0800387 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800388
Jerry Yu0baf9072022-08-25 11:21:04 +0800389 *selected_ciphersuite = 0;
390 *selected_ciphersuite_info = NULL;
391
Jerry Yuf35ba382022-08-23 17:58:26 +0800392 /* RFC 8446, page 55.
393 *
394 * For externally established PSKs, the Hash algorithm MUST be set when the
395 * PSK is established or default to SHA-256 if no such algorithm is defined.
396 *
397 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800398
Jerry Yu5725f1c2022-08-21 17:27:16 +0800399 /*
400 * Search for a matching ciphersuite
401 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 for (const unsigned char *p = cipher_suites;
403 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800404 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800405 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800406
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
408 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
409 cipher_suite);
410 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800411 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100412 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800413
Jerry Yu5725f1c2022-08-21 17:27:16 +0800414 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
415 * Otherwise, client should reject.
416 */
Dave Rodgman2eab4622023-10-05 13:30:37 +0100417 if (psk_hash_alg ==
418 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800419 *selected_ciphersuite = cipher_suite;
420 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800422 }
423 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
425 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800426}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800427
Jerry Yu82534862022-08-30 10:42:33 +0800428#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800429MBEDTLS_CHECK_RETURN_CRITICAL
430static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 mbedtls_ssl_context *ssl,
432 const unsigned char *cipher_suites,
433 const unsigned char *cipher_suites_end,
434 mbedtls_ssl_session *session,
435 uint16_t *selected_ciphersuite,
436 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800437{
Jerry Yu82534862022-08-30 10:42:33 +0800438
Jerry Yuf35ba382022-08-23 17:58:26 +0800439 *selected_ciphersuite = 0;
440 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
442 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800443 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800446 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 }
Jerry Yu82534862022-08-30 10:42:33 +0800448
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
450 cipher_suite);
451 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800452 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 }
Jerry Yu82534862022-08-30 10:42:33 +0800454
Jerry Yu4746b102022-09-13 11:11:48 +0800455 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800456 *selected_ciphersuite_info = ciphersuite_info;
457
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800459 }
460
Gilles Peskine449bd832023-01-11 14:50:10 +0100461 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800462}
Jerry Yuf35ba382022-08-23 17:58:26 +0800463
Jerry Yu82534862022-08-30 10:42:33 +0800464MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100465static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
466 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800467{
Jerry Yu82534862022-08-30 10:42:33 +0800468 dst->ticket_age_add = src->ticket_age_add;
469 dst->ticket_flags = src->ticket_flags;
470 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100471 if (src->resumption_key_len == 0) {
472 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
473 }
474 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800475
Jerry Yu33bf2402022-12-12 16:01:43 +0800476#if defined(MBEDTLS_SSL_EARLY_DATA)
477 dst->max_early_data_size = src->max_early_data_size;
478#endif
479
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800481}
482#endif /* MBEDTLS_SSL_SESSION_TICKETS */
483
Jerry Yu1c105562022-07-10 06:32:38 +0000484/* Parser for pre_shared_key extension in client hello
485 * struct {
486 * opaque identity<1..2^16-1>;
487 * uint32 obfuscated_ticket_age;
488 * } PskIdentity;
489 *
490 * opaque PskBinderEntry<32..255>;
491 *
492 * struct {
493 * PskIdentity identities<7..2^16-1>;
494 * PskBinderEntry binders<33..2^16-1>;
495 * } OfferedPsks;
496 *
497 * struct {
498 * select (Handshake.msg_type) {
499 * case client_hello: OfferedPsks;
500 * ....
501 * };
502 * } PreSharedKeyExtension;
503 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800504MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000505static int ssl_tls13_parse_pre_shared_key_ext(
506 mbedtls_ssl_context *ssl,
507 const unsigned char *pre_shared_key_ext,
508 const unsigned char *pre_shared_key_ext_end,
509 const unsigned char *ciphersuites,
510 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000511{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100512 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800513 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800514 const unsigned char *p_identity_len;
515 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000516 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800517 const unsigned char *binders;
518 const unsigned char *p_binder_len;
519 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000520 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800521 int matched_identity = -1;
522 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000523
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
525 pre_shared_key_ext,
526 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000527
Jerry Yu96a2e362022-07-21 15:11:34 +0800528 /* identities_len 2 bytes
529 * identities_data >= 7 bytes
530 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
532 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800533 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
535 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800536 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000537
Jerry Yu96a2e362022-07-21 15:11:34 +0800538 /* binders_len 2 bytes
539 * binders >= 33 bytes
540 */
Jerry Yu568ec252022-07-22 21:27:34 +0800541 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
543 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800544 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800546 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000547
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100548 ret = ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
549 identities_end - pre_shared_key_ext);
550 if (0 != ret) {
551 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
552 return ret;
553 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800554
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000556 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800557 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800558 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800559 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800560 size_t binder_len;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800561 int psk_type;
562 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800563 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800564#if defined(MBEDTLS_SSL_SESSION_TICKETS)
565 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800567#endif
Jerry Yubb852022022-07-20 21:10:44 +0800568
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
570 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800571 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
573 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800574 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000575
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800577 binder_len = *p_binder_len;
578 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800580 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800581
Jerry Yu96a2e362022-07-21 15:11:34 +0800582 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000584 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 }
Jerry Yu1c105562022-07-10 06:32:38 +0000586
Jerry Yu96a2e362022-07-21 15:11:34 +0800587 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 ssl, identity, identity_len, obfuscated_ticket_age,
589 &psk_type, &session);
590 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800591 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800593
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
595 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800596 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
597 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 ssl, ciphersuites, ciphersuites_end,
599 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800600 break;
601 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800602#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800603 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 ssl, ciphersuites, ciphersuites_end, &session,
605 &cipher_suite, &ciphersuite_info);
606 if (ret != 0) {
607 mbedtls_ssl_session_free(&session);
608 }
Jerry Yu82534862022-08-30 10:42:33 +0800609#else
610 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
611#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800612 break;
613 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800615 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100616 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800617 /* See below, no cipher_suite available, abort handshake */
618 MBEDTLS_SSL_PEND_FATAL_ALERT(
619 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800621 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100622 2, "ssl_tls13_select_ciphersuite", ret);
623 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800624 }
625
Jerry Yu96a2e362022-07-21 15:11:34 +0800626 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100627 ssl, binder, binder_len, psk_type,
Dave Rodgman2eab4622023-10-05 13:30:37 +0100628 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac));
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800630 /* For security reasons, the handshake should be aborted when we
631 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
632 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800633#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100634 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800635#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100636 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000637 MBEDTLS_SSL_DEBUG_RET(
638 1, "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800639 MBEDTLS_SSL_PEND_FATAL_ALERT(
640 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100641 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
642 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800643 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800644
645 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800646
647 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800648 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800649 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100650 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
651 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800652#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100653 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
654 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
655 &session);
656 mbedtls_ssl_session_free(&session);
657 if (ret != 0) {
658 return ret;
659 }
Jerry Yu82534862022-08-30 10:42:33 +0800660 }
661#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000662 }
663
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 if (p_identity_len != identities_end || p_binder_len != binders_end) {
665 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
666 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
667 MBEDTLS_ERR_SSL_DECODE_ERROR);
668 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000669 }
670
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800671 /* Update the handshake transcript with the binder list. */
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000672 ret = ssl->handshake->update_checksum(
673 ssl, identities_end, (size_t) (binders_end - identities_end));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100674 if (0 != ret) {
675 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
676 return ret;
677 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 if (matched_identity == -1) {
679 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
680 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000681 }
682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 ssl->handshake->selected_identity = (uint16_t) matched_identity;
684 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000685
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000687}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000688
689/*
690 * struct {
691 * select ( Handshake.msg_type ) {
692 * ....
693 * case server_hello:
694 * uint16 selected_identity;
695 * }
696 * } PreSharedKeyExtension;
697 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100698static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
699 unsigned char *buf,
700 unsigned char *end,
701 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000702{
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000704
705 *olen = 0;
706
David Horstmann21b89762022-10-06 18:34:28 +0100707 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000708#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000710#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000712#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000714 /* We shouldn't have called this extension writer unless we've
715 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100716 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000717 }
718
Gilles Peskine449bd832023-01-11 14:50:10 +0100719 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
720 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
723 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000726
727 *olen = 6;
728
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
730 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000731
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800733
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000735}
736
Ronald Cron41a443a2022-10-04 16:38:25 +0200737#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000738
XiaokangQian7807f9f2022-02-15 10:04:37 +0000739/* From RFC 8446:
740 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000741 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000742 * } SupportedVersions;
743 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200744MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100745static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
746 const unsigned char *buf,
747 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000748{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000749 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000750 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000751 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000752 uint16_t tls_version;
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100753 int found_supported_version = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000754
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000756 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000757 p += 1;
758
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000760 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 while (p < versions_end) {
762 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
763 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000764 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000765
Ronald Cron3bd2b022023-04-03 16:45:39 +0200766 if (MBEDTLS_SSL_VERSION_TLS1_3 == tls_version) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100767 found_supported_version = 1;
768 break;
769 }
770
Ronald Cron3bd2b022023-04-03 16:45:39 +0200771 if ((MBEDTLS_SSL_VERSION_TLS1_2 == tls_version) &&
772 mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100773 found_supported_version = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000774 break;
775 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000776 }
777
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100778 if (!found_supported_version) {
779 MBEDTLS_SSL_DEBUG_MSG(1, ("No supported version found."));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000780
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
782 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
783 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000784 }
785
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100786 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version: [%04x]",
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000788
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100789 return (int) tls_version;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000790}
791
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200792#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000793/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000794 *
795 * From RFC 8446:
796 * enum {
797 * ... (0xFFFF)
798 * } NamedGroup;
799 * struct {
800 * NamedGroup named_group_list<2..2^16-1>;
801 * } NamedGroupList;
802 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200803MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100804static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
805 const unsigned char *buf,
806 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000807{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000808 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000809 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000810 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000811
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
813 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
814 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000815 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000817 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000818 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000819
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000821 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100822 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
823 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000824 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000825
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 MBEDTLS_SSL_DEBUG_MSG(2,
827 ("got named group: %s(%04x)",
828 mbedtls_ssl_named_group_to_str(named_group),
829 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000830
Gilles Peskine449bd832023-01-11 14:50:10 +0100831 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
832 !mbedtls_ssl_named_group_is_supported(named_group) ||
833 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000834 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000835 }
836
Gilles Peskine449bd832023-01-11 14:50:10 +0100837 MBEDTLS_SSL_DEBUG_MSG(2,
838 ("add named group %s(%04x) into received list.",
839 mbedtls_ssl_named_group_to_str(named_group),
840 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800841
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000842 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000843 }
844
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000846
847}
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200848#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000849
XiaokangQian08037552022-04-20 07:16:41 +0000850#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
851
Valerio Settic9ae8622023-07-25 11:23:50 +0200852#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000853/*
854 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000855 * extension is correct and stores the first acceptable key share and its
856 * associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000857 *
858 * Possible return values are:
859 * - 0: Successful processing of the client provided key share extension.
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000860 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by
861 * the client does not match a group supported by the server. A
862 * HelloRetryRequest will be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000863 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800864 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200865MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100866static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
867 const unsigned char *buf,
868 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000869{
XiaokangQianb67384d2022-04-19 00:02:38 +0000870 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000871 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000872 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800873 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000874
875 /* From RFC 8446:
876 *
877 * struct {
878 * KeyShareEntry client_shares<0..2^16-1>;
879 * } KeyShareClientHello;
880 *
881 */
882
Gilles Peskine449bd832023-01-11 14:50:10 +0100883 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
884 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000885 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000887
888 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000889 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000890
891 /* We try to find a suitable key share entry and copy it to the
892 * handshake context. Later, we have to find out whether we can do
893 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000894 * dismiss it and send a HelloRetryRequest message.
895 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000896
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000898 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800899 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800900 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000901
902 /*
903 * struct {
904 * NamedGroup group;
905 * opaque key_exchange<1..2^16-1>;
906 * } KeyShareEntry;
907 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
909 group = MBEDTLS_GET_UINT16_BE(p, 0);
910 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800911 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800912 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100913 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800914 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000915
916 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000917 * for input validation purposes.
918 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
920 !mbedtls_ssl_named_group_is_supported(group) ||
921 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000922 continue;
923 }
XiaokangQian060d8672022-04-21 09:24:56 +0000924
XiaokangQian7807f9f2022-02-15 10:04:37 +0000925 /*
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200926 * ECDHE and FFDHE groups are supported
XiaokangQian7807f9f2022-02-15 10:04:37 +0000927 */
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200928 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200929 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200930 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH/FFDH group: %s (%04x)",
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 mbedtls_ssl_named_group_to_str(group),
932 group));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200933 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100934 ssl, key_exchange - 2, key_exchange_len + 2);
935 if (ret != 0) {
936 return ret;
937 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000938
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 } else {
940 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
941 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000942 continue;
943 }
944
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000945 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000946 }
947
Jerry Yuc1be19f2022-04-23 16:11:39 +0800948
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 if (ssl->handshake->offered_group_id == 0) {
950 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
951 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000952 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000954}
Valerio Settic9ae8622023-07-25 11:23:50 +0200955#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000956
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200957MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100958static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
959 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000960{
Jerry Yu0c354a22022-08-29 15:25:36 +0800961 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000963}
964
Jerry Yue5991322022-11-07 14:03:44 +0800965#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200966MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000967static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000969{
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 return ssl_tls13_client_hello_has_exts(
971 ssl,
972 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
973 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
974 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000975}
Jerry Yue5991322022-11-07 14:03:44 +0800976#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000977
Jerry Yue5991322022-11-07 14:03:44 +0800978#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000979MBEDTLS_CHECK_RETURN_CRITICAL
980static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000982{
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 return ssl_tls13_client_hello_has_exts(
984 ssl,
985 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
986 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000987}
Jerry Yue5991322022-11-07 14:03:44 +0800988#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000989
Jerry Yue5991322022-11-07 14:03:44 +0800990#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000991MBEDTLS_CHECK_RETURN_CRITICAL
992static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000994{
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 return ssl_tls13_client_hello_has_exts(
996 ssl,
997 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
998 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
999 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
1000 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +00001001}
Jerry Yue5991322022-11-07 14:03:44 +08001002#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +00001003
Pengyu Lv306a01d2023-02-02 16:35:47 +08001004#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
1005MBEDTLS_CHECK_RETURN_CRITICAL
Pengyu Lv52ad3332023-02-14 14:32:37 +08001006static int ssl_tls13_ticket_permission_check(mbedtls_ssl_context *ssl,
1007 unsigned int kex_mode)
Pengyu Lv306a01d2023-02-02 16:35:47 +08001008{
1009#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1010 if (ssl->handshake->resume) {
Pengyu Lv7b711712023-10-24 17:07:14 +08001011 if (mbedtls_ssl_session_check_ticket_flags(
Pengyu Lv306a01d2023-02-02 16:35:47 +08001012 ssl->session_negotiate, kex_mode)) {
1013 return 0;
1014 }
1015 }
1016#else
1017 ((void) ssl);
1018 ((void) kex_mode);
1019#endif
1020 return 1;
1021}
1022#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
1023
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001024MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001025static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001026{
Jerry Yue5991322022-11-07 14:03:44 +08001027#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
1029 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +08001030#else
1031 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001032 return 0;
Jerry Yue5991322022-11-07 14:03:44 +08001033#endif
Jerry Yu77f01482022-07-11 07:03:24 +00001034}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001035
Jerry Yu77f01482022-07-11 07:03:24 +00001036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001037static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001038{
Jerry Yue5991322022-11-07 14:03:44 +08001039#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Pengyu Lv52ad3332023-02-14 14:32:37 +08001040 return ssl_tls13_ticket_permission_check(
Pengyu Lv306a01d2023-02-02 16:35:47 +08001041 ssl, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) &&
1042 mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 mbedtls_ssl_tls13_psk_enabled(ssl) &&
1044 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001045#else
1046 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001048#endif
1049}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001050
Jerry Yu77f01482022-07-11 07:03:24 +00001051MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001052static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001053{
Jerry Yue5991322022-11-07 14:03:44 +08001054#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Pengyu Lv52ad3332023-02-14 14:32:37 +08001055 return ssl_tls13_ticket_permission_check(
Pengyu Lv306a01d2023-02-02 16:35:47 +08001056 ssl, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) &&
1057 mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1059 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001060#else
1061 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001063#endif
1064}
1065
Gilles Peskine449bd832023-01-11 14:50:10 +01001066static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001067{
1068 /*
1069 * Determine the key exchange algorithm to use.
1070 * There are three types of key exchanges supported in TLS 1.3:
1071 * - (EC)DH with ECDSA,
1072 * - (EC)DH with PSK,
1073 * - plain PSK.
1074 *
1075 * The PSK-based key exchanges may additionally be used with 0-RTT.
1076 *
1077 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001078 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1079 * 2 ) Certificate Mode ( ephemeral )
1080 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001081 */
1082
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001083 ssl->handshake->key_exchange_mode =
1084 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
Jerry Yu77f01482022-07-11 07:03:24 +00001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001087 ssl->handshake->key_exchange_mode =
1088 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1090 } else
1091 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001092 ssl->handshake->key_exchange_mode =
1093 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1095 } else
1096 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001097 ssl->handshake->key_exchange_mode =
1098 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1100 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001101 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 1,
1103 ("ClientHello message misses mandatory extensions."));
1104 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1105 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1106 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001107 }
1108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001110
XiaokangQian7807f9f2022-02-15 10:04:37 +00001111}
1112
XiaokangQian81802f42022-06-10 13:25:22 +00001113#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001114 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001115
1116#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001118{
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001120 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001122 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001124 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001126 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001128 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001130 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001132 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001134 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001136 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001138 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001140 }
1141}
1142#endif /* MBEDTLS_USE_PSA_CRYPTO */
1143
XiaokangQian23c5be62022-06-07 02:04:34 +00001144/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001145 * Pick best ( private key, certificate chain ) pair based on the signature
1146 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001147 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001148MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001149static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001150{
XiaokangQianfb665a82022-06-15 03:57:21 +00001151 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001152 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001153
1154#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001156 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001158#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001160
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 if (key_cert_list == NULL) {
1162 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1163 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001164 }
1165
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1167 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001168 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001170
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001172 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001174
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 for (key_cert = key_cert_list; key_cert != NULL;
1176 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001177#if defined(MBEDTLS_USE_PSA_CRYPTO)
1178 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1179#endif /* MBEDTLS_USE_PSA_CRYPTO */
1180
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1182 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001183
1184 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001185 * This avoids sending the client a cert it'll reject based on
1186 * keyUsage or other extensions.
1187 */
1188 if (mbedtls_x509_crt_check_key_usage(
1189 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001190 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001191 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1193 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1194 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001195 continue;
1196 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001197
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 MBEDTLS_SSL_DEBUG_MSG(3,
1199 ("ssl_tls13_pick_key_cert:"
1200 "check signature algorithm %s [%04x]",
1201 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1202 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001203#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001205#endif /* MBEDTLS_USE_PSA_CRYPTO */
1206
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1208 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001209#if defined(MBEDTLS_USE_PSA_CRYPTO)
1210 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1212 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001213#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001215 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 MBEDTLS_SSL_DEBUG_MSG(3,
1217 ("ssl_tls13_pick_key_cert:"
1218 "selected signature algorithm"
1219 " %s [%04x]",
1220 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1221 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001222 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 3, "selected certificate (chain)",
1224 ssl->handshake->key_cert->cert);
1225 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001226 }
XiaokangQian81802f42022-06-10 13:25:22 +00001227 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001228 }
1229
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1231 "no suitable certificate found"));
1232 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001233}
XiaokangQian81802f42022-06-10 13:25:22 +00001234#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001235 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001236
XiaokangQian4080a7f2022-04-11 09:55:18 +00001237/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001238 *
1239 * STATE HANDLING: ClientHello
1240 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001241 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001242 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001243 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001244 *
1245 * In this case, the server progresses to sending its ServerHello.
1246 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001247 * 2) The ClientHello was well-formed but didn't match the server's
1248 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001249 *
1250 * For example, the client might not have offered a key share which
1251 * the server supports, or the server might require a cookie.
1252 *
1253 * In this case, the server sends a HelloRetryRequest.
1254 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001255 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001256 *
1257 * In this case, we abort the handshake.
1258 *
1259 */
1260
1261/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001262 * Structure of this message:
1263 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001264 * uint16 ProtocolVersion;
1265 * opaque Random[32];
1266 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001267 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001268 * struct {
1269 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1270 * Random random;
1271 * opaque legacy_session_id<0..32>;
1272 * CipherSuite cipher_suites<2..2^16-2>;
1273 * opaque legacy_compression_methods<1..2^8-1>;
1274 * Extension extensions<8..2^16-1>;
1275 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001276 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001277
1278#define SSL_CLIENT_HELLO_OK 0
1279#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001280#define SSL_CLIENT_HELLO_TLS1_2 2
XiaokangQianed582dd2022-04-13 08:21:05 +00001281
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001282MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001283static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1284 const unsigned char *buf,
1285 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001286{
XiaokangQianb67384d2022-04-19 00:02:38 +00001287 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1288 const unsigned char *p = buf;
Ronald Crond540d992023-03-07 09:41:48 +01001289 const unsigned char *random;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001290 size_t legacy_session_id_len;
Ronald Croncada4102023-03-07 09:51:39 +01001291 const unsigned char *legacy_session_id;
XiaokangQian318dc762022-04-20 09:43:51 +00001292 size_t cipher_suites_len;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001293 const unsigned char *cipher_suites;
XiaokangQian060d8672022-04-21 09:24:56 +00001294 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001295 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001296 const unsigned char *extensions_end;
Ronald Croneff56732023-04-03 17:36:31 +02001297 const unsigned char *supported_versions_data;
1298 const unsigned char *supported_versions_data_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001299 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001300 int hrr_required = 0;
Ronald Cron8a74f072023-06-14 17:59:29 +02001301 int no_usable_share_for_key_agreement = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001302
Ronald Cron41a443a2022-10-04 16:38:25 +02001303#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu29d9faa2022-08-23 17:52:45 +08001304 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001305 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001306#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001307
XiaokangQian7807f9f2022-02-15 10:04:37 +00001308 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001309 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001310 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001311 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001312 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001313 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001314 * .. . .. ciphersuite list length ( 2 bytes )
1315 * .. . .. ciphersuite list
1316 * .. . .. compression alg. list length ( 1 byte )
1317 * .. . .. compression alg. list
1318 * .. . .. extensions length ( 2 bytes, optional )
1319 * .. . .. extensions ( optional )
1320 */
1321
XiaokangQianb67384d2022-04-19 00:02:38 +00001322 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001323 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001324 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1325 * read at least up to session id length without worrying.
1326 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001328
1329 /* ...
1330 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1331 * ...
1332 * with ProtocolVersion defined as:
1333 * uint16 ProtocolVersion;
1334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1336 MBEDTLS_SSL_VERSION_TLS1_2) {
1337 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1338 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1339 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1340 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001341 }
1342 p += 2;
1343
Jerry Yuc1be19f2022-04-23 16:11:39 +08001344 /* ...
1345 * Random random;
1346 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001347 * with Random defined as:
1348 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001349 */
Ronald Crond540d992023-03-07 09:41:48 +01001350 random = p;
XiaokangQian08037552022-04-20 07:16:41 +00001351 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001352
Jerry Yuc1be19f2022-04-23 16:11:39 +08001353 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001354 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001355 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001356 */
Ronald Croncada4102023-03-07 09:51:39 +01001357 legacy_session_id_len = *(p++);
1358 legacy_session_id = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001359
XiaokangQianb67384d2022-04-19 00:02:38 +00001360 /*
1361 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001362 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001365 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001366
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001367 /* ...
1368 * CipherSuite cipher_suites<2..2^16-2>;
1369 * ...
1370 * with CipherSuite defined as:
1371 * uint8 CipherSuite[2];
1372 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001373 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001374 p += 2;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001375 cipher_suites = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001376
Ronald Cronfc7ae872023-02-16 15:32:19 +01001377 /*
1378 * The length of the ciphersuite list has to be even.
1379 */
1380 if (cipher_suites_len & 1) {
1381 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1382 MBEDTLS_ERR_SSL_DECODE_ERROR);
1383 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1384 }
1385
XiaokangQianb67384d2022-04-19 00:02:38 +00001386 /* Check we have enough data for the ciphersuite list, the legacy
1387 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001388 *
1389 * cipher_suites cipher_suites_len bytes
1390 * legacy_compression_methods 2 bytes
1391 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001392 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
Ronald Cron8c527d02023-03-07 15:47:47 +01001394 p += cipher_suites_len;
1395 cipher_suites_end = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001396
1397 /*
Ronald Cron8c527d02023-03-07 15:47:47 +01001398 * Search for the supported versions extension and parse it to determine
1399 * if the client supports TLS 1.3.
1400 */
1401 ret = mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1402 ssl, p + 2, end,
Ronald Croneff56732023-04-03 17:36:31 +02001403 &supported_versions_data, &supported_versions_data_end);
Ronald Cron8c527d02023-03-07 15:47:47 +01001404 if (ret < 0) {
1405 MBEDTLS_SSL_DEBUG_RET(1,
1406 ("mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts"), ret);
1407 return ret;
1408 }
1409
1410 if (ret == 0) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001411 return SSL_CLIENT_HELLO_TLS1_2;
Ronald Cron8c527d02023-03-07 15:47:47 +01001412 }
1413
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001414 if (ret == 1) {
1415 ret = ssl_tls13_parse_supported_versions_ext(ssl,
Ronald Croneff56732023-04-03 17:36:31 +02001416 supported_versions_data,
1417 supported_versions_data_end);
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001418 if (ret < 0) {
1419 MBEDTLS_SSL_DEBUG_RET(1,
1420 ("ssl_tls13_parse_supported_versions_ext"), ret);
1421 return ret;
1422 }
1423
Ronald Cronb828c7d2023-04-03 16:37:22 +02001424 /*
1425 * The supported versions extension was parsed successfully as the
1426 * value returned by ssl_tls13_parse_supported_versions_ext() is
1427 * positive. The return value is then equal to
1428 * MBEDTLS_SSL_VERSION_TLS1_2 or MBEDTLS_SSL_VERSION_TLS1_3, defining
1429 * the TLS version to negotiate.
1430 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001431 if (MBEDTLS_SSL_VERSION_TLS1_2 == ret) {
1432 return SSL_CLIENT_HELLO_TLS1_2;
1433 }
Ronald Cron8c527d02023-03-07 15:47:47 +01001434 }
1435
1436 /*
1437 * We negotiate TLS 1.3.
Ronald Cron64582392023-03-07 09:21:40 +01001438 */
1439 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1440
1441#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1442 /* Store minor version for later use with ticket serialization. */
1443 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1444 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1445#endif
1446
1447 /*
Ronald Crondad02b22023-04-06 09:57:52 +02001448 * We are negotiating the version 1.3 of the protocol. Do what we have
Ronald Croncada4102023-03-07 09:51:39 +01001449 * postponed: copy of the client random bytes, copy of the legacy session
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001450 * identifier and selection of the TLS 1.3 cipher suite.
Ronald Crond540d992023-03-07 09:41:48 +01001451 */
1452 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1453 random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1454 memcpy(&handshake->randbytes[0], random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1455
Ronald Croncada4102023-03-07 09:51:39 +01001456 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1457 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1458 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1459 }
1460 ssl->session_negotiate->id_len = legacy_session_id_len;
1461 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1462 legacy_session_id, legacy_session_id_len);
1463 memcpy(&ssl->session_negotiate->id[0],
1464 legacy_session_id, legacy_session_id_len);
1465
Ronald Crond540d992023-03-07 09:41:48 +01001466 /*
Jerry Yu5725f1c2022-08-21 17:27:16 +08001467 * Search for a matching ciphersuite
1468 */
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001469 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, list of cipher suites",
1470 cipher_suites, cipher_suites_len);
Ronald Crone45afd72023-04-04 15:10:06 +02001471 for (const unsigned char *cipher_suites_p = cipher_suites;
1472 cipher_suites_p < cipher_suites_end; cipher_suites_p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001473 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001474 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001475
Ronald Crond89360b2023-02-21 08:53:33 +01001476 /*
Ronald Crone45afd72023-04-04 15:10:06 +02001477 * "cipher_suites_end - cipher_suites_p is even" is an invariant of the
1478 * loop. As cipher_suites_end - cipher_suites_p > 0, we have
1479 * cipher_suites_end - cipher_suites_p >= 2 and it is thus safe to read
1480 * two bytes.
Ronald Crond89360b2023-02-21 08:53:33 +01001481 */
Ronald Crone45afd72023-04-04 15:10:06 +02001482 cipher_suite = MBEDTLS_GET_UINT16_BE(cipher_suites_p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001483 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 ssl, cipher_suite);
1485 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001486 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001488
Jerry Yu5725f1c2022-08-21 17:27:16 +08001489 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001490 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001491 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1492 cipher_suite,
1493 ciphersuite_info->name));
Ronald Cron25e9ec62023-02-16 15:35:16 +01001494 break;
XiaokangQian17f974c2022-04-19 09:57:41 +00001495 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001496
Gilles Peskine449bd832023-01-11 14:50:10 +01001497 if (handshake->ciphersuite_info == NULL) {
1498 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1499 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1500 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001501 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001502
XiaokangQian4080a7f2022-04-11 09:55:18 +00001503 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001504 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001505 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1508 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1509 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1510 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1511 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001512 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001513 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001514
Jerry Yuc1be19f2022-04-23 16:11:39 +08001515 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001516 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001517 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001518 * with Extension defined as:
1519 * struct {
1520 * ExtensionType extension_type;
1521 * opaque extension_data<0..2^16-1>;
1522 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001523 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001525 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001527 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
Jerry Yu63a459c2022-10-31 13:38:40 +08001530 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001531
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001533 unsigned int extension_type;
1534 size_t extension_data_len;
1535 const unsigned char *extension_data_end;
1536
Jerry Yu0c354a22022-08-29 15:25:36 +08001537 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001538 *
1539 * The "pre_shared_key" extension MUST be the last extension in the
1540 * ClientHello (this facilitates implementation as described below).
1541 * Servers MUST check that it is the last extension and otherwise fail
1542 * the handshake with an "illegal_parameter" alert.
1543 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001545 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001547 MBEDTLS_SSL_PEND_FATAL_ALERT(
1548 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1550 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001551 }
1552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1554 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1555 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001556 p += 4;
1557
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001559 extension_data_end = p + extension_data_len;
1560
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001561 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1563 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1564 if (ret != 0) {
1565 return ret;
1566 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001567
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001569#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1570 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1572 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1573 extension_data_end);
1574 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001575 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 1, "mbedtls_ssl_parse_servername_ext", ret);
1577 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001578 }
XiaokangQian40a35232022-05-07 09:02:40 +00001579 break;
1580#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1581
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001582#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001583 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001585
1586 /* Supported Groups Extension
1587 *
1588 * When sent by the client, the "supported_groups" extension
1589 * indicates the named groups which the client supports,
1590 * ordered from most preferred to least preferred.
1591 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001592 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 ssl, p, extension_data_end);
1594 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001595 MBEDTLS_SSL_DEBUG_RET(
Xiaokang Qian8bce0e62023-04-04 10:15:48 +00001596 1, "ssl_tls13_parse_supported_groups_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001598 }
1599
XiaokangQian7807f9f2022-02-15 10:04:37 +00001600 break;
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001601#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH*/
XiaokangQian7807f9f2022-02-15 10:04:37 +00001602
Valerio Settic9ae8622023-07-25 11:23:50 +02001603#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001604 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001606
1607 /*
1608 * Key Share Extension
1609 *
1610 * When sent by the client, the "key_share" extension
1611 * contains the endpoint's cryptographic parameters for
1612 * ECDHE/DHE key establishment methods.
1613 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001614 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 ssl, p, extension_data_end);
1616 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
Ronald Cron8a74f072023-06-14 17:59:29 +02001617 MBEDTLS_SSL_DEBUG_MSG(2, ("No usable share for key agreement."));
1618 no_usable_share_for_key_agreement = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001619 }
1620
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001622 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 1, "ssl_tls13_parse_key_shares_ext", ret);
1624 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001625 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001626
XiaokangQian7807f9f2022-02-15 10:04:37 +00001627 break;
Valerio Settic9ae8622023-07-25 11:23:50 +02001628#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001629
1630 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Ronald Cron8c527d02023-03-07 15:47:47 +01001631 /* Already parsed */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001632 break;
1633
Ronald Cron41a443a2022-10-04 16:38:25 +02001634#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001635 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001636 MBEDTLS_SSL_DEBUG_MSG(
1637 3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001638
1639 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001640 ssl, p, extension_data_end);
1641 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001642 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1644 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001645 }
1646
Jerry Yue19e3b92022-07-08 12:04:51 +00001647 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001648#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001649
Jerry Yu1c105562022-07-10 06:32:38 +00001650 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1652 if ((handshake->received_extensions &
1653 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001654 MBEDTLS_SSL_PEND_FATAL_ALERT(
1655 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1657 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001658 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001659#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001660 /* Delay processing of the PSK identity once we have
1661 * found out which algorithms to use. We keep a pointer
1662 * to the buffer and the size for later processing.
1663 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001664 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001665 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001666#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001667 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001668
XiaokangQianacb39922022-06-17 10:18:48 +00001669#if defined(MBEDTLS_SSL_ALPN)
1670 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001671 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001672
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1674 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001675 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1677 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001678 }
XiaokangQianacb39922022-06-17 10:18:48 +00001679 break;
1680#endif /* MBEDTLS_SSL_ALPN */
1681
Ronald Cron928cbd32022-10-04 16:14:26 +02001682#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001683 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001685
Gabor Mezei078e8032022-04-27 21:17:56 +02001686 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001687 ssl, p, extension_data_end);
1688 if (ret != 0) {
Xiaokang Qian49f39c12023-04-06 02:31:02 +00001689 MBEDTLS_SSL_DEBUG_RET(
1690 1, "mbedtls_ssl_parse_sig_alg_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001692 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001693 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001694#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001695
Jan Bruckner151f6422023-02-10 12:45:19 +01001696#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1697 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
1698 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
1699
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001700 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
1701 ssl, p, extension_data_end);
Jan Bruckner151f6422023-02-10 12:45:19 +01001702
Xiaokang Qian09c3ccc2023-04-04 10:18:38 +00001703 /*
1704 * TODO: Return unconditionally here until we handle the record
1705 * size limit correctly.
1706 * Once handled correctly, only return in case of errors.
1707 */
Jan Bruckner151f6422023-02-10 12:45:19 +01001708 return ret;
1709
1710 break;
1711#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1712
XiaokangQian7807f9f2022-02-15 10:04:37 +00001713 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001714 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001715 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001717 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001718 }
1719
1720 p += extension_data_len;
1721 }
1722
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1724 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001725
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001726 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1727 MBEDTLS_SSL_HS_CLIENT_HELLO,
1728 p - buf);
1729 if (0 != ret) {
1730 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1731 return ret;
1732 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001733
Ronald Cron41a443a2022-10-04 16:38:25 +02001734#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001735 /* Update checksum with either
1736 * - The entire content of the CH message, if no PSK extension is present
1737 * - The content up to but excluding the PSK extension, if present.
1738 */
Jerry Yu1c105562022-07-10 06:32:38 +00001739 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Pengyu Lvcfb23b82023-10-30 15:26:26 +08001740 if (ssl_tls13_check_psk_key_exchange(ssl) ||
1741 ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001742 ret = handshake->update_checksum(ssl, buf,
1743 pre_shared_key_ext - buf);
1744 if (0 != ret) {
1745 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1746 return ret;
1747 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1749 pre_shared_key_ext,
1750 pre_shared_key_ext_end,
1751 cipher_suites,
1752 cipher_suites_end);
1753 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1754 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1755 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001756 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1758 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001759 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001761#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001762 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001763 ret = handshake->update_checksum(ssl, buf, p - buf);
1764 if (0 != ret) {
1765 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1766 return ret;
1767 }
Jerry Yu1c105562022-07-10 06:32:38 +00001768 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001769
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1771 if (ret < 0) {
1772 return ret;
1773 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001774
Ronald Cron8a74f072023-06-14 17:59:29 +02001775 if (ssl->handshake->key_exchange_mode !=
1776 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) {
1777 hrr_required = (no_usable_share_for_key_agreement != 0);
1778 }
1779
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001781
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001783}
1784
Jerry Yuab0da372023-02-08 13:55:24 +08001785#if defined(MBEDTLS_SSL_EARLY_DATA)
1786static void ssl_tls13_update_early_data_status(mbedtls_ssl_context *ssl)
1787{
1788 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1789
1790 if ((handshake->received_extensions &
1791 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) == 0) {
1792 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yub47b2992023-10-18 15:50:35 +08001793 1, ("EarlyData: no early data extension received."));
Jerry Yuab0da372023-02-08 13:55:24 +08001794 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_RECEIVED;
1795 return;
1796 }
1797
1798 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
1799
Jerry Yu985c9672022-12-04 14:06:30 +08001800 if (ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_DISABLED) {
1801 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu985c9672022-12-04 14:06:30 +08001802 1,
Jerry Yu454dda32023-10-31 15:13:54 +08001803 ("EarlyData: rejected, feature disabled in server configuration."));
Jerry Yu985c9672022-12-04 14:06:30 +08001804 return;
1805 }
1806
Jerry Yu454dda32023-10-31 15:13:54 +08001807 if (!handshake->resume) {
1808 /* We currently support early data only in the case of PSKs established
1809 via a NewSessionTicket message thus in the case of a session
1810 resumption. */
Jerry Yu985c9672022-12-04 14:06:30 +08001811 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001812 1, ("EarlyData: rejected, not a session resumption."));
Jerry Yu985c9672022-12-04 14:06:30 +08001813 return;
1814 }
1815
Jerry Yu82fd6c12023-10-31 16:32:19 +08001816 /* RFC 8446 4.2.10
1817 *
1818 * In order to accept early data, the server MUST have accepted a PSK cipher
1819 * suite and selected the first key offered in the client's "pre_shared_key"
1820 * extension. In addition, it MUST verify that the following values are the
1821 * same as those associated with the selected PSK:
1822 * - The TLS version number
1823 * - The selected cipher suite
1824 * - The selected ALPN [RFC7301] protocol, if any
1825 *
1826 * NOTE:
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001827 * - The TLS version number is checked in
1828 * ssl_tls13_offered_psks_check_identity_match_ticket().
1829 * - ALPN is not checked for the time being (TODO).
Jerry Yu82fd6c12023-10-31 16:32:19 +08001830 */
1831
1832 if (handshake->selected_identity != 0) {
1833 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001834 1, ("EarlyData: rejected, the selected key in "
1835 "`pre_shared_key` is not the first one."));
Jerry Yu82fd6c12023-10-31 16:32:19 +08001836 return;
1837 }
1838
1839 if (handshake->ciphersuite_info->id !=
1840 ssl->session_negotiate->ciphersuite) {
1841 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001842 1, ("EarlyData: rejected, the selected ciphersuite is not the one "
1843 "of the selected pre-shared key."));
Jerry Yu82fd6c12023-10-31 16:32:19 +08001844 return;
1845
1846 }
Jerry Yu985c9672022-12-04 14:06:30 +08001847
Jerry Yu985c9672022-12-04 14:06:30 +08001848
1849 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
1850
Jerry Yuab0da372023-02-08 13:55:24 +08001851}
1852#endif /* MBEDTLS_SSL_EARLY_DATA */
1853
XiaokangQian75fe8c72022-06-15 09:42:45 +00001854/* Update the handshake state machine */
1855
Ronald Cronce7d76e2022-07-08 18:56:49 +02001856MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001857static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001858{
1859 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1860
XiaokangQian7807f9f2022-02-15 10:04:37 +00001861 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001862 * Server certificate selection
1863 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1865 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1866 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001867 }
1868#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1869 ssl->handshake->sni_name = NULL;
1870 ssl->handshake->sni_name_len = 0;
1871#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1874 if (ret != 0) {
1875 MBEDTLS_SSL_DEBUG_RET(1,
1876 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1877 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001878 }
1879
Jerry Yuab0da372023-02-08 13:55:24 +08001880#if defined(MBEDTLS_SSL_EARLY_DATA)
1881 /* There is enough information, update early data state. */
1882 ssl_tls13_update_early_data_status(ssl);
Jerry Yu4e9b70e2022-12-04 14:08:02 +08001883
1884 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_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 }
1892
Jerry Yuab0da372023-02-08 13:55:24 +08001893#endif /* MBEDTLS_SSL_EARLY_DATA */
1894
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001896
1897}
1898
1899/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001900 * Main entry point from the state machine; orchestrates the otherfunctions.
1901 */
1902
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001903MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001904static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001905{
1906
XiaokangQian08037552022-04-20 07:16:41 +00001907 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001909 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001910 int parse_client_hello_ret;
1911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1915 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1916 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001917
Gilles Peskine449bd832023-01-11 14:50:10 +01001918 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1919 buf + buflen));
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001920 parse_client_hello_ret = ret; /* Store positive return value of
1921 * parse_client_hello,
1922 * as negative error codes are handled
Jerry Yuf41553b2022-05-09 22:20:30 +08001923 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001924
Ronald Cronb828c7d2023-04-03 16:37:22 +02001925 /*
1926 * Version 1.2 of the protocol has been chosen, set the
1927 * ssl->keep_current_message flag for the ClientHello to be kept and parsed
1928 * as a TLS 1.2 ClientHello. We also change ssl->tls_version to
1929 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1930 * will dispatch to the TLS 1.2 state machine.
1931 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001932 if (SSL_CLIENT_HELLO_TLS1_2 == parse_client_hello_ret) {
1933 ssl->keep_current_message = 1;
1934 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
1935 return 0;
1936 }
1937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001939
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001940 if (SSL_CLIENT_HELLO_OK == parse_client_hello_ret) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001941 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1942 } else {
1943 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1944 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001945
1946cleanup:
1947
Gilles Peskine449bd832023-01-11 14:50:10 +01001948 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1949 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001950}
1951
1952/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001953 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001954 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001955MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001956static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001957{
Jerry Yu637a3f12022-04-20 21:37:58 +08001958 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1959 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1961 if (ssl->conf->f_rng == NULL) {
1962 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1963 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001964 }
1965
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1967 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1968 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1969 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001970 }
1971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1973 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001974
1975#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001976 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001977#endif /* MBEDTLS_HAVE_TIME */
1978
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001980}
1981
Jerry Yu3bf2c642022-03-30 22:02:12 +08001982/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001983 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001984 *
1985 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001986 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001987 * } SupportedVersions;
1988 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001989MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001990static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 mbedtls_ssl_context *ssl,
1992 unsigned char *buf,
1993 unsigned char *end,
1994 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001995{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001996 *out_len = 0;
1997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001999
2000 /* Check if we have space to write the extension:
2001 * - extension_type (2 bytes)
2002 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08002003 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002004 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002010
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 mbedtls_ssl_write_version(buf + 4,
2012 ssl->conf->transport,
2013 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
2016 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002017
Jerry Yu349a6132022-04-14 20:52:56 +08002018 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002019
Jerry Yub95dd362022-11-08 21:19:34 +08002020 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08002022
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002024}
2025
Jerry Yud9436a12022-04-20 22:28:09 +08002026
Jerry Yu3bf2c642022-03-30 22:02:12 +08002027
2028/* Generate and export a single key share. For hybrid KEMs, this can
2029 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002030MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002031static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
2032 uint16_t named_group,
2033 unsigned char *buf,
2034 unsigned char *end,
2035 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002036{
2037 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08002038
2039 *out_len = 0;
2040
Valerio Settic9ae8622023-07-25 11:23:50 +02002041#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02002042 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +02002043 mbedtls_ssl_tls13_named_group_is_ffdh(named_group)) {
Przemek Stekiel408569f2023-07-06 11:26:44 +02002044 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 ssl, named_group, buf, end, out_len);
2046 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08002047 MBEDTLS_SSL_DEBUG_RET(
Przemek Stekiel408569f2023-07-06 11:26:44 +02002048 1, "mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 ret);
2050 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002051 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 } else
Valerio Settic9ae8622023-07-25 11:23:50 +02002053#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 if (0 /* Other kinds of KEMs */) {
2055 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08002056 ((void) ssl);
2057 ((void) named_group);
2058 ((void) buf);
2059 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002060 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2061 }
2062
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002064}
2065
2066/*
2067 * ssl_tls13_write_key_share_ext
2068 *
2069 * Structure of key_share extension in ServerHello:
2070 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08002071 * struct {
2072 * NamedGroup group;
2073 * opaque key_exchange<1..2^16-1>;
2074 * } KeyShareEntry;
2075 * struct {
2076 * KeyShareEntry server_share;
2077 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002078 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002079MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002080static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
2081 unsigned char *buf,
2082 unsigned char *end,
2083 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002084{
Jerry Yu955ddd72022-04-22 22:27:33 +08002085 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002086 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08002087 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002088 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002089 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002090
2091 *out_len = 0;
2092
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
2096 mbedtls_ssl_named_group_to_str(group),
2097 group));
Jerry Yu58af2332022-09-06 11:19:31 +08002098
Jerry Yu3bf2c642022-03-30 22:02:12 +08002099 /* Check if we have space for header and length fields:
2100 * - extension_type (2 bytes)
2101 * - extension_data_length (2 bytes)
2102 * - group (2 bytes)
2103 * - key_exchange_length (2 bytes)
2104 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
2106 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
2107 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002108 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08002109
Jerry Yu3bf2c642022-03-30 22:02:12 +08002110 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
2111 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08002112 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 ssl, group, server_share + 4, end, &key_exchange_length);
2114 if (ret != 0) {
2115 return ret;
2116 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002117 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08002118
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002122
Jerry Yu57d48412022-04-20 21:50:42 +08002123 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08002124
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002128}
Jerry Yud9436a12022-04-20 22:28:09 +08002129
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002130MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002131static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
2132 unsigned char *buf,
2133 unsigned char *end,
2134 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002135{
2136 uint16_t selected_group = ssl->handshake->hrr_selected_group;
2137 /* key_share Extension
2138 *
2139 * struct {
2140 * select (Handshake.msg_type) {
2141 * ...
2142 * case hello_retry_request:
2143 * NamedGroup selected_group;
2144 * ...
2145 * };
2146 * } KeyShare;
2147 */
2148
2149 *out_len = 0;
2150
Jerry Yub0ac10b2022-05-05 11:10:08 +08002151 /*
2152 * For a pure PSK key exchange, there is no group to agree upon. The purpose
2153 * of the HRR is then to transmit a cookie to force the client to demonstrate
2154 * reachability at their apparent network address (primarily useful for DTLS).
2155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2157 return 0;
2158 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002159
2160 /* We should only send the key_share extension if the client's initial
2161 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (ssl->handshake->offered_group_id != 0) {
2163 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
2164 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002165 }
2166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (selected_group == 0) {
2168 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
2169 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002170 }
2171
Jerry Yub0ac10b2022-05-05 11:10:08 +08002172 /* Check if we have enough space:
2173 * - extension_type (2 bytes)
2174 * - extension_data_length (2 bytes)
2175 * - selected_group (2 bytes)
2176 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
2180 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
2181 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002182
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 MBEDTLS_SSL_DEBUG_MSG(3,
2184 ("HRR selected_group: %s (%x)",
2185 mbedtls_ssl_named_group_to_str(selected_group),
2186 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002187
2188 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002193}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002194
2195/*
2196 * Structure of ServerHello message:
2197 *
2198 * struct {
2199 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2200 * Random random;
2201 * opaque legacy_session_id_echo<0..32>;
2202 * CipherSuite cipher_suite;
2203 * uint8 legacy_compression_method = 0;
2204 * Extension extensions<6..2^16-1>;
2205 * } ServerHello;
2206 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002207MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002208static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2209 unsigned char *buf,
2210 unsigned char *end,
2211 size_t *out_len,
2212 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002213{
Jerry Yu955ddd72022-04-22 22:27:33 +08002214 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002215 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002216 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002217 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002218
2219 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002220 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002221
Jerry Yucfc04b32022-04-21 09:31:58 +08002222 /* ...
2223 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2224 * ...
2225 * with ProtocolVersion defined as:
2226 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002227 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2229 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002230 p += 2;
2231
Jerry Yu1c3e6882022-04-20 21:23:40 +08002232 /* ...
2233 * Random random;
2234 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002235 * with Random defined as:
2236 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002237 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2239 if (is_hrr) {
2240 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2241 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2242 } else {
2243 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2244 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002245 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2247 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002248 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2249
Jerry Yucfc04b32022-04-21 09:31:58 +08002250 /* ...
2251 * opaque legacy_session_id_echo<0..32>;
2252 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002253 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2255 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2256 if (ssl->session_negotiate->id_len > 0) {
2257 memcpy(p, &ssl->session_negotiate->id[0],
2258 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002259 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2262 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002263 }
2264
Jerry Yucfc04b32022-04-21 09:31:58 +08002265 /* ...
2266 * CipherSuite cipher_suite;
2267 * ...
2268 * with CipherSuite defined as:
2269 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002270 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2272 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002273 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 MBEDTLS_SSL_DEBUG_MSG(3,
2275 ("server hello, chosen ciphersuite: %s ( id=%d )",
2276 mbedtls_ssl_get_ciphersuite_name(
2277 ssl->session_negotiate->ciphersuite),
2278 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002279
Jerry Yucfc04b32022-04-21 09:31:58 +08002280 /* ...
2281 * uint8 legacy_compression_method = 0;
2282 * ...
2283 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002285 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002286
Jerry Yucfc04b32022-04-21 09:31:58 +08002287 /* ...
2288 * Extension extensions<6..2^16-1>;
2289 * ...
2290 * struct {
2291 * ExtensionType extension_type; (2 bytes)
2292 * opaque extension_data<0..2^16-1>;
2293 * } Extension;
2294 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002296 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002297 p += 2;
2298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2300 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002301 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2303 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002304 }
2305 p += output_len;
2306
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2308 if (is_hrr) {
2309 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2310 } else {
2311 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2312 }
2313 if (ret != 0) {
2314 return ret;
2315 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002316 p += output_len;
2317 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002318
Ronald Cron41a443a2022-10-04 16:38:25 +02002319#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2321 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2322 if (ret != 0) {
2323 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2324 ret);
2325 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002326 }
2327 p += output_len;
2328 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002329#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002332
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2334 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002335
Jerry Yud9436a12022-04-20 22:28:09 +08002336 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002339
Jerry Yu7de2ff02022-11-08 21:43:46 +08002340 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002341 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 MBEDTLS_SSL_HS_SERVER_HELLO,
2343 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002344
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002346}
2347
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002348MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002349static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002350{
2351 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2353 if (ret != 0) {
2354 MBEDTLS_SSL_DEBUG_RET(1,
2355 "mbedtls_ssl_tls13_compute_handshake_transform",
2356 ret);
2357 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002358 }
2359
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002361}
2362
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002363MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002364static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002365{
Jerry Yu637a3f12022-04-20 21:37:58 +08002366 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002367 unsigned char *buf;
2368 size_t buf_len, msg_len;
2369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002371
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002373
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002374 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2375 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2378 buf + buf_len,
2379 &msg_len,
2380 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002381
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002382 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002383 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002384
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2386 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002387
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002388 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002389
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002390#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2391 /* The server sends a dummy change_cipher_spec record immediately
2392 * after its first handshake message. This may either be after
2393 * a ServerHello or a HelloRetryRequest.
2394 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002395 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002397#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002399#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002400
Jerry Yuf4b27e42022-03-30 17:32:21 +08002401cleanup:
2402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2404 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002405}
2406
Jerry Yu23d1a252022-05-12 18:08:59 +08002407
2408/*
2409 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2410 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002411MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002412static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002413{
2414 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 if (ssl->handshake->hello_retry_request_count > 0) {
2416 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2417 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2418 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2419 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002420 }
2421
2422 /*
2423 * Create stateless transcript hash for HRR
2424 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2426 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2427 if (ret != 0) {
2428 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2429 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002430 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002432
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002434}
2435
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002436MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002437static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002438{
2439 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2440 unsigned char *buf;
2441 size_t buf_len, msg_len;
2442
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002444
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2448 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2449 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2452 buf + buf_len,
2453 &msg_len,
2454 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002455 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002456 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002457
2458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2460 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002461
2462 ssl->handshake->hello_retry_request_count++;
2463
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002464#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2465 /* The server sends a dummy change_cipher_spec record immediately
2466 * after its first handshake message. This may either be after
2467 * a ServerHello or a HelloRetryRequest.
2468 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002469 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002471#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002473#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002474
2475cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2477 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002478}
2479
Jerry Yu5b64ae92022-03-30 17:15:02 +08002480/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002481 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2482 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002483
2484/*
2485 * struct {
2486 * Extension extensions<0..2 ^ 16 - 1>;
2487 * } EncryptedExtensions;
2488 *
2489 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002490MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002491static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2492 unsigned char *buf,
2493 unsigned char *end,
2494 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002495{
XiaokangQianacb39922022-06-17 10:18:48 +00002496 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002497 unsigned char *p = buf;
2498 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002499 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002500 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002501
Jerry Yu4d3841a2022-04-16 12:37:19 +08002502 *out_len = 0;
2503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002505 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002506 p += 2;
2507
Jerry Yu8937eb42022-05-03 12:12:14 +08002508 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002509 ((void) ret);
2510 ((void) output_len);
2511
2512#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2514 if (ret != 0) {
2515 return ret;
2516 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002517 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002518#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002519
Jerry Yu71c14f12022-12-12 11:10:35 +08002520#if defined(MBEDTLS_SSL_EARLY_DATA)
2521 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2522 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &output_len);
2523 if (ret != 0) {
2524 return ret;
2525 }
2526 p += output_len;
2527 }
2528#endif /* MBEDTLS_SSL_EARLY_DATA */
2529
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 extensions_len = (p - p_extensions_len) - 2;
2531 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002532
2533 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002536
Jerry Yu7de2ff02022-11-08 21:43:46 +08002537 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002539
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002541}
2542
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002543MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002544static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002545{
2546 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2547 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002548 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 mbedtls_ssl_set_outbound_transform(ssl,
2551 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002552 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002556
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002557 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2558 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2559 &buf, &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2562 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002563
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002564 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002565 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2566 buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2569 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002570
Ronald Cron928cbd32022-10-04 16:14:26 +02002571#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2573 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2574 } else {
2575 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2576 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002577#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002579#endif
2580
Jerry Yu4d3841a2022-04-16 12:37:19 +08002581cleanup:
2582
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2584 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002585}
2586
Ronald Cron928cbd32022-10-04 16:14:26 +02002587#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002588#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2589#define SSL_CERTIFICATE_REQUEST_SKIP 1
2590/* Coordination:
2591 * Check whether a CertificateRequest message should be written.
2592 * Returns a negative code on failure, or
2593 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2594 * - SSL_CERTIFICATE_REQUEST_SKIP
2595 * indicating if the writing of the CertificateRequest
2596 * should be skipped or not.
2597 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002598MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002599static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002600{
2601 int authmode;
2602
XiaokangQian40a35232022-05-07 09:02:40 +00002603#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002605 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002607#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002608 authmode = ssl->conf->authmode;
2609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002611 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002613 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002614
XiaokangQianc3017f62022-05-13 05:55:41 +00002615 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002616
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002618}
2619
XiaokangQiancec9ae62022-05-06 07:28:50 +00002620/*
2621 * struct {
2622 * opaque certificate_request_context<0..2^8-1>;
2623 * Extension extensions<2..2^16-1>;
2624 * } CertificateRequest;
2625 *
2626 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002627MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002628static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2629 unsigned char *buf,
2630 const unsigned char *end,
2631 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002632{
2633 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2634 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002635 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002636 unsigned char *p_extensions_len;
2637
2638 *out_len = 0;
2639
2640 /* Check if we have enough space:
2641 * - certificate_request_context (1 byte)
2642 * - extensions length (2 bytes)
2643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002645
2646 /*
2647 * Write certificate_request_context
2648 */
2649 /*
2650 * We use a zero length context for the normal handshake
2651 * messages. For post-authentication handshake messages
2652 * this request context would be set to a non-zero value.
2653 */
2654 *p++ = 0x0;
2655
2656 /*
2657 * Write extensions
2658 */
2659 /* The extensions must contain the signature_algorithms. */
2660 p_extensions_len = p;
2661 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2663 if (ret != 0) {
2664 return ret;
2665 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002666
XiaokangQianec6efb92022-05-06 09:53:10 +00002667 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002669
2670 *out_len = p - buf;
2671
Jerry Yu7de2ff02022-11-08 21:43:46 +08002672 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002676}
2677
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002678MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002679static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002680{
2681 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002688 unsigned char *buf;
2689 size_t buf_len, msg_len;
2690
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002691 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2692 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2693 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2696 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002697
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002698 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002699 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2700 buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2703 ssl, buf_len, msg_len));
2704 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2705 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002706 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 } else {
2708 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002709 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2710 goto cleanup;
2711 }
2712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002714cleanup:
2715
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2717 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002718}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002719
Jerry Yu4d3841a2022-04-16 12:37:19 +08002720/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002721 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002722 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002723MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002724static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002725{
Jerry Yu5a26f302022-05-10 20:46:40 +08002726 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002727
2728#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2730 mbedtls_ssl_own_cert(ssl) == NULL) {
2731 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2732 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2733 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2734 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002735 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002736#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002737
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2739 if (ret != 0) {
2740 return ret;
2741 }
2742 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2743 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002744}
2745
2746/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002747 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
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_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002751{
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2753 if (ret != 0) {
2754 return ret;
2755 }
2756 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2757 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002758}
Ronald Cron928cbd32022-10-04 16:14:26 +02002759#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002760
Jerry Yu9b72e392023-12-01 16:27:08 +08002761
2762/*
2763 * RFC 8446 section A.2
2764 *
2765 * | Send ServerHello
2766 * | K_send = handshake
2767 * | Send EncryptedExtensions
2768 * | [Send CertificateRequest]
2769 * Can send | [Send Certificate + CertificateVerify]
2770 * app data | Send Finished
2771 * after --> | K_send = application
2772 * here +--------+--------+
2773 * No 0-RTT | | 0-RTT
2774 * | |
2775 * K_recv = handshake | | K_recv = early data
2776 * [Skip decrypt errors] | +------> WAIT_EOED -+
2777 * | | Recv | | Recv EndOfEarlyData
2778 * | | early data | | K_recv = handshake
2779 * | +------------+ |
2780 * | |
2781 * +> WAIT_FLIGHT2 <--------+
2782 * |
2783 * +--------+--------+
2784 * No auth | | Client auth
2785 * | |
2786 * | v
2787 * | WAIT_CERT
2788 * | Recv | | Recv Certificate
2789 * | empty | v
2790 * | Certificate | WAIT_CV
2791 * | | | Recv
2792 * | v | CertificateVerify
2793 * +-> WAIT_FINISHED <---+
2794 * | Recv Finished
2795 *
2796 *
2797 * The following function handles the state changes after WAIT_FLIGHT2 in the
2798 * above diagram.
2799 */
2800static void ssl_tls13_process_wait_flight2(mbedtls_ssl_context *ssl)
2801{
2802 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_tls13_process_wait_flight2"));
2803
2804 if (ssl->handshake->certificate_request_sent) {
2805 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2806 } else {
2807 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2808 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2809 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
2810 }
2811
2812 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_tls13_process_wait_flight2"));
2813}
2814
Jerry Yu83da34e2022-04-16 13:59:52 +08002815/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002816 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002817 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002818MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002819static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002820{
Jerry Yud6e253d2022-05-18 13:59:24 +08002821 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2824 if (ret != 0) {
2825 return ret;
2826 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002827
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2829 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002830 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2832 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2833 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002834 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002835
Jerry Yu87b5ed42022-12-12 13:07:07 +08002836#if defined(MBEDTLS_SSL_EARLY_DATA)
2837 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2838 /* TODO: compute early transform here?
2839 *
2840 * RFC 8446, section A.2
2841 * | Send Finished
2842 * | K_send = application
2843 * +--------+--------+
2844 * No 0-RTT | | 0-RTT
2845 * | |
2846 * | | K_recv = early data
2847 * | +------> WAIT_EOED -+
2848 *
2849 * early transform is set after server finished in this section. But
2850 * it breaks our key computation, so we put early transform computation
Jerry Yud33f7a82023-11-29 15:09:21 +08002851 * at the end of client hello. For the time being, I am not sure the
2852 * benifit for moving computation here.
Jerry Yu87b5ed42022-12-12 13:07:07 +08002853 */
2854 MBEDTLS_SSL_DEBUG_MSG(
2855 1, ("Switch to early keys for inbound traffic. "
2856 "( K_recv = early data )"));
2857 mbedtls_ssl_set_inbound_transform(
2858 ssl, ssl->handshake->transform_earlydata);
2859 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_END_OF_EARLY_DATA);
2860 return 0;
2861 }
2862#endif /* MBEDTLS_SSL_EARLY_DATA */
2863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2865 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002866
Jerry Yu9b72e392023-12-01 16:27:08 +08002867 ssl_tls13_process_wait_flight2(ssl);
Jerry Yu7d8c3fe2022-12-12 12:59:44 +08002868
2869 return 0;
2870}
2871
Jerry Yu87b5ed42022-12-12 13:07:07 +08002872#if defined(MBEDTLS_SSL_EARLY_DATA)
2873/*
Jerry Yu59d420f2023-12-01 16:30:34 +08002874 * Handler for MBEDTLS_SSL_END_OF_EARLY_DATA
Jerry Yu87b5ed42022-12-12 13:07:07 +08002875 */
2876MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu59d420f2023-12-01 16:30:34 +08002877static int ssl_tls13_process_end_of_early_data(mbedtls_ssl_context *ssl)
Jerry Yu87b5ed42022-12-12 13:07:07 +08002878{
2879 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu59d420f2023-12-01 16:30:34 +08002880 ((void) ssl);
Jerry Yu87b5ed42022-12-12 13:07:07 +08002881 return ret;
2882}
2883#endif /* MBEDTLS_SSL_EARLY_DATA */
2884
Jerry Yu69dd8d42022-04-16 12:51:26 +08002885/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002886 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002887 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002888MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002889static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002890{
Jerry Yud6e253d2022-05-18 13:59:24 +08002891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2894 if (ret != 0) {
2895 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002896 }
2897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2899 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002900 MBEDTLS_SSL_DEBUG_RET(
2901 1, "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 }
2903
2904 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2905 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002906}
2907
2908/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002909 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002910 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002911MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002912static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002913{
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002917
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002918#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2919 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002920/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2921 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2922 * expected to be resolved with issue#6395.
2923 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002924 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002925 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002926 mbedtls_ssl_handshake_set_state(
2927 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002928 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002929#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002930 {
2931 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2932 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002934}
2935
2936/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002937 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002938 */
2939#define SSL_NEW_SESSION_TICKET_SKIP 0
2940#define SSL_NEW_SESSION_TICKET_WRITE 1
2941MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002942static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002943{
2944 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 if (ssl->conf->f_ticket_write == NULL) {
2946 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2947 " callback is not set"));
2948 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002949 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 if (ssl->conf->new_session_tickets_count == 0) {
2951 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2952 " configured count is zero"));
2953 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002954 }
2955
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 if (ssl->handshake->new_session_tickets_count == 0) {
2957 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2958 "been sent."));
2959 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002960 }
2961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002963}
2964
2965#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2966MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002967static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2968 unsigned char *ticket_nonce,
2969 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002970{
2971 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2972 mbedtls_ssl_session *session = ssl->session;
2973 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2974 psa_algorithm_t psa_hash_alg;
2975 int hash_length;
2976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002978
2979#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu25ba4d42023-11-10 14:12:20 +08002980 session->ticket_creation_time = mbedtls_ms_time();
Jerry Yue67bef42022-07-07 07:29:42 +00002981#endif
2982
Pengyu Lv9f926952022-11-17 15:22:33 +08002983 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002984 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002985 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002986#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002987 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002988 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002989#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002990 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002991
Jerry Yue67bef42022-07-07 07:29:42 +00002992 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2994 (unsigned char *) &session->ticket_age_add,
2995 sizeof(session->ticket_age_add)) != 0)) {
2996 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2997 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002998 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
3000 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00003001
3002 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
3004 if (ret != 0) {
3005 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
3006 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003007 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
3009 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00003010
3011 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
Dave Rodgman2eab4622023-10-05 13:30:37 +01003013 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
3015 if (hash_length == -1 ||
3016 (size_t) hash_length > sizeof(session->resumption_key)) {
3017 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08003018 }
3019
Jerry Yue67bef42022-07-07 07:29:42 +00003020 /* In this code the psk key length equals the length of the hash */
3021 session->resumption_key_len = hash_length;
3022 session->ciphersuite = ciphersuite_info->id;
3023
3024 /* Compute resumption key
3025 *
3026 * HKDF-Expand-Label( resumption_master_secret,
3027 * "resumption", ticket_nonce, Hash.length )
3028 */
3029 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 psa_hash_alg,
3031 session->app_secrets.resumption_master_secret,
3032 hash_length,
3033 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
3034 ticket_nonce,
3035 ticket_nonce_size,
3036 session->resumption_key,
3037 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00003038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 if (ret != 0) {
3040 MBEDTLS_SSL_DEBUG_RET(2,
3041 "Creating the ticket-resumed PSK failed",
3042 ret);
3043 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003044 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
3046 session->resumption_key,
3047 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00003048
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
3050 session->app_secrets.resumption_master_secret,
3051 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00003052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00003054}
3055
3056/* This function creates a NewSessionTicket message in the following format:
3057 *
3058 * struct {
3059 * uint32 ticket_lifetime;
3060 * uint32 ticket_age_add;
3061 * opaque ticket_nonce<0..255>;
3062 * opaque ticket<1..2^16-1>;
3063 * Extension extensions<0..2^16-2>;
3064 * } NewSessionTicket;
3065 *
3066 * The ticket inside the NewSessionTicket message is an encrypted container
3067 * carrying the necessary information so that the server is later able to
3068 * re-start the communication.
3069 *
3070 * The following fields are placed inside the ticket by the
3071 * f_ticket_write() function:
3072 *
3073 * - creation time (start)
3074 * - flags (flags)
3075 * - age add (ticket_age_add)
3076 * - key (key)
3077 * - key length (key_len)
3078 * - ciphersuite (ciphersuite)
3079 */
3080MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003081static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
3082 unsigned char *buf,
3083 unsigned char *end,
3084 size_t *out_len,
3085 unsigned char *ticket_nonce,
3086 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00003087{
3088 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3089 unsigned char *p = buf;
3090 mbedtls_ssl_session *session = ssl->session;
3091 size_t ticket_len;
3092 uint32_t ticket_lifetime;
3093
3094 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00003096
3097 /*
3098 * ticket_lifetime 4 bytes
3099 * ticket_age_add 4 bytes
3100 * ticket_nonce 1 + ticket_nonce_size bytes
3101 * ticket >=2 bytes
3102 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00003104
3105 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
3107 session,
3108 p + 9 + ticket_nonce_size + 2,
3109 end,
3110 &ticket_len,
3111 &ticket_lifetime);
3112 if (ret != 0) {
3113 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
3114 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003115 }
3116 /* RFC 8446 4.6.1
3117 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
3118 * unsigned integer in network byte order from the time of ticket
3119 * issuance. Servers MUST NOT use any value greater than
3120 * 604800 seconds (7 days). The value of zero indicates that the
3121 * ticket should be discarded immediately. Clients MUST NOT cache
3122 * tickets for longer than 7 days, regardless of the ticket_lifetime,
3123 * and MAY delete tickets earlier based on local policy. A server
3124 * MAY treat a ticket as valid for a shorter period of time than what
3125 * is stated in the ticket_lifetime.
3126 */
Jerry Yu8e0174a2023-11-10 13:58:16 +08003127 if (ticket_lifetime > MBEDTLS_SSL_TLS1_3_MAX_ALLOWED_TICKET_LIFETIME) {
3128 ticket_lifetime = MBEDTLS_SSL_TLS1_3_MAX_ALLOWED_TICKET_LIFETIME;
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 }
3130 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
3131 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
3132 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00003133
3134 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
3136 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
3137 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00003138
3139 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 p[8] = (unsigned char) ticket_nonce_size;
3141 if (ticket_nonce_size > 0) {
3142 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00003143 }
3144 p += 9 + ticket_nonce_size;
3145
3146 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00003148 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00003150 p += ticket_len;
3151
3152 /* Ticket Extensions
3153 *
3154 * Note: We currently don't have any extensions.
3155 * Set length to zero.
3156 */
Jerry Yuedab6372022-10-31 14:37:31 +08003157 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
3158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
3160 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00003161 p += 2;
3162
3163 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
3165 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00003166
Jerry Yu7de2ff02022-11-08 21:43:46 +08003167 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08003169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00003171}
3172
3173/*
Jerry Yua8d3c502022-10-30 14:51:23 +08003174 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003175 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003176static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00003177{
3178 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3179
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00003181
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00003183 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
3184 unsigned char *buf;
3185 size_t buf_len, msg_len;
3186
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
3188 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003189
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003190 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
3191 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
3192 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00003193
Gilles Peskine449bd832023-01-11 14:50:10 +01003194 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
3195 ssl, buf, buf + buf_len, &msg_len,
3196 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
3199 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08003200
Jerry Yu359e65f2022-09-22 23:47:43 +08003201 /* Limit session tickets count to one when resumption connection.
3202 *
3203 * See document of mbedtls_ssl_conf_new_session_tickets.
3204 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08003206 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08003208 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08003210
Jerry Yua8d3c502022-10-30 14:51:23 +08003211 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
3213 } else {
3214 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00003215 }
3216
Jerry Yue67bef42022-07-07 07:29:42 +00003217cleanup:
3218
Gilles Peskine449bd832023-01-11 14:50:10 +01003219 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003220}
3221#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3222
3223/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00003224 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00003225 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003226int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08003227{
XiaokangQian08037552022-04-20 07:16:41 +00003228 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003229
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
3231 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3232 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
Dave Rodgman2eab4622023-10-05 13:30:37 +01003235 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state),
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08003237
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00003239 /* start state */
3240 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00003242 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003243 break;
3244
XiaokangQian7807f9f2022-02-15 10:04:37 +00003245 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 ret = ssl_tls13_process_client_hello(ssl);
3247 if (ret != 0) {
3248 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
3249 }
Jerry Yuf41553b2022-05-09 22:20:30 +08003250 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003251
Jerry Yuf41553b2022-05-09 22:20:30 +08003252 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 ret = ssl_tls13_write_hello_retry_request(ssl);
3254 if (ret != 0) {
3255 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
3256 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08003257 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003258 break;
3259
Jerry Yu5b64ae92022-03-30 17:15:02 +08003260 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08003262 break;
3263
Xiaofei Baicba64af2022-02-15 10:00:56 +00003264 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 ret = ssl_tls13_write_encrypted_extensions(ssl);
3266 if (ret != 0) {
3267 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
3268 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00003269 }
Jerry Yu48330562022-05-06 21:35:44 +08003270 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08003271
Ronald Cron928cbd32022-10-04 16:14:26 +02003272#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003273 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003275 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003276
Jerry Yu83da34e2022-04-16 13:59:52 +08003277 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003279 break;
3280
3281 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003283 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003284#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003285
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 /*
3287 * Injection of dummy-CCS's for middlebox compatibility
3288 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003289#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003290 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3292 if (ret == 0) {
3293 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3294 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003295 break;
3296
3297 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3299 if (ret == 0) {
3300 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
3301 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003302 break;
3303#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3304
Jerry Yu7d8c3fe2022-12-12 12:59:44 +08003305 /* RFC 8446 section A.2
3306 *
3307 * | Send Finished ( SERVER_FINISHED )
3308 * | K_send = application
3309 * +--------+--------+
3310 * No 0-RTT | | 0-RTT
3311 * | |
3312 * K_recv = handshake | | K_recv = early data
3313 * [Skip decrypt errors] | +------> WAIT_EOED -+
3314 * | | Recv | | Recv EndOfEarlyData
3315 * | | early data | | K_recv = handshake
3316 * | +------------+ |
3317 * | |
3318 * +> WAIT_FLIGHT2 <--------+
3319 * |
3320 */
Jerry Yu69dd8d42022-04-16 12:51:26 +08003321 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003322 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003323 break;
3324
Jerry Yu87b5ed42022-12-12 13:07:07 +08003325#if defined(MBEDTLS_SSL_EARLY_DATA)
3326 case MBEDTLS_SSL_END_OF_EARLY_DATA:
Jerry Yu59d420f2023-12-01 16:30:34 +08003327 ret = ssl_tls13_process_end_of_early_data(ssl);
Jerry Yu87b5ed42022-12-12 13:07:07 +08003328 break;
3329#endif /* MBEDTLS_SSL_EARLY_DATA */
3330
Jerry Yu69dd8d42022-04-16 12:51:26 +08003331 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003333 break;
3334
Jerry Yu69dd8d42022-04-16 12:51:26 +08003335 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003337 break;
3338
Ronald Cron766c0cd2022-10-18 12:17:11 +02003339#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003340 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003341 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3342 if (ret == 0) {
3343 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003344 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3346 } else {
3347 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003348 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003350 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003351 }
3352 break;
3353
3354 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3356 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003357 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003359 }
3360 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003361#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003362
Jerry Yue67bef42022-07-07 07:29:42 +00003363#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003364 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 ret = ssl_tls13_write_new_session_ticket(ssl);
3366 if (ret != 0) {
3367 MBEDTLS_SSL_DEBUG_RET(1,
3368 "ssl_tls13_write_new_session_ticket ",
3369 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003370 }
3371 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003372 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003373 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003374 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003375 * as part of ssl_prepare_handshake_step.
3376 */
3377 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003378
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 if (ssl->handshake->new_session_tickets_count == 0) {
3380 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3381 } else {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003382 mbedtls_ssl_handshake_set_state(
3383 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 }
Jerry Yue67bef42022-07-07 07:29:42 +00003385 break;
3386
3387#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3388
XiaokangQian7807f9f2022-02-15 10:04:37 +00003389 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3391 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003392 }
3393
Gilles Peskine449bd832023-01-11 14:50:10 +01003394 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003395}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003396
Jerry Yufb4b6472022-01-27 15:03:26 +08003397#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */