blob: 7c3206a04a636eb49550243421130b8891a96713 [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;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000741 int tls13_supported = 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
754 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000756 tls13_supported = 1;
757 break;
758 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000759 }
760
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 if (!tls13_supported) {
762 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 is not supported by the client"));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000763
Gilles Peskine449bd832023-01-11 14:50:10 +0100764 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
765 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
766 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000767 }
768
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version. Supported is [%04x]",
770 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000771
Gilles Peskine449bd832023-01-11 14:50:10 +0100772 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000773}
774
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000775#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000776/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000777 *
778 * From RFC 8446:
779 * enum {
780 * ... (0xFFFF)
781 * } NamedGroup;
782 * struct {
783 * NamedGroup named_group_list<2..2^16-1>;
784 * } NamedGroupList;
785 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200786MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100787static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
788 const unsigned char *buf,
789 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000790{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000791 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000792 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000793 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000794
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
796 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
797 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000798 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100799 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000800 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000801 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000802
Gilles Peskine449bd832023-01-11 14:50:10 +0100803 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000804 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
806 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000807 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000808
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 MBEDTLS_SSL_DEBUG_MSG(2,
810 ("got named group: %s(%04x)",
811 mbedtls_ssl_named_group_to_str(named_group),
812 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000813
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
815 !mbedtls_ssl_named_group_is_supported(named_group) ||
816 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000817 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000818 }
819
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 MBEDTLS_SSL_DEBUG_MSG(2,
821 ("add named group %s(%04x) into received list.",
822 mbedtls_ssl_named_group_to_str(named_group),
823 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800824
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000825 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000826 }
827
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000829
830}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000831#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000832
XiaokangQian08037552022-04-20 07:16:41 +0000833#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
834
XiaokangQian88408882022-04-02 10:15:03 +0000835#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000836/*
837 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000838 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000839 *
840 * Possible return values are:
841 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000842 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000843 * does not match a group supported by the server. A HelloRetryRequest will
844 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000845 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800846 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200847MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100848static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
849 const unsigned char *buf,
850 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000851{
XiaokangQianb67384d2022-04-19 00:02:38 +0000852 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000853 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000854 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800855 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000856
857 /* From RFC 8446:
858 *
859 * struct {
860 * KeyShareEntry client_shares<0..2^16-1>;
861 * } KeyShareClientHello;
862 *
863 */
864
Gilles Peskine449bd832023-01-11 14:50:10 +0100865 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
866 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000867 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100868 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000869
870 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000871 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000872
873 /* We try to find a suitable key share entry and copy it to the
874 * handshake context. Later, we have to find out whether we can do
875 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000876 * dismiss it and send a HelloRetryRequest message.
877 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000878
Gilles Peskine449bd832023-01-11 14:50:10 +0100879 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000880 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800881 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800882 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000883
884 /*
885 * struct {
886 * NamedGroup group;
887 * opaque key_exchange<1..2^16-1>;
888 * } KeyShareEntry;
889 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100890 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
891 group = MBEDTLS_GET_UINT16_BE(p, 0);
892 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800893 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800894 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100895 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800896 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000897
898 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000899 * for input validation purposes.
900 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100901 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
902 !mbedtls_ssl_named_group_is_supported(group) ||
903 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000904 continue;
905 }
XiaokangQian060d8672022-04-21 09:24:56 +0000906
XiaokangQian7807f9f2022-02-15 10:04:37 +0000907 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000908 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000909 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100910 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
911 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH group: %s (%04x)",
912 mbedtls_ssl_named_group_to_str(group),
913 group));
XiaokangQian318dc762022-04-20 09:43:51 +0000914 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 ssl, key_exchange - 2, key_exchange_len + 2);
916 if (ret != 0) {
917 return ret;
918 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000919
Gilles Peskine449bd832023-01-11 14:50:10 +0100920 } else {
921 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
922 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000923 continue;
924 }
925
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000926 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000927 }
928
Jerry Yuc1be19f2022-04-23 16:11:39 +0800929
Gilles Peskine449bd832023-01-11 14:50:10 +0100930 if (ssl->handshake->offered_group_id == 0) {
931 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
932 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000933 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100934 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000935}
XiaokangQian88408882022-04-02 10:15:03 +0000936#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000937
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200938MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100939static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
940 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000941{
Jerry Yu0c354a22022-08-29 15:25:36 +0800942 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000944}
945
Jerry Yue5991322022-11-07 14:03:44 +0800946#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200947MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000948static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000950{
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 return ssl_tls13_client_hello_has_exts(
952 ssl,
953 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
954 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
955 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000956}
Jerry Yue5991322022-11-07 14:03:44 +0800957#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000958
Jerry Yue5991322022-11-07 14:03:44 +0800959#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000960MBEDTLS_CHECK_RETURN_CRITICAL
961static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000963{
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 return ssl_tls13_client_hello_has_exts(
965 ssl,
966 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
967 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000968}
Jerry Yue5991322022-11-07 14:03:44 +0800969#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000970
Jerry Yue5991322022-11-07 14:03:44 +0800971#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000972MBEDTLS_CHECK_RETURN_CRITICAL
973static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000975{
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 return ssl_tls13_client_hello_has_exts(
977 ssl,
978 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
979 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
980 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
981 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000982}
Jerry Yue5991322022-11-07 14:03:44 +0800983#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000984
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200985MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100986static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000987{
Jerry Yue5991322022-11-07 14:03:44 +0800988#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100989 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
990 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800991#else
992 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 return 0;
Jerry Yue5991322022-11-07 14:03:44 +0800994#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000995}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000996
Jerry Yu77f01482022-07-11 07:03:24 +0000997MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100998static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000999{
Jerry Yue5991322022-11-07 14:03:44 +08001000#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
1002 mbedtls_ssl_tls13_psk_enabled(ssl) &&
1003 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001004#else
1005 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001007#endif
1008}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001009
Jerry Yu77f01482022-07-11 07:03:24 +00001010MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001011static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001012{
Jerry Yue5991322022-11-07 14:03:44 +08001013#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
1015 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1016 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001017#else
1018 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001020#endif
1021}
1022
Gilles Peskine449bd832023-01-11 14:50:10 +01001023static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001024{
1025 /*
1026 * Determine the key exchange algorithm to use.
1027 * There are three types of key exchanges supported in TLS 1.3:
1028 * - (EC)DH with ECDSA,
1029 * - (EC)DH with PSK,
1030 * - plain PSK.
1031 *
1032 * The PSK-based key exchanges may additionally be used with 0-RTT.
1033 *
1034 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001035 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1036 * 2 ) Certificate Mode ( ephemeral )
1037 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001038 */
1039
1040 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1041
Gilles Peskine449bd832023-01-11 14:50:10 +01001042 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001043 ssl->handshake->key_exchange_mode =
1044 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1046 } else
1047 if (ssl_tls13_check_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_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001050 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1051 } else
1052 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001053 ssl->handshake->key_exchange_mode =
1054 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1056 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001057 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 1,
1059 ("ClientHello message misses mandatory extensions."));
1060 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1061 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1062 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001063 }
1064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001066
XiaokangQian7807f9f2022-02-15 10:04:37 +00001067}
1068
XiaokangQian81802f42022-06-10 13:25:22 +00001069#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001070 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001071
1072#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001073static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001074{
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001076 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001078 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001080 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001082 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001084 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001086 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001088 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001090 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001092 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001094 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001096 }
1097}
1098#endif /* MBEDTLS_USE_PSA_CRYPTO */
1099
XiaokangQian23c5be62022-06-07 02:04:34 +00001100/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001101 * Pick best ( private key, certificate chain ) pair based on the signature
1102 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001103 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001104MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001105static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001106{
XiaokangQianfb665a82022-06-15 03:57:21 +00001107 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001108 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001109
1110#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001112 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001114#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001116
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 if (key_cert_list == NULL) {
1118 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1119 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001120 }
1121
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1123 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001124 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001126
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001128 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001130
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 for (key_cert = key_cert_list; key_cert != NULL;
1132 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001133#if defined(MBEDTLS_USE_PSA_CRYPTO)
1134 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1135#endif /* MBEDTLS_USE_PSA_CRYPTO */
1136
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1138 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001139
1140 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 * This avoids sending the client a cert it'll reject based on
1142 * keyUsage or other extensions.
1143 */
1144 if (mbedtls_x509_crt_check_key_usage(
1145 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001146 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001147 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1149 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1150 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001151 continue;
1152 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001153
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 MBEDTLS_SSL_DEBUG_MSG(3,
1155 ("ssl_tls13_pick_key_cert:"
1156 "check signature algorithm %s [%04x]",
1157 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1158 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001159#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001161#endif /* MBEDTLS_USE_PSA_CRYPTO */
1162
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1164 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001165#if defined(MBEDTLS_USE_PSA_CRYPTO)
1166 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1168 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001169#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001171 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 MBEDTLS_SSL_DEBUG_MSG(3,
1173 ("ssl_tls13_pick_key_cert:"
1174 "selected signature algorithm"
1175 " %s [%04x]",
1176 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1177 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001178 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 3, "selected certificate (chain)",
1180 ssl->handshake->key_cert->cert);
1181 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001182 }
XiaokangQian81802f42022-06-10 13:25:22 +00001183 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001184 }
1185
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1187 "no suitable certificate found"));
1188 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001189}
XiaokangQian81802f42022-06-10 13:25:22 +00001190#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001191 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001192
XiaokangQian4080a7f2022-04-11 09:55:18 +00001193/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001194 *
1195 * STATE HANDLING: ClientHello
1196 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001197 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001198 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001199 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001200 *
1201 * In this case, the server progresses to sending its ServerHello.
1202 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001203 * 2) The ClientHello was well-formed but didn't match the server's
1204 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001205 *
1206 * For example, the client might not have offered a key share which
1207 * the server supports, or the server might require a cookie.
1208 *
1209 * In this case, the server sends a HelloRetryRequest.
1210 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001211 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001212 *
1213 * In this case, we abort the handshake.
1214 *
1215 */
1216
1217/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001218 * Structure of this message:
1219 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001220 * uint16 ProtocolVersion;
1221 * opaque Random[32];
1222 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001223 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001224 * struct {
1225 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1226 * Random random;
1227 * opaque legacy_session_id<0..32>;
1228 * CipherSuite cipher_suites<2..2^16-2>;
1229 * opaque legacy_compression_methods<1..2^8-1>;
1230 * Extension extensions<8..2^16-1>;
1231 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001232 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001233
1234#define SSL_CLIENT_HELLO_OK 0
1235#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1236
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001237MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001238static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1239 const unsigned char *buf,
1240 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001241{
XiaokangQianb67384d2022-04-19 00:02:38 +00001242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1243 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001244 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001245 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001246 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001247 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001248 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001249 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001250 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001251
Ronald Cron41a443a2022-10-04 16:38:25 +02001252#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001253 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001254 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001255 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001256#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001257
XiaokangQian7807f9f2022-02-15 10:04:37 +00001258 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001259 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001260 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001261 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001262 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001263 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001264 * .. . .. ciphersuite list length ( 2 bytes )
1265 * .. . .. ciphersuite list
1266 * .. . .. compression alg. list length ( 1 byte )
1267 * .. . .. compression alg. list
1268 * .. . .. extensions length ( 2 bytes, optional )
1269 * .. . .. extensions ( optional )
1270 */
1271
XiaokangQianb67384d2022-04-19 00:02:38 +00001272 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001273 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001274 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1275 * read at least up to session id length without worrying.
1276 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001278
1279 /* ...
1280 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1281 * ...
1282 * with ProtocolVersion defined as:
1283 * uint16 ProtocolVersion;
1284 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1286 MBEDTLS_SSL_VERSION_TLS1_2) {
1287 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1288 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1289 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1290 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001291 }
1292 p += 2;
1293
1294 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001295 * Only support TLS 1.3 currently, temporarily set the version.
1296 */
XiaokangQiande333912022-04-20 08:49:42 +00001297 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001298
Jerry Yue67bef42022-07-07 07:29:42 +00001299#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1300 /* Store minor version for later use with ticket serialization. */
1301 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001302 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001303#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001304
Jerry Yuc1be19f2022-04-23 16:11:39 +08001305 /* ...
1306 * Random random;
1307 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001308 * with Random defined as:
1309 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001310 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1312 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001313
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 memcpy(&handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian08037552022-04-20 07:16:41 +00001315 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001316
Jerry Yuc1be19f2022-04-23 16:11:39 +08001317 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001318 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001319 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001320 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001321 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001322 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1325 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1326 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001327 }
1328
XiaokangQian4080a7f2022-04-11 09:55:18 +00001329 ssl->session_negotiate->id_len = legacy_session_id_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1331 p, legacy_session_id_len);
XiaokangQianb67384d2022-04-19 00:02:38 +00001332 /*
1333 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001334 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001335 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001337
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 memcpy(&ssl->session_negotiate->id[0], p, legacy_session_id_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001339 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001340
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001342 p += 2;
1343
Ronald Cronfc7ae872023-02-16 15:32:19 +01001344 /*
1345 * The length of the ciphersuite list has to be even.
1346 */
1347 if (cipher_suites_len & 1) {
1348 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1349 MBEDTLS_ERR_SSL_DECODE_ERROR);
1350 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1351 }
1352
XiaokangQianb67384d2022-04-19 00:02:38 +00001353 /* Check we have enough data for the ciphersuite list, the legacy
1354 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001355 *
1356 * cipher_suites cipher_suites_len bytes
1357 * legacy_compression_methods 2 bytes
1358 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001359 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001361
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 /* ...
1363 * CipherSuite cipher_suites<2..2^16-2>;
1364 * ...
1365 * with CipherSuite defined as:
1366 * uint8 CipherSuite[2];
1367 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001368#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001369 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001370#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001371 cipher_suites_end = p + cipher_suites_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, ciphersuitelist",
1373 p, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001374
1375 /*
1376 * Search for a matching ciphersuite
1377 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 for (; p < cipher_suites_end; p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001379 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001381
Ronald Crond89360b2023-02-21 08:53:33 +01001382 /*
1383 * "cipher_suite_end - p is even" is an invariant of the loop. As
1384 * cipher_suites_end - p > 0, we have cipher_suites_end - p >= 2 and
1385 * it is thus safe to read two bytes.
1386 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001388 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 ssl, cipher_suite);
1390 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001391 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001392 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001393
Jerry Yu5725f1c2022-08-21 17:27:16 +08001394 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001395 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1397 cipher_suite,
1398 ciphersuite_info->name));
Ronald Cron25e9ec62023-02-16 15:35:16 +01001399 break;
XiaokangQian17f974c2022-04-19 09:57:41 +00001400 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001401
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 if (handshake->ciphersuite_info == NULL) {
1403 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1404 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1405 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001406 }
Ronald Cron25e9ec62023-02-16 15:35:16 +01001407 p = cipher_suites_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001408
XiaokangQian4080a7f2022-04-11 09:55:18 +00001409 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001410 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001411 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001412 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1414 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1415 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1416 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1417 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001418 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001419 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001420
Jerry Yuc1be19f2022-04-23 16:11:39 +08001421 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001422 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001423 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001424 * with Extension defined as:
1425 * struct {
1426 * ExtensionType extension_type;
1427 * opaque extension_data<0..2^16-1>;
1428 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001431 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001433 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001434
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001436
Jerry Yu63a459c2022-10-31 13:38:40 +08001437 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001438
Gilles Peskine449bd832023-01-11 14:50:10 +01001439 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001440 unsigned int extension_type;
1441 size_t extension_data_len;
1442 const unsigned char *extension_data_end;
1443
Jerry Yu0c354a22022-08-29 15:25:36 +08001444 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001445 *
1446 * The "pre_shared_key" extension MUST be the last extension in the
1447 * ClientHello (this facilitates implementation as described below).
1448 * Servers MUST check that it is the last extension and otherwise fail
1449 * the handshake with an "illegal_parameter" alert.
1450 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001452 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001454 MBEDTLS_SSL_PEND_FATAL_ALERT(
1455 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1457 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001458 }
1459
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1461 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1462 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001463 p += 4;
1464
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001466 extension_data_end = p + extension_data_len;
1467
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001468 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1470 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1471 if (ret != 0) {
1472 return ret;
1473 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001474
Gilles Peskine449bd832023-01-11 14:50:10 +01001475 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001476#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1477 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001478 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1479 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1480 extension_data_end);
1481 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001482 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 1, "mbedtls_ssl_parse_servername_ext", ret);
1484 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001485 }
XiaokangQian40a35232022-05-07 09:02:40 +00001486 break;
1487#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1488
XiaokangQianb67384d2022-04-19 00:02:38 +00001489#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001490 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001491 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001492
1493 /* Supported Groups Extension
1494 *
1495 * When sent by the client, the "supported_groups" extension
1496 * indicates the named groups which the client supports,
1497 * ordered from most preferred to least preferred.
1498 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001499 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 ssl, p, extension_data_end);
1501 if (ret != 0) {
1502 MBEDTLS_SSL_DEBUG_RET(1,
1503 "mbedtls_ssl_parse_supported_groups_ext", ret);
1504 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001505 }
1506
XiaokangQian7807f9f2022-02-15 10:04:37 +00001507 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001508#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001509
XiaokangQian88408882022-04-02 10:15:03 +00001510#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001511 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001513
1514 /*
1515 * Key Share Extension
1516 *
1517 * When sent by the client, the "key_share" extension
1518 * contains the endpoint's cryptographic parameters for
1519 * ECDHE/DHE key establishment methods.
1520 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001521 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 ssl, p, extension_data_end);
1523 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1524 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001525 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001526 }
1527
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001529 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 1, "ssl_tls13_parse_key_shares_ext", ret);
1531 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001532 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001533
XiaokangQian7807f9f2022-02-15 10:04:37 +00001534 break;
XiaokangQian88408882022-04-02 10:15:03 +00001535#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001536
1537 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported versions extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001539
1540 ret = ssl_tls13_parse_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 ssl, p, extension_data_end);
1542 if (ret != 0) {
1543 MBEDTLS_SSL_DEBUG_RET(1,
1544 ("ssl_tls13_parse_supported_versions_ext"), ret);
1545 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001546 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001547 break;
1548
Ronald Cron41a443a2022-10-04 16:38:25 +02001549#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001550 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001552
1553 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 ssl, p, extension_data_end);
1555 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001556 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1558 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001559 }
1560
Jerry Yue19e3b92022-07-08 12:04:51 +00001561 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001562#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001563
Jerry Yu1c105562022-07-10 06:32:38 +00001564 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1566 if ((handshake->received_extensions &
1567 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001568 MBEDTLS_SSL_PEND_FATAL_ALERT(
1569 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1571 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001572 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001573#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001574 /* Delay processing of the PSK identity once we have
1575 * found out which algorithms to use. We keep a pointer
1576 * to the buffer and the size for later processing.
1577 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001578 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001579 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001580#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001581 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001582
XiaokangQianacb39922022-06-17 10:18:48 +00001583#if defined(MBEDTLS_SSL_ALPN)
1584 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001586
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1588 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001589 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1591 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001592 }
XiaokangQianacb39922022-06-17 10:18:48 +00001593 break;
1594#endif /* MBEDTLS_SSL_ALPN */
1595
Ronald Cron928cbd32022-10-04 16:14:26 +02001596#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001597 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001599
Gabor Mezei078e8032022-04-27 21:17:56 +02001600 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 ssl, p, extension_data_end);
1602 if (ret != 0) {
1603 MBEDTLS_SSL_DEBUG_MSG(1,
1604 (
1605 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1606 ret));
1607 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001608 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001609 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001610#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001611
1612 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001613 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001614 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001616 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001617 }
1618
1619 p += extension_data_len;
1620 }
1621
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1623 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001624
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001625 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1626 MBEDTLS_SSL_HS_CLIENT_HELLO,
1627 p - buf);
1628 if (0 != ret) {
1629 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1630 return ret;
1631 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001632
Ronald Cron41a443a2022-10-04 16:38:25 +02001633#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001634 /* Update checksum with either
1635 * - The entire content of the CH message, if no PSK extension is present
1636 * - The content up to but excluding the PSK extension, if present.
1637 */
Jerry Yu1c105562022-07-10 06:32:38 +00001638 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001639 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1640 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1641 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001642 ret = handshake->update_checksum(ssl, buf,
1643 pre_shared_key_ext - buf);
1644 if (0 != ret) {
1645 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1646 return ret;
1647 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001648 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1649 pre_shared_key_ext,
1650 pre_shared_key_ext_end,
1651 cipher_suites,
1652 cipher_suites_end);
1653 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1654 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1655 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001656 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1658 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001659 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001661#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001662 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001663 ret = handshake->update_checksum(ssl, buf, p - buf);
1664 if (0 != ret) {
1665 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1666 return ret;
1667 }
Jerry Yu1c105562022-07-10 06:32:38 +00001668 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001669
Gilles Peskine449bd832023-01-11 14:50:10 +01001670 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1671 if (ret < 0) {
1672 return ret;
1673 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001674
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001676
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001678}
1679
1680/* Update the handshake state machine */
1681
Ronald Cronce7d76e2022-07-08 18:56:49 +02001682MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001683static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001684{
1685 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1686
XiaokangQian7807f9f2022-02-15 10:04:37 +00001687 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001688 * Server certificate selection
1689 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1691 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1692 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001693 }
1694#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1695 ssl->handshake->sni_name = NULL;
1696 ssl->handshake->sni_name_len = 0;
1697#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1700 if (ret != 0) {
1701 MBEDTLS_SSL_DEBUG_RET(1,
1702 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1703 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001704 }
1705
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001707
1708}
1709
1710/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001711 * Main entry point from the state machine; orchestrates the otherfunctions.
1712 */
1713
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001714MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001715static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001716{
1717
XiaokangQian08037552022-04-20 07:16:41 +00001718 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001720 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001721 int parse_client_hello_ret;
1722
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001724
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1726 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1727 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1730 buf + buflen));
Jerry Yuf41553b2022-05-09 22:20:30 +08001731 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1732 * only SSL_CLIENT_HELLO_OK or
1733 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1734 * stage as negative error codes are handled
1735 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001736
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 if (parse_client_hello_ret == SSL_CLIENT_HELLO_OK) {
1740 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1741 } else {
1742 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1743 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001744
1745cleanup:
1746
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1748 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001749}
1750
1751/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001752 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001753 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001754MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001755static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001756{
Jerry Yu637a3f12022-04-20 21:37:58 +08001757 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1758 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1760 if (ssl->conf->f_rng == NULL) {
1761 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1762 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001763 }
1764
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1766 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1767 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1768 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001769 }
1770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1772 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001773
1774#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001776#endif /* MBEDTLS_HAVE_TIME */
1777
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001779}
1780
Jerry Yu3bf2c642022-03-30 22:02:12 +08001781/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001782 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001783 *
1784 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001785 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001786 * } SupportedVersions;
1787 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001788MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001789static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 mbedtls_ssl_context *ssl,
1791 unsigned char *buf,
1792 unsigned char *end,
1793 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001794{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001795 *out_len = 0;
1796
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001798
1799 /* Check if we have space to write the extension:
1800 * - extension_type (2 bytes)
1801 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001802 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001803 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001805
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001807
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001809
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 mbedtls_ssl_write_version(buf + 4,
1811 ssl->conf->transport,
1812 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001813
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1815 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001816
Jerry Yu349a6132022-04-14 20:52:56 +08001817 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001818
Jerry Yub95dd362022-11-08 21:19:34 +08001819 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001820 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001821
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001823}
1824
Jerry Yud9436a12022-04-20 22:28:09 +08001825
Jerry Yu3bf2c642022-03-30 22:02:12 +08001826
1827/* Generate and export a single key share. For hybrid KEMs, this can
1828 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001829MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001830static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1831 uint16_t named_group,
1832 unsigned char *buf,
1833 unsigned char *end,
1834 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001835{
1836 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001837
1838 *out_len = 0;
1839
Jerry Yu89e103c2022-03-30 22:43:29 +08001840#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001842 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 ssl, named_group, buf, end, out_len);
1844 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001845 MBEDTLS_SSL_DEBUG_RET(
1846 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 ret);
1848 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001849 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 } else
Jerry Yu89e103c2022-03-30 22:43:29 +08001851#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 if (0 /* Other kinds of KEMs */) {
1853 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001854 ((void) ssl);
1855 ((void) named_group);
1856 ((void) buf);
1857 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001858 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1859 }
1860
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001862}
1863
1864/*
1865 * ssl_tls13_write_key_share_ext
1866 *
1867 * Structure of key_share extension in ServerHello:
1868 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001869 * struct {
1870 * NamedGroup group;
1871 * opaque key_exchange<1..2^16-1>;
1872 * } KeyShareEntry;
1873 * struct {
1874 * KeyShareEntry server_share;
1875 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001876 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001877MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001878static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1879 unsigned char *buf,
1880 unsigned char *end,
1881 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001882{
Jerry Yu955ddd72022-04-22 22:27:33 +08001883 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001884 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001885 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001886 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001887 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001888
1889 *out_len = 0;
1890
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001892
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1894 mbedtls_ssl_named_group_to_str(group),
1895 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001896
Jerry Yu3bf2c642022-03-30 22:02:12 +08001897 /* Check if we have space for header and length fields:
1898 * - extension_type (2 bytes)
1899 * - extension_data_length (2 bytes)
1900 * - group (2 bytes)
1901 * - key_exchange_length (2 bytes)
1902 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1904 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1905 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001906 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001907
Jerry Yu3bf2c642022-03-30 22:02:12 +08001908 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1909 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001910 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 ssl, group, server_share + 4, end, &key_exchange_length);
1912 if (ret != 0) {
1913 return ret;
1914 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001915 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001916
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001918
Gilles Peskine449bd832023-01-11 14:50:10 +01001919 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001920
Jerry Yu57d48412022-04-20 21:50:42 +08001921 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001922
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001924
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001926}
Jerry Yud9436a12022-04-20 22:28:09 +08001927
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001928MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001929static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
1930 unsigned char *buf,
1931 unsigned char *end,
1932 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001933{
1934 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1935 /* key_share Extension
1936 *
1937 * struct {
1938 * select (Handshake.msg_type) {
1939 * ...
1940 * case hello_retry_request:
1941 * NamedGroup selected_group;
1942 * ...
1943 * };
1944 * } KeyShare;
1945 */
1946
1947 *out_len = 0;
1948
Jerry Yub0ac10b2022-05-05 11:10:08 +08001949 /*
1950 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1951 * of the HRR is then to transmit a cookie to force the client to demonstrate
1952 * reachability at their apparent network address (primarily useful for DTLS).
1953 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
1955 return 0;
1956 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001957
1958 /* We should only send the key_share extension if the client's initial
1959 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 if (ssl->handshake->offered_group_id != 0) {
1961 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
1962 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001963 }
1964
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 if (selected_group == 0) {
1966 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
1967 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001968 }
1969
Jerry Yub0ac10b2022-05-05 11:10:08 +08001970 /* Check if we have enough space:
1971 * - extension_type (2 bytes)
1972 * - extension_data_length (2 bytes)
1973 * - selected_group (2 bytes)
1974 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001976
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
1978 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
1979 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001980
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 MBEDTLS_SSL_DEBUG_MSG(3,
1982 ("HRR selected_group: %s (%x)",
1983 mbedtls_ssl_named_group_to_str(selected_group),
1984 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001985
1986 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001989
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001991}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001992
1993/*
1994 * Structure of ServerHello message:
1995 *
1996 * struct {
1997 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1998 * Random random;
1999 * opaque legacy_session_id_echo<0..32>;
2000 * CipherSuite cipher_suite;
2001 * uint8 legacy_compression_method = 0;
2002 * Extension extensions<6..2^16-1>;
2003 * } ServerHello;
2004 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002005MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002006static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2007 unsigned char *buf,
2008 unsigned char *end,
2009 size_t *out_len,
2010 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002011{
Jerry Yu955ddd72022-04-22 22:27:33 +08002012 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002013 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002014 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002015 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002016
2017 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002018 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002019
Jerry Yucfc04b32022-04-21 09:31:58 +08002020 /* ...
2021 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2022 * ...
2023 * with ProtocolVersion defined as:
2024 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002025 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2027 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002028 p += 2;
2029
Jerry Yu1c3e6882022-04-20 21:23:40 +08002030 /* ...
2031 * Random random;
2032 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002033 * with Random defined as:
2034 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002035 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2037 if (is_hrr) {
2038 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2039 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2040 } else {
2041 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2042 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002043 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2045 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002046 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2047
Jerry Yucfc04b32022-04-21 09:31:58 +08002048 /* ...
2049 * opaque legacy_session_id_echo<0..32>;
2050 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002051 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2053 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2054 if (ssl->session_negotiate->id_len > 0) {
2055 memcpy(p, &ssl->session_negotiate->id[0],
2056 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002057 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002058
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2060 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002061 }
2062
Jerry Yucfc04b32022-04-21 09:31:58 +08002063 /* ...
2064 * CipherSuite cipher_suite;
2065 * ...
2066 * with CipherSuite defined as:
2067 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002068 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2070 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002071 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 MBEDTLS_SSL_DEBUG_MSG(3,
2073 ("server hello, chosen ciphersuite: %s ( id=%d )",
2074 mbedtls_ssl_get_ciphersuite_name(
2075 ssl->session_negotiate->ciphersuite),
2076 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002077
Jerry Yucfc04b32022-04-21 09:31:58 +08002078 /* ...
2079 * uint8 legacy_compression_method = 0;
2080 * ...
2081 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002083 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002084
Jerry Yucfc04b32022-04-21 09:31:58 +08002085 /* ...
2086 * Extension extensions<6..2^16-1>;
2087 * ...
2088 * struct {
2089 * ExtensionType extension_type; (2 bytes)
2090 * opaque extension_data<0..2^16-1>;
2091 * } Extension;
2092 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002094 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002095 p += 2;
2096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2098 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002099 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2101 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002102 }
2103 p += output_len;
2104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2106 if (is_hrr) {
2107 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2108 } else {
2109 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2110 }
2111 if (ret != 0) {
2112 return ret;
2113 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002114 p += output_len;
2115 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002116
Ronald Cron41a443a2022-10-04 16:38:25 +02002117#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2119 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2120 if (ret != 0) {
2121 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2122 ret);
2123 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002124 }
2125 p += output_len;
2126 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002127#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002130
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2132 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002133
Jerry Yud9436a12022-04-20 22:28:09 +08002134 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002135
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002137
Jerry Yu7de2ff02022-11-08 21:43:46 +08002138 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002139 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 MBEDTLS_SSL_HS_SERVER_HELLO,
2141 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002144}
2145
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002146MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002147static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002148{
2149 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2151 if (ret != 0) {
2152 MBEDTLS_SSL_DEBUG_RET(1,
2153 "mbedtls_ssl_tls13_compute_handshake_transform",
2154 ret);
2155 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002156 }
2157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002159}
2160
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002161MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002162static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002163{
Jerry Yu637a3f12022-04-20 21:37:58 +08002164 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002165 unsigned char *buf;
2166 size_t buf_len, msg_len;
2167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002169
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002171
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2173 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2174 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002175
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2177 buf + buf_len,
2178 &msg_len,
2179 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002180
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002181 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002182 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002183
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2185 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002186
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002187 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002188
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002189#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2190 /* The server sends a dummy change_cipher_spec record immediately
2191 * after its first handshake message. This may either be after
2192 * a ServerHello or a HelloRetryRequest.
2193 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002194 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002196#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002198#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002199
Jerry Yuf4b27e42022-03-30 17:32:21 +08002200cleanup:
2201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2203 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002204}
2205
Jerry Yu23d1a252022-05-12 18:08:59 +08002206
2207/*
2208 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2209 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002210MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002211static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002212{
2213 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if (ssl->handshake->hello_retry_request_count > 0) {
2215 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2216 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2217 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2218 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002219 }
2220
2221 /*
2222 * Create stateless transcript hash for HRR
2223 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2225 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2226 if (ret != 0) {
2227 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2228 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002229 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002233}
2234
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002235MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002236static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002237{
2238 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2239 unsigned char *buf;
2240 size_t buf_len, msg_len;
2241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002243
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2247 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2248 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2251 buf + buf_len,
2252 &msg_len,
2253 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002254 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002255 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002256
2257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2259 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002260
2261 ssl->handshake->hello_retry_request_count++;
2262
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002263#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2264 /* The server sends a dummy change_cipher_spec record immediately
2265 * after its first handshake message. This may either be after
2266 * a ServerHello or a HelloRetryRequest.
2267 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002268 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002270#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002272#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002273
2274cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2276 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002277}
2278
Jerry Yu5b64ae92022-03-30 17:15:02 +08002279/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002280 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2281 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002282
2283/*
2284 * struct {
2285 * Extension extensions<0..2 ^ 16 - 1>;
2286 * } EncryptedExtensions;
2287 *
2288 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002289MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002290static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2291 unsigned char *buf,
2292 unsigned char *end,
2293 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002294{
XiaokangQianacb39922022-06-17 10:18:48 +00002295 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002296 unsigned char *p = buf;
2297 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002298 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002299 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002300
Jerry Yu4d3841a2022-04-16 12:37:19 +08002301 *out_len = 0;
2302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002304 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002305 p += 2;
2306
Jerry Yu8937eb42022-05-03 12:12:14 +08002307 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002308 ((void) ret);
2309 ((void) output_len);
2310
2311#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2313 if (ret != 0) {
2314 return ret;
2315 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002316 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002317#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 extensions_len = (p - p_extensions_len) - 2;
2320 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002321
2322 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002325
Jerry Yu7de2ff02022-11-08 21:43:46 +08002326 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002330}
2331
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002332MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002333static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002334{
2335 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2336 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002337 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002338
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 mbedtls_ssl_set_outbound_transform(ssl,
2340 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002341 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002343
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2347 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2348 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002349
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2351 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002352
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002353 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002354 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002355
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2357 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002358
Ronald Cron928cbd32022-10-04 16:14:26 +02002359#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2361 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2362 } else {
2363 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2364 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002365#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002367#endif
2368
Jerry Yu4d3841a2022-04-16 12:37:19 +08002369cleanup:
2370
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2372 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002373}
2374
Ronald Cron928cbd32022-10-04 16:14:26 +02002375#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002376#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2377#define SSL_CERTIFICATE_REQUEST_SKIP 1
2378/* Coordination:
2379 * Check whether a CertificateRequest message should be written.
2380 * Returns a negative code on failure, or
2381 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2382 * - SSL_CERTIFICATE_REQUEST_SKIP
2383 * indicating if the writing of the CertificateRequest
2384 * should be skipped or not.
2385 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002386MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002387static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002388{
2389 int authmode;
2390
XiaokangQian40a35232022-05-07 09:02:40 +00002391#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002393 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002395#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002396 authmode = ssl->conf->authmode;
2397
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002399 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002401 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002402
XiaokangQianc3017f62022-05-13 05:55:41 +00002403 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002404
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002406}
2407
XiaokangQiancec9ae62022-05-06 07:28:50 +00002408/*
2409 * struct {
2410 * opaque certificate_request_context<0..2^8-1>;
2411 * Extension extensions<2..2^16-1>;
2412 * } CertificateRequest;
2413 *
2414 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002416static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2417 unsigned char *buf,
2418 const unsigned char *end,
2419 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002420{
2421 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2422 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002423 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002424 unsigned char *p_extensions_len;
2425
2426 *out_len = 0;
2427
2428 /* Check if we have enough space:
2429 * - certificate_request_context (1 byte)
2430 * - extensions length (2 bytes)
2431 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002433
2434 /*
2435 * Write certificate_request_context
2436 */
2437 /*
2438 * We use a zero length context for the normal handshake
2439 * messages. For post-authentication handshake messages
2440 * this request context would be set to a non-zero value.
2441 */
2442 *p++ = 0x0;
2443
2444 /*
2445 * Write extensions
2446 */
2447 /* The extensions must contain the signature_algorithms. */
2448 p_extensions_len = p;
2449 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2451 if (ret != 0) {
2452 return ret;
2453 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002454
XiaokangQianec6efb92022-05-06 09:53:10 +00002455 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002457
2458 *out_len = p - buf;
2459
Jerry Yu7de2ff02022-11-08 21:43:46 +08002460 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002464}
2465
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002466MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002467static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002468{
2469 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2470
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002472
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002476 unsigned char *buf;
2477 size_t buf_len, msg_len;
2478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2480 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2481 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002482
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2484 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002485
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002486 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002487 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2490 ssl, buf_len, msg_len));
2491 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2492 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002493 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 } else {
2495 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002496 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2497 goto cleanup;
2498 }
2499
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002501cleanup:
2502
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2504 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002505}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002506
Jerry Yu4d3841a2022-04-16 12:37:19 +08002507/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002508 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002509 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002510MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002511static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002512{
Jerry Yu5a26f302022-05-10 20:46:40 +08002513 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002514
2515#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2517 mbedtls_ssl_own_cert(ssl) == NULL) {
2518 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2519 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2520 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2521 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002522 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002523#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002524
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2526 if (ret != 0) {
2527 return ret;
2528 }
2529 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2530 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002531}
2532
2533/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002534 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002535 */
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_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002538{
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2540 if (ret != 0) {
2541 return ret;
2542 }
2543 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2544 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002545}
Ronald Cron928cbd32022-10-04 16:14:26 +02002546#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002547
2548/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002549 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002550 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002551MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002552static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002553{
Jerry Yud6e253d2022-05-18 13:59:24 +08002554 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2557 if (ret != 0) {
2558 return ret;
2559 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2562 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002563 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2565 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2566 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002567 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2570 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 if (ssl->handshake->certificate_request_sent) {
2573 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2574 } else {
2575 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2576 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2577 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002578 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002581}
2582
2583/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002584 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002585 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002586MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002587static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002588{
Jerry Yud6e253d2022-05-18 13:59:24 +08002589 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2590
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2592 if (ret != 0) {
2593 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002594 }
2595
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2597 if (ret != 0) {
2598 MBEDTLS_SSL_DEBUG_RET(1,
2599 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2600 }
2601
2602 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2603 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002604}
2605
2606/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002607 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002608 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002609MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002610static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002611{
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002613
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002615
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002616#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2617 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002618/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2619 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2620 * expected to be resolved with issue#6395.
2621 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002622 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002623 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2624 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002625 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002626#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002627 {
2628 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2629 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002631}
2632
2633/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002634 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002635 */
2636#define SSL_NEW_SESSION_TICKET_SKIP 0
2637#define SSL_NEW_SESSION_TICKET_WRITE 1
2638MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002639static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002640{
2641 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 if (ssl->conf->f_ticket_write == NULL) {
2643 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2644 " callback is not set"));
2645 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002646 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 if (ssl->conf->new_session_tickets_count == 0) {
2648 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2649 " configured count is zero"));
2650 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002651 }
2652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 if (ssl->handshake->new_session_tickets_count == 0) {
2654 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2655 "been sent."));
2656 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002657 }
2658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002660}
2661
2662#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2663MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002664static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2665 unsigned char *ticket_nonce,
2666 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002667{
2668 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2669 mbedtls_ssl_session *session = ssl->session;
2670 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2671 psa_algorithm_t psa_hash_alg;
2672 int hash_length;
2673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002675
2676#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002678#endif
2679
Pengyu Lv9f926952022-11-17 15:22:33 +08002680 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002681 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002682 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002683#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002684 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002685 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002686#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002687 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002688
Jerry Yue67bef42022-07-07 07:29:42 +00002689 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2691 (unsigned char *) &session->ticket_age_add,
2692 sizeof(session->ticket_age_add)) != 0)) {
2693 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2694 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002695 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2697 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002698
2699 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2701 if (ret != 0) {
2702 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2703 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002704 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2706 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002707
2708 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2710 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2711 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2712 if (hash_length == -1 ||
2713 (size_t) hash_length > sizeof(session->resumption_key)) {
2714 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002715 }
2716
Jerry Yue67bef42022-07-07 07:29:42 +00002717 /* In this code the psk key length equals the length of the hash */
2718 session->resumption_key_len = hash_length;
2719 session->ciphersuite = ciphersuite_info->id;
2720
2721 /* Compute resumption key
2722 *
2723 * HKDF-Expand-Label( resumption_master_secret,
2724 * "resumption", ticket_nonce, Hash.length )
2725 */
2726 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 psa_hash_alg,
2728 session->app_secrets.resumption_master_secret,
2729 hash_length,
2730 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2731 ticket_nonce,
2732 ticket_nonce_size,
2733 session->resumption_key,
2734 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002735
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 if (ret != 0) {
2737 MBEDTLS_SSL_DEBUG_RET(2,
2738 "Creating the ticket-resumed PSK failed",
2739 ret);
2740 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002741 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2743 session->resumption_key,
2744 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002745
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2747 session->app_secrets.resumption_master_secret,
2748 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002751}
2752
2753/* This function creates a NewSessionTicket message in the following format:
2754 *
2755 * struct {
2756 * uint32 ticket_lifetime;
2757 * uint32 ticket_age_add;
2758 * opaque ticket_nonce<0..255>;
2759 * opaque ticket<1..2^16-1>;
2760 * Extension extensions<0..2^16-2>;
2761 * } NewSessionTicket;
2762 *
2763 * The ticket inside the NewSessionTicket message is an encrypted container
2764 * carrying the necessary information so that the server is later able to
2765 * re-start the communication.
2766 *
2767 * The following fields are placed inside the ticket by the
2768 * f_ticket_write() function:
2769 *
2770 * - creation time (start)
2771 * - flags (flags)
2772 * - age add (ticket_age_add)
2773 * - key (key)
2774 * - key length (key_len)
2775 * - ciphersuite (ciphersuite)
2776 */
2777MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002778static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2779 unsigned char *buf,
2780 unsigned char *end,
2781 size_t *out_len,
2782 unsigned char *ticket_nonce,
2783 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002784{
2785 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2786 unsigned char *p = buf;
2787 mbedtls_ssl_session *session = ssl->session;
2788 size_t ticket_len;
2789 uint32_t ticket_lifetime;
2790
2791 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002793
2794 /*
2795 * ticket_lifetime 4 bytes
2796 * ticket_age_add 4 bytes
2797 * ticket_nonce 1 + ticket_nonce_size bytes
2798 * ticket >=2 bytes
2799 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002801
2802 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2804 session,
2805 p + 9 + ticket_nonce_size + 2,
2806 end,
2807 &ticket_len,
2808 &ticket_lifetime);
2809 if (ret != 0) {
2810 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2811 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002812 }
2813 /* RFC 8446 4.6.1
2814 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2815 * unsigned integer in network byte order from the time of ticket
2816 * issuance. Servers MUST NOT use any value greater than
2817 * 604800 seconds (7 days). The value of zero indicates that the
2818 * ticket should be discarded immediately. Clients MUST NOT cache
2819 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2820 * and MAY delete tickets earlier based on local policy. A server
2821 * MAY treat a ticket as valid for a shorter period of time than what
2822 * is stated in the ticket_lifetime.
2823 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002825 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 }
2827 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2828 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2829 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002830
2831 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2833 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2834 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002835
2836 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 p[8] = (unsigned char) ticket_nonce_size;
2838 if (ticket_nonce_size > 0) {
2839 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002840 }
2841 p += 9 + ticket_nonce_size;
2842
2843 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002845 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002847 p += ticket_len;
2848
2849 /* Ticket Extensions
2850 *
2851 * Note: We currently don't have any extensions.
2852 * Set length to zero.
2853 */
Jerry Yuedab6372022-10-31 14:37:31 +08002854 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2857 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002858 p += 2;
2859
2860 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2862 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002863
Jerry Yu7de2ff02022-11-08 21:43:46 +08002864 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002868}
2869
2870/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002871 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002873static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002874{
2875 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002880 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2881 unsigned char *buf;
2882 size_t buf_len, msg_len;
2883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2885 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2888 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2889 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2892 ssl, buf, buf + buf_len, &msg_len,
2893 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002894
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2896 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002897
Jerry Yu359e65f2022-09-22 23:47:43 +08002898 /* Limit session tickets count to one when resumption connection.
2899 *
2900 * See document of mbedtls_ssl_conf_new_session_tickets.
2901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002903 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002905 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002907
Jerry Yua8d3c502022-10-30 14:51:23 +08002908 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2910 } else {
2911 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002912 }
2913
Jerry Yue67bef42022-07-07 07:29:42 +00002914cleanup:
2915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002917}
2918#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2919
2920/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002921 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002922 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002923int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002924{
XiaokangQian08037552022-04-20 07:16:41 +00002925 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002926
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2928 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2929 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
2932 mbedtls_ssl_states_str(ssl->state),
2933 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00002936 /* start state */
2937 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00002939 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002940 break;
2941
XiaokangQian7807f9f2022-02-15 10:04:37 +00002942 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 ret = ssl_tls13_process_client_hello(ssl);
2944 if (ret != 0) {
2945 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
2946 }
Jerry Yuf41553b2022-05-09 22:20:30 +08002947 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002948
Jerry Yuf41553b2022-05-09 22:20:30 +08002949 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 ret = ssl_tls13_write_hello_retry_request(ssl);
2951 if (ret != 0) {
2952 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
2953 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08002954 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002955 break;
2956
Jerry Yu5b64ae92022-03-30 17:15:02 +08002957 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08002959 break;
2960
Xiaofei Baicba64af2022-02-15 10:00:56 +00002961 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 ret = ssl_tls13_write_encrypted_extensions(ssl);
2963 if (ret != 0) {
2964 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
2965 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00002966 }
Jerry Yu48330562022-05-06 21:35:44 +08002967 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002968
Ronald Cron928cbd32022-10-04 16:14:26 +02002969#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002970 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002972 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002973
Jerry Yu83da34e2022-04-16 13:59:52 +08002974 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002976 break;
2977
2978 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002980 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002981#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 /*
2984 * Injection of dummy-CCS's for middlebox compatibility
2985 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002986#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002987 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2989 if (ret == 0) {
2990 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2991 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002992 break;
2993
2994 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2996 if (ret == 0) {
2997 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
2998 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002999 break;
3000#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3001
Jerry Yu69dd8d42022-04-16 12:51:26 +08003002 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003004 break;
3005
3006 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003008 break;
3009
Jerry Yu69dd8d42022-04-16 12:51:26 +08003010 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003012 break;
3013
Ronald Cron766c0cd2022-10-18 12:17:11 +02003014#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003015 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3017 if (ret == 0) {
3018 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003019 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3021 } else {
3022 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003023 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003025 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003026 }
3027 break;
3028
3029 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3031 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003032 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003034 }
3035 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003036#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003037
Jerry Yue67bef42022-07-07 07:29:42 +00003038#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003039 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 ret = ssl_tls13_write_new_session_ticket(ssl);
3041 if (ret != 0) {
3042 MBEDTLS_SSL_DEBUG_RET(1,
3043 "ssl_tls13_write_new_session_ticket ",
3044 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003045 }
3046 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003047 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003048 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003049 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003050 * as part of ssl_prepare_handshake_step.
3051 */
3052 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 if (ssl->handshake->new_session_tickets_count == 0) {
3055 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3056 } else {
3057 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3058 }
Jerry Yue67bef42022-07-07 07:29:42 +00003059 break;
3060
3061#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3062
XiaokangQian7807f9f2022-02-15 10:04:37 +00003063 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3065 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003066 }
3067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003069}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003070
Jerry Yufb4b6472022-01-27 15:03:26 +08003071#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */