blob: ed9bdfb4bd02ada8d8de19d6eb6f64ab49603688 [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
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Gilles Peskine449bd832023-01-11 14:50:10 +010018 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080019
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000027#include "mbedtls/constant_time.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080028
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000029#include "ssl_misc.h"
30#include "ssl_tls13_keys.h"
31#include "ssl_debug_helpers.h"
32
Jerry Yuf35ba382022-08-23 17:58:26 +080033
Jerry Yuc5a23a02022-08-25 10:51:44 +080034static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +010035 mbedtls_ssl_context *ssl,
36 unsigned int cipher_suite)
Jerry Yuf35ba382022-08-23 17:58:26 +080037{
38 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +010039 if (!mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
40 return NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +080041 }
Gilles Peskine449bd832023-01-11 14:50:10 +010042
43 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
44 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
45 ssl->tls_version,
46 ssl->tls_version) != 0)) {
47 return NULL;
48 }
49 return ciphersuite_info;
Jerry Yuf35ba382022-08-23 17:58:26 +080050}
51
Ronald Cron41a443a2022-10-04 16:38:25 +020052#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000053/* From RFC 8446:
54 *
55 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
56 * struct {
57 * PskKeyExchangeMode ke_modes<1..255>;
58 * } PskKeyExchangeModes;
59 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010061static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
62 const unsigned char *buf,
63 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +000064{
Jerry Yu299e31f2022-07-13 23:06:36 +080065 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000066 size_t ke_modes_len;
67 int ke_modes = 0;
68
Jerry Yu854dd9e2022-07-15 14:28:27 +080069 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +010070 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +080071 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000072 /* Currently, there are only two PSK modes, so even without looking
73 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +010074 if (ke_modes_len > 2) {
75 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
76 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
77 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +080078 }
Jerry Yue19e3b92022-07-08 12:04:51 +000079
Gilles Peskine449bd832023-01-11 14:50:10 +010080 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +000081
Gilles Peskine449bd832023-01-11 14:50:10 +010082 while (ke_modes_len-- != 0) {
83 switch (*p++) {
84 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
85 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
86 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
87 break;
88 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
89 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
90 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
91 break;
92 default:
93 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
94 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
95 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +000096 }
97 }
98
99 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +0100100 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +0000101}
Jerry Yu1c105562022-07-10 06:32:38 +0000102
Jerry Yue9d4fc02022-08-20 19:21:15 +0800103#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
104#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800105
106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
107
108MBEDTLS_CHECK_RETURN_CRITICAL
109static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 mbedtls_ssl_context *ssl,
111 const unsigned char *identity,
112 size_t identity_len,
113 uint32_t obfuscated_ticket_age,
114 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800115{
Jerry Yufd310eb2022-09-06 09:16:35 +0800116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800117 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800118#if defined(MBEDTLS_HAVE_TIME)
119 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800120 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800121 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800122#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800123
124 ((void) obfuscated_ticket_age);
125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800127
Jerry Yufd310eb2022-09-06 09:16:35 +0800128 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
130 return 0;
131 }
Jerry Yu95699e72022-08-21 19:22:23 +0800132
Jerry Yu4746b102022-09-13 11:11:48 +0800133 /* We create a copy of the encrypted ticket since the ticket parsing
134 * function is allowed to use its input buffer as an output buffer
135 * (in-place decryption). We do, however, need the original buffer for
136 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800137 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100138 ticket_buffer = mbedtls_calloc(1, identity_len);
139 if (ticket_buffer == NULL) {
140 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
141 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800142 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800144
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
146 session,
147 ticket_buffer, identity_len)) != 0) {
148 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
149 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
150 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
151 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
152 } else {
153 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
154 }
Jerry Yu95699e72022-08-21 19:22:23 +0800155 }
156
157 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800161 goto exit;
162 }
Jerry Yu95699e72022-08-21 19:22:23 +0800163
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800164 /* RFC 8446 section 4.2.9
165 *
166 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
167 * compatible with the advertised modes; however, if a server does so,
168 * the impact will just be that the client's attempts at resumption fail.
169 *
170 * We regard the ticket with incompatible key exchange modes as not match.
171 */
Pengyu Lv18946532023-01-12 12:28:09 +0800172 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
Pengyu Lv4938a562023-01-16 11:28:49 +0800173 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4,
Pengyu Lv80270b22023-01-12 11:54:04 +0800174 session->ticket_flags);
Pengyu Lve2f1dbf2023-01-16 12:28:27 +0800175 if (mbedtls_ssl_tls13_check_kex_modes(
176 ssl,
177 mbedtls_ssl_session_get_ticket_flags(
178 session,
179 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL))) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800180 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
181 goto exit;
182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
185#if defined(MBEDTLS_HAVE_TIME)
186 now = mbedtls_time(NULL);
187
188 if (now < session->start) {
189 MBEDTLS_SSL_DEBUG_MSG(
190 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
191 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
192 (long long) now, (long long) session->start));
193 goto exit;
194 }
195
196 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800197
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800198 /* RFC 8446 section 4.6.1
199 *
200 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
201 *
202 * RFC 8446 section 4.2.11.1
203 *
204 * Clients MUST NOT attempt to use tickets which have ages greater than
205 * the "ticket_lifetime" value which was provided with the ticket.
206 *
207 * For time being, the age MUST be less than 604800 seconds (7 days).
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800210 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 3, ("Ticket age exceeds limitation ticket_age=%lu",
212 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800213 goto exit;
214 }
Jerry Yu95699e72022-08-21 19:22:23 +0800215
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800216 /* RFC 8446 section 4.2.10
217 *
218 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
219 * the ticket age for the selected PSK identity (computed by subtracting
220 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
221 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800222 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800223 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
224 * as the age units are different on the server (s) and in the
225 * client (ms) side. Add a -1000 ms tolerance window to take this
226 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800227 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800228 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
230 if (age_diff_in_ms <= -1000 ||
231 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800232 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100233 3, ("Ticket age outside tolerance window ( diff=%d )",
234 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800235 goto exit;
236 }
237
238 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800239
240#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800241
242exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (ret != 0) {
244 mbedtls_ssl_session_free(session);
245 }
Jerry Yu95699e72022-08-21 19:22:23 +0800246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
248 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800249}
250#endif /* MBEDTLS_SSL_SESSION_TICKETS */
251
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800252MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000253static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 mbedtls_ssl_context *ssl,
255 const unsigned char *identity,
256 size_t identity_len,
257 uint32_t obfuscated_ticket_age,
258 int *psk_type,
259 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000260{
Ronald Cron606671e2023-02-17 11:36:33 +0100261 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
262
Jerry Yu95699e72022-08-21 19:22:23 +0800263 ((void) session);
264 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800265 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800266
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800268 ssl->handshake->resume = 0;
269
Jerry Yu95699e72022-08-21 19:22:23 +0800270#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800272 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800274 ssl->handshake->resume = 1;
275 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Ronald Cron606671e2023-02-17 11:36:33 +0100276 ret = mbedtls_ssl_set_hs_psk(ssl,
277 session->resumption_key,
278 session->resumption_key_len);
279 if (ret != 0) {
280 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
281 return ret;
282 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100283
284 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
285 session->resumption_key,
286 session->resumption_key_len);
287 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
288 (unsigned) obfuscated_ticket_age));
289 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800290 }
291#endif /* MBEDTLS_SSL_SESSION_TICKETS */
292
Jerry Yu1c105562022-07-10 06:32:38 +0000293 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 if (ssl->conf->f_psk != NULL) {
295 if (ssl->conf->f_psk(
296 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
297 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000298 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000300 }
301
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000303 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800305 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 mbedtls_ct_memcmp(ssl->conf->psk_identity,
307 identity, identity_len) == 0) {
Ronald Cron606671e2023-02-17 11:36:33 +0100308 ret = mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
309 if (ret != 0) {
310 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
311 return ret;
312 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000314 }
315
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000317}
318
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800319MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100320static int ssl_tls13_offered_psks_check_binder_match(mbedtls_ssl_context *ssl,
321 const unsigned char *binder,
322 size_t binder_len,
323 int psk_type,
324 psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000325{
326 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800327
Jerry Yudaf375a2022-07-20 21:31:43 +0800328 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000329 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800330 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800331 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800332 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000333
Jerry Yu1c105562022-07-10 06:32:38 +0000334 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800335 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 ssl, mbedtls_hash_info_md_from_psa(psk_hash_alg),
337 transcript, sizeof(transcript), &transcript_len);
338 if (ret != 0) {
339 return ret;
340 }
Jerry Yu1c105562022-07-10 06:32:38 +0000341
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
343 if (ret != 0) {
344 return ret;
345 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800346
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
348 psk, psk_len, psk_type,
349 transcript,
350 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800351#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800353#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 if (ret != 0) {
355 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
356 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000357 }
358
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
360 server_computed_binder, transcript_len);
361 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000362
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
364 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000365 }
366
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 mbedtls_platform_zeroize(server_computed_binder,
368 sizeof(server_computed_binder));
369 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000370}
Jerry Yu96a2e362022-07-21 15:11:34 +0800371
Jerry Yu5725f1c2022-08-21 17:27:16 +0800372MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800373static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 mbedtls_ssl_context *ssl,
375 const unsigned char *cipher_suites,
376 const unsigned char *cipher_suites_end,
377 uint16_t *selected_ciphersuite,
378 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800379{
Jerry Yuf35ba382022-08-23 17:58:26 +0800380 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800381
Jerry Yu0baf9072022-08-25 11:21:04 +0800382 *selected_ciphersuite = 0;
383 *selected_ciphersuite_info = NULL;
384
Jerry Yuf35ba382022-08-23 17:58:26 +0800385 /* RFC 8446, page 55.
386 *
387 * For externally established PSKs, the Hash algorithm MUST be set when the
388 * PSK is established or default to SHA-256 if no such algorithm is defined.
389 *
390 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800391
Jerry Yu5725f1c2022-08-21 17:27:16 +0800392 /*
393 * Search for a matching ciphersuite
394 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 for (const unsigned char *p = cipher_suites;
396 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800397 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800398 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800399
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
401 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
402 cipher_suite);
403 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800404 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800406
Jerry Yu5725f1c2022-08-21 17:27:16 +0800407 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
408 * Otherwise, client should reject.
409 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 if (psk_hash_alg == mbedtls_psa_translate_md(ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800411 *selected_ciphersuite = cipher_suite;
412 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800414 }
415 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
417 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800418}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800419
Jerry Yu82534862022-08-30 10:42:33 +0800420#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800421MBEDTLS_CHECK_RETURN_CRITICAL
422static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 mbedtls_ssl_context *ssl,
424 const unsigned char *cipher_suites,
425 const unsigned char *cipher_suites_end,
426 mbedtls_ssl_session *session,
427 uint16_t *selected_ciphersuite,
428 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800429{
Jerry Yu82534862022-08-30 10:42:33 +0800430
Jerry Yuf35ba382022-08-23 17:58:26 +0800431 *selected_ciphersuite = 0;
432 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
434 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800435 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
436
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800438 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 }
Jerry Yu82534862022-08-30 10:42:33 +0800440
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
442 cipher_suite);
443 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800444 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 }
Jerry Yu82534862022-08-30 10:42:33 +0800446
Jerry Yu4746b102022-09-13 11:11:48 +0800447 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800448 *selected_ciphersuite_info = ciphersuite_info;
449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800451 }
452
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800454}
Jerry Yuf35ba382022-08-23 17:58:26 +0800455
Jerry Yu82534862022-08-30 10:42:33 +0800456MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100457static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
458 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800459{
Jerry Yu82534862022-08-30 10:42:33 +0800460 dst->ticket_age_add = src->ticket_age_add;
461 dst->ticket_flags = src->ticket_flags;
462 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100463 if (src->resumption_key_len == 0) {
464 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
465 }
466 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800467
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800469}
470#endif /* MBEDTLS_SSL_SESSION_TICKETS */
471
Jerry Yu1c105562022-07-10 06:32:38 +0000472/* Parser for pre_shared_key extension in client hello
473 * struct {
474 * opaque identity<1..2^16-1>;
475 * uint32 obfuscated_ticket_age;
476 * } PskIdentity;
477 *
478 * opaque PskBinderEntry<32..255>;
479 *
480 * struct {
481 * PskIdentity identities<7..2^16-1>;
482 * PskBinderEntry binders<33..2^16-1>;
483 * } OfferedPsks;
484 *
485 * struct {
486 * select (Handshake.msg_type) {
487 * case client_hello: OfferedPsks;
488 * ....
489 * };
490 * } PreSharedKeyExtension;
491 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800492MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100493static int ssl_tls13_parse_pre_shared_key_ext(mbedtls_ssl_context *ssl,
494 const unsigned char *pre_shared_key_ext,
495 const unsigned char *pre_shared_key_ext_end,
496 const unsigned char *ciphersuites,
497 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000498{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100499 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800500 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800501 const unsigned char *p_identity_len;
502 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000503 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800504 const unsigned char *binders;
505 const unsigned char *p_binder_len;
506 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000507 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800508 int matched_identity = -1;
509 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000510
Gilles Peskine449bd832023-01-11 14:50:10 +0100511 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
512 pre_shared_key_ext,
513 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000514
Jerry Yu96a2e362022-07-21 15:11:34 +0800515 /* identities_len 2 bytes
516 * identities_data >= 7 bytes
517 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
519 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800520 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
522 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800523 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000524
Jerry Yu96a2e362022-07-21 15:11:34 +0800525 /* binders_len 2 bytes
526 * binders >= 33 bytes
527 */
Jerry Yu568ec252022-07-22 21:27:34 +0800528 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
530 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800531 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800533 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000534
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100535 ret = ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
536 identities_end - pre_shared_key_ext);
537 if (0 != ret) {
538 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
539 return ret;
540 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800541
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000543 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800544 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800545 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800546 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800547 size_t binder_len;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800548 int psk_type;
549 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800550 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800551#if defined(MBEDTLS_SSL_SESSION_TICKETS)
552 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800554#endif
Jerry Yubb852022022-07-20 21:10:44 +0800555
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
557 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800558 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
560 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800561 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000562
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800564 binder_len = *p_binder_len;
565 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800567 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800568
Jerry Yu96a2e362022-07-21 15:11:34 +0800569 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000571 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 }
Jerry Yu1c105562022-07-10 06:32:38 +0000573
Jerry Yu96a2e362022-07-21 15:11:34 +0800574 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 ssl, identity, identity_len, obfuscated_ticket_age,
576 &psk_type, &session);
577 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800578 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800580
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
582 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800583 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
584 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 ssl, ciphersuites, ciphersuites_end,
586 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800587 break;
588 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800589#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800590 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 ssl, ciphersuites, ciphersuites_end, &session,
592 &cipher_suite, &ciphersuite_info);
593 if (ret != 0) {
594 mbedtls_ssl_session_free(&session);
595 }
Jerry Yu82534862022-08-30 10:42:33 +0800596#else
597 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
598#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800599 break;
600 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800602 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100603 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800604 /* See below, no cipher_suite available, abort handshake */
605 MBEDTLS_SSL_PEND_FATAL_ALERT(
606 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800608 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 2, "ssl_tls13_select_ciphersuite", ret);
610 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800611 }
612
Jerry Yu96a2e362022-07-21 15:11:34 +0800613 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 ssl, binder, binder_len, psk_type,
615 mbedtls_psa_translate_md(ciphersuite_info->mac));
616 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800617 /* For security reasons, the handshake should be aborted when we
618 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
619 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800620#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800622#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
624 MBEDTLS_SSL_DEBUG_RET(1,
625 "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800626 MBEDTLS_SSL_PEND_FATAL_ALERT(
627 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100628 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
629 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800630 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800631
632 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800633
634 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800635 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800636 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100637 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
638 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800639#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
641 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
642 &session);
643 mbedtls_ssl_session_free(&session);
644 if (ret != 0) {
645 return ret;
646 }
Jerry Yu82534862022-08-30 10:42:33 +0800647 }
648#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000649 }
650
Gilles Peskine449bd832023-01-11 14:50:10 +0100651 if (p_identity_len != identities_end || p_binder_len != binders_end) {
652 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
653 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
654 MBEDTLS_ERR_SSL_DECODE_ERROR);
655 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000656 }
657
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800658 /* Update the handshake transcript with the binder list. */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100659 ret = ssl->handshake->update_checksum(ssl,
660 identities_end,
661 (size_t) (binders_end - identities_end));
662 if (0 != ret) {
663 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
664 return ret;
665 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100666 if (matched_identity == -1) {
667 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
668 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000669 }
670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 ssl->handshake->selected_identity = (uint16_t) matched_identity;
672 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000673
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000675}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000676
677/*
678 * struct {
679 * select ( Handshake.msg_type ) {
680 * ....
681 * case server_hello:
682 * uint16 selected_identity;
683 * }
684 * } PreSharedKeyExtension;
685 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
687 unsigned char *buf,
688 unsigned char *end,
689 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000690{
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000692
693 *olen = 0;
694
David Horstmann21b89762022-10-06 18:34:28 +0100695 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000696#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000698#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000700#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000702 /* We shouldn't have called this extension writer unless we've
703 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000705 }
706
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
708 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000709
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
711 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000714
715 *olen = 6;
716
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
718 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000719
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000723}
724
Ronald Cron41a443a2022-10-04 16:38:25 +0200725#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000726
XiaokangQian7807f9f2022-02-15 10:04:37 +0000727/* From RFC 8446:
728 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000729 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000730 * } SupportedVersions;
731 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200732MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100733static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
734 const unsigned char *buf,
735 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000736{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000737 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000738 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000739 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000740 uint16_t tls_version;
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100741 int found_supported_version = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000744 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000745 p += 1;
746
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000748 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 while (p < versions_end) {
750 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
751 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000752 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000753
Ronald Cron3bd2b022023-04-03 16:45:39 +0200754 if (MBEDTLS_SSL_VERSION_TLS1_3 == tls_version) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100755 found_supported_version = 1;
756 break;
757 }
758
Ronald Cron3bd2b022023-04-03 16:45:39 +0200759 if ((MBEDTLS_SSL_VERSION_TLS1_2 == tls_version) &&
760 mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100761 found_supported_version = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000762 break;
763 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000764 }
765
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100766 if (!found_supported_version) {
767 MBEDTLS_SSL_DEBUG_MSG(1, ("No supported version found."));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000768
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
770 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
771 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000772 }
773
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100774 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version: [%04x]",
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000776
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100777 return (int) tls_version;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000778}
779
Valerio Setti080a22b2023-03-20 15:22:47 +0100780#if defined(PSA_WANT_ALG_ECDH)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000781/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000782 *
783 * From RFC 8446:
784 * enum {
785 * ... (0xFFFF)
786 * } NamedGroup;
787 * struct {
788 * NamedGroup named_group_list<2..2^16-1>;
789 * } NamedGroupList;
790 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200791MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100792static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
793 const unsigned char *buf,
794 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000795{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000796 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000797 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000798 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000799
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
801 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
802 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000803 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100804 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000805 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000806 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000807
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000809 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
811 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000812 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000813
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 MBEDTLS_SSL_DEBUG_MSG(2,
815 ("got named group: %s(%04x)",
816 mbedtls_ssl_named_group_to_str(named_group),
817 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000818
Gilles Peskine449bd832023-01-11 14:50:10 +0100819 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
820 !mbedtls_ssl_named_group_is_supported(named_group) ||
821 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000822 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000823 }
824
Gilles Peskine449bd832023-01-11 14:50:10 +0100825 MBEDTLS_SSL_DEBUG_MSG(2,
826 ("add named group %s(%04x) into received list.",
827 mbedtls_ssl_named_group_to_str(named_group),
828 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800829
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000830 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000831 }
832
Gilles Peskine449bd832023-01-11 14:50:10 +0100833 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000834
835}
Valerio Setti080a22b2023-03-20 15:22:47 +0100836#endif /* PSA_WANT_ALG_ECDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000837
XiaokangQian08037552022-04-20 07:16:41 +0000838#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
839
Valerio Setti080a22b2023-03-20 15:22:47 +0100840#if defined(PSA_WANT_ALG_ECDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000841/*
842 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000843 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000844 *
845 * Possible return values are:
846 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000847 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000848 * does not match a group supported by the server. A HelloRetryRequest will
849 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000850 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800851 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200852MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100853static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
854 const unsigned char *buf,
855 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000856{
XiaokangQianb67384d2022-04-19 00:02:38 +0000857 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000858 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000859 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800860 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000861
862 /* From RFC 8446:
863 *
864 * struct {
865 * KeyShareEntry client_shares<0..2^16-1>;
866 * } KeyShareClientHello;
867 *
868 */
869
Gilles Peskine449bd832023-01-11 14:50:10 +0100870 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
871 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000872 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100873 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000874
875 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000876 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000877
878 /* We try to find a suitable key share entry and copy it to the
879 * handshake context. Later, we have to find out whether we can do
880 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000881 * dismiss it and send a HelloRetryRequest message.
882 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000883
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000885 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800886 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800887 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000888
889 /*
890 * struct {
891 * NamedGroup group;
892 * opaque key_exchange<1..2^16-1>;
893 * } KeyShareEntry;
894 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100895 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
896 group = MBEDTLS_GET_UINT16_BE(p, 0);
897 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800898 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800899 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100900 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800901 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000902
903 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000904 * for input validation purposes.
905 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
907 !mbedtls_ssl_named_group_is_supported(group) ||
908 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000909 continue;
910 }
XiaokangQian060d8672022-04-21 09:24:56 +0000911
XiaokangQian7807f9f2022-02-15 10:04:37 +0000912 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000913 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000914 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
916 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH group: %s (%04x)",
917 mbedtls_ssl_named_group_to_str(group),
918 group));
XiaokangQian318dc762022-04-20 09:43:51 +0000919 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100920 ssl, key_exchange - 2, key_exchange_len + 2);
921 if (ret != 0) {
922 return ret;
923 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000924
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 } else {
926 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
927 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000928 continue;
929 }
930
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000931 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000932 }
933
Jerry Yuc1be19f2022-04-23 16:11:39 +0800934
Gilles Peskine449bd832023-01-11 14:50:10 +0100935 if (ssl->handshake->offered_group_id == 0) {
936 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
937 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000938 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000940}
Valerio Setti080a22b2023-03-20 15:22:47 +0100941#endif /* PSA_WANT_ALG_ECDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000942
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200943MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100944static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
945 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000946{
Jerry Yu0c354a22022-08-29 15:25:36 +0800947 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000949}
950
Jerry Yue5991322022-11-07 14:03:44 +0800951#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200952MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000953static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000955{
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 return ssl_tls13_client_hello_has_exts(
957 ssl,
958 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
959 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
960 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000961}
Jerry Yue5991322022-11-07 14:03:44 +0800962#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000963
Jerry Yue5991322022-11-07 14:03:44 +0800964#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000965MBEDTLS_CHECK_RETURN_CRITICAL
966static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000968{
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 return ssl_tls13_client_hello_has_exts(
970 ssl,
971 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
972 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000973}
Jerry Yue5991322022-11-07 14:03:44 +0800974#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000975
Jerry Yue5991322022-11-07 14:03:44 +0800976#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000977MBEDTLS_CHECK_RETURN_CRITICAL
978static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000980{
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 return ssl_tls13_client_hello_has_exts(
982 ssl,
983 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
984 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
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_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000989
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200990MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100991static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000992{
Jerry Yue5991322022-11-07 14:03:44 +0800993#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
995 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800996#else
997 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 return 0;
Jerry Yue5991322022-11-07 14:03:44 +0800999#endif
Jerry Yu77f01482022-07-11 07:03:24 +00001000}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001001
Jerry Yu77f01482022-07-11 07:03:24 +00001002MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001003static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001004{
Jerry Yue5991322022-11-07 14:03:44 +08001005#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
1007 mbedtls_ssl_tls13_psk_enabled(ssl) &&
1008 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001009#else
1010 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001012#endif
1013}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001014
Jerry Yu77f01482022-07-11 07:03:24 +00001015MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001016static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001017{
Jerry Yue5991322022-11-07 14:03:44 +08001018#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
1020 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1021 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001022#else
1023 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001025#endif
1026}
1027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001029{
1030 /*
1031 * Determine the key exchange algorithm to use.
1032 * There are three types of key exchanges supported in TLS 1.3:
1033 * - (EC)DH with ECDSA,
1034 * - (EC)DH with PSK,
1035 * - plain PSK.
1036 *
1037 * The PSK-based key exchanges may additionally be used with 0-RTT.
1038 *
1039 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001040 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1041 * 2 ) Certificate Mode ( ephemeral )
1042 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001043 */
1044
1045 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1046
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001048 ssl->handshake->key_exchange_mode =
1049 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001050 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1051 } else
1052 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001053 ssl->handshake->key_exchange_mode =
1054 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1056 } else
1057 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001058 ssl->handshake->key_exchange_mode =
1059 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1061 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001062 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 1,
1064 ("ClientHello message misses mandatory extensions."));
1065 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1066 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1067 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001068 }
1069
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001071
XiaokangQian7807f9f2022-02-15 10:04:37 +00001072}
1073
XiaokangQian81802f42022-06-10 13:25:22 +00001074#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001075 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001076
1077#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001078static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001079{
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001081 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001083 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001085 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001087 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001089 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001091 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001093 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001095 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001097 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001099 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001101 }
1102}
1103#endif /* MBEDTLS_USE_PSA_CRYPTO */
1104
XiaokangQian23c5be62022-06-07 02:04:34 +00001105/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001106 * Pick best ( private key, certificate chain ) pair based on the signature
1107 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001108 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001109MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001110static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001111{
XiaokangQianfb665a82022-06-15 03:57:21 +00001112 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001113 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001114
1115#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001117 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001119#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001121
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 if (key_cert_list == NULL) {
1123 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1124 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001125 }
1126
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1128 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001129 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001133 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001135
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 for (key_cert = key_cert_list; key_cert != NULL;
1137 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001138#if defined(MBEDTLS_USE_PSA_CRYPTO)
1139 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1140#endif /* MBEDTLS_USE_PSA_CRYPTO */
1141
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1143 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001144
1145 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 * This avoids sending the client a cert it'll reject based on
1147 * keyUsage or other extensions.
1148 */
1149 if (mbedtls_x509_crt_check_key_usage(
1150 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001151 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001152 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1154 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1155 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001156 continue;
1157 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001158
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 MBEDTLS_SSL_DEBUG_MSG(3,
1160 ("ssl_tls13_pick_key_cert:"
1161 "check signature algorithm %s [%04x]",
1162 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1163 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001164#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001166#endif /* MBEDTLS_USE_PSA_CRYPTO */
1167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1169 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001170#if defined(MBEDTLS_USE_PSA_CRYPTO)
1171 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1173 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001174#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001176 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 MBEDTLS_SSL_DEBUG_MSG(3,
1178 ("ssl_tls13_pick_key_cert:"
1179 "selected signature algorithm"
1180 " %s [%04x]",
1181 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1182 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001183 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 3, "selected certificate (chain)",
1185 ssl->handshake->key_cert->cert);
1186 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001187 }
XiaokangQian81802f42022-06-10 13:25:22 +00001188 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001189 }
1190
Gilles Peskine449bd832023-01-11 14:50:10 +01001191 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1192 "no suitable certificate found"));
1193 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001194}
XiaokangQian81802f42022-06-10 13:25:22 +00001195#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001196 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001197
XiaokangQian4080a7f2022-04-11 09:55:18 +00001198/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001199 *
1200 * STATE HANDLING: ClientHello
1201 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001202 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001203 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001204 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001205 *
1206 * In this case, the server progresses to sending its ServerHello.
1207 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001208 * 2) The ClientHello was well-formed but didn't match the server's
1209 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001210 *
1211 * For example, the client might not have offered a key share which
1212 * the server supports, or the server might require a cookie.
1213 *
1214 * In this case, the server sends a HelloRetryRequest.
1215 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001216 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001217 *
1218 * In this case, we abort the handshake.
1219 *
1220 */
1221
1222/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001223 * Structure of this message:
1224 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001225 * uint16 ProtocolVersion;
1226 * opaque Random[32];
1227 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001228 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001229 * struct {
1230 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1231 * Random random;
1232 * opaque legacy_session_id<0..32>;
1233 * CipherSuite cipher_suites<2..2^16-2>;
1234 * opaque legacy_compression_methods<1..2^8-1>;
1235 * Extension extensions<8..2^16-1>;
1236 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001237 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001238
1239#define SSL_CLIENT_HELLO_OK 0
1240#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001241#define SSL_CLIENT_HELLO_TLS1_2 2
XiaokangQianed582dd2022-04-13 08:21:05 +00001242
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001243MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001244static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1245 const unsigned char *buf,
1246 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001247{
XiaokangQianb67384d2022-04-19 00:02:38 +00001248 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1249 const unsigned char *p = buf;
Ronald Crond540d992023-03-07 09:41:48 +01001250 const unsigned char *random;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001251 size_t legacy_session_id_len;
Ronald Croncada4102023-03-07 09:51:39 +01001252 const unsigned char *legacy_session_id;
XiaokangQian318dc762022-04-20 09:43:51 +00001253 size_t cipher_suites_len;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001254 const unsigned char *cipher_suites;
XiaokangQian060d8672022-04-21 09:24:56 +00001255 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001256 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001257 const unsigned char *extensions_end;
Ronald Croneff56732023-04-03 17:36:31 +02001258 const unsigned char *supported_versions_data;
1259 const unsigned char *supported_versions_data_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001260 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001261 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001262
Ronald Cron41a443a2022-10-04 16:38:25 +02001263#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu29d9faa2022-08-23 17:52:45 +08001264 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001265 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001266#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001267
XiaokangQian7807f9f2022-02-15 10:04:37 +00001268 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001269 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001270 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001271 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001272 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001273 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001274 * .. . .. ciphersuite list length ( 2 bytes )
1275 * .. . .. ciphersuite list
1276 * .. . .. compression alg. list length ( 1 byte )
1277 * .. . .. compression alg. list
1278 * .. . .. extensions length ( 2 bytes, optional )
1279 * .. . .. extensions ( optional )
1280 */
1281
XiaokangQianb67384d2022-04-19 00:02:38 +00001282 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001283 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001284 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1285 * read at least up to session id length without worrying.
1286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001287 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001288
1289 /* ...
1290 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1291 * ...
1292 * with ProtocolVersion defined as:
1293 * uint16 ProtocolVersion;
1294 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1296 MBEDTLS_SSL_VERSION_TLS1_2) {
1297 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1298 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1299 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1300 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001301 }
1302 p += 2;
1303
Jerry Yuc1be19f2022-04-23 16:11:39 +08001304 /* ...
1305 * Random random;
1306 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001307 * with Random defined as:
1308 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001309 */
Ronald Crond540d992023-03-07 09:41:48 +01001310 random = p;
XiaokangQian08037552022-04-20 07:16:41 +00001311 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001312
Jerry Yuc1be19f2022-04-23 16:11:39 +08001313 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001314 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001315 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001316 */
Ronald Croncada4102023-03-07 09:51:39 +01001317 legacy_session_id_len = *(p++);
1318 legacy_session_id = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001319
XiaokangQianb67384d2022-04-19 00:02:38 +00001320 /*
1321 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001322 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001323 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001325 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001326
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001327 /* ...
1328 * CipherSuite cipher_suites<2..2^16-2>;
1329 * ...
1330 * with CipherSuite defined as:
1331 * uint8 CipherSuite[2];
1332 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001334 p += 2;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001335 cipher_suites = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001336
Ronald Cronfc7ae872023-02-16 15:32:19 +01001337 /*
1338 * The length of the ciphersuite list has to be even.
1339 */
1340 if (cipher_suites_len & 1) {
1341 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1342 MBEDTLS_ERR_SSL_DECODE_ERROR);
1343 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1344 }
1345
XiaokangQianb67384d2022-04-19 00:02:38 +00001346 /* Check we have enough data for the ciphersuite list, the legacy
1347 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001348 *
1349 * cipher_suites cipher_suites_len bytes
1350 * legacy_compression_methods 2 bytes
1351 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
Ronald Cron8c527d02023-03-07 15:47:47 +01001354 p += cipher_suites_len;
1355 cipher_suites_end = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001356
1357 /*
Ronald Cron8c527d02023-03-07 15:47:47 +01001358 * Search for the supported versions extension and parse it to determine
1359 * if the client supports TLS 1.3.
1360 */
1361 ret = mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1362 ssl, p + 2, end,
Ronald Croneff56732023-04-03 17:36:31 +02001363 &supported_versions_data, &supported_versions_data_end);
Ronald Cron8c527d02023-03-07 15:47:47 +01001364 if (ret < 0) {
1365 MBEDTLS_SSL_DEBUG_RET(1,
1366 ("mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts"), ret);
1367 return ret;
1368 }
1369
1370 if (ret == 0) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001371 return SSL_CLIENT_HELLO_TLS1_2;
Ronald Cron8c527d02023-03-07 15:47:47 +01001372 }
1373
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001374 if (ret == 1) {
1375 ret = ssl_tls13_parse_supported_versions_ext(ssl,
Ronald Croneff56732023-04-03 17:36:31 +02001376 supported_versions_data,
1377 supported_versions_data_end);
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001378 if (ret < 0) {
1379 MBEDTLS_SSL_DEBUG_RET(1,
1380 ("ssl_tls13_parse_supported_versions_ext"), ret);
1381 return ret;
1382 }
1383
Ronald Cronb828c7d2023-04-03 16:37:22 +02001384 /*
1385 * The supported versions extension was parsed successfully as the
1386 * value returned by ssl_tls13_parse_supported_versions_ext() is
1387 * positive. The return value is then equal to
1388 * MBEDTLS_SSL_VERSION_TLS1_2 or MBEDTLS_SSL_VERSION_TLS1_3, defining
1389 * the TLS version to negotiate.
1390 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001391 if (MBEDTLS_SSL_VERSION_TLS1_2 == ret) {
1392 return SSL_CLIENT_HELLO_TLS1_2;
1393 }
Ronald Cron8c527d02023-03-07 15:47:47 +01001394 }
1395
1396 /*
1397 * We negotiate TLS 1.3.
Ronald Cron64582392023-03-07 09:21:40 +01001398 */
1399 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1400
1401#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1402 /* Store minor version for later use with ticket serialization. */
1403 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1404 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1405#endif
1406
1407 /*
Ronald Crond540d992023-03-07 09:41:48 +01001408 * We are negotiation the version 1.3 of the protocol. Do what we have
Ronald Croncada4102023-03-07 09:51:39 +01001409 * postponed: copy of the client random bytes, copy of the legacy session
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001410 * identifier and selection of the TLS 1.3 cipher suite.
Ronald Crond540d992023-03-07 09:41:48 +01001411 */
1412 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1413 random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1414 memcpy(&handshake->randbytes[0], random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1415
Ronald Croncada4102023-03-07 09:51:39 +01001416 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1417 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1418 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1419 }
1420 ssl->session_negotiate->id_len = legacy_session_id_len;
1421 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1422 legacy_session_id, legacy_session_id_len);
1423 memcpy(&ssl->session_negotiate->id[0],
1424 legacy_session_id, legacy_session_id_len);
1425
Ronald Crond540d992023-03-07 09:41:48 +01001426 /*
Jerry Yu5725f1c2022-08-21 17:27:16 +08001427 * Search for a matching ciphersuite
1428 */
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001429 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, list of cipher suites",
1430 cipher_suites, cipher_suites_len);
Ronald Crone45afd72023-04-04 15:10:06 +02001431 for (const unsigned char *cipher_suites_p = cipher_suites;
1432 cipher_suites_p < cipher_suites_end; cipher_suites_p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001433 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001435
Ronald Crond89360b2023-02-21 08:53:33 +01001436 /*
Ronald Crone45afd72023-04-04 15:10:06 +02001437 * "cipher_suites_end - cipher_suites_p is even" is an invariant of the
1438 * loop. As cipher_suites_end - cipher_suites_p > 0, we have
1439 * cipher_suites_end - cipher_suites_p >= 2 and it is thus safe to read
1440 * two bytes.
Ronald Crond89360b2023-02-21 08:53:33 +01001441 */
Ronald Crone45afd72023-04-04 15:10:06 +02001442 cipher_suite = MBEDTLS_GET_UINT16_BE(cipher_suites_p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001443 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 ssl, cipher_suite);
1445 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001446 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001448
Jerry Yu5725f1c2022-08-21 17:27:16 +08001449 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001450 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1452 cipher_suite,
1453 ciphersuite_info->name));
Ronald Cron25e9ec62023-02-16 15:35:16 +01001454 break;
XiaokangQian17f974c2022-04-19 09:57:41 +00001455 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 if (handshake->ciphersuite_info == NULL) {
1458 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1459 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1460 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001461 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001462
XiaokangQian4080a7f2022-04-11 09:55:18 +00001463 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001464 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001465 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1468 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1469 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1470 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1471 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001472 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001473 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001474
Jerry Yuc1be19f2022-04-23 16:11:39 +08001475 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001476 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001477 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001478 * with Extension defined as:
1479 * struct {
1480 * ExtensionType extension_type;
1481 * opaque extension_data<0..2^16-1>;
1482 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001485 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001487 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001488
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
Jerry Yu63a459c2022-10-31 13:38:40 +08001490 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001491
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001493 unsigned int extension_type;
1494 size_t extension_data_len;
1495 const unsigned char *extension_data_end;
1496
Jerry Yu0c354a22022-08-29 15:25:36 +08001497 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001498 *
1499 * The "pre_shared_key" extension MUST be the last extension in the
1500 * ClientHello (this facilitates implementation as described below).
1501 * Servers MUST check that it is the last extension and otherwise fail
1502 * the handshake with an "illegal_parameter" alert.
1503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001505 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001507 MBEDTLS_SSL_PEND_FATAL_ALERT(
1508 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1510 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001511 }
1512
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1514 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1515 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001516 p += 4;
1517
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001519 extension_data_end = p + extension_data_len;
1520
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001521 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1523 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1524 if (ret != 0) {
1525 return ret;
1526 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001527
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001529#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1530 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1532 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1533 extension_data_end);
1534 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001535 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 1, "mbedtls_ssl_parse_servername_ext", ret);
1537 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001538 }
XiaokangQian40a35232022-05-07 09:02:40 +00001539 break;
1540#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1541
Valerio Setti080a22b2023-03-20 15:22:47 +01001542#if defined(PSA_WANT_ALG_ECDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001543 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001545
1546 /* Supported Groups Extension
1547 *
1548 * When sent by the client, the "supported_groups" extension
1549 * indicates the named groups which the client supports,
1550 * ordered from most preferred to least preferred.
1551 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001552 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 ssl, p, extension_data_end);
1554 if (ret != 0) {
1555 MBEDTLS_SSL_DEBUG_RET(1,
1556 "mbedtls_ssl_parse_supported_groups_ext", ret);
1557 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001558 }
1559
XiaokangQian7807f9f2022-02-15 10:04:37 +00001560 break;
Valerio Setti080a22b2023-03-20 15:22:47 +01001561#endif /* PSA_WANT_ALG_ECDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001562
Valerio Setti080a22b2023-03-20 15:22:47 +01001563#if defined(PSA_WANT_ALG_ECDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001564 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001566
1567 /*
1568 * Key Share Extension
1569 *
1570 * When sent by the client, the "key_share" extension
1571 * contains the endpoint's cryptographic parameters for
1572 * ECDHE/DHE key establishment methods.
1573 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001574 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001575 ssl, p, extension_data_end);
1576 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1577 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001578 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001579 }
1580
Gilles Peskine449bd832023-01-11 14:50:10 +01001581 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001582 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 1, "ssl_tls13_parse_key_shares_ext", ret);
1584 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001585 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001586
XiaokangQian7807f9f2022-02-15 10:04:37 +00001587 break;
Valerio Setti080a22b2023-03-20 15:22:47 +01001588#endif /* PSA_WANT_ALG_ECDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001589
1590 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Ronald Cron8c527d02023-03-07 15:47:47 +01001591 /* Already parsed */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001592 break;
1593
Ronald Cron41a443a2022-10-04 16:38:25 +02001594#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001595 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001597
1598 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 ssl, p, extension_data_end);
1600 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001601 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1603 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001604 }
1605
Jerry Yue19e3b92022-07-08 12:04:51 +00001606 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001607#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001608
Jerry Yu1c105562022-07-10 06:32:38 +00001609 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001610 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1611 if ((handshake->received_extensions &
1612 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001613 MBEDTLS_SSL_PEND_FATAL_ALERT(
1614 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1616 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001617 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001618#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001619 /* Delay processing of the PSK identity once we have
1620 * found out which algorithms to use. We keep a pointer
1621 * to the buffer and the size for later processing.
1622 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001623 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001624 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001625#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001626 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001627
XiaokangQianacb39922022-06-17 10:18:48 +00001628#if defined(MBEDTLS_SSL_ALPN)
1629 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1633 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001634 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1636 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001637 }
XiaokangQianacb39922022-06-17 10:18:48 +00001638 break;
1639#endif /* MBEDTLS_SSL_ALPN */
1640
Ronald Cron928cbd32022-10-04 16:14:26 +02001641#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001642 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001644
Gabor Mezei078e8032022-04-27 21:17:56 +02001645 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 ssl, p, extension_data_end);
1647 if (ret != 0) {
1648 MBEDTLS_SSL_DEBUG_MSG(1,
1649 (
1650 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1651 ret));
1652 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001653 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001654 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001655#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001656
Jan Bruckner151f6422023-02-10 12:45:19 +01001657#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1658 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
1659 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
1660
1661 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(ssl, p, extension_data_end);
1662
Jan Bruckner1a38e542023-03-15 14:15:11 +01001663 /* TODO: Return unconditionally here until we handle the record size limit correctly.
1664 * Once handled correctly, only return in case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01001665 return ret;
1666
1667 break;
1668#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1669
XiaokangQian7807f9f2022-02-15 10:04:37 +00001670 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001671 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001672 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001674 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001675 }
1676
1677 p += extension_data_len;
1678 }
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1681 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001682
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001683 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1684 MBEDTLS_SSL_HS_CLIENT_HELLO,
1685 p - buf);
1686 if (0 != ret) {
1687 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1688 return ret;
1689 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001690
Ronald Cron41a443a2022-10-04 16:38:25 +02001691#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001692 /* Update checksum with either
1693 * - The entire content of the CH message, if no PSK extension is present
1694 * - The content up to but excluding the PSK extension, if present.
1695 */
Jerry Yu1c105562022-07-10 06:32:38 +00001696 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1698 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1699 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001700 ret = handshake->update_checksum(ssl, buf,
1701 pre_shared_key_ext - buf);
1702 if (0 != ret) {
1703 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1704 return ret;
1705 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1707 pre_shared_key_ext,
1708 pre_shared_key_ext_end,
1709 cipher_suites,
1710 cipher_suites_end);
1711 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1712 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1713 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001714 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1716 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001717 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001719#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001720 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001721 ret = handshake->update_checksum(ssl, buf, p - buf);
1722 if (0 != ret) {
1723 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1724 return ret;
1725 }
Jerry Yu1c105562022-07-10 06:32:38 +00001726 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1729 if (ret < 0) {
1730 return ret;
1731 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001732
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001734
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001736}
1737
1738/* Update the handshake state machine */
1739
Ronald Cronce7d76e2022-07-08 18:56:49 +02001740MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001741static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001742{
1743 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1744
XiaokangQian7807f9f2022-02-15 10:04:37 +00001745 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001746 * Server certificate selection
1747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1749 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1750 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001751 }
1752#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1753 ssl->handshake->sni_name = NULL;
1754 ssl->handshake->sni_name_len = 0;
1755#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001756
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1758 if (ret != 0) {
1759 MBEDTLS_SSL_DEBUG_RET(1,
1760 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1761 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001762 }
1763
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001765
1766}
1767
1768/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001769 * Main entry point from the state machine; orchestrates the otherfunctions.
1770 */
1771
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001772MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001773static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001774{
1775
XiaokangQian08037552022-04-20 07:16:41 +00001776 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001778 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001779 int parse_client_hello_ret;
1780
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001782
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1784 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1785 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001786
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1788 buf + buflen));
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001789 parse_client_hello_ret = ret; /* Store positive return value of
1790 * parse_client_hello,
1791 * as negative error codes are handled
Jerry Yuf41553b2022-05-09 22:20:30 +08001792 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001793
Ronald Cronb828c7d2023-04-03 16:37:22 +02001794 /*
1795 * Version 1.2 of the protocol has been chosen, set the
1796 * ssl->keep_current_message flag for the ClientHello to be kept and parsed
1797 * as a TLS 1.2 ClientHello. We also change ssl->tls_version to
1798 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1799 * will dispatch to the TLS 1.2 state machine.
1800 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001801 if (SSL_CLIENT_HELLO_TLS1_2 == parse_client_hello_ret) {
1802 ssl->keep_current_message = 1;
1803 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
1804 return 0;
1805 }
1806
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001808
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001809 if (SSL_CLIENT_HELLO_OK == parse_client_hello_ret) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1811 } else {
1812 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1813 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001814
1815cleanup:
1816
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1818 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001819}
1820
1821/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001822 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001823 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001824MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001825static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001826{
Jerry Yu637a3f12022-04-20 21:37:58 +08001827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1828 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1830 if (ssl->conf->f_rng == NULL) {
1831 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1832 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001833 }
1834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1836 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1837 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1838 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001839 }
1840
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1842 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001843
1844#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001846#endif /* MBEDTLS_HAVE_TIME */
1847
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001849}
1850
Jerry Yu3bf2c642022-03-30 22:02:12 +08001851/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001852 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001853 *
1854 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001855 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001856 * } SupportedVersions;
1857 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001858MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001859static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 mbedtls_ssl_context *ssl,
1861 unsigned char *buf,
1862 unsigned char *end,
1863 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001864{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001865 *out_len = 0;
1866
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001868
1869 /* Check if we have space to write the extension:
1870 * - extension_type (2 bytes)
1871 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001872 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001873 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001875
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 mbedtls_ssl_write_version(buf + 4,
1881 ssl->conf->transport,
1882 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001883
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1885 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001886
Jerry Yu349a6132022-04-14 20:52:56 +08001887 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001888
Jerry Yub95dd362022-11-08 21:19:34 +08001889 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001893}
1894
Jerry Yud9436a12022-04-20 22:28:09 +08001895
Jerry Yu3bf2c642022-03-30 22:02:12 +08001896
1897/* Generate and export a single key share. For hybrid KEMs, this can
1898 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001899MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001900static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1901 uint16_t named_group,
1902 unsigned char *buf,
1903 unsigned char *end,
1904 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001905{
1906 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001907
1908 *out_len = 0;
1909
Valerio Setti080a22b2023-03-20 15:22:47 +01001910#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001912 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 ssl, named_group, buf, end, out_len);
1914 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001915 MBEDTLS_SSL_DEBUG_RET(
1916 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 ret);
1918 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001919 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 } else
Valerio Setti080a22b2023-03-20 15:22:47 +01001921#endif /* PSA_WANT_ALG_ECDH */
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 if (0 /* Other kinds of KEMs */) {
1923 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001924 ((void) ssl);
1925 ((void) named_group);
1926 ((void) buf);
1927 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001928 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1929 }
1930
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001932}
1933
1934/*
1935 * ssl_tls13_write_key_share_ext
1936 *
1937 * Structure of key_share extension in ServerHello:
1938 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001939 * struct {
1940 * NamedGroup group;
1941 * opaque key_exchange<1..2^16-1>;
1942 * } KeyShareEntry;
1943 * struct {
1944 * KeyShareEntry server_share;
1945 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001946 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001947MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001948static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1949 unsigned char *buf,
1950 unsigned char *end,
1951 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001952{
Jerry Yu955ddd72022-04-22 22:27:33 +08001953 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001954 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001955 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001956 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001957 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001958
1959 *out_len = 0;
1960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001962
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1964 mbedtls_ssl_named_group_to_str(group),
1965 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001966
Jerry Yu3bf2c642022-03-30 22:02:12 +08001967 /* Check if we have space for header and length fields:
1968 * - extension_type (2 bytes)
1969 * - extension_data_length (2 bytes)
1970 * - group (2 bytes)
1971 * - key_exchange_length (2 bytes)
1972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1974 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1975 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001976 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001977
Jerry Yu3bf2c642022-03-30 22:02:12 +08001978 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1979 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001980 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 ssl, group, server_share + 4, end, &key_exchange_length);
1982 if (ret != 0) {
1983 return ret;
1984 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001985 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001986
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001988
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001990
Jerry Yu57d48412022-04-20 21:50:42 +08001991 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001996}
Jerry Yud9436a12022-04-20 22:28:09 +08001997
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001998MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001999static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
2000 unsigned char *buf,
2001 unsigned char *end,
2002 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002003{
2004 uint16_t selected_group = ssl->handshake->hrr_selected_group;
2005 /* key_share Extension
2006 *
2007 * struct {
2008 * select (Handshake.msg_type) {
2009 * ...
2010 * case hello_retry_request:
2011 * NamedGroup selected_group;
2012 * ...
2013 * };
2014 * } KeyShare;
2015 */
2016
2017 *out_len = 0;
2018
Jerry Yub0ac10b2022-05-05 11:10:08 +08002019 /*
2020 * For a pure PSK key exchange, there is no group to agree upon. The purpose
2021 * of the HRR is then to transmit a cookie to force the client to demonstrate
2022 * reachability at their apparent network address (primarily useful for DTLS).
2023 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2025 return 0;
2026 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002027
2028 /* We should only send the key_share extension if the client's initial
2029 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 if (ssl->handshake->offered_group_id != 0) {
2031 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
2032 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002033 }
2034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 if (selected_group == 0) {
2036 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
2037 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002038 }
2039
Jerry Yub0ac10b2022-05-05 11:10:08 +08002040 /* Check if we have enough space:
2041 * - extension_type (2 bytes)
2042 * - extension_data_length (2 bytes)
2043 * - selected_group (2 bytes)
2044 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
2048 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
2049 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 MBEDTLS_SSL_DEBUG_MSG(3,
2052 ("HRR selected_group: %s (%x)",
2053 mbedtls_ssl_named_group_to_str(selected_group),
2054 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002055
2056 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002059
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002061}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002062
2063/*
2064 * Structure of ServerHello message:
2065 *
2066 * struct {
2067 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2068 * Random random;
2069 * opaque legacy_session_id_echo<0..32>;
2070 * CipherSuite cipher_suite;
2071 * uint8 legacy_compression_method = 0;
2072 * Extension extensions<6..2^16-1>;
2073 * } ServerHello;
2074 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002075MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002076static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2077 unsigned char *buf,
2078 unsigned char *end,
2079 size_t *out_len,
2080 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002081{
Jerry Yu955ddd72022-04-22 22:27:33 +08002082 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002083 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002084 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002085 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002086
2087 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002088 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002089
Jerry Yucfc04b32022-04-21 09:31:58 +08002090 /* ...
2091 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2092 * ...
2093 * with ProtocolVersion defined as:
2094 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002095 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2097 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002098 p += 2;
2099
Jerry Yu1c3e6882022-04-20 21:23:40 +08002100 /* ...
2101 * Random random;
2102 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002103 * with Random defined as:
2104 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002105 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2107 if (is_hrr) {
2108 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2109 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2110 } else {
2111 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2112 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002113 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2115 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002116 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2117
Jerry Yucfc04b32022-04-21 09:31:58 +08002118 /* ...
2119 * opaque legacy_session_id_echo<0..32>;
2120 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002121 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2123 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2124 if (ssl->session_negotiate->id_len > 0) {
2125 memcpy(p, &ssl->session_negotiate->id[0],
2126 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002127 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2130 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002131 }
2132
Jerry Yucfc04b32022-04-21 09:31:58 +08002133 /* ...
2134 * CipherSuite cipher_suite;
2135 * ...
2136 * with CipherSuite defined as:
2137 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002138 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2140 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002141 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 MBEDTLS_SSL_DEBUG_MSG(3,
2143 ("server hello, chosen ciphersuite: %s ( id=%d )",
2144 mbedtls_ssl_get_ciphersuite_name(
2145 ssl->session_negotiate->ciphersuite),
2146 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002147
Jerry Yucfc04b32022-04-21 09:31:58 +08002148 /* ...
2149 * uint8 legacy_compression_method = 0;
2150 * ...
2151 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002153 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002154
Jerry Yucfc04b32022-04-21 09:31:58 +08002155 /* ...
2156 * Extension extensions<6..2^16-1>;
2157 * ...
2158 * struct {
2159 * ExtensionType extension_type; (2 bytes)
2160 * opaque extension_data<0..2^16-1>;
2161 * } Extension;
2162 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002164 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002165 p += 2;
2166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2168 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002169 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2171 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002172 }
2173 p += output_len;
2174
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2176 if (is_hrr) {
2177 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2178 } else {
2179 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2180 }
2181 if (ret != 0) {
2182 return ret;
2183 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002184 p += output_len;
2185 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002186
Ronald Cron41a443a2022-10-04 16:38:25 +02002187#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2189 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2190 if (ret != 0) {
2191 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2192 ret);
2193 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002194 }
2195 p += output_len;
2196 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002197#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2202 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002203
Jerry Yud9436a12022-04-20 22:28:09 +08002204 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002207
Jerry Yu7de2ff02022-11-08 21:43:46 +08002208 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002209 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 MBEDTLS_SSL_HS_SERVER_HELLO,
2211 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002214}
2215
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002216MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002217static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002218{
2219 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2221 if (ret != 0) {
2222 MBEDTLS_SSL_DEBUG_RET(1,
2223 "mbedtls_ssl_tls13_compute_handshake_transform",
2224 ret);
2225 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002226 }
2227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002229}
2230
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002231MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002232static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002233{
Jerry Yu637a3f12022-04-20 21:37:58 +08002234 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002235 unsigned char *buf;
2236 size_t buf_len, msg_len;
2237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2243 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2244 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2247 buf + buf_len,
2248 &msg_len,
2249 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002250
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002251 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002252 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002253
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2255 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002256
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002257 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002258
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002259#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2260 /* The server sends a dummy change_cipher_spec record immediately
2261 * after its first handshake message. This may either be after
2262 * a ServerHello or a HelloRetryRequest.
2263 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002264 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002266#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002268#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002269
Jerry Yuf4b27e42022-03-30 17:32:21 +08002270cleanup:
2271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2273 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002274}
2275
Jerry Yu23d1a252022-05-12 18:08:59 +08002276
2277/*
2278 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2279 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002280MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002281static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002282{
2283 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 if (ssl->handshake->hello_retry_request_count > 0) {
2285 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2286 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2287 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2288 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002289 }
2290
2291 /*
2292 * Create stateless transcript hash for HRR
2293 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2295 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2296 if (ret != 0) {
2297 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2298 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002299 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002303}
2304
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002305MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002306static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002307{
2308 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2309 unsigned char *buf;
2310 size_t buf_len, msg_len;
2311
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2317 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2318 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2321 buf + buf_len,
2322 &msg_len,
2323 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002324 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002325 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002326
2327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2329 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002330
2331 ssl->handshake->hello_retry_request_count++;
2332
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002333#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2334 /* The server sends a dummy change_cipher_spec record immediately
2335 * after its first handshake message. This may either be after
2336 * a ServerHello or a HelloRetryRequest.
2337 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002338 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002340#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002342#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002343
2344cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2346 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002347}
2348
Jerry Yu5b64ae92022-03-30 17:15:02 +08002349/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002350 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2351 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002352
2353/*
2354 * struct {
2355 * Extension extensions<0..2 ^ 16 - 1>;
2356 * } EncryptedExtensions;
2357 *
2358 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002359MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002360static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2361 unsigned char *buf,
2362 unsigned char *end,
2363 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002364{
XiaokangQianacb39922022-06-17 10:18:48 +00002365 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002366 unsigned char *p = buf;
2367 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002368 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002369 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002370
Jerry Yu4d3841a2022-04-16 12:37:19 +08002371 *out_len = 0;
2372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002374 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002375 p += 2;
2376
Jerry Yu8937eb42022-05-03 12:12:14 +08002377 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002378 ((void) ret);
2379 ((void) output_len);
2380
2381#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2383 if (ret != 0) {
2384 return ret;
2385 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002386 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002387#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002388
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 extensions_len = (p - p_extensions_len) - 2;
2390 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002391
2392 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002393
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002395
Jerry Yu7de2ff02022-11-08 21:43:46 +08002396 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002398
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002400}
2401
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002402MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002403static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002404{
2405 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2406 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002407 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 mbedtls_ssl_set_outbound_transform(ssl,
2410 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002411 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002413
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002415
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2417 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2418 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2421 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002422
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002423 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002424 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2427 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002428
Ronald Cron928cbd32022-10-04 16:14:26 +02002429#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2431 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2432 } else {
2433 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2434 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002435#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002437#endif
2438
Jerry Yu4d3841a2022-04-16 12:37:19 +08002439cleanup:
2440
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2442 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002443}
2444
Ronald Cron928cbd32022-10-04 16:14:26 +02002445#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002446#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2447#define SSL_CERTIFICATE_REQUEST_SKIP 1
2448/* Coordination:
2449 * Check whether a CertificateRequest message should be written.
2450 * Returns a negative code on failure, or
2451 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2452 * - SSL_CERTIFICATE_REQUEST_SKIP
2453 * indicating if the writing of the CertificateRequest
2454 * should be skipped or not.
2455 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002456MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002457static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002458{
2459 int authmode;
2460
XiaokangQian40a35232022-05-07 09:02:40 +00002461#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002463 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002465#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002466 authmode = ssl->conf->authmode;
2467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002469 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002471 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002472
XiaokangQianc3017f62022-05-13 05:55:41 +00002473 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002476}
2477
XiaokangQiancec9ae62022-05-06 07:28:50 +00002478/*
2479 * struct {
2480 * opaque certificate_request_context<0..2^8-1>;
2481 * Extension extensions<2..2^16-1>;
2482 * } CertificateRequest;
2483 *
2484 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002485MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002486static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2487 unsigned char *buf,
2488 const unsigned char *end,
2489 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002490{
2491 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2492 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002493 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002494 unsigned char *p_extensions_len;
2495
2496 *out_len = 0;
2497
2498 /* Check if we have enough space:
2499 * - certificate_request_context (1 byte)
2500 * - extensions length (2 bytes)
2501 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002503
2504 /*
2505 * Write certificate_request_context
2506 */
2507 /*
2508 * We use a zero length context for the normal handshake
2509 * messages. For post-authentication handshake messages
2510 * this request context would be set to a non-zero value.
2511 */
2512 *p++ = 0x0;
2513
2514 /*
2515 * Write extensions
2516 */
2517 /* The extensions must contain the signature_algorithms. */
2518 p_extensions_len = p;
2519 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2521 if (ret != 0) {
2522 return ret;
2523 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002524
XiaokangQianec6efb92022-05-06 09:53:10 +00002525 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002527
2528 *out_len = p - buf;
2529
Jerry Yu7de2ff02022-11-08 21:43:46 +08002530 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002532
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002534}
2535
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002536MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002537static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002538{
2539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002542
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002544
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002546 unsigned char *buf;
2547 size_t buf_len, msg_len;
2548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2550 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2551 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002552
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2554 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002555
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002556 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002557 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002558
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2560 ssl, buf_len, msg_len));
2561 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2562 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002563 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 } else {
2565 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002566 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2567 goto cleanup;
2568 }
2569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002571cleanup:
2572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2574 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002575}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002576
Jerry Yu4d3841a2022-04-16 12:37:19 +08002577/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002578 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002579 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002580MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002581static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002582{
Jerry Yu5a26f302022-05-10 20:46:40 +08002583 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002584
2585#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2587 mbedtls_ssl_own_cert(ssl) == NULL) {
2588 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2589 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2590 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2591 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002592 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002593#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002594
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2596 if (ret != 0) {
2597 return ret;
2598 }
2599 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2600 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002601}
2602
2603/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002604 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002605 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002606MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002607static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002608{
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2610 if (ret != 0) {
2611 return ret;
2612 }
2613 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2614 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002615}
Ronald Cron928cbd32022-10-04 16:14:26 +02002616#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002617
2618/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002619 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002620 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002621MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002622static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002623{
Jerry Yud6e253d2022-05-18 13:59:24 +08002624 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002625
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2627 if (ret != 0) {
2628 return ret;
2629 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002630
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2632 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002633 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2635 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2636 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002637 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2640 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 if (ssl->handshake->certificate_request_sent) {
2643 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2644 } else {
2645 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2646 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2647 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002648 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002649
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002651}
2652
2653/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002654 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002655 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002656MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002657static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002658{
Jerry Yud6e253d2022-05-18 13:59:24 +08002659 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2662 if (ret != 0) {
2663 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002664 }
2665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2667 if (ret != 0) {
2668 MBEDTLS_SSL_DEBUG_RET(1,
2669 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2670 }
2671
2672 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2673 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002674}
2675
2676/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002677 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002678 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002679MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002680static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002681{
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002685
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002686#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2687 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002688/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2689 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2690 * expected to be resolved with issue#6395.
2691 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002692 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002693 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2694 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002695 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002696#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002697 {
2698 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2699 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002701}
2702
2703/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002704 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002705 */
2706#define SSL_NEW_SESSION_TICKET_SKIP 0
2707#define SSL_NEW_SESSION_TICKET_WRITE 1
2708MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002709static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002710{
2711 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 if (ssl->conf->f_ticket_write == NULL) {
2713 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2714 " callback is not set"));
2715 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002716 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 if (ssl->conf->new_session_tickets_count == 0) {
2718 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2719 " configured count is zero"));
2720 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002721 }
2722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 if (ssl->handshake->new_session_tickets_count == 0) {
2724 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2725 "been sent."));
2726 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002727 }
2728
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002730}
2731
2732#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2733MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002734static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2735 unsigned char *ticket_nonce,
2736 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002737{
2738 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2739 mbedtls_ssl_session *session = ssl->session;
2740 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2741 psa_algorithm_t psa_hash_alg;
2742 int hash_length;
2743
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002745
2746#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002748#endif
2749
Pengyu Lv9f926952022-11-17 15:22:33 +08002750 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002751 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002752 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002753#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002754 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002755 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002756#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002757 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002758
Jerry Yue67bef42022-07-07 07:29:42 +00002759 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2761 (unsigned char *) &session->ticket_age_add,
2762 sizeof(session->ticket_age_add)) != 0)) {
2763 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2764 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002765 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2767 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002768
2769 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2771 if (ret != 0) {
2772 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2773 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002774 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2776 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002777
2778 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2780 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2781 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2782 if (hash_length == -1 ||
2783 (size_t) hash_length > sizeof(session->resumption_key)) {
2784 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002785 }
2786
Jerry Yue67bef42022-07-07 07:29:42 +00002787 /* In this code the psk key length equals the length of the hash */
2788 session->resumption_key_len = hash_length;
2789 session->ciphersuite = ciphersuite_info->id;
2790
2791 /* Compute resumption key
2792 *
2793 * HKDF-Expand-Label( resumption_master_secret,
2794 * "resumption", ticket_nonce, Hash.length )
2795 */
2796 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 psa_hash_alg,
2798 session->app_secrets.resumption_master_secret,
2799 hash_length,
2800 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2801 ticket_nonce,
2802 ticket_nonce_size,
2803 session->resumption_key,
2804 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 if (ret != 0) {
2807 MBEDTLS_SSL_DEBUG_RET(2,
2808 "Creating the ticket-resumed PSK failed",
2809 ret);
2810 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002811 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2813 session->resumption_key,
2814 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002815
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2817 session->app_secrets.resumption_master_secret,
2818 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002821}
2822
2823/* This function creates a NewSessionTicket message in the following format:
2824 *
2825 * struct {
2826 * uint32 ticket_lifetime;
2827 * uint32 ticket_age_add;
2828 * opaque ticket_nonce<0..255>;
2829 * opaque ticket<1..2^16-1>;
2830 * Extension extensions<0..2^16-2>;
2831 * } NewSessionTicket;
2832 *
2833 * The ticket inside the NewSessionTicket message is an encrypted container
2834 * carrying the necessary information so that the server is later able to
2835 * re-start the communication.
2836 *
2837 * The following fields are placed inside the ticket by the
2838 * f_ticket_write() function:
2839 *
2840 * - creation time (start)
2841 * - flags (flags)
2842 * - age add (ticket_age_add)
2843 * - key (key)
2844 * - key length (key_len)
2845 * - ciphersuite (ciphersuite)
2846 */
2847MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002848static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2849 unsigned char *buf,
2850 unsigned char *end,
2851 size_t *out_len,
2852 unsigned char *ticket_nonce,
2853 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002854{
2855 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2856 unsigned char *p = buf;
2857 mbedtls_ssl_session *session = ssl->session;
2858 size_t ticket_len;
2859 uint32_t ticket_lifetime;
2860
2861 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002863
2864 /*
2865 * ticket_lifetime 4 bytes
2866 * ticket_age_add 4 bytes
2867 * ticket_nonce 1 + ticket_nonce_size bytes
2868 * ticket >=2 bytes
2869 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002871
2872 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2874 session,
2875 p + 9 + ticket_nonce_size + 2,
2876 end,
2877 &ticket_len,
2878 &ticket_lifetime);
2879 if (ret != 0) {
2880 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2881 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002882 }
2883 /* RFC 8446 4.6.1
2884 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2885 * unsigned integer in network byte order from the time of ticket
2886 * issuance. Servers MUST NOT use any value greater than
2887 * 604800 seconds (7 days). The value of zero indicates that the
2888 * ticket should be discarded immediately. Clients MUST NOT cache
2889 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2890 * and MAY delete tickets earlier based on local policy. A server
2891 * MAY treat a ticket as valid for a shorter period of time than what
2892 * is stated in the ticket_lifetime.
2893 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002895 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 }
2897 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2898 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2899 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002900
2901 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2903 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2904 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002905
2906 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 p[8] = (unsigned char) ticket_nonce_size;
2908 if (ticket_nonce_size > 0) {
2909 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002910 }
2911 p += 9 + ticket_nonce_size;
2912
2913 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002915 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002917 p += ticket_len;
2918
2919 /* Ticket Extensions
2920 *
2921 * Note: We currently don't have any extensions.
2922 * Set length to zero.
2923 */
Jerry Yuedab6372022-10-31 14:37:31 +08002924 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2927 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002928 p += 2;
2929
2930 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2932 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002933
Jerry Yu7de2ff02022-11-08 21:43:46 +08002934 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002938}
2939
2940/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002941 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002942 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002943static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002944{
2945 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002950 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2951 unsigned char *buf;
2952 size_t buf_len, msg_len;
2953
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2955 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002956
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2958 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2959 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002960
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2962 ssl, buf, buf + buf_len, &msg_len,
2963 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002964
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2966 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002967
Jerry Yu359e65f2022-09-22 23:47:43 +08002968 /* Limit session tickets count to one when resumption connection.
2969 *
2970 * See document of mbedtls_ssl_conf_new_session_tickets.
2971 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002973 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002975 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002977
Jerry Yua8d3c502022-10-30 14:51:23 +08002978 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2980 } else {
2981 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002982 }
2983
Jerry Yue67bef42022-07-07 07:29:42 +00002984cleanup:
2985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002987}
2988#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2989
2990/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002991 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002992 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002993int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002994{
XiaokangQian08037552022-04-20 07:16:41 +00002995 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2998 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2999 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
3002 mbedtls_ssl_states_str(ssl->state),
3003 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08003004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00003006 /* start state */
3007 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00003009 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003010 break;
3011
XiaokangQian7807f9f2022-02-15 10:04:37 +00003012 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 ret = ssl_tls13_process_client_hello(ssl);
3014 if (ret != 0) {
3015 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
3016 }
Jerry Yuf41553b2022-05-09 22:20:30 +08003017 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003018
Jerry Yuf41553b2022-05-09 22:20:30 +08003019 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 ret = ssl_tls13_write_hello_retry_request(ssl);
3021 if (ret != 0) {
3022 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
3023 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08003024 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003025 break;
3026
Jerry Yu5b64ae92022-03-30 17:15:02 +08003027 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08003029 break;
3030
Xiaofei Baicba64af2022-02-15 10:00:56 +00003031 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 ret = ssl_tls13_write_encrypted_extensions(ssl);
3033 if (ret != 0) {
3034 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
3035 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00003036 }
Jerry Yu48330562022-05-06 21:35:44 +08003037 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08003038
Ronald Cron928cbd32022-10-04 16:14:26 +02003039#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003040 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003042 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003043
Jerry Yu83da34e2022-04-16 13:59:52 +08003044 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003046 break;
3047
3048 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003050 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003051#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 /*
3054 * Injection of dummy-CCS's for middlebox compatibility
3055 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003056#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003057 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3059 if (ret == 0) {
3060 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3061 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003062 break;
3063
3064 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3066 if (ret == 0) {
3067 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
3068 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003069 break;
3070#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3071
Jerry Yu69dd8d42022-04-16 12:51:26 +08003072 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003074 break;
3075
3076 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003078 break;
3079
Jerry Yu69dd8d42022-04-16 12:51:26 +08003080 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003082 break;
3083
Ronald Cron766c0cd2022-10-18 12:17:11 +02003084#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003085 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3087 if (ret == 0) {
3088 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003089 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3091 } else {
3092 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003093 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003095 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003096 }
3097 break;
3098
3099 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3101 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003102 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003104 }
3105 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003106#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003107
Jerry Yue67bef42022-07-07 07:29:42 +00003108#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003109 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 ret = ssl_tls13_write_new_session_ticket(ssl);
3111 if (ret != 0) {
3112 MBEDTLS_SSL_DEBUG_RET(1,
3113 "ssl_tls13_write_new_session_ticket ",
3114 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003115 }
3116 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003117 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003118 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003119 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003120 * as part of ssl_prepare_handshake_step.
3121 */
3122 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003123
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 if (ssl->handshake->new_session_tickets_count == 0) {
3125 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3126 } else {
3127 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3128 }
Jerry Yue67bef42022-07-07 07:29:42 +00003129 break;
3130
3131#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3132
XiaokangQian7807f9f2022-02-15 10:04:37 +00003133 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3135 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003136 }
3137
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003139}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003140
Jerry Yufb4b6472022-01-27 15:03:26 +08003141#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */